@aptos-labs/ts-sdk 1.29.1 → 1.30.0

package/src/transactions/types.ts

@@ -23,7 +23,7 @@ import { MultiAgentTransaction } from "./instances/multiAgentTransaction";
 import { Serialized } from "../bcs";
 
 /**
- * Entry function arguments to be used when building a raw transaction using remote ABI
+ * Entry function arguments for building a raw transaction using remote ABI, supporting various data types including primitives and arrays.
  */
 export type SimpleEntryFunctionArgumentTypes =
   | boolean
@@ -37,7 +37,7 @@ export type SimpleEntryFunctionArgumentTypes =
   | Array<SimpleEntryFunctionArgumentTypes | EntryFunctionArgumentTypes>;
 
 /**
- * Entry function arguments to be used when building a raw transaction using BCS serialized arguments
+ * Entry function arguments for building a raw transaction using BCS serialized arguments.
  */
 export type EntryFunctionArgumentTypes =
   | Bool
@@ -54,7 +54,7 @@ export type EntryFunctionArgumentTypes =
   | FixedBytes;
 
 /**
- * Script function arguments to be used when building a raw transaction using BCS serialized arguments
+ * Script function arguments for building raw transactions using BCS serialized arguments.
  */
 export type ScriptFunctionArgumentTypes =
   | Bool
@@ -71,8 +71,10 @@ export type ScriptFunctionArgumentTypes =
   | Serialized;
 
 /**
- * TypeArgument inputs for Entry functions, view functions, and scripts
+ * Inputs for Entry functions, view functions, and scripts, which can be a string representation of various types including
+ * primitive types, vectors, and structured types.
  *
+ *  *
  * This can be a string version of the type argument such as:
  * - u8
  * - u16
@@ -90,14 +92,14 @@ export type ScriptFunctionArgumentTypes =
 export type TypeArgument = TypeTag | string;
 
 /**
- * Type that holds all raw transaction instances Aptos SDK supports
+ * Holds all return interfaces for generating different transaction types.
  */
 export type AnyRawTransactionInstance = RawTransaction | MultiAgentRawTransaction | FeePayerRawTransaction;
 
 // TRANSACTION GENERATION TYPES //
 
 /**
- * Optional options to set when generating a transaction
+ * Optional options to set when generating a transaction, including a maximum gas amount.
  */
 export type InputGenerateTransactionOptions = {
   maxGasAmount?: number;
@@ -107,7 +109,8 @@ export type InputGenerateTransactionOptions = {
 };
 
 /**
- * The generated transaction payload type that was produces from `generateTransactionPayload()` function.
+ * The transaction payload type generated from the `generateTransactionPayload()` function, which can be an entry function,
+ * script, or multi-signature payload.
  */
 export type AnyTransactionPayloadInstance =
   | TransactionPayloadEntryFunction
@@ -115,18 +118,21 @@ export type AnyTransactionPayloadInstance =
   | TransactionPayloadMultiSig;
 
 /**
- * Unified type for the data needed to generate a transaction payload of types:
- * Entry Function | Script | Multi Sig
+ * The data needed to generate a transaction payload for Entry Function, Script, or Multi Sig types.
  */
 export type InputGenerateTransactionPayloadData = InputEntryFunctionData | InputScriptData | InputMultiSigData;
 
+/**
+ * The payload for generating a transaction, which can be either script data, entry function data with remote ABI, or
+ * multi-signature data.
+ */
 export type InputGenerateTransactionPayloadDataWithRemoteABI =
   | InputScriptData
   | InputEntryFunctionDataWithRemoteABI
   | InputMultiSigDataWithRemoteABI;
 
 /**
- * The data needed to generate an Entry Function payload
+ * The data needed to generate an Entry Function payload.
  */
 export type InputEntryFunctionData = {
   function: MoveFunctionId;
@@ -135,16 +141,28 @@ export type InputEntryFunctionData = {
   abi?: EntryFunctionABI;
 };
 
+/**
+ * The payload for generating a transaction, which can be either an entry function or a multi-signature transaction.
+ */
 export type InputGenerateTransactionPayloadDataWithABI = InputEntryFunctionDataWithABI | InputMultiSigDataWithABI;
 
+/**
+ * The input data for an entry function, including its associated ABI.
+ */
 export type InputEntryFunctionDataWithABI = Omit<InputEntryFunctionData, "abi"> & {
   abi: EntryFunctionABI;
 };
 
+/**
+ * The data needed to generate a Multi Sig payload, including the multisig address.
+ */
 export type InputMultiSigDataWithABI = {
   multisigAddress: AccountAddressInput;
 } & InputEntryFunctionDataWithABI;
 
+/**
+ * Combines input function data with Aptos configuration for remote ABI interactions.
+ */
 export type InputEntryFunctionDataWithRemoteABI = InputEntryFunctionData & { aptosConfig: AptosConfig };
 /**
  * The data needed to generate a Multi Sig payload
@@ -154,14 +172,14 @@ export type InputMultiSigData = {
 } & InputEntryFunctionData;
 
 /**
- * The data needed to generate a Multi Sig payload
+ * The data needed to generate a Multi Sig payload, including the multisig address.
  */
 export type InputMultiSigDataWithRemoteABI = {
   multisigAddress: AccountAddressInput;
 } & InputEntryFunctionDataWithRemoteABI;
 
 /**
- * The data needed to generate a Script payload
+ * The data needed to generate a Script payload.
  */
 export type InputScriptData = {
   bytecode: HexInput;
@@ -170,7 +188,7 @@ export type InputScriptData = {
 };
 
 /**
- * The data needed to generate a View Function payload
+ * The data needed to generate a View Function payload.
  */
 export type InputViewFunctionData = {
   function: MoveFunctionId;
@@ -180,7 +198,7 @@ export type InputViewFunctionData = {
 };
 
 /**
- * The data needed to generate a View Function payload in JSON
+ * The data needed to generate a View Function payload in JSON format.
  */
 export type InputViewFunctionJsonData = {
   function: MoveFunctionId;
@@ -189,7 +207,7 @@ export type InputViewFunctionJsonData = {
 };
 
 /**
- *  Payload sent to the fullnode for a JSON view request
+ * The payload sent to the fullnode for a JSON view request.
  */
 export type ViewFunctionJsonPayload = {
   function: MoveFunctionId;
@@ -198,17 +216,17 @@ export type ViewFunctionJsonPayload = {
 };
 
 /**
- * Data needed to generate a view function payload and fetch the remote ABI
+ * Data required to create a view function payload and retrieve the remote ABI, including Aptos configuration.
  */
 export type InputViewFunctionDataWithRemoteABI = InputViewFunctionData & { aptosConfig: AptosConfig };
 
 /**
- * Data needed to generate a view function, with an already fetched ABI
+ * Data needed to generate a view function, including the fetched ABI.
  */
 export type InputViewFunctionDataWithABI = InputViewFunctionData & { abi: ViewFunctionABI };
 
 /**
- * Data need for a generic function ABI, both view and entry
+ * Data needed for a generic function ABI, applicable to both view and entry functions.
  */
 export type FunctionABI = {
   typeParameters: Array<MoveFunctionGenericTypeParam>;
@@ -216,26 +234,27 @@ export type FunctionABI = {
 };
 
 /**
- * Interface of an Entry function's ABI.
- *
- * This is used to provide type checking and simple input conversion on ABI based transaction submission.
+ * Interface for an Entry function's ABI, enabling type checking and input conversion for ABI-based transaction submissions.
  */
 export type EntryFunctionABI = FunctionABI & {
   signers?: number;
 };
 
 /**
- * Interface of an View function's ABI.
- *
- * This is used to provide type checking and simple input conversion on ABI based transaction submission.
+ * Interface for a view function's ABI, providing type checking and input conversion for ABI-based transaction submissions.
  */
 export type ViewFunctionABI = FunctionABI & {
   returnTypes: Array<TypeTag>;
 };
 
 /**
- * Interface of the arguments to generate a single signer transaction.
- * Used to provide to `generateTransaction()` method in the transaction builder flow
+ * Arguments for generating a single signer raw transaction, used in the transaction builder flow.
+ *
+ * @param aptosConfig - Configuration settings for Aptos.
+ * @param sender - The address of the sender.
+ * @param payload - The transaction payload.
+ * @param options - Optional transaction generation options.
+ * @param feePayerAddress - Optional address of the fee payer.
  */
 export interface InputGenerateSingleSignerRawTransactionArgs {
   aptosConfig: AptosConfig;
@@ -246,8 +265,14 @@ export interface InputGenerateSingleSignerRawTransactionArgs {
 }
 
 /**
- * Interface of the arguments to generate a multi-agent transaction.
- * Used to provide to `generateTransaction()` method in the transaction builder flow
+ * Arguments for generating a multi-agent transaction, used in the `generateTransaction()` method of the transaction builder flow.
+ *
+ * @param aptosConfig - Configuration settings for Aptos.
+ * @param sender - The address of the transaction sender.
+ * @param payload - The transaction payload.
+ * @param secondarySignerAddresses - List of secondary signer addresses.
+ * @param options - Optional settings for transaction generation.
+ * @param feePayerAddress - Optional address of the fee payer.
  */
 export interface InputGenerateMultiAgentRawTransactionArgs {
   aptosConfig: AptosConfig;
@@ -259,7 +284,7 @@ export interface InputGenerateMultiAgentRawTransactionArgs {
 }
 
 /**
- * Unified type that holds all the interfaces to generate different transaction types
+ * A unified type for generating various transaction types.
  */
 export type InputGenerateRawTransactionArgs =
   | InputGenerateSingleSignerRawTransactionArgs
@@ -272,6 +297,9 @@ export type AnyRawTransaction = SimpleTransaction | MultiAgentTransaction;
 
 // TRANSACTION SIMULATION TYPES //
 
+/**
+ * The data required to simulate a transaction, typically generated by `generateTransaction()`.
+ */
 export type InputSimulateTransactionData = {
   /**
    * The transaction to simulate, probably generated by `generateTransaction()`
@@ -292,6 +320,9 @@ export type InputSimulateTransactionData = {
   options?: InputSimulateTransactionOptions;
 };
 
+/**
+ * Options for simulating a transaction input, including whether to estimate the gas unit price.
+ */
 export type InputSimulateTransactionOptions = {
   estimateGasUnitPrice?: boolean;
   estimateMaxGasAmount?: boolean;
@@ -301,7 +332,13 @@ export type InputSimulateTransactionOptions = {
 // USER INPUT TYPES //
 
 /**
- * Interface that holds the user data input when generating a single signer transaction
+ * Holds user input data for generating a single signer transaction.
+ *
+ * @param sender - The address of the account sending the transaction.
+ * @param data - The payload data for the transaction.
+ * @param options - Optional transaction options.
+ * @param withFeePayer - Indicates if the fee payer is included.
+ * @param secondarySignerAddresses - Addresses for any secondary signers (not used in single signer transactions).
  */
 export interface InputGenerateSingleSignerRawTransactionData {
   sender: AccountAddressInput;
@@ -312,7 +349,13 @@ export interface InputGenerateSingleSignerRawTransactionData {
 }
 
 /**
- * Interface that holds the user data input when generating a multi-agent transaction
+ * Holds user data input for generating a multi-agent transaction.
+ *
+ * @param sender - The address of the primary sender.
+ * @param data - The payload data for the transaction.
+ * @param secondarySignerAddresses - An array of addresses for secondary signers.
+ * @param options - Optional transaction options.
+ * @param withFeePayer - Indicates if a fee payer is included.
  */
 export interface InputGenerateMultiAgentRawTransactionData {
   sender: AccountAddressInput;
@@ -323,14 +366,19 @@ export interface InputGenerateMultiAgentRawTransactionData {
 }
 
 /**
- * Unified type that holds all the user data input interfaces when generating different transaction types
+ * Unified type holding user data input interfaces for generating various transaction types.
  */
 export type InputGenerateTransactionData =
   | InputGenerateSingleSignerRawTransactionData
   | InputGenerateMultiAgentRawTransactionData;
 
 /**
- * Interface that holds the user data input when submitting a transaction
+ * Holds user data input for submitting a transaction.
+ *
+ * @param transaction - The raw transaction data.
+ * @param senderAuthenticator - The authenticator for the sender's account.
+ * @param feePayerAuthenticator - Optional authenticator for the fee payer's account.
+ * @param additionalSignersAuthenticators - Optional array of authenticators for additional signers.
  */
 export interface InputSubmitTransactionData {
   transaction: AnyRawTransaction;