@ar.io/sdk 3.0.1-alpha.1 → 3.1.0-alpha.2

package/lib/esm/cli/commands/transfer.js

@@ -1,9 +1,13 @@
-import { assertEnoughBalance, confirmationPrompt, formatARIOWithCommas, requiredTargetAndQuantityFromOptions, writeARIOFromOptions, writeActionTagsFromOptions, } from '../utils.js';
+import { assertEnoughMARIOBalance, confirmationPrompt, formatARIOWithCommas, requiredTargetAndQuantityFromOptions, writeARIOFromOptions, writeActionTagsFromOptions, } from '../utils.js';
 export async function transfer(options) {
     const { target, arioQuantity } = requiredTargetAndQuantityFromOptions(options);
     const { ario, signerAddress } = writeARIOFromOptions(options);
     if (!options.skipConfirmation) {
-        await assertEnoughBalance(ario, signerAddress, arioQuantity);
+        await assertEnoughMARIOBalance({
+            ario,
+            address: signerAddress,
+            mARIOQuantity: arioQuantity.toMARIO(),
+        });
         const confirm = await confirmationPrompt(`Are you sure you want to transfer ${formatARIOWithCommas(arioQuantity)} ARIO to ${target}?`);
         if (!confirm) {
             return { message: 'Transfer aborted by user' };

package/lib/esm/cli/options.js

@@ -234,6 +234,10 @@ export const optionMap = {
         description: 'Include failed gateways in the list',
         type: 'array',
     },
+    fundFrom: {
+        alias: '--fund-from <fundFrom>',
+        description: 'Where to fund the action from. e.g. "balance", "stakes", or "any',
+    },
 };
 export const walletOptions = [
     optionMap.walletFile,
@@ -248,11 +252,13 @@ export const globalOptions = [
     optionMap.cuUrl,
 ];
 export const writeActionOptions = [optionMap.skipConfirmation, optionMap.tags];
-export const addressOptions = [optionMap.address];
-export const nameOptions = [optionMap.name];
-export const initiatorOptions = [optionMap.initiator];
+export const arnsPurchaseOptions = [
+    ...writeActionOptions,
+    optionMap.name,
+    optionMap.fundFrom,
+];
 export const epochOptions = [optionMap.epochIndex, optionMap.timestamp];
-export const addressAndVaultIdOptions = [...addressOptions, optionMap.vaultId];
+export const addressAndVaultIdOptions = [optionMap.address, optionMap.vaultId];
 export const nameWriteOptions = [...writeActionOptions, optionMap.name];
 export const paginationOptions = [
     optionMap.cursor,
@@ -271,6 +277,8 @@ export const tokenCostOptions = [
     optionMap.type,
     optionMap.years,
     optionMap.quantity,
+    optionMap.address,
+    optionMap.fundFrom,
 ];
 export const transferOptions = [
     ...writeActionOptions,
@@ -307,8 +315,7 @@ export const joinNetworkOptions = [
     optionMap.operatorStake,
 ];
 export const buyRecordOptions = [
-    ...writeActionOptions,
-    optionMap.name,
+    ...arnsPurchaseOptions,
     optionMap.quantity,
     optionMap.type,
     optionMap.years,

package/lib/esm/cli/utils.js

@@ -17,7 +17,7 @@ import { connect } from '@permaweb/aoconnect';
 import { program } from 'commander';
 import { readFileSync } from 'fs';
 import prompts from 'prompts';
-import { ANT, AOProcess, ARIO, ARIOToken, ARIO_DEVNET_PROCESS_ID, ARIO_TESTNET_PROCESS_ID, ArweaveSigner, Logger, createAoSigner, fromB64Url, initANTStateForAddress, mARIOToken, sha256B64Url, } from '../node/index.js';
+import { ANT, AOProcess, ARIO, ARIOToken, ARIO_DEVNET_PROCESS_ID, ARIO_TESTNET_PROCESS_ID, ArweaveSigner, Logger, createAoSigner, fromB64Url, fundFromOptions, initANTStateForAddress, isValidFundFrom, isValidIntent, mARIOToken, sha256B64Url, validIntents, } from '../node/index.js';
 import { globalOptions } from './options.js';
 export function stringifyJsonForCLIDisplay(json) {
     return JSON.stringify(json, null, 2);
@@ -141,6 +141,9 @@ export function formatARIOWithCommas(value) {
     }
     return integerWithCommas + '.' + decimalPart;
 }
+export function formatMARIOToARIOWithCommas(value) {
+    return formatARIOWithCommas(value.toARIO());
+}
 /** helper to get address from --address option first, then check wallet options  */
 export function addressFromOptions(options) {
     if (options.address !== undefined) {
@@ -265,16 +268,34 @@ export function recordTypeFromOptions(options) {
     }
     return options.type;
 }
-export function requiredMIOFromOptions(options, key) {
+export function requiredMARIOFromOptions(options, key) {
     if (options[key] === undefined) {
         throw new Error(`No ${key} provided. Use --${key} denominated in ARIO`);
     }
     return new ARIOToken(+options[key]).toMARIO();
 }
-export async function assertEnoughBalance(ario, address, arioQuantity) {
+export async function assertEnoughBalanceForArNSPurchase({ ario, address, costDetailsParams, }) {
+    const costDetails = await ario.getCostDetails(costDetailsParams);
+    if (costDetails.fundingPlan) {
+        if (costDetails.fundingPlan.shortfall > 0) {
+            throw new Error(`Insufficient balance for action. Shortfall: ${formatMARIOToARIOWithCommas(new mARIOToken(costDetails.fundingPlan.shortfall))}\n${JSON.stringify(costDetails, null, 2)}`);
+        }
+    }
+    else {
+        await assertEnoughMARIOBalance({
+            ario,
+            address,
+            mARIOQuantity: costDetails.tokenCost,
+        });
+    }
+}
+export async function assertEnoughMARIOBalance({ address, ario, mARIOQuantity, }) {
+    if (typeof mARIOQuantity === 'number') {
+        mARIOQuantity = new mARIOToken(mARIOQuantity);
+    }
     const balance = await ario.getBalance({ address });
-    if (balance < arioQuantity.toMARIO().valueOf()) {
-        throw new Error(`Insufficient ARIO balance for action. Balance available: ${new mARIOToken(balance).toARIO()} ARIO`);
+    if (balance < mARIOQuantity.valueOf()) {
+        throw new Error(`Insufficient ARIO balance for action. Balance available: ${formatMARIOToARIOWithCommas(new mARIOToken(balance))} ARIO`);
     }
 }
 export async function confirmationPrompt(message) {
@@ -364,3 +385,30 @@ export function getANTStateFromOptions(options) {
         ttlSeconds: options.ttlSeconds !== undefined ? +options.ttlSeconds : 3600,
     });
 }
+export function getTokenCostParamsFromOptions(o) {
+    o.intent ??= 'Buy-Record';
+    o.type ??= 'lease';
+    o.years ??= '1';
+    if (!isValidIntent(o.intent)) {
+        throw new Error(`Invalid intent. Valid intents are: ${validIntents.join(', ')}`);
+    }
+    if (o.type !== 'lease' && o.type !== 'permabuy') {
+        throw new Error(`Invalid type. Valid types are: lease, permabuy`);
+    }
+    return {
+        type: o.type,
+        quantity: o.quantity !== undefined ? +o.quantity : undefined,
+        years: +o.years,
+        intent: o.intent,
+        name: requiredStringFromOptions(o, 'name'),
+        fromAddress: addressFromOptions(o),
+    };
+}
+export function fundFromFromOptions(o) {
+    if (o.fundFrom !== undefined) {
+        if (!isValidFundFrom(o.fundFrom)) {
+            throw new Error(`Invalid fund from: ${o.fundFrom}. Please use one of ${fundFromOptions.join(', ')}`);
+        }
+    }
+    return o.fundFrom ?? 'balance';
+}

package/lib/esm/common/contracts/ao-process.js

@@ -28,7 +28,7 @@ export class AOProcess {
         this.logger = logger;
         this.ao = ao;
     }
-    async read({ tags, retries = 3, }) {
+    async read({ tags, retries = 3, fromAddress, }) {
         let attempts = 0;
         let lastError;
         while (attempts < retries) {
@@ -37,10 +37,14 @@ export class AOProcess {
                     tags,
                 });
                 // map tags to inputs
-                const result = await this.ao.dryrun({
+                const dryRunInput = {
                     process: this.processId,
                     tags,
-                });
+                };
+                if (fromAddress !== undefined) {
+                    dryRunInput['Owner'] = fromAddress;
+                }
+                const result = await this.ao.dryrun(dryRunInput);
                 this.logger.debug(`Read interaction result`, {
                     result,
                 });

package/lib/esm/common/io.js

@@ -261,7 +261,7 @@ export class ARIOReadable {
             tags: pruneTags(allTags),
         });
     }
-    async getTokenCost({ intent, type, years, name, quantity, }) {
+    async getTokenCost({ intent, type, years, name, quantity, fromAddress, }) {
         const allTags = [
             { name: 'Action', value: 'Token-Cost' },
             {
@@ -298,6 +298,52 @@ export class ARIOReadable {
         ];
         return this.process.read({
             tags: pruneTags(allTags),
+            fromAddress,
+        });
+    }
+    // TODO: Can overload this function to refine different types of cost details params
+    async getCostDetails({ intent, type, years, name, quantity, fromAddress, fundFrom, }) {
+        const allTags = [
+            { name: 'Action', value: 'Get-Cost-Details-For-Action' },
+            {
+                name: 'Intent',
+                value: intent,
+            },
+            {
+                name: 'Name',
+                value: name,
+            },
+            {
+                name: 'Years',
+                value: years?.toString(),
+            },
+            {
+                name: 'Quantity',
+                value: quantity?.toString(),
+            },
+            {
+                name: 'Purchase-Type',
+                value: type,
+            },
+            {
+                name: 'Fund-From',
+                value: fundFrom,
+            },
+            {
+                name: 'Timestamp',
+                value: (await this.arweave.blocks
+                    .getCurrent()
+                    .then((block) => {
+                    return { timestamp: block.timestamp * 1000 };
+                })
+                    .catch(() => {
+                    return { timestamp: Date.now() }; // fallback to current time
+                })).timestamp.toString(),
+            },
+        ];
+        return this.process.read({
+            tags: pruneTags(allTags),
+            fromAddress,
         });
     }
     async getRegistrationFees() {
@@ -662,6 +708,7 @@ export class ARIOWriteable extends ARIOReadable {
             { name: 'Years', value: params.years?.toString() ?? '1' },
             { name: 'Process-Id', value: params.processId },
             { name: 'Purchase-Type', value: params.type || 'lease' },
+            { name: 'Fund-From', value: params.fundFrom },
         ];
         return this.process.send({
             signer: this.signer,
@@ -678,13 +725,15 @@ export class ARIOWriteable extends ARIOReadable {
      */
     async upgradeRecord(params, options) {
         const { tags = [] } = options || {};
+        const allTags = [
+            ...tags,
+            { name: 'Action', value: 'Upgrade-Name' }, // TODO: align on Update-Record vs. Upgrade-Name (contract currently uses Upgrade-Name)
+            { name: 'Name', value: params.name },
+            { name: 'Fund-From', value: params.fundFrom },
+        ];
         return this.process.send({
             signer: this.signer,
-            tags: [
-                ...tags,
-                { name: 'Action', value: 'Upgrade-Name' }, // TODO: align on Update-Record vs. Upgrade-Name (contract currently uses Upgrade-Name)
-                { name: 'Name', value: params.name },
-            ],
+            tags: pruneTags(allTags),
         });
     }
     /**
@@ -698,26 +747,30 @@ export class ARIOWriteable extends ARIOReadable {
      */
     async extendLease(params, options) {
         const { tags = [] } = options || {};
+        const allTags = [
+            ...tags,
+            { name: 'Action', value: 'Extend-Lease' },
+            { name: 'Name', value: params.name },
+            { name: 'Years', value: params.years.toString() },
+            { name: 'Fund-From', value: params.fundFrom },
+        ];
         return this.process.send({
             signer: this.signer,
-            tags: [
-                ...tags,
-                { name: 'Action', value: 'Extend-Lease' },
-                { name: 'Name', value: params.name },
-                { name: 'Years', value: params.years.toString() },
-            ],
+            tags: pruneTags(allTags),
         });
     }
     async increaseUndernameLimit(params, options) {
         const { tags = [] } = options || {};
+        const allTags = [
+            ...tags,
+            { name: 'Action', value: 'Increase-Undername-Limit' },
+            { name: 'Name', value: params.name },
+            { name: 'Quantity', value: params.increaseCount.toString() },
+            { name: 'Fund-From', value: params.fundFrom },
+        ];
         return this.process.send({
             signer: this.signer,
-            tags: [
-                ...tags,
-                { name: 'Action', value: 'Increase-Undername-Limit' },
-                { name: 'Name', value: params.name },
-                { name: 'Quantity', value: params.increaseCount.toString() },
-            ],
+            tags: pruneTags(allTags),
         });
     }
     /**
@@ -742,13 +795,16 @@ export class ARIOWriteable extends ARIOReadable {
             tags: pruneTags(allTags),
         });
     }
-    async requestPrimaryName(params) {
+    async requestPrimaryName(params, options) {
+        const { tags = [] } = options || {};
+        const allTags = [
+            ...tags,
+            { name: 'Action', value: 'Request-Primary-Name' },
+            { name: 'Name', value: params.name },
+        ];
         return this.process.send({
             signer: this.signer,
-            tags: [
-                { name: 'Action', value: 'Request-Primary-Name' },
-                { name: 'Name', value: params.name },
-            ],
+            tags: pruneTags(allTags),
         });
     }
     /**

package/lib/esm/types/io.js

@@ -10,6 +10,10 @@ export const intentsUsingYears = ['Buy-Record', 'Extend-Lease'];
 export const isValidIntent = (intent) => {
     return validIntents.indexOf(intent) !== -1;
 };
+export const fundFromOptions = ['balance', 'stakes', 'any'];
+export const isValidFundFrom = (fundFrom) => {
+    return fundFromOptions.indexOf(fundFrom) !== -1;
+};
 // Typeguard functions
 export function isProcessConfiguration(config) {
     return 'process' in config;

package/lib/esm/version.js

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

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

@@ -0,0 +1,22 @@
+/**
+ * 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 { AoArNSPurchaseParams, AoBuyRecordParams, AoExtendLeaseParams, AoIncreaseUndernameLimitParams } from '../../types/io.js';
+import { CLIWriteOptionsFromAoParams } from '../types.js';
+export declare function buyRecordCLICommand(o: CLIWriteOptionsFromAoParams<AoBuyRecordParams>): Promise<import("../../types/common.js").AoMessageResult>;
+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>;

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

@@ -1,4 +1,20 @@
-import { AddressAndNameCLIOptions, AddressAndVaultIdCLIOptions, AddressCLIOptions, EpochCLIOptions, GetTokenCostCLIOptions, NameCLIOptions, PaginationAddressCLIOptions, PaginationCLIOptions } from '../types.js';
+/**
+ * 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 { AoGetCostDetailsParams } from '../../types/io.js';
+import { AddressAndNameCLIOptions, AddressAndVaultIdCLIOptions, AddressCLIOptions, CLIOptionsFromAoParams, EpochCLIOptions, GetTokenCostCLIOptions, GlobalCLIOptions, NameCLIOptions, PaginationAddressCLIOptions, PaginationCLIOptions } from '../types.js';
 export declare function getGateway(o: AddressCLIOptions): Promise<import("../../types/io.js").AoGateway | {
     message: string;
 }>;
@@ -42,9 +58,15 @@ export declare function getPrescribedNames(o: EpochCLIOptions): Promise<string[]
     message: string;
 }>;
 export declare function getTokenCost(o: GetTokenCostCLIOptions): Promise<{
-    mIOTokenCost: number;
+    mARIOTokenCost: number;
     message: string;
 }>;
+export declare function getCostDetails(o: GlobalCLIOptions & CLIOptionsFromAoParams<AoGetCostDetailsParams>): Promise<{
+    message: string;
+    tokenCost: number;
+    discounts: import("../../types/io.js").CostDiscount[];
+    fundingPlan?: import("../../types/io.js").AoFundingPlan | undefined;
+}>;
 export declare function getPrimaryName(o: AddressAndNameCLIOptions): Promise<import("../../types/common.js").AoPrimaryName | {
     message: string;
 }>;

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

@@ -230,6 +230,10 @@ export declare const optionMap: {
         description: string;
         type: string;
     };
+    fundFrom: {
+        alias: string;
+        description: string;
+    };
 };
 export declare const walletOptions: {
     alias: string;
@@ -244,15 +248,7 @@ export declare const writeActionOptions: {
     description: string;
     type: string;
 }[];
-export declare const addressOptions: {
-    alias: string;
-    description: string;
-}[];
-export declare const nameOptions: {
-    alias: string;
-    description: string;
-}[];
-export declare const initiatorOptions: {
+export declare const arnsPurchaseOptions: {
     alias: string;
     description: string;
 }[];

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

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { AoAddressParams, AoArNSNameParams, AoBuyRecordParams, AoExtendLeaseParams, AoGetVaultParams, AoIncreaseUndernameLimitParams, AoJoinNetworkParams, AoTokenCostParams, PaginationParams } from '../types/io.js';
+import { AoAddressParams, AoArNSNameParams, AoGetVaultParams, AoJoinNetworkParams, AoTokenCostParams, PaginationParams } from '../types/io.js';
 export type WalletCLIOptions = {
     walletFile?: string;
     privateKey?: string;
@@ -47,6 +47,8 @@ export type ProcessIdWriteActionCLIOptions = WriteActionCLIOptions & {
 export type CLIOptionsFromAoParams<T> = {
     [K in keyof T]?: T[K] extends number | undefined ? string | undefined : T[K] extends string | boolean | symbol ? string : T[K] extends ReadonlyArray<infer U> ? ReadonlyArray<U> : T[K] extends object ? CLIOptionsFromAoParams<T[K]> : T[K];
 };
+export type CLIReadOptionsFromAoParams<T> = CLIOptionsFromAoParams<T> & GlobalCLIOptions;
+export type CLIWriteOptionsFromAoParams<T> = WriteActionCLIOptions & CLIOptionsFromAoParams<T>;
 export type PaginationCLIOptions = GlobalCLIOptions & CLIOptionsFromAoParams<PaginationParams>;
 export type AddressCLIOptions = GlobalCLIOptions & CLIOptionsFromAoParams<AoAddressParams>;
 export type ProcessIdCLIOptions = GlobalCLIOptions & {
@@ -86,10 +88,6 @@ export type OperatorStakeCLIOptions = WriteActionCLIOptions & {
 export type DecreaseDelegateStakeCLIOptions = DelegateStakeCLIOptions & {
     instant: boolean;
 };
-export type BuyRecordCLIOptions = WriteActionCLIOptions & CLIOptionsFromAoParams<AoBuyRecordParams>;
-export type UpgradeRecordCLIOptions = NameWriteCLIOptions;
-export type ExtendLeaseCLIOptions = WriteActionCLIOptions & CLIOptionsFromAoParams<AoExtendLeaseParams>;
-export type IncreaseUndernameLimitCLIOptions = WriteActionCLIOptions & CLIOptionsFromAoParams<AoIncreaseUndernameLimitParams>;
 export type ANTStateCLIOptions = WriteActionCLIOptions & {
     target?: string;
     keywords?: string[];

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

@@ -1,7 +1,7 @@
 import { JWKInterface } from 'arweave/node/lib/wallet.js';
 import { Command, OptionValues } from 'commander';
-import { ARIOToken, AoANTRead, AoANTWrite, AoARIORead, AoARIOWrite, AoRedelegateStakeParams, AoSigner, AoUpdateGatewaySettingsParams, ContractSigner, EpochInput, Logger, PaginationParams, SpawnANTState, WriteOptions, mARIOToken } from '../node/index.js';
-import { ANTStateCLIOptions, AddressCLIOptions, EpochCLIOptions, GlobalCLIOptions, InitiatorCLIOptions, JsonSerializable, PaginationCLIOptions, ProcessIdCLIOptions, RedelegateStakeCLIOptions, TransferCLIOptions, UpdateGatewaySettingsCLIOptions, WalletCLIOptions, WriteActionCLIOptions } from './types.js';
+import { ARIOToken, AoANTRead, AoANTWrite, AoARIORead, AoARIOWrite, AoGetCostDetailsParams, AoRedelegateStakeParams, AoSigner, AoUpdateGatewaySettingsParams, ContractSigner, EpochInput, FundFrom, Logger, PaginationParams, SpawnANTState, WriteOptions, mARIOToken } from '../node/index.js';
+import { ANTStateCLIOptions, AddressCLIOptions, EpochCLIOptions, GetTokenCostCLIOptions, GlobalCLIOptions, InitiatorCLIOptions, JsonSerializable, PaginationCLIOptions, ProcessIdCLIOptions, RedelegateStakeCLIOptions, TransferCLIOptions, UpdateGatewaySettingsCLIOptions, WalletCLIOptions, WriteActionCLIOptions } from './types.js';
 export declare function stringifyJsonForCLIDisplay(json: JsonSerializable | unknown): string;
 export declare function runCommand<O extends OptionValues>(command: Command, action: (options: O) => Promise<JsonSerializable>): Promise<void>;
 export interface CommanderOption {
@@ -31,6 +31,7 @@ export declare function writeARIOFromOptions(options: GlobalCLIOptions): {
     signerAddress: string;
 };
 export declare function formatARIOWithCommas(value: ARIOToken): string;
+export declare function formatMARIOToARIOWithCommas(value: mARIOToken): string;
 /** helper to get address from --address option first, then check wallet options  */
 export declare function addressFromOptions<O extends AddressCLIOptions>(options: O): string | undefined;
 export declare function requiredAddressFromOptions<O extends AddressCLIOptions>(options: O): string;
@@ -51,8 +52,17 @@ export declare function redelegateParamsFromOptions(options: RedelegateStakeCLIO
 export declare function recordTypeFromOptions<O extends {
     type?: string;
 }>(options: O): 'lease' | 'permabuy';
-export declare function requiredMIOFromOptions<O extends GlobalCLIOptions>(options: O, key: string): mARIOToken;
-export declare function assertEnoughBalance(ario: AoARIORead, address: string, arioQuantity: ARIOToken): Promise<void>;
+export declare function requiredMARIOFromOptions<O extends GlobalCLIOptions>(options: O, key: string): mARIOToken;
+export declare function assertEnoughBalanceForArNSPurchase({ ario, address, costDetailsParams, }: {
+    ario: AoARIORead;
+    address: string;
+    costDetailsParams: AoGetCostDetailsParams;
+}): Promise<void>;
+export declare function assertEnoughMARIOBalance({ address, ario, mARIOQuantity, }: {
+    ario: AoARIORead;
+    address: string;
+    mARIOQuantity: mARIOToken | number;
+}): Promise<void>;
 export declare function confirmationPrompt(message: string): Promise<boolean>;
 export declare function assertConfirmationPrompt<O extends {
     skipConfirmation?: boolean;
@@ -65,3 +75,14 @@ export declare function requiredStringArrayFromOptions<O extends GlobalCLIOption
 export declare function positiveIntegerFromOptions<O extends GlobalCLIOptions>(options: O, key: string): number | undefined;
 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";
+    quantity: number | undefined;
+    years: number;
+    intent: "Buy-Record" | "Extend-Lease" | "Increase-Undername-Limit" | "Upgrade-Name" | "Primary-Name-Request";
+    name: string;
+    fromAddress: string | undefined;
+};
+export declare function fundFromFromOptions<O extends {
+    fundFrom?: string;
+}>(o: O): FundFrom;

package/lib/types/common/contracts/ao-process.d.ts

@@ -9,12 +9,13 @@ export declare class AOProcess implements AOContract {
         ao?: AoClient;
         logger?: ILogger;
     });
-    read<K>({ tags, retries, }: {
+    read<K>({ tags, retries, fromAddress, }: {
         tags?: Array<{
             name: string;
             value: string;
         }>;
         retries?: number;
+        fromAddress?: string;
     }): Promise<K>;
     send<K>({ tags, data, signer, retries, }: {
         tags: Array<{

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

@@ -15,7 +15,7 @@
  */
 import Arweave from 'arweave';
 import { AoArNSNameDataWithName, AoArNSReservedNameData, AoBalanceWithAddress, AoEpochDistributionData, AoEpochObservationData, AoGatewayWithAddress, AoJoinNetworkParams, AoMessageResult, AoPrimaryName, AoPrimaryNameRequest, AoRedelegationFeeInfo, AoReturnedName, AoTokenSupplyData, AoUpdateGatewaySettingsParams, AoWeightedObserver, ContractSigner, PaginationParams, PaginationResult, ProcessConfiguration, TransactionId, WalletAddress, WithSigner, WriteOptions } from '../types/index.js';
-import { AoARIORead, AoARIOWrite, AoArNSNameData, AoArNSReservedNameDataWithName, AoDelegation, AoEpochData, AoEpochSettings, AoGateway, AoGatewayDelegateWithAddress, AoGatewayRegistrySettings, AoGatewayVault, AoPaginatedAddressParams, AoRegistrationFees, AoVaultData, AoWalletVault, DemandFactorSettings, EpochInput } from '../types/io.js';
+import { AoARIORead, AoARIOWrite, AoArNSNameData, AoArNSPurchaseParams, AoArNSReservedNameDataWithName, AoBuyRecordParams, AoDelegation, AoEpochData, AoEpochSettings, AoExtendLeaseParams, AoGateway, AoGatewayDelegateWithAddress, AoGatewayRegistrySettings, AoGatewayVault, AoGetCostDetailsParams, AoIncreaseUndernameLimitParams, AoPaginatedAddressParams, AoRegistrationFees, AoVaultData, AoWalletVault, CostDetailsResult, DemandFactorSettings, EpochInput } from '../types/io.js';
 import { mARIOToken } from '../types/token.js';
 import { AOProcess } from './contracts/ao-process.js';
 export declare class ARIO {
@@ -107,6 +107,7 @@ export declare class ARIOReadable implements AoARIORead {
         intent: 'Primary-Name-Request';
         name: string;
     }): Promise<number>;
+    getCostDetails({ intent, type, years, name, quantity, fromAddress, fundFrom, }: AoGetCostDetailsParams): Promise<CostDetailsResult>;
     getRegistrationFees(): Promise<AoRegistrationFees>;
     getDemandFactor(): Promise<number>;
     getDemandFactorSettings(): Promise<DemandFactorSettings>;
@@ -190,12 +191,7 @@ export declare class ARIOWriteable extends ARIOReadable implements AoARIOWrite {
         reportTxId: TransactionId;
         failedGateways: WalletAddress[];
     }, options?: WriteOptions): Promise<AoMessageResult>;
-    buyRecord(params: {
-        name: string;
-        years?: number;
-        type: 'lease' | 'permabuy';
-        processId: string;
-    }, options?: WriteOptions): Promise<AoMessageResult>;
+    buyRecord(params: AoBuyRecordParams, options?: WriteOptions): Promise<AoMessageResult>;
     /**
      * Upgrades an existing leased record to a permabuy.
      *
@@ -204,9 +200,7 @@ export declare class ARIOWriteable extends ARIOReadable implements AoARIOWrite {
      * @param {Object} [options] - The options for the upgrade
      * @returns {Promise<AoMessageResult>} The result of the upgrade
      */
-    upgradeRecord(params: {
-        name: string;
-    }, options?: WriteOptions): Promise<AoMessageResult>;
+    upgradeRecord(params: AoArNSPurchaseParams, options?: WriteOptions): Promise<AoMessageResult>;
     /**
      * Extends the lease of an existing leased record.
      *
@@ -216,14 +210,8 @@ export declare class ARIOWriteable extends ARIOReadable implements AoARIOWrite {
      * @param {Object} [options] - The options for the extension
      * @returns {Promise<AoMessageResult>} The result of the extension
      */
-    extendLease(params: {
-        name: string;
-        years: number;
-    }, options?: WriteOptions): Promise<AoMessageResult>;
-    increaseUndernameLimit(params: {
-        name: string;
-        increaseCount: number;
-    }, options?: WriteOptions): Promise<AoMessageResult>;
+    extendLease(params: AoExtendLeaseParams, options?: WriteOptions): Promise<AoMessageResult>;
+    increaseUndernameLimit(params: AoIncreaseUndernameLimitParams, options?: WriteOptions): Promise<AoMessageResult>;
     /**
      * Cancel a withdrawal from a gateway.
      *
@@ -237,9 +225,7 @@ export declare class ARIOWriteable extends ARIOReadable implements AoARIOWrite {
         gatewayAddress?: WalletAddress;
         vaultId: string;
     }, options?: WriteOptions | undefined): Promise<AoMessageResult>;
-    requestPrimaryName(params: {
-        name: string;
-    }): Promise<AoMessageResult>;
+    requestPrimaryName(params: AoArNSPurchaseParams, options?: WriteOptions): Promise<AoMessageResult>;
     /**
      * Redelegate stake from one gateway to another gateway.
      *