Struct Chain 

pub struct Chain<N: NodePrimitives = EthPrimitives> { /* private fields */ }

A chain of blocks and their final state.

The chain contains the state of accounts after execution of its blocks, changesets for those blocks (and their transactions), as well as the blocks themselves.

Used inside the BlockchainTree.

Warning

A chain of blocks should not be empty.

Implementations

impl<N: NodePrimitives> Chain<N>

pub fn new( blocks: impl IntoIterator<Item: Into<Arc<RecoveredBlock<N::Block>>>>, execution_outcome: ExecutionOutcome<N::Receipt>, trie_data: BTreeMap<BlockNumber, LazyTrieData>, ) -> Self

Create new Chain from blocks and state.

Warning

A chain of blocks should not be empty.

pub fn from_block( block: impl Into<Arc<RecoveredBlock<N::Block>>>, execution_outcome: ExecutionOutcome<N::Receipt>, trie_data: LazyTrieData, ) -> Self

Create new Chain from a single block and its state.

pub const fn blocks( &self, ) -> &BTreeMap<BlockNumber, Arc<RecoveredBlock<N::Block>>>

Get the blocks in this chain.

pub fn into_blocks(self) -> BTreeMap<BlockNumber, Arc<RecoveredBlock<N::Block>>>

Consumes the type and only returns the blocks in this chain.

pub fn headers(&self) -> impl Iterator<Item = SealedHeader<N::BlockHeader>> + '_

Returns an iterator over all headers in the block with increasing block numbers.

pub const fn trie_data(&self) -> &BTreeMap<BlockNumber, LazyTrieData>

Get all trie data for this chain.

pub fn trie_data_at(&self, block_number: BlockNumber) -> Option<&LazyTrieData>

Get trie data for a specific block number.

pub fn clear_trie_data(&mut self)

Remove all trie data for this chain.

pub const fn bals(&self) -> &BTreeMap<BlockNumber, Arc<DecodedEvmBal>>

Get all prepared block access lists for this chain.

Blocks without an available BAL have no entry; see the bals field for details.

pub fn bal_at(&self, block_number: BlockNumber) -> Option<&Arc<DecodedEvmBal>>

Get the prepared block access list for a specific block number, if one is available.

None only means no BAL was attached for that block; see the bals field for details.

pub fn insert_bal(&mut self, block_number: BlockNumber, bal: Arc<DecodedEvmBal>)

Attach a prepared block access list to a block of this chain.

pub const fn execution_outcome(&self) -> &ExecutionOutcome<N::Receipt>

Get execution outcome of this chain

pub const fn execution_outcome_mut( &mut self, ) -> &mut ExecutionOutcome<N::Receipt>

Get mutable execution outcome of this chain

pub fn is_empty(&self) -> bool

Return true if chain is empty and has no blocks.

pub fn block_number(&self, block_hash: BlockHash) -> Option<BlockNumber>

Return block number of the block hash.

pub fn recovered_block( &self, block_hash: BlockHash, ) -> Option<&RecoveredBlock<N::Block>>

Returns the block with matching hash.

pub fn execution_outcome_at_block( &self, block_number: BlockNumber, ) -> Option<ExecutionOutcome<N::Receipt>>

Return execution outcome at the block_number or None if block is not known

pub fn into_inner( self, ) -> (ChainBlocks<'static, N::Block>, ExecutionOutcome<N::Receipt>, BTreeMap<BlockNumber, LazyTrieData>)

Destructure the chain into its inner components:

1. The blocks contained in the chain.
2. The execution outcome representing the final state.
3. The trie data map.

pub const fn inner( &self, ) -> (ChainBlocks<'_, N::Block>, &ExecutionOutcome<N::Receipt>)

Destructure the chain into its inner components:

1. A reference to the blocks contained in the chain.
2. A reference to the execution outcome representing the final state.

pub fn block_receipts_iter(&self) -> impl Iterator<Item = &Vec<N::Receipt>> + '_

Returns an iterator over all the receipts of the blocks in the chain.

pub fn receipts_iter(&self) -> impl Iterator<Item = &N::Receipt> + '_

Returns an iterator over all receipts in the chain.

pub fn logs_iter(&self) -> impl Iterator<Item = &Log> + '_

where N::Receipt: TxReceipt<Log = Log>,

Returns an iterator over all logs in the chain.

pub fn blocks_iter( &self, ) -> impl Iterator<Item = &Arc<RecoveredBlock<N::Block>>> + '_

Returns an iterator over all blocks in the chain with increasing block number.

pub fn transactions_iter(&self) -> impl Iterator<Item = &N::SignedTx> + '_

Returns an iterator over all transactions in the chain.

pub fn transaction_hashes(&self) -> impl Iterator<Item = &TxHash> + '_

Returns an iterator over all transaction hashes in the chain.

pub fn transactions_recovered_iter( &self, ) -> impl Iterator<Item = Recovered<&N::SignedTx>> + '_

Returns an iterator over all [Recovered] transaction references in the chain.

pub fn blocks_and_receipts( &self, ) -> impl Iterator<Item = (&Arc<RecoveredBlock<N::Block>>, &Vec<N::Receipt>)> + '_

Returns an iterator over all blocks and their receipts in the chain.

pub fn blocks_and_bals( &self, ) -> impl Iterator<Item = (&Arc<RecoveredBlock<N::Block>>, &Arc<DecodedEvmBal>)> + '_

Returns an iterator over the blocks of this chain that have a prepared block access list, paired with that BAL.

Blocks without an available BAL are skipped; see the bals field for details.

pub fn find_transaction_and_receipt_by_hash( &self, tx_hash: TxHash, ) -> Option<(&'_ Arc<RecoveredBlock<<N as NodePrimitives>::Block>>, IndexedTx<'_, <N as NodePrimitives>::Block>, &'_ <N as NodePrimitives>::Receipt, &'_ [<N as NodePrimitives>::Receipt])>

Finds a transaction by hash and returns it along with its corresponding receipt data.

Returns None if the transaction is not found in this chain.

pub fn fork_block(&self) -> ForkBlock

Get the block at which this chain forked.

pub fn first(&self) -> &RecoveredBlock<N::Block>

Get the first block in this chain.

Panics

If chain doesn’t have any blocks.

pub fn tip(&self) -> &RecoveredBlock<N::Block>

Get the tip of the chain.

Panics

If chain doesn’t have any blocks.

pub fn len(&self) -> usize

Returns length of the chain.

pub fn range(&self) -> RangeInclusive<BlockNumber>

Returns the range of block numbers in the chain.

Panics

If chain doesn’t have any blocks.

pub fn receipts_by_block_hash( &self, block_hash: BlockHash, ) -> Option<Vec<&N::Receipt>>

Get all receipts for the given block.

pub fn receipts_with_attachment(&self) -> Vec<BlockReceipts<N::Receipt>>

Get all receipts with attachment.

Attachment includes block number, block hash, transaction hash and transaction index.

pub fn append_block( &mut self, block: impl Into<Arc<RecoveredBlock<N::Block>>>, execution_outcome: ExecutionOutcome<N::Receipt>, trie_data: LazyTrieData, )

Append a single block with state to the chain. This method assumes that blocks attachment to the chain has already been validated.

pub fn append_chain(&mut self, other: Self) -> Result<(), Self>

Merge two chains by appending the given chain into the current one.

The state of accounts for this chain is set to the state of the newest chain.

Returns the passed other chain in Result::Err variant if the chains could not be connected.

Trait Implementations

impl<N: Clone + NodePrimitives> Clone for Chain<N>

where N::Block: Clone, N::Receipt: Clone,

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<N: Debug + NodePrimitives> Debug for Chain<N>

where N::Block: Debug, N::Receipt: Debug,

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

Formats the value using the given formatter.

impl<N: NodePrimitives> Default for Chain<N>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, N: NodePrimitives> Deserialize<'de> for Chain<N>

Available on crate feature serde only.

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'de, N> DeserializeAs<'de, Chain<N>> for Chain<'de, N>

where N: NodePrimitives,

Available on crate feature serde-bincode-compat only.

fn deserialize_as<D>(deserializer: D) -> Result<Chain<N>, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<N: Eq + NodePrimitives> Eq for Chain<N>

where N::Block: Eq, N::Receipt: Eq,

impl<'a, N> From<&'a Chain<N>> for Chain<'a, N>

where N: NodePrimitives,

Available on crate feature serde-bincode-compat only.

fn from(value: &'a Chain<N>) -> Self

Converts to this type from the input type.

impl<'a, N> From<Chain<'a, N>> for Chain<N>

where N: NodePrimitives,

Available on crate feature serde-bincode-compat only.

fn from(value: Chain<'a, N>) -> Self

Converts to this type from the input type.

impl<N: PartialEq + NodePrimitives> PartialEq for Chain<N>

where N::Block: PartialEq, N::Receipt: PartialEq,

fn eq(&self, other: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<N: NodePrimitives> Serialize for Chain<N>

Available on crate feature serde only.

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<N> SerializeAs<Chain<N>> for Chain<'_, N>

where N: NodePrimitives,

Available on crate feature serde-bincode-compat only.

fn serialize_as<S>(source: &Chain<N>, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<N: PartialEq + NodePrimitives> StructuralPartialEq for Chain<N>

where N::Block: PartialEq, N::Receipt: PartialEq,

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