@aptos-labs/ts-sdk 1.29.1 → 1.31.0

package/dist/esm/api/account.mjs

@@ -1,2 +1,2 @@
-import{a}from"../chunk-DF4WKSTK.mjs";import"../chunk-EWZ2M5BW.mjs";import"../chunk-G7MWTE2J.mjs";import"../chunk-I5OYNCZS.mjs";import"../chunk-JXCZTOYC.mjs";import"../chunk-MEWFJJJN.mjs";import"../chunk-NNRAQP36.mjs";import"../chunk-3YKAGVHZ.mjs";import"../chunk-PKXEB7XP.mjs";import"../chunk-BSCOVLWS.mjs";import"../chunk-V3MBJJTL.mjs";import"../chunk-BKEJMQQ6.mjs";import"../chunk-STGYDB5E.mjs";import"../chunk-MO4IZXLK.mjs";import"../chunk-GFGX3QDP.mjs";import"../chunk-VHNX2NUR.mjs";import"../chunk-GAEAYY44.mjs";import"../chunk-46D5QX3G.mjs";import"../chunk-FRGXKOU5.mjs";import"../chunk-B6M7QBUO.mjs";import"../chunk-KYSDF3CA.mjs";import"../chunk-6RZZIOGH.mjs";import"../chunk-YHAPZP5A.mjs";import"../chunk-K2O24YLZ.mjs";import"../chunk-KXBIA4KR.mjs";import"../chunk-4NMDYPUD.mjs";import"../chunk-XONG5JZ4.mjs";import"../chunk-RNTXQYJQ.mjs";import"../chunk-CVDR5SJR.mjs";import"../chunk-TL7DR54X.mjs";import"../chunk-5655UVIK.mjs";import"../chunk-UYVPNUH3.mjs";import"../chunk-2TQIU7CG.mjs";import"../chunk-QDIKOQRK.mjs";import"../chunk-QIW56MUH.mjs";import"../chunk-LXLISEQ4.mjs";import"../chunk-E37YRKWK.mjs";import"../chunk-N5JNKD5F.mjs";import"../chunk-TMW2HIXC.mjs";import"../chunk-E7FWVXGX.mjs";import"../chunk-NECL5FCQ.mjs";import"../chunk-4QMXOWHP.mjs";import"../chunk-WP7WF54Q.mjs";import"../chunk-B2CXRZL5.mjs";import"../chunk-HEZ2ZYZA.mjs";import"../chunk-KUX6GQ2E.mjs";import"../chunk-BD6BJETG.mjs";import"../chunk-GGR3P2TG.mjs";import"../chunk-U67PFBTL.mjs";import"../chunk-LGD5KU56.mjs";import"../chunk-PNXUYOYI.mjs";import"../chunk-LG3DAAPD.mjs";import"../chunk-SRPI2FFA.mjs";import"../chunk-M2QV232A.mjs";import"../chunk-3MCYLML2.mjs";import"../chunk-DAJOX4PL.mjs";import"../chunk-IMGLHDIA.mjs";import"../chunk-BF4ZE37Q.mjs";import"../chunk-Q4XR6QOZ.mjs";import"../chunk-LR65XHSF.mjs";import"../chunk-KA6FZNWP.mjs";import"../chunk-QPP6BX53.mjs";import"../chunk-AH44UPM4.mjs";import"../chunk-N2FKVZ4D.mjs";import"../chunk-EV2USF7B.mjs";import"../chunk-7V6DEA7G.mjs";import"../chunk-PUZ25PTD.mjs";import"../chunk-HGLO5LDS.mjs";import"../chunk-BSUYPXRD.mjs";import"../chunk-FZY4PMEE.mjs";import"../chunk-CCMHWJ3Q.mjs";import"../chunk-6QGVRNV6.mjs";import"../chunk-YJCZU6PR.mjs";import"../chunk-MS4MRLGA.mjs";import"../chunk-KEYAPEAX.mjs";import"../chunk-TDGQGILY.mjs";import"../chunk-44GYWUSH.mjs";import"../chunk-4WPQQPUF.mjs";import"../chunk-HPZ2S4FE.mjs";import"../chunk-56CNRT2K.mjs";import"../chunk-BCUSI3N6.mjs";import"../chunk-LG7RJQ57.mjs";import"../chunk-UAL27G6B.mjs";import"../chunk-SCHZ67F3.mjs";import"../chunk-EXP5STXZ.mjs";import"../chunk-555I4YHP.mjs";import"../chunk-FVA2OPG4.mjs";export{a as Account};
+import{a}from"../chunk-HM5HITUC.mjs";import"../chunk-YZ5BCOGI.mjs";import"../chunk-I5OYNCZS.mjs";import"../chunk-JXCZTOYC.mjs";import"../chunk-22ZSW5EN.mjs";import"../chunk-DMSHPWA5.mjs";import"../chunk-IFXUWUP2.mjs";import"../chunk-KRVLR3L4.mjs";import"../chunk-BSCOVLWS.mjs";import"../chunk-V3MBJJTL.mjs";import"../chunk-Y267I7DC.mjs";import"../chunk-EE7GDBA5.mjs";import"../chunk-BG2TZI3H.mjs";import"../chunk-T5BCTWGK.mjs";import"../chunk-BVVHGSWC.mjs";import"../chunk-VHNX2NUR.mjs";import"../chunk-GAEAYY44.mjs";import"../chunk-5SGSPCOY.mjs";import"../chunk-3H5DGQKX.mjs";import"../chunk-WZCKSN2U.mjs";import"../chunk-VYMRIKUV.mjs";import"../chunk-GLATLXF6.mjs";import"../chunk-M22UGFQ5.mjs";import"../chunk-CDQGPCHU.mjs";import"../chunk-WSZCPSV4.mjs";import"../chunk-4NMDYPUD.mjs";import"../chunk-F2RY4YQ7.mjs";import"../chunk-XQ7ONNII.mjs";import"../chunk-UYVPNUH3.mjs";import"../chunk-RBJNSUSU.mjs";import"../chunk-4LKLOUMG.mjs";import"../chunk-ZPIMARUG.mjs";import"../chunk-OTY3NO7Q.mjs";import"../chunk-ZINOJTLU.mjs";import"../chunk-NODYW7DM.mjs";import"../chunk-AGBA3Y7A.mjs";import"../chunk-A2AEFKXS.mjs";import"../chunk-SGQFWWLQ.mjs";import"../chunk-MK2QAHXC.mjs";import"../chunk-E7FWVXGX.mjs";import"../chunk-NECL5FCQ.mjs";import"../chunk-4QMXOWHP.mjs";import"../chunk-PCLU4KLY.mjs";import"../chunk-WV2VJQDS.mjs";import"../chunk-HEZ2ZYZA.mjs";import"../chunk-CC7VOPYH.mjs";import"../chunk-6DMDYBV6.mjs";import"../chunk-TPJLAYW6.mjs";import"../chunk-4VU2ABLU.mjs";import"../chunk-KUX6GQ2E.mjs";import"../chunk-BOWPP6YG.mjs";import"../chunk-FTZGP6XW.mjs";import"../chunk-GMKKHGXK.mjs";import"../chunk-ONBFUPEC.mjs";import"../chunk-OAEDFM7T.mjs";import"../chunk-P3J54CQG.mjs";import"../chunk-IBLZ6MZU.mjs";import"../chunk-KIW54KWR.mjs";import"../chunk-4OV7QU2U.mjs";import"../chunk-PHP47DI4.mjs";import"../chunk-HBIDHQ2M.mjs";import"../chunk-N2FKVZ4D.mjs";import"../chunk-RNJHULIT.mjs";import"../chunk-2652SPOM.mjs";import"../chunk-2GEIHUHT.mjs";import"../chunk-HGLO5LDS.mjs";import"../chunk-4CDDWSKZ.mjs";import"../chunk-GQABU3RQ.mjs";import"../chunk-D3OEQLUE.mjs";import"../chunk-J245N3XF.mjs";import"../chunk-PRZ7AIGA.mjs";import"../chunk-KM6UXNC7.mjs";import"../chunk-FZY4PMEE.mjs";import"../chunk-IECDO22V.mjs";import"../chunk-6FLHGOKP.mjs";import"../chunk-OZN3OOJV.mjs";import"../chunk-JGNMNCQB.mjs";import"../chunk-7XS45O6M.mjs";import"../chunk-4WPQQPUF.mjs";import"../chunk-N47FTRYO.mjs";import"../chunk-QQIVWB6G.mjs";import"../chunk-KFNDDPOW.mjs";import"../chunk-6Q2O5G3J.mjs";import"../chunk-56CNRT2K.mjs";import"../chunk-LEKBJ2EG.mjs";import"../chunk-2CGJLPHP.mjs";import"../chunk-KDMSOCZY.mjs";export{a as Account};
 //# sourceMappingURL=account.mjs.map

package/dist/esm/api/ans.d.mts

@@ -1,7 +1,7 @@
 import { GetANSNameResponse } from '../types/indexer.mjs';
 import { AccountAddress, AccountAddressInput } from '../core/accountAddress.mjs';
 import { AptosConfig } from './aptosConfig.mjs';
-import { A as Account } from '../Ed25519Account-B1VMJOY2.mjs';
+import { A as Account } from '../Ed25519Account-DpH9qAcg.mjs';
 import { InputGenerateTransactionOptions } from '../transactions/types.mjs';
 import { RegisterNameParameters, GetAccountNamesArgs, GetAccountDomainsArgs, GetAccountSubdomainsArgs, GetDomainSubdomainsArgs } from '../internal/ans.mjs';
 import { SimpleTransaction } from '../transactions/instances/simpleTransaction.mjs';
@@ -17,7 +17,7 @@ import '../transactions/instances/transactionArgument.mjs';
 import '../utils/const.mjs';
 import '../transactions/authenticator/account.mjs';
 import '../core/crypto/ed25519.mjs';
-import '../publicKey-B3XRNhHO.mjs';
+import '../publicKey-_tPa99ea.mjs';
 import '../core/crypto/signature.mjs';
 import '../core/crypto/privateKey.mjs';
 import '../core/crypto/multiEd25519.mjs';
@@ -35,22 +35,58 @@ import '../transactions/typeTag/index.mjs';
 import '../transactions/instances/multiAgentTransaction.mjs';
 
 /**
- * A class to handle all `ANS` operations
+ * A class to handle all `ANS` operations.
  */
 declare class ANS {
     readonly config: AptosConfig;
-    constructor(config: AptosConfig);
     /**
-     * Retrieve the owner address of a domain name or subdomain name from the contract.
+     * Initializes a new instance of the Aptos class with the provided configuration.
+     * This allows you to interact with the Aptos blockchain using the specified network settings.
+     *
+     * @param config - The configuration settings for the Aptos client.
+     * @param config.network - The network to connect to (e.g., mainnet, testnet).
+     * @param config.nodeUrl - The URL of the Aptos node to connect to.
+     * @param config.faucetUrl - The URL of the faucet to use for funding accounts.
      *
      * @example
-     * // Will return the owner address of "test.aptos.apt" or undefined
-     * const owner = await aptos.getOwnerAddress({name: "test.aptos"})
-     * // owner = 0x123...
+     * ```typescript
+     * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
+     *
+     * async function runExample() {
+     *     // Create a configuration for connecting to the Aptos testnet
+     *     const config = new AptosConfig({ network: Network.TESTNET });
+     *
+     *     // Initialize the Aptos client with the configuration
+     *     const aptos = new Aptos(config);
+     *
+     *     console.log("Aptos client initialized:", aptos);
+     * }
+     * runExample().catch(console.error);
+     * ```
+     */
+    constructor(config: AptosConfig);
+    /**
+     * Retrieve the owner address of a specified domain name or subdomain name from the contract.
+     *
+     * @param args - The arguments for retrieving the owner address.
+     * @param args.name - A string representing the name of the domain or subdomain to retrieve the owner address for.
      *
-     * @param args.name - A string of the name to retrieve
+     * @returns AccountAddress if the name is owned, undefined otherwise.
      *
-     * @returns AccountAddress if the name is owned, undefined otherwise
+     * @example
+     * ```typescript
+     * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
+     *
+     * const config = new AptosConfig({ network: Network.TESTNET });
+     * const aptos = new Aptos(config);
+     *
+     * async function runExample() {
+     *   // Retrieve the owner address of "test.aptos"
+     *   const owner = await aptos.getOwnerAddress({ name: "test.aptos" });
+     *   console.log(owner); // Logs the owner address or undefined if not owned
+     * }
+     * runExample().catch(console.error);
+     * ```
      */
     getOwnerAddress(args: {
         name: string;
@@ -58,48 +94,95 @@ declare class ANS {
     /**
      * Retrieve the expiration time of a domain name or subdomain name from the contract.
      *
+     * @param args - The arguments for retrieving the expiration.
+     * @param args.name - A string of the name to retrieve.
+     *
+     * @returns number as a unix timestamp in milliseconds.
+     *
      * @example
-     * // Will return the expiration of "test.aptos.apt" or undefined
-     * const exp = await aptos.getExpiration({name: "test.aptos"})
-     * // new Date(exp) would give you the date in question: 2021-01-01T00:00:00.000Z
+     * ```typescript
+     * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
      *
-     * @param args.name - A string of the name to retrieve
+     * const config = new AptosConfig({ network: Network.TESTNET });
+     * const aptos = new Aptos(config);
      *
-     * @returns number as a unix timestamp in milliseconds.
+     * async function runExample() {
+     *   // Get the expiration time for the domain "test.aptos"
+     *   const exp = await aptos.getExpiration({ name: "test.aptos" });
+     *
+     *   // Log the expiration date
+     *   console.log(new Date(exp)); // Outputs the expiration date
+     * }
+     * runExample().catch(console.error);
+     * ```
      */
     getExpiration(args: {
         name: string;
     }): Promise<number | undefined>;
     /**
-     * Retrieve the target address of a domain or subdomain name. This is the
-     * address the name points to for use on chain. Note, the target address can
-     * point to addresses that are not the owner of the name
+     * Retrieve the target address of a domain or subdomain name, which indicates the address the name points to for use on-chain.
+     * Note that the target address can point to addresses that do not own the name.
+     *
+     * @param args - The arguments for retrieving the target address.
+     * @param args.name - A string representing the name, which can be a primary name, a subdomain, or a combination (e.g.,
+     * "primary", "primary.apt", "secondary.primary", "secondary.primary.apt").
+     *
+     * @returns AccountAddress if the name has a target, undefined otherwise.
      *
      * @example
-     * const targetAddr = await aptos.getTargetAddress({name: "test.aptos"})
-     * // targetAddr = 0x123...
+     * ```typescript
+     * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
+     *
+     * const config = new AptosConfig({ network: Network.TESTNET });
+     * const aptos = new Aptos(config);
      *
-     * @param args.name - A string of the name: primary, primary.apt, secondary.primary, secondary.primary.apt, etc.
+     * async function runExample() {
+     *   // Retrieve the target address for the specified domain name
+     *   const targetAddr = await aptos.getTargetAddress({ name: "test.aptos" });
      *
-     * @returns AccountAddress if the name has a target, undefined otherwise
+     *   console.log(targetAddr); // Logs the target address, e.g., 0x123...
+     * }
+     * runExample().catch(console.error);
+     * ```
      */
     getTargetAddress(args: {
         name: string;
     }): Promise<AccountAddress | undefined>;
     /**
-     * Sets the target address of a domain or subdomain name. This is the
-     * address the name points to for use on chain. Note, the target address can
-     * point to addresses that are not the owner of the name
+     * Sets the target address of a domain or subdomain name, pointing it to a specified address for use on-chain.
+     * The target address can be different from the owner of the name.
      *
-     * @example
-     * await aptos.setTargetAddress({sender: alice, name: "test.aptos", address: bob.accountAddress})
-     * const address = await aptos.getTargetAddress({name: "test.aptos"})
-     * // address = bob.accountAddress
-     *
-     * @param args.name - A string of the name: test.aptos.apt, test.apt, test, test.aptos, etc.
-     * @param args.address - A AccountAddressInput of the address to set the domain or subdomain to
+     * @param args - The arguments for setting the target address.
+     * @param args.sender - The account initiating the transaction.
+     * @param args.name - A string representing the domain or subdomain name (e.g., "test.aptos").
+     * @param args.address - The AccountAddressInput of the address to set the domain or subdomain to.
+     * @param args.options - Optional settings for generating the transaction.
      *
      * @returns SimpleTransaction
+     *
+     * @example
+     * ```typescript
+     * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
+     *
+     * const config = new AptosConfig({ network: Network.TESTNET });
+     * const aptos = new Aptos(config);
+     *
+     * async function runExample() {
+     *   // Setting the target address for a domain name
+     *   const sender = Account.generate(); // replace with a real account
+     *   const address = "0x1"; // replace with a real account address
+     *
+     *   await aptos.setTargetAddress({
+     *     sender: sender,
+     *     name: "test.aptos",
+     *     address: address,
+     *   });
+     *
+     *   const targetAddress = await aptos.getTargetAddress({ name: "test.aptos" });
+     *   console.log(targetAddress); // Should log the address set for "test.aptos"
+     * }
+     * runExample().catch(console.error);
+     * ```
      */
     setTargetAddress(args: {
         sender: Account;
@@ -108,35 +191,59 @@ declare class ANS {
         options?: InputGenerateTransactionOptions;
     }): Promise<SimpleTransaction>;
     /**
-     * Retrieve the primary name for an account. An account can have
-     * multiple names that target it, but only a single name that is primary. An
-     * account also may not have a primary name.
+     * Retrieve the primary name for an account. An account can have multiple names, but only one primary name, which may not exist.
      *
-     * @example
-     * const name = await aptos.getPrimaryName({address: alice.accountAddress})
-     * // name = test.aptos
+     * @param args - The arguments for retrieving the primary name.
+     * @param args.address - An AccountAddressInput (address) of the account.
      *
-     * @param args.address - A AccountAddressInput (address) of the account
+     * @returns A string if the account has a primary name, undefined otherwise.
      *
-     * @returns a string if the account has a primary name, undefined otherwise
+     * @example
+     * ```typescript
+     * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
+     *
+     * const config = new AptosConfig({ network: Network.TESTNET });
+     * const aptos = new Aptos(config);
+     *
+     * async function runExample() {
+     *   // Retrieve the primary name for the specified account address
+     *   const name = await aptos.getPrimaryName({ address: "0x1" }); // replace with a real account address
+     *   console.log(name);
+     * }
+     * runExample().catch(console.error);
+     * ```
      */
     getPrimaryName(args: {
         address: AccountAddressInput;
     }): Promise<string | undefined>;
     /**
-     * Sets the primary name for the sender. An account can have
-     * multiple names that target it, but only a single name that is primary. An
-     * account also may not have a primary name.
+     * Sets the primary name for the sender account, allowing them to designate a single primary name among potentially multiple
+     * names. An account may not have a primary name.
      *
-     * @example
-     * await aptos.setPrimaryName({sender: alice, name: "test.aptos"})
-     * const primaryName = await aptos.getPrimaryName({address: alice.accountAddress})
-     * // primaryName = test.aptos
-     *
-     * @param args.sender - The sender account
-     * @param args.name - A string of the name: test, test.apt, test.aptos, test.aptos.apt, etc.
+     * @param args - The arguments for setting the primary name.
+     * @param args.sender - The sender account.
+     * @param args.name - A string representing the name to set as primary (e.g., "test.aptos").
+     * @param args.options - Optional transaction options.
      *
      * @returns SimpleTransaction
+     *
+     * @example
+     * ```typescript
+     * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
+     *
+     * const config = new AptosConfig({ network: Network.TESTNET });
+     * const aptos = new Aptos(config);
+     *
+     * async function runExample() {
+     *   // Set the primary name for the sender account
+     *   const sender = Account.generate(); // replace with a real account
+     *   await aptos.setPrimaryName({ sender, name: "test.aptos" });
+     *
+     *   const primaryName = await aptos.getPrimaryName({ address: sender.accountAddress });
+     *   console.log("Primary Name:", primaryName); // Should log: "Primary Name: test.aptos"
+     * }
+     * runExample().catch(console.error);
+     * ```
      */
     setPrimaryName(args: {
         sender: Account;
@@ -144,55 +251,82 @@ declare class ANS {
         options?: InputGenerateTransactionOptions;
     }): Promise<SimpleTransaction>;
     /**
-     * Registers a new name
+     * Registers a new name.
      *
-     * @example
-     * // An example of registering a subdomain name assuming def.apt is already registered
-     * // and belongs to the sender alice.
-     *  const txn = aptos.registerName({
-     *    sender: alice,
-     *    name: "test.aptos.apt",
-     *    expiration: {
-     *      policy: "subdomain:independent",
-     *      expirationDate: Date.now() + 30 * 24 * 60 * 60 * 1000,
-     *    },
-     *  });
-     *
-     * @param args.sender - The sender account
-     * @param args.name - A string of the name to register. This can be inclusive or exclusive of the .apt suffix.
-     * Examples include: "test", "test.apt", "test.aptos.apt", etc.
+     * This function allows you to register a domain or subdomain name with specific expiration policies and options.
+     *
+     * @param args.sender - The sender account.
+     * @param args.name - A string of the name to register. This can be inclusive or exclusive of the .apt suffix. Examples include:
+     * "test", "test.apt", "test.aptos.apt", etc.
      * @param args.expiration  - An object with the expiration policy of the name.
-     * @param args.expiration.policy - 'domain' | 'subdomain:follow-domain' | 'subdomain:independent'
+     * @param args.expiration.policy - 'domain' | 'subdomain:follow-domain' | 'subdomain:independent'.
      * - domain: Years is required and the name will expire after the given number of years.
      * - subdomain:follow-domain: The name will expire at the same time as the domain name.
      * - subdomain:independent: The name will expire at the given date.
-     * @param args.expiration.expirationDate - An epoch number in milliseconds of
-     * the date when the subdomain will expire. Only applicable when the policy is
-     * set to 'subdomain:independent'.
+     * @param args.expiration.expirationDate - An epoch number in milliseconds of the date when the subdomain will expire. Only
+     * applicable when the policy is set to 'subdomain:independent'.
      * @param args.transferable  - Determines if the subdomain being minted is soul-bound. Applicable only to subdomains.
-     * @param args.targetAddress optional - The address the domain name will resolve to. If not provided,
-     * the sender's address will be used.
-     * @param args.toAddress optional - The address to send the domain name to. If not provided,
-     * the transaction will be sent to the router.
+     * @param args.targetAddress optional - The address the domain name will resolve to. If not provided, the sender's address will
+     * be used.
+     * @param args.toAddress optional - The address to send the domain name to. If not provided, the transaction will be sent to the
+     * router.
      *
      * @returns SimpleTransaction
+     *
+     * @example
+     * ```typescript
+     * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
+     *
+     * const config = new AptosConfig({ network: Network.TESTNET });
+     * const aptos = new Aptos(config);
+     *
+     * async function runExample() {
+     *   // Registering a subdomain name assuming def.apt is already registered and belongs to the sender alice.
+     *   const txn = await aptos.registerName({
+     *     sender: "0x1", // replace with a real sender account
+     *     name: "test.aptos.apt",
+     *     expiration: {
+     *       policy: "subdomain:independent",
+     *       expirationDate: Date.now() + 30 * 24 * 60 * 60 * 1000, // expires in 30 days
+     *     },
+     *   });
+     *
+     *   console.log("Transaction:", txn);
+     * }
+     * runExample().catch(console.error);
+     * ```
      */
     registerName(args: Omit<RegisterNameParameters, "aptosConfig">): Promise<SimpleTransaction>;
     /**
-     * Renews a domain name
-     *
-     * Note: If a domain name was minted with V1 of the contract, it will automatically be upgraded to V2 via this transaction.
+     * Renews a domain name for one year.
+     * If a domain name was minted with V1 of the contract, it will automatically be upgraded to V2 via this transaction.
      *
-     * @example
-     * await aptos.renewDomain({sender: alice, name: "test"})
-     * // test.apt will be renewed for one year
-     *
-     * @param args.sender - The sender account
-     * @param args.name - A string of the domain the subdomain will be under. The signer must be the domain owner.
-     * Subdomains cannot be renewed.
-     * @param args.years - The number of years to renew the name. Currently only one year is permitted.
+     * @param args - The arguments for renewing the domain.
+     * @param args.sender - The sender account, which must be the domain owner.
+     * @param args.name - A string representing the domain to renew. Subdomains cannot be renewed.
+     * @param args.years - The number of years to renew the name. Currently, only one year is permitted.
+     * @param args.options - Optional transaction options.
      *
      * @returns SimpleTransaction
+     *
+     * @example
+     * ```typescript
+     * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
+     *
+     * const config = new AptosConfig({ network: Network.TESTNET });
+     * const aptos = new Aptos(config);
+     *
+     * async function runExample() {
+     *   // Renew the domain "test" for one year
+     *   const transaction = await aptos.renewDomain({
+     *     sender: Account.generate(), // replace with a real account
+     *     name: "test"
+     *   });
+     *
+     *   console.log(transaction);
+     * }
+     * runExample().catch(console.error);
+     * ```
      */
     renewDomain(args: {
         sender: Account;
@@ -201,66 +335,179 @@ declare class ANS {
         options?: InputGenerateTransactionOptions;
     }): Promise<SimpleTransaction>;
     /**
-     * Fetches a single name from the indexer
-     * @param args.name - A string of the name to retrieve, e.g. "test.aptos.apt"
-     * or "test.apt" or "test". Can be inclusive or exclusive of the .apt suffix.
-     * Can be a subdomain.
+     * Fetches a single name from the indexer based on the provided name argument.
+     *
+     * @param args - The arguments for retrieving the name.
+     * @param args.name - A string of the name to retrieve, e.g. "test.aptos.apt" or "test.apt" or "test".
+     *                    Can be inclusive or exclusive of the .apt suffix and can be a subdomain.
+     *
+     * @returns A promise of an ANSName or undefined if the name is not active.
      *
-     * @returns A promise of an ANSName or undefined
+     * @example
+     * ```typescript
+     * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
+     *
+     * const config = new AptosConfig({ network: Network.TESTNET });
+     * const aptos = new Aptos(config);
+     *
+     * async function runExample() {
+     *     // Fetching a name from the indexer
+     *     const name = await aptos.getName({ name: "test.aptos" }); // replace with a real name
+     *     console.log(name);
+     * }
+     * runExample().catch(console.error);
+     * ```
      */
     getName(args: {
         name: string;
     }): Promise<GetANSNameResponse[0] | undefined>;
     /**
-     * Fetches all  names for an account (both top level domains and subdomains)
+     * Fetches all names for an account, including both top-level domains and subdomains.
+     *
+     * @param args - The arguments for fetching account names.
+     * @param args.accountAddress - An AccountAddressInput of the address to retrieve names for.
+     * @param args.options - Optional parameters for fetching names.
+     * @param args.options.offset - Optional, the offset to start from when fetching names.
+     * @param args.options.limit - Optional, a number of the names to fetch per request.
+     * @param args.options.orderBy - The order to sort the names by.
+     * @param args.options.where - Additional filters to apply to the query.
      *
-     * @param args
-     * @param args.accountAddress - A AccountAddressInput of the address to retrieve names for.
-     * @param args.options.offset - Optional, the offset to start from when fetching names
-     * @param args.options.limit - Optional, A number of the names to fetch per request
-     * @param args.options.orderBy - The order to sort the names by
-     * @param args.options.where - Additional filters to apply to the query
+     * @returns A promise of an array of ANSName.
      *
-     * @returns a promise of an array of ANSName
+     * @example
+     * ```typescript
+     * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
+     *
+     * const config = new AptosConfig({ network: Network.TESTNET });
+     * const aptos = new Aptos(config);
+     *
+     * async function runExample() {
+     *   // Fetch account names for a specific address
+     *   const accountNames = await aptos.getAccountNames({
+     *     accountAddress: "0x1", // replace with a real account address
+     *     options: {
+     *       limit: 10, // specify how many names to fetch
+     *       orderBy: "name", // specify the order by which to sort the names
+     *     },
+     *   });
+     *
+     *   console.log(accountNames);
+     * }
+     * runExample().catch(console.error);
+     * ```
      */
     getAccountNames(args: GetAccountNamesArgs): Promise<GetANSNameResponse>;
     /**
-     * Fetches all top level domain names for an account
+     * Fetches all top-level domain names for a specified account.
      *
-     * @param args
-     * @param args.accountAddress - A AccountAddressInput of the address to retrieve domain names for.
-     * @param args.options.offset - Optional, the offset to start from when fetching names
-     * @param args.options.limit - Optional, A number of the names to fetch per request
-     * @param args.options.orderBy - The order to sort the names by
-     * @param args.options.where - Additional filters to apply to the query
+     * @param args - The arguments for retrieving account domains.
+     * @param args.accountAddress - An AccountAddressInput of the address to retrieve domain names for.
+     * @param args.options.offset - Optional, the offset to start from when fetching names.
+     * @param args.options.limit - Optional, a number of the names to fetch per request.
+     * @param args.options.orderBy - The order to sort the names by.
+     * @param args.options.where - Additional filters to apply to the query.
      *
-     * @returns a promise of an array of ANSName
+     * @returns A promise of an array of ANSName.
+     *
+     * @example
+     * ```typescript
+     * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
+     *
+     * const config = new AptosConfig({ network: Network.TESTNET });
+     * const aptos = new Aptos(config);
+     *
+     * async function runExample() {
+     *   // Fetching all top-level domain names for a specific account
+     *   const domains = await aptos.getAccountDomains({
+     *     accountAddress: "0x1", // replace with a real account address
+     *     options: {
+     *       limit: 10, // specify the number of names to fetch
+     *       offset: 0, // specify the offset for pagination
+     *       orderBy: "created_at", // specify the order by which to sort the names
+     *       where: {
+     *         // additional filters can be specified here
+     *       },
+     *     },
+     *   });
+     *
+     *   console.log(domains);
+     * }
+     * runExample().catch(console.error);
+     * ```
      */
     getAccountDomains(args: GetAccountDomainsArgs): Promise<GetANSNameResponse>;
     /**
-     * Fetches all subdomains names for an account
+     * Fetches all subdomain names for a specified account.
+     *
+     * @param args - The arguments for retrieving subdomains.
+     * @param args.accountAddress - The address to retrieve subdomain names for.
+     * @param args.options - Optional parameters for fetching subdomains.
+     * @param args.options.offset - The offset to start from when fetching names.
+     * @param args.options.limit - The number of names to fetch per request.
+     * @param args.options.orderBy - The order to sort the names by.
+     * @param args.options.where - Additional filters to apply to the query.
      *
-     * @param args
-     * @param args.accountAddress - A AccountAddressInput of the address to retrieve subdomains names for.
-     * @param args.options.offset - Optional, the offset to start from when fetching names
-     * @param args.options.limit - Optional, A number of the names to fetch per request
-     * @param args.options.orderBy - The order to sort the names by
-     * @param args.options.where - Additional filters to apply to the query
+     * @returns A promise of an array of ANSName.
      *
-     * @returns a promise of an array of ANSName
+     * @example
+     * ```typescript
+     * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
+     *
+     * const config = new AptosConfig({ network: Network.TESTNET });
+     * const aptos = new Aptos(config);
+     *
+     * async function runExample() {
+     *     // Fetching subdomain names for a specific account
+     *     const subdomains = await aptos.getAccountSubdomains({
+     *         accountAddress: "0x1", // replace with a real account address
+     *         options: {
+     *             limit: 10, // specify the number of subdomains to fetch
+     *             offset: 0, // specify the offset for pagination
+     *             orderBy: "name", // specify the order by which to sort the names
+     *         },
+     *     });
+     *
+     *     console.log(subdomains);
+     * }
+     * runExample().catch(console.error);
+     * ```
      */
     getAccountSubdomains(args: GetAccountSubdomainsArgs): Promise<GetANSNameResponse>;
     /**
-     * Fetches all subdomains names for a given domain. Note, this will not return the domain itself.
+     * Fetches all subdomain names for a given domain, excluding the domain itself.
+     *
+     * @param args - The arguments for fetching subdomains.
+     * @param args.domain - A string of the domain name, e.g., "test.apt" or "test" (without the suffix of .apt).
+     * @param args.options - Optional parameters for fetching subdomains.
+     * @param args.options.offset - Optional, the offset to start from when fetching names.
+     * @param args.options.limit - Optional, the number of names to fetch per request.
+     * @param args.options.orderBy - The order to sort the names by.
+     * @param args.options.where - Additional filters to apply to the query.
      *
-     * @param args
-     * @param args.domain - A string of the domain name: eg. "test.apt" or "test" (without the suffix of .apt)
-     * @param args.options.offset - Optional, the offset to start from when fetching names
-     * @param args.options.limit - Optional, A number of the names to fetch per request
-     * @param args.options.orderBy - The order to sort the names by
-     * @param args.options.where - Additional filters to apply to the query
+     * @returns A promise that resolves to an array of ANSName.
      *
-     * @returns a promise of an array of ANSName
+     * @example
+     * ```typescript
+     * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
+     *
+     * const config = new AptosConfig({ network: Network.TESTNET });
+     * const aptos = new Aptos(config);
+     *
+     * async function runExample() {
+     *   // Fetching subdomains for a specific domain
+     *   const subdomains = await aptos.getDomainSubdomains({
+     *     domain: "test", // replace with your domain
+     *     options: {
+     *       limit: 10, // specify the number of subdomains to fetch
+     *       offset: 0, // specify the starting point for fetching
+     *       orderBy: "name", // specify the order by which to sort the results
+     *     },
+     *   });
+     *
+     *   console.log(subdomains);
+     * }
+     * runExample().catch(console.error);
+     * ```
      */
     getDomainSubdomains(args: GetDomainSubdomainsArgs): Promise<GetANSNameResponse>;
 }