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.

20,237 bytes · SHA-256 26bffd87ade3182b… · 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 the listtransactions API."""
6
7from decimal import Decimal
8import time
9import os
10import shutil
11
12from test_framework.blocktools import MAX_FUTURE_BLOCK_TIME
13from test_framework.descriptors import descsum_create
14from test_framework.extendedkey import ExtendedPrivateKey
15from test_framework.test_framework import BitcoinTestFramework
16from test_framework.util import (
17    assert_not_equal,
18    assert_array_result,
19    assert_equal,
20    assert_greater_than,
21    assert_raises_rpc_error,
22    find_vout_for_address,
23)
24from test_framework.wallet_util import get_generate_key
25
26
27class ListTransactionsTest(BitcoinTestFramework):
28    def set_test_params(self):
29        self.num_nodes = 3
30        # whitelist peers to speed up tx relay / mempool sync
31        self.noban_tx_relay = True
32
33    def skip_test_if_missing_module(self):
34        self.skip_if_no_wallet()
35
36    def run_test(self):
37        self.log.info("Test simple send from node0 to node1")
38        txid = self.nodes[0].sendtoaddress(self.nodes[1].getnewaddress(), 0.1)
39        self.sync_all()
40        assert_array_result(self.nodes[0].listtransactions(),
41                            {"txid": txid},
42                            {"category": "send", "amount": Decimal("-0.1"), "confirmations": 0, "trusted": True})
43        assert_array_result(self.nodes[1].listtransactions(),
44                            {"txid": txid},
45                            {"category": "receive", "amount": Decimal("0.1"), "confirmations": 0, "trusted": False})
46        self.log.info("Test confirmations change after mining a block")
47        blockhash = self.generate(self.nodes[0], 1)[0]
48        blockheight = self.nodes[0].getblockheader(blockhash)['height']
49        assert_array_result(self.nodes[0].listtransactions(),
50                            {"txid": txid},
51                            {"category": "send", "amount": Decimal("-0.1"), "confirmations": 1, "blockhash": blockhash, "blockheight": blockheight})
52        assert_array_result(self.nodes[1].listtransactions(),
53                            {"txid": txid},
54                            {"category": "receive", "amount": Decimal("0.1"), "confirmations": 1, "blockhash": blockhash, "blockheight": blockheight})
55
56        self.log.info("Test send-to-self on node0")
57        txid = self.nodes[0].sendtoaddress(self.nodes[0].getnewaddress(), 0.2)
58        assert_array_result(self.nodes[0].listtransactions(),
59                            {"txid": txid, "category": "send"},
60                            {"amount": Decimal("-0.2")})
61        assert_array_result(self.nodes[0].listtransactions(),
62                            {"txid": txid, "category": "receive"},
63                            {"amount": Decimal("0.2")})
64
65        self.log.info("Test sendmany from node1: twice to self, twice to node0")
66        send_to = {self.nodes[0].getnewaddress(): 0.11,
67                   self.nodes[1].getnewaddress(): 0.22,
68                   self.nodes[0].getnewaddress(): 0.33,
69                   self.nodes[1].getnewaddress(): 0.44}
70        txid = self.nodes[1].sendmany("", send_to)
71        self.sync_all()
72        assert_array_result(self.nodes[1].listtransactions(),
73                            {"category": "send", "amount": Decimal("-0.11")},
74                            {"txid": txid})
75        assert_array_result(self.nodes[0].listtransactions(),
76                            {"category": "receive", "amount": Decimal("0.11")},
77                            {"txid": txid})
78        assert_array_result(self.nodes[1].listtransactions(),
79                            {"category": "send", "amount": Decimal("-0.22")},
80                            {"txid": txid})
81        assert_array_result(self.nodes[1].listtransactions(),
82                            {"category": "receive", "amount": Decimal("0.22")},
83                            {"txid": txid})
84        assert_array_result(self.nodes[1].listtransactions(),
85                            {"category": "send", "amount": Decimal("-0.33")},
86                            {"txid": txid})
87        assert_array_result(self.nodes[0].listtransactions(),
88                            {"category": "receive", "amount": Decimal("0.33")},
89                            {"txid": txid})
90        assert_array_result(self.nodes[1].listtransactions(),
91                            {"category": "send", "amount": Decimal("-0.44")},
92                            {"txid": txid})
93        assert_array_result(self.nodes[1].listtransactions(),
94                            {"category": "receive", "amount": Decimal("0.44")},
95                            {"txid": txid})
96
97        self.run_externally_generated_address_test()
98        self.run_coinjoin_test()
99        self.run_invalid_parameters_test()
100        self.test_op_return()
101        self.test_alternate_witness_tx()
102        self.test_from_me_status_change()
103
104    def run_externally_generated_address_test(self):
105        """Test behavior when receiving address is not in the address book."""
106
107        self.log.info("Setup the same wallet on two nodes")
108        # refill keypool otherwise the second node wouldn't recognize addresses generated on the first nodes
109        self.nodes[0].keypoolrefill(1000)
110        self.stop_nodes()
111        wallet0 = os.path.join(self.nodes[0].chain_path, self.default_wallet_name, "wallet.dat")
112        wallet2 = os.path.join(self.nodes[2].chain_path, self.default_wallet_name, "wallet.dat")
113        shutil.copyfile(wallet0, wallet2)
114        self.start_nodes()
115        # reconnect nodes
116        self.connect_nodes(0, 1)
117        self.connect_nodes(1, 2)
118        self.connect_nodes(2, 0)
119
120        addr1 = self.nodes[0].getnewaddress("pizza1", 'legacy')
121        addr2 = self.nodes[0].getnewaddress("pizza2", 'p2sh-segwit')
122        addr3 = self.nodes[0].getnewaddress("pizza3", 'bech32')
123
124        self.log.info("Send to externally generated addresses")
125        # send to an address beyond the next to be generated to test the keypool gap
126        self.nodes[1].sendtoaddress(addr3, "0.001")
127        self.generate(self.nodes[1], 1)
128
129        # send to an address that is already marked as used due to the keypool gap mechanics
130        self.nodes[1].sendtoaddress(addr2, "0.001")
131        self.generate(self.nodes[1], 1)
132
133        # send to self transaction
134        self.nodes[0].sendtoaddress(addr1, "0.001")
135        self.generate(self.nodes[0], 1)
136
137        self.log.info("Verify listtransactions is the same regardless of where the address was generated")
138        transactions0 = self.nodes[0].listtransactions()
139        transactions2 = self.nodes[2].listtransactions()
140
141        # normalize results: remove fields that normally could differ and sort
142        def normalize_list(txs):
143            for tx in txs:
144                tx.pop('label', None)
145                tx.pop('time', None)
146                tx.pop('timereceived', None)
147            txs.sort(key=lambda x: x['txid'])
148
149        normalize_list(transactions0)
150        normalize_list(transactions2)
151        assert_equal(transactions0, transactions2)
152
153        self.log.info("Verify labels are persistent on the node that generated the addresses")
154        assert_equal(['pizza1'], self.nodes[0].getaddressinfo(addr1)['labels'])
155        assert_equal(['pizza2'], self.nodes[0].getaddressinfo(addr2)['labels'])
156        assert_equal(['pizza3'], self.nodes[0].getaddressinfo(addr3)['labels'])
157
158    def run_coinjoin_test(self):
159        self.log.info('Check "coin-join" transaction')
160        input_0 = next(i for i in self.nodes[0].listunspent(query_options={"minimumAmount": 0.2}, include_unsafe=False))
161        input_1 = next(i for i in self.nodes[1].listunspent(query_options={"minimumAmount": 0.2}, include_unsafe=False))
162        raw_hex = self.nodes[0].createrawtransaction(
163            inputs=[
164                {
165                    "txid": input_0["txid"],
166                    "vout": input_0["vout"],
167                },
168                {
169                    "txid": input_1["txid"],
170                    "vout": input_1["vout"],
171                },
172            ],
173            outputs={
174                self.nodes[0].getnewaddress(): 0.123,
175                self.nodes[1].getnewaddress(): 0.123,
176            },
177        )
178        raw_hex = self.nodes[0].signrawtransactionwithwallet(raw_hex)["hex"]
179        raw_hex = self.nodes[1].signrawtransactionwithwallet(raw_hex)["hex"]
180        txid_join = self.nodes[0].sendrawtransaction(hexstring=raw_hex, maxfeerate=0)
181        fee_join = self.nodes[0].getmempoolentry(txid_join)["fees"]["base"]
182        # Fee should be correct: assert_equal(fee_join, self.nodes[0].gettransaction(txid_join)['fee'])
183        # But it is not, see for example https://github.com/bitcoin/bitcoin/issues/14136:
184        assert_not_equal(fee_join, self.nodes[0].gettransaction(txid_join)["fee"])
185
186    def run_invalid_parameters_test(self):
187        self.log.info("Test listtransactions RPC parameter validity")
188        assert_raises_rpc_error(-8, 'Label argument must be a valid label name or "*".', self.nodes[0].listtransactions, label="")
189        self.nodes[0].listtransactions(label="*")
190        assert_raises_rpc_error(-8, "Negative count", self.nodes[0].listtransactions, count=-1)
191        assert_raises_rpc_error(-8, "Negative from", self.nodes[0].listtransactions, skip=-1)
192
193    def test_op_return(self):
194        """Test if OP_RETURN outputs will be displayed correctly."""
195        raw_tx = self.nodes[0].createrawtransaction([], [{'data': 'aa'}])
196        funded_tx = self.nodes[0].fundrawtransaction(raw_tx)
197        signed_tx = self.nodes[0].signrawtransactionwithwallet(funded_tx['hex'])
198        tx_id = self.nodes[0].sendrawtransaction(signed_tx['hex'])
199
200        op_ret_tx = [tx for tx in self.nodes[0].listtransactions() if tx['txid'] == tx_id][0]
201
202        assert 'address' not in op_ret_tx
203
204    def test_from_me_status_change(self):
205        self.log.info("Test gettransaction after changing a transaction's 'from me' status")
206        self.nodes[0].createwallet("fromme")
207        default_wallet = self.nodes[0].get_wallet_rpc(self.default_wallet_name)
208        wallet = self.nodes[0].get_wallet_rpc("fromme")
209
210        # The 'fee' field of gettransaction is only added when the transaction is 'from me'
211        # Run twice, once for a transaction in the mempool, again when it confirms
212        for confirm in [False, True]:
213            key = get_generate_key()
214            descriptor = descsum_create(f"wpkh({key.privkey})")
215            default_wallet.importdescriptors([{"desc": descriptor, "timestamp": "now"}])
216
217            send_res = default_wallet.send(outputs=[{key.p2wpkh_addr: 1}, {wallet.getnewaddress(): 1}])
218            assert_equal(send_res["complete"], True)
219            vout = find_vout_for_address(self.nodes[0], send_res["txid"], key.p2wpkh_addr)
220            utxos = [{"txid": send_res["txid"], "vout": vout}]
221            self.generate(self.nodes[0], 1, sync_fun=self.no_op)
222
223            # Send to the test wallet, ensuring that one input is for the descriptor we will import,
224            # and that there are other inputs belonging to only the sending wallet
225            send_res = default_wallet.send(outputs=[{wallet.getnewaddress(): 1.5}], inputs=utxos, add_inputs=True)
226            assert_equal(send_res["complete"], True)
227            txid = send_res["txid"]
228            self.nodes[0].syncwithvalidationinterfacequeue()
229            tx_info = wallet.gettransaction(txid)
230            assert "fee" not in tx_info
231            assert_equal(any(detail["category"] == "send" for detail in tx_info["details"]), False)
232
233            if confirm:
234                self.generate(self.nodes[0], 1, sync_fun=self.no_op)
235                # Mock time forward and generate blocks so that the import does not rescan the transaction
236                self.nodes[0].setmocktime(int(time.time()) + MAX_FUTURE_BLOCK_TIME + 1)
237                self.generate(self.nodes[0], 10, sync_fun=self.no_op)
238
239            import_res = wallet.importdescriptors([{"desc": descriptor, "timestamp": "now"}])
240            assert_equal(import_res[0]["success"], True)
241            # TODO: We should check that the fee matches, but since the transaction spends inputs
242            # not known to the wallet, it is incorrectly calculating the fee.
243            # assert_equal(wallet.gettransaction(txid)["fee"], fee)
244            tx_info = wallet.gettransaction(txid)
245            assert "fee" in tx_info
246            assert_equal(any(detail["category"] == "send" for detail in tx_info["details"]), True)
247
248    def check_tx_variants(self, wallet, txid, canonical_tx_hex, canonical_wtxid, alternate_wtxids):
249        """Assert gettransaction and listtransactions report tx variants properly"""
250        tx_info = wallet.gettransaction(txid)

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.