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.

11,512 bytes · SHA-256 4f53b41340b43664… · View upstream ↗

1#!/usr/bin/env python3
2# Copyright (c) 2019-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_COMPACT_FILTERS (BIP 157/158).
6
7Tests that a node configured with -blockfilterindex and -peerblockfilters signals
8NODE_COMPACT_FILTERS and can serve cfilters, cfheaders and cfcheckpts.
9"""
10
11from test_framework.messages import (
12    FILTER_TYPE_BASIC,
13    NODE_COMPACT_FILTERS,
14    hash256,
15    msg_getcfcheckpt,
16    msg_getcfheaders,
17    msg_getcfilters,
18    ser_uint256,
19    uint256_from_str,
20)
21from test_framework.p2p import P2PInterface
22from test_framework.test_framework import BitcoinTestFramework
23from test_framework.util import (
24    assert_not_equal,
25    assert_equal,
26)
27
28class FiltersClient(P2PInterface):
29    def __init__(self):
30        super().__init__()
31        # Store the cfilters received.
32        self.cfilters = []
33
34    def pop_cfilters(self):
35        cfilters = self.cfilters
36        self.cfilters = []
37        return cfilters
38
39    def on_cfilter(self, message):
40        """Store cfilters received in a list."""
41        self.cfilters.append(message)
42
43
44class CompactFiltersTest(BitcoinTestFramework):
45    def set_test_params(self):
46        self.setup_clean_chain = True
47        self.rpc_timeout = 480
48        self.num_nodes = 2
49        self.extra_args = [
50            ["-blockfilterindex", "-peerblockfilters"],
51            ["-blockfilterindex"],
52        ]
53
54    def run_test(self):
55        # Node 0 supports COMPACT_FILTERS, node 1 does not.
56        peer_0 = self.nodes[0].add_p2p_connection(FiltersClient())
57        peer_1 = self.nodes[1].add_p2p_connection(FiltersClient())
58
59        # Nodes 0 & 1 share the same first 999 blocks in the chain.
60        self.generate(self.nodes[0], 999)
61
62        # Stale blocks by disconnecting nodes 0 & 1, mining, then reconnecting
63        self.disconnect_nodes(0, 1)
64
65        stale_block_hash = self.generate(self.nodes[0], 1, sync_fun=self.no_op)[0]
66        self.nodes[0].syncwithvalidationinterfacequeue()
67        assert_equal(self.nodes[0].getblockcount(), 1000)
68
69        self.generate(self.nodes[1], 1001, sync_fun=self.no_op)
70        assert_equal(self.nodes[1].getblockcount(), 2000)
71
72        # Check that nodes have signalled NODE_COMPACT_FILTERS correctly.
73        assert_not_equal(peer_0.nServices & NODE_COMPACT_FILTERS, 0)
74        assert_equal(peer_1.nServices & NODE_COMPACT_FILTERS, 0)
75
76        # Check that the localservices is as expected.
77        assert_not_equal(int(self.nodes[0].getnetworkinfo()['localservices'], 16) & NODE_COMPACT_FILTERS, 0)
78        assert_equal(int(self.nodes[1].getnetworkinfo()['localservices'], 16) & NODE_COMPACT_FILTERS, 0)
79
80        self.log.info("get cfcheckpt on chain to be re-orged out.")
81        request = msg_getcfcheckpt(
82            filter_type=FILTER_TYPE_BASIC,
83            stop_hash=int(stale_block_hash, 16),
84        )
85        peer_0.send_and_ping(message=request)
86        response = peer_0.last_message['cfcheckpt']
87        assert_equal(response.filter_type, request.filter_type)
88        assert_equal(response.stop_hash, request.stop_hash)
89        assert_equal(len(response.headers), 1)
90
91        self.log.info("Reorg node 0 to a new chain.")
92        self.connect_nodes(0, 1)
93        self.sync_blocks(timeout=600)
94        self.nodes[0].syncwithvalidationinterfacequeue()
95
96        main_block_hash = self.nodes[0].getblockhash(1000)
97        assert_not_equal(main_block_hash, stale_block_hash, error_message="node 0 chain did not reorganize")
98
99        self.log.info("Check that peers can fetch cfcheckpt on active chain.")
100        tip_hash = self.nodes[0].getbestblockhash()
101        request = msg_getcfcheckpt(
102            filter_type=FILTER_TYPE_BASIC,
103            stop_hash=int(tip_hash, 16),
104        )
105        peer_0.send_and_ping(request)
106        response = peer_0.last_message['cfcheckpt']
107        assert_equal(response.filter_type, request.filter_type)
108        assert_equal(response.stop_hash, request.stop_hash)
109
110        main_cfcheckpt = self.nodes[0].getblockfilter(main_block_hash, 'basic')['header']
111        tip_cfcheckpt = self.nodes[0].getblockfilter(tip_hash, 'basic')['header']
112        assert_equal(
113            response.headers,
114            [int(header, 16) for header in (main_cfcheckpt, tip_cfcheckpt)],
115        )
116
117        self.log.info("Check that peers can fetch cfcheckpt on stale chain.")
118        request = msg_getcfcheckpt(
119            filter_type=FILTER_TYPE_BASIC,
120            stop_hash=int(stale_block_hash, 16),
121        )
122        peer_0.send_and_ping(request)
123        response = peer_0.last_message['cfcheckpt']
124
125        stale_cfcheckpt = self.nodes[0].getblockfilter(stale_block_hash, 'basic')['header']
126        assert_equal(
127            response.headers,
128            [int(header, 16) for header in (stale_cfcheckpt, )],
129        )
130
131        self.log.info("Check that peers can fetch cfheaders on active chain.")
132        request = msg_getcfheaders(
133            filter_type=FILTER_TYPE_BASIC,
134            start_height=1,
135            stop_hash=int(main_block_hash, 16),
136        )
137        peer_0.send_and_ping(request)
138        response = peer_0.last_message['cfheaders']
139        main_cfhashes = response.hashes
140        assert_equal(len(main_cfhashes), 1000)
141        assert_equal(
142            compute_last_header(response.prev_header, response.hashes),
143            int(main_cfcheckpt, 16),
144        )
145
146        self.log.info("Check that peers can fetch cfheaders on stale chain.")
147        request = msg_getcfheaders(
148            filter_type=FILTER_TYPE_BASIC,
149            start_height=1,
150            stop_hash=int(stale_block_hash, 16),
151        )
152        peer_0.send_and_ping(request)
153        response = peer_0.last_message['cfheaders']
154        stale_cfhashes = response.hashes
155        assert_equal(len(stale_cfhashes), 1000)
156        assert_equal(
157            compute_last_header(response.prev_header, response.hashes),
158            int(stale_cfcheckpt, 16),
159        )
160
161        self.log.info("Check that peers can fetch cfilters.")
162        stop_hash = self.nodes[0].getblockhash(10)
163        request = msg_getcfilters(
164            filter_type=FILTER_TYPE_BASIC,
165            start_height=1,
166            stop_hash=int(stop_hash, 16),
167        )
168        peer_0.send_and_ping(request)
169        response = peer_0.pop_cfilters()
170        assert_equal(len(response), 10)
171
172        self.log.info("Check that cfilter responses are correct.")
173        for cfilter, cfhash, height in zip(response, main_cfhashes, range(1, 11)):
174            block_hash = self.nodes[0].getblockhash(height)
175            assert_equal(cfilter.filter_type, FILTER_TYPE_BASIC)
176            assert_equal(cfilter.block_hash, int(block_hash, 16))
177            computed_cfhash = uint256_from_str(hash256(cfilter.filter_data))
178            assert_equal(computed_cfhash, cfhash)
179
180        self.log.info("Check that peers can fetch cfilters for stale blocks.")
181        request = msg_getcfilters(
182            filter_type=FILTER_TYPE_BASIC,
183            start_height=1000,
184            stop_hash=int(stale_block_hash, 16),
185        )
186        peer_0.send_and_ping(request)
187        response = peer_0.pop_cfilters()
188        assert_equal(len(response), 1)
189
190        cfilter = response[0]
191        assert_equal(cfilter.filter_type, FILTER_TYPE_BASIC)
192        assert_equal(cfilter.block_hash, int(stale_block_hash, 16))
193        computed_cfhash = uint256_from_str(hash256(cfilter.filter_data))
194        assert_equal(computed_cfhash, stale_cfhashes[999])
195
196        self.log.info("Requests to node 1 without NODE_COMPACT_FILTERS results in disconnection.")
197        requests = [
198            msg_getcfcheckpt(
199                filter_type=FILTER_TYPE_BASIC,
200                stop_hash=int(main_block_hash, 16),
201            ),
202            msg_getcfheaders(
203                filter_type=FILTER_TYPE_BASIC,
204                start_height=1000,
205                stop_hash=int(main_block_hash, 16),
206            ),
207            msg_getcfilters(
208                filter_type=FILTER_TYPE_BASIC,
209                start_height=1000,
210                stop_hash=int(main_block_hash, 16),
211            ),
212        ]
213        for request in requests:
214            peer_1 = self.nodes[1].add_p2p_connection(P2PInterface())
215            with self.nodes[1].assert_debug_log(expected_msgs=["requested unsupported block filter type"]):
216                peer_1.send_without_ping(request)
217                peer_1.wait_for_disconnect()
218
219        self.log.info("Check that invalid requests result in disconnection.")
220        requests = [
221            # Requesting too many filters results in disconnection.
222            (
223                msg_getcfilters(
224                    filter_type=FILTER_TYPE_BASIC,
225                    start_height=0,
226                    stop_hash=int(main_block_hash, 16),
227                ), "requested too many cfilters/cfheaders"
228            ),
229            # Requesting too many filter headers results in disconnection.
230            (
231                msg_getcfheaders(
232                    filter_type=FILTER_TYPE_BASIC,
233                    start_height=0,
234                    stop_hash=int(tip_hash, 16),
235                ), "requested too many cfilters/cfheaders"
236            ),
237            # Requesting unknown filter type results in disconnection.
238            (
239                msg_getcfcheckpt(
240                    filter_type=255,
241                    stop_hash=int(main_block_hash, 16),
242                ), "requested unsupported block filter type"
243            ),
244            # Requesting unknown hash results in disconnection.
245            (
246                msg_getcfcheckpt(
247                    filter_type=FILTER_TYPE_BASIC,
248                    stop_hash=123456789,
249                ), "requested invalid block hash"
250            ),

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.