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.

30,113 bytes · SHA-256 07da8ff5cadad389… · View upstream ↗

1#!/usr/bin/env python3
2# Copyright (c) 2020-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 send RPC command."""
6
7from decimal import Decimal, getcontext
8from itertools import product
9
10from test_framework.descriptors import descsum_create
11from test_framework.extendedkey import ExtendedPrivateKey
12from test_framework.test_framework import BitcoinTestFramework
13from test_framework.util import (
14    assert_not_equal,
15    assert_equal,
16    assert_fee_amount,
17    assert_greater_than,
18    assert_greater_than_or_equal,
19    assert_raises_rpc_error,
20    count_bytes,
21    JSONRPCException,
22)
23from test_framework.wallet_util import (
24    calculate_input_weight,
25    generate_keypair,
26)
27
28
29class WalletSendTest(BitcoinTestFramework):
30    def set_test_params(self):
31        self.num_nodes = 2
32        # whitelist peers to speed up tx relay / mempool sync
33        self.noban_tx_relay = True
34        self.supports_cli = False
35        self.extra_args = [["-datacarriersize=16"]] * self.num_nodes
36        getcontext().prec = 8 # Satoshi precision for Decimal
37
38    def skip_test_if_missing_module(self):
39        self.skip_if_no_wallet()
40
41    def test_send(self, from_wallet, to_wallet=None, amount=None, data=None,
42                  arg_conf_target=None, arg_estimate_mode=None, arg_fee_rate=None,
43                  conf_target=None, estimate_mode=None, fee_rate=None, add_to_wallet=None, psbt=None,
44                  inputs=None, add_inputs=None, include_unsafe=None, change_address=None, change_position=None, change_type=None,
45                  locktime=None, lock_unspents=None, replaceable=None, subtract_fee_from_outputs=None,
46                  expect_error=None, solving_data=None, minconf=None, nonmempool=False):
47        assert_not_equal((amount is None), (data is None))
48
49        from_balance_before = from_wallet.getbalances()["mine"]["trusted"]
50        if include_unsafe:
51            from_balance_before += from_wallet.getbalances()["mine"]["untrusted_pending"]
52
53        if to_wallet is None:
54            assert amount is None
55        else:
56            to_untrusted_pending_before = to_wallet.getbalances()["mine"]["untrusted_pending"]
57
58        if amount:
59            dest = to_wallet.getnewaddress()
60            outputs = {dest: amount}
61        else:
62            outputs = {"data": data}
63
64        # Construct options dictionary
65        options = {}
66        if add_to_wallet is not None:
67            options["add_to_wallet"] = add_to_wallet
68        else:
69            if psbt:
70                add_to_wallet = False
71            else:
72                add_to_wallet = from_wallet.getwalletinfo()["private_keys_enabled"] # Default value
73        if psbt is not None:
74            options["psbt"] = psbt
75        if conf_target is not None:
76            options["conf_target"] = conf_target
77        if estimate_mode is not None:
78            options["estimate_mode"] = estimate_mode
79        if fee_rate is not None:
80            options["fee_rate"] = fee_rate
81        if inputs is not None:
82            options["inputs"] = inputs
83        if add_inputs is not None:
84            options["add_inputs"] = add_inputs
85        if include_unsafe is not None:
86            options["include_unsafe"] = include_unsafe
87        if change_address is not None:
88            options["change_address"] = change_address
89        if change_position is not None:
90            options["change_position"] = change_position
91        if change_type is not None:
92            options["change_type"] = change_type
93        if locktime is not None:
94            options["locktime"] = locktime
95        if lock_unspents is not None:
96            options["lock_unspents"] = lock_unspents
97        if replaceable is None:
98            replaceable = True # default
99        else:
100            options["replaceable"] = replaceable
101        if subtract_fee_from_outputs is not None:
102            options["subtract_fee_from_outputs"] = subtract_fee_from_outputs
103        if solving_data is not None:
104            options["solving_data"] = solving_data
105        if minconf is not None:
106            options["minconf"] = minconf
107
108        if len(options.keys()) == 0:
109            options = None
110
111        expect_sign = from_wallet.getwalletinfo()["private_keys_enabled"]
112        expect_sign = expect_sign and solving_data is None
113        if inputs is not None:
114            expect_sign = expect_sign and all(["weight" not in i for i in inputs])
115
116        if expect_error is None:
117            res = from_wallet.send(outputs=outputs, conf_target=arg_conf_target, estimate_mode=arg_estimate_mode, fee_rate=arg_fee_rate, options=options)
118        else:
119            try:
120                assert_raises_rpc_error(expect_error[0], expect_error[1], from_wallet.send,
121                    outputs=outputs, conf_target=arg_conf_target, estimate_mode=arg_estimate_mode, fee_rate=arg_fee_rate, options=options)
122            except AssertionError:
123                # Provide debug info if the test fails
124                self.log.error("Unexpected successful result:")
125                self.log.error(arg_conf_target)
126                self.log.error(arg_estimate_mode)
127                self.log.error(arg_fee_rate)
128                self.log.error(options)
129                res = from_wallet.send(outputs=outputs, conf_target=arg_conf_target, estimate_mode=arg_estimate_mode, fee_rate=arg_fee_rate, options=options)
130                self.log.error(res)
131                if "txid" in res and add_to_wallet:
132                    self.log.error("Transaction details:")
133                    try:
134                        tx = from_wallet.gettransaction(res["txid"])
135                        self.log.error(tx)
136                        self.log.error("testmempoolaccept (transaction may already be in mempool):")
137                        self.log.error(from_wallet.testmempoolaccept([tx["hex"]]))
138                    except JSONRPCException as exc:
139                        self.log.error(exc)
140
141                raise
142
143            return
144
145        if locktime:
146            assert_equal(from_wallet.gettransaction(txid=res["txid"], verbose=True)["decoded"]["locktime"], locktime)
147            return res
148        else:
149            if add_to_wallet:
150                decoded_tx = from_wallet.gettransaction(txid=res["txid"], verbose=True)["decoded"]
151                # the locktime should be within 100 blocks of the
152                # block height
153                assert_greater_than_or_equal(decoded_tx["locktime"], from_wallet.getblockcount() - 100)
154
155        if expect_sign:
156            assert_equal(res["complete"], True)
157            assert "txid" in res
158        else:
159            assert_equal(res["complete"], False)
160            assert "txid" not in res
161            assert "psbt" in res
162
163        from_balance = from_wallet.getbalances()["mine"]["trusted"]
164        if include_unsafe:
165            from_balance += from_wallet.getbalances()["mine"]["untrusted_pending"]
166
167        if add_to_wallet:
168            # Ensure transaction exists in the wallet:
169            tx = from_wallet.gettransaction(res["txid"])
170            assert tx
171            if nonmempool:
172                assert_raises_rpc_error(-5, "No such mempool transaction", from_wallet.getrawtransaction, res["txid"])
173                assert from_wallet.getbalances()["mine"]["nonmempool"] < 0
174            else:
175                # Ensure transaction exists in the mempool:
176                tx = from_wallet.getrawtransaction(res["txid"], True)
177                assert tx
178                if amount:
179                    if subtract_fee_from_outputs:
180                        assert_equal(from_balance_before - from_balance, amount)
181                    else:
182                        assert_greater_than(from_balance_before - from_balance, amount)
183                else:
184                    assert next((out for out in tx["vout"] if out["scriptPubKey"]["asm"] == "OP_RETURN 35"), None)
185        else:
186            assert_equal(from_balance_before, from_balance)
187
188        if to_wallet:
189            self.sync_mempools()
190            if add_to_wallet:
191                if not subtract_fee_from_outputs:
192                    assert_equal(to_wallet.getbalances()["mine"]["untrusted_pending"], to_untrusted_pending_before + Decimal(amount if amount else 0))
193            else:
194                assert_equal(to_wallet.getbalances()["mine"]["untrusted_pending"], to_untrusted_pending_before)
195
196        return res
197
198    def run_test(self):
199        self.log.info("Setup wallets...")
200        # w0 is a wallet with coinbase rewards
201        w0 = self.nodes[0].get_wallet_rpc(self.default_wallet_name)
202        # w1 is a regular wallet
203        self.nodes[1].createwallet(wallet_name="w1")
204        w1 = self.nodes[1].get_wallet_rpc("w1")
205        # w2 contains the private keys for w3
206        self.nodes[1].createwallet(wallet_name="w2", blank=True)
207        w2 = self.nodes[1].get_wallet_rpc("w2")
208        extendedkey = ExtendedPrivateKey.generate()
209        xpriv = extendedkey.to_string()
210        xpub = extendedkey.pubkey().to_string()
211        w2.importdescriptors([{
212            "desc": descsum_create("wpkh(" + xpriv + "/0/0/*)"),
213            "timestamp": "now",
214            "range": [0, 100],
215            "active": True
216        },{
217            "desc": descsum_create("wpkh(" + xpriv + "/0/1/*)"),
218            "timestamp": "now",
219            "range": [0, 100],
220            "active": True,
221            "internal": True
222        }])
223
224        # w3 is a watch-only wallet, based on w2
225        self.nodes[1].createwallet(wallet_name="w3", disable_private_keys=True)
226        w3 = self.nodes[1].get_wallet_rpc("w3")
227        # Match the privkeys in w2 for descriptors
228        res = w3.importdescriptors([{
229            "desc": descsum_create("wpkh(" + xpub + "/0/0/*)"),
230            "timestamp": "now",
231            "range": [0, 100],
232            "active": True,
233        },{
234            "desc": descsum_create("wpkh(" + xpub + "/0/1/*)"),
235            "timestamp": "now",
236            "range": [0, 100],
237            "active": True,
238            "internal": True,
239        }])
240        assert_equal(res, [{"success": True}, {"success": True}])
241
242        for _ in range(3):
243            a2_receive = w2.getnewaddress()
244        w0.sendtoaddress(a2_receive, 10) # fund w3
245        self.generate(self.nodes[0], 1)
246
247        self.log.info("Send to address...")
248        self.test_send(from_wallet=w0, to_wallet=w1, amount=1)
249        self.test_send(from_wallet=w0, to_wallet=w1, amount=1, add_to_wallet=True)
250

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.