@aptos-labs/ts-sdk 1.33.1 → 1.33.2

package/src/internal/transactionSubmission.ts

@@ -3,6 +3,7 @@
  * the {@link api/transaction}. By moving the methods out into a separate file,
  * other namespaces and processes can access these methods without depending on the entire
  * transaction namespace and without having a dependency cycle error.
+ * @group Implementation
  */
 
 import { AptosConfig } from "../api/aptosConfig";
@@ -10,7 +11,7 @@ import { Deserializer, MoveVector, U8 } from "../bcs";
 import { postAptosFullNode } from "../client";
 import { Account, AbstractKeylessAccount, isKeylessSigner } from "../account";
 import { AccountAddress, AccountAddressInput } from "../core/accountAddress";
-import { FederatedKeylessPublicKey, KeylessPublicKey, KeylessSignature, PrivateKey } from "../core/crypto";
+import { FederatedKeylessPublicKey, KeylessPublicKey, KeylessSignature, PrivateKeyInput } from "../core/crypto";
 import { AccountAuthenticator } from "../transactions/authenticator/account";
 import { RotationProofChallenge } from "../transactions/instances/rotationProofChallenge";
 import {
@@ -42,6 +43,7 @@ import { MultiAgentTransaction } from "../transactions/instances/multiAgentTrans
  * These are the possible function signature for `generateTransaction` function.
  * When we call `generateTransaction` function with the relevant type properties,
  * Typescript can infer the return type based on the appropriate function overload.
+ * @group Implementation
  */
 export async function generateTransaction(
   args: { aptosConfig: AptosConfig } & InputGenerateSingleSignerRawTransactionData,
@@ -88,6 +90,7 @@ export async function generateTransaction(
  *  feePayerAddress?: AccountAddress
  * }
  * ```
+ * @group Implementation
  */
 export async function generateTransaction(
   args: { aptosConfig: AptosConfig } & InputGenerateTransactionData,
@@ -105,6 +108,7 @@ export async function generateTransaction(
  * @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.
+ * @group Implementation
  */
 export async function buildTransactionPayload(
   args: { aptosConfig: AptosConfig } & InputGenerateTransactionData,
@@ -149,6 +153,7 @@ export async function buildTransactionPayload(
  * @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.
+ * @group Implementation
  */
 export async function buildRawTransaction(
   args: { aptosConfig: AptosConfig } & InputGenerateTransactionData,
@@ -188,6 +193,7 @@ export async function buildRawTransaction(
  * @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.
+ * @group Implementation
  */
 function isFeePayerTransactionInput(data: InputGenerateTransactionData): boolean {
   return data.withFeePayer === true;
@@ -198,6 +204,7 @@ function isFeePayerTransactionInput(data: InputGenerateTransactionData): boolean
  *
  * @param data - The transaction input data to evaluate.
  * @param data.secondarySignerAddresses - An array of secondary signer addresses, indicating multiple agents.
+ * @group Implementation
  */
 function isMultiAgentTransactionInput(
   data: InputGenerateTransactionData,
@@ -214,6 +221,7 @@ function isMultiAgentTransactionInput(
  * @param args.transaction - AnyRawTransaction, as generated by `generateTransaction()`.
  *
  * @returns The message to be signed.
+ * @group Implementation
  */
 export function getSigningMessage(args: { transaction: AnyRawTransaction }): Uint8Array {
   const { transaction } = args;
@@ -228,6 +236,7 @@ export function getSigningMessage(args: { transaction: AnyRawTransaction }): Uin
  * @param args.transaction An instance of a RawTransaction, plus optional secondary/fee payer addresses.
  *
  * @return The signer AccountAuthenticator.
+ * @group Implementation
  */
 export function signTransaction(args: { signer: Account; transaction: AnyRawTransaction }): AccountAuthenticator {
   const { signer, transaction } = args;
@@ -265,6 +274,7 @@ export function signAsFeePayer(args: { signer: Account; transaction: AnyRawTrans
  * @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.
+ * @group Implementation
  */
 export async function simulateTransaction(
   args: { aptosConfig: AptosConfig } & InputSimulateTransactionData,
@@ -304,6 +314,7 @@ export async function simulateTransaction(
  * @param args.secondarySignerAuthenticators - Optional. Authenticators for additional signers in a multi-signer transaction.
  *
  * @returns PendingTransactionResponse - The response containing the status of the submitted transaction.
+ * @group Implementation
  */
 export async function submitTransaction(
   args: {
@@ -409,6 +420,7 @@ const packagePublishAbi: EntryFunctionABI = {
  * @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.
+ * @group Implementation
  */
 export async function publicPackageTransaction(args: {
   aptosConfig: AptosConfig;
@@ -457,11 +469,12 @@ const rotateAuthKeyAbi: EntryFunctionABI = {
  * 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.
+ * @group Implementation
  */
 export async function rotateAuthKey(args: {
   aptosConfig: AptosConfig;
   fromAccount: Account;
-  toNewPrivateKey: PrivateKey;
+  toNewPrivateKey: PrivateKeyInput;
 }): Promise<TransactionResponse> {
   const { aptosConfig, fromAccount, toNewPrivateKey } = args;
   const accountInfo = await getInfo({

package/src/transactions/authenticator/account.ts

@@ -16,6 +16,8 @@ import { AccountAuthenticatorVariant } from "../../types";
  * and deserialization of various authenticator types.
  *
  * @extends Serializable
+ * @group Implementation
+ * @category Transactions
  */
 export abstract class AccountAuthenticator extends Serializable {
   abstract serialize(serializer: Serializer): void;
@@ -25,6 +27,8 @@ export abstract class AccountAuthenticator extends Serializable {
    * This function helps in reconstructing the AccountAuthenticator object based on the variant index.
    *
    * @param deserializer - The deserializer instance used to read the serialized data.
+   * @group Implementation
+   * @category Transactions
    */
   static deserialize(deserializer: Deserializer): AccountAuthenticator {
     const index = deserializer.deserializeUleb128AsU32();
@@ -48,6 +52,8 @@ 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.
+   * @group Implementation
+   * @category Transactions
    */
   isEd25519(): this is AccountAuthenticatorEd25519 {
     return this instanceof AccountAuthenticatorEd25519;
@@ -57,6 +63,8 @@ export abstract class AccountAuthenticator extends Serializable {
    * Determines if the current instance is of type AccountAuthenticatorMultiEd25519.
    *
    * @returns {boolean} True if the instance is a multi-signature Ed25519 account authenticator, otherwise false.
+   * @group Implementation
+   * @category Transactions
    */
   isMultiEd25519(): this is AccountAuthenticatorMultiEd25519 {
     return this instanceof AccountAuthenticatorMultiEd25519;
@@ -66,6 +74,8 @@ export abstract class AccountAuthenticator extends Serializable {
    * Determines if the current instance is of the type AccountAuthenticatorSingleKey.
    *
    * @returns {boolean} True if the instance is an AccountAuthenticatorSingleKey, otherwise false.
+   * @group Implementation
+   * @category Transactions
    */
   isSingleKey(): this is AccountAuthenticatorSingleKey {
     return this instanceof AccountAuthenticatorSingleKey;
@@ -75,6 +85,8 @@ export abstract class AccountAuthenticator extends Serializable {
    * Determine if the current instance is of type AccountAuthenticatorMultiKey.
    *
    * @returns {boolean} Returns true if the instance is an AccountAuthenticatorMultiKey, otherwise false.
+   * @group Implementation
+   * @category Transactions
    */
   isMultiKey(): this is AccountAuthenticatorMultiKey {
     return this instanceof AccountAuthenticatorMultiKey;
@@ -87,6 +99,8 @@ export abstract class AccountAuthenticator extends Serializable {
  *
  * @param public_key - The Ed25519 public key associated with the account.
  * @param signature - The Ed25519 signature for the account.
+ * @group Implementation
+ * @category Transactions
  */
 export class AccountAuthenticatorEd25519 extends AccountAuthenticator {
   public readonly public_key: Ed25519PublicKey;
@@ -98,6 +112,8 @@ export class AccountAuthenticatorEd25519 extends AccountAuthenticator {
    *
    * @param public_key The public key used for verification.
    * @param signature The signatures corresponding to the public keys.
+   * @group Implementation
+   * @category Transactions
    */
   constructor(public_key: Ed25519PublicKey, signature: Ed25519Signature) {
     super();
@@ -110,6 +126,8 @@ export class AccountAuthenticatorEd25519 extends AccountAuthenticator {
    * This function captures the multi-key variant, public keys, and signatures for serialization.
    *
    * @param serializer - The serializer instance used to perform the serialization.
+   * @group Implementation
+   * @category Transactions
    */
   serialize(serializer: Serializer): void {
     serializer.serializeU32AsUleb128(AccountAuthenticatorVariant.Ed25519);
@@ -122,6 +140,8 @@ export class AccountAuthenticatorEd25519 extends AccountAuthenticator {
    * 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.
+   * @group Implementation
+   * @category Transactions
    */
   static load(deserializer: Deserializer): AccountAuthenticatorEd25519 {
     const public_key = Ed25519PublicKey.deserialize(deserializer);
@@ -135,6 +155,8 @@ export class AccountAuthenticatorEd25519 extends AccountAuthenticator {
  *
  * @param public_key - The MultiEd25519 public key of the account.
  * @param signature - The MultiEd25519 signature of the account.
+ * @group Implementation
+ * @category Transactions
  */
 export class AccountAuthenticatorMultiEd25519 extends AccountAuthenticator {
   public readonly public_key: MultiEd25519PublicKey;
@@ -166,6 +188,8 @@ export class AccountAuthenticatorMultiEd25519 extends AccountAuthenticator {
  *
  * @param public_key - The public key used for authentication.
  * @param signature - The signature associated with the public key.
+ * @group Implementation
+ * @category Transactions
  */
 export class AccountAuthenticatorSingleKey extends AccountAuthenticator {
   public readonly public_key: AnyPublicKey;
@@ -196,6 +220,8 @@ export class AccountAuthenticatorSingleKey extends AccountAuthenticator {
  *
  * @param public_keys - The public keys used for authentication.
  * @param signatures - The signatures corresponding to the public keys.
+ * @group Implementation
+ * @category Transactions
  */
 export class AccountAuthenticatorMultiKey extends AccountAuthenticator {
   public readonly public_keys: MultiKey;

package/src/transactions/authenticator/transaction.ts

@@ -15,6 +15,8 @@ import { TransactionAuthenticatorVariant } from "../../types";
  * This class provides methods for serializing and deserializing different types of transaction authenticators.
  *
  * @extends Serializable
+ * @group Implementation
+ * @category Transactions
  */
 export abstract class TransactionAuthenticator extends Serializable {
   abstract serialize(serializer: Serializer): void;
@@ -24,6 +26,8 @@ export abstract class TransactionAuthenticator extends Serializable {
    * 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.
+   * @group Implementation
+   * @category Transactions
    */
   static deserialize(deserializer: Deserializer): TransactionAuthenticator {
     const index = deserializer.deserializeUleb128AsU32();
@@ -72,6 +76,8 @@ export abstract class TransactionAuthenticator extends Serializable {
  * @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.
+ * @group Implementation
+ * @category Transactions
  */
 export class TransactionAuthenticatorEd25519 extends TransactionAuthenticator {
   public readonly public_key: Ed25519PublicKey;
@@ -83,6 +89,8 @@ export class TransactionAuthenticatorEd25519 extends TransactionAuthenticator {
    *
    * @param public_key - The Ed25519PublicKey that will be used for authentication.
    * @param signature - The Ed25519Signature that will be used for authentication.
+   * @group Implementation
+   * @category Transactions
    */
   constructor(public_key: Ed25519PublicKey, signature: Ed25519Signature) {
     super();
@@ -94,6 +102,8 @@ export class TransactionAuthenticatorEd25519 extends TransactionAuthenticator {
    * Serializes the transaction authenticator by encoding the sender information.
    *
    * @param serializer - The serializer instance used to perform the serialization.
+   * @group Implementation
+   * @category Transactions
    */
   serialize(serializer: Serializer): void {
     serializer.serializeU32AsUleb128(TransactionAuthenticatorVariant.Ed25519);
@@ -106,6 +116,8 @@ export class TransactionAuthenticatorEd25519 extends TransactionAuthenticator {
    * This function helps in deserializing the sender information to create a transaction authenticator.
    *
    * @param deserializer - The deserializer used to extract the sender data.
+   * @group Implementation
+   * @category Transactions
    */
   static load(deserializer: Deserializer): TransactionAuthenticatorEd25519 {
     const public_key = Ed25519PublicKey.deserialize(deserializer);
@@ -120,6 +132,8 @@ export class TransactionAuthenticatorEd25519 extends TransactionAuthenticator {
  *
  * @param public_key - The public key of the client involved in the transaction.
  * @param signature - The multi-signature of the raw transaction.
+ * @group Implementation
+ * @category Transactions
  */
 export class TransactionAuthenticatorMultiEd25519 extends TransactionAuthenticator {
   public readonly public_key: MultiEd25519PublicKey;
@@ -153,6 +167,8 @@ export class TransactionAuthenticatorMultiEd25519 extends TransactionAuthenticat
  * @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.
+ * @group Implementation
+ * @category Transactions
  */
 export class TransactionAuthenticatorMultiAgent extends TransactionAuthenticator {
   public readonly sender: AccountAuthenticator;
@@ -196,6 +212,8 @@ export class TransactionAuthenticatorMultiAgent extends TransactionAuthenticator
  * @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.
+ * @group Implementation
+ * @category Transactions
  */
 export class TransactionAuthenticatorFeePayer extends TransactionAuthenticator {
   public readonly sender: AccountAuthenticator;
@@ -247,6 +265,8 @@ export class TransactionAuthenticatorFeePayer extends TransactionAuthenticator {
  * This class is responsible for managing the authentication of a transaction initiated by a single sender.
  *
  * @param sender - An instance of AccountAuthenticator that represents the account of the sender.
+ * @group Implementation
+ * @category Transactions
  */
 export class TransactionAuthenticatorSingleSender extends TransactionAuthenticator {
   public readonly sender: AccountAuthenticator;

package/src/transactions/instances/chainId.ts

@@ -8,6 +8,8 @@ import { Deserializer } from "../../bcs/deserializer";
  * Represents a ChainId that can be serialized and deserialized.
  *
  * @extends Serializable
+ * @group Implementation
+ * @category Transactions
  */
 export class ChainId extends Serializable {
   public readonly chainId: number;
@@ -16,6 +18,8 @@ export class ChainId extends Serializable {
    * Initializes a new instance of the class with the specified chain ID.
    *
    * @param chainId - The ID of the blockchain network to be used.
+   * @group Implementation
+   * @category Transactions
    */
   constructor(chainId: number) {
     super();
@@ -27,6 +31,8 @@ export class ChainId extends Serializable {
    * 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.
+   * @group Implementation
+   * @category Transactions
    */
   serialize(serializer: Serializer): void {
     serializer.serializeU8(this.chainId);
@@ -37,6 +43,8 @@ export class ChainId extends Serializable {
    * This function allows you to reconstruct a ChainId object from serialized data.
    *
    * @param deserializer - The deserializer instance used to read the serialized data.
+   * @group Implementation
+   * @category Transactions
    */
   static deserialize(deserializer: Deserializer): ChainId {
     const chainId = deserializer.deserializeU8();

package/src/transactions/instances/identifier.ts

@@ -10,6 +10,8 @@ import { Serializable, Serializer } from "../../bcs/serializer";
  * the "function name" in "EntryFunction".
  *
  * @extends Serializable
+ * @group Implementation
+ * @category Transactions
  */
 export class Identifier extends Serializable {
   public identifier: string;
@@ -18,6 +20,8 @@ export class Identifier extends Serializable {
    * Creates an instance of the class with a specified identifier.
    *
    * @param identifier - The unique identifier for the instance.
+   * @group Implementation
+   * @category Transactions
    */
   constructor(identifier: string) {
     super();
@@ -28,6 +32,8 @@ export class Identifier extends Serializable {
    * Serializes the identifier of the current instance using the provided serializer.
    *
    * @param serializer - The serializer instance used to perform the serialization.
+   * @group Implementation
+   * @category Transactions
    */
   public serialize(serializer: Serializer): void {
     serializer.serializeStr(this.identifier);
@@ -38,6 +44,8 @@ export class Identifier extends Serializable {
    * This function is useful for reconstructing an Identifier object from a serialized format.
    *
    * @param deserializer - The deserializer instance used to read the serialized data.
+   * @group Implementation
+   * @category Transactions
    */
   static deserialize(deserializer: Deserializer): Identifier {
     const identifier = deserializer.deserializeStr();

package/src/transactions/instances/moduleId.ts

@@ -10,6 +10,8 @@ import { MoveModuleId } from "../../types";
 /**
  * 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").
+ * @group Implementation
+ * @category Transactions
  */
 export class ModuleId extends Serializable {
   public readonly address: AccountAddress;
@@ -21,6 +23,8 @@ export class ModuleId extends Serializable {
    *
    * @param address - The account address, e.g., "0x1".
    * @param name - The module name under the specified address, e.g., "coin".
+   * @group Implementation
+   * @category Transactions
    */
   constructor(address: AccountAddress, name: Identifier) {
     super();
@@ -33,6 +37,8 @@ export class ModuleId extends Serializable {
    * @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.
+   * @group Implementation
+   * @category Transactions
    */
   static fromStr(moduleId: MoveModuleId): ModuleId {
     const parts = moduleId.split("::");
@@ -47,6 +53,8 @@ export class ModuleId extends Serializable {
    * 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.
+   * @group Implementation
+   * @category Transactions
    */
   serialize(serializer: Serializer): void {
     this.address.serialize(serializer);
@@ -58,6 +66,8 @@ export class ModuleId extends Serializable {
    * This function retrieves the account address and identifier to construct a ModuleId instance.
    *
    * @param deserializer - The deserializer instance used to read the data.
+   * @group Implementation
+   * @category Transactions
    */
   static deserialize(deserializer: Deserializer): ModuleId {
     const address = AccountAddress.deserialize(deserializer);

package/src/transactions/instances/multiAgentTransaction.ts

@@ -15,6 +15,8 @@ import { RawTransaction } from "./rawTransaction";
  * @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.
+ * @group Implementation
+ * @category Transactions
  */
 export class MultiAgentTransaction extends Serializable {
   public rawTransaction: RawTransaction;
@@ -30,6 +32,8 @@ export class MultiAgentTransaction extends Serializable {
    * @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.
+   * @group Implementation
+   * @category Transactions
    */
   constructor(
     rawTransaction: RawTransaction,
@@ -47,6 +51,8 @@ export class MultiAgentTransaction extends Serializable {
    * 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.
+   * @group Implementation
+   * @category Transactions
    */
   serialize(serializer: Serializer): void {
     this.rawTransaction.serialize(serializer);
@@ -67,6 +73,8 @@ export class MultiAgentTransaction extends Serializable {
    * signer addresses and the fee payer address if present.
    *
    * @param deserializer - The deserializer instance used to read the serialized data.
+   * @group Implementation
+   * @category Transactions
    */
   static deserialize(deserializer: Deserializer): MultiAgentTransaction {
     const rawTransaction = RawTransaction.deserialize(deserializer);

package/src/transactions/instances/rawTransaction.ts

@@ -14,6 +14,8 @@ import { TransactionVariants } from "../../types";
  * 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.
+ * @group Implementation
+ * @category Transactions
  */
 export class RawTransaction extends Serializable {
   public readonly sender: AccountAddress;
@@ -44,6 +46,8 @@ export class RawTransaction extends Serializable {
    * @param gas_unit_price Price to be paid per gas unit.
    * @param expiration_timestamp_secs The blockchain timestamp at which the blockchain would discard this transaction.
    * @param chain_id The chain ID of the blockchain that this transaction is intended to be run on.
+   * @group Implementation
+   * @category Transactions
    */
   constructor(
     sender: AccountAddress,
@@ -70,6 +74,8 @@ export class RawTransaction extends Serializable {
    * 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.
+   * @group Implementation
+   * @category Transactions
    */
   serialize(serializer: Serializer): void {
     this.sender.serialize(serializer);
@@ -86,6 +92,8 @@ export class RawTransaction extends Serializable {
    * 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.
+   * @group Implementation
+   * @category Transactions
    */
   static deserialize(deserializer: Deserializer): RawTransaction {
     const sender = AccountAddress.deserialize(deserializer);
@@ -111,15 +119,21 @@ export class RawTransaction extends Serializable {
  * Represents a raw transaction with associated data that can be serialized and deserialized.
  *
  * @extends Serializable
+ * @group Implementation
+ * @category Transactions
  */
 export abstract class RawTransactionWithData extends Serializable {
   /**
    * Serialize a Raw Transaction With Data
+   * @group Implementation
+   * @category Transactions
    */
   abstract serialize(serializer: Serializer): void;
 
   /**
    * Deserialize a Raw Transaction With Data
+   * @group Implementation
+   * @category Transactions
    */
   static deserialize(deserializer: Deserializer): RawTransactionWithData {
     // index enum variant
@@ -139,15 +153,21 @@ export abstract class RawTransactionWithData extends Serializable {
  * Represents a multi-agent transaction that can be serialized and deserialized.
  *
  * @extends RawTransactionWithData
+ * @group Implementation
+ * @category Transactions
  */
 export class MultiAgentRawTransaction extends RawTransactionWithData {
   /**
    * The raw transaction
+   * @group Implementation
+   * @category Transactions
    */
   public readonly raw_txn: RawTransaction;
 
   /**
    * The secondary signers on this transaction
+   * @group Implementation
+   * @category Transactions
    */
   public readonly secondary_signer_addresses: Array<AccountAddress>;
 
@@ -170,6 +190,8 @@ export class MultiAgentRawTransaction extends RawTransactionWithData {
    *
    * @param deserializer - The deserializer used to read the raw transaction data.
    * @returns A FeePayerRawTransaction object constructed from the deserialized data.
+   * @group Implementation
+   * @category Transactions
    */
   static load(deserializer: Deserializer): MultiAgentRawTransaction {
     const rawTxn = RawTransaction.deserialize(deserializer);
@@ -181,20 +203,28 @@ export class MultiAgentRawTransaction extends RawTransactionWithData {
 
 /**
  * Represents a Fee Payer Transaction that can be serialized and deserialized.
+ * @group Implementation
+ * @category Transactions
  */
 export class FeePayerRawTransaction extends RawTransactionWithData {
   /**
    * The raw transaction
+   * @group Implementation
+   * @category Transactions
    */
   public readonly raw_txn: RawTransaction;
 
   /**
    * The secondary signers on this transaction - optional and can be empty
+   * @group Implementation
+   * @category Transactions
    */
   public readonly secondary_signer_addresses: Array<AccountAddress>;
 
   /**
    * The fee payer account address
+   * @group Implementation
+   * @category Transactions
    */
   public readonly fee_payer_address: AccountAddress;
 

package/src/transactions/instances/rotationProofChallenge.ts

@@ -9,6 +9,8 @@ import { MoveString, MoveVector, U64, U8 } from "../../bcs";
 
 /**
  * Represents a challenge required for the account owner to sign in order to rotate the authentication key.
+ * @group Implementation
+ * @category Transactions
  */
 export class RotationProofChallenge extends Serializable {
   // Resource account address
@@ -41,6 +43,8 @@ export class RotationProofChallenge extends Serializable {
    * @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.
+   * @group Implementation
+   * @category Transactions
    */
   constructor(args: {
     sequenceNumber: AnyNumber;
@@ -67,6 +71,8 @@ export class RotationProofChallenge extends Serializable {
    * @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.
+   * @group Implementation
+   * @category Transactions
    */
   serialize(serializer: Serializer): void {
     serializer.serialize(this.accountAddress);

package/src/transactions/instances/signedTransaction.ts

@@ -17,6 +17,8 @@ import { RawTransaction } from "./rawTransaction";
  * @param authenticator - Contains a client's public key and the signature of the raw transaction.
  * Authenticator can have three variations: single signature, multi-signature, and multi-agent.
  * @see {@link https://github.com/aptos-labs/aptos-core/blob/main/types/src/transaction/authenticator.rs} for details.
+ * @group Implementation
+ * @category Transactions
  */
 export class SignedTransaction extends Serializable {
   public readonly raw_txn: RawTransaction;
@@ -33,6 +35,8 @@ export class SignedTransaction extends Serializable {
    * flavors: single signature, multi-signature and multi-agent.
    * @see {@link https://aptos.dev/integration/creating-a-signed-transaction | Creating a Signed Transaction}
    * @see {@link https://github.com/aptos-labs/aptos-core/blob/main/types/src/transaction/authenticator.rs} for details.
+   * @group Implementation
+   * @category Transactions
    */
   constructor(raw_txn: RawTransaction, authenticator: TransactionAuthenticator) {
     super();
@@ -45,6 +49,8 @@ export class SignedTransaction extends Serializable {
    * This function is essential for preparing the transaction data for transmission or storage.
    *
    * @param serializer - The serializer instance used to serialize the transaction and authenticator.
+   * @group Implementation
+   * @category Transactions
    */
   serialize(serializer: Serializer): void {
     this.raw_txn.serialize(serializer);
@@ -56,6 +62,8 @@ export class SignedTransaction extends Serializable {
    * This function allows you to reconstruct a SignedTransaction object from its serialized form, enabling further processing or validation.
    *
    * @param deserializer - The deserializer instance used to read the serialized data.
+   * @group Implementation
+   * @category Transactions
    */
   static deserialize(deserializer: Deserializer): SignedTransaction {
     const raw_txn = RawTransaction.deserialize(deserializer);