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.

7,567 bytes · SHA-256 6008337d7a8f9d58… · 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 the invalidateblock RPC."""
6
7from test_framework.test_framework import BitcoinTestFramework
8from test_framework.address import ADDRESS_BCRT1_UNSPENDABLE_DESCRIPTOR
9from test_framework.blocktools import (
10    create_block,
11)
12from test_framework.util import (
13    assert_equal,
14    assert_raises_rpc_error,
15)
16
17
18class InvalidateTest(BitcoinTestFramework):
19    def set_test_params(self):
20        self.setup_clean_chain = True
21        self.num_nodes = 3
22
23    def setup_network(self):
24        self.setup_nodes()
25
26    def run_test(self):
27        self.log.info("Make sure we repopulate setBlockIndexCandidates after InvalidateBlock:")
28        self.log.info("Mine 4 blocks on Node 0")
29        self.generate(self.nodes[0], 4, sync_fun=self.no_op)
30        assert_equal(self.nodes[0].getblockcount(), 4)
31        besthash_n0 = self.nodes[0].getbestblockhash()
32
33        self.log.info("Mine competing 6 blocks on Node 1")
34        self.generate(self.nodes[1], 6, sync_fun=self.no_op)
35        assert_equal(self.nodes[1].getblockcount(), 6)
36
37        self.log.info("Connect nodes to force a reorg")
38        self.connect_nodes(0, 1)
39        self.sync_blocks(self.nodes[0:2])
40        assert_equal(self.nodes[0].getblockcount(), 6)
41
42        # Add a header to the tip of node 0 without submitting the block. This shouldn't
43        # affect results since this chain will be invalidated next.
44        tip = self.nodes[0].getbestblockhash()
45        block_time = self.nodes[0].getblock(self.nodes[0].getbestblockhash())['time'] + 1
46        block = create_block(int(tip, 16), height=self.nodes[0].getblockcount(), ntime=block_time, version=4)
47        block.solve()
48        self.nodes[0].submitheader(block.serialize().hex())
49        assert_equal(self.nodes[0].getblockchaininfo()["headers"], self.nodes[0].getblockchaininfo()["blocks"] + 1)
50
51        self.log.info("Invalidate block 2 on node 0 and verify we reorg to node 0's original chain")
52        badhash = self.nodes[1].getblockhash(2)
53        self.nodes[0].invalidateblock(badhash)
54        assert_equal(self.nodes[0].getblockcount(), 4)
55        assert_equal(self.nodes[0].getbestblockhash(), besthash_n0)
56        # Should report consistent blockchain info
57        assert_equal(self.nodes[0].getblockchaininfo()["headers"], self.nodes[0].getblockchaininfo()["blocks"])
58
59        self.log.info("Reconsider block 6 on node 0 again and verify that the best header is set correctly")
60        self.nodes[0].reconsiderblock(tip)
61        assert_equal(self.nodes[0].getblockchaininfo()["headers"], self.nodes[0].getblockchaininfo()["blocks"] + 1)
62
63        self.log.info("Invalidate block 2 on node 0 and verify we reorg to node 0's original chain again")
64        self.nodes[0].invalidateblock(badhash)
65        assert_equal(self.nodes[0].getblockcount(), 4)
66        assert_equal(self.nodes[0].getbestblockhash(), besthash_n0)
67        assert_equal(self.nodes[0].getblockchaininfo()["headers"], self.nodes[0].getblockchaininfo()["blocks"])
68
69        self.log.info("Make sure we won't reorg to a lower work chain:")
70        self.connect_nodes(1, 2)
71        self.log.info("Sync node 2 to node 1 so both have 6 blocks")
72        self.sync_blocks(self.nodes[1:3])
73        assert_equal(self.nodes[2].getblockcount(), 6)
74        self.log.info("Invalidate block 5 on node 1 so its tip is now at 4")
75        self.nodes[1].invalidateblock(self.nodes[1].getblockhash(5))
76        assert_equal(self.nodes[1].getblockcount(), 4)
77        self.log.info("Invalidate block 3 on node 2, so its tip is now 2")
78        self.nodes[2].invalidateblock(self.nodes[2].getblockhash(3))
79        assert_equal(self.nodes[2].getblockcount(), 2)
80        self.log.info("..and then mine a block")
81        self.generate(self.nodes[2], 1, sync_fun=self.no_op)
82        self.log.info("Verify all nodes are at the right height")
83        self.wait_until(lambda: self.nodes[2].getblockcount() == 3, timeout=5)
84        self.wait_until(lambda: self.nodes[0].getblockcount() == 4, timeout=5)
85        self.wait_until(lambda: self.nodes[1].getblockcount() == 4, timeout=5)
86
87        self.log.info("Verify that ancestors can become chain tip candidates when we reconsider blocks")
88        # Invalidate node0's current chain (1' -> 2' -> 3' -> 4') so that we don't reorg back to it in this test
89        badhash = self.nodes[0].getblockhash(1)
90        self.nodes[0].invalidateblock(badhash)
91        # Reconsider the tip so that node0's chain becomes this chain again : 1 -> 2 -> 3 -> 4 -> 5 -> 6 -> header 7
92        self.nodes[0].reconsiderblock(tip)
93        blockhash_3 = self.nodes[0].getblockhash(3)
94        blockhash_4 = self.nodes[0].getblockhash(4)
95        blockhash_6 = self.nodes[0].getblockhash(6)
96        assert_equal(self.nodes[0].getbestblockhash(), blockhash_6)
97
98        # Invalidate block 4 so that chain becomes : 1 -> 2 -> 3
99        self.nodes[0].invalidateblock(blockhash_4)
100        assert_equal(self.nodes[0].getbestblockhash(), blockhash_3)
101        assert_equal(self.nodes[0].getblockchaininfo()['blocks'], 3)
102        assert_equal(self.nodes[0].getblockchaininfo()['headers'], 3)
103
104        # Reconsider the header
105        self.nodes[0].reconsiderblock(block.hash_hex)
106        # Since header doesn't have block data, it can't be chain tip
107        # Check if it's possible for an ancestor (with block data) to be the chain tip
108        assert_equal(self.nodes[0].getbestblockhash(), blockhash_6)
109        assert_equal(self.nodes[0].getblockchaininfo()['blocks'], 6)
110        assert_equal(self.nodes[0].getblockchaininfo()['headers'], 7)
111
112        self.log.info("Verify that we reconsider all ancestors as well")
113        blocks = self.generatetodescriptor(self.nodes[1], 10, ADDRESS_BCRT1_UNSPENDABLE_DESCRIPTOR, sync_fun=self.no_op)
114        assert_equal(self.nodes[1].getbestblockhash(), blocks[-1])
115        # Invalidate the two blocks at the tip
116        self.nodes[1].invalidateblock(blocks[-1])
117        self.nodes[1].invalidateblock(blocks[-2])
118        assert_equal(self.nodes[1].getbestblockhash(), blocks[-3])
119        # Reconsider only the previous tip
120        self.nodes[1].reconsiderblock(blocks[-1])
121        # Should be back at the tip by now
122        assert_equal(self.nodes[1].getbestblockhash(), blocks[-1])
123
124        self.log.info("Verify that we reconsider all descendants")
125        blocks = self.generatetodescriptor(self.nodes[1], 10, ADDRESS_BCRT1_UNSPENDABLE_DESCRIPTOR, sync_fun=self.no_op)
126        assert_equal(self.nodes[1].getbestblockhash(), blocks[-1])
127        # Invalidate the two blocks at the tip
128        self.nodes[1].invalidateblock(blocks[-2])
129        self.nodes[1].invalidateblock(blocks[-4])
130        assert_equal(self.nodes[1].getbestblockhash(), blocks[-5])
131        # Reconsider only the previous tip
132        self.nodes[1].reconsiderblock(blocks[-4])
133        # Should be back at the tip by now
134        assert_equal(self.nodes[1].getbestblockhash(), blocks[-1])
135        # Should report consistent blockchain info
136        assert_equal(self.nodes[1].getblockchaininfo()["headers"], self.nodes[1].getblockchaininfo()["blocks"])
137
138        self.log.info("Verify that invalidating an unknown block throws an error")
139        assert_raises_rpc_error(-5, "Block not found", self.nodes[1].invalidateblock, "00" * 32)
140        assert_equal(self.nodes[1].getbestblockhash(), blocks[-1])
141
142
143if __name__ == '__main__':
144    InvalidateTest(__file__).main()
145

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.