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.

40,170 bytes · SHA-256 8ae72da7c960fb94… · 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 <arith_uint256.h>
6#include <consensus/validation.h>
7#include <node/txorphanage.h>
8#include <policy/policy.h>
9#include <primitives/transaction.h>
10#include <pubkey.h>
11#include <script/sign.h>
12#include <script/signingprovider.h>
13#include <test/util/common.h>
14#include <test/util/random.h>
15#include <test/util/setup_common.h>
16#include <test/util/time.h>
17#include <test/util/transaction_utils.h>
18
19#include <array>
20#include <cstdint>
21
22#include <boost/test/unit_test.hpp>
23
24BOOST_FIXTURE_TEST_SUITE(orphanage_tests, BasicTestingSetup)
25
26static void MakeNewKeyWithFastRandomContext(CKey& key, FastRandomContext& rand_ctx)
27{
28    std::vector<unsigned char> keydata;
29    keydata = rand_ctx.randbytes(32);
30    key.Set(keydata.data(), keydata.data() + keydata.size(), /*fCompressedIn=*/true);
31    assert(key.IsValid());
32}
33
34// Creates a transaction with 2 outputs. Spends all outpoints. If outpoints is empty, spends a random one.
35static CTransactionRef MakeTransactionSpending(const std::vector<COutPoint>& outpoints, FastRandomContext& det_rand)
36{
37    CKey key;
38    MakeNewKeyWithFastRandomContext(key, det_rand);
39    CMutableTransaction tx;
40    // If no outpoints are given, create a random one.
41    if (outpoints.empty()) {
42        tx.vin.emplace_back(Txid::FromUint256(det_rand.rand256()), 0);
43    } else {
44        for (const auto& outpoint : outpoints) {
45            tx.vin.emplace_back(outpoint);
46        }
47    }
48    // Ensure txid != wtxid
49    tx.vin[0].scriptWitness.stack.push_back({1});
50    tx.vout.resize(2);
51    tx.vout[0].nValue = CENT;
52    tx.vout[0].scriptPubKey = GetScriptForDestination(PKHash(key.GetPubKey()));
53    tx.vout[1].nValue = 3 * CENT;
54    tx.vout[1].scriptPubKey = GetScriptForDestination(WitnessV0KeyHash(key.GetPubKey()));
55    return MakeTransactionRef(tx);
56}
57
58// Make another (not necessarily valid) tx with the same txid but different wtxid.
59static CTransactionRef MakeMutation(const CTransactionRef& ptx)
60{
61    CMutableTransaction tx(*ptx);
62    tx.vin[0].scriptWitness.stack.push_back({5});
63    auto mutated_tx = MakeTransactionRef(tx);
64    assert(ptx->GetHash() == mutated_tx->GetHash());
65    return mutated_tx;
66}
67
68static bool EqualTxns(const std::set<CTransactionRef>& set_txns, const std::vector<CTransactionRef>& vec_txns)
69{
70    if (vec_txns.size() != set_txns.size()) return false;
71    for (const auto& tx : vec_txns) {
72        if (!set_txns.contains(tx)) return false;
73    }
74    return true;
75}
76
77BOOST_AUTO_TEST_CASE(peer_dos_limits)
78{
79    FastRandomContext det_rand{true};
80
81    // Construct transactions to use. They must all be the same size.
82    static constexpr unsigned int NUM_TXNS_CREATED = 100;
83    static constexpr int64_t TX_SIZE{469};
84    static constexpr int64_t TOTAL_SIZE = NUM_TXNS_CREATED * TX_SIZE;
85
86    std::vector<CTransactionRef> txns;
87    txns.reserve(NUM_TXNS_CREATED);
88    // All transactions are the same size.
89    for (unsigned int i{0}; i < NUM_TXNS_CREATED; ++i) {
90        auto ptx = MakeTransactionSpending({}, det_rand);
91        txns.emplace_back(ptx);
92        BOOST_CHECK_EQUAL(TX_SIZE, GetTransactionWeight(*ptx));
93    }
94
95    // Single peer: eviction is triggered if either limit is hit
96    {
97        // Test announcement limits
98        NodeId peer{8};
99        auto orphanage_low_ann = node::MakeTxOrphanage(/*max_global_latency_score=*/1, /*reserved_peer_usage=*/TX_SIZE * 10);
100        auto orphanage_low_mem = node::MakeTxOrphanage(/*max_global_latency_score=*/10, /*reserved_peer_usage=*/TX_SIZE);
101
102        // Add the first transaction
103        orphanage_low_ann->AddTx(txns.at(0), peer);
104        orphanage_low_mem->AddTx(txns.at(0), peer);
105
106        // Add more. One of the limits is exceeded, so LimitOrphans evicts 1.
107        orphanage_low_ann->AddTx(txns.at(1), peer);
108        orphanage_low_mem->AddTx(txns.at(1), peer);
109
110        // The older transaction is evicted.
111        BOOST_CHECK(!orphanage_low_ann->HaveTx(txns.at(0)->GetWitnessHash()));
112        BOOST_CHECK(!orphanage_low_mem->HaveTx(txns.at(0)->GetWitnessHash()));
113        BOOST_CHECK(orphanage_low_ann->HaveTx(txns.at(1)->GetWitnessHash()));
114        BOOST_CHECK(orphanage_low_mem->HaveTx(txns.at(1)->GetWitnessHash()));
115
116        orphanage_low_ann->SanityCheck();
117        orphanage_low_mem->SanityCheck();
118    }
119
120    // Single peer: latency score includes inputs
121    {
122        // Test latency score limits
123        NodeId peer{10};
124        auto orphanage_low_ann = node::MakeTxOrphanage(/*max_global_latency_score=*/5, /*reserved_peer_usage=*/TX_SIZE * 1000);
125
126        // Add the first transaction
127        orphanage_low_ann->AddTx(txns.at(0), peer);
128
129        // Add 1 more transaction with 45 inputs. Even though there are only 2 announcements, this pushes the orphanage above its maximum latency score.
130        std::vector<COutPoint> outpoints_45;
131        for (unsigned int j{0}; j < 45; ++j) {
132            outpoints_45.emplace_back(Txid::FromUint256(det_rand.rand256()), j);
133        }
134        auto ptx = MakeTransactionSpending(outpoints_45, det_rand);
135        orphanage_low_ann->AddTx(ptx, peer);
136
137        // The older transaction is evicted.
138        BOOST_CHECK(!orphanage_low_ann->HaveTx(txns.at(0)->GetWitnessHash()));
139        BOOST_CHECK(orphanage_low_ann->HaveTx(ptx->GetWitnessHash()));
140
141        orphanage_low_ann->SanityCheck();
142    }
143
144    // Single peer: eviction order is FIFO on non-reconsiderable, then reconsiderable orphans.
145    {
146        // Construct parent + child pairs
147        std::vector<CTransactionRef> parents;
148        std::vector<CTransactionRef> children;
149        for (unsigned int i{0}; i < 10; ++i) {
150            CTransactionRef parent = MakeTransactionSpending({}, det_rand);
151            CTransactionRef child = MakeTransactionSpending({{parent->GetHash(), 0}}, det_rand);
152            parents.emplace_back(parent);
153            children.emplace_back(child);
154        }
155
156        // Test announcement limits
157        NodeId peer{9};
158        auto orphanage = node::MakeTxOrphanage(/*max_global_latency_score=*/3, /*reserved_peer_usage=*/TX_SIZE * 10);
159
160        // First add a tx which will be made reconsiderable.
161        orphanage->AddTx(children.at(0), peer);
162
163        // Then add 2 more orphans... not oversize yet.
164        orphanage->AddTx(children.at(1), peer);
165        orphanage->AddTx(children.at(2), peer);
166
167        // Make child0 ready to reconsider
168        const std::vector<std::pair<Wtxid, NodeId>> expected_set_c0{std::make_pair(children.at(0)->GetWitnessHash(), peer)};
169        BOOST_CHECK(orphanage->AddChildrenToWorkSet(*parents.at(0), det_rand) == expected_set_c0);
170        BOOST_CHECK(orphanage->HaveTxToReconsider(peer));
171
172        // Add 1 more orphan, causing the orphanage to be oversize. child1 is evicted.
173        orphanage->AddTx(children.at(3), peer);
174        BOOST_CHECK(orphanage->HaveTx(children.at(0)->GetWitnessHash()));
175        BOOST_CHECK(!orphanage->HaveTx(children.at(1)->GetWitnessHash()));
176        BOOST_CHECK(orphanage->HaveTx(children.at(2)->GetWitnessHash()));
177        BOOST_CHECK(orphanage->HaveTx(children.at(3)->GetWitnessHash()));
178        orphanage->SanityCheck();
179
180        // Add 1 more... child2 is evicted.
181        orphanage->AddTx(children.at(4), peer);
182        BOOST_CHECK(orphanage->HaveTx(children.at(0)->GetWitnessHash()));
183        BOOST_CHECK(!orphanage->HaveTx(children.at(2)->GetWitnessHash()));
184        BOOST_CHECK(orphanage->HaveTx(children.at(3)->GetWitnessHash()));
185        BOOST_CHECK(orphanage->HaveTx(children.at(4)->GetWitnessHash()));
186
187        // Eviction order is FIFO within the orphans that are read
188        const std::vector<std::pair<Wtxid, NodeId>> expected_set_c4{std::make_pair(children.at(4)->GetWitnessHash(), peer)};
189        BOOST_CHECK(orphanage->AddChildrenToWorkSet(*parents.at(4), det_rand) == expected_set_c4);
190        const std::vector<std::pair<Wtxid, NodeId>> expected_set_c3{std::make_pair(children.at(3)->GetWitnessHash(), peer)};
191        BOOST_CHECK(orphanage->AddChildrenToWorkSet(*parents.at(3), det_rand) == expected_set_c3);
192
193        // child5 is evicted immediately because it is the only non-reconsiderable orphan.
194        orphanage->AddTx(children.at(5), peer);
195        BOOST_CHECK(orphanage->HaveTx(children.at(0)->GetWitnessHash()));
196        BOOST_CHECK(orphanage->HaveTx(children.at(3)->GetWitnessHash()));
197        BOOST_CHECK(orphanage->HaveTx(children.at(4)->GetWitnessHash()));
198        BOOST_CHECK(!orphanage->HaveTx(children.at(5)->GetWitnessHash()));
199
200        // Transactions are marked non-reconsiderable again when returned through GetTxToReconsider
201        BOOST_CHECK_EQUAL(orphanage->GetTxToReconsider(peer), children.at(0));
202        orphanage->AddTx(children.at(6), peer);
203        BOOST_CHECK(!orphanage->HaveTx(children.at(0)->GetWitnessHash()));
204        BOOST_CHECK(orphanage->HaveTx(children.at(3)->GetWitnessHash()));
205        BOOST_CHECK(orphanage->HaveTx(children.at(4)->GetWitnessHash()));
206        BOOST_CHECK(orphanage->HaveTx(children.at(6)->GetWitnessHash()));
207
208        // The first transaction returned from GetTxToReconsider is the older one, not the one that was marked for
209        // reconsideration earlier.
210        BOOST_CHECK_EQUAL(orphanage->GetTxToReconsider(peer), children.at(3));
211        BOOST_CHECK_EQUAL(orphanage->GetTxToReconsider(peer), children.at(4));
212
213        orphanage->SanityCheck();
214    }
215
216    // Multiple peers: when limit is exceeded, we choose the DoSiest peer and evict their oldest transaction.
217    {
218        NodeId peer_dosy{0};
219        NodeId peer1{1};
220        NodeId peer2{2};
221
222        unsigned int max_announcements = 60;
223        // Set a high per-peer reservation so announcement limit is always hit first.
224        auto orphanage = node::MakeTxOrphanage(max_announcements, TOTAL_SIZE * 10);
225
226        // No evictions happen before the global limit is reached.
227        for (unsigned int i{0}; i < max_announcements; ++i) {
228            orphanage->AddTx(txns.at(i), peer_dosy);
229        }
230        orphanage->SanityCheck();
231        BOOST_CHECK_EQUAL(orphanage->AnnouncementsFromPeer(peer_dosy), max_announcements);
232        BOOST_CHECK_EQUAL(orphanage->AnnouncementsFromPeer(peer1), 0);
233        BOOST_CHECK_EQUAL(orphanage->AnnouncementsFromPeer(peer2), 0);
234
235        // Add 10 unique transactions from peer1.
236        // LimitOrphans should evict from peer_dosy, because that's the one exceeding announcement limits.
237        unsigned int num_from_peer1 = 10;
238        for (unsigned int i{0}; i < num_from_peer1; ++i) {
239            orphanage->AddTx(txns.at(max_announcements + i), peer1);
240            // The announcement limit per peer has halved, but LimitOrphans does not evict beyond what is necessary to
241            // bring the total announcements within its global limit.
242            BOOST_CHECK(orphanage->AnnouncementsFromPeer(peer_dosy) > orphanage->MaxPeerLatencyScore());
243
244            BOOST_CHECK_EQUAL(orphanage->AnnouncementsFromPeer(peer1), i + 1);
245            BOOST_CHECK_EQUAL(orphanage->AnnouncementsFromPeer(peer_dosy), max_announcements - i - 1);
246
247            // Evictions are FIFO within a peer, so the ith transaction sent by peer_dosy is the one that was evicted.
248            BOOST_CHECK(!orphanage->HaveTx(txns.at(i)->GetWitnessHash()));
249        }
250        // Add 10 transactions that are duplicates of the ones sent by peer_dosy. We need to add 10 because the first 10

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.