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.

10,036 bytes · SHA-256 a268c619f70e0f2b… · View upstream ↗

1#!/usr/bin/env python3
2# Copyright (c) 2020-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 indices in conjunction with prune."""
6import concurrent.futures
7import os
8from test_framework.test_framework import BitcoinTestFramework
9from test_framework.test_node import TestNode
10from test_framework.util import (
11    assert_equal,
12    assert_greater_than,
13    assert_raises_rpc_error,
14    JSONRPCException,
15)
16
17from typing import List, Any
18
19def send_batch_request(node: TestNode, method: str, params: List[Any]) -> List[Any]:
20    """Send batch request and parse all results"""
21    data = [getattr(node, method).get_request(*p) for p in params]
22    response = node.batch(data)
23    result = []
24    for item in response:
25        assert "error" not in item, item["error"]
26        result.append(item["result"])
27
28    return result
29
30
31class FeatureIndexPruneTest(BitcoinTestFramework):
32    def set_test_params(self):
33        self.num_nodes = 4
34        self.extra_args = [
35            ["-fastprune", "-prune=1", "-blockfilterindex=1"],
36            ["-fastprune", "-prune=1", "-coinstatsindex=1"],
37            ["-fastprune", "-prune=1", "-blockfilterindex=1", "-coinstatsindex=1"],
38            [],
39        ]
40
41    def setup_network(self):
42        self.setup_nodes()  # No P2P connection, so that linear_sync works
43
44    def linear_sync(self, node_from, *, height_from=None):
45        # Linear sync over RPC, because P2P sync may not be linear
46        to_height = node_from.getblockcount()
47        if height_from is None:
48            height_from = min([n.getblockcount() for n in self.nodes]) + 1
49        with concurrent.futures.ThreadPoolExecutor(max_workers=self.num_nodes) as rpc_threads:
50            for i in range(height_from, to_height + 1):
51                b = node_from.getblock(blockhash=node_from.getblockhash(i), verbosity=0)
52                list(rpc_threads.map(lambda n: n.submitblock(b), self.nodes))
53
54    def generate(self, node, num_blocks, sync_fun=None):
55        return super().generate(node, num_blocks, sync_fun=sync_fun or (lambda: self.linear_sync(node)))
56
57    def sync_index(self, height):
58        expected_filter = {
59            'basic block filter index': {'synced': True, 'best_block_height': height},
60        }
61        self.wait_until(lambda: self.nodes[0].getindexinfo() == expected_filter)
62
63        expected_stats = {
64            'coinstatsindex': {'synced': True, 'best_block_height': height}
65        }
66        self.wait_until(lambda: self.nodes[1].getindexinfo() == expected_stats, timeout=150)
67
68        expected = {**expected_filter, **expected_stats}
69        self.wait_until(lambda: self.nodes[2].getindexinfo() == expected)
70
71    def restart_without_indices(self):
72        for i in range(3):
73            self.restart_node(i, extra_args=["-fastprune", "-prune=1"])
74
75    def check_for_block(self, node, hash):
76        try:
77            self.nodes[node].getblock(hash)
78            return True
79        except JSONRPCException:
80            return False
81
82    def run_test(self):
83        filter_nodes = [self.nodes[0], self.nodes[2]]
84        stats_nodes = [self.nodes[1], self.nodes[2]]
85
86        self.log.info("check if we can access blockfilters and coinstats when pruning is enabled but no blocks are actually pruned")
87        self.sync_index(height=200)
88        tip = self.nodes[0].getbestblockhash()
89        for node in filter_nodes:
90            assert_greater_than(len(node.getblockfilter(tip)['filter']), 0)
91        for node in stats_nodes:
92            assert node.gettxoutsetinfo(hash_type="muhash", hash_or_height=tip)['muhash']
93
94        self.generate(self.nodes[0], 500)
95        self.sync_index(height=700)
96
97        self.log.info("prune some blocks")
98        for node in self.nodes[:2]:
99            with node.assert_debug_log(['limited pruning to height 689']):
100                pruneheight_new = node.pruneblockchain(400)
101                # the prune heights used here and below are magic numbers that are determined by the
102                # thresholds at which block files wrap, so they depend on disk serialization and default block file size.
103                assert_equal(pruneheight_new, 249)
104
105        self.log.info("check if we can access the tips blockfilter and coinstats when we have pruned some blocks")
106        tip = self.nodes[0].getbestblockhash()
107        for node in filter_nodes:
108            assert_greater_than(len(node.getblockfilter(tip)['filter']), 0)
109        for node in stats_nodes:
110            assert node.gettxoutsetinfo(hash_type="muhash", hash_or_height=tip)['muhash']
111
112        self.log.info("check if we can access the blockfilter and coinstats of a pruned block")
113        height_hash = self.nodes[0].getblockhash(2)
114        for node in filter_nodes:
115            assert_greater_than(len(node.getblockfilter(height_hash)['filter']), 0)
116        for node in stats_nodes:
117            assert node.gettxoutsetinfo(hash_type="muhash", hash_or_height=height_hash)['muhash']
118
119        # mine and sync index up to a height that will later be the pruneheight
120        self.generate(self.nodes[0], 54)
121        self.sync_index(height=754)
122
123        self.restart_without_indices()
124
125        self.log.info("make sure trying to access the indices throws errors")
126        for node in filter_nodes:
127            msg = "Index is not enabled for filtertype basic"
128            assert_raises_rpc_error(-1, msg, node.getblockfilter, height_hash)
129        for node in stats_nodes:
130            msg = "Querying specific block heights requires coinstatsindex"
131            assert_raises_rpc_error(-8, msg, node.gettxoutsetinfo, "muhash", height_hash)
132
133        self.generate(self.nodes[0], 746)
134
135        self.log.info("prune exactly up to the indices best blocks while the indices are disabled")
136        for i in range(3):
137            pruneheight_2 = self.nodes[i].pruneblockchain(1000)
138            assert_equal(pruneheight_2, 753)
139            # Restart the nodes again with the indices activated
140            self.restart_node(i, extra_args=self.extra_args[i])
141
142        self.log.info("make sure that we can continue with the partially synced indices after having pruned up to the index height")
143        self.sync_index(height=1500)
144
145        self.log.info("prune further than the indices best blocks while the indices are disabled")
146        self.restart_without_indices()
147        self.generate(self.nodes[0], 1000)
148
149        for i in range(3):
150            pruneheight_3 = self.nodes[i].pruneblockchain(2000)
151            assert_greater_than(pruneheight_3, pruneheight_2)
152            self.stop_node(i)
153
154        self.log.info("make sure we get an init error when starting the nodes again with the indices")
155        filter_msg = "Error: basic block filter index best block of the index goes beyond pruned data (including undo data). Please disable the index or reindex (which will download the whole blockchain again)"
156        stats_msg = "Error: coinstatsindex best block of the index goes beyond pruned data (including undo data). Please disable the index or reindex (which will download the whole blockchain again)"
157        end_msg = f"{os.linesep}Error: A fatal internal error occurred, see debug.log for details: Failed to start indexes, shutting down…"
158        for i, msg in enumerate([filter_msg, stats_msg, filter_msg]):
159            self.nodes[i].assert_start_raises_init_error(extra_args=self.extra_args[i], expected_msg=msg+end_msg)
160
161        self.log.info("fetching the missing blocks with getblockfrompeer doesn't work for block filter index and coinstatsindex")
162        # Only checking the first two nodes since this test takes a long time
163        # and the third node is kind of redundant in this context
164        for i, msg in enumerate([filter_msg, stats_msg]):
165            self.restart_node(i, extra_args=["-prune=1", "-fastprune"])
166            node = self.nodes[i]
167            prune_height = node.getblockchaininfo()["pruneheight"]
168            self.connect_nodes(i, 3)
169            peers = node.getpeerinfo()
170            assert_equal(len(peers), 1)
171            peer_id = peers[0]["id"]
172
173            # 1500 is the height to where the indices were able to sync previously
174            hashes = send_batch_request(node, "getblockhash", [[a] for a in range(1500, prune_height)])
175            send_batch_request(node, "getblockfrompeer", [[bh, peer_id] for bh in hashes])
176            # Ensure all necessary blocks have been fetched before proceeding
177            for bh in hashes:
178                self.wait_until(lambda: self.check_for_block(i, bh), timeout=10)
179
180            # Upon restart we expect the same errors as previously although all
181            # necessary blocks have been fetched. Both indices need the undo
182            # data of the blocks to be available as well and getblockfrompeer
183            # can not provide that.
184            self.stop_node(i)
185            node.assert_start_raises_init_error(extra_args=self.extra_args[i], expected_msg=msg+end_msg)
186
187        self.log.info("make sure the nodes start again with the indices and an additional -reindex arg")
188        for i in range(3):
189            restart_args = self.extra_args[i] + ["-reindex"]
190            self.restart_node(i, extra_args=restart_args)
191
192        self.linear_sync(self.nodes[3])
193        self.sync_index(height=2500)
194
195        for node in self.nodes[:2]:
196            with node.assert_debug_log(['limited pruning to height 2489']):
197                pruneheight_new = node.pruneblockchain(2500)
198                assert_equal(pruneheight_new, 2013)
199
200        self.log.info("ensure that prune locks don't prevent indices from failing in a reorg scenario")
201        with self.nodes[0].assert_debug_log(['basic block filter index prune lock moved back to 2480']):
202            self.nodes[3].invalidateblock(self.nodes[0].getblockhash(2480))
203            self.generate(self.nodes[3], 30, sync_fun=lambda: self.linear_sync(self.nodes[3], height_from=2480))
204
205
206if __name__ == '__main__':
207    FeatureIndexPruneTest(__file__).main()
208

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.