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

  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.

Hierarchy

Constructors

constructor

Properties

account accountSequnceNumber aptosConfig executedTransactions outstandingTransactions sentTransactions started taskQueue transactionsQueue prefixed

Methods

addListener checkTransaction emit eventNames generateNextTransaction listenerCount listeners off on once processTransactions push removeAllListeners removeListener run start stop submitNextTransaction

Constructors

constructor

  • new TransactionWorker(aptosConfig, account, maxWaitTime?, maximumInFlight?, sleepTime?): TransactionWorker

  • Provides a simple framework for receiving payloads to be processed.

    Parameters

    • aptosConfig: AptosConfig

      a config object

    • account: Account
    • OptionalmaxWaitTime: number

      the max wait time to wait before resyncing the sequence number to the current on-chain state, default to 30

    • OptionalmaximumInFlight: number

      submit up to maximumInFlight transactions per account. Mempool limits the number of transactions per account to 100, hence why we default to 100.

    • OptionalsleepTime: number

      If maximumInFlight are in flight, wait sleepTime seconds before re-evaluating, default to 10

    Returns TransactionWorker

Properties

Readonlyaccount

account: Account

ReadonlyaccountSequnceNumber

accountSequnceNumber: AccountSequenceNumber

ReadonlyaptosConfig

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

ReadonlytaskQueue

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

Staticprefixed

prefixed: string | boolean

Methods

addListener

checkTransaction

  • checkTransaction(sentTransaction, sequenceNumber): Promise<void>

  • Once transaction has been sent to chain, we check for its execution status.

    Parameters

    • sentTransaction: PromiseFulfilledResult<PendingTransactionResponse>

      transactions that were sent to chain and are now waiting to be executed

    • sequenceNumber: bigint

      the account's sequence number that was sent with the transaction

    Returns Promise<void>

emit

  • emit<T>(event, ...args): boolean

  • Calls each of the listeners registered for a given event.

    Type Parameters

    Parameters

    Returns boolean

eventNames

  • eventNames(): (keyof TransactionWorkerEvents)[]

  • Return an array listing the events for which the emitter has registered listeners.

    Returns (keyof TransactionWorkerEvents)[]

generateNextTransaction

  • generateNextTransaction(account, sequenceNumber): Promise<undefined | SimpleTransaction>

  • Generates a signed transaction that can be submitted to chain

    Parameters

    • account: Account

      an Aptos account

    • sequenceNumber: bigint

      a sequence number the transaction will be generated with

    Returns Promise<undefined | SimpleTransaction>

listenerCount

  • listenerCount(event): number

  • Return the number of listeners listening to a given event.

    Parameters

    Returns number

listeners

off

on

once

processTransactions

  • processTransactions(): Promise<void>

  • Reads the outstanding transaction queue and submits the transaction to chain.

    If the transaction has fulfilled, it pushes the transaction to the processed transactions queue and fires a transactionsFulfilled event.

    If the transaction has failed, it pushes the transaction to the processed transactions queue with the failure reason and fires a transactionsFailed event.

    Returns Promise<void>

push

  • push(transactionData, options?): Promise<void>

  • Push transaction to the transactions queue

    Parameters

    Returns Promise<void>

removeAllListeners

  • removeAllListeners(event?): this

  • Remove all listeners, or those of the specified event.

    Parameters

    • Optionalevent: keyof TransactionWorkerEvents

    Returns this

removeListener

run

  • run(): Promise<void>

  • Starts transaction submission and transaction processing.

    Returns Promise<void>

start

  • start(): void

  • Starts the transaction management process.

    Returns void

stop

  • stop(): void

  • Stops the the transaction management process.

    Returns void

submitNextTransaction

  • submitNextTransaction(): Promise<void>

  • Gets the current account sequence number, generates the transaction with the account sequence number, adds the transaction to the outstanding transaction queue to be processed later.

    Returns Promise<void>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods