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.

14,105 bytes · SHA-256 8fd69cb6c1b0e8ef… · 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 coinstatsindex across nodes.
6
7Test that the values returned by gettxoutsetinfo are consistent
8between a node running the coinstatsindex and a node without
9the index.
10"""
11
12from decimal import Decimal
13
14from test_framework.blocktools import (
15    COINBASE_MATURITY,
16    create_block,
17    create_coinbase,
18)
19from test_framework.messages import (
20    COIN,
21    CTxOut,
22)
23from test_framework.script import (
24    CScript,
25    OP_FALSE,
26    OP_RETURN,
27)
28from test_framework.test_framework import BitcoinTestFramework
29from test_framework.util import (
30    assert_not_equal,
31    assert_equal,
32    assert_raises_rpc_error,
33)
34from test_framework.wallet import (
35    MiniWallet,
36    getnewdestination,
37)
38
39
40class CoinStatsIndexTest(BitcoinTestFramework):
41    def set_test_params(self):
42        self.setup_clean_chain = True
43        self.num_nodes = 2
44        self.extra_args = [
45            [],
46            ["-coinstatsindex"]
47        ]
48
49    def run_test(self):
50        self.wallet = MiniWallet(self.nodes[0])
51        self._test_coin_stats_index()
52        self._test_use_index_option()
53        self._test_reorg_index()
54        self._test_index_rejects_hash_serialized()
55        self._test_init_index_after_reorg()
56
57    def block_sanity_check(self, block_info):
58        block_subsidy = 50
59        assert_equal(
60            block_info['prevout_spent'] + block_subsidy,
61            block_info['new_outputs_ex_coinbase'] + block_info['coinbase'] + block_info['unspendable']
62        )
63
64    def sync_index_node(self):
65        self.wait_until(lambda: self.nodes[1].getindexinfo()['coinstatsindex']['synced'] is True)
66
67    def _test_coin_stats_index(self):
68        node = self.nodes[0]
69        index_node = self.nodes[1]
70        # Both none and muhash options allow the usage of the index
71        index_hash_options = ['none', 'muhash']
72
73        # Generate a normal transaction and mine it
74        self.generate(self.wallet, COINBASE_MATURITY + 1)
75        self.wallet.send_self_transfer(from_node=node)
76        self.generate(node, 1)
77
78        self.log.info("Test that gettxoutsetinfo() output is consistent with or without coinstatsindex option")
79        res0 = node.gettxoutsetinfo('none')
80
81        # The fields 'disk_size' and 'transactions' do not exist on the index
82        del res0['disk_size'], res0['transactions']
83
84        for hash_option in index_hash_options:
85            res1 = index_node.gettxoutsetinfo(hash_option)
86            # The fields 'block_info' and 'total_unspendable_amount' only exist on the index
87            del res1['block_info'], res1['total_unspendable_amount']
88            res1.pop('muhash', None)
89
90            # Everything left should be the same
91            assert_equal(res1, res0)
92
93        self.log.info("Test that gettxoutsetinfo() can get fetch data on specific heights with index")
94
95        # Generate a new tip
96        self.generate(node, 5)
97
98        for hash_option in index_hash_options:
99            # Fetch old stats by height
100            res2 = index_node.gettxoutsetinfo(hash_option, 102)
101            del res2['block_info'], res2['total_unspendable_amount']
102            res2.pop('muhash', None)
103            assert_equal(res0, res2)
104
105            # Fetch old stats by hash
106            res3 = index_node.gettxoutsetinfo(hash_option, res0['bestblock'])
107            del res3['block_info'], res3['total_unspendable_amount']
108            res3.pop('muhash', None)
109            assert_equal(res0, res3)
110
111            # It does not work without coinstatsindex
112            assert_raises_rpc_error(-8, "Querying specific block heights requires coinstatsindex", node.gettxoutsetinfo, hash_option, 102)
113
114        self.log.info("Test gettxoutsetinfo() with index and verbose flag")
115
116        for hash_option in index_hash_options:
117            # Genesis block is unspendable
118            res4 = index_node.gettxoutsetinfo(hash_option, 0)
119            assert_equal(res4['total_unspendable_amount'], 50)
120            assert_equal(res4['block_info'], {
121                'unspendable': 50,
122                'prevout_spent': 0,
123                'new_outputs_ex_coinbase': 0,
124                'coinbase': 0,
125                'unspendables': {
126                    'genesis_block': 50,
127                    'bip30': 0,
128                    'scripts': 0,
129                    'unclaimed_rewards': 0
130                }
131            })
132            self.block_sanity_check(res4['block_info'])
133
134            # Test an older block height that included a normal tx
135            res5 = index_node.gettxoutsetinfo(hash_option, 102)
136            assert_equal(res5['total_unspendable_amount'], 50)
137            assert_equal(res5['block_info'], {
138                'unspendable': 0,
139                'prevout_spent': 50,
140                'new_outputs_ex_coinbase': Decimal('49.99968800'),
141                'coinbase': Decimal('50.00031200'),
142                'unspendables': {
143                    'genesis_block': 0,
144                    'bip30': 0,
145                    'scripts': 0,
146                    'unclaimed_rewards': 0,
147                }
148            })
149            self.block_sanity_check(res5['block_info'])
150
151        # Generate and send a normal tx with two outputs
152        tx1 = self.wallet.send_to(
153            from_node=node,
154            scriptPubKey=self.wallet.get_output_script(),
155            amount=21 * COIN,
156        )
157
158        # Find the right position of the 21 BTC output
159        tx1_out_21 = self.wallet.get_utxo(txid=tx1["txid"], vout=tx1["sent_vout"])
160
161        # Generate and send another tx with an OP_RETURN output (which is unspendable)
162        tx2 = self.wallet.create_self_transfer(utxo_to_spend=tx1_out_21)['tx']
163        tx2_val = '20.99'
164        tx2.vout = [CTxOut(int(Decimal(tx2_val) * COIN), CScript([OP_RETURN] + [OP_FALSE] * 30))]
165        tx2_hex = tx2.serialize().hex()
166        self.nodes[0].sendrawtransaction(tx2_hex, 0, tx2_val)
167
168        # Include both txs in a block
169        self.generate(self.nodes[0], 1)
170
171        for hash_option in index_hash_options:
172            # Check all amounts were registered correctly
173            res6 = index_node.gettxoutsetinfo(hash_option, 108)
174            assert_equal(res6['total_unspendable_amount'], Decimal('70.99000000'))
175            assert_equal(res6['block_info'], {
176                'unspendable': Decimal('20.99000000'),
177                'prevout_spent': 71,
178                'new_outputs_ex_coinbase': Decimal('49.99999000'),
179                'coinbase': Decimal('50.01001000'),
180                'unspendables': {
181                    'genesis_block': 0,
182                    'bip30': 0,
183                    'scripts': Decimal('20.99000000'),
184                    'unclaimed_rewards': 0,
185                }
186            })
187            self.block_sanity_check(res6['block_info'])
188
189        # Create a coinbase that does not claim full subsidy and also
190        # has two outputs
191        cb = create_coinbase(109, nValue=35)
192        cb.vout.append(CTxOut(5 * COIN, CScript([OP_FALSE])))
193
194        # Generate a block that includes previous coinbase
195        tip = self.nodes[0].getbestblockhash()
196        block_time = self.nodes[0].getblock(tip)['time'] + 1
197        block = create_block(int(tip, 16), cb, ntime=block_time)
198        block.solve()
199        self.nodes[0].submitblock(block.serialize().hex())
200        self.sync_all()
201
202        for hash_option in index_hash_options:
203            res7 = index_node.gettxoutsetinfo(hash_option, 109)
204            assert_equal(res7['total_unspendable_amount'], Decimal('80.99000000'))
205            assert_equal(res7['block_info'], {
206                'unspendable': 10,
207                'prevout_spent': 0,
208                'new_outputs_ex_coinbase': 0,
209                'coinbase': 40,
210                'unspendables': {
211                    'genesis_block': 0,
212                    'bip30': 0,
213                    'scripts': 0,
214                    'unclaimed_rewards': 10
215                }
216            })
217            self.block_sanity_check(res7['block_info'])
218
219        self.log.info("Test that the index is robust across restarts")
220
221        res8 = index_node.gettxoutsetinfo('muhash')
222        self.restart_node(1, extra_args=self.extra_args[1])
223        res9 = index_node.gettxoutsetinfo('muhash')
224        assert_equal(res8, res9)
225
226        self.generate(index_node, 1, sync_fun=self.no_op)
227        res10 = index_node.gettxoutsetinfo('muhash')
228        assert res8['txouts'] < res10['txouts']
229
230        self.log.info("Test that the index works with -reindex")
231
232        self.restart_node(1, extra_args=["-coinstatsindex", "-reindex"])
233        self.sync_index_node()
234        res11 = index_node.gettxoutsetinfo('muhash')
235        assert_equal(res11, res10)
236
237        self.log.info("Test that the index works with -reindex-chainstate")
238
239        self.restart_node(1, extra_args=["-coinstatsindex", "-reindex-chainstate"])
240        self.sync_index_node()
241        res12 = index_node.gettxoutsetinfo('muhash')
242        assert_equal(res12, res10)
243
244        self.log.info("Test obtaining info for a non-existent block hash")
245        assert_raises_rpc_error(-5, "Block not found", index_node.gettxoutsetinfo, hash_type="none", hash_or_height="ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff", use_index=True)
246
247    def _test_use_index_option(self):
248        self.log.info("Test use_index option for nodes running the index")
249
250        self.connect_nodes(0, 1)

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.