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,158 bytes · SHA-256 5be7cfe79e1ff82c… · View upstream ↗

1#!/usr/bin/env python3
2# Copyright (c) 2022-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 signet miner tool"""
6
7import json
8import os.path
9import shlex
10import subprocess
11import sys
12import time
13
14from test_framework.blocktools import DIFF_1_N_BITS, SIGNET_HEADER
15from test_framework.key import ECKey
16from test_framework.script_util import CScript, key_to_p2wpkh_script
17from test_framework.test_framework import BitcoinTestFramework
18from test_framework.util import (
19    assert_equal,
20    wallet_importprivkey,
21)
22from test_framework.wallet_util import bytes_to_wif
23
24
25CHALLENGE_PRIVATE_KEY = (42).to_bytes(32, 'big')
26
27def get_segwit_commitment(node):
28    coinbase = node.getblock(node.getbestblockhash(), 2)['tx'][0]
29    commitment = coinbase['vout'][1]['scriptPubKey']['hex']
30    assert_equal(commitment[0:12], '6a24aa21a9ed')
31    return commitment
32
33def get_signet_commitment(segwit_commitment):
34    for el in CScript.fromhex(segwit_commitment):
35        if isinstance(el, bytes) and el[0:4] == SIGNET_HEADER:
36            return el[4:].hex()
37    return None
38
39class SignetMinerTest(BitcoinTestFramework):
40    def set_test_params(self):
41        self.chain = "signet"
42        self.setup_clean_chain = True
43        self.num_nodes = 4
44
45        # generate and specify signet challenge (simple p2wpkh script)
46        privkey = ECKey()
47        privkey.set(CHALLENGE_PRIVATE_KEY, True)
48        pubkey = privkey.get_pubkey().get_bytes()
49        challenge = key_to_p2wpkh_script(pubkey)
50
51        self.extra_args = [
52            [f'-signetchallenge={challenge.hex()}'],
53            ["-signetchallenge=51"], # OP_TRUE
54            ["-signetchallenge=60"], # OP_16
55            ["-signetchallenge=202cf24dba5fb0a30e26e83b2ac5b9e29e1b161e5c1fa7425e73043362938b9824"], # sha256("hello")
56        ]
57
58    def skip_test_if_missing_module(self):
59        self.skip_if_no_cli()
60        self.skip_if_no_wallet()
61        self.skip_if_no_bitcoin_util()
62
63    def setup_network(self):
64        self.setup_nodes()
65        # Nodes with different signet networks are not connected
66
67    # generate block with signet miner tool
68    def mine_block(self, node):
69        n_blocks = node.getblockcount()
70        base_dir = self.config["environment"]["SRCDIR"]
71        signet_miner_path = os.path.join(base_dir, "contrib", "signet", "miner")
72        rpc_argv = node.binaries.rpc_argv() + [f"-datadir={node.datadir_path}"]
73        util_argv = node.binaries.util_argv() + ["grind"]
74        subprocess.run([
75                sys.executable,
76                signet_miner_path,
77                f'--cli={shlex.join(rpc_argv)}',
78                'generate',
79                f'--address={node.getnewaddress()}',
80                f'--grind-cmd={shlex.join(util_argv)}',
81                f'--nbits={DIFF_1_N_BITS:08x}',
82                f'--set-block-time={int(time.time())}',
83                '--poolnum=99',
84            ], check=True, stderr=subprocess.STDOUT)
85        assert_equal(node.getblockcount(), n_blocks + 1)
86
87    # generate block using the signet miner tool genpsbt and solvepsbt commands
88    def mine_block_manual(self, node, *, sign):
89        n_blocks = node.getblockcount()
90        base_dir = self.config["environment"]["SRCDIR"]
91        signet_miner_path = os.path.join(base_dir, "contrib", "signet", "miner")
92        rpc_argv = node.binaries.rpc_argv() + [f"-datadir={node.datadir_path}"]
93        util_argv = node.binaries.util_argv() + ["grind"]
94        base_cmd = [
95            sys.executable,
96            signet_miner_path,
97            f'--cli={shlex.join(rpc_argv)}',
98        ]
99
100        template = node.getblocktemplate(dict(rules=["signet","segwit"]))
101        genpsbt = subprocess.run(base_cmd + [
102                'genpsbt',
103                f'--address={node.getnewaddress()}',
104                '--poolnum=98',
105            ], check=True, text=True, input=json.dumps(template), capture_output=True)
106        psbt = genpsbt.stdout.strip()
107        if sign:
108            self.log.debug("Sign the PSBT")
109            res = node.walletprocesspsbt(psbt=psbt, sign=True, sighashtype='ALL')
110            assert res['complete']
111            psbt = res['psbt']
112        solvepsbt = subprocess.run(base_cmd + [
113                'solvepsbt',
114                f'--grind-cmd={shlex.join(util_argv)}',
115            ], check=True, text=True, input=psbt, capture_output=True)
116        node.submitblock(solvepsbt.stdout.strip())
117        assert_equal(node.getblockcount(), n_blocks + 1)
118
119    def run_test(self):
120        self.log.info("Signet node with single signature challenge")
121        node = self.nodes[0]
122        # import private key needed for signing block
123        wallet_importprivkey(node, bytes_to_wif(CHALLENGE_PRIVATE_KEY), 0)
124        self.mine_block(node)
125        # MUST include signet commitment
126        assert get_signet_commitment(get_segwit_commitment(node))
127
128        self.log.info("Mine manually using genpsbt and solvepsbt")
129        self.mine_block_manual(node, sign=True)
130        assert get_signet_commitment(get_segwit_commitment(node))
131
132        node = self.nodes[1]
133        self.log.info("Signet node with trivial challenge (OP_TRUE)")
134        self.mine_block(node)
135        # MAY omit signet commitment (BIP 325). Do so for better compatibility
136        # with signet unaware mining software and hardware.
137        assert get_signet_commitment(get_segwit_commitment(node)) is None
138
139        node = self.nodes[2]
140        self.log.info("Signet node with trivial challenge (OP_16)")
141        self.mine_block(node)
142        assert get_signet_commitment(get_segwit_commitment(node)) is None
143
144        node = self.nodes[3]
145        self.log.info("Signet node with trivial challenge (push sha256 hash)")
146        self.mine_block(node)
147        assert get_signet_commitment(get_segwit_commitment(node)) is None
148
149        self.log.info("Manual mining with a trivial challenge doesn't require a PSBT")
150        self.mine_block_manual(node, sign=False)
151        assert get_signet_commitment(get_segwit_commitment(node)) is None
152
153
154if __name__ == "__main__":
155    SignetMinerTest(__file__).main()
156

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.