READ THE CODE

Inside Bitcoin

The code behind the network, with room to understand it.

Stable release v32.1bitcoin/bitcoin · f0de87f04062 ↗3,020 source files · 47.5 MB stored on the server440 file guides

Release published 2026-10-28 · Snapshot fetched 2026-11-01. Latest stable release at fetch time; development branches and Git history are excluded. Only the selected code window and visible folders load here.

34,260 bytes · SHA-256 f7f5bd8e9e275db9… · View upstream ↗

1// Copyright (c) 2011-present The Bitcoin Core developers
2// Distributed under the MIT software license, see the accompanying
3// file COPYING or http://www.opensource.org/licenses/mit-license.php.
4
5#include <test/util/setup_common.h>
6
7#include <addrman.h>
8#include <banman.h>
9#include <chain.h>
10#include <chainparams.h>
11#include <coins.h>
12#include <common/system.h>
13#include <consensus/amount.h>
14#include <consensus/consensus.h>
15#include <consensus/validation.h>
16#include <crypto/hex_base.h>
17#include <dbwrapper.h>
18#include <init.h>
19#include <interfaces/chain.h>
20#include <interfaces/mining.h>
21#include <kernel/caches.h>
22#include <kernel/context.h>
23#include <key.h>
24#include <logging.h>
25#include <net.h>
26#include <net_processing.h>
27#include <netbase.h>
28#include <netgroup.h>
29#include <node/blockstorage.h>
30#include <node/chainstate.h>
31#include <node/context.h>
32#include <node/kernel_notifications.h>
33#include <node/miner.h>
34#include <node/mining_args.h>
35#include <node/mining_types.h>
36#include <node/peerman_args.h>
37#include <node/warnings.h>
38#include <noui.h>
39#include <policy/feerate.h>
40#include <policy/policy.h>
41#include <pow.h>
42#include <primitives/block.h>
43#include <primitives/transaction.h>
44#include <random.h>
45#include <rpc/register.h>
46#include <rpc/server.h>
47#include <scheduler.h>
48#include <script/interpreter.h>
49#include <script/script.h>
50#include <script/sign.h>
51#include <script/signingprovider.h>
52#include <serialize.h>
53#include <span.h>
54#include <streams.h>
55#include <sync.h>
56#include <test/util/coverage.h>
57#include <test/util/net.h>
58#include <test/util/random.h>
59#include <test/util/txmempool.h>
60#include <tinyformat.h>
61#include <txmempool.h>
62#include <uint256.h>
63#include <util/chaintype.h>
64#include <util/check.h>
65#include <util/fs.h>
66#include <util/fs_helpers.h>
67#include <util/rbf.h>
68#include <util/result.h>
69#include <util/signalinterrupt.h>
70#include <util/strencodings.h>
71#include <util/task_runner.h>
72#include <util/thread.h>
73#include <util/threadnames.h>
74#include <util/time.h>
75#include <util/translation.h>
76#include <util/vector.h>
77#include <validation.h>
78#include <validationinterface.h>
79
80#include <algorithm>
81#include <array>
82#include <atomic>
83#include <cstdlib>
84#include <deque>
85#include <functional>
86#include <future>
87#include <iostream>
88#include <iterator>
89#include <map>
90#include <numeric>
91#include <span>
92#include <stdexcept>
93#include <string_view>
94#include <thread>
95#include <tuple>
96#include <utility>
97
98using namespace util::hex_literals;
99using node::ApplyArgsManOptions;
100using node::BlockManager;
101using node::KernelNotifications;
102using node::LoadChainstate;
103using node::RegenerateCommitments;
104using node::VerifyLoadedChainstate;
105
106const TranslateFn G_TRANSLATION_FUN{nullptr};
107
108constexpr inline auto TEST_DIR_PATH_ELEMENT{"test_common bitcoin"}; // Includes a space to catch possible path escape issues.
109/** Random context to get unique temp data dirs. Separate from m_rng, which can be seeded from a const env var */
110static FastRandomContext g_rng_temp_path;
111static const bool g_rng_temp_path_init{[] {
112    // Must be initialized before any SeedRandomForTest
113    Assert(!g_used_g_prng);
114    (void)g_rng_temp_path.rand64();
115    g_used_g_prng = false;
116    ResetCoverageCounters(); // The seed strengthen in SeedStartup is not deterministic, so exclude it from coverage counts
117    return true;
118}()};
119
120struct NetworkSetup
121{
122    NetworkSetup()
123    {
124        Assert(SetupNetworking());
125    }
126};
127static NetworkSetup g_networksetup_instance;
128
129void SetupCommonTestArgs(ArgsManager& argsman)
130{
131    argsman.AddArg("-testdatadir", strprintf("Custom data directory (default: %s<random_string>)", fs::PathToString(fs::temp_directory_path() / TEST_DIR_PATH_ELEMENT / "")),
132                   ArgsManager::ALLOW_ANY, OptionsCategory::DEBUG_TEST);
133}
134
135/** Test setup failure */
136static void ExitFailure(std::string_view str_err)
137{
138    std::cerr << str_err << std::endl;
139    exit(EXIT_FAILURE);
140}
141
142BasicTestingSetup::BasicTestingSetup(const ChainType chainType, TestOpts opts)
143    : m_args{}
144{
145    if (!EnableFuzzDeterminism()) {
146        SeedRandomForTest(SeedRand::FIXED_SEED);
147    }
148
149    // Reset globals
150    fDiscover = true;
151    fListen = true;
152    SetRPCWarmupStarting();
153    g_reachable_nets.Reset();
154    ClearLocal();
155
156    m_node.shutdown_signal = &m_interrupt;
157    m_node.shutdown_request = [this]{ return m_interrupt(); };
158    m_node.args = &gArgs;
159    std::vector<const char*> arguments = Cat(
160        {
161            "dummy",
162            "-printtoconsole=0",
163            "-logsourcelocations",
164            "-logtimemicros",
165            "-logthreadnames",
166            "-loglevel=trace",
167            "-debug",
168            "-debugexclude=leveldb",
169        },
170        opts.extra_args);
171    if (G_TEST_COMMAND_LINE_ARGUMENTS) {
172        arguments = Cat(arguments, G_TEST_COMMAND_LINE_ARGUMENTS());
173    }
174    util::ThreadRename("test");
175    gArgs.ClearPathCache();
176    {
177        SetupServerArgs(*m_node.args);
178        SetupCommonTestArgs(*m_node.args);
179        std::string error;
180        if (!m_node.args->ParseParameters(arguments.size(), arguments.data(), error)) {
181            m_node.args->ClearArgs();
182            throw std::runtime_error{error};
183        }
184    }
185
186    const std::string test_name{G_TEST_GET_FULL_NAME ? G_TEST_GET_FULL_NAME() : ""};
187    if (!m_node.args->IsArgSet("-testdatadir")) {
188        // To avoid colliding with a leftover prior datadir, and to allow
189        // tests, such as the fuzz tests to run in several processes at the
190        // same time, add a random element to the path. Keep it small enough to
191        // avoid a MAX_PATH violation on Windows.
192        //
193        // When fuzzing with AFL++, use the shared memory ID for a deterministic
194        // path. This allows for cleanup of leftover directories from timed-out
195        // or crashed iterations, preventing accumulation of stale datadirs.
196        if (const char* shm_id = std::getenv("__AFL_SHM_ID"); shm_id && *shm_id) {
197            m_path_root = fs::temp_directory_path() / TEST_DIR_PATH_ELEMENT / test_name / shm_id;
198            fs::remove_all(m_path_root);
199        } else {
200            const auto rand{HexStr(g_rng_temp_path.randbytes(10))};
201            m_path_root = fs::temp_directory_path() / TEST_DIR_PATH_ELEMENT / test_name / rand;
202        }
203        TryCreateDirectories(m_path_root);
204    } else {
205        // Custom data directory
206        m_has_custom_datadir = true;
207        fs::path root_dir{m_node.args->GetPathArg("-testdatadir")};
208        if (root_dir.empty()) ExitFailure("-testdatadir argument is empty, please specify a path");
209
210        root_dir = fs::absolute(root_dir);
211        m_path_lock = root_dir / TEST_DIR_PATH_ELEMENT / fs::PathFromString(test_name);
212        m_path_root = m_path_lock / "datadir";
213
214        // Try to obtain the lock; if unsuccessful don't disturb the existing test.
215        TryCreateDirectories(m_path_lock);
216        if (util::LockDirectory(m_path_lock, ".lock", /*probe_only=*/false) != util::LockResult::Success) {
217            ExitFailure("Cannot obtain a lock on test data lock directory " + fs::PathToString(m_path_lock) + '\n' + "The test executable is probably already running.");
218        }
219
220        // Always start with a fresh data directory; this doesn't delete the .lock file located one level above.
221        fs::remove_all(m_path_root);
222        if (!TryCreateDirectories(m_path_root)) ExitFailure("Cannot create test data directory");
223
224        // Print the test directory name if custom.
225        std::cout << "Test directory (will not be deleted): " << m_path_root << std::endl;
226    }
227    m_args.ForceSetArg("-datadir", fs::PathToString(m_path_root));
228    gArgs.ForceSetArg("-datadir", fs::PathToString(m_path_root));
229
230    // Avoid non-loopback network traffic during tests.
231    gArgs.ForceSetArg("-dnsseed", "0"); // DNS queries are usually forwarded to upstream DNS servers.
232    gArgs.ForceSetArg("-natpmp", "0"); // NATPMP sends packets to the router.
233
234    SelectParams(chainType);
235    InitLogging(*m_node.args);
236    AppInitParameterInteraction(*m_node.args);
237    LogInstance().StartLogging();
238    m_node.warnings = std::make_unique<node::Warnings>();
239    m_node.kernel = std::make_unique<kernel::Context>();
240    m_node.ecc_context = std::make_unique<ECC_Context>();
241    SetupEnvironment();
242
243    m_node.chain = interfaces::MakeChain(m_node);
244    static bool noui_connected = false;
245    if (!noui_connected) {
246        noui_connect();
247        noui_connected = true;
248    }
249}
250

src/wallet/receive.cpp

src/wallet/coinselection.cpp

src/consensus/validation.h

src/primitives/transaction.cpp

src/script/descriptor.cpp

src/bitcoin-cli.cpp

src/rpc/blockchain.cpp

src/rpc/rawtransaction.cpp

src/init.cpp

src/crypto/sha256.cpp

src/consensus/merkle.h

src/consensus/tx_check.h

src/consensus/tx_verify.h

src/policy/feerate.h

src/policy/feerate.cpp

src/primitives/transaction_identifier.h

src/chainparamsbase.h

src/chainparamsbase.cpp

src/util/moneystr.cpp

src/crypto/ripemd160.h

src/crypto/sha1.h

src/crypto/sha512.h

src/crypto/hmac_sha256.h

src/crypto/hmac_sha512.h

src/crypto/hmac_sha256.cpp

src/crypto/hmac_sha512.cpp

src/crypto/hkdf_sha256_32.h

src/crypto/hkdf_sha256_32.cpp

src/support/cleanse.h

src/support/cleanse.cpp

src/crypto/siphash.cpp

src/crypto/muhash.h

src/crypto/chacha20.h

src/crypto/poly1305.h

src/crypto/chacha20poly1305.h

src/crypto/chacha20poly1305.cpp

src/util/chaintype.cpp

src/util/obfuscation.h

src/util/byte_units.h

src/util/overflow.h

src/blockencodings.cpp

src/net_permissions.cpp

src/policy/packages.cpp

src/policy/rbf.cpp

src/policy/truc_policy.cpp

src/policy/ephemeral_policy.cpp

src/policy/settings.cpp

src/policy/policy.cpp

src/node/transaction.cpp

src/node/coin.cpp

src/rpc/client.cpp

src/rpc/external_signer.cpp

src/rpc/request.cpp

src/rpc/server_util.cpp

src/rpc/fees.cpp

src/rpc/output_script.cpp

src/rpc/rawtransaction_util.cpp

src/rpc/rawtransaction_util.h

src/rpc/register.h

src/rpc/request.h

src/rpc/server_util.h

src/rpc/protocol.h

src/rpc/server.h

src/rpc/signmessage.cpp

src/rpc/txoutproof.cpp

src/rpc/util.cpp

src/rpc/util.h

src/wallet/rpc/addresses.cpp

src/wallet/rpc/backup.cpp

src/wallet/rpc/coins.cpp

src/wallet/rpc/encrypt.cpp

src/wallet/rpc/signmessage.cpp

src/wallet/rpc/util.cpp

src/wallet/rpc/util.h

src/wallet/coincontrol.cpp

src/wallet/coincontrol.h

src/wallet/context.cpp

src/wallet/context.h

src/wallet/crypter.cpp

src/wallet/crypter.h

src/wallet/db.cpp

src/wallet/export.cpp

src/wallet/external_signer_scriptpubkeyman.cpp

src/wallet/rpc/spend.cpp

src/wallet/rpc/transactions.cpp

src/wallet/rpc/wallet.cpp

src/wallet/feebumper.cpp

src/wallet/feebumper.h

src/index/base.h

src/index/base.cpp

src/index/txindex.h

src/index/txindex.cpp

src/index/txindex_key.h

src/index/txospenderindex.h

src/index/txospenderindex.cpp

src/index/blockfilterindex.h

src/index/blockfilterindex.cpp

src/index/coinstatsindex.h

src/index/coinstatsindex.cpp

src/index/db_key.h

src/index/disktxpos.h

src/kernel/chain.cpp

src/kernel/chain.h

src/kernel/checks.cpp

src/kernel/checks.h

src/kernel/context.cpp

src/kernel/context.h

src/kernel/cs_main.cpp

src/kernel/cs_main.h

src/kernel/disconnected_transactions.cpp

src/kernel/disconnected_transactions.h

src/kernel/mempool_removal_reason.cpp

src/kernel/mempool_removal_reason.h

src/kernel/coinstats.cpp

src/kernel/coinstats.h

src/kernel/chainparams.cpp

src/kernel/chainparams.h

src/wallet/sqlite.cpp

src/wallet/sqlite.h

src/wallet/transaction.cpp

src/wallet/transaction.h

src/wallet/dump.cpp

src/wallet/dump.h

src/wallet/init.cpp

src/wallet/walletutil.cpp

src/wallet/walletutil.h

src/wallet/wallettool.cpp

src/wallet/wallettool.h

src/wallet/export.h

src/wallet/migrate.cpp

src/wallet/migrate.h

src/wallet/db.h

src/wallet/walletdb.cpp

src/wallet/interfaces.cpp

src/wallet/scriptpubkeyman.cpp

src/wallet/scriptpubkeyman.h

src/kernel/bitcoinkernel.cpp

src/kernel/bitcoinkernel.h

src/kernel/bitcoinkernel_wrapper.h

src/node/chainstate.cpp

src/node/chainstate.h

src/node/blockstorage.cpp

src/node/blockstorage.h

src/node/mempool_persist.cpp

src/node/mempool_persist.h

src/node/utxo_snapshot.cpp

src/node/utxo_snapshot.h

src/node/kernel_notifications.cpp

src/node/kernel_notifications.h

src/node/blockmanager_args.cpp

src/kernel/blockmanager_opts.h

src/util/expected.cpp

src/policy/settings.h

src/util/types.h

src/kernel/messagestartchars.h

src/kernel/warning.h

src/util/exception.h

src/common/license_info.h

src/node/coins_view_args.h

src/node/database_args.h

src/util/batchpriority.h

src/util/ui_change_type.h

src/node/coins_view_args.cpp

src/node/peerman_args.h

src/util/serfloat.h

src/node/blockmanager_args.h

src/node/database_args.cpp

src/util/overloaded.h

src/interfaces/types.h

src/node/chainstatemanager_args.h

src/node/minisketchwrapper.h

src/util/macros.h

src/util/syserror.h

src/common/run_command.h

src/util/bytevectorhash.cpp

src/node/mempool_persist_args.cpp

src/util/exec.h

src/util/rbf.h

src/crypto/hex_base.h

src/node/mempool_persist_args.h

src/interfaces/echo.h

src/util/any.h

src/util/batchpriority.cpp

src/util/threadnames.h

src/node/coin.h

src/node/mempool_args.h

src/util/asmap.h

src/util/bytevectorhash.h

src/node/context.cpp

src/util/insert.h

src/util/readwritefile.h

src/node/peerman_args.cpp

src/node/interface_ui.cpp

src/interfaces/handler.h

src/node/mining_args.h

src/util/hasher.cpp

src/common/init.h

src/kernel/mempool_limits.h

src/common/system.h

src/crypto/sha3.h

src/util/threadinterrupt.cpp

src/node/protocol_version.h

src/util/exception.cpp

src/common/messages.h

src/node/connection_types.cpp

src/util/bip32.h

src/common/license_info.cpp

src/util/stdmutex.h

src/common/run_command.cpp

src/util/check.cpp

src/util/golombrice.h

src/node/types.h

src/node/timeoffsets.h

src/util/readwritefile.cpp

src/util/fastrange.h

src/util/signalinterrupt.h

src/util/task_runner.h

src/util/syserror.cpp

src/common/interfaces.cpp

src/common/types.h

src/util/threadinterrupt.h

src/kernel/chainstatemanager_opts.h

src/node/psbt.h

src/policy/ephemeral_policy.h

src/util/trace.h

src/common/url.cpp

src/kernel/mempool_options.h

src/util/serfloat.cpp

src/kernel/notifications_interface.h

src/node/timeoffsets.cpp

src/node/warnings.cpp

src/util/hash_type.h

src/crypto/hex_base.cpp

src/node/eviction.h

src/util/tokenbucket.h

src/crypto/aes.h

src/common/pcp.h

src/util/feefrac.cpp

src/node/transaction.h

src/util/threadnames.cpp

src/common/signmessage.h

src/util/exec.cpp

src/util/signalinterrupt.cpp

src/clientversion.cpp

src/common/signmessage.cpp

src/compat/assumptions.h

src/compat/byteswap.h

src/deploymentinfo.cpp

src/deploymentinfo.h

src/deploymentstatus.cpp

src/deploymentstatus.h

src/dummywallet.cpp

src/external_signer.h

src/init/bitcoin-gui.cpp

src/init/bitcoin-node.cpp

src/init/bitcoin-qt.cpp

src/init/bitcoin-wallet.cpp

src/init/bitcoind.cpp

src/init/common.h

src/interfaces/init.h

src/interfaces/ipc.h

src/key_io.h

src/logging/categories.h

src/logging/timer.h

src/mapport.h

src/musig.h

src/net_permissions.h

src/netgroup.h

src/netmessagemaker.h

src/node/chainstatemanager_args.cpp

src/node/connection_types.h

src/node/context.h

src/node/interface_ui.h

src/node/mempool_args.cpp

src/node/mining_args.cpp

src/node/minisketchwrapper.cpp

src/node/txreconciliation.h

src/policy/fees/estimator_args.cpp

src/policy/fees/estimator_args.h

src/policy/fees/estimator_man.cpp

src/policy/fees/estimator_man.h

src/policy/packages.h

src/policy/rbf.h

src/policy/truc_policy.h

src/pow.h

src/primitives/block.cpp

src/randomenv.h

src/rest.h

src/script/keyorigin.h

src/script/parsing.cpp

src/script/parsing.h

src/script/script_error.h

src/script/sigcache.cpp

src/script/sigcache.h

src/script/solver.h

src/script/verify_flags.h

src/semaphore_grant.h

src/signet.h

src/span.h

src/support/allocators/secure.h

src/support/allocators/zeroafterfree.h

src/util/tokenpipe.cpp

src/util/translation.h

src/util/vector.h

src/versionbits.h

src/versionbits_impl.h

src/wallet/external_signer_scriptpubkeyman.h

src/wallet/fees.h

src/wallet/load.h

src/wallet/receive.h

src/wallet/rpc/wallet.h

src/wallet/types.h

src/walletinitinterface.h

src/zmq/zmqabstractnotifier.cpp

Independent explanations by MyBitcoinExplorer. Not affiliated with or endorsed by Bitcoin Core. Guides are educational and do not replace the source or its tests.

Bitcoin Core source © its contributors, distributed under the MIT license. Original notices and bundled third-party licenses are retained in the source tree.