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.

34,957 bytes · SHA-256 1d44e6dd32df2091… · View upstream ↗

1#!/usr/bin/env python3
2# Copyright (c) 2014-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 RPCs related to blockchainstate.
6
7Test the following RPCs:
8    - getblockchaininfo
9    - getdeploymentinfo
10    - getchaintxstats
11    - gettxoutsetinfo
12    - gettxout
13    - getblockheader
14    - getdifficulty
15    - getnetworkhashps
16    - waitforblockheight
17    - getblock
18    - getblockhash
19    - getbestblockhash
20    - verifychain
21
22Tests correspond to code in rpc/blockchain.cpp.
23"""
24
25from decimal import Decimal
26import http.client
27import os
28import subprocess
29import textwrap
30
31from test_framework.blocktools import (
32    MAX_FUTURE_BLOCK_TIME,
33    TIME_GENESIS_BLOCK,
34    REGTEST_N_BITS,
35    REGTEST_TARGET,
36    create_block,
37    create_coinbase,
38    create_tx_with_script,
39    nbits_str,
40    target_str,
41)
42from test_framework.messages import (
43    CBlockHeader,
44    COIN,
45    from_hex,
46    msg_block,
47)
48from test_framework.p2p import P2PInterface
49from test_framework.script import hash256, OP_TRUE
50from test_framework.test_framework import BitcoinTestFramework
51from test_framework.util import (
52    assert_not_equal,
53    assert_equal,
54    assert_greater_than,
55    assert_greater_than_or_equal,
56    assert_raises,
57    assert_raises_rpc_error,
58    assert_is_hex_string,
59    assert_is_hash_string,
60)
61from test_framework.wallet import MiniWallet
62
63
64HEIGHT = 200  # blocks mined
65TIME_RANGE_STEP = 600  # ten-minute steps
66TIME_RANGE_MTP = TIME_GENESIS_BLOCK + (HEIGHT - 6) * TIME_RANGE_STEP
67TIME_RANGE_TIP = TIME_GENESIS_BLOCK + (HEIGHT - 1) * TIME_RANGE_STEP
68TIME_RANGE_END = TIME_GENESIS_BLOCK + HEIGHT * TIME_RANGE_STEP
69DIFFICULTY_ADJUSTMENT_INTERVAL = 144
70
71
72class BlockchainTest(BitcoinTestFramework):
73    def set_test_params(self):
74        self.setup_clean_chain = True
75        self.num_nodes = 1
76        self.supports_cli = False
77
78    def run_test(self):
79        self.wallet = MiniWallet(self.nodes[0])
80        self._test_prune_disk_space()
81        self.mine_chain()
82        self._test_max_future_block_time()
83        self.restart_node(
84            0,
85            extra_args=[
86                "-stopatheight=207",
87                "-checkblocks=-1",  # Check all blocks
88                "-prune=1",  # Set pruning after rescan is complete
89            ],
90        )
91
92        self._test_getblockchaininfo()
93        self._test_getchaintxstats()
94        self._test_gettxoutsetinfo()
95        self._test_gettxout()
96        self._test_getblockheader()
97        self._test_getdifficulty()
98        self._test_getnetworkhashps()
99        self._test_stopatheight()
100        self._test_waitforblock() # also tests waitfornewblock
101        self._test_waitforblockheight()
102        self._test_getblock()
103        self._test_getdeploymentinfo()
104        self._test_verificationprogress()
105        self._test_y2106()
106        assert self.nodes[0].verifychain(4, 0)
107
108    def mine_chain(self):
109        self.log.info(f"Generate {HEIGHT} blocks after the genesis block in ten-minute steps")
110        for t in range(TIME_GENESIS_BLOCK, TIME_RANGE_END, TIME_RANGE_STEP):
111            self.nodes[0].setmocktime(t)
112            self.generate(self.wallet, 1)
113        assert_equal(self.nodes[0].getblockchaininfo()['blocks'], HEIGHT)
114
115    def _test_prune_disk_space(self):
116        self.log.info("Test that a manually pruned node does not run into "
117                      "integer overflow on first start up")
118        self.restart_node(0, extra_args=["-prune=1"])
119        self.log.info("Avoid warning when assumed chain size is enough")
120        self.restart_node(0, extra_args=["-prune=123456789"])
121
122    def _test_max_future_block_time(self):
123        self.stop_node(0)
124        self.log.info("A block tip of more than MAX_FUTURE_BLOCK_TIME in the future raises an error")
125        self.nodes[0].assert_start_raises_init_error(
126            extra_args=[f"-mocktime={TIME_RANGE_TIP - MAX_FUTURE_BLOCK_TIME - 1}"],
127            expected_msg="The block database contains a block which appears to be from the future."
128            " This may be due to your computer's date and time being set incorrectly."
129            f" Only rebuild the block database if you are sure that your computer's date and time are correct.{os.linesep}"
130            "Please restart with -reindex or -reindex-chainstate to recover.",
131        )
132        self.log.info("A block tip of MAX_FUTURE_BLOCK_TIME in the future is fine")
133        self.start_node(0, extra_args=[f"-mocktime={TIME_RANGE_TIP - MAX_FUTURE_BLOCK_TIME}"])
134
135    def _test_getblockchaininfo(self):
136        self.log.info("Test getblockchaininfo")
137
138        keys = [
139            'bestblockhash',
140            'bits',
141            'blocks',
142            'chain',
143            'chainwork',
144            'difficulty',
145            'headers',
146            'initialblockdownload',
147            'mediantime',
148            'pruned',
149            'size_on_disk',
150            'target',
151            'time',
152            'verificationprogress',
153            'warnings',
154        ]
155        res = self.nodes[0].getblockchaininfo()
156
157        assert_equal(res['time'], TIME_RANGE_END - TIME_RANGE_STEP)
158        assert_equal(res['mediantime'], TIME_RANGE_MTP)
159
160        # result should have these additional pruning keys if manual pruning is enabled
161        assert_equal(sorted(res.keys()), sorted(['pruneheight', 'automatic_pruning'] + keys))
162
163        # size_on_disk should be > 0
164        assert_greater_than(res['size_on_disk'], 0)
165
166        # pruneheight should be greater or equal to 0
167        assert_greater_than_or_equal(res['pruneheight'], 0)
168
169        # check other pruning fields given that prune=1
170        assert res['pruned']
171        assert not res['automatic_pruning']
172
173        # check background validation is not present when we are not using assumeutxo
174        assert "backgroundvalidation" not in res.keys()
175
176        self.restart_node(0, ['-stopatheight=207'])
177        res = self.nodes[0].getblockchaininfo()
178        # should have exact keys
179        assert_equal(sorted(res.keys()), keys)
180
181        self.stop_node(0)
182        self.nodes[0].assert_start_raises_init_error(
183            extra_args=['-testactivationheight=name@2'],
184            expected_msg='Error: Invalid name (name@2) for -testactivationheight=name@height.',
185        )
186        self.nodes[0].assert_start_raises_init_error(
187            extra_args=['-testactivationheight=bip34@-2'],
188            expected_msg='Error: Invalid height value (bip34@-2) for -testactivationheight=name@height.',
189        )
190        self.nodes[0].assert_start_raises_init_error(
191            extra_args=['-testactivationheight='],
192            expected_msg='Error: Invalid format () for -testactivationheight=name@height.',
193        )
194        self.start_node(0, extra_args=[
195            '-stopatheight=207',
196            '-prune=550',
197        ])
198
199        res = self.nodes[0].getblockchaininfo()
200        # result should have these additional pruning keys if prune=550
201        assert_equal(sorted(res.keys()), sorted(['pruneheight', 'automatic_pruning', 'prune_target_size'] + keys))
202
203        # check related fields
204        assert res['pruned']
205        assert_equal(res['pruneheight'], 0)
206        assert res['automatic_pruning']
207        assert_equal(res['prune_target_size'], 576716800)
208        assert_greater_than(res['size_on_disk'], 0)
209
210        assert_equal(res['bits'], nbits_str(REGTEST_N_BITS))
211        assert_equal(res['target'], target_str(REGTEST_TARGET))
212
213    def check_signalling_deploymentinfo_result(self, gdi_result, height, blockhash, status_next):
214        assert height >= 144 and height <= 287
215
216        assert_equal(gdi_result, {
217          "hash": blockhash,
218          "height": height,
219          "script_flags": ["CHECKLOCKTIMEVERIFY","CHECKSEQUENCEVERIFY","DERSIG","NULLDUMMY","P2SH","TAPROOT","WITNESS"],
220          "deployments": {
221            'bip34': {'type': 'buried', 'active': True, 'height': 2},
222            'bip66': {'type': 'buried', 'active': True, 'height': 3},
223            'bip65': {'type': 'buried', 'active': True, 'height': 4},
224            'csv': {'type': 'buried', 'active': True, 'height': 5},
225            'segwit': {'type': 'buried', 'active': True, 'height': 6},
226            'testdummy': {
227                'type': 'bip9',
228                'bip9': {
229                    'bit': 28,
230                    'start_time': 0,
231                    'timeout': 0x7fffffffffffffff,  # testdummy does not have a timeout so is set to the max int64 value
232                    'min_activation_height': 0,
233                    'status': 'started',
234                    'status_next': status_next,
235                    'since': 144,
236                    'statistics': {
237                        'period': 144,
238                        'threshold': 108,
239                        'elapsed': height - 143,
240                        'count': height - 143,
241                        'possible': True,
242                    },
243                    'signalling': '#'*(height-143),
244                },
245                'active': False
246            },
247          }
248        })
249
250    def _test_getdeploymentinfo(self):

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.