Struct CanonicalInMemoryState

pub struct CanonicalInMemoryState<N: NodePrimitives = EthPrimitives> { /* private fields */ }

This type is responsible for providing the blocks, receipts, and state for all canonical blocks not on disk yet and keeps track of the block range that is in memory.

Implementations

impl<N: NodePrimitives> CanonicalInMemoryState<N>

pub fn new( blocks: HashMap<B256, Arc<BlockState<N>>>, numbers: BTreeMap<u64, B256>, pending: Option<BlockState<N>>, finalized: Option<SealedHeader<N::BlockHeader>>, safe: Option<SealedHeader<N::BlockHeader>>, ) -> Self

Create a new in-memory state with the given blocks, numbers, pending state, and optional finalized header.

pub fn empty() -> Self

Create an empty state.

pub fn with_head( head: SealedHeader<N::BlockHeader>, finalized: Option<SealedHeader<N::BlockHeader>>, safe: Option<SealedHeader<N::BlockHeader>>, ) -> Self

Create a new in memory state with the given local head and finalized header if it exists.

pub fn hash_by_number(&self, number: u64) -> Option<B256>

Returns the block hash corresponding to the given number.

pub fn header_by_hash(&self, hash: B256) -> Option<SealedHeader<N::BlockHeader>>

Returns the header corresponding to the given hash.

pub fn clear_state(&self)

Clears all entries in the in memory state.

pub fn set_pending_block(&self, pending: ExecutedBlock<N>)

Updates the pending block with the given block.

Note: This assumes that the parent block of the pending block is canonical.

pub fn update_chain(&self, new_chain: NewCanonicalChain<N>)

Update the in memory state with the given chain update.

pub fn remove_persisted_blocks(&self, persisted_num_hash: BlockNumHash)

Removes blocks from the in memory state that are persisted to the given height.

This will update the links between blocks and remove all blocks that are [.. persisted_height].

pub fn state_by_hash(&self, hash: B256) -> Option<Arc<BlockState<N>>>

Returns in memory state corresponding the given hash.

pub fn state_by_number(&self, number: u64) -> Option<Arc<BlockState<N>>>

Returns in memory state corresponding the block number.

pub fn head_state(&self) -> Option<Arc<BlockState<N>>>

Returns the in memory head state.

pub fn pending_state(&self) -> Option<BlockState<N>>

Returns the in memory pending state.

pub fn pending_block_num_hash(&self) -> Option<BlockNumHash>

Returns the in memory pending BlockNumHash.

pub fn chain_info(&self) -> ChainInfo

Returns the current ChainInfo.

pub fn get_canonical_block_number(&self) -> u64

Returns the latest canonical block number.

pub fn get_safe_num_hash(&self) -> Option<BlockNumHash>

Returns the BlockNumHash of the safe head.

pub fn get_finalized_num_hash(&self) -> Option<BlockNumHash>

Returns the BlockNumHash of the finalized head.

pub fn on_forkchoice_update_received(&self)

Hook for new fork choice update.

pub fn last_received_update_timestamp(&self) -> Option<Instant>

Returns the timestamp of the last received update.

pub fn on_transition_configuration_exchanged(&self)

Hook for transition configuration exchanged.

pub fn last_exchanged_transition_configuration_timestamp( &self, ) -> Option<Instant>

Returns the timestamp of the last transition configuration exchanged,

pub fn set_canonical_head(&self, header: SealedHeader<N::BlockHeader>)

Canonical head setter.

pub fn set_safe(&self, header: SealedHeader<N::BlockHeader>)

Safe head setter.

pub fn set_finalized(&self, header: SealedHeader<N::BlockHeader>)

Finalized head setter.

pub fn get_canonical_head(&self) -> SealedHeader<N::BlockHeader>

Canonical head getter.

pub fn get_finalized_header(&self) -> Option<SealedHeader<N::BlockHeader>>

Finalized header getter.

pub fn get_safe_header(&self) -> Option<SealedHeader<N::BlockHeader>>

Safe header getter.

pub fn pending_sealed_header(&self) -> Option<SealedHeader<N::BlockHeader>>

Returns the SealedHeader corresponding to the pending state.

pub fn pending_header(&self) -> Option<N::BlockHeader>

Returns the Header corresponding to the pending state.

pub fn pending_block(&self) -> Option<SealedBlock<N::BlockHeader, N::BlockBody>>

Returns the SealedBlock corresponding to the pending state.

pub fn pending_block_with_senders( &self, ) -> Option<SealedBlockWithSenders<N::Block>>

where N::SignedTx: SignedTransaction,

Returns the SealedBlockWithSenders corresponding to the pending state.

pub fn pending_block_and_receipts( &self, ) -> Option<(SealedBlockFor<<N as NodePrimitives>::Block>, Vec<ReceiptTy<N>>)>

Returns a tuple with the SealedBlock corresponding to the pending state and a vector of its Receipts.

pub fn subscribe_canon_state(&self) -> CanonStateNotifications<N>

Subscribe to new blocks events.

pub fn subscribe_safe_block( &self, ) -> Receiver<Option<SealedHeader<N::BlockHeader>>>

Subscribe to new safe block events.

pub fn subscribe_finalized_block( &self, ) -> Receiver<Option<SealedHeader<N::BlockHeader>>>

Subscribe to new finalized block events.

pub fn notify_canon_state(&self, event: CanonStateNotification<N>)

Attempts to send a new CanonStateNotification to all active Receiver handles.

pub fn state_provider( &self, hash: B256, historical: StateProviderBox, ) -> MemoryOverlayStateProvider<N>

Return state provider with reference to in-memory blocks that overlay database state.

This merges the state of all blocks that are part of the chain that the requested block is the head of. This includes all blocks that connect back to the canonical block on disk.

pub fn canonical_chain(&self) -> impl Iterator<Item = Arc<BlockState<N>>>

Returns an iterator over all canonical blocks in the in-memory state, from newest to oldest (highest to lowest).

This iterator contains a snapshot of the in-memory state at the time of the call.

pub fn transaction_by_hash(&self, hash: TxHash) -> Option<N::SignedTx>

where N::SignedTx: Encodable2718,

Returns [SignedTransaction] type for the given TxHash if found.

pub fn transaction_by_hash_with_meta( &self, tx_hash: TxHash, ) -> Option<(N::SignedTx, TransactionMeta)>

where N::SignedTx: Encodable2718,

Returns a tuple with [SignedTransaction] type and [TransactionMeta] for the given [TxHash] if found.

Trait Implementations

impl<N: Clone + NodePrimitives> Clone for CanonicalInMemoryState<N>

fn clone(&self) -> CanonicalInMemoryState<N>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<N: Debug + NodePrimitives> Debug for CanonicalInMemoryState<N>

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

Formats the value using the given formatter.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 8 bytes