@ar.io/sdk 3.3.1 → 3.4.0-alpha.2

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.arnsPurchaseOptions = 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.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>',
@@ -241,6 +241,19 @@ exports.optionMap = {
         alias: '--fund-from <fundFrom>',
         description: 'Where to fund the action from. e.g. "balance", "stakes", or "any',
     },
+    revokable: {
+        alias: '--revokable',
+        description: 'Whether the vaulted transfer is revokable by the sender. Defaults to false',
+        type: 'boolean',
+    },
+    lockLengthMs: {
+        alias: '--lock-length-ms <lockLengthMs>',
+        description: 'The length of time in milliseconds to lock the transfer for',
+    },
+    recipient: {
+        alias: '--recipient <recipient>',
+        description: 'The recipient to interact with',
+    },
 };
 exports.walletOptions = [
     exports.optionMap.walletFile,
@@ -288,6 +301,13 @@ exports.transferOptions = [
     exports.optionMap.quantity,
     exports.optionMap.target,
 ];
+exports.vaultedTransferOptions = [
+    ...exports.writeActionOptions,
+    exports.optionMap.quantity,
+    exports.optionMap.recipient,
+    exports.optionMap.lockLengthMs,
+    exports.optionMap.revokable,
+];
 exports.operatorStakeOptions = [
     ...exports.writeActionOptions,
     exports.optionMap.operatorStake,

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.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;
+exports.fundFromFromOptions = exports.getTokenCostParamsFromOptions = exports.getANTStateFromOptions = exports.requiredPositiveIntegerFromOptions = exports.positiveIntegerFromOptions = exports.requiredStringArrayFromOptions = exports.requiredStringFromOptions = exports.booleanFromOptions = 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.
  *
@@ -376,6 +376,10 @@ function writeANTFromOptions(options, signer) {
     });
 }
 exports.writeANTFromOptions = writeANTFromOptions;
+function booleanFromOptions(options, key) {
+    return !!options[key];
+}
+exports.booleanFromOptions = booleanFromOptions;
 function requiredStringFromOptions(options, key) {
     const value = options[key];
     if (value === undefined) {

package/lib/cjs/common/ant.js

@@ -285,6 +285,9 @@ class AoANTWriteable extends AoANTReadable {
         });
     }
     /**
+     * Sets the transactionId and ttlSeconds of a record (for updating the top level name, use undername "@".)
+     *
+     * @deprecated Use setUndernameRecord instead for undernames, and setBaseNameRecord instead for the top level name (e.g. "@")
      * @param undername @type {string} The record you want to set the transactionId and ttlSeconds of.
      * @param transactionId @type {string} The transactionId of the record.
      * @param ttlSeconds @type {number} The time to live of the record.
@@ -307,11 +310,68 @@ class AoANTWriteable extends AoANTReadable {
         });
     }
     /**
+     * Sets the top level name of the ANT. This is the name that will be used to resolve the ANT (e.g. ardrive.ar.io)
+     *
+     * @param transactionId @type {string} The transactionId of the record.
+     * @param ttlSeconds @type {number} The time to live of the record.
+     * @returns {Promise<AoMessageResult>} The result of the interaction.
+     * @example
+     * ```ts
+     * ant.setBaseNameRecord({ transactionId: "432l1cy0aksiL_x9M359faGzM_yjralacHIUo8_nQXM", ttlSeconds: 100 }); // ardrive.ar.io will resolve to the provided transaction id and be cached for 100 seconds by clients
+     * ```
+     */
+    async setBaseNameRecord({ transactionId, ttlSeconds, }) {
+        return this.process.send({
+            tags: [
+                { name: 'Action', value: 'Set-Record' },
+                { name: 'Sub-Domain', value: '@' },
+                { name: 'Transaction-Id', value: transactionId },
+                { name: 'TTL-Seconds', value: ttlSeconds.toString() },
+            ],
+            signer: this.signer,
+        });
+    }
+    /**
+     * Adds or updates an undername of the ANT. An undername is appended to the base name of the ANT (e.g. ardrive.ar.io) to form a fully qualified name (e.g. dapp_ardrive.ar.io)
+     *
+     * @param undername @type {string} The undername of the ANT.
+     * @param transactionId @type {string} The transactionId of the record.
+     * @param ttlSeconds @type {number} The time to live of the record.
+     * @returns {Promise<AoMessageResult>} The result of the interaction.
+     * @example
+     * ```ts
+     * ant.setUndernameRecord({ undername: "dapp", transactionId: "432l1cy0aksiL_x9M359faGzM_yjralacHIUo8_nQXM", ttlSeconds: 100 }); // dapp_ardrive.ar.io will resolve to the provided transaction id and be cached for 100 seconds by clients
+     * ```
+     */
+    async setUndernameRecord({ undername, transactionId, ttlSeconds, }) {
+        return this.setRecord({
+            undername,
+            transactionId,
+            ttlSeconds,
+        });
+    }
+    /**
+     * Removes an undername from the ANT. This will remove the undername from the ANT.
+     *
+     * @param undername @type {string} The undername you want to remove.
+     * @returns {Promise<AoMessageResult>} The result of the interaction.
+     * @example
+     * ```ts
+     * ant.removeUndernameRecord({ undername: "dapp" }); // removes dapp_ardrive.ar.io
+     * ```
+     */
+    async removeUndernameRecord({ undername, }) {
+        return this.removeRecord({ undername });
+    }
+    /**
+     * Removes a record from the ANT. This will remove the record from the ANT. If '@' is provided, the top level name will be removed.
+     *
+     * @deprecated Use removeUndernameRecord instead.
      * @param undername @type {string} The record you want to remove.
      * @returns {Promise<AoMessageResult>} The result of the interaction.
      * @example
      * ```ts
-     * ant.removeRecord({ subDomain: "shorts" });
+     * ant.removeRecord({ undername: "dapp" }); // removes dapp_ardrive.ar.io
      * ```
      */
     async removeRecord({ undername, }, options) {
@@ -325,6 +385,8 @@ class AoANTWriteable extends AoANTReadable {
         });
     }
     /**
+     * Sets the ticker of the ANT. This is the abbreviation displayed in ecosystem apps.
+     *
      * @param ticker @type {string} Sets the ANT Ticker.
      * @returns {Promise<AoMessageResult>} The result of the interaction.
      * @example
@@ -343,6 +405,8 @@ class AoANTWriteable extends AoANTReadable {
         });
     }
     /**
+     * Sets the name of the ANT. This is the display name of the ANT. This is NOT the base name record.
+     *
      * @param name @type {string} Sets the Name of the ANT.
      * @returns {Promise<AoMessageResult>} The result of the interaction.
      * @example
@@ -361,6 +425,8 @@ class AoANTWriteable extends AoANTReadable {
         });
     }
     /**
+     * Sets the description of the ANT. This is the description of the ANT displayed in ecosystem apps.
+     *
      * @param description @type {string} Sets the ANT Description.
      * @returns {Promise<AoMessageResult>} The result of the interaction.
      * @example
@@ -379,6 +445,8 @@ class AoANTWriteable extends AoANTReadable {
         });
     }
     /**
+     * Sets the keywords of the ANT. This is the keywords of the ANT displayed in ecosystem apps.
+     *
      * @param keywords @type {string[]} Sets the ANT Keywords.
      * @returns {Promise<AoMessageResult>} The result of the interaction.
      * @example
@@ -397,6 +465,8 @@ class AoANTWriteable extends AoANTReadable {
         });
     }
     /**
+     * Sets the logo of the ANT. This is the logo of the ANT displayed in ecosystem apps. Additionally, this logo is displayed for any primary names affiliated with the ANT.
+     *
      * @param txId @type {string} - Arweave transaction id of the logo we want to set
      * @param options @type {WriteOptions} - additional options to add to the write interaction (optional)
      * @returns {Promise<AoMessageResult>} The result of the interaction.
@@ -416,6 +486,9 @@ class AoANTWriteable extends AoANTReadable {
         });
     }
     /**
+     * Releases an ArNS name associated with the ANT. This will release the name to the public and allow anyone to register it. All primary names must be removed before the name can be released.
+     *
+     *
      * @param name @type {string} The name you want to release. The name will be put up for as a recently returned name on the ARIO contract. 50% of the winning bid will be distributed to the ANT owner at the time of purchase. If no purchase in the recently returned name period (14 epochs), the name will be released and can be reregistered by anyone.
      * @param arioProcessId @type {string} The processId of the ARIO contract. This is where the ANT will send the message to release the name.
      * @returns {Promise<AoMessageResult>} The result of the interaction.
@@ -437,7 +510,8 @@ class AoANTWriteable extends AoANTReadable {
         });
     }
     /**
-     * Sends a message to the ARIO contract to reassign the name to a new ANT. This can only be done by the current owner of the ANT.
+     * Sends a message to the ARIO contract to reassign the the base ArNS name to a new ANT. This can only be done by the current owner of the ANT.
+     *
      * @param name @type {string} The name you want to reassign.
      * @param arioProcessId @type {string} The processId of the ARIO contract.
      * @param antProcessId @type {string} The processId of the ANT contract.
@@ -462,6 +536,15 @@ class AoANTWriteable extends AoANTReadable {
     }
     /**
      * Approves a primary name request for a given name or address.
+     *
+     * @param name @type {string} The name you want to approve.
+     * @param address @type {WalletAddress} The address you want to approve.
+     * @param arioProcessId @type {string} The processId of the ARIO contract.
+     * @returns {Promise<AoMessageResult>} The result of the interaction.
+     * @example
+     * ```ts
+     * ant.approvePrimaryNameRequest({ name: "ardrive", address: "U7RXcpaVShG4u9nIcPVmm2FJSM5Gru9gQCIiRaIPV7f", arioProcessId: ARIO_TESTNET_PROCESS_ID }); // approves the request for ardrive.ar.io to be registered by the address
+     * ```
      */
     async approvePrimaryNameRequest({ name, address, arioProcessId, }, options) {
         return this.process.send({
@@ -476,6 +559,18 @@ class AoANTWriteable extends AoANTReadable {
             signer: this.signer,
         });
     }
+    /**
+     * Removes primary names from the ANT. This will remove the primary names associated with the base ArNS name controlled by this ANT. All primary names must be removed before the name can be released.
+     *
+     * @param names @type {string[]} The names you want to remove.
+     * @param arioProcessId @type {string} The processId of the ARIO contract.
+     * @param notifyOwners @type {boolean} Whether to notify the owners of the primary names.
+     * @returns {Promise<AoMessageResult>} The result of the interaction.
+     * @example
+     * ```ts
+     * ant.removePrimaryNames({ names: ["ardrive", "dapp_ardrive"], arioProcessId: ARIO_TESTNET_PROCESS_ID, notifyOwners: true }); // removes the primary names and associated wallet addresses assigned to "ardrive" and "dapp_ardrive"
+     * ```
+     */
     async removePrimaryNames({ names, arioProcessId, notifyOwners = false, }, options) {
         return this.process.send({
             tags: [

package/lib/cjs/common/io.js

@@ -492,6 +492,32 @@ class ARIOWriteable extends ARIOReadable {
             signer: this.signer,
         });
     }
+    async vaultedTransfer({ recipient, quantity, lockLengthMs, revokable = false, }, options) {
+        const { tags = [] } = options || {};
+        return this.process.send({
+            tags: [
+                ...tags,
+                { name: 'Action', value: 'Vaulted-Transfer' },
+                { name: 'Recipient', value: recipient },
+                { name: 'Quantity', value: quantity.toString() },
+                { name: 'Lock-Length', value: lockLengthMs.toString() },
+                { name: 'Revokable', value: `${revokable}` },
+            ],
+            signer: this.signer,
+        });
+    }
+    async revokeVault({ vaultId, recipient }, options) {
+        const { tags = [] } = options || {};
+        return this.process.send({
+            tags: [
+                ...tags,
+                { name: 'Action', value: 'Revoke-Vault' },
+                { name: 'Vault-Id', value: vaultId },
+                { name: 'Recipient', value: recipient },
+            ],
+            signer: this.signer,
+        });
+    }
     async joinNetwork({ operatorStake, allowDelegatedStaking, allowedDelegates, delegateRewardShareRatio, fqdn, label, minDelegatedStake, note, port, properties, protocol, autoStake, observerAddress, }, options) {
         const { tags = [] } = options || {};
         const allTags = [

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.3.1';
+exports.version = '3.4.0-alpha.2';

package/lib/esm/cli/cli.js

@@ -22,8 +22,8 @@ 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 { getAllGatewayVaults, getAllowedDelegates, getArNSRecord, getArNSReservedName, getArNSReturnedName, getCostDetails, getDelegations, getEpoch, getGateway, getGatewayDelegates, getGatewayVaults, getPrescribedNames, getPrescribedObservers, getPrimaryName, getTokenCost, getVault, listAllDelegatesCLICommand, listArNSRecords, listArNSReservedNames, listArNSReturnedNames, listGateways, } from './commands/readCommands.js';
-import { transfer } from './commands/transfer.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 { revokeVaultCLICommand, transferCLICommand, vaultedTransferCLICommand, } from './commands/transfer.js';
+import { addressAndVaultIdOptions, antStateOptions, arnsPurchaseOptions, buyRecordOptions, decreaseDelegateStakeOptions, delegateStakeOptions, epochOptions, getVaultOptions, globalOptions, joinNetworkOptions, operatorStakeOptions, optionMap, paginationAddressOptions, paginationOptions, redelegateStakeOptions, tokenCostOptions, transferOptions, updateGatewaySettingsOptions, vaultedTransferOptions, writeActionOptions, } from './options.js';
 import { applyOptions, arioProcessIdFromOptions, assertConfirmationPrompt, epochInputFromOptions, formatARIOWithCommas, getANTStateFromOptions, getLoggerFromOptions, makeCommand, paginationParamsFromOptions, readANTFromOptions, readARIOFromOptions, requiredAddressFromOptions, requiredAoSignerFromOptions, requiredProcessIdFromOptions, requiredStringArrayFromOptions, requiredStringFromOptions, writeANTFromOptions, writeActionTagsFromOptions, } from './utils.js';
 applyOptions(program
     .name('ar.io')
@@ -266,7 +266,19 @@ makeCommand({
     name: 'transfer',
     description: 'Transfer ARIO to another address',
     options: transferOptions,
-    action: transfer,
+    action: transferCLICommand,
+});
+makeCommand({
+    name: 'vaulted-transfer',
+    description: 'Transfer ARIO to another address into a locked vault',
+    options: vaultedTransferOptions,
+    action: vaultedTransferCLICommand,
+});
+makeCommand({
+    name: 'revoke-vault',
+    description: 'Revoke a vaulted transfer as the controller',
+    options: [...writeActionOptions, optionMap.vaultId, optionMap.recipient],
+    action: revokeVaultCLICommand,
 });
 makeCommand({
     name: 'join-network',

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

@@ -1,5 +1,5 @@
-import { assertEnoughMARIOBalance, confirmationPrompt, formatARIOWithCommas, requiredTargetAndQuantityFromOptions, writeARIOFromOptions, writeActionTagsFromOptions, } from '../utils.js';
-export async function transfer(options) {
+import { assertEnoughMARIOBalance, confirmationPrompt, formatARIOWithCommas, formatMARIOToARIOWithCommas, requiredMARIOFromOptions, requiredPositiveIntegerFromOptions, requiredStringFromOptions, requiredTargetAndQuantityFromOptions, writeARIOFromOptions, writeActionTagsFromOptions, } from '../utils.js';
+export async function transferCLICommand(options) {
     const { target, arioQuantity } = requiredTargetAndQuantityFromOptions(options);
     const { ario, signerAddress } = writeARIOFromOptions(options);
     if (!options.skipConfirmation) {
@@ -24,3 +24,57 @@ export async function transfer(options) {
     };
     return output;
 }
+export async function vaultedTransferCLICommand(o) {
+    const mARIOQuantity = requiredMARIOFromOptions(o, 'quantity');
+    const recipient = requiredStringFromOptions(o, 'recipient');
+    const { ario, signerAddress } = writeARIOFromOptions(o);
+    const lockLengthMs = requiredPositiveIntegerFromOptions(o, 'lockLengthMs');
+    if (!o.skipConfirmation) {
+        await assertEnoughMARIOBalance({
+            ario,
+            address: signerAddress,
+            mARIOQuantity,
+        });
+        const confirm = await confirmationPrompt(`Are you sure you want transfer ${formatMARIOToARIOWithCommas(mARIOQuantity)} ARIO to ${recipient}, locked in a ${o.revokable ? '' : 'non-'}revokable vault for ${lockLengthMs}ms?`);
+        if (!confirm) {
+            return { message: 'Transfer aborted by user' };
+        }
+    }
+    const result = await ario.vaultedTransfer({
+        recipient,
+        quantity: mARIOQuantity,
+        lockLengthMs,
+        revokable: o.revokable,
+    }, writeActionTagsFromOptions(o));
+    const output = {
+        senderAddress: signerAddress,
+        transferResult: result,
+        message: `Successfully vaulted transferred ${formatMARIOToARIOWithCommas(mARIOQuantity)} ARIO to ${recipient}`,
+    };
+    return output;
+}
+export async function revokeVaultCLICommand(o) {
+    const { ario, signerAddress } = writeARIOFromOptions(o);
+    const vaultId = requiredStringFromOptions(o, 'vaultId');
+    const recipient = requiredStringFromOptions(o, 'recipient');
+    if (!o.skipConfirmation) {
+        const vault = await ario.getVault({ vaultId, address: recipient });
+        if (!vault) {
+            throw new Error(`Vault for recipient '${recipient}' with vault id '${vaultId}' not found`);
+        }
+        const confirm = await confirmationPrompt(`Are you sure you want to revoke vault with id ${vaultId} from ${recipient}?`);
+        if (!confirm) {
+            return { message: 'Revoke aborted by user' };
+        }
+    }
+    const result = await ario.revokeVault({
+        vaultId,
+        recipient,
+    }, writeActionTagsFromOptions(o));
+    const output = {
+        senderAddress: signerAddress,
+        transferResult: result,
+        message: `Successfully revoked vault with id ${vaultId}`,
+    };
+    return output;
+}

package/lib/esm/cli/options.js

@@ -238,6 +238,19 @@ export const optionMap = {
         alias: '--fund-from <fundFrom>',
         description: 'Where to fund the action from. e.g. "balance", "stakes", or "any',
     },
+    revokable: {
+        alias: '--revokable',
+        description: 'Whether the vaulted transfer is revokable by the sender. Defaults to false',
+        type: 'boolean',
+    },
+    lockLengthMs: {
+        alias: '--lock-length-ms <lockLengthMs>',
+        description: 'The length of time in milliseconds to lock the transfer for',
+    },
+    recipient: {
+        alias: '--recipient <recipient>',
+        description: 'The recipient to interact with',
+    },
 };
 export const walletOptions = [
     optionMap.walletFile,
@@ -285,6 +298,13 @@ export const transferOptions = [
     optionMap.quantity,
     optionMap.target,
 ];
+export const vaultedTransferOptions = [
+    ...writeActionOptions,
+    optionMap.quantity,
+    optionMap.recipient,
+    optionMap.lockLengthMs,
+    optionMap.revokable,
+];
 export const operatorStakeOptions = [
     ...writeActionOptions,
     optionMap.operatorStake,

package/lib/esm/cli/utils.js

@@ -338,6 +338,9 @@ export function writeANTFromOptions(options, signer) {
         signer,
     });
 }
+export function booleanFromOptions(options, key) {
+    return !!options[key];
+}
 export function requiredStringFromOptions(options, key) {
     const value = options[key];
     if (value === undefined) {

package/lib/esm/common/ant.js

@@ -280,6 +280,9 @@ export class AoANTWriteable extends AoANTReadable {
         });
     }
     /**
+     * Sets the transactionId and ttlSeconds of a record (for updating the top level name, use undername "@".)
+     *
+     * @deprecated Use setUndernameRecord instead for undernames, and setBaseNameRecord instead for the top level name (e.g. "@")
      * @param undername @type {string} The record you want to set the transactionId and ttlSeconds of.
      * @param transactionId @type {string} The transactionId of the record.
      * @param ttlSeconds @type {number} The time to live of the record.
@@ -302,11 +305,68 @@ export class AoANTWriteable extends AoANTReadable {
         });
     }
     /**
+     * Sets the top level name of the ANT. This is the name that will be used to resolve the ANT (e.g. ardrive.ar.io)
+     *
+     * @param transactionId @type {string} The transactionId of the record.
+     * @param ttlSeconds @type {number} The time to live of the record.
+     * @returns {Promise<AoMessageResult>} The result of the interaction.
+     * @example
+     * ```ts
+     * ant.setBaseNameRecord({ transactionId: "432l1cy0aksiL_x9M359faGzM_yjralacHIUo8_nQXM", ttlSeconds: 100 }); // ardrive.ar.io will resolve to the provided transaction id and be cached for 100 seconds by clients
+     * ```
+     */
+    async setBaseNameRecord({ transactionId, ttlSeconds, }) {
+        return this.process.send({
+            tags: [
+                { name: 'Action', value: 'Set-Record' },
+                { name: 'Sub-Domain', value: '@' },
+                { name: 'Transaction-Id', value: transactionId },
+                { name: 'TTL-Seconds', value: ttlSeconds.toString() },
+            ],
+            signer: this.signer,
+        });
+    }
+    /**
+     * Adds or updates an undername of the ANT. An undername is appended to the base name of the ANT (e.g. ardrive.ar.io) to form a fully qualified name (e.g. dapp_ardrive.ar.io)
+     *
+     * @param undername @type {string} The undername of the ANT.
+     * @param transactionId @type {string} The transactionId of the record.
+     * @param ttlSeconds @type {number} The time to live of the record.
+     * @returns {Promise<AoMessageResult>} The result of the interaction.
+     * @example
+     * ```ts
+     * ant.setUndernameRecord({ undername: "dapp", transactionId: "432l1cy0aksiL_x9M359faGzM_yjralacHIUo8_nQXM", ttlSeconds: 100 }); // dapp_ardrive.ar.io will resolve to the provided transaction id and be cached for 100 seconds by clients
+     * ```
+     */
+    async setUndernameRecord({ undername, transactionId, ttlSeconds, }) {
+        return this.setRecord({
+            undername,
+            transactionId,
+            ttlSeconds,
+        });
+    }
+    /**
+     * Removes an undername from the ANT. This will remove the undername from the ANT.
+     *
+     * @param undername @type {string} The undername you want to remove.
+     * @returns {Promise<AoMessageResult>} The result of the interaction.
+     * @example
+     * ```ts
+     * ant.removeUndernameRecord({ undername: "dapp" }); // removes dapp_ardrive.ar.io
+     * ```
+     */
+    async removeUndernameRecord({ undername, }) {
+        return this.removeRecord({ undername });
+    }
+    /**
+     * Removes a record from the ANT. This will remove the record from the ANT. If '@' is provided, the top level name will be removed.
+     *
+     * @deprecated Use removeUndernameRecord instead.
      * @param undername @type {string} The record you want to remove.
      * @returns {Promise<AoMessageResult>} The result of the interaction.
      * @example
      * ```ts
-     * ant.removeRecord({ subDomain: "shorts" });
+     * ant.removeRecord({ undername: "dapp" }); // removes dapp_ardrive.ar.io
      * ```
      */
     async removeRecord({ undername, }, options) {
@@ -320,6 +380,8 @@ export class AoANTWriteable extends AoANTReadable {
         });
     }
     /**
+     * Sets the ticker of the ANT. This is the abbreviation displayed in ecosystem apps.
+     *
      * @param ticker @type {string} Sets the ANT Ticker.
      * @returns {Promise<AoMessageResult>} The result of the interaction.
      * @example
@@ -338,6 +400,8 @@ export class AoANTWriteable extends AoANTReadable {
         });
     }
     /**
+     * Sets the name of the ANT. This is the display name of the ANT. This is NOT the base name record.
+     *
      * @param name @type {string} Sets the Name of the ANT.
      * @returns {Promise<AoMessageResult>} The result of the interaction.
      * @example
@@ -356,6 +420,8 @@ export class AoANTWriteable extends AoANTReadable {
         });
     }
     /**
+     * Sets the description of the ANT. This is the description of the ANT displayed in ecosystem apps.
+     *
      * @param description @type {string} Sets the ANT Description.
      * @returns {Promise<AoMessageResult>} The result of the interaction.
      * @example
@@ -374,6 +440,8 @@ export class AoANTWriteable extends AoANTReadable {
         });
     }
     /**
+     * Sets the keywords of the ANT. This is the keywords of the ANT displayed in ecosystem apps.
+     *
      * @param keywords @type {string[]} Sets the ANT Keywords.
      * @returns {Promise<AoMessageResult>} The result of the interaction.
      * @example
@@ -392,6 +460,8 @@ export class AoANTWriteable extends AoANTReadable {
         });
     }
     /**
+     * Sets the logo of the ANT. This is the logo of the ANT displayed in ecosystem apps. Additionally, this logo is displayed for any primary names affiliated with the ANT.
+     *
      * @param txId @type {string} - Arweave transaction id of the logo we want to set
      * @param options @type {WriteOptions} - additional options to add to the write interaction (optional)
      * @returns {Promise<AoMessageResult>} The result of the interaction.
@@ -411,6 +481,9 @@ export class AoANTWriteable extends AoANTReadable {
         });
     }
     /**
+     * Releases an ArNS name associated with the ANT. This will release the name to the public and allow anyone to register it. All primary names must be removed before the name can be released.
+     *
+     *
      * @param name @type {string} The name you want to release. The name will be put up for as a recently returned name on the ARIO contract. 50% of the winning bid will be distributed to the ANT owner at the time of purchase. If no purchase in the recently returned name period (14 epochs), the name will be released and can be reregistered by anyone.
      * @param arioProcessId @type {string} The processId of the ARIO contract. This is where the ANT will send the message to release the name.
      * @returns {Promise<AoMessageResult>} The result of the interaction.
@@ -432,7 +505,8 @@ export class AoANTWriteable extends AoANTReadable {
         });
     }
     /**
-     * Sends a message to the ARIO contract to reassign the name to a new ANT. This can only be done by the current owner of the ANT.
+     * Sends a message to the ARIO contract to reassign the the base ArNS name to a new ANT. This can only be done by the current owner of the ANT.
+     *
      * @param name @type {string} The name you want to reassign.
      * @param arioProcessId @type {string} The processId of the ARIO contract.
      * @param antProcessId @type {string} The processId of the ANT contract.
@@ -457,6 +531,15 @@ export class AoANTWriteable extends AoANTReadable {
     }
     /**
      * Approves a primary name request for a given name or address.
+     *
+     * @param name @type {string} The name you want to approve.
+     * @param address @type {WalletAddress} The address you want to approve.
+     * @param arioProcessId @type {string} The processId of the ARIO contract.
+     * @returns {Promise<AoMessageResult>} The result of the interaction.
+     * @example
+     * ```ts
+     * ant.approvePrimaryNameRequest({ name: "ardrive", address: "U7RXcpaVShG4u9nIcPVmm2FJSM5Gru9gQCIiRaIPV7f", arioProcessId: ARIO_TESTNET_PROCESS_ID }); // approves the request for ardrive.ar.io to be registered by the address
+     * ```
      */
     async approvePrimaryNameRequest({ name, address, arioProcessId, }, options) {
         return this.process.send({
@@ -471,6 +554,18 @@ export class AoANTWriteable extends AoANTReadable {
             signer: this.signer,
         });
     }
+    /**
+     * Removes primary names from the ANT. This will remove the primary names associated with the base ArNS name controlled by this ANT. All primary names must be removed before the name can be released.
+     *
+     * @param names @type {string[]} The names you want to remove.
+     * @param arioProcessId @type {string} The processId of the ARIO contract.
+     * @param notifyOwners @type {boolean} Whether to notify the owners of the primary names.
+     * @returns {Promise<AoMessageResult>} The result of the interaction.
+     * @example
+     * ```ts
+     * ant.removePrimaryNames({ names: ["ardrive", "dapp_ardrive"], arioProcessId: ARIO_TESTNET_PROCESS_ID, notifyOwners: true }); // removes the primary names and associated wallet addresses assigned to "ardrive" and "dapp_ardrive"
+     * ```
+     */
     async removePrimaryNames({ names, arioProcessId, notifyOwners = false, }, options) {
         return this.process.send({
             tags: [

package/lib/esm/common/io.js

@@ -487,6 +487,32 @@ export class ARIOWriteable extends ARIOReadable {
             signer: this.signer,
         });
     }
+    async vaultedTransfer({ recipient, quantity, lockLengthMs, revokable = false, }, options) {
+        const { tags = [] } = options || {};
+        return this.process.send({
+            tags: [
+                ...tags,
+                { name: 'Action', value: 'Vaulted-Transfer' },
+                { name: 'Recipient', value: recipient },
+                { name: 'Quantity', value: quantity.toString() },
+                { name: 'Lock-Length', value: lockLengthMs.toString() },
+                { name: 'Revokable', value: `${revokable}` },
+            ],
+            signer: this.signer,
+        });
+    }
+    async revokeVault({ vaultId, recipient }, options) {
+        const { tags = [] } = options || {};
+        return this.process.send({
+            tags: [
+                ...tags,
+                { name: 'Action', value: 'Revoke-Vault' },
+                { name: 'Vault-Id', value: vaultId },
+                { name: 'Recipient', value: recipient },
+            ],
+            signer: this.signer,
+        });
+    }
     async joinNetwork({ operatorStake, allowDelegatedStaking, allowedDelegates, delegateRewardShareRatio, fqdn, label, minDelegatedStake, note, port, properties, protocol, autoStake, observerAddress, }, options) {
         const { tags = [] } = options || {};
         const allTags = [

package/lib/esm/version.js

@@ -14,4 +14,4 @@
  * limitations under the License.
  */
 // AUTOMATICALLY GENERATED FILE - DO NOT TOUCH
-export const version = '3.3.1';
+export const version = '3.4.0-alpha.2';