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,782 bytes · SHA-256 2d7295b00bf0dfa2… · 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"""Tests for orphan related RPCs."""
6
7from test_framework.mempool_util import (
8    tx_in_orphanage,
9)
10from test_framework.messages import (
11    CInv,
12    msg_inv,
13    msg_tx,
14    MSG_WTX,
15)
16from test_framework.p2p import P2PInterface
17from test_framework.util import (
18    assert_equal,
19    assert_not_equal,
20    assert_raises_rpc_error,
21)
22from test_framework.test_framework import BitcoinTestFramework
23from test_framework.wallet import MiniWallet
24
25
26class OrphanRPCsTest(BitcoinTestFramework):
27    def set_test_params(self):
28        self.num_nodes = 1
29
30    def run_test(self):
31        self.wallet = MiniWallet(self.nodes[0])
32        self.test_orphan_activity()
33        self.test_orphan_details()
34        self.test_misc()
35
36    def test_orphan_activity(self):
37        self.log.info("Check that orphaned transactions are returned with getorphantxs")
38        node = self.nodes[0]
39
40        self.log.info("Create two 1P1C packages, but only broadcast the children")
41        tx_parent_1 = self.wallet.create_self_transfer()
42        tx_child_1 = self.wallet.create_self_transfer(utxo_to_spend=tx_parent_1["new_utxo"])
43        tx_parent_2 = self.wallet.create_self_transfer()
44        tx_child_2 = self.wallet.create_self_transfer(utxo_to_spend=tx_parent_2["new_utxo"])
45        peer = node.add_p2p_connection(P2PInterface())
46        peer.send_and_ping(msg_tx(tx_child_1["tx"]))
47        peer.send_and_ping(msg_tx(tx_child_2["tx"]))
48
49        self.log.info("Check that neither parent is in the mempool")
50        assert_equal(node.getmempoolinfo()["size"], 0)
51
52        orphanage = node.getorphantxs(verbosity=0)
53        self.log.info("Check the size of the orphanage")
54        assert_equal(len(orphanage), 2)
55        self.log.info("Check that undefined verbosity is disallowed")
56        assert_raises_rpc_error(-8, "Invalid verbosity value -1", node.getorphantxs, verbosity=-1)
57        assert_raises_rpc_error(-8, "Invalid verbosity value 3", node.getorphantxs, verbosity=3)
58        self.log.info("Check that both children are in the orphanage")
59        assert tx_in_orphanage(node, tx_child_1["tx"])
60        assert tx_in_orphanage(node, tx_child_2["tx"])
61
62        self.log.info("Broadcast parent 1")
63        peer.send_and_ping(msg_tx(tx_parent_1["tx"]))
64        self.log.info("Check that parent 1 and child 1 are in the mempool")
65        raw_mempool = node.getrawmempool()
66        assert_equal(len(raw_mempool), 2)
67        assert tx_parent_1["txid"] in raw_mempool
68        assert tx_child_1["txid"] in raw_mempool
69
70        self.log.info("Check that orphanage only contains child 2")
71        orphanage = node.getorphantxs()
72        assert_equal(len(orphanage), 1)
73        assert tx_in_orphanage(node, tx_child_2["tx"])
74
75        peer.send_and_ping(msg_tx(tx_parent_2["tx"]))
76        self.log.info("Check that all parents and children are now in the mempool")
77        raw_mempool = node.getrawmempool()
78        assert_equal(len(raw_mempool), 4)
79        assert tx_parent_1["txid"] in raw_mempool
80        assert tx_child_1["txid"] in raw_mempool
81        assert tx_parent_2["txid"] in raw_mempool
82        assert tx_child_2["txid"] in raw_mempool
83        self.log.info("Check that the orphanage is empty")
84        assert_equal(len(node.getorphantxs()), 0)
85
86        self.log.info("Confirm the transactions (clears mempool)")
87        self.generate(node, 1)
88        assert_equal(node.getmempoolinfo()["size"], 0)
89
90    def test_orphan_details(self):
91        self.log.info("Check the transaction details returned from getorphantxs")
92        node = self.nodes[0]
93
94        self.log.info("Create two orphans, from different peers")
95        tx_parent_1 = self.wallet.create_self_transfer()
96        tx_child_1 = self.wallet.create_self_transfer(utxo_to_spend=tx_parent_1["new_utxo"])
97        tx_parent_2 = self.wallet.create_self_transfer()
98        tx_child_2 = self.wallet.create_self_transfer(utxo_to_spend=tx_parent_2["new_utxo"])
99        peer_1 = node.add_p2p_connection(P2PInterface())
100        peer_2 = node.add_p2p_connection(P2PInterface())
101        peer_1.send_and_ping(msg_tx(tx_child_1["tx"]))
102        peer_2.send_and_ping(msg_tx(tx_child_2["tx"]))
103
104        orphanage = node.getorphantxs(verbosity=2)
105        assert tx_in_orphanage(node, tx_child_1["tx"])
106        assert tx_in_orphanage(node, tx_child_2["tx"])
107
108        self.log.info("Check that orphan 1 and 2 were from different peers")
109        assert_not_equal(orphanage[0]["from"][0], orphanage[1]["from"][0])
110        peer_ids = [orphanage[0]["from"][0], orphanage[1]["from"][0]]
111
112        self.log.info("Unorphan child 2")
113        peer_2.send_and_ping(msg_tx(tx_parent_2["tx"]))
114        assert not tx_in_orphanage(node, tx_child_2["tx"])
115
116        self.log.info("Check that additional announcers are reflected in RPC result")
117        peer_2.send_and_ping(msg_inv([CInv(t=MSG_WTX, h=int(tx_child_1["wtxid"], 16))]))
118
119        orphanage = node.getorphantxs(verbosity=2)
120        assert_equal(set(orphanage[0]["from"]), set(peer_ids))
121
122        self.log.info("Checking orphan details")
123        assert_equal(len(node.getorphantxs()), 1)
124        orphan_1 = orphanage[0]
125        self.orphan_details_match(orphan_1, tx_child_1, verbosity=1)
126
127        self.log.info("Checking orphan details (verbosity 2)")
128        orphanage = node.getorphantxs(verbosity=2)
129        orphan_1 = orphanage[0]
130        self.orphan_details_match(orphan_1, tx_child_1, verbosity=2)
131
132    def orphan_details_match(self, orphan, tx, verbosity):
133        self.log.info("Check txid/wtxid of orphan")
134        assert_equal(orphan["txid"], tx["txid"])
135        assert_equal(orphan["wtxid"], tx["wtxid"])
136
137        self.log.info("Check the sizes of orphan")
138        assert_equal(orphan["bytes"], len(tx["tx"].serialize()))
139        assert_equal(orphan["vsize"], tx["tx"].get_vsize())
140        assert_equal(orphan["weight"], tx["tx"].get_weight())
141
142        if verbosity == 2:
143            self.log.info("Check the transaction hex of orphan")
144            assert_equal(orphan["hex"], tx["hex"])
145
146    def test_misc(self):
147        node = self.nodes[0]
148        assert_raises_rpc_error(-3, "Verbosity was boolean but only integer allowed", node.getorphantxs, verbosity=True)
149        assert_raises_rpc_error(-3, "Verbosity was boolean but only integer allowed", node.getorphantxs, verbosity=False)
150        help_output = node.help()
151        self.log.info("Check that getorphantxs is a hidden RPC")
152        assert "getorphantxs" not in help_output
153        assert "unknown command: getorphantxs" not in node.help("getorphantxs")
154
155
156if __name__ == '__main__':
157    OrphanRPCsTest(__file__).main()
158

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.