Struct Block 

pub struct Block<T = Transaction, H = Header> {
    pub header: H,
    pub uncles: Vec<FixedBytes<32>>,
    pub transactions: BlockTransactions<T>,
    pub withdrawals: Option<Withdrawals>,
}

Available on crate feature rpc only.

Block representation for RPC.

Fields

header: H

Header of the block.

uncles: Vec<FixedBytes<32>>

Uncles’ hashes.

transactions: BlockTransactions<T>

Block Transactions. In the case of an uncle block, this field is not included in RPC responses, and when deserialized, it will be set to BlockTransactions::Uncle.

withdrawals: Option<Withdrawals>

Withdrawals in the block.

Implementations

impl<T, H> Block<T, H>

pub const fn empty(header: H) -> Block<T, H>

Available on crate feature node-api only.

Creates a new empty block (without transactions).

pub const fn new(header: H, transactions: BlockTransactions<T>) -> Block<T, H>

Available on crate feature node-api only.

Creates a new Block with the given header and transactions.

Note: This does not set the withdrawals for the block.

use alloy_eips::eip4895::Withdrawals;
use alloy_network_primitives::BlockTransactions;
use alloy_rpc_types_eth::{Block, Header, Transaction};
let block = Block::new(
    Header::new(alloy_consensus::Header::default()),
    BlockTransactions::<Transaction>::Full(vec![]),
)
.with_withdrawals(Some(Withdrawals::default()));

pub fn number(&self) -> u64

where H: BlockHeader,

Available on crate feature node-api only.

Returns the block’s number.

pub fn apply<F>(self, f: F) -> Block<T, H>

where F: FnOnce(Block<T, H>) -> Block<T, H>,

Available on crate feature node-api only.

Apply a function to the block, returning the modified block.

pub fn with_transactions( self, transactions: BlockTransactions<T>, ) -> Block<T, H>

Available on crate feature node-api only.

Sets the transactions for the block.

pub fn with_withdrawals(self, withdrawals: Option<Withdrawals>) -> Block<T, H>

Available on crate feature node-api only.

Sets the withdrawals for the block.

pub fn with_uncles(self, uncles: Vec<FixedBytes<32>>) -> Block<T, H>

Available on crate feature node-api only.

Sets the uncles for the block.

pub fn try_into_transactions( self, ) -> Result<Vec<T>, ValueError<BlockTransactions<T>>>

Available on crate feature node-api only.

Tries to convert inner transactions into a vector of full transactions

Returns an error if the block contains only transaction hashes or if it is an uncle block.

pub fn into_transactions_vec(self) -> Vec<T>

Available on crate feature node-api only.

Consumes the type and returns the transactions as a vector.

Note: if this is an uncle or hashes, this will return an empty vector.

pub fn into_hashes_vec(self) -> Vec<FixedBytes<32>>

where T: TransactionResponse,

Available on crate feature node-api only.

Consumes the type and returns the transaction hashes as a vector.

Note: if this is an uncle, this will return an empty vector.

pub fn try_into_block_body( self, ) -> Result<BlockBody<T, H>, ValueError<Block<T, H>>>

Available on crate feature node-api only.

Converts this block into a [BlockBody].

Returns an error if the transactions are not full or if the block has uncles.

pub fn into_block_body_unchecked(self) -> BlockBody<T, H>

Available on crate feature node-api only.

Converts this block into a [BlockBody]

Caution: The body will have empty transactions unless the block’s transactions are BlockTransactions::Full. This will disregard ommers/uncles and always return an empty ommers vec.

pub fn into_consensus_block(self) -> Block<T, H>

Available on crate feature node-api only.

Consumes the block and returns the [alloy_consensus::Block] with the current transaction and header type.

Note: Unlike Self::into_consensus, this method returns the Header type H as-is without converting it to alloy_consensus::Header, See Header::into_consensus.

This has two caveats:

• The returned block will always have empty uncles.
• If the block’s transaction is not BlockTransactions::Full, the returned block will have an empty transaction vec.

pub fn map_header<U>(self, f: impl FnOnce(H) -> U) -> Block<T, U>

Available on crate feature node-api only.

Converts the block’s header type by applying a function to it.

pub fn into_header(self) -> H

Available on crate feature node-api only.

Consumes the block and returns its header.

To obtain the underlying alloy_consensus::Header use Block::into_consensus_header.

pub fn try_convert_header<U>( self, ) -> Result<Block<T, U>, <U as TryFrom<H>>::Error>

where U: TryFrom<H>,

Available on crate feature node-api only.

Converts the block’s header type to the given alternative that is TryFrom<H>

pub fn try_map_header<U, E>( self, f: impl FnOnce(H) -> Result<U, E>, ) -> Result<Block<T, U>, E>

Available on crate feature node-api only.

Converts the block’s header type by applying a fallible function to it.

pub fn convert_transactions<U>(self) -> Block<U, H>

where U: From<T>,

Available on crate feature node-api only.

Converts the block’s transaction type to the given alternative that is From<T>

pub fn try_convert_transactions<U>( self, ) -> Result<Block<U, H>, <U as TryFrom<T>>::Error>

where U: TryFrom<T>,

Available on crate feature node-api only.

Converts the block’s transaction to the given alternative that is TryFrom<T>

Returns the block with the new transaction type if all conversions were successful.

pub fn map_transactions<U>(self, f: impl FnMut(T) -> U) -> Block<U, H>

Available on crate feature node-api only.

Converts the block’s transaction type by applying a function to each transaction.

Returns the block with the new transaction type.

pub fn try_map_transactions<U, E>( self, f: impl FnMut(T) -> Result<U, E>, ) -> Result<Block<U, H>, E>

Available on crate feature node-api only.

Converts the block’s transaction type by applying a fallible function to each transaction.

Returns the block with the new transaction type if all transactions were mapped successfully.

pub fn calculate_transactions_root(&self) -> Option<FixedBytes<32>>

where T: Encodable2718,

Available on crate feature node-api only.

Calculate the transaction root for the full transactions in this block type.

Returns None if the transactions is not the BlockTransactions::Full variant.

impl<T, H> Block<T, H>

where T: TransactionResponse,

pub fn into_full_block(self, txs: Vec<T>) -> Block<T, H>

Available on crate feature node-api only.

Converts a block with transaction hashes into a full block.

This replaces the transaction representation without validating the supplied transaction hashes, count, or order against the original block or its transactions root.

impl<T, H> Block<T, Header<H>>

where H: Sealable + Encodable,

pub fn uncle_from_header(header: H) -> Block<T, Header<H>>

Available on crate feature node-api only.

Constructs an “uncle block” from the provided header.

This function creates a new Block structure for uncle blocks (ommer blocks), using the provided header.

impl<T> Block<T>

pub const fn hash(&self) -> FixedBytes<32>

Available on crate feature node-api only.

Returns the block’s hash as received from rpc.

pub const fn sealed_header(&self) -> Sealed<&Header>

Available on crate feature node-api only.

Returns a sealed reference of the header using its stored RPC hash without verification.

pub fn into_sealed_header(self) -> Sealed<Header>

Available on crate feature node-api only.

Consumes the type and returns the sealed alloy_consensus::Header.

pub fn into_consensus_header(self) -> Header

Available on crate feature node-api only.

Consumes the type, strips away the rpc context from the rpc Header type and just returns the alloy_consensus::Header.

pub fn from_consensus( block: Block<T>, total_difficulty: Option<Uint<256, 4>>, ) -> Block<T>

where T: Encodable,

Available on crate feature node-api only.

Constructs block from a consensus block and total_difficulty.

pub fn into_consensus(self) -> Block<T>

Available on crate feature node-api only.

Consumes the block and returns the ethereum [alloy_consensus::Block] with the ethereum header type.

This has two caveats:

• The returned block will always have empty uncles.
• If the block’s transaction is not BlockTransactions::Full, the returned block will have an empty transaction vec.

pub fn into_consensus_sealed(self) -> Sealed<Block<T>>

Available on crate feature node-api only.

Same as Self::into_consensus but returns the block as [Sealed] with its stored RPC hash, without verification or recomputation.

Trait Implementations

impl<T, H> BlockResponse for Block<T, H>

where T: TransactionResponse,

type Header = H

Concrete RPC header representation.

type Transaction = T

Full-transaction representation used by BlockTransactions::Full.

fn header(&self) -> &<Block<T, H> as BlockResponse>::Header

Block header

fn transactions(&self) -> &BlockTransactions<T>

Block transactions

fn transactions_mut( &mut self, ) -> &mut BlockTransactions<<Block<T, H> as BlockResponse>::Transaction>

Returns a mutable reference to the block transactions.

fn other_fields(&self) -> Option<&OtherFields>

Returns flattened chain- or client-specific RPC fields when they were retained.

impl<T, H> Clone for Block<T, H>

where T: Clone, H: Clone,

fn clone(&self) -> Block<T, H>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T, H> Debug for Block<T, H>

where T: Debug, H: Debug,

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

Formats the value using the given formatter.

impl<T, H> Default for Block<T, H>

where H: Default,

fn default() -> Block<T, H>

Returns the “default value” for a type.

impl<'de, T, H> Deserialize<'de> for Block<T, H>

where T: Deserialize<'de>, H: Deserialize<'de>,

fn deserialize<__D>( __deserializer: __D, ) -> Result<Block<T, H>, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<Eth, EthFilter> EngineEthApiServer<<<Eth as EthApiTypes>::NetworkTypes as RpcTypes>::TransactionRequest, Block<<<Eth as EthApiTypes>::NetworkTypes as RpcTypes>::TransactionResponse, <<Eth as EthApiTypes>::NetworkTypes as RpcTypes>::Header>, <<Eth as EthApiTypes>::NetworkTypes as RpcTypes>::Receipt, <<Eth as EthApiTypes>::NetworkTypes as RpcTypes>::Log> for EngineEthApi<Eth, EthFilter>

where Eth: EthApiServer<<<Eth as EthApiTypes>::NetworkTypes as RpcTypes>::TransactionRequest, <<Eth as EthApiTypes>::NetworkTypes as RpcTypes>::TransactionResponse, Block<<<Eth as EthApiTypes>::NetworkTypes as RpcTypes>::TransactionResponse, <<Eth as EthApiTypes>::NetworkTypes as RpcTypes>::Header>, <<Eth as EthApiTypes>::NetworkTypes as RpcTypes>::Receipt, <<Eth as EthApiTypes>::NetworkTypes as RpcTypes>::Header, <<Eth as RpcNodeCore>::Primitives as NodePrimitives>::SignedTx> + FullEthApiTypes, EthFilter: EngineEthFilter<<<Eth as EthApiTypes>::NetworkTypes as RpcTypes>::Log>,

fn syncing(&self) -> Result<SyncStatus, ErrorObject<'static>>

Handler for: eth_syncing

async fn chain_id(&self) -> Result<Option<Uint<64, 1>>, ErrorObject<'static>>

Handler for: eth_chainId

fn block_number(&self) -> Result<Uint<256, 4>, ErrorObject<'static>>

Handler for: eth_blockNumber

async fn call( &self, request: <<Eth as EthApiTypes>::NetworkTypes as RpcTypes>::TransactionRequest, block_id: Option<BlockId>, state_overrides: Option<HashMap<Address, AccountOverride, FbBuildHasher<20>>>, block_overrides: Option<Box<BlockOverrides>>, ) -> Result<Bytes, ErrorObject<'static>>

Handler for: eth_call

async fn get_code( &self, address: Address, block_id: Option<BlockId>, ) -> Result<Bytes, ErrorObject<'static>>

Handler for: eth_getCode

async fn block_by_hash( &self, hash: FixedBytes<32>, full: bool, ) -> Result<Option<Block<<<Eth as EthApiTypes>::NetworkTypes as RpcTypes>::TransactionResponse, <<Eth as EthApiTypes>::NetworkTypes as RpcTypes>::Header>>, ErrorObject<'static>>

Handler for: eth_getBlockByHash

async fn block_by_number( &self, number: BlockNumberOrTag, full: bool, ) -> Result<Option<Block<<<Eth as EthApiTypes>::NetworkTypes as RpcTypes>::TransactionResponse, <<Eth as EthApiTypes>::NetworkTypes as RpcTypes>::Header>>, ErrorObject<'static>>

Handler for: eth_getBlockByNumber

async fn raw_transaction_by_block_hash_and_index( &self, hash: FixedBytes<32>, index: Index, ) -> Result<Option<Bytes>, ErrorObject<'static>>

Handler for: eth_getRawTransactionByBlockHashAndIndex

async fn raw_transaction_by_block_number_and_index( &self, number: BlockNumberOrTag, index: Index, ) -> Result<Option<Bytes>, ErrorObject<'static>>

Handler for: eth_getRawTransactionByBlockNumberAndIndex

async fn send_raw_transaction( &self, bytes: Bytes, ) -> Result<FixedBytes<32>, ErrorObject<'static>>

Handler for: eth_sendRawTransaction

async fn logs( &self, filter: Filter, ) -> Result<Vec<<<Eth as EthApiTypes>::NetworkTypes as RpcTypes>::Log>, ErrorObject<'static>>

Handler for eth_getLogs

async fn get_proof( &self, address: Address, keys: Vec<JsonStorageKey>, block_number: Option<BlockId>, ) -> Result<EIP1186AccountProofResponse, ErrorObject<'static>>

Handler for eth_getProof

async fn get_multi_proof( &self, targets: Vec<(Address, Vec<FixedBytes<32>>)>, block_number: Option<BlockId>, ) -> Result<Vec<EIP1186AccountProofResponse>, ErrorObject<'static>>

Handler for eth_getMultiProof

async fn block_access_list_by_block_hash( &self, hash: FixedBytes<32>, ) -> Result<Option<Vec<AccountChanges>>, ErrorObject<'static>>

Handler for eth_getBlockAccessListByBlockHash

async fn block_access_list_by_block_number( &self, block_number: BlockNumberOrTag, ) -> Result<Option<Vec<AccountChanges>>, ErrorObject<'static>>

Handler for eth_getBlockAccessListByBlockNumber

async fn block_access_list( &self, block_id: BlockId, ) -> Result<Option<Vec<AccountChanges>>, ErrorObject<'static>>

Handler for eth_getBlockAccessList

async fn block_access_list_raw( &self, block: BlockId, ) -> Result<Option<Bytes>, ErrorObject<'static>>

Handler for getBlockAccessListRaw

async fn block_receipts( &self, block_id: BlockId, ) -> Result<Option<Vec<<<Eth as EthApiTypes>::NetworkTypes as RpcTypes>::Receipt>>, ErrorObject<'static>>

Returns all transaction receipts for a given block.

async fn transaction_receipt( &self, hash: FixedBytes<32>, ) -> Result<Option<<<Eth as EthApiTypes>::NetworkTypes as RpcTypes>::Receipt>, ErrorObject<'static>>

Returns the receipt of a transaction by transaction hash.

fn into_rpc(self) -> RpcModule<Self>

where TxReq: Send + Sync + 'static + DeserializeOwned, B: Send + Sync + 'static + Clone + Serialize, R: Send + Sync + 'static + Clone + Serialize, L: Send + Sync + 'static + Clone + Serialize,

Collects all the methods and subscriptions defined in the trait and adds them into a single RpcModule.

impl<T, H> Eq for Block<T, H>

where T: Eq, H: Eq,

impl From<AnyRpcBlock> for Block<AnyRpcTransaction, Header<AnyHeader>>

fn from(value: AnyRpcBlock) -> Block<AnyRpcTransaction, Header<AnyHeader>>

Converts to this type from the input type.

impl<T, S> From<Block<T>> for Block<S>

where S: From<T>,

fn from(block: Block<T>) -> Block<S>

Converts to this type from the input type.

impl<T, H> PartialEq for Block<T, H>

where T: PartialEq, H: PartialEq,

fn eq(&self, other: &Block<T, H>) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<T, H> Serialize for Block<T, H>

where T: Serialize, H: Serialize,

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T, H> StructuralPartialEq for Block<T, H>

where T: PartialEq, H: PartialEq,

impl<T, U> TryFrom<Block<U>> for RecoveredBlock<Block<T>>

where T: SignedTransaction + From<U>,

type Error = BlockRecoveryError<Block<T>>

The type returned in the event of a conversion error.

fn try_from( block: Block<U>, ) -> Result<RecoveredBlock<Block<T>>, <RecoveredBlock<Block<T>> as TryFrom<Block<U>>>::Error>

Performs the conversion.

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.