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.

11,384 bytes · SHA-256 59664eb4707a40cc… · View upstream ↗

1#!/usr/bin/env python3
2# Copyright (c) 2024-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 getblocktemplate RPC in proposal mode
6
7Generate several blocks and test them against the getblocktemplate RPC.
8"""
9
10from concurrent.futures import ThreadPoolExecutor
11
12import copy
13
14from test_framework.blocktools import (
15    create_block,
16    add_witness_commitment,
17    NORMAL_GBT_REQUEST_PARAMS,
18)
19
20from test_framework.test_framework import BitcoinTestFramework
21from test_framework.util import (
22    assert_equal,
23    assert_raises_rpc_error,
24)
25
26from test_framework.messages import (
27    BLOCK_HEADER_SIZE,
28    uint256_from_compact,
29)
30
31from test_framework.wallet import (
32    MiniWallet,
33)
34
35def assert_template(node, block, expect, *, rehash=True, submit=True, solve=True, expect_submit=None):
36    if rehash:
37        block.hashMerkleRoot = block.calc_merkle_root()
38
39    rsp = node.getblocktemplate(template_request={
40        'data': block.serialize().hex(),
41        'mode': 'proposal',
42        **NORMAL_GBT_REQUEST_PARAMS,
43    })
44    assert_equal(rsp, expect)
45    # Only attempt to submit invalid templates
46    if submit and expect is not None:
47        # submitblock runs checks in a different order, so may not return
48        # the same error
49        if expect_submit is None:
50            expect_submit = expect
51        if solve:
52            block.solve()
53        assert_equal(node.submitblock(block.serialize().hex()), expect_submit)
54
55class MiningTemplateVerificationTest(BitcoinTestFramework):
56
57    def set_test_params(self):
58        self.num_nodes = 1
59
60    def valid_block_test(self, node, block):
61        self.log.info("Valid block")
62        assert_template(node, block, None)
63
64    def cb_missing_test(self, node, block):
65        self.log.info("Bad input hash for coinbase transaction")
66        bad_block = copy.deepcopy(block)
67        bad_block.vtx[0].vin[0].prevout.hash += 1
68        assert_template(node, bad_block, 'bad-cb-missing')
69
70    def block_without_transactions_test(self, node, block):
71        self.log.info("Block with no transactions")
72
73        no_tx_block = copy.deepcopy(block)
74        no_tx_block.vtx.clear()
75        no_tx_block.hashMerkleRoot = 0
76        no_tx_block.solve()
77        assert_template(node, no_tx_block, 'bad-blk-length', rehash=False)
78
79    def truncated_final_transaction_test(self, node, block):
80        self.log.info("Truncated final transaction")
81        assert_raises_rpc_error(-22, "Block decode failed", node.getblocktemplate,
82            template_request={
83                "data": block.serialize()[:-1].hex(),
84                "mode": "proposal",
85                **NORMAL_GBT_REQUEST_PARAMS,
86            }
87        )
88
89    def duplicate_transaction_test(self, node, block):
90        self.log.info("Duplicate transaction")
91        bad_block = copy.deepcopy(block)
92        bad_block.vtx.append(bad_block.vtx[0])
93        assert_template(node, bad_block, 'bad-txns-duplicate')
94
95    def thin_air_spending_test(self, node, block):
96        self.log.info("Transaction that spends from thin air")
97        bad_block = copy.deepcopy(block)
98        bad_tx = copy.deepcopy(bad_block.vtx[0])
99        bad_tx.vin[0].prevout.hash = 255
100        bad_block.vtx.append(bad_tx)
101        assert_template(node, bad_block, 'bad-txns-inputs-missingorspent')
102
103    def non_final_transaction_test(self, node, block):
104        self.log.info("Non-final transaction")
105        bad_block = copy.deepcopy(block)
106        bad_block.vtx[0].nLockTime = 2**32 - 1
107        assert_template(node, bad_block, 'bad-txns-nonfinal')
108
109    def bad_tx_count_test(self, node, block):
110        self.log.info("Bad tx count")
111        # The tx count is immediately after the block header
112        bad_block_sn = bytearray(block.serialize())
113        assert_equal(bad_block_sn[BLOCK_HEADER_SIZE], 1)
114        bad_block_sn[BLOCK_HEADER_SIZE] += 1
115        assert_raises_rpc_error(-22, "Block decode failed", node.getblocktemplate, {
116            'data': bad_block_sn.hex(),
117            'mode': 'proposal',
118            **NORMAL_GBT_REQUEST_PARAMS,
119        })
120
121    def nbits_test(self, node, block):
122        self.log.info("Extremely high nBits")
123        bad_block = copy.deepcopy(block)
124        bad_block.nBits = 469762303  # impossible in the real world
125        assert_template(node, bad_block, "bad-diffbits", solve=False, expect_submit="high-hash")
126
127        self.log.info("Lowering nBits should make the block invalid")
128        bad_block = copy.deepcopy(block)
129        bad_block.nBits -= 1
130        assert_template(node, bad_block, "bad-diffbits")
131
132    def merkle_root_test(self, node, block):
133        self.log.info("Bad merkle root")
134        bad_block = copy.deepcopy(block)
135        bad_block.hashMerkleRoot += 1
136        assert_template(node, bad_block, 'bad-txnmrklroot', rehash=False)
137
138    def bad_timestamp_test(self, node, block):
139        self.log.info("Bad timestamps")
140        bad_block = copy.deepcopy(block)
141        bad_block.nTime = 2**32 - 1
142        assert_template(node, bad_block, 'time-too-new')
143        bad_block.nTime = 0
144        assert_template(node, bad_block, 'time-too-old')
145
146    def current_tip_test(self, node, block):
147        self.log.info("Block must build on the current tip")
148        bad_block = copy.deepcopy(block)
149        bad_block.hashPrevBlock = 123
150        bad_block.solve()
151
152        assert_template(node, bad_block, "inconclusive-not-best-prevblk", expect_submit="prev-blk-not-found")
153
154    def pow_test(self, node, block):
155        '''Modifies block with the generated PoW'''
156        self.log.info("Generate a block")
157        target = uint256_from_compact(block.nBits)
158        # Ensure that it doesn't meet the target by coincidence
159        while block.hash_int <= target:
160            block.nNonce += 1
161        self.log.debug("Found a nonce")
162
163        self.log.info("A block template doesn't need PoW")
164        assert_template(node, block, None)
165
166        self.log.info("Add proof of work")
167        block.solve()
168        assert_template(node, block, None)
169
170    def submit_test(self, node, block_0_height, block):
171        self.log.info("getblocktemplate call in previous tests did not submit the block")
172        assert_equal(node.getblockcount(), block_0_height + 1)
173
174        self.log.info("Submitting this block should succeed")
175        assert_equal(node.submitblock(block.serialize().hex()), None)
176        node.waitforblockheight(2)
177
178    def transaction_test(self, node, block_0_height, tx):
179        self.log.info("make block template with a transaction")
180
181        block_1 = node.getblock(node.getblockhash(block_0_height + 1))
182        block_2_hash = node.getblockhash(block_0_height + 2)
183
184        block_3 = create_block(
185            int(block_2_hash, 16),
186            height=block_0_height + 3,
187            ntime=block_1["mediantime"] + 1,
188            txlist=[tx["hex"]],
189        )
190        assert_equal(len(block_3.vtx), 2)
191        add_witness_commitment(block_3)
192        block_3.solve()
193        assert_template(node, block_3, None)
194
195        self.log.info("checking block validity did not update the UTXO set")
196        # Call again to ensure the UTXO set wasn't updated
197        assert_template(node, block_3, None)
198
199    def overspending_transaction_test(self, node, block_0_height, tx):
200        self.log.info("Add an transaction that spends too much")
201
202        block_1 = node.getblock(node.getblockhash(block_0_height + 1))
203        block_2_hash = node.getblockhash(block_0_height + 2)
204
205        bad_tx = copy.deepcopy(tx)
206        bad_tx["tx"].vout[0].nValue = 10000000000
207        bad_tx_hex = bad_tx["tx"].serialize().hex()
208        assert_equal(
209            node.testmempoolaccept([bad_tx_hex])[0]["reject-reason"],
210            "bad-txns-in-belowout",
211        )
212        block_3 = create_block(
213            int(block_2_hash, 16),
214            height=block_0_height + 3,
215            ntime=block_1["mediantime"] + 1,
216            txlist=[bad_tx_hex],
217        )
218        assert_equal(len(block_3.vtx), 2)
219        add_witness_commitment(block_3)
220        block_3.solve()
221
222        assert_template(node, block_3, "bad-txns-in-belowout")
223
224    def spend_twice_test(self, node, block_0_height, tx):
225        block_1 = node.getblock(node.getblockhash(block_0_height + 1))
226        block_2_hash = node.getblockhash(block_0_height + 2)
227
228        self.log.info("Can't spend coins twice")
229        tx_hex = tx["tx"].serialize().hex()
230        tx_2 = copy.deepcopy(tx)
231        tx_2_hex = tx_2["tx"].serialize().hex()
232        # Nothing wrong with these transactions individually
233        assert_equal(node.testmempoolaccept([tx_hex])[0]["allowed"], True)
234        assert_equal(node.testmempoolaccept([tx_2_hex])[0]["allowed"], True)
235        # But can't be combined
236        assert_equal(
237            node.testmempoolaccept([tx_hex, tx_2_hex])[0]["package-error"],
238            "package-contains-duplicates",
239        )
240        block_3 = create_block(
241            int(block_2_hash, 16),
242            height=block_0_height + 3,
243            ntime=block_1["mediantime"] + 1,
244            txlist=[tx_hex, tx_2_hex],
245        )
246        assert_equal(len(block_3.vtx), 3)
247        add_witness_commitment(block_3)
248
249        assert_template(node, block_3, "bad-txns-inputs-missingorspent", submit=False)
250

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.