Class: TransactionManager

Defined in: packages/txm/lib/TransactionManager.ts:145

The TransactionManager is the core module of the transaction manager. To use the transaction manager, you must instantiate this class. Before using the transaction manager, call the TransactionManager.start method to start it. Once started, use the TransactionManager.addTransactionOriginator method to add a transaction originator and begin sending transactions to the blockchain.

Constructors

new TransactionManager()

new TransactionManager(_config: TransactionManagerConfig): TransactionManager

Defined in: packages/txm/lib/TransactionManager.ts:171

Parameters

_config

TransactionManagerConfig

Returns

TransactionManager

Methods

addHook()

addHook<T>(type: T, handler: TxmHookHandler<T>): Promise<void>

Defined in: packages/txm/lib/TransactionManager.ts:279

Adds a hook to the hook manager.

Type Parameters

• T extends TxmHookType

Parameters

type

T

The type of hook to add.

handler

TxmHookHandler<T>

The handler function to add.

Returns

Promise<void>

addTransactionOriginator()

addTransactionOriginator(originator: TransactionOriginator): void

Defined in: packages/txm/lib/TransactionManager.ts:270

Adds an originator to the transaction manager. An originator is a function that returns a list of transactions to be sent in the next block. It is important that the originator function is as fast as possible to avoid delays when sending transactions to the blockchain

Parameters

originator

TransactionOriginator

The originator to add.

Returns

void

createTransaction()

createTransaction(params: TransactionConstructorConfig): Transaction

Defined in: packages/txm/lib/TransactionManager.ts:292

Creates a new transaction.

Parameters

params

TransactionConstructorConfig

TransactionConstructorConfig.

Returns

Transaction

A new transaction.

getTransaction()

getTransaction(txIntentId: UUID): Promise<undefined | Transaction>

Defined in: packages/txm/lib/TransactionManager.ts:283

Parameters

txIntentId

UUID

Returns

Promise<undefined | Transaction>

start()

start(): Promise<void>

Defined in: packages/txm/lib/TransactionManager.ts:300

Returns

Promise<void>

Properties

abiManager

readonly abiManager: ABIManager;

Defined in: packages/txm/lib/TransactionManager.ts:153

baseFeeMargin

readonly baseFeeMargin: bigint;

Defined in: packages/txm/lib/TransactionManager.ts:163

blockMonitor

readonly blockMonitor: BlockMonitor;

Defined in: packages/txm/lib/TransactionManager.ts:147

blockTime

readonly blockTime: bigint;

Defined in: packages/txm/lib/TransactionManager.ts:166

chainId

readonly chainId: number;

Defined in: packages/txm/lib/TransactionManager.ts:161

collectors

readonly collectors: TransactionOriginator[];

Defined in: packages/txm/lib/TransactionManager.ts:146

eip1559

readonly eip1559: EIP1559Parameters;

Defined in: packages/txm/lib/TransactionManager.ts:162

finalizedTransactionPurgeTime

readonly finalizedTransactionPurgeTime: number;

Defined in: packages/txm/lib/TransactionManager.ts:167

gasEstimator

readonly gasEstimator: GasEstimator;

Defined in: packages/txm/lib/TransactionManager.ts:152

gasPriceOracle

readonly gasPriceOracle: GasPriceOracle;

Defined in: packages/txm/lib/TransactionManager.ts:151

hookManager

readonly hookManager: HookManager;

Defined in: packages/txm/lib/TransactionManager.ts:158

maxPriorityFeePerGas

readonly maxPriorityFeePerGas: bigint;

Defined in: packages/txm/lib/TransactionManager.ts:164

nonceManager

readonly nonceManager: NonceManager;

Defined in: packages/txm/lib/TransactionManager.ts:150

pendingTxReporter

readonly pendingTxReporter: TxMonitor;

Defined in: packages/txm/lib/TransactionManager.ts:154

pollingInterval

readonly pollingInterval: number;

Defined in: packages/txm/lib/TransactionManager.ts:168

retryPolicyManager

readonly retryPolicyManager: RetryPolicyManager;

Defined in: packages/txm/lib/TransactionManager.ts:159

rpcAllowDebug

readonly rpcAllowDebug: boolean;

Defined in: packages/txm/lib/TransactionManager.ts:165

transactionCollector

readonly transactionCollector: TransactionCollector;

Defined in: packages/txm/lib/TransactionManager.ts:156

transactionRepository

readonly transactionRepository: TransactionRepository;

Defined in: packages/txm/lib/TransactionManager.ts:155

transactionSubmitter

readonly transactionSubmitter: TransactionSubmitter;

Defined in: packages/txm/lib/TransactionManager.ts:157

transportProtocol

readonly transportProtocol: "http" | "websocket";

Defined in: packages/txm/lib/TransactionManager.ts:169

viemClient

readonly viemClient: SafeViemPublicClient;

Defined in: packages/txm/lib/TransactionManager.ts:149

viemWallet

readonly viemWallet: SafeViemWalletClient;

Defined in: packages/txm/lib/TransactionManager.ts:148