@aptos-labs/ts-sdk 1.29.1 → 1.31.0

package/dist/esm/internal/account.d.mts

@@ -1,9 +1,9 @@
 import { AptosConfig } from '../api/aptosConfig.mjs';
 import { AccountAddressInput, AccountAddress } from '../core/accountAddress.mjs';
 import { AccountData, PaginationArgs, LedgerVersionArg, MoveModuleBytecode, TransactionResponse, MoveResource, MoveStructId, TokenStandardArg, OrderByArg, WhereArg } from '../types/index.mjs';
-import { A as AuthenticationKey } from '../publicKey-B3XRNhHO.mjs';
+import { A as AuthenticationKey } from '../publicKey-_tPa99ea.mjs';
 import { PrivateKey } from '../core/crypto/privateKey.mjs';
-import { A as Account } from '../Ed25519Account-B1VMJOY2.mjs';
+import { A as Account } from '../Ed25519Account-DpH9qAcg.mjs';
 import { CurrentFungibleAssetBalancesBoolExp } from '../types/generated/types.mjs';
 import { GetAccountOwnedTokensQueryResponse, GetAccountOwnedTokensFromCollectionResponse, GetAccountCollectionsWithOwnedTokenResponse, GetAccountCoinsDataResponse, GetObjectDataQueryResponse } from '../types/indexer.mjs';
 import '../utils/apiEndpoints.mjs';
@@ -40,21 +40,43 @@ import '../transactions/instances/multiAgentTransaction.mjs';
  * account namespace and without having a dependency cycle error.
  */
 
+/**
+ * Retrieves account information for a specified account address.
+ *
+ * @param args - The arguments for retrieving account information.
+ * @param args.aptosConfig - The configuration object for Aptos.
+ * @param args.accountAddress - The address of the account to retrieve information for.
+ */
 declare function getInfo(args: {
     aptosConfig: AptosConfig;
     accountAddress: AccountAddressInput;
 }): Promise<AccountData>;
+/**
+ * Retrieves the modules associated with a specified account address.
+ *
+ * @param args - The arguments for retrieving modules.
+ * @param args.aptosConfig - The configuration for connecting to the Aptos blockchain.
+ * @param args.accountAddress - The address of the account whose modules are to be retrieved.
+ * @param args.options - Optional parameters for pagination and ledger version.
+ * @param args.options.limit - The maximum number of modules to retrieve (default is 1000).
+ * @param args.options.offset - The starting point for pagination.
+ * @param args.options.ledgerVersion - The specific ledger version to query.
+ */
 declare function getModules(args: {
     aptosConfig: AptosConfig;
     accountAddress: AccountAddressInput;
     options?: PaginationArgs & LedgerVersionArg;
 }): Promise<MoveModuleBytecode[]>;
 /**
- * Queries for a move module given account address and module name
+ * Queries for a move module given an account address and module name.
+ * This function can help you retrieve the module's ABI and other relevant information.
  *
- * @param args.accountAddress Hex-encoded 32 byte Aptos account address
- * @param args.moduleName The name of the module
- * @param args.query.ledgerVersion Specifies ledger version of transactions. By default, latest version will be used
+ * @param args - The arguments for retrieving the module.
+ * @param args.aptosConfig - The configuration for the Aptos client.
+ * @param args.accountAddress - The account address in hex-encoded 32 byte format.
+ * @param args.moduleName - The name of the module to retrieve.
+ * @param args.options - Optional parameters for the request.
+ * @param args.options.ledgerVersion - Specifies the ledger version of transactions. By default, the latest version will be used.
  * @returns The move module.
  */
 declare function getModule(args: {
@@ -63,81 +85,238 @@ declare function getModule(args: {
     moduleName: string;
     options?: LedgerVersionArg;
 }): Promise<MoveModuleBytecode>;
+/**
+ * Retrieves a list of transactions associated with a specific account address.
+ * This function allows you to paginate through the transactions for better performance and usability.
+ *
+ * @param args - The arguments for retrieving transactions.
+ * @param args.aptosConfig - The configuration settings for Aptos.
+ * @param args.accountAddress - The account address for which to retrieve transactions.
+ * @param args.options - Optional pagination parameters.
+ * @param args.options.offset - The starting point for pagination.
+ * @param args.options.limit - The maximum number of transactions to retrieve.
+ */
 declare function getTransactions(args: {
     aptosConfig: AptosConfig;
     accountAddress: AccountAddressInput;
     options?: PaginationArgs;
 }): Promise<TransactionResponse[]>;
+/**
+ * Retrieves a list of resources associated with a specific account address.
+ *
+ * @param args - The arguments for retrieving resources.
+ * @param args.aptosConfig - The configuration settings for Aptos.
+ * @param args.accountAddress - The address of the account to fetch resources for.
+ * @param args.options - Optional pagination and ledger version parameters.
+ * @param args.options.offset - The starting point for pagination.
+ * @param args.options.limit - The maximum number of resources to retrieve (default is 999).
+ * @param args.options.ledgerVersion - The specific ledger version to query.
+ */
 declare function getResources(args: {
     aptosConfig: AptosConfig;
     accountAddress: AccountAddressInput;
     options?: PaginationArgs & LedgerVersionArg;
 }): Promise<MoveResource[]>;
+/**
+ * Retrieves a specific resource of a given type for the specified account address.
+ *
+ * @param args - The arguments for retrieving the resource.
+ * @param args.aptosConfig - The configuration settings for Aptos.
+ * @param args.accountAddress - The address of the account from which to retrieve the resource.
+ * @param args.resourceType - The type of the resource to retrieve, specified as a MoveStructId.
+ * @param args.options - Optional parameters for specifying the ledger version.
+ */
 declare function getResource<T extends {}>(args: {
     aptosConfig: AptosConfig;
     accountAddress: AccountAddressInput;
     resourceType: MoveStructId;
     options?: LedgerVersionArg;
 }): Promise<T>;
+/**
+ * Retrieves the original account address associated with a given authentication key, which is useful for handling key rotations.
+ *
+ * @param args - The arguments for the lookup.
+ * @param args.aptosConfig - The configuration for the Aptos client.
+ * @param args.authenticationKey - The authentication key for which to look up the original address.
+ * @param args.options - Optional parameters for specifying the ledger version.
+ * @returns The original account address or the provided authentication key address if not found.
+ * @throws Throws an error if the lookup fails for reasons other than the address not being found.
+ */
 declare function lookupOriginalAccountAddress(args: {
     aptosConfig: AptosConfig;
     authenticationKey: AccountAddressInput;
     options?: LedgerVersionArg;
 }): Promise<AccountAddress>;
+/**
+ * Retrieves the count of tokens owned by a specific account address.
+ *
+ * @param args - The arguments for retrieving the account tokens count.
+ * @param args.aptosConfig - The configuration settings for the Aptos network.
+ * @param args.accountAddress - The address of the account for which to count the tokens.
+ * @returns The count of tokens owned by the specified account.
+ */
 declare function getAccountTokensCount(args: {
     aptosConfig: AptosConfig;
     accountAddress: AccountAddressInput;
 }): Promise<number>;
+/**
+ * Retrieves the tokens owned by a specified account address.
+ *
+ * @param args - The arguments for retrieving the account's tokens.
+ * @param args.aptosConfig - The configuration for the Aptos client.
+ * @param args.accountAddress - The address of the account whose tokens are being queried.
+ * @param args.options - Optional parameters for filtering and pagination.
+ * @param args.options.tokenStandard - The specific token standard to filter the results.
+ * @param args.options.offset - The number of records to skip before starting to collect the result set.
+ * @param args.options.limit - The maximum number of records to return.
+ * @param args.options.orderBy - The criteria for ordering the results.
+ * @returns A promise that resolves to the current token ownerships of the specified account.
+ */
 declare function getAccountOwnedTokens(args: {
     aptosConfig: AptosConfig;
     accountAddress: AccountAddressInput;
     options?: TokenStandardArg & PaginationArgs & OrderByArg<GetAccountOwnedTokensQueryResponse[0]>;
 }): Promise<GetAccountOwnedTokensQueryResponse>;
+/**
+ * Retrieves the tokens owned by a specific account from a particular collection address.
+ *
+ * @param args - The parameters required to fetch the owned tokens.
+ * @param args.aptosConfig - The Aptos configuration object.
+ * @param args.accountAddress - The address of the account whose tokens are being queried.
+ * @param args.collectionAddress - The address of the collection from which tokens are being retrieved.
+ * @param args.options - Optional parameters for filtering and pagination, including token standard, pagination arguments, and
+ * order by options.
+ */
 declare function getAccountOwnedTokensFromCollectionAddress(args: {
     aptosConfig: AptosConfig;
     accountAddress: AccountAddressInput;
     collectionAddress: AccountAddressInput;
     options?: TokenStandardArg & PaginationArgs & OrderByArg<GetAccountOwnedTokensFromCollectionResponse[0]>;
 }): Promise<GetAccountOwnedTokensFromCollectionResponse>;
+/**
+ * Retrieves the collections owned by a specified account along with the tokens in those collections.
+ *
+ * @param args - The arguments for the function.
+ * @param args.aptosConfig - The configuration for the Aptos client.
+ * @param args.accountAddress - The address of the account whose collections are being queried.
+ * @param args.options - Optional parameters for filtering and pagination.
+ * @param args.options.tokenStandard - An optional token standard to filter the collections.
+ * @param args.options.offset - An optional offset for pagination.
+ * @param args.options.limit - An optional limit for the number of results returned.
+ * @param args.options.orderBy - An optional parameter to specify the order of the results.
+ */
 declare function getAccountCollectionsWithOwnedTokens(args: {
     aptosConfig: AptosConfig;
     accountAddress: AccountAddressInput;
     options?: TokenStandardArg & PaginationArgs & OrderByArg<GetAccountCollectionsWithOwnedTokenResponse[0]>;
 }): Promise<GetAccountCollectionsWithOwnedTokenResponse>;
+/**
+ * Retrieves the count of transactions associated with a specified account.
+ *
+ * @param args - The arguments for the function.
+ * @param args.aptosConfig - The configuration settings for Aptos.
+ * @param args.accountAddress - The address of the account for which to retrieve the transaction count.
+ * @returns The number of transactions associated with the specified account.
+ */
 declare function getAccountTransactionsCount(args: {
     aptosConfig: AptosConfig;
     accountAddress: AccountAddressInput;
 }): Promise<number>;
+/**
+ * Retrieves the amount of a specific coin held by an account.
+ *
+ * @param args - The parameters for the request.
+ * @param args.aptosConfig - The Aptos configuration object.
+ * @param args.accountAddress - The address of the account to query.
+ * @param args.coinType - Optional; the type of coin to check the amount for.
+ * @param args.faMetadataAddress - Optional; the address of the fungible asset metadata.
+ * @returns The amount of the specified coin held by the account, or 0 if none is found.
+ * @throws Error if neither coinType nor faMetadataAddress is provided.
+ */
+declare function getAccountCoinAmount(args: {
+    aptosConfig: AptosConfig;
+    accountAddress: AccountAddressInput;
+    coinType?: MoveStructId;
+    faMetadataAddress?: AccountAddressInput;
+}): Promise<number>;
+/**
+ * Retrieves the current fungible asset balances for a specified account.
+ *
+ * @param args - The arguments for retrieving account coins data.
+ * @param args.aptosConfig - The configuration for connecting to the Aptos network.
+ * @param args.accountAddress - The address of the account for which to retrieve coin data.
+ * @param args.options - Optional parameters for pagination and filtering the results.
+ * @param args.options.offset - The number of items to skip before starting to collect the result set.
+ * @param args.options.limit - The maximum number of items to return.
+ * @param args.options.orderBy - The criteria for ordering the results.
+ * @param args.options.where - Conditions to filter the results based on the current fungible asset balances.
+ */
 declare function getAccountCoinsData(args: {
     aptosConfig: AptosConfig;
     accountAddress: AccountAddressInput;
     options?: PaginationArgs & OrderByArg<GetAccountCoinsDataResponse[0]> & WhereArg<CurrentFungibleAssetBalancesBoolExp>;
 }): Promise<GetAccountCoinsDataResponse>;
+/**
+ * Retrieves the count of fungible asset coins held by a specified account.
+ *
+ * @param args - The arguments for the function.
+ * @param args.aptosConfig - The configuration settings for the Aptos network.
+ * @param args.accountAddress - The address of the account for which to retrieve the coin count.
+ * @throws Error if the count of account coins cannot be retrieved.
+ */
 declare function getAccountCoinsCount(args: {
     aptosConfig: AptosConfig;
     accountAddress: AccountAddressInput;
 }): Promise<number>;
+/**
+ * Retrieves the objects owned by a specified account.
+ *
+ * @param args - The parameters for the request.
+ * @param args.aptosConfig - The configuration for the Aptos client.
+ * @param args.accountAddress - The address of the account whose owned objects are to be retrieved.
+ * @param args.options - Optional parameters for pagination and ordering of the results.
+ * @param args.options.offset - The number of items to skip before starting to collect the result set.
+ * @param args.options.limit - The maximum number of items to return.
+ * @param args.options.orderBy - The criteria to order the results by.
+ * @returns A promise that resolves to the current objects owned by the specified account.
+ */
 declare function getAccountOwnedObjects(args: {
     aptosConfig: AptosConfig;
     accountAddress: AccountAddressInput;
     options?: PaginationArgs & OrderByArg<GetObjectDataQueryResponse[0]>;
 }): Promise<GetObjectDataQueryResponse>;
 /**
- * NOTE: There is a potential issue once unified single signer scheme will be adopted
- * by the community.
+ * Derives an account from the provided private key and Aptos configuration.
+ * This function helps in obtaining the account details associated with a given private key,
+ * considering both unified and legacy authentication schemes.
  *
- * Becuase on could create 2 accounts with the same private key with this new authenticator type,
- * we’ll need to determine the order in which we lookup the accounts. First unified
- * scheme and then legacy scheme vs first legacy scheme and then unified scheme.
+ * NOTE: There is a potential issue once the unified single signer scheme is adopted by the community.
+ * Because one could create two accounts with the same private key with this new authenticator type,
+ * we’ll need to determine the order in which we look up the accounts: first unified scheme and then legacy scheme,
+ * or first legacy scheme and then unified scheme.
  *
+ * @param args - The arguments for deriving the account.
+ * @param args.aptosConfig - The Aptos configuration used for account lookup.
+ * @param args.privateKey - The private key used to derive the account.
+ * @throws Error if the account cannot be derived from the private key.
  */
 declare function deriveAccountFromPrivateKey(args: {
     aptosConfig: AptosConfig;
     privateKey: PrivateKey;
 }): Promise<Account>;
+/**
+ * Checks if an account exists by verifying its information against the Aptos blockchain.
+ *
+ * @param args - The arguments for the function.
+ * @param args.aptosConfig - The configuration for connecting to the Aptos blockchain.
+ * @param args.authKey - The authentication key used to derive the account address.
+ * @returns A promise that resolves to a boolean indicating whether the account exists.
+ *
+ * @throws Throws an Error if there is an issue while looking for account information.
+ */
 declare function isAccountExist(args: {
     aptosConfig: AptosConfig;
     authKey: AuthenticationKey;
 }): Promise<boolean>;
 
-export { deriveAccountFromPrivateKey, getAccountCoinsCount, getAccountCoinsData, getAccountCollectionsWithOwnedTokens, getAccountOwnedObjects, getAccountOwnedTokens, getAccountOwnedTokensFromCollectionAddress, getAccountTokensCount, getAccountTransactionsCount, getInfo, getModule, getModules, getResource, getResources, getTransactions, isAccountExist, lookupOriginalAccountAddress };
+export { deriveAccountFromPrivateKey, getAccountCoinAmount, getAccountCoinsCount, getAccountCoinsData, getAccountCollectionsWithOwnedTokens, getAccountOwnedObjects, getAccountOwnedTokens, getAccountOwnedTokensFromCollectionAddress, getAccountTokensCount, getAccountTransactionsCount, getInfo, getModule, getModules, getResource, getResources, getTransactions, isAccountExist, lookupOriginalAccountAddress };

package/dist/esm/internal/account.mjs

@@ -1,2 +1,2 @@
-import{a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q}from"../chunk-BKEJMQQ6.mjs";import"../chunk-STGYDB5E.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{p as deriveAccountFromPrivateKey,n as getAccountCoinsCount,m as getAccountCoinsData,k as getAccountCollectionsWithOwnedTokens,o as getAccountOwnedObjects,i as getAccountOwnedTokens,j as getAccountOwnedTokensFromCollectionAddress,h as getAccountTokensCount,l as getAccountTransactionsCount,a as getInfo,c as getModule,b as getModules,f as getResource,e as getResources,d as getTransactions,q as isAccountExist,g as lookupOriginalAccountAddress};
+import{a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r}from"../chunk-Y267I7DC.mjs";import"../chunk-EE7GDBA5.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{q as deriveAccountFromPrivateKey,m as getAccountCoinAmount,o as getAccountCoinsCount,n as getAccountCoinsData,k as getAccountCollectionsWithOwnedTokens,p as getAccountOwnedObjects,i as getAccountOwnedTokens,j as getAccountOwnedTokensFromCollectionAddress,h as getAccountTokensCount,l as getAccountTransactionsCount,a as getInfo,c as getModule,b as getModules,f as getResource,e as getResources,d as getTransactions,r as isAccountExist,g as lookupOriginalAccountAddress};
 //# sourceMappingURL=account.mjs.map

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

@@ -1,7 +1,7 @@
 import { AptosConfig } from '../api/aptosConfig.mjs';
 import { PaginationArgs, OrderByArg, WhereArg } from '../types/index.mjs';
 import { AccountAddress, AccountAddressInput } from '../core/accountAddress.mjs';
-import { A as Account } from '../Ed25519Account-B1VMJOY2.mjs';
+import { A as Account } from '../Ed25519Account-DpH9qAcg.mjs';
 import { InputGenerateTransactionOptions } from '../transactions/types.mjs';
 import { CurrentAptosNamesBoolExp } from '../types/generated/types.mjs';
 import { SimpleTransaction } from '../transactions/instances/simpleTransaction.mjs';
@@ -16,7 +16,7 @@ import '../bcs/deserializer.mjs';
 import '../transactions/instances/transactionArgument.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';
@@ -42,42 +42,61 @@ import '../transactions/instances/multiAgentTransaction.mjs';
 
 declare const VALIDATION_RULES_DESCRIPTION: string;
 /**
+ * Validate if a given fragment is a valid ANS segment.
+ * This function checks the length and character constraints of the fragment to ensure it meets the ANS standards.
  *
- * @param fragment A fragment of a name, either the domain or subdomain
- * @returns boolean indicating if the fragment is a valid fragment
+ * @param fragment - A fragment of a name, either the domain or subdomain.
+ * @returns A boolean indicating if the fragment is a valid fragment.
  */
 declare function isValidANSSegment(fragment: string): boolean;
 /**
- * Checks if an ANS name is valid or not
+ * Checks if an ANS name is valid or not.
  *
- * @param name A string of the domain name, can include or exclude the .apt suffix
+ * @param name - A string of the domain name, which can include or exclude the .apt suffix.
  */
 declare function isValidANSName(name: string): {
     domainName: string;
     subdomainName?: string;
 };
+/**
+ * Policy for determining how subdomains expire in relation to their parent domain.
+ */
 declare enum SubdomainExpirationPolicy {
     Independent = 0,
     FollowsDomain = 1
 }
 /**
- * A helper function to determine if a given ANS name is considered active or
- * not. Domains are considered active if their expiration date is in the
- * future. Subdomains have two policies which modify their behavior. They can
- * follow their parent's expiration (1) in which they ignore their own
- * expiration timestamp or they can expire independently (0) in which they can
- * expire before their parent but not afterwards.
+ * Determine if a given ANS name is considered active based on its expiration dates.
+ * Domains are active if their expiration date is in the future, while subdomains may
+ * follow their parent's expiration policy (1) or expire independently (0).
+ * If the subdomain is expiring independently, it can expire before their parent, but not after.
  *
- * @param name - An ANS name returned from one of the functions of the SDK
- * @returns A boolean representing if the contract considers the name active or not
+ * @param name - An ANS name returned from one of the functions of the SDK.
+ * @returns A boolean indicating whether the contract considers the name active or not.
  */
 declare function isActiveANSName(name: GetANSNameResponse[0]): boolean;
 declare const LOCAL_ANS_ACCOUNT_PK: string;
 declare const LOCAL_ANS_ACCOUNT_ADDRESS: string;
+/**
+ * Retrieve the owner address of a specified domain or subdomain.
+ *
+ * @param args - The arguments for retrieving the owner address.
+ * @param args.aptosConfig - The Aptos configuration object.
+ * @param args.name - The name of the domain or subdomain to query.
+ * @returns The account address of the owner, or undefined if not found.
+ */
 declare function getOwnerAddress(args: {
     aptosConfig: AptosConfig;
     name: string;
 }): Promise<AccountAddress | undefined>;
+/**
+ * Parameters for registering a name in the Aptos network.
+ *
+ * @param aptosConfig - Configuration settings for the Aptos network.
+ * @param sender - The account initiating the name registration.
+ * @param name - The name to be registered.
+ * @param expiration - The expiration policy for the name registration.
+ */
 interface RegisterNameParameters {
     aptosConfig: AptosConfig;
     sender: Account;
@@ -96,25 +115,94 @@ interface RegisterNameParameters {
     targetAddress?: AccountAddressInput;
     options?: InputGenerateTransactionOptions;
 }
+/**
+ * Registers a domain or subdomain with the specified parameters. This function ensures that the provided names and expiration
+ * policies are valid before proceeding with the registration process.
+ *
+ * @param args - The parameters required for registering a name.
+ * @param args.aptosConfig - The configuration settings for Aptos.
+ * @param args.expiration - The expiration details for the registration.
+ * @param args.name - The name to be registered, which can be a domain or subdomain.
+ * @param args.sender - The account details of the sender initiating the registration.
+ * @param args.targetAddress - The target address for the registration.
+ * @param args.toAddress - The address to which the registration is associated.
+ * @param args.options - Additional options for the registration process.
+ * @param args.transferable - Indicates whether the registered name is transferable.
+ *
+ * @throws Error if the provided expiration policy is invalid for subdomains.
+ * @throws Error if the domain does not exist.
+ * @throws Error if the subdomain expiration time exceeds the domain expiration time.
+ *
+ * @returns A transaction object representing the registration process.
+ */
 declare function registerName(args: RegisterNameParameters): Promise<SimpleTransaction>;
+/**
+ * Retrieves the expiration time of a specified domain or subdomain in epoch milliseconds.
+ *
+ * @param args - The arguments for the function.
+ * @param args.aptosConfig - The configuration object for Aptos.
+ * @param args.name - The name of the domain or subdomain to check.
+ * @returns The expiration time in epoch milliseconds, or undefined if an error occurs.
+ */
 declare function getExpiration(args: {
     aptosConfig: AptosConfig;
     name: string;
 }): Promise<number | undefined>;
+/**
+ * Retrieves the primary name associated with a given account address.
+ * This function helps in obtaining the complete domain name by combining the subdomain and domain names.
+ *
+ * @param args - The arguments for retrieving the primary name.
+ * @param args.aptosConfig - The Aptos configuration object.
+ * @param args.address - The account address for which to retrieve the primary name.
+ * @returns The primary name as a string, or undefined if no domain name exists.
+ */
 declare function getPrimaryName(args: {
     aptosConfig: AptosConfig;
     address: AccountAddressInput;
 }): Promise<string | undefined>;
+/**
+ * Sets the primary name for the specified account, allowing for the association of a domain or subdomain with the account.
+ * If no name is provided, it clears the existing primary name.
+ *
+ * @param args - The arguments for setting the primary name.
+ * @param args.aptosConfig - The Aptos configuration object.
+ * @param args.sender - The account that is sending the transaction.
+ * @param args.name - The name to set as the primary name. If omitted, the function will clear the primary name.
+ * @param args.options - Optional transaction generation options.
+ * @returns A transaction object representing the operation.
+ */
 declare function setPrimaryName(args: {
     aptosConfig: AptosConfig;
     sender: Account;
     name?: string;
     options?: InputGenerateTransactionOptions;
 }): Promise<SimpleTransaction>;
+/**
+ * Retrieves the target address associated with a given domain name and subdomain name.
+ *
+ * @param args - The arguments for retrieving the target address.
+ * @param args.aptosConfig - The Aptos configuration object.
+ * @param args.name - The name of the domain, which may include a subdomain.
+ * @returns The target address as an AccountAddress, or undefined if not found.
+ */
 declare function getTargetAddress(args: {
     aptosConfig: AptosConfig;
     name: string;
 }): Promise<AccountAddress | undefined>;
+/**
+ * Sets the target address for a specified domain and subdomain in the Aptos network.
+ * This function helps to associate a given address with a domain name, allowing for easier access and management of resources.
+ *
+ * @param args - The arguments for setting the target address.
+ * @param args.aptosConfig - The configuration settings for the Aptos network.
+ * @param args.sender - The account that is sending the transaction.
+ * @param args.name - The name of the domain or subdomain to be set.
+ * @param args.address - The address to be associated with the domain or subdomain.
+ * @param args.options - Optional parameters for generating the transaction.
+ *
+ * @returns A transaction object representing the set target address operation.
+ */
 declare function setTargetAddress(args: {
     aptosConfig: AptosConfig;
     sender: Account;
@@ -122,37 +210,141 @@ declare function setTargetAddress(args: {
     address: AccountAddressInput;
     options?: InputGenerateTransactionOptions;
 }): Promise<SimpleTransaction>;
+/**
+ * Retrieves the active Aptos name associated with the specified domain and subdomain.
+ *
+ * @param args - The parameters for the function.
+ * @param args.aptosConfig - The configuration object for Aptos.
+ * @param args.name - The name to look up, which includes the domain and optional subdomain.
+ * @returns The active Aptos name if it exists; otherwise, returns undefined.
+ */
 declare function getName(args: {
     aptosConfig: AptosConfig;
     name: string;
 }): Promise<GetANSNameResponse[0] | undefined>;
+/**
+ * Options for querying names, including pagination, ordering, and filtering criteria.
+ *
+ * @param options - Pagination and filtering options for the query.
+ */
 interface QueryNamesOptions {
     options?: PaginationArgs & OrderByArg<GetANSNameResponse[0]> & WhereArg<CurrentAptosNamesBoolExp>;
 }
+/**
+ * Arguments for retrieving account names based on the specified account address.
+ *
+ * @param accountAddress - The address of the account for which names are to be retrieved.
+ */
 interface GetAccountNamesArgs extends QueryNamesOptions {
     accountAddress: AccountAddressInput;
 }
+/**
+ * Retrieves the current Aptos names associated with a specific account address.
+ *
+ * @param args - The arguments for retrieving account names.
+ * @param args.aptosConfig - The configuration object for Aptos.
+ * @param args.options - Optional parameters for querying account names.
+ * @param args.options.limit - The maximum number of names to retrieve.
+ * @param args.options.offset - The number of names to skip before starting to collect the result set.
+ * @param args.options.orderBy - The field by which to order the results.
+ * @param args.options.where - Additional conditions to filter the results.
+ * @param args.accountAddress - The address of the account for which to retrieve names.
+ *
+ * @returns An array of sanitized Aptos names associated with the specified account address.
+ */
 declare function getAccountNames(args: {
     aptosConfig: AptosConfig;
 } & GetAccountNamesArgs): Promise<GetANSNameResponse>;
+/**
+ * Arguments for retrieving the domains associated with a specific account.
+ *
+ * @param accountAddress - The address of the account for which to fetch domains.
+ */
 interface GetAccountDomainsArgs extends QueryNamesOptions {
     accountAddress: AccountAddressInput;
 }
+/**
+ * Retrieves the list of top-level domains owned by a specified account.
+ *
+ * @param args - The arguments for retrieving account domains.
+ * @param args.aptosConfig - The Aptos configuration object.
+ * @param args.options - Optional parameters for the query.
+ * @param args.options.limit - The maximum number of results to return.
+ * @param args.options.offset - The number of results to skip before starting to collect the result set.
+ * @param args.options.orderBy - The field by which to order the results.
+ * @param args.options.where - Additional conditions to filter the results.
+ * @param args.options.where.owner_address - The address of the account whose domains are being queried.
+ * @param args.options.where.expiration_timestamp - The minimum expiration timestamp for the domains.
+ * @param args.options.where.subdomain - The specific subdomain to filter by.
+ *
+ * @returns An array of sanitized domain names owned by the specified account.
+ */
 declare function getAccountDomains(args: {
     aptosConfig: AptosConfig;
 } & GetAccountDomainsArgs): Promise<GetANSNameResponse>;
+/**
+ * Arguments for retrieving subdomains associated with a specific account.
+ *
+ * @param accountAddress - The address of the account for which to fetch subdomains.
+ */
 interface GetAccountSubdomainsArgs extends QueryNamesOptions {
     accountAddress: AccountAddressInput;
 }
+/**
+ * Retrieves a list of subdomains owned by a specified account address.
+ * This function helps you identify all subdomains associated with a given account.
+ *
+ * @param args - The arguments for retrieving account subdomains.
+ * @param args.aptosConfig - The configuration object for Aptos.
+ * @param args.options - Optional parameters for the query.
+ * @param args.options.limit - The maximum number of results to return.
+ * @param args.options.offset - The number of results to skip before starting to collect the result set.
+ * @param args.options.orderBy - The field by which to order the results.
+ * @param args.options.where - Additional conditions to filter the results.
+ * @param args.options.where.owner_address - The address of the account to filter by.
+ * @param args.options.where.expiration_timestamp - The expiration timestamp to filter by.
+ * @param args.options.where.subdomain - The subdomain condition to filter by.
+ * @param args.accountAddress - The address of the account whose subdomains are being queried.
+ */
 declare function getAccountSubdomains(args: {
     aptosConfig: AptosConfig;
 } & GetAccountSubdomainsArgs): Promise<GetANSNameResponse>;
+/**
+ * Arguments for retrieving subdomains associated with a specific domain.
+ *
+ * @param domain - The domain for which to fetch subdomains.
+ */
 interface GetDomainSubdomainsArgs extends QueryNamesOptions {
     domain: string;
 }
+/**
+ * Retrieve the active subdomains associated with a specified domain.
+ *
+ * @param args - The arguments for retrieving subdomains.
+ * @param args.aptosConfig - The configuration settings for Aptos.
+ * @param args.options - Optional parameters for the query.
+ * @param args.options.limit - The maximum number of results to return.
+ * @param args.options.offset - The number of results to skip before starting to collect the results.
+ * @param args.options.orderBy - The field by which to order the results.
+ * @param args.options.where - Additional conditions to filter the results.
+ * @param args.domain - The domain for which to retrieve subdomains.
+ *
+ * @returns An array of active subdomain names.
+ */
 declare function getDomainSubdomains(args: {
     aptosConfig: AptosConfig;
 } & GetDomainSubdomainsArgs): Promise<GetANSNameResponse>;
+/**
+ * Renews a domain for a specified duration. This function allows you to extend the registration of a domain for one year.
+ *
+ * @param args - The parameters required to renew the domain.
+ * @param args.aptosConfig - The configuration settings for Aptos.
+ * @param args.sender - The account that is sending the renewal transaction.
+ * @param args.name - The name of the domain to renew.
+ * @param args.years - The number of years to renew the domain for. Currently, only 1 year renewals are supported. (optional, default is 1)
+ * @param args.options - Additional options for generating the transaction. (optional)
+ * @throws Error if the name contains a subdomain or if the years parameter is not equal to 1.
+ */
 declare function renewDomain(args: {
     aptosConfig: AptosConfig;
     sender: Account;