CChainParams Class Reference

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:

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 CMessageHeader::MessageStartChars &	MessageStart () const
int	GetDefaultPort () const
const CBlock &	GenesisBlock () const
bool	DefaultConsistencyChecks () const
	Default value for -checkmempool and -checkblockindex argument. More...
bool	RequireStandard () const
	Policy: Filter transactions that do not match well-defined patterns. More...
bool	IsTestChain () const
	If this chain is exclusively used for testing. More...
bool	IsMockableChain () const
	If this chain allows time to be mocked. More...
uint64_t	PruneAfterHeight () const
uint64_t	AssumedBlockchainSize () const
	Minimum free space (in GB) needed for data directory. More...
uint64_t	AssumedChainStateSize () const
	Minimum free space (in GB) needed for data directory when pruned; Does not include prune target. More...
bool	MineBlocksOnDemand () const
	Whether it is possible to mine blocks on demand (no retargeting) More...
std::string	NetworkIDString () const
	Return the network string. More...
const std::vector< std::string > &	DNSSeeds () const
	Return the list of hostnames to look up for DNS seeds. More...
const std::vector< unsigned char > &	Base58Prefix (Base58Type type) const
const std::string &	Bech32HRP () const
const std::vector< SeedSpec6 > &	FixedSeeds () const
const CCheckpointData &	Checkpoints () const
const ChainTxData &	TxData () const

Protected Member Functions
	CChainParams ()

Protected Attributes
Consensus::Params	consensus
CMessageHeader::MessageStartChars	pchMessageStart
int	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
std::string	strNetworkID
CBlock	genesis
std::vector< SeedSpec6 >	vFixedSeeds
bool	fDefaultConsistencyChecks
bool	fRequireStandard
bool	m_is_test_chain
bool	m_is_mockable_chain
CCheckpointData	checkpointData
ChainTxData	chainTxData

Detailed Description

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

There are three: the main network on which people trade goods and services, the public test network which gets reset from time to time and a regression test mode which is intended for private networks only. It has minimal difficulty to ensure that blocks can be found instantly.

Definition at line 52 of file chainparams.h.

Member Enumeration Documentation

enum CChainParams::Base58Type

Enumerator
PUBKEY_ADDRESS
SCRIPT_ADDRESS
SECRET_KEY
EXT_PUBLIC_KEY
EXT_SECRET_KEY
MAX_BASE58_TYPES

Definition at line 55 of file chainparams.h.

Constructor & Destructor Documentation

CChainParams::CChainParams ( )

inlineprotected

Definition at line 95 of file chainparams.h.

Member Function Documentation

uint64_t CChainParams::AssumedBlockchainSize ( ) const

inline

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

Definition at line 80 of file chainparams.h.

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 82 of file chainparams.h.

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

inline

Definition at line 89 of file chainparams.h.

Here is the caller graph for this function:

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

inline

Definition at line 90 of file chainparams.h.

const CCheckpointData& CChainParams::Checkpoints ( ) const

inline

Definition at line 92 of file chainparams.h.

bool CChainParams::DefaultConsistencyChecks ( ) const

inline

Default value for -checkmempool and -checkblockindex argument.

Definition at line 71 of file chainparams.h.

Here is the caller graph for this function:

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

inline

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

Definition at line 88 of file chainparams.h.

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

inline

Definition at line 91 of file chainparams.h.

const CBlock& CChainParams::GenesisBlock ( ) const

inline

Definition at line 69 of file chainparams.h.

Here is the caller graph for this function:

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

inline

Definition at line 65 of file chainparams.h.

Here is the caller graph for this function:

int CChainParams::GetDefaultPort ( ) const

inline

Definition at line 67 of file chainparams.h.

bool CChainParams::IsMockableChain ( ) const

inline

If this chain allows time to be mocked.

Definition at line 77 of file chainparams.h.

Here is the caller graph for this function:

bool CChainParams::IsTestChain ( ) const

inline

If this chain is exclusively used for testing.

Definition at line 75 of file chainparams.h.

Here is the caller graph for this function:

const CMessageHeader::MessageStartChars& CChainParams::MessageStart ( ) const

inline

Definition at line 66 of file chainparams.h.

Here is the caller graph for this function:

bool CChainParams::MineBlocksOnDemand ( ) const

inline

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

Definition at line 84 of file chainparams.h.

Here is the caller graph for this function:

std::string CChainParams::NetworkIDString ( ) const

inline

Return the network string.

Definition at line 86 of file chainparams.h.

Here is the caller graph for this function:

uint64_t CChainParams::PruneAfterHeight ( ) const

inline

Definition at line 78 of file chainparams.h.

bool CChainParams::RequireStandard ( ) const

inline

Policy: Filter transactions that do not match well-defined patterns.

Definition at line 73 of file chainparams.h.

Here is the caller graph for this function:

const ChainTxData& CChainParams::TxData ( ) const

inline

Definition at line 93 of file chainparams.h.

Here is the caller graph for this function:

Member Data Documentation

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

protected

Definition at line 104 of file chainparams.h.

std::string CChainParams::bech32_hrp

protected

Definition at line 105 of file chainparams.h.

ChainTxData CChainParams::chainTxData

protected

Definition at line 114 of file chainparams.h.

CCheckpointData CChainParams::checkpointData

protected

Definition at line 113 of file chainparams.h.

Consensus::Params CChainParams::consensus

protected

Definition at line 97 of file chainparams.h.

bool CChainParams::fDefaultConsistencyChecks

protected

Definition at line 109 of file chainparams.h.

bool CChainParams::fRequireStandard

protected

Definition at line 110 of file chainparams.h.

CBlock CChainParams::genesis

protected

Definition at line 107 of file chainparams.h.

uint64_t CChainParams::m_assumed_blockchain_size

protected

Definition at line 101 of file chainparams.h.

uint64_t CChainParams::m_assumed_chain_state_size

protected

Definition at line 102 of file chainparams.h.

bool CChainParams::m_is_mockable_chain

protected

Definition at line 112 of file chainparams.h.

bool CChainParams::m_is_test_chain

protected

Definition at line 111 of file chainparams.h.

int CChainParams::nDefaultPort

protected

Definition at line 99 of file chainparams.h.

uint64_t CChainParams::nPruneAfterHeight

protected

Definition at line 100 of file chainparams.h.

CMessageHeader::MessageStartChars CChainParams::pchMessageStart

protected

Definition at line 98 of file chainparams.h.

std::string CChainParams::strNetworkID

protected

Definition at line 106 of file chainparams.h.

std::vector<SeedSpec6> CChainParams::vFixedSeeds

protected

Definition at line 108 of file chainparams.h.

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

protected

Definition at line 103 of file chainparams.h.

---

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

• src/chainparams.h