@ar.io/sdk 3.10.0-alpha.1 → 3.10.0-alpha.3

package/lib/cjs/common/faucet.js

@@ -0,0 +1,150 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ARIOTokenFaucet = exports.createFaucet = void 0;
+const DEFAULT_FAUCET_API_URL = 'https://faucet.ario.permaweb.services';
+/**
+ * Creates a proxy object that implements the TokenFaucet interface. It wraps the ARIOReadable instance and adds methods for claiming tokens from the faucet API.
+ * @param arioInstance - The ARIOReadable instance
+ * @param faucetApiUrl - The URL of the faucet API
+ * @returns A proxy object that implements the TokenFaucet interface
+ */
+function createFaucet({ arioInstance, faucetApiUrl = DEFAULT_FAUCET_API_URL, }) {
+    const faucet = new ARIOTokenFaucet({
+        faucetUrl: faucetApiUrl,
+        processId: arioInstance.process.processId,
+    });
+    const proxy = new Proxy(arioInstance, {
+        get(target, prop) {
+            if (prop === 'faucet') {
+                return faucet;
+            }
+            if (prop in target) {
+                const result = target[prop];
+                if (typeof result === 'function') {
+                    return result.bind(target);
+                }
+                return result;
+            }
+            return undefined;
+        },
+    });
+    return proxy;
+}
+exports.createFaucet = createFaucet;
+class ARIOTokenFaucet {
+    faucetUrl;
+    processId;
+    constructor({ faucetUrl, processId, }) {
+        this.faucetUrl = faucetUrl;
+        this.processId = processId;
+    }
+    /**
+     * Returns the captcha URL for a process. The captcha is used to verify a human is solving the captcha. Once you have a captcha response, you can use it to request an authorization token via the requestAuthToken method.
+     * @returns The captcha URL for a process
+     */
+    async captchaUrl() {
+        const res = await fetch(`${this.faucetUrl}/api/captcha/url?process-id=${this.processId}`, {
+            method: 'GET',
+        });
+        if (!res.ok) {
+            const body = await res.json().catch(() => ({ error: res.statusText }));
+            throw new Error(body.error);
+        }
+        const data = (await res.json());
+        return data;
+    }
+    /**
+     * Claim tokens for a process using a captcha response. This method is used to synchronously claim tokens for a process using a captcha response.
+     * @param captchaResponse - The captcha response
+     * @param recipient - The recipient address
+     * @param quantity - The quantity of tokens to claim
+     * @returns The claim id and success status
+     */
+    async claimWithCaptchaResponse({ captchaResponse, recipient, quantity, }) {
+        const res = await fetch(`${this.faucetUrl}/api/claim/sync`, {
+            method: 'POST',
+            headers: { 'Content-Type': 'application/json' },
+            body: JSON.stringify({
+                processId: this.processId,
+                recipient,
+                quantity,
+                captchaResponse,
+            }),
+        });
+        if (!res.ok) {
+            const body = await res.json().catch(() => ({ error: res.statusText }));
+            throw new Error(body.error);
+        }
+        const data = (await res.json());
+        return data;
+    }
+    /**
+     * Requests an authorization token for a process. The captcha response is used to verify a human is solving the captcha. Once you have an authorization token, you can use it to claim tokens from the faucet via the claimWithAuthToken method.
+     * @param captchaResponse - The captcha response
+     * @returns The status of the request, the authorization token, and the expiration time
+     */
+    async requestAuthToken({ captchaResponse, }) {
+        const res = await fetch(`${this.faucetUrl}/api/captcha/verify`, {
+            method: 'POST',
+            headers: { 'Content-Type': 'application/json' },
+            body: JSON.stringify({
+                processId: this.processId,
+                captchaResponse,
+            }),
+        });
+        if (!res.ok) {
+            const body = await res.json().catch(() => ({ error: res.statusText }));
+            throw new Error(body.error);
+        }
+        const data = (await res.json());
+        return data;
+    }
+    /**
+     * Transfers tokens from the faucet wallet to a recipient address using an authorization token. To request an authorization token, solve the captcha from the captchaUrl method.
+     * @param authToken - The authorization token
+     * @param recipient - The recipient address
+     * @param quantity - The quantity of tokens to claim
+     * @returns The message id of the transfer and success status
+     */
+    async claimWithAuthToken({ authToken, recipient, quantity, }) {
+        const res = await fetch(`${this.faucetUrl}/api/claim/async`, {
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json',
+                Authorization: `Bearer ${authToken}`,
+            },
+            body: JSON.stringify({
+                recipient,
+                qty: quantity,
+                processId: this.processId,
+            }),
+        });
+        if (!res.ok) {
+            const body = await res.json().catch(() => ({ error: res.statusText }));
+            throw new Error(body.error);
+        }
+        const data = (await res.json());
+        return data;
+    }
+    /**
+     * Verifies an authorization token is valid.
+     * @param authToken - The authorization token
+     * @returns The validity of the authorization token and the expiration time
+     */
+    async verifyAuthToken({ authToken }) {
+        const res = await fetch(`${this.faucetUrl}/api/token/verify?process-id=${this.processId}`, {
+            method: 'GET',
+            headers: {
+                'Content-Type': 'application/json',
+                Authorization: `Bearer ${authToken}`,
+            },
+        });
+        if (!res.ok) {
+            const body = await res.json().catch(() => ({ error: res.statusText }));
+            throw new Error(body.error);
+        }
+        const data = (await res.json());
+        return data;
+    }
+}
+exports.ARIOTokenFaucet = ARIOTokenFaucet;

package/lib/cjs/common/index.js

@@ -34,6 +34,7 @@ __exportStar(require("./logger.js"), exports);
 __exportStar(require("./ant.js"), exports);
 __exportStar(require("./ant-registry.js"), exports);
 __exportStar(require("./ant-versions.js"), exports);
+__exportStar(require("./faucet.js"), exports);
 // ao
 __exportStar(require("./io.js"), exports);
 __exportStar(require("./contracts/ao-process.js"), exports);

package/lib/cjs/common/io.js

@@ -1,13 +1,30 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ARIOWriteable = exports.ARIOReadable = exports.ARIO = void 0;
+/**
+ * Copyright (C) 2022-2024 Permanent Data Solutions, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+const aoconnect_1 = require("@permaweb/aoconnect");
 const constants_js_1 = require("../constants.js");
-const io_js_1 = require("../types/io.js");
+const index_js_1 = require("../types/index.js");
 const ao_js_1 = require("../utils/ao.js");
 const arweave_js_1 = require("../utils/arweave.js");
 const arweave_js_2 = require("./arweave.js");
 const ao_process_js_1 = require("./contracts/ao-process.js");
 const error_js_1 = require("./error.js");
+const faucet_js_1 = require("./faucet.js");
 const turbo_js_1 = require("./turbo.js");
 class ARIO {
     // Implementation
@@ -17,6 +34,56 @@ class ARIO {
         }
         return new ARIOReadable(config);
     }
+    static mainnet(config) {
+        if (config !== undefined && 'signer' in config) {
+            return new ARIOWriteable({
+                ...config,
+                process: new ao_process_js_1.AOProcess({
+                    processId: constants_js_1.ARIO_MAINNET_PROCESS_ID,
+                    ao: (0, aoconnect_1.connect)({
+                        CU_URL: 'https://cu.ardrive.io',
+                        ...config?.process?.ao,
+                    }),
+                }),
+            });
+        }
+        return new ARIOReadable({
+            ...config,
+            process: new ao_process_js_1.AOProcess({
+                processId: constants_js_1.ARIO_MAINNET_PROCESS_ID,
+            }),
+        });
+    }
+    static testnet(config) {
+        if (config !== undefined && 'signer' in config) {
+            return (0, faucet_js_1.createFaucet)({
+                arioInstance: new ARIOWriteable({
+                    ...config,
+                    process: new ao_process_js_1.AOProcess({
+                        processId: constants_js_1.ARIO_TESTNET_PROCESS_ID,
+                        ao: (0, aoconnect_1.connect)({
+                            CU_URL: 'https://cu.ardrive.io',
+                            ...config?.process?.ao,
+                        }),
+                    }),
+                }),
+                faucetApiUrl: config?.faucetUrl,
+            });
+        }
+        return (0, faucet_js_1.createFaucet)({
+            arioInstance: new ARIOReadable({
+                ...config,
+                process: new ao_process_js_1.AOProcess({
+                    processId: constants_js_1.ARIO_TESTNET_PROCESS_ID,
+                    ao: (0, aoconnect_1.connect)({
+                        CU_URL: 'https://cu.ardrive.io',
+                        ...config?.process?.ao,
+                    }),
+                }),
+            }),
+            faucetApiUrl: config?.faucetUrl,
+        });
+    }
 }
 exports.ARIO = ARIO;
 class ARIOReadable {
@@ -31,10 +98,10 @@ class ARIOReadable {
                 processId: constants_js_1.ARIO_MAINNET_PROCESS_ID,
             });
         }
-        else if ((0, io_js_1.isProcessConfiguration)(config)) {
+        else if ((0, index_js_1.isProcessConfiguration)(config)) {
             this.process = config.process;
         }
-        else if ((0, io_js_1.isProcessIdConfiguration)(config)) {
+        else if ((0, index_js_1.isProcessIdConfiguration)(config)) {
             this.process = new ao_process_js_1.AOProcess({
                 processId: config.processId,
             });
@@ -42,7 +109,7 @@ class ARIOReadable {
         else {
             throw new error_js_1.InvalidContractConfigurationError();
         }
-        this.paymentProvider = new turbo_js_1.TurboArNSPaymentProvider({
+        this.paymentProvider = turbo_js_1.TurboArNSPaymentFactory.init({
             paymentUrl: config?.paymentUrl,
         });
     }
@@ -570,8 +637,8 @@ class ARIOWriteable extends ARIOReadable {
             super(config);
         }
         this.signer = (0, ao_js_1.createAoSigner)(signer);
-        this.paymentProvider = new turbo_js_1.TurboArNSPaymentProvider({
-            signer: signer,
+        this.paymentProvider = turbo_js_1.TurboArNSPaymentFactory.init({
+            signer: (0, turbo_js_1.isTurboArNSSigner)(signer) ? signer : undefined,
             paymentUrl,
         });
     }
@@ -849,6 +916,9 @@ class ARIOWriteable extends ARIOReadable {
     }
     async buyRecord(params, options) {
         if (params.fundFrom === 'turbo') {
+            if (!(this.paymentProvider instanceof turbo_js_1.TurboArNSPaymentProviderAuthenticated)) {
+                throw new Error('Turbo funding is not supported for this payment provider');
+            }
             return this.paymentProvider.initiateArNSPurchase({
                 intent: 'Buy-Name',
                 ...params,
@@ -879,6 +949,9 @@ class ARIOWriteable extends ARIOReadable {
      */
     async upgradeRecord(params, options) {
         if (params.fundFrom === 'turbo') {
+            if (!(this.paymentProvider instanceof turbo_js_1.TurboArNSPaymentProviderAuthenticated)) {
+                throw new Error('Turbo funding is not supported for this payment provider');
+            }
             return this.paymentProvider.initiateArNSPurchase({
                 intent: 'Upgrade-Name',
                 name: params.name,
@@ -907,6 +980,9 @@ class ARIOWriteable extends ARIOReadable {
      */
     async extendLease(params, options) {
         if (params.fundFrom === 'turbo') {
+            if (!(this.paymentProvider instanceof turbo_js_1.TurboArNSPaymentProviderAuthenticated)) {
+                throw new Error('Turbo funding is not supported for this payment provider');
+            }
             return this.paymentProvider.initiateArNSPurchase({
                 intent: 'Extend-Lease',
                 ...params,
@@ -927,6 +1003,9 @@ class ARIOWriteable extends ARIOReadable {
     }
     async increaseUndernameLimit(params, options) {
         if (params.fundFrom === 'turbo') {
+            if (!(this.paymentProvider instanceof turbo_js_1.TurboArNSPaymentProviderAuthenticated)) {
+                throw new Error('Turbo funding is not supported for this payment provider');
+            }
             return this.paymentProvider.initiateArNSPurchase({
                 intent: 'Increase-Undername-Limit',
                 ...params,

package/lib/cjs/common/turbo.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TurboArNSPaymentProvider = exports.signedRequestHeadersFromSigner = void 0;
+exports.isTurboArNSSigner = exports.TurboArNSPaymentProviderAuthenticated = exports.TurboArNSPaymentProviderUnauthenticated = exports.TurboArNSPaymentFactory = exports.signedRequestHeadersFromSigner = void 0;
 /**
  * Copyright (C) 2022-2024 Permanent Data Solutions, Inc.
  *
@@ -24,40 +24,89 @@ const http_client_js_1 = require("../utils/http-client.js");
 const url_js_1 = require("../utils/url.js");
 const logger_js_1 = require("./logger.js");
 async function signedRequestHeadersFromSigner({ signer, nonce = (0, uuid_1.v4)(), }) {
-    await signer.setPublicKey?.();
-    const signature = await signer.sign(Uint8Array.from(Buffer.from(nonce)));
-    let publicKey;
-    switch (signer.signatureType) {
+    let signature = undefined;
+    let publicKey = undefined;
+    const signatureType = isWanderArweaveBrowserSigner(signer)
+        ? arbundles_1.SignatureConfig.ARWEAVE
+        : signer.signatureType;
+    // equivalent to window.arweaveWallet
+    if (isWanderArweaveBrowserSigner(signer)) {
+        signature = (0, base64_js_1.toB64Url)(Buffer.from(await signer.signMessage(Uint8Array.from(Buffer.from(nonce)))));
+    }
+    else if (signer instanceof arbundles_1.ArconnectSigner) {
+        signature = (0, base64_js_1.toB64Url)(Buffer.from(await signer['signer'].signMessage(Uint8Array.from(Buffer.from(nonce)))));
+    }
+    else if (signer instanceof arbundles_1.ArweaveSigner ||
+        signer instanceof arbundles_1.EthereumSigner ||
+        signer instanceof arbundles_1.InjectedEthereumSigner) {
+        if ('setPublicKey' in signer) {
+            await signer.setPublicKey();
+        }
+        signature = (0, base64_js_1.toB64Url)(Buffer.from(await signer.sign(Uint8Array.from(Buffer.from(nonce)))));
+    }
+    switch (signatureType) {
         case arbundles_1.SignatureConfig.ARWEAVE:
-            publicKey = (0, base64_js_1.toB64Url)(signer.publicKey);
+            if (isWanderArweaveBrowserSigner(signer)) {
+                publicKey = await signer.getActivePublicKey();
+            }
+            else if ('setPublicKey' in signer) {
+                await signer.setPublicKey();
+                publicKey = (0, base64_js_1.toB64Url)(signer.publicKey);
+            }
             break;
         case arbundles_1.SignatureConfig.ETHEREUM:
-            publicKey = '0x' + signer.publicKey.toString('hex');
+            if ('publicKey' in signer) {
+                publicKey = '0x' + signer.publicKey.toString('hex');
+            }
+            else {
+                throw new Error('Public key not found');
+            }
             break;
         // TODO: solana sig support
         // case SignatureConfig.SOLANA:
         // case SignatureConfig.ED25519:
         default:
-            throw new Error(`Unsupported signer type for signing requests: ${signer.signatureType}`);
+            throw new Error(`Unsupported signer type for signing requests: ${signatureType}`);
+    }
+    if (publicKey === undefined || signature === undefined) {
+        throw new Error('Public key or signature not found');
     }
     return {
         'x-public-key': publicKey,
         'x-nonce': nonce,
-        'x-signature': (0, base64_js_1.toB64Url)(Buffer.from(signature)),
-        'x-signature-type': signer.signatureType,
+        'x-signature': signature,
+        'x-signature-type': signatureType,
     };
 }
 exports.signedRequestHeadersFromSigner = signedRequestHeadersFromSigner;
-class TurboArNSPaymentProvider {
+class TurboArNSPaymentFactory {
+    static init(config) {
+        const { signer, paymentUrl, axios, logger } = config ?? {};
+        if (signer !== undefined) {
+            return new TurboArNSPaymentProviderAuthenticated({
+                signer,
+                paymentUrl,
+                axios,
+                logger,
+            });
+        }
+        return new TurboArNSPaymentProviderUnauthenticated({
+            paymentUrl,
+            axios,
+            logger,
+        });
+    }
+}
+exports.TurboArNSPaymentFactory = TurboArNSPaymentFactory;
+// Base class for unauthenticated operations
+class TurboArNSPaymentProviderUnauthenticated {
     paymentUrl;
     axios;
     logger;
-    signer;
-    constructor({ paymentUrl = 'https://payment.ardrive.io', axios = (0, http_client_js_1.createAxiosInstance)(), logger = logger_js_1.Logger.default, signer, }) {
+    constructor({ paymentUrl = 'https://payment.ardrive.io', axios = (0, http_client_js_1.createAxiosInstance)(), logger = logger_js_1.Logger.default, }) {
         this.paymentUrl = paymentUrl;
         this.axios = axios;
         this.logger = logger;
-        this.signer = signer;
     }
     async getArNSPriceDetails({ intent, name, quantity, type, years, }) {
         const url = (0, url_js_1.urlWithSearchParams)({
@@ -93,10 +142,20 @@ class TurboArNSPaymentProvider {
         const { winc } = await this.getArNSPriceDetails(params);
         return +winc;
     }
-    async initiateArNSPurchase({ intent, name, quantity, type, processId, years, }) {
-        if (!this.signer) {
-            throw new Error('Signer required for initiating ArNS purchase with Turbo');
+}
+exports.TurboArNSPaymentProviderUnauthenticated = TurboArNSPaymentProviderUnauthenticated;
+// Class for authenticated operations, extending the base class
+class TurboArNSPaymentProviderAuthenticated extends TurboArNSPaymentProviderUnauthenticated {
+    signer;
+    constructor({ signer, ...restConfig }) {
+        super(restConfig); // Pass unauthenticated config to base class+
+        if (!isTurboArNSSigner(signer)) {
+            throw new Error('Signer must be a TurboArNSSigner');
         }
+        this.signer = signer;
+    }
+    async initiateArNSPurchase({ intent, name, quantity, type, processId, years, }) {
+        // Signer check is implicitly handled by requiring it in the constructor
         const url = (0, url_js_1.urlWithSearchParams)({
             baseUrl: `${this.paymentUrl}/v1/arns/purchase/${intent}/${name}`,
             params: {
@@ -131,4 +190,19 @@ class TurboArNSPaymentProvider {
         };
     }
 }
-exports.TurboArNSPaymentProvider = TurboArNSPaymentProvider;
+exports.TurboArNSPaymentProviderAuthenticated = TurboArNSPaymentProviderAuthenticated;
+function isWanderArweaveBrowserSigner(signer) {
+    return (typeof signer === 'object' &&
+        signer !== null &&
+        'signMessage' in signer &&
+        'getActivePublicKey' in signer);
+}
+function isTurboArNSSigner(signer) {
+    const isWanderWallet = isWanderArweaveBrowserSigner(signer);
+    const isSigner = signer instanceof arbundles_1.EthereumSigner ||
+        signer instanceof arbundles_1.InjectedEthereumSigner ||
+        signer instanceof arbundles_1.ArweaveSigner ||
+        signer instanceof arbundles_1.ArconnectSigner;
+    return isWanderWallet || isSigner;
+}
+exports.isTurboArNSSigner = isTurboArNSSigner;

package/lib/cjs/types/faucet.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/cjs/types/index.js

@@ -32,5 +32,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./ant-registry.js"), exports);
 __exportStar(require("./ant.js"), exports);
 __exportStar(require("./common.js"), exports);
+__exportStar(require("./faucet.js"), exports);
 __exportStar(require("./io.js"), exports);
 __exportStar(require("./token.js"), exports);

package/lib/cjs/types/io.js

@@ -35,11 +35,12 @@ const isValidFundFrom = (fundFrom) => {
 exports.isValidFundFrom = isValidFundFrom;
 // Type-guard functions
 function isProcessConfiguration(config) {
-    return 'process' in config;
+    return config !== undefined && 'process' in config;
 }
 exports.isProcessConfiguration = isProcessConfiguration;
 function isProcessIdConfiguration(config) {
-    return ('processId' in config &&
+    return (config !== undefined &&
+        'processId' in config &&
         typeof config.processId === 'string' &&
         (0, arweave_js_1.validateArweaveId)(config.processId) === true);
 }

package/lib/cjs/utils/ao.js

@@ -137,6 +137,8 @@ function createAoSigner(signer) {
         }));
         return signedData;
     };
+    // eslint-disable-next-line
+    // @ts-ignore Buffer vs ArrayBuffer type mismatch
     return aoSigner;
 }
 exports.createAoSigner = createAoSigner;

package/lib/cjs/version.js

@@ -17,4 +17,4 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.version = void 0;
 // AUTOMATICALLY GENERATED FILE - DO NOT TOUCH
-exports.version = '3.10.0-alpha.1';
+exports.version = '3.10.0-alpha.3';

package/lib/cjs/web/index.js

@@ -14,7 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ArconnectSigner = exports.ArweaveSigner = void 0;
+exports.EthereumSigner = exports.InjectedEthereumSigner = exports.ArconnectSigner = exports.ArweaveSigner = void 0;
 /**
  * Copyright (C) 2022-2024 Permanent Data Solutions, Inc.
  *
@@ -33,6 +33,8 @@ exports.ArconnectSigner = exports.ArweaveSigner = void 0;
 var arbundles_1 = require("@dha-team/arbundles");
 Object.defineProperty(exports, "ArweaveSigner", { enumerable: true, get: function () { return arbundles_1.ArweaveSigner; } });
 Object.defineProperty(exports, "ArconnectSigner", { enumerable: true, get: function () { return arbundles_1.ArconnectSigner; } });
+Object.defineProperty(exports, "InjectedEthereumSigner", { enumerable: true, get: function () { return arbundles_1.InjectedEthereumSigner; } });
+Object.defineProperty(exports, "EthereumSigner", { enumerable: true, get: function () { return arbundles_1.EthereumSigner; } });
 __exportStar(require("../types/index.js"), exports);
 __exportStar(require("../common/index.js"), exports);
 __exportStar(require("../constants.js"), exports);