TransactionLogger
@algorandfoundation/algokit-utils / testing / TransactionLogger
testing.TransactionLogger
Allows you to keep track of Algorand transaction IDs by wrapping an Algodv2 in a proxy.
Useful for automated tests.
Table of contents
Constructors
Properties
Accessors
Methods
Constructors
constructor
• new TransactionLogger(): TransactionLogger
Returns
Properties
_latestLastValidRound
• Private Optional _latestLastValidRound: bigint
Defined in
src/testing/transaction-logger.ts:14
_sentTransactionIds
• Private _sentTransactionIds: string[] = []
Defined in
src/testing/transaction-logger.ts:13
Accessors
sentTransactionIds
• get sentTransactionIds(): readonly string[]
The list of transaction IDs that has been logged thus far.
Returns
readonly string[]
Defined in
src/testing/transaction-logger.ts:27
Methods
_pushTxn
▸ _pushTxn(stxn): void
Parameters
| Name | Type |
|---|---|
stxn | Uint8Array |
Returns
void
Defined in
src/testing/transaction-logger.ts:16
capture
▸ capture(algod): AlgodClient
Return a proxy that wraps the given Algodv2 with this transaction logger.
Parameters
| Name | Type | Description |
|---|---|---|
algod | AlgodClient | The Algodv2 to wrap |
Returns
AlgodClient
The wrapped Algodv2, any transactions sent using this algod instance will be logged by this transaction logger
Defined in
src/testing/transaction-logger.ts:54
clear
▸ clear(): void
Clear all logged IDs.
Returns
void
Defined in
src/testing/transaction-logger.ts:34
logRawTransaction
▸ logRawTransaction(signedTransactions): void
The method that captures raw transactions and stores the transaction IDs.
Parameters
| Name | Type |
|---|---|
signedTransactions | Uint8Array | Uint8Array[] |
Returns
void
Defined in
src/testing/transaction-logger.ts:41
waitForIndexer
▸ waitForIndexer(indexer): Promise<void>
Wait until all logged transactions IDs appear in the given Indexer.
Parameters
| Name | Type |
|---|---|
indexer | IndexerClient |
Returns
Promise<void>