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.

52,232 bytes · SHA-256 1c6f2d53d76053ef… · View upstream ↗

1#!/usr/bin/env python3
2# Copyright (c) 2016-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 compact blocks (BIP 152)."""
6import random
7
8from test_framework.blocktools import (
9    COINBASE_MATURITY,
10    NORMAL_GBT_REQUEST_PARAMS,
11    add_witness_commitment,
12    create_block,
13)
14from test_framework.messages import (
15    BlockTransactions,
16    BlockTransactionsRequest,
17    CBlock,
18    CBlockHeader,
19    CInv,
20    COutPoint,
21    CTransaction,
22    CTxIn,
23    CTxInWitness,
24    CTxOut,
25    from_hex,
26    HeaderAndShortIDs,
27    MSG_BLOCK,
28    MSG_CMPCT_BLOCK,
29    MSG_WITNESS_FLAG,
30    P2PHeaderAndShortIDs,
31    PrefilledTransaction,
32    calculate_shortid,
33    msg_block,
34    msg_blocktxn,
35    msg_cmpctblock,
36    msg_getblocktxn,
37    msg_getdata,
38    msg_getheaders,
39    msg_headers,
40    msg_inv,
41    msg_no_witness_block,
42    msg_no_witness_blocktxn,
43    msg_sendcmpct,
44    msg_sendheaders,
45    msg_tx,
46    ser_uint256,
47    tx_from_hex,
48)
49from test_framework.p2p import (
50    P2PInterface,
51    p2p_lock,
52)
53from test_framework.script import (
54    CScript,
55    OP_DROP,
56    OP_TRUE,
57    OP_RETURN,
58)
59from test_framework.test_framework import BitcoinTestFramework
60from test_framework.test_node import TestNode
61from test_framework.util import (
62    assert_not_equal,
63    assert_equal,
64    softfork_active,
65)
66from test_framework.wallet import MiniWallet
67
68
69# TestP2PConn: A peer we use to send messages to bitcoind, and store responses.
70class TestP2PConn(P2PInterface):
71    def __init__(self):
72        super().__init__()
73        self.last_sendcmpct = []
74        self.block_announced = False
75        # Store the hashes of blocks we've seen announced.
76        # This is for synchronizing the p2p message traffic,
77        # so we can eg wait until a particular block is announced.
78        self.announced_blockhashes = set()
79
80    def on_sendcmpct(self, message):
81        self.last_sendcmpct.append(message)
82
83    def on_cmpctblock(self, message):
84        self.block_announced = True
85        self.announced_blockhashes.add(self.last_message["cmpctblock"].header_and_shortids.header.hash_int)
86
87    def on_headers(self, message):
88        self.block_announced = True
89        for x in self.last_message["headers"].headers:
90            self.announced_blockhashes.add(x.hash_int)
91
92    def on_inv(self, message):
93        for x in self.last_message["inv"].inv:
94            if x.type == MSG_BLOCK:
95                self.block_announced = True
96                self.announced_blockhashes.add(x.hash)
97
98    # Requires caller to hold p2p_lock
99    def received_block_announcement(self):
100        return self.block_announced
101
102    def clear_block_announcement(self):
103        with p2p_lock:
104            self.block_announced = False
105            self.last_message.pop("inv", None)
106            self.last_message.pop("headers", None)
107            self.last_message.pop("cmpctblock", None)
108
109    def clear_getblocktxn(self):
110        with p2p_lock:
111            self.last_message.pop("getblocktxn", None)
112
113    def get_headers(self, locator, hashstop):
114        msg = msg_getheaders()
115        msg.locator.vHave = locator
116        msg.hashstop = hashstop
117        self.send_without_ping(msg)
118
119    def send_header_for_blocks(self, new_blocks):
120        headers_message = msg_headers()
121        headers_message.headers = [CBlockHeader(b) for b in new_blocks]
122        self.send_without_ping(headers_message)
123
124    def request_headers_and_sync(self, locator, hashstop=0):
125        self.clear_block_announcement()
126        self.get_headers(locator, hashstop)
127        self.wait_until(self.received_block_announcement, timeout=30)
128        self.clear_block_announcement()
129
130    # Block until a block announcement for a particular block hash is
131    # received.
132    def wait_for_block_announcement(self, block_hash, timeout=30):
133        def received_hash():
134            return (block_hash in self.announced_blockhashes)
135        self.wait_until(received_hash, timeout=timeout)
136
137    def send_await_disconnect(self, message, timeout=30):
138        """Sends a message to the node and wait for disconnect.
139
140        This is used when we want to send a message into the node that we expect
141        will get us disconnected, eg an invalid block."""
142        self.send_without_ping(message)
143        self.wait_for_disconnect(timeout=timeout)
144
145class CompactBlocksTest(BitcoinTestFramework):
146    def set_test_params(self):
147        self.setup_clean_chain = True
148        self.num_nodes = 1
149        self.extra_args = [[
150            "-acceptnonstdtxn=1",
151        ]]
152        self.utxos = []
153
154    def getblocktxn_expected(self, peer, blockhash, indices=None):
155        with p2p_lock:
156            assert "getblocktxn" in peer.last_message
157            gbt = peer.last_message["getblocktxn"].block_txn_request
158
159        assert_equal(gbt.blockhash, blockhash)
160        if indices is not None:
161            assert_equal(gbt.to_absolute(), indices)
162        if isinstance(peer, TestNode):
163            assert_not_equal(peer.getbestblockhash(), blockhash)
164
165    def build_block_on_tip(self, node):
166        block = create_block(tmpl=node.getblocktemplate(NORMAL_GBT_REQUEST_PARAMS))
167        block.solve()
168        return block
169
170    # Create 12 more anyone-can-spend utxo's for testing.
171    def make_utxos(self):
172        COUNT = 12
173        block = self.build_block_on_tip(self.nodes[0])
174        self.segwit_node.send_and_ping(msg_no_witness_block(block))
175        assert_equal(self.nodes[0].getbestblockhash(), block.hash_hex)
176        self.generate(self.wallet, COINBASE_MATURITY)
177
178        total_value = block.vtx[0].vout[0].nValue
179        out_value = total_value // COUNT
180        tx = CTransaction()
181        tx.vin.append(CTxIn(COutPoint(block.vtx[0].txid_int, 0), b''))
182        for _ in range(COUNT):
183            tx.vout.append(CTxOut(out_value, CScript([OP_TRUE])))
184
185        block2 = self.build_block_on_tip(self.nodes[0])
186        block2.vtx.append(tx)
187        block2.hashMerkleRoot = block2.calc_merkle_root()
188        block2.solve()
189        self.segwit_node.send_and_ping(msg_no_witness_block(block2))
190        assert_equal(self.nodes[0].getbestblockhash(), block2.hash_hex)
191        self.utxos.extend([[tx.txid_int, i, out_value] for i in range(COUNT)])
192
193    def announce_cmpct_block(self, node, peer, txn_count=5, solicit=False):
194        utxo = self.utxos.pop(0)
195        block = self.build_block_with_transactions(node, utxo, txn_count)
196
197        cmpct_block = HeaderAndShortIDs()
198        cmpct_block.initialize_from_block(block)
199        msg = msg_cmpctblock(cmpct_block.to_p2p())
200        if solicit:
201            peer.send_without_ping(msg_headers([block]))
202            peer.wait_for_getdata([block.hash_int], timeout=30)
203
204        peer.clear_getblocktxn()
205        peer.send_and_ping(msg)
206        self.getblocktxn_expected(peer, block.hash_int)
207        return block, cmpct_block
208
209    # Test "sendcmpct" (between peers preferring the same version):
210    # - No compact block announcements unless sendcmpct is sent.
211    # - If sendcmpct is sent with version = 1, the message is ignored.
212    # - If sendcmpct is sent with version > 2, the message is ignored.
213    # - If sendcmpct is sent with boolean 0, then block announcements are not
214    #   made with compact blocks.
215    # - If sendcmpct is then sent with boolean 1, then new block announcements
216    #   are made with compact blocks.
217    def test_sendcmpct(self, test_node):
218        node = self.nodes[0]
219
220        # Make sure we get a SENDCMPCT message from our peer
221        def received_sendcmpct():
222            return (len(test_node.last_sendcmpct) > 0)
223        test_node.wait_until(received_sendcmpct, timeout=30)
224        with p2p_lock:
225            # Check that version 2 is received.
226            assert_equal(test_node.last_sendcmpct[0].version, 2)
227            test_node.last_sendcmpct = []
228
229        tip = int(node.getbestblockhash(), 16)
230
231        def check_announcement_of_new_block(node, peer, predicate):
232            peer.clear_block_announcement()
233            block_hash = int(self.generate(node, 1)[0], 16)
234            peer.wait_for_block_announcement(block_hash, timeout=30)
235            assert peer.block_announced
236
237            with p2p_lock:
238                assert predicate(peer), (
239                    "block_hash={!r}, cmpctblock={!r}, inv={!r}".format(
240                        block_hash, peer.last_message.get("cmpctblock", None), peer.last_message.get("inv", None)))
241
242        # We shouldn't get any block announcements via cmpctblock yet.
243        check_announcement_of_new_block(node, test_node, lambda p: "cmpctblock" not in p.last_message)
244
245        # Try one more time, this time after requesting headers.
246        test_node.request_headers_and_sync(locator=[tip])
247        check_announcement_of_new_block(node, test_node, lambda p: "cmpctblock" not in p.last_message and "inv" in p.last_message)
248
249        # Test a few ways of using sendcmpct that should NOT
250        # result in compact block announcements.

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.