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.

14,389 bytes · SHA-256 4ec14fd14d56737c… · 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 listreceivedbyaddress, listreceivedbylabel, getreceivedybaddress, and getreceivedbylabel RPCs."""
6from decimal import Decimal
7
8from test_framework.blocktools import COINBASE_MATURITY
9from test_framework.test_framework import BitcoinTestFramework
10from test_framework.util import (
11    assert_array_result,
12    assert_equal,
13    assert_raises_rpc_error,
14)
15from test_framework.wallet_util import test_address
16
17
18class ReceivedByTest(BitcoinTestFramework):
19    def set_test_params(self):
20        self.num_nodes = 2
21        # whitelist peers to speed up tx relay / mempool sync
22        self.noban_tx_relay = True
23
24    def skip_test_if_missing_module(self):
25        self.skip_if_no_wallet()
26        self.skip_if_no_cli()
27
28    def run_test(self):
29        # save the number of coinbase reward addresses so far
30        num_cb_reward_addresses = len(self.nodes[1].listreceivedbyaddress(minconf=0, include_empty=True))
31
32        self.log.info("listreceivedbyaddress Test")
33
34        # Send from node 0 to 1
35        addr = self.nodes[1].getnewaddress()
36        txid = self.nodes[0].sendtoaddress(addr, 0.1)
37        self.sync_all()
38
39        # Check not listed in listreceivedbyaddress because has 0 confirmations
40        assert_array_result(self.nodes[1].listreceivedbyaddress(),
41                            {"address": addr},
42                            {},
43                            True)
44        # Bury Tx under 10 block so it will be returned by listreceivedbyaddress
45        self.generate(self.nodes[1], 10)
46        assert_array_result(self.nodes[1].listreceivedbyaddress(),
47                            {"address": addr},
48                            {"address": addr, "label": "", "amount": Decimal("0.1"), "confirmations": 10, "txids": [txid, ]})
49        # With min confidence < 10
50        assert_array_result(self.nodes[1].listreceivedbyaddress(5),
51                            {"address": addr},
52                            {"address": addr, "label": "", "amount": Decimal("0.1"), "confirmations": 10, "txids": [txid, ]})
53        # With min confidence > 10, should not find Tx
54        assert_array_result(self.nodes[1].listreceivedbyaddress(11), {"address": addr}, {}, True)
55
56        # Empty Tx
57        empty_addr = self.nodes[1].getnewaddress()
58        assert_array_result(self.nodes[1].listreceivedbyaddress(0, True),
59                            {"address": empty_addr},
60                            {"address": empty_addr, "label": "", "amount": 0, "confirmations": 0, "txids": []})
61
62        # No returned addy should be a change addr
63        for node in self.nodes:
64            for addr_obj in node.listreceivedbyaddress():
65                assert_equal(node.getaddressinfo(addr_obj["address"])["ischange"], False)
66
67        # Test Address filtering
68        # Only on addr
69        expected = {"address": addr, "label": "", "amount": Decimal("0.1"), "confirmations": 10, "txids": [txid, ]}
70        res = self.nodes[1].listreceivedbyaddress(minconf=0, include_empty=True, address_filter=addr)
71        assert_array_result(res, {"address": addr}, expected)
72        assert_equal(len(res), 1)
73        # Test for regression on CLI calls with address string (#14173)
74        cli_res = self.nodes[1].cli.listreceivedbyaddress(0, True, True, addr)
75        assert_array_result(cli_res, {"address": addr}, expected)
76        assert_equal(len(cli_res), 1)
77        # Error on invalid address
78        assert_raises_rpc_error(-4, "address_filter parameter was invalid", self.nodes[1].listreceivedbyaddress, minconf=0, include_empty=True, address_filter="bamboozling")
79        # Another address receive money
80        res = self.nodes[1].listreceivedbyaddress(0, True, True)
81        assert_equal(len(res), 2 + num_cb_reward_addresses)  # Right now 2 entries
82        other_addr = self.nodes[1].getnewaddress()
83        txid2 = self.nodes[0].sendtoaddress(other_addr, 0.1)
84        self.generate(self.nodes[0], 1)
85        # Same test as above should still pass
86        expected = {"address": addr, "label": "", "amount": Decimal("0.1"), "confirmations": 11, "txids": [txid, ]}
87        res = self.nodes[1].listreceivedbyaddress(0, True, True, addr)
88        assert_array_result(res, {"address": addr}, expected)
89        assert_equal(len(res), 1)
90        # Same test as above but with other_addr should still pass
91        expected = {"address": other_addr, "label": "", "amount": Decimal("0.1"), "confirmations": 1, "txids": [txid2, ]}
92        res = self.nodes[1].listreceivedbyaddress(0, True, True, other_addr)
93        assert_array_result(res, {"address": other_addr}, expected)
94        assert_equal(len(res), 1)
95        # Should be two entries though without filter
96        res = self.nodes[1].listreceivedbyaddress(0, True, True)
97        assert_equal(len(res), 3 + num_cb_reward_addresses)  # Became 3 entries
98
99        # Not on random addr
100        other_addr = self.nodes[0].getnewaddress()  # note on node[0]! just a random addr
101        res = self.nodes[1].listreceivedbyaddress(0, True, True, other_addr)
102        assert_equal(len(res), 0)
103
104        self.log.info("listreceivedbyaddress and listreceivedbylabel exclude not owned addresses")
105        # setlabel assigns a "send" purpose when the wallet doesn't own the address.
106        send_label = "external-address"
107        external_addr = self.nodes[0].getnewaddress(send_label)
108        self.nodes[1].setlabel(external_addr, send_label)
109        assert_equal(self.nodes[1].getaddressinfo(external_addr)["ismine"], False)
110        assert_array_result(self.nodes[1].listreceivedbyaddress(minconf=0, include_empty=True),
111                            {"address": external_addr}, {}, True)
112        assert_array_result(self.nodes[1].listreceivedbylabel(minconf=0, include_empty=True),
113                            {"label": send_label}, {}, True)
114
115        self.log.info("getreceivedbyaddress Test")
116
117        # Send from node 0 to 1
118        addr = self.nodes[1].getnewaddress()
119        txid = self.nodes[0].sendtoaddress(addr, 0.1)
120        self.sync_all()
121
122        # Check balance is 0 because of 0 confirmations
123        balance = self.nodes[1].getreceivedbyaddress(addr)
124        assert_equal(balance, Decimal("0.0"))
125
126        # Check balance is 0.1
127        balance = self.nodes[1].getreceivedbyaddress(addr, 0)
128        assert_equal(balance, Decimal("0.1"))
129
130        # Bury Tx under 10 block so it will be returned by the default getreceivedbyaddress
131        self.generate(self.nodes[1], 10)
132        balance = self.nodes[1].getreceivedbyaddress(addr)
133        assert_equal(balance, Decimal("0.1"))
134
135        # Trying to getreceivedby for an address the wallet doesn't own should return an error
136        assert_raises_rpc_error(-4, "Address not found in wallet", self.nodes[0].getreceivedbyaddress, addr)
137
138        # Test multiple transactions to the same address
139        addr_with_multiple_txs = self.nodes[1].getnewaddress()
140        self.nodes[0].sendtoaddress(addr_with_multiple_txs, Decimal("0.1"))
141        self.nodes[0].sendtoaddress(addr_with_multiple_txs, Decimal("0.2"))
142        self.generate(self.nodes[0], 1)
143        balance = self.nodes[1].getreceivedbyaddress(addr_with_multiple_txs)
144        assert_equal(balance, Decimal("0.3"))
145
146        # Test invalid address format error
147        assert_raises_rpc_error(-5, "Invalid Bitcoin address", self.nodes[1].getreceivedbyaddress, "invalid_address")
148
149        self.log.info("listreceivedbylabel + getreceivedbylabel Test")
150
151        # set pre-state
152        label = ''
153        address = self.nodes[1].getnewaddress()
154        test_address(self.nodes[1], address, labels=[label])
155        received_by_label_json = [r for r in self.nodes[1].listreceivedbylabel() if r["label"] == label][0]
156        balance_by_label = self.nodes[1].getreceivedbylabel(label)
157
158        txid = self.nodes[0].sendtoaddress(addr, 0.1)
159        self.sync_all()
160
161        # getreceivedbylabel returns an error if the wallet doesn't own the label
162        assert_raises_rpc_error(-4, "Label not found in wallet", self.nodes[0].getreceivedbylabel, "dummy")
163
164        # listreceivedbylabel should return received_by_label_json because of 0 confirmations
165        assert_array_result(self.nodes[1].listreceivedbylabel(),
166                            {"label": label},
167                            received_by_label_json)
168
169        # getreceivedbylabel should return same balance because of 0 confirmations
170        balance = self.nodes[1].getreceivedbylabel(label)
171        assert_equal(balance, balance_by_label)
172
173        self.generate(self.nodes[1], 10)
174        # listreceivedbylabel should return updated received list
175        assert_array_result(self.nodes[1].listreceivedbylabel(),
176                            {"label": label},
177                            {"label": received_by_label_json["label"], "amount": (received_by_label_json["amount"] + Decimal("0.1"))})
178
179        # getreceivedbylabel should return updated receive total
180        balance = self.nodes[1].getreceivedbylabel(label)
181        assert_equal(balance, balance_by_label + Decimal("0.1"))
182
183        # Create a new label named "mynewlabel" that has a 0 balance
184        address = self.nodes[1].getnewaddress()
185        self.nodes[1].setlabel(address, "mynewlabel")
186        received_by_label_json = [r for r in self.nodes[1].listreceivedbylabel(0, True) if r["label"] == "mynewlabel"][0]
187
188        # Test includeempty of listreceivedbylabel
189        assert_equal(received_by_label_json["amount"], Decimal("0.0"))
190
191        # Test getreceivedbylabel for 0 amount labels
192        balance = self.nodes[1].getreceivedbylabel("mynewlabel")
193        assert_equal(balance, Decimal("0.0"))
194
195        self.log.info("Tests for including coinbase outputs")
196
197        # Generate block reward to address with label
198        label = "label"
199        address = self.nodes[0].getnewaddress(label)
200
201        reward = Decimal("25")
202        self.generatetoaddress(self.nodes[0], 1, address)
203        hash = self.nodes[0].getbestblockhash()
204
205        self.log.info("getreceivedbyaddress returns nothing with defaults")
206        balance = self.nodes[0].getreceivedbyaddress(address)
207        assert_equal(balance, 0)
208
209        self.log.info("getreceivedbyaddress returns block reward when including immature coinbase")
210        balance = self.nodes[0].getreceivedbyaddress(address=address, include_immature_coinbase=True)
211        assert_equal(balance, reward)
212
213        self.log.info("getreceivedbylabel returns nothing with defaults")
214        balance = self.nodes[0].getreceivedbylabel("label")
215        assert_equal(balance, 0)
216
217        self.log.info("getreceivedbylabel returns block reward when including immature coinbase")
218        balance = self.nodes[0].getreceivedbylabel(label="label", include_immature_coinbase=True)
219        assert_equal(balance, reward)
220
221        self.log.info("listreceivedbyaddress does not include address with defaults")
222        assert_array_result(self.nodes[0].listreceivedbyaddress(),
223                            {"address": address},
224                            {}, True)
225
226        self.log.info("listreceivedbyaddress includes address when including immature coinbase")
227        assert_array_result(self.nodes[0].listreceivedbyaddress(minconf=1, include_immature_coinbase=True),
228                            {"address": address},
229                            {"address": address, "amount": reward})
230
231        self.log.info("listreceivedbylabel does not include label with defaults")
232        assert_array_result(self.nodes[0].listreceivedbylabel(),
233                            {"label": label},
234                            {}, True)
235
236        self.log.info("listreceivedbylabel includes label when including immature coinbase")
237        assert_array_result(self.nodes[0].listreceivedbylabel(minconf=1, include_immature_coinbase=True),
238                            {"label": label},
239                            {"label": label, "amount": reward})
240
241        self.log.info("Generate 100 more blocks")
242        self.generate(self.nodes[0], COINBASE_MATURITY)
243
244        self.log.info("getreceivedbyaddress returns reward with defaults")
245        balance = self.nodes[0].getreceivedbyaddress(address)
246        assert_equal(balance, reward)
247
248        self.log.info("getreceivedbylabel returns reward with defaults")
249        balance = self.nodes[0].getreceivedbylabel("label")
250        assert_equal(balance, reward)

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.