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

package/lib/esm/cli/cli.js

@@ -19,12 +19,12 @@ import { program } from 'commander';
 import { AOProcess, spawnANT } from '../node/index.js';
 import { mARIOToken } from '../types/token.js';
 import { version } from '../version.js';
-import { setAntBaseNameCLICommand, setAntRecordCLICommand, } from './commands/antCommands.js';
+import { setAntBaseNameCLICommand, setAntRecordCLICommand, setAntUndernameCLICommand, transferRecordOwnershipCLICommand, upgradeAntCLICommand, } from './commands/antCommands.js';
 import { buyRecordCLICommand, extendLeaseCLICommand, increaseUndernameLimitCLICommand, requestPrimaryNameCLICommand, setPrimaryNameCLICommand, upgradeRecordCLICommand, } from './commands/arnsPurchaseCommands.js';
 import { cancelWithdrawal, decreaseDelegateStake, decreaseOperatorStake, delegateStake, increaseOperatorStake, instantWithdrawal, joinNetwork, leaveNetwork, redelegateStake, saveObservations, updateGatewaySettings, } from './commands/gatewayWriteCommands.js';
 import { getAllGatewayVaults, getAllowedDelegates, getArNSRecord, getArNSReservedName, getArNSReturnedName, getCostDetails, getDelegations, getEpoch, getGateway, getGatewayDelegates, getGatewayVaults, getPrescribedNames, getPrescribedObservers, getPrimaryName, getTokenCost, getVault, listAllDelegatesCLICommand, listAntsForAddress, listArNSRecords, listArNSRecordsForAddress, listArNSReservedNames, listArNSReturnedNames, listGateways, resolveArNSName, } from './commands/readCommands.js';
 import { createVaultCLICommand, extendVaultCLICommand, increaseVaultCLICommand, revokeVaultCLICommand, transferCLICommand, vaultedTransferCLICommand, } from './commands/transfer.js';
-import { addressAndVaultIdOptions, antStateOptions, arnsPurchaseOptions, buyRecordOptions, decreaseDelegateStakeOptions, delegateStakeOptions, epochOptions, getVaultOptions, globalOptions, joinNetworkOptions, operatorStakeOptions, optionMap, paginationAddressOptions, paginationOptions, redelegateStakeOptions, setAntBaseNameOptions, setAntUndernameOptions, tokenCostOptions, transferOptions, updateGatewaySettingsOptions, vaultedTransferOptions, writeActionOptions, } from './options.js';
+import { addressAndVaultIdOptions, antStateOptions, arnsPurchaseOptions, buyRecordOptions, decreaseDelegateStakeOptions, delegateStakeOptions, epochOptions, getVaultOptions, globalOptions, joinNetworkOptions, operatorStakeOptions, optionMap, paginationAddressOptions, paginationOptions, redelegateStakeOptions, setAntBaseNameOptions, setAntUndernameOptions, tokenCostOptions, transferOptions, transferRecordOwnershipOptions, updateGatewaySettingsOptions, upgradeAntOptions, vaultedTransferOptions, writeActionOptions, } from './options.js';
 import { applyOptions, arioProcessIdFromOptions, assertConfirmationPrompt, customTagsFromOptions, epochInputFromOptions, formatARIOWithCommas, getANTStateFromOptions, getLoggerFromOptions, makeCommand, paginationParamsFromOptions, readANTFromOptions, readARIOFromOptions, requiredAddressFromOptions, requiredAoSignerFromOptions, requiredProcessIdFromOptions, requiredStringArrayFromOptions, requiredStringFromOptions, writeANTFromOptions, } from './utils.js';
 applyOptions(program
     .name('ar.io')
@@ -534,6 +534,7 @@ makeCommand({
             state,
             signer: requiredAoSignerFromOptions(options),
             logger: getLoggerFromOptions(options),
+            ...(options.module !== undefined ? { module: options.module } : {}),
         });
         return {
             processId: antProcessId,
@@ -630,7 +631,19 @@ makeCommand({
     name: 'set-ant-undername',
     description: 'Set an undername of an ANT process',
     options: setAntUndernameOptions,
-    action: setAntRecordCLICommand,
+    action: setAntUndernameCLICommand,
+});
+makeCommand({
+    name: 'transfer-record',
+    description: 'Transfer ownership of a specific record (undername) to another address',
+    options: transferRecordOwnershipOptions,
+    action: transferRecordOwnershipCLICommand,
+});
+makeCommand({
+    name: 'upgrade-ant',
+    description: 'Upgrade an ANT by forking it to the latest version and reassigning names',
+    options: upgradeAntOptions,
+    action: upgradeAntCLICommand,
 });
 makeCommand({
     name: 'set-ant-ticker',

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

@@ -1,42 +1,106 @@
-import { assertConfirmationPrompt, customTagsFromOptions, defaultTtlSecondsCLI, requiredStringFromOptions, writeANTFromOptions, } from '../utils.js';
+import { antRecordMetadataFromOptions, arioProcessIdFromOptions, assertConfirmationPrompt, booleanFromOptions, customTagsFromOptions, defaultTtlSecondsCLI, readARIOFromOptions, requiredStringFromOptions, stringArrayFromOptions, writeANTFromOptions, } from '../utils.js';
 /** @deprecated -- use set-ant-base-name and set-ant-undername */
 export async function setAntRecordCLICommand(o) {
     const ttlSeconds = +(o.ttlSeconds ?? defaultTtlSecondsCLI);
     const undername = requiredStringFromOptions(o, 'undername');
     const transactionId = requiredStringFromOptions(o, 'transactionId');
     const writeAnt = writeANTFromOptions(o);
-    if (!o.skipConfirmation) {
-        await 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 writeANTFromOptions(o).setRecord({
+    const recordParams = {
         undername,
         transactionId,
         ttlSeconds,
-    }, customTagsFromOptions(o));
+        ...antRecordMetadataFromOptions(o),
+    };
+    if (!o.skipConfirmation) {
+        await assertConfirmationPrompt(`Are you sure you want to set this record on the ANT process ${writeAnt.processId}?\n${JSON.stringify(recordParams, null, 2)}`, o);
+    }
+    return writeANTFromOptions(o).setRecord(recordParams, customTagsFromOptions(o));
 }
 export async function setAntBaseNameCLICommand(o) {
     const ttlSeconds = +(o.ttlSeconds ?? defaultTtlSecondsCLI);
     const transactionId = requiredStringFromOptions(o, 'transactionId');
+    const params = {
+        transactionId,
+        ttlSeconds,
+        ...antRecordMetadataFromOptions(o),
+    };
     const writeAnt = writeANTFromOptions(o);
     if (!o.skipConfirmation) {
-        await 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 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 writeANTFromOptions(o).setBaseNameRecord({
-        transactionId,
-        ttlSeconds,
-    }, customTagsFromOptions(o));
+    return writeANTFromOptions(o).setBaseNameRecord(params, customTagsFromOptions(o));
 }
 export async function setAntUndernameCLICommand(o) {
     const ttlSeconds = +(o.ttlSeconds ?? defaultTtlSecondsCLI);
     const undername = requiredStringFromOptions(o, 'undername');
     const transactionId = requiredStringFromOptions(o, 'transactionId');
-    const writeAnt = writeANTFromOptions(o);
-    if (!o.skipConfirmation) {
-        await 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 writeANTFromOptions(o).setUndernameRecord({
+    const params = {
         undername,
         transactionId,
         ttlSeconds,
-    }, customTagsFromOptions(o));
+        ...antRecordMetadataFromOptions(o),
+    };
+    const writeAnt = writeANTFromOptions(o);
+    if (!o.skipConfirmation) {
+        await assertConfirmationPrompt(`Are you sure you want to set this undername on the ANT process ${writeAnt.processId}?\n${JSON.stringify(params, null, 2)}`, o);
+    }
+    return writeANTFromOptions(o).setUndernameRecord(params, customTagsFromOptions(o));
+}
+export async function transferRecordOwnershipCLICommand(o) {
+    const undername = requiredStringFromOptions(o, 'undername');
+    const recipient = requiredStringFromOptions(o, 'recipient');
+    const writeAnt = writeANTFromOptions(o);
+    if (!o.skipConfirmation) {
+        await 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 writeANTFromOptions(o).transferRecord({ undername, recipient }, customTagsFromOptions(o));
+}
+export async function upgradeAntCLICommand(o) {
+    const writeAnt = writeANTFromOptions(o);
+    const arioProcessId = arioProcessIdFromOptions(o);
+    const ario = readARIOFromOptions(o);
+    const reassignAffiliatedNames = booleanFromOptions(o, 'reassignAffiliatedNames');
+    const names = 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 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 writeANTFromOptions(o).upgrade({
+            reassignAffiliatedNames,
+            arioProcessId,
+        })
+        : await 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/esm/cli/options.js

@@ -251,6 +251,14 @@ export const 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',
@@ -286,6 +294,10 @@ export const 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',
@@ -300,6 +312,11 @@ export const 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',
+    },
 };
 export const walletOptions = [
     optionMap.walletFile,
@@ -408,14 +425,32 @@ export const antStateOptions = [
     optionMap.controllers,
     optionMap.ttlSeconds,
     optionMap.logo,
+    optionMap.module,
 ];
 export const setAntBaseNameOptions = [
     optionMap.processId,
     optionMap.transactionId,
     optionMap.ttlSeconds,
+    optionMap.owner,
+    optionMap.displayName,
+    optionMap.logo,
+    optionMap.description,
+    optionMap.keywords,
     ...writeActionOptions,
 ];
 export const setAntUndernameOptions = [
     ...setAntBaseNameOptions,
     optionMap.undername,
 ];
+export const upgradeAntOptions = [
+    optionMap.processId,
+    optionMap.names,
+    optionMap.reassignAffiliatedNames,
+    ...writeActionOptions,
+];
+export const transferRecordOwnershipOptions = [
+    optionMap.processId,
+    optionMap.undername,
+    optionMap.recipient,
+    ...writeActionOptions,
+];

package/lib/esm/cli/utils.js

@@ -18,7 +18,7 @@ import { connect } from '@permaweb/aoconnect';
 import { program } from 'commander';
 import { readFileSync } from 'fs';
 import prompts from 'prompts';
-import { ANT, ANTRegistry, ANT_REGISTRY_ID, AOProcess, ARIO, ARIOToken, ARIO_DEVNET_PROCESS_ID, ARIO_MAINNET_PROCESS_ID, ARIO_TESTNET_PROCESS_ID, ArweaveSigner, Logger, createAoSigner, fromB64Url, fundFromOptions, initANTStateForAddress, isValidFundFrom, isValidIntent, mARIOToken, sha256B64Url, validIntents, } from '../node/index.js';
+import { ANT, ANTRegistry, ANT_REGISTRY_ID, ANT_REGISTRY_TESTNET_ID, AOProcess, ARIO, ARIOToken, ARIO_DEVNET_PROCESS_ID, ARIO_MAINNET_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 const defaultTtlSecondsCLI = 3600;
 export function stringifyJsonForCLIDisplay(json) {
@@ -78,6 +78,15 @@ export function arioProcessIdFromOptions({ arioProcessId, devnet, testnet, }) {
     }
     return ARIO_MAINNET_PROCESS_ID;
 }
+export function antRegistryIdFromOptions({ antRegistryProcessId, testnet, }) {
+    if (antRegistryProcessId !== undefined) {
+        return antRegistryProcessId;
+    }
+    if (testnet) {
+        return ANT_REGISTRY_TESTNET_ID;
+    }
+    return ANT_REGISTRY_ID;
+}
 function walletFromOptions({ privateKey, walletFile, }) {
     if (privateKey !== undefined) {
         return JSON.parse(privateKey);
@@ -125,18 +134,9 @@ export function readARIOFromOptions(options) {
         paymentUrl: options.paymentUrl,
     });
 }
-export function ANTRegistryProcessFromOptions(options) {
-    return new AOProcess({
-        processId: options.antRegistryProcessId ?? ANT_REGISTRY_ID,
-        ao: connect({
-            MODE: 'legacy',
-            CU_URL: options.cuUrl,
-        }),
-    });
-}
 export function readANTRegistryFromOptions(options) {
     return ANTRegistry.init({
-        process: ANTRegistryProcessFromOptions(options),
+        process: aoProcessFromOptions(options),
         hyperbeamUrl: options.hyperbeamUrl,
     });
 }
@@ -507,3 +507,16 @@ export function assertLockLengthInRange(lockLengthMs, assertMin = true) {
         throw new Error(`Lock length must be at least 14 days (1209600000 ms). Provided lock length: ${lockLengthMs} ms`);
     }
 }
+export 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 }),
+    };
+}