@ar.io/sdk 3.19.0-alpha.1 → 3.19.0-alpha.11

package/lib/cjs/cli/cli.js

@@ -536,6 +536,7 @@ const utils_js_1 = require("./utils.js");
             state,
             signer: (0, utils_js_1.requiredAoSignerFromOptions)(options),
             logger: (0, utils_js_1.getLoggerFromOptions)(options),
+            ...(options.module !== undefined ? { module: options.module } : {}),
         });
         return {
             processId: antProcessId,
@@ -632,7 +633,19 @@ const utils_js_1 = require("./utils.js");
     name: 'set-ant-undername',
     description: 'Set an undername of an ANT process',
     options: options_js_1.setAntUndernameOptions,
-    action: antCommands_js_1.setAntRecordCLICommand,
+    action: antCommands_js_1.setAntUndernameCLICommand,
+});
+(0, utils_js_1.makeCommand)({
+    name: 'transfer-record',
+    description: 'Transfer ownership of a specific record (undername) to another address',
+    options: options_js_1.transferRecordOwnershipOptions,
+    action: antCommands_js_1.transferRecordOwnershipCLICommand,
+});
+(0, utils_js_1.makeCommand)({
+    name: 'upgrade-ant',
+    description: 'Upgrade an ANT by forking it to the latest version and reassigning names',
+    options: options_js_1.upgradeAntOptions,
+    action: antCommands_js_1.upgradeAntCLICommand,
 });
 (0, utils_js_1.makeCommand)({
     name: 'set-ant-ticker',

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

@@ -3,6 +3,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.setAntRecordCLICommand = setAntRecordCLICommand;
 exports.setAntBaseNameCLICommand = setAntBaseNameCLICommand;
 exports.setAntUndernameCLICommand = setAntUndernameCLICommand;
+exports.transferRecordOwnershipCLICommand = transferRecordOwnershipCLICommand;
+exports.upgradeAntCLICommand = upgradeAntCLICommand;
 const utils_js_1 = require("../utils.js");
 /** @deprecated -- use set-ant-base-name and set-ant-undername */
 async function setAntRecordCLICommand(o) {
@@ -10,38 +12,102 @@ async function setAntRecordCLICommand(o) {
     const undername = (0, utils_js_1.requiredStringFromOptions)(o, 'undername');
     const transactionId = (0, utils_js_1.requiredStringFromOptions)(o, 'transactionId');
     const writeAnt = (0, utils_js_1.writeANTFromOptions)(o);
-    if (!o.skipConfirmation) {
-        await (0, utils_js_1.assertConfirmationPrompt)(`Are you sure you want to set this record on the ANT process ${writeAnt.processId}?\n${JSON.stringify({ undername, transactionId, ttlSeconds }, null, 2)}`, o);
-    }
-    return (0, utils_js_1.writeANTFromOptions)(o).setRecord({
+    const recordParams = {
         undername,
         transactionId,
         ttlSeconds,
-    }, (0, utils_js_1.customTagsFromOptions)(o));
+        ...(0, utils_js_1.antRecordMetadataFromOptions)(o),
+    };
+    if (!o.skipConfirmation) {
+        await (0, utils_js_1.assertConfirmationPrompt)(`Are you sure you want to set this record on the ANT process ${writeAnt.processId}?\n${JSON.stringify(recordParams, null, 2)}`, o);
+    }
+    return (0, utils_js_1.writeANTFromOptions)(o).setRecord(recordParams, (0, utils_js_1.customTagsFromOptions)(o));
 }
 async function setAntBaseNameCLICommand(o) {
     const ttlSeconds = +(o.ttlSeconds ?? utils_js_1.defaultTtlSecondsCLI);
     const transactionId = (0, utils_js_1.requiredStringFromOptions)(o, 'transactionId');
+    const params = {
+        transactionId,
+        ttlSeconds,
+        ...(0, utils_js_1.antRecordMetadataFromOptions)(o),
+    };
     const writeAnt = (0, utils_js_1.writeANTFromOptions)(o);
     if (!o.skipConfirmation) {
-        await (0, utils_js_1.assertConfirmationPrompt)(`Are you sure you want to set this base name on the ANT process ${writeAnt.processId}?\n${JSON.stringify({ transactionId, ttlSeconds }, null, 2)}`, o);
+        await (0, utils_js_1.assertConfirmationPrompt)(`Are you sure you want to set this base name on the ANT process ${writeAnt.processId}?\n${JSON.stringify(params, null, 2)}`, o);
     }
-    return (0, utils_js_1.writeANTFromOptions)(o).setBaseNameRecord({
-        transactionId,
-        ttlSeconds,
-    }, (0, utils_js_1.customTagsFromOptions)(o));
+    return (0, utils_js_1.writeANTFromOptions)(o).setBaseNameRecord(params, (0, utils_js_1.customTagsFromOptions)(o));
 }
 async function setAntUndernameCLICommand(o) {
     const ttlSeconds = +(o.ttlSeconds ?? utils_js_1.defaultTtlSecondsCLI);
     const undername = (0, utils_js_1.requiredStringFromOptions)(o, 'undername');
     const transactionId = (0, utils_js_1.requiredStringFromOptions)(o, 'transactionId');
-    const writeAnt = (0, utils_js_1.writeANTFromOptions)(o);
-    if (!o.skipConfirmation) {
-        await (0, utils_js_1.assertConfirmationPrompt)(`Are you sure you want to set this undername on the ANT process ${writeAnt.processId}?\n${JSON.stringify({ undername, transactionId, ttlSeconds }, null, 2)}`, o);
-    }
-    return (0, utils_js_1.writeANTFromOptions)(o).setUndernameRecord({
+    const params = {
         undername,
         transactionId,
         ttlSeconds,
-    }, (0, utils_js_1.customTagsFromOptions)(o));
+        ...(0, utils_js_1.antRecordMetadataFromOptions)(o),
+    };
+    const writeAnt = (0, utils_js_1.writeANTFromOptions)(o);
+    if (!o.skipConfirmation) {
+        await (0, utils_js_1.assertConfirmationPrompt)(`Are you sure you want to set this undername on the ANT process ${writeAnt.processId}?\n${JSON.stringify(params, null, 2)}`, o);
+    }
+    return (0, utils_js_1.writeANTFromOptions)(o).setUndernameRecord(params, (0, utils_js_1.customTagsFromOptions)(o));
+}
+async function transferRecordOwnershipCLICommand(o) {
+    const undername = (0, utils_js_1.requiredStringFromOptions)(o, 'undername');
+    const recipient = (0, utils_js_1.requiredStringFromOptions)(o, 'recipient');
+    const writeAnt = (0, utils_js_1.writeANTFromOptions)(o);
+    if (!o.skipConfirmation) {
+        await (0, utils_js_1.assertConfirmationPrompt)(`Are you sure you want to transfer ownership of "${undername}" to "${recipient}" on ANT process ${writeAnt.processId}?\n${JSON.stringify({ undername, recipient }, null, 2)}`, o);
+    }
+    return (0, utils_js_1.writeANTFromOptions)(o).transferRecord({ undername, recipient }, (0, utils_js_1.customTagsFromOptions)(o));
+}
+async function upgradeAntCLICommand(o) {
+    const writeAnt = (0, utils_js_1.writeANTFromOptions)(o);
+    const arioProcessId = (0, utils_js_1.arioProcessIdFromOptions)(o);
+    const ario = (0, utils_js_1.readARIOFromOptions)(o);
+    const reassignAffiliatedNames = (0, utils_js_1.booleanFromOptions)(o, 'reassignAffiliatedNames');
+    const names = (0, utils_js_1.stringArrayFromOptions)(o, 'names') || [];
+    if (reassignAffiliatedNames) {
+        // Fetch all ArNS records that point to this ANT process
+        const allRecords = await ario.getArNSRecords({
+            filters: {
+                processId: writeAnt.processId,
+            },
+        });
+        // Filter records that belong to this ANT
+        const affiliatedNames = allRecords.items.map((record) => record.name);
+        names.push(...affiliatedNames);
+    }
+    if (names.length === 0) {
+        throw new Error('No names to reassign');
+    }
+    if (!o.skipConfirmation) {
+        await (0, utils_js_1.assertConfirmationPrompt)(`Upgrade all names affiliated with this ANT on ARIO process?\n` +
+            `ARIO Process ID: ${arioProcessId}\n` +
+            `ANT Process ID: ${writeAnt.processId}\n` +
+            `Names that will be reassigned (${names.length}): ${names.join(', ')}`, o);
+    }
+    const result = reassignAffiliatedNames
+        ? await (0, utils_js_1.writeANTFromOptions)(o).upgrade({
+            reassignAffiliatedNames,
+            arioProcessId,
+        })
+        : await (0, utils_js_1.writeANTFromOptions)(o).upgrade({
+            names,
+            arioProcessId,
+        });
+    // Serialize error objects for JSON compatibility
+    const serializedFailedReassignedNames = {};
+    for (const [name, failure] of Object.entries(result.failedReassignedNames)) {
+        serializedFailedReassignedNames[name] = {
+            id: failure.id,
+            error: failure.error.message,
+        };
+    }
+    return {
+        forkedProcessId: result.forkedProcessId,
+        reassignedNames: result.reassignedNames,
+        failedReassignedNames: serializedFailedReassignedNames,
+    };
 }

package/lib/cjs/cli/options.js

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.setAntUndernameOptions = exports.setAntBaseNameOptions = exports.antStateOptions = exports.buyRecordOptions = exports.joinNetworkOptions = exports.updateGatewaySettingsOptions = exports.decreaseDelegateStakeOptions = exports.delegateStakeOptions = exports.redelegateStakeOptions = exports.operatorStakeOptions = exports.vaultedTransferOptions = 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.transferRecordOwnershipOptions = exports.upgradeAntOptions = exports.setAntUndernameOptions = exports.setAntBaseNameOptions = exports.antStateOptions = exports.buyRecordOptions = exports.joinNetworkOptions = exports.updateGatewaySettingsOptions = exports.decreaseDelegateStakeOptions = exports.delegateStakeOptions = exports.redelegateStakeOptions = exports.operatorStakeOptions = exports.vaultedTransferOptions = 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>',
@@ -254,6 +254,14 @@ exports.optionMap = {
         description: 'The keywords for the ANT',
         type: 'array',
     },
+    owner: {
+        alias: '--owner <owner>',
+        description: 'The owner address for the record',
+    },
+    displayName: {
+        alias: '--display-name <displayName>',
+        description: 'The display name for the record',
+    },
     names: {
         alias: '--names <names...>',
         description: 'The names to interact with',
@@ -289,6 +297,10 @@ exports.optionMap = {
         alias: '--logo <logo>',
         description: 'The ANT logo',
     },
+    module: {
+        alias: '--module <module>',
+        description: 'The module ID to use for spawning the ANT process',
+    },
     token: {
         alias: '-t, --token <type>',
         description: 'Crypto token type for wallet or action',
@@ -303,6 +315,11 @@ exports.optionMap = {
         alias: '--referrer <referrer>',
         description: 'The referrer for ArNS purchase tracking',
     },
+    reassignAffiliatedNames: {
+        alias: '--reassign-affiliated-names',
+        description: 'Reassign all affiliated names to the new process',
+        type: 'boolean',
+    },
 };
 exports.walletOptions = [
     exports.optionMap.walletFile,
@@ -411,14 +428,32 @@ exports.antStateOptions = [
     exports.optionMap.controllers,
     exports.optionMap.ttlSeconds,
     exports.optionMap.logo,
+    exports.optionMap.module,
 ];
 exports.setAntBaseNameOptions = [
     exports.optionMap.processId,
     exports.optionMap.transactionId,
     exports.optionMap.ttlSeconds,
+    exports.optionMap.owner,
+    exports.optionMap.displayName,
+    exports.optionMap.logo,
+    exports.optionMap.description,
+    exports.optionMap.keywords,
     ...exports.writeActionOptions,
 ];
 exports.setAntUndernameOptions = [
     ...exports.setAntBaseNameOptions,
     exports.optionMap.undername,
 ];
+exports.upgradeAntOptions = [
+    exports.optionMap.processId,
+    exports.optionMap.names,
+    exports.optionMap.reassignAffiliatedNames,
+    ...exports.writeActionOptions,
+];
+exports.transferRecordOwnershipOptions = [
+    exports.optionMap.processId,
+    exports.optionMap.undername,
+    exports.optionMap.recipient,
+    ...exports.writeActionOptions,
+];

package/lib/cjs/cli/utils.js

@@ -9,11 +9,11 @@ exports.runCommand = runCommand;
 exports.applyOptions = applyOptions;
 exports.makeCommand = makeCommand;
 exports.arioProcessIdFromOptions = arioProcessIdFromOptions;
+exports.antRegistryIdFromOptions = antRegistryIdFromOptions;
 exports.requiredJwkFromOptions = requiredJwkFromOptions;
 exports.jwkToAddress = jwkToAddress;
 exports.getLoggerFromOptions = getLoggerFromOptions;
 exports.readARIOFromOptions = readARIOFromOptions;
-exports.ANTRegistryProcessFromOptions = ANTRegistryProcessFromOptions;
 exports.readANTRegistryFromOptions = readANTRegistryFromOptions;
 exports.contractSignerFromOptions = contractSignerFromOptions;
 exports.requiredContractSignerFromOptions = requiredContractSignerFromOptions;
@@ -50,6 +50,7 @@ exports.getTokenCostParamsFromOptions = getTokenCostParamsFromOptions;
 exports.fundFromFromOptions = fundFromFromOptions;
 exports.referrerFromOptions = referrerFromOptions;
 exports.assertLockLengthInRange = assertLockLengthInRange;
+exports.antRecordMetadataFromOptions = antRecordMetadataFromOptions;
 /**
  * Copyright (C) 2022-2024 Permanent Data Solutions, Inc.
  *
@@ -130,6 +131,15 @@ function arioProcessIdFromOptions({ arioProcessId, devnet, testnet, }) {
     }
     return index_js_1.ARIO_MAINNET_PROCESS_ID;
 }
+function antRegistryIdFromOptions({ antRegistryProcessId, testnet, }) {
+    if (antRegistryProcessId !== undefined) {
+        return antRegistryProcessId;
+    }
+    if (testnet) {
+        return index_js_1.ANT_REGISTRY_TESTNET_ID;
+    }
+    return index_js_1.ANT_REGISTRY_ID;
+}
 function walletFromOptions({ privateKey, walletFile, }) {
     if (privateKey !== undefined) {
         return JSON.parse(privateKey);
@@ -177,18 +187,9 @@ function readARIOFromOptions(options) {
         paymentUrl: options.paymentUrl,
     });
 }
-function ANTRegistryProcessFromOptions(options) {
-    return new index_js_1.AOProcess({
-        processId: options.antRegistryProcessId ?? index_js_1.ANT_REGISTRY_ID,
-        ao: (0, aoconnect_1.connect)({
-            MODE: 'legacy',
-            CU_URL: options.cuUrl,
-        }),
-    });
-}
 function readANTRegistryFromOptions(options) {
     return index_js_1.ANTRegistry.init({
-        process: ANTRegistryProcessFromOptions(options),
+        process: aoProcessFromOptions(options),
         hyperbeamUrl: options.hyperbeamUrl,
     });
 }
@@ -559,3 +560,16 @@ function assertLockLengthInRange(lockLengthMs, assertMin = true) {
         throw new Error(`Lock length must be at least 14 days (1209600000 ms). Provided lock length: ${lockLengthMs} ms`);
     }
 }
+function antRecordMetadataFromOptions(options) {
+    return {
+        ...(options.owner != null &&
+            options.owner !== '' && { owner: options.owner }),
+        ...(options.displayName != null &&
+            options.displayName !== '' && { displayName: options.displayName }),
+        ...(options.logo != null && options.logo !== '' && { logo: options.logo }),
+        ...(options.description != null &&
+            options.description !== '' && { description: options.description }),
+        ...(options.keywords != null &&
+            options.keywords.length > 0 && { keywords: options.keywords }),
+    };
+}