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.

32,916 bytes · SHA-256 6bf88d11f5b26cf7… · View upstream ↗

1// Copyright (c) 2020-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
6#include <txrequest.h>
7#include <uint256.h>
8
9#include <test/util/random.h>
10#include <test/util/setup_common.h>
11
12#include <algorithm>
13#include <functional>
14#include <vector>
15
16#include <boost/test/unit_test.hpp>
17
18namespace {
19
20class Scenario;
21
22struct TxRequestTest : BasicTestingSetup {
23    std::chrono::microseconds RandomTime8s();
24    std::chrono::microseconds RandomTime1y();
25    void BuildSingleTest(Scenario& scenario, int config);
26    void BuildPriorityTest(Scenario& scenario, int config);
27    void BuildBigPriorityTest(Scenario& scenario, int peers);
28    void BuildRequestOrderTest(Scenario& scenario, int config);
29    void BuildWtxidTest(Scenario& scenario, int config);
30    void BuildTimeBackwardsTest(Scenario& scenario);
31    void BuildWeirdRequestsTest(Scenario& scenario);
32    void TestInterleavedScenarios();
33};
34
35constexpr std::chrono::microseconds MIN_TIME = std::chrono::microseconds::min();
36constexpr std::chrono::microseconds MAX_TIME = std::chrono::microseconds::max();
37constexpr std::chrono::microseconds MICROSECOND = std::chrono::microseconds{1};
38constexpr std::chrono::microseconds NO_TIME = std::chrono::microseconds{0};
39
40/** An Action is a function to call at a particular (simulated) timestamp. */
41using Action = std::pair<std::chrono::microseconds, std::function<void()>>;
42
43/** Object that stores actions from multiple interleaved scenarios, and data shared across them.
44 *
45 * The Scenario below is used to fill this.
46 */
47struct Runner
48{
49    /** The TxRequestTracker being tested. */
50    TxRequestTracker txrequest;
51
52    /** List of actions to be executed (in order of increasing timestamp). */
53    std::vector<Action> actions;
54
55    /** Which node ids have been assigned already (to prevent reuse). */
56    std::set<NodeId> peerset;
57
58    /** Which txhashes have been assigned already (to prevent reuse). */
59    std::set<uint256> txhashset;
60
61    /** Which (peer, gtxid) combinations are known to be expired. These need to be accumulated here instead of
62     *  checked directly in the GetRequestable return value to avoid introducing a dependency between the various
63     *  parallel tests. */
64    std::multiset<std::pair<NodeId, GenTxid>> expired;
65};
66
67std::chrono::microseconds TxRequestTest::RandomTime8s() { return std::chrono::microseconds{1 + m_rng.randbits(23)}; }
68std::chrono::microseconds TxRequestTest::RandomTime1y() { return std::chrono::microseconds{1 + m_rng.randbits(45)}; }
69
70/** A proxy for a Runner that helps build a sequence of consecutive test actions on a TxRequestTracker.
71 *
72 * Each Scenario is a proxy through which actions for the (sequential) execution of various tests are added to a
73 * Runner. The actions from multiple scenarios are then run concurrently, resulting in these tests being performed
74 * against a TxRequestTracker in parallel. Every test has its own unique txhashes and NodeIds which are not
75 * reused in other tests, and thus they should be independent from each other. Running them in parallel however
76 * means that we verify the behavior (w.r.t. one test's txhashes and NodeIds) even when the state of the data
77 * structure is more complicated due to the presence of other tests.
78 */
79class Scenario
80{
81    FastRandomContext& m_rng;
82    Runner& m_runner;
83    std::chrono::microseconds m_now;
84    std::string m_testname;
85
86public:
87    Scenario(FastRandomContext& rng, Runner& runner, std::chrono::microseconds starttime) : m_rng(rng), m_runner(runner), m_now(starttime) {}
88
89    /** Set a name for the current test, to give more clear error messages. */
90    void SetTestName(std::string testname)
91    {
92        m_testname = std::move(testname);
93    }
94
95    /** Advance this Scenario's time; this affects the timestamps newly scheduled events get. */
96    void AdvanceTime(std::chrono::microseconds amount)
97    {
98        assert(amount.count() >= 0);
99        m_now += amount;
100    }
101
102    /** Schedule a ForgetTxHash call at the Scheduler's current time. */
103    void ForgetTxHash(const uint256& txhash)
104    {
105        auto& runner = m_runner;
106        runner.actions.emplace_back(m_now, [=, &runner]() {
107            runner.txrequest.ForgetTxHash(txhash);
108            runner.txrequest.SanityCheck();
109        });
110    }
111
112    /** Schedule a ReceivedInv call at the Scheduler's current time. */
113    void ReceivedInv(NodeId peer, const GenTxid& gtxid, bool pref, std::chrono::microseconds reqtime)
114    {
115        auto& runner = m_runner;
116        runner.actions.emplace_back(m_now, [=, &runner]() {
117            runner.txrequest.ReceivedInv(peer, gtxid, pref, reqtime);
118            runner.txrequest.SanityCheck();
119        });
120    }
121
122    /** Schedule a DisconnectedPeer call at the Scheduler's current time. */
123    void DisconnectedPeer(NodeId peer)
124    {
125        auto& runner = m_runner;
126        runner.actions.emplace_back(m_now, [=, &runner]() {
127            runner.txrequest.DisconnectedPeer(peer);
128            runner.txrequest.SanityCheck();
129        });
130    }
131
132    /** Schedule a RequestedTx call at the Scheduler's current time. */
133    void RequestedTx(NodeId peer, const uint256& txhash, std::chrono::microseconds exptime)
134    {
135        auto& runner = m_runner;
136        runner.actions.emplace_back(m_now, [=, &runner]() {
137            runner.txrequest.RequestedTx(peer, txhash, exptime);
138            runner.txrequest.SanityCheck();
139        });
140    }
141
142    /** Schedule a ReceivedResponse call at the Scheduler's current time. */
143    void ReceivedResponse(NodeId peer, const uint256& txhash)
144    {
145        auto& runner = m_runner;
146        runner.actions.emplace_back(m_now, [=, &runner]() {
147            runner.txrequest.ReceivedResponse(peer, txhash);
148            runner.txrequest.SanityCheck();
149        });
150    }
151
152    /** Schedule calls to verify the TxRequestTracker's state at the Scheduler's current time.
153     *
154     * @param peer       The peer whose state will be inspected.
155     * @param expected   The expected return value for GetRequestable(peer)
156     * @param candidates The expected return value CountCandidates(peer)
157     * @param inflight   The expected return value CountInFlight(peer)
158     * @param completed  The expected return value of Count(peer), minus candidates and inflight.
159     * @param checkname  An arbitrary string to include in error messages, for test identificatrion.
160     * @param offset     Offset with the current time to use (must be <= 0). This allows simulations of time going
161     *                   backwards (but note that the ordering of this event only follows the scenario's m_now.
162     */
163    void Check(NodeId peer, const std::vector<GenTxid>& expected, size_t candidates, size_t inflight,
164               size_t completed, const std::string& checkname,
165               std::chrono::microseconds offset = std::chrono::microseconds{0})
166    {
167        const auto comment = m_testname + " " + checkname;
168        auto& runner = m_runner;
169        const auto now = m_now;
170        assert(offset.count() <= 0);
171        runner.actions.emplace_back(m_now, [=, &runner]() {
172            std::vector<std::pair<NodeId, GenTxid>> expired_now;
173            auto ret = runner.txrequest.GetRequestable(peer, now + offset, &expired_now);
174            for (const auto& entry : expired_now) {
175                runner.expired.insert(entry);
176            }
177            runner.txrequest.SanityCheck();
178            runner.txrequest.PostGetRequestableSanityCheck(now + offset);
179            size_t total = candidates + inflight + completed;
180            size_t real_total = runner.txrequest.Count(peer);
181            size_t real_candidates = runner.txrequest.CountCandidates(peer);
182            size_t real_inflight = runner.txrequest.CountInFlight(peer);
183            BOOST_CHECK_MESSAGE(real_total == total, strprintf("[%s] total %i (%i expected)", comment, real_total, total));
184            BOOST_CHECK_MESSAGE(real_inflight == inflight, strprintf("[%s] inflight %i (%i expected)", comment, real_inflight, inflight));
185            BOOST_CHECK_MESSAGE(real_candidates == candidates, strprintf("[%s] candidates %i (%i expected)", comment, real_candidates, candidates));
186            BOOST_CHECK_MESSAGE(ret == expected, strprintf("[%s] mismatching requestables", comment));
187        });
188    }
189
190    /** Verify that an announcement for gtxid by peer has expired some time before this check is scheduled.
191     *
192     * Every expected expiration should be accounted for through exactly one call to this function.
193     */
194    void CheckExpired(NodeId peer, GenTxid gtxid)
195    {
196        const auto& testname = m_testname;
197        auto& runner = m_runner;
198        runner.actions.emplace_back(m_now, [=, &runner]() {
199            auto it = runner.expired.find(std::pair<NodeId, GenTxid>{peer, gtxid});
200            BOOST_CHECK_MESSAGE(it != runner.expired.end(), "[" + testname + "] missing expiration");
201            if (it != runner.expired.end()) runner.expired.erase(it);
202        });
203    }
204
205    /** Generate a random txhash, whose priorities for certain peers are constrained.
206     *
207     * For example, NewTxHash({{p1,p2,p3},{p2,p4,p5}}) will generate a txhash T such that both:
208     *  - priority(p1,T) > priority(p2,T) > priority(p3,T)
209     *  - priority(p2,T) > priority(p4,T) > priority(p5,T)
210     * where priority is the predicted internal TxRequestTracker's priority, assuming all announcements
211     * are within the same preferredness class.
212     */
213    uint256 NewTxHash(const std::vector<std::vector<NodeId>>& orders = {})
214    {
215        uint256 ret;
216        bool ok;
217        do {
218            ret = m_rng.rand256();
219            ok = true;
220            for (const auto& order : orders) {
221                for (size_t pos = 1; pos < order.size(); ++pos) {
222                    uint64_t prio_prev = m_runner.txrequest.ComputePriority(ret, order[pos - 1], true);
223                    uint64_t prio_cur = m_runner.txrequest.ComputePriority(ret, order[pos], true);
224                    if (prio_prev <= prio_cur) {
225                        ok = false;
226                        break;
227                    }
228                }
229                if (!ok) break;
230            }
231            if (ok) {
232                ok = m_runner.txhashset.insert(ret).second;
233            }
234        } while(!ok);
235        return ret;
236    }
237
238    /** Generate a random GenTxid; the txhash follows NewTxHash; the transaction identifier is random. */
239    GenTxid NewGTxid(const std::vector<std::vector<NodeId>>& orders = {})
240    {
241        const uint256 txhash{NewTxHash(orders)};
242        return m_rng.randbool() ? GenTxid{Wtxid::FromUint256(txhash)} : GenTxid{Txid::FromUint256(txhash)};
243    }
244
245    /** Generate a new random NodeId to use as peer. The same NodeId is never returned twice
246     *  (across all Scenarios combined). */
247    NodeId NewPeer()
248    {
249        bool ok;
250        NodeId ret;

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.