@aptos-labs/ts-sdk 1.29.1 → 1.30.0

package/src/internal/transactionSubmission.ts

@@ -84,7 +84,7 @@ export async function generateTransaction(
  * ```
  * {
  *  rawTransaction: RawTransaction,
- *  secondarySignerAddresses? : Array<AccountAddress>,
+ *  secondarySignerAddresses?: Array<AccountAddress>,
  *  feePayerAddress?: AccountAddress
  * }
  * ```
@@ -96,6 +96,16 @@ export async function generateTransaction(
   return buildRawTransaction(args, payload);
 }
 
+/**
+ * Builds a transaction payload based on the provided configuration and input data.
+ * This function is essential for preparing transaction data for execution on the Aptos blockchain.
+ *
+ * @param args - The arguments for building the transaction payload.
+ * @param args.aptosConfig - Configuration settings for the Aptos network.
+ * @param args.data - Input data required to generate the transaction payload, which may include bytecode, multisig address,
+ * function name, function arguments, type arguments, and ABI.
+ * @returns A promise that resolves to the generated transaction payload instance.
+ */
 export async function buildTransactionPayload(
   args: { aptosConfig: AptosConfig } & InputGenerateTransactionData,
 ): Promise<AnyTransactionPayloadInstance> {
@@ -130,6 +140,16 @@ export async function buildTransactionPayload(
   return payload;
 }
 
+/**
+ * Builds a raw transaction based on the provided configuration and payload.
+ * This function helps in creating a transaction that can be sent to the Aptos blockchain.
+ *
+ * @param args - The arguments for generating the transaction.
+ * @param args.aptosConfig - The configuration settings for Aptos.
+ * @param args.sender - The address of the sender of the transaction.
+ * @param args.options - Additional options for the transaction.
+ * @param payload - The payload of the transaction, which defines the action to be performed.
+ */
 export async function buildRawTransaction(
   args: { aptosConfig: AptosConfig } & InputGenerateTransactionData,
   payload: AnyTransactionPayloadInstance,
@@ -162,10 +182,23 @@ export async function buildRawTransaction(
   });
 }
 
+/**
+ * Determine if the transaction input includes a fee payer.
+ *
+ * @param data - The input data for generating a transaction.
+ * @param data.withFeePayer - Indicates whether a fee payer is included in the transaction input.
+ * @returns A boolean value indicating if the transaction input has a fee payer.
+ */
 function isFeePayerTransactionInput(data: InputGenerateTransactionData): boolean {
   return data.withFeePayer === true;
 }
 
+/**
+ * Determines whether the provided transaction input data includes multiple agent signatures.
+ *
+ * @param data - The transaction input data to evaluate.
+ * @param data.secondarySignerAddresses - An array of secondary signer addresses, indicating multiple agents.
+ */
 function isMultiAgentTransactionInput(
   data: InputGenerateTransactionData,
 ): data is InputGenerateMultiAgentRawTransactionData {
@@ -173,13 +206,14 @@ function isMultiAgentTransactionInput(
 }
 
 /**
- * Builds a signing message that can be signed by external signers
+ * Builds a signing message that can be signed by external signers.
  *
- * Note: Please prefer using `signTransaction` unless signing outside the SDK
+ * Note: Please prefer using `signTransaction` unless signing outside the SDK.
  *
- * @param args.transaction AnyRawTransaction, as generated by `generateTransaction()`
+ * @param args - The arguments for generating the signing message.
+ * @param args.transaction - AnyRawTransaction, as generated by `generateTransaction()`.
  *
- * @return The message to be signed
+ * @returns The message to be signed.
  */
 export function getSigningMessage(args: { transaction: AnyRawTransaction }): Uint8Array {
   const { transaction } = args;
@@ -187,19 +221,13 @@ export function getSigningMessage(args: { transaction: AnyRawTransaction }): Uin
 }
 
 /**
- * Sign a transaction that can later be submitted to chain
+ * Sign a transaction that can later be submitted to the chain.
  *
- * @param args.signer The signer account to sign the transaction
- * @param args.transaction An instance of a RawTransaction, plus optional secondary/fee payer addresses
- * ```
- * {
- *  rawTransaction: RawTransaction,
- *  secondarySignerAddresses? : Array<AccountAddress>,
- *  feePayerAddress?: AccountAddress
- * }
- * ```
+ * @param args The arguments for signing the transaction.
+ * @param args.signer The signer account to sign the transaction.
+ * @param args.transaction An instance of a RawTransaction, plus optional secondary/fee payer addresses.
  *
- * @return The signer AccountAuthenticator
+ * @return The signer AccountAuthenticator.
  */
 export function signTransaction(args: { signer: Account; transaction: AnyRawTransaction }): AccountAuthenticator {
   const { signer, transaction } = args;
@@ -209,7 +237,7 @@ export function signTransaction(args: { signer: Account; transaction: AnyRawTran
 export function signAsFeePayer(args: { signer: Account; transaction: AnyRawTransaction }): AccountAuthenticator {
   const { signer, transaction } = args;
 
-  // if transaction doesnt hold a "feePayerAddress" prop it means
+  // if transaction doesn't hold a "feePayerAddress" prop it means
   // this is not a fee payer transaction
   if (!transaction.feePayerAddress) {
     throw new Error(`Transaction ${transaction} is not a Fee Payer transaction`);
@@ -225,13 +253,18 @@ export function signAsFeePayer(args: { signer: Account; transaction: AnyRawTrans
 }
 
 /**
- * Simulates a transaction before singing it.
+ * Simulates a transaction before signing it to evaluate its potential outcome.
  *
- * @param args.signerPublicKey The signer public key
- * @param args.transaction The raw transaction to simulate
- * @param args.secondarySignersPublicKeys optional. For when the transaction is a multi signers transaction
- * @param args.feePayerPublicKey optional. For when the transaction is a fee payer (aka sponsored) transaction
- * @param args.options optional. A config to simulate the transaction with
+ * @param args The arguments for simulating the transaction.
+ * @param args.aptosConfig The configuration for the Aptos network.
+ * @param args.transaction The raw transaction to simulate.
+ * @param args.signerPublicKey The signer public key.
+ * @param args.secondarySignersPublicKeys Optional. For when the transaction involves multiple signers.
+ * @param args.feePayerPublicKey Optional. For when the transaction is sponsored by a fee payer.
+ * @param args.options Optional. A configuration object to customize the simulation process.
+ * @param args.options.estimateGasUnitPrice Optional. Indicates whether to estimate the gas unit price.
+ * @param args.options.estimateMaxGasAmount Optional. Indicates whether to estimate the maximum gas amount.
+ * @param args.options.estimatePrioritizedGasUnitPrice Optional. Indicates whether to estimate the prioritized gas unit price.
  */
 export async function simulateTransaction(
   args: { aptosConfig: AptosConfig } & InputSimulateTransactionData,
@@ -262,13 +295,15 @@ export async function simulateTransaction(
 }
 
 /**
- * Submit transaction to chain
+ * Submit a transaction to the Aptos blockchain.
  *
- * @param args.transaction A aptos transaction type
- * @param args.senderAuthenticator The account authenticator of the transaction sender
- * @param args.secondarySignerAuthenticators optional. For when the transaction is a multi signers transaction
+ * @param args - The arguments for submitting the transaction.
+ * @param args.aptosConfig - The configuration for connecting to the Aptos network.
+ * @param args.transaction - The Aptos transaction data to be submitted.
+ * @param args.senderAuthenticator - The account authenticator of the transaction sender.
+ * @param args.secondarySignerAuthenticators - Optional. Authenticators for additional signers in a multi-signer transaction.
  *
- * @return PendingTransactionResponse
+ * @returns PendingTransactionResponse - The response containing the status of the submitted transaction.
  */
 export async function submitTransaction(
   args: {
@@ -300,7 +335,7 @@ export async function signAndSubmitTransaction(
 ): Promise<PendingTransactionResponse> {
   const { aptosConfig, signer, feePayer, transaction } = args;
   // If the signer contains a KeylessAccount, await proof fetching in case the proof
-  // was fetched asyncronously.
+  // was fetched asynchronously.
   if (signer instanceof AbstractKeylessAccount || signer instanceof MultiKeyAccount) {
     await signer.waitForProofFetch();
   }
@@ -346,6 +381,17 @@ const packagePublishAbi: EntryFunctionABI = {
   parameters: [TypeTagVector.u8(), new TypeTagVector(TypeTagVector.u8())],
 };
 
+/**
+ * Publishes a package transaction to the Aptos blockchain.
+ * This function allows you to create and send a transaction that publishes a package with the specified metadata and bytecode.
+ *
+ * @param args - The arguments for the package transaction.
+ * @param args.aptosConfig - The configuration settings for the Aptos client.
+ * @param args.account - The address of the account sending the transaction.
+ * @param args.metadataBytes - The metadata associated with the package, represented as hexadecimal input.
+ * @param args.moduleBytecode - An array of module bytecode, each represented as hexadecimal input.
+ * @param args.options - Optional parameters for generating the transaction.
+ */
 export async function publicPackageTransaction(args: {
   aptosConfig: AptosConfig;
   account: AccountAddressInput;
@@ -382,7 +428,17 @@ const rotateAuthKeyAbi: EntryFunctionABI = {
 };
 
 /**
- * TODO: Need to refactor and move this function out of transactionSubmission
+ * Rotates the authentication key for a given account, allowing for enhanced security and management of account access.
+ *
+ * @param args - The arguments for rotating the authentication key.
+ * @param args.aptosConfig - The configuration settings for the Aptos network.
+ * @param args.fromAccount - The account from which the authentication key will be rotated.
+ * @param args.toNewPrivateKey - The new private key that will be associated with the account.
+ *
+ * @remarks
+ * This function requires the current authentication key and the new private key to sign a challenge that validates the rotation.
+ *
+ * TODO: Need to refactor and move this function out of transactionSubmission.
  */
 export async function rotateAuthKey(args: {
   aptosConfig: AptosConfig;

package/src/transactions/authenticator/account.ts

@@ -10,9 +10,22 @@ import { MultiEd25519PublicKey, MultiEd25519Signature } from "../../core/crypto/
 import { MultiKey, MultiKeySignature } from "../../core/crypto/multiKey";
 import { AccountAuthenticatorVariant } from "../../types";
 
+/**
+ * Represents an account authenticator that can handle multiple authentication variants.
+ * This class serves as a base for different types of account authenticators, allowing for serialization
+ * and deserialization of various authenticator types.
+ *
+ * @extends Serializable
+ */
 export abstract class AccountAuthenticator extends Serializable {
   abstract serialize(serializer: Serializer): void;
 
+  /**
+   * Deserializes an AccountAuthenticator from the provided deserializer.
+   * This function helps in reconstructing the AccountAuthenticator object based on the variant index.
+   *
+   * @param deserializer - The deserializer instance used to read the serialized data.
+   */
   static deserialize(deserializer: Deserializer): AccountAuthenticator {
     const index = deserializer.deserializeUleb128AsU32();
     switch (index) {
@@ -29,47 +42,85 @@ export abstract class AccountAuthenticator extends Serializable {
     }
   }
 
+  /**
+   * Determines if the current instance is an Ed25519 account authenticator.
+   *
+   * @returns {boolean} True if the instance is of type AccountAuthenticatorEd25519, otherwise false.
+   */
   isEd25519(): this is AccountAuthenticatorEd25519 {
     return this instanceof AccountAuthenticatorEd25519;
   }
 
+  /**
+   * Determines if the current instance is of type AccountAuthenticatorMultiEd25519.
+   *
+   * @returns {boolean} True if the instance is a multi-signature Ed25519 account authenticator, otherwise false.
+   */
   isMultiEd25519(): this is AccountAuthenticatorMultiEd25519 {
     return this instanceof AccountAuthenticatorMultiEd25519;
   }
 
+  /**
+   * Determines if the current instance is of the type AccountAuthenticatorSingleKey.
+   *
+   * @returns {boolean} True if the instance is an AccountAuthenticatorSingleKey, otherwise false.
+   */
   isSingleKey(): this is AccountAuthenticatorSingleKey {
     return this instanceof AccountAuthenticatorSingleKey;
   }
 
+  /**
+   * Determine if the current instance is of type AccountAuthenticatorMultiKey.
+   *
+   * @returns {boolean} Returns true if the instance is an AccountAuthenticatorMultiKey, otherwise false.
+   */
   isMultiKey(): this is AccountAuthenticatorMultiKey {
     return this instanceof AccountAuthenticatorMultiKey;
   }
 }
 
 /**
- * Transaction authenticator Ed25519 for a multi signer transaction
- *
- * @param public_key Account's Ed25519 public key.
- * @param signature Account's Ed25519 signature
+ * Represents an Ed25519 transaction authenticator for multi-signer transactions.
+ * This class encapsulates the account's Ed25519 public key and signature.
  *
+ * @param public_key - The Ed25519 public key associated with the account.
+ * @param signature - The Ed25519 signature for the account.
  */
 export class AccountAuthenticatorEd25519 extends AccountAuthenticator {
   public readonly public_key: Ed25519PublicKey;
 
   public readonly signature: Ed25519Signature;
 
+  /**
+   * Creates an instance of the class with the specified public keys and signatures.
+   *
+   * @param public_key The public key used for verification.
+   * @param signature The signatures corresponding to the public keys.
+   */
   constructor(public_key: Ed25519PublicKey, signature: Ed25519Signature) {
     super();
     this.public_key = public_key;
     this.signature = signature;
   }
 
+  /**
+   * Serializes the account authenticator data into the provided serializer.
+   * This function captures the multi-key variant, public keys, and signatures for serialization.
+   *
+   * @param serializer - The serializer instance used to perform the serialization.
+   */
   serialize(serializer: Serializer): void {
     serializer.serializeU32AsUleb128(AccountAuthenticatorVariant.Ed25519);
     this.public_key.serialize(serializer);
     this.signature.serialize(serializer);
   }
 
+  /**
+   * Loads an instance of AccountAuthenticatorMultiKey from the provided deserializer.
+   * This function helps in reconstructing the authenticator object using the deserialized public keys and signatures.
+   *
+   * @param deserializer - The deserializer used to extract the necessary data for loading the authenticator.
+   */
   static load(deserializer: Deserializer): AccountAuthenticatorEd25519 {
     const public_key = Ed25519PublicKey.deserialize(deserializer);
     const signature = Ed25519Signature.deserialize(deserializer);
@@ -78,11 +129,10 @@ export class AccountAuthenticatorEd25519 extends AccountAuthenticator {
 }
 
 /**
- * Transaction authenticator Multi Ed25519 for a multi signers transaction
- *
- * @param public_key Account's MultiEd25519 public key.
- * @param signature Account's MultiEd25519 signature
+ * Represents a transaction authenticator for Multi Ed25519, designed for multi-signer transactions.
  *
+ * @param public_key - The MultiEd25519 public key of the account.
+ * @param signature - The MultiEd25519 signature of the account.
  */
 export class AccountAuthenticatorMultiEd25519 extends AccountAuthenticator {
   public readonly public_key: MultiEd25519PublicKey;
@@ -109,11 +159,11 @@ export class AccountAuthenticatorMultiEd25519 extends AccountAuthenticator {
 }
 
 /**
- * AccountAuthenticatorSingleKey for a single signer
- *
- * @param public_key AnyPublicKey
- * @param signature AnySignature
+ * Represents an account authenticator that utilizes a single key for signing.
+ * This class is designed to handle authentication using a public key and its corresponding signature.
  *
+ * @param public_key - The public key used for authentication.
+ * @param signature - The signature associated with the public key.
  */
 export class AccountAuthenticatorSingleKey extends AccountAuthenticator {
   public readonly public_key: AnyPublicKey;
@@ -140,11 +190,10 @@ export class AccountAuthenticatorSingleKey extends AccountAuthenticator {
 }
 
 /**
- * AccountAuthenticatorMultiKey for a multi signer
- *
- * @param public_keys MultiKey
- * @param signatures Signature
+ * Represents an account authenticator that supports multiple keys and signatures for multi-signature scenarios.
  *
+ * @param public_keys - The public keys used for authentication.
+ * @param signatures - The signatures corresponding to the public keys.
  */
 export class AccountAuthenticatorMultiKey extends AccountAuthenticator {
   public readonly public_keys: MultiKey;

package/src/transactions/authenticator/transaction.ts

@@ -10,9 +10,21 @@ import { Ed25519PublicKey, Ed25519Signature } from "../../core/crypto/ed25519";
 import { MultiEd25519PublicKey, MultiEd25519Signature } from "../../core/crypto/multiEd25519";
 import { TransactionAuthenticatorVariant } from "../../types";
 
+/**
+ * Represents an abstract base class for transaction authenticators.
+ * This class provides methods for serializing and deserializing different types of transaction authenticators.
+ *
+ * @extends Serializable
+ */
 export abstract class TransactionAuthenticator extends Serializable {
   abstract serialize(serializer: Serializer): void;
 
+  /**
+   * Deserializes a TransactionAuthenticator from the provided deserializer.
+   * This function helps in reconstructing the TransactionAuthenticator based on the variant index found in the serialized data.
+   *
+   * @param deserializer - The deserializer instance used to read the serialized data.
+   */
   static deserialize(deserializer: Deserializer): TransactionAuthenticator {
     const index = deserializer.deserializeUleb128AsU32();
     switch (index) {
@@ -33,10 +45,11 @@ export abstract class TransactionAuthenticator extends Serializable {
 }
 
 /**
- * Transaction authenticator Ed25519 for a single signer transaction
+ * Represents a transaction authenticator using Ed25519 for a single signer transaction.
+ * This class encapsulates the client's public key and the Ed25519 signature of a raw transaction.
  *
- * @param public_key Client's public key.
- * @param signature Ed25519 signature of a raw transaction.
+ * @param public_key - The client's public key.
+ * @param signature - The Ed25519 signature of a raw transaction.
  * @see {@link https://aptos.dev/integration/creating-a-signed-transaction | Creating a Signed Transaction}
  * for details about generating a signature.
  */
@@ -45,18 +58,35 @@ export class TransactionAuthenticatorEd25519 extends TransactionAuthenticator {
 
   public readonly signature: Ed25519Signature;
 
+  /**
+   * Creates an instance of the class with the specified account authenticator.
+   *
+   * @param public_key - The Ed25519PublicKey that will be used for authentication.
+   * @param signature - The Ed25519Signature that will be used for authentication.
+   */
   constructor(public_key: Ed25519PublicKey, signature: Ed25519Signature) {
     super();
     this.public_key = public_key;
     this.signature = signature;
   }
 
+  /**
+   * Serializes the transaction authenticator by encoding the sender information.
+   *
+   * @param serializer - The serializer instance used to perform the serialization.
+   */
   serialize(serializer: Serializer): void {
     serializer.serializeU32AsUleb128(TransactionAuthenticatorVariant.Ed25519);
     this.public_key.serialize(serializer);
     this.signature.serialize(serializer);
   }
 
+  /**
+   * Loads a TransactionAuthenticatorSingleSender instance from the provided deserializer.
+   * This function helps in deserializing the sender information to create a transaction authenticator.
+   *
+   * @param deserializer - The deserializer used to extract the sender data.
+   */
   static load(deserializer: Deserializer): TransactionAuthenticatorEd25519 {
     const public_key = Ed25519PublicKey.deserialize(deserializer);
     const signature = Ed25519Signature.deserialize(deserializer);
@@ -65,11 +95,11 @@ export class TransactionAuthenticatorEd25519 extends TransactionAuthenticator {
 }
 
 /**
- * Transaction authenticator Ed25519 for a multi signers transaction
- *
- * @param public_key Client's public key.
- * @param signature Multi Ed25519 signature of a raw transaction.
+ * Represents a transaction authenticator for multi-signature transactions using Ed25519.
+ * This class is used to validate transactions that require multiple signatures from different signers.
  *
+ * @param public_key - The public key of the client involved in the transaction.
+ * @param signature - The multi-signature of the raw transaction.
  */
 export class TransactionAuthenticatorMultiEd25519 extends TransactionAuthenticator {
   public readonly public_key: MultiEd25519PublicKey;
@@ -96,12 +126,13 @@ export class TransactionAuthenticatorMultiEd25519 extends TransactionAuthenticat
 }
 
 /**
- * Transaction authenticator for a multi-agent transaction
+ * Represents a transaction authenticator for a multi-agent transaction.
  *
- * @param sender Sender account authenticator
- * @param secondary_signer_addresses Secondary signers address
- * @param secondary_signers Secondary signers account authenticators
+ * This class manages the authentication process involving a primary sender and multiple secondary signers.
  *
+ * @param sender - The authenticator for the sender account.
+ * @param secondary_signer_addresses - An array of addresses for the secondary signers.
+ * @param secondary_signers - An array of authenticators for the secondary signer accounts.
  */
 export class TransactionAuthenticatorMultiAgent extends TransactionAuthenticator {
   public readonly sender: AccountAuthenticator;
@@ -137,13 +168,14 @@ export class TransactionAuthenticatorMultiAgent extends TransactionAuthenticator
 }
 
 /**
- * Transaction authenticator for a fee payer transaction
- *
- * @param sender Sender account authenticator
- * @param secondary_signer_addresses Secondary signers address
- * @param secondary_signers Secondary signers account authenticators
- * @param fee_payer Object of the fee payer account address and the fee payer authentication
+ * Represents a transaction authenticator specifically for fee payer transactions.
+ * It encapsulates the sender's account authenticator, addresses of secondary signers,
+ * their respective authenticators, and the fee payer's account information.
  *
+ * @param sender - The authenticator for the sender's account.
+ * @param secondary_signer_addresses - An array of addresses for secondary signers.
+ * @param secondary_signers - An array of authenticators for secondary signers' accounts.
+ * @param fee_payer - An object containing the fee payer's account address and authenticator.
  */
 export class TransactionAuthenticatorFeePayer extends TransactionAuthenticator {
   public readonly sender: AccountAuthenticator;
@@ -191,9 +223,10 @@ export class TransactionAuthenticatorFeePayer extends TransactionAuthenticator {
 }
 
 /**
- * Single Sender authenticator for a single signer transaction
+ * Represents a single sender authenticator for transactions that require a single signer.
+ * This class is responsible for managing the authentication of a transaction initiated by a single sender.
  *
- * @param sender AccountAuthenticator
+ * @param sender - An instance of AccountAuthenticator that represents the account of the sender.
  */
 export class TransactionAuthenticatorSingleSender extends TransactionAuthenticator {
   public readonly sender: AccountAuthenticator;

package/src/transactions/instances/chainId.ts

@@ -5,20 +5,39 @@ import { Serializer, Serializable } from "../../bcs/serializer";
 import { Deserializer } from "../../bcs/deserializer";
 
 /**
- * Representation of a ChainId that can serialized and deserialized
+ * Represents a ChainId that can be serialized and deserialized.
+ *
+ * @extends Serializable
  */
 export class ChainId extends Serializable {
   public readonly chainId: number;
 
+  /**
+   * Initializes a new instance of the class with the specified chain ID.
+   *
+   * @param chainId - The ID of the blockchain network to be used.
+   */
   constructor(chainId: number) {
     super();
     this.chainId = chainId;
   }
 
+  /**
+   * Serializes the current object using the provided serializer.
+   * This function helps in converting the object into a format suitable for transmission or storage.
+   *
+   * @param serializer - The serializer instance used to perform the serialization.
+   */
   serialize(serializer: Serializer): void {
     serializer.serializeU8(this.chainId);
   }
 
+  /**
+   * Deserializes a ChainId from the provided deserializer.
+   * This function allows you to reconstruct a ChainId object from serialized data.
+   *
+   * @param deserializer - The deserializer instance used to read the serialized data.
+   */
   static deserialize(deserializer: Deserializer): ChainId {
     const chainId = deserializer.deserializeU8();
     return new ChainId(chainId);

package/src/transactions/instances/identifier.ts

@@ -5,22 +5,40 @@ import { Deserializer } from "../../bcs/deserializer";
 import { Serializable, Serializer } from "../../bcs/serializer";
 
 /**
- * Representation of an Identifier that can serialized and deserialized.
- * We use Identifier to represent the module "name" in "ModuleId" and
- * the "function name" in "EntryFunction"
+ * Represents an Identifier that can be serialized and deserialized.
+ * This class is used to denote the module "name" in "ModuleId" and
+ * the "function name" in "EntryFunction".
+ *
+ * @extends Serializable
  */
 export class Identifier extends Serializable {
   public identifier: string;
 
+  /**
+   * Creates an instance of the class with a specified identifier.
+   *
+   * @param identifier - The unique identifier for the instance.
+   */
   constructor(identifier: string) {
     super();
     this.identifier = identifier;
   }
 
+  /**
+   * Serializes the identifier of the current instance using the provided serializer.
+   *
+   * @param serializer - The serializer instance used to perform the serialization.
+   */
   public serialize(serializer: Serializer): void {
     serializer.serializeStr(this.identifier);
   }
 
+  /**
+   * Deserializes an identifier from the provided deserializer.
+   * This function is useful for reconstructing an Identifier object from a serialized format.
+   *
+   * @param deserializer - The deserializer instance used to read the serialized data.
+   */
   static deserialize(deserializer: Deserializer): Identifier {
     const identifier = deserializer.deserializeStr();
     return new Identifier(identifier);

package/src/transactions/instances/moduleId.ts

@@ -8,8 +8,8 @@ import { Identifier } from "./identifier";
 import { MoveModuleId } from "../../types";
 
 /**
- * Representation of a ModuleId that can serialized and deserialized
- * ModuleId means the module address (e.g "0x1") and the module name (e.g "coin")
+ * Represents a ModuleId that can be serialized and deserialized.
+ * A ModuleId consists of a module address (e.g., "0x1") and a module name (e.g., "coin").
  */
 export class ModuleId extends Serializable {
   public readonly address: AccountAddress;
@@ -17,9 +17,10 @@ export class ModuleId extends Serializable {
   public readonly name: Identifier;
 
   /**
-   * Full name of a module.
-   * @param address The account address. e.g "0x1"
-   * @param name The module name under the "address". e.g "coin"
+   * Initializes a new instance of the module with the specified account address and name.
+   *
+   * @param address - The account address, e.g., "0x1".
+   * @param name - The module name under the specified address, e.g., "coin".
    */
   constructor(address: AccountAddress, name: Identifier) {
     super();
@@ -28,9 +29,10 @@ export class ModuleId extends Serializable {
   }
 
   /**
-   * Converts a string literal to a ModuleId
-   * @param moduleId String literal in format "account_address::module_name", e.g. "0x1::coin"
-   * @returns ModuleId
+   * Converts a string literal in the format "account_address::module_name" to a ModuleId.
+   * @param moduleId - A string literal representing the module identifier.
+   * @throws Error if the provided moduleId is not in the correct format.
+   * @returns ModuleId - The corresponding ModuleId object.
    */
   static fromStr(moduleId: MoveModuleId): ModuleId {
     const parts = moduleId.split("::");
@@ -40,11 +42,23 @@ export class ModuleId extends Serializable {
     return new ModuleId(AccountAddress.fromString(parts[0]), new Identifier(parts[1]));
   }
 
+  /**
+   * Serializes the address and name properties using the provided serializer.
+   * This function is essential for converting the object's data into a format suitable for transmission or storage.
+   *
+   * @param serializer - The serializer instance used to perform the serialization.
+   */
   serialize(serializer: Serializer): void {
     this.address.serialize(serializer);
     this.name.serialize(serializer);
   }
 
+  /**
+   * Deserializes a ModuleId from the provided deserializer.
+   * This function retrieves the account address and identifier to construct a ModuleId instance.
+   *
+   * @param deserializer - The deserializer instance used to read the data.
+   */
   static deserialize(deserializer: Deserializer): ModuleId {
     const address = AccountAddress.deserialize(deserializer);
     const name = Identifier.deserialize(deserializer);