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.

6,065 bytes · SHA-256 6cb566416642d0c0… · View upstream ↗

1#!/usr/bin/env python3
2# Copyright (c) 2016-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 version bits warning system.
6
7Generate chains with block versions that appear to be signalling unknown
8soft-forks, and test that warning alerts are generated.
9"""
10import os
11import re
12
13from test_framework.blocktools import create_block
14from test_framework.messages import msg_block
15from test_framework.p2p import P2PInterface
16from test_framework.test_framework import BitcoinTestFramework
17
18VB_PERIOD = 144           # versionbits period length for regtest
19VB_THRESHOLD = 108        # versionbits activation threshold for regtest
20VB_TOP_BITS = 0x20000000
21
22# Choose a bit unassigned to any deployment, or start the
23# node with the deployment matching this bit disabled.
24VB_UNKNOWN_BIT = 3
25VB_UNKNOWN_VERSION = VB_TOP_BITS | (1 << VB_UNKNOWN_BIT)
26VB_IGNORED_BIT = 5
27VB_IGNORED_VERSION = VB_TOP_BITS | (1 << VB_IGNORED_BIT)
28
29WARN_UNKNOWN_RULES_ACTIVE = f"Unknown new rules activated (versionbit {VB_UNKNOWN_BIT})"
30VB_PATTERN = re.compile("Unknown new rules activated.*versionbit")
31
32class VersionBitsWarningTest(BitcoinTestFramework):
33    def set_test_params(self):
34        self.setup_clean_chain = True
35        self.num_nodes = 1
36
37    def setup_network(self):
38        self.alert_filename = os.path.join(self.options.tmpdir, "alert.txt")
39        # Open and close to create zero-length file
40        with open(self.alert_filename, 'w'):
41            pass
42        self.extra_args = [[f"-alertnotify=echo %s >> \"{self.alert_filename}\""]]
43        self.setup_nodes()
44
45    def send_blocks_with_version(self, peer, numblocks, version):
46        """Send numblocks blocks to peer with version set"""
47        tip = self.nodes[0].getbestblockhash()
48        height = self.nodes[0].getblockcount()
49        block_time = self.nodes[0].getblockheader(tip)["time"] + 1
50        tip = int(tip, 16)
51
52        for _ in range(numblocks):
53            block = create_block(tip, height=height + 1, ntime=block_time, version=version)
54            block.solve()
55            peer.send_without_ping(msg_block(block))
56            block_time += 1
57            height += 1
58            tip = block.hash_int
59        peer.sync_with_ping()
60
61    def versionbits_in_alert_file(self):
62        """Test that the versionbits warning has been written to the alert file."""
63        with open(self.alert_filename, 'r') as f:
64            alert_text = f.read()
65        return VB_PATTERN.search(alert_text) is not None
66
67    def run_test(self):
68        node = self.nodes[0]
69        peer = node.add_p2p_connection(P2PInterface())
70
71        node_deterministic_address = node.get_deterministic_priv_key().address
72        # Mine one period worth of blocks
73        self.generatetoaddress(node, VB_PERIOD, node_deterministic_address)
74
75        self.log.info("Check that there is no warning if previous VB_BLOCKS have <VB_THRESHOLD blocks with unknown versionbits version.")
76        # Build one period of blocks with < VB_THRESHOLD blocks signaling some unknown bit
77        self.send_blocks_with_version(peer, VB_THRESHOLD - 1, VB_UNKNOWN_VERSION)
78        self.generatetoaddress(node, VB_PERIOD - VB_THRESHOLD + 1, node_deterministic_address)
79
80        # Check that we're not getting any versionbit-related errors in get*info()
81        assert not VB_PATTERN.match(",".join(node.getmininginfo()["warnings"]))
82        assert not VB_PATTERN.match(",".join(node.getnetworkinfo()["warnings"]))
83
84        self.log.info("Check that there is no warning if previous VB_BLOCKS have VB_PERIOD blocks with ignored versionbits version.")
85        # Build one period of blocks with VB_THRESHOLD blocks signaling some unknown bit
86        self.send_blocks_with_version(peer, VB_THRESHOLD, VB_IGNORED_VERSION)
87        self.generatetoaddress(node, VB_PERIOD - VB_THRESHOLD, node_deterministic_address)
88
89        # Move the ignored deployment state to ACTIVE and make sure we're out of IBD.
90        self.generatetoaddress(node, VB_PERIOD, node_deterministic_address)
91        self.wait_until(lambda: not node.getblockchaininfo()['initialblockdownload'])
92
93        # Check that we're not getting any versionbit-related warnings in get*info()
94        assert not VB_PATTERN.match(", ".join(node.getmininginfo()["warnings"]))
95        assert not VB_PATTERN.match(", ".join(node.getnetworkinfo()["warnings"]))
96
97        self.log.info("Check that there is a warning if previous VB_BLOCKS have >=VB_THRESHOLD blocks with unknown versionbits version.")
98        # Build one period of blocks with VB_THRESHOLD blocks signaling some unknown bit
99        self.send_blocks_with_version(peer, VB_THRESHOLD, VB_UNKNOWN_VERSION)
100        self.generatetoaddress(node, VB_PERIOD - VB_THRESHOLD, node_deterministic_address)
101
102        # Mine a period worth of expected blocks so the generic block-version warning
103        # is cleared. This will move the versionbit state to ACTIVE.
104        self.generatetoaddress(node, VB_PERIOD, node_deterministic_address)
105
106        # Stop-start the node. This is required because bitcoind will only warn once about unknown versions or unknown rules activating.
107        self.restart_node(0)
108
109        # Generating one block guarantees that we'll get out of IBD
110        self.generatetoaddress(node, 1, node_deterministic_address)
111        self.wait_until(lambda: not node.getblockchaininfo()['initialblockdownload'])
112        # Generating one more block will be enough to generate an error.
113        self.generatetoaddress(node, 1, node_deterministic_address)
114        # Check that get*info() shows the versionbits unknown rules warning
115        assert WARN_UNKNOWN_RULES_ACTIVE in ",".join(node.getmininginfo()["warnings"])
116        assert WARN_UNKNOWN_RULES_ACTIVE in ",".join(node.getnetworkinfo()["warnings"])
117        # Check that the alert file shows the versionbits unknown rules warning
118        self.wait_until(lambda: self.versionbits_in_alert_file())
119
120if __name__ == '__main__':
121    VersionBitsWarningTest(__file__).main()
122

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.