Interface EventsOptions

Options used when requesting events.

If both a start block and checkpoint are specified, and the checkpoint has a valid position set, the checkpoint position is used and the specified start block is ignored. If the checkpoint is unset then the start block is used.

If no start position is specified, eventing begins from the next committed block.

interface EventsOptions {
    checkpoint?: Checkpoint;
    startBlock?: bigint;
}

Properties

checkpoint? startBlock?

Properties

Optional checkpoint

checkpoint?: Checkpoint

Used to get checkpointed state.

Optional startBlock

startBlock?: bigint

Block number at which to start reading events.

Settings

Member Visibility

Theme

On This Page

checkpointstartBlock