@ar.io/sdk 3.4.0-alpha.1 → 3.4.0-alpha.3

package/lib/esm/common/ant.js

@@ -30,6 +30,7 @@ export class ANT {
 }
 export class AoANTReadable {
     process;
+    processId;
     strict;
     constructor(config) {
         this.strict = config.strict || false;
@@ -44,6 +45,7 @@ export class AoANTReadable {
         else {
             throw new InvalidContractConfigurationError();
         }
+        this.processId = this.process.processId;
     }
     async getState({ strict } = { strict: this.strict }) {
         const tags = [{ name: 'Action', value: 'State' }];
@@ -280,16 +282,15 @@ 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.
      * @returns {Promise<AoMessageResult>} The result of the interaction.
-     * @example
-     * ```ts
-     * ant.setController({ controller: "fGht8v4STuwPnTck1zFVkQqJh5K9q9Zik4Y5-5dV7nk" });
-     * ```
      */
-    async setRecord({ undername, transactionId, ttlSeconds, }, options) {
+    async setRecord({ undername, transactionId, ttlSeconds }, options) {
         return this.process.send({
             tags: [
                 ...(options?.tags ?? []),
@@ -302,11 +303,64 @@ 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 }, options) {
+        return this.setRecord({
+            transactionId,
+            ttlSeconds,
+            undername: '@',
+        }, options);
+    }
+    /**
+     * 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 }, options) {
+        return this.setRecord({
+            undername,
+            transactionId,
+            ttlSeconds,
+        }, options);
+    }
+    /**
+     * 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 +374,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 +394,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 +414,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 +434,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 +454,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 +475,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 +499,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 +525,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 +548,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/version.js

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

package/lib/types/cli/commands/antCommands.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Copyright (C) 2022-2024 Permanent Data Solutions, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { AoANTSetBaseNameRecordParams, AoANTSetUndernameRecordParams } from '../../types/ant.js';
+import { CLIWriteOptionsFromAoAntParams } from '../types.js';
+/** @deprecated -- use set-ant-base-name and set-ant-undername */
+export declare function setAntRecordCLICommand(o: CLIWriteOptionsFromAoAntParams<AoANTSetUndernameRecordParams>): Promise<import("../../types/common.js").AoMessageResult>;
+export declare function setAntBaseNameCLICommand(o: CLIWriteOptionsFromAoAntParams<AoANTSetBaseNameRecordParams>): Promise<import("../../types/common.js").AoMessageResult>;
+export declare function setAntUndernameCLICommand(o: CLIWriteOptionsFromAoAntParams<AoANTSetUndernameRecordParams>): Promise<import("../../types/common.js").AoMessageResult>;

package/lib/types/cli/options.d.ts

@@ -333,3 +333,11 @@ export declare const antStateOptions: {
     alias: string;
     description: string;
 }[];
+export declare const setAntBaseNameOptions: {
+    alias: string;
+    description: string;
+}[];
+export declare const setAntUndernameOptions: {
+    alias: string;
+    description: string;
+}[];

package/lib/types/cli/types.d.ts

@@ -49,6 +49,9 @@ export type CLIOptionsFromAoParams<T> = {
 };
 export type CLIReadOptionsFromAoParams<T> = CLIOptionsFromAoParams<T> & GlobalCLIOptions;
 export type CLIWriteOptionsFromAoParams<T> = WriteActionCLIOptions & CLIOptionsFromAoParams<T>;
+export type CLIWriteOptionsFromAoAntParams<T> = CLIWriteOptionsFromAoParams<T & {
+    processId: string;
+}>;
 export type PaginationCLIOptions = GlobalCLIOptions & CLIOptionsFromAoParams<PaginationParams>;
 export type AddressCLIOptions = GlobalCLIOptions & CLIOptionsFromAoParams<AoAddressParams>;
 export type ProcessIdCLIOptions = GlobalCLIOptions & {

package/lib/types/cli/utils.d.ts

@@ -2,6 +2,7 @@ import { JWKInterface } from 'arweave/node/lib/wallet.js';
 import { Command, OptionValues } from 'commander';
 import { ARIOToken, AoANTRead, AoANTWrite, AoARIORead, AoARIOWrite, AoGetCostDetailsParams, AoRedelegateStakeParams, AoSigner, AoUpdateGatewaySettingsParams, ContractSigner, EpochInput, FundFrom, Logger, PaginationParams, SpawnANTState, WriteOptions, mARIOToken } from '../node/index.js';
 import { ANTStateCLIOptions, AddressCLIOptions, EpochCLIOptions, GetTokenCostCLIOptions, GlobalCLIOptions, InitiatorCLIOptions, JsonSerializable, PaginationCLIOptions, ProcessIdCLIOptions, RedelegateStakeCLIOptions, TransferCLIOptions, UpdateGatewaySettingsCLIOptions, WalletCLIOptions, WriteActionCLIOptions } from './types.js';
+export declare const defaultTtlSecondsCLI = 3600;
 export declare function stringifyJsonForCLIDisplay(json: JsonSerializable | unknown): string;
 export declare function runCommand<O extends OptionValues>(command: Command, action: (options: O) => Promise<JsonSerializable>): Promise<void>;
 export interface CommanderOption {

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

@@ -1,4 +1,4 @@
-import { AntReadOptions, AoANTHandler, AoANTInfo, AoANTRead, AoANTRecord, AoANTState, AoANTWrite } from '../types/ant.js';
+import { AntReadOptions, AoANTHandler, AoANTInfo, AoANTRead, AoANTRecord, AoANTSetBaseNameRecordParams, AoANTSetUndernameRecordParams, AoANTState, AoANTWrite } from '../types/ant.js';
 import { AoMessageResult, ProcessConfiguration, WalletAddress, WithSigner, WriteOptions } from '../types/index.js';
 import { AOProcess } from './index.js';
 type ANTConfigOptionalStrict = Required<ProcessConfiguration> & {
@@ -12,6 +12,7 @@ export declare class ANT {
 }
 export declare class AoANTReadable implements AoANTRead {
     protected process: AOProcess;
+    readonly processId: string;
     private strict;
     constructor(config: ANTConfigOptionalStrict);
     getState({ strict }?: AntReadOptions): Promise<AoANTState>;
@@ -147,32 +148,70 @@ export declare class AoANTWriteable extends AoANTReadable implements AoANTWrite
         controller: string;
     }, options?: WriteOptions): Promise<AoMessageResult>;
     /**
+     * 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.
      * @returns {Promise<AoMessageResult>} The result of the interaction.
+     */
+    setRecord({ undername, transactionId, ttlSeconds }: AoANTSetUndernameRecordParams, options?: WriteOptions): Promise<AoMessageResult>;
+    /**
+     * 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.setController({ controller: "fGht8v4STuwPnTck1zFVkQqJh5K9q9Zik4Y5-5dV7nk" });
+     * 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
      * ```
      */
-    setRecord({ undername, transactionId, ttlSeconds, }: {
+    setBaseNameRecord({ transactionId, ttlSeconds }: AoANTSetBaseNameRecordParams, options?: WriteOptions): Promise<AoMessageResult>;
+    /**
+     * 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
+     * ```
+     */
+    setUndernameRecord({ undername, transactionId, ttlSeconds }: AoANTSetUndernameRecordParams, options?: WriteOptions): Promise<AoMessageResult>;
+    /**
+     * 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
+     * ```
+     */
+    removeUndernameRecord({ undername, }: {
         undername: string;
-        transactionId: string;
-        ttlSeconds: number;
-    }, options?: WriteOptions): Promise<AoMessageResult>;
+    }): Promise<AoMessageResult>;
     /**
+     * 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
      * ```
      */
     removeRecord({ undername, }: {
         undername: string;
     }, options?: WriteOptions): Promise<AoMessageResult>;
     /**
+     * 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
@@ -184,6 +223,8 @@ export declare class AoANTWriteable extends AoANTReadable implements AoANTWrite
         ticker: string;
     }, options?: WriteOptions): Promise<AoMessageResult>;
     /**
+     * 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
@@ -195,6 +236,8 @@ export declare class AoANTWriteable extends AoANTReadable implements AoANTWrite
         name: string;
     }, options?: WriteOptions): Promise<AoMessageResult>;
     /**
+     * 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
@@ -206,6 +249,8 @@ export declare class AoANTWriteable extends AoANTReadable implements AoANTWrite
         description: string;
     }, options?: WriteOptions): Promise<AoMessageResult>;
     /**
+     * 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
@@ -217,6 +262,8 @@ export declare class AoANTWriteable extends AoANTReadable implements AoANTWrite
         keywords: string[];
     }, options?: WriteOptions): Promise<AoMessageResult>;
     /**
+     * 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.
@@ -229,6 +276,9 @@ export declare class AoANTWriteable extends AoANTReadable implements AoANTWrite
         txId: string;
     }, options?: WriteOptions): Promise<AoMessageResult>;
     /**
+     * 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.
@@ -242,7 +292,8 @@ export declare class AoANTWriteable extends AoANTReadable implements AoANTWrite
         arioProcessId: string;
     }, options?: WriteOptions): Promise<AoMessageResult>;
     /**
-     * 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.
@@ -259,12 +310,33 @@ export declare class AoANTWriteable extends AoANTReadable implements AoANTWrite
     }, options?: WriteOptions): Promise<AoMessageResult>;
     /**
      * 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
+     * ```
      */
     approvePrimaryNameRequest({ name, address, arioProcessId, }: {
         name: string;
         address: WalletAddress;
         arioProcessId: string;
     }, options?: WriteOptions): Promise<AoMessageResult>;
+    /**
+     * 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"
+     * ```
+     */
     removePrimaryNames({ names, arioProcessId, notifyOwners, }: {
         names: string[];
         arioProcessId: string;

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

@@ -161,6 +161,7 @@ export type AntReadOptions = {
     strict?: boolean;
 };
 export interface AoANTRead {
+    processId: string;
     getState(opts?: AntReadOptions): Promise<AoANTState>;
     getInfo(opts?: AntReadOptions): Promise<AoANTInfo>;
     getRecord({ undername }: {
@@ -179,55 +180,67 @@ export interface AoANTRead {
     getHandlers(): Promise<AoANTHandler[]>;
 }
 export interface AoANTWrite extends AoANTRead {
-    transfer({ target }: {
+    transfer: WriteAction<{
         target: WalletAddress;
-    }, options?: WriteOptions): Promise<AoMessageResult>;
-    addController({ controller, }: {
+    }>;
+    addController: WriteAction<{
         controller: WalletAddress;
-    }, options?: WriteOptions): Promise<AoMessageResult>;
-    removeController({ controller, }: {
+    }>;
+    removeController: WriteAction<{
         controller: WalletAddress;
-    }, options?: WriteOptions): Promise<AoMessageResult>;
-    setRecord({ undername, transactionId, ttlSeconds, }: {
+    }>;
+    /** @deprecated Use setUndernameRecord instead for undernames, and setBaseNameRecord instead for the top level name (e.g. "@") */
+    setRecord: WriteAction<AoANTSetUndernameRecordParams>;
+    removeRecord: WriteAction<{
         undername: string;
-        transactionId: string;
-        ttlSeconds: number;
-    }, options?: WriteOptions): Promise<AoMessageResult>;
-    removeRecord({ undername }: {
+    }>;
+    setBaseNameRecord: WriteAction<AoANTSetBaseNameRecordParams>;
+    setUndernameRecord: WriteAction<AoANTSetUndernameRecordParams>;
+    removeUndernameRecord: WriteAction<{
         undername: string;
-    }, options?: WriteOptions): Promise<AoMessageResult>;
-    setTicker({ ticker }: {
+    }>;
+    setTicker: WriteAction<{
         ticker: string;
-    }, options?: WriteOptions): Promise<AoMessageResult>;
-    setDescription({ description }: {
+    }>;
+    setDescription: WriteAction<{
         description: string;
-    }, options?: WriteOptions): Promise<AoMessageResult>;
-    setKeywords({ keywords }: {
+    }>;
+    setKeywords: WriteAction<{
         keywords: string[];
-    }, options?: WriteOptions): Promise<AoMessageResult>;
-    setName({ name }: {
+    }>;
+    setName: WriteAction<{
         name: string;
-    }, options?: WriteOptions): Promise<AoMessageResult>;
-    setLogo({ txId }: {
+    }>;
+    setLogo: WriteAction<{
         txId: string;
-    }, options?: WriteOptions): Promise<AoMessageResult>;
-    releaseName({ name, arioProcessId }: {
+    }>;
+    releaseName: WriteAction<{
         name: string;
         arioProcessId: string;
-    }, options?: WriteOptions): Promise<AoMessageResult>;
-    reassignName({ name, arioProcessId, antProcessId, }: {
+    }>;
+    reassignName: WriteAction<{
         name: string;
         arioProcessId: string;
         antProcessId: string;
-    }, options?: WriteOptions): Promise<AoMessageResult>;
-    approvePrimaryNameRequest({ name, address, arioProcessId, }: {
+    }>;
+    approvePrimaryNameRequest: WriteAction<{
         name: string;
-        address: WalletAddress;
+        address: string;
         arioProcessId: string;
-    }, options?: WriteOptions): Promise<AoMessageResult>;
-    removePrimaryNames({ names, arioProcessId, notifyOwners, }: {
+    }>;
+    removePrimaryNames: WriteAction<{
         names: string[];
         arioProcessId: string;
         notifyOwners?: boolean;
-    }, options?: WriteOptions): Promise<AoMessageResult>;
+    }>;
 }
+/** utility type to ensure WriteOptions are appended to each parameter set */
+type WriteAction<P, R = AoMessageResult> = (params: P, options?: WriteOptions) => Promise<R>;
+export type AoANTSetBaseNameRecordParams = {
+    transactionId: string;
+    ttlSeconds: number;
+};
+export type AoANTSetUndernameRecordParams = AoANTSetBaseNameRecordParams & {
+    undername: string;
+};
+export {};

package/lib/types/version.d.ts

@@ -13,4 +13,4 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-export declare const version = "3.3.1-alpha.4";
+export declare const version = "3.4.0-alpha.2";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ar.io/sdk",
-  "version": "3.4.0-alpha.1",
+  "version": "3.4.0-alpha.3",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/ar-io/ar-io-sdk.git"