@algorandfoundation/algokit-subscriber / types/subscription / TransactionSubscriptionResult
types/subscription.TransactionSubscriptionResult
The result of a single subscription pull/poll.
• Optional blockMetadata: BlockMetadata[]
The metadata about any blocks that were retrieved from algod as part of the subscription poll.
• currentRound: bigint
The current detected tip of the configured Algorand blockchain.
• newWatermark: bigint
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: bigint
The watermark value that was retrieved at the start of the subscription poll.
• subscribedTransactions: SubscribedTransaction[]
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: [startRound: bigint, endRound: bigint]
The round range that was synced from/to