Struct MockEthProvider

pub struct MockEthProvider {
    pub blocks: Arc<Mutex<HashMap<B256, Block>>>,
    pub headers: Arc<Mutex<HashMap<B256, Header>>>,
    pub accounts: Arc<Mutex<HashMap<Address, ExtendedAccount>>>,
    pub chain_spec: Arc<ChainSpec>,
    pub state_roots: Arc<Mutex<Vec<B256>>>,
}

Available on crate feature test-utils only.

A mock implementation for Provider interfaces.

Fields

blocks: Arc<Mutex<HashMap<B256, Block>>>

Local block store

headers: Arc<Mutex<HashMap<B256, Header>>>

Local header store

accounts: Arc<Mutex<HashMap<Address, ExtendedAccount>>>

Local account store

chain_spec: Arc<ChainSpec>

Local chain spec

state_roots: Arc<Mutex<Vec<B256>>>

Local state roots

Implementations

impl MockEthProvider

pub fn add_block(&self, hash: B256, block: Block)

Add block to local block store

pub fn extend_blocks(&self, iter: impl IntoIterator<Item = (B256, Block)>)

Add multiple blocks to local block store

pub fn add_header(&self, hash: B256, header: Header)

Add header to local header store

pub fn extend_headers(&self, iter: impl IntoIterator<Item = (B256, Header)>)

Add multiple headers to local header store

pub fn add_account(&self, address: Address, account: ExtendedAccount)

Add account to local account store

pub fn extend_accounts( &self, iter: impl IntoIterator<Item = (Address, ExtendedAccount)>, )

Add account to local account store

pub fn add_state_root(&self, state_root: B256)

Add state root to local state root store

Trait Implementations

impl AccountReader for MockEthProvider

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

Get basic account information.

impl BlockBodyIndicesProvider for MockEthProvider

fn block_body_indices( &self, _num: u64, ) -> ProviderResult<Option<StoredBlockBodyIndices>>

Returns the block body indices with matching number from database.

impl BlockHashReader for MockEthProvider

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 BlockIdReader for MockEthProvider

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 BlockNumReader for MockEthProvider

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 BlockReader for MockEthProvider

type Block = Block

The block type this provider reads.

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 block_with_senders( &self, _id: BlockHashOrNumber, _transaction_kind: TransactionVariant, ) -> ProviderResult<Option<BlockWithSenders>>

Returns the block with senders with matching number or hash 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<Self::Block>, ProviderError>

Returns the block with matching hash from the database.

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

Returns the block with matching number from database.

impl BlockReaderIdExt for MockEthProvider

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

Returns the block with the matching [BlockId] 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<Self::Block>, ProviderError>

Returns the block with matching tag from the database

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

Returns the pending block header if available

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

Returns the latest block header if available

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

Returns the safe block header if available

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

Returns the finalized block header if available

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

Returns the block with senders with matching [BlockId].

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

Returns the header with matching tag from the database

fn sealed_header_by_number_or_tag( &self, id: BlockNumberOrTag, ) -> Result<Option<SealedHeader<Self::Header>>, ProviderError>

Returns the header with matching tag from the database

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

Returns the ommers with the matching tag from the database.

impl ChainSpecProvider for MockEthProvider

type ChainSpec = ChainSpec

The chain spec type.

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

Get an Arc to the chainspec.

impl ChangeSetReader for MockEthProvider

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 Clone for MockEthProvider

fn clone(&self) -> MockEthProvider

Returns a copy of the value.

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

Performs copy-assignment from source.

impl DatabaseProviderFactory for MockEthProvider

type DB = DatabaseMock

Database this factory produces providers for.

type Provider = DatabaseProvider<TxMock, MockNode>

Provider type returned by the factory.

type ProviderRW = DatabaseProvider<TxMock, MockNode>

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 Debug for MockEthProvider

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

Formats the value using the given formatter.

impl Default for MockEthProvider

fn default() -> Self

Returns the “default value” for a type.

impl EvmEnvProvider for MockEthProvider

fn env_with_header<EvmConfig>( &self, header: &Header, evm_config: EvmConfig, ) -> ProviderResult<EvmEnv>

where EvmConfig: ConfigureEvmEnv<Header = Header>,

Fills the default [EvmEnv] fields with values specific to the given block header.

impl HashedPostStateProvider for MockEthProvider

fn hashed_post_state(&self, _state: &BundleState) -> HashedPostState

Returns the HashedPostState of the provided [BundleState].

impl HeaderProvider for MockEthProvider

type Header = Header

The header type this provider supports.

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

Get header by block hash

fn header_by_number(&self, num: u64) -> 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_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<Self::Header>>, ProviderError>

Retrieves the header sealed by the given block hash.

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

Get header by block number or hash

fn sealed_headers_range( &self, range: impl RangeBounds<u64>, ) -> Result<Vec<SealedHeader<Self::Header>>, ProviderError>

Get headers in range of block numbers.

impl OmmersProvider for MockEthProvider

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

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

impl ReceiptProvider for MockEthProvider

type Receipt = Receipt

The receipt type.

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 ReceiptProviderIdExt for MockEthProvider

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

Get receipt by block id

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

Returns the block with the matching BlockId from the database.

impl StageCheckpointReader for MockEthProvider

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 StateCommitmentProvider for MockEthProvider

type StateCommitment = <MockNode as NodeTypes>::StateCommitment

The [StateCommitment] type that can be used to perform state commitment operations.

impl StateProofProvider for MockEthProvider

fn proof( &self, _input: TrieInput, address: Address, _slots: &[B256], ) -> ProviderResult<AccountProof>

Get account and storage proofs of target keys in the HashedPostState on top of the current state.

fn multiproof( &self, _input: TrieInput, _targets: MultiProofTargets, ) -> ProviderResult<MultiProof>

Generate MultiProof for target hashed account and corresponding hashed storage slot keys.

fn witness( &self, _input: TrieInput, _target: HashedPostState, ) -> ProviderResult<B256HashMap<Bytes>>

Get trie witness for provided state.

impl StateProvider for MockEthProvider

fn storage( &self, account: Address, storage_key: StorageKey, ) -> ProviderResult<Option<StorageValue>>

Get storage of given account.

fn bytecode_by_hash(&self, code_hash: B256) -> ProviderResult<Option<Bytecode>>

Get account code by its hash

fn account_code(&self, addr: Address) -> Result<Option<Bytecode>, ProviderError>

Get account code by its address.

fn account_balance( &self, addr: Address, ) -> Result<Option<Uint<256, 4>>, ProviderError>

Get account balance by its address.

fn account_nonce(&self, addr: Address) -> Result<Option<u64>, ProviderError>

Get account nonce by its address.

impl StateProviderFactory for MockEthProvider

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

Storage provider for latest block.

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

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

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

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

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

Returns a historical StateProvider indexed by the given block hash.

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

Returns any StateProvider with matching block hash.

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

Storage provider for pending state.

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 StateReader for MockEthProvider

type Receipt = Receipt

Receipt type in ExecutionOutcome.

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

Get the ExecutionOutcome for the given block

impl StateRootProvider for MockEthProvider

fn state_root(&self, _state: HashedPostState) -> ProviderResult<B256>

Returns the state root of the BundleState on top of the current state.

fn state_root_from_nodes(&self, _input: TrieInput) -> ProviderResult<B256>

Returns the state root of the HashedPostState on top of the current state but re-uses the intermediate nodes to speed up the computation. It’s up to the caller to construct the prefix sets and inform the provider of the trie paths that have changes.

fn state_root_with_updates( &self, _state: HashedPostState, ) -> ProviderResult<(B256, TrieUpdates)>

Returns the state root of the HashedPostState on top of the current state with trie updates to be committed to the database.

fn state_root_from_nodes_with_updates( &self, _input: TrieInput, ) -> ProviderResult<(B256, TrieUpdates)>

Returns state root and trie updates. See StateRootProvider::state_root_from_nodes for more info.

impl StorageRootProvider for MockEthProvider

fn storage_root( &self, _address: Address, _hashed_storage: HashedStorage, ) -> ProviderResult<B256>

Returns the storage root of the HashedStorage for target address on top of the current state.

fn storage_proof( &self, _address: Address, slot: B256, _hashed_storage: HashedStorage, ) -> ProviderResult<StorageProof>

Returns the storage proof of the HashedStorage for target slot on top of the current state.

fn storage_multiproof( &self, _address: Address, _slots: &[B256], _hashed_storage: HashedStorage, ) -> ProviderResult<StorageMultiProof>

Returns the storage multiproof for target slots.

impl TransactionsProvider for MockEthProvider

type Transaction = TransactionSigned

The transaction type this provider reads.

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<Self::Transaction>>

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

fn transaction_by_id_unhashed( &self, id: TxNumber, ) -> ProviderResult<Option<Self::Transaction>>

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, hash: TxHash, ) -> ProviderResult<Option<(Self::Transaction, 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<Self::Transaction>>>

Get transactions by block id.

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

Get transactions by block range.

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

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 WithdrawalsProvider for MockEthProvider

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: 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: 40 bytes