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.

12,317 bytes · SHA-256 ef7a4c30fea7661b… · View upstream ↗

1#!/usr/bin/env python3
2# Copyright (c) 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 gettxspendingprevout RPC."""
6
7from test_framework.test_framework import BitcoinTestFramework
8from test_framework.util import (
9    assert_equal,
10    assert_raises_rpc_error,
11)
12from test_framework.wallet import MiniWallet
13
14#### Query Helpers ####
15def prevout(txid, vout):
16    """Build a prevout query dict for use with gettxspendingprevout"""
17    return {'txid': txid, 'vout': vout}
18
19#### Result Helpers ####
20
21def unspent_out(txid, vout):
22    """Expected result for an available output (not spent)"""
23    return {'txid': txid, 'vout': vout}
24
25def spent_out(txid, vout, spending_tx_id):
26    """Expected result for an output with a known spender"""
27    return {'txid': txid, 'vout': vout, 'spendingtxid': spending_tx_id}
28
29def spent_out_in_block(txid, vout, spending_tx_id, blockhash, spending_tx):
30    """Expected result for an output spent in a confirmed block, with full tx data"""
31    return {'txid': txid, 'vout': vout, 'spendingtxid': spending_tx_id, 'blockhash': blockhash, 'spendingtx': spending_tx}
32
33class GetTxSpendingPrevoutTest(BitcoinTestFramework):
34    def set_test_params(self):
35        self.num_nodes = 3
36        self.noban_tx_relay = True
37        self.extra_args = [
38            ["-txospenderindex"],
39            ["-txospenderindex"],
40            [],
41        ]
42
43    def run_test(self):
44        node0, node1, node2 = self.nodes
45        self.wallet = MiniWallet(node0)
46        root_utxo = self.wallet.get_utxo()
47        txid_root_utxo = root_utxo['txid']
48
49        def create_tx(**kwargs):
50            return self.wallet.send_self_transfer_multi(from_node=node0, **kwargs)
51
52        # Create a tree of unconfirmed transactions in the mempool:
53        #             txA
54        #             / \
55        #            /   \
56        #           /     \
57        #          /       \
58        #         /         \
59        #       txB         txC
60        #       / \         / \
61        #      /   \       /   \
62        #    txD   txE   txF   txG
63        #            \   /
64        #             \ /
65        #             txH
66
67        txA = create_tx(utxos_to_spend=[root_utxo], num_outputs=2)
68        txB = create_tx(utxos_to_spend=[txA["new_utxos"][0]], num_outputs=2)
69        txC = create_tx(utxos_to_spend=[txA["new_utxos"][1]], num_outputs=2)
70        txD = create_tx(utxos_to_spend=[txB["new_utxos"][0]], num_outputs=1)
71        txE = create_tx(utxos_to_spend=[txB["new_utxos"][1]], num_outputs=1)
72        txF = create_tx(utxos_to_spend=[txC["new_utxos"][0]], num_outputs=2)
73        txG = create_tx(utxos_to_spend=[txC["new_utxos"][1]], num_outputs=1)
74        txH = create_tx(utxos_to_spend=[txE["new_utxos"][0], txF["new_utxos"][0]], num_outputs=1)
75
76        txs = [txA, txB, txC, txD, txE, txF, txG, txH]
77        txidA, txidB, txidC, txidD, txidE, txidF, txidG, txidH = [tx["txid"] for tx in txs]
78
79        self.sync_mempools()
80        self.wait_until(lambda: node0.getindexinfo()["txospenderindex"]["synced"])
81        self.wait_until(lambda: node1.getindexinfo()["txospenderindex"]["synced"])
82        mempool = node0.getrawmempool()
83        assert_equal(len(mempool), 8)
84        for tx in txs:
85            assert tx["txid"] in mempool
86
87        self.log.info("Find transactions spending outputs")
88        # wait until spending transactions are found in the mempool of node 0, 1 and 2
89        result = node0.gettxspendingprevout([prevout(txid_root_utxo, vout=0), prevout(txidA, vout=1)])
90        assert_equal(result, [spent_out(txid_root_utxo, vout=0, spending_tx_id=txidA),
91                              spent_out(txidA, vout=1, spending_tx_id=txidC)])
92        self.wait_until(lambda: node1.gettxspendingprevout([prevout(txid_root_utxo, vout=0), prevout(txidA, vout=1)]) == result)
93        self.wait_until(lambda: node2.gettxspendingprevout([prevout(txid_root_utxo, vout=0), prevout(txidA, vout=1)], mempool_only=True) == result)
94
95        self.log.info("Find transaction spending multiple outputs")
96        result = node0.gettxspendingprevout([prevout(txidE, vout=0), prevout(txidF, vout=0)])
97        assert_equal(result, [spent_out(txidE, vout=0, spending_tx_id=txidH),
98                              spent_out(txidF, vout=0, spending_tx_id=txidH)])
99
100        self.log.info("Find no transaction when output is unspent")
101        assert_equal(node0.gettxspendingprevout([prevout(txidH, vout=0)]), [unspent_out(txidH, vout=0)])
102        for node in self.nodes:
103            assert_equal(node.gettxspendingprevout([prevout(txidA, vout=5)]), [unspent_out(txidA, vout=5)])
104
105        self.log.info("Mixed spent and unspent outputs")
106        result = node0.gettxspendingprevout([prevout(txidB, vout=0), prevout(txidG, vout=3)])
107        assert_equal(result, [spent_out(txidB, vout=0, spending_tx_id=txidD),
108                              unspent_out(txidG, vout=3)])
109
110        self.log.info("Unknown input fields")
111        assert_raises_rpc_error(-3, "Unexpected key unknown", node0.gettxspendingprevout, [{'txid' : txidC, 'vout' : 1, 'unknown' : 42}])
112
113        self.log.info("Invalid vout provided")
114        assert_raises_rpc_error(-8, "Invalid parameter, vout cannot be negative", node0.gettxspendingprevout, [prevout(txidA, vout=-1)])
115
116        self.log.info("Invalid txid provided")
117        assert_raises_rpc_error(-3, "JSON value of type number for field txid is not of expected type string", node0.gettxspendingprevout, [prevout(42, vout=0)])
118
119        self.log.info("Missing outputs")
120        assert_raises_rpc_error(-8, "Invalid parameter, outputs are missing", node0.gettxspendingprevout, [])
121
122        self.log.info("Missing vout")
123        assert_raises_rpc_error(-3, "Missing vout", node0.gettxspendingprevout, [{'txid' : txidA}])
124
125        self.log.info("Missing txid")
126        assert_raises_rpc_error(-3, "Missing txid", node0.gettxspendingprevout, [{'vout' : 3}])
127
128        blockhash = self.generate(self.wallet, 1)[0]
129        # spending transactions are found in the index of nodes 0 and 1 but not node 2
130        for node in [node0, node1]:
131            result = node.gettxspendingprevout([prevout(txid_root_utxo, vout=0), prevout(txidA, vout=1)], return_spending_tx=True)
132            assert_equal(result, [spent_out_in_block(txid_root_utxo, vout=0, spending_tx_id=txidA, blockhash=blockhash, spending_tx=txA['hex']),
133                                  spent_out_in_block(txidA, vout=1, spending_tx_id=txidC, blockhash=blockhash, spending_tx=txC['hex'])])
134        # Spending transactions not in node 2 (no spending index)
135        result = node2.gettxspendingprevout([prevout(txid_root_utxo, vout=0), prevout(txidA, vout=1)], return_spending_tx=True)
136        assert_equal(result, [unspent_out(txid_root_utxo, vout=0), unspent_out(txidA, vout=1)])
137
138        # spending transaction is not found if we only search the mempool
139        result = node0.gettxspendingprevout([prevout(txid_root_utxo, vout=0), prevout(txidA, vout=1)], return_spending_tx=True, mempool_only=True)
140        assert_equal(result, [unspent_out(txid_root_utxo, vout=0), unspent_out(txidA, vout=1)])
141
142        self.log.info("Check that our txospenderindex is updated when a reorg replaces a spending transaction")
143        reorg_replace_utxo = self.wallet.get_utxo(mark_as_spent=False)
144        txid_reorg_replace_utxo = reorg_replace_utxo['txid']
145
146        tx1 = create_tx(utxos_to_spend=[reorg_replace_utxo], num_outputs=1)
147        blockhash = self.generate(self.wallet, 1)[0]
148
149        # tx1 is confirmed, and indexed in txospenderindex as spending our utxo
150        assert tx1["txid"] not in node0.getrawmempool()
151        result = node0.gettxspendingprevout([prevout(txid_reorg_replace_utxo, vout=0)], return_spending_tx=True)
152        assert_equal(result, [spent_out_in_block(txid_reorg_replace_utxo, vout=0, spending_tx_id=tx1["txid"], blockhash=blockhash, spending_tx=tx1['hex'])])
153
154        # replace tx1 with tx2 triggering a "reorg"
155        best_block_hash = node0.getbestblockhash()
156        for node in self.nodes:
157            node.invalidateblock(best_block_hash)
158            assert tx1["txid"] in node.getrawmempool()
159
160        # create and submit replacement
161        tx2 = create_tx(utxos_to_spend=[reorg_replace_utxo], num_outputs=2)
162        assert tx2["txid"] in node0.getrawmempool()
163
164        # check that when we find tx2 when we look in the mempool for a tx spending our output
165        result = node0.gettxspendingprevout([prevout(txid_reorg_replace_utxo, vout=0)], return_spending_tx=True)
166        assert_equal(result, [ {'txid' : txid_reorg_replace_utxo, 'vout' : 0, 'spendingtxid' : tx2["txid"], 'spendingtx' : tx2['hex']} ])
167
168        # check that our txospenderindex has been updated
169        blockhash = self.generate(self.wallet, 1)[0]
170        result = node0.gettxspendingprevout([prevout(txid_reorg_replace_utxo, vout=0)], return_spending_tx=True)
171        assert_equal(result, [spent_out_in_block(txid_reorg_replace_utxo, vout=0, spending_tx_id=tx2["txid"], blockhash=blockhash, spending_tx=tx2['hex'])])
172
173        self.log.info("Check that our txospenderindex is updated when a reorg cancels a spending transaction")
174        reorg_cancel_utxo = self.wallet.get_utxo(mark_as_spent=False)
175        txid_reorg_cancel_utxo = reorg_cancel_utxo['txid']
176
177        tx1 = create_tx(utxos_to_spend=[reorg_cancel_utxo], num_outputs=1)
178        tx2 = create_tx(utxos_to_spend=[tx1["new_utxos"][0]], num_outputs=1)
179        # tx1 spends our utxo, tx2 spends tx1
180        blockhash = self.generate(self.wallet, 1)[0]
181        # tx1 and tx2 are confirmed, and indexed in txospenderindex
182        result = node0.gettxspendingprevout([prevout(txid_reorg_cancel_utxo, vout=0)], return_spending_tx=True)
183        assert_equal(result, [spent_out_in_block(txid_reorg_cancel_utxo, vout=0, spending_tx_id=tx1["txid"], blockhash=blockhash, spending_tx=tx1['hex'])])
184        result = node0.gettxspendingprevout([prevout(tx1['txid'], vout=0)], return_spending_tx=True)
185        assert_equal(result, [spent_out_in_block(tx1['txid'], vout=0, spending_tx_id=tx2["txid"], blockhash=blockhash, spending_tx=tx2['hex'])])
186
187        # replace tx1 with tx3
188        blockhash = node0.getbestblockhash()
189        for node in self.nodes:
190            node.invalidateblock(blockhash)
191
192        tx3 = create_tx(utxos_to_spend=[reorg_cancel_utxo], num_outputs=2, fee_per_output=2000)
193        node0_mempool = node0.getrawmempool()
194        assert tx3["txid"] in node0_mempool
195        assert tx1["txid"] not in node0_mempool
196        assert tx2["txid"] not in node0_mempool
197
198        # tx2 is not in the mempool anymore, but still in txospender index which has not been rewound yet
199        result = node0.gettxspendingprevout([prevout(tx1['txid'], vout=0)], return_spending_tx=True)
200        assert_equal(result, [spent_out_in_block(tx1['txid'], vout=0, spending_tx_id=tx2["txid"], blockhash=blockhash, spending_tx=tx2['hex'])])
201
202        txinfo = node0.getrawtransaction(tx2["txid"], verbose = True, blockhash = blockhash)
203        assert_equal(txinfo["confirmations"], 0)
204        assert_equal(txinfo["in_active_chain"], False)
205
206        blockhash = self.generate(self.wallet, 1)[0]
207        # we check that the spending tx for tx1 is now tx3
208        result = node0.gettxspendingprevout([prevout(txid_reorg_cancel_utxo, vout=0)], return_spending_tx=True)
209        assert_equal(result, [spent_out_in_block(txid_reorg_cancel_utxo, vout=0, spending_tx_id=tx3["txid"], blockhash=blockhash, spending_tx=tx3['hex'])])
210
211        # we check that there is no more spending tx for tx1
212        result = node0.gettxspendingprevout([prevout(tx1['txid'], vout=0)], return_spending_tx=True)
213        assert_equal(result, [unspent_out(tx1['txid'], vout=0)])
214
215        self.log.info("Check mixed mempool and index result order")
216        tx4 = create_tx(utxos_to_spend=[txH["new_utxos"][0]], num_outputs=1)
217        result = node0.gettxspendingprevout([prevout(txid_reorg_cancel_utxo, vout=0), prevout(txidH, vout=0)])
218        assert_equal(result, [
219            spent_out(txid_reorg_cancel_utxo, vout=0, spending_tx_id=tx3["txid"]) | {"blockhash": blockhash},
220            spent_out(txidH, vout=0, spending_tx_id=tx4["txid"]),
221        ])
222
223
224if __name__ == '__main__':
225    GetTxSpendingPrevoutTest(__file__).main()
226

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.