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.

30,508 bytes · SHA-256 02c8421823aa4313… · View upstream ↗

1// Copyright (c) 2021-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 <netaddress.h>
6#include <net.h>
7#include <test/util/net.h>
8#include <test/util/setup_common.h>
9
10#include <boost/test/unit_test.hpp>
11
12#include <algorithm>
13#include <functional>
14#include <optional>
15#include <unordered_set>
16#include <vector>
17
18BOOST_FIXTURE_TEST_SUITE(net_peer_eviction_tests, BasicTestingSetup)
19
20// Create `num_peers` random nodes, apply setup function `candidate_setup_fn`,
21// call ProtectEvictionCandidatesByRatio() to apply protection logic, and then
22// return true if all of `protected_peer_ids` and none of `unprotected_peer_ids`
23// are protected from eviction, i.e. removed from the eviction candidates.
24bool IsProtected(int num_peers,
25                 std::function<void(NodeEvictionCandidate&)> candidate_setup_fn,
26                 const std::unordered_set<NodeId>& protected_peer_ids,
27                 const std::unordered_set<NodeId>& unprotected_peer_ids,
28                 FastRandomContext& random_context)
29{
30    std::vector<NodeEvictionCandidate> candidates{GetRandomNodeEvictionCandidates(num_peers, random_context)};
31    for (NodeEvictionCandidate& candidate : candidates) {
32        candidate_setup_fn(candidate);
33    }
34    std::shuffle(candidates.begin(), candidates.end(), random_context);
35
36    const size_t size{candidates.size()};
37    const size_t expected{size - size / 2}; // Expect half the candidates will be protected.
38    ProtectEvictionCandidatesByRatio(candidates);
39    BOOST_CHECK_EQUAL(candidates.size(), expected);
40
41    size_t unprotected_count{0};
42    for (const NodeEvictionCandidate& candidate : candidates) {
43        if (protected_peer_ids.contains(candidate.id)) {
44            // this peer should have been removed from the eviction candidates
45            BOOST_TEST_MESSAGE(strprintf("expected candidate to be protected: %d", candidate.id));
46            return false;
47        }
48        if (unprotected_peer_ids.contains(candidate.id)) {
49            // this peer remains in the eviction candidates, as expected
50            ++unprotected_count;
51        }
52    }
53
54    const bool is_protected{unprotected_count == unprotected_peer_ids.size()};
55    if (!is_protected) {
56        BOOST_TEST_MESSAGE(strprintf("unprotected: expected %d, actual %d",
57                                     unprotected_peer_ids.size(), unprotected_count));
58    }
59    return is_protected;
60}
61
62BOOST_AUTO_TEST_CASE(peer_protection_test)
63{
64    FastRandomContext random_context{true};
65    int num_peers{12};
66
67    // Expect half of the peers with greatest uptime (the lowest m_connected)
68    // to be protected from eviction.
69    BOOST_CHECK(IsProtected(
70        num_peers, [](NodeEvictionCandidate& c) {
71            c.m_connected = NodeSeconds{std::chrono::seconds{c.id}};
72            c.m_is_local = false;
73            c.m_network = NET_IPV4;
74        },
75        /*protected_peer_ids=*/{0, 1, 2, 3, 4, 5},
76        /*unprotected_peer_ids=*/{6, 7, 8, 9, 10, 11},
77        random_context));
78
79    // Verify in the opposite direction.
80    BOOST_CHECK(IsProtected(
81        num_peers, [num_peers](NodeEvictionCandidate& c) {
82            c.m_connected = NodeSeconds{std::chrono::seconds{num_peers - c.id}};
83            c.m_is_local = false;
84            c.m_network = NET_IPV6;
85        },
86        /*protected_peer_ids=*/{6, 7, 8, 9, 10, 11},
87        /*unprotected_peer_ids=*/{0, 1, 2, 3, 4, 5},
88        random_context));
89
90    // Test protection of onion, localhost, and I2P peers...
91
92    // Expect 1/4 onion peers to be protected from eviction,
93    // if no localhost, I2P, or CJDNS peers.
94    BOOST_CHECK(IsProtected(
95        num_peers, [](NodeEvictionCandidate& c) {
96            c.m_is_local = false;
97            c.m_network = (c.id == 3 || c.id == 8 || c.id == 9) ? NET_ONION : NET_IPV4;
98        },
99        /*protected_peer_ids=*/{3, 8, 9},
100        /*unprotected_peer_ids=*/{},
101        random_context));
102
103    // Expect 1/4 onion peers and 1/4 of the other peers to be protected,
104    // sorted by longest uptime (lowest m_connected), if no localhost, I2P or CJDNS peers.
105    BOOST_CHECK(IsProtected(
106        num_peers, [](NodeEvictionCandidate& c) {
107            c.m_connected = NodeSeconds{std::chrono::seconds{c.id}};
108            c.m_is_local = false;
109            c.m_network = (c.id == 3 || c.id > 7) ? NET_ONION : NET_IPV6;
110        },
111        /*protected_peer_ids=*/{0, 1, 2, 3, 8, 9},
112        /*unprotected_peer_ids=*/{4, 5, 6, 7, 10, 11},
113        random_context));
114
115    // Expect 1/4 localhost peers to be protected from eviction,
116    // if no onion, I2P, or CJDNS peers.
117    BOOST_CHECK(IsProtected(
118        num_peers, [](NodeEvictionCandidate& c) {
119            c.m_is_local = (c.id == 1 || c.id == 9 || c.id == 11);
120            c.m_network = NET_IPV4;
121        },
122        /*protected_peer_ids=*/{1, 9, 11},
123        /*unprotected_peer_ids=*/{},
124        random_context));
125
126    // Expect 1/4 localhost peers and 1/4 of the other peers to be protected,
127    // sorted by longest uptime (lowest m_connected), if no onion, I2P, or CJDNS peers.
128    BOOST_CHECK(IsProtected(
129        num_peers, [](NodeEvictionCandidate& c) {
130            c.m_connected = NodeSeconds{std::chrono::seconds{c.id}};
131            c.m_is_local = (c.id > 6);
132            c.m_network = NET_IPV6;
133        },
134        /*protected_peer_ids=*/{0, 1, 2, 7, 8, 9},
135        /*unprotected_peer_ids=*/{3, 4, 5, 6, 10, 11},
136        random_context));
137
138    // Expect 1/4 I2P peers to be protected from eviction,
139    // if no onion, localhost, or CJDNS peers.
140    BOOST_CHECK(IsProtected(
141        num_peers, [](NodeEvictionCandidate& c) {
142            c.m_is_local = false;
143            c.m_network = (c.id == 2 || c.id == 7 || c.id == 10) ? NET_I2P : NET_IPV4;
144        },
145        /*protected_peer_ids=*/{2, 7, 10},
146        /*unprotected_peer_ids=*/{},
147        random_context));
148
149    // Expect 1/4 I2P peers and 1/4 of the other peers to be protected, sorted
150    // by longest uptime (lowest m_connected), if no onion, localhost, or CJDNS peers.
151    BOOST_CHECK(IsProtected(
152        num_peers, [](NodeEvictionCandidate& c) {
153            c.m_connected = NodeSeconds{std::chrono::seconds{c.id}};
154            c.m_is_local = false;
155            c.m_network = (c.id == 4 || c.id > 8) ? NET_I2P : NET_IPV6;
156        },
157        /*protected_peer_ids=*/{0, 1, 2, 4, 9, 10},
158        /*unprotected_peer_ids=*/{3, 5, 6, 7, 8, 11},
159        random_context));
160
161    // Expect 1/4 CJDNS peers to be protected from eviction,
162    // if no onion, localhost, or I2P peers.
163    BOOST_CHECK(IsProtected(
164        num_peers, [](NodeEvictionCandidate& c) {
165            c.m_is_local = false;
166            c.m_network = (c.id == 2 || c.id == 7 || c.id == 10) ? NET_CJDNS : NET_IPV4;
167        },
168        /*protected_peer_ids=*/{2, 7, 10},
169        /*unprotected_peer_ids=*/{},
170        random_context));
171
172    // Expect 1/4 CJDNS peers and 1/4 of the other peers to be protected, sorted
173    // by longest uptime (lowest m_connected), if no onion, localhost, or I2P peers.
174    BOOST_CHECK(IsProtected(
175        num_peers, [](NodeEvictionCandidate& c) {
176            c.m_connected = NodeSeconds{std::chrono::seconds{c.id}};
177            c.m_is_local = false;
178            c.m_network = (c.id == 4 || c.id > 8) ? NET_CJDNS : NET_IPV6;
179        },
180        /*protected_peer_ids=*/{0, 1, 2, 4, 9, 10},
181        /*unprotected_peer_ids=*/{3, 5, 6, 7, 8, 11},
182        random_context));
183
184    // Tests with 2 networks...
185
186    // Combined test: expect having 1 localhost and 1 onion peer out of 4 to
187    // protect 1 localhost, 0 onion and 1 other peer, sorted by longest uptime;
188    // stable sort breaks tie with array order of localhost first.
189    BOOST_CHECK(IsProtected(
190        4, [](NodeEvictionCandidate& c) {
191            c.m_connected = NodeSeconds{std::chrono::seconds{c.id}};
192            c.m_is_local = (c.id == 4);
193            c.m_network = (c.id == 3) ? NET_ONION : NET_IPV4;
194        },
195        /*protected_peer_ids=*/{0, 4},
196        /*unprotected_peer_ids=*/{1, 2},
197        random_context));
198
199    // Combined test: expect having 1 localhost and 1 onion peer out of 7 to
200    // protect 1 localhost, 0 onion, and 2 other peers (3 total), sorted by
201    // uptime; stable sort breaks tie with array order of localhost first.
202    BOOST_CHECK(IsProtected(
203        7, [](NodeEvictionCandidate& c) {
204            c.m_connected = NodeSeconds{std::chrono::seconds{c.id}};
205            c.m_is_local = (c.id == 6);
206            c.m_network = (c.id == 5) ? NET_ONION : NET_IPV4;
207        },
208        /*protected_peer_ids=*/{0, 1, 6},
209        /*unprotected_peer_ids=*/{2, 3, 4, 5},
210        random_context));
211
212    // Combined test: expect having 1 localhost and 1 onion peer out of 8 to
213    // protect protect 1 localhost, 1 onion and 2 other peers (4 total), sorted
214    // by uptime; stable sort breaks tie with array order of localhost first.
215    BOOST_CHECK(IsProtected(
216        8, [](NodeEvictionCandidate& c) {
217            c.m_connected = NodeSeconds{std::chrono::seconds{c.id}};
218            c.m_is_local = (c.id == 6);
219            c.m_network = (c.id == 5) ? NET_ONION : NET_IPV4;
220        },
221        /*protected_peer_ids=*/{0, 1, 5, 6},
222        /*unprotected_peer_ids=*/{2, 3, 4, 7},
223        random_context));
224
225    // Combined test: expect having 3 localhost and 3 onion peers out of 12 to
226    // protect 2 localhost and 1 onion, plus 3 other peers, sorted by longest
227    // uptime; stable sort breaks ties with the array order of localhost first.
228    BOOST_CHECK(IsProtected(
229        num_peers, [](NodeEvictionCandidate& c) {
230            c.m_connected = NodeSeconds{std::chrono::seconds{c.id}};
231            c.m_is_local = (c.id == 6 || c.id == 9 || c.id == 11);
232            c.m_network = (c.id == 7 || c.id == 8 || c.id == 10) ? NET_ONION : NET_IPV6;
233        },
234        /*protected_peer_ids=*/{0, 1, 2, 6, 7, 9},
235        /*unprotected_peer_ids=*/{3, 4, 5, 8, 10, 11},
236        random_context));
237
238    // Combined test: expect having 4 localhost and 1 onion peer out of 12 to
239    // protect 2 localhost and 1 onion, plus 3 other peers, sorted by longest uptime.
240    BOOST_CHECK(IsProtected(
241        num_peers, [](NodeEvictionCandidate& c) {
242            c.m_connected = NodeSeconds{std::chrono::seconds{c.id}};
243            c.m_is_local = (c.id > 4 && c.id < 9);
244            c.m_network = (c.id == 10) ? NET_ONION : NET_IPV4;
245        },
246        /*protected_peer_ids=*/{0, 1, 2, 5, 6, 10},
247        /*unprotected_peer_ids=*/{3, 4, 7, 8, 9, 11},
248        random_context));
249
250    // Combined test: expect having 4 localhost and 2 onion peers out of 16 to

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.