elements/test/functional/feature_blocksign.py
2026-07-10 12:11:21 +01:00

270 lines
11 KiB
Python
Executable file

#!/usr/bin/env python3
import codecs
from test_framework.test_framework import BitcoinTestFramework
from test_framework.util import (assert_raises_rpc_error, assert_equal)
from test_framework import (
address,
key,
)
from test_framework.messages import (
CBlock,
from_hex,
)
from test_framework.script import (
CScript
)
# Generate wallet import format from private key.
def wif(pk):
# Base58Check version for regtest WIF keys is 0xef = 239
pk_compressed = pk + bytes([0x1])
return address.byte_to_base58(pk_compressed, 239)
# The signblockscript is a Bitcoin Script k-of-n multisig script.
def make_signblockscript(num_nodes, required_signers, keys):
assert num_nodes >= required_signers
script = "{}".format(50 + required_signers)
for i in range(num_nodes):
k = keys[i]
script += "21"
script += codecs.encode(k.get_pubkey().get_bytes(), 'hex_codec').decode("utf-8")
script += "{}".format(50 + num_nodes) # num keys
script += "ae" # OP_CHECKMULTISIG
return script
class BlockSignTest(BitcoinTestFramework):
"""
Test signed-blockchain-related RPC calls and functionality:
- getnewblockhex
- signblock
- combineblocksigs
- submitblock
- testproposedblock
- getcompactsketch
- consumecompactsketch
- consumegetblocktxn
- finalizecompactblock
As well as syncing blocks over p2p
This test covers both pre-dynafed and post.
TODO: Show block max witness actually limits the witness
"""
def skip_test_if_missing_module(self):
self.skip_if_no_wallet()
def add_options(self, parser):
self.add_wallet_options(parser)
# Dynamically generate N keys to be used for block signing.
def init_keys(self, num_keys):
self.keys = []
self.wifs = []
for i in range(num_keys):
k = key.ECKey()
k.generate()
w = wif(k.get_bytes())
self.keys.append(k)
self.wifs.append(w)
def set_test_params(self):
self.num_nodes = 5
self.num_keys = 4
self.required_signers = 3
self.setup_clean_chain = True
self.init_keys(self.num_nodes-1) # Last node cannot sign and is connected to all via p2p
signblockscript = make_signblockscript(self.num_keys, self.required_signers, self.keys)
self.witnessScript = signblockscript # post-dynafed this becomes witnessScript
self.extra_args = [[
"-signblockscript={}".format(signblockscript),
"-con_max_block_sig_size={}".format(self.required_signers*74+self.num_nodes*33),
"-anyonecanspendaremine=1",
"-evbparams=dynafed:0:::",
"-con_dyna_deploy_signal=1",
]] * self.num_nodes
def setup_network(self):
self.setup_nodes()
# Connect non-signing node to a single signing one (to not pass blocks between signers)
self.connect_nodes(0, self.num_nodes-1)
def check_height(self, expected_height):
for n in self.nodes:
assert_equal(n.getblockcount(), expected_height)
def mine_block(self, make_transactions):
# mine block in round robin sense: depending on the block number, a node
# is selected to create the block, others sign it and the selected node
# broadcasts it
mineridx = self.nodes[0].getblockcount() % self.num_nodes # assuming in sync
mineridx_next = (self.nodes[0].getblockcount() + 1) % self.num_nodes
miner = self.nodes[mineridx]
miner_next = self.nodes[mineridx_next]
blockcount = miner.getblockcount()
# If dynafed is enabled, this means signblockscript has been WSH-wrapped
deployment_info = self.nodes[0].getdeploymentinfo()
is_dyna = deployment_info['deployments']['dynafed']['bip9']['status'] == "active"
if is_dyna:
wsh_wrap = self.nodes[0].decodescript(self.witnessScript)['segwit']['hex']
assert_equal(wsh_wrap, self.nodes[0].getblockchaininfo()['current_signblock_hex'])
# Make a few transactions to make non-empty blocks for compact transmission
if make_transactions:
for i in range(20):
miner.sendtoaddress(miner_next.getnewaddress(), int(miner.getbalance()['bitcoin']/10), "", "", True)
# miner makes a block
block = miner.getnewblockhex()
block_struct = from_hex(CBlock(), block)
# make another block with the commitment field filled out
dummy_block = miner.getnewblockhex(commit_data="deadbeef")
dummy_struct = from_hex(CBlock(), dummy_block)
assert_equal(len(dummy_struct.vtx[0].vout), len(block_struct.vtx[0].vout) + 1)
# OP_RETURN deadbeef
assert_equal(CScript(dummy_struct.vtx[0].vout[0].scriptPubKey).hex(), '6a04deadbeef')
# All nodes get compact blocks, first node may get complete
# block in 0.5 RTT even with transactions thanks to p2p connection
# with non-signing node being miner
for i in range(self.num_keys):
if i == mineridx:
continue
sketch = miner.getcompactsketch(block)
compact_response = self.nodes[i].consumecompactsketch(sketch)
if "block_tx_req" in compact_response:
block_txn = self.nodes[i].consumegetblocktxn(block, compact_response["block_tx_req"])
final_block = self.nodes[i].finalizecompactblock(sketch, block_txn, compact_response["found_transactions"])
else:
assert (mineridx == 4 and i == 0) or not make_transactions
# If there's only coinbase, it should succeed immediately
final_block = compact_response["blockhex"]
# Block should be complete, sans signatures
self.nodes[i].testproposedblock(final_block)
# non-signing node can not sign
assert_raises_rpc_error(-25, "Could not sign the block.", self.nodes[-1].signblock, block, self.witnessScript)
# collect num_keys signatures from signers, reduce to required_signers sigs during combine
sigs = []
for i in range(self.num_keys):
result = miner.combineblocksigs(block, sigs, self.witnessScript)
sigs = sigs + self.nodes[i].signblock(block, self.witnessScript)
assert_equal(result["complete"], i >= self.required_signers)
# submitting should have no effect pre-threshold
if i < self.required_signers:
miner.submitblock(result["hex"])
self.check_height(blockcount)
result = miner.combineblocksigs(block, sigs, self.witnessScript)
assert_equal(result["complete"], True)
# All signing nodes must submit... we're not connected!
self.nodes[0].submitblock(result["hex"])
early_proposal = self.nodes[0].getnewblockhex() # testproposedblock should reject
# Submit blocks to all other signing nodes next, as well as too-early block proposal
for i in range(1, self.num_keys):
assert_raises_rpc_error(-25, "proposal was not based on our best chain", self.nodes[i].testproposedblock, early_proposal)
self.nodes[i].submitblock(result["hex"])
# All nodes should be synced in blocks and transactions(mempool should be empty)
self.sync_all(expect_disconnected=True)
def mine_blocks(self, num_blocks, transactions):
for i in range(num_blocks):
self.mine_block(transactions)
def test_combineblocksigs_witnessscript_arg(self):
# Regression test for combineblocksigs witnessScript optionality.
node = self.nodes[0]
block = node.getnewblockhex()
is_dyna = node.getdeploymentinfo()['deployments']['dynafed']['bip9']['status'] == "active"
if is_dyna:
# no witnessScript must give RPC_INVALID_PARAMETER, not a help error from arg-count validation.
assert_raises_rpc_error(
-8,
"Signing dynamic blocks requires the witnessScript argument",
node.combineblocksigs,
block,
[],
)
# Supplying witnessScript must work normally.
result = node.combineblocksigs(block, [], self.witnessScript)
assert "hex" in result
assert "complete" in result
else:
# Non-dynafed: 2-argument call must not be rejected by arg-count validation.
try:
result = node.combineblocksigs(block, [])
assert "hex" in result
assert "complete" in result
except Exception as e:
# If exception it must not be the help string
assert "combineblocksigs" not in str(e), \
"Got help text — 2-arg call was rejected by arg-count validation"
raise
def run_test(self):
# Have every node except last import its block signing private key.
for i in range(self.num_keys):
self.nodes[i].importprivkey(self.wifs[i])
self.check_height(0)
# mine a block with no transactions
self.log.info("Mining and signing 101 blocks to unlock funds")
self.mine_blocks(101, False)
# mine blocks with transactions
self.log.info("Mining and signing non-empty blocks")
self.mine_blocks(10, True)
# Height check also makes sure non-signing, p2p connected node gets block
self.check_height(111)
# signblock rpc field stuff
tip = self.nodes[0].getblockhash(self.nodes[0].getblockcount())
header = self.nodes[0].getblockheader(tip)
block = self.nodes[0].getblock(tip)
info = self.nodes[0].getdeploymentinfo()
assert 'signblock_witness_asm' in header
assert 'signblock_witness_hex' in header
assert 'signblock_witness_asm' in block
assert 'signblock_witness_hex' in block
assert_equal(info['deployments']['dynafed']['bip9']['status'], "defined")
# Test combineblocksigs witnessScript optionality pre-dynafed
self.log.info("Testing combineblocksigs witnessScript argument (pre-dynafed)")
self.test_combineblocksigs_witnessscript_arg()
# Next let's activate dynafed
blocks_til_dynafed = 431 - self.nodes[0].getblockcount()
self.log.info("Activating dynafed")
self.mine_blocks(blocks_til_dynafed, False)
self.check_height(111+blocks_til_dynafed)
assert_equal(self.nodes[0].getdeploymentinfo()['deployments']['dynafed']['bip9']['status'], "locked_in")
self.log.info("Mine some dynamic federation blocks without txns")
self.mine_blocks(10, False)
# Test combineblocksigs witnessScript optionality post-dynafed
self.log.info("Testing combineblocksigs witnessScript argument (post-dynafed)")
self.test_combineblocksigs_witnessscript_arg()
self.log.info("Mine some dynamic federation blocks with txns")
self.mine_blocks(10, True)
if __name__ == '__main__':
BlockSignTest(__file__).main()