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

package/lib/cjs/cli/cli.js

@@ -154,10 +154,16 @@ const utils_js_1 = require("./utils.js");
 });
 (0, utils_js_1.makeCommand)({
     name: 'get-token-cost',
-    description: 'Get token cost',
+    description: 'Get token cost for an intended action',
     options: options_js_1.tokenCostOptions,
     action: readCommands_js_1.getTokenCost,
 });
+(0, utils_js_1.makeCommand)({
+    name: 'get-cost-details',
+    description: 'Get expanded cost details for an intended action',
+    options: options_js_1.tokenCostOptions,
+    action: readCommands_js_1.getCostDetails,
+});
 (0, utils_js_1.makeCommand)({
     name: 'list-vaults',
     description: 'Get all wallet vaults',
@@ -209,7 +215,7 @@ const utils_js_1 = require("./utils.js");
         .getBalance({ address: (0, utils_js_1.requiredAddressFromOptions)(options) })
         .then((result) => ({
         address: (0, utils_js_1.requiredAddressFromOptions)(options),
-        mIOBalance: result,
+        mARIOBalance: result,
         message: `Provided address current has a balance of ${(0, utils_js_1.formatARIOWithCommas)(new token_js_1.mARIOToken(result).toARIO())} ARIO`,
     })),
 });

package/lib/cjs/cli/commands/readCommands.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getVault = exports.getGatewayVaults = exports.getPrimaryName = exports.getTokenCost = exports.getPrescribedNames = exports.getPrescribedObservers = exports.getEpoch = exports.listArNSReturnedNames = exports.getArNSReturnedName = exports.listArNSReservedNames = exports.getArNSReservedName = exports.listArNSRecords = exports.getArNSRecord = exports.getAllowedDelegates = exports.getDelegations = exports.getGatewayDelegates = exports.listGateways = exports.getGateway = void 0;
+exports.getVault = exports.getGatewayVaults = exports.getPrimaryName = exports.getCostDetails = exports.getTokenCost = exports.getPrescribedNames = exports.getPrescribedObservers = exports.getEpoch = exports.listArNSReturnedNames = exports.getArNSReturnedName = exports.listArNSReservedNames = exports.getArNSReservedName = exports.listArNSRecords = exports.getArNSRecord = exports.getAllowedDelegates = exports.getDelegations = exports.getGatewayDelegates = exports.listGateways = exports.getGateway = void 0;
 /**
  * Copyright (C) 2022-2024 Permanent Data Solutions, Inc.
  *
@@ -132,33 +132,33 @@ async function getPrescribedNames(o) {
 }
 exports.getPrescribedNames = getPrescribedNames;
 async function getTokenCost(o) {
-    o.intent ??= 'Buy-Record';
-    o.type ??= 'lease';
-    if (!(0, io_js_1.isValidIntent)(o.intent)) {
-        throw new Error(`Invalid intent. Valid intents are: ${io_js_1.validIntents.join(', ')}`);
-    }
-    if (o.type !== 'lease' && o.type !== 'permabuy') {
-        throw new Error(`Invalid type. Valid types are: lease, permabuy`);
-    }
-    if (o.type === 'lease' &&
-        io_js_1.intentsUsingYears.includes(o.intent) &&
-        o.years === undefined) {
-        throw new Error('Years is required for lease type');
-    }
-    const tokenCost = await (0, utils_js_1.readARIOFromOptions)(o).getTokenCost({
-        type: o.type,
-        quantity: o.quantity !== undefined ? +o.quantity : undefined,
-        years: o.years !== undefined ? +o.years : undefined,
-        intent: o.intent,
-        name: (0, utils_js_1.requiredStringFromOptions)(o, 'name'),
-    });
+    const tokenCost = await (0, utils_js_1.readARIOFromOptions)(o).getTokenCost((0, utils_js_1.getTokenCostParamsFromOptions)(o));
     const output = {
-        mIOTokenCost: tokenCost,
+        mARIOTokenCost: tokenCost,
         message: `The cost of the provided action is ${(0, utils_js_1.formatARIOWithCommas)(new token_js_1.mARIOToken(tokenCost).toARIO())} ARIO`,
     };
     return output;
 }
 exports.getTokenCost = getTokenCost;
+async function getCostDetails(o) {
+    if (o.fundFrom !== undefined) {
+        if (!(0, io_js_1.isValidFundFrom)(o.fundFrom)) {
+            throw new Error(`Invalid fund from: ${o.fundFrom}. Please use one of ${io_js_1.fundFromOptions.join(', ')}`);
+        }
+    }
+    const costDetails = await (0, utils_js_1.readARIOFromOptions)(o).getCostDetails({
+        ...(0, utils_js_1.getTokenCostParamsFromOptions)(o),
+        fundFrom: o.fundFrom,
+    });
+    const output = {
+        ...costDetails,
+        message: `The cost of the provided action is ${(0, utils_js_1.formatARIOWithCommas)(new token_js_1.mARIOToken(costDetails.tokenCost).toARIO())} ARIO${costDetails.fundingPlan && costDetails.fundingPlan.shortfall > 0
+            ? `. Insufficient funds for action. There is a shortfall of ${(0, utils_js_1.formatARIOWithCommas)(new token_js_1.mARIOToken(costDetails.fundingPlan.shortfall).toARIO())} ARIO`
+            : ''}`,
+    };
+    return output;
+}
+exports.getCostDetails = getCostDetails;
 async function getPrimaryName(o) {
     const address = (0, utils_js_1.addressFromOptions)(o);
     const name = o.name;

package/lib/cjs/cli/options.js

@@ -237,6 +237,10 @@ exports.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',
+    },
 };
 exports.walletOptions = [
     exports.optionMap.walletFile,
@@ -274,6 +278,8 @@ exports.tokenCostOptions = [
     exports.optionMap.type,
     exports.optionMap.years,
     exports.optionMap.quantity,
+    exports.optionMap.address,
+    exports.optionMap.fundFrom,
 ];
 exports.transferOptions = [
     ...exports.writeActionOptions,

package/lib/cjs/cli/utils.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getANTStateFromOptions = exports.requiredPositiveIntegerFromOptions = exports.positiveIntegerFromOptions = exports.requiredStringArrayFromOptions = exports.requiredStringFromOptions = exports.writeANTFromOptions = exports.readANTFromOptions = exports.requiredProcessIdFromOptions = exports.assertConfirmationPrompt = exports.confirmationPrompt = exports.assertEnoughBalance = exports.requiredMIOFromOptions = exports.recordTypeFromOptions = exports.redelegateParamsFromOptions = exports.requiredTargetAndQuantityFromOptions = exports.gatewaySettingsFromOptions = exports.writeActionTagsFromOptions = exports.requiredInitiatorFromOptions = exports.epochInputFromOptions = exports.paginationParamsFromOptions = exports.requiredAddressFromOptions = exports.addressFromOptions = exports.formatARIOWithCommas = exports.writeARIOFromOptions = exports.requiredAoSignerFromOptions = exports.requiredContractSignerFromOptions = exports.readARIOFromOptions = exports.getLoggerFromOptions = exports.jwkToAddress = exports.requiredJwkFromOptions = exports.arioProcessIdFromOptions = exports.makeCommand = exports.applyOptions = exports.runCommand = exports.stringifyJsonForCLIDisplay = void 0;
+exports.getTokenCostParamsFromOptions = exports.getANTStateFromOptions = exports.requiredPositiveIntegerFromOptions = exports.positiveIntegerFromOptions = exports.requiredStringArrayFromOptions = exports.requiredStringFromOptions = exports.writeANTFromOptions = exports.readANTFromOptions = exports.requiredProcessIdFromOptions = exports.assertConfirmationPrompt = exports.confirmationPrompt = exports.assertEnoughBalance = exports.requiredMIOFromOptions = exports.recordTypeFromOptions = exports.redelegateParamsFromOptions = exports.requiredTargetAndQuantityFromOptions = exports.gatewaySettingsFromOptions = exports.writeActionTagsFromOptions = exports.requiredInitiatorFromOptions = exports.epochInputFromOptions = exports.paginationParamsFromOptions = exports.requiredAddressFromOptions = exports.addressFromOptions = exports.formatARIOWithCommas = exports.writeARIOFromOptions = exports.requiredAoSignerFromOptions = exports.requiredContractSignerFromOptions = exports.readARIOFromOptions = exports.getLoggerFromOptions = exports.jwkToAddress = exports.requiredJwkFromOptions = exports.arioProcessIdFromOptions = exports.makeCommand = exports.applyOptions = exports.runCommand = exports.stringifyJsonForCLIDisplay = void 0;
 /**
  * Copyright (C) 2022-2024 Permanent Data Solutions, Inc.
  *
@@ -405,3 +405,23 @@ function getANTStateFromOptions(options) {
     });
 }
 exports.getANTStateFromOptions = getANTStateFromOptions;
+function getTokenCostParamsFromOptions(o) {
+    o.intent ??= 'Buy-Record';
+    o.type ??= 'lease';
+    o.years ??= '1';
+    if (!(0, index_js_1.isValidIntent)(o.intent)) {
+        throw new Error(`Invalid intent. Valid intents are: ${index_js_1.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),
+    };
+}
+exports.getTokenCostParamsFromOptions = getTokenCostParamsFromOptions;

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

@@ -31,7 +31,7 @@ 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) {
@@ -40,10 +40,14 @@ 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/cjs/common/io.js

@@ -265,7 +265,7 @@ class ARIOReadable {
             tags: (0, arweave_js_1.pruneTags)(allTags),
         });
     }
-    async getTokenCost({ intent, type, years, name, quantity, }) {
+    async getTokenCost({ intent, type, years, name, quantity, fromAddress, }) {
         const allTags = [
             { name: 'Action', value: 'Token-Cost' },
             {
@@ -302,6 +302,52 @@ class ARIOReadable {
         ];
         return this.process.read({
             tags: (0, arweave_js_1.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: (0, arweave_js_1.pruneTags)(allTags),
+            fromAddress,
         });
     }
     async getRegistrationFees() {

package/lib/cjs/types/io.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isLeasedArNSRecord = exports.isProcessIdConfiguration = exports.isProcessConfiguration = exports.isValidIntent = exports.intentsUsingYears = exports.validIntents = void 0;
+exports.isLeasedArNSRecord = exports.isProcessIdConfiguration = exports.isProcessConfiguration = exports.isValidFundFrom = exports.fundFromOptions = exports.isValidIntent = exports.intentsUsingYears = exports.validIntents = void 0;
 const arweave_js_1 = require("../utils/arweave.js");
 exports.validIntents = [
     'Buy-Record',
@@ -14,6 +14,11 @@ const isValidIntent = (intent) => {
     return exports.validIntents.indexOf(intent) !== -1;
 };
 exports.isValidIntent = isValidIntent;
+exports.fundFromOptions = ['balance', 'stakes', 'any'];
+const isValidFundFrom = (fundFrom) => {
+    return exports.fundFromOptions.indexOf(fundFrom) !== -1;
+};
+exports.isValidFundFrom = isValidFundFrom;
 // Typeguard functions
 function isProcessConfiguration(config) {
     return 'process' in config;

package/lib/cjs/version.js

@@ -17,4 +17,4 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.version = void 0;
 // AUTOMATICALLY GENERATED FILE - DO NOT TOUCH
-exports.version = '3.0.1-alpha.1';
+exports.version = '3.1.0-alpha.1';

package/lib/esm/cli/cli.js

@@ -20,7 +20,7 @@ import { spawnANT } from '../node/index.js';
 import { mARIOToken } from '../types/token.js';
 import { version } from '../version.js';
 import { cancelWithdrawal, decreaseDelegateStake, decreaseOperatorStake, delegateStake, increaseOperatorStake, instantWithdrawal, joinNetwork, leaveNetwork, redelegateStake, saveObservations, updateGatewaySettings, } from './commands/gatewayWriteCommands.js';
-import { getAllowedDelegates, getArNSRecord, getArNSReservedName, getArNSReturnedName, getDelegations, getEpoch, getGateway, getGatewayDelegates, getGatewayVaults, getPrescribedNames, getPrescribedObservers, getPrimaryName, getTokenCost, getVault, listArNSRecords, listArNSReservedNames, listArNSReturnedNames, listGateways, } from './commands/readCommands.js';
+import { getAllowedDelegates, getArNSRecord, getArNSReservedName, getArNSReturnedName, getCostDetails, getDelegations, getEpoch, getGateway, getGatewayDelegates, getGatewayVaults, getPrescribedNames, getPrescribedObservers, getPrimaryName, getTokenCost, getVault, listArNSRecords, listArNSReservedNames, listArNSReturnedNames, listGateways, } from './commands/readCommands.js';
 import { transfer } from './commands/transfer.js';
 import { addressAndVaultIdOptions, addressOptions, antStateOptions, buyRecordOptions, decreaseDelegateStakeOptions, delegateStakeOptions, epochOptions, getVaultOptions, globalOptions, initiatorOptions, joinNetworkOptions, nameOptions, nameWriteOptions, operatorStakeOptions, optionMap, paginationAddressOptions, paginationOptions, redelegateStakeOptions, tokenCostOptions, transferOptions, updateGatewaySettingsOptions, writeActionOptions, } from './options.js';
 import { applyOptions, arioProcessIdFromOptions, assertConfirmationPrompt, epochInputFromOptions, formatARIOWithCommas, getANTStateFromOptions, getLoggerFromOptions, makeCommand, paginationParamsFromOptions, positiveIntegerFromOptions, readANTFromOptions, readARIOFromOptions, recordTypeFromOptions, requiredAddressFromOptions, requiredAoSignerFromOptions, requiredPositiveIntegerFromOptions, requiredStringArrayFromOptions, requiredStringFromOptions, writeANTFromOptions, writeARIOFromOptions, writeActionTagsFromOptions, } from './utils.js';
@@ -152,10 +152,16 @@ makeCommand({
 });
 makeCommand({
     name: 'get-token-cost',
-    description: 'Get token cost',
+    description: 'Get token cost for an intended action',
     options: tokenCostOptions,
     action: getTokenCost,
 });
+makeCommand({
+    name: 'get-cost-details',
+    description: 'Get expanded cost details for an intended action',
+    options: tokenCostOptions,
+    action: getCostDetails,
+});
 makeCommand({
     name: 'list-vaults',
     description: 'Get all wallet vaults',
@@ -207,7 +213,7 @@ makeCommand({
         .getBalance({ address: requiredAddressFromOptions(options) })
         .then((result) => ({
         address: requiredAddressFromOptions(options),
-        mIOBalance: result,
+        mARIOBalance: result,
         message: `Provided address current has a balance of ${formatARIOWithCommas(new mARIOToken(result).toARIO())} ARIO`,
     })),
 });

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

@@ -13,9 +13,9 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { intentsUsingYears, isValidIntent, validIntents, } from '../../types/io.js';
+import { fundFromOptions, isValidFundFrom, } from '../../types/io.js';
 import { mARIOToken } from '../../types/token.js';
-import { addressFromOptions, epochInputFromOptions, formatARIOWithCommas, paginationParamsFromOptions, readARIOFromOptions, requiredAddressFromOptions, requiredStringFromOptions, } from '../utils.js';
+import { addressFromOptions, epochInputFromOptions, formatARIOWithCommas, getTokenCostParamsFromOptions, paginationParamsFromOptions, readARIOFromOptions, requiredAddressFromOptions, requiredStringFromOptions, } from '../utils.js';
 export async function getGateway(o) {
     const address = requiredAddressFromOptions(o);
     const gateway = await readARIOFromOptions(o).getGateway({
@@ -115,29 +115,28 @@ export async function getPrescribedNames(o) {
         : { message: `No prescribed names found for epoch ${epoch}` };
 }
 export async function getTokenCost(o) {
-    o.intent ??= 'Buy-Record';
-    o.type ??= 'lease';
-    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`);
-    }
-    if (o.type === 'lease' &&
-        intentsUsingYears.includes(o.intent) &&
-        o.years === undefined) {
-        throw new Error('Years is required for lease type');
+    const tokenCost = await readARIOFromOptions(o).getTokenCost(getTokenCostParamsFromOptions(o));
+    const output = {
+        mARIOTokenCost: tokenCost,
+        message: `The cost of the provided action is ${formatARIOWithCommas(new mARIOToken(tokenCost).toARIO())} ARIO`,
+    };
+    return output;
+}
+export async function getCostDetails(o) {
+    if (o.fundFrom !== undefined) {
+        if (!isValidFundFrom(o.fundFrom)) {
+            throw new Error(`Invalid fund from: ${o.fundFrom}. Please use one of ${fundFromOptions.join(', ')}`);
+        }
     }
-    const tokenCost = await readARIOFromOptions(o).getTokenCost({
-        type: o.type,
-        quantity: o.quantity !== undefined ? +o.quantity : undefined,
-        years: o.years !== undefined ? +o.years : undefined,
-        intent: o.intent,
-        name: requiredStringFromOptions(o, 'name'),
+    const costDetails = await readARIOFromOptions(o).getCostDetails({
+        ...getTokenCostParamsFromOptions(o),
+        fundFrom: o.fundFrom,
     });
     const output = {
-        mIOTokenCost: tokenCost,
-        message: `The cost of the provided action is ${formatARIOWithCommas(new mARIOToken(tokenCost).toARIO())} ARIO`,
+        ...costDetails,
+        message: `The cost of the provided action is ${formatARIOWithCommas(new mARIOToken(costDetails.tokenCost).toARIO())} ARIO${costDetails.fundingPlan && costDetails.fundingPlan.shortfall > 0
+            ? `. Insufficient funds for action. There is a shortfall of ${formatARIOWithCommas(new mARIOToken(costDetails.fundingPlan.shortfall).toARIO())} ARIO`
+            : ''}`,
     };
     return output;
 }

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,
@@ -271,6 +275,8 @@ export const tokenCostOptions = [
     optionMap.type,
     optionMap.years,
     optionMap.quantity,
+    optionMap.address,
+    optionMap.fundFrom,
 ];
 export const transferOptions = [
     ...writeActionOptions,

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, initANTStateForAddress, isValidIntent, mARIOToken, sha256B64Url, validIntents, } from '../node/index.js';
 import { globalOptions } from './options.js';
 export function stringifyJsonForCLIDisplay(json) {
     return JSON.stringify(json, null, 2);
@@ -364,3 +364,22 @@ 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),
+    };
+}

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() {

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.1';

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;

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 { 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 {
@@ -65,3 +65,11 @@ 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;
+};

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, AoArNSReservedNameDataWithName, AoDelegation, AoEpochData, AoEpochSettings, AoGateway, AoGatewayDelegateWithAddress, AoGatewayRegistrySettings, AoGatewayVault, AoGetCostDetailsParams, 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>;