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

package/lib/esm/utils/url.js

@@ -0,0 +1,24 @@
+/**
+ * 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.
+ */
+export const urlWithSearchParams = ({ baseUrl, params, }) => {
+    const urlObj = new URL(baseUrl);
+    Object.entries(params).forEach(([key, value]) => {
+        if (value === undefined || value === null)
+            return;
+        urlObj.searchParams.set(key, value.toString());
+    });
+    return urlObj.toString();
+};

package/lib/esm/utils/url.test.js

@@ -0,0 +1,19 @@
+import assert from 'node:assert';
+import { test } from 'node:test';
+import { urlWithSearchParams } from './url.js';
+test('urlWithSearchParams prunes undefined values but keeps other falsey values', () => {
+    const result = urlWithSearchParams({
+        baseUrl: 'https://example.com',
+        params: {
+            number: 1,
+            string: 'string',
+            boolean: true,
+            empty: '',
+            zero: 0,
+            false: false,
+            null: null,
+            undef: undefined,
+        },
+    });
+    assert.strictEqual(result, 'https://example.com/?number=1&string=string&boolean=true&empty=&zero=0&false=false');
+});

package/lib/esm/utils/utils.test.js

@@ -1,7 +1,7 @@
 import { strict as assert } from 'node:assert';
 import { describe, it } from 'node:test';
+import { errorMessageFromOutput } from './ao.js';
 import { pruneTags, sortAndPaginateEpochDataIntoEligibleDistributions, } from './arweave.js';
-import { errorMessageFromOutput } from './index.js';
 describe('pruneTags', () => {
     it('should remove tags with undefined values', () => {
         const tags = [

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';
+export const version = '3.11.0-alpha.1';

package/lib/esm/web/index.js

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-export { ArweaveSigner, ArconnectSigner } from '@dha-team/arbundles';
+export { ArweaveSigner, ArconnectSigner, InjectedEthereumSigner, EthereumSigner, } from '@dha-team/arbundles';
 export * from '../types/index.js';
 export * from '../common/index.js';
 export * from '../constants.js';

package/lib/types/cli/commands/antCommands.d.ts

@@ -16,6 +16,6 @@
 import { AoANTSetBaseNameRecordParams, AoANTSetUndernameRecordParams } from '../../types/ant.js';
 import { CLIWriteOptionsFromAoAntParams } from '../types.js';
 /** @deprecated -- use set-ant-base-name and set-ant-undername */
-export declare function setAntRecordCLICommand(o: CLIWriteOptionsFromAoAntParams<AoANTSetUndernameRecordParams>): Promise<import("../../types/common.js").AoMessageResult>;
-export declare function setAntBaseNameCLICommand(o: CLIWriteOptionsFromAoAntParams<AoANTSetBaseNameRecordParams>): Promise<import("../../types/common.js").AoMessageResult>;
-export declare function setAntUndernameCLICommand(o: CLIWriteOptionsFromAoAntParams<AoANTSetUndernameRecordParams>): Promise<import("../../types/common.js").AoMessageResult>;
+export declare function setAntRecordCLICommand(o: CLIWriteOptionsFromAoAntParams<AoANTSetUndernameRecordParams>): Promise<import("../../types/common.js").AoMessageResult<Record<string, string | number | boolean | null>>>;
+export declare function setAntBaseNameCLICommand(o: CLIWriteOptionsFromAoAntParams<AoANTSetBaseNameRecordParams>): Promise<import("../../types/common.js").AoMessageResult<Record<string, string | number | boolean | null>>>;
+export declare function setAntUndernameCLICommand(o: CLIWriteOptionsFromAoAntParams<AoANTSetUndernameRecordParams>): Promise<import("../../types/common.js").AoMessageResult<Record<string, string | number | boolean | null>>>;

package/lib/types/cli/commands/arnsPurchaseCommands.d.ts

@@ -19,4 +19,4 @@ export declare function buyRecordCLICommand(o: CLIWriteOptionsFromAoParams<AoBuy
 export declare function upgradeRecordCLICommand(o: CLIWriteOptionsFromAoParams<AoArNSPurchaseParams>): Promise<import("../../types/common.js").AoMessageResult>;
 export declare function extendLeaseCLICommand(o: CLIWriteOptionsFromAoParams<AoExtendLeaseParams>): Promise<import("../../types/common.js").AoMessageResult>;
 export declare function increaseUndernameLimitCLICommand(o: CLIWriteOptionsFromAoParams<AoIncreaseUndernameLimitParams>): Promise<import("../../types/common.js").AoMessageResult>;
-export declare function requestPrimaryNameCLICommand(o: CLIWriteOptionsFromAoParams<AoArNSPurchaseParams>): Promise<import("../../types/common.js").AoMessageResult>;
+export declare function requestPrimaryNameCLICommand(o: CLIWriteOptionsFromAoParams<AoArNSPurchaseParams>): Promise<import("../../types/common.js").AoMessageResult<Record<string, string | number | boolean | null>>>;

package/lib/types/cli/commands/gatewayWriteCommands.d.ts

@@ -1,11 +1,11 @@
 import { AddressAndVaultIdCLIWriteOptions, DecreaseDelegateStakeCLIOptions, JoinNetworkCLIOptions, OperatorStakeCLIOptions, RedelegateStakeCLIOptions, TransferCLIOptions, UpdateGatewaySettingsCLIOptions, WriteActionCLIOptions } from '../types.js';
 export declare function joinNetwork(options: JoinNetworkCLIOptions): Promise<{
-    joinNetworkResult: import("../../types/common.js").AoMessageResult;
+    joinNetworkResult: import("../../types/common.js").AoMessageResult<Record<string, string | number | boolean | null>>;
     joinedAddress: string;
     message: string;
 }>;
 export declare function updateGatewaySettings(options: UpdateGatewaySettingsCLIOptions): Promise<{
-    updateGatewaySettingsResult: import("../../types/common.js").AoMessageResult;
+    updateGatewaySettingsResult: import("../../types/common.js").AoMessageResult<Record<string, string | number | boolean | null>>;
     updatedGatewayAddress: string;
     message: string;
 }>;
@@ -13,26 +13,26 @@ export declare function leaveNetwork(options: WriteActionCLIOptions): Promise<im
 export declare function saveObservations(o: WriteActionCLIOptions & {
     failedGateways?: string[];
     transactionId?: string;
-}): Promise<import("../../types/common.js").AoMessageResult>;
+}): Promise<import("../../types/common.js").AoMessageResult<Record<string, string | number | boolean | null>>>;
 export declare function increaseOperatorStake(o: OperatorStakeCLIOptions): Promise<import("../../types/common.js").WriteOptions>;
-export declare function decreaseOperatorStake(o: OperatorStakeCLIOptions): Promise<import("../../types/common.js").AoMessageResult>;
-export declare function instantWithdrawal(o: AddressAndVaultIdCLIWriteOptions): Promise<import("../../types/common.js").AoMessageResult>;
-export declare function cancelWithdrawal(o: AddressAndVaultIdCLIWriteOptions): Promise<import("../../types/common.js").AoMessageResult>;
+export declare function decreaseOperatorStake(o: OperatorStakeCLIOptions): Promise<import("../../types/common.js").AoMessageResult<Record<string, string | number | boolean | null>>>;
+export declare function instantWithdrawal(o: AddressAndVaultIdCLIWriteOptions): Promise<import("../../types/common.js").AoMessageResult<Record<string, string | number | boolean | null>>>;
+export declare function cancelWithdrawal(o: AddressAndVaultIdCLIWriteOptions): Promise<import("../../types/common.js").AoMessageResult<Record<string, string | number | boolean | null>>>;
 export declare function delegateStake(options: TransferCLIOptions): Promise<{
     senderAddress: string;
-    transferResult: import("../../types/common.js").AoMessageResult;
+    transferResult: import("../../types/common.js").AoMessageResult<Record<string, string | number | boolean | null>>;
     message: string;
 } | {
     message: string;
 }>;
 export declare function decreaseDelegateStake(options: DecreaseDelegateStakeCLIOptions): Promise<{
     targetGateway: string;
-    decreaseDelegateStakeResult: import("../../types/common.js").AoMessageResult;
+    decreaseDelegateStakeResult: import("../../types/common.js").AoMessageResult<Record<string, string | number | boolean | null>>;
     message: string;
 }>;
 export declare function redelegateStake(options: RedelegateStakeCLIOptions): Promise<{
     sourceGateway: string;
     targetGateway: string;
-    redelegateStakeResult: import("../../types/common.js").AoMessageResult;
+    redelegateStakeResult: import("../../types/common.js").AoMessageResult<Record<string, string | number | boolean | null>>;
     message: string;
 }>;

package/lib/types/cli/commands/readCommands.d.ts

@@ -58,6 +58,7 @@ export declare function getCostDetails(o: GlobalCLIOptions & CLIOptionsFromAoPar
         basePrice: number;
     };
     fundingPlan?: import("../../types/io.js").AoFundingPlan;
+    wincQty?: string;
 }>;
 export declare function getPrimaryName(o: AddressAndNameCLIOptions): Promise<import("../../types/common.js").AoPrimaryName>;
 export declare function getGatewayVaults(o: PaginationAddressCLIOptions): Promise<import("../../types/io.js").PaginationResult<AoGatewayVault> | {

package/lib/types/cli/commands/transfer.d.ts

@@ -17,7 +17,7 @@ import { AoCreateVaultParams, AoExtendVaultParams, AoIncreaseVaultParams, AoRevo
 import { CLIWriteOptionsFromAoParams, JsonSerializable, TransferCLIOptions } from '../types.js';
 export declare function transferCLICommand(options: TransferCLIOptions): Promise<{
     senderAddress: string;
-    transferResult: import("../../types/common.js").AoMessageResult;
+    transferResult: import("../../types/common.js").AoMessageResult<Record<string, string | number | boolean | null>>;
     message: string;
 } | {
     message: string;
@@ -27,14 +27,14 @@ export declare function revokeVaultCLICommand(o: CLIWriteOptionsFromAoParams<AoR
 export declare function createVaultCLICommand(o: CLIWriteOptionsFromAoParams<AoCreateVaultParams>): Promise<JsonSerializable>;
 export declare function extendVaultCLICommand(o: CLIWriteOptionsFromAoParams<AoExtendVaultParams>): Promise<{
     senderAddress: string;
-    transferResult: import("../../types/common.js").AoMessageResult;
+    transferResult: import("../../types/common.js").AoMessageResult<Record<string, string | number | boolean | null>>;
     message: string;
 } | {
     message: string;
 }>;
 export declare function increaseVaultCLICommand(o: CLIWriteOptionsFromAoParams<AoIncreaseVaultParams>): Promise<{
     senderAddress: string;
-    transferResult: import("../../types/common.js").AoMessageResult;
+    transferResult: import("../../types/common.js").AoMessageResult<Record<string, string | number | boolean | null>>;
     message: string;
 } | {
     message: string;

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

@@ -45,6 +45,10 @@ export declare const optionMap: {
         alias: string;
         description: string;
     };
+    paymentUrl: {
+        alias: string;
+        description: string;
+    };
     processId: {
         alias: string;
         description: string;
@@ -265,6 +269,11 @@ export declare const optionMap: {
         alias: string;
         description: string;
     };
+    token: {
+        alias: string;
+        description: string;
+        default: string;
+    };
 };
 export declare const walletOptions: {
     alias: string;

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

@@ -14,8 +14,10 @@
  * limitations under the License.
  */
 import { AoAddressParams, AoArNSNameParams, AoGetVaultParams, AoJoinNetworkParams, AoTokenCostParams, PaginationParams } from '../types/io.js';
+export type SupportedCLITokenType = 'ethereum' | 'arweave';
 export type WalletCLIOptions = {
     walletFile?: string;
+    token?: SupportedCLITokenType;
     privateKey?: string;
 };
 export type GlobalCLIOptions = WalletCLIOptions & {
@@ -25,6 +27,7 @@ export type GlobalCLIOptions = WalletCLIOptions & {
     debug: boolean;
     arioProcessId?: string;
     cuUrl?: string;
+    paymentUrl?: string;
 };
 export type WriteActionCLIOptions = GlobalCLIOptions & {
     tags?: string[];

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

@@ -22,6 +22,10 @@ export declare function requiredJwkFromOptions(options: WalletCLIOptions): JWKIn
 export declare function jwkToAddress(jwk: JWKInterface): string;
 export declare function getLoggerFromOptions(options: GlobalCLIOptions): Logger;
 export declare function readARIOFromOptions(options: GlobalCLIOptions): AoARIORead;
+export declare function contractSignerFromOptions(options: WalletCLIOptions): {
+    signer: ContractSigner;
+    signerAddress: string;
+} | undefined;
 export declare function requiredContractSignerFromOptions(options: WalletCLIOptions): {
     signer: ContractSigner;
     signerAddress: string;

package/lib/types/common/ant-versions.d.ts

@@ -1,5 +1,5 @@
 import { AoANTVersionsRead, AoANTVersionsWrite } from '../types/ant.js';
-import { WithSigner } from '../types/common.js';
+import { AoMessageResult, WithSigner } from '../types/common.js';
 import { ProcessConfiguration } from '../types/io.js';
 import { AOProcess } from './contracts/ao-process.js';
 type ANTVersionsNoSigner = ProcessConfiguration;
@@ -27,16 +27,13 @@ export declare class ANTVersionsReadable implements AoANTVersionsRead {
 export declare class ANTVersionsWritable extends ANTVersionsReadable implements AoANTVersionsWrite {
     private signer;
     constructor({ signer, ...config }: WithSigner<ProcessConfiguration>);
-    addVersion(params: {
+    addVersion({ version, moduleId, luaSourceId, notes, }: {
         version: string;
         moduleId: string;
         luaSourceId?: string;
         notes?: string;
     }, { tags }: {
         tags: any;
-    }): Promise<{
-        id: string;
-        result?: unknown;
-    }>;
+    }): Promise<AoMessageResult>;
 }
 export {};

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

@@ -21,3 +21,4 @@ export * from './ant-versions.js';
 export * from './faucet.js';
 export * from './io.js';
 export * from './contracts/ao-process.js';
+export * from './wayfinder/index.js';

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

@@ -1,8 +1,9 @@
 import Arweave from 'arweave';
-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, PaginationParams, PaginationResult, ProcessConfiguration, TransactionId, WalletAddress, WithSigner, WriteOptions, mARIOToken } from '../types/index.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';
-type ARIOConfigNoSigner = OptionalArweave<ProcessConfiguration>;
-type ARIOConfigWithSigner = WithSigner<OptionalArweave<ProcessConfiguration>>;
+import { TurboArNSPaymentProviderAuthenticated, TurboArNSPaymentProviderUnauthenticated } from './turbo.js';
+type ARIOConfigNoSigner = OptionalPaymentUrl<OptionalArweave<ProcessConfiguration>>;
+type ARIOConfigWithSigner = WithSigner<OptionalPaymentUrl<OptionalArweave<ProcessConfiguration>>>;
 export declare class ARIO {
     static init(): AoARIORead;
     static init(config: ARIOConfigWithSigner): AoARIOWrite;
@@ -26,7 +27,8 @@ export declare class ARIOReadable implements AoARIORead {
     readonly process: AOProcess;
     protected epochSettings: AoEpochSettings | undefined;
     protected arweave: Arweave;
-    constructor(config?: OptionalArweave<ProcessConfiguration>);
+    protected paymentProvider: TurboArNSPaymentProviderUnauthenticated;
+    constructor(config?: ARIOConfigNoSigner);
     getInfo(): Promise<{
         Name: string;
         Ticker: string;
@@ -41,8 +43,8 @@ export declare class ARIOReadable implements AoARIORead {
     private computeCurrentEpochIndex;
     private computeEpochIndex;
     getEpochSettings(): Promise<AoEpochSettings>;
-    getEpoch(epoch: EpochInput): Promise<AoEpochData<AoEpochDistributed>>;
     getEpoch(): Promise<AoEpochData<AoEpochDistributionTotalsData>>;
+    getEpoch(epoch: EpochInput): Promise<AoEpochData<AoEpochDistributed>>;
     getArNSRecord({ name }: {
         name: string;
     }): Promise<AoArNSNameData>;
@@ -139,9 +141,9 @@ export declare class ARIOReadable implements AoARIORead {
     getAllGatewayVaults(params?: PaginationParams<AoAllGatewayVaults>): Promise<PaginationResult<AoAllGatewayVaults>>;
 }
 export declare class ARIOWriteable extends ARIOReadable implements AoARIOWrite {
-    readonly process: AOProcess;
     private signer;
-    constructor({ signer, ...config }: ARIOConfigWithSigner);
+    protected paymentProvider: TurboArNSPaymentProviderAuthenticated | TurboArNSPaymentProviderUnauthenticated;
+    constructor({ signer, paymentUrl, ...config }: ARIOConfigWithSigner);
     transfer({ target, qty, }: {
         target: string;
         qty: number | mARIOToken;

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

@@ -0,0 +1,62 @@
+import { AxiosInstance, RawAxiosRequestHeaders } from 'axios';
+import { AoMessageResult, TransactionId, TurboArNSSigner } from '../types/common.js';
+import { AoTokenCostParams } from '../types/io.js';
+import { mARIOToken } from '../types/token.js';
+import { ILogger } from './logger.js';
+export interface TurboUnauthenticatedConfig {
+    paymentUrl?: string;
+    logger?: ILogger;
+    axios?: AxiosInstance;
+}
+export interface TurboAuthenticatedConfig extends TurboUnauthenticatedConfig {
+    signer: TurboArNSSigner;
+}
+export declare function signedRequestHeadersFromSigner({ signer, nonce, }: {
+    signer: TurboArNSSigner;
+    nonce?: string;
+}): Promise<RawAxiosRequestHeaders>;
+export type ArNSPurchaseReceipt = AoTokenCostParams & {
+    wincQty: string;
+    mARIOQty: string;
+    usdArRate: number;
+    createdDate: string;
+};
+export interface ArNSPaymentProvider {
+    /** Returns the cost of the action in the Payment Provider's native currency (winc for Turbo) */
+    getPrice(params: AoTokenCostParams): Promise<number>;
+    getArNSPriceDetails(params: AoTokenCostParams): Promise<{
+        winc: string;
+        mARIO: mARIOToken;
+    }>;
+}
+export interface ArNSAuthenticatedPaymentProvider extends ArNSPaymentProvider {
+    initiateArNSPurchase(params: AoTokenCostParams & {
+        processId?: TransactionId;
+    }): Promise<AoMessageResult<ArNSPurchaseReceipt>>;
+}
+export declare class TurboArNSPaymentFactory {
+    static init(): TurboArNSPaymentProviderUnauthenticated;
+    static init({ paymentUrl, axios, logger, }: TurboUnauthenticatedConfig & {
+        signer?: TurboArNSSigner;
+    }): TurboArNSPaymentProviderUnauthenticated;
+    static init({ signer, paymentUrl, axios, logger, }: TurboAuthenticatedConfig): TurboArNSPaymentProviderAuthenticated;
+}
+export declare class TurboArNSPaymentProviderUnauthenticated implements ArNSPaymentProvider {
+    protected readonly paymentUrl: string;
+    protected readonly axios: AxiosInstance;
+    protected readonly logger: ILogger;
+    constructor({ paymentUrl, axios, logger, }: TurboUnauthenticatedConfig);
+    getArNSPriceDetails({ intent, name, quantity, type, years, }: AoTokenCostParams): Promise<{
+        winc: string;
+        mARIO: mARIOToken;
+    }>;
+    getPrice(params: AoTokenCostParams): Promise<number>;
+}
+export declare class TurboArNSPaymentProviderAuthenticated extends TurboArNSPaymentProviderUnauthenticated implements ArNSAuthenticatedPaymentProvider {
+    private readonly signer;
+    constructor({ signer, ...restConfig }: TurboAuthenticatedConfig);
+    initiateArNSPurchase({ intent, name, quantity, type, processId, years, }: AoTokenCostParams & {
+        processId?: TransactionId;
+    }): Promise<AoMessageResult<ArNSPurchaseReceipt>>;
+}
+export declare function isTurboArNSSigner(signer: unknown): signer is TurboArNSSigner;

package/lib/types/common/wayfinder/gateways.d.ts

@@ -0,0 +1,44 @@
+/**
+ * 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, AoGatewayWithAddress } from '../../types/io.js';
+export interface GatewaysProvider {
+    getGateways(): Promise<AoGatewayWithAddress[]>;
+}
+export declare class ARIOGatewaysProvider implements GatewaysProvider {
+    private ario;
+    constructor({ ario }: {
+        ario: AoARIORead;
+    });
+    getGateways(): Promise<AoGatewayWithAddress[]>;
+}
+export declare class StaticGatewaysProvider implements GatewaysProvider {
+    private gateways;
+    constructor({ gateways }: {
+        gateways: AoGatewayWithAddress[];
+    });
+    getGateways(): Promise<AoGatewayWithAddress[]>;
+}
+export declare class SimpleCacheGatewaysProvider implements GatewaysProvider {
+    private gatewaysProvider;
+    private ttlSeconds;
+    private lastUpdated;
+    private gatewaysCache;
+    constructor({ gatewaysProvider, ttlSeconds, }: {
+        gatewaysProvider: GatewaysProvider;
+        ttlSeconds?: number;
+    });
+    getGateways(): Promise<AoGatewayWithAddress[]>;
+}

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

@@ -0,0 +1,19 @@
+/**
+ * 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.
+ */
+export * from './wayfinder.js';
+export * from './routers/random.js';
+export * from './routers/priority.js';
+export * from './routers/fixed.js';

package/lib/types/common/wayfinder/routers/fixed.d.ts

@@ -0,0 +1,24 @@
+/**
+ * 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 { WayfinderRouter } from '../../../types/wayfinder.js';
+export declare class FixedGatewayRouter implements WayfinderRouter {
+    readonly name = "fixed";
+    private gateway;
+    constructor({ gateway }: {
+        gateway: URL;
+    });
+    getTargetGateway(): Promise<URL>;
+}

package/lib/types/common/wayfinder/routers/fixed.test.d.ts

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

package/lib/types/common/wayfinder/routers/priority.d.ts

@@ -0,0 +1,33 @@
+/**
+ * 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 { WayfinderRouter } from '../../../types/wayfinder.js';
+import { GatewaysProvider } from '../gateways.js';
+export declare class PriorityGatewayRouter implements WayfinderRouter {
+    readonly name = "priority";
+    private gatewaysProvider;
+    private limit;
+    private sortBy;
+    private sortOrder;
+    private blocklist;
+    constructor({ gatewaysProvider, limit, sortBy, sortOrder, blocklist, }: {
+        gatewaysProvider: GatewaysProvider;
+        limit?: number;
+        sortBy?: 'totalDelegatedStake' | 'operatorStake' | 'startTimestamp';
+        sortOrder?: 'asc' | 'desc';
+        blocklist?: string[];
+    });
+    getTargetGateway(): Promise<URL>;
+}

package/lib/types/common/wayfinder/routers/priority.test.d.ts

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

package/lib/types/common/wayfinder/routers/random.d.ts

@@ -0,0 +1,27 @@
+/**
+ * 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 { WayfinderRouter } from '../../../types/wayfinder.js';
+import { GatewaysProvider } from '../gateways.js';
+export declare class RandomGatewayRouter implements WayfinderRouter {
+    readonly name = "random";
+    private gatewaysProvider;
+    private blocklist;
+    constructor({ gatewaysProvider, blocklist, }: {
+        gatewaysProvider: GatewaysProvider;
+        blocklist?: string[];
+    });
+    getTargetGateway(): Promise<URL>;
+}

package/lib/types/common/wayfinder/routers/random.test.d.ts

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

package/lib/types/common/wayfinder/routers/simple-cache.d.ts

@@ -0,0 +1,28 @@
+/**
+ * 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 { WayfinderRouter } from '../../../types/wayfinder.js';
+export declare class SimpleCacheRouter implements WayfinderRouter {
+    readonly name: 'simple-cache';
+    private lastUpdatedTimestamp;
+    private ttlSeconds;
+    private targetGateway;
+    private router;
+    constructor({ router, ttlSeconds, }: {
+        router: WayfinderRouter;
+        ttlSeconds?: number;
+    });
+    getTargetGateway(): Promise<URL>;
+}

package/lib/types/common/wayfinder/routers/simple-cache.test.d.ts

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