@aptos-labs/ts-sdk 1.29.0-zeta.0 → 1.29.0-zeta.2

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);

package/src/transactions/instances/multiAgentTransaction.ts

@@ -9,7 +9,12 @@ import { AccountAddress } from "../../core";
 import { RawTransaction } from "./rawTransaction";
 
 /**
- * Representation of a Raw Transaction that can serialized and deserialized
+ * Represents a multi-agent transaction that can be serialized and deserialized.
+ * This transaction includes a raw transaction, optional fee payer address, and multiple secondary signer addresses.
+ *
+ * @param rawTransaction The raw transaction to be executed.
+ * @param secondarySignerAddresses An array of secondary signer addresses involved in the transaction.
+ * @param feePayerAddress An optional account address that sponsors the transaction's gas fees.
  */
 export class MultiAgentTransaction extends Serializable {
   public rawTransaction: RawTransaction;
@@ -19,14 +24,12 @@ export class MultiAgentTransaction extends Serializable {
   public secondarySignerAddresses: AccountAddress[];
 
   /**
-   * SimpleTransaction represents a simple transaction type of a single signer that
-   * can be submitted to Aptos chain for execution.
+   * Represents a MultiAgentTransaction that can be submitted to the Aptos chain for execution.
+   * This class encapsulates the raw transaction data, the secondary signer addresses, and an optional fee payer address.
    *
-   * SimpleTransaction metadata contains the Raw Transaction and an optional
-   * sponsor Account Address to pay the gas fees.
-   *
-   * @param rawTransaction The Raw Tranasaction
-   * @param feePayerAddress The sponsor Account Address
+   * @param rawTransaction The raw transaction data.
+   * @param secondarySignerAddresses An array of secondary signer addresses.
+   * @param feePayerAddress An optional account address that sponsors the gas fees.
    */
   constructor(
     rawTransaction: RawTransaction,
@@ -39,6 +42,12 @@ export class MultiAgentTransaction extends Serializable {
     this.secondarySignerAddresses = secondarySignerAddresses;
   }
 
+  /**
+   * Serializes the transaction data, including the raw transaction, secondary signer addresses, and fee payer address.
+   * This function is essential for preparing the transaction for transmission or storage in a serialized format.
+   *
+   * @param serializer - The serializer instance used to serialize the transaction data.
+   */
   serialize(serializer: Serializer): void {
     this.rawTransaction.serialize(serializer);
 
@@ -52,14 +61,21 @@ export class MultiAgentTransaction extends Serializable {
     }
   }
 
+  /**
+   * Deserializes a MultiAgentTransaction from the provided deserializer.
+   * This function allows you to reconstruct a MultiAgentTransaction object from its serialized form, including any secondary
+   * signer addresses and the fee payer address if present.
+   *
+   * @param deserializer - The deserializer instance used to read the serialized data.
+   */
   static deserialize(deserializer: Deserializer): MultiAgentTransaction {
     const rawTransaction = RawTransaction.deserialize(deserializer);
 
     const secondarySignerAddresses = deserializer.deserializeVector(AccountAddress);
 
-    const feepayerPresent = deserializer.deserializeBool();
+    const feePayerPresent = deserializer.deserializeBool();
     let feePayerAddress;
-    if (feepayerPresent) {
+    if (feePayerPresent) {
       feePayerAddress = AccountAddress.deserialize(deserializer);
     }
 

package/src/transactions/instances/rawTransaction.ts

@@ -11,7 +11,9 @@ import { TransactionPayload } from "./transactionPayload";
 import { TransactionVariants } from "../../types";
 
 /**
- * Representation of a Raw Transaction that can serialized and deserialized
+ * Represents a raw transaction that can be serialized and deserialized.
+ * Raw transactions contain the metadata and payloads that can be submitted to the Aptos chain for execution.
+ * They must be signed before the Aptos chain can execute them.
  */
 export class RawTransaction extends Serializable {
   public readonly sender: AccountAddress;
@@ -62,6 +64,13 @@ export class RawTransaction extends Serializable {
     this.chain_id = chain_id;
   }
 
+  /**
+   * Serializes the transaction data, including the fee payer transaction type, raw transaction, secondary signer addresses,
+   * and fee payer address.
+   * This function is essential for preparing the transaction for transmission or storage in a serialized format.
+   *
+   * @param serializer - The serializer instance used to serialize the transaction data.
+   */
   serialize(serializer: Serializer): void {
     this.sender.serialize(serializer);
     serializer.serializeU64(this.sequence_number);
@@ -72,6 +81,12 @@ export class RawTransaction extends Serializable {
     this.chain_id.serialize(serializer);
   }
 
+  /**
+   * Deserialize a Raw Transaction With Data.
+   * This function retrieves the appropriate raw transaction based on the variant index provided by the deserializer.
+   *
+   * @param deserializer - An instance of the Deserializer used to read the serialized data.
+   */
   static deserialize(deserializer: Deserializer): RawTransaction {
     const sender = AccountAddress.deserialize(deserializer);
     const sequence_number = deserializer.deserializeU64();
@@ -93,7 +108,9 @@ export class RawTransaction extends Serializable {
 }
 
 /**
- * Representation of a Raw Transaction With Data that can serialized and deserialized
+ * Represents a raw transaction with associated data that can be serialized and deserialized.
+ *
+ * @extends Serializable
  */
 export abstract class RawTransactionWithData extends Serializable {
   /**
@@ -119,7 +136,9 @@ export abstract class RawTransactionWithData extends Serializable {
 }
 
 /**
- * Representation of a Multi Agent Transaction that can serialized and deserialized
+ * Represents a multi-agent transaction that can be serialized and deserialized.
+ *
+ * @extends RawTransactionWithData
  */
 export class MultiAgentRawTransaction extends RawTransactionWithData {
   /**
@@ -144,6 +163,14 @@ export class MultiAgentRawTransaction extends RawTransactionWithData {
     serializer.serializeVector(this.secondary_signer_addresses);
   }
 
+  /**
+   * Deserializes a Fee Payer Raw Transaction from the provided deserializer.
+   * This function allows you to reconstruct a Fee Payer Raw Transaction object, which includes the raw transaction data,
+   * secondary signer addresses, and the fee payer address.
+   *
+   * @param deserializer - The deserializer used to read the raw transaction data.
+   * @returns A FeePayerRawTransaction object constructed from the deserialized data.
+   */
   static load(deserializer: Deserializer): MultiAgentRawTransaction {
     const rawTxn = RawTransaction.deserialize(deserializer);
     const secondarySignerAddresses = deserializer.deserializeVector(AccountAddress);
@@ -153,7 +180,7 @@ export class MultiAgentRawTransaction extends RawTransactionWithData {
 }
 
 /**
- * Representation of a Fee Payer Transaction that can serialized and deserialized
+ * Represents a Fee Payer Transaction that can be serialized and deserialized.
  */
 export class FeePayerRawTransaction extends RawTransactionWithData {
   /**

package/src/transactions/instances/rotationProofChallenge.ts

@@ -8,8 +8,7 @@ import { PublicKey } from "../../core/crypto";
 import { MoveString, MoveVector, U64, U8 } from "../../bcs";
 
 /**
- * Representation of the challenge which is needed to sign by owner of the account
- * to rotate the authentication key.
+ * Represents a challenge required for the account owner to sign in order to rotate the authentication key.
  */
 export class RotationProofChallenge extends Serializable {
   // Resource account address
@@ -33,6 +32,16 @@ export class RotationProofChallenge extends Serializable {
   // Sequence number of the account
   public readonly sequenceNumber: U64;
 
+  /**
+   * Initializes a new instance of the class with the specified parameters.
+   * This constructor sets up the necessary attributes for managing account keys.
+   *
+   * @param args - The parameters required to create the instance.
+   * @param args.sequenceNumber - The sequence number associated with the transaction.
+   * @param args.originator - The account address of the originator.
+   * @param args.currentAuthKey - The current authentication key of the account.
+   * @param args.newPublicKey - The new public key to be set for the account.
+   */
   constructor(args: {
     sequenceNumber: AnyNumber;
     originator: AccountAddress;
@@ -46,6 +55,19 @@ export class RotationProofChallenge extends Serializable {
     this.newPublicKey = MoveVector.U8(args.newPublicKey.toUint8Array());
   }
 
+  /**
+   * Serializes the properties of the current instance for transmission or storage.
+   * This function helps in converting the instance data into a format suitable for serialization.
+   *
+   * @param serializer - The serializer used to serialize the instance properties.
+   * @param serializer.accountAddress - The account address to serialize.
+   * @param serializer.moduleName - The module name to serialize.
+   * @param serializer.structName - The struct name to serialize.
+   * @param serializer.sequenceNumber - The sequence number to serialize.
+   * @param serializer.originator - The originator to serialize.
+   * @param serializer.currentAuthKey - The current authentication key to serialize.
+   * @param serializer.newPublicKey - The new public key to serialize.
+   */
   serialize(serializer: Serializer): void {
     serializer.serialize(this.accountAddress);
     serializer.serialize(this.moduleName);