@aptos-labs/ts-sdk 1.29.1 → 1.31.0

package/dist/esm/types/index.d.mts

@@ -4,6 +4,9 @@ export { GetANSNameResponse, GetAccountCoinsDataResponse, GetAccountCollectionsW
 import './generated/operations.mjs';
 import './generated/types.mjs';
 
+/**
+ * Different MIME types used for data interchange in transactions and responses.
+ */
 declare enum MimeType {
     /**
      * JSON representation, used for transaction submission and accept type JSON output
@@ -20,11 +23,11 @@ declare enum MimeType {
     BCS_VIEW_FUNCTION = "application/x.aptos.view_function+bcs"
 }
 /**
- * Hex data as input to a function
+ * Hexadecimal data input for functions, supporting both string and Uint8Array formats.
  */
 type HexInput = string | Uint8Array;
 /**
- * TypeTag enum as they are represented in Rust
+ * Variants of type tags used in the system, encompassing various data types and structures.
  * {@link https://github.com/aptos-labs/aptos-core/blob/main/third_party/move/move-core/types/src/language_storage.rs#L27}
  */
 declare enum TypeTagVariants {
@@ -43,7 +46,7 @@ declare enum TypeTagVariants {
     Generic = 255
 }
 /**
- * Script transaction arguments enum as they are represented in Rust
+ * Variants of script transaction arguments used in Rust, encompassing various data types for transaction processing.
  * {@link https://github.com/aptos-labs/aptos-core/blob/main/third_party/move/move-core/types/src/transaction_argument.rs#L11}
  */
 declare enum ScriptTransactionArgumentVariants {
@@ -59,7 +62,7 @@ declare enum ScriptTransactionArgumentVariants {
     Serialized = 9
 }
 /**
- * Transaction payload enum as they are represented in Rust
+ * The payload for various transaction types in the system.
  * {@link https://github.com/aptos-labs/aptos-core/blob/main/types/src/transaction/mod.rs#L478}
  */
 declare enum TransactionPayloadVariants {
@@ -68,7 +71,7 @@ declare enum TransactionPayloadVariants {
     Multisig = 3
 }
 /**
- * Transaction variants enum as they are represented in Rust
+ * Variants of transactions used in the system.
  * {@link https://github.com/aptos-labs/aptos-core/blob/main/types/src/transaction/mod.rs#L440}
  */
 declare enum TransactionVariants {
@@ -76,7 +79,7 @@ declare enum TransactionVariants {
     FeePayerTransaction = 1
 }
 /**
- * Transaction Authenticator enum as they are represented in Rust
+ * Variants of transaction authenticators used in the system.
  * {@link https://github.com/aptos-labs/aptos-core/blob/main/types/src/transaction/authenticator.rs#L44}
  */
 declare enum TransactionAuthenticatorVariant {
@@ -87,7 +90,7 @@ declare enum TransactionAuthenticatorVariant {
     SingleSender = 4
 }
 /**
- * Transaction Authenticator enum as they are represented in Rust
+ * Variants of account authenticators used in transactions.
  * {@link https://github.com/aptos-labs/aptos-core/blob/main/types/src/transaction/authenticator.rs#L414}
  */
 declare enum AccountAuthenticatorVariant {
@@ -96,26 +99,44 @@ declare enum AccountAuthenticatorVariant {
     SingleKey = 2,
     MultiKey = 3
 }
+/**
+ * Variants of public keys used in cryptographic operations.
+ */
 declare enum AnyPublicKeyVariant {
     Ed25519 = 0,
     Secp256k1 = 1,
     Keyless = 3,
     FederatedKeyless = 4
 }
+/**
+ * Variants of signature types used for cryptographic operations.
+ */
 declare enum AnySignatureVariant {
     Ed25519 = 0,
     Secp256k1 = 1,
     Keyless = 3
 }
+/**
+ * Variants of ephemeral public keys used in cryptographic operations.
+ */
 declare enum EphemeralPublicKeyVariant {
     Ed25519 = 0
 }
+/**
+ * Variants of ephemeral signatures used for secure communication.
+ */
 declare enum EphemeralSignatureVariant {
     Ed25519 = 0
 }
+/**
+ * Variants of ephemeral certificates used in secure transactions.
+ */
 declare enum EphemeralCertificateVariant {
     ZkProof = 0
 }
+/**
+ * Variants of zero-knowledge proofs used in cryptographic operations.
+ */
 declare enum ZkpVariant {
     Groth16 = 0
 }
@@ -123,16 +144,32 @@ declare enum ZkpVariant {
  * BCS types
  */
 type Uint8 = number;
+/**
+ * A 16-bit unsigned integer.
+ */
 type Uint16 = number;
+/**
+ * A 32-bit unsigned integer.
+ */
 type Uint32 = number;
+/**
+ * A 64-bit unsigned integer value.
+ */
 type Uint64 = bigint;
+/**
+ * A 128-bit unsigned integer used for precise arithmetic operations.
+ */
 type Uint128 = bigint;
+/**
+ * A 256-bit unsigned integer used for precise numerical calculations.
+ */
 type Uint256 = bigint;
+/**
+ * A number or a bigint value.
+ */
 type AnyNumber = number | bigint;
 /**
- * Set of configuration options that can be provided when initializing the SDK.
- * The purpose of these options is to configure various aspects of the SDK's
- * behavior and interaction with the Aptos network
+ * Configuration options for initializing the SDK, allowing customization of its behavior and interaction with the Aptos network.
  */
 type AptosSettings = {
     readonly network?: Network;
@@ -148,15 +185,19 @@ type AptosSettings = {
     readonly faucetConfig?: FaucetConfig;
 };
 /**
- *
- * Controls the number of results that are returned and the starting position of those results.
- * @param offset parameter specifies the starting position of the query result within the set of data. Default is 0.
- * @param limit specifies the maximum number of items or records to return in a query result. Default is 25.
+ * Defines the parameters for paginating query results, including the starting position and maximum number of items to return.
+ * @param offset Specifies the starting position of the query result. Default is 0.
+ * @param limit Specifies the maximum number of items to return. Default is 25.
  */
 interface PaginationArgs {
     offset?: AnyNumber;
     limit?: number;
 }
+/**
+ * Represents the arguments for specifying a token standard.
+ *
+ * @param tokenStandard - Optional standard of the token.
+ */
 interface TokenStandardArg {
     tokenStandard?: TokenStandard;
 }
@@ -170,43 +211,38 @@ interface WhereArg<T extends {}> {
  * QUERY TYPES
  */
 /**
- * A configuration object we can pass with the request to the server.
- *
- * @param API_KEY - api key generated from developer portal {@link https://developers.aptoslabs.com/manage/api-keys}}
- * @param HEADERS - extra headers we want to send with the request
- * @param WITH_CREDENTIALS - whether to carry cookies. By default, it is set to true and cookies will be sent
+ * A configuration object for requests to the server, including API key, extra headers, and cookie handling options.
  */
 type ClientConfig = ClientHeadersType & {
     WITH_CREDENTIALS?: boolean;
     API_KEY?: string;
 };
 /**
- * A Fullnode only configuration object
- *
- * @param HEADERS - extra headers we want to send with the request
+ * A configuration object for a Fullnode, allowing for the inclusion of extra headers in requests.
  */
 type FullNodeConfig = ClientHeadersType;
 /**
- * An Indexer only configuration object
- *
- * @param HEADERS - extra headers we want to send with the request
+ * An Indexer configuration object for sending requests with additional headers.
  */
 type IndexerConfig = ClientHeadersType;
 /**
- * A Faucet only configuration object
- *
- * @param HEADERS - extra headers we want to send with the request
- * @param AUTH_TOKEN - an auth token to send with a faucet request
+ * A configuration object for a faucet, including optional authentication and headers for requests.
  */
 type FaucetConfig = ClientHeadersType & {
     AUTH_TOKEN?: string;
 };
 /**
- * General type definition for client HEADERS
+ * General type definition for client headers.
  */
 type ClientHeadersType = {
     HEADERS?: Record<string, string | number | boolean>;
 };
+/**
+ * Represents a client for making requests to a service provider.
+ *
+ * @param Req - The type of the request payload.
+ * @param Res - The type of the response payload.
+ */
 interface ClientRequest<Req> {
     url: string;
     method: "GET" | "POST";
@@ -227,14 +263,28 @@ interface ClientResponse<Res> {
     headers?: any;
 }
 interface Client {
+    /**
+     * Sends a request to the specified URL with the given options.
+     *
+     * @param requestOptions - The options for the request.
+     * @param requestOptions.url - The URL to send the request to.
+     * @param requestOptions.method - The HTTP method to use, either "GET" or "POST".
+     * @param requestOptions.path - An optional path to append to the URL.
+     * @param requestOptions.body - The body of the request, applicable for POST requests.
+     * @param requestOptions.contentType - The content type of the request body.
+     * @param requestOptions.acceptType - The expected content type of the response.
+     * @param requestOptions.params - Optional parameters to include in the request.
+     * @param requestOptions.originMethod - An optional method to specify the origin of the request.
+     * @param requestOptions.overrides - Optional configuration overrides for the request.
+     */
     provider<Req, Res>(requestOptions: ClientRequest<Req>): Promise<ClientResponse<Res>>;
 }
 /**
  * The API request type
  *
- * @param url - the url to make the request to, i.e https://fullnode.devnet.aptoslabs.com/v1
+ * @param url - the url to make the request to, i.e. https://fullnode.devnet.aptoslabs.com/v1
  * @param method - the request method "GET" | "POST"
- * @param endpoint (optional) - the endpoint to make the request to, i.e transactions
+ * @param endpoint (optional) - the endpoint to make the request to, i.e. transactions
  * @param body (optional) - the body of the request
  * @param contentType (optional) - the content type to set the `content-type` header to,
  * by default is set to `application/json`
@@ -254,7 +304,7 @@ type AptosRequest = {
     overrides?: ClientConfig & FullNodeConfig & IndexerConfig & FaucetConfig;
 };
 /**
- * Specifies ledger version of transactions. By default latest version will be used
+ * The ledger version of transactions, defaulting to the latest version if not specified.
  */
 type LedgerVersionArg = {
     ledgerVersion?: AnyNumber;
@@ -263,7 +313,7 @@ type LedgerVersionArg = {
  * RESPONSE TYPES
  */
 /**
- * Type holding the outputs of the estimate gas API
+ * The output of the estimate gas API, including the deprioritized estimate for the gas unit price.
  */
 type GasEstimation = {
     /**
@@ -283,10 +333,16 @@ type MoveResource<T = {}> = {
     type: MoveStructId;
     data: T;
 };
+/**
+ * The data associated with an account, including its sequence number.
+ */
 type AccountData = {
     sequence_number: string;
     authentication_key: string;
 };
+/**
+ * A Move module containing an address.
+ */
 type MoveModuleBytecode = {
     bytecode: string;
     abi?: MoveModule;
@@ -294,6 +350,9 @@ type MoveModuleBytecode = {
 /**
  * TRANSACTION TYPES
  */
+/**
+ * Different types of transaction responses that can occur in the system.
+ */
 declare enum TransactionResponseType {
     Pending = "pending_transaction",
     User = "user_transaction",
@@ -303,15 +362,66 @@ declare enum TransactionResponseType {
     Validator = "validator_transaction",
     BlockEpilogue = "block_epilogue_transaction"
 }
+/**
+ * The response for a transaction, which can be either pending or committed.
+ */
 type TransactionResponse = PendingTransactionResponse | CommittedTransactionResponse;
+/**
+ * The response for a committed transaction, which can be one of several transaction types.
+ */
 type CommittedTransactionResponse = UserTransactionResponse | GenesisTransactionResponse | BlockMetadataTransactionResponse | StateCheckpointTransactionResponse | ValidatorTransactionResponse | BlockEpilogueTransactionResponse;
+/**
+ * Determine if the given transaction response is currently pending.
+ *
+ * @param response - The transaction response to evaluate.
+ * @returns A boolean indicating whether the transaction is pending.
+ */
 declare function isPendingTransactionResponse(response: TransactionResponse): response is PendingTransactionResponse;
+/**
+ * Determines if the given transaction response is a user transaction.
+ *
+ * @param response - The transaction response to evaluate.
+ * @returns A boolean indicating whether the transaction is of type User.
+ */
 declare function isUserTransactionResponse(response: TransactionResponse): response is UserTransactionResponse;
+/**
+ * Determines if the given transaction response is a Genesis transaction.
+ *
+ * @param response - The transaction response to evaluate.
+ * @returns A boolean indicating whether the transaction is a Genesis transaction.
+ */
 declare function isGenesisTransactionResponse(response: TransactionResponse): response is GenesisTransactionResponse;
+/**
+ * Determine if the given transaction response is of type BlockMetadata.
+ *
+ * @param response - The transaction response to evaluate.
+ * @returns A boolean indicating whether the response is a BlockMetadata transaction.
+ */
 declare function isBlockMetadataTransactionResponse(response: TransactionResponse): response is BlockMetadataTransactionResponse;
+/**
+ * Determines if the provided transaction response is a state checkpoint transaction.
+ *
+ * @param response - The transaction response to evaluate.
+ * @returns A boolean indicating whether the transaction response is of type StateCheckpoint.
+ */
 declare function isStateCheckpointTransactionResponse(response: TransactionResponse): response is StateCheckpointTransactionResponse;
+/**
+ * Determine if the given transaction response is of type Validator.
+ *
+ * @param response - The transaction response to evaluate.
+ * @returns A boolean indicating whether the transaction response is a Validator type.
+ */
 declare function isValidatorTransactionResponse(response: TransactionResponse): response is ValidatorTransactionResponse;
+/**
+ * Determines if the given transaction response is of the type Block Epilogue.
+ *
+ * @param response - The transaction response to evaluate.
+ * @returns A boolean indicating whether the response is a Block Epilogue transaction.
+ */
 declare function isBlockEpilogueTransactionResponse(response: TransactionResponse): response is BlockEpilogueTransactionResponse;
+/**
+ * The response for a pending transaction, indicating that the transaction is still being processed.
+ */
 type PendingTransactionResponse = {
     type: TransactionResponseType.Pending;
     hash: string;
@@ -323,6 +433,9 @@ type PendingTransactionResponse = {
     payload: TransactionPayloadResponse;
     signature?: TransactionSignature;
 };
+/**
+ * The response structure for a user transaction.
+ */
 type UserTransactionResponse = {
     type: TransactionResponseType.User;
     version: string;
@@ -357,6 +470,9 @@ type UserTransactionResponse = {
     events: Array<Event>;
     timestamp: string;
 };
+/**
+ * The response for a genesis transaction, indicating the type of transaction.
+ */
 type GenesisTransactionResponse = {
     type: TransactionResponseType.Genesis;
     version: string;
@@ -384,6 +500,9 @@ type GenesisTransactionResponse = {
      */
     events: Array<Event>;
 };
+/**
+ * The structure representing a blockchain block with its height.
+ */
 type BlockMetadataTransactionResponse = {
     type: TransactionResponseType.BlockMetadata;
     version: string;
@@ -423,6 +542,9 @@ type BlockMetadataTransactionResponse = {
     failed_proposer_indices: Array<number>;
     timestamp: string;
 };
+/**
+ * The response for a state checkpoint transaction, indicating the type of transaction.
+ */
 type StateCheckpointTransactionResponse = {
     type: TransactionResponseType.StateCheckpoint;
     version: string;
@@ -446,6 +568,9 @@ type StateCheckpointTransactionResponse = {
     changes: Array<WriteSetChange>;
     timestamp: string;
 };
+/**
+ * The response for a validator transaction, indicating the type of transaction.
+ */
 type ValidatorTransactionResponse = {
     type: TransactionResponseType.Validator;
     version: string;
@@ -474,7 +599,7 @@ type ValidatorTransactionResponse = {
     timestamp: string;
 };
 /**
- * BlockEndInfo describes the gas state of the block
+ * Describes the gas state of the block, indicating whether the block gas limit has been reached.
  */
 type BlockEndInfo = {
     block_gas_limit_reached: boolean;
@@ -483,8 +608,7 @@ type BlockEndInfo = {
     block_approx_output_size: number;
 };
 /**
- * BlockEpilogueTransactionResponse is a transaction that is executed at the end of a block keeping track of data from
- * the whole block
+ * A transaction executed at the end of a block that tracks data from the entire block.
  */
 type BlockEpilogueTransactionResponse = {
     type: TransactionResponseType.BlockEpilogue;
@@ -513,7 +637,13 @@ type BlockEpilogueTransactionResponse = {
 /**
  * WRITESET CHANGE TYPES
  */
+/**
+ * A union type that encompasses both script and direct write sets for data operations.
+ */
 type WriteSetChange = WriteSetChangeDeleteModule | WriteSetChangeDeleteResource | WriteSetChangeDeleteTableItem | WriteSetChangeWriteModule | WriteSetChangeWriteResource | WriteSetChangeWriteTableItem;
+/**
+ * The structure for a module deletion change in a write set.
+ */
 type WriteSetChangeDeleteModule = {
     type: string;
     address: string;
@@ -523,12 +653,18 @@ type WriteSetChangeDeleteModule = {
     state_key_hash: string;
     module: MoveModuleId;
 };
+/**
+ * The payload for a resource deletion in a write set change.
+ */
 type WriteSetChangeDeleteResource = {
     type: string;
     address: string;
     state_key_hash: string;
     resource: string;
 };
+/**
+ * The payload for a write set change that deletes a table item.
+ */
 type WriteSetChangeDeleteTableItem = {
     type: string;
     state_key_hash: string;
@@ -536,18 +672,27 @@ type WriteSetChangeDeleteTableItem = {
     key: string;
     data?: DeletedTableData;
 };
+/**
+ * The structure for a write module change in a write set.
+ */
 type WriteSetChangeWriteModule = {
     type: string;
     address: string;
     state_key_hash: string;
     data: MoveModuleBytecode;
 };
+/**
+ * The resource associated with a write set change, identified by its type.
+ */
 type WriteSetChangeWriteResource = {
     type: string;
     address: string;
     state_key_hash: string;
     data: MoveResource;
 };
+/**
+ * The structure for a write operation on a table in a write set change.
+ */
 type WriteSetChangeWriteTableItem = {
     type: string;
     state_key_hash: string;
@@ -556,6 +701,9 @@ type WriteSetChangeWriteTableItem = {
     value: string;
     data?: DecodedTableData;
 };
+/**
+ * The decoded data for a table, including its key in JSON format.
+ */
 type DecodedTableData = {
     /**
      * Key of table in JSON
@@ -575,7 +723,7 @@ type DecodedTableData = {
     value_type: string;
 };
 /**
- * Deleted table data
+ * Data for a deleted table entry.
  */
 type DeletedTableData = {
     /**
@@ -587,7 +735,13 @@ type DeletedTableData = {
      */
     key_type: string;
 };
+/**
+ * The payload for a transaction response, which can be an entry function, script, or multisig payload.
+ */
 type TransactionPayloadResponse = EntryFunctionPayloadResponse | ScriptPayloadResponse | MultisigPayloadResponse;
+/**
+ * The response payload for an entry function, containing the type of the entry.
+ */
 type EntryFunctionPayloadResponse = {
     type: string;
     function: MoveFunctionId;
@@ -600,6 +754,9 @@ type EntryFunctionPayloadResponse = {
      */
     arguments: Array<any>;
 };
+/**
+ * The payload for a script response, containing the type of the script.
+ */
 type ScriptPayloadResponse = {
     type: string;
     code: MoveScriptBytecode;
@@ -612,41 +769,88 @@ type ScriptPayloadResponse = {
      */
     arguments: Array<any>;
 };
+/**
+ * The response payload for a multisig transaction, containing the type of the transaction.
+ */
 type MultisigPayloadResponse = {
     type: string;
     multisig_address: string;
     transaction_payload?: EntryFunctionPayloadResponse;
 };
+/**
+ * The payload for the genesis block containing the type of the payload.
+ */
 type GenesisPayload = {
     type: string;
     write_set: WriteSet;
 };
 /**
- * Move script bytecode
+ * The bytecode for a Move script.
  */
 type MoveScriptBytecode = {
     bytecode: string;
     abi?: MoveFunction;
 };
 /**
- * These are the JSON representations of transaction signatures returned from the node API.
+ * JSON representations of transaction signatures returned from the node API.
  */
 type TransactionSignature = TransactionEd25519Signature | TransactionSecp256k1Signature | TransactionMultiEd25519Signature | TransactionMultiAgentSignature | TransactionFeePayerSignature;
+/**
+ * Determine if the provided signature is an Ed25519 signature.
+ * This function checks for the presence of the "signature" property
+ * and verifies that its value is "ed25519_signature".
+ *
+ * @param signature - The transaction signature to be checked.
+ * @returns A boolean indicating whether the signature is an Ed25519 signature.
+ */
 declare function isEd25519Signature(signature: TransactionSignature): signature is TransactionFeePayerSignature;
+/**
+ * Determine if the provided signature is a valid secp256k1 ECDSA signature.
+ *
+ * @param signature - The transaction signature to validate.
+ * @returns A boolean indicating whether the signature is a secp256k1 ECDSA signature.
+ */
 declare function isSecp256k1Signature(signature: TransactionSignature): signature is TransactionFeePayerSignature;
+/**
+ * Determine if the provided transaction signature is a multi-agent signature.
+ *
+ * @param signature - The transaction signature to evaluate.
+ * @returns A boolean indicating whether the signature is a multi-agent signature.
+ */
 declare function isMultiAgentSignature(signature: TransactionSignature): signature is TransactionMultiAgentSignature;
+/**
+ * Determine if the provided signature is a fee payer signature.
+ *
+ * @param signature - The transaction signature to evaluate.
+ * @returns A boolean indicating whether the signature is a fee payer signature.
+ */
 declare function isFeePayerSignature(signature: TransactionSignature): signature is TransactionFeePayerSignature;
+/**
+ * Determine if the provided signature is of type "multi_ed25519_signature".
+ *
+ * @param signature - The transaction signature to check.
+ * @returns A boolean indicating whether the signature is a multi-ed25519 signature.
+ */
 declare function isMultiEd25519Signature(signature: TransactionSignature): signature is TransactionMultiEd25519Signature;
+/**
+ * The signature for a transaction using the Ed25519 algorithm.
+ */
 type TransactionEd25519Signature = {
     type: string;
     public_key: string;
     signature: "ed25519_signature";
 };
+/**
+ * The structure for a Secp256k1 signature in a transaction.
+ */
 type TransactionSecp256k1Signature = {
     type: string;
     public_key: string;
     signature: "secp256k1_ecdsa_signature";
 };
+/**
+ * The structure for a multi-signature transaction using Ed25519.
+ */
 type TransactionMultiEd25519Signature = {
     type: "multi_ed25519_signature";
     /**
@@ -663,6 +867,9 @@ type TransactionMultiEd25519Signature = {
     threshold: number;
     bitmap: string;
 };
+/**
+ * The structure for a multi-agent signature in a transaction.
+ */
 type TransactionMultiAgentSignature = {
     type: "multi_agent_signature";
     sender: AccountSignature;
@@ -675,6 +882,9 @@ type TransactionMultiAgentSignature = {
      */
     secondary_signers: Array<AccountSignature>;
 };
+/**
+ * The signature of the fee payer in a transaction.
+ */
 type TransactionFeePayerSignature = {
     type: "fee_payer_signature";
     sender: AccountSignature;
@@ -690,20 +900,32 @@ type TransactionFeePayerSignature = {
     fee_payer_signer: AccountSignature;
 };
 /**
- * The union of all single account signatures.
+ * The union of all single account signatures, including Ed25519, Secp256k1, and MultiEd25519 signatures.
  */
 type AccountSignature = TransactionEd25519Signature | TransactionSecp256k1Signature | TransactionMultiEd25519Signature;
 type WriteSet = ScriptWriteSet | DirectWriteSet;
+/**
+ * The set of properties for writing scripts, including the type of script.
+ */
 type ScriptWriteSet = {
     type: string;
     execute_as: string;
     script: ScriptPayloadResponse;
 };
+/**
+ * The set of direct write operations, identified by a type string.
+ */
 type DirectWriteSet = {
     type: string;
     changes: Array<WriteSetChange>;
     events: Array<Event>;
 };
+/**
+ * The structure for an event's unique identifier, including its creation number.
+ */
+/**
+ * The structure for an event, identified by a unique GUID.
+ */
 type EventGuid = {
     creation_number: string;
     account_address: string;
@@ -718,23 +940,54 @@ type Event = {
     data: any;
 };
 /**
- * Map of Move types to local TypeScript types
+ * A number representing a Move uint8 type.
  */
 type MoveUint8Type = number;
+/**
+ * A 16-bit unsigned integer used in the Move programming language.
+ */
 type MoveUint16Type = number;
+/**
+ * A 32-bit unsigned integer type used in Move programming.
+ */
 type MoveUint32Type = number;
+/**
+ * A string representation of a 64-bit unsigned integer used in Move programming.
+ */
 type MoveUint64Type = string;
+/**
+ * A string representing a 128-bit unsigned integer in the Move programming language.
+ */
 type MoveUint128Type = string;
+/**
+ * A string representation of a 256-bit unsigned integer used in Move programming.
+ */
 type MoveUint256Type = string;
+/**
+ * A string representing a Move address.
+ */
 type MoveAddressType = string;
+/**
+ * The type for identifying objects to be moved within the system.
+ */
 type MoveObjectType = string;
+/**
+ * The type for move options, which can be a MoveType, null, or undefined.
+ */
 type MoveOptionType = MoveType | null | undefined;
 /**
- * This is the format for a fully qualified struct, resource, or entry function in Move.
+ * A structure representing a move with a name.
  */
 type MoveStructId = `${string}::${string}::${string}`;
+/**
+ * The move function containing its name. Same as MoveStructId since it reads weird to take a StructId for a Function.
+ */
 type MoveFunctionId = MoveStructId;
 type MoveStructType = {};
+/**
+ * A union type that encompasses various data types used in Move, including primitive types, address types, object types, and
+ * arrays of MoveType.
+ */
 type MoveType = boolean | string | MoveUint8Type | MoveUint16Type | MoveUint32Type | MoveUint64Type | MoveUint128Type | MoveUint256Type | MoveAddressType | MoveObjectType | MoveStructType | Array<MoveType>;
 /**
  * Possible Move values acceptable by move functions (entry, view)
@@ -761,12 +1014,12 @@ type MoveType = boolean | string | MoveUint8Type | MoveUint16Type | MoveUint32Ty
  */
 type MoveValue = boolean | string | MoveUint8Type | MoveUint16Type | MoveUint32Type | MoveUint64Type | MoveUint128Type | MoveUint256Type | MoveAddressType | MoveObjectType | MoveStructId | MoveOptionType | Array<MoveValue>;
 /**
- * Move module id is a string representation of Move module.
- * Module name is case-sensitive.
+ * A string representation of a Move module, formatted as `module_name::function_name`.
+ * Module names are case-sensitive.
  */
 type MoveModuleId = `${string}::${string}`;
 /**
- * Move function visibility
+ * Specifies the visibility levels for move functions, controlling access permissions.
  */
 declare enum MoveFunctionVisibility {
     PRIVATE = "private",
@@ -774,7 +1027,7 @@ declare enum MoveFunctionVisibility {
     FRIEND = "friend"
 }
 /**
- * Move function ability
+ * Abilities related to moving items within the system.
  */
 declare enum MoveAbility {
     STORE = "store",
@@ -783,13 +1036,13 @@ declare enum MoveAbility {
     COPY = "copy"
 }
 /**
- * Move abilities tied to the generic type param and associated with the function that uses it
+ * Move abilities associated with the generic type parameter of a function.
  */
 type MoveFunctionGenericTypeParam = {
     constraints: Array<MoveAbility>;
 };
 /**
- * Move struct field
+ * A field in a Move struct, identified by its name.
  */
 type MoveStructField = {
     name: string;
@@ -869,10 +1122,16 @@ type MoveFunction = {
      */
     return: Array<string>;
 };
+/**
+ * Roles that can be assigned within the system, indicating different levels of access and functionality.
+ */
 declare enum RoleType {
     VALIDATOR = "validator",
     FULL_NODE = "full_node"
 }
+/**
+ * Information about the current blockchain ledger, including its chain ID.
+ */
 type LedgerInfo = {
     /**
      * Chain ID of the current chain
@@ -906,7 +1165,7 @@ type Block = {
     transactions?: Array<TransactionResponse>;
 };
 /**
- * Table Item request for the GetTableItem API
+ * The request payload for the GetTableItem API.
  */
 type TableItemRequest = {
     key_type: MoveValue;
@@ -917,11 +1176,12 @@ type TableItemRequest = {
     key: any;
 };
 /**
- * A list of Authentication Key schemes that are supported by Aptos.
- *
- * They are combinations of signing schemes and derive schemes.
+ * A list of supported Authentication Key schemes in Aptos, consisting of combinations of signing schemes and derive schemes.
  */
 type AuthenticationKeyScheme = SigningScheme | DeriveScheme;
+/**
+ * Different schemes for signing keys used in cryptographic operations.
+ */
 declare enum SigningScheme {
     /**
      * For Ed25519PublicKey
@@ -937,6 +1197,9 @@ declare enum SigningScheme {
     SingleKey = 2,
     MultiKey = 3
 }
+/**
+ * Specifies the signing schemes available for cryptographic operations.
+ */
 declare enum SigningSchemeInput {
     /**
      * For Ed25519PublicKey
@@ -948,7 +1211,7 @@ declare enum SigningSchemeInput {
     Secp256k1Ecdsa = 2
 }
 /**
- * Scheme used for deriving account addresses from other data
+ * Specifies the schemes for deriving account addresses from various data sources.
  */
 declare enum DeriveScheme {
     /**
@@ -973,7 +1236,7 @@ declare enum DeriveScheme {
     DeriveResourceAccountAddress = 255
 }
 /**
- * Option properties to pass for waitForTransaction() function
+ * Options for configuring the behavior of the waitForTransaction() function.
  */
 type WaitForTransactionOptions = {
     timeoutSecs?: number;
@@ -981,16 +1244,14 @@ type WaitForTransactionOptions = {
     waitForIndexer?: boolean;
 };
 /**
- * Input type to generate an account using Single Signer
- * Ed25519 or Legacy Ed25519
+ * Input type to generate an account using the Ed25519 signing scheme.
  */
 type GenerateAccountWithEd25519 = {
     scheme: SigningSchemeInput.Ed25519;
     legacy: boolean;
 };
 /**
- * Input type to generate an account using Single Signer
- * Secp256k1
+ * Input type to generate an account with a Single Signer using Secp256k1.
  */
 type GenerateAccountWithSingleSignerSecp256k1Key = {
     scheme: SigningSchemeInput.Secp256k1Ecdsa;