@aptos-labs/ts-sdk 6.3.1 → 7.0.1

package/dist/api/transaction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transaction.js","sourceRoot":"","sources":["../../src/api/transaction.ts"],"names":[],"mappings":"AAAA,+BAA+B;AAC/B,sCAAsC;AAGtC,OAAO,EACL,qBAAqB,EACrB,oBAAoB,EACpB,uBAAuB,EACvB,eAAe,EACf,oBAAoB,EACpB,kBAAkB,GACnB,MAAM,4BAA4B,CAAC;AAWpC,OAAO,EAEL,iBAAiB,EACjB,wBAAwB,EACxB,uBAAuB,EACvB,wBAAwB,EACxB,cAAc,EACd,eAAe,GAChB,MAAM,sCAAsC,CAAC;AAU9C,OAAO,EAAE,KAAK,EAAE,MAAM,kCAAkC,CAAC;AACzD,OAAO,EAAE,QAAQ,EAAE,MAAM,qCAAqC,CAAC;AAC/D,OAAO,EAAE,MAAM,EAAE,MAAM,mCAAmC,CAAC;AAC3D,OAAO,EAAE,qBAAqB,EAAE,MAAM,uCAAuC,CAAC;AAE9E,OAAO,EAAE,aAAa,EAAE,uBAAuB,EAAE,MAAM,wBAAwB,CAAC;AAEhF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqFG;AACH,MAAM,OAAO,WAAW;IACb,MAAM,CAAc;IAEpB,KAAK,CAAQ;IAEb,QAAQ,CAAW;IAEnB,MAAM,CAAS;IAEf,KAAK,CAAwB;IAEtC;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,YAAY,MAAmB;QAC7B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,KAAK,GAAG,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACpC,IAAI,CAAC,QAAQ,GAAG,IAAI,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC1C,IAAI,CAAC,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACtC,IAAI,CAAC,KAAK,GAAG,IAAI,qBAAqB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACtD,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,KAAK,CAAC,eAAe,CAAC,IAAmC;QACvD,OAAO,eAAe,CAAC;YACrB,WAAW,EAAE,IAAI,CAAC,MAAM;YACxB,GAAG,IAAI;SACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,KAAK,CAAC,uBAAuB,CAAC,IAAkC;QAC9D,OAAO,uBAAuB,CAAC;YAC7B,WAAW,EAAE,IAAI,CAAC,MAAM;YACxB,GAAG,IAAI;SACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,KAAK,CAAC,oBAAoB,CAAC,IAAmC;QAC5D,OAAO,oBAAoB,CAAC;YAC1B,WAAW,EAAE,IAAI,CAAC,MAAM;YACxB,GAAG,IAAI;SACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,KAAK,CAAC,oBAAoB,CAAC,IAAmC;QAC5D,OAAO,oBAAoB,CAAC;YAC1B,WAAW,EAAE,IAAI,CAAC,MAAM;YACxB,GAAG,IAAI;SACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4CG;IACH,KAAK,CAAC,kBAAkB,CAAC,IAGxB;QACC,OAAO,kBAAkB,CAAC;YACxB,WAAW,EAAE,IAAI,CAAC,MAAM;YACxB,GAAG,IAAI;SACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,KAAK,CAAC,qBAAqB;QACzB,OAAO,qBAAqB,CAAC;YAC3B,WAAW,EAAE,IAAI,CAAC,MAAM;SACzB,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IAEH,iBAAiB,CAAC,IAAwC;QACxD,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;IACH,KAAK,CAAC,yBAAyB,CAAC,IAK/B;QACC,OAAO,wBAAwB,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,KAAK,CAAC,aAAa,CACjB,IAGkG;QAElG,OAAO,aAAa,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,KAAK,CAAC,uBAAuB,CAAC,IAI7B;QACC,OAAO,uBAAuB,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;IACxE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IAEH,IAAI,CAAC,IAAyD;QAC5D,OAAO,eAAe,CAAC;YACrB,GAAG,IAAI;SACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;IAEH,cAAc,CAAC,IAAyD;QACtE,OAAO,cAAc,CAAC;YACpB,GAAG,IAAI;SACR,CAAC,CAAC;IACL,CAAC;IAED,4BAA4B;IAE5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuCG;IACH,KAAK,CAAC,iCAAiC,CAAC,IAIvC;QACC,IAAI,CAAC;YACH,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;YACvC,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;QACzD,CAAC;QAAC,OAAO,KAAU,EAAE,CAAC;YACpB,MAAM,IAAI,KAAK,CAAC,6CAA6C,KAAK,EAAE,CAAC,CAAC;QACxE,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,KAAK,CAAC,wBAAwB,CAC5B,IAG8B;QAE9B,OAAO,wBAAwB,CAAC;YAC9B,WAAW,EAAE,IAAI,CAAC,MAAM;YACxB,GAAG,IAAI;SACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,uBAAuB,CAC3B,IAI8B;QAE9B,OAAO,uBAAuB,CAAC;YAC7B,WAAW,EAAE,IAAI,CAAC,MAAM;YACxB,GAAG,IAAI;SACR,CAAC,CAAC;IACL,CAAC;CACF"}

package/dist/api/transactionSubmission/build.d.ts

@@ -0,0 +1,137 @@
+import { AccountAddressInput } from "../../core/index.js";
+import { InputGenerateTransactionPayloadData, InputGenerateTransactionOptions } from "../../transactions/index.js";
+import { MultiAgentTransaction } from "../../transactions/instances/multiAgentTransaction.js";
+import { SimpleTransaction } from "../../transactions/instances/simpleTransaction.js";
+import { AptosConfig } from "../aptosConfig.js";
+/**
+ * A class to handle all `Build` transaction operations.
+ * @group Implementation
+ */
+export declare class Build {
+    readonly config: AptosConfig;
+    /**
+     * Initializes a new instance of the Aptos client with the specified configuration.
+     * This allows you to interact with the Aptos blockchain using the provided settings.
+     *
+     * @param config - The configuration settings for the Aptos client.
+     * @param config.network - The network to connect to (e.g., TESTNET, MAINNET).
+     * @param config.nodeUrl - The URL of the Aptos node to connect to.
+     * @param config.account - The account details for authentication.
+     *
+     * @example
+     * ```typescript
+     * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
+     *
+     * async function runExample() {
+     *     // Create a configuration for the Aptos client
+     *     const config = new AptosConfig({
+     *         network: Network.TESTNET, // specify the network
+     *         nodeUrl: "https://testnet.aptos.dev", // specify the node URL
+     *     });
+     *
+     *     // Initialize the Aptos client
+     *     const aptos = new Aptos(config);
+     *
+     *     console.log("Aptos client initialized:", aptos);
+     * }
+     * runExample().catch(console.error);
+     * ```
+     * @group Implementation
+     */
+    constructor(config: AptosConfig);
+    /**
+     * Build a simple transaction.
+     *
+     * This function allows you to create a transaction with specified sender and data.
+     *
+     * @param args.sender - The sender account address.
+     * @param args.data - The transaction data.
+     * @param args.options - Optional transaction configurations.
+     * @param args.withFeePayer - Whether there is a fee payer for the transaction.
+     *
+     * @returns SimpleTransaction
+     *
+     * @example
+     * ```typescript
+     * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
+     *
+     * const config = new AptosConfig({ network: Network.TESTNET });
+     * const aptos = new Aptos(config);
+     *
+     * async function runExample() {
+     *   // Build a simple transaction
+     *   const transaction = await aptos.transaction.simple({
+     *     sender: "0x1", // replace with a real sender account address
+     *     data: {
+     *       function: "0x1::aptos_account::transfer",
+     *       functionArguments: ["0x2", 100], // replace with a real destination account address
+     *     },
+     *     options: {
+     *       gasUnitPrice: 100, // specify your own gas unit price if needed
+     *       maxGasAmount: 1000, // specify your own max gas amount if needed
+     *     },
+     *   });
+     *
+     *   console.log(transaction);
+     * }
+     * runExample().catch(console.error);
+     * ```
+     * @group Implementation
+     */
+    simple(args: {
+        sender: AccountAddressInput;
+        data: InputGenerateTransactionPayloadData;
+        options?: InputGenerateTransactionOptions;
+        withFeePayer?: boolean;
+    }): Promise<SimpleTransaction>;
+    /**
+     * Build a multi-agent transaction that allows multiple signers to authorize a transaction.
+     *
+     * @param args - The parameters for creating the multi-agent transaction.
+     * @param args.sender - The sender account address.
+     * @param args.data - The transaction data.
+     * @param args.secondarySignerAddresses - An array of the secondary signers' account addresses.
+     * @param args.options - Optional transaction configurations.
+     * @param args.withFeePayer - Whether there is a fee payer for the transaction.
+     *
+     * @returns MultiAgentTransaction
+     *
+     * @example
+     * ```typescript
+     * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
+     *
+     * const config = new AptosConfig({ network: Network.TESTNET });
+     * const aptos = new Aptos(config);
+     *
+     * async function runExample() {
+     *   // Build a multi-agent transaction
+     *   const transaction = await aptos.multiAgent({
+     *     sender: "0x1", // replace with a real sender account address
+     *     data: {
+     *       // Transaction data structure
+     *       function: "0x1::aptos_account::transfer",
+     *       functionArguments: ["0x2", 100], // replace with a real destination account address and amount
+     *     },
+     *     secondarySignerAddresses: ["0x3", "0x4"], // replace with real secondary signer addresses
+     *     options: {
+     *       // Optional transaction configurations
+     *       maxGasAmount: "1000",
+     *       gasUnitPrice: "1",
+     *     },
+     *   });
+     *
+     *   console.log(transaction);
+     * }
+     * runExample().catch(console.error);
+     * ```
+     * @group Implementation
+     */
+    multiAgent(args: {
+        sender: AccountAddressInput;
+        data: InputGenerateTransactionPayloadData;
+        secondarySignerAddresses: AccountAddressInput[];
+        options?: InputGenerateTransactionOptions;
+        withFeePayer?: boolean;
+    }): Promise<MultiAgentTransaction>;
+}
+//# sourceMappingURL=build.d.ts.map

package/dist/api/transactionSubmission/build.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"build.d.ts","sourceRoot":"","sources":["../../../src/api/transactionSubmission/build.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAE1D,OAAO,EAAE,mCAAmC,EAAE,+BAA+B,EAAE,MAAM,6BAA6B,CAAC;AACnH,OAAO,EAAE,qBAAqB,EAAE,MAAM,uDAAuD,CAAC;AAC9F,OAAO,EAAE,iBAAiB,EAAE,MAAM,mDAAmD,CAAC;AACtF,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD;;;GAGG;AACH,qBAAa,KAAK;IAChB,QAAQ,CAAC,MAAM,EAAE,WAAW,CAAC;IAE7B;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;gBACS,MAAM,EAAE,WAAW;IAI/B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsCG;IACG,MAAM,CAAC,IAAI,EAAE;QACjB,MAAM,EAAE,mBAAmB,CAAC;QAC5B,IAAI,EAAE,mCAAmC,CAAC;QAC1C,OAAO,CAAC,EAAE,+BAA+B,CAAC;QAC1C,YAAY,CAAC,EAAE,OAAO,CAAC;KACxB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAI9B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;IACG,UAAU,CAAC,IAAI,EAAE;QACrB,MAAM,EAAE,mBAAmB,CAAC;QAC5B,IAAI,EAAE,mCAAmC,CAAC;QAC1C,wBAAwB,EAAE,mBAAmB,EAAE,CAAC;QAChD,OAAO,CAAC,EAAE,+BAA+B,CAAC;QAC1C,YAAY,CAAC,EAAE,OAAO,CAAC;KACxB,GAAG,OAAO,CAAC,qBAAqB,CAAC;CAGnC"}

package/dist/api/transactionSubmission/build.js

@@ -0,0 +1,130 @@
+// Copyright © Aptos Foundation
+// SPDX-License-Identifier: Apache-2.0
+import { generateTransaction } from "../../internal/transactionSubmission.js";
+/**
+ * A class to handle all `Build` transaction operations.
+ * @group Implementation
+ */
+export class Build {
+    config;
+    /**
+     * Initializes a new instance of the Aptos client with the specified configuration.
+     * This allows you to interact with the Aptos blockchain using the provided settings.
+     *
+     * @param config - The configuration settings for the Aptos client.
+     * @param config.network - The network to connect to (e.g., TESTNET, MAINNET).
+     * @param config.nodeUrl - The URL of the Aptos node to connect to.
+     * @param config.account - The account details for authentication.
+     *
+     * @example
+     * ```typescript
+     * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
+     *
+     * async function runExample() {
+     *     // Create a configuration for the Aptos client
+     *     const config = new AptosConfig({
+     *         network: Network.TESTNET, // specify the network
+     *         nodeUrl: "https://testnet.aptos.dev", // specify the node URL
+     *     });
+     *
+     *     // Initialize the Aptos client
+     *     const aptos = new Aptos(config);
+     *
+     *     console.log("Aptos client initialized:", aptos);
+     * }
+     * runExample().catch(console.error);
+     * ```
+     * @group Implementation
+     */
+    constructor(config) {
+        this.config = config;
+    }
+    /**
+     * Build a simple transaction.
+     *
+     * This function allows you to create a transaction with specified sender and data.
+     *
+     * @param args.sender - The sender account address.
+     * @param args.data - The transaction data.
+     * @param args.options - Optional transaction configurations.
+     * @param args.withFeePayer - Whether there is a fee payer for the transaction.
+     *
+     * @returns SimpleTransaction
+     *
+     * @example
+     * ```typescript
+     * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
+     *
+     * const config = new AptosConfig({ network: Network.TESTNET });
+     * const aptos = new Aptos(config);
+     *
+     * async function runExample() {
+     *   // Build a simple transaction
+     *   const transaction = await aptos.transaction.simple({
+     *     sender: "0x1", // replace with a real sender account address
+     *     data: {
+     *       function: "0x1::aptos_account::transfer",
+     *       functionArguments: ["0x2", 100], // replace with a real destination account address
+     *     },
+     *     options: {
+     *       gasUnitPrice: 100, // specify your own gas unit price if needed
+     *       maxGasAmount: 1000, // specify your own max gas amount if needed
+     *     },
+     *   });
+     *
+     *   console.log(transaction);
+     * }
+     * runExample().catch(console.error);
+     * ```
+     * @group Implementation
+     */
+    async simple(args) {
+        return generateTransaction({ aptosConfig: this.config, ...args });
+    }
+    /**
+     * Build a multi-agent transaction that allows multiple signers to authorize a transaction.
+     *
+     * @param args - The parameters for creating the multi-agent transaction.
+     * @param args.sender - The sender account address.
+     * @param args.data - The transaction data.
+     * @param args.secondarySignerAddresses - An array of the secondary signers' account addresses.
+     * @param args.options - Optional transaction configurations.
+     * @param args.withFeePayer - Whether there is a fee payer for the transaction.
+     *
+     * @returns MultiAgentTransaction
+     *
+     * @example
+     * ```typescript
+     * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
+     *
+     * const config = new AptosConfig({ network: Network.TESTNET });
+     * const aptos = new Aptos(config);
+     *
+     * async function runExample() {
+     *   // Build a multi-agent transaction
+     *   const transaction = await aptos.multiAgent({
+     *     sender: "0x1", // replace with a real sender account address
+     *     data: {
+     *       // Transaction data structure
+     *       function: "0x1::aptos_account::transfer",
+     *       functionArguments: ["0x2", 100], // replace with a real destination account address and amount
+     *     },
+     *     secondarySignerAddresses: ["0x3", "0x4"], // replace with real secondary signer addresses
+     *     options: {
+     *       // Optional transaction configurations
+     *       maxGasAmount: "1000",
+     *       gasUnitPrice: "1",
+     *     },
+     *   });
+     *
+     *   console.log(transaction);
+     * }
+     * runExample().catch(console.error);
+     * ```
+     * @group Implementation
+     */
+    async multiAgent(args) {
+        return generateTransaction({ aptosConfig: this.config, ...args });
+    }
+}
+//# sourceMappingURL=build.js.map

package/dist/api/transactionSubmission/build.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"build.js","sourceRoot":"","sources":["../../../src/api/transactionSubmission/build.ts"],"names":[],"mappings":"AAAA,+BAA+B;AAC/B,sCAAsC;AAGtC,OAAO,EAAE,mBAAmB,EAAE,MAAM,yCAAyC,CAAC;AAM9E;;;GAGG;AACH,MAAM,OAAO,KAAK;IACP,MAAM,CAAc;IAE7B;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,YAAY,MAAmB;QAC7B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsCG;IACH,KAAK,CAAC,MAAM,CAAC,IAKZ;QACC,OAAO,mBAAmB,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;IACH,KAAK,CAAC,UAAU,CAAC,IAMhB;QACC,OAAO,mBAAmB,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;IACpE,CAAC;CACF"}

package/dist/api/transactionSubmission/helpers.d.ts

@@ -0,0 +1,91 @@
+import { AccountAuthenticator, AnyRawTransaction, InputTransactionPluginData } from "../../transactions/index.js";
+import { AptosConfig } from "../aptosConfig.js";
+/**
+ * Validates the fee payer data when submitting a transaction to ensure that the fee
+ * payer authenticator is provided if a fee payer address is specified. This helps
+ * prevent errors in transaction submission related to fee payer authentication.
+ *
+ * The validation is skipped if a custom transaction submitter is defined.
+ *
+ * @param config - The Aptos configuration that may contain a transaction submitter.
+ * @param args - The method arguments containing transaction data and optional transaction submitter.
+ *
+ * @example
+ * ```typescript
+ * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
+ *
+ * const config = new AptosConfig({ network: Network.TESTNET });
+ * const aptos = new Aptos(config);
+ *
+ * class TransactionHandler {
+ *   async submitTransaction(methodArgs: { transaction: { feePayerAddress: string }, feePayerAuthenticator?: string }) {
+ *     validateFeePayerDataOnSubmission(this.config, methodArgs);
+ *     // Logic to submit the transaction
+ *   }
+ * }
+ *
+ * async function runExample() {
+ *   const handler = new TransactionHandler();
+ *
+ *   // Attempt to submit a transaction without a fee payer authenticator
+ *   try {
+ *     await handler.submitTransaction({
+ *       transaction: { feePayerAddress: "0x1" }, // replace with a real fee payer address
+ *     });
+ *   } catch (error) {
+ *     console.error(error.message); // Should log the error message
+ *   }
+ *
+ *   // Submit a transaction with a fee payer authenticator
+ *   await handler.submitTransaction({
+ *     transaction: { feePayerAddress: "0x1" }, // replace with a real fee payer address
+ *     feePayerAuthenticator: "authenticatorValue", // replace with a real authenticator
+ *   });
+ *
+ *   console.log("Transaction submitted successfully.");
+ * }
+ * runExample().catch(console.error);
+ * ```
+ * @group Implementation
+ */
+export declare function validateFeePayerDataOnSubmission(config: AptosConfig, args: {
+    transaction: AnyRawTransaction;
+    senderAuthenticator: AccountAuthenticator;
+    feePayerAuthenticator?: AccountAuthenticator;
+} & InputTransactionPluginData): void;
+/**
+ * Validates that the fee payer public key is provided when simulating a Fee Payer transaction.
+ * This ensures that all necessary data is present for the simulation to proceed correctly.
+ *
+ * @param target - The target object where the method is defined.
+ * @param propertyKey - The name of the method being decorated.
+ * @param descriptor - The property descriptor for the method.
+ *
+ * @example
+ * ```typescript
+ * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
+ *
+ * const config = new AptosConfig({ network: Network.TESTNET });
+ * const aptos = new Aptos(config);
+ *
+ * async function runExample() {
+ *   const methodArgs = {
+ *     transaction: {
+ *       feePayerAddress: "0x1", // replace with a real fee payer address
+ *     },
+ *     feePayerPublicKey: undefined, // missing fee payer public key
+ *   };
+ *
+ *   try {
+ *     // This will throw an error due to missing feePayerPublicKey
+ *     await aptos.someMethod(methodArgs);
+ *   } catch (error) {
+ *     console.error(error.message); // Output the error message
+ *   }
+ * }
+ * runExample().catch(console.error);
+ * ```
+ * @group Implementation
+ */
+export declare function ValidateFeePayerDataOnSimulation(target: unknown, propertyKey: string, descriptor: PropertyDescriptor): PropertyDescriptor;
+//# sourceMappingURL=helpers.d.ts.map

package/dist/api/transactionSubmission/helpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../../src/api/transactionSubmission/helpers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,iBAAiB,EAAE,0BAA0B,EAAE,MAAM,6BAA6B,CAAC;AAClH,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+CG;AACH,wBAAgB,gCAAgC,CAC9C,MAAM,EAAE,WAAW,EACnB,IAAI,EAAE;IACJ,WAAW,EAAE,iBAAiB,CAAC;IAC/B,mBAAmB,EAAE,oBAAoB,CAAC;IAC1C,qBAAqB,CAAC,EAAE,oBAAoB,CAAC;CAC9C,GAAG,0BAA0B,GAC7B,IAAI,CASN;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,wBAAgB,gCAAgC,CAAC,MAAM,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,UAAU,EAAE,kBAAkB,sBAOpH"}

package/dist/api/transactionSubmission/helpers.js

@@ -0,0 +1,99 @@
+/**
+ * Validates the fee payer data when submitting a transaction to ensure that the fee
+ * payer authenticator is provided if a fee payer address is specified. This helps
+ * prevent errors in transaction submission related to fee payer authentication.
+ *
+ * The validation is skipped if a custom transaction submitter is defined.
+ *
+ * @param config - The Aptos configuration that may contain a transaction submitter.
+ * @param args - The method arguments containing transaction data and optional transaction submitter.
+ *
+ * @example
+ * ```typescript
+ * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
+ *
+ * const config = new AptosConfig({ network: Network.TESTNET });
+ * const aptos = new Aptos(config);
+ *
+ * class TransactionHandler {
+ *   async submitTransaction(methodArgs: { transaction: { feePayerAddress: string }, feePayerAuthenticator?: string }) {
+ *     validateFeePayerDataOnSubmission(this.config, methodArgs);
+ *     // Logic to submit the transaction
+ *   }
+ * }
+ *
+ * async function runExample() {
+ *   const handler = new TransactionHandler();
+ *
+ *   // Attempt to submit a transaction without a fee payer authenticator
+ *   try {
+ *     await handler.submitTransaction({
+ *       transaction: { feePayerAddress: "0x1" }, // replace with a real fee payer address
+ *     });
+ *   } catch (error) {
+ *     console.error(error.message); // Should log the error message
+ *   }
+ *
+ *   // Submit a transaction with a fee payer authenticator
+ *   await handler.submitTransaction({
+ *     transaction: { feePayerAddress: "0x1" }, // replace with a real fee payer address
+ *     feePayerAuthenticator: "authenticatorValue", // replace with a real authenticator
+ *   });
+ *
+ *   console.log("Transaction submitted successfully.");
+ * }
+ * runExample().catch(console.error);
+ * ```
+ * @group Implementation
+ */
+export function validateFeePayerDataOnSubmission(config, args) {
+    // Skip validation if a transaction submitter is defined.
+    if (config.getTransactionSubmitter() !== undefined || args.transactionSubmitter !== undefined) {
+        return;
+    }
+    if (args.transaction.feePayerAddress && !args.feePayerAuthenticator) {
+        throw new Error("You are submitting a Fee Payer transaction but missing the feePayerAuthenticator");
+    }
+}
+/**
+ * Validates that the fee payer public key is provided when simulating a Fee Payer transaction.
+ * This ensures that all necessary data is present for the simulation to proceed correctly.
+ *
+ * @param target - The target object where the method is defined.
+ * @param propertyKey - The name of the method being decorated.
+ * @param descriptor - The property descriptor for the method.
+ *
+ * @example
+ * ```typescript
+ * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
+ *
+ * const config = new AptosConfig({ network: Network.TESTNET });
+ * const aptos = new Aptos(config);
+ *
+ * async function runExample() {
+ *   const methodArgs = {
+ *     transaction: {
+ *       feePayerAddress: "0x1", // replace with a real fee payer address
+ *     },
+ *     feePayerPublicKey: undefined, // missing fee payer public key
+ *   };
+ *
+ *   try {
+ *     // This will throw an error due to missing feePayerPublicKey
+ *     await aptos.someMethod(methodArgs);
+ *   } catch (error) {
+ *     console.error(error.message); // Output the error message
+ *   }
+ * }
+ * runExample().catch(console.error);
+ * ```
+ * @group Implementation
+ */
+export function ValidateFeePayerDataOnSimulation(target, propertyKey, descriptor) {
+    const originalMethod = descriptor.value;
+    descriptor.value = async function (...args) {
+        return originalMethod.apply(this, args);
+    };
+    return descriptor;
+}
+//# sourceMappingURL=helpers.js.map

package/dist/api/transactionSubmission/helpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../../../src/api/transactionSubmission/helpers.ts"],"names":[],"mappings":"AAGA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+CG;AACH,MAAM,UAAU,gCAAgC,CAC9C,MAAmB,EACnB,IAI8B;IAE9B,yDAAyD;IACzD,IAAI,MAAM,CAAC,uBAAuB,EAAE,KAAK,SAAS,IAAI,IAAI,CAAC,oBAAoB,KAAK,SAAS,EAAE,CAAC;QAC9F,OAAO;IACT,CAAC;IAED,IAAI,IAAI,CAAC,WAAW,CAAC,eAAe,IAAI,CAAC,IAAI,CAAC,qBAAqB,EAAE,CAAC;QACpE,MAAM,IAAI,KAAK,CAAC,kFAAkF,CAAC,CAAC;IACtG,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,MAAM,UAAU,gCAAgC,CAAC,MAAe,EAAE,WAAmB,EAAE,UAA8B;IACnH,MAAM,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;IACxC,UAAU,CAAC,KAAK,GAAG,KAAK,WAAW,GAAG,IAAW;QAC/C,OAAO,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAC1C,CAAC,CAAC;IAEF,OAAO,UAAU,CAAC;AACpB,CAAC"}

package/dist/api/transactionSubmission/management.d.ts

@@ -0,0 +1,159 @@
+import { EventEmitter } from "eventemitter3";
+import { TransactionWorkerEvents, TransactionWorker } from "../../transactions/management/index.js";
+import { InputGenerateTransactionPayloadData, InputGenerateTransactionOptions } from "../../transactions/index.js";
+import { AptosConfig } from "../aptosConfig.js";
+import { Account } from "../../account/index.js";
+export declare class TransactionManagement extends EventEmitter<TransactionWorkerEvents> {
+    account: Account;
+    transactionWorker: TransactionWorker;
+    readonly config: AptosConfig;
+    /**
+     * Initializes a new instance of the Aptos client with the provided configuration settings.
+     * This allows you to interact with the Aptos blockchain using the specified network and options.
+     *
+     * @param config - The configuration settings for the Aptos client.
+     * @param config.network - The network to connect to (e.g., TESTNET, MAINNET).
+     * @param config.nodeUrl - The URL of the Aptos node to connect to.
+     * @param config.account - Optional account settings for authentication.
+     *
+     * @example
+     * ```typescript
+     * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
+     *
+     * async function runExample() {
+     *     // Create a configuration for the Aptos client
+     *     const config = new AptosConfig({
+     *         network: Network.TESTNET, // specify the network to use
+     *         nodeUrl: "https://testnet.aptos.dev" // replace with your node URL
+     *     });
+     *
+     *     // Initialize the Aptos client with the configuration
+     *     const aptos = new Aptos(config);
+     *
+     *     console.log("Aptos client initialized successfully.");
+     * }
+     * runExample().catch(console.error);
+     * ```
+     * @group Implementation
+     */
+    constructor(config: AptosConfig);
+    /**
+     * Initializes the transaction worker using the provided sender account and begins listening for events.
+     * This function is essential for setting up the transaction processing environment.
+     *
+     * @param args - The arguments for starting the transaction worker.
+     * @param args.sender - The sender account to sign and submit the transaction.
+     *
+     * @example
+     * ```typescript
+     * import { Aptos, AptosConfig, Network, Account } from "@aptos-labs/ts-sdk";
+     *
+     * const config = new AptosConfig({ network: Network.TESTNET });
+     * const aptos = new Aptos(config);
+     *
+     * async function runExample() {
+     *     const sender = Account.generate(); // Generate a new account for sending transactions
+     *
+     *     // Start the transaction worker with the sender account
+     *     aptos.start({ sender });
+     *
+     *     console.log("Transaction worker started with sender:", sender.accountAddress);
+     * }
+     * runExample().catch(console.error);
+     * ```
+     * @group Implementation
+     */
+    private start;
+    /**
+     * Pushes transaction data to the transaction worker for processing.
+     *
+     * @param args.data An array of transaction payloads to be processed.
+     * @param args.options Optional. Transaction generation configurations (excluding accountSequenceNumber).
+     *
+     * @example
+     * ```typescript
+     * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
+     *
+     * const config = new AptosConfig({ network: Network.TESTNET });
+     * const aptos = new Aptos(config);
+     *
+     * async function runExample() {
+     *   // Prepare transaction payloads
+     *   const payloads = [
+     *      {}, // Build your first transaction payload
+     *      {}, // Build your second transaction payload
+     *   ];
+     *
+     *   // Push transaction data to the worker
+     *   aptos.push({
+     *     data: payloads,
+     *     {}, // Specify options as needed
+     *   });
+     *
+     *   console.log("Transaction data pushed successfully.");
+     * }
+     * runExample().catch(console.error);
+     * ```
+     * @group Implementation
+     */
+    private push;
+    /**
+     * Starts listening to transaction worker events, allowing the application to respond to transaction status changes.
+     * This function enables the application to handle events such as transaction sent, execution success, or failure.
+     *
+     * @example
+     * ```typescript
+     * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
+     *
+     * const config = new AptosConfig({ network: Network.TESTNET });
+     * const aptos = new Aptos(config);
+     *
+     * async function runExample() {
+     *   // Register to listen for transaction events
+     *   aptos.registerToEvents();
+     *
+     *   // You can send a transaction here to see the events in action
+     *   const sender = Account.generate(); // replace with a real account
+     *   const destination = Account.generate(); // replace with a real account
+     *
+     *   const transaction = await aptos.transaction.build.simple({
+     *     sender: sender.accountAddress,
+     *     data: {
+     *       function: "0x1::aptos_account::transfer",
+     *       functionArguments: [destination.accountAddress, 100],
+     *     },
+     *   });
+     *
+     *   await aptos.transaction.send(transaction);
+     *
+     *   console.log("Transaction sent and events registered.");
+     * }
+     * runExample().catch(console.error);
+     * ```
+     * @group Implementation
+     */
+    private registerToEvents;
+    /**
+     * Send batch transactions for a single account.
+     *
+     * This function uses a transaction worker that receives payloads to be processed
+     * and submitted to chain.
+     * Note that this process is best for submitting multiple transactions that
+     * don't rely on each other, i.e. batch funds, batch token mints, etc.
+     *
+     * If any worker failure, the functions throws an error.
+     *
+     * @param args.sender The sender account to sign and submit the transaction
+     * @param args.data An array of transaction payloads
+     * @param args.options optional. Transaction generation configurations (excluding accountSequenceNumber)
+     *
+     * @return void. Throws if any error
+     * @group Implementation
+     */
+    forSingleAccount(args: {
+        sender: Account;
+        data: InputGenerateTransactionPayloadData[];
+        options?: Omit<InputGenerateTransactionOptions, "accountSequenceNumber">;
+    }): void;
+}
+//# sourceMappingURL=management.d.ts.map

package/dist/api/transactionSubmission/management.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"management.d.ts","sourceRoot":"","sources":["../../../src/api/transactionSubmission/management.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,EACL,uBAAuB,EACvB,iBAAiB,EAElB,MAAM,wCAAwC,CAAC;AAChD,OAAO,EAAE,mCAAmC,EAAE,+BAA+B,EAAE,MAAM,6BAA6B,CAAC;AACnH,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AAEjD,qBAAa,qBAAsB,SAAQ,YAAY,CAAC,uBAAuB,CAAC;IAC9E,OAAO,EAAG,OAAO,CAAC;IAElB,iBAAiB,EAAG,iBAAiB,CAAC;IAEtC,QAAQ,CAAC,MAAM,EAAE,WAAW,CAAC;IAE7B;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;gBACS,MAAM,EAAE,WAAW;IAK/B;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,OAAO,CAAC,KAAK;IASb;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,OAAO,CAAC,IAAI;IAWZ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,OAAO,CAAC,gBAAgB;IAmBxB;;;;;;;;;;;;;;;;OAgBG;IACH,gBAAgB,CAAC,IAAI,EAAE;QACrB,MAAM,EAAE,OAAO,CAAC;QAChB,IAAI,EAAE,mCAAmC,EAAE,CAAC;QAC5C,OAAO,CAAC,EAAE,IAAI,CAAC,+BAA+B,EAAE,uBAAuB,CAAC,CAAC;KAC1E,GAAG,IAAI;CAUT"}