Bitcoin Core 28.99.0
P2P Digital Currency
chainparams.cpp
Go to the documentation of this file.
1// Copyright (c) 2010 Satoshi Nakamoto
2// Copyright (c) 2009-2022 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#include <chainparams.h>
7
8#include <chainparamsbase.h>
9#include <common/args.h>
10#include <consensus/params.h>
11#include <deploymentinfo.h>
12#include <logging.h>
13#include <tinyformat.h>
14#include <util/chaintype.h>
15#include <util/strencodings.h>
16#include <util/string.h>
17
18#include <cassert>
19#include <cstdint>
20#include <limits>
21#include <stdexcept>
22#include <vector>
23
25
27{
28 if (args.IsArgSet("-signetseednode")) {
29 options.seeds.emplace(args.GetArgs("-signetseednode"));
30 }
31 if (args.IsArgSet("-signetchallenge")) {
32 const auto signet_challenge = args.GetArgs("-signetchallenge");
33 if (signet_challenge.size() != 1) {
34 throw std::runtime_error("-signetchallenge cannot be multiple values.");
35 }
36 const auto val{TryParseHex<uint8_t>(signet_challenge[0])};
37 if (!val) {
38 throw std::runtime_error(strprintf("-signetchallenge must be hex, not '%s'.", signet_challenge[0]));
39 }
40 options.challenge.emplace(*val);
41 }
42}
43
45{
46 if (auto value = args.GetBoolArg("-fastprune")) options.fastprune = *value;
47 if (HasTestOption(args, "bip94")) options.enforce_bip94 = true;
48
49 for (const std::string& arg : args.GetArgs("-testactivationheight")) {
50 const auto found{arg.find('@')};
51 if (found == std::string::npos) {
52 throw std::runtime_error(strprintf("Invalid format (%s) for -testactivationheight=name@height.", arg));
53 }
54
55 const auto value{arg.substr(found + 1)};
56 int32_t height;
57 if (!ParseInt32(value, &height) || height < 0 || height >= std::numeric_limits<int>::max()) {
58 throw std::runtime_error(strprintf("Invalid height value (%s) for -testactivationheight=name@height.", arg));
59 }
60
61 const auto deployment_name{arg.substr(0, found)};
62 if (const auto buried_deployment = GetBuriedDeployment(deployment_name)) {
63 options.activation_heights[*buried_deployment] = height;
64 } else {
65 throw std::runtime_error(strprintf("Invalid name (%s) for -testactivationheight=name@height.", arg));
66 }
67 }
68
69 if (!args.IsArgSet("-vbparams")) return;
70
71 for (const std::string& strDeployment : args.GetArgs("-vbparams")) {
72 std::vector<std::string> vDeploymentParams = SplitString(strDeployment, ':');
73 if (vDeploymentParams.size() < 3 || 4 < vDeploymentParams.size()) {
74 throw std::runtime_error("Version bits parameters malformed, expecting deployment:start:end[:min_activation_height]");
75 }
77 if (!ParseInt64(vDeploymentParams[1], &vbparams.start_time)) {
78 throw std::runtime_error(strprintf("Invalid nStartTime (%s)", vDeploymentParams[1]));
79 }
80 if (!ParseInt64(vDeploymentParams[2], &vbparams.timeout)) {
81 throw std::runtime_error(strprintf("Invalid nTimeout (%s)", vDeploymentParams[2]));
82 }
83 if (vDeploymentParams.size() >= 4) {
84 if (!ParseInt32(vDeploymentParams[3], &vbparams.min_activation_height)) {
85 throw std::runtime_error(strprintf("Invalid min_activation_height (%s)", vDeploymentParams[3]));
86 }
87 } else {
88 vbparams.min_activation_height = 0;
89 }
90 bool found = false;
91 for (int j=0; j < (int)Consensus::MAX_VERSION_BITS_DEPLOYMENTS; ++j) {
92 if (vDeploymentParams[0] == VersionBitsDeploymentInfo[j].name) {
94 found = true;
95 LogPrintf("Setting version bits activation parameters for %s to start=%ld, timeout=%ld, min_activation_height=%d\n", vDeploymentParams[0], vbparams.start_time, vbparams.timeout, vbparams.min_activation_height);
96 break;
97 }
98 }
99 if (!found) {
100 throw std::runtime_error(strprintf("Invalid deployment (%s)", vDeploymentParams[0]));
101 }
102 }
103}
104
105static std::unique_ptr<const CChainParams> globalChainParams;
106
109 return *globalChainParams;
110}
111
112std::unique_ptr<const CChainParams> CreateChainParams(const ArgsManager& args, const ChainType chain)
113{
114 switch (chain) {
115 case ChainType::MAIN:
116 return CChainParams::Main();
118 return CChainParams::TestNet();
120 return CChainParams::TestNet4();
121 case ChainType::SIGNET: {
122 auto opts = CChainParams::SigNetOptions{};
123 ReadSigNetArgs(args, opts);
124 return CChainParams::SigNet(opts);
125 }
126 case ChainType::REGTEST: {
127 auto opts = CChainParams::RegTestOptions{};
128 ReadRegTestArgs(args, opts);
129 return CChainParams::RegTest(opts);
130 }
131 }
132 assert(false);
133}
134
135void SelectParams(const ChainType chain)
136{
137 SelectBaseParams(chain);
139}
ArgsManager gArgs
Definition: args.cpp:42
bool HasTestOption(const ArgsManager &args, const std::string &test_option)
Checks if a particular test option is present in -test command-line arg options.
Definition: args.cpp:715
ArgsManager & args
Definition: bitcoind.cpp:277
std::unique_ptr< const CChainParams > CreateChainParams(const ArgsManager &args, const ChainType chain)
Creates and returns a std::unique_ptr<CChainParams> of the chosen chain.
static std::unique_ptr< const CChainParams > globalChainParams
void SelectParams(const ChainType chain)
Sets the params returned by Params() to those for the given chain type.
const CChainParams & Params()
Return the currently selected parameters.
void ReadSigNetArgs(const ArgsManager &args, CChainParams::SigNetOptions &options)
Definition: chainparams.cpp:26
void ReadRegTestArgs(const ArgsManager &args, CChainParams::RegTestOptions &options)
Definition: chainparams.cpp:44
void SelectBaseParams(const ChainType chain)
Sets the params returned by Params() to those for the given chain.
ChainType
Definition: chaintype.h:11
std::vector< std::string > GetArgs(const std::string &strArg) const
Return a vector of strings of the given argument.
Definition: args.cpp:362
bool IsArgSet(const std::string &strArg) const
Return true if the given argument has been manually set.
Definition: args.cpp:371
bool GetBoolArg(const std::string &strArg, bool fDefault) const
Return boolean argument or default value.
Definition: args.cpp:507
CChainParams defines various tweakable parameters of a given instance of the Bitcoin system.
Definition: chainparams.h:81
static std::unique_ptr< const CChainParams > Main()
static std::unique_ptr< const CChainParams > RegTest(const RegTestOptions &options)
static std::unique_ptr< const CChainParams > TestNet()
static std::unique_ptr< const CChainParams > TestNet4()
static std::unique_ptr< const CChainParams > SigNet(const SigNetOptions &options)
std::optional< Consensus::BuriedDeployment > GetBuriedDeployment(const std::string_view name)
const struct VBDeploymentInfo VersionBitsDeploymentInfo[Consensus::MAX_VERSION_BITS_DEPLOYMENTS]
#define LogPrintf(...)
Definition: logging.h:266
DeploymentPos
Definition: params.h:32
@ MAX_VERSION_BITS_DEPLOYMENTS
Definition: params.h:36
std::vector< std::string > SplitString(std::string_view str, char sep)
Definition: string.h:136
const char * name
Definition: rest.cpp:49
RegTestOptions holds configurations for creating a regtest CChainParams.
Definition: chainparams.h:154
std::unordered_map< Consensus::DeploymentPos, VersionBitsParameters > version_bits_parameters
Definition: chainparams.h:155
std::unordered_map< Consensus::BuriedDeployment, int > activation_heights
Definition: chainparams.h:156
SigNetOptions holds configurations for creating a signet CChainParams.
Definition: chainparams.h:137
std::optional< std::vector< uint8_t > > challenge
Definition: chainparams.h:138
std::optional< std::vector< std::string > > seeds
Definition: chainparams.h:139
VersionBitsParameters holds activation parameters.
Definition: chainparams.h:145
#define strprintf
Format arguments and return the string or write to given std::ostream (see tinyformat::format doc for...
Definition: tinyformat.h:1165
bool ParseInt32(std::string_view str, int32_t *out)
Convert string to signed 32-bit integer with strict parse error feedback.
bool ParseInt64(std::string_view str, int64_t *out)
Convert string to signed 64-bit integer with strict parse error feedback.
assert(!tx.IsCoinBase())