Class TransactionWorker

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

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.

Hierarchy (View Summary)

EventEmitter<TransactionWorkerEvents>
- TransactionWorker

Index

Implementation - Transactions

constructor

new TransactionWorker(
    aptosConfig: AptosConfig,
    account: Account,
    maxWaitTime?: number,
    maximumInFlight?: number,
    sleepTime?: number,
): TransactionWorker
Initializes a new instance of the class, providing a framework for receiving payloads to be processed.
Parameters
- aptosConfig: AptosConfig
  A configuration object for Aptos.
- account: Account
  The account that will be used for sending transactions.
- maxWaitTime: number = 30
  The maximum wait time to wait before re-syncing the sequence number to the current on-chain state, default is 30 seconds.
- maximumInFlight: number = 100
  The maximum number of transactions that can be submitted per account, default is 100.
- sleepTime: number = 10
  The time to wait in seconds before re-evaluating if the maximum number of transactions are in flight, default is 10 seconds.
Returns TransactionWorker
Overrides EventEmitter.constructor
- Defined in packages/ts-sdk/src/transactions/management/transactionWorker.ts:202

executedTransactions

executedTransactions: [string, bigint, any][] = []

transactions that have been committed to chain. Limited to MAX_TRANSACTION_HISTORY_SIZE entries to prevent unbounded memory growth.

outstandingTransactions

outstandingTransactions: AsyncQueue<
[Promise<PendingTransactionResponse>, bigint],
> = ...

signed transactions waiting to be submitted

sentTransactions

sentTransactions: [string, bigint, any][] = []

transactions that have been submitted to chain. Limited to MAX_TRANSACTION_HISTORY_SIZE entries to prevent unbounded memory growth.

transactionsQueue

transactionsQueue: AsyncQueue<
    [
        InputGenerateTransactionPayloadData,
        InputGenerateTransactionOptions
        | undefined,
    ],
> = ...

transactions payloads waiting to be generated and signed

TODO support entry function payload from ABI builder

checkTransaction

checkTransaction(
sentTransaction: PromiseFulfilledResult<PendingTransactionResponse>,
sequenceNumber: bigint,
): Promise<void>
Once a transaction has been sent to the chain, this function checks for its execution status.
Parameters
- sentTransaction: PromiseFulfilledResult<PendingTransactionResponse>
  The transaction that was sent to the chain and is now waiting to be executed.
- sequenceNumber: bigint
  The account's sequence number that was sent with the transaction.
Returns Promise<void>
- Defined in packages/ts-sdk/src/transactions/management/transactionWorker.ts:312

generateNextTransaction

generateNextTransaction(
account: Account,
sequenceNumber: bigint,
): Promise<SimpleTransaction | undefined>
Generates a signed transaction that can be submitted to the chain.
Parameters
- account: Account
  An Aptos account used as the sender of the transaction.
- sequenceNumber: bigint
  A sequence number the transaction will be generated with.
Returns Promise<SimpleTransaction | undefined>
A signed transaction object or undefined if the transaction queue is empty.
- Defined in packages/ts-sdk/src/transactions/management/transactionWorker.ts:378

processTransactions

processTransactions(): Promise<void>
Reads the outstanding transaction queue and checks each successfully submitted transaction's execution status.

Returns Promise<void>

Throws
Throws an error if the process execution fails. TransactionWorkerEventsEnum.TransactionExecuted - Emitted when a transaction executes successfully. TransactionWorkerEventsEnum.TransactionExecutionFailed - Emitted when a transaction fails during execution. TransactionWorkerEventsEnum.ExecutionFinish - Emitted when the execution of transactions is complete.
- Defined in packages/ts-sdk/src/transactions/management/transactionWorker.ts:266

push

push(
transactionData: InputGenerateTransactionPayloadData,
options?: InputGenerateTransactionOptions,
): Promise<void>
Pushes a transaction to the transactions queue for processing.
Parameters
- transactionData: InputGenerateTransactionPayloadData
  The transaction payload containing necessary details.
- Optionaloptions: InputGenerateTransactionOptions
  Optional parameters for transaction configuration.
Returns Promise<void>
- Defined in packages/ts-sdk/src/transactions/management/transactionWorker.ts:362

run

run(): Promise<void>
Starts transaction submission and processing by executing tasks from the queue until it is cancelled.

Returns Promise<void>

Throws
Throws an error if unable to start transaction batching.
- Defined in packages/ts-sdk/src/transactions/management/transactionWorker.ts:396

start

start(): void
Starts the transaction management process.

Returns void

Throws
Throws an error if the worker has already started.
- Defined in packages/ts-sdk/src/transactions/management/transactionWorker.ts:414

stop

stop(): void
Stops the transaction management process.

Returns void

Throws
Throws an error if the worker has already stopped.
- Defined in packages/ts-sdk/src/transactions/management/transactionWorker.ts:431

submitNextTransaction

submitNextTransaction(): Promise<void>
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.

Returns Promise<void>

Throws
Throws an error if the transaction submission fails. TransactionWorkerEventsEnum.TransactionSent - Emitted when a transaction is sent to the chain. TransactionWorkerEventsEnum.TransactionSendFailed - Emitted when a transaction fails to send.
- Defined in packages/ts-sdk/src/transactions/management/transactionWorker.ts:233

Events - Transactions

processTransactions

processTransactions(): Promise<void>
Reads the outstanding transaction queue and checks each successfully submitted transaction's execution status.

Returns Promise<void>

Throws
Throws an error if the process execution fails. TransactionWorkerEventsEnum.TransactionExecuted - Emitted when a transaction executes successfully. TransactionWorkerEventsEnum.TransactionExecutionFailed - Emitted when a transaction fails during execution. TransactionWorkerEventsEnum.ExecutionFinish - Emitted when the execution of transactions is complete.
- Defined in packages/ts-sdk/src/transactions/management/transactionWorker.ts:266

submitNextTransaction

submitNextTransaction(): Promise<void>
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.

Returns Promise<void>

Throws
Throws an error if the transaction submission fails. TransactionWorkerEventsEnum.TransactionSent - Emitted when a transaction is sent to the chain. TransactionWorkerEventsEnum.TransactionSendFailed - Emitted when a transaction fails to send.
- Defined in packages/ts-sdk/src/transactions/management/transactionWorker.ts:233

Methods

addListener

addListener<T extends keyof TransactionWorkerEvents>(
    event: T,
    fn: (
        ...args: EventEmitter.ArgumentMap<TransactionWorkerEvents>[Extract<
            T,
            keyof TransactionWorkerEvents,
        >],
    ) => void,
    context?: any,
): this
Type Parameters
- T extends keyof TransactionWorkerEvents
Parameters
- event: T
- fn: (
      ...args: EventEmitter.ArgumentMap<TransactionWorkerEvents>[Extract<
          T,
          keyof TransactionWorkerEvents,
      >],
  ) => void
- Optionalcontext: any
Returns this
Inherited from EventEmitter.addListener
- Defined in node_modules/.pnpm/eventemitter3@5.0.4/node_modules/eventemitter3/index.d.ts:45

emit

emit<T extends keyof TransactionWorkerEvents>(
    event: T,
    ...args: EventEmitter.ArgumentMap<TransactionWorkerEvents>[Extract<
        T,
        keyof TransactionWorkerEvents,
    >],
): boolean
Calls each of the listeners registered for a given event.
Type Parameters
- T extends keyof TransactionWorkerEvents
Parameters
- event: T
- ...args: EventEmitter.ArgumentMap<TransactionWorkerEvents>[Extract<
  T,
  keyof TransactionWorkerEvents,
  >]
Returns boolean
Inherited from EventEmitter.emit
- Defined in node_modules/.pnpm/eventemitter3@5.0.4/node_modules/eventemitter3/index.d.ts:32

eventNames

eventNames(): (keyof TransactionWorkerEvents)[]
Return an array listing the events for which the emitter has registered listeners.

Returns (keyof TransactionWorkerEvents)[]
Inherited from EventEmitter.eventNames
- Defined in node_modules/.pnpm/eventemitter3@5.0.4/node_modules/eventemitter3/index.d.ts:15

listenerCount

listenerCount(event: keyof TransactionWorkerEvents): number
Return the number of listeners listening to a given event.
Parameters
- event: keyof TransactionWorkerEvents
Returns number
Inherited from EventEmitter.listenerCount
- Defined in node_modules/.pnpm/eventemitter3@5.0.4/node_modules/eventemitter3/index.d.ts:27

listeners

listeners<T extends keyof TransactionWorkerEvents>(
    event: T,
): (
    (
        ...args: EventEmitter.ArgumentMap<TransactionWorkerEvents>[Extract<
            T,
            keyof TransactionWorkerEvents,
        >],
    ) => void
)[]
Return the listeners registered for a given event.
Type Parameters
- T extends keyof TransactionWorkerEvents
Parameters
- event: T
Returns (
    (
        ...args: EventEmitter.ArgumentMap<TransactionWorkerEvents>[Extract<
            T,
            keyof TransactionWorkerEvents,
        >],
    ) => void
)[]
Inherited from EventEmitter.listeners
- Defined in node_modules/.pnpm/eventemitter3@5.0.4/node_modules/eventemitter3/index.d.ts:20

off

off<T extends keyof TransactionWorkerEvents>(
    event: T,
    fn?: (
        ...args: EventEmitter.ArgumentMap<TransactionWorkerEvents>[Extract<
            T,
            keyof TransactionWorkerEvents,
        >],
    ) => void,
    context?: any,
    once?: boolean,
): this
Type Parameters
- T extends keyof TransactionWorkerEvents
Parameters
- event: T
- Optionalfn: (
      ...args: EventEmitter.ArgumentMap<TransactionWorkerEvents>[Extract<
          T,
          keyof TransactionWorkerEvents,
      >],
  ) => void
- Optionalcontext: any
- Optionalonce: boolean
Returns this
Inherited from EventEmitter.off
- Defined in node_modules/.pnpm/eventemitter3@5.0.4/node_modules/eventemitter3/index.d.ts:69

on

on<T extends keyof TransactionWorkerEvents>(
    event: T,
    fn: (
        ...args: EventEmitter.ArgumentMap<TransactionWorkerEvents>[Extract<
            T,
            keyof TransactionWorkerEvents,
        >],
    ) => void,
    context?: any,
): this
Add a listener for a given event.
Type Parameters
- T extends keyof TransactionWorkerEvents
Parameters
- event: T
- fn: (
      ...args: EventEmitter.ArgumentMap<TransactionWorkerEvents>[Extract<
          T,
          keyof TransactionWorkerEvents,
      >],
  ) => void
- Optionalcontext: any
Returns this
Inherited from EventEmitter.on
- Defined in node_modules/.pnpm/eventemitter3@5.0.4/node_modules/eventemitter3/index.d.ts:40

once

once<T extends keyof TransactionWorkerEvents>(
    event: T,
    fn: (
        ...args: EventEmitter.ArgumentMap<TransactionWorkerEvents>[Extract<
            T,
            keyof TransactionWorkerEvents,
        >],
    ) => void,
    context?: any,
): this
Add a one-time listener for a given event.
Type Parameters
- T extends keyof TransactionWorkerEvents
Parameters
- event: T
- fn: (
      ...args: EventEmitter.ArgumentMap<TransactionWorkerEvents>[Extract<
          T,
          keyof TransactionWorkerEvents,
      >],
  ) => void
- Optionalcontext: any
Returns this
Inherited from EventEmitter.once
- Defined in node_modules/.pnpm/eventemitter3@5.0.4/node_modules/eventemitter3/index.d.ts:54

removeAllListeners

removeAllListeners(event?: keyof TransactionWorkerEvents): this
Remove all listeners, or those of the specified event.
Parameters
- Optionalevent: keyof TransactionWorkerEvents
Returns this
Inherited from EventEmitter.removeAllListeners
- Defined in node_modules/.pnpm/eventemitter3@5.0.4/node_modules/eventemitter3/index.d.ts:79

removeListener

removeListener<T extends keyof TransactionWorkerEvents>(
    event: T,
    fn?: (
        ...args: EventEmitter.ArgumentMap<TransactionWorkerEvents>[Extract<
            T,
            keyof TransactionWorkerEvents,
        >],
    ) => void,
    context?: any,
    once?: boolean,
): this
Remove the listeners of a given event.
Type Parameters
- T extends keyof TransactionWorkerEvents
Parameters
- event: T
- Optionalfn: (
      ...args: EventEmitter.ArgumentMap<TransactionWorkerEvents>[Extract<
          T,
          keyof TransactionWorkerEvents,
      >],
  ) => void
- Optionalcontext: any
- Optionalonce: boolean
Returns this
Inherited from EventEmitter.removeListener
- Defined in node_modules/.pnpm/eventemitter3@5.0.4/node_modules/eventemitter3/index.d.ts:63

Properties

`Readonly`account

account: Account

`Readonly`accountSequnceNumber

accountSequnceNumber: AccountSequenceNumber

`Readonly`aptosConfig

aptosConfig: AptosConfig

started

started: boolean

`Readonly`taskQueue

taskQueue: AsyncQueue<() => Promise<void>> = ...

`Static`prefixed

prefixed: string | boolean

Class TransactionWorker

Hierarchy (View Summary)

Index

Implementation - Transactions

Events - Transactions

Methods

Properties

Implementation - Transactions

constructor

Parameters

Returns TransactionWorker

executedTransactions

outstandingTransactions

sentTransactions

transactionsQueue

checkTransaction

Parameters

Returns Promise<void>

generateNextTransaction

Parameters

Returns Promise<SimpleTransaction | undefined>

processTransactions

Returns Promise<void>

Throws

push

Parameters

Returns Promise<void>

run

Returns Promise<void>

Throws

start

Returns void

Throws

stop

Returns void

Throws

submitNextTransaction

Returns Promise<void>

Throws

Events - Transactions

processTransactions

Returns Promise<void>

Throws

submitNextTransaction

Returns Promise<void>

Throws

Methods

addListener

Type Parameters

Parameters

Returns this

emit

Type Parameters

Parameters

Returns boolean

eventNames

Returns (keyof TransactionWorkerEvents)[]

listenerCount

Parameters

Returns number

listeners

Type Parameters

Parameters

Returns ( ( ...args: EventEmitter.ArgumentMap<TransactionWorkerEvents>[Extract< T, keyof TransactionWorkerEvents, >], ) => void)[]

off

Type Parameters

Parameters

Returns this

on

Type Parameters

Parameters

Returns this

once

Type Parameters

Parameters

Returns this

removeAllListeners

Parameters

Returns this

removeListener

Returns (
(
...args: EventEmitter.ArgumentMap<TransactionWorkerEvents>[Extract<
T,
keyof TransactionWorkerEvents,
>],
) => void
)[]

`Readonly`account

`Readonly`accountSequnceNumber

`Readonly`aptosConfig

`Readonly`taskQueue

`Static`prefixed