@aptos-labs/ts-sdk 6.3.1 → 7.0.0

package/dist/transactions/management/transactionWorker.d.ts

@@ -0,0 +1,213 @@
+import { EventEmitter } from "eventemitter3";
+import { AptosConfig } from "../../api/aptosConfig.js";
+import { Account } from "../../account/index.js";
+import { PendingTransactionResponse } from "../../types/index.js";
+import { InputGenerateTransactionOptions, InputGenerateTransactionPayloadData } from "../types.js";
+import { AccountSequenceNumber } from "./accountSequenceNumber.js";
+import { AsyncQueue } from "./asyncQueue.js";
+import { SimpleTransaction } from "../instances/simpleTransaction.js";
+/**
+ * @group Implementation
+ * @category Transactions
+ */
+export declare const promiseFulfilledStatus = "fulfilled";
+/**
+ * Events emitted by the transaction worker during its operation, allowing the dapp to respond to various transaction states.
+ * @group Implementation
+ * @category Transactions
+ */
+export declare enum TransactionWorkerEventsEnum {
+    TransactionSent = "transactionSent",
+    TransactionSendFailed = "transactionSendFailed",
+    TransactionExecuted = "transactionExecuted",
+    TransactionExecutionFailed = "transactionExecutionFailed",
+    ExecutionFinish = "executionFinish"
+}
+/**
+ * Defines the events emitted by the transaction worker during various stages of transaction processing. *
+ * @group Implementation
+ * @category Transactions
+ */
+export interface TransactionWorkerEvents {
+    transactionSent: (data: SuccessEventData) => void;
+    transactionSendFailed: (data: FailureEventData) => void;
+    transactionExecuted: (data: SuccessEventData) => void;
+    transactionExecutionFailed: (data: FailureEventData) => void;
+    executionFinish: (data: ExecutionFinishEventData) => void;
+}
+/**
+ * The payload for when the worker has finished its job.
+ * @group Implementation
+ * @category Transactions
+ */
+export type ExecutionFinishEventData = {
+    message: string;
+};
+/**
+ * The payload for a success event.
+ * @group Implementation
+ * @category Transactions
+ */
+export type SuccessEventData = {
+    message: string;
+    transactionHash: string;
+};
+/**
+ * The payload for a failure event.
+ * @group Implementation
+ * @category Transactions
+ */
+export type FailureEventData = {
+    message: string;
+    error: string;
+};
+/**
+ * TransactionWorker provides a simple framework for receiving payloads to be processed.
+ *
+ * Once one `start()` the process and pushes a new transaction, the worker acquires
+ * the current account's next sequence number (by using the AccountSequenceNumber class),
+ * generates a signed transaction and pushes an async submission process into the `outstandingTransactions` queue.
+ * At the same time, the worker processes transactions by reading the `outstandingTransactions` queue
+ * and submits the next transaction to chain, it
+ * 1) waits for resolution of the submission process or get pre-execution validation error
+ * and 2) waits for the resolution of the execution process or get an execution error.
+ * The worker fires events for any submission and/or execution success and/or failure.
+ * @group Implementation
+ * @category Transactions
+ */
+export declare class TransactionWorker extends EventEmitter<TransactionWorkerEvents> {
+    readonly aptosConfig: AptosConfig;
+    readonly account: Account;
+    readonly accountSequnceNumber: AccountSequenceNumber;
+    readonly taskQueue: AsyncQueue<() => Promise<void>>;
+    started: boolean;
+    /**
+     * transactions payloads waiting to be generated and signed
+     *
+     * TODO support entry function payload from ABI builder
+     * @group Implementation
+     * @category Transactions
+     */
+    transactionsQueue: AsyncQueue<[InputGenerateTransactionPayloadData, InputGenerateTransactionOptions | undefined]>;
+    /**
+     * signed transactions waiting to be submitted
+     * @group Implementation
+     * @category Transactions
+     */
+    outstandingTransactions: AsyncQueue<[Promise<PendingTransactionResponse>, bigint]>;
+    /**
+     * transactions that have been submitted to chain.
+     * Limited to MAX_TRANSACTION_HISTORY_SIZE entries to prevent unbounded memory growth.
+     * @group Implementation
+     * @category Transactions
+     */
+    sentTransactions: Array<[string, bigint, any]>;
+    /**
+     * transactions that have been committed to chain.
+     * Limited to MAX_TRANSACTION_HISTORY_SIZE entries to prevent unbounded memory growth.
+     * @group Implementation
+     * @category Transactions
+     */
+    executedTransactions: Array<[string, bigint, any]>;
+    /**
+     * Adds a transaction to the history array while enforcing the maximum size limit.
+     * Removes the oldest entries when the limit is exceeded.
+     * @private
+     */
+    private addToTransactionHistory;
+    /**
+     * Initializes a new instance of the class, providing a framework for receiving payloads to be processed.
+     *
+     * @param aptosConfig - A configuration object for Aptos.
+     * @param account - The account that will be used for sending transactions.
+     * @param maxWaitTime - The maximum wait time to wait before re-syncing the sequence number to the current on-chain state,
+     * default is 30 seconds.
+     * @param maximumInFlight - The maximum number of transactions that can be submitted per account, default is 100.
+     * @param sleepTime - The time to wait in seconds before re-evaluating if the maximum number of transactions are in flight,
+     * default is 10 seconds.
+     * @group Implementation
+     * @category Transactions
+     */
+    constructor(aptosConfig: AptosConfig, account: Account, maxWaitTime?: number, maximumInFlight?: number, sleepTime?: number);
+    /**
+     * Submits the next transaction for the account by generating it with the current sequence number
+     * and adding it to the outstanding transaction queue for processing.
+     * This function continues to submit transactions until there are no more to process.
+     *
+     * @throws {Error} Throws an error if the transaction submission fails.
+     * @group Implementation
+     * @category Transactions
+     */
+    submitNextTransaction(): Promise<void>;
+    /**
+     * Reads the outstanding transaction queue and submits the transactions to the chain.
+     * This function processes each transaction, checking their status and emitting events based on whether they were successfully
+     * sent or failed.
+     *
+     * @throws {Error} Throws an error if the process execution fails.
+     * @event TransactionWorkerEventsEnum.TransactionSent - Emitted when a transaction has been successfully committed to the chain.
+     * @event TransactionWorkerEventsEnum.TransactionSendFailed - Emitted when a transaction fails to commit, along with the error
+     * reason.
+     * @event TransactionWorkerEventsEnum.ExecutionFinish - Emitted when the execution of transactions is complete.
+     * @group Implementation
+     * @category Transactions
+     */
+    processTransactions(): Promise<void>;
+    /**
+     * Once a transaction has been sent to the chain, this function checks for its execution status.
+     * @param sentTransaction - The transaction that was sent to the chain and is now waiting to be executed.
+     * @param sequenceNumber - The account's sequence number that was sent with the transaction.
+     * @group Implementation
+     * @category Transactions
+     */
+    checkTransaction(sentTransaction: PromiseFulfilledResult<PendingTransactionResponse>, sequenceNumber: bigint): Promise<void>;
+    /**
+     * Pushes a transaction to the transactions queue for processing.
+     *
+     * @param transactionData - The transaction payload containing necessary details.
+     * @param transactionData.abi - For all entry function payloads, the ABI to skip remote ABI lookups.
+     * @param options - Optional parameters for transaction configuration.
+     * @param options.maxGasAmount - Maximum gas amount for the transaction.
+     * @param options.gasUnitPrice - Gas unit price for the transaction.
+     * @param options.expireTimestamp - Expiration timestamp on the transaction.
+     * @param options.accountSequenceNumber - The sequence number for the transaction.
+     * @group Implementation
+     * @category Transactions
+     */
+    push(transactionData: InputGenerateTransactionPayloadData, options?: InputGenerateTransactionOptions): Promise<void>;
+    /**
+     * Generates a signed transaction that can be submitted to the chain.
+     *
+     * @param account - An Aptos account used as the sender of the transaction.
+     * @param sequenceNumber - A sequence number the transaction will be generated with.
+     * @returns A signed transaction object or undefined if the transaction queue is empty.
+     * @group Implementation
+     * @category Transactions
+     */
+    generateNextTransaction(account: Account, sequenceNumber: bigint): Promise<SimpleTransaction | undefined>;
+    /**
+     * Starts transaction submission and processing by executing tasks from the queue until it is cancelled.
+     *
+     * @throws {Error} Throws an error if unable to start transaction batching.
+     * @group Implementation
+     * @category Transactions
+     */
+    run(): Promise<void>;
+    /**
+     * Starts the transaction management process.
+     *
+     * @throws {Error} Throws an error if the worker has already started.
+     * @group Implementation
+     * @category Transactions
+     */
+    start(): void;
+    /**
+     * Stops the transaction management process.
+     *
+     * @throws {Error} Throws an error if the worker has already stopped.
+     * @group Implementation
+     * @category Transactions
+     */
+    stop(): void;
+}
+//# sourceMappingURL=transactionWorker.d.ts.map

package/dist/transactions/management/transactionWorker.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transactionWorker.d.ts","sourceRoot":"","sources":["../../../src/transactions/management/transactionWorker.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AACvD,OAAO,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AAGjD,OAAO,EAAE,0BAA0B,EAAuB,MAAM,sBAAsB,CAAC;AACvF,OAAO,EAAE,+BAA+B,EAAE,mCAAmC,EAAE,MAAM,aAAa,CAAC;AACnG,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACnE,OAAO,EAAE,UAAU,EAA4B,MAAM,iBAAiB,CAAC;AACvE,OAAO,EAAE,iBAAiB,EAAE,MAAM,mCAAmC,CAAC;AAQtE;;;GAGG;AACH,eAAO,MAAM,sBAAsB,cAAc,CAAC;AAElD;;;;GAIG;AACH,oBAAY,2BAA2B;IAErC,eAAe,oBAAoB;IAEnC,qBAAqB,0BAA0B;IAE/C,mBAAmB,wBAAwB;IAE3C,0BAA0B,+BAA+B;IAEzD,eAAe,oBAAoB;CACpC;AAED;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACtC,eAAe,EAAE,CAAC,IAAI,EAAE,gBAAgB,KAAK,IAAI,CAAC;IAClD,qBAAqB,EAAE,CAAC,IAAI,EAAE,gBAAgB,KAAK,IAAI,CAAC;IACxD,mBAAmB,EAAE,CAAC,IAAI,EAAE,gBAAgB,KAAK,IAAI,CAAC;IACtD,0BAA0B,EAAE,CAAC,IAAI,EAAE,gBAAgB,KAAK,IAAI,CAAC;IAC7D,eAAe,EAAE,CAAC,IAAI,EAAE,wBAAwB,KAAK,IAAI,CAAC;CAC3D;AAED;;;;GAIG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,eAAe,EAAE,MAAM,CAAC;CACzB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,qBAAa,iBAAkB,SAAQ,YAAY,CAAC,uBAAuB,CAAC;IAC1E,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAElC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAI1B,QAAQ,CAAC,oBAAoB,EAAE,qBAAqB,CAAC;IAErD,QAAQ,CAAC,SAAS,EAAE,UAAU,CAAC,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC,CAAyC;IAG5F,OAAO,EAAE,OAAO,CAAC;IAEjB;;;;;;OAMG;IACH,iBAAiB,iGAEb;IAEJ;;;;OAIG;IACH,uBAAuB,4DAAmE;IAE1F;;;;;OAKG;IACH,gBAAgB,EAAE,KAAK,CAAC,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,CAAC,CAAC,CAAM;IAEpD;;;;;OAKG;IACH,oBAAoB,EAAE,KAAK,CAAC,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,CAAC,CAAC,CAAM;IAExD;;;;OAIG;IACH,OAAO,CAAC,uBAAuB;IAS/B;;;;;;;;;;;;OAYG;gBAED,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,OAAO,EAChB,WAAW,GAAE,MAAW,EACxB,eAAe,GAAE,MAAY,EAC7B,SAAS,GAAE,MAAW;IAexB;;;;;;;;OAQG;IACG,qBAAqB;IAsB3B;;;;;;;;;;;;OAYG;IACG,mBAAmB;IAwDzB;;;;;;OAMG;IACG,gBAAgB,CAAC,eAAe,EAAE,sBAAsB,CAAC,0BAA0B,CAAC,EAAE,cAAc,EAAE,MAAM;IAqClH;;;;;;;;;;;;OAYG;IACG,IAAI,CACR,eAAe,EAAE,mCAAmC,EACpD,OAAO,CAAC,EAAE,+BAA+B,GACxC,OAAO,CAAC,IAAI,CAAC;IAIhB;;;;;;;;OAQG;IACG,uBAAuB,CAAC,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,GAAG,SAAS,CAAC;IAW/G;;;;;;OAMG;IACG,GAAG;IAWT;;;;;;OAMG;IACH,KAAK;IAUL;;;;;;OAMG;IACH,IAAI;CAOL"}

package/dist/transactions/management/transactionWorker.js

@@ -0,0 +1,347 @@
+import { EventEmitter } from "eventemitter3";
+import { waitForTransaction } from "../../internal/transaction.js";
+import { generateTransaction, signAndSubmitTransaction } from "../../internal/transactionSubmission.js";
+import { AccountSequenceNumber } from "./accountSequenceNumber.js";
+import { AsyncQueue, AsyncQueueCancelledError } from "./asyncQueue.js";
+/**
+ * Maximum number of transactions to keep in the history arrays to prevent unbounded memory growth.
+ * When this limit is exceeded, the oldest entries are removed.
+ */
+const MAX_TRANSACTION_HISTORY_SIZE = 10000;
+/**
+ * @group Implementation
+ * @category Transactions
+ */
+export const promiseFulfilledStatus = "fulfilled";
+/**
+ * Events emitted by the transaction worker during its operation, allowing the dapp to respond to various transaction states.
+ * @group Implementation
+ * @category Transactions
+ */
+export var TransactionWorkerEventsEnum;
+(function (TransactionWorkerEventsEnum) {
+    // fired after a transaction gets sent to the chain
+    TransactionWorkerEventsEnum["TransactionSent"] = "transactionSent";
+    // fired if there is an error sending the transaction to the chain
+    TransactionWorkerEventsEnum["TransactionSendFailed"] = "transactionSendFailed";
+    // fired when a single transaction has executed successfully
+    TransactionWorkerEventsEnum["TransactionExecuted"] = "transactionExecuted";
+    // fired if a single transaction fails in execution
+    TransactionWorkerEventsEnum["TransactionExecutionFailed"] = "transactionExecutionFailed";
+    // fired when the worker has finished its job / when the queue has been emptied
+    TransactionWorkerEventsEnum["ExecutionFinish"] = "executionFinish";
+})(TransactionWorkerEventsEnum || (TransactionWorkerEventsEnum = {}));
+/**
+ * TransactionWorker provides a simple framework for receiving payloads to be processed.
+ *
+ * Once one `start()` the process and pushes a new transaction, the worker acquires
+ * the current account's next sequence number (by using the AccountSequenceNumber class),
+ * generates a signed transaction and pushes an async submission process into the `outstandingTransactions` queue.
+ * At the same time, the worker processes transactions by reading the `outstandingTransactions` queue
+ * and submits the next transaction to chain, it
+ * 1) waits for resolution of the submission process or get pre-execution validation error
+ * and 2) waits for the resolution of the execution process or get an execution error.
+ * The worker fires events for any submission and/or execution success and/or failure.
+ * @group Implementation
+ * @category Transactions
+ */
+export class TransactionWorker extends EventEmitter {
+    aptosConfig;
+    account;
+    // current account sequence number
+    // TODO: Rename Sequnce -> Sequence
+    accountSequnceNumber;
+    taskQueue = new AsyncQueue();
+    // process has started
+    started;
+    /**
+     * transactions payloads waiting to be generated and signed
+     *
+     * TODO support entry function payload from ABI builder
+     * @group Implementation
+     * @category Transactions
+     */
+    transactionsQueue = new AsyncQueue();
+    /**
+     * signed transactions waiting to be submitted
+     * @group Implementation
+     * @category Transactions
+     */
+    outstandingTransactions = new AsyncQueue();
+    /**
+     * transactions that have been submitted to chain.
+     * Limited to MAX_TRANSACTION_HISTORY_SIZE entries to prevent unbounded memory growth.
+     * @group Implementation
+     * @category Transactions
+     */
+    sentTransactions = [];
+    /**
+     * transactions that have been committed to chain.
+     * Limited to MAX_TRANSACTION_HISTORY_SIZE entries to prevent unbounded memory growth.
+     * @group Implementation
+     * @category Transactions
+     */
+    executedTransactions = [];
+    /**
+     * Adds a transaction to the history array while enforcing the maximum size limit.
+     * Removes the oldest entries when the limit is exceeded.
+     * @private
+     */
+    addToTransactionHistory(history, entry) {
+        history.push(entry);
+        // Remove oldest entries if we exceed the limit (remove ~10% when triggered)
+        if (history.length > MAX_TRANSACTION_HISTORY_SIZE) {
+            const removeCount = Math.ceil(MAX_TRANSACTION_HISTORY_SIZE * 0.1);
+            history.splice(0, removeCount);
+        }
+    }
+    /**
+     * Initializes a new instance of the class, providing a framework for receiving payloads to be processed.
+     *
+     * @param aptosConfig - A configuration object for Aptos.
+     * @param account - The account that will be used for sending transactions.
+     * @param maxWaitTime - The maximum wait time to wait before re-syncing the sequence number to the current on-chain state,
+     * default is 30 seconds.
+     * @param maximumInFlight - The maximum number of transactions that can be submitted per account, default is 100.
+     * @param sleepTime - The time to wait in seconds before re-evaluating if the maximum number of transactions are in flight,
+     * default is 10 seconds.
+     * @group Implementation
+     * @category Transactions
+     */
+    constructor(aptosConfig, account, maxWaitTime = 30, maximumInFlight = 100, sleepTime = 10) {
+        super();
+        this.aptosConfig = aptosConfig;
+        this.account = account;
+        this.started = false;
+        this.accountSequnceNumber = new AccountSequenceNumber(aptosConfig, account, maxWaitTime, maximumInFlight, sleepTime);
+    }
+    /**
+     * Submits the next transaction for the account by generating it with the current sequence number
+     * and adding it to the outstanding transaction queue for processing.
+     * This function continues to submit transactions until there are no more to process.
+     *
+     * @throws {Error} Throws an error if the transaction submission fails.
+     * @group Implementation
+     * @category Transactions
+     */
+    async submitNextTransaction() {
+        try {
+            while (true) {
+                const sequenceNumber = await this.accountSequnceNumber.nextSequenceNumber();
+                if (sequenceNumber === null)
+                    return;
+                const transaction = await this.generateNextTransaction(this.account, sequenceNumber);
+                if (!transaction)
+                    return;
+                const pendingTransaction = signAndSubmitTransaction({
+                    aptosConfig: this.aptosConfig,
+                    transaction,
+                    signer: this.account,
+                });
+                await this.outstandingTransactions.enqueue([pendingTransaction, sequenceNumber]);
+            }
+        }
+        catch (error) {
+            if (error instanceof AsyncQueueCancelledError) {
+                return;
+            }
+            throw new Error(`Submit transaction failed for ${this.account.accountAddress.toString()} with error ${error}`);
+        }
+    }
+    /**
+     * Reads the outstanding transaction queue and submits the transactions to the chain.
+     * This function processes each transaction, checking their status and emitting events based on whether they were successfully
+     * sent or failed.
+     *
+     * @throws {Error} Throws an error if the process execution fails.
+     * @event TransactionWorkerEventsEnum.TransactionSent - Emitted when a transaction has been successfully committed to the chain.
+     * @event TransactionWorkerEventsEnum.TransactionSendFailed - Emitted when a transaction fails to commit, along with the error
+     * reason.
+     * @event TransactionWorkerEventsEnum.ExecutionFinish - Emitted when the execution of transactions is complete.
+     * @group Implementation
+     * @category Transactions
+     */
+    async processTransactions() {
+        try {
+            while (true) {
+                const awaitingTransactions = [];
+                const sequenceNumbers = [];
+                let [pendingTransaction, sequenceNumber] = await this.outstandingTransactions.dequeue();
+                awaitingTransactions.push(pendingTransaction);
+                sequenceNumbers.push(sequenceNumber);
+                while (!this.outstandingTransactions.isEmpty()) {
+                    [pendingTransaction, sequenceNumber] = await this.outstandingTransactions.dequeue();
+                    awaitingTransactions.push(pendingTransaction);
+                    sequenceNumbers.push(sequenceNumber);
+                }
+                // send awaiting transactions to chain
+                const sentTransactions = await Promise.allSettled(awaitingTransactions);
+                for (let i = 0; i < sentTransactions.length && i < sequenceNumbers.length; i += 1) {
+                    // check sent transaction status
+                    const sentTransaction = sentTransactions[i];
+                    sequenceNumber = sequenceNumbers[i];
+                    if (sentTransaction.status === promiseFulfilledStatus) {
+                        // transaction sent to chain
+                        this.addToTransactionHistory(this.sentTransactions, [sentTransaction.value.hash, sequenceNumber, null]);
+                        // check sent transaction execution
+                        this.emit(TransactionWorkerEventsEnum.TransactionSent, {
+                            message: `transaction hash ${sentTransaction.value.hash} has been committed to chain`,
+                            transactionHash: sentTransaction.value.hash,
+                        });
+                        await this.checkTransaction(sentTransaction, sequenceNumber);
+                    }
+                    else {
+                        // send transaction failed
+                        this.addToTransactionHistory(this.sentTransactions, [
+                            sentTransaction.status,
+                            sequenceNumber,
+                            sentTransaction.reason,
+                        ]);
+                        this.emit(TransactionWorkerEventsEnum.TransactionSendFailed, {
+                            message: `failed to commit transaction ${this.sentTransactions.length} with error ${sentTransaction.reason}`,
+                            error: sentTransaction.reason,
+                        });
+                    }
+                }
+                this.emit(TransactionWorkerEventsEnum.ExecutionFinish, {
+                    message: `execute ${sentTransactions.length} transactions finished`,
+                });
+            }
+        }
+        catch (error) {
+            if (error instanceof AsyncQueueCancelledError) {
+                return;
+            }
+            throw new Error(`Process execution failed for ${this.account.accountAddress.toString()} with error ${error}`);
+        }
+    }
+    /**
+     * Once a transaction has been sent to the chain, this function checks for its execution status.
+     * @param sentTransaction - The transaction that was sent to the chain and is now waiting to be executed.
+     * @param sequenceNumber - The account's sequence number that was sent with the transaction.
+     * @group Implementation
+     * @category Transactions
+     */
+    async checkTransaction(sentTransaction, sequenceNumber) {
+        try {
+            const waitFor = [];
+            waitFor.push(waitForTransaction({ aptosConfig: this.aptosConfig, transactionHash: sentTransaction.value.hash }));
+            const sentTransactions = await Promise.allSettled(waitFor);
+            for (let i = 0; i < sentTransactions.length; i += 1) {
+                const executedTransaction = sentTransactions[i];
+                if (executedTransaction.status === promiseFulfilledStatus) {
+                    // transaction executed to chain
+                    this.addToTransactionHistory(this.executedTransactions, [
+                        executedTransaction.value.hash,
+                        sequenceNumber,
+                        null,
+                    ]);
+                    this.emit(TransactionWorkerEventsEnum.TransactionExecuted, {
+                        message: `transaction hash ${executedTransaction.value.hash} has been executed on chain`,
+                        transactionHash: sentTransaction.value.hash,
+                    });
+                }
+                else {
+                    // transaction execution failed
+                    this.addToTransactionHistory(this.executedTransactions, [
+                        executedTransaction.status,
+                        sequenceNumber,
+                        executedTransaction.reason,
+                    ]);
+                    this.emit(TransactionWorkerEventsEnum.TransactionExecutionFailed, {
+                        message: `failed to execute transaction ${this.executedTransactions.length} with error ${executedTransaction.reason}`,
+                        error: executedTransaction.reason,
+                    });
+                }
+            }
+        }
+        catch (error) {
+            throw new Error(`Check transaction failed for ${this.account.accountAddress.toString()} with error ${error}`);
+        }
+    }
+    /**
+     * Pushes a transaction to the transactions queue for processing.
+     *
+     * @param transactionData - The transaction payload containing necessary details.
+     * @param transactionData.abi - For all entry function payloads, the ABI to skip remote ABI lookups.
+     * @param options - Optional parameters for transaction configuration.
+     * @param options.maxGasAmount - Maximum gas amount for the transaction.
+     * @param options.gasUnitPrice - Gas unit price for the transaction.
+     * @param options.expireTimestamp - Expiration timestamp on the transaction.
+     * @param options.accountSequenceNumber - The sequence number for the transaction.
+     * @group Implementation
+     * @category Transactions
+     */
+    async push(transactionData, options) {
+        this.transactionsQueue.enqueue([transactionData, options]);
+    }
+    /**
+     * Generates a signed transaction that can be submitted to the chain.
+     *
+     * @param account - An Aptos account used as the sender of the transaction.
+     * @param sequenceNumber - A sequence number the transaction will be generated with.
+     * @returns A signed transaction object or undefined if the transaction queue is empty.
+     * @group Implementation
+     * @category Transactions
+     */
+    async generateNextTransaction(account, sequenceNumber) {
+        if (this.transactionsQueue.isEmpty())
+            return undefined;
+        const [transactionData, options] = await this.transactionsQueue.dequeue();
+        return generateTransaction({
+            aptosConfig: this.aptosConfig,
+            sender: account.accountAddress,
+            data: transactionData,
+            options: { ...options, accountSequenceNumber: sequenceNumber, replayProtectionNonce: undefined },
+        });
+    }
+    /**
+     * Starts transaction submission and processing by executing tasks from the queue until it is cancelled.
+     *
+     * @throws {Error} Throws an error if unable to start transaction batching.
+     * @group Implementation
+     * @category Transactions
+     */
+    async run() {
+        try {
+            while (!this.taskQueue.isCancelled()) {
+                const task = await this.taskQueue.dequeue();
+                await task();
+            }
+        }
+        catch (error) {
+            throw new Error(`Unable to start transaction batching: ${error}`);
+        }
+    }
+    /**
+     * Starts the transaction management process.
+     *
+     * @throws {Error} Throws an error if the worker has already started.
+     * @group Implementation
+     * @category Transactions
+     */
+    start() {
+        if (this.started) {
+            throw new Error("worker has already started");
+        }
+        this.started = true;
+        this.taskQueue.enqueue(() => this.submitNextTransaction());
+        this.taskQueue.enqueue(() => this.processTransactions());
+        this.run();
+    }
+    /**
+     * Stops the transaction management process.
+     *
+     * @throws {Error} Throws an error if the worker has already stopped.
+     * @group Implementation
+     * @category Transactions
+     */
+    stop() {
+        if (this.taskQueue.isCancelled()) {
+            throw new Error("worker has already stopped");
+        }
+        this.started = false;
+        this.taskQueue.cancel();
+    }
+}
+//# sourceMappingURL=transactionWorker.js.map

package/dist/transactions/management/transactionWorker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transactionWorker.js","sourceRoot":"","sources":["../../../src/transactions/management/transactionWorker.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAG7C,OAAO,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AACnE,OAAO,EAAE,mBAAmB,EAAE,wBAAwB,EAAE,MAAM,yCAAyC,CAAC;AAGxG,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACnE,OAAO,EAAE,UAAU,EAAE,wBAAwB,EAAE,MAAM,iBAAiB,CAAC;AAGvE;;;GAGG;AACH,MAAM,4BAA4B,GAAG,KAAK,CAAC;AAE3C;;;GAGG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,WAAW,CAAC;AAElD;;;;GAIG;AACH,MAAM,CAAN,IAAY,2BAWX;AAXD,WAAY,2BAA2B;IACrC,mDAAmD;IACnD,kEAAmC,CAAA;IACnC,kEAAkE;IAClE,8EAA+C,CAAA;IAC/C,4DAA4D;IAC5D,0EAA2C,CAAA;IAC3C,mDAAmD;IACnD,wFAAyD,CAAA;IACzD,+EAA+E;IAC/E,kEAAmC,CAAA;AACrC,CAAC,EAXW,2BAA2B,KAA3B,2BAA2B,QAWtC;AA4CD;;;;;;;;;;;;;GAaG;AACH,MAAM,OAAO,iBAAkB,SAAQ,YAAqC;IACjE,WAAW,CAAc;IAEzB,OAAO,CAAU;IAE1B,kCAAkC;IAClC,mCAAmC;IAC1B,oBAAoB,CAAwB;IAE5C,SAAS,GAAoC,IAAI,UAAU,EAAuB,CAAC;IAE5F,sBAAsB;IACtB,OAAO,CAAU;IAEjB;;;;;;OAMG;IACH,iBAAiB,GAAG,IAAI,UAAU,EAE/B,CAAC;IAEJ;;;;OAIG;IACH,uBAAuB,GAAG,IAAI,UAAU,EAAiD,CAAC;IAE1F;;;;;OAKG;IACH,gBAAgB,GAAiC,EAAE,CAAC;IAEpD;;;;;OAKG;IACH,oBAAoB,GAAiC,EAAE,CAAC;IAExD;;;;OAIG;IACK,uBAAuB,CAAC,OAAqC,EAAE,KAA4B;QACjG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACpB,4EAA4E;QAC5E,IAAI,OAAO,CAAC,MAAM,GAAG,4BAA4B,EAAE,CAAC;YAClD,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,4BAA4B,GAAG,GAAG,CAAC,CAAC;YAClE,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC;QACjC,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,YACE,WAAwB,EACxB,OAAgB,EAChB,cAAsB,EAAE,EACxB,kBAA0B,GAAG,EAC7B,YAAoB,EAAE;QAEtB,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;QACrB,IAAI,CAAC,oBAAoB,GAAG,IAAI,qBAAqB,CACnD,WAAW,EACX,OAAO,EACP,WAAW,EACX,eAAe,EACf,SAAS,CACV,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,qBAAqB;QACzB,IAAI,CAAC;YACH,OAAO,IAAI,EAAE,CAAC;gBACZ,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,oBAAoB,CAAC,kBAAkB,EAAE,CAAC;gBAC5E,IAAI,cAAc,KAAK,IAAI;oBAAE,OAAO;gBACpC,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;gBACrF,IAAI,CAAC,WAAW;oBAAE,OAAO;gBACzB,MAAM,kBAAkB,GAAG,wBAAwB,CAAC;oBAClD,WAAW,EAAE,IAAI,CAAC,WAAW;oBAC7B,WAAW;oBACX,MAAM,EAAE,IAAI,CAAC,OAAO;iBACrB,CAAC,CAAC;gBACH,MAAM,IAAI,CAAC,uBAAuB,CAAC,OAAO,CAAC,CAAC,kBAAkB,EAAE,cAAc,CAAC,CAAC,CAAC;YACnF,CAAC;QACH,CAAC;QAAC,OAAO,KAAU,EAAE,CAAC;YACpB,IAAI,KAAK,YAAY,wBAAwB,EAAE,CAAC;gBAC9C,OAAO;YACT,CAAC;YACD,MAAM,IAAI,KAAK,CAAC,iCAAiC,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,QAAQ,EAAE,eAAe,KAAK,EAAE,CAAC,CAAC;QACjH,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,mBAAmB;QACvB,IAAI,CAAC;YACH,OAAO,IAAI,EAAE,CAAC;gBACZ,MAAM,oBAAoB,GAAG,EAAE,CAAC;gBAChC,MAAM,eAAe,GAAG,EAAE,CAAC;gBAC3B,IAAI,CAAC,kBAAkB,EAAE,cAAc,CAAC,GAAG,MAAM,IAAI,CAAC,uBAAuB,CAAC,OAAO,EAAE,CAAC;gBAExF,oBAAoB,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;gBAC9C,eAAe,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;gBAErC,OAAO,CAAC,IAAI,CAAC,uBAAuB,CAAC,OAAO,EAAE,EAAE,CAAC;oBAC/C,CAAC,kBAAkB,EAAE,cAAc,CAAC,GAAG,MAAM,IAAI,CAAC,uBAAuB,CAAC,OAAO,EAAE,CAAC;oBAEpF,oBAAoB,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;oBAC9C,eAAe,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;gBACvC,CAAC;gBACD,sCAAsC;gBACtC,MAAM,gBAAgB,GAAG,MAAM,OAAO,CAAC,UAAU,CAAC,oBAAoB,CAAC,CAAC;gBACxE,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,gBAAgB,CAAC,MAAM,IAAI,CAAC,GAAG,eAAe,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;oBAClF,gCAAgC;oBAChC,MAAM,eAAe,GAAG,gBAAgB,CAAC,CAAC,CAAC,CAAC;oBAC5C,cAAc,GAAG,eAAe,CAAC,CAAC,CAAC,CAAC;oBACpC,IAAI,eAAe,CAAC,MAAM,KAAK,sBAAsB,EAAE,CAAC;wBACtD,4BAA4B;wBAC5B,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC,eAAe,CAAC,KAAK,CAAC,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,CAAC,CAAC;wBACxG,mCAAmC;wBACnC,IAAI,CAAC,IAAI,CAAC,2BAA2B,CAAC,eAAe,EAAE;4BACrD,OAAO,EAAE,oBAAoB,eAAe,CAAC,KAAK,CAAC,IAAI,8BAA8B;4BACrF,eAAe,EAAE,eAAe,CAAC,KAAK,CAAC,IAAI;yBAC5C,CAAC,CAAC;wBACH,MAAM,IAAI,CAAC,gBAAgB,CAAC,eAAe,EAAE,cAAc,CAAC,CAAC;oBAC/D,CAAC;yBAAM,CAAC;wBACN,0BAA0B;wBAC1B,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,gBAAgB,EAAE;4BAClD,eAAe,CAAC,MAAM;4BACtB,cAAc;4BACd,eAAe,CAAC,MAAM;yBACvB,CAAC,CAAC;wBACH,IAAI,CAAC,IAAI,CAAC,2BAA2B,CAAC,qBAAqB,EAAE;4BAC3D,OAAO,EAAE,gCAAgC,IAAI,CAAC,gBAAgB,CAAC,MAAM,eAAe,eAAe,CAAC,MAAM,EAAE;4BAC5G,KAAK,EAAE,eAAe,CAAC,MAAM;yBAC9B,CAAC,CAAC;oBACL,CAAC;gBACH,CAAC;gBACD,IAAI,CAAC,IAAI,CAAC,2BAA2B,CAAC,eAAe,EAAE;oBACrD,OAAO,EAAE,WAAW,gBAAgB,CAAC,MAAM,wBAAwB;iBACpE,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QAAC,OAAO,KAAU,EAAE,CAAC;YACpB,IAAI,KAAK,YAAY,wBAAwB,EAAE,CAAC;gBAC9C,OAAO;YACT,CAAC;YACD,MAAM,IAAI,KAAK,CAAC,gCAAgC,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,QAAQ,EAAE,eAAe,KAAK,EAAE,CAAC,CAAC;QAChH,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,gBAAgB,CAAC,eAAmE,EAAE,cAAsB;QAChH,IAAI,CAAC;YACH,MAAM,OAAO,GAAwC,EAAE,CAAC;YACxD,OAAO,CAAC,IAAI,CAAC,kBAAkB,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,WAAW,EAAE,eAAe,EAAE,eAAe,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;YACjH,MAAM,gBAAgB,GAAG,MAAM,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;YAE3D,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,gBAAgB,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;gBACpD,MAAM,mBAAmB,GAAG,gBAAgB,CAAC,CAAC,CAAC,CAAC;gBAChD,IAAI,mBAAmB,CAAC,MAAM,KAAK,sBAAsB,EAAE,CAAC;oBAC1D,gCAAgC;oBAChC,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,oBAAoB,EAAE;wBACtD,mBAAmB,CAAC,KAAK,CAAC,IAAI;wBAC9B,cAAc;wBACd,IAAI;qBACL,CAAC,CAAC;oBACH,IAAI,CAAC,IAAI,CAAC,2BAA2B,CAAC,mBAAmB,EAAE;wBACzD,OAAO,EAAE,oBAAoB,mBAAmB,CAAC,KAAK,CAAC,IAAI,6BAA6B;wBACxF,eAAe,EAAE,eAAe,CAAC,KAAK,CAAC,IAAI;qBAC5C,CAAC,CAAC;gBACL,CAAC;qBAAM,CAAC;oBACN,+BAA+B;oBAC/B,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,oBAAoB,EAAE;wBACtD,mBAAmB,CAAC,MAAM;wBAC1B,cAAc;wBACd,mBAAmB,CAAC,MAAM;qBAC3B,CAAC,CAAC;oBACH,IAAI,CAAC,IAAI,CAAC,2BAA2B,CAAC,0BAA0B,EAAE;wBAChE,OAAO,EAAE,iCAAiC,IAAI,CAAC,oBAAoB,CAAC,MAAM,eAAe,mBAAmB,CAAC,MAAM,EAAE;wBACrH,KAAK,EAAE,mBAAmB,CAAC,MAAM;qBAClC,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;QACH,CAAC;QAAC,OAAO,KAAU,EAAE,CAAC;YACpB,MAAM,IAAI,KAAK,CAAC,gCAAgC,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,QAAQ,EAAE,eAAe,KAAK,EAAE,CAAC,CAAC;QAChH,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,IAAI,CACR,eAAoD,EACpD,OAAyC;QAEzC,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,uBAAuB,CAAC,OAAgB,EAAE,cAAsB;QACpE,IAAI,IAAI,CAAC,iBAAiB,CAAC,OAAO,EAAE;YAAE,OAAO,SAAS,CAAC;QACvD,MAAM,CAAC,eAAe,EAAE,OAAO,CAAC,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAAC,OAAO,EAAE,CAAC;QAC1E,OAAO,mBAAmB,CAAC;YACzB,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,MAAM,EAAE,OAAO,CAAC,cAAc;YAC9B,IAAI,EAAE,eAAe;YACrB,OAAO,EAAE,EAAE,GAAG,OAAO,EAAE,qBAAqB,EAAE,cAAc,EAAE,qBAAqB,EAAE,SAAS,EAAE;SACjG,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,GAAG;QACP,IAAI,CAAC;YACH,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,EAAE,CAAC;gBACrC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC;gBAC5C,MAAM,IAAI,EAAE,CAAC;YACf,CAAC;QACH,CAAC;QAAC,OAAO,KAAU,EAAE,CAAC;YACpB,MAAM,IAAI,KAAK,CAAC,yCAAyC,KAAK,EAAE,CAAC,CAAC;QACpE,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACH,KAAK;QACH,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;QAChD,CAAC;QACD,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QACpB,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,qBAAqB,EAAE,CAAC,CAAC;QAC3D,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,mBAAmB,EAAE,CAAC,CAAC;QACzD,IAAI,CAAC,GAAG,EAAE,CAAC;IACb,CAAC;IAED;;;;;;OAMG;IACH,IAAI;QACF,IAAI,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,EAAE,CAAC;YACjC,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;QAChD,CAAC;QACD,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;QACrB,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC;IAC1B,CAAC;CACF"}

package/dist/transactions/transactionBuilder/encryptPayload.d.ts

@@ -0,0 +1,21 @@
+import { AptosConfig } from "../../api/aptosConfig.js";
+import { AccountAddressInput } from "../../core/index.js";
+import { TransactionPayloadEncryptedPayload } from "../instances/transactionPayload.js";
+import { AnyTransactionPayloadInstance, InputGenerateTransactionOptions } from "../types.js";
+/**
+ * Encrypts an entry-function/script/inner payload using the node's per-epoch batch encryption key.
+ * Validates `options.encrypted` requirements first.
+ *
+ * @group Implementation
+ * @category Transactions
+ */
+export declare function buildEncryptedPayload(args: {
+    aptosConfig: AptosConfig;
+    sender: AccountAddressInput;
+    payload: AnyTransactionPayloadInstance;
+    options: InputGenerateTransactionOptions;
+    feePayerAddress?: AccountAddressInput;
+    secondarySignerAddresses?: AccountAddressInput[];
+    replayProtectionNonce?: bigint;
+}): Promise<TransactionPayloadEncryptedPayload>;
+//# sourceMappingURL=encryptPayload.d.ts.map

package/dist/transactions/transactionBuilder/encryptPayload.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"encryptPayload.d.ts","sourceRoot":"","sources":["../../../src/transactions/transactionBuilder/encryptPayload.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AACvD,OAAO,EAAkB,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAa1E,OAAO,EAML,kCAAkC,EAEnC,MAAM,oCAAoC,CAAC;AAE5C,OAAO,EAAE,6BAA6B,EAA6B,+BAA+B,EAAE,MAAM,aAAa,CAAC;AAuJxH;;;;;;GAMG;AACH,wBAAsB,qBAAqB,CAAC,IAAI,EAAE;IAChD,WAAW,EAAE,WAAW,CAAC;IACzB,MAAM,EAAE,mBAAmB,CAAC;IAC5B,OAAO,EAAE,6BAA6B,CAAC;IACvC,OAAO,EAAE,+BAA+B,CAAC;IACzC,eAAe,CAAC,EAAE,mBAAmB,CAAC;IACtC,wBAAwB,CAAC,EAAE,mBAAmB,EAAE,CAAC;IACjD,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC,GAAG,OAAO,CAAC,kCAAkC,CAAC,CAyC9C"}