Struct ChainSpec 

pub struct ChainSpec<H: BlockHeader = Header> {
    pub chain: Chain,
    pub genesis: Genesis,
    pub genesis_header: SealedHeader<H>,
    pub paris_block_and_final_difficulty: Option<(u64, U256)>,
    pub hardforks: ChainHardforks,
    pub deposit_contract: Option<DepositContract>,
    pub base_fee_params: BaseFeeParamsKind,
    pub prune_delete_limit: usize,
    pub blob_params: BlobScheduleBlobParams,
}

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_header: SealedHeader<H>

The header corresponding to the genesis block.

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

prune_delete_limit: usize

The delete limit for pruner, per run.

blob_params: BlobScheduleBlobParams

The settings passed for blob configurations for specific hardforks.

Implementations

impl ChainSpec

pub fn from_genesis(genesis: Genesis) -> Self

Converts the given [Genesis] into a ChainSpec.

pub fn builder() -> ChainSpecBuilder

Build a chainspec using ChainSpecBuilder

impl<H: BlockHeader> ChainSpec<H>

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 fn paris_block(&self) -> Option<u64>

Returns the known paris block, if it exists.

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) -> &H

Get the header for the genesis block.

pub fn sealed_genesis_header(&self) -> SealedHeader<H>

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 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 hardfork_fork_filter<HF: Hardfork + Clone>( &self, fork: HF, ) -> 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<HF: Hardfork + Clone>(&self, fork: HF) -> 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.

Note: In case there are multiple hardforks activated at the same block or timestamp, only the first gets applied.

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

Returns the known bootnode records for the given chain.

pub fn map_header<NewH: BlockHeader>( self, f: impl FnOnce(H) -> NewH, ) -> ChainSpec<NewH>

Convert header to another type.

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<H: Clone + BlockHeader> Clone for ChainSpec<H>

fn clone(&self) -> ChainSpec<H>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<H: Debug + BlockHeader> Debug for ChainSpec<H>

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

Formats the value using the given formatter.

impl<H: BlockHeader> Default for ChainSpec<H>

fn default() -> Self

Returns the “default value” for a type.

impl<H: BlockHeader> Deref for ChainSpec<H>

type Target = ChainHardforks

The resulting type after dereferencing.

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

Dereferences the value.

impl<H: BlockHeader> EthChainSpec for ChainSpec<H>

type Header = H

The header type of the network.

fn chain(&self) -> Chain

Returns the Chain object this spec targets.

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

Get the BaseFeeParams for the chain at the given timestamp.

fn blob_params_at_timestamp(&self, timestamp: u64) -> Option<BlobParams>

Get the [BlobParams] for 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) -> &Self::Header

The genesis header.

fn genesis(&self) -> &Genesis

The genesis block specification.

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 final_paris_total_difficulty(&self) -> Option<U256>

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

fn chain_id(&self) -> u64

Returns the chain id number

fn is_ethereum(&self) -> bool

Returns true if this chain contains Ethereum configuration.

fn next_block_base_fee( &self, parent: &Self::Header, target_timestamp: u64, ) -> Option<u64>

See [calc_next_block_base_fee].

impl<H: BlockHeader> EthExecutorSpec for ChainSpec<H>

fn deposit_contract_address(&self) -> Option<Address>

Address of deposit contract emitting deposit events.

impl<H: BlockHeader> EthereumHardforks for ChainSpec<H>

fn ethereum_fork_activation(&self, fork: EthereumHardfork) -> ForkCondition

Retrieves ForkCondition by an EthereumHardfork. If fork is not present, returns ForkCondition::Never.

fn is_ethereum_fork_active_at_timestamp( &self, fork: EthereumHardfork, timestamp: u64, ) -> bool

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

fn is_ethereum_fork_active_at_block( &self, fork: EthereumHardfork, block_number: u64, ) -> bool

Convenience method to check if an EthereumHardfork 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_tangerine_whistle_active_at_block(&self, block_number: u64) -> bool

Convenience method to check if EthereumHardfork::Tangerine 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_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_constantinople_active_at_block(&self, block_number: u64) -> bool

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

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

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

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

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

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

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

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

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

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

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

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_amsterdam_active_at_timestamp(&self, timestamp: u64) -> bool

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

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

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

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

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

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

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

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

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

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

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

impl From<Genesis> for ChainSpec

fn from(genesis: Genesis) -> Self

Converts to this type from the input type.

impl<H: BlockHeader> Hardforks for ChainSpec<H>

fn fork<HF: Hardfork>(&self, fork: HF) -> 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<H: PartialEq + BlockHeader> PartialEq for ChainSpec<H>

fn eq(&self, other: &ChainSpec<H>) -> 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<H: Eq + BlockHeader> Eq for ChainSpec<H>

impl<H: BlockHeader> StructuralPartialEq for ChainSpec<H>

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.