@ar.io/sdk 3.11.0-alpha.8 → 3.11.0-alpha.9

package/lib/cjs/cli/cli.js

@@ -33,6 +33,7 @@ const utils_js_1 = require("./utils.js");
     .version(version_js_1.version)
     .description('AR.IO Network CLI')
     .helpCommand(true), options_js_1.globalOptions);
+// # Getters
 (0, utils_js_1.makeCommand)({
     name: 'info',
     description: 'Get network info',
@@ -43,6 +44,18 @@ const utils_js_1 = require("./utils.js");
     description: 'Get the total token supply',
     action: (options) => (0, utils_js_1.readARIOFromOptions)(options).getTokenSupply(),
 });
+(0, utils_js_1.makeCommand)({
+    name: 'balance',
+    description: 'Get the balance of an address',
+    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),
+        mARIOBalance: result,
+        message: `Provided address current has a balance of ${(0, utils_js_1.formatARIOWithCommas)(new token_js_1.mARIOToken(result).toARIO())} ARIO`,
+    })),
+});
 (0, utils_js_1.makeCommand)({
     name: 'get-registration-fees',
     description: 'Get registration fees',
@@ -69,24 +82,18 @@ const utils_js_1 = require("./utils.js");
     options: [options_js_1.optionMap.address],
     action: readCommands_js_1.getGateway,
 });
-(0, utils_js_1.makeCommand)({
-    name: 'list-gateways',
-    description: 'List the gateways of the network',
-    options: options_js_1.paginationOptions,
-    action: readCommands_js_1.listGateways,
-});
-(0, utils_js_1.makeCommand)({
-    name: 'list-all-delegates',
-    description: 'List all paginated delegates from all gateways',
-    options: options_js_1.paginationOptions,
-    action: readCommands_js_1.listAllDelegatesCLICommand,
-});
 (0, utils_js_1.makeCommand)({
     name: 'get-gateway-delegates',
     description: 'Get the delegates of a gateway',
     options: options_js_1.paginationAddressOptions,
     action: readCommands_js_1.getGatewayDelegates,
 });
+(0, utils_js_1.makeCommand)({
+    name: 'get-gateway-vaults',
+    description: 'Get the vaults of a gateway',
+    options: options_js_1.paginationAddressOptions,
+    action: readCommands_js_1.getGatewayVaults,
+});
 (0, utils_js_1.makeCommand)({
     name: 'get-delegations',
     description: 'Get all stake delegated to gateways from this address',
@@ -105,36 +112,18 @@ const utils_js_1 = require("./utils.js");
     options: [options_js_1.optionMap.name],
     action: readCommands_js_1.getArNSRecord,
 });
-(0, utils_js_1.makeCommand)({
-    name: 'list-arns-records',
-    description: 'List all ArNS records',
-    options: options_js_1.paginationOptions,
-    action: readCommands_js_1.listArNSRecords,
-});
 (0, utils_js_1.makeCommand)({
     name: 'get-arns-reserved-name',
     description: 'Get a reserved ArNS name',
     options: [options_js_1.optionMap.name],
     action: readCommands_js_1.getArNSReservedName,
 });
-(0, utils_js_1.makeCommand)({
-    name: 'list-arns-reserved-names',
-    description: 'Get all reserved ArNS names',
-    options: options_js_1.paginationOptions,
-    action: readCommands_js_1.listArNSReservedNames,
-});
 (0, utils_js_1.makeCommand)({
     name: 'get-arns-returned-name',
     description: 'Get an ArNS returned name by name',
     options: [options_js_1.optionMap.name],
     action: readCommands_js_1.getArNSReturnedName,
 });
-(0, utils_js_1.makeCommand)({
-    name: 'list-arns-returned-names',
-    description: 'Get all ArNS recently returned names',
-    options: options_js_1.paginationOptions,
-    action: readCommands_js_1.listArNSReturnedNames,
-});
 (0, utils_js_1.makeCommand)({
     name: 'get-epoch',
     description: 'Get epoch data',
@@ -195,14 +184,11 @@ const utils_js_1 = require("./utils.js");
     action: readCommands_js_1.getCostDetails,
 });
 (0, utils_js_1.makeCommand)({
-    name: 'list-vaults',
-    description: 'Get all wallet vaults',
-    options: options_js_1.paginationOptions,
-    action: (o) => (0, utils_js_1.readARIOFromOptions)(o)
-        .getVaults((0, utils_js_1.paginationParamsFromOptions)(o))
-        .then((result) => result.items.length ? result : { message: 'No vaults found' }),
+    name: 'get-primary-name',
+    description: 'Get primary name',
+    options: [options_js_1.optionMap.address, options_js_1.optionMap.name],
+    action: readCommands_js_1.getPrimaryName,
 });
-// TODO: Could assert valid arweave (or ETH) addresses at CLI level when coming from options (no need from wallet)
 (0, utils_js_1.makeCommand)({
     name: 'get-primary-name-request',
     description: 'Get primary name request',
@@ -215,6 +201,66 @@ const utils_js_1 = require("./utils.js");
         message: `No primary name request found`,
     }),
 });
+(0, utils_js_1.makeCommand)({
+    name: 'get-redelegation-fee',
+    description: 'Get redelegation fee',
+    options: [options_js_1.optionMap.address],
+    action: (options) => (0, utils_js_1.readARIOFromOptions)(options).getRedelegationFee({
+        address: (0, utils_js_1.requiredAddressFromOptions)(options),
+    }),
+});
+(0, utils_js_1.makeCommand)({
+    name: 'get-vault',
+    description: 'Get the vault of provided address and vault ID',
+    options: options_js_1.getVaultOptions,
+    action: readCommands_js_1.getVault,
+});
+// # ArNS Resolution
+(0, utils_js_1.makeCommand)({
+    name: 'resolve-arns-name',
+    description: 'Resolve an ArNS name',
+    options: [options_js_1.optionMap.name],
+    action: readCommands_js_1.resolveArNSName,
+});
+// # Paginated handlers
+(0, utils_js_1.makeCommand)({
+    name: 'list-gateways',
+    description: 'List the gateways of the network',
+    options: options_js_1.paginationOptions,
+    action: readCommands_js_1.listGateways,
+});
+(0, utils_js_1.makeCommand)({
+    name: 'list-all-delegates',
+    description: 'List all paginated delegates from all gateways',
+    options: options_js_1.paginationOptions,
+    action: readCommands_js_1.listAllDelegatesCLICommand,
+});
+(0, utils_js_1.makeCommand)({
+    name: 'list-arns-records',
+    description: 'List all ArNS records',
+    options: options_js_1.paginationOptions,
+    action: readCommands_js_1.listArNSRecords,
+});
+(0, utils_js_1.makeCommand)({
+    name: 'list-arns-reserved-names',
+    description: 'Get all reserved ArNS names',
+    options: options_js_1.paginationOptions,
+    action: readCommands_js_1.listArNSReservedNames,
+});
+(0, utils_js_1.makeCommand)({
+    name: 'list-arns-returned-names',
+    description: 'Get all ArNS recently returned names',
+    options: options_js_1.paginationOptions,
+    action: readCommands_js_1.listArNSReturnedNames,
+});
+(0, utils_js_1.makeCommand)({
+    name: 'list-vaults',
+    description: 'Get all wallet vaults',
+    options: options_js_1.paginationOptions,
+    action: (o) => (0, utils_js_1.readARIOFromOptions)(o)
+        .getVaults((0, utils_js_1.paginationParamsFromOptions)(o))
+        .then((result) => result.items.length ? result : { message: 'No vaults found' }),
+});
 (0, utils_js_1.makeCommand)({
     name: 'list-primary-name-requests',
     description: 'Get primary name requests',
@@ -223,12 +269,6 @@ const utils_js_1 = require("./utils.js");
         .getPrimaryNameRequests((0, utils_js_1.paginationParamsFromOptions)(o))
         .then((result) => result.items.length ? result : { message: 'No requests found' }),
 });
-(0, utils_js_1.makeCommand)({
-    name: 'get-primary-name',
-    description: 'Get primary name',
-    options: [options_js_1.optionMap.address, options_js_1.optionMap.name],
-    action: readCommands_js_1.getPrimaryName,
-});
 (0, utils_js_1.makeCommand)({
     name: 'list-primary-names',
     description: 'Get primary names',
@@ -237,18 +277,6 @@ const utils_js_1 = require("./utils.js");
         .getPrimaryNames((0, utils_js_1.paginationParamsFromOptions)(o))
         .then((result) => result.items.length ? result : { message: 'No names found' }),
 });
-(0, utils_js_1.makeCommand)({
-    name: 'balance',
-    description: 'Get the balance of an address',
-    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),
-        mARIOBalance: result,
-        message: `Provided address current has a balance of ${(0, utils_js_1.formatARIOWithCommas)(new token_js_1.mARIOToken(result).toARIO())} ARIO`,
-    })),
-});
 (0, utils_js_1.makeCommand)({
     name: 'list-balances',
     description: 'List all balances',
@@ -257,32 +285,13 @@ const utils_js_1 = require("./utils.js");
         .getBalances((0, utils_js_1.paginationParamsFromOptions)(o))
         .then((result) => result.items.length ? result : { message: 'No balances found' }),
 });
-(0, utils_js_1.makeCommand)({
-    name: 'get-redelegation-fee',
-    description: 'Get redelegation fee',
-    options: [options_js_1.optionMap.address],
-    action: (options) => (0, utils_js_1.readARIOFromOptions)(options).getRedelegationFee({
-        address: (0, utils_js_1.requiredAddressFromOptions)(options),
-    }),
-});
-(0, utils_js_1.makeCommand)({
-    name: 'get-vault',
-    description: 'Get the vault of provided address and vault ID',
-    options: options_js_1.getVaultOptions,
-    action: readCommands_js_1.getVault,
-});
-(0, utils_js_1.makeCommand)({
-    name: 'get-gateway-vaults',
-    description: 'Get the vaults of a gateway',
-    options: options_js_1.paginationAddressOptions,
-    action: readCommands_js_1.getGatewayVaults,
-});
 (0, utils_js_1.makeCommand)({
     name: 'list-all-gateway-vaults',
     description: 'List vaults from all gateways',
     options: options_js_1.paginationAddressOptions,
     action: readCommands_js_1.getAllGatewayVaults,
 });
+// # Actions
 (0, utils_js_1.makeCommand)({
     name: 'transfer',
     description: 'Transfer ARIO to another address',
@@ -418,24 +427,8 @@ const utils_js_1 = require("./utils.js");
     options: options_js_1.arnsPurchaseOptions,
     action: arnsPurchaseCommands_js_1.requestPrimaryNameCLICommand,
 });
-(0, utils_js_1.makeCommand)({
-    name: 'spawn-ant',
-    description: 'Spawn an ANT process',
-    options: options_js_1.antStateOptions,
-    action: async (options) => {
-        const state = (0, utils_js_1.getANTStateFromOptions)(options);
-        const antProcessId = await (0, index_js_1.spawnANT)({
-            state,
-            signer: (0, utils_js_1.requiredAoSignerFromOptions)(options),
-            logger: (0, utils_js_1.getLoggerFromOptions)(options),
-        });
-        return {
-            processId: antProcessId,
-            state,
-            message: `Spawned ANT process with process ID ${antProcessId}`,
-        };
-    },
-});
+// # ANTS
+// # Getters
 (0, utils_js_1.makeCommand)({
     name: 'get-ant-state',
     description: 'Get the state of an ANT process',
@@ -462,14 +455,6 @@ const utils_js_1 = require("./utils.js");
         })) ?? { message: 'No record found' });
     },
 });
-(0, utils_js_1.makeCommand)({
-    name: 'list-ant-records',
-    description: 'Get the records of an ANT process',
-    options: [options_js_1.optionMap.processId],
-    action: async (options) => {
-        return (0, utils_js_1.readANTFromOptions)(options).getRecords();
-    },
-});
 (0, utils_js_1.makeCommand)({
     name: 'get-ant-owner',
     description: 'Get the owner of an ANT process',
@@ -478,14 +463,6 @@ const utils_js_1 = require("./utils.js");
         return (0, utils_js_1.readANTFromOptions)(options).getOwner();
     },
 });
-(0, utils_js_1.makeCommand)({
-    name: 'list-ant-controllers',
-    description: 'List the controllers of an ANT process',
-    options: [options_js_1.optionMap.processId],
-    action: async (options) => {
-        return (0, utils_js_1.readANTFromOptions)(options).getControllers();
-    },
-});
 (0, utils_js_1.makeCommand)({
     name: 'get-ant-name',
     description: 'Get the name of an ANT process',
@@ -512,6 +489,42 @@ const utils_js_1 = require("./utils.js");
         });
     },
 });
+// # Spawn
+(0, utils_js_1.makeCommand)({
+    name: 'spawn-ant',
+    description: 'Spawn an ANT process',
+    options: options_js_1.antStateOptions,
+    action: async (options) => {
+        const state = (0, utils_js_1.getANTStateFromOptions)(options);
+        const antProcessId = await (0, index_js_1.spawnANT)({
+            state,
+            signer: (0, utils_js_1.requiredAoSignerFromOptions)(options),
+            logger: (0, utils_js_1.getLoggerFromOptions)(options),
+        });
+        return {
+            processId: antProcessId,
+            state,
+            message: `Spawned ANT process with process ID ${antProcessId}`,
+        };
+    },
+});
+// # ANT Paginated Handlers
+(0, utils_js_1.makeCommand)({
+    name: 'list-ant-records',
+    description: 'Get the records of an ANT process',
+    options: [options_js_1.optionMap.processId],
+    action: async (options) => {
+        return (0, utils_js_1.readANTFromOptions)(options).getRecords();
+    },
+});
+(0, utils_js_1.makeCommand)({
+    name: 'list-ant-controllers',
+    description: 'List the controllers of an ANT process',
+    options: [options_js_1.optionMap.processId],
+    action: async (options) => {
+        return (0, utils_js_1.readANTFromOptions)(options).getControllers();
+    },
+});
 (0, utils_js_1.makeCommand)({
     name: 'list-ant-balances',
     description: 'Get the balances of an ANT process',
@@ -520,6 +533,7 @@ const utils_js_1 = require("./utils.js");
         return (0, utils_js_1.readANTFromOptions)(options).getBalances();
     },
 });
+// # Actions
 (0, utils_js_1.makeCommand)({
     name: 'transfer-ant-ownership',
     description: 'Transfer ownership of an ANT process',
@@ -554,6 +568,18 @@ const utils_js_1 = require("./utils.js");
         }, (0, utils_js_1.customTagsFromOptions)(options));
     },
 });
+(0, utils_js_1.makeCommand)({
+    name: 'remove-ant-record',
+    description: 'Remove a record from an ANT process',
+    options: [options_js_1.optionMap.processId, options_js_1.optionMap.undername, ...options_js_1.writeActionOptions],
+    action: async (options) => {
+        const undername = (0, utils_js_1.requiredStringFromOptions)(options, 'undername');
+        await (0, utils_js_1.assertConfirmationPrompt)(`Are you sure you want to remove the record with undername ${undername}?`, options);
+        return (0, utils_js_1.writeANTFromOptions)(options).removeRecord({
+            undername,
+        }, (0, utils_js_1.customTagsFromOptions)(options));
+    },
+});
 (0, utils_js_1.makeCommand)({
     name: 'set-ant-record',
     description: 'Set a record of an ANT process. Deprecated: use set-ant-base-name and set-ant-undername',
@@ -572,18 +598,6 @@ const utils_js_1 = require("./utils.js");
     options: options_js_1.setAntUndernameOptions,
     action: antCommands_js_1.setAntRecordCLICommand,
 });
-(0, utils_js_1.makeCommand)({
-    name: 'remove-ant-record',
-    description: 'Remove a record from an ANT process',
-    options: [options_js_1.optionMap.processId, options_js_1.optionMap.undername, ...options_js_1.writeActionOptions],
-    action: async (options) => {
-        const undername = (0, utils_js_1.requiredStringFromOptions)(options, 'undername');
-        await (0, utils_js_1.assertConfirmationPrompt)(`Are you sure you want to remove the record with undername ${undername}?`, options);
-        return (0, utils_js_1.writeANTFromOptions)(options).removeRecord({
-            undername,
-        }, (0, utils_js_1.customTagsFromOptions)(options));
-    },
-});
 (0, utils_js_1.makeCommand)({
     name: 'set-ant-ticker',
     description: 'Set the ticker of an ANT process',
@@ -644,11 +658,11 @@ const utils_js_1 = require("./utils.js");
         const txId = (0, utils_js_1.requiredStringFromOptions)(options, 'transactionId');
         await (0, utils_js_1.assertConfirmationPrompt)(`Are you sure you want to set the ANT logo to target Arweave TxID ${txId}?`, options);
         return (0, utils_js_1.writeANTFromOptions)(options).setLogo({
-            // TODO: Could take a logo file, upload it to Arweave, get transaction ID
             txId,
         }, (0, utils_js_1.customTagsFromOptions)(options));
     },
 });
+// # ARIO Actions
 (0, utils_js_1.makeCommand)({
     name: 'release-name',
     description: 'Release the name of an ANT process',
@@ -715,6 +729,7 @@ const utils_js_1 = require("./utils.js");
         }, (0, utils_js_1.customTagsFromOptions)(options));
     },
 });
+// # Utilities
 (0, utils_js_1.makeCommand)({
     name: 'write-action',
     description: 'Send a write action to an AO Process',

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

@@ -21,6 +21,7 @@ exports.getPrimaryName = getPrimaryName;
 exports.getGatewayVaults = getGatewayVaults;
 exports.getAllGatewayVaults = getAllGatewayVaults;
 exports.getVault = getVault;
+exports.resolveArNSName = resolveArNSName;
 const token_js_1 = require("../../types/token.js");
 const utils_js_1 = require("../utils.js");
 async function getGateway(o) {
@@ -188,3 +189,8 @@ async function getVault(o) {
         message: `No vault found for provided address and vault ID`,
     });
 }
+async function resolveArNSName(o) {
+    const name = (0, utils_js_1.requiredStringFromOptions)(o, 'name');
+    const result = await (0, utils_js_1.readARIOFromOptions)(o).resolveArNSName({ name });
+    return result ?? { message: `No record found for name ${name}` };
+}

package/lib/cjs/common/ant.js

@@ -93,12 +93,12 @@ class AoANTReadable {
      * ```
      */
     async getRecord({ undername }, { strict } = { strict: this.strict }) {
-        const tags = [
-            { name: 'Sub-Domain', value: undername },
-            { name: 'Action', value: 'Record' },
-        ];
+        // TODO: use sortedANTRecords to get priority on all records, even if ANT does not have a priority set
         const record = await this.process.read({
-            tags,
+            tags: [
+                { name: 'Action', value: 'Record' },
+                { name: 'Sub-Domain', value: undername },
+            ],
         });
         if (strict)
             (0, schema_js_1.parseSchemaResult)(ant_js_1.AntRecordSchema.passthrough(), record);

package/lib/cjs/common/io.js

@@ -21,6 +21,7 @@ const constants_js_1 = require("../constants.js");
 const index_js_1 = require("../types/index.js");
 const ao_js_1 = require("../utils/ao.js");
 const arweave_js_1 = require("../utils/arweave.js");
+const ant_js_1 = require("./ant.js");
 const arweave_js_2 = require("./arweave.js");
 const ao_process_js_1 = require("./contracts/ao-process.js");
 const error_js_1 = require("./error.js");
@@ -624,6 +625,42 @@ class ARIOReadable {
             ],
         });
     }
+    async resolveArNSName({ name, }) {
+        const baseName = name.split('_').pop();
+        if (baseName === undefined) {
+            throw new Error('Invalid name');
+        }
+        const undername = name === baseName ? '@' : name.replace(`_${baseName}`, '');
+        const nameData = await this.getArNSRecord({ name: baseName });
+        const ant = ant_js_1.ANT.init({
+            process: new ao_process_js_1.AOProcess({
+                ao: this.process.ao,
+                processId: nameData.processId,
+            }),
+        });
+        const [owner, antRecord] = await Promise.all([
+            ant.getOwner(),
+            ant.getRecord({ undername }),
+        ]);
+        if (antRecord === undefined) {
+            throw new Error(`Record for ${undername} not found on ANT.`);
+        }
+        if (antRecord.ttlSeconds === undefined ||
+            antRecord.transactionId === undefined) {
+            throw new Error(`Invalid record on ANT. Must have ttlSeconds and transactionId. Record: ${JSON.stringify(antRecord)}`);
+        }
+        return {
+            name: name,
+            owner: owner,
+            txId: antRecord.transactionId,
+            ttlSeconds: antRecord.ttlSeconds,
+            priority: antRecord.priority,
+            // NOTE: we may want return the actual index of the record based on sorting in case ANT tries to set duplicate priority values to get around undername limits
+            processId: nameData.processId,
+            undernameLimit: nameData.undernameLimit,
+            type: nameData.type,
+        };
+    }
 }
 exports.ARIOReadable = ARIOReadable;
 class ARIOWriteable extends ARIOReadable {

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.11.0-alpha.8';
+exports.version = '3.11.0-alpha.9';