Struct ChainParams

pub struct ChainParams {
    pub params: Params,
    pub genesis: Block,
    pub subsidy_halving_interval: u64,
    pub pow_target_timespan: u64,
    pub coinbase_maturity: u32,
    pub segwit_activation_height: u32,
    pub csv_activation_height: u32,
    pub exceptions: HashMap<BlockHash, c_uint>,
    pub network: Network,
    pub enforce_bip94: bool,
}

This struct encapsulates all chain-specific parameters.

Fields

params: Params

Field to store parameters related to the chain consensus.

genesis: Block

The network’s first block, also called genesis block.

subsidy_halving_interval: u64

Interval of blocks until the block reward halves

pow_target_timespan: u64

When we retarget we expect this many seconds to be elapsed since last time. If it’s more, we decrease difficulty, if it’s less we increase difficulty

coinbase_maturity: u32

We wait this many blocks before a coinbase output can be spent

segwit_activation_height: u32

The height at which segwit is activated

csv_activation_height: u32

The height at which csv(CHECK_SEQUENCE_VERIFY) is activated

exceptions: HashMap<BlockHash, c_uint>

A list of exceptions to the rules, where the key is the block hash and the value is the verification flags

network: Network

The network this chain params is for

enforce_bip94: bool

Whether we should enforce BIP-094 “Testnet 4” rules

Implementations

impl ChainParams

pub fn get_assume_utreexo(network: Network) -> AssumeUtreexoValue

This method is called when Assume Utreexo is set to true. It means that the user will accept the hardcoded utreexo state for the specified block, if it is found in the best chain. We can then sync rapidly from this state.

pub fn get_assume_valid( network: Network, arg: AssumeValidArg, ) -> Option<BlockHash>

Returns the [BlockHash] to use as the assume-valid checkpoint, or None if script validation should run on all blocks.

Blocks at and before this checkpoint skip script execution during IBD. This argument does not influence chain selection; if the best chain doesn’t include this block, we will verify all the historical scripts.

Variants

• AssumeValidArg::Disabled — no checkpoint; all scripts are validated.
• AssumeValidArg::UserInput — use the provided hash.
• AssumeValidArg::Hardcoded — use a release-time checkpoint per [Network]:
  • Bitcoin: block 939,969
  • Signet: block 296,870
  • Testnet: block 4,887,983
  • Testnet4: block 126,514
  • Regtest: genesis block

pub fn get_validation_flags(&self, height: u32, hash: BlockHash) -> c_uint

Returns the validation flags for a given block hash and height

Trait Implementations

impl AsRef<Params> for ChainParams

fn as_ref(&self) -> &Params

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for ChainParams

fn clone(&self) -> ChainParams

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ChainParams

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

Formats the value using the given formatter.

impl From<Network> for ChainParams

fn from(network: Network) -> Self

Converts to this type from the input type.