Struct BlockchainProvider2

pub struct BlockchainProvider2<N: NodeTypesWithDB> { /* private fields */ }

The main type for interacting with the blockchain.

This type serves as the main entry point for interacting with the blockchain and provides data from database storage and from the blockchain tree (pending state etc.) It is a simple wrapper type that holds an instance of the database and the blockchain tree.

Implementations

impl<N: ProviderNodeTypes> BlockchainProvider2<N>

pub fn new(storage: ProviderFactory<N>) -> ProviderResult<Self>

Create a new BlockchainProvider2 using only the storage, fetching the latest header from the database to initialize the provider.

pub fn with_latest( storage: ProviderFactory<N>, latest: SealedHeader, ) -> ProviderResult<Self>

Create new provider instance that wraps the database and the blockchain tree, using the provided latest header to initialize the chain info tracker.

This returns a ProviderResult since it tries the retrieve the last finalized header from database.

pub fn canonical_in_memory_state(&self) -> CanonicalInMemoryState

Gets a clone of canonical_in_memory_state.

pub fn consistent_provider(&self) -> ProviderResult<ConsistentProvider<N>>

Returns a provider with a created DbTx inside, which allows fetching data from the database using different types of providers. Example: HeaderProvider BlockHashReader. This may fail if the inner read database transaction fails to open.

pub fn get_state( &self, range: RangeInclusive<BlockNumber>, ) -> ProviderResult<Option<ExecutionOutcome>>

Return the last N blocks of state, recreating the ExecutionOutcome.

If the range is empty, or there are no blocks for the given range, then this returns None.

Trait Implementations

impl<N: ProviderNodeTypes> AccountReader for BlockchainProvider2<N>

fn basic_account(&self, address: Address) -> ProviderResult<Option<Account>>

Get basic account information.

impl<N: ProviderNodeTypes> BlockHashReader for BlockchainProvider2<N>

fn block_hash(&self, number: u64) -> ProviderResult<Option<B256>>

Get the hash of the block with the given number. Returns None if no block with this number exists.

fn canonical_hashes_range( &self, start: BlockNumber, end: BlockNumber, ) -> ProviderResult<Vec<B256>>

Get headers in range of block hashes or numbers

fn convert_block_hash( &self, hash_or_number: HashOrNumber, ) -> Result<Option<FixedBytes<32>>, ProviderError>

Get the hash of the block with the given number. Returns None if no block with this number exists.

impl<N: ProviderNodeTypes> BlockIdReader for BlockchainProvider2<N>

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

Get the current pending block number and hash.

fn safe_block_num_hash(&self) -> ProviderResult<Option<BlockNumHash>>

Get the current safe block number and hash.

fn finalized_block_num_hash(&self) -> ProviderResult<Option<BlockNumHash>>

Get the current finalized block number and hash.

fn convert_block_number( &self, num: BlockNumberOrTag, ) -> Result<Option<u64>, ProviderError>

Converts the BlockNumberOrTag variants to a block number.

fn block_hash_for_id( &self, block_id: BlockId, ) -> Result<Option<FixedBytes<32>>, ProviderError>

Get the hash of the block by matching the given id.

fn block_number_for_id( &self, block_id: BlockId, ) -> Result<Option<u64>, ProviderError>

Get the number of the block by matching the given id.

fn safe_block_number(&self) -> Result<Option<u64>, ProviderError>

Get the safe block number.

fn finalized_block_number(&self) -> Result<Option<u64>, ProviderError>

Get the finalized block number.

fn safe_block_hash(&self) -> Result<Option<FixedBytes<32>>, ProviderError>

Get the safe block hash.

fn finalized_block_hash(&self) -> Result<Option<FixedBytes<32>>, ProviderError>

Get the finalized block hash.

impl<N: ProviderNodeTypes> BlockNumReader for BlockchainProvider2<N>

fn chain_info(&self) -> ProviderResult<ChainInfo>

Returns the current info for the chain.

fn best_block_number(&self) -> ProviderResult<BlockNumber>

Returns the best block number in the chain.

fn last_block_number(&self) -> ProviderResult<BlockNumber>

Returns the last block number associated with the last canonical header in the database.

fn block_number(&self, hash: B256) -> ProviderResult<Option<BlockNumber>>

Gets the BlockNumber for the given hash. Returns None if no block with this hash exists.

fn convert_hash_or_number( &self, id: HashOrNumber, ) -> Result<Option<u64>, ProviderError>

Gets the block number for the given BlockHashOrNumber. Returns None if no block with this hash exists. If the BlockHashOrNumber is a Number, it is returned as is.

fn convert_number( &self, id: HashOrNumber, ) -> Result<Option<FixedBytes<32>>, ProviderError>

Gets the block hash for the given BlockHashOrNumber. Returns None if no block with this number exists. If the BlockHashOrNumber is a Hash, it is returned as is.

impl<N: ProviderNodeTypes> BlockReader for BlockchainProvider2<N>

fn block_with_senders( &self, id: BlockHashOrNumber, transaction_kind: TransactionVariant, ) -> ProviderResult<Option<BlockWithSenders>>

Returns the block with senders with matching number or hash from database.

NOTE: If TransactionVariant::NoHash is provided then the transactions have invalid hashes, since they would need to be calculated on the spot, and we want fast querying.

Returns None if block is not found.

fn find_block_by_hash( &self, hash: B256, source: BlockSource, ) -> ProviderResult<Option<Block>>

Tries to find in the given block source.

fn block(&self, id: BlockHashOrNumber) -> ProviderResult<Option<Block>>

Returns the block with given id from the database.

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

Returns the pending block if available

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

Returns the pending block if available

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

Returns the pending block and receipts if available.

fn ommers(&self, id: BlockHashOrNumber) -> ProviderResult<Option<Vec<Header>>>

Returns the ommers/uncle headers of the given block from the database.

fn block_body_indices( &self, number: BlockNumber, ) -> ProviderResult<Option<StoredBlockBodyIndices>>

Returns the block body indices with matching number from database.

fn sealed_block_with_senders( &self, id: BlockHashOrNumber, transaction_kind: TransactionVariant, ) -> ProviderResult<Option<SealedBlockWithSenders>>

Returns the sealed block with senders with matching number or hash from database.

fn block_range( &self, range: RangeInclusive<BlockNumber>, ) -> ProviderResult<Vec<Block>>

Returns all blocks in the given inclusive range.

fn block_with_senders_range( &self, range: RangeInclusive<BlockNumber>, ) -> ProviderResult<Vec<BlockWithSenders>>

Returns a range of blocks from the database, along with the senders of each transaction in the blocks.

fn sealed_block_with_senders_range( &self, range: RangeInclusive<BlockNumber>, ) -> ProviderResult<Vec<SealedBlockWithSenders>>

Returns a range of sealed blocks from the database, along with the senders of each transaction in the blocks.

fn block_by_hash( &self, hash: FixedBytes<32>, ) -> Result<Option<Block>, ProviderError>

Returns the block with matching hash from the database.

fn block_by_number(&self, num: u64) -> Result<Option<Block>, ProviderError>

Returns the block with matching number from database.

impl<N: ProviderNodeTypes> BlockReaderIdExt for BlockchainProvider2<N>

where Self: BlockReader + ReceiptProviderIdExt,

fn block_by_id(&self, id: BlockId) -> ProviderResult<Option<Block>>

Returns the block with the matching [BlockId] from the database.

fn header_by_number_or_tag( &self, id: BlockNumberOrTag, ) -> ProviderResult<Option<Header>>

Returns the header with matching tag from the database

fn sealed_header_by_number_or_tag( &self, id: BlockNumberOrTag, ) -> ProviderResult<Option<SealedHeader>>

Returns the header with matching tag from the database

fn sealed_header_by_id( &self, id: BlockId, ) -> ProviderResult<Option<SealedHeader>>

Returns the sealed header with the matching BlockId from the database.

fn header_by_id(&self, id: BlockId) -> ProviderResult<Option<Header>>

Returns the header with the matching BlockId from the database.

fn ommers_by_id(&self, id: BlockId) -> ProviderResult<Option<Vec<Header>>>

Returns the ommers with the matching BlockId from the database.

fn block_by_number_or_tag( &self, id: BlockNumberOrTag, ) -> Result<Option<Block>, ProviderError>

Returns the block with matching tag from the database

fn pending_header(&self) -> Result<Option<SealedHeader>, ProviderError>

Returns the pending block header if available

fn latest_header(&self) -> Result<Option<SealedHeader>, ProviderError>

Returns the latest block header if available

fn safe_header(&self) -> Result<Option<SealedHeader>, ProviderError>

Returns the safe block header if available

fn finalized_header(&self) -> Result<Option<SealedHeader>, ProviderError>

Returns the finalized block header if available

fn block_with_senders_by_id( &self, id: BlockId, transaction_kind: TransactionVariant, ) -> Result<Option<BlockWithSenders>, ProviderError>

Returns the block with senders with matching [BlockId].

fn ommers_by_number_or_tag( &self, id: BlockNumberOrTag, ) -> Result<Option<Vec<Header>>, ProviderError>

Returns the ommers with the matching tag from the database.

impl<N: NodeTypesWithDB> CanonChainTracker for BlockchainProvider2<N>

where Self: BlockReader,

fn on_forkchoice_update_received(&self, _update: &ForkchoiceState)

Notify the tracker about a received fork choice update.

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

Returns the last time a fork choice update was received from the CL (CanonChainTracker::on_forkchoice_update_received)

fn on_transition_configuration_exchanged(&self)

Notify the tracker about a transition configuration exchange.

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

Returns the last time a transition configuration was exchanged with the CL (CanonChainTracker::on_transition_configuration_exchanged)

fn set_canonical_head(&self, header: SealedHeader)

Sets the canonical head of the chain.

fn set_safe(&self, header: SealedHeader)

Sets the safe block of the chain.

fn set_finalized(&self, header: SealedHeader)

Sets the finalized block of the chain.

impl<N: NodeTypesWithDB> CanonStateSubscriptions for BlockchainProvider2<N>

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<N: NodeTypesWithDB> ChainSpecProvider for BlockchainProvider2<N>

type ChainSpec = <N as NodeTypes>::ChainSpec

The chain spec type.

fn chain_spec(&self) -> Arc<N::ChainSpec>

Get an Arc to the chainspec.

impl<N: ProviderNodeTypes> ChangeSetReader for BlockchainProvider2<N>

fn account_block_changeset( &self, block_number: BlockNumber, ) -> ProviderResult<Vec<AccountBeforeTx>>

Iterate over account changesets and return the account state from before this block.

impl<N: NodeTypesWithDB> Clone for BlockchainProvider2<N>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<N: ProviderNodeTypes> DatabaseProviderFactory for BlockchainProvider2<N>

type DB = <N as NodeTypesWithDB>::DB

Database this factory produces providers for.

type Provider = <ProviderFactory<N> as DatabaseProviderFactory>::Provider

Provider type returned by the factory.

type ProviderRW = <ProviderFactory<N> as DatabaseProviderFactory>::ProviderRW

Read-write provider type returned by the factory.

fn database_provider_ro(&self) -> ProviderResult<Self::Provider>

Create new read-only database provider.

fn database_provider_rw(&self) -> ProviderResult<Self::ProviderRW>

Create new read-write database provider.

impl<N: Debug + NodeTypesWithDB> Debug for BlockchainProvider2<N>

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

Formats the value using the given formatter.

impl<N: ProviderNodeTypes> EvmEnvProvider for BlockchainProvider2<N>

fn fill_env_at<EvmConfig>( &self, cfg: &mut CfgEnvWithHandlerCfg, block_env: &mut BlockEnv, at: BlockHashOrNumber, evm_config: EvmConfig, ) -> ProviderResult<()>

where EvmConfig: ConfigureEvmEnv<Header = Header>,

Fills the [CfgEnvWithHandlerCfg] and [BlockEnv] fields with values specific to the given [BlockHashOrNumber].

fn fill_env_with_header<EvmConfig>( &self, cfg: &mut CfgEnvWithHandlerCfg, block_env: &mut BlockEnv, header: &Header, evm_config: EvmConfig, ) -> ProviderResult<()>

where EvmConfig: ConfigureEvmEnv<Header = Header>,

Fills the [CfgEnvWithHandlerCfg] and [BlockEnv] fields with values specific to the given [Header].

fn fill_cfg_env_at<EvmConfig>( &self, cfg: &mut CfgEnvWithHandlerCfg, at: BlockHashOrNumber, evm_config: EvmConfig, ) -> ProviderResult<()>

where EvmConfig: ConfigureEvmEnv<Header = Header>,

Fills the [CfgEnvWithHandlerCfg] fields with values specific to the given [BlockHashOrNumber].

fn fill_cfg_env_with_header<EvmConfig>( &self, cfg: &mut CfgEnvWithHandlerCfg, header: &Header, evm_config: EvmConfig, ) -> ProviderResult<()>

where EvmConfig: ConfigureEvmEnv<Header = Header>,

Fills the [CfgEnvWithHandlerCfg] fields with values specific to the given [Header].

fn env_with_header<EvmConfig>( &self, header: &Header, evm_config: EvmConfig, ) -> Result<(CfgEnvWithHandlerCfg, BlockEnv), ProviderError>

where EvmConfig: ConfigureEvmEnv<Header = Header>,

Fills the default [CfgEnvWithHandlerCfg] and [BlockEnv] fields with values specific to the given [Header].

impl<N: NodeTypesWithDB> ForkChoiceSubscriptions for BlockchainProvider2<N>

fn subscribe_safe_block(&self) -> ForkChoiceNotifications

Get notified when a new safe block of the chain is selected.

fn subscribe_finalized_block(&self) -> ForkChoiceNotifications

Get notified when a new finalized block of the chain is selected.

fn safe_block_stream(&self) -> ForkChoiceStream<SealedHeader>

Convenience method to get a stream of the new safe blocks of the chain.

fn finalized_block_stream(&self) -> ForkChoiceStream<SealedHeader>

Convenience method to get a stream of the new finalized blocks of the chain.

impl<N: ProviderNodeTypes> HeaderProvider for BlockchainProvider2<N>

fn header(&self, block_hash: &BlockHash) -> ProviderResult<Option<Header>>

Get header by block hash

fn header_by_number(&self, num: BlockNumber) -> ProviderResult<Option<Header>>

Get header by block number

fn header_td(&self, hash: &BlockHash) -> ProviderResult<Option<U256>>

Get total difficulty by block hash.

fn header_td_by_number( &self, number: BlockNumber, ) -> ProviderResult<Option<U256>>

Get total difficulty by block number.

fn headers_range( &self, range: impl RangeBounds<BlockNumber>, ) -> ProviderResult<Vec<Header>>

Get headers in range of block numbers

fn sealed_header( &self, number: BlockNumber, ) -> ProviderResult<Option<SealedHeader>>

Get a single sealed header by block number.

fn sealed_headers_range( &self, range: impl RangeBounds<BlockNumber>, ) -> ProviderResult<Vec<SealedHeader>>

Get headers in range of block numbers.

fn sealed_headers_while( &self, range: impl RangeBounds<BlockNumber>, predicate: impl FnMut(&SealedHeader) -> bool, ) -> ProviderResult<Vec<SealedHeader>>

Get sealed headers while predicate returns true or the range is exhausted.

fn is_known(&self, block_hash: &FixedBytes<32>) -> Result<bool, ProviderError>

Check if block is known

fn sealed_header_by_hash( &self, block_hash: FixedBytes<32>, ) -> Result<Option<SealedHeader>, ProviderError>

Retrieves the header sealed by the given block hash.

fn header_by_hash_or_number( &self, hash_or_num: HashOrNumber, ) -> Result<Option<Header>, ProviderError>

Get header by block number or hash

impl<N: ProviderNodeTypes> PruneCheckpointReader for BlockchainProvider2<N>

fn get_prune_checkpoint( &self, segment: PruneSegment, ) -> ProviderResult<Option<PruneCheckpoint>>

Fetch the prune checkpoint for the given segment.

fn get_prune_checkpoints( &self, ) -> ProviderResult<Vec<(PruneSegment, PruneCheckpoint)>>

Fetch all the prune checkpoints.

impl<N: ProviderNodeTypes> ReceiptProvider for BlockchainProvider2<N>

fn receipt(&self, id: TxNumber) -> ProviderResult<Option<Receipt>>

Get receipt by transaction number

fn receipt_by_hash(&self, hash: TxHash) -> ProviderResult<Option<Receipt>>

Get receipt by transaction hash.

fn receipts_by_block( &self, block: BlockHashOrNumber, ) -> ProviderResult<Option<Vec<Receipt>>>

Get receipts by block num or hash.

fn receipts_by_tx_range( &self, range: impl RangeBounds<TxNumber>, ) -> ProviderResult<Vec<Receipt>>

Get receipts by tx range.

impl<N: ProviderNodeTypes> ReceiptProviderIdExt for BlockchainProvider2<N>

fn receipts_by_block_id( &self, block: BlockId, ) -> ProviderResult<Option<Vec<Receipt>>>

Get receipt by block id

fn receipts_by_number_or_tag( &self, number_or_tag: BlockNumberOrTag, ) -> Result<Option<Vec<Receipt>>, ProviderError>

Returns the block with the matching BlockId from the database.

impl<N: ProviderNodeTypes> StageCheckpointReader for BlockchainProvider2<N>

fn get_stage_checkpoint( &self, id: StageId, ) -> ProviderResult<Option<StageCheckpoint>>

Fetch the checkpoint for the given stage.

fn get_stage_checkpoint_progress( &self, id: StageId, ) -> ProviderResult<Option<Vec<u8>>>

Get stage checkpoint progress.

fn get_all_checkpoints(&self) -> ProviderResult<Vec<(String, StageCheckpoint)>>

Reads all stage checkpoints and returns a list with the name of the stage and the checkpoint data.

impl<N: ProviderNodeTypes> StateProviderFactory for BlockchainProvider2<N>

fn latest(&self) -> ProviderResult<StateProviderBox>

Storage provider for latest block

fn pending(&self) -> ProviderResult<StateProviderBox>

Returns the state provider for pending state.

If there’s no pending block available then the latest state provider is returned: Self::latest

fn state_by_block_number_or_tag( &self, number_or_tag: BlockNumberOrTag, ) -> ProviderResult<StateProviderBox>

Returns a StateProviderBox indexed by the given block number or tag.

fn history_by_block_number( &self, block_number: BlockNumber, ) -> ProviderResult<StateProviderBox>

Returns a historical StateProvider indexed by the given historic block number.

fn history_by_block_hash( &self, block_hash: BlockHash, ) -> ProviderResult<StateProviderBox>

Returns a historical StateProvider indexed by the given block hash.

fn state_by_block_hash( &self, hash: BlockHash, ) -> ProviderResult<StateProviderBox>

Returns any StateProvider with matching block hash.

fn pending_state_by_hash( &self, block_hash: B256, ) -> ProviderResult<Option<StateProviderBox>>

Storage provider for pending state for the given block hash.

fn state_by_block_id( &self, block_id: BlockId, ) -> Result<Box<dyn StateProvider>, ProviderError>

Returns a StateProvider indexed by the given [BlockId].

impl<N: ProviderNodeTypes> StateReader for BlockchainProvider2<N>

fn get_state( &self, block: BlockNumber, ) -> ProviderResult<Option<ExecutionOutcome>>

Re-constructs the ExecutionOutcome from in-memory and database state, if necessary.

If data for the block does not exist, this will return None.

NOTE: This cannot be called safely in a loop outside of the blockchain tree thread. This is because the [CanonicalInMemoryState] could change during a reorg, causing results to be inconsistent. Currently this can safely be called within the blockchain tree thread, because the tree thread is responsible for modifying the [CanonicalInMemoryState] in the first place.

impl<N: ProviderNodeTypes> StaticFileProviderFactory for BlockchainProvider2<N>

type Primitives = <N as NodeTypes>::Primitives

The network primitives type StaticFileProvider is using.

fn static_file_provider(&self) -> StaticFileProvider<Self::Primitives>

Create new instance of static file provider.

impl<N: ProviderNodeTypes> StorageChangeSetReader for BlockchainProvider2<N>

fn storage_changeset( &self, block_number: BlockNumber, ) -> ProviderResult<Vec<(BlockNumberAddress, StorageEntry)>>

Iterate over storage changesets and return the storage state from before this block.

impl<N: ProviderNodeTypes> TransactionsProvider for BlockchainProvider2<N>

fn transaction_id(&self, tx_hash: TxHash) -> ProviderResult<Option<TxNumber>>

Get internal transaction identifier by transaction hash.

fn transaction_by_id( &self, id: TxNumber, ) -> ProviderResult<Option<TransactionSigned>>

Get transaction by id, computes hash every time so more expensive.

fn transaction_by_id_no_hash( &self, id: TxNumber, ) -> ProviderResult<Option<TransactionSignedNoHash>>

Get transaction by id without computing the hash.

fn transaction_by_hash( &self, hash: TxHash, ) -> ProviderResult<Option<TransactionSigned>>

Get transaction by transaction hash.

fn transaction_by_hash_with_meta( &self, tx_hash: TxHash, ) -> ProviderResult<Option<(TransactionSigned, TransactionMeta)>>

Get transaction by transaction hash and additional metadata of the block the transaction was mined in

fn transaction_block(&self, id: TxNumber) -> ProviderResult<Option<BlockNumber>>

Get transaction block number

fn transactions_by_block( &self, id: BlockHashOrNumber, ) -> ProviderResult<Option<Vec<TransactionSigned>>>

Get transactions by block id.

fn transactions_by_block_range( &self, range: impl RangeBounds<BlockNumber>, ) -> ProviderResult<Vec<Vec<TransactionSigned>>>

Get transactions by block range.

fn transactions_by_tx_range( &self, range: impl RangeBounds<TxNumber>, ) -> ProviderResult<Vec<TransactionSignedNoHash>>

Get transactions by tx range.

fn senders_by_tx_range( &self, range: impl RangeBounds<TxNumber>, ) -> ProviderResult<Vec<Address>>

Get Senders from a tx range.

fn transaction_sender(&self, id: TxNumber) -> ProviderResult<Option<Address>>

Get transaction sender.

impl<N: ProviderNodeTypes> WithdrawalsProvider for BlockchainProvider2<N>

fn withdrawals_by_block( &self, id: BlockHashOrNumber, timestamp: u64, ) -> ProviderResult<Option<Withdrawals>>

Get withdrawals by block id.

fn latest_withdrawal(&self) -> ProviderResult<Option<Withdrawal>>

Get latest withdrawal from this block or earlier .

Layout

Note: Unable to compute type layout, possibly due to this type having generic parameters. Layout can only be computed for concrete, fully-instantiated types.