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.

28,858 bytes · SHA-256 68d952c2b7bf0edb… · View upstream ↗

1#!/usr/bin/env python3
2# Copyright (c) 2014-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 mining RPCs
6
7- getmininginfo
8- getblocktemplate
9- submitblock
10
11mining_template_verification.py tests getblocktemplate in proposal mode"""
12
13import copy
14from decimal import Decimal
15
16from test_framework.blocktools import (
17    create_block,
18    create_coinbase,
19    get_witness_script,
20    NORMAL_GBT_REQUEST_PARAMS,
21    TIME_GENESIS_BLOCK,
22    REGTEST_N_BITS,
23    REGTEST_TARGET,
24    nbits_str,
25    target_str,
26)
27from test_framework.messages import (
28    BLOCK_HEADER_SIZE,
29    CBlock,
30    CBlockHeader,
31    COIN,
32    DEFAULT_BLOCK_RESERVED_WEIGHT,
33    MAX_BLOCK_WEIGHT,
34    MAX_SEQUENCE_NONFINAL,
35    MINIMUM_BLOCK_RESERVED_WEIGHT,
36    ser_uint256,
37    WITNESS_SCALE_FACTOR,
38)
39from test_framework.p2p import P2PDataStore
40from test_framework.test_framework import BitcoinTestFramework
41from test_framework.util import (
42    assert_equal,
43    assert_greater_than,
44    assert_greater_than_or_equal,
45    assert_raises_rpc_error,
46    get_fee,
47)
48from test_framework.wallet import (
49    MiniWallet,
50    MiniWalletMode,
51)
52
53
54DIFFICULTY_ADJUSTMENT_INTERVAL = 144
55MAX_FUTURE_BLOCK_TIME = 2 * 3600
56MAX_TIMEWARP = 600
57VERSIONBITS_TOP_BITS = 0x20000000
58VERSIONBITS_DEPLOYMENT_TESTDUMMY_BIT = 28
59DEFAULT_BLOCK_MIN_TX_FEE = 1 # default `-blockmintxfee` setting [sat/kvB]
60
61class MiningTest(BitcoinTestFramework):
62    def set_test_params(self):
63        self.num_nodes = 3
64        self.extra_args = [
65            [],
66            [],
67            ["-fastprune", "-prune=1"]
68        ]
69        self.setup_clean_chain = True
70
71    def mine_chain(self):
72        self.log.info('Create some old blocks')
73        for t in range(TIME_GENESIS_BLOCK, TIME_GENESIS_BLOCK + 200 * 600, 600):
74            self.nodes[0].setmocktime(t)
75            self.generate(self.wallet, 1, sync_fun=self.no_op)
76        mining_info = self.nodes[0].getmininginfo()
77        assert_equal(mining_info['blocks'], 200)
78        assert_equal(mining_info['currentblocktx'], 0)
79        assert_equal(mining_info['currentblockweight'], DEFAULT_BLOCK_RESERVED_WEIGHT)
80
81        self.log.info('test blockversion')
82        self.restart_node(0, extra_args=[f'-mocktime={t}', '-blockversion=1337'])
83        self.connect_nodes(0, 1)
84        assert_equal(1337, self.nodes[0].getblocktemplate(NORMAL_GBT_REQUEST_PARAMS)['version'])
85        self.restart_node(0, extra_args=[f'-mocktime={t}'])
86        self.connect_nodes(0, 1)
87        assert_equal(VERSIONBITS_TOP_BITS + (1 << VERSIONBITS_DEPLOYMENT_TESTDUMMY_BIT), self.nodes[0].getblocktemplate(NORMAL_GBT_REQUEST_PARAMS)['version'])
88        self.restart_node(0)
89        self.connect_nodes(0, 1)
90
91    def test_fees_and_sigops(self):
92        self.log.info("Test fees and sigops in getblocktemplate result")
93        node = self.nodes[0]
94
95        # Generate a coinbases with p2pk transactions for its sigops.
96        wallet_sigops = MiniWallet(node, mode=MiniWalletMode.RAW_P2PK)
97        self.generate(wallet_sigops, 1, sync_fun=self.no_op)
98
99        # Mature with regular coinbases to prevent interference with other tests
100        self.generate(self.wallet, 100, sync_fun=self.no_op)
101
102        # Generate three transactions that must be mined in sequence
103        #
104        #      tx_a (1 sat/vbyte)
105        #        |
106        #        |
107        #      tx_b (2 sat/vbyte)
108        #        |
109        #        |
110        #      tx_c (3 sat/vbyte)
111        #
112        tx_a = wallet_sigops.send_self_transfer(from_node=node,
113                                                fee_rate=Decimal("0.00001"))
114        tx_b = wallet_sigops.send_self_transfer(from_node=node,
115                                                fee_rate=Decimal("0.00002"),
116                                                utxo_to_spend=tx_a["new_utxo"])
117        tx_c = wallet_sigops.send_self_transfer(from_node=node,
118                                                fee_rate=Decimal("0.00003"),
119                                                utxo_to_spend=tx_b["new_utxo"])
120
121        # Generate transaction without sigops. It will go first because it pays
122        # higher fees (100 sat/vbyte) and descends from a different coinbase.
123        tx_d = self.wallet.send_self_transfer(from_node=node,
124                                              fee_rate=Decimal("0.00100"))
125
126        block_template = node.getblocktemplate(NORMAL_GBT_REQUEST_PARAMS)
127        block_template_txs = block_template['transactions']
128
129        block_template_fees = [tx['fee'] for tx in block_template_txs]
130        assert_equal(block_template_fees, [
131            tx_d["fee"] * COIN,
132            tx_a["fee"] * COIN,
133            tx_b["fee"] * COIN,
134            tx_c["fee"] * COIN
135        ])
136        # verify that coinbasevalue field is set to claim full block reward (subsidy + fees)
137        expected_block_reward = create_coinbase(
138            height=int(block_template["height"]), fees=sum(block_template_fees)).vout[0].nValue
139        assert_equal(block_template["coinbasevalue"], expected_block_reward)
140
141        block_template_sigops = [tx['sigops'] for tx in block_template_txs]
142        assert_equal(block_template_sigops, [0, 4, 4, 4])
143
144        # Clear mempool
145        self.generate(self.wallet, 1, sync_fun=self.no_op)
146
147    def test_blockmintxfee_parameter(self):
148        self.log.info("Test -blockmintxfee setting")
149        self.restart_node(0, extra_args=['-minrelaytxfee=0', '-persistmempool=0'])
150        node = self.nodes[0]
151
152        # test default (no parameter), zero and a bunch of arbitrary blockmintxfee rates [sat/kvB]
153        for blockmintxfee_sat_kvb in (DEFAULT_BLOCK_MIN_TX_FEE, 0, 5, 10, 50, 100, 500, 1000, 2500, 5000, 21000, 333333, 2500000):
154            blockmintxfee_btc_kvb = blockmintxfee_sat_kvb / Decimal(COIN)
155            if blockmintxfee_sat_kvb == DEFAULT_BLOCK_MIN_TX_FEE:
156                self.log.info(f"-> Default -blockmintxfee setting ({blockmintxfee_sat_kvb} sat/kvB)...")
157            else:
158                blockmintxfee_parameter = f"-blockmintxfee={blockmintxfee_btc_kvb:.8f}"
159                self.log.info(f"-> Test {blockmintxfee_parameter} ({blockmintxfee_sat_kvb} sat/kvB)...")
160                self.restart_node(0, extra_args=[blockmintxfee_parameter, '-minrelaytxfee=0', '-persistmempool=0'])
161            assert_equal(node.getmininginfo()['blockmintxfee'], blockmintxfee_btc_kvb)
162
163            # submit one tx with exactly the blockmintxfee rate, and one slightly below
164            tx_with_min_feerate = self.wallet.send_self_transfer(from_node=node, fee_rate=blockmintxfee_btc_kvb, confirmed_only=True)
165            assert_equal(tx_with_min_feerate["fee"], get_fee(tx_with_min_feerate["tx"].get_vsize(), blockmintxfee_btc_kvb))
166            if blockmintxfee_sat_kvb >= 10:
167                lowerfee_btc_kvb = blockmintxfee_btc_kvb - Decimal(10)/COIN  # 0.01 sat/vbyte lower
168                assert_greater_than(blockmintxfee_btc_kvb, lowerfee_btc_kvb)
169                assert_greater_than_or_equal(lowerfee_btc_kvb, 0)
170                tx_below_min_feerate = self.wallet.send_self_transfer(from_node=node, fee_rate=lowerfee_btc_kvb, confirmed_only=True)
171                assert_equal(tx_below_min_feerate["fee"], get_fee(tx_below_min_feerate["tx"].get_vsize(), lowerfee_btc_kvb))
172            else:  # go below zero fee by using modified fees
173                tx_below_min_feerate = self.wallet.send_self_transfer(from_node=node, fee_rate=blockmintxfee_btc_kvb, confirmed_only=True)
174                node.prioritisetransaction(tx_below_min_feerate["txid"], 0, -11)
175
176            # check that tx below specified fee-rate is neither in template nor in the actual block
177            block_template = node.getblocktemplate(NORMAL_GBT_REQUEST_PARAMS)
178            block_template_txids = [tx['txid'] for tx in block_template['transactions']]
179
180            # Unless blockmintxfee is 0, the template shouldn't contain free transactions.
181            # Note that the real block assembler uses package feerates, but we didn't create dependent transactions so it's ok to use base feerate.
182            if blockmintxfee_btc_kvb > 0:
183                for txid in block_template_txids:
184                    tx = node.getmempoolentry(txid)
185                    assert_greater_than(tx['fees']['base'], 0)
186
187            self.generate(self.wallet, 1, sync_fun=self.no_op)
188            block = node.getblock(node.getbestblockhash(), verbosity=2)
189            block_txids = [tx['txid'] for tx in block['tx']]
190
191            assert tx_with_min_feerate['txid'] in block_template_txids
192            assert tx_with_min_feerate['txid'] in block_txids
193            assert tx_below_min_feerate['txid'] not in block_template_txids
194            assert tx_below_min_feerate['txid'] not in block_txids
195
196            # Restart node to clear mempool for the next test
197            self.restart_node(0)
198
199    def test_timewarp(self):
200        self.log.info("Test timewarp attack mitigation (BIP94)")
201        node = self.nodes[0]
202        self.restart_node(0, extra_args=['-test=bip94'])
203
204        self.log.info("Mine until the last block of the retarget period")
205        blockchain_info = self.nodes[0].getblockchaininfo()
206        n = DIFFICULTY_ADJUSTMENT_INTERVAL - blockchain_info['blocks'] % DIFFICULTY_ADJUSTMENT_INTERVAL - 2
207        t = blockchain_info['time']
208
209        for _ in range(n):
210            t += 600
211            self.nodes[0].setmocktime(t)
212            self.generate(self.wallet, 1, sync_fun=self.no_op)
213
214        self.log.info("Create block two hours in the future")
215        self.nodes[0].setmocktime(t + MAX_FUTURE_BLOCK_TIME)
216        self.generate(self.wallet, 1, sync_fun=self.no_op)
217        assert_equal(node.getblock(node.getbestblockhash())['time'], t + MAX_FUTURE_BLOCK_TIME)
218
219        self.log.info("First block template of retarget period can't use wall clock time")
220        self.nodes[0].setmocktime(t)
221        # The template will have an adjusted timestamp, which we then modify
222        tmpl = node.getblocktemplate(NORMAL_GBT_REQUEST_PARAMS)
223        assert_greater_than_or_equal(tmpl['curtime'], t + MAX_FUTURE_BLOCK_TIME - MAX_TIMEWARP)
224        # mintime and curtime should match
225        assert_equal(tmpl['mintime'], tmpl['curtime'])
226
227        block = CBlock()
228        block.nVersion = tmpl["version"]
229        block.hashPrevBlock = int(tmpl["previousblockhash"], 16)
230        block.nTime = tmpl["curtime"]
231        block.nBits = int(tmpl["bits"], 16)
232        block.nNonce = 0
233        block.vtx = [create_coinbase(height=int(tmpl["height"]))]
234        block.hashMerkleRoot = block.calc_merkle_root()
235        block.solve()
236        assert_equal(node.getblocktemplate(template_request={
237            'data': block.serialize().hex(),
238            'mode': 'proposal',
239            **NORMAL_GBT_REQUEST_PARAMS,
240        }), None)
241
242        bad_block = copy.deepcopy(block)
243        bad_block.nTime = t
244        bad_block.solve()
245        assert_raises_rpc_error(-25, 'time-timewarp-attack', lambda: node.submitheader(hexdata=CBlockHeader(bad_block).serialize().hex()))
246
247        self.log.info("Test timewarp protection boundary")
248        bad_block.nTime = t + MAX_FUTURE_BLOCK_TIME - MAX_TIMEWARP - 1
249        bad_block.solve()
250        assert_raises_rpc_error(-25, 'time-timewarp-attack', lambda: node.submitheader(hexdata=CBlockHeader(bad_block).serialize().hex()))

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.