Struct ChainSpec

pub struct ChainSpec {
    pub chain: Chain,
    pub genesis: Genesis,
    pub genesis_hash: OnceLock<B256>,
    pub genesis_header: OnceLock<Header>,
    pub paris_block_and_final_difficulty: Option<(u64, U256)>,
    pub hardforks: ChainHardforks,
    pub deposit_contract: Option<DepositContract>,
    pub base_fee_params: BaseFeeParamsKind,
    pub max_gas_limit: u64,
    pub prune_delete_limit: usize,
}

An Ethereum chain specification.

A chain specification describes:

• Meta-information about the chain (the chain ID)
• The genesis block of the chain ([Genesis])
• What hardforks are activated, and under which conditions

Fields

chain: Chain

The chain ID

genesis: Genesis

The genesis block.

genesis_hash: OnceLock<B256>

The hash of the genesis block.

This is either stored at construction time if it is known using once_cell_set, or computed once on the first access.

genesis_header: OnceLock<Header>

The header corresponding to the genesis block.

This is either stored at construction time if it is known using once_cell_set, or computed once on the first access.

paris_block_and_final_difficulty: Option<(u64, U256)>

The block at which EthereumHardfork::Paris was activated and the final difficulty at this block.

hardforks: ChainHardforks

The active hard forks and their activation conditions

deposit_contract: Option<DepositContract>

The deposit contract deployed for PoS

base_fee_params: BaseFeeParamsKind

The parameters that configure how a block’s base fee is computed

max_gas_limit: u64

The maximum gas limit

prune_delete_limit: usize

The delete limit for pruner, per run.

Implementations

impl ChainSpec

pub const fn chain(&self) -> Chain

Get information about the chain itself

pub const fn is_ethereum(&self) -> bool

Returns true if this chain contains Ethereum configuration.

pub fn is_optimism_mainnet(&self) -> bool

Returns true if this chain is Optimism mainnet.

pub const fn genesis(&self) -> &Genesis

Get the genesis block specification.

To get the header for the genesis block, use Self::genesis_header instead.

pub fn genesis_header(&self) -> &Header

Get the header for the genesis block.

pub fn sealed_genesis_header(&self) -> SealedHeader

Get the sealed header for the genesis block.

pub fn initial_base_fee(&self) -> Option<u64>

Get the initial base fee of the genesis block.

pub fn base_fee_params_at_timestamp(&self, timestamp: u64) -> BaseFeeParams

Get the BaseFeeParams for the chain at the given timestamp.

pub fn base_fee_params_at_block(&self, block_number: u64) -> BaseFeeParams

Get the BaseFeeParams for the chain at the given block number

pub fn genesis_hash(&self) -> B256

Get the hash of the genesis block.

pub const fn genesis_timestamp(&self) -> u64

Get the timestamp of the genesis block.

pub fn get_final_paris_total_difficulty(&self) -> Option<U256>

Returns the final total difficulty if the Paris hardfork is known.

pub fn final_paris_total_difficulty(&self, block_number: u64) -> Option<U256>

Returns the final total difficulty if the given block number is after the Paris hardfork.

Note: technically this would also be valid for the block before the paris upgrade, but this edge case is omitted here.

pub fn hardfork_fork_filter<H: Hardfork + Clone>( &self, fork: H, ) -> Option<ForkFilter>

Get the fork filter for the given hardfork

pub fn display_hardforks(&self) -> DisplayHardforks

Returns the hardfork display helper.

pub fn hardfork_fork_id<H: Hardfork + Clone>(&self, fork: H) -> Option<ForkId>

Get the fork id for the given hardfork.

pub fn shanghai_fork_id(&self) -> Option<ForkId>

Convenience method to get the fork id for EthereumHardfork::Shanghai from a given chainspec.

pub fn cancun_fork_id(&self) -> Option<ForkId>

Convenience method to get the fork id for EthereumHardfork::Cancun from a given chainspec.

pub fn latest_fork_id(&self) -> ForkId

Convenience method to get the latest fork id from the chainspec. Panics if chainspec has no hardforks.

pub fn fork_filter(&self, head: Head) -> ForkFilter

Creates a ForkFilter for the block described by Head.

pub fn fork_id(&self, head: &Head) -> ForkId

Compute the ForkId for the given Head following eip-6122 spec

pub fn builder() -> ChainSpecBuilder

Build a chainspec using ChainSpecBuilder

pub fn bootnodes(&self) -> Option<Vec<NodeRecord>>

Returns the known bootnode records for the given chain.

Methods from Deref<Target = ChainHardforks>

pub fn len(&self) -> usize

Total number of hardforks.

pub fn is_empty(&self) -> bool

Checks if the fork list is empty.

pub fn fork<H>(&self, fork: H) -> ForkCondition

where H: Hardfork,

Retrieves ForkCondition from fork. If fork is not present, returns ForkCondition::Never.

pub fn get<H>(&self, fork: H) -> Option<ForkCondition>

where H: Hardfork,

Retrieves ForkCondition from fork if it exists, otherwise None.

pub fn fork_block<H>(&self, fork: H) -> Option<u64>

where H: Hardfork,

Retrieves the fork block number or timestamp from fork if it exists, otherwise None.

pub fn forks_iter( &self, ) -> impl Iterator<Item = (&(dyn Hardfork + 'static), ForkCondition)>

Get an iterator of all hardforks with their respective activation conditions.

pub fn last(&self) -> Option<(Box<dyn Hardfork>, ForkCondition)>

Get last hardfork from the list.

pub fn is_fork_active_at_timestamp<H>(&self, fork: H, timestamp: u64) -> bool

where H: Hardfork,

Convenience method to check if a fork is active at a given timestamp.

pub fn is_fork_active_at_block<H>(&self, fork: H, block_number: u64) -> bool

where H: Hardfork,

Convenience method to check if a fork is active at a given block number.

Trait Implementations

impl Clone for ChainSpec

fn clone(&self) -> ChainSpec

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ChainSpec

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

Formats the value using the given formatter.

impl Default for ChainSpec

fn default() -> Self

Returns the “default value” for a type.

impl Deref for ChainSpec

type Target = ChainHardforks

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl EthChainSpec for ChainSpec

fn chain(&self) -> Chain

Returns the Chain object this spec targets.

fn base_fee_params_at_block(&self, block_number: u64) -> BaseFeeParams

Get the BaseFeeParams for the chain at the given block.

fn base_fee_params_at_timestamp(&self, timestamp: u64) -> BaseFeeParams

Get the BaseFeeParams for the chain at the given timestamp.

fn deposit_contract(&self) -> Option<&DepositContract>

Returns the deposit contract data for the chain, if it’s present

fn genesis_hash(&self) -> B256

The genesis hash.

fn prune_delete_limit(&self) -> usize

The delete limit for pruner, per run.

fn display_hardforks(&self) -> Box<dyn Display>

Returns a string representation of the hardforks.

fn genesis_header(&self) -> &Header

The genesis header.

fn genesis(&self) -> &Genesis

The genesis block specification.

fn max_gas_limit(&self) -> u64

The block gas limit.

fn bootnodes(&self) -> Option<Vec<NodeRecord>>

The bootnodes for the chain, if any.

fn is_optimism(&self) -> bool

Returns true if this chain contains Optimism configuration.

fn chain_id(&self) -> u64

Returns the chain id number

fn is_ethereum(&self) -> bool

Returns true if this chain contains Ethereum configuration.

impl EthereumHardforks for ChainSpec

fn get_final_paris_total_difficulty(&self) -> Option<U256>

Returns the final total difficulty if the Paris hardfork is known.

fn final_paris_total_difficulty(&self, block_number: u64) -> Option<U256>

Returns the final total difficulty if the given block number is after the Paris hardfork.

fn is_shanghai_active_at_timestamp(&self, timestamp: u64) -> bool

Convenience method to check if EthereumHardfork::Shanghai is active at a given timestamp.

fn is_cancun_active_at_timestamp(&self, timestamp: u64) -> bool

Convenience method to check if EthereumHardfork::Cancun is active at a given timestamp.

fn is_prague_active_at_timestamp(&self, timestamp: u64) -> bool

Convenience method to check if EthereumHardfork::Prague is active at a given timestamp.

fn is_osaka_active_at_timestamp(&self, timestamp: u64) -> bool

Convenience method to check if EthereumHardfork::Osaka is active at a given timestamp.

fn is_byzantium_active_at_block(&self, block_number: u64) -> bool

Convenience method to check if EthereumHardfork::Byzantium is active at a given block number.

fn is_spurious_dragon_active_at_block(&self, block_number: u64) -> bool

Convenience method to check if EthereumHardfork::SpuriousDragon is active at a given block number.

fn is_homestead_active_at_block(&self, block_number: u64) -> bool

Convenience method to check if EthereumHardfork::Homestead is active at a given block number.

fn is_paris_active_at_block(&self, block_number: u64) -> Option<bool>

The Paris hardfork (merge) is activated via block number. If we have knowledge of the block, this function will return true if the block number is greater than or equal to the Paris (merge) block.

impl From<Genesis> for ChainSpec

fn from(genesis: Genesis) -> Self

Converts to this type from the input type.

impl Hardforks for ChainSpec

fn fork<H: Hardfork>(&self, fork: H) -> ForkCondition

Retrieves ForkCondition from fork. If fork is not present, returns ForkCondition::Never.

fn forks_iter(&self) -> impl Iterator<Item = (&dyn Hardfork, ForkCondition)>

Get an iterator of all hardforks with their respective activation conditions.

fn fork_id(&self, head: &Head) -> ForkId

Compute the ForkId for the given Head following eip-6122 spec

fn latest_fork_id(&self) -> ForkId

Returns the ForkId for the last fork.

fn fork_filter(&self, head: Head) -> ForkFilter

Creates a ForkFilter for the block described by Head.

fn is_fork_active_at_timestamp<H>(&self, fork: H, timestamp: u64) -> bool

where H: Hardfork,

Convenience method to check if a fork is active at a given timestamp.

fn is_fork_active_at_block<H>(&self, fork: H, block_number: u64) -> bool

where H: Hardfork,

Convenience method to check if a fork is active at a given block number.

impl PartialEq for ChainSpec

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for ChainSpec

impl StructuralPartialEq for ChainSpec

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