CChainParams defines various tweakable parameters of a given instance of the Bitcoin system. More...

#include <chainparams.h>

Inheritance diagram for CChainParams:

Collaboration diagram for CChainParams:

Classes
struct	VersionBitsParameters
	VersionBitsParameters holds activation parameters. More...
struct	DeploymentOptions
struct	SigNetOptions
	SigNetOptions holds configurations for creating a signet CChainParams. More...
struct	RegTestOptions
	RegTestOptions holds configurations for creating a regtest CChainParams. More...
struct	MainNetOptions
struct	TestNetOptions

Public Types
enum	Base58Type { PUBKEY_ADDRESS , SCRIPT_ADDRESS , SECRET_KEY , EXT_PUBLIC_KEY , EXT_SECRET_KEY , MAX_BASE58_TYPES }

Public Member Functions
const Consensus::Params &	GetConsensus () const
const MessageStartChars &	MessageStart () const
uint16_t	GetDefaultPort () const
std::vector< int >	GetAvailableSnapshotHeights () const
const CBlock &	GenesisBlock () const
bool	DefaultConsistencyChecks () const
	Default value for -checkmempool and -checkblockindex argument.
bool	IsTestChain () const
	If this chain is exclusively used for testing.
bool	IsMockableChain () const
	If this chain allows time to be mocked.
uint64_t	PruneAfterHeight () const
uint64_t	AssumedBlockchainSize () const
	Minimum free space (in GB) needed for data directory.
uint64_t	AssumedChainStateSize () const
	Minimum free space (in GB) needed for data directory when pruned; Does not include prune target.
bool	MineBlocksOnDemand () const
	Whether it is possible to mine blocks on demand (no retargeting).
std::string	GetChainTypeString () const
	Return the chain type string.
ChainType	GetChainType () const
	Return the chain type.
const std::vector< std::string > &	DNSSeeds () const
	Return the list of hostnames to look up for DNS seeds.
const std::vector< unsigned char > &	Base58Prefix (Base58Type type) const
const std::string &	Bech32HRP () const
const std::vector< uint8_t > &	FixedSeeds () const
const HeadersSyncParams &	HeadersSync () const
std::optional< AssumeutxoData >	AssumeutxoForHeight (int height) const
std::optional< AssumeutxoData >	AssumeutxoForBlockhash (const uint256 &blockhash) const
const ChainTxData &	TxData () const

Static Public Member Functions
static std::unique_ptr< const CChainParams >	RegTest (const RegTestOptions &options)
static std::unique_ptr< const CChainParams >	RegTest ()
static std::unique_ptr< const CChainParams >	SigNet (const SigNetOptions &options)
static std::unique_ptr< const CChainParams >	SigNet ()
static std::unique_ptr< const CChainParams >	Main (const MainNetOptions &options)
static std::unique_ptr< const CChainParams >	Main ()
static std::unique_ptr< const CChainParams >	TestNet (const TestNetOptions &options)
static std::unique_ptr< const CChainParams >	TestNet ()
static std::unique_ptr< const CChainParams >	TestNet4 (const TestNetOptions &options)
static std::unique_ptr< const CChainParams >	TestNet4 ()

Protected Member Functions
	CChainParams ()=default
void	ApplyDeploymentOptions (const DeploymentOptions &opts)

Protected Attributes
Consensus::Params	consensus
MessageStartChars	pchMessageStart
uint16_t	nDefaultPort
uint64_t	nPruneAfterHeight
uint64_t	m_assumed_blockchain_size
uint64_t	m_assumed_chain_state_size
std::vector< std::string >	vSeeds
std::vector< unsigned char >	base58Prefixes [MAX_BASE58_TYPES]
std::string	bech32_hrp
ChainType	m_chain_type
CBlock	genesis
std::vector< uint8_t >	vFixedSeeds
bool	fDefaultConsistencyChecks
bool	m_is_mockable_chain
std::vector< AssumeutxoData >	m_assumeutxo_data
ChainTxData	chainTxData
HeadersSyncParams	m_headers_sync_params

Detailed Description

CChainParams defines various tweakable parameters of a given instance of the Bitcoin system.

Definition at line 76 of file chainparams.h.

Member Enumeration Documentation

◆ Base58Type

enum CChainParams::Base58Type

Enumerator
PUBKEY_ADDRESS
SCRIPT_ADDRESS
SECRET_KEY
EXT_PUBLIC_KEY
EXT_SECRET_KEY
MAX_BASE58_TYPES

Definition at line 79 of file chainparams.h.

Constructor & Destructor Documentation

◆ CChainParams()

CChainParams::CChainParams ( )

protecteddefault

Member Function Documentation

◆ ApplyDeploymentOptions()

void CChainParams::ApplyDeploymentOptions ( const DeploymentOptions & opts )

protected

Definition at line 76 of file chainparams.cpp.

Here is the caller graph for this function:

◆ AssumedBlockchainSize()

uint64_t CChainParams::AssumedBlockchainSize ( ) const

inline

Minimum free space (in GB) needed for data directory.

Definition at line 103 of file chainparams.h.

◆ AssumedChainStateSize()

uint64_t CChainParams::AssumedChainStateSize ( ) const

inline

Minimum free space (in GB) needed for data directory when pruned; Does not include prune target.

Definition at line 105 of file chainparams.h.

◆ AssumeutxoForBlockhash()

std::optional< AssumeutxoData > CChainParams::AssumeutxoForBlockhash ( const uint256 & blockhash ) const

inline

Definition at line 123 of file chainparams.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ AssumeutxoForHeight()

std::optional< AssumeutxoData > CChainParams::AssumeutxoForHeight ( int height ) const

inline

Definition at line 119 of file chainparams.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Base58Prefix()

const std::vector< unsigned char > & CChainParams::Base58Prefix ( Base58Type type ) const

inline

Definition at line 114 of file chainparams.h.

Here is the caller graph for this function:

◆ Bech32HRP()

const std::string & CChainParams::Bech32HRP ( ) const

inline

Definition at line 115 of file chainparams.h.

◆ DefaultConsistencyChecks()

bool CChainParams::DefaultConsistencyChecks ( ) const

inline

Default value for -checkmempool and -checkblockindex argument.

Definition at line 96 of file chainparams.h.

Here is the caller graph for this function:

◆ DNSSeeds()

const std::vector< std::string > & CChainParams::DNSSeeds ( ) const

inline

Return the list of hostnames to look up for DNS seeds.

Definition at line 113 of file chainparams.h.

Here is the caller graph for this function:

◆ FixedSeeds()

const std::vector< uint8_t > & CChainParams::FixedSeeds ( ) const

inline

Definition at line 116 of file chainparams.h.

Here is the caller graph for this function:

◆ GenesisBlock()

const CBlock & CChainParams::GenesisBlock ( ) const

inline

Definition at line 94 of file chainparams.h.

Here is the caller graph for this function:

◆ GetAvailableSnapshotHeights()

std::vector< int > CChainParams::GetAvailableSnapshotHeights ( ) const

Definition at line 713 of file chainparams.cpp.

◆ GetChainType()

ChainType CChainParams::GetChainType ( ) const

inline

Return the chain type.

Definition at line 111 of file chainparams.h.

Here is the caller graph for this function:

◆ GetChainTypeString()

std::string CChainParams::GetChainTypeString ( ) const

inline

Return the chain type string.

Definition at line 109 of file chainparams.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetConsensus()

const Consensus::Params & CChainParams::GetConsensus ( ) const

inline

Definition at line 89 of file chainparams.h.

Here is the caller graph for this function:

◆ GetDefaultPort()

uint16_t CChainParams::GetDefaultPort ( ) const

inline

Definition at line 91 of file chainparams.h.

Here is the caller graph for this function:

◆ HeadersSync()

const HeadersSyncParams & CChainParams::HeadersSync ( ) const

inline

Definition at line 117 of file chainparams.h.

Here is the caller graph for this function:

◆ IsMockableChain()

bool CChainParams::IsMockableChain ( ) const

inline

If this chain allows time to be mocked.

Definition at line 100 of file chainparams.h.

◆ IsTestChain()

bool CChainParams::IsTestChain ( ) const

inline

If this chain is exclusively used for testing.

Definition at line 98 of file chainparams.h.

Here is the caller graph for this function:

◆ Main() [1/2]

std::unique_ptr< const CChainParams > CChainParams::Main ( )

inlinestatic

Definition at line 175 of file chainparams.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Main() [2/2]

std::unique_ptr< const CChainParams > CChainParams::Main ( const MainNetOptions & options )

static

Definition at line 698 of file chainparams.cpp.

Here is the caller graph for this function:

◆ MessageStart()

const MessageStartChars & CChainParams::MessageStart ( ) const

inline

Definition at line 90 of file chainparams.h.

Here is the caller graph for this function:

◆ MineBlocksOnDemand()

bool CChainParams::MineBlocksOnDemand ( ) const

inline

Whether it is possible to mine blocks on demand (no retargeting).

Definition at line 107 of file chainparams.h.

Here is the caller graph for this function:

◆ PruneAfterHeight()

uint64_t CChainParams::PruneAfterHeight ( ) const

inline

Definition at line 101 of file chainparams.h.

Here is the caller graph for this function:

◆ RegTest() [1/2]

std::unique_ptr< const CChainParams > CChainParams::RegTest ( )

inlinestatic

Definition at line 171 of file chainparams.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ RegTest() [2/2]

std::unique_ptr< const CChainParams > CChainParams::RegTest ( const RegTestOptions & options )

static

Definition at line 693 of file chainparams.cpp.

Here is the caller graph for this function:

◆ SigNet() [1/2]

std::unique_ptr< const CChainParams > CChainParams::SigNet ( )

inlinestatic

Definition at line 173 of file chainparams.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SigNet() [2/2]

std::unique_ptr< const CChainParams > CChainParams::SigNet ( const SigNetOptions & options )

static

Definition at line 688 of file chainparams.cpp.

Here is the caller graph for this function:

◆ TestNet() [1/2]

std::unique_ptr< const CChainParams > CChainParams::TestNet ( )

inlinestatic

Definition at line 177 of file chainparams.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TestNet() [2/2]

std::unique_ptr< const CChainParams > CChainParams::TestNet ( const TestNetOptions & options )

static

Definition at line 703 of file chainparams.cpp.

Here is the caller graph for this function:

◆ TestNet4() [1/2]

std::unique_ptr< const CChainParams > CChainParams::TestNet4 ( )

inlinestatic

Definition at line 179 of file chainparams.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TestNet4() [2/2]

std::unique_ptr< const CChainParams > CChainParams::TestNet4 ( const TestNetOptions & options )

static

Definition at line 708 of file chainparams.cpp.

Here is the caller graph for this function:

◆ TxData()

const ChainTxData & CChainParams::TxData ( ) const

inline

Definition at line 128 of file chainparams.h.

Here is the caller graph for this function:

Member Data Documentation

◆ base58Prefixes

std::vector<unsigned char> CChainParams::base58Prefixes[MAX_BASE58_TYPES]

protected

Definition at line 191 of file chainparams.h.

◆ bech32_hrp

std::string CChainParams::bech32_hrp

protected

Definition at line 192 of file chainparams.h.

◆ chainTxData

ChainTxData CChainParams::chainTxData

protected

Definition at line 199 of file chainparams.h.

◆ consensus

Consensus::Params CChainParams::consensus

protected

Definition at line 184 of file chainparams.h.

◆ fDefaultConsistencyChecks

bool CChainParams::fDefaultConsistencyChecks

protected

Definition at line 196 of file chainparams.h.

◆ genesis

CBlock CChainParams::genesis

protected

Definition at line 194 of file chainparams.h.

◆ m_assumed_blockchain_size

uint64_t CChainParams::m_assumed_blockchain_size

protected

Definition at line 188 of file chainparams.h.

◆ m_assumed_chain_state_size

uint64_t CChainParams::m_assumed_chain_state_size

protected

Definition at line 189 of file chainparams.h.

◆ m_assumeutxo_data

std::vector<AssumeutxoData> CChainParams::m_assumeutxo_data

protected

Definition at line 198 of file chainparams.h.

◆ m_chain_type

ChainType CChainParams::m_chain_type

protected

Definition at line 193 of file chainparams.h.

◆ m_headers_sync_params

HeadersSyncParams CChainParams::m_headers_sync_params

protected

Definition at line 200 of file chainparams.h.

◆ m_is_mockable_chain

bool CChainParams::m_is_mockable_chain

protected

Definition at line 197 of file chainparams.h.

◆ nDefaultPort

uint16_t CChainParams::nDefaultPort

protected

Definition at line 186 of file chainparams.h.

◆ nPruneAfterHeight

uint64_t CChainParams::nPruneAfterHeight

protected

Definition at line 187 of file chainparams.h.

◆ pchMessageStart

MessageStartChars CChainParams::pchMessageStart

protected

Definition at line 185 of file chainparams.h.

◆ vFixedSeeds

std::vector<uint8_t> CChainParams::vFixedSeeds

protected

Definition at line 195 of file chainparams.h.

◆ vSeeds

std::vector<std::string> CChainParams::vSeeds

protected

Definition at line 190 of file chainparams.h.

The documentation for this class was generated from the following files:

src/kernel/chainparams.h
src/kernel/chainparams.cpp

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ Base58Type

Constructor & Destructor Documentation

◆ CChainParams()

Member Function Documentation

◆ ApplyDeploymentOptions()

◆ AssumedBlockchainSize()

◆ AssumedChainStateSize()

◆ AssumeutxoForBlockhash()

◆ AssumeutxoForHeight()

◆ Base58Prefix()

◆ Bech32HRP()

◆ DefaultConsistencyChecks()

◆ DNSSeeds()

◆ FixedSeeds()

◆ GenesisBlock()

◆ GetAvailableSnapshotHeights()

◆ GetChainType()

◆ GetChainTypeString()

◆ GetConsensus()

◆ GetDefaultPort()

◆ HeadersSync()

◆ IsMockableChain()

◆ IsTestChain()

◆ Main() [1/2]

◆ Main() [2/2]

◆ MessageStart()

◆ MineBlocksOnDemand()

◆ PruneAfterHeight()

◆ RegTest() [1/2]

◆ RegTest() [2/2]

◆ SigNet() [1/2]

◆ SigNet() [2/2]

◆ TestNet() [1/2]

◆ TestNet() [2/2]

◆ TestNet4() [1/2]

◆ TestNet4() [2/2]

◆ TxData()

Member Data Documentation

◆ base58Prefixes

◆ bech32_hrp

◆ chainTxData

◆ consensus

◆ fDefaultConsistencyChecks

◆ genesis

◆ m_assumed_blockchain_size

◆ m_assumed_chain_state_size

◆ m_assumeutxo_data

◆ m_chain_type

◆ m_headers_sync_params

◆ m_is_mockable_chain

◆ nDefaultPort

◆ nPruneAfterHeight

◆ pchMessageStart

◆ vFixedSeeds

◆ vSeeds