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

package/lib/esm/common/ant.js

@@ -326,7 +326,7 @@ export class AoANTWriteable extends AoANTReadable {
      * @returns {Promise<AoMessageResult>} The result of the interaction.
      * @example
      * ```ts
-     * ant.setName({ name: "ships at sea" });
+     * ant.setName({ name: "test" }); // results in the resolution of `test_<apexName>.ar.io`
      * ```
      */
     async setName({ name }, options) {
@@ -339,4 +339,83 @@ export class AoANTWriteable extends AoANTReadable {
             signer: this.signer,
         });
     }
+    /**
+     * @param description @type {string} Sets the ANT Description.
+     * @returns {Promise<AoMessageResult>} The result of the interaction.
+     * @example
+     * ```ts
+     * ant.setDescription({ description: "This name is used for the ArDrive" });
+     * ```
+     */
+    async setDescription({ description }, options) {
+        return this.process.send({
+            tags: [
+                ...(options?.tags ?? []),
+                { name: 'Action', value: 'Set-Description' },
+                { name: 'Description', value: description },
+            ],
+            signer: this.signer,
+        });
+    }
+    /**
+     * @param keywords @type {string[]} Sets the ANT Keywords.
+     * @returns {Promise<AoMessageResult>} The result of the interaction.
+     * @example
+     * ```ts
+     * ant.setKeywords({ keywords: ['keyword1', 'keyword2', 'keyword3']});
+     * ```
+     */
+    async setKeywords({ keywords }, options) {
+        return this.process.send({
+            tags: [
+                ...(options?.tags ?? []),
+                { name: 'Action', value: 'Set-Keywords' },
+                { name: 'Description', value: JSON.stringify(keywords) },
+            ],
+            signer: this.signer,
+        });
+    }
+    /**
+     * @param name @type {string} The name you want to release. The name will be put up for auction on the IO contract. 50% of the winning bid will be distributed to the ANT owner at the time of release. If no bids, the name will be released and can be reregistered by anyone.
+     * @param ioProcessId @type {string} The processId of the IO contract. This is where the ANT will send the message to release the name.
+     * @returns {Promise<AoMessageResult>} The result of the interaction.
+     * @example
+     * ```ts
+     * ant.releaseName({ name: "ardrive", ioProcessId: IO_TESTNET_PROCESS_ID });
+     * ```
+     */
+    async releaseName({ name, ioProcessId }, options) {
+        return this.process.send({
+            tags: [
+                ...(options?.tags ?? []),
+                { name: 'Action', value: 'Release-Name' },
+                { name: 'Name', value: name },
+                { name: 'IO-Process-Id', value: ioProcessId },
+            ],
+            signer: this.signer,
+        });
+    }
+    /**
+     * Sends a message to the IO contract to reassign the 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 ioProcessId @type {string} The processId of the IO contract.
+     * @param antProcessId @type {string} The processId of the ANT contract.
+     * @returns {Promise<AoMessageResult>} The result of the interaction.
+     * @example
+     * ```ts
+     * ant.reassignName({ name: "ardrive", ioProcessId: IO_TESTNET_PROCESS_ID, antProcessId: NEW_ANT_PROCESS_ID });
+     * ```
+     */
+    async reassignName({ name, ioProcessId, antProcessId, }, options) {
+        return this.process.send({
+            tags: [
+                ...(options?.tags ?? []),
+                { name: 'Action', value: 'Reassign-Name' },
+                { name: 'Name', value: name },
+                { name: 'IO-Process-Id', value: ioProcessId },
+                { name: 'Process-Id', value: antProcessId },
+            ],
+            signer: this.signer,
+        });
+    }
 }

package/lib/esm/common/io.js

@@ -1,6 +1,7 @@
 import { IO_TESTNET_PROCESS_ID } from '../constants.js';
 import { isProcessConfiguration, isProcessIdConfiguration, } from '../types/io.js';
 import { createAoSigner } from '../utils/ao.js';
+import { pruneTags } from '../utils/arweave.js';
 import { defaultArweave } from './arweave.js';
 import { AOProcess } from './contracts/ao-process.js';
 import { InvalidContractConfigurationError } from './error.js';
@@ -68,9 +69,8 @@ export class IOReadable {
                 value: params?.epochIndex?.toString(),
             },
         ];
-        const prunedTags = allTags.filter((tag) => tag.value !== undefined);
         return this.process.read({
-            tags: prunedTags,
+            tags: pruneTags(allTags),
         });
     }
     async getEpoch(epoch) {
@@ -93,9 +93,8 @@ export class IOReadable {
                 value: epoch?.epochIndex?.toString(),
             },
         ];
-        const prunedTags = allTags.filter((tag) => tag.value !== undefined);
         return this.process.read({
-            tags: prunedTags,
+            tags: pruneTags(allTags),
         });
     }
     async getArNSRecord({ name, }) {
@@ -106,17 +105,16 @@ export class IOReadable {
             ],
         });
     }
-    async getArNSRecords(pageParams) {
+    async getArNSRecords(params) {
         const allTags = [
             { name: 'Action', value: 'Paginated-Records' },
-            { name: 'Cursor', value: pageParams?.cursor?.toString() },
-            { name: 'Limit', value: pageParams?.limit?.toString() },
-            { name: 'Sort-By', value: pageParams?.sortBy },
-            { name: 'Sort-Order', value: pageParams?.sortOrder },
+            { name: 'Cursor', value: params?.cursor?.toString() },
+            { name: 'Limit', value: params?.limit?.toString() },
+            { name: 'Sort-By', value: params?.sortBy },
+            { name: 'Sort-Order', value: params?.sortOrder },
         ];
-        const prunedTags = allTags.filter((tag) => tag.value !== undefined);
         return this.process.read({
-            tags: prunedTags,
+            tags: pruneTags(allTags),
         });
     }
     async getArNSReservedNames() {
@@ -140,17 +138,16 @@ export class IOReadable {
             ],
         });
     }
-    async getBalances(pageParams) {
+    async getBalances(params) {
         const allTags = [
             { name: 'Action', value: 'Paginated-Balances' },
-            { name: 'Cursor', value: pageParams?.cursor?.toString() },
-            { name: 'Limit', value: pageParams?.limit?.toString() },
-            { name: 'Sort-By', value: pageParams?.sortBy },
-            { name: 'Sort-Order', value: pageParams?.sortOrder },
+            { name: 'Cursor', value: params?.cursor?.toString() },
+            { name: 'Limit', value: params?.limit?.toString() },
+            { name: 'Sort-By', value: params?.sortBy },
+            { name: 'Sort-Order', value: params?.sortOrder },
         ];
-        const prunedTags = allTags.filter((tag) => tag.value !== undefined);
         return this.process.read({
-            tags: prunedTags,
+            tags: pruneTags(allTags),
         });
     }
     async getGateway({ address, }) {
@@ -161,6 +158,32 @@ export class IOReadable {
             ],
         });
     }
+    async getGatewayDelegates({ address, ...pageParams }) {
+        const allTags = [
+            { name: 'Action', value: 'Paginated-Delegates' },
+            { name: 'Address', value: address },
+            { name: 'Cursor', value: pageParams?.cursor?.toString() },
+            { name: 'Limit', value: pageParams?.limit?.toString() },
+            { name: 'Sort-By', value: pageParams?.sortBy },
+            { name: 'Sort-Order', value: pageParams?.sortOrder },
+        ];
+        return this.process.read({
+            tags: pruneTags(allTags),
+        });
+    }
+    async getGatewayDelegateAllowList({ address, ...pageParams }) {
+        const allTags = [
+            { name: 'Action', value: 'Paginated-Allowed-Delegates' },
+            { name: 'Address', value: address },
+            { name: 'Cursor', value: pageParams?.cursor?.toString() },
+            { name: 'Limit', value: pageParams?.limit?.toString() },
+            { name: 'Sort-Order', value: pageParams?.sortOrder },
+            // note: sortBy is omitted because it's not supported for this action as table is an of addresses
+        ];
+        return this.process.read({
+            tags: pruneTags(allTags),
+        });
+    }
     async getGateways(pageParams) {
         const allTags = [
             { name: 'Action', value: 'Paginated-Gateways' },
@@ -169,9 +192,8 @@ export class IOReadable {
             { name: 'Sort-By', value: pageParams?.sortBy },
             { name: 'Sort-Order', value: pageParams?.sortOrder },
         ];
-        const prunedTags = allTags.filter((tag) => tag.value !== undefined);
         return this.process.read({
-            tags: prunedTags,
+            tags: pruneTags(allTags),
         });
     }
     async getCurrentEpoch() {
@@ -212,9 +234,8 @@ export class IOReadable {
                 value: epoch?.epochIndex?.toString(),
             },
         ];
-        const prunedTags = allTags.filter((tag) => tag.value !== undefined);
         return this.process.read({
-            tags: prunedTags,
+            tags: pruneTags(allTags),
         });
     }
     async getPrescribedNames(epoch) {
@@ -237,9 +258,8 @@ export class IOReadable {
                 value: epoch?.epochIndex?.toString(),
             },
         ];
-        const prunedTags = allTags.filter((tag) => tag.value !== undefined);
         return this.process.read({
-            tags: prunedTags,
+            tags: pruneTags(allTags),
         });
     }
     async getObservations(epoch) {
@@ -262,9 +282,8 @@ export class IOReadable {
                 value: epoch?.epochIndex?.toString(),
             },
         ];
-        const prunedTags = allTags.filter((tag) => tag.value !== undefined);
         return this.process.read({
-            tags: prunedTags,
+            tags: pruneTags(allTags),
         });
     }
     async getDistributions(epoch) {
@@ -287,12 +306,11 @@ export class IOReadable {
                 value: epoch?.epochIndex?.toString(),
             },
         ];
-        const prunedTags = allTags.filter((tag) => tag.value !== undefined);
         return this.process.read({
-            tags: prunedTags,
+            tags: pruneTags(allTags),
         });
     }
-    async getTokenCost({ intent, purchaseType, years, name, quantity, }) {
+    async getTokenCost({ intent, type, years, name, quantity, }) {
         const allTags = [
             { name: 'Action', value: 'Token-Cost' },
             {
@@ -313,7 +331,7 @@ export class IOReadable {
             },
             {
                 name: 'Purchase-Type',
-                value: purchaseType,
+                value: type,
             },
             {
                 name: 'Timestamp',
@@ -327,9 +345,8 @@ export class IOReadable {
                 })).timestamp.toString(),
             },
         ];
-        const prunedTags = allTags.filter((tag) => tag.value !== undefined);
         return this.process.read({
-            tags: prunedTags,
+            tags: pruneTags(allTags),
         });
     }
     async getRegistrationFees() {
@@ -342,6 +359,63 @@ export class IOReadable {
             tags: [{ name: 'Action', value: 'Demand-Factor' }],
         });
     }
+    // Auctions
+    async getArNSAuctions(params) {
+        const allTags = [
+            { name: 'Action', value: 'Auctions' },
+            { name: 'Cursor', value: params?.cursor?.toString() },
+            { name: 'Limit', value: params?.limit?.toString() },
+            { name: 'Sort-By', value: params?.sortBy },
+            { name: 'Sort-Order', value: params?.sortOrder },
+        ];
+        return this.process.read({
+            tags: pruneTags(allTags),
+        });
+    }
+    async getArNSAuction({ name, }) {
+        const allTags = [
+            { name: 'Action', value: 'Auction-Info' },
+            { name: 'Name', value: name },
+        ];
+        return this.process.read({
+            tags: allTags,
+        });
+    }
+    /**
+     * Get auction prices for a given auction at the provided intervals
+     *
+     * @param {Object} params - The parameters for fetching auction prices
+     * @param {string} params.name - The name of the auction
+     * @param {('permabuy'|'lease')} [params.type='lease'] - The type of purchase
+     * @param {number} [params.years=1] - The number of years for lease (only applicable if type is 'lease')
+     * @param {number} [params.timestamp=Date.now()] - The timestamp to fetch prices for
+     * @param {number} [params.intervalMs=900000] - The interval in milliseconds between price points (default is 15 minutes)
+     * @returns {Promise<AoAuctionPriceData>} The auction price data
+     */
+    async getArNSAuctionPrices({ name, type, years, timestamp, intervalMs, }) {
+        const prunedPriceTags = [
+            { name: 'Action', value: 'Auction-Prices' },
+            { name: 'Name', value: name },
+            {
+                name: 'Timestamp',
+                value: timestamp?.toString() ?? Date.now().toString(),
+            },
+            { name: 'Purchase-Type', value: type ?? 'lease' },
+            {
+                name: 'Years',
+                value: type == undefined || type === 'lease'
+                    ? years?.toString() ?? '1'
+                    : undefined,
+            },
+            {
+                name: 'Price-Interval-Ms',
+                value: intervalMs?.toString() ?? '900000',
+            },
+        ].filter((tag) => tag.value !== undefined);
+        return this.process.read({
+            tags: prunedPriceTags,
+        });
+    }
 }
 export class IOWriteable extends IOReadable {
     signer;
@@ -388,7 +462,7 @@ export class IOWriteable extends IOReadable {
             signer: this.signer,
         });
     }
-    async joinNetwork({ operatorStake, allowDelegatedStaking, delegateRewardShareRatio, fqdn, label, minDelegatedStake, note, port, properties, protocol, autoStake, observerAddress, }, options) {
+    async joinNetwork({ operatorStake, allowDelegatedStaking, allowedDelegates, delegateRewardShareRatio, fqdn, label, minDelegatedStake, note, port, properties, protocol, autoStake, observerAddress, }, options) {
         const { tags = [] } = options || {};
         const allTags = [
             ...tags,
@@ -401,6 +475,10 @@ export class IOWriteable extends IOReadable {
                 name: 'Allow-Delegated-Staking',
                 value: allowDelegatedStaking?.toString(),
             },
+            {
+                name: 'Allowed-Delegates',
+                value: allowedDelegates?.join(','),
+            },
             {
                 name: 'Delegate-Reward-Share-Ratio',
                 value: delegateRewardShareRatio?.toString(),
@@ -442,10 +520,9 @@ export class IOWriteable extends IOReadable {
                 value: observerAddress,
             },
         ];
-        const prunedTags = allTags.filter((tag) => tag.value !== undefined);
         return this.process.send({
             signer: this.signer,
-            tags: prunedTags,
+            tags: pruneTags(allTags),
         });
     }
     async leaveNetwork(options) {
@@ -455,7 +532,7 @@ export class IOWriteable extends IOReadable {
             tags: [...tags, { name: 'Action', value: 'Leave-Network' }],
         });
     }
-    async updateGatewaySettings({ allowDelegatedStaking, delegateRewardShareRatio, fqdn, label, minDelegatedStake, note, port, properties, protocol, autoStake, observerAddress, }, options) {
+    async updateGatewaySettings({ allowDelegatedStaking, allowedDelegates, delegateRewardShareRatio, fqdn, label, minDelegatedStake, note, port, properties, protocol, autoStake, observerAddress, }, options) {
         const { tags = [] } = options || {};
         const allTags = [
             ...tags,
@@ -471,6 +548,10 @@ export class IOWriteable extends IOReadable {
                 name: 'Allow-Delegated-Staking',
                 value: allowDelegatedStaking?.toString(),
             },
+            {
+                name: 'Allowed-Delegates',
+                value: allowedDelegates?.join(','),
+            },
             {
                 name: 'Delegate-Reward-Share-Ratio',
                 value: delegateRewardShareRatio?.toString(),
@@ -481,10 +562,9 @@ export class IOWriteable extends IOReadable {
             },
             { name: 'Auto-Stake', value: autoStake?.toString() },
         ];
-        const prunedTags = allTags.filter((tag) => tag.value !== undefined);
         return this.process.send({
             signer: this.signer,
-            tags: prunedTags,
+            tags: pruneTags(allTags),
         });
     }
     async delegateStake(params, options) {
@@ -512,16 +592,25 @@ export class IOWriteable extends IOReadable {
             ],
         });
     }
-    async instantDelegateWithdrawal(params, options) {
+    /**
+     * Initiates an instant withdrawal from a gateway.
+     *
+     * @param {Object} params - The parameters for initiating an instant withdrawal
+     * @param {string} params.address - The gateway address of the withdrawal, if not provided, the signer's address will be used
+     * @param {string} params.vaultId - The vault ID of the withdrawal
+     * @returns {Promise<AoMessageResult>} The result of the withdrawal
+     */
+    async instantWithdrawal(params, options) {
         const { tags = [] } = options || {};
+        const allTags = [
+            ...tags,
+            { name: 'Action', value: 'Instant-Withdrawal' },
+            { name: 'Vault-Id', value: params.vaultId },
+            { name: 'Address', value: params.gatewayAddress },
+        ];
         return this.process.send({
             signer: this.signer,
-            tags: [
-                ...tags,
-                { name: 'Action', value: 'Decrease-Delegate-Stake' },
-                { name: 'Target', value: params.target },
-                { name: 'Vault-Id', value: params.vaultId },
-            ],
+            tags: pruneTags(allTags),
         });
     }
     async increaseOperatorStake(params, options) {
@@ -574,12 +663,39 @@ export class IOWriteable extends IOReadable {
             { name: 'Process-Id', value: params.processId },
             { name: 'Purchase-Type', value: params.type || 'lease' },
         ];
-        const prunedTags = allTags.filter((tag) => tag.value !== undefined);
         return this.process.send({
             signer: this.signer,
-            tags: prunedTags,
+            tags: pruneTags(allTags),
+        });
+    }
+    /**
+     * Upgrades an existing leased record to a permabuy.
+     *
+     * @param {Object} params - The parameters for upgrading a record
+     * @param {string} params.name - The name of the record to upgrade
+     * @param {Object} [options] - The options for the upgrade
+     * @returns {Promise<AoMessageResult>} The result of the upgrade
+     */
+    async upgradeRecord(params, options) {
+        const { tags = [] } = options || {};
+        return this.process.send({
+            signer: this.signer,
+            tags: [
+                ...tags,
+                { name: 'Action', value: 'Upgrade-Name' }, // TODO: align on Update-Record vs. Upgrade-Name (contract currently uses Upgrade-Name)
+                { name: 'Name', value: params.name },
+            ],
         });
     }
+    /**
+     * Extends the lease of an existing leased record.
+     *
+     * @param {Object} params - The parameters for extending a lease
+     * @param {string} params.name - The name of the record to extend
+     * @param {number} params.years - The number of years to extend the lease
+     * @param {Object} [options] - The options for the extension
+     * @returns {Promise<AoMessageResult>} The result of the extension
+     */
     async extendLease(params, options) {
         const { tags = [] } = options || {};
         return this.process.send({
@@ -604,16 +720,42 @@ export class IOWriteable extends IOReadable {
             ],
         });
     }
-    async cancelDelegateWithdrawal(params, options) {
+    /**
+     * Cancel a withdrawal from a gateway.
+     *
+     * @param {Object} params - The parameters for cancelling a withdrawal
+     * @param {string} [params.address] - The address of the withdrawal (optional). If not provided, the signer's address will be used.
+     * @param {string} params.vaultId - The vault ID of the withdrawal.
+     * @param {Object} [options] - The options for the cancellation
+     * @returns {Promise<AoMessageResult>} The result of the cancellation
+     */
+    async cancelWithdrawal(params, options) {
         const { tags = [] } = options || {};
+        const allTags = [
+            ...tags,
+            { name: 'Action', value: 'Cancel-Withdrawal' },
+            { name: 'Vault-Id', value: params.vaultId },
+            { name: 'Address', value: params.gatewayAddress },
+        ];
         return this.process.send({
             signer: this.signer,
-            tags: [
-                ...tags,
-                { name: 'Action', value: 'Cancel-Delegate-Withdrawal' },
-                { name: 'Address', value: params.address },
-                { name: 'Vault-Id', value: params.vaultId },
-            ],
+            tags: pruneTags(allTags),
+        });
+    }
+    async submitAuctionBid(params, options) {
+        const { tags = [] } = options || {};
+        const allTags = [
+            ...tags,
+            { name: 'Action', value: 'Auction-Bid' },
+            { name: 'Name', value: params.name },
+            { name: 'Process-Id', value: params.processId },
+            { name: 'Quantity', value: params.quantity?.toString() ?? undefined },
+            { name: 'Purchase-Type', value: params.type || 'lease' },
+            { name: 'Years', value: params.years?.toString() ?? undefined },
+        ];
+        return this.process.send({
+            signer: this.signer,
+            tags: pruneTags(allTags),
         });
     }
 }

package/lib/esm/types/ant.js

@@ -42,6 +42,8 @@ export const IntegerStringSchema = z
     const num = parseInt(val);
     return Number.isInteger(num) && num >= 0;
 }, { message: 'Must be a non negative integer string' });
+export const AntDescriptionSchema = z.string(); // TODO: add specific limits for description ie max length
+export const AntKeywordsSchema = z.array(z.string()); // TODO: add specific limits for keywords ie max amount and max length
 export const AntRecordSchema = z.object({
     transactionId: ArweaveTxIdSchema.describe('The Target ID of the undername'),
     ttlSeconds: z.number(),
@@ -52,6 +54,8 @@ export const AntBalancesSchema = z.record(ArweaveTxIdSchema.describe('Holder add
 export const AntStateSchema = z.object({
     Name: z.string().describe('The name of the ANT.'),
     Ticker: z.string().describe('The ticker symbol for the ANT.'),
+    Description: z.string().describe('The description for the ANT.'),
+    Keywords: AntKeywordsSchema.describe('The keywords for the ANT.'),
     Denomination: z
         .number()
         .describe('The number of decimal places to use for the ANT. Defaults to 0 if not set representing whole numbers.')
@@ -88,8 +92,12 @@ export const AntHandlerNames = [
     'records',
     'setName',
     'setTicker',
+    'setDescription',
+    'setKeywords',
     'initializeState',
     'state',
+    'releaseName',
+    'reassignName',
 ];
 export const AntHandlersSchema = z
     .array(z.string({ description: 'Handler Name' }))
@@ -104,6 +112,8 @@ export const AntInfoSchema = z.object({
     ['Source-Code-TX-ID']: ArweaveTxIdSchema.describe('Transaction ID of the Source Code for the ANT.'),
     Ticker: z.string().describe('The ticker symbol for the ANT.'),
     ['Total-Supply']: IntegerStringSchema.describe('Total supply of the ANT in circulation.'),
+    Description: AntDescriptionSchema.describe('The description for the ANT.'),
+    Keywords: AntKeywordsSchema.describe('The keywords for the ANT.'),
     Logo: ArweaveTxIdSchema.describe('Transaction ID of the ANT logo.'),
     Denomination: IntegerStringSchema.describe('The number of decimal places to use for the ANT. Defaults to 0 if not set representing whole numbers.'),
     Handlers: AntHandlersSchema.optional().describe('List of handlers for the ANT.'),

package/lib/esm/utils/arweave.js

@@ -20,3 +20,6 @@ export const validateArweaveId = (id) => {
 export function isBlockHeight(height) {
     return height !== undefined && !isNaN(parseInt(height.toString()));
 }
+export const pruneTags = (tags) => {
+    return tags.filter((tag) => tag.value !== undefined);
+};

package/lib/esm/utils/processes.js

@@ -48,14 +48,16 @@ export class ArNSEventEmitter extends EventEmitter {
     timeoutMs; // timeout for each request to 3 seconds
     throttle;
     logger;
+    strict;
     constructor({ contract = IO.init({
         processId: IO_TESTNET_PROCESS_ID,
-    }), timeoutMs = 60_000, concurrency = 30, logger = Logger.default, } = {}) {
+    }), timeoutMs = 60_000, concurrency = 30, logger = Logger.default, strict = true, } = {}) {
         super();
         this.contract = contract;
         this.timeoutMs = timeoutMs;
         this.throttle = pLimit(concurrency);
         this.logger = logger;
+        this.strict = strict;
     }
     async fetchProcessesOwnedByWallet({ address, pageSize, antRegistry = ANTRegistry.init(), }) {
         const uniqueContractProcessIds = {};
@@ -94,7 +96,7 @@ export class ArNSEventEmitter extends EventEmitter {
             }
             const ant = ANT.init({
                 processId,
-                strict: true,
+                strict: this.strict,
             });
             const state = (await timeout(this.timeoutMs, ant.getState()).catch((e) => {
                 this.emit('error', `Error getting state for process ${processId}: ${e}`);

package/lib/esm/version.js

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

package/lib/types/common/ant.d.ts

@@ -177,10 +177,61 @@ export declare class AoANTWriteable extends AoANTReadable implements AoANTWrite
      * @returns {Promise<AoMessageResult>} The result of the interaction.
      * @example
      * ```ts
-     * ant.setName({ name: "ships at sea" });
+     * ant.setName({ name: "test" }); // results in the resolution of `test_<apexName>.ar.io`
      * ```
      */
     setName({ name }: {
         name: string;
     }, options?: WriteOptions): Promise<AoMessageResult>;
+    /**
+     * @param description @type {string} Sets the ANT Description.
+     * @returns {Promise<AoMessageResult>} The result of the interaction.
+     * @example
+     * ```ts
+     * ant.setDescription({ description: "This name is used for the ArDrive" });
+     * ```
+     */
+    setDescription({ description }: {
+        description: string;
+    }, options?: WriteOptions): Promise<AoMessageResult>;
+    /**
+     * @param keywords @type {string[]} Sets the ANT Keywords.
+     * @returns {Promise<AoMessageResult>} The result of the interaction.
+     * @example
+     * ```ts
+     * ant.setKeywords({ keywords: ['keyword1', 'keyword2', 'keyword3']});
+     * ```
+     */
+    setKeywords({ keywords }: {
+        keywords: string[];
+    }, options?: WriteOptions): Promise<AoMessageResult>;
+    /**
+     * @param name @type {string} The name you want to release. The name will be put up for auction on the IO contract. 50% of the winning bid will be distributed to the ANT owner at the time of release. If no bids, the name will be released and can be reregistered by anyone.
+     * @param ioProcessId @type {string} The processId of the IO contract. This is where the ANT will send the message to release the name.
+     * @returns {Promise<AoMessageResult>} The result of the interaction.
+     * @example
+     * ```ts
+     * ant.releaseName({ name: "ardrive", ioProcessId: IO_TESTNET_PROCESS_ID });
+     * ```
+     */
+    releaseName({ name, ioProcessId }: {
+        name: string;
+        ioProcessId: string;
+    }, options?: WriteOptions): Promise<AoMessageResult>;
+    /**
+     * Sends a message to the IO contract to reassign the 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 ioProcessId @type {string} The processId of the IO contract.
+     * @param antProcessId @type {string} The processId of the ANT contract.
+     * @returns {Promise<AoMessageResult>} The result of the interaction.
+     * @example
+     * ```ts
+     * ant.reassignName({ name: "ardrive", ioProcessId: IO_TESTNET_PROCESS_ID, antProcessId: NEW_ANT_PROCESS_ID });
+     * ```
+     */
+    reassignName({ name, ioProcessId, antProcessId, }: {
+        name: string;
+        ioProcessId: string;
+        antProcessId: string;
+    }, options?: WriteOptions): Promise<AoMessageResult>;
 }