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.

6,680 bytes · SHA-256 3cee758a5f55037f… · 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 the scanblocks RPC call."""
6from test_framework.address import address_to_scriptpubkey
7from test_framework.blockfilter import (
8    bip158_basic_element_hash,
9    bip158_relevant_scriptpubkeys,
10)
11from test_framework.messages import COIN
12from test_framework.test_framework import BitcoinTestFramework
13from test_framework.util import (
14    assert_equal,
15    assert_raises_rpc_error,
16)
17from test_framework.wallet import (
18    MiniWallet,
19    getnewdestination,
20)
21
22
23class ScanblocksTest(BitcoinTestFramework):
24    def set_test_params(self):
25        self.num_nodes = 2
26        self.extra_args = [["-blockfilterindex=1"], []]
27
28    def run_test(self):
29        node = self.nodes[0]
30        wallet = MiniWallet(node)
31
32        # send 1.0, mempool only
33        _, spk_1, addr_1 = getnewdestination()
34        wallet.send_to(from_node=node, scriptPubKey=spk_1, amount=1 * COIN)
35
36        parent_key = "tpubD6NzVbkrYhZ4WaWSyoBvQwbpLkojyoTZPRsgXELWz3Popb3qkjcJyJUGLnL4qHHoQvao8ESaAstxYSnhyswJ76uZPStJRJCTKvosUCJZL5B"
37        # send 1.0, mempool only
38        # childkey 5 of `parent_key`
39        wallet.send_to(from_node=node,
40                       scriptPubKey=address_to_scriptpubkey("mkS4HXoTYWRTescLGaUTGbtTTYX5EjJyEE"),
41                       amount=1 * COIN)
42
43        # mine a block and assure that the mined blockhash is in the filterresult
44        blockhash = self.generate(node, 1)[0]
45        height = node.getblockheader(blockhash)['height']
46        self.wait_until(lambda: all(i["synced"] for i in node.getindexinfo().values()))
47
48        out = node.scanblocks("start", [f"addr({addr_1})"])
49        assert blockhash in out['relevant_blocks']
50        assert_equal(height, out['to_height'])
51        assert_equal(0, out['from_height'])
52        assert_equal(True, out['completed'])
53
54        # mine another block
55        blockhash_new = self.generate(node, 1)[0]
56        height_new = node.getblockheader(blockhash_new)['height']
57
58        # make sure the blockhash is not in the filter result if we set the start_height
59        # to the just mined block (unlikely to hit a false positive)
60        assert blockhash not in node.scanblocks(
61            "start", [f"addr({addr_1})"], height_new)['relevant_blocks']
62
63        # make sure the blockhash is present when using the first mined block as start_height
64        assert blockhash in node.scanblocks(
65            "start", [f"addr({addr_1})"], height)['relevant_blocks']
66        for v in [False, True]:
67            assert blockhash in node.scanblocks(
68                action="start",
69                scanobjects=[f"addr({addr_1})"],
70                start_height=height,
71                options={"filter_false_positives": v})['relevant_blocks']
72
73        # also test the stop height
74        assert blockhash in node.scanblocks(
75            "start", [f"addr({addr_1})"], height, height)['relevant_blocks']
76
77        # use the stop_height to exclude the relevant block
78        assert blockhash not in node.scanblocks(
79            "start", [f"addr({addr_1})"], 0, height - 1)['relevant_blocks']
80
81        # make sure the blockhash is present when using the first mined block as start_height
82        assert blockhash in node.scanblocks(
83            "start", [{"desc": f"pkh({parent_key}/*)", "range": [0, 100]}], height)['relevant_blocks']
84
85        # check that false-positives are included in the result now; note that
86        # finding a false-positive at runtime would take too long, hence we simply
87        # use a pre-calculated one that collides with the regtest genesis block's
88        # coinbase output and verify that their BIP158 ranged hashes match
89        genesis_blockhash = node.getblockhash(0)
90        genesis_spks = bip158_relevant_scriptpubkeys(node, genesis_blockhash)
91        assert_equal(len(genesis_spks), 1)
92        genesis_coinbase_spk = list(genesis_spks)[0]
93        false_positive_spk = bytes.fromhex("001400000000000000000000000000000000000cadcb")
94
95        genesis_coinbase_hash = bip158_basic_element_hash(genesis_coinbase_spk, 1, genesis_blockhash)
96        false_positive_hash = bip158_basic_element_hash(false_positive_spk, 1, genesis_blockhash)
97        assert_equal(genesis_coinbase_hash, false_positive_hash)
98
99        assert genesis_blockhash in node.scanblocks(
100            "start", [{"desc": f"raw({genesis_coinbase_spk.hex()})"}], 0, 0)['relevant_blocks']
101        assert genesis_blockhash in node.scanblocks(
102            "start", [{"desc": f"raw({false_positive_spk.hex()})"}], 0, 0)['relevant_blocks']
103
104        # check that the filter_false_positives option works
105        assert genesis_blockhash in node.scanblocks(
106            "start", [{"desc": f"raw({genesis_coinbase_spk.hex()})"}], 0, 0, "basic", {"filter_false_positives": True})['relevant_blocks']
107        assert genesis_blockhash not in node.scanblocks(
108            "start", [{"desc": f"raw({false_positive_spk.hex()})"}], 0, 0, "basic", {"filter_false_positives": True})['relevant_blocks']
109
110        # test node with disabled blockfilterindex
111        assert_raises_rpc_error(-1, "Index is not enabled for filtertype basic",
112                                self.nodes[1].scanblocks, "start", [f"addr({addr_1})"])
113
114        # test unknown filtertype
115        assert_raises_rpc_error(-5, "Unknown filtertype",
116                                node.scanblocks, "start", [f"addr({addr_1})"], 0, 10, "extended")
117
118        # test invalid start_height
119        assert_raises_rpc_error(-1, "Invalid start_height",
120                                node.scanblocks, "start", [f"addr({addr_1})"], 100000000)
121
122        # test invalid stop_height
123        assert_raises_rpc_error(-1, "Invalid stop_height",
124                                node.scanblocks, "start", [f"addr({addr_1})"], 10, 0)
125        assert_raises_rpc_error(-1, "Invalid stop_height",
126                                node.scanblocks, "start", [f"addr({addr_1})"], 10, 100000000)
127
128        # test accessing the status (must be empty)
129        assert_equal(node.scanblocks("status"), None)
130
131        # test aborting the current scan (there is no, must return false)
132        assert_equal(node.scanblocks("abort"), False)
133
134        # test invalid command
135        assert_raises_rpc_error(-8, "Invalid action 'foobar'", node.scanblocks, "foobar")
136
137        # test that null scanobjects is rejected for start
138        assert_raises_rpc_error(-1, "scanobjects argument is required for the start action", node.scanblocks, "start", None)
139
140
141if __name__ == '__main__':
142    ScanblocksTest(__file__).main()
143

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.