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.

5,740 bytes · SHA-256 dbcf97d981d949e6… · View upstream ↗

1#!/usr/bin/env python3
2# Copyright (c) 2022-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 fast rescan using block filters for descriptor wallets detects
6   top-ups correctly and finds the same transactions than the slow variant."""
7from test_framework.address import address_to_scriptpubkey
8from test_framework.descriptors import descsum_create
9from test_framework.test_framework import BitcoinTestFramework
10from test_framework.test_node import TestNode
11from test_framework.util import assert_equal
12from test_framework.wallet import MiniWallet
13from test_framework.wallet_util import get_generate_key
14
15
16KEYPOOL_SIZE = 100   # smaller than default size to speed-up test
17NUM_BLOCKS = 6       # number of blocks to mine
18
19
20class WalletFastRescanTest(BitcoinTestFramework):
21    def set_test_params(self):
22        self.num_nodes = 1
23        self.extra_args = [[f'-keypool={KEYPOOL_SIZE}', '-blockfilterindex=1']]
24
25    def skip_test_if_missing_module(self):
26        self.skip_if_no_wallet()
27
28    def get_wallet_txids(self, node: TestNode, wallet_name: str) -> list[str]:
29        w = node.get_wallet_rpc(wallet_name)
30        txs = w.listtransactions('*', 1000000)
31        return [tx['txid'] for tx in txs]
32
33    def run_test(self):
34        node = self.nodes[0]
35        funding_wallet = MiniWallet(node)
36
37        self.log.info("Create descriptor wallet with backup")
38        WALLET_BACKUP_FILENAME = node.datadir_path / 'wallet.bak'
39        node.createwallet(wallet_name='topup_test')
40        w = node.get_wallet_rpc('topup_test')
41        fixed_key = get_generate_key()
42        w.importdescriptors([{"desc": descsum_create(f"wpkh({fixed_key.privkey})"), "timestamp": "now"}])
43        descriptors = w.listdescriptors()['descriptors']
44        w.backupwallet(WALLET_BACKUP_FILENAME)
45
46        num_txs = 0
47
48        fast_rescan_messages = []
49        def append_fast_rescan_message():
50            chain_info = self.nodes[0].getblockchaininfo()
51            fast_rescan_messages.append(f"Fast rescan: inspect block {chain_info['blocks']} [{chain_info['bestblockhash']}] (filter matched)")
52
53        self.log.info("Create tx sending to non-ranged descriptors")
54        self.log.debug(f"Block 1/{NUM_BLOCKS}")
55        spk = bytes.fromhex(fixed_key.p2wpkh_script)
56        self.log.debug(f"-> fixed non-range descriptor address {fixed_key.p2wpkh_addr}")
57        funding_wallet.send_to(from_node=node, scriptPubKey=spk, amount=10000)
58        num_txs += 1
59        self.generate(node, 1)
60        append_fast_rescan_message()
61
62        self.log.info("Create txs sending to end range address of each descriptor, triggering top-ups")
63        for i in range(1, NUM_BLOCKS):
64            self.log.debug(f"Block {i+1}/{NUM_BLOCKS}")
65            # Get descriptors with updated ranges
66            ranged_descs = [desc for desc in w.listdescriptors()['descriptors'] if 'range' in desc]
67            for desc_info in ranged_descs:
68                start_range, end_range = desc_info['range']
69                addr = w.deriveaddresses(desc_info['desc'], [end_range, end_range])[0]
70                spk = address_to_scriptpubkey(addr)
71                self.log.debug(f"-> range [{start_range},{end_range}], last address {addr}")
72                funding_wallet.send_to(from_node=node, scriptPubKey=spk, amount=10000)
73                num_txs += 1
74            self.generate(node, 1)
75            append_fast_rescan_message()
76
77        self.log.info("Import wallet backup with block filter index")
78        with node.assert_debug_log(['fast variant using block filters', *fast_rescan_messages]):
79            node.restorewallet('rescan_fast', WALLET_BACKUP_FILENAME)
80        txids_fast = self.get_wallet_txids(node, 'rescan_fast')
81
82        self.log.info("Import non-active descriptors with block filter index")
83        node.createwallet(wallet_name='rescan_fast_nonactive', disable_private_keys=True, blank=True)
84        with node.assert_debug_log(['fast variant using block filters', *fast_rescan_messages]):
85            w = node.get_wallet_rpc('rescan_fast_nonactive')
86            w.importdescriptors([{"desc": descriptor['desc'], "timestamp": 0} for descriptor in descriptors])
87        txids_fast_nonactive = self.get_wallet_txids(node, 'rescan_fast_nonactive')
88
89        self.restart_node(0, [f'-keypool={KEYPOOL_SIZE}', '-blockfilterindex=0'])
90        self.log.info("Import wallet backup w/o block filter index")
91        with node.assert_debug_log(['slow variant inspecting all blocks']):
92            node.restorewallet("rescan_slow", WALLET_BACKUP_FILENAME)
93        txids_slow = self.get_wallet_txids(node, 'rescan_slow')
94
95        self.log.info("Import non-active descriptors w/o block filter index")
96        node.createwallet(wallet_name='rescan_slow_nonactive', disable_private_keys=True, blank=True)
97        with node.assert_debug_log(['slow variant inspecting all blocks']):
98            w = node.get_wallet_rpc('rescan_slow_nonactive')
99            w.importdescriptors([{"desc": descriptor['desc'], "timestamp": 0} for descriptor in descriptors])
100        txids_slow_nonactive = self.get_wallet_txids(node, 'rescan_slow_nonactive')
101
102        self.log.info("Verify that all rescans found the same txs in slow and fast variants")
103        assert_equal(len(txids_slow), num_txs)
104        assert_equal(len(txids_fast), num_txs)
105        assert_equal(len(txids_slow_nonactive), num_txs)
106        assert_equal(len(txids_fast_nonactive), num_txs)
107        assert_equal(sorted(txids_slow), sorted(txids_fast))
108        assert_equal(sorted(txids_slow_nonactive), sorted(txids_fast_nonactive))
109
110
111if __name__ == '__main__':
112    WalletFastRescanTest(__file__).main()
113

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.