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,880 bytes · SHA-256 8d4ee3d2efd39c48… · View upstream ↗

1#!/usr/bin/env python3
2# Copyright (c) 2021-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"""Test that a node in blocksonly mode does not request compact blocks."""
6
7from test_framework.messages import (
8    MSG_BLOCK,
9    MSG_CMPCT_BLOCK,
10    MSG_WITNESS_FLAG,
11    CBlock,
12    CBlockHeader,
13    CInv,
14    from_hex,
15    HeaderAndShortIDs,
16    msg_block,
17    msg_cmpctblock,
18    msg_getdata,
19    msg_headers,
20    msg_sendcmpct,
21)
22from test_framework.p2p import P2PInterface
23from test_framework.test_framework import BitcoinTestFramework
24from test_framework.util import assert_equal
25
26
27class P2PCompactBlocksBlocksOnly(BitcoinTestFramework):
28    def set_test_params(self):
29        self.extra_args = [["-blocksonly"], [], [], []]
30        self.num_nodes = 4
31
32    def setup_network(self):
33        self.setup_nodes()
34        # Start network with everyone disconnected
35        self.sync_all()
36
37    def build_block_on_tip(self):
38        blockhash = self.generate(self.nodes[2], 1, sync_fun=self.no_op)[0]
39        block_hex = self.nodes[2].getblock(blockhash=blockhash, verbosity=0)
40        block = from_hex(CBlock(), block_hex)
41        return block
42
43    def ignores_cmpctblock(self, node_id, conn, solicited=False):
44        # Briefly connect to mining node, sync, and disconnect, just to make
45        # sure the node is on the same tip as the miner so that compact block
46        # reconstruction works.
47        self.connect_nodes(2, node_id)
48        self.sync_blocks([self.nodes[2], self.nodes[node_id]], timeout=10)
49        self.disconnect_nodes(2, node_id)
50
51        block = self.build_block_on_tip()
52        if solicited:
53            conn.send_without_ping(msg_headers([block]))
54            conn.wait_for_getdata([block.hash_int], timeout=10)
55        cmpct_block = HeaderAndShortIDs()
56        cmpct_block.initialize_from_block(block, use_witness=True)
57        msg = msg_cmpctblock(cmpct_block.to_p2p())
58        conn.send_and_ping(msg)
59
60        cmpct_block_received = self.nodes[node_id].getbestblockhash() == cmpct_block.header.hash_hex
61        if not cmpct_block_received:
62            # Compact block was ignored, send the full block to keep in sync.
63            conn.send_and_ping(msg_block(block))
64
65        return not cmpct_block_received
66
67    def run_test(self):
68        # Nodes will only request hb compact blocks mode when they're out of IBD
69        for node in self.nodes:
70            assert not node.getblockchaininfo()['initialblockdownload']
71
72        p2p_conn_blocksonly = self.nodes[0].add_p2p_connection(P2PInterface())
73        p2p_conn_high_bw = self.nodes[1].add_p2p_connection(P2PInterface())
74        p2p_conn_low_bw = self.nodes[3].add_p2p_connection(P2PInterface())
75        for conn in [p2p_conn_blocksonly, p2p_conn_high_bw, p2p_conn_low_bw]:
76            assert_equal(conn.message_count['sendcmpct'], 1)
77            conn.send_and_ping(msg_sendcmpct(announce=False, version=2))
78
79        # Nodes:
80        #   0 -> blocksonly
81        #   1 -> high bandwidth
82        #   2 -> miner
83        #   3 -> low bandwidth
84        #
85        # Topology:
86        #   p2p_conn_blocksonly ---> node0
87        #   p2p_conn_high_bw    ---> node1
88        #   p2p_conn_low_bw     ---> node3
89        #   node2 (no connections)
90        #
91        # node2 produces blocks that are passed to the rest of the nodes
92        # through the respective p2p connections.
93
94        self.log.info("Test that -blocksonly nodes do not select peers for BIP152 high bandwidth mode")
95
96        block0 = self.build_block_on_tip()
97
98        # A -blocksonly node should not request BIP152 high bandwidth mode upon
99        # receiving a new valid block at the tip.
100        p2p_conn_blocksonly.send_and_ping(msg_block(block0))
101        assert_equal(self.nodes[0].getbestblockhash(), block0.hash_hex)
102        assert_equal(p2p_conn_blocksonly.message_count['sendcmpct'], 1)
103        assert_equal(p2p_conn_blocksonly.last_message['sendcmpct'].announce, False)
104
105        # A normal node participating in transaction relay should request BIP152
106        # high bandwidth mode upon receiving a new valid block at the tip.
107        p2p_conn_high_bw.send_and_ping(msg_block(block0))
108        assert_equal(self.nodes[1].getbestblockhash(), block0.hash_hex)
109        p2p_conn_high_bw.wait_until(lambda: p2p_conn_high_bw.message_count['sendcmpct'] == 2)
110        assert_equal(p2p_conn_high_bw.last_message['sendcmpct'].announce, True)
111
112        # Don't send a block from the p2p_conn_low_bw so the low bandwidth node
113        # doesn't select it for BIP152 high bandwidth relay.
114        self.nodes[3].submitblock(block0.serialize().hex())
115
116        self.log.info("Test that -blocksonly nodes send getdata(BLOCK) instead"
117                      " of getdata(CMPCT) in BIP152 low bandwidth mode")
118
119        block1 = self.build_block_on_tip()
120
121        p2p_conn_blocksonly.send_and_ping(msg_headers(headers=[CBlockHeader(block1)]))
122        assert_equal(p2p_conn_blocksonly.last_message['getdata'].inv, [CInv(MSG_BLOCK | MSG_WITNESS_FLAG, block1.hash_int)])
123
124        p2p_conn_high_bw.send_and_ping(msg_headers(headers=[CBlockHeader(block1)]))
125        assert_equal(p2p_conn_high_bw.last_message['getdata'].inv, [CInv(MSG_CMPCT_BLOCK, block1.hash_int)])
126
127        # Send the block to avoid stalling the peer later in the test.
128        comp_block = HeaderAndShortIDs()
129        comp_block.initialize_from_block(block1, use_witness=True)
130        block1_cb_msg = msg_cmpctblock(comp_block.to_p2p())
131        p2p_conn_high_bw.send_and_ping(block1_cb_msg)
132
133        self.log.info("Test that getdata(CMPCT) is still sent on BIP152 low bandwidth connections"
134                      " when no -blocksonly nodes are involved")
135
136        p2p_conn_low_bw.send_and_ping(msg_headers(headers=[CBlockHeader(block1)]))
137        assert_equal(p2p_conn_low_bw.last_message['getdata'].inv, [CInv(MSG_CMPCT_BLOCK, block1.hash_int)])
138        # Send the block to avoid stalling the peer later in the test.
139        p2p_conn_low_bw.send_and_ping(block1_cb_msg)
140
141        self.log.info("Test that -blocksonly nodes still serve compact blocks")
142
143        def test_for_cmpctblock(block):
144            if 'cmpctblock' not in p2p_conn_blocksonly.last_message:
145                return False
146            return p2p_conn_blocksonly.last_message['cmpctblock'].header_and_shortids.header.hash_int == block.hash_int
147
148        p2p_conn_blocksonly.send_without_ping(msg_getdata([CInv(MSG_CMPCT_BLOCK, block0.hash_int)]))
149        p2p_conn_blocksonly.wait_until(lambda: test_for_cmpctblock(block0))
150
151        # Request BIP152 high bandwidth mode from the -blocksonly node.
152        p2p_conn_blocksonly.send_and_ping(msg_sendcmpct(announce=True, version=2))
153
154        block2 = self.build_block_on_tip()
155        self.nodes[0].submitblock(block1.serialize().hex())
156        self.nodes[0].submitblock(block2.serialize().hex())
157        p2p_conn_blocksonly.wait_until(lambda: test_for_cmpctblock(block2))
158
159        # This is redundant with other tests, and is here as a test-of-the-test
160        self.log.info("Test that normal nodes don't ignore CMPCTBLOCK messages from HB peers")
161        assert not self.ignores_cmpctblock(1, p2p_conn_high_bw, solicited=False)
162
163        self.log.info("Test that -blocksonly nodes ignore CMPCTBLOCK messages")
164        assert self.ignores_cmpctblock(0, p2p_conn_blocksonly, solicited=False)
165
166        self.log.info("Test that low bandwidth nodes listen to CMPCTBLOCK messages when the block is requested")
167        assert not self.ignores_cmpctblock(3, p2p_conn_low_bw, solicited=True)
168
169        self.log.info("Test that -blocksonly nodes ignore CMPCTBLOCK messages even when the block is requested")
170        assert self.ignores_cmpctblock(0, p2p_conn_blocksonly, solicited=True)
171
172if __name__ == '__main__':
173    P2PCompactBlocksBlocksOnly(__file__).main()
174

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.