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

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,20 @@
+/**
+ * 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';
+export * from './gateways.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 {};

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

@@ -0,0 +1,120 @@
+/**
+ * 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';
+type HttpClientFunction = (...args: [string, ...unknown[]]) => unknown;
+type WayfinderHttpClient<T extends HttpClientFunction> = T;
+export declare const arnsRegex: RegExp;
+export declare const txIdRegex: RegExp;
+/**
+ * Core function to resolve a wayfinder url against a target gateway
+ * @param originalUrl - the wayfinder url to resolve
+ * @param targetGateway - the target gateway to resolve the url against
+ * @returns the resolved url that can be used to make a request
+ */
+export declare const resolveWayfinderUrl: ({ originalUrl, targetGateway, }: {
+    originalUrl: string | URL;
+    targetGateway: string | URL;
+}) => URL;
+/**
+ * Creates a wrapped http client that supports ar:// protocol
+ *
+ * This function leverages a Proxy to intercept calls to the http client
+ * and redirects them to the target gateway using the resolveUrl function url.
+ * It also supports the http client methods like get(), post(), put(), delete(), etc.
+ *
+ * Any URLs provided that are not wayfinder urls will be returned as is.
+ *
+ * @param httpClient - the http client to wrap (e.g. axios, fetch, got, etc.)
+ * @param resolveUrl - the function to construct the redirect url for ar:// requests
+ * @returns a wrapped http client that supports ar:// protocol
+ */
+export declare const createWayfinderClient: <T extends HttpClientFunction>({ httpClient, resolveUrl, }: {
+    httpClient: T;
+    resolveUrl: (params: {
+        originalUrl: string | URL;
+    }) => Promise<URL>;
+}) => WayfinderHttpClient<T>;
+/**
+ * The main class for the wayfinder
+ * @param router - the router to use for requests
+ * @param httpClient - the http client to use for requests
+ * @param blocklist - the blocklist of gateways to avoid
+ */
+export declare class Wayfinder<T extends HttpClientFunction> {
+    /**
+     * The router to use for requests
+     *
+     * @example
+     * const wayfinder = new Wayfinder({
+     *   router: new RandomGatewayRouter({
+     *     gatewaysProvider: new ARIOGatewaysProvider({ ario: ARIO.mainnet() })
+     *   }),
+     * });
+     */
+    readonly router: WayfinderRouter;
+    /**
+     * The http client to use for requests
+     *
+     * @example
+     * const wayfinder = new Wayfinder({
+     *   router: new RandomGatewayRouter({
+     *     gatewaysProvider: new ARIOGatewaysProvider({ ario: ARIO.mainnet() })
+     *   }),
+     *   httpClient: axios,
+     * });
+     */
+    readonly httpClient: T;
+    /**
+     * The function that resolves the redirect url for ar:// requests to a target gateway
+     *
+     * @example
+     * const wayfinder = new Wayfinder({
+     *   router: new RandomGatewayRouter({
+     *     gatewaysProvider: new ARIOGatewaysProvider({ ario: ARIO.mainnet() })
+     *   }),
+     *   httpClient: axios,
+     * });
+     *
+     * const redirectUrl = await wayfinder.resolveUrl({ originalUrl: 'ar://example' });
+     */
+    readonly resolveUrl: (params: {
+        originalUrl: string;
+    }) => Promise<URL>;
+    /**
+     * A wrapped http client that supports ar:// protocol
+     *
+     * @example
+     * const { request: wayfind } = new Wayfinder({
+     *   router: new RandomGatewayRouter({
+     *     gatewaysProvider: new ARIOGatewaysProvider({ ario: ARIO.mainnet() })
+     *   }),
+     *   httpClient: axios,
+     * });;
+     *
+     * const response = await wayfind('ar://example', {
+     *   method: 'POST',
+     *   data: {
+     *     name: 'John Doe',
+     *   },
+     * })
+     */
+    readonly request: WayfinderHttpClient<T>;
+    constructor({ router, httpClient, }: {
+        router: WayfinderRouter;
+        httpClient: T;
+    });
+}
+export {};

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

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

package/lib/types/types/ant.d.ts

@@ -127,11 +127,63 @@ export declare const AntStateSchema: z.ZodObject<{
     Initialized: boolean;
 }>;
 export type AoANTState = z.infer<typeof AntStateSchema>;
+export declare const SpawnANTStateSchema: z.ZodObject<{
+    name: z.ZodString;
+    ticker: z.ZodString;
+    description: z.ZodString;
+    keywords: z.ZodArray<z.ZodString, "many">;
+    owner: z.ZodString;
+    controllers: z.ZodArray<z.ZodString, "many">;
+    records: z.ZodRecord<z.ZodString, z.ZodObject<{
+        transactionId: z.ZodEffects<z.ZodString, string, string>;
+        ttlSeconds: z.ZodNumber;
+        priority: z.ZodOptional<z.ZodNumber>;
+    }, "strip", z.ZodTypeAny, {
+        transactionId: string;
+        ttlSeconds: number;
+        priority?: number | undefined;
+    }, {
+        transactionId: string;
+        ttlSeconds: number;
+        priority?: number | undefined;
+    }>>;
+    balances: z.ZodRecord<z.ZodString, z.ZodNumber>;
+    logo: z.ZodEffects<z.ZodString, string, string>;
+}, "strip", z.ZodTypeAny, {
+    description: string;
+    name: string;
+    ticker: string;
+    keywords: string[];
+    owner: string;
+    controllers: string[];
+    records: Record<string, {
+        transactionId: string;
+        ttlSeconds: number;
+        priority?: number | undefined;
+    }>;
+    balances: Record<string, number>;
+    logo: string;
+}, {
+    description: string;
+    name: string;
+    ticker: string;
+    keywords: string[];
+    owner: string;
+    controllers: string[];
+    records: Record<string, {
+        transactionId: string;
+        ttlSeconds: number;
+        priority?: number | undefined;
+    }>;
+    balances: Record<string, number>;
+    logo: string;
+}>;
+export type SpawnANTState = z.infer<typeof SpawnANTStateSchema>;
 export declare const AntReadHandlers: readonly ["balance", "balances", "totalSupply", "info", "controllers", "record", "records", "state"];
 export type AoANTReadHandler = (typeof AntReadHandlers)[number];
 export declare const AntWriteHandlers: readonly ["_eval", "_default", "transfer", "addController", "removeController", "setRecord", "removeRecord", "setName", "setTicker", "setDescription", "setKeywords", "setLogo", "initializeState", "releaseName", "reassignName", "approvePrimaryName", "removePrimaryNames"];
 export type AoANTWriteHandler = (typeof AntWriteHandlers)[number];
-export declare const AntHandlerNames: ("balance" | "balances" | "totalSupply" | "info" | "controllers" | "record" | "records" | "state" | "_eval" | "_default" | "transfer" | "addController" | "removeController" | "setRecord" | "removeRecord" | "setName" | "setTicker" | "setDescription" | "setKeywords" | "setLogo" | "initializeState" | "releaseName" | "reassignName" | "approvePrimaryName" | "removePrimaryNames")[];
+export declare const AntHandlerNames: ("controllers" | "records" | "balances" | "balance" | "totalSupply" | "info" | "record" | "state" | "_eval" | "_default" | "transfer" | "addController" | "removeController" | "setRecord" | "removeRecord" | "setName" | "setTicker" | "setDescription" | "setKeywords" | "setLogo" | "initializeState" | "releaseName" | "reassignName" | "approvePrimaryName" | "removePrimaryNames")[];
 export type AoANTHandler = AoANTWriteHandler | AoANTReadHandler;
 export declare const AntHandlersSchema: z.ZodEffects<z.ZodArray<z.ZodString, "many">, string[], string[]>;
 export declare const AntInfoSchema: z.ZodObject<{

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

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { Signer } from '@dha-team/arbundles';
+import { ArconnectSigner, ArweaveSigner, EthereumSigner, InjectedEthereumSigner, Signer } from '@dha-team/arbundles';
 import { dryrun, message, monitor, result, results, spawn, unmonitor } from '@permaweb/aoconnect';
 import Arweave from 'arweave';
 import { AoSigner } from './token.js';
@@ -26,6 +26,10 @@ export type ProcessId = string;
 export type OptionalArweave<T = NonNullable<unknown>> = {
     arweave?: Arweave;
 } & T;
+export type OptionalPaymentUrl<T = NonNullable<unknown>> = {
+    paymentUrl?: string;
+} & T;
+export type TurboArNSSigner = EthereumSigner | InjectedEthereumSigner | ArweaveSigner | ArconnectSigner | Window['arweaveWallet'];
 export type ContractSigner = Signer | Window['arweaveWallet'] | AoSigner;
 export type WithSigner<T = NonNullable<unknown>> = {
     signer: ContractSigner;
@@ -44,8 +48,9 @@ export type WriteOptions = {
     }[];
 };
 export type WriteParameters<Input> = WithSigner<Required<ReadParameters<Input>>>;
-export type AoMessageResult = {
+export type AoMessageResult<T = Record<string, string | number | boolean | null>> = {
     id: string;
+    result?: T;
 };
 export type AoPrimaryNameRequest = {
     name: string;

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

@@ -19,3 +19,4 @@ export * from './common.js';
 export * from './faucet.js';
 export * from './io.js';
 export * from './token.js';
+export * from './wayfinder.js';

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

@@ -310,7 +310,7 @@ export type AoTokenCostParams = {
     quantity?: number;
     fromAddress?: WalletAddress;
 };
-export declare const fundFromOptions: readonly ["balance", "stakes", "any"];
+export declare const fundFromOptions: readonly ["balance", "stakes", "any", "turbo"];
 export type FundFrom = (typeof fundFromOptions)[number];
 export declare const isValidFundFrom: (fundFrom: string) => fundFrom is FundFrom;
 export type AoGetCostDetailsParams = AoTokenCostParams & {
@@ -338,6 +338,7 @@ export type CostDetailsResult = {
         basePrice: number;
     };
     fundingPlan?: AoFundingPlan;
+    wincQty?: string;
 };
 export type AoGetVaultParams = {
     address: WalletAddress;
@@ -420,6 +421,7 @@ export type DemandFactorSettings = {
     criteria: string;
 };
 export interface AoARIORead {
+    process: AOProcess;
     getInfo(): Promise<{
         Ticker: string;
         Name: string;
@@ -523,10 +525,10 @@ export interface AoARIOWrite extends AoARIORead {
         reportTxId: TransactionId;
         failedGateways: WalletAddress[];
     }>;
-    buyRecord: AoWriteAction<AoBuyRecordParams>;
-    upgradeRecord: AoWriteAction<AoArNSPurchaseParams>;
-    extendLease: AoWriteAction<AoExtendLeaseParams>;
-    increaseUndernameLimit: AoWriteAction<AoIncreaseUndernameLimitParams>;
+    buyRecord: AoWriteAction<AoBuyRecordParams, AoMessageResult>;
+    upgradeRecord: AoWriteAction<AoArNSPurchaseParams, AoMessageResult>;
+    extendLease: AoWriteAction<AoExtendLeaseParams, AoMessageResult>;
+    increaseUndernameLimit: AoWriteAction<AoIncreaseUndernameLimitParams, AoMessageResult>;
     cancelWithdrawal: AoWriteAction<{
         gatewayAddress?: WalletAddress;
         vaultId: string;

package/lib/types/types/wayfinder.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 interface WayfinderRouter {
+    readonly name: string;
+    getTargetGateway: () => Promise<URL>;
+}

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

@@ -1,18 +1,7 @@
 import Arweave from 'arweave';
 import { Logger } from '../common/index.js';
-import { AoANTRecord } from '../types/ant.js';
+import { SpawnANTState } from '../types/ant.js';
 import { AoClient, AoEpochData, AoEpochDistributed, AoSigner, ContractSigner, WalletAddress } from '../types/index.js';
-export type SpawnANTState = {
-    owner: WalletAddress;
-    controllers: WalletAddress[];
-    name: string;
-    description: string;
-    keywords: string[];
-    ticker: string;
-    records: Record<string, AoANTRecord>;
-    balances: Record<WalletAddress, number>;
-    logo: string;
-};
 export type SpawnANTParams = {
     signer: AoSigner;
     module?: string;

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

@@ -0,0 +1,7 @@
+/**
+ * Cryptographically secure helper for randomness, does not support seeding
+ * @param min - the minimum value
+ * @param max - the maximum value
+ * @returns a random integer between min and max
+ */
+export declare const randomInt: (min: number, max: number) => number;

package/lib/types/utils/url.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 declare const urlWithSearchParams: ({ baseUrl, params, }: {
+    baseUrl: string;
+    params: Record<string, string | number | boolean | null | undefined>;
+}) => string;

package/lib/types/utils/url.test.d.ts

@@ -0,0 +1 @@
+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.10.0-alpha.1";
+export declare const version = "3.11.0-alpha.1";