TransactionSubscriptionResult
@algorandfoundation/algokit-subscriber
Interface: TransactionSubscriptionResult
Section titled “Interface: TransactionSubscriptionResult”Defined in: src/types/subscription.ts:7
The result of a single subscription pull/poll.
Properties
Section titled “Properties”blockMetadata?
Section titled “blockMetadata?”
optionalblockMetadata:BlockMetadata[]
Defined in: src/types/subscription.ts:29
The metadata about any blocks that were retrieved from algod as part of the subscription poll.
currentRound
Section titled “currentRound”currentRound:
bigint
Defined in: src/types/subscription.ts:11
The current detected tip of the configured Algorand blockchain.
newWatermark
Section titled “newWatermark”newWatermark:
bigint
Defined in: src/types/subscription.ts:19
The new watermark value to persist for the next call to
getSubscribedTransactions to continue the sync.
Will be equal to syncedRoundRange[1]. Only persist this
after processing (or in the same atomic transaction as)
subscribed transactions to keep it reliable.
startingWatermark
Section titled “startingWatermark”startingWatermark:
bigint
Defined in: src/types/subscription.ts:13
The watermark value that was retrieved at the start of the subscription poll.
subscribedTransactions
Section titled “subscribedTransactions”subscribedTransactions:
SubscribedTransaction[]
Defined in: src/types/subscription.ts:25
Any transactions that matched the given filter within the synced round range. This substantively uses the indexer transaction format to represent the data with some additional fields.
syncedRoundRange
Section titled “syncedRoundRange”syncedRoundRange: [
bigint,bigint]
Defined in: src/types/subscription.ts:9
The round range that was synced from/to