Trait reth::rpc::api::servers::eth::helpers::state::LoadState

pub trait LoadState {
    // Required methods
    fn provider(&self) -> impl StateProviderFactory;
    fn cache(&self) -> &EthStateCache;
    fn pool(&self) -> impl TransactionPool;

    // Provided methods
    fn state_at_hash(
        &self,
        block_hash: FixedBytes<32>,
    ) -> Result<Box<dyn StateProvider>, EthApiError> { ... }
    fn state_at_block_id(
        &self,
        at: BlockId,
    ) -> Result<Box<dyn StateProvider>, EthApiError> { ... }
    fn latest_state(&self) -> Result<Box<dyn StateProvider>, EthApiError> { ... }
    fn state_at_block_id_or_latest(
        &self,
        block_id: Option<BlockId>,
    ) -> Result<Box<dyn StateProvider>, EthApiError> { ... }
    fn evm_env_at(
        &self,
        at: BlockId,
    ) -> impl Future<Output = Result<(CfgEnvWithHandlerCfg, BlockEnv, BlockId), EthApiError>> + Send
       where Self: LoadPendingBlock + SpawnBlocking { ... }
    fn evm_env_for_raw_block(
        &self,
        header: &Header,
    ) -> impl Future<Output = Result<(CfgEnvWithHandlerCfg, BlockEnv), EthApiError>> + Send
       where Self: LoadPendingBlock + SpawnBlocking { ... }
    fn transaction_count(
        &self,
        address: Address,
        block_id: Option<BlockId>,
    ) -> impl Future<Output = Result<Uint<256, 4>, EthApiError>> + Send
       where Self: SpawnBlocking { ... }
}

Loads state from database.

Behaviour shared by several eth_ RPC methods, not exclusive to eth_ state RPC methods.

Required Methods

fn provider(&self) -> impl StateProviderFactory

Returns a handle for reading state from database.

Data access in default trait method implementations.

fn cache(&self) -> &EthStateCache

Returns a handle for reading data from memory.

Data access in default (L1) trait method implementations.

fn pool(&self) -> impl TransactionPool

Returns a handle for reading data from transaction pool.

Data access in default trait method implementations.

Provided Methods

fn state_at_hash( &self, block_hash: FixedBytes<32>, ) -> Result<Box<dyn StateProvider>, EthApiError>

Returns the state at the given block number

fn state_at_block_id( &self, at: BlockId, ) -> Result<Box<dyn StateProvider>, EthApiError>

Returns the state at the given BlockId enum.

Note: if not BlockNumberOrTag::Pending then this will only return canonical state. See also https://github.com/paradigmxyz/reth/issues/4515

fn latest_state(&self) -> Result<Box<dyn StateProvider>, EthApiError>

Returns the latest state

fn state_at_block_id_or_latest( &self, block_id: Option<BlockId>, ) -> Result<Box<dyn StateProvider>, EthApiError>

Returns the state at the given BlockId enum or the latest.

Convenience function to interprets None as BlockId::Number(BlockNumberOrTag::Latest)

fn evm_env_at( &self, at: BlockId, ) -> impl Future<Output = Result<(CfgEnvWithHandlerCfg, BlockEnv, BlockId), EthApiError>> + Send

where Self: LoadPendingBlock + SpawnBlocking,

Returns the revm evm env for the requested BlockId

If the BlockId this will return the BlockId of the block the env was configured for. If the BlockId is pending, this will return the “Pending” tag, otherwise this returns the hash of the exact block.

fn evm_env_for_raw_block( &self, header: &Header, ) -> impl Future<Output = Result<(CfgEnvWithHandlerCfg, BlockEnv), EthApiError>> + Send

where Self: LoadPendingBlock + SpawnBlocking,

Returns the revm evm env for the raw block header

This is used for tracing raw blocks

fn transaction_count( &self, address: Address, block_id: Option<BlockId>, ) -> impl Future<Output = Result<Uint<256, 4>, EthApiError>> + Send

where Self: SpawnBlocking,

Returns the number of transactions sent from an address at the given block identifier.

If this is BlockNumberOrTag::Pending then this will look up the highest transaction in pool and return the next nonce (highest + 1).

Object Safety

This trait is not object safe.

Implementors

impl<Provider, Pool, Network, EvmConfig> LoadState for EthApi<Provider, Pool, Network, EvmConfig>

where Provider: StateProviderFactory, Pool: TransactionPool,