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

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,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ARIOWriteable = exports.ARIOReadable = exports.ARIO = void 0;
+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 +19,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 +83,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,
             });

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.2';

package/lib/esm/common/faucet.js

@@ -0,0 +1,145 @@
+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
+ */
+export 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;
+}
+export 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;
+    }
+}

package/lib/esm/common/index.js

@@ -18,6 +18,7 @@ export * from './logger.js';
 export * from './ant.js';
 export * from './ant-registry.js';
 export * from './ant-versions.js';
+export * from './faucet.js';
 // ao
 export * from './io.js';
 export * from './contracts/ao-process.js';

package/lib/esm/common/io.js

@@ -1,10 +1,12 @@
-import { ARIO_MAINNET_PROCESS_ID } from '../constants.js';
-import { isProcessConfiguration, isProcessIdConfiguration, } from '../types/io.js';
+import { connect } from '@permaweb/aoconnect';
+import { ARIO_MAINNET_PROCESS_ID, ARIO_TESTNET_PROCESS_ID, } from '../constants.js';
+import { isProcessConfiguration, isProcessIdConfiguration, } from '../types/index.js';
 import { createAoSigner } from '../utils/ao.js';
 import { getEpochDataFromGqlWithCUFallback, paginationParamsToTags, pruneTags, removeEligibleRewardsFromEpochData, sortAndPaginateEpochDataIntoEligibleDistributions, } from '../utils/arweave.js';
 import { defaultArweave } from './arweave.js';
 import { AOProcess } from './contracts/ao-process.js';
 import { InvalidContractConfigurationError } from './error.js';
+import { createFaucet } from './faucet.js';
 import { TurboArNSPaymentProvider } from './turbo.js';
 export class ARIO {
     // Implementation
@@ -14,6 +16,56 @@ export class ARIO {
         }
         return new ARIOReadable(config);
     }
+    static mainnet(config) {
+        if (config !== undefined && 'signer' in config) {
+            return new ARIOWriteable({
+                ...config,
+                process: new AOProcess({
+                    processId: ARIO_MAINNET_PROCESS_ID,
+                    ao: connect({
+                        CU_URL: 'https://cu.ardrive.io',
+                        ...config?.process?.ao,
+                    }),
+                }),
+            });
+        }
+        return new ARIOReadable({
+            ...config,
+            process: new AOProcess({
+                processId: ARIO_MAINNET_PROCESS_ID,
+            }),
+        });
+    }
+    static testnet(config) {
+        if (config !== undefined && 'signer' in config) {
+            return createFaucet({
+                arioInstance: new ARIOWriteable({
+                    ...config,
+                    process: new AOProcess({
+                        processId: ARIO_TESTNET_PROCESS_ID,
+                        ao: connect({
+                            CU_URL: 'https://cu.ardrive.io',
+                            ...config?.process?.ao,
+                        }),
+                    }),
+                }),
+                faucetApiUrl: config?.faucetUrl,
+            });
+        }
+        return createFaucet({
+            arioInstance: new ARIOReadable({
+                ...config,
+                process: new AOProcess({
+                    processId: ARIO_TESTNET_PROCESS_ID,
+                    ao: connect({
+                        CU_URL: 'https://cu.ardrive.io',
+                        ...config?.process?.ao,
+                    }),
+                }),
+            }),
+            faucetApiUrl: config?.faucetUrl,
+        });
+    }
 }
 export class ARIOReadable {
     process;

package/lib/esm/types/faucet.js

@@ -0,0 +1 @@
+export {};

package/lib/esm/types/index.js

@@ -16,5 +16,6 @@
 export * from './ant-registry.js';
 export * from './ant.js';
 export * from './common.js';
+export * from './faucet.js';
 export * from './io.js';
 export * from './token.js';

package/lib/esm/types/io.js

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

package/lib/esm/utils/ao.js

@@ -131,6 +131,8 @@ export function createAoSigner(signer) {
         }));
         return signedData;
     };
+    // eslint-disable-next-line
+    // @ts-ignore Buffer vs ArrayBuffer type mismatch
     return aoSigner;
 }
 export const defaultTargetManifestId = '-k7t8xMoB8hW482609Z9F4bTFMC3MnuW8bTvTyT8pFI';

package/lib/esm/version.js

@@ -14,4 +14,4 @@
  * limitations under the License.
  */
 // AUTOMATICALLY GENERATED FILE - DO NOT TOUCH
-export const version = '3.10.0-alpha.1';
+export const version = '3.10.0-alpha.2';

package/lib/types/cli/utils.d.ts

@@ -80,7 +80,7 @@ export declare function positiveIntegerFromOptions<O extends GlobalCLIOptions>(o
 export declare function requiredPositiveIntegerFromOptions<O extends GlobalCLIOptions>(options: O, key: string): number;
 export declare function getANTStateFromOptions(options: ANTStateCLIOptions): SpawnANTState;
 export declare function getTokenCostParamsFromOptions(o: GetTokenCostCLIOptions): {
-    type: "permabuy" | "lease";
+    type: "lease" | "permabuy";
     quantity: number | undefined;
     years: number;
     intent: "Buy-Name" | "Buy-Record" | "Extend-Lease" | "Increase-Undername-Limit" | "Upgrade-Name" | "Primary-Name-Request";

package/lib/types/common/faucet.d.ts

@@ -0,0 +1,96 @@
+/**
+ * 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.
+ */
+import { ARIOWithFaucet, TokenFaucet } from '../types/faucet.js';
+import { ARIOReadable, ARIOWriteable } from './io.js';
+/**
+ * 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
+ */
+export declare function createFaucet({ arioInstance, faucetApiUrl, }: {
+    arioInstance: ARIOReadable | ARIOWriteable;
+    faucetApiUrl?: string;
+}): ARIOWithFaucet<ARIOReadable | ARIOWriteable>;
+export declare class ARIOTokenFaucet implements TokenFaucet {
+    private faucetUrl;
+    private processId;
+    constructor({ faucetUrl, processId, }: {
+        faucetUrl: string;
+        processId: string;
+    });
+    /**
+     * 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
+     */
+    captchaUrl(): Promise<{
+        processId: string;
+        captchaUrl: string;
+    }>;
+    /**
+     * 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
+     */
+    claimWithCaptchaResponse({ captchaResponse, recipient, quantity, }: {
+        captchaResponse: string;
+        recipient: string;
+        quantity: number;
+    }): Promise<{
+        id: string;
+        success: boolean;
+    }>;
+    /**
+     * 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
+     */
+    requestAuthToken({ captchaResponse, }: {
+        captchaResponse: string;
+    }): Promise<{
+        status: 'success' | 'error';
+        token: string;
+        expiresAt: number;
+    }>;
+    /**
+     * 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
+     */
+    claimWithAuthToken({ authToken, recipient, quantity, }: {
+        authToken: string;
+        recipient: string;
+        quantity: number;
+    }): Promise<{
+        id: string;
+        success: boolean;
+    }>;
+    /**
+     * Verifies an authorization token is valid.
+     * @param authToken - The authorization token
+     * @returns The validity of the authorization token and the expiration time
+     */
+    verifyAuthToken({ authToken }: {
+        authToken: string;
+    }): Promise<{
+        valid: boolean;
+        expiresAt: number;
+    }>;
+}

package/lib/types/common/index.d.ts

@@ -18,5 +18,6 @@ export * from './logger.js';
 export * from './ant.js';
 export * from './ant-registry.js';
 export * from './ant-versions.js';
+export * from './faucet.js';
 export * from './io.js';
 export * from './contracts/ao-process.js';