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.

44,294 bytes · SHA-256 d4db1bb3a816578d… · View upstream ↗

1#!/usr/bin/env python3
2# Copyright (c) 2023-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
6import time
7
8from test_framework.blocktools import MAX_STANDARD_TX_WEIGHT
9from test_framework.mempool_util import (
10    create_large_orphan,
11    tx_in_orphanage,
12)
13from test_framework.messages import (
14    CInv,
15    DEFAULT_ANCESTOR_LIMIT,
16    MSG_TX,
17    MSG_WITNESS_TX,
18    MSG_WTX,
19    malleate_tx_to_invalid_witness,
20    msg_getdata,
21    msg_inv,
22    msg_notfound,
23    msg_tx,
24    tx_from_hex,
25)
26from test_framework.p2p import (
27    GETDATA_TX_INTERVAL,
28    NONPREF_PEER_TX_DELAY,
29    OVERLOADED_PEER_TX_DELAY,
30    p2p_lock,
31    P2PInterface,
32    P2PTxInvStore,
33    TXID_RELAY_DELAY,
34)
35from test_framework.util import (
36    assert_not_equal,
37    assert_equal,
38)
39from test_framework.test_framework import BitcoinTestFramework
40from test_framework.wallet import (
41    MiniWallet,
42    MiniWalletMode,
43)
44
45# Time to bump forward (using setmocktime) before waiting for the node to send getdata(tx) in response
46# to an inv(tx), in seconds. This delay includes all possible delays + 1, so it should only be used
47# when the value of the delay is not interesting. If we want to test that the node waits x seconds
48# for one peer and y seconds for another, use specific values instead.
49TXREQUEST_TIME_SKIP = NONPREF_PEER_TX_DELAY + TXID_RELAY_DELAY + OVERLOADED_PEER_TX_DELAY + 1
50
51def cleanup(func):
52    def wrapper(self):
53        func(self)
54
55        # Clear mempool
56        self.generate(self.nodes[0], 1)
57        self.nodes[0].disconnect_p2ps()
58        # Check that mempool and orphanage have been cleared
59        self.wait_until(lambda: len(self.nodes[0].getorphantxs()) == 0)
60        assert_equal(0, len(self.nodes[0].getrawmempool()))
61
62        self.restart_node(0, extra_args=["-persistmempool=0"])
63        # Allow use of bumpmocktime again
64        self.nodes[0].setmocktime(int(time.time()))
65        self.wallet.rescan_utxos(include_mempool=True)
66    return wrapper
67
68class PeerTxRelayer(P2PTxInvStore):
69    """A P2PTxInvStore that also remembers all of the getdata and tx messages it receives."""
70    def __init__(self, wtxidrelay=True):
71        super().__init__(wtxidrelay=wtxidrelay)
72        self._tx_received = []
73        self._getdata_received = []
74
75    @property
76    def tx_received(self):
77        with p2p_lock:
78            return self._tx_received
79
80    @property
81    def getdata_received(self):
82        with p2p_lock:
83            return self._getdata_received
84
85    def on_tx(self, message):
86        self._tx_received.append(message)
87
88    def on_getdata(self, message):
89        self._getdata_received.append(message)
90
91    def wait_for_parent_requests(self, txids):
92        """Wait for requests for missing parents by txid with witness data (MSG_WITNESS_TX or
93        WitnessTx). Requires that the getdata message match these txids exactly; all txids must be
94        requested and no additional requests are allowed."""
95        def test_function():
96            last_getdata = self.last_message.get('getdata')
97            if not last_getdata:
98                return False
99            return len(last_getdata.inv) == len(txids) and all([item.type == MSG_WITNESS_TX and item.hash in txids for item in last_getdata.inv])
100        self.wait_until(test_function, timeout=10)
101
102    def assert_no_immediate_response(self, message):
103        """Check that the node does not immediately respond to this message with any of getdata,
104        inv, tx. The node may respond later.
105        """
106        prev_lastmessage = self.last_message
107        self.send_and_ping(message)
108        after_lastmessage = self.last_message
109        for msgtype in ["getdata", "inv", "tx"]:
110            if msgtype not in prev_lastmessage:
111                assert msgtype not in after_lastmessage
112            else:
113                assert_equal(prev_lastmessage[msgtype], after_lastmessage[msgtype])
114
115    def assert_never_requested(self, txhash):
116        """Check that the node has never sent us a getdata for this hash (int type)"""
117        self.sync_with_ping()
118        for getdata in self.getdata_received:
119            for request in getdata.inv:
120                assert_not_equal(request.hash, txhash)
121
122class OrphanHandlingTest(BitcoinTestFramework):
123    def set_test_params(self):
124        self.num_nodes = 1
125        self.extra_args = [[]]
126
127    def create_parent_and_child(self):
128        """Create package with 1 parent and 1 child, normal fees (no cpfp)."""
129        parent = self.wallet.create_self_transfer()
130        child = self.wallet.create_self_transfer(utxo_to_spend=parent['new_utxo'])
131        return child["tx"].wtxid_hex, child["tx"], parent["tx"]
132
133    def relay_transaction(self, peer, tx):
134        """Relay transaction using MSG_WTX"""
135        wtxid = tx.wtxid_int
136        peer.send_and_ping(msg_inv([CInv(t=MSG_WTX, h=wtxid)]))
137        self.nodes[0].bumpmocktime(TXREQUEST_TIME_SKIP)
138        peer.wait_for_getdata([wtxid])
139        peer.send_and_ping(msg_tx(tx))
140
141    @cleanup
142    def test_arrival_timing_orphan(self):
143        self.log.info("Test missing parents that arrive during delay are not requested")
144        node = self.nodes[0]
145        tx_parent_arrives = self.wallet.create_self_transfer()
146        tx_parent_doesnt_arrive = self.wallet.create_self_transfer()
147        # Fake orphan spends nonexistent outputs of the two parents
148        tx_fake_orphan = self.wallet.create_self_transfer_multi(utxos_to_spend=[
149            {"txid": tx_parent_doesnt_arrive["txid"], "vout": 10, "value": tx_parent_doesnt_arrive["new_utxo"]["value"]},
150            {"txid": tx_parent_arrives["txid"], "vout": 10, "value": tx_parent_arrives["new_utxo"]["value"]}
151        ])
152
153        peer_spy = node.add_p2p_connection(PeerTxRelayer())
154        peer_normal = node.add_p2p_connection(PeerTxRelayer())
155        # This transaction is an orphan because it is missing inputs. It is a "fake" orphan that the
156        # spy peer has crafted to learn information about tx_parent_arrives even though it isn't
157        # able to spend a real output of it, but it could also just be a normal, real child tx.
158        # The node should not immediately respond with a request for orphan parents.
159        # Also, no request should be sent later because it will be resolved by
160        # the time the request is scheduled to be sent.
161        peer_spy.assert_no_immediate_response(msg_tx(tx_fake_orphan["tx"]))
162
163        # Node receives transaction. It attempts to obfuscate the exact timing at which this
164        # transaction entered its mempool. Send unsolicited because otherwise we need to wait for
165        # request delays.
166        peer_normal.send_and_ping(msg_tx(tx_parent_arrives["tx"]))
167        assert tx_parent_arrives["txid"] in node.getrawmempool()
168
169        # Spy peer should not be able to query the node for the parent yet, since it hasn't been
170        # announced / insufficient time has elapsed.
171        parent_inv = CInv(t=MSG_WTX, h=tx_parent_arrives["tx"].wtxid_int)
172        assert_equal(len(peer_spy.get_invs()), 0)
173        peer_spy.assert_no_immediate_response(msg_getdata([parent_inv]))
174
175        # Request would be scheduled with this delay because it is not a preferred relay peer.
176        self.nodes[0].bumpmocktime(NONPREF_PEER_TX_DELAY)
177        peer_spy.assert_never_requested(int(tx_parent_arrives["txid"], 16))
178        peer_spy.assert_never_requested(int(tx_parent_doesnt_arrive["txid"], 16))
179        # Request would be scheduled with this delay because it is by txid.
180        self.nodes[0].bumpmocktime(TXID_RELAY_DELAY)
181        peer_spy.wait_for_parent_requests([int(tx_parent_doesnt_arrive["txid"], 16)])
182        peer_spy.assert_never_requested(int(tx_parent_arrives["txid"], 16))
183
184    @cleanup
185    def test_orphan_rejected_parents_exceptions(self):
186        node = self.nodes[0]
187        peer1 = node.add_p2p_connection(PeerTxRelayer())
188        peer2 = node.add_p2p_connection(PeerTxRelayer())
189
190        self.log.info("Test orphan handling when a nonsegwit parent is known to be invalid")
191        parent_overly_large_nonsegwit = self.wallet_nonsegwit.create_self_transfer(target_vsize=int(MAX_STANDARD_TX_WEIGHT / 4) + 1)
192        assert_equal(parent_overly_large_nonsegwit["txid"], parent_overly_large_nonsegwit["tx"].wtxid_hex)
193        parent_other = self.wallet_nonsegwit.create_self_transfer()
194        child_nonsegwit = self.wallet_nonsegwit.create_self_transfer_multi(
195            utxos_to_spend=[parent_other["new_utxo"], parent_overly_large_nonsegwit["new_utxo"]])
196
197        # Relay the parent. It should be rejected (and not reconsiderable) because it violated size limitations.
198        self.relay_transaction(peer1, parent_overly_large_nonsegwit["tx"])
199        assert parent_overly_large_nonsegwit["txid"] not in node.getrawmempool()
200
201        # Relay the child. It should not be accepted because it has missing inputs.
202        # Its parent should not be requested because its hash (txid == wtxid) has been added to the rejection filter.
203        self.relay_transaction(peer2, child_nonsegwit["tx"])
204        assert child_nonsegwit["txid"] not in node.getrawmempool()
205        assert not tx_in_orphanage(node, child_nonsegwit["tx"])
206
207        # No parents are requested.
208        self.nodes[0].bumpmocktime(GETDATA_TX_INTERVAL)
209        peer1.assert_never_requested(int(parent_other["txid"], 16))
210        peer2.assert_never_requested(int(parent_other["txid"], 16))
211        peer2.assert_never_requested(int(parent_overly_large_nonsegwit["txid"], 16))
212
213        self.log.info("Test orphan handling when a segwit parent was invalid but may be retried with another witness")
214        parent_low_fee = self.wallet.create_self_transfer(fee_rate=0)
215        child_low_fee = self.wallet.create_self_transfer(utxo_to_spend=parent_low_fee["new_utxo"])
216
217        # Relay the low fee parent. It should not be accepted.
218        self.relay_transaction(peer1, parent_low_fee["tx"])
219        assert parent_low_fee["txid"] not in node.getrawmempool()
220
221        # Relay the child. It should not be accepted because it has missing inputs.
222        self.relay_transaction(peer2, child_low_fee["tx"])
223        assert child_low_fee["txid"] not in node.getrawmempool()
224        assert tx_in_orphanage(node, child_low_fee["tx"])
225
226        # The parent should be requested because even though the txid commits to the fee, it doesn't
227        # commit to the feerate. Delayed because it's by txid and this is not a preferred relay peer.
228        self.nodes[0].bumpmocktime(NONPREF_PEER_TX_DELAY + TXID_RELAY_DELAY)
229        peer2.wait_for_getdata([parent_low_fee["tx"].txid_int])
230
231        self.log.info("Test orphan handling when a parent was previously downloaded with witness stripped")
232        parent_normal = self.wallet.create_self_transfer()
233        parent1_witness_stripped = tx_from_hex(parent_normal["tx"].serialize_without_witness().hex())
234        child_invalid_witness = self.wallet.create_self_transfer(utxo_to_spend=parent_normal["new_utxo"])
235
236        # Relay the parent with witness stripped. It should not be accepted.
237        self.relay_transaction(peer1, parent1_witness_stripped)
238        assert_equal(parent_normal["txid"], parent1_witness_stripped.txid_hex)
239        assert parent1_witness_stripped.txid_hex not in node.getrawmempool()
240
241        # Relay the child. It should not be accepted because it has missing inputs.
242        self.relay_transaction(peer2, child_invalid_witness["tx"])
243        assert child_invalid_witness["txid"] not in node.getrawmempool()
244        assert tx_in_orphanage(node, child_invalid_witness["tx"])
245
246        # The parent should be requested since the unstripped wtxid would differ. Delayed because
247        # it's by txid and this is not a preferred relay peer.
248        self.nodes[0].bumpmocktime(NONPREF_PEER_TX_DELAY + TXID_RELAY_DELAY)
249        peer2.wait_for_getdata([parent_normal["tx"].txid_int])
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.