Trait LoadPendingBlock 

pub trait LoadPendingBlock: EthApiTypes + RpcNodeCore
where
    Self::Error: FromEvmError<Self::Evm>,
    Self::RpcConvert: RpcConvert<Network = Self::NetworkTypes>,
{
    // Required methods
    fn pending_block(&self) -> &Mutex<Option<PendingBlock<Self::Primitives>>>;
    fn pending_env_builder(
        &self,
    ) -> &(dyn PendingEnvBuilder<Self::Evm> + 'static);

    // Provided methods
    fn pending_block_kind(&self) -> PendingBlockKind { ... }
    fn pending_block_env_and_cfg(
        &self,
    ) -> Result<PendingBlockEnv<Self::Evm>, Self::Error> { ... }
    fn next_env_attributes(
        &self,
        parent: &SealedHeader<<Self::Provider as HeaderProvider>::Header>,
    ) -> Result<<Self::Evm as ConfigureEvm>::NextBlockEnvCtx, Self::Error> { ... }
    fn local_pending_state(
        &self,
    ) -> impl Future<Output = Result<Option<Box<dyn StateProvider + Send>>, Self::Error>> + Send
       where Self: SpawnBlocking { ... }
    fn local_pending_block_or_state(
        &self,
    ) -> impl Future<Output = Result<Option<PendingStateSource<Self::Primitives>>, Self::Error>> + Send
       where Self: SpawnBlocking { ... }
    fn pool_pending_block(
        &self,
    ) -> impl Future<Output = Result<Option<PendingBlock<Self::Primitives>>, Self::Error>> + Send
       where Self: SpawnBlocking { ... }
    fn build_pool_pending_block(
        &self,
        parent: SealedHeader<<Self::Provider as HeaderProvider>::Header>,
        evm_env: EvmEnv<<<<Self::Evm as ConfigureEvm>::BlockExecutorFactory as BlockExecutorFactory>::EvmFactory as EvmFactory>::Spec, <<<Self::Evm as ConfigureEvm>::BlockExecutorFactory as BlockExecutorFactory>::EvmFactory as EvmFactory>::BlockEnv>,
    ) -> impl Future<Output = Result<Option<PendingBlock<Self::Primitives>>, Self::Error>> + Send
       where Self: SpawnBlocking { ... }
    fn local_pending_block(
        &self,
    ) -> impl Future<Output = Result<Option<BlockAndReceipts<Self::Primitives>>, Self::Error>> + Send
       where Self: SpawnBlocking,
             Self::Pool: TransactionPool,
             <Self::Pool as TransactionPool>::Transaction: PoolTransaction<Consensus = <Self::Provider as TransactionsProvider>::Transaction> { ... }
    fn build_block(
        &self,
        parent: &SealedHeader<<Self::Provider as HeaderProvider>::Header>,
    ) -> Result<ExecutedBlock<Self::Primitives>, Self::Error>
       where Self::Pool: TransactionPool,
             <Self::Pool as TransactionPool>::Transaction: PoolTransaction<Consensus = <Self::Provider as TransactionsProvider>::Transaction>,
             EthApiError: From<ProviderError> { ... }
}

Available on crate feature rpc only.

Loads a provider pending block or builds one from the transaction pool.

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

Required Methods

fn pending_block(&self) -> &Mutex<Option<PendingBlock<Self::Primitives>>>

Returns a handle to the pending block.

Data access in default (L1) trait method implementations.

fn pending_env_builder(&self) -> &(dyn PendingEnvBuilder<Self::Evm> + 'static)

Returns a PendingEnvBuilder for the pending block.

Provided Methods

fn pending_block_kind(&self) -> PendingBlockKind

Returns the pending block kind.

fn pending_block_env_and_cfg( &self, ) -> Result<PendingBlockEnv<Self::Evm>, Self::Error>

Returns the pending block environment and its origin.

Uses the provider’s pending block when available; otherwise derives the next block environment from the latest header. This method performs synchronous provider reads.

fn next_env_attributes( &self, parent: &SealedHeader<<Self::Provider as HeaderProvider>::Header>, ) -> Result<<Self::Evm as ConfigureEvm>::NextBlockEnvCtx, Self::Error>

Returns ConfigureEvm::NextBlockEnvCtx for building a local pending block.

fn local_pending_state( &self, ) -> impl Future<Output = Result<Option<Box<dyn StateProvider + Send>>, Self::Error>> + Send

where Self: SpawnBlocking,

Returns a StateProviderBox on a mem-pool built pending block overlaying latest.

This is used by state_at_block_id and, by default, by Self::local_pending_block_or_state. This method’s default opens the provider state on a blocking task after building the pending block.

fn local_pending_block_or_state( &self, ) -> impl Future<Output = Result<Option<PendingStateSource<Self::Primitives>>, Self::Error>> + Send

where Self: SpawnBlocking,

Selects the local pending source for state RPCs.

By default, delegates to Self::local_pending_state so existing chain-specific overrides continue to apply. Implementations can return PendingStateSource::Block to defer opening the block’s state provider until the state RPC’s blocking task. Returning None falls back to the provider’s pending state.

fn pool_pending_block( &self, ) -> impl Future<Output = Result<Option<PendingBlock<Self::Primitives>>, Self::Error>> + Send

where Self: SpawnBlocking,

Returns a cached or newly built pending block from the transaction pool.

Returns None if local pending blocks are disabled or the provider has an actual pending block. Resolves the environment before awaiting the cache lock, then may spawn a blocking task to build the block. Callers must await this outside a blocking task.

fn build_pool_pending_block( &self, parent: SealedHeader<<Self::Provider as HeaderProvider>::Header>, evm_env: EvmEnv<<<<Self::Evm as ConfigureEvm>::BlockExecutorFactory as BlockExecutorFactory>::EvmFactory as EvmFactory>::Spec, <<<Self::Evm as ConfigureEvm>::BlockExecutorFactory as BlockExecutorFactory>::EvmFactory as EvmFactory>::BlockEnv>, ) -> impl Future<Output = Result<Option<PendingBlock<Self::Primitives>>, Self::Error>> + Send

where Self: SpawnBlocking,

Returns a cached or newly built pending block for the given parent and environment.

Holds the async cache lock while rebuilding, which may spawn blocking work. The resolved parent and environment let callers reuse the result of their provider lookup.

fn local_pending_block( &self, ) -> impl Future<Output = Result<Option<BlockAndReceipts<Self::Primitives>>, Self::Error>> + Send

where Self: SpawnBlocking, Self::Pool: TransactionPool, <Self::Pool as TransactionPool>::Transaction: PoolTransaction<Consensus = <Self::Provider as TransactionsProvider>::Transaction>,

When enabled, returns the provider’s pending block or builds one from the pool.

fn build_block( &self, parent: &SealedHeader<<Self::Provider as HeaderProvider>::Header>, ) -> Result<ExecutedBlock<Self::Primitives>, Self::Error>

where Self::Pool: TransactionPool, <Self::Pool as TransactionPool>::Transaction: PoolTransaction<Consensus = <Self::Provider as TransactionsProvider>::Transaction>, EthApiError: From<ProviderError>,

Builds a locally derived pending block using the configured provider and pool.

This is used when no execution-layer pending block is available and a pending block is derived from the latest canonical header, using the provided parent.

Withdrawals and any fork-specific behavior (such as EIP-4788 pre-block contract calls) are determined by the EVM environment and chain specification used during construction.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors

impl<N, Rpc> LoadPendingBlock for EthApi<N, Rpc>

where N: RpcNodeCore, EthApiError: FromEvmError<<N as RpcNodeCore>::Evm>, Rpc: RpcConvert<Primitives = <N as RpcNodeCore>::Primitives, Error = EthApiError>,