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

package/lib/cjs/cli/utils.js

@@ -3,7 +3,48 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.assertLockLengthInRange = exports.fundFromFromOptions = exports.getTokenCostParamsFromOptions = exports.getANTStateFromOptions = exports.requiredPositiveIntegerFromOptions = exports.positiveIntegerFromOptions = exports.requiredStringArrayFromOptions = exports.requiredStringFromOptions = exports.booleanFromOptions = exports.writeANTFromOptions = exports.readANTFromOptions = exports.requiredProcessIdFromOptions = exports.assertConfirmationPrompt = exports.confirmationPrompt = exports.assertEnoughMARIOBalance = exports.assertEnoughBalanceForArNSPurchase = exports.requiredMARIOFromOptions = exports.recordTypeFromOptions = exports.redelegateParamsFromOptions = exports.requiredTargetAndQuantityFromOptions = exports.gatewaySettingsFromOptions = exports.customTagsFromOptions = exports.requiredInitiatorFromOptions = exports.epochInputFromOptions = exports.paginationParamsFromOptions = exports.requiredAddressFromOptions = exports.addressFromOptions = exports.formatMARIOToARIOWithCommas = exports.formatARIOWithCommas = exports.writeARIOFromOptions = exports.requiredAoSignerFromOptions = exports.requiredContractSignerFromOptions = exports.contractSignerFromOptions = exports.readARIOFromOptions = exports.getLoggerFromOptions = exports.jwkToAddress = exports.requiredJwkFromOptions = exports.arioProcessIdFromOptions = exports.makeCommand = exports.applyOptions = exports.runCommand = exports.stringifyJsonForCLIDisplay = exports.defaultTtlSecondsCLI = void 0;
+exports.defaultTtlSecondsCLI = void 0;
+exports.stringifyJsonForCLIDisplay = stringifyJsonForCLIDisplay;
+exports.runCommand = runCommand;
+exports.applyOptions = applyOptions;
+exports.makeCommand = makeCommand;
+exports.arioProcessIdFromOptions = arioProcessIdFromOptions;
+exports.requiredJwkFromOptions = requiredJwkFromOptions;
+exports.jwkToAddress = jwkToAddress;
+exports.getLoggerFromOptions = getLoggerFromOptions;
+exports.readARIOFromOptions = readARIOFromOptions;
+exports.requiredContractSignerFromOptions = requiredContractSignerFromOptions;
+exports.requiredAoSignerFromOptions = requiredAoSignerFromOptions;
+exports.writeARIOFromOptions = writeARIOFromOptions;
+exports.formatARIOWithCommas = formatARIOWithCommas;
+exports.formatMARIOToARIOWithCommas = formatMARIOToARIOWithCommas;
+exports.addressFromOptions = addressFromOptions;
+exports.requiredAddressFromOptions = requiredAddressFromOptions;
+exports.paginationParamsFromOptions = paginationParamsFromOptions;
+exports.epochInputFromOptions = epochInputFromOptions;
+exports.requiredInitiatorFromOptions = requiredInitiatorFromOptions;
+exports.customTagsFromOptions = customTagsFromOptions;
+exports.gatewaySettingsFromOptions = gatewaySettingsFromOptions;
+exports.requiredTargetAndQuantityFromOptions = requiredTargetAndQuantityFromOptions;
+exports.redelegateParamsFromOptions = redelegateParamsFromOptions;
+exports.recordTypeFromOptions = recordTypeFromOptions;
+exports.requiredMARIOFromOptions = requiredMARIOFromOptions;
+exports.assertEnoughBalanceForArNSPurchase = assertEnoughBalanceForArNSPurchase;
+exports.assertEnoughMARIOBalance = assertEnoughMARIOBalance;
+exports.confirmationPrompt = confirmationPrompt;
+exports.assertConfirmationPrompt = assertConfirmationPrompt;
+exports.requiredProcessIdFromOptions = requiredProcessIdFromOptions;
+exports.readANTFromOptions = readANTFromOptions;
+exports.writeANTFromOptions = writeANTFromOptions;
+exports.booleanFromOptions = booleanFromOptions;
+exports.requiredStringFromOptions = requiredStringFromOptions;
+exports.requiredStringArrayFromOptions = requiredStringArrayFromOptions;
+exports.positiveIntegerFromOptions = positiveIntegerFromOptions;
+exports.requiredPositiveIntegerFromOptions = requiredPositiveIntegerFromOptions;
+exports.getANTStateFromOptions = getANTStateFromOptions;
+exports.getTokenCostParamsFromOptions = getTokenCostParamsFromOptions;
+exports.fundFromFromOptions = fundFromFromOptions;
+exports.assertLockLengthInRange = assertLockLengthInRange;
 /**
  * Copyright (C) 2022-2024 Permanent Data Solutions, Inc.
  *
@@ -19,7 +60,6 @@ exports.assertLockLengthInRange = exports.fundFromFromOptions = exports.getToken
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-const arbundles_1 = require("@dha-team/arbundles");
 const aoconnect_1 = require("@permaweb/aoconnect");
 const commander_1 = require("commander");
 const fs_1 = require("fs");
@@ -30,7 +70,6 @@ exports.defaultTtlSecondsCLI = 3600;
 function stringifyJsonForCLIDisplay(json) {
     return JSON.stringify(json, null, 2);
 }
-exports.stringifyJsonForCLIDisplay = stringifyJsonForCLIDisplay;
 function logCommandOutput(output) {
     console.log(stringifyJsonForCLIDisplay(output));
 }
@@ -59,14 +98,12 @@ async function runCommand(command, action) {
         exitWithErrorLog(error, options.debug);
     }
 }
-exports.runCommand = runCommand;
 function applyOptions(command, options) {
     [...options].forEach((option) => {
         command.option(option.alias, option.description, option.default);
     });
     return command;
 }
-exports.applyOptions = applyOptions;
 function makeCommand({ description, name, options = [], action, }) {
     const command = commander_1.program.command(name).description(description);
     const appliedCommand = applyOptions(command, [...options, ...options_js_1.globalOptions]);
@@ -75,7 +112,6 @@ function makeCommand({ description, name, options = [], action, }) {
     }
     return appliedCommand;
 }
-exports.makeCommand = makeCommand;
 function arioProcessIdFromOptions({ arioProcessId, devnet, testnet, }) {
     if (arioProcessId !== undefined) {
         return arioProcessId;
@@ -88,8 +124,7 @@ function arioProcessIdFromOptions({ arioProcessId, devnet, testnet, }) {
     }
     return index_js_1.ARIO_MAINNET_PROCESS_ID;
 }
-exports.arioProcessIdFromOptions = arioProcessIdFromOptions;
-function walletFromOptions({ privateKey, walletFile, }) {
+function jwkFromOptions({ privateKey, walletFile, }) {
     if (privateKey !== undefined) {
         return JSON.parse(privateKey);
     }
@@ -99,17 +134,15 @@ function walletFromOptions({ privateKey, walletFile, }) {
     return undefined;
 }
 function requiredJwkFromOptions(options) {
-    const jwk = walletFromOptions(options);
+    const jwk = jwkFromOptions(options);
     if (jwk === undefined) {
         throw new Error('No JWK provided for signing!\nPlease provide a stringified JWK with `--private-key` or the file path of a jwk.json file with `--wallet-file`');
     }
     return jwk;
 }
-exports.requiredJwkFromOptions = requiredJwkFromOptions;
 function jwkToAddress(jwk) {
     return (0, index_js_1.sha256B64Url)((0, index_js_1.fromB64Url)(jwk.n));
 }
-exports.jwkToAddress = jwkToAddress;
 function setLoggerIfDebug(options) {
     if (options.debug) {
         index_js_1.Logger.default.setLogLevel('debug');
@@ -119,7 +152,6 @@ function getLoggerFromOptions(options) {
     setLoggerIfDebug(options);
     return index_js_1.Logger.default;
 }
-exports.getLoggerFromOptions = getLoggerFromOptions;
 function aoProcessFromOptions(options) {
     return new index_js_1.AOProcess({
         processId: arioProcessIdFromOptions(options),
@@ -132,38 +164,17 @@ function readARIOFromOptions(options) {
     setLoggerIfDebug(options);
     return index_js_1.ARIO.init({
         process: aoProcessFromOptions(options),
-        paymentUrl: options.paymentUrl,
     });
 }
-exports.readARIOFromOptions = readARIOFromOptions;
-function contractSignerFromOptions(options) {
-    const wallet = walletFromOptions(options);
-    if (wallet === undefined) {
-        return undefined;
-    }
-    const token = options.token ?? 'arweave';
-    if (token === 'ethereum') {
-        const signer = new arbundles_1.EthereumSigner(wallet);
-        // For EthereumSigner, we need to convert the JWK to a string
-        return { signer, signerAddress: signer.publicKey.toString('hex') };
-    }
-    // TODO: Support other wallet types
-    const signer = new index_js_1.ArweaveSigner(wallet);
-    return { signer, signerAddress: jwkToAddress(wallet) };
-}
-exports.contractSignerFromOptions = contractSignerFromOptions;
 function requiredContractSignerFromOptions(options) {
-    const contractSigner = contractSignerFromOptions(options);
-    if (contractSigner === undefined) {
-        throw new Error('No signer provided for signing!\nPlease provide a stringified JWK or Ethereum private key with `--private-key` or the file path of an arweave.jwk.json or eth.private.key.txt file with `--wallet-file`');
-    }
-    return contractSigner;
+    // TODO: Support other wallet types
+    const jwk = requiredJwkFromOptions(options);
+    const signer = new index_js_1.ArweaveSigner(jwk);
+    return { signer, signerAddress: jwkToAddress(jwk) };
 }
-exports.requiredContractSignerFromOptions = requiredContractSignerFromOptions;
 function requiredAoSignerFromOptions(options) {
     return (0, index_js_1.createAoSigner)(requiredContractSignerFromOptions(options).signer);
 }
-exports.requiredAoSignerFromOptions = requiredAoSignerFromOptions;
 function writeARIOFromOptions(options) {
     const { signer, signerAddress } = requiredContractSignerFromOptions(options);
     setLoggerIfDebug(options);
@@ -171,12 +182,10 @@ function writeARIOFromOptions(options) {
         ario: index_js_1.ARIO.init({
             process: aoProcessFromOptions(options),
             signer,
-            paymentUrl: options.paymentUrl,
         }),
         signerAddress,
     };
 }
-exports.writeARIOFromOptions = writeARIOFromOptions;
 function formatARIOWithCommas(value) {
     const [integerPart, decimalPart] = value.toString().split('.');
     const integerWithCommas = integerPart.replace(/\B(?=(\d{3})+(?!\d))/g, ',');
@@ -185,23 +194,21 @@ function formatARIOWithCommas(value) {
     }
     return integerWithCommas + '.' + decimalPart;
 }
-exports.formatARIOWithCommas = formatARIOWithCommas;
 function formatMARIOToARIOWithCommas(value) {
     return formatARIOWithCommas(value.toARIO());
 }
-exports.formatMARIOToARIOWithCommas = formatMARIOToARIOWithCommas;
 /** helper to get address from --address option first, then check wallet options  */
 function addressFromOptions(options) {
     if (options.address !== undefined) {
         return options.address;
     }
-    const signer = contractSignerFromOptions(options);
-    if (signer !== undefined) {
-        return signer.signerAddress;
+    // TODO: Support other wallet types
+    const jwk = jwkFromOptions(options);
+    if (jwk !== undefined) {
+        return jwkToAddress(jwk);
     }
     return undefined;
 }
-exports.addressFromOptions = addressFromOptions;
 function requiredAddressFromOptions(options) {
     const address = addressFromOptions(options);
     if (address !== undefined) {
@@ -209,7 +216,6 @@ function requiredAddressFromOptions(options) {
     }
     throw new Error('No address provided. Use --address or --wallet-file');
 }
-exports.requiredAddressFromOptions = requiredAddressFromOptions;
 const defaultCliPaginationLimit = 10; // more friendly UX than 100
 function paginationParamsFromOptions(options) {
     const { cursor, limit, sortBy, sortOrder } = options;
@@ -227,7 +233,6 @@ function paginationParamsFromOptions(options) {
         sortOrder,
     };
 }
-exports.paginationParamsFromOptions = paginationParamsFromOptions;
 function epochInputFromOptions(options) {
     if (options.epochIndex !== undefined) {
         return { epochIndex: +options.epochIndex };
@@ -237,14 +242,12 @@ function epochInputFromOptions(options) {
     }
     return undefined;
 }
-exports.epochInputFromOptions = epochInputFromOptions;
 function requiredInitiatorFromOptions(options) {
     if (options.initiator !== undefined) {
         return options.initiator;
     }
     return requiredAddressFromOptions(options);
 }
-exports.requiredInitiatorFromOptions = requiredInitiatorFromOptions;
 function customTagsFromOptions(options) {
     if (options.tags === undefined) {
         return {};
@@ -269,7 +272,6 @@ function customTagsFromOptions(options) {
         tags,
     };
 }
-exports.customTagsFromOptions = customTagsFromOptions;
 function gatewaySettingsFromOptions({ allowDelegatedStaking, autoStake, delegateRewardShareRatio, fqdn, label, minDelegatedStake, note, observerAddress, port, properties, allowedDelegates, }) {
     return {
         observerAddress,
@@ -287,7 +289,6 @@ function gatewaySettingsFromOptions({ allowDelegatedStaking, autoStake, delegate
         properties,
     };
 }
-exports.gatewaySettingsFromOptions = gatewaySettingsFromOptions;
 function requiredTargetAndQuantityFromOptions(options) {
     if (options.target === undefined) {
         throw new Error('No target provided. Use --target');
@@ -300,7 +301,6 @@ function requiredTargetAndQuantityFromOptions(options) {
         arioQuantity: new index_js_1.ARIOToken(+options.quantity),
     };
 }
-exports.requiredTargetAndQuantityFromOptions = requiredTargetAndQuantityFromOptions;
 function redelegateParamsFromOptions(options) {
     const { target, arioQuantity: aRIOQuantity } = requiredTargetAndQuantityFromOptions(options);
     const source = options.source;
@@ -314,7 +314,6 @@ function redelegateParamsFromOptions(options) {
         stakeQty: aRIOQuantity.toMARIO(),
     };
 }
-exports.redelegateParamsFromOptions = redelegateParamsFromOptions;
 function recordTypeFromOptions(options) {
     options.type ??= 'lease';
     if (options.type !== 'lease' && options.type !== 'permabuy') {
@@ -322,18 +321,13 @@ function recordTypeFromOptions(options) {
     }
     return options.type;
 }
-exports.recordTypeFromOptions = recordTypeFromOptions;
 function requiredMARIOFromOptions(options, key) {
     if (options[key] === undefined) {
         throw new Error(`No ${key} provided. Use --${key} denominated in ARIO`);
     }
     return new index_js_1.ARIOToken(+options[key]).toMARIO();
 }
-exports.requiredMARIOFromOptions = requiredMARIOFromOptions;
 async function assertEnoughBalanceForArNSPurchase({ ario, address, costDetailsParams, }) {
-    if (costDetailsParams.fundFrom === 'turbo') {
-        return;
-    }
     const costDetails = await ario.getCostDetails(costDetailsParams);
     if (costDetails.fundingPlan) {
         if (costDetails.fundingPlan.shortfall > 0) {
@@ -348,7 +342,6 @@ async function assertEnoughBalanceForArNSPurchase({ ario, address, costDetailsPa
         });
     }
 }
-exports.assertEnoughBalanceForArNSPurchase = assertEnoughBalanceForArNSPurchase;
 async function assertEnoughMARIOBalance({ address, ario, mARIOQuantity, }) {
     if (typeof mARIOQuantity === 'number') {
         mARIOQuantity = new index_js_1.mARIOToken(mARIOQuantity);
@@ -358,7 +351,6 @@ async function assertEnoughMARIOBalance({ address, ario, mARIOQuantity, }) {
         throw new Error(`Insufficient ARIO balance for action. Balance available: ${formatMARIOToARIOWithCommas(new index_js_1.mARIOToken(balance))} ARIO`);
     }
 }
-exports.assertEnoughMARIOBalance = assertEnoughMARIOBalance;
 async function confirmationPrompt(message) {
     const { confirm } = await (0, prompts_1.default)({
         type: 'confirm',
@@ -367,21 +359,18 @@ async function confirmationPrompt(message) {
     });
     return confirm;
 }
-exports.confirmationPrompt = confirmationPrompt;
 async function assertConfirmationPrompt(message, options) {
     if (options.skipConfirmation) {
         return true;
     }
     return confirmationPrompt(message);
 }
-exports.assertConfirmationPrompt = assertConfirmationPrompt;
 function requiredProcessIdFromOptions(o) {
     if (o.processId === undefined) {
         throw new Error('--process-id is required');
     }
     return o.processId;
 }
-exports.requiredProcessIdFromOptions = requiredProcessIdFromOptions;
 function ANTProcessFromOptions(options) {
     return new index_js_1.AOProcess({
         processId: requiredProcessIdFromOptions(options),
@@ -395,7 +384,6 @@ function readANTFromOptions(options) {
         process: ANTProcessFromOptions(options),
     });
 }
-exports.readANTFromOptions = readANTFromOptions;
 function writeANTFromOptions(options, signer) {
     signer ??= requiredContractSignerFromOptions(options).signer;
     return index_js_1.ANT.init({
@@ -403,11 +391,9 @@ function writeANTFromOptions(options, signer) {
         signer,
     });
 }
-exports.writeANTFromOptions = writeANTFromOptions;
 function booleanFromOptions(options, key) {
     return !!options[key];
 }
-exports.booleanFromOptions = booleanFromOptions;
 function requiredStringFromOptions(options, key) {
     const value = options[key];
     if (value === undefined) {
@@ -415,7 +401,6 @@ function requiredStringFromOptions(options, key) {
     }
     return value;
 }
-exports.requiredStringFromOptions = requiredStringFromOptions;
 function requiredStringArrayFromOptions(options, key) {
     const value = options[key];
     if (value === undefined) {
@@ -426,7 +411,6 @@ function requiredStringArrayFromOptions(options, key) {
     }
     return value;
 }
-exports.requiredStringArrayFromOptions = requiredStringArrayFromOptions;
 function positiveIntegerFromOptions(options, key) {
     const value = options[key];
     if (value === undefined) {
@@ -438,7 +422,6 @@ function positiveIntegerFromOptions(options, key) {
     }
     return numberValue;
 }
-exports.positiveIntegerFromOptions = positiveIntegerFromOptions;
 function requiredPositiveIntegerFromOptions(options, key) {
     const value = positiveIntegerFromOptions(options, key);
     if (value === undefined) {
@@ -446,7 +429,6 @@ function requiredPositiveIntegerFromOptions(options, key) {
     }
     return value;
 }
-exports.requiredPositiveIntegerFromOptions = requiredPositiveIntegerFromOptions;
 function getANTStateFromOptions(options) {
     return (0, index_js_1.initANTStateForAddress)({
         owner: requiredAddressFromOptions(options),
@@ -462,7 +444,6 @@ function getANTStateFromOptions(options) {
             : exports.defaultTtlSecondsCLI,
     });
 }
-exports.getANTStateFromOptions = getANTStateFromOptions;
 function getTokenCostParamsFromOptions(o) {
     o.intent ??= 'Buy-Name';
     o.type ??= 'lease';
@@ -482,7 +463,6 @@ function getTokenCostParamsFromOptions(o) {
         fromAddress: addressFromOptions(o),
     };
 }
-exports.getTokenCostParamsFromOptions = getTokenCostParamsFromOptions;
 function fundFromFromOptions(o) {
     if (o.fundFrom !== undefined) {
         if (!(0, index_js_1.isValidFundFrom)(o.fundFrom)) {
@@ -491,7 +471,6 @@ function fundFromFromOptions(o) {
     }
     return o.fundFrom ?? 'balance';
 }
-exports.fundFromFromOptions = fundFromFromOptions;
 function assertLockLengthInRange(lockLengthMs, assertMin = true) {
     const minLockLengthMs = 1209600000; // 14 days
     const maxLockLengthMs = 378432000000; // ~12 years
@@ -505,4 +484,3 @@ function assertLockLengthInRange(lockLengthMs, assertMin = true) {
         throw new Error(`Lock length must be at least 14 days (1209600000 ms). Provided lock length: ${lockLengthMs} ms`);
     }
 }
-exports.assertLockLengthInRange = assertLockLengthInRange;

package/lib/cjs/common/ant-versions.js

@@ -75,14 +75,14 @@ class ANTVersionsWritable extends ANTVersionsReadable {
         super(config);
         this.signer = (0, ao_js_1.createAoSigner)(signer);
     }
-    async addVersion({ version, moduleId, luaSourceId, notes, }, { tags }) {
+    async addVersion(params, { tags }) {
         return this.process.send({
             tags: (0, arweave_js_1.pruneTags)([
                 { name: 'Action', value: 'Add-Version' },
-                { name: 'Version', value: version },
-                { name: 'Module-Id', value: moduleId },
-                { name: 'Lua-Source-Id', value: luaSourceId },
-                { name: 'Notes', value: notes },
+                { name: 'Version', value: params.version },
+                { name: 'Module-Id', value: params.moduleId },
+                { name: 'Lua-Source-Id', value: params.luaSourceId },
+                { name: 'Notes', value: params.notes },
                 ...(tags ?? []),
             ]),
             signer: this.signer,

package/lib/cjs/common/faucet.js

@@ -0,0 +1,150 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ARIOTokenFaucet = void 0;
+exports.createFaucet = createFaucet;
+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;
+}
+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);