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.

15,548 bytes · SHA-256 b33fa73aee1dce43… · 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#include <crypto/common.h>
6#include <crypto/sha256.h>
7#include <crypto/siphash.h>
8#include <primitives/transaction.h>
9#include <test/fuzz/fuzz.h>
10#include <txrequest.h>
11
12#include <bitset>
13#include <cstdint>
14#include <queue>
15#include <vector>
16
17namespace {
18
19constexpr int MAX_TXHASHES = 16;
20constexpr int MAX_PEERS = 16;
21
22//! Randomly generated txhashes used in this test (length is MAX_TXHASHES).
23uint256 TXHASHES[MAX_TXHASHES];
24
25//! Precomputed random durations (positive and negative, each ~exponentially distributed).
26std::chrono::microseconds DELAYS[256];
27
28struct Initializer
29{
30    Initializer()
31    {
32        for (uint8_t txhash = 0; txhash < MAX_TXHASHES; txhash += 1) {
33            CSHA256().Write(&txhash, 1).Finalize(TXHASHES[txhash].begin());
34        }
35        int i = 0;
36        // DELAYS[N] for N=0..15 is just N microseconds.
37        for (; i < 16; ++i) {
38            DELAYS[i] = std::chrono::microseconds{i};
39        }
40        // DELAYS[N] for N=16..127 has randomly-looking but roughly exponentially increasing values up to
41        // 198.416453 seconds.
42        for (; i < 128; ++i) {
43            int diff_bits = ((i - 10) * 2) / 9;
44            uint64_t diff = 1 + (CSipHasher(0, 0).Write(i).Finalize() >> (64 - diff_bits));
45            DELAYS[i] = DELAYS[i - 1] + std::chrono::microseconds{diff};
46        }
47        // DELAYS[N] for N=128..255 are negative delays with the same magnitude as N=0..127.
48        for (; i < 256; ++i) {
49            DELAYS[i] = -DELAYS[255 - i];
50        }
51    }
52} g_initializer;
53
54/** Tester class for TxRequestTracker
55 *
56 * It includes a naive reimplementation of its behavior, for a limited set
57 * of MAX_TXHASHES distinct txids, and MAX_PEERS peer identifiers.
58 *
59 * All of the public member functions perform the same operation on
60 * an actual TxRequestTracker and on the state of the reimplementation.
61 * The output of GetRequestable is compared with the expected value
62 * as well.
63 *
64 * Check() calls the TxRequestTracker's sanity check, plus compares the
65 * output of the constant accessors (Size(), CountLoad(), CountTracked())
66 * with expected values.
67 */
68class Tester
69{
70    //! TxRequestTracker object being tested.
71    TxRequestTracker m_tracker;
72
73    //! States for txid/peer combinations in the naive data structure.
74    enum class State {
75        NOTHING, //!< Absence of this txid/peer combination
76
77        // Note that this implementation does not distinguish between DELAYED/READY/BEST variants of CANDIDATE.
78        CANDIDATE,
79        REQUESTED,
80        COMPLETED,
81    };
82
83    //! Sequence numbers, incremented whenever a new CANDIDATE is added.
84    uint64_t m_current_sequence{0};
85
86    //! List of future 'events' (all inserted reqtimes/exptimes). This is used to implement AdvanceToEvent.
87    std::priority_queue<std::chrono::microseconds, std::vector<std::chrono::microseconds>,
88        std::greater<std::chrono::microseconds>> m_events;
89
90    //! Information about a txhash/peer combination.
91    struct Announcement
92    {
93        std::chrono::microseconds m_time;
94        uint64_t m_sequence;
95        State m_state{State::NOTHING};
96        bool m_preferred;
97        bool m_is_wtxid;
98        uint64_t m_priority; //!< Precomputed priority.
99    };
100
101    //! Information about all txhash/peer combination.
102    Announcement m_announcements[MAX_TXHASHES][MAX_PEERS];
103
104    //! The current time; can move forward and backward.
105    std::chrono::microseconds m_now{244466666};
106
107    //! Delete txhashes whose only announcements are COMPLETED.
108    void Cleanup(int txhash)
109    {
110        bool all_nothing = true;
111        for (int peer = 0; peer < MAX_PEERS; ++peer) {
112            const Announcement& ann = m_announcements[txhash][peer];
113            if (ann.m_state != State::NOTHING) {
114                if (ann.m_state != State::COMPLETED) return;
115                all_nothing = false;
116            }
117        }
118        if (all_nothing) return;
119        for (int peer = 0; peer < MAX_PEERS; ++peer) {
120            m_announcements[txhash][peer].m_state = State::NOTHING;
121        }
122    }
123
124    //! Find the current best peer to request from for a txhash (or -1 if none).
125    int GetSelected(int txhash) const
126    {
127        int ret = -1;
128        uint64_t ret_priority = 0;
129        for (int peer = 0; peer < MAX_PEERS; ++peer) {
130            const Announcement& ann = m_announcements[txhash][peer];
131            // Return -1 if there already is a (non-expired) in-flight request.
132            if (ann.m_state == State::REQUESTED) return -1;
133            // If it's a viable candidate, see if it has lower priority than the best one so far.
134            if (ann.m_state == State::CANDIDATE && ann.m_time <= m_now) {
135                if (ret == -1 || ann.m_priority > ret_priority) {
136                    std::tie(ret, ret_priority) = std::tie(peer, ann.m_priority);
137                }
138            }
139        }
140        return ret;
141    }
142
143public:
144    Tester() : m_tracker(true) {}
145
146    std::chrono::microseconds Now() const { return m_now; }
147
148    void AdvanceTime(std::chrono::microseconds offset)
149    {
150        m_now += offset;
151        while (!m_events.empty() && m_events.top() <= m_now) m_events.pop();
152    }
153
154    void AdvanceToEvent()
155    {
156        while (!m_events.empty() && m_events.top() <= m_now) m_events.pop();
157        if (!m_events.empty()) {
158            m_now = m_events.top();
159            m_events.pop();
160        }
161    }
162
163    void DisconnectedPeer(int peer)
164    {
165        // Apply to naive structure: all announcements for that peer are wiped.
166        for (int txhash = 0; txhash < MAX_TXHASHES; ++txhash) {
167            if (m_announcements[txhash][peer].m_state != State::NOTHING) {
168                m_announcements[txhash][peer].m_state = State::NOTHING;
169                Cleanup(txhash);
170            }
171        }
172
173        // Call TxRequestTracker's implementation.
174        m_tracker.DisconnectedPeer(peer);
175    }
176
177    void ForgetTxHash(int txhash)
178    {
179        // Apply to naive structure: all announcements for that txhash are wiped.
180        for (int peer = 0; peer < MAX_PEERS; ++peer) {
181            m_announcements[txhash][peer].m_state = State::NOTHING;
182        }
183        Cleanup(txhash);
184
185        // Call TxRequestTracker's implementation.
186        m_tracker.ForgetTxHash(TXHASHES[txhash]);
187    }
188
189    void ReceivedInv(int peer, int txhash, bool is_wtxid, bool preferred, std::chrono::microseconds reqtime)
190    {
191        // Apply to naive structure: if no announcement for txidnum/peer combination
192        // already, create a new CANDIDATE; otherwise do nothing.
193        Announcement& ann = m_announcements[txhash][peer];
194        if (ann.m_state == State::NOTHING) {
195            ann.m_preferred = preferred;
196            ann.m_state = State::CANDIDATE;
197            ann.m_time = reqtime;
198            ann.m_is_wtxid = is_wtxid;
199            ann.m_sequence = m_current_sequence++;
200            ann.m_priority = m_tracker.ComputePriority(TXHASHES[txhash], peer, ann.m_preferred);
201
202            // Add event so that AdvanceToEvent can quickly jump to the point where its reqtime passes.
203            if (reqtime > m_now) m_events.push(reqtime);
204        }
205
206        // Call TxRequestTracker's implementation.
207        auto gtxid = is_wtxid ? GenTxid{Wtxid::FromUint256(TXHASHES[txhash])} : GenTxid{Txid::FromUint256(TXHASHES[txhash])};
208        m_tracker.ReceivedInv(peer, gtxid, preferred, reqtime);
209    }
210
211    void RequestedTx(int peer, int txhash, std::chrono::microseconds exptime)
212    {
213        // Apply to naive structure: if a CANDIDATE announcement exists for peer/txhash,
214        // convert it to REQUESTED, and change any existing REQUESTED announcement for the same txhash to COMPLETED.
215        if (m_announcements[txhash][peer].m_state == State::CANDIDATE) {
216            for (int peer2 = 0; peer2 < MAX_PEERS; ++peer2) {
217                if (m_announcements[txhash][peer2].m_state == State::REQUESTED) {
218                    m_announcements[txhash][peer2].m_state = State::COMPLETED;
219                }
220            }
221            m_announcements[txhash][peer].m_state = State::REQUESTED;
222            m_announcements[txhash][peer].m_time = exptime;
223        }
224
225        // Add event so that AdvanceToEvent can quickly jump to the point where its exptime passes.
226        if (exptime > m_now) m_events.push(exptime);
227
228        // Call TxRequestTracker's implementation.
229        m_tracker.RequestedTx(peer, TXHASHES[txhash], exptime);
230    }
231
232    void ReceivedResponse(int peer, int txhash)
233    {
234        // Apply to naive structure: convert anything to COMPLETED.
235        if (m_announcements[txhash][peer].m_state != State::NOTHING) {
236            m_announcements[txhash][peer].m_state = State::COMPLETED;
237            Cleanup(txhash);
238        }
239
240        // Call TxRequestTracker's implementation.
241        m_tracker.ReceivedResponse(peer, TXHASHES[txhash]);
242    }
243
244    void GetRequestable(int peer)
245    {
246        // Implement using naive structure:
247
248        //! list of (sequence number, txhash, is_wtxid) tuples.
249        std::vector<std::tuple<uint64_t, int, bool>> result;
250        std::vector<std::pair<NodeId, GenTxid>> expected_expired;

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.