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

package/lib/cjs/cli/cli.js

@@ -21,6 +21,7 @@ const commander_1 = require("commander");
 const index_js_1 = require("../node/index.js");
 const token_js_1 = require("../types/token.js");
 const version_js_1 = require("../version.js");
+const arnsPurchaseCommands_js_1 = require("./commands/arnsPurchaseCommands.js");
 const gatewayWriteCommands_js_1 = require("./commands/gatewayWriteCommands.js");
 const readCommands_js_1 = require("./commands/readCommands.js");
 const transfer_js_1 = require("./commands/transfer.js");
@@ -54,7 +55,7 @@ const utils_js_1 = require("./utils.js");
 (0, utils_js_1.makeCommand)({
     name: 'get-gateway',
     description: 'Get the gateway of an address',
-    options: options_js_1.addressOptions,
+    options: [options_js_1.optionMap.address],
     action: readCommands_js_1.getGateway,
 });
 (0, utils_js_1.makeCommand)({
@@ -72,7 +73,7 @@ const utils_js_1 = require("./utils.js");
 (0, utils_js_1.makeCommand)({
     name: 'get-delegations',
     description: 'Get all stake delegated to gateways from this address',
-    options: options_js_1.addressOptions,
+    options: [options_js_1.optionMap.address],
     action: readCommands_js_1.getDelegations,
 });
 (0, utils_js_1.makeCommand)({
@@ -84,7 +85,7 @@ const utils_js_1 = require("./utils.js");
 (0, utils_js_1.makeCommand)({
     name: 'get-arns-record',
     description: 'Get an ArNS record by name',
-    options: options_js_1.nameOptions,
+    options: [options_js_1.optionMap.name],
     action: readCommands_js_1.getArNSRecord,
 });
 (0, utils_js_1.makeCommand)({
@@ -96,7 +97,7 @@ const utils_js_1 = require("./utils.js");
 (0, utils_js_1.makeCommand)({
     name: 'get-arns-reserved-name',
     description: 'Get a reserved ArNS name',
-    options: options_js_1.nameOptions,
+    options: [options_js_1.optionMap.name],
     action: readCommands_js_1.getArNSReservedName,
 });
 (0, utils_js_1.makeCommand)({
@@ -108,7 +109,7 @@ const utils_js_1 = require("./utils.js");
 (0, utils_js_1.makeCommand)({
     name: 'get-arns-returned-name',
     description: 'Get an ArNS returned name by name',
-    options: options_js_1.nameOptions,
+    options: [options_js_1.optionMap.name],
     action: readCommands_js_1.getArNSReturnedName,
 });
 (0, utils_js_1.makeCommand)({
@@ -154,10 +155,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',
@@ -170,7 +177,7 @@ const utils_js_1 = require("./utils.js");
 (0, utils_js_1.makeCommand)({
     name: 'get-primary-name-request',
     description: 'Get primary name request',
-    options: options_js_1.initiatorOptions,
+    options: [options_js_1.optionMap.initiator],
     action: (o) => (0, utils_js_1.readARIOFromOptions)(o)
         .getPrimaryNameRequest({
         initiator: (0, utils_js_1.requiredStringFromOptions)(o, 'initiator'),
@@ -190,7 +197,7 @@ const utils_js_1 = require("./utils.js");
 (0, utils_js_1.makeCommand)({
     name: 'get-primary-name',
     description: 'Get primary name',
-    options: [...options_js_1.addressOptions, options_js_1.optionMap.name],
+    options: [options_js_1.optionMap.address, options_js_1.optionMap.name],
     action: readCommands_js_1.getPrimaryName,
 });
 (0, utils_js_1.makeCommand)({
@@ -204,12 +211,12 @@ const utils_js_1 = require("./utils.js");
 (0, utils_js_1.makeCommand)({
     name: 'balance',
     description: 'Get the balance of an address',
-    options: options_js_1.addressOptions,
+    options: [options_js_1.optionMap.address],
     action: (options) => (0, utils_js_1.readARIOFromOptions)(options)
         .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`,
     })),
 });
@@ -224,7 +231,7 @@ const utils_js_1 = require("./utils.js");
 (0, utils_js_1.makeCommand)({
     name: 'get-redelegation-fee',
     description: 'Get redelegation fee',
-    options: options_js_1.addressOptions,
+    options: [options_js_1.optionMap.address],
     action: (options) => (0, utils_js_1.readARIOFromOptions)(options).getRedelegationFee({
         address: (0, utils_js_1.requiredAddressFromOptions)(options),
     }),
@@ -320,82 +327,31 @@ const utils_js_1 = require("./utils.js");
     name: 'buy-record',
     description: 'Buy a record',
     options: options_js_1.buyRecordOptions,
-    action: async (options) => {
-        const ario = (0, utils_js_1.writeARIOFromOptions)(options).ario;
-        const name = (0, utils_js_1.requiredStringFromOptions)(options, 'name');
-        const type = (0, utils_js_1.recordTypeFromOptions)(options);
-        const years = (0, utils_js_1.positiveIntegerFromOptions)(options, 'years');
-        // TODO: Assert balance is sufficient for action
-        // TODO: Assert record is not already owned
-        const processId = options.processId;
-        if (processId === undefined) {
-            // TODO: Spawn ANT process, register it to ANT registry, get process ID
-            throw new Error('Process ID must be provided for buy-record');
-        }
-        await (0, utils_js_1.assertConfirmationPrompt)(`Are you sure you want to ${type} the record ${name}?`, options);
-        return ario.buyRecord({
-            name: (0, utils_js_1.requiredStringFromOptions)(options, 'name'),
-            processId,
-            type,
-            years,
-        });
-    },
+    action: arnsPurchaseCommands_js_1.buyRecordCLICommand,
 });
 (0, utils_js_1.makeCommand)({
     name: 'upgrade-record',
     description: 'Upgrade the lease of a record to a permabuy',
-    options: [...options_js_1.nameOptions, ...options_js_1.writeActionOptions],
-    // TODO: could assert record is leased by sender, assert balance is sufficient
-    action: async (options) => {
-        const name = (0, utils_js_1.requiredStringFromOptions)(options, 'name');
-        await (0, utils_js_1.assertConfirmationPrompt)(`Are you sure you want to upgrade the lease of ${name} to a permabuy?`, options);
-        return (0, utils_js_1.writeARIOFromOptions)(options).ario.upgradeRecord({
-            name,
-        });
-    },
+    options: options_js_1.arnsPurchaseOptions,
+    action: arnsPurchaseCommands_js_1.upgradeRecordCLICommand,
 });
 (0, utils_js_1.makeCommand)({
     name: 'extend-lease',
     description: 'Extend the lease of a record',
-    options: [...options_js_1.writeActionOptions, options_js_1.optionMap.name, options_js_1.optionMap.years],
-    action: async (options) => {
-        const name = (0, utils_js_1.requiredStringFromOptions)(options, 'name');
-        const years = (0, utils_js_1.requiredPositiveIntegerFromOptions)(options, 'years');
-        await (0, utils_js_1.assertConfirmationPrompt)(`Are you sure you want to extend the lease of ${name} by ${years}?`, options);
-        return (0, utils_js_1.writeARIOFromOptions)(options).ario.extendLease({
-            name,
-            years,
-        }, (0, utils_js_1.writeActionTagsFromOptions)(options));
-    },
+    options: [...options_js_1.arnsPurchaseOptions, options_js_1.optionMap.years],
+    action: arnsPurchaseCommands_js_1.extendLeaseCLICommand,
 });
 (0, utils_js_1.makeCommand)({
     name: 'increase-undername-limit',
     description: 'Increase the limit of a name',
-    options: [...options_js_1.writeActionOptions, options_js_1.optionMap.name, options_js_1.optionMap.increaseCount],
-    action: async (options) => {
-        const name = (0, utils_js_1.requiredStringFromOptions)(options, 'name');
-        const increaseCount = (0, utils_js_1.requiredPositiveIntegerFromOptions)(options, 'increaseCount');
-        await (0, utils_js_1.assertConfirmationPrompt)(`Are you sure you want to increase the undername limit of ${name} by ${increaseCount}?`, options);
-        return (0, utils_js_1.writeARIOFromOptions)(options).ario.increaseUndernameLimit({
-            name,
-            increaseCount,
-        }, (0, utils_js_1.writeActionTagsFromOptions)(options));
-    },
+    options: [...options_js_1.arnsPurchaseOptions, options_js_1.optionMap.increaseCount],
+    action: arnsPurchaseCommands_js_1.increaseUndernameLimitCLICommand,
 });
 (0, utils_js_1.makeCommand)({
     name: 'request-primary-name',
     description: 'Request a primary name',
-    options: options_js_1.nameWriteOptions,
-    action: async (options) => {
-        // TODO: Assert balance is sufficient for action?
-        // TODO: Assert name requested is not already owned
-        // TODO: More assertions?
-        const name = (0, utils_js_1.requiredStringFromOptions)(options, 'name');
-        await (0, utils_js_1.assertConfirmationPrompt)(`Are you sure you want to request the primary name ${name}?`, options);
-        return (0, utils_js_1.writeARIOFromOptions)(options).ario.requestPrimaryName({
-            name,
-        });
-    },
+    options: options_js_1.arnsPurchaseOptions,
+    action: arnsPurchaseCommands_js_1.requestPrimaryNameCLICommand,
 });
 (0, utils_js_1.makeCommand)({
     name: 'spawn-ant',

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

@@ -0,0 +1,167 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.requestPrimaryNameCLICommand = exports.increaseUndernameLimitCLICommand = exports.extendLeaseCLICommand = exports.upgradeRecordCLICommand = exports.buyRecordCLICommand = void 0;
+const utils_js_1 = require("../utils.js");
+async function buyRecordCLICommand(o) {
+    const { ario, signerAddress } = (0, utils_js_1.writeARIOFromOptions)(o);
+    const name = (0, utils_js_1.requiredStringFromOptions)(o, 'name');
+    const type = (0, utils_js_1.recordTypeFromOptions)(o);
+    const years = (0, utils_js_1.positiveIntegerFromOptions)(o, 'years');
+    const fundFrom = (0, utils_js_1.fundFromFromOptions)(o);
+    const processId = o.processId;
+    if (processId === undefined) {
+        // TODO: Spawn ANT process, register it to ANT registry, get process ID
+        throw new Error('Process ID must be provided for buy-record');
+    }
+    if (!o.skipConfirmation) {
+        const existingRecord = await ario.getArNSRecord({
+            name,
+        });
+        if (existingRecord !== undefined) {
+            throw new Error(`ArNS Record ${name} is already owned`);
+        }
+        await (0, utils_js_1.assertEnoughBalanceForArNSPurchase)({
+            ario,
+            address: signerAddress,
+            costDetailsParams: {
+                intent: 'Buy-Record',
+                type,
+                name,
+                years,
+                fundFrom,
+                fromAddress: signerAddress,
+            },
+        });
+        await (0, utils_js_1.assertConfirmationPrompt)(`Are you sure you want to ${type} the record ${name}?`, o);
+    }
+    return ario.buyRecord({
+        name: (0, utils_js_1.requiredStringFromOptions)(o, 'name'),
+        processId,
+        type,
+        years,
+        fundFrom: (0, utils_js_1.fundFromFromOptions)(o),
+    }, (0, utils_js_1.writeActionTagsFromOptions)(o));
+}
+exports.buyRecordCLICommand = buyRecordCLICommand;
+async function upgradeRecordCLICommand(o) {
+    const name = (0, utils_js_1.requiredStringFromOptions)(o, 'name');
+    const { ario, signerAddress } = (0, utils_js_1.writeARIOFromOptions)(o);
+    const fundFrom = (0, utils_js_1.fundFromFromOptions)(o);
+    if (!o.skipConfirmation) {
+        const existingRecord = await ario.getArNSRecord({
+            name,
+        });
+        if (existingRecord === undefined) {
+            throw new Error(`ArNS Record ${name} does not exist`);
+        }
+        if (existingRecord.type === 'permabuy') {
+            throw new Error(`ArNS Record ${name} is already a permabuy`);
+        }
+        await (0, utils_js_1.assertEnoughBalanceForArNSPurchase)({
+            ario,
+            address: signerAddress,
+            costDetailsParams: {
+                intent: 'Upgrade-Name',
+                name,
+                fundFrom,
+                fromAddress: signerAddress,
+            },
+        });
+        await (0, utils_js_1.assertConfirmationPrompt)(`Are you sure you want to upgrade the lease of ${name} to a permabuy?`, o);
+    }
+    return ario.upgradeRecord({
+        name,
+        fundFrom,
+    });
+}
+exports.upgradeRecordCLICommand = upgradeRecordCLICommand;
+async function extendLeaseCLICommand(o) {
+    const name = (0, utils_js_1.requiredStringFromOptions)(o, 'name');
+    const years = (0, utils_js_1.requiredPositiveIntegerFromOptions)(o, 'years');
+    const fundFrom = (0, utils_js_1.fundFromFromOptions)(o);
+    const { ario, signerAddress } = (0, utils_js_1.writeARIOFromOptions)(o);
+    if (!o.skipConfirmation) {
+        const existingRecord = await ario.getArNSRecord({
+            name,
+        });
+        if (existingRecord === undefined) {
+            throw new Error(`ArNS Record ${name} does not exist`);
+        }
+        if (existingRecord.type === 'permabuy') {
+            throw new Error(`ArNS Record ${name} is a permabuy and cannot be extended`);
+        }
+        await (0, utils_js_1.assertEnoughBalanceForArNSPurchase)({
+            ario: ario,
+            address: signerAddress,
+            costDetailsParams: {
+                intent: 'Extend-Lease',
+                name,
+                years,
+                fundFrom,
+                fromAddress: signerAddress,
+            },
+        });
+        await (0, utils_js_1.assertConfirmationPrompt)(`Are you sure you want to extend the lease of ${name} by ${years}?`, o);
+    }
+    return ario.extendLease({
+        name,
+        years,
+    }, (0, utils_js_1.writeActionTagsFromOptions)(o));
+}
+exports.extendLeaseCLICommand = extendLeaseCLICommand;
+async function increaseUndernameLimitCLICommand(o) {
+    const name = (0, utils_js_1.requiredStringFromOptions)(o, 'name');
+    const increaseCount = (0, utils_js_1.requiredPositiveIntegerFromOptions)(o, 'increaseCount');
+    const fundFrom = (0, utils_js_1.fundFromFromOptions)(o);
+    const { ario, signerAddress } = (0, utils_js_1.writeARIOFromOptions)(o);
+    if (!o.skipConfirmation) {
+        const existingRecord = await ario.getArNSRecord({
+            name,
+        });
+        if (existingRecord === undefined) {
+            throw new Error(`ArNS Record ${name} does not exist`);
+        }
+        await (0, utils_js_1.assertEnoughBalanceForArNSPurchase)({
+            ario,
+            address: signerAddress,
+            costDetailsParams: {
+                intent: 'Increase-Undername-Limit',
+                name,
+                quantity: increaseCount,
+                fundFrom,
+                fromAddress: signerAddress,
+            },
+        });
+        await (0, utils_js_1.assertConfirmationPrompt)(`Are you sure you want to increase the undername limit of ${name} by ${increaseCount}?`, o);
+    }
+    return ario.increaseUndernameLimit({
+        name,
+        increaseCount,
+    }, (0, utils_js_1.writeActionTagsFromOptions)(o));
+}
+exports.increaseUndernameLimitCLICommand = increaseUndernameLimitCLICommand;
+async function requestPrimaryNameCLICommand(o) {
+    const { ario, signerAddress } = (0, utils_js_1.writeARIOFromOptions)(o);
+    const fundFrom = (0, utils_js_1.fundFromFromOptions)(o);
+    const name = (0, utils_js_1.requiredStringFromOptions)(o, 'name');
+    if (!o.skipConfirmation) {
+        // TODO: Assert name requested is not already owned?
+        // TODO: More assertions?
+        await (0, utils_js_1.assertEnoughBalanceForArNSPurchase)({
+            ario,
+            address: signerAddress,
+            costDetailsParams: {
+                intent: 'Primary-Name-Request',
+                name,
+                fromAddress: signerAddress,
+                fundFrom,
+            },
+        });
+        await (0, utils_js_1.assertConfirmationPrompt)(`Are you sure you want to request the primary name ${name}?`, o);
+    }
+    return ario.requestPrimaryName({
+        name,
+        fundFrom,
+    }, (0, utils_js_1.writeActionTagsFromOptions)(o));
+}
+exports.requestPrimaryNameCLICommand = requestPrimaryNameCLICommand;

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

@@ -24,7 +24,7 @@ const index_js_1 = require("../../node/index.js");
 const utils_js_1 = require("../utils.js");
 async function joinNetwork(options) {
     const { ario, signerAddress } = (0, utils_js_1.writeARIOFromOptions)(options);
-    const mARIOQuantity = (0, utils_js_1.requiredMIOFromOptions)(options, 'operatorStake');
+    const mARIOQuantity = (0, utils_js_1.requiredMARIOFromOptions)(options, 'operatorStake');
     const settings = {
         ...(0, utils_js_1.gatewaySettingsFromOptions)(options),
         operatorStake: mARIOQuantity.valueOf(),
@@ -40,7 +40,11 @@ async function joinNetwork(options) {
         if (settings.operators.minStake > mARIOQuantity.valueOf()) {
             throw new Error(`The minimum operator stake is ${(0, utils_js_1.formatARIOWithCommas)(new index_js_1.mARIOToken(settings.operators.minStake).toARIO())} ARIO. Please provide a higher stake.`);
         }
-        await (0, utils_js_1.assertEnoughBalance)(ario, signerAddress, mARIOQuantity.toARIO());
+        await (0, utils_js_1.assertEnoughMARIOBalance)({
+            ario,
+            address: signerAddress,
+            mARIOQuantity,
+        });
         await (0, utils_js_1.assertConfirmationPrompt)(`Gateway Settings:\n\n${JSON.stringify(settings, null, 2)}\n\nYou are about to stake ${(0, utils_js_1.formatARIOWithCommas)(mARIOQuantity.toARIO())} ARIO to join the AR.IO network\nAre you sure?\n`, options);
     }
     const result = await ario.joinNetwork(settings, (0, utils_js_1.writeActionTagsFromOptions)(options));
@@ -95,7 +99,7 @@ async function saveObservations(o) {
 }
 exports.saveObservations = saveObservations;
 async function increaseOperatorStake(o) {
-    const increaseQty = (0, utils_js_1.requiredMIOFromOptions)(o, 'operatorStake');
+    const increaseQty = (0, utils_js_1.requiredMARIOFromOptions)(o, 'operatorStake');
     await (0, utils_js_1.assertConfirmationPrompt)(`You are about to increase your operator stake by ${(0, utils_js_1.formatARIOWithCommas)(increaseQty.toARIO())} ARIO\nAre you sure?`, o);
     return ((0, utils_js_1.writeARIOFromOptions)(o).ario.increaseOperatorStake({
         increaseQty,
@@ -104,7 +108,7 @@ async function increaseOperatorStake(o) {
 }
 exports.increaseOperatorStake = increaseOperatorStake;
 async function decreaseOperatorStake(o) {
-    const decreaseQty = (0, utils_js_1.requiredMIOFromOptions)(o, 'operatorStake');
+    const decreaseQty = (0, utils_js_1.requiredMARIOFromOptions)(o, 'operatorStake');
     // TODO: Can assert stake is sufficient for action, and new target stake meets contract minimum
     await (0, utils_js_1.assertConfirmationPrompt)(`You are about to decrease your operator stake by ${(0, utils_js_1.formatARIOWithCommas)(decreaseQty.toARIO())} ARIO\nAre you sure?`, o);
     return (0, utils_js_1.writeARIOFromOptions)(o).ario.decreaseOperatorStake({

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

@@ -1,22 +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;
-/**
- * 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.
- */
-const io_js_1 = require("../../types/io.js");
+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;
 const token_js_1 = require("../../types/token.js");
 const utils_js_1 = require("../utils.js");
 async function getGateway(o) {
@@ -132,33 +116,28 @@ 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) {
+    const costDetails = await (0, utils_js_1.readARIOFromOptions)(o).getCostDetails({
+        ...(0, utils_js_1.getTokenCostParamsFromOptions)(o),
+        fundFrom: (0, utils_js_1.fundFromFromOptions)(o),
+    });
+    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/commands/transfer.js

@@ -6,7 +6,11 @@ async function transfer(options) {
     const { target, arioQuantity } = (0, utils_js_1.requiredTargetAndQuantityFromOptions)(options);
     const { ario, signerAddress } = (0, utils_js_1.writeARIOFromOptions)(options);
     if (!options.skipConfirmation) {
-        await (0, utils_js_1.assertEnoughBalance)(ario, signerAddress, arioQuantity);
+        await (0, utils_js_1.assertEnoughMARIOBalance)({
+            ario,
+            address: signerAddress,
+            mARIOQuantity: arioQuantity.toMARIO(),
+        });
         const confirm = await (0, utils_js_1.confirmationPrompt)(`Are you sure you want to transfer ${(0, utils_js_1.formatARIOWithCommas)(arioQuantity)} ARIO to ${target}?`);
         if (!confirm) {
             return { message: 'Transfer aborted by user' };

package/lib/cjs/cli/options.js

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.antStateOptions = exports.buyRecordOptions = exports.joinNetworkOptions = exports.updateGatewaySettingsOptions = exports.decreaseDelegateStakeOptions = exports.delegateStakeOptions = exports.redelegateStakeOptions = exports.operatorStakeOptions = exports.transferOptions = exports.tokenCostOptions = exports.getVaultOptions = exports.paginationAddressOptions = exports.paginationOptions = exports.nameWriteOptions = exports.addressAndVaultIdOptions = exports.epochOptions = exports.initiatorOptions = exports.nameOptions = exports.addressOptions = exports.writeActionOptions = exports.globalOptions = exports.walletOptions = exports.optionMap = void 0;
+exports.antStateOptions = exports.buyRecordOptions = exports.joinNetworkOptions = exports.updateGatewaySettingsOptions = exports.decreaseDelegateStakeOptions = exports.delegateStakeOptions = exports.redelegateStakeOptions = exports.operatorStakeOptions = exports.transferOptions = exports.tokenCostOptions = exports.getVaultOptions = exports.paginationAddressOptions = exports.paginationOptions = exports.nameWriteOptions = exports.addressAndVaultIdOptions = exports.epochOptions = exports.arnsPurchaseOptions = exports.writeActionOptions = exports.globalOptions = exports.walletOptions = exports.optionMap = void 0;
 exports.optionMap = {
     walletFile: {
         alias: '-w, --wallet-file <walletFilePath>',
@@ -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,
@@ -251,11 +255,13 @@ exports.globalOptions = [
     exports.optionMap.cuUrl,
 ];
 exports.writeActionOptions = [exports.optionMap.skipConfirmation, exports.optionMap.tags];
-exports.addressOptions = [exports.optionMap.address];
-exports.nameOptions = [exports.optionMap.name];
-exports.initiatorOptions = [exports.optionMap.initiator];
+exports.arnsPurchaseOptions = [
+    ...exports.writeActionOptions,
+    exports.optionMap.name,
+    exports.optionMap.fundFrom,
+];
 exports.epochOptions = [exports.optionMap.epochIndex, exports.optionMap.timestamp];
-exports.addressAndVaultIdOptions = [...exports.addressOptions, exports.optionMap.vaultId];
+exports.addressAndVaultIdOptions = [exports.optionMap.address, exports.optionMap.vaultId];
 exports.nameWriteOptions = [...exports.writeActionOptions, exports.optionMap.name];
 exports.paginationOptions = [
     exports.optionMap.cursor,
@@ -274,6 +280,8 @@ exports.tokenCostOptions = [
     exports.optionMap.type,
     exports.optionMap.years,
     exports.optionMap.quantity,
+    exports.optionMap.address,
+    exports.optionMap.fundFrom,
 ];
 exports.transferOptions = [
     ...exports.writeActionOptions,
@@ -310,8 +318,7 @@ exports.joinNetworkOptions = [
     exports.optionMap.operatorStake,
 ];
 exports.buyRecordOptions = [
-    ...exports.writeActionOptions,
-    exports.optionMap.name,
+    ...exports.arnsPurchaseOptions,
     exports.optionMap.quantity,
     exports.optionMap.type,
     exports.optionMap.years,

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.fundFromFromOptions = exports.getTokenCostParamsFromOptions = exports.getANTStateFromOptions = exports.requiredPositiveIntegerFromOptions = exports.positiveIntegerFromOptions = exports.requiredStringArrayFromOptions = exports.requiredStringFromOptions = exports.writeANTFromOptions = exports.readANTFromOptions = exports.requiredProcessIdFromOptions = exports.assertConfirmationPrompt = exports.confirmationPrompt = exports.assertEnoughMARIOBalance = exports.assertEnoughBalanceForArNSPurchase = exports.requiredMARIOFromOptions = exports.recordTypeFromOptions = exports.redelegateParamsFromOptions = exports.requiredTargetAndQuantityFromOptions = exports.gatewaySettingsFromOptions = exports.writeActionTagsFromOptions = exports.requiredInitiatorFromOptions = exports.epochInputFromOptions = exports.paginationParamsFromOptions = exports.requiredAddressFromOptions = exports.addressFromOptions = exports.formatMARIOToARIOWithCommas = 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.
  *
@@ -160,6 +160,10 @@ function formatARIOWithCommas(value) {
     return integerWithCommas + '.' + decimalPart;
 }
 exports.formatARIOWithCommas = formatARIOWithCommas;
+function formatMARIOToARIOWithCommas(value) {
+    return formatARIOWithCommas(value.toARIO());
+}
+exports.formatMARIOToARIOWithCommas = formatMARIOToARIOWithCommas;
 /** helper to get address from --address option first, then check wallet options  */
 function addressFromOptions(options) {
     if (options.address !== undefined) {
@@ -294,20 +298,39 @@ function recordTypeFromOptions(options) {
     return options.type;
 }
 exports.recordTypeFromOptions = recordTypeFromOptions;
-function requiredMIOFromOptions(options, key) {
+function requiredMARIOFromOptions(options, key) {
     if (options[key] === undefined) {
         throw new Error(`No ${key} provided. Use --${key} denominated in ARIO`);
     }
     return new index_js_1.ARIOToken(+options[key]).toMARIO();
 }
-exports.requiredMIOFromOptions = requiredMIOFromOptions;
-async function assertEnoughBalance(ario, address, arioQuantity) {
+exports.requiredMARIOFromOptions = requiredMARIOFromOptions;
+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 index_js_1.mARIOToken(costDetails.fundingPlan.shortfall))}\n${JSON.stringify(costDetails, null, 2)}`);
+        }
+    }
+    else {
+        await assertEnoughMARIOBalance({
+            ario,
+            address,
+            mARIOQuantity: costDetails.tokenCost,
+        });
+    }
+}
+exports.assertEnoughBalanceForArNSPurchase = assertEnoughBalanceForArNSPurchase;
+async function assertEnoughMARIOBalance({ address, ario, mARIOQuantity, }) {
+    if (typeof mARIOQuantity === 'number') {
+        mARIOQuantity = new index_js_1.mARIOToken(mARIOQuantity);
+    }
     const balance = await ario.getBalance({ address });
-    if (balance < arioQuantity.toMARIO().valueOf()) {
-        throw new Error(`Insufficient ARIO balance for action. Balance available: ${new index_js_1.mARIOToken(balance).toARIO()} ARIO`);
+    if (balance < mARIOQuantity.valueOf()) {
+        throw new Error(`Insufficient ARIO balance for action. Balance available: ${formatMARIOToARIOWithCommas(new index_js_1.mARIOToken(balance))} ARIO`);
     }
 }
-exports.assertEnoughBalance = assertEnoughBalance;
+exports.assertEnoughMARIOBalance = assertEnoughMARIOBalance;
 async function confirmationPrompt(message) {
     const { confirm } = await (0, prompts_1.default)({
         type: 'confirm',
@@ -405,3 +428,32 @@ 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;
+function fundFromFromOptions(o) {
+    if (o.fundFrom !== undefined) {
+        if (!(0, index_js_1.isValidFundFrom)(o.fundFrom)) {
+            throw new Error(`Invalid fund from: ${o.fundFrom}. Please use one of ${index_js_1.fundFromOptions.join(', ')}`);
+        }
+    }
+    return o.fundFrom ?? 'balance';
+}
+exports.fundFromFromOptions = fundFromFromOptions;