Coverage Report

Created: 2026-09-21 19:49

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/tmp/bitcoin/src/chainparamsbase.cpp
Line
Count
Source
1
// Copyright (c) 2010 Satoshi Nakamoto
2
// Copyright (c) 2009-present 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 <chainparamsbase.h>
7
8
#include <common/args.h>
9
#include <crypto/hex_base.h>
10
#include <kernel/signet.h>
11
#include <tinyformat.h>
12
#include <util/chaintype.h>
13
#include <util/strencodings.h>
14
15
#include <cassert>
16
17
void SetupChainParamsBaseOptions(ArgsManager& argsman)
18
3.26k
{
19
3.26k
    argsman.AddArg("-chain=<chain>", "Use the chain <chain> (default: main). Allowed values: " LIST_CHAIN_NAMES, ArgsManager::ALLOW_ANY, OptionsCategory::CHAINPARAMS);
20
3.26k
    argsman.AddArg("-regtest", "Enter regression test mode, which uses a special chain in which blocks can be solved instantly. "
21
3.26k
                 "This is intended for regression testing tools and app development. Equivalent to -chain=regtest.", ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::CHAINPARAMS);
22
3.26k
    argsman.AddArg("-testactivationheight=name@height.", "Set the activation height of 'name' (segwit, bip34, dersig, cltv, csv). (test-only)", ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::DEBUG_TEST);
23
3.26k
    argsman.AddArg("-testnet", "Use the testnet3 chain. Equivalent to -chain=test. Support for testnet3 is deprecated and will be removed in an upcoming release. Consider moving to testnet4 now by using -testnet4.", ArgsManager::ALLOW_ANY, OptionsCategory::CHAINPARAMS);
24
3.26k
    argsman.AddArg("-testnet4", "Use the testnet4 chain. Equivalent to -chain=testnet4.", ArgsManager::ALLOW_ANY, OptionsCategory::CHAINPARAMS);
25
3.26k
    argsman.AddArg("-vbparams=deployment:start:end[:min_activation_height]", "Use given start/end times and min_activation_height for specified version bits deployment (test-only)", ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::CHAINPARAMS);
26
3.26k
    argsman.AddArg("-signet", "Use the signet chain. Equivalent to -chain=signet. Note that the network is defined by the -signetchallenge parameter", ArgsManager::ALLOW_ANY, OptionsCategory::CHAINPARAMS);
27
3.26k
    argsman.AddArg("-signetchallenge", "Blocks must satisfy the given script to be considered valid (only for signet networks; defaults to the global default signet test network challenge)", ArgsManager::ALLOW_ANY | ArgsManager::DISALLOW_NEGATION, OptionsCategory::CHAINPARAMS);
28
3.26k
    argsman.AddArg("-signetseednode", "Specify a seed node for the signet network, in the hostname[:port] format, e.g. sig.net:1234 (may be used multiple times to specify multiple seed nodes; defaults to the global default signet test network seed node(s))", ArgsManager::ALLOW_ANY | ArgsManager::DISALLOW_NEGATION, OptionsCategory::CHAINPARAMS);
29
3.26k
}
30
31
static std::unique_ptr<CBaseChainParams> globalChainBaseParams;
32
33
const CBaseChainParams& BaseParams()
34
10.2k
{
35
10.2k
    assert(globalChainBaseParams);
36
10.2k
    return *globalChainBaseParams;
37
10.2k
}
38
39
std::string GetSignetDataDir(const ArgsManager& args)
40
3.26k
{
41
3.26k
    std::string base_data_dir = "signet";
42
    // no default to treat no -signetchallenge (default signet) as distinct from
43
    // the empty -signetchallenge= (custom signet)
44
3.26k
    const auto challenge_hex = args.GetArg("-signetchallenge");
45
3.26k
    if (!challenge_hex) {
46
3.22k
        return base_data_dir;
47
3.22k
    }
48
    // -signetchallenge can be invalid hex here (it's checked later in
49
    // ReadSigNetArgs), but we don't mind to keep validation in one place.
50
38
    const auto challenge_bytes = TryParseHex<uint8_t>(*challenge_hex);
51
38
    if (!challenge_bytes || *challenge_bytes == kernel::SIGNET_DEFAULT_CHALLENGE) {
52
3
        return base_data_dir;
53
3
    }
54
35
    return base_data_dir + "_" + HexStr(kernel::GetSignetMessageStart(*challenge_bytes));
55
38
}
56
57
/**
58
 * Port numbers for incoming Tor connections (8334, 18334, 38334, 48334, 18445) have
59
 * been chosen arbitrarily to keep ranges of used ports tight.
60
 */
61
std::unique_ptr<CBaseChainParams> CreateBaseChainParams(const ArgsManager& args, const ChainType chain)
62
19.2k
{
63
19.2k
    switch (chain) {
64
3.97k
    case ChainType::MAIN:
65
3.97k
        return std::make_unique<CBaseChainParams>("", 8332);
66
3.18k
    case ChainType::TESTNET:
67
3.18k
        return std::make_unique<CBaseChainParams>("testnet3", 18332);
68
3.15k
    case ChainType::TESTNET4:
69
3.15k
        return std::make_unique<CBaseChainParams>("testnet4", 48332);
70
3.26k
    case ChainType::SIGNET:
71
3.26k
        return std::make_unique<CBaseChainParams>(GetSignetDataDir(args), 38332);
72
5.65k
    case ChainType::REGTEST:
73
5.65k
        return std::make_unique<CBaseChainParams>("regtest", 18443);
74
19.2k
    }
75
19.2k
    assert(false);
76
0
}
77
78
void SelectBaseParams(const ChainType chain)
79
3.66k
{
80
3.66k
    gArgs.SelectConfigNetwork(ChainTypeToString(chain));
81
3.66k
    globalChainBaseParams = CreateBaseChainParams(gArgs, chain);
82
3.66k
}