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

package/lib/esm/common/io.js

@@ -5,6 +5,7 @@ import { getEpochDataFromGqlWithCUFallback, paginationParamsToTags, pruneTags, r
 import { defaultArweave } from './arweave.js';
 import { AOProcess } from './contracts/ao-process.js';
 import { InvalidContractConfigurationError } from './error.js';
+import { TurboArNSPaymentProvider } from './turbo.js';
 export class ARIO {
     // Implementation
     static init(config) {
@@ -18,6 +19,7 @@ export class ARIOReadable {
     process;
     epochSettings;
     arweave;
+    paymentProvider; // TODO: this could be an array/map of payment providers
     constructor(config) {
         this.arweave = config?.arweave ?? defaultArweave;
         if (config === undefined || Object.keys(config).length === 0) {
@@ -36,6 +38,9 @@ export class ARIOReadable {
         else {
             throw new InvalidContractConfigurationError();
         }
+        this.paymentProvider = new TurboArNSPaymentProvider({
+            paymentUrl: config?.paymentUrl,
+        });
     }
     async getInfo() {
         return this.process.read({
@@ -367,6 +372,20 @@ export class ARIOReadable {
     // TODO: Can overload this function to refine different types of cost details params
     async getCostDetails({ intent, type, years, name, quantity, fromAddress, fundFrom, }) {
         const replacedBuyRecordWithBuyName = intent === 'Buy-Record' ? 'Buy-Name' : intent;
+        if (fundFrom === 'turbo') {
+            const { mARIO, winc } = await this.paymentProvider.getArNSPriceDetails({
+                intent: replacedBuyRecordWithBuyName,
+                name,
+                quantity,
+                type,
+                years,
+            });
+            return {
+                tokenCost: +mARIO,
+                wincQty: winc,
+                discounts: [],
+            };
+        }
         const allTags = [
             { name: 'Action', value: 'Cost-Details' },
             {
@@ -533,7 +552,8 @@ export class ARIOReadable {
 }
 export class ARIOWriteable extends ARIOReadable {
     signer;
-    constructor({ signer, ...config }) {
+    paymentProvider;
+    constructor({ signer, paymentUrl, ...config }) {
         if (config === undefined) {
             super({
                 process: new AOProcess({
@@ -545,6 +565,10 @@ export class ARIOWriteable extends ARIOReadable {
             super(config);
         }
         this.signer = createAoSigner(signer);
+        this.paymentProvider = new TurboArNSPaymentProvider({
+            signer: signer,
+            paymentUrl,
+        });
     }
     async transfer({ target, qty, }, options) {
         const { tags = [] } = options || {};
@@ -819,6 +843,12 @@ export class ARIOWriteable extends ARIOReadable {
         });
     }
     async buyRecord(params, options) {
+        if (params.fundFrom === 'turbo') {
+            return this.paymentProvider.initiateArNSPurchase({
+                intent: 'Buy-Name',
+                ...params,
+            });
+        }
         const { tags = [] } = options || {};
         const allTags = [
             ...tags,
@@ -843,6 +873,12 @@ export class ARIOWriteable extends ARIOReadable {
      * @returns {Promise<AoMessageResult>} The result of the upgrade
      */
     async upgradeRecord(params, options) {
+        if (params.fundFrom === 'turbo') {
+            return this.paymentProvider.initiateArNSPurchase({
+                intent: 'Upgrade-Name',
+                name: params.name,
+            });
+        }
         const { tags = [] } = options || {};
         const allTags = [
             ...tags,
@@ -865,6 +901,12 @@ export class ARIOWriteable extends ARIOReadable {
      * @returns {Promise<AoMessageResult>} The result of the extension
      */
     async extendLease(params, options) {
+        if (params.fundFrom === 'turbo') {
+            return this.paymentProvider.initiateArNSPurchase({
+                intent: 'Extend-Lease',
+                ...params,
+            });
+        }
         const { tags = [] } = options || {};
         const allTags = [
             ...tags,
@@ -879,6 +921,12 @@ export class ARIOWriteable extends ARIOReadable {
         });
     }
     async increaseUndernameLimit(params, options) {
+        if (params.fundFrom === 'turbo') {
+            return this.paymentProvider.initiateArNSPurchase({
+                intent: 'Increase-Undername-Limit',
+                ...params,
+            });
+        }
         const { tags = [] } = options || {};
         const allTags = [
             ...tags,
@@ -915,6 +963,9 @@ export class ARIOWriteable extends ARIOReadable {
         });
     }
     async requestPrimaryName(params, options) {
+        if (params.fundFrom === 'turbo') {
+            throw new Error('Turbo funding is not yet supported for primary name requests');
+        }
         const { tags = [] } = options || {};
         const allTags = [
             ...tags,

package/lib/esm/common/turbo.js

@@ -0,0 +1,129 @@
+/**
+ * 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 { SignatureConfig } from '@dha-team/arbundles';
+import { v4 as uuidv4 } from 'uuid';
+import { mARIOToken } from '../types/token.js';
+import { toB64Url } from '../utils/base64.js';
+import { createAxiosInstance } from '../utils/http-client.js';
+import { urlWithSearchParams } from '../utils/url.js';
+import { Logger } from './logger.js';
+export async function signedRequestHeadersFromSigner({ signer, nonce = uuidv4(), }) {
+    await signer.setPublicKey?.();
+    const signature = await signer.sign(Uint8Array.from(Buffer.from(nonce)));
+    let publicKey;
+    switch (signer.signatureType) {
+        case SignatureConfig.ARWEAVE:
+            publicKey = toB64Url(signer.publicKey);
+            break;
+        case SignatureConfig.ETHEREUM:
+            publicKey = '0x' + signer.publicKey.toString('hex');
+            break;
+        // TODO: solana sig support
+        // case SignatureConfig.SOLANA:
+        // case SignatureConfig.ED25519:
+        default:
+            throw new Error(`Unsupported signer type for signing requests: ${signer.signatureType}`);
+    }
+    return {
+        'x-public-key': publicKey,
+        'x-nonce': nonce,
+        'x-signature': toB64Url(Buffer.from(signature)),
+        'x-signature-type': signer.signatureType,
+    };
+}
+export class TurboArNSPaymentProvider {
+    paymentUrl;
+    axios;
+    logger;
+    signer;
+    constructor({ paymentUrl = 'https://payment.ardrive.io', axios = createAxiosInstance(), logger = Logger.default, signer, }) {
+        this.paymentUrl = paymentUrl;
+        this.axios = axios;
+        this.logger = logger;
+        this.signer = signer;
+    }
+    async getArNSPriceDetails({ intent, name, quantity, type, years, }) {
+        const url = urlWithSearchParams({
+            baseUrl: `${this.paymentUrl}/v1/arns/price/${intent}/${name}`,
+            params: {
+                increaseQty: quantity,
+                type,
+                years,
+            },
+        });
+        const { data, status } = await this.axios.get(url);
+        this.logger.debug('getArNSPriceDetails', {
+            intent,
+            name,
+            quantity,
+            type,
+            years,
+            data,
+            status,
+        });
+        if (status !== 200) {
+            throw new Error('Failed to get ArNS purchase price ' + JSON.stringify(data));
+        }
+        if (!data.winc || !data.mARIO) {
+            throw new Error('Invalid response from Turbo ' + JSON.stringify(data));
+        }
+        return {
+            winc: data.winc,
+            mARIO: new mARIOToken(+data.mARIO),
+        };
+    }
+    async getPrice(params) {
+        const { winc } = await this.getArNSPriceDetails(params);
+        return +winc;
+    }
+    async initiateArNSPurchase({ intent, name, quantity, type, processId, years, }) {
+        if (!this.signer) {
+            throw new Error('Signer required for initiating ArNS purchase with Turbo');
+        }
+        const url = urlWithSearchParams({
+            baseUrl: `${this.paymentUrl}/v1/arns/purchase/${intent}/${name}`,
+            params: {
+                increaseQty: quantity,
+                processId,
+                type,
+                years,
+            },
+        });
+        const headers = await signedRequestHeadersFromSigner({
+            signer: this.signer,
+        });
+        const { data, status } = await this.axios.post(url, null, {
+            headers,
+        });
+        this.logger.debug('Initiated ArNS purchase', {
+            intent,
+            name,
+            quantity,
+            processId,
+            type,
+            years,
+            data,
+            status,
+        });
+        if (status !== 200) {
+            throw new Error('Failed to initiate ArNS purchase ' + JSON.stringify(data));
+        }
+        return {
+            id: data.arioWriteResult.id,
+            result: data.purchaseReceipt,
+        };
+    }
+}

package/lib/esm/types/io.js

@@ -22,7 +22,7 @@ export const intentsUsingYears = [
 export const isValidIntent = (intent) => {
     return validIntents.indexOf(intent) !== -1;
 };
-export const fundFromOptions = ['balance', 'stakes', 'any'];
+export const fundFromOptions = ['balance', 'stakes', 'any', 'turbo'];
 export const isValidFundFrom = (fundFrom) => {
     return fundFromOptions.indexOf(fundFrom) !== -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/version.js

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

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;
     }) | undefined;
     fundingPlan?: import("../../types/io.js").AoFundingPlan | undefined;
+    wincQty?: string | undefined;
 }>;
 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;
@@ -76,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: "lease" | "permabuy";
+    type: "permabuy" | "lease";
     quantity: number | undefined;
     years: number;
     intent: "Buy-Name" | "Buy-Record" | "Extend-Lease" | "Increase-Undername-Limit" | "Upgrade-Name" | "Primary-Name-Request";

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

@@ -1,25 +1,11 @@
-/**
- * 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 Arweave from 'arweave';
-import { AoArNSNameDataWithName, AoArNSReservedNameData, AoBalanceWithAddress, AoEpochDistributionData, AoEpochObservationData, AoGatewayWithAddress, AoJoinNetworkParams, AoMessageResult, AoPrimaryName, AoPrimaryNameRequest, AoRedelegationFeeInfo, AoReturnedName, AoTokenSupplyData, AoUpdateGatewaySettingsParams, AoWeightedObserver, OptionalArweave, PaginationParams, PaginationResult, ProcessConfiguration, TransactionId, WalletAddress, WithSigner, WriteOptions } from '../types/index.js';
+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 { AOProcess } from './contracts/ao-process.js';
-type ARIOConfigNoSigner = OptionalArweave<ProcessConfiguration>;
-type ARIOConfigWithSigner = WithSigner<OptionalArweave<ProcessConfiguration>>;
+import { TurboArNSPaymentProvider } 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;
@@ -29,7 +15,8 @@ export declare class ARIOReadable implements AoARIORead {
     protected process: AOProcess;
     protected epochSettings: AoEpochSettings | undefined;
     protected arweave: Arweave;
-    constructor(config?: OptionalArweave<ProcessConfiguration>);
+    protected paymentProvider: TurboArNSPaymentProvider;
+    constructor(config?: ARIOConfigNoSigner);
     getInfo(): Promise<{
         Name: string;
         Ticker: string;
@@ -44,8 +31,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>;
@@ -144,7 +131,8 @@ export declare class ARIOReadable implements AoARIORead {
 export declare class ARIOWriteable extends ARIOReadable implements AoARIOWrite {
     protected process: AOProcess;
     private signer;
-    constructor({ signer, ...config }: ARIOConfigWithSigner);
+    protected paymentProvider: TurboArNSPaymentProvider;
+    constructor({ signer, paymentUrl, ...config }: ARIOConfigWithSigner);
     transfer({ target, qty, }: {
         target: string;
         qty: number | mARIOToken;

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

@@ -0,0 +1,47 @@
+import { AxiosInstance, RawAxiosRequestHeaders } from 'axios';
+import { AoMessageResult, TransactionId, TurboArNSSigner, WriteOptions } from '../types/common.js';
+import { AoTokenCostParams } from '../types/io.js';
+import { mARIOToken } from '../types/token.js';
+import { ILogger } from './logger.js';
+export interface TurboConfig {
+    paymentUrl?: string;
+    logger?: ILogger;
+    axios?: AxiosInstance;
+    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;
+    }>;
+    initiateArNSPurchase(params: AoTokenCostParams & {
+        processId?: TransactionId;
+    }, options: WriteOptions): Promise<AoMessageResult<ArNSPurchaseReceipt>>;
+}
+export declare class TurboArNSPaymentProvider implements ArNSPaymentProvider {
+    private readonly paymentUrl;
+    private readonly axios;
+    private readonly logger;
+    private readonly signer?;
+    constructor({ paymentUrl, axios, logger, signer, }: TurboConfig);
+    getArNSPriceDetails({ intent, name, quantity, type, years, }: AoTokenCostParams): Promise<{
+        winc: string;
+        mARIO: mARIOToken;
+    }>;
+    getPrice(params: AoTokenCostParams): Promise<number>;
+    initiateArNSPurchase({ intent, name, quantity, type, processId, years, }: AoTokenCostParams & {
+        processId?: TransactionId;
+    }): Promise<AoMessageResult<ArNSPurchaseReceipt>>;
+}

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

@@ -27,6 +27,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 = Signer;
 export type ContractSigner = Signer | Window['arweaveWallet'] | AoSigner;
 export type WithSigner<T = NonNullable<unknown>> = {
     signer: ContractSigner;
@@ -45,8 +49,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;