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.

7,320 bytes · SHA-256 b8a0c2304df3e464… · View upstream ↗

1#!/usr/bin/env python3
2# Copyright (c) 2017-present The Bitcoin Core developers
3# Distributed under the MIT software license, see the accompanying
4# file COPYING or http://www.opensource.org/licenses/mit-license.php.
5"""Tests NODE_NETWORK_LIMITED.
6
7Tests that a node configured with -prune=550 signals NODE_NETWORK_LIMITED correctly
8and that it responds to getdata requests for blocks correctly:
9    - send a block within 288 + 2 of the tip
10    - disconnect peers who request blocks older than that."""
11from test_framework.messages import (
12    CInv,
13    MSG_BLOCK,
14    NODE_NETWORK_LIMITED,
15    NODE_P2P_V2,
16    NODE_WITNESS,
17    msg_getdata,
18)
19from test_framework.p2p import P2PInterface
20from test_framework.test_framework import BitcoinTestFramework
21from test_framework.util import (
22    assert_equal,
23    assert_raises_rpc_error,
24    try_rpc
25)
26
27# Minimum blocks required to signal NODE_NETWORK_LIMITED #
28NODE_NETWORK_LIMITED_MIN_BLOCKS = 288
29
30class P2PIgnoreInv(P2PInterface):
31    def on_inv(self, message):
32        # The node will send us invs for other blocks. Ignore them.
33        pass
34    def send_getdata_for_block(self, blockhash):
35        getdata_request = msg_getdata()
36        getdata_request.inv.append(CInv(MSG_BLOCK, int(blockhash, 16)))
37        self.send_without_ping(getdata_request)
38
39class NodeNetworkLimitedTest(BitcoinTestFramework):
40    def set_test_params(self):
41        self.setup_clean_chain = True
42        self.num_nodes = 3
43        self.extra_args = [['-prune=550'], [], []]
44
45    def disconnect_all(self):
46        self.disconnect_nodes(0, 1)
47        self.disconnect_nodes(0, 2)
48        self.disconnect_nodes(1, 2)
49
50    def setup_network(self):
51        self.add_nodes(self.num_nodes, self.extra_args)
52        self.start_nodes()
53
54    def test_avoid_requesting_historical_blocks(self):
55        self.log.info("Test full node does not request blocks beyond the limited peer threshold")
56        pruned_node = self.nodes[0]
57        miner = self.nodes[1]
58        full_node = self.nodes[2]
59
60        # Connect and generate block to ensure IBD=false
61        self.connect_nodes(1, 0)
62        self.connect_nodes(1, 2)
63        self.generate(miner, 1)
64
65        # Verify peers are out of IBD
66        for node in self.nodes:
67            assert not node.getblockchaininfo()['initialblockdownload']
68
69        # Isolate full_node (the node will remain out of IBD)
70        full_node.setnetworkactive(False)
71        self.wait_until(lambda: len(full_node.getpeerinfo()) == 0)
72
73        # Mine blocks and sync the pruned node. Surpass the NETWORK_NODE_LIMITED threshold.
74        # Blocks deeper than the threshold are considered "historical blocks"
75        num_historial_blocks = 12
76        self.generate(miner, NODE_NETWORK_LIMITED_MIN_BLOCKS + num_historial_blocks, sync_fun=self.no_op)
77        self.sync_blocks([miner, pruned_node])
78
79        # Connect full_node to prune_node and check peers don't disconnect right away.
80        # (they will disconnect if full_node, which is chain-wise behind, request blocks
81        # older than NODE_NETWORK_LIMITED_MIN_BLOCKS)
82        start_height_full_node = full_node.getblockcount()
83        full_node.setnetworkactive(True)
84        self.connect_nodes(2, 0)
85        assert_equal(len(full_node.getpeerinfo()), 1)
86
87        # Wait until the full_node is headers-wise sync
88        best_block_hash = pruned_node.getbestblockhash()
89        default_value = {'status': ''}  # No status
90        self.wait_until(lambda: next(filter(lambda x: x['hash'] == best_block_hash, full_node.getchaintips()), default_value)['status'] == "headers-only")
91
92        # Now, since the node aims to download a window of 1024 blocks,
93        # ensure it requests the blocks below the threshold only (with a
94        # 2-block buffer). And also, ensure it does not request any
95        # historical block.
96        tip_height = pruned_node.getblockcount()
97        limit_buffer = 2
98        # Prevent races by waiting for the tip to arrive first
99        self.wait_until(lambda: not try_rpc(-1, "Block not available (not fully downloaded)", full_node.getblock, pruned_node.getbestblockhash()))
100        for height in range(start_height_full_node + 1, tip_height + 1):
101            if height <= tip_height - (NODE_NETWORK_LIMITED_MIN_BLOCKS - limit_buffer):
102                assert_raises_rpc_error(-1, "Block not available (not fully downloaded)", full_node.getblock, pruned_node.getblockhash(height))
103            else:
104                full_node.getblock(pruned_node.getblockhash(height))  # just assert it does not throw an exception
105
106        # Lastly, ensure the full_node is not sync and verify it can get synced by
107        # establishing a connection with another full node capable of providing them.
108        assert_equal(full_node.getblockcount(), start_height_full_node)
109        self.connect_nodes(2, 1)
110        self.sync_blocks([miner, full_node])
111
112    def run_test(self):
113        node = self.nodes[0].add_p2p_connection(P2PIgnoreInv())
114
115        expected_services = NODE_WITNESS | NODE_NETWORK_LIMITED
116        if self.options.v2transport:
117            expected_services |= NODE_P2P_V2
118
119        self.log.info("Check that node has signalled expected services.")
120        assert_equal(node.nServices, expected_services)
121
122        self.log.info("Check that the localservices is as expected.")
123        assert_equal(int(self.nodes[0].getnetworkinfo()['localservices'], 16), expected_services)
124
125        self.log.info("Mine enough blocks to reach the NODE_NETWORK_LIMITED range.")
126        self.connect_nodes(0, 1)
127        blocks = self.generate(self.nodes[1], 292, sync_fun=lambda: self.sync_blocks([self.nodes[0], self.nodes[1]]))
128
129        self.log.info("Make sure we can max retrieve block at tip-288.")
130        node.send_getdata_for_block(blocks[1])  # last block in valid range
131        node.wait_for_block(int(blocks[1], 16), timeout=3)
132
133        self.log.info("Requesting block at height 2 (tip-289) must fail (ignored).")
134        node.send_getdata_for_block(blocks[0])  # first block outside of the 288+2 limit
135        node.wait_for_disconnect(timeout=5)
136        self.nodes[0].disconnect_p2ps()
137
138        # connect unsynced node 2 with pruned NODE_NETWORK_LIMITED peer
139        # because node 2 is in IBD and node 0 is a NODE_NETWORK_LIMITED peer, sync must not be possible
140        self.connect_nodes(0, 2)
141        try:
142            self.sync_blocks([self.nodes[0], self.nodes[2]], timeout=5)
143        except Exception:
144            pass
145        # node2 must remain at height 0
146        assert_equal(self.nodes[2].getblockheader(self.nodes[2].getbestblockhash())['height'], 0)
147
148        # now connect also to node 1 (non pruned)
149        self.connect_nodes(1, 2)
150
151        # sync must be possible
152        self.sync_blocks()
153
154        # disconnect all peers
155        self.disconnect_all()
156
157        # mine 10 blocks on node 0 (pruned node)
158        self.generate(self.nodes[0], 10, sync_fun=self.no_op)
159
160        # connect node1 (non pruned) with node0 (pruned) and check if the can sync
161        self.connect_nodes(0, 1)
162
163        # sync must be possible, node 1 is no longer in IBD and should therefore connect to node 0 (NODE_NETWORK_LIMITED)
164        self.sync_blocks([self.nodes[0], self.nodes[1]])
165
166        self.test_avoid_requesting_historical_blocks()
167
168if __name__ == '__main__':
169    NodeNetworkLimitedTest(__file__).main()
170

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.