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

package/lib/esm/cli/cli.js

@@ -19,11 +19,12 @@ import { program } from 'commander';
 import { spawnANT } from '../node/index.js';
 import { mARIOToken } from '../types/token.js';
 import { version } from '../version.js';
+import { buyRecordCLICommand, extendLeaseCLICommand, increaseUndernameLimitCLICommand, requestPrimaryNameCLICommand, upgradeRecordCLICommand, } from './commands/arnsPurchaseCommands.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';
+import { addressAndVaultIdOptions, antStateOptions, arnsPurchaseOptions, buyRecordOptions, decreaseDelegateStakeOptions, delegateStakeOptions, epochOptions, getVaultOptions, globalOptions, joinNetworkOptions, operatorStakeOptions, optionMap, paginationAddressOptions, paginationOptions, redelegateStakeOptions, tokenCostOptions, transferOptions, updateGatewaySettingsOptions, writeActionOptions, } from './options.js';
+import { applyOptions, arioProcessIdFromOptions, assertConfirmationPrompt, epochInputFromOptions, formatARIOWithCommas, getANTStateFromOptions, getLoggerFromOptions, makeCommand, paginationParamsFromOptions, readANTFromOptions, readARIOFromOptions, requiredAddressFromOptions, requiredAoSignerFromOptions, requiredStringArrayFromOptions, requiredStringFromOptions, writeANTFromOptions, writeActionTagsFromOptions, } from './utils.js';
 applyOptions(program
     .name('ar.io')
     .version(version)
@@ -52,7 +53,7 @@ makeCommand({
 makeCommand({
     name: 'get-gateway',
     description: 'Get the gateway of an address',
-    options: addressOptions,
+    options: [optionMap.address],
     action: getGateway,
 });
 makeCommand({
@@ -70,7 +71,7 @@ makeCommand({
 makeCommand({
     name: 'get-delegations',
     description: 'Get all stake delegated to gateways from this address',
-    options: addressOptions,
+    options: [optionMap.address],
     action: getDelegations,
 });
 makeCommand({
@@ -82,7 +83,7 @@ makeCommand({
 makeCommand({
     name: 'get-arns-record',
     description: 'Get an ArNS record by name',
-    options: nameOptions,
+    options: [optionMap.name],
     action: getArNSRecord,
 });
 makeCommand({
@@ -94,7 +95,7 @@ makeCommand({
 makeCommand({
     name: 'get-arns-reserved-name',
     description: 'Get a reserved ArNS name',
-    options: nameOptions,
+    options: [optionMap.name],
     action: getArNSReservedName,
 });
 makeCommand({
@@ -106,7 +107,7 @@ makeCommand({
 makeCommand({
     name: 'get-arns-returned-name',
     description: 'Get an ArNS returned name by name',
-    options: nameOptions,
+    options: [optionMap.name],
     action: getArNSReturnedName,
 });
 makeCommand({
@@ -152,10 +153,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',
@@ -168,7 +175,7 @@ makeCommand({
 makeCommand({
     name: 'get-primary-name-request',
     description: 'Get primary name request',
-    options: initiatorOptions,
+    options: [optionMap.initiator],
     action: (o) => readARIOFromOptions(o)
         .getPrimaryNameRequest({
         initiator: requiredStringFromOptions(o, 'initiator'),
@@ -188,7 +195,7 @@ makeCommand({
 makeCommand({
     name: 'get-primary-name',
     description: 'Get primary name',
-    options: [...addressOptions, optionMap.name],
+    options: [optionMap.address, optionMap.name],
     action: getPrimaryName,
 });
 makeCommand({
@@ -202,12 +209,12 @@ makeCommand({
 makeCommand({
     name: 'balance',
     description: 'Get the balance of an address',
-    options: addressOptions,
+    options: [optionMap.address],
     action: (options) => readARIOFromOptions(options)
         .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`,
     })),
 });
@@ -222,7 +229,7 @@ makeCommand({
 makeCommand({
     name: 'get-redelegation-fee',
     description: 'Get redelegation fee',
-    options: addressOptions,
+    options: [optionMap.address],
     action: (options) => readARIOFromOptions(options).getRedelegationFee({
         address: requiredAddressFromOptions(options),
     }),
@@ -318,82 +325,31 @@ makeCommand({
     name: 'buy-record',
     description: 'Buy a record',
     options: buyRecordOptions,
-    action: async (options) => {
-        const ario = writeARIOFromOptions(options).ario;
-        const name = requiredStringFromOptions(options, 'name');
-        const type = recordTypeFromOptions(options);
-        const years = 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 assertConfirmationPrompt(`Are you sure you want to ${type} the record ${name}?`, options);
-        return ario.buyRecord({
-            name: requiredStringFromOptions(options, 'name'),
-            processId,
-            type,
-            years,
-        });
-    },
+    action: buyRecordCLICommand,
 });
 makeCommand({
     name: 'upgrade-record',
     description: 'Upgrade the lease of a record to a permabuy',
-    options: [...nameOptions, ...writeActionOptions],
-    // TODO: could assert record is leased by sender, assert balance is sufficient
-    action: async (options) => {
-        const name = requiredStringFromOptions(options, 'name');
-        await assertConfirmationPrompt(`Are you sure you want to upgrade the lease of ${name} to a permabuy?`, options);
-        return writeARIOFromOptions(options).ario.upgradeRecord({
-            name,
-        });
-    },
+    options: arnsPurchaseOptions,
+    action: upgradeRecordCLICommand,
 });
 makeCommand({
     name: 'extend-lease',
     description: 'Extend the lease of a record',
-    options: [...writeActionOptions, optionMap.name, optionMap.years],
-    action: async (options) => {
-        const name = requiredStringFromOptions(options, 'name');
-        const years = requiredPositiveIntegerFromOptions(options, 'years');
-        await assertConfirmationPrompt(`Are you sure you want to extend the lease of ${name} by ${years}?`, options);
-        return writeARIOFromOptions(options).ario.extendLease({
-            name,
-            years,
-        }, writeActionTagsFromOptions(options));
-    },
+    options: [...arnsPurchaseOptions, optionMap.years],
+    action: extendLeaseCLICommand,
 });
 makeCommand({
     name: 'increase-undername-limit',
     description: 'Increase the limit of a name',
-    options: [...writeActionOptions, optionMap.name, optionMap.increaseCount],
-    action: async (options) => {
-        const name = requiredStringFromOptions(options, 'name');
-        const increaseCount = requiredPositiveIntegerFromOptions(options, 'increaseCount');
-        await assertConfirmationPrompt(`Are you sure you want to increase the undername limit of ${name} by ${increaseCount}?`, options);
-        return writeARIOFromOptions(options).ario.increaseUndernameLimit({
-            name,
-            increaseCount,
-        }, writeActionTagsFromOptions(options));
-    },
+    options: [...arnsPurchaseOptions, optionMap.increaseCount],
+    action: increaseUndernameLimitCLICommand,
 });
 makeCommand({
     name: 'request-primary-name',
     description: 'Request a primary name',
-    options: nameWriteOptions,
-    action: async (options) => {
-        // TODO: Assert balance is sufficient for action?
-        // TODO: Assert name requested is not already owned
-        // TODO: More assertions?
-        const name = requiredStringFromOptions(options, 'name');
-        await assertConfirmationPrompt(`Are you sure you want to request the primary name ${name}?`, options);
-        return writeARIOFromOptions(options).ario.requestPrimaryName({
-            name,
-        });
-    },
+    options: arnsPurchaseOptions,
+    action: requestPrimaryNameCLICommand,
 });
 makeCommand({
     name: 'spawn-ant',

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

@@ -0,0 +1,159 @@
+import { assertConfirmationPrompt, assertEnoughBalanceForArNSPurchase, fundFromFromOptions, positiveIntegerFromOptions, recordTypeFromOptions, requiredPositiveIntegerFromOptions, requiredStringFromOptions, writeARIOFromOptions, writeActionTagsFromOptions, } from '../utils.js';
+export async function buyRecordCLICommand(o) {
+    const { ario, signerAddress } = writeARIOFromOptions(o);
+    const name = requiredStringFromOptions(o, 'name');
+    const type = recordTypeFromOptions(o);
+    const years = positiveIntegerFromOptions(o, 'years');
+    const fundFrom = 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 assertEnoughBalanceForArNSPurchase({
+            ario,
+            address: signerAddress,
+            costDetailsParams: {
+                intent: 'Buy-Record',
+                type,
+                name,
+                years,
+                fundFrom,
+                fromAddress: signerAddress,
+            },
+        });
+        await assertConfirmationPrompt(`Are you sure you want to ${type} the record ${name}?`, o);
+    }
+    return ario.buyRecord({
+        name: requiredStringFromOptions(o, 'name'),
+        processId,
+        type,
+        years,
+        fundFrom: fundFromFromOptions(o),
+    }, writeActionTagsFromOptions(o));
+}
+export async function upgradeRecordCLICommand(o) {
+    const name = requiredStringFromOptions(o, 'name');
+    const { ario, signerAddress } = writeARIOFromOptions(o);
+    const fundFrom = 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 assertEnoughBalanceForArNSPurchase({
+            ario,
+            address: signerAddress,
+            costDetailsParams: {
+                intent: 'Upgrade-Name',
+                name,
+                fundFrom,
+                fromAddress: signerAddress,
+            },
+        });
+        await assertConfirmationPrompt(`Are you sure you want to upgrade the lease of ${name} to a permabuy?`, o);
+    }
+    return ario.upgradeRecord({
+        name,
+        fundFrom,
+    });
+}
+export async function extendLeaseCLICommand(o) {
+    const name = requiredStringFromOptions(o, 'name');
+    const years = requiredPositiveIntegerFromOptions(o, 'years');
+    const fundFrom = fundFromFromOptions(o);
+    const { ario, signerAddress } = 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 assertEnoughBalanceForArNSPurchase({
+            ario: ario,
+            address: signerAddress,
+            costDetailsParams: {
+                intent: 'Extend-Lease',
+                name,
+                years,
+                fundFrom,
+                fromAddress: signerAddress,
+            },
+        });
+        await assertConfirmationPrompt(`Are you sure you want to extend the lease of ${name} by ${years}?`, o);
+    }
+    return ario.extendLease({
+        name,
+        years,
+    }, writeActionTagsFromOptions(o));
+}
+export async function increaseUndernameLimitCLICommand(o) {
+    const name = requiredStringFromOptions(o, 'name');
+    const increaseCount = requiredPositiveIntegerFromOptions(o, 'increaseCount');
+    const fundFrom = fundFromFromOptions(o);
+    const { ario, signerAddress } = writeARIOFromOptions(o);
+    if (!o.skipConfirmation) {
+        const existingRecord = await ario.getArNSRecord({
+            name,
+        });
+        if (existingRecord === undefined) {
+            throw new Error(`ArNS Record ${name} does not exist`);
+        }
+        await assertEnoughBalanceForArNSPurchase({
+            ario,
+            address: signerAddress,
+            costDetailsParams: {
+                intent: 'Increase-Undername-Limit',
+                name,
+                quantity: increaseCount,
+                fundFrom,
+                fromAddress: signerAddress,
+            },
+        });
+        await assertConfirmationPrompt(`Are you sure you want to increase the undername limit of ${name} by ${increaseCount}?`, o);
+    }
+    return ario.increaseUndernameLimit({
+        name,
+        increaseCount,
+    }, writeActionTagsFromOptions(o));
+}
+export async function requestPrimaryNameCLICommand(o) {
+    const { ario, signerAddress } = writeARIOFromOptions(o);
+    const fundFrom = fundFromFromOptions(o);
+    const name = requiredStringFromOptions(o, 'name');
+    if (!o.skipConfirmation) {
+        // TODO: Assert name requested is not already owned?
+        // TODO: More assertions?
+        await assertEnoughBalanceForArNSPurchase({
+            ario,
+            address: signerAddress,
+            costDetailsParams: {
+                intent: 'Primary-Name-Request',
+                name,
+                fromAddress: signerAddress,
+                fundFrom,
+            },
+        });
+        await assertConfirmationPrompt(`Are you sure you want to request the primary name ${name}?`, o);
+    }
+    return ario.requestPrimaryName({
+        name,
+        fundFrom,
+    }, writeActionTagsFromOptions(o));
+}

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

@@ -15,7 +15,7 @@
  */
 import prompts from 'prompts';
 import { mARIOToken } from '../../node/index.js';
-import { assertConfirmationPrompt, assertEnoughBalance, formatARIOWithCommas, gatewaySettingsFromOptions, redelegateParamsFromOptions, requiredAddressFromOptions, requiredMIOFromOptions as requiredMARIOFromOptions, requiredStringArrayFromOptions, requiredStringFromOptions, requiredTargetAndQuantityFromOptions, stringifyJsonForCLIDisplay, writeARIOFromOptions, writeActionTagsFromOptions, } from '../utils.js';
+import { assertConfirmationPrompt, assertEnoughMARIOBalance, formatARIOWithCommas, gatewaySettingsFromOptions, redelegateParamsFromOptions, requiredAddressFromOptions, requiredMARIOFromOptions, requiredStringArrayFromOptions, requiredStringFromOptions, requiredTargetAndQuantityFromOptions, stringifyJsonForCLIDisplay, writeARIOFromOptions, writeActionTagsFromOptions, } from '../utils.js';
 export async function joinNetwork(options) {
     const { ario, signerAddress } = writeARIOFromOptions(options);
     const mARIOQuantity = requiredMARIOFromOptions(options, 'operatorStake');
@@ -34,7 +34,11 @@ export async function joinNetwork(options) {
         if (settings.operators.minStake > mARIOQuantity.valueOf()) {
             throw new Error(`The minimum operator stake is ${formatARIOWithCommas(new mARIOToken(settings.operators.minStake).toARIO())} ARIO. Please provide a higher stake.`);
         }
-        await assertEnoughBalance(ario, signerAddress, mARIOQuantity.toARIO());
+        await assertEnoughMARIOBalance({
+            ario,
+            address: signerAddress,
+            mARIOQuantity,
+        });
         await assertConfirmationPrompt(`Gateway Settings:\n\n${JSON.stringify(settings, null, 2)}\n\nYou are about to stake ${formatARIOWithCommas(mARIOQuantity.toARIO())} ARIO to join the AR.IO network\nAre you sure?\n`, options);
     }
     const result = await ario.joinNetwork(settings, writeActionTagsFromOptions(options));

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

@@ -1,21 +1,5 @@
-/**
- * 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 { intentsUsingYears, isValidIntent, validIntents, } 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, fundFromFromOptions, getTokenCostParamsFromOptions, paginationParamsFromOptions, readARIOFromOptions, requiredAddressFromOptions, requiredStringFromOptions, } from '../utils.js';
 export async function getGateway(o) {
     const address = requiredAddressFromOptions(o);
     const gateway = await readARIOFromOptions(o).getGateway({
@@ -115,32 +99,26 @@ 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({
-        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 tokenCost = await readARIOFromOptions(o).getTokenCost(getTokenCostParamsFromOptions(o));
     const output = {
-        mIOTokenCost: tokenCost,
+        mARIOTokenCost: tokenCost,
         message: `The cost of the provided action is ${formatARIOWithCommas(new mARIOToken(tokenCost).toARIO())} ARIO`,
     };
     return output;
 }
+export async function getCostDetails(o) {
+    const costDetails = await readARIOFromOptions(o).getCostDetails({
+        ...getTokenCostParamsFromOptions(o),
+        fundFrom: fundFromFromOptions(o),
+    });
+    const output = {
+        ...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;
+}
 export async function getPrimaryName(o) {
     const address = addressFromOptions(o);
     const name = o.name;

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';
+}