Struct NoopBlockchainTree

#[non_exhaustive]
pub struct NoopBlockchainTree {
    pub canon_state_notification_sender: Option<CanonStateNotificationSender>,
}

A BlockchainTree that does nothing.

Caution: this is only intended for testing purposes, or for wiring components together.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

canon_state_notification_sender: Option<CanonStateNotificationSender>

Broadcast channel for canon state changes notifications.

Implementations

impl NoopBlockchainTree

pub const fn with_canon_state_notifications( canon_state_notification_sender: CanonStateNotificationSender, ) -> Self

Create a new NoopBlockchainTree with a canon state notification sender.

Trait Implementations

impl BlockchainTreeEngine for NoopBlockchainTree

fn buffer_block( &self, _block: SealedBlockWithSenders, ) -> Result<(), InsertBlockError>

Buffer block with senders

fn insert_block( &self, block: SealedBlockWithSenders, _validation_kind: BlockValidationKind, ) -> Result<InsertPayloadOk, InsertBlockError>

Inserts block with senders

fn finalize_block(&self, _finalized_block: BlockNumber) -> ProviderResult<()>

Finalize blocks up until and including finalized_block, and remove them from the tree.

fn connect_buffered_blocks_to_canonical_hashes_and_finalize( &self, _last_finalized_block: BlockNumber, ) -> Result<(), CanonicalError>

Reads the last N canonical hashes from the database and updates the block indices of the tree by attempting to connect the buffered blocks to canonical hashes.

fn update_block_hashes_and_clear_buffered( &self, ) -> Result<BTreeMap<BlockNumber, BlockHash>, CanonicalError>

Update all block hashes. iterate over present and new list of canonical hashes and compare them. Remove all mismatches, disconnect them, removes all chains and clears all buffered blocks before the tip.

fn connect_buffered_blocks_to_canonical_hashes( &self, ) -> Result<(), CanonicalError>

Reads the last N canonical hashes from the database and updates the block indices of the tree by attempting to connect the buffered blocks to canonical hashes.

fn make_canonical( &self, block_hash: BlockHash, ) -> Result<CanonicalOutcome, CanonicalError>

Make a block and its parent chain part of the canonical chain by committing it to the database.

fn insert_block_without_senders( &self, block: SealedBlock, validation_kind: BlockValidationKind, ) -> Result<InsertPayloadOk, InsertBlockError>

Recover senders and call BlockchainTreeEngine::insert_block.

fn buffer_block_without_senders( &self, block: SealedBlock, ) -> Result<(), InsertBlockError>

Recover senders and call BlockchainTreeEngine::buffer_block.

impl BlockchainTreePendingStateProvider for NoopBlockchainTree

fn find_pending_state_provider( &self, _block_hash: BlockHash, ) -> Option<Box<dyn FullExecutionDataProvider>>

Returns state provider if a matching block exists.

fn pending_state_provider( &self, block_hash: FixedBytes<32>, ) -> Result<Box<dyn FullExecutionDataProvider>, ProviderError>

Returns a state provider that includes all state changes of the given (pending) block hash.

impl BlockchainTreeViewer for NoopBlockchainTree

fn header_by_hash(&self, _hash: BlockHash) -> Option<SealedHeader>

Returns the header with matching hash from the tree, if it exists.

fn block_by_hash(&self, _hash: BlockHash) -> Option<SealedBlock>

Returns the block with matching hash from the tree, if it exists.

fn block_with_senders_by_hash( &self, _hash: BlockHash, ) -> Option<SealedBlockWithSenders>

Returns the block with matching hash from the tree, if it exists.

fn buffered_header_by_hash( &self, _block_hash: BlockHash, ) -> Option<SealedHeader>

Returns the buffered (disconnected) header with matching hash from the internal buffer if it exists.

fn is_canonical(&self, _block_hash: BlockHash) -> Result<bool, ProviderError>

Return whether or not the block is known and in the canonical chain.

fn lowest_buffered_ancestor( &self, _hash: BlockHash, ) -> Option<SealedBlockWithSenders>

Given the hash of a block, this checks the buffered blocks for the lowest ancestor in the buffer.

fn canonical_tip(&self) -> BlockNumHash

Return BlockchainTree best known canonical chain tip (BlockHash, BlockNumber)

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

Return block number and hash that extends the canonical chain tip by one.

fn pending_block_and_receipts(&self) -> Option<(SealedBlock, Vec<Receipt>)>

Returns the pending block and its receipts in one call.

fn receipts_by_block_hash(&self, _block_hash: BlockHash) -> Option<Vec<Receipt>>

Returns the pending receipts if there is one.

fn contains(&self, hash: FixedBytes<32>) -> bool

Returns true if the tree contains the block with matching hash.

fn pending_block(&self) -> Option<SealedBlock>

Returns the pending block if there is one.

fn pending_block_with_senders(&self) -> Option<SealedBlockWithSenders>

Returns the pending block if there is one.

fn pending_receipts(&self) -> Option<Vec<Receipt>>

Returns the pending receipts if there is one.

fn pending_header(&self) -> Option<SealedHeader>

Returns the pending block if there is one.

impl CanonStateSubscriptions for NoopBlockchainTree

fn subscribe_to_canonical_state(&self) -> CanonStateNotifications

Get notified when a new canonical chain was imported.

fn canonical_state_stream(&self) -> CanonStateNotificationStream

Convenience method to get a stream of [CanonStateNotification].

impl Clone for NoopBlockchainTree

fn clone(&self) -> NoopBlockchainTree

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NoopBlockchainTree

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

Formats the value using the given formatter.

impl Default for NoopBlockchainTree

fn default() -> NoopBlockchainTree

Returns the “default value” for a type.

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