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

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

@@ -1,7 +1,5 @@
 import Arweave from 'arweave';
-import { AoArNSNameDataWithName, AoArNSReservedNameData, AoBalanceWithAddress, AoEpochDistributionData, AoEpochObservationData, AoGatewayWithAddress, AoJoinNetworkParams, AoMessageResult, AoPrimaryName, AoPrimaryNameRequest, AoRedelegationFeeInfo, AoReturnedName, AoTokenSupplyData, AoUpdateGatewaySettingsParams, AoWeightedObserver, OptionalArweave, OptionalPaymentUrl, PaginationParams, PaginationResult, ProcessConfiguration, TransactionId, WalletAddress, WithSigner, WriteOptions } from '../types/index.js';
-import { AoARIORead, AoARIOWrite, AoAllDelegates, AoAllGatewayVaults, AoArNSNameData, AoArNSPurchaseParams, AoArNSReservedNameDataWithName, AoBuyRecordParams, AoCreateVaultParams, AoDelegation, AoEligibleDistribution, AoEpochData, AoEpochDistributed, AoEpochDistributionTotalsData, AoEpochSettings, AoExtendLeaseParams, AoExtendVaultParams, AoGateway, AoGatewayDelegateWithAddress, AoGatewayRegistrySettings, AoGatewayVault, AoGetCostDetailsParams, AoIncreaseUndernameLimitParams, AoIncreaseVaultParams, AoPaginatedAddressParams, AoRegistrationFees, AoRevokeVaultParams, AoVaultData, AoVaultedTransferParams, AoWalletVault, CostDetailsResult, DemandFactorSettings, EpochInput } from '../types/io.js';
-import { mARIOToken } from '../types/token.js';
+import { ARIOWithFaucet, AoARIORead, AoARIOWrite, AoAllDelegates, AoAllGatewayVaults, AoArNSNameData, AoArNSNameDataWithName, AoArNSPurchaseParams, AoArNSReservedNameData, AoArNSReservedNameDataWithName, AoBalanceWithAddress, AoBuyRecordParams, AoCreateVaultParams, AoDelegation, AoEligibleDistribution, AoEpochData, AoEpochDistributed, AoEpochDistributionData, AoEpochDistributionTotalsData, AoEpochObservationData, AoEpochSettings, AoExtendLeaseParams, AoExtendVaultParams, AoGateway, AoGatewayDelegateWithAddress, AoGatewayRegistrySettings, AoGatewayVault, AoGatewayWithAddress, AoGetCostDetailsParams, AoIncreaseUndernameLimitParams, AoIncreaseVaultParams, AoJoinNetworkParams, AoMessageResult, AoPaginatedAddressParams, AoPrimaryName, AoPrimaryNameRequest, AoRedelegationFeeInfo, AoRegistrationFees, AoReturnedName, AoRevokeVaultParams, AoTokenSupplyData, AoUpdateGatewaySettingsParams, AoVaultData, AoVaultedTransferParams, AoWalletVault, AoWeightedObserver, CostDetailsResult, DemandFactorSettings, EpochInput, OptionalArweave, OptionalPaymentUrl, PaginationParams, PaginationResult, ProcessConfiguration, TransactionId, WalletAddress, WithSigner, WriteOptions, mARIOToken } from '../types/index.js';
 import { AOProcess } from './contracts/ao-process.js';
 import { TurboArNSPaymentProvider } from './turbo.js';
 type ARIOConfigNoSigner = OptionalPaymentUrl<OptionalArweave<ProcessConfiguration>>;
@@ -10,9 +8,23 @@ export declare class ARIO {
     static init(): AoARIORead;
     static init(config: ARIOConfigWithSigner): AoARIOWrite;
     static init(config: ARIOConfigNoSigner): AoARIORead;
+    static mainnet(): AoARIORead;
+    static mainnet(config: ARIOConfigNoSigner & {
+        faucetUrl?: string;
+    }): AoARIORead;
+    static mainnet(config: ARIOConfigWithSigner & {
+        faucetUrl?: string;
+    }): AoARIOWrite;
+    static testnet(): ARIOWithFaucet<AoARIORead>;
+    static testnet(config: ARIOConfigNoSigner & {
+        faucetUrl?: string;
+    }): ARIOWithFaucet<AoARIORead>;
+    static testnet(config: ARIOConfigWithSigner & {
+        faucetUrl?: string;
+    }): ARIOWithFaucet<AoARIOWrite>;
 }
 export declare class ARIOReadable implements AoARIORead {
-    protected process: AOProcess;
+    readonly process: AOProcess;
     protected epochSettings: AoEpochSettings | undefined;
     protected arweave: Arweave;
     protected paymentProvider: TurboArNSPaymentProvider;
@@ -129,7 +141,7 @@ export declare class ARIOReadable implements AoARIORead {
     getAllGatewayVaults(params?: PaginationParams<AoAllGatewayVaults>): Promise<PaginationResult<AoAllGatewayVaults>>;
 }
 export declare class ARIOWriteable extends ARIOReadable implements AoARIOWrite {
-    protected process: AOProcess;
+    readonly process: AOProcess;
     private signer;
     protected paymentProvider: TurboArNSPaymentProvider;
     constructor({ signer, paymentUrl, ...config }: ARIOConfigWithSigner);

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

@@ -0,0 +1,82 @@
+/**
+ * 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 { AoARIORead, AoARIOWrite } from './io.js';
+export type ARIOWithFaucet<T extends AoARIORead | AoARIOWrite> = T & {
+    faucet: TokenFaucet;
+};
+export interface TokenFaucet {
+    /**
+     * 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;
+    }>;
+    /**
+     * 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;
+    }>;
+    /**
+     * 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/types/index.d.ts

@@ -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/types/types/io.d.ts

@@ -535,7 +535,7 @@ export interface AoARIOWrite extends AoARIORead {
     requestPrimaryName: AoWriteAction<AoArNSPurchaseParams>;
     redelegateStake: AoWriteAction<AoRedelegateStakeParams>;
 }
-export declare function isProcessConfiguration(config: object): config is Required<ProcessConfiguration> & Record<string, never>;
-export declare function isProcessIdConfiguration(config: object): config is Required<ProcessIdConfig> & Record<string, never>;
+export declare function isProcessConfiguration(config: object | undefined): config is Required<ProcessConfiguration> & Record<string, never>;
+export declare function isProcessIdConfiguration(config: object | undefined): config is Required<ProcessIdConfig> & Record<string, never>;
 export declare function isLeasedArNSRecord(record: AoArNSNameData): record is AoArNSLeaseData;
 export {};

package/lib/types/version.d.ts

@@ -13,4 +13,4 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-export declare const version = "3.9.1";
+export declare const version = "3.10.0-alpha.1";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ar.io/sdk",
-  "version": "3.10.0-alpha.1",
+  "version": "3.10.0-alpha.2",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/ar-io/ar-io-sdk.git"
@@ -67,7 +67,7 @@
     "lint": "eslint src",
     "lint:fix": "eslint src --fix",
     "format": "prettier --check .",
-    "format:fix": "prettier --write .",
+    "format:fix": "prettier --write . && yarn docs:update",
     "test": "yarn test:unit && yarn test:e2e",
     "test:cjs": "yarn build:cjs && yarn link && cd ./tests/e2e/cjs && yarn && yarn test",
     "test:esm": "yarn build:esm && yarn link && cd ./tests/e2e/esm && yarn && yarn test",
@@ -77,7 +77,7 @@
     "test:e2e": "yarn test:cjs && yarn test:esm && yarn test:web",
     "test:integration": "yarn build:esm && yarn link && cd ./tests/integration && yarn && yarn test",
     "prepare": "husky install",
-    "docs:update": "markdown-toc-gen insert README.md",
+    "docs:update": "markdown-toc-gen insert README.md --max-depth 2",
     "example:esm": "cd examples/esm && yarn && node index.mjs",
     "example:cjs": "yarn build:cjs && yarn link && cd examples/cjs && yarn && node index.cjs",
     "example:web": "yarn build:web && http-server --port 8080 --host -o examples/web",
@@ -121,8 +121,7 @@
     "sinon": "^15.2.0",
     "testcontainers": "^10.13.1",
     "ts-node": "^10.9.2",
-    "typescript": "^5.1.6",
-    "vite-plugin-node-polyfills": "^0.22.0"
+    "typescript": "^5.1.6"
   },
   "dependencies": {
     "@dha-team/arbundles": "^1.0.1",
@@ -143,7 +142,7 @@
       "prettier --write ."
     ],
     "**/README.md": [
-      "markdown-toc-gen insert"
+      "markdown-toc-gen insert --max-depth 2"
     ]
   }
 }