Skip to main content

Module checkpoint_positions

Module checkpoint_positions 

Source
Expand description

Start and end positions inside the checkpoints at the edges of a ListTransactions / ListEvents request’s checkpoint window.

A position is a gap between items, named by checkpoint-relative offsets: (checkpoint, transaction_index[, event_index]) is the gap just before that transaction (or that event of it). The start position (start_checkpoint, start_transaction_index[, start_event_index]) is the first position a scan admits. The end position is exclusive and lies in the window’s last checkpoint, (end_checkpoint - 1, end_transaction_index[, end_event_index]), so a server that ignores it returns a superset. Offsets past the end of their checkpoint (or transaction) clamp to its end instead of failing: the gap after a checkpoint’s last item is (C, n) for its transaction count n, which clients cannot know.

Structs§

CheckpointPositions
A request’s start and end positions within its checkpoint window’s edge checkpoints. An unset position leaves its edge at the checkpoint boundary.