#!/usr/bin/env python3 # Copyright (c) 2016-2022 The Bitcoin Core developers # Distributed under the MIT software license, see the accompanying # file COPYING or http://www.opensource.org/licenses/mit-license.php. """Test version bits warning system. Generate chains with block versions that appear to be signalling unknown soft-forks, and test that warning alerts are generated. """ import os import re from test_framework.blocktools import create_block, create_coinbase from test_framework.messages import msg_block from test_framework.p2p import P2PInterface from test_framework.test_framework import BitcoinTestFramework VB_PERIOD = 144 # versionbits period length for regtest VB_THRESHOLD = 108 # versionbits activation threshold for regtest VB_TOP_BITS = 0x20000000 VB_UNKNOWN_BIT = 12 # Choose a bit unassigned to any deployment VB_UNKNOWN_VERSION = VB_TOP_BITS | (1 << VB_UNKNOWN_BIT) VB_BIP320_BIT = 13 VB_BIP320_VERSION = VB_TOP_BITS | (1 << VB_BIP320_BIT) VB_BIP320_THRESHOLD = 76 UNKNOWN_VERSION_SCHEMA = 0x60000000 UNKNOWN_VERSION_SCHEMA_THRESHOLD = 51 WARN_UNKNOWN_RULES_MINED = "Warning: Unrecognised block version (0x%08x) is being mined! Unknown rules may or may not be in effect" % (UNKNOWN_VERSION_SCHEMA,) WARN_UNKNOWN_BIT_MINED = f"Warning: Miners are attempting to activate unknown new rules (bit {VB_UNKNOWN_BIT})" # NOTE: WARN_BIP320_BIT_MINED includes VB_UNKNOWN_BIT because it persists from the earlier check WARN_BIP320_BIT_MINED = f"Warning: Miners are attempting to activate unknown new rules (bit {VB_UNKNOWN_BIT}, {VB_BIP320_BIT})" WARN_UNKNOWN_RULES_ACTIVE = f"Unknown new rules activated (versionbit {VB_UNKNOWN_BIT})" WARN_BIP320_BLOCK = "Miner violated version bit protocol" VB_PATTERN = re.compile("Unknown new rules activated.*versionbit") class VersionBitsWarningTest(BitcoinTestFramework): def set_test_params(self): self.setup_clean_chain = True self.num_nodes = 1 def setup_network(self): self.alert_filename = os.path.join(self.options.tmpdir, "alert.txt") # Open and close to create zero-length file with open(self.alert_filename, 'w', encoding='utf8'): pass self.extra_args = [[f"-alertnotify=echo %s >> \"{self.alert_filename}\""]] self.setup_nodes() def send_blocks_with_version(self, peer, numblocks, version): """Send numblocks blocks to peer with version set""" tip = self.nodes[0].getbestblockhash() height = self.nodes[0].getblockcount() block_time = self.nodes[0].getblockheader(tip)["time"] + 1 tip = int(tip, 16) for _ in range(numblocks): block = create_block(tip, create_coinbase(height + 1), block_time, version=version) block.solve() peer.send_message(msg_block(block)) block_time += 1 height += 1 tip = block.sha256 peer.sync_with_ping() def versionbits_in_alert_file(self): """Test that the versionbits warning has been written to the alert file.""" with open(self.alert_filename, 'r', encoding='utf8') as f: alert_text = f.read() return VB_PATTERN.search(alert_text) is not None def run_test(self): node = self.nodes[0] peer = node.add_p2p_connection(P2PInterface()) node_deterministic_address = node.get_deterministic_priv_key().address # Mine one period worth of blocks self.generatetoaddress(node, VB_PERIOD, node_deterministic_address) self.log.info("Check that there is no warning if previous VB_BLOCKS have 50 blocks in the last 100 were an unknown version schema") # Build UNKNOWN_VERSION_SCHEMA_THRESHOLD blocks signaling some unknown schema self.send_blocks_with_version(peer, UNKNOWN_VERSION_SCHEMA_THRESHOLD, UNKNOWN_VERSION_SCHEMA) # Check that get*info() shows the 51/100 unknown block version warning assert(WARN_UNKNOWN_RULES_MINED in ",".join(node.getmininginfo()["warnings"])) assert(WARN_UNKNOWN_RULES_MINED in ",".join(node.getnetworkinfo()["warnings"])) # Close the period normally self.generatetoaddress(node, VB_PERIOD - UNKNOWN_VERSION_SCHEMA_THRESHOLD, node_deterministic_address) # Make sure the warning remains assert(WARN_UNKNOWN_RULES_MINED in ",".join(node.getmininginfo()["warnings"])) assert(WARN_UNKNOWN_RULES_MINED in ",".join(node.getnetworkinfo()["warnings"])) # Stop-start the node, and make sure the warning is gone self.restart_node(0) assert(WARN_UNKNOWN_RULES_MINED not in ",".join(node.getmininginfo()["warnings"])) assert(WARN_UNKNOWN_RULES_MINED not in ",".join(node.getnetworkinfo()["warnings"])) peer = node.add_p2p_connection(P2PInterface()) self.log.info("Check that there is a warning if >50 blocks in the last 100 were an unknown version") # Build one period of blocks with VB_THRESHOLD blocks signaling some unknown bit self.send_blocks_with_version(peer, VB_THRESHOLD, VB_UNKNOWN_VERSION) self.generatetoaddress(node, VB_PERIOD - VB_THRESHOLD, node_deterministic_address) # Check that get*info() shows the 51/100 unknown block version warning assert(WARN_UNKNOWN_BIT_MINED in ",".join(node.getmininginfo()["warnings"])) assert(WARN_UNKNOWN_BIT_MINED in ",".join(node.getnetworkinfo()["warnings"])) self.log.info("Check that there is a warning if BIP320 is used, and a second persistent warning if >75 blocks in the last 100 were a BIP320 version") with node.busy_wait_for_debug_log([WARN_BIP320_BLOCK.encode('ascii')]): self.send_blocks_with_version(peer, VB_BIP320_THRESHOLD - 1, VB_BIP320_VERSION) # Check that get*info() doesn't shows the 76/100 unknown block version warning yet. assert(WARN_BIP320_BIT_MINED not in ",".join(node.getmininginfo()["warnings"])) assert(WARN_BIP320_BIT_MINED not in ",".join(node.getnetworkinfo()["warnings"])) # ...and it shouldn't show the BIP320-specific warning assert(WARN_BIP320_BLOCK not in node.getmininginfo()["warnings"]) assert(WARN_BIP320_BLOCK not in node.getnetworkinfo()["warnings"]) with node.busy_wait_for_debug_log([WARN_BIP320_BLOCK.encode('ascii'), b'Enqueuing UpdatedBlockTip']): self.send_blocks_with_version(peer, 1, VB_BIP320_VERSION) # Check that get*info() shows the 76/100 unknown block version warning. assert(WARN_BIP320_BIT_MINED in ",".join(node.getmininginfo()["warnings"])) assert(WARN_BIP320_BIT_MINED in ",".join(node.getnetworkinfo()["warnings"])) assert(WARN_BIP320_BLOCK not in node.getmininginfo()["warnings"]) assert(WARN_BIP320_BLOCK not in node.getnetworkinfo()["warnings"]) with node.busy_wait_for_debug_log([b'Enqueuing UpdatedBlockTip'], forbid_msgs=[WARN_BIP320_BLOCK.encode('ascii')]): self.generatetoaddress(node, 1, node_deterministic_address) # Only the 76/100 should persist assert(WARN_BIP320_BIT_MINED in ",".join(node.getmininginfo()["warnings"])) assert(WARN_BIP320_BIT_MINED in ",".join(node.getnetworkinfo()["warnings"])) assert(WARN_BIP320_BLOCK not in node.getmininginfo()["warnings"]) assert(WARN_BIP320_BLOCK not in node.getnetworkinfo()["warnings"]) self.generatetoaddress(node, VB_PERIOD - VB_BIP320_THRESHOLD - 1, node_deterministic_address) self.log.info("Check that there is a warning if previous VB_BLOCKS have >=VB_THRESHOLD blocks with unknown versionbits version.") # Mine a period worth of expected blocks so the generic block-version warning # is cleared. This will move the versionbit state to ACTIVE. self.generatetoaddress(node, VB_PERIOD, node_deterministic_address) # Stop-start the node. This is required because bitcoind will only warn once about unknown versions or unknown rules activating. self.restart_node(0) # Generating one block guarantees that we'll get out of IBD self.generatetoaddress(node, 1, node_deterministic_address) self.wait_until(lambda: not node.getblockchaininfo()['initialblockdownload']) # Generating one more block will be enough to generate an error. self.generatetoaddress(node, 1, node_deterministic_address) # Check that get*info() shows the versionbits unknown rules warning assert WARN_UNKNOWN_RULES_ACTIVE in ",".join(node.getmininginfo()["warnings"]) assert WARN_UNKNOWN_RULES_ACTIVE in ",".join(node.getnetworkinfo()["warnings"]) # Check that the alert file shows the versionbits unknown rules warning self.wait_until(lambda: self.versionbits_in_alert_file()) if __name__ == '__main__': VersionBitsWarningTest(__file__).main()