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,539 bytes · SHA-256 f97c1133512770f6… · 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 mempool re-org scenarios.
6
7Test re-org scenarios with a mempool that contains transactions
8that spend (directly or indirectly) coinbase transactions.
9"""
10
11import time
12
13from test_framework.messages import (
14    CInv,
15    MSG_WTX,
16    msg_getdata,
17)
18from test_framework.p2p import (
19    P2PTxInvStore,
20    p2p_lock,
21)
22from test_framework.test_framework import BitcoinTestFramework
23from test_framework.util import assert_equal, assert_raises_rpc_error
24from test_framework.wallet import MiniWallet
25from test_framework.blocktools import (
26    create_empty_fork,
27)
28
29# Number of blocks to create in temporary blockchain branch for reorg testing
30# needs to be long enough to allow MTP to move arbitrarily forward
31FORK_LENGTH = 20
32
33class MempoolCoinbaseTest(BitcoinTestFramework):
34    def set_test_params(self):
35        self.num_nodes = 2
36        self.extra_args = [
37            [
38                '[email protected]',  # immediate tx relay
39            ],
40            []
41        ]
42
43    def trigger_reorg(self, fork_blocks, node):
44        """Trigger reorg of the fork blocks."""
45        for block in fork_blocks:
46            node.submitblock(block.serialize().hex())
47        assert_equal(self.nodes[0].getbestblockhash(), fork_blocks[-1].hash_hex)
48
49    def test_reorg_relay(self):
50        self.log.info("Test that transactions from disconnected blocks are available for relay immediately")
51        # Prevent time from moving forward
52        self.nodes[1].setmocktime(int(time.time()))
53        self.connect_nodes(0, 1)
54        self.generate(self.wallet, 3)
55
56        # Disconnect node0 and node1 to create different chains.
57        self.disconnect_nodes(0, 1)
58        # Connect a peer to node1, which doesn't have immediate tx relay
59        peer1 = self.nodes[1].add_p2p_connection(P2PTxInvStore())
60
61        # Create a transaction that is included in a block.
62        tx_disconnected = self.wallet.send_self_transfer(from_node=self.nodes[1])
63        self.generate(self.nodes[1], 1, sync_fun=self.no_op)
64
65        # Create a transaction and submit it to node1's mempool.
66        tx_before_reorg = self.wallet.send_self_transfer(from_node=self.nodes[1])
67
68        # Create a child of that transaction and submit it to node1's mempool.
69        tx_child = self.wallet.send_self_transfer(utxo_to_spend=tx_disconnected["new_utxo"], from_node=self.nodes[1])
70        assert_equal(self.nodes[1].getmempoolentry(tx_child["txid"])["ancestorcount"], 1)
71        assert_equal(len(peer1.get_invs()), 0)
72
73        # node0 has a longer chain in which tx_disconnected was not confirmed.
74        self.generate(self.nodes[0], 3, sync_fun=self.no_op)
75
76        # Reconnect the nodes and sync chains. node0's chain should win.
77        self.connect_nodes(0, 1)
78        self.sync_blocks()
79
80        # Child now has an ancestor from the disconnected block
81        assert_equal(self.nodes[1].getmempoolentry(tx_child["txid"])["ancestorcount"], 2)
82        assert_equal(self.nodes[1].getmempoolentry(tx_before_reorg["txid"])["ancestorcount"], 1)
83
84        # peer1 should not have received an inv for any of the transactions during this time, as no
85        # mocktime has elapsed for those transactions to be announced. Likewise, it cannot
86        # request very recent, unanounced transactions.
87        assert_equal(len(peer1.get_invs()), 0)
88        # It's too early to request these two transactions
89        requests_too_recent = msg_getdata([CInv(t=MSG_WTX, h=tx["tx"].wtxid_int) for tx in [tx_before_reorg, tx_child]])
90        peer1.send_and_ping(requests_too_recent)
91        for _ in range(len(requests_too_recent.inv)):
92            peer1.sync_with_ping()
93        with p2p_lock:
94            assert "tx" not in peer1.last_message
95            assert "notfound" in peer1.last_message
96
97        # Request the tx from the disconnected block
98        request_disconnected_tx = msg_getdata([CInv(t=MSG_WTX, h=tx_disconnected["tx"].wtxid_int)])
99        peer1.send_and_ping(request_disconnected_tx)
100
101        # The tx from the disconnected block was never announced, and it entered the mempool later
102        # than the transactions that are too recent.
103        assert_equal(len(peer1.get_invs()), 0)
104        with p2p_lock:
105            # However, the node will answer requests for the tx from the recently-disconnected block.
106            assert_equal(peer1.last_message["tx"].tx.wtxid_hex,tx_disconnected["tx"].wtxid_hex)
107
108        self.nodes[1].setmocktime(int(time.time()) + 300)
109        peer1.sync_with_ping()
110        # the transactions are now announced
111        assert_equal(len(peer1.get_invs()), 3)
112        for _ in range(3):
113            # make sure all tx requests have been responded to
114            peer1.sync_with_ping()
115        last_tx_received = peer1.last_message["tx"]
116
117        tx_after_reorg = self.wallet.send_self_transfer(from_node=self.nodes[1])
118        request_after_reorg = msg_getdata([CInv(t=MSG_WTX, h=tx_after_reorg["tx"].wtxid_int)])
119        assert tx_after_reorg["txid"] in self.nodes[1].getrawmempool()
120        peer1.send_and_ping(request_after_reorg)
121        with p2p_lock:
122            assert_equal(peer1.last_message["tx"], last_tx_received)
123
124    def run_test(self):
125        self.wallet = MiniWallet(self.nodes[0])
126        wallet = self.wallet
127
128        # Prevent clock from moving blocks further forward in time
129        now = int(time.time())
130        self.nodes[0].setmocktime(now)
131
132        # Start with a 200 block chain
133        assert_equal(self.nodes[0].getblockcount(), 200)
134
135        self.log.info("Add 4 coinbase utxos to the miniwallet")
136        # Block 76 contains the first spendable coinbase txs.
137        first_block = 76
138
139        # Three scenarios for re-orging coinbase spends in the memory pool:
140        # 1. Direct coinbase spend  :  spend_1
141        # 2. Indirect (coinbase spend in chain, child in mempool) : spend_2 and spend_2_1
142        # 3. Indirect (coinbase and child both in chain) : spend_3 and spend_3_1
143        # Use re-org to make all of the above coinbase spends invalid (immature coinbase),
144        # and make sure the mempool code behaves correctly.
145        b = [self.nodes[0].getblockhash(n) for n in range(first_block, first_block+4)]
146        coinbase_txids = [self.nodes[0].getblock(h)['tx'][0] for h in b]
147        utxo_1 = wallet.get_utxo(txid=coinbase_txids[1])
148        utxo_2 = wallet.get_utxo(txid=coinbase_txids[2])
149        utxo_3 = wallet.get_utxo(txid=coinbase_txids[3])
150        self.log.info("Create three transactions spending from coinbase utxos: spend_1, spend_2, spend_3")
151        spend_1 = wallet.create_self_transfer(utxo_to_spend=utxo_1)
152        spend_2 = wallet.create_self_transfer(utxo_to_spend=utxo_2)
153        spend_3 = wallet.create_self_transfer(utxo_to_spend=utxo_3)
154
155        self.log.info("Create another transaction which is time-locked to 300 seconds in the future")
156        future = now + 300
157        utxo = wallet.get_utxo(txid=coinbase_txids[0])
158        timelock_tx = wallet.create_self_transfer(
159            utxo_to_spend=utxo,
160            locktime=future,
161        )['hex']
162
163        self.log.info("Check that the time-locked transaction is too immature to spend")
164        assert_raises_rpc_error(-26, "non-final", self.nodes[0].sendrawtransaction, timelock_tx)
165
166        self.log.info("Broadcast and mine spend_2 and spend_3")
167        spend_2_id = wallet.sendrawtransaction(from_node=self.nodes[0], tx_hex=spend_2['hex'])
168        wallet.sendrawtransaction(from_node=self.nodes[0], tx_hex=spend_3['hex'])
169        self.log.info("Generate a block")
170        self.generate(self.nodes[0], 1)
171        self.log.info("Check that time-locked transaction is still too immature to spend")
172        assert_raises_rpc_error(-26, 'non-final', self.nodes[0].sendrawtransaction, timelock_tx)
173
174        self.log.info("Create spend_2_1 and spend_3_1")
175        spend_2_1 = wallet.create_self_transfer(utxo_to_spend=spend_2["new_utxo"], version=1)
176        spend_3_1 = wallet.create_self_transfer(utxo_to_spend=spend_3["new_utxo"])
177
178        self.log.info("Broadcast and mine spend_3_1")
179        spend_3_1_id = self.nodes[0].sendrawtransaction(spend_3_1['hex'])
180        self.log.info("Generate a block")
181
182        # Prep for fork, only go FORK_LENGTH  seconds into the MTP future max
183        fork_blocks = create_empty_fork(self.nodes[0], fork_length=FORK_LENGTH)
184
185        # Jump node and MTP 300 seconds and generate a slightly weaker chain than reorg one
186        self.nodes[0].setmocktime(future)
187        self.generate(self.nodes[0], FORK_LENGTH - 1)
188        block_time = self.nodes[0].getblock(self.nodes[0].getbestblockhash())['time']
189        assert(block_time >= now + 300)
190
191        # generate() implicitly syncs blocks, so that peer 1 gets the block before timelock_tx
192        # Otherwise, peer 1 would put the timelock_tx in m_lazy_recent_rejects
193        self.log.info("The time-locked transaction can now be spent")
194        timelock_tx_id = self.nodes[0].sendrawtransaction(timelock_tx)
195
196        self.log.info("Add spend_1 and spend_2_1 to the mempool")
197        spend_1_id = self.nodes[0].sendrawtransaction(spend_1['hex'])
198        spend_2_1_id = self.nodes[0].sendrawtransaction(spend_2_1['hex'])
199
200        assert_equal(set(self.nodes[0].getrawmempool()), {spend_1_id, spend_2_1_id, timelock_tx_id})
201        self.sync_all()
202
203        self.trigger_reorg(fork_blocks, self.nodes[0])
204        self.sync_blocks()
205
206        # We went backwards in time to boot timelock_tx_id
207        fork_block_time = self.nodes[0].getblock(self.nodes[0].getbestblockhash())['time']
208        assert fork_block_time < block_time
209
210        self.log.info("The time-locked transaction is now too immature and has been removed from the mempool")
211        self.log.info("spend_3_1 has been re-orged out of the chain and is back in the mempool")
212        assert_equal(set(self.nodes[0].getrawmempool()), {spend_1_id, spend_2_1_id, spend_3_1_id})
213
214        self.log.info("Reorg out enough blocks to get spend_2 back in the mempool, along with its child")
215
216        while (spend_2_id not in self.nodes[0].getrawmempool()):
217            b = self.nodes[0].getbestblockhash()
218            for node in self.nodes:
219                node.invalidateblock(b)
220
221        assert(spend_2_id in self.nodes[0].getrawmempool())
222        assert(spend_2_1_id in self.nodes[0].getrawmempool())
223
224        # Chain 10 more transactions off of spend_2_1
225        self.log.info("Give spend_2 some more descendants by creating a chain of 10 transactions spending from it")
226        parent_utxo = spend_2_1["new_utxo"]
227        for i in range(10):
228            tx = wallet.create_self_transfer(utxo_to_spend=parent_utxo, version=1)
229            self.nodes[0].sendrawtransaction(tx['hex'])
230            parent_utxo = tx["new_utxo"]
231
232        self.log.info("Use invalidateblock to re-org back and make all those coinbase spends immature/invalid")
233        b = self.nodes[0].getblockhash(first_block + 100)
234
235        # Use invalidateblock to go backwards in MTP time.
236        # invalidateblock actually moves MTP backwards, making timelock_tx_id valid again.
237        for node in self.nodes:
238            node.invalidateblock(b)
239
240        self.log.info("Check that the mempool is empty")
241        assert_equal(set(self.nodes[0].getrawmempool()), set())
242        self.sync_all()
243
244        self.test_reorg_relay()
245
246
247if __name__ == '__main__':
248    MempoolCoinbaseTest(__file__).main()
249

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.