Struct BlockRangeScanner 

pub struct BlockRangeScanner<N: Network> { /* private fields */ }

A BlockRangeScanner connected to a provider.

Implementations

impl<N: Network> BlockRangeScanner<N>

pub fn new( provider: RobustProvider<N>, max_block_range: u64, past_blocks_storage_capacity: RingBufferCapacity, buffer_capacity: usize, ) -> Self

Creates a new BlockRangeScanner with the specified configuration.

Arguments

• provider - The robust provider to use for blockchain interactions
• max_block_range - Maximum number of blocks per streamed range (must be > 0)
• past_blocks_storage_capacity - How many past block hashes to keep for reorg detection
• buffer_capacity - Stream buffer capacity (must be > 0)

pub fn provider(&self) -> &RobustProvider<N>

Returns the underlying RobustProvider.

pub fn buffer_capacity(&self) -> usize

Returns the stream buffer capacity.

pub async fn stream_live( &self, block_confirmations: u64, ) -> Result<ReceiverStream<BlockScannerResult>, ScannerError>

Streams live blocks starting from the latest block.

Arguments

• block_confirmations - Number of confirmations to apply once in live mode.

Errors

• ScannerError::Timeout - if an RPC call required for startup times out.
• ScannerError::RpcError - if an RPC call required for startup fails.

pub async fn stream_historical( &self, start_id: impl Into<BlockId>, end_id: impl Into<BlockId>, ) -> Result<ReceiverStream<BlockScannerResult>, ScannerError>

Streams a batch of historical blocks from start_id to end_id.

Arguments

• start_id - The starting block id
• end_id - The ending block id

Errors

• ScannerError::Timeout - if an RPC call required for startup times out.
• ScannerError::RpcError - if an RPC call required for startup fails.
• ScannerError::BlockNotFound - if start_id or end_id cannot be resolved.

pub async fn stream_from( &self, start_id: impl Into<BlockId>, block_confirmations: u64, ) -> Result<ReceiverStream<BlockScannerResult>, ScannerError>

Streams blocks starting from start_id and transitions to live mode.

Arguments

• start_id - The starting block id.
• block_confirmations - Number of confirmations to apply once in live mode.

Errors

• ScannerError::Timeout - if an RPC call required for startup times out.
• ScannerError::RpcError - if an RPC call required for startup fails.
• ScannerError::BlockNotFound - if start_id cannot be resolved.

pub async fn stream_rewind( &self, start_id: impl Into<BlockId>, end_id: impl Into<BlockId>, ) -> Result<ReceiverStream<BlockScannerResult>, ScannerError>

Streams blocks in reverse order from start_id to end_id.

The start_id block is assumed to be greater than or equal to the end_id block. Blocks are streamed in batches, where each batch is ordered from lower to higher block numbers (chronological order within each batch), but batches themselves progress from newer to older blocks.

Arguments

• start_id - The starting block id (higher block number).
• end_id - The ending block id (lower block number).

Reorg Handling

Reorg checks are only performed when the specified block range tip is above the current finalized block height. When a reorg is detected:

1. A Notification::ReorgDetected is emitted with the common ancestor block
2. The scanner fetches the new tip block at the same height
3. Reorged blocks are re-streamed in chronological order (from common_ancestor + 1 up to the new tip)
4. The reverse scan continues from where it left off

If the range tip is at or below the finalized block, no reorg checks are performed since finalized blocks cannot be reorganized.

Note

The reason reorged blocks are streamed in chronological order is to make it easier to handle reorgs in EventScannerBuilder::latest mode, i.e. to prepend reorged blocks to the result collection, which must maintain chronological order.

Errors

• ScannerError::Timeout - if an RPC call required for startup times out.
• ScannerError::RpcError - if an RPC call required for startup fails.
• ScannerError::BlockNotFound - if start_id or end_id cannot be resolved.

Trait Implementations

impl<N: Debug + Network> Debug for BlockRangeScanner<N>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.