Bitcoin Core  25.99.0
P2P Digital Currency
chainparams.h
Go to the documentation of this file.
1 // Copyright (c) 2009-2010 Satoshi Nakamoto
2 // Copyright (c) 2009-2021 The Bitcoin Core developers
3 // Distributed under the MIT software license, see the accompanying
4 // file COPYING or http://www.opensource.org/licenses/mit-license.php.
5 
6 #ifndef BITCOIN_KERNEL_CHAINPARAMS_H
7 #define BITCOIN_KERNEL_CHAINPARAMS_H
8 
9 #include <consensus/params.h>
11 #include <primitives/block.h>
12 #include <uint256.h>
13 #include <util/chaintype.h>
14 #include <util/hash_type.h>
15 
16 #include <cstdint>
17 #include <iterator>
18 #include <map>
19 #include <memory>
20 #include <optional>
21 #include <string>
22 #include <unordered_map>
23 #include <utility>
24 #include <vector>
25 
26 typedef std::map<int, uint256> MapCheckpoints;
27 
30 
31  int GetHeight() const {
32  const auto& final_checkpoint = mapCheckpoints.rbegin();
33  return final_checkpoint->first /* height */;
34  }
35 };
36 
37 struct AssumeutxoHash : public BaseHash<uint256> {
38  explicit AssumeutxoHash(const uint256& hash) : BaseHash(hash) {}
39 };
40 
49 
54  const unsigned int nChainTx;
55 };
56 
57 using MapAssumeutxo = std::map<int, const AssumeutxoData>;
58 
65 struct ChainTxData {
66  int64_t nTime;
67  int64_t nTxCount;
68  double dTxRate;
69 };
70 
76 {
77 public:
78  enum Base58Type {
84 
86  };
87 
88  const Consensus::Params& GetConsensus() const { return consensus; }
89  const MessageStartChars& MessageStart() const { return pchMessageStart; }
90  uint16_t GetDefaultPort() const { return nDefaultPort; }
91 
92  const CBlock& GenesisBlock() const { return genesis; }
96  bool IsTestChain() const { return m_chain_type != ChainType::MAIN; }
98  bool IsMockableChain() const { return m_is_mockable_chain; }
99  uint64_t PruneAfterHeight() const { return nPruneAfterHeight; }
107  std::string GetChainTypeString() const { return ChainTypeToString(m_chain_type); }
109  ChainType GetChainType() const { return m_chain_type; }
111  const std::vector<std::string>& DNSSeeds() const { return vSeeds; }
112  const std::vector<unsigned char>& Base58Prefix(Base58Type type) const { return base58Prefixes[type]; }
113  const std::string& Bech32HRP() const { return bech32_hrp; }
114  const std::vector<uint8_t>& FixedSeeds() const { return vFixedSeeds; }
115  const CCheckpointData& Checkpoints() const { return checkpointData; }
116 
119  const MapAssumeutxo& Assumeutxo() const { return m_assumeutxo_data; }
120 
121  const ChainTxData& TxData() const { return chainTxData; }
122 
126  struct SigNetOptions {
127  std::optional<std::vector<uint8_t>> challenge{};
128  std::optional<std::vector<std::string>> seeds{};
129  };
130 
135  int64_t start_time;
136  int64_t timeout;
138  };
139 
143  struct RegTestOptions {
144  std::unordered_map<Consensus::DeploymentPos, VersionBitsParameters> version_bits_parameters{};
145  std::unordered_map<Consensus::BuriedDeployment, int> activation_heights{};
146  bool fastprune{false};
147  };
148 
149  static std::unique_ptr<const CChainParams> RegTest(const RegTestOptions& options);
150  static std::unique_ptr<const CChainParams> SigNet(const SigNetOptions& options);
151  static std::unique_ptr<const CChainParams> Main();
152  static std::unique_ptr<const CChainParams> TestNet();
153 
154 protected:
156 
159  uint16_t nDefaultPort;
163  std::vector<std::string> vSeeds;
164  std::vector<unsigned char> base58Prefixes[MAX_BASE58_TYPES];
165  std::string bech32_hrp;
168  std::vector<uint8_t> vFixedSeeds;
174 };
175 
176 #endif // BITCOIN_KERNEL_CHAINPARAMS_H
std::string ChainTypeToString(ChainType chain)
Definition: chaintype.cpp:11
ChainType
Definition: chaintype.h:11
Definition: block.h:69
CChainParams defines various tweakable parameters of a given instance of the Bitcoin system.
Definition: chainparams.h:76
std::string GetChainTypeString() const
Return the chain type string.
Definition: chainparams.h:107
uint64_t m_assumed_chain_state_size
Definition: chainparams.h:162
MessageStartChars pchMessageStart
Definition: chainparams.h:158
const std::vector< unsigned char > & Base58Prefix(Base58Type type) const
Definition: chainparams.h:112
static std::unique_ptr< const CChainParams > Main()
std::string bech32_hrp
Definition: chainparams.h:165
bool DefaultConsistencyChecks() const
Default value for -checkmempool and -checkblockindex argument.
Definition: chainparams.h:94
static std::unique_ptr< const CChainParams > RegTest(const RegTestOptions &options)
CBlock genesis
Definition: chainparams.h:167
MapAssumeutxo m_assumeutxo_data
Definition: chainparams.h:172
const std::vector< std::string > & DNSSeeds() const
Return the list of hostnames to look up for DNS seeds.
Definition: chainparams.h:111
const ChainTxData & TxData() const
Definition: chainparams.h:121
const std::string & Bech32HRP() const
Definition: chainparams.h:113
uint64_t m_assumed_blockchain_size
Definition: chainparams.h:161
const CCheckpointData & Checkpoints() const
Definition: chainparams.h:115
std::vector< uint8_t > vFixedSeeds
Definition: chainparams.h:168
bool IsMockableChain() const
If this chain allows time to be mocked.
Definition: chainparams.h:98
bool fDefaultConsistencyChecks
Definition: chainparams.h:169
static std::unique_ptr< const CChainParams > TestNet()
const MapAssumeutxo & Assumeutxo() const
Get allowed assumeutxo configuration.
Definition: chainparams.h:119
std::vector< unsigned char > base58Prefixes[MAX_BASE58_TYPES]
Definition: chainparams.h:164
bool IsTestChain() const
If this chain is exclusively used for testing.
Definition: chainparams.h:96
bool MineBlocksOnDemand() const
Whether it is possible to mine blocks on demand (no retargeting)
Definition: chainparams.h:105
Consensus::Params consensus
Definition: chainparams.h:157
const std::vector< uint8_t > & FixedSeeds() const
Definition: chainparams.h:114
const Consensus::Params & GetConsensus() const
Definition: chainparams.h:88
uint16_t GetDefaultPort() const
Definition: chainparams.h:90
uint64_t AssumedBlockchainSize() const
Minimum free space (in GB) needed for data directory.
Definition: chainparams.h:101
std::vector< std::string > vSeeds
Definition: chainparams.h:163
bool m_is_mockable_chain
Definition: chainparams.h:170
const MessageStartChars & MessageStart() const
Definition: chainparams.h:89
ChainType m_chain_type
Definition: chainparams.h:166
uint64_t AssumedChainStateSize() const
Minimum free space (in GB) needed for data directory when pruned; Does not include prune target.
Definition: chainparams.h:103
uint64_t PruneAfterHeight() const
Definition: chainparams.h:99
CCheckpointData checkpointData
Definition: chainparams.h:171
uint16_t nDefaultPort
Definition: chainparams.h:159
ChainType GetChainType() const
Return the chain type.
Definition: chainparams.h:109
const CBlock & GenesisBlock() const
Definition: chainparams.h:92
static std::unique_ptr< const CChainParams > SigNet(const SigNetOptions &options)
uint64_t nPruneAfterHeight
Definition: chainparams.h:160
ChainTxData chainTxData
Definition: chainparams.h:173
256-bit opaque blob.
Definition: uint256.h:106
std::map< int, const AssumeutxoData > MapAssumeutxo
Definition: chainparams.h:57
std::map< int, uint256 > MapCheckpoints
Definition: chainparams.h:26
std::array< uint8_t, 4 > MessageStartChars
Holds configuration for use during UTXO snapshot load and validation.
Definition: chainparams.h:46
const AssumeutxoHash hash_serialized
The expected hash of the deserialized UTXO set.
Definition: chainparams.h:48
const unsigned int nChainTx
Used to populate the nChainTx value, which is used during BlockManager::LoadBlockIndex().
Definition: chainparams.h:54
AssumeutxoHash(const uint256 &hash)
Definition: chainparams.h:38
RegTestOptions holds configurations for creating a regtest CChainParams.
Definition: chainparams.h:143
std::unordered_map< Consensus::DeploymentPos, VersionBitsParameters > version_bits_parameters
Definition: chainparams.h:144
std::unordered_map< Consensus::BuriedDeployment, int > activation_heights
Definition: chainparams.h:145
SigNetOptions holds configurations for creating a signet CChainParams.
Definition: chainparams.h:126
std::optional< std::vector< uint8_t > > challenge
Definition: chainparams.h:127
std::optional< std::vector< std::string > > seeds
Definition: chainparams.h:128
VersionBitsParameters holds activation parameters.
Definition: chainparams.h:134
int GetHeight() const
Definition: chainparams.h:31
MapCheckpoints mapCheckpoints
Definition: chainparams.h:29
Holds various statistics on transactions within a chain.
Definition: chainparams.h:65
double dTxRate
estimated number of transactions per second after that timestamp
Definition: chainparams.h:68
int64_t nTime
UNIX timestamp of last known number of transactions.
Definition: chainparams.h:66
int64_t nTxCount
total number of transactions between genesis and that timestamp
Definition: chainparams.h:67
Parameters that influence chain consensus.
Definition: params.h:74
bool fPowNoRetargeting
Definition: params.h:111