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

EventEmitter<TransactionWorkerEvents>
- TransactionWorker

Constructors

constructor

new TransactionWorker(aptosConfig, account, maxWaitTime?, maximumInFlight?, sleepTime?): 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 src/transactions/management/transactionWorker.ts:132

Events

processTransactions

processTransactions(): 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.

Returns Promise<void>
Throws
Throws an error if the process execution fails. TransactionWorkerEventsEnum.TransactionSent - Emitted when a transaction has been successfully committed to the chain. TransactionWorkerEventsEnum.TransactionSendFailed - Emitted when a transaction fails to commit, along with the error reason. TransactionWorkerEventsEnum.ExecutionFinish - Emitted when the execution of transactions is complete.
- Defined in src/transactions/management/transactionWorker.ts:193

Methods

addListener

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

checkTransaction

checkTransaction(sentTransaction, sequenceNumber): 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 src/transactions/management/transactionWorker.ts:251

emit

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

generateNextTransaction

generateNextTransaction(account, sequenceNumber): Promise<undefined | SimpleTransaction>
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<undefined | SimpleTransaction>
A signed transaction object or undefined if the transaction queue is empty.
- Defined in src/transactions/management/transactionWorker.ts:305

listenerCount

listenerCount(event): 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.1/node_modules/eventemitter3/index.d.ts:27

listeners

listeners<T>(event): ((...args: 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: ArgumentMap<TransactionWorkerEvents>[Extract<T, keyof TransactionWorkerEvents>]) => void)[]
Inherited from EventEmitter.listeners
- Defined in node_modules/.pnpm/eventemitter3@5.0.1/node_modules/eventemitter3/index.d.ts:20

off

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

on

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

once

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

push

push(transactionData, options?): 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 src/transactions/management/transactionWorker.ts:291

removeAllListeners

removeAllListeners(event?): 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.1/node_modules/eventemitter3/index.d.ts:79

removeListener

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

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 src/transactions/management/transactionWorker.ts:321

start

start(): void
Starts the transaction management process.

Returns void
Throws
Throws an error if the worker has already started.
- Defined in src/transactions/management/transactionWorker.ts:337

stop

stop(): void
Stops the transaction management process.

Returns void
Throws
Throws an error if the worker has already stopped.
- Defined in src/transactions/management/transactionWorker.ts:352

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.
- Defined in src/transactions/management/transactionWorker.ts:159

Properties

`Readonly`account

account: Account

`Readonly`accountSequnceNumber

accountSequnceNumber: AccountSequenceNumber

`Readonly`aptosConfig

aptosConfig: AptosConfig

executedTransactions

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

transactions that have been committed to chain

outstandingTransactions

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

signed transactions waiting to be submitted

sentTransactions

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

transactions that have been submitted to chain

started

started: boolean

`Readonly`taskQueue

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

transactionsQueue

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

transactions payloads waiting to be generated and signed

TODO support entry function payload from ABI builder

`Static`prefixed

prefixed: string | boolean

Class TransactionWorker

Hierarchy (view full)

Index

Constructors

Events

Methods

Properties

Constructors

constructor

Parameters

Returns TransactionWorker

Events

processTransactions

Returns Promise<void>

Throws

Methods

addListener

Type Parameters

Parameters

Parameters

Returns void

Returns this

checkTransaction

Parameters

Returns Promise<void>

emit

Type Parameters

Parameters

Returns boolean

eventNames

Returns (keyof TransactionWorkerEvents)[]

generateNextTransaction

Parameters

Returns Promise<undefined | SimpleTransaction>

listenerCount

Parameters

Returns number

listeners

Type Parameters

Parameters

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

off

Type Parameters

Parameters

Parameters

Returns void

Returns this

on

Type Parameters

Parameters

Parameters

Returns void

Returns this

once

Type Parameters

Parameters

Parameters

Returns void

Returns this

push

Parameters

Returns Promise<void>

removeAllListeners

Parameters

Returns this

removeListener

Type Parameters

Parameters

Parameters

Returns void

Returns this

run

Returns Promise<void>

Throws

start

Returns void

Throws

stop

Returns void

Throws

`Readonly`account

`Readonly`accountSequnceNumber

`Readonly`aptosConfig

`Readonly`taskQueue

`Static`prefixed