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.

11,858 bytes · SHA-256 591f841248dab687… · View upstream ↗

1// Copyright (c) 2015-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#ifndef BITCOIN_TEST_UTIL_SETUP_COMMON_H
6#define BITCOIN_TEST_UTIL_SETUP_COMMON_H
7
8#include <common/args.h> // IWYU pragma: export
9#include <consensus/amount.h>
10#include <kernel/caches.h>
11#include <key.h>
12#include <node/caches.h>
13#include <node/context.h> // IWYU pragma: export
14#include <primitives/transaction.h>
15#include <random.h>
16#include <test/util/net.h>
17#include <test/util/random.h>
18#include <test/util/time.h>
19#include <util/chaintype.h> // IWYU pragma: export
20#include <util/fs.h>
21#include <util/signalinterrupt.h>
22#include <util/vector.h>
23
24#include <cstddef>
25#include <cstdint>
26#include <functional>
27#include <memory>
28#include <optional>
29#include <string>
30#include <utility>
31#include <vector>
32
33class CFeeRate;
34
35/** Retrieve the command line arguments. */
36extern const std::function<std::vector<const char*>()> G_TEST_COMMAND_LINE_ARGUMENTS;
37
38/** Retrieve the unit test name. */
39extern const std::function<std::string()> G_TEST_GET_FULL_NAME;
40
41inline constexpr CAmount CENT{1'000'000};
42
43/** Register common test args. Shared across binaries that rely on the test framework. */
44void SetupCommonTestArgs(ArgsManager& argsman);
45
46struct TestOpts {
47    std::vector<const char*> extra_args{};
48    bool coins_db_in_memory{true};
49    bool block_tree_db_in_memory{true};
50    bool setup_net{true};
51    bool setup_validation_interface{true};
52    bool min_validation_cache{false}; // Equivalent of -maxsigcachebytes=0
53};
54
55/** Basic testing setup.
56 * This just configures logging, data dir and chain parameters.
57 */
58struct BasicTestingSetup {
59    util::SignalInterrupt m_interrupt;
60    node::NodeContext m_node; // keep as first member to be destructed last
61
62    FastRandomContext m_rng;
63    /** Seed the global RNG state and m_rng for testing and log the seed value. This affects all randomness, except GetStrongRandBytes(). */
64    void SeedRandomForTest(SeedRand seed)
65    {
66        SeedRandomStateForTest(seed);
67        m_rng.Reseed(GetRandHash());
68    }
69
70    explicit BasicTestingSetup(ChainType chainType = ChainType::MAIN, TestOpts = {});
71    ~BasicTestingSetup();
72
73    fs::path m_path_root;
74    fs::path m_path_lock;
75    bool m_has_custom_datadir{false};
76    /** @brief Test-specific arguments and settings.
77     *
78     * This member is intended to be the primary source of settings for code
79     * being tested by unit tests. It exists to make tests more self-contained
80     * and reduce reliance on global state.
81     *
82     * Usage guidelines:
83     * 1. Prefer using m_args where possible in test code.
84     * 2. If m_args is not accessible, use m_node.args as a fallback.
85     * 3. Avoid direct references to gArgs in test code.
86     *
87     * Note: Currently, m_node.args points to gArgs for backwards
88     * compatibility. In the future, it will point to m_args to further isolate
89     * test environments.
90     *
91     * @see https://github.com/bitcoin/bitcoin/issues/25055 for additional context.
92     */
93    ArgsManager m_args;
94};
95
96/** Testing setup that performs all steps up until right before
97 * ChainstateManager gets initialized. Meant for testing ChainstateManager
98 * initialization behaviour.
99 */
100struct ChainTestingSetup : public BasicTestingSetup {
101    kernel::CacheSizes m_kernel_cache_sizes{node::CalculateCacheSizes(m_args).kernel};
102    bool m_coins_db_in_memory{true};
103    bool m_block_tree_db_in_memory{true};
104    std::function<void()> m_make_chainman{};
105
106    explicit ChainTestingSetup(ChainType chainType = ChainType::MAIN, TestOpts = {});
107    ~ChainTestingSetup();
108
109    // Supplies a chainstate, if one is needed
110    void LoadVerifyActivateChainstate();
111};
112
113/** Testing setup that configures a complete environment.
114 */
115struct TestingSetup : public ChainTestingSetup {
116    explicit TestingSetup(
117        ChainType chainType = ChainType::MAIN,
118        TestOpts = {});
119};
120
121/** Identical to TestingSetup, but chain set to regtest */
122struct RegTestingSetup : public TestingSetup {
123    RegTestingSetup()
124        : TestingSetup{ChainType::REGTEST} {}
125};
126
127/** Identical to TestingSetup, but chain set to testnet4 */
128struct Testnet4Setup : public TestingSetup {
129    Testnet4Setup()
130        : TestingSetup{ChainType::TESTNET4} {}
131};
132
133class CBlock;
134class CScript;
135
136/**
137 * Testing fixture that pre-creates a 100-block REGTEST-mode block chain
138 */
139struct TestChain100Setup : public TestingSetup {
140    TestChain100Setup(
141        ChainType chain_type = ChainType::REGTEST,
142        TestOpts = {});
143
144    /**
145     * Create a new block with just given transactions, coinbase paying to
146     * scriptPubKey, and try to add it to the current chain.
147     */
148    CBlock CreateAndProcessBlock(const std::vector<CMutableTransaction>& txns,
149                                 const CScript& scriptPubKey);
150
151    /**
152     * Create a new block with just given transactions, coinbase paying to
153     * scriptPubKey.
154     */
155    CBlock CreateBlock(
156        const std::vector<CMutableTransaction>& txns,
157        const CScript& scriptPubKey);
158
159    //! Mine a series of new blocks on the active chain.
160    void mineBlocks(int num_blocks);
161
162    /**
163    * Create a transaction, optionally setting the fee based on the feerate.
164    * Note: The feerate may not be met exactly depending on whether the signatures can have different sizes.
165    *
166    * @param input_transactions   The transactions to spend
167    * @param inputs               Outpoints with which to construct transaction vin.
168    * @param input_height         The height of the block that included the input transactions.
169    * @param input_signing_keys   The keys to spend the input transactions.
170    * @param outputs              Transaction vout.
171    * @param feerate              The feerate the transaction should pay.
172    * @param fee_output           The index of the output to take the fee from.
173    * @return The transaction and the fee it pays
174    */
175    std::pair<CMutableTransaction, CAmount> CreateValidTransaction(const std::vector<CTransactionRef>& input_transactions,
176                                                                   const std::vector<COutPoint>& inputs,
177                                                                   int input_height,
178                                                                   const std::vector<CKey>& input_signing_keys,
179                                                                   const std::vector<CTxOut>& outputs,
180                                                                   const std::optional<CFeeRate>& feerate,
181                                                                   const std::optional<uint32_t>& fee_output);
182    /**
183     * Create a transaction and, optionally, submit to the mempool.
184     *
185     * @param input_transactions   The transactions to spend
186     * @param inputs               Outpoints with which to construct transaction vin.
187     * @param input_height         The height of the block that included the input transaction(s).
188     * @param input_signing_keys   The keys to spend inputs.
189     * @param outputs              Transaction vout.
190     * @param submit               Whether or not to submit to mempool
191     */
192    CMutableTransaction CreateValidMempoolTransaction(const std::vector<CTransactionRef>& input_transactions,
193                                                      const std::vector<COutPoint>& inputs,
194                                                      int input_height,
195                                                      const std::vector<CKey>& input_signing_keys,
196                                                      const std::vector<CTxOut>& outputs,
197                                                      bool submit = true);
198
199    /**
200     * Create a 1-in-1-out transaction and, optionally, submit to the mempool.
201     *
202     * @param input_transaction  The transaction to spend
203     * @param input_vout         The vout to spend from the input_transaction
204     * @param input_height       The height of the block that included the input_transaction
205     * @param input_signing_key  The key to spend the input_transaction
206     * @param output_destination Where to send the output
207     * @param output_amount      How much to send
208     * @param submit             Whether or not to submit to mempool
209     */
210    CMutableTransaction CreateValidMempoolTransaction(CTransactionRef input_transaction,
211                                                      uint32_t input_vout,
212                                                      int input_height,
213                                                      CKey input_signing_key,
214                                                      CScript output_destination,
215                                                      CAmount output_amount = CAmount(1 * COIN),
216                                                      bool submit = true);
217
218    /** Create transactions spending from m_coinbase_txns. These transactions will only spend coins
219     * that exist in the current chain, but may be premature coinbase spends, have missing
220     * signatures, or violate some other consensus rules. They should only be used for testing
221     * mempool consistency. All transactions will have some random number of inputs and outputs
222     * (between 1 and 24). Transactions may or may not be dependent upon each other; if dependencies
223     * exit, every parent will always be somewhere in the list before the child so each transaction
224     * can be submitted in the same order they appear in the list.
225     * @param[in]   submit      When true, submit transactions to the mempool.
226     *                          When false, return them but don't submit them.
227     * @returns A vector of transactions that can be submitted to the mempool.
228     */
229    std::vector<CTransactionRef> PopulateMempool(FastRandomContext& det_rand, size_t num_transactions, bool submit);
230
231    FakeNodeClock m_clock{std::chrono::seconds{1598887952}}; // 2020-08-31, arbitrary
232    std::vector<CTransactionRef> m_coinbase_txns; // For convenience, coinbase transactions
233    CKey coinbaseKey; // private/public key needed to spend coinbase transactions
234};
235
236/**
237 * Make a test setup that has disk access to the debug.log file disabled. Can
238 * be used in "hot loops", for example fuzzing or benchmarking.
239 */
240template <class T = const BasicTestingSetup>
241std::unique_ptr<T> MakeNoLogFileContext(const ChainType chain_type = ChainType::REGTEST, TestOpts opts = {})
242{
243    opts.extra_args = Cat(
244        {
245            "-nodebuglogfile",
246            "-nodebug",
247        },
248        opts.extra_args);
249
250    return std::make_unique<T>(chain_type, opts);

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.