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.

25,210 bytes · SHA-256 4f77d1ef95bd68a9… · View upstream ↗

1#!/usr/bin/env python3
2# Copyright (c) 2022-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 sendall RPC command."""
6
7from decimal import Decimal, getcontext
8
9from test_framework.messages import SEQUENCE_FINAL
10from test_framework.test_framework import BitcoinTestFramework
11from test_framework.util import (
12    assert_equal,
13    assert_greater_than,
14    assert_greater_than_or_equal,
15    assert_raises_rpc_error,
16)
17
18# Decorator to reset activewallet to zero utxos
19def cleanup(func):
20    def wrapper(self):
21        func(self)
22
23        if 0 < self.wallet.getbalances()["mine"]["trusted"]:
24            self.wallet.sendall([self.remainder_target])
25        assert_equal(0, self.wallet.getbalances()["mine"]["trusted"]) # wallet is empty
26    return wrapper
27
28class SendallTest(BitcoinTestFramework):
29    def skip_test_if_missing_module(self):
30        self.skip_if_no_wallet()
31
32    def set_test_params(self):
33        getcontext().prec=10
34        self.num_nodes = 1
35        self.setup_clean_chain = True
36
37    def assert_balance_swept_completely(self, tx, balance):
38        output_sum = sum([o["value"] for o in tx["decoded"]["vout"]])
39        assert_equal(output_sum, balance + tx["fee"])
40        assert_equal(0, self.wallet.getbalances()["mine"]["trusted"]) # wallet is empty
41
42    def assert_tx_has_output(self, tx, addr, value=None):
43        for output in tx["decoded"]["vout"]:
44            if addr == output["scriptPubKey"]["address"] and value is None or value == output["value"]:
45                return
46        raise AssertionError("Output to {} not present or wrong amount".format(addr))
47
48    def assert_tx_has_outputs(self, tx, expected_outputs):
49        assert_equal(len(expected_outputs), len(tx["decoded"]["vout"]))
50        for eo in expected_outputs:
51            self.assert_tx_has_output(tx, eo["address"], eo["value"])
52
53    def add_utxos(self, amounts):
54        for a in amounts:
55            self.def_wallet.sendtoaddress(self.wallet.getnewaddress(), a)
56        self.generate(self.nodes[0], 1)
57        assert_greater_than(self.wallet.getbalances()["mine"]["trusted"], 0)
58        return self.wallet.getbalances()["mine"]["trusted"]
59
60    # Helper schema for success cases
61    def test_sendall_success(self, sendall_args, remaining_balance = 0, *, options=None):
62        sendall_tx_receipt = self.wallet.sendall(sendall_args, options=options)
63        self.generate(self.nodes[0], 1)
64        # wallet has remaining balance (usually empty)
65        assert_equal(remaining_balance, self.wallet.getbalances()["mine"]["trusted"])
66
67        assert_equal(sendall_tx_receipt["complete"], True)
68        return self.wallet.gettransaction(txid = sendall_tx_receipt["txid"], verbose = True)
69
70    @cleanup
71    def gen_and_clean(self):
72        self.add_utxos([15, 2, 4])
73
74    def test_cleanup(self):
75        self.log.info("Test that cleanup wrapper empties wallet")
76        self.gen_and_clean()
77        assert_equal(0, self.wallet.getbalances()["mine"]["trusted"]) # wallet is empty
78
79    # Actual tests
80    @cleanup
81    def sendall_two_utxos(self):
82        self.log.info("Testing basic sendall case without specific amounts")
83        pre_sendall_balance = self.add_utxos([10,11])
84        tx_from_wallet = self.test_sendall_success(sendall_args = [self.remainder_target])
85
86        self.assert_tx_has_outputs(tx = tx_from_wallet,
87            expected_outputs = [
88                { "address": self.remainder_target, "value": pre_sendall_balance + tx_from_wallet["fee"] } # fee is neg
89            ]
90        )
91        self.assert_balance_swept_completely(tx_from_wallet, pre_sendall_balance)
92
93    @cleanup
94    def sendall_split(self):
95        self.log.info("Testing sendall where two recipients have unspecified amount")
96        pre_sendall_balance = self.add_utxos([1, 2, 3, 15])
97        tx_from_wallet = self.test_sendall_success([self.remainder_target, self.split_target])
98
99        half = (pre_sendall_balance + tx_from_wallet["fee"]) / 2
100        self.assert_tx_has_outputs(tx_from_wallet,
101            expected_outputs = [
102                { "address": self.split_target, "value": half },
103                { "address": self.remainder_target, "value": half }
104            ]
105        )
106        self.assert_balance_swept_completely(tx_from_wallet, pre_sendall_balance)
107
108    @cleanup
109    def sendall_and_spend(self):
110        self.log.info("Testing sendall in combination with paying specified amount to recipient")
111        pre_sendall_balance = self.add_utxos([8, 13])
112        tx_from_wallet = self.test_sendall_success([{self.recipient: 5}, self.remainder_target])
113
114        self.assert_tx_has_outputs(tx_from_wallet,
115            expected_outputs = [
116                { "address": self.recipient, "value": 5 },
117                { "address": self.remainder_target, "value": pre_sendall_balance - 5 + tx_from_wallet["fee"] }
118            ]
119        )
120        self.assert_balance_swept_completely(tx_from_wallet, pre_sendall_balance)
121
122    @cleanup
123    def sendall_invalid_recipient_addresses(self):
124        self.log.info("Test having only recipient with specified amount, missing recipient with unspecified amount")
125        self.add_utxos([12, 9])
126
127        assert_raises_rpc_error(
128                -8,
129                "Must provide at least one address without a specified amount" ,
130                self.wallet.sendall,
131                [{self.recipient: 5}]
132            )
133
134    @cleanup
135    def sendall_duplicate_recipient(self):
136        self.log.info("Test duplicate destination")
137        self.add_utxos([1, 8, 3, 9])
138
139        assert_raises_rpc_error(
140                -8,
141                "Invalid parameter, duplicated address: {}".format(self.remainder_target),
142                self.wallet.sendall,
143                [self.remainder_target, self.remainder_target]
144            )
145
146    @cleanup
147    def sendall_invalid_amounts(self):
148        self.log.info("Test sending more than balance")
149        pre_sendall_balance = self.add_utxos([7, 14])
150
151        expected_tx = self.wallet.sendall(recipients=[{self.recipient: 5}, self.remainder_target], add_to_wallet=False)
152        tx = self.wallet.decoderawtransaction(expected_tx['hex'])
153        fee = 21 - sum([o["value"] for o in tx["vout"]])
154
155        assert_raises_rpc_error(-6, "Assigned more value to outputs than available funds.", self.wallet.sendall,
156                [{self.recipient: pre_sendall_balance + 1}, self.remainder_target])
157        assert_raises_rpc_error(-6, "Insufficient funds for fees after creating specified outputs.", self.wallet.sendall,
158                [{self.recipient: pre_sendall_balance}, self.remainder_target])
159        assert_raises_rpc_error(-8, "Specified output amount to {} is below dust threshold".format(self.recipient),
160                self.wallet.sendall, [{self.recipient: 0.00000001}, self.remainder_target])
161        assert_raises_rpc_error(-6, "Dynamically assigned remainder results in dust output.", self.wallet.sendall,
162                [{self.recipient: pre_sendall_balance - fee}, self.remainder_target])
163        assert_raises_rpc_error(-6, "Dynamically assigned remainder results in dust output.", self.wallet.sendall,
164                [{self.recipient: pre_sendall_balance - fee - Decimal(0.00000010)}, self.remainder_target])
165
166    # @cleanup not needed because different wallet used
167    def sendall_negative_effective_value(self):
168        self.log.info("Test that sendall fails if all UTXOs have negative effective value")
169        # Use dedicated wallet for dust amounts and unload wallet at end
170        self.nodes[0].createwallet("dustwallet")
171        dust_wallet = self.nodes[0].get_wallet_rpc("dustwallet")
172
173        self.def_wallet.sendtoaddress(dust_wallet.getnewaddress(), 0.00000400)
174        self.def_wallet.sendtoaddress(dust_wallet.getnewaddress(), 0.00000300)
175        self.generate(self.nodes[0], 1)
176        assert_greater_than(dust_wallet.getbalances()["mine"]["trusted"], 0)
177
178        assert_raises_rpc_error(-6, "Total value of UTXO pool too low to pay for transaction."
179                + " Try using lower feerate or excluding uneconomic UTXOs with 'send_max' option.",
180                dust_wallet.sendall, recipients=[self.remainder_target], fee_rate=300)
181
182        dust_wallet.unloadwallet()
183
184    @cleanup
185    def sendall_with_send_max(self):
186        self.log.info("Check that `send_max` option causes negative value UTXOs to be left behind")
187        self.add_utxos([0.00000400, 0.00000300, 1])
188
189        # sendall with send_max
190        sendall_tx_receipt = self.wallet.sendall(recipients=[self.remainder_target], fee_rate=300, send_max=True)
191        tx_from_wallet = self.wallet.gettransaction(txid = sendall_tx_receipt["txid"], verbose = True)
192
193        assert_equal(len(tx_from_wallet["decoded"]["vin"]), 1)
194        self.assert_tx_has_outputs(tx_from_wallet, [{"address": self.remainder_target, "value": 1 + tx_from_wallet["fee"]}])
195        assert_equal(self.wallet.getbalances()["mine"]["trusted"], Decimal("0.00000700"))
196
197        self.def_wallet.sendtoaddress(self.wallet.getnewaddress(), 1)
198        self.generate(self.nodes[0], 1)
199
200    @cleanup
201    def sendall_specific_inputs(self):
202        self.log.info("Test sendall with a subset of UTXO pool")
203        self.add_utxos([17, 4])
204        utxo = self.wallet.listunspent()[0]
205
206        sendall_tx_receipt = self.wallet.sendall(recipients=[self.remainder_target], inputs=[utxo])
207        tx_from_wallet = self.wallet.gettransaction(txid = sendall_tx_receipt["txid"], verbose = True)
208        assert_equal(len(tx_from_wallet["decoded"]["vin"]), 1)
209        assert_equal(len(tx_from_wallet["decoded"]["vout"]), 1)
210        assert_equal(tx_from_wallet["decoded"]["vin"][0]["txid"], utxo["txid"])
211        assert_equal(tx_from_wallet["decoded"]["vin"][0]["vout"], utxo["vout"])
212        self.assert_tx_has_output(tx_from_wallet, self.remainder_target)
213
214        self.generate(self.nodes[0], 1)
215        assert_greater_than(self.wallet.getbalances()["mine"]["trusted"], 0)
216
217    @cleanup
218    def sendall_fails_on_missing_input(self):
219        # fails because UTXO was previously spent, and wallet is empty
220        self.log.info("Test sendall fails because specified UTXO is not available")
221        self.add_utxos([16, 5])
222        spent_utxo = self.wallet.listunspent()[0]
223
224        # fails on out of bounds vout
225        assert_raises_rpc_error(-8,
226                "Input not found. UTXO ({}:{}) is not part of wallet.".format(spent_utxo["txid"], 1000),
227                self.wallet.sendall, recipients=[self.remainder_target], inputs=[{"txid": spent_utxo["txid"], "vout": 1000}])
228
229        # fails on unconfirmed spent UTXO
230        self.wallet.sendall(recipients=[self.remainder_target])
231        assert_raises_rpc_error(-8,
232                "Input not available. UTXO ({}:{}) was already spent.".format(spent_utxo["txid"], spent_utxo["vout"]),
233                self.wallet.sendall, recipients=[self.remainder_target], inputs=[spent_utxo])
234
235        # fails on specific previously spent UTXO, while other UTXOs exist
236        self.generate(self.nodes[0], 1)
237        self.add_utxos([19, 2])
238        assert_raises_rpc_error(-8,
239                "Input not available. UTXO ({}:{}) was already spent.".format(spent_utxo["txid"], spent_utxo["vout"]),
240                self.wallet.sendall, recipients=[self.remainder_target], inputs=[spent_utxo])
241
242        # fails because UTXO is unknown, while other UTXOs exist
243        foreign_utxo = self.def_wallet.listunspent()[0]
244        assert_raises_rpc_error(-8, "Input not found. UTXO ({}:{}) is not part of wallet.".format(foreign_utxo["txid"],
245            foreign_utxo["vout"]), self.wallet.sendall, recipients=[self.remainder_target],
246            inputs=[foreign_utxo])
247
248    @cleanup
249    def sendall_fails_on_no_address(self):
250        self.log.info("Test sendall fails because no address is provided")

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.