Coverage Report

Created: 2026-07-20 20:52

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/tmp/bitcoin/src/wallet/rpc/spend.cpp
Line
Count
Source
1
// Copyright (c) 2011-present The Bitcoin Core developers
2
// Distributed under the MIT software license, see the accompanying
3
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
4
5
#include <common/messages.h>
6
#include <consensus/validation.h>
7
#include <core_io.h>
8
#include <key_io.h>
9
#include <node/types.h>
10
#include <policy/policy.h>
11
#include <policy/truc_policy.h>
12
#include <rpc/rawtransaction_util.h>
13
#include <rpc/util.h>
14
#include <script/script.h>
15
#include <util/rbf.h>
16
#include <util/translation.h>
17
#include <util/vector.h>
18
#include <wallet/coincontrol.h>
19
#include <wallet/feebumper.h>
20
#include <wallet/fees.h>
21
#include <wallet/rpc/util.h>
22
#include <wallet/spend.h>
23
#include <wallet/wallet.h>
24
25
#include <univalue.h>
26
27
using common::FeeModeFromString;
28
using common::FeeModesDetail;
29
using common::InvalidEstimateModeErrorMessage;
30
using common::StringForFeeReason;
31
using common::TransactionErrorString;
32
using node::TransactionError;
33
34
namespace wallet {
35
std::vector<CRecipient> CreateRecipients(const std::vector<std::pair<CTxDestination, CAmount>>& outputs, const std::set<int>& subtract_fee_outputs)
36
1.96k
{
37
1.96k
    std::vector<CRecipient> recipients;
38
23.0k
    for (size_t i = 0; i < outputs.size(); ++i) {
39
21.0k
        const auto& [destination, amount] = outputs.at(i);
40
21.0k
        CRecipient recipient{destination, amount, subtract_fee_outputs.contains(i)};
41
21.0k
        recipients.push_back(recipient);
42
21.0k
    }
43
1.96k
    return recipients;
44
1.96k
}
45
46
static void InterpretFeeEstimationInstructions(const UniValue& conf_target, const UniValue& estimate_mode, const UniValue& fee_rate, UniValue& options)
47
392
{
48
392
    if (options.exists("conf_target") || options.exists("estimate_mode")) {
49
24
        if (!conf_target.isNull() || !estimate_mode.isNull()) {
50
3
            throw JSONRPCError(RPC_INVALID_PARAMETER, "Pass conf_target and estimate_mode either as arguments or in the options object, but not both");
51
3
        }
52
368
    } else {
53
368
        options.pushKV("conf_target", conf_target);
54
368
        options.pushKV("estimate_mode", estimate_mode);
55
368
    }
56
389
    if (options.exists("fee_rate")) {
57
28
        if (!fee_rate.isNull()) {
58
1
            throw JSONRPCError(RPC_INVALID_PARAMETER, "Pass the fee_rate either as an argument, or in the options object, but not both");
59
1
        }
60
361
    } else {
61
361
        options.pushKV("fee_rate", fee_rate);
62
361
    }
63
388
    if (!options["conf_target"].isNull() && (options["estimate_mode"].isNull() || (options["estimate_mode"].get_str() == "unset"))) {
64
0
        throw JSONRPCError(RPC_INVALID_PARAMETER, "Specify estimate_mode");
65
0
    }
66
388
}
67
68
std::set<int> InterpretSubtractFeeFromOutputInstructions(const UniValue& sffo_instructions, const std::vector<std::string>& destinations)
69
745
{
70
745
    std::set<int> sffo_set;
71
745
    if (sffo_instructions.isNull()) return sffo_set;
72
73
105
    for (const auto& sffo : sffo_instructions.getValues()) {
74
105
        int pos{-1};
75
105
        if (sffo.isStr()) {
76
9
            auto it = find(destinations.begin(), destinations.end(), sffo.get_str());
77
9
            if (it == destinations.end()) throw JSONRPCError(RPC_INVALID_PARAMETER, strprintf("Invalid parameter 'subtract fee from output', destination %s not found in tx outputs", sffo.get_str()));
78
8
            pos = it - destinations.begin();
79
96
        } else if (sffo.isNum()) {
80
95
            pos = sffo.getInt<int>();
81
95
        } else {
82
1
            throw JSONRPCError(RPC_INVALID_PARAMETER, strprintf("Invalid parameter 'subtract fee from output', invalid value type: %s", uvTypeName(sffo.type())));
83
1
        }
84
85
103
        if (sffo_set.contains(pos))
86
2
            throw JSONRPCError(RPC_INVALID_PARAMETER, strprintf("Invalid parameter 'subtract fee from output', duplicated position: %d", pos));
87
101
        if (pos < 0)
88
1
            throw JSONRPCError(RPC_INVALID_PARAMETER, strprintf("Invalid parameter 'subtract fee from output', negative position: %d", pos));
89
100
        if (pos >= int(destinations.size()))
90
1
            throw JSONRPCError(RPC_INVALID_PARAMETER, strprintf("Invalid parameter 'subtract fee from output', position too large: %d", pos));
91
99
        sffo_set.insert(pos);
92
99
    }
93
95
    return sffo_set;
94
101
}
95
96
static UniValue FinishTransaction(const std::shared_ptr<CWallet> pwallet, const UniValue& options, CMutableTransaction& rawTx)
97
247
{
98
247
    bool can_anti_fee_snipe = !options.exists("locktime");
99
100
1.40k
    for (const CTxIn& tx_in : rawTx.vin) {
101
        // Checks sequence values consistent with DiscourageFeeSniping
102
1.40k
        can_anti_fee_snipe = can_anti_fee_snipe && (tx_in.nSequence == CTxIn::MAX_SEQUENCE_NONFINAL || tx_in.nSequence == MAX_BIP125_RBF_SEQUENCE);
103
1.40k
    }
104
105
247
    if (can_anti_fee_snipe) {
106
241
        LOCK(pwallet->cs_wallet);
107
241
        FastRandomContext rng_fast;
108
241
        DiscourageFeeSniping(rawTx, rng_fast, pwallet->chain(), pwallet->GetLastBlockHash(), pwallet->GetLastBlockHeight());
109
241
    }
110
111
    // Make a blank psbt
112
247
    PartiallySignedTransaction psbtx(rawTx, /*version=*/2);
113
114
    // First fill transaction with our data without signing,
115
    // so external signers are not asked to sign more than once.
116
247
    bool complete;
117
247
    pwallet->FillPSBT(psbtx, {.sign = false, .bip32_derivs = true}, complete);
118
247
    const auto err{pwallet->FillPSBT(psbtx, {.sign = true, .bip32_derivs = false}, complete)};
119
247
    if (err) {
120
1
        throw JSONRPCPSBTError(*err);
121
1
    }
122
123
246
    CMutableTransaction mtx;
124
246
    complete = FinalizeAndExtractPSBT(psbtx, mtx);
125
126
246
    UniValue result(UniValue::VOBJ);
127
128
246
    const bool psbt_opt_in{options.exists("psbt") && options["psbt"].get_bool()};
129
246
    bool add_to_wallet{options.exists("add_to_wallet") ? options["add_to_wallet"].get_bool() : true};
130
246
    if (psbt_opt_in || !complete || !add_to_wallet) {
131
        // Serialize the PSBT
132
60
        DataStream ssTx{};
133
60
        ssTx << psbtx;
134
60
        result.pushKV("psbt", EncodeBase64(ssTx.str()));
135
60
    }
136
137
246
    if (complete) {
138
218
        std::string hex{EncodeHexTx(CTransaction(mtx))};
139
218
        CTransactionRef tx(MakeTransactionRef(std::move(mtx)));
140
218
        result.pushKV("txid", tx->GetHash().GetHex());
141
218
        if (add_to_wallet && !psbt_opt_in) {
142
186
            pwallet->CommitTransaction(tx);
143
186
        } else {
144
32
            result.pushKV("hex", hex);
145
32
        }
146
218
    }
147
246
    result.pushKV("complete", complete);
148
149
246
    return result;
150
247
}
151
152
static void PreventOutdatedOptions(const UniValue& options)
153
388
{
154
388
    if (options.exists("feeRate")) {
155
1
        throw JSONRPCError(RPC_INVALID_PARAMETER, "Use fee_rate (" + CURRENCY_ATOM + "/vB) instead of feeRate");
156
1
    }
157
387
    if (options.exists("changeAddress")) {
158
0
        throw JSONRPCError(RPC_INVALID_PARAMETER, "Use change_address instead of changeAddress");
159
0
    }
160
387
    if (options.exists("changePosition")) {
161
0
        throw JSONRPCError(RPC_INVALID_PARAMETER, "Use change_position instead of changePosition");
162
0
    }
163
387
    if (options.exists("lockUnspents")) {
164
0
        throw JSONRPCError(RPC_INVALID_PARAMETER, "Use lock_unspents instead of lockUnspents");
165
0
    }
166
387
    if (options.exists("subtractFeeFromOutputs")) {
167
0
        throw JSONRPCError(RPC_INVALID_PARAMETER, "Use subtract_fee_from_outputs instead of subtractFeeFromOutputs");
168
0
    }
169
387
}
170
171
UniValue SendMoney(CWallet& wallet, const CCoinControl &coin_control, std::vector<CRecipient> &recipients, std::optional<std::string> comment, std::optional<std::string> comment_to, bool verbose)
172
1.28k
{
173
1.28k
    EnsureWalletIsUnlocked(wallet);
174
175
    // This function is only used by sendtoaddress and sendmany.
176
    // This should always try to sign, if we don't have (all) private keys, don't
177
    // try to do anything here.
178
1.28k
    if (wallet.IsWalletFlagSet(WALLET_FLAG_EXTERNAL_SIGNER)) {
179
2
        throw JSONRPCError(RPC_WALLET_ERROR, "Error: sendtoaddress and sendmany are not supported for wallets with external signers; use send instead");
180
2
    }
181
1.28k
    if (wallet.IsWalletFlagSet(WALLET_FLAG_DISABLE_PRIVATE_KEYS)) {
182
1
        throw JSONRPCError(RPC_WALLET_ERROR, "Error: Private keys are disabled for this wallet");
183
1
    }
184
185
    // Shuffle recipient list
186
1.28k
    std::shuffle(recipients.begin(), recipients.end(), FastRandomContext());
187
188
    // Send
189
1.28k
    auto res = CreateTransaction(wallet, recipients, /*change_pos=*/std::nullopt, coin_control, true);
190
1.28k
    if (!res) {
191
17
        throw JSONRPCError(RPC_WALLET_INSUFFICIENT_FUNDS, util::ErrorString(res).original);
192
17
    }
193
1.26k
    const CTransactionRef& tx = res->tx;
194
1.26k
    wallet.CommitTransaction(tx, /*replaces_txid=*/std::nullopt, comment, comment_to);
195
1.26k
    if (verbose) {
196
6
        UniValue entry(UniValue::VOBJ);
197
6
        entry.pushKV("txid", tx->GetHash().GetHex());
198
6
        entry.pushKV("fee_reason", StringForFeeReason(res->fee_calc.reason));
199
6
        return entry;
200
6
    }
201
1.25k
    return tx->GetHash().GetHex();
202
1.26k
}
203
204
205
/**
206
 * Update coin control with fee estimation based on the given parameters
207
 *
208
 * @param[in]     wallet            Wallet reference
209
 * @param[in,out] cc                Coin control to be updated
210
 * @param[in]     conf_target       UniValue integer; confirmation target in blocks, values between 1 and 1008 are valid per policy/fees/block_policy_estimator.h;
211
 * @param[in]     estimate_mode     UniValue string; fee estimation mode, valid values are "unset", "economical" or "conservative";
212
 * @param[in]     fee_rate          UniValue real; fee rate in sat/vB;
213
 *                                      if present, both conf_target and estimate_mode must either be null, or "unset"
214
 * @param[in]     override_min_fee  bool; whether to set fOverrideFeeRate to true to disable minimum fee rate checks and instead
215
 *                                      verify only that fee_rate is greater than 0
216
 * @throws a JSONRPCError if conf_target, estimate_mode, or fee_rate contain invalid values or are in conflict
217
 */
218
static void SetFeeEstimateMode(const CWallet& wallet, CCoinControl& cc, const UniValue& conf_target, const UniValue& estimate_mode, const UniValue& fee_rate, bool override_min_fee)
219
2.15k
{
220
2.15k
    if (!fee_rate.isNull()) {
221
548
        if (!conf_target.isNull()) {
222
3
            throw JSONRPCError(RPC_INVALID_PARAMETER, "Cannot specify both conf_target and fee_rate. Please provide either a confirmation target in blocks for automatic fee estimation, or an explicit fee rate.");
223
3
        }
224
545
        if (!estimate_mode.isNull() && estimate_mode.get_str() != "unset") {
225
3
            throw JSONRPCError(RPC_INVALID_PARAMETER, "Cannot specify both estimate_mode and fee_rate");
226
3
        }
227
        // Fee rates in sat/vB cannot represent more than 3 significant digits.
228
542
        cc.m_feerate = CFeeRate{AmountFromValue(fee_rate, /*decimals=*/3)};
229
542
        if (override_min_fee) cc.fOverrideFeeRate = true;
230
        // Default RBF to true for explicit fee_rate, if unset.
231
542
        if (!cc.m_signal_bip125_rbf) cc.m_signal_bip125_rbf = true;
232
542
        return;
233
545
    }
234
1.60k
    if (!estimate_mode.isNull() && !FeeModeFromString(estimate_mode.get_str(), cc.m_fee_mode)) {
235
27
        throw JSONRPCError(RPC_INVALID_PARAMETER, InvalidEstimateModeErrorMessage());
236
27
    }
237
1.57k
    if (!conf_target.isNull()) {
238
32
        cc.m_confirm_target = ParseConfirmTarget(conf_target, wallet.chain().estimateMaxBlocks());
239
32
    }
240
1.57k
}
241
242
RPCMethod sendtoaddress()
243
2.05k
{
244
2.05k
    return RPCMethod{
245
2.05k
        "sendtoaddress",
246
2.05k
        "Send an amount to a given address." +
247
2.05k
        HELP_REQUIRING_PASSPHRASE,
248
2.05k
                {
249
2.05k
                    {"address", RPCArg::Type::STR, RPCArg::Optional::NO, "The bitcoin address to send to."},
250
2.05k
                    {"amount", RPCArg::Type::AMOUNT, RPCArg::Optional::NO, "The amount in " + CURRENCY_UNIT + " to send. eg 0.1"},
251
2.05k
                    {"comment", RPCArg::Type::STR, RPCArg::Optional::OMITTED, "A comment used to store what the transaction is for.\n"
252
2.05k
                                         "This is not part of the transaction, just kept in your wallet."},
253
2.05k
                    {"comment_to", RPCArg::Type::STR, RPCArg::Optional::OMITTED, "A comment to store the name of the person or organization\n"
254
2.05k
                                         "to which you're sending the transaction. This is not part of the \n"
255
2.05k
                                         "transaction, just kept in your wallet."},
256
2.05k
                    {"subtractfeefromamount", RPCArg::Type::BOOL, RPCArg::Default{false}, "The fee will be deducted from the amount being sent.\n"
257
2.05k
                                         "The recipient will receive less bitcoins than you enter in the amount field."},
258
2.05k
                    {"replaceable", RPCArg::Type::BOOL, RPCArg::DefaultHint{"wallet default"}, "Signal that this transaction can be replaced by a transaction (BIP 125)"},
259
2.05k
                    {"conf_target", RPCArg::Type::NUM, RPCArg::DefaultHint{"wallet -txconfirmtarget"}, "Confirmation target in blocks"},
260
2.05k
                    {"estimate_mode", RPCArg::Type::STR, RPCArg::Default{"unset"}, "The fee estimate mode, must be one of (case insensitive):\n"
261
2.05k
                      + FeeModesDetail(std::string("economical mode is used if the transaction is replaceable;\notherwise, conservative mode is used"))},
262
2.05k
                    {"avoid_reuse", RPCArg::Type::BOOL, RPCArg::Default{true}, "(only available if avoid_reuse wallet flag is set) Avoid spending from dirty addresses; addresses are considered\n"
263
2.05k
                                         "dirty if they have previously been used in a transaction. If true, this also activates avoidpartialspends, grouping outputs by their addresses."},
264
2.05k
                    {"fee_rate", RPCArg::Type::AMOUNT, RPCArg::DefaultHint{"not set, fall back to wallet fee estimation"}, "Specify a fee rate in " + CURRENCY_ATOM + "/vB."},
265
2.05k
                    {"verbose", RPCArg::Type::BOOL, RPCArg::Default{false}, "If true, return extra information about the transaction."},
266
2.05k
                },
267
2.05k
                {
268
2.05k
                    RPCResult{"if verbose is not set or set to false",
269
2.05k
                        RPCResult::Type::STR_HEX, "txid", "The transaction id."
270
2.05k
                    },
271
2.05k
                    RPCResult{"if verbose is set to true",
272
2.05k
                        RPCResult::Type::OBJ, "", "",
273
2.05k
                        {
274
2.05k
                            {RPCResult::Type::STR_HEX, "txid", "The transaction id."},
275
2.05k
                            {RPCResult::Type::STR, "fee_reason", "The transaction fee reason."}
276
2.05k
                        },
277
2.05k
                    },
278
2.05k
                },
279
2.05k
                RPCExamples{
280
2.05k
                    "\nSend 0.1 BTC\n"
281
2.05k
                    + HelpExampleCli("sendtoaddress", "\"" + EXAMPLE_ADDRESS[0] + "\" 0.1") +
282
2.05k
                    "\nSend 0.1 BTC with a confirmation target of 6 blocks in economical fee estimate mode using positional arguments\n"
283
2.05k
                    + HelpExampleCli("sendtoaddress", "\"" + EXAMPLE_ADDRESS[0] + "\" 0.1 \"donation\" \"sean's outpost\" false true 6 economical") +
284
2.05k
                    "\nSend 0.1 BTC with a fee rate of 1.1 " + CURRENCY_ATOM + "/vB, subtract fee from amount, BIP125-replaceable, using positional arguments\n"
285
2.05k
                    + HelpExampleCli("sendtoaddress", "\"" + EXAMPLE_ADDRESS[0] + "\" 0.1 \"drinks\" \"room77\" true true null \"unset\" null 1.1") +
286
2.05k
                    "\nSend 0.2 BTC with a confirmation target of 6 blocks in economical fee estimate mode using named arguments\n"
287
2.05k
                    + HelpExampleCli("-named sendtoaddress", "address=\"" + EXAMPLE_ADDRESS[0] + "\" amount=0.2 conf_target=6 estimate_mode=\"economical\"") +
288
2.05k
                    "\nSend 0.5 BTC with a fee rate of 25 " + CURRENCY_ATOM + "/vB using named arguments\n"
289
2.05k
                    + HelpExampleCli("-named sendtoaddress", "address=\"" + EXAMPLE_ADDRESS[0] + "\" amount=0.5 fee_rate=25")
290
2.05k
                    + HelpExampleCli("-named sendtoaddress", "address=\"" + EXAMPLE_ADDRESS[0] + "\" amount=0.5 fee_rate=25 subtractfeefromamount=false replaceable=true avoid_reuse=true comment=\"2 pizzas\" comment_to=\"jeremy\" verbose=true")
291
2.05k
                },
292
2.05k
        [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
293
2.05k
{
294
1.23k
    std::shared_ptr<CWallet> const pwallet = GetWalletForJSONRPCRequest(request);
295
1.23k
    if (!pwallet) return UniValue::VNULL;
296
297
    // Make sure the results are valid at least up to the most recent block
298
    // the user could have gotten from another RPC command prior to now
299
1.23k
    pwallet->BlockUntilSyncedToCurrentChain();
300
301
1.23k
    LOCK(pwallet->cs_wallet);
302
303
    // Wallet comments
304
1.23k
    std::optional<std::string> comment;
305
1.23k
    std::optional<std::string> comment_to;
306
1.23k
    if (!request.params[2].isNull() && !request.params[2].get_str().empty())
307
1
        comment = request.params[2].get_str();
308
1.23k
    if (!request.params[3].isNull() && !request.params[3].get_str().empty())
309
1
        comment_to = request.params[3].get_str();
310
311
1.23k
    CCoinControl coin_control;
312
1.23k
    if (!request.params[5].isNull()) {
313
2
        coin_control.m_signal_bip125_rbf = request.params[5].get_bool();
314
2
    }
315
316
1.23k
    coin_control.m_avoid_address_reuse = GetAvoidReuseFlag(*pwallet, request.params[8]);
317
    // We also enable partial spend avoidance if reuse avoidance is set.
318
1.23k
    coin_control.m_avoid_partial_spends |= coin_control.m_avoid_address_reuse;
319
320
1.23k
    SetFeeEstimateMode(*pwallet, coin_control, /*conf_target=*/request.params[6], /*estimate_mode=*/request.params[7], /*fee_rate=*/request.params[9], /*override_min_fee=*/false);
321
322
1.23k
    EnsureWalletIsUnlocked(*pwallet);
323
324
1.23k
    UniValue address_amounts(UniValue::VOBJ);
325
1.23k
    const std::string address = request.params[0].get_str();
326
1.23k
    address_amounts.pushKV(address, request.params[1]);
327
328
1.23k
    std::set<int> sffo_set;
329
1.23k
    if (!request.params[4].isNull() && request.params[4].get_bool()) {
330
216
        sffo_set.insert(0);
331
216
    }
332
333
1.23k
    std::vector<CRecipient> recipients{CreateRecipients(ParseOutputs(address_amounts), sffo_set)};
334
1.23k
    const bool verbose{request.params[10].isNull() ? false : request.params[10].get_bool()};
335
336
1.23k
    return SendMoney(*pwallet, coin_control, recipients, comment, comment_to, verbose);
337
1.23k
},
338
2.05k
    };
339
2.05k
}
340
341
RPCMethod sendmany()
342
904
{
343
904
    return RPCMethod{"sendmany",
344
904
        "Send multiple times. Amounts are double-precision floating point numbers." +
345
904
        HELP_REQUIRING_PASSPHRASE,
346
904
                {
347
904
                    {"dummy", RPCArg::Type::STR, RPCArg::Default{"\"\""}, "Must be set to \"\" for backwards compatibility.",
348
904
                     RPCArgOptions{
349
904
                         .oneline_description = "\"\"",
350
904
                     }},
351
904
                    {"amounts", RPCArg::Type::OBJ_USER_KEYS, RPCArg::Optional::NO, "The addresses and amounts",
352
904
                        {
353
904
                            {"address", RPCArg::Type::AMOUNT, RPCArg::Optional::NO, "The bitcoin address is the key, the numeric amount (can be string) in " + CURRENCY_UNIT + " is the value"},
354
904
                        },
355
904
                    },
356
904
                    {"minconf", RPCArg::Type::NUM, RPCArg::Optional::OMITTED, "Ignored dummy value"},
357
904
                    {"comment", RPCArg::Type::STR, RPCArg::Optional::OMITTED, "A comment"},
358
904
                    {"subtractfeefrom", RPCArg::Type::ARR, RPCArg::Optional::OMITTED, "The addresses.\n"
359
904
                                       "The fee will be equally deducted from the amount of each selected address.\n"
360
904
                                       "Those recipients will receive less bitcoins than you enter in their corresponding amount field.\n"
361
904
                                       "If no addresses are specified here, the sender pays the fee.",
362
904
                        {
363
904
                            {"address", RPCArg::Type::STR, RPCArg::Optional::OMITTED, "Subtract fee from this address"},
364
904
                        },
365
904
                    },
366
904
                    {"replaceable", RPCArg::Type::BOOL, RPCArg::DefaultHint{"wallet default"}, "Signal that this transaction can be replaced by a transaction (BIP 125)"},
367
904
                    {"conf_target", RPCArg::Type::NUM, RPCArg::DefaultHint{"wallet -txconfirmtarget"}, "Confirmation target in blocks"},
368
904
                    {"estimate_mode", RPCArg::Type::STR, RPCArg::Default{"unset"}, "The fee estimate mode, must be one of (case insensitive):\n"
369
904
                      + FeeModesDetail(std::string("economical mode is used if the transaction is replaceable;\notherwise, conservative mode is used"))},
370
904
                    {"fee_rate", RPCArg::Type::AMOUNT, RPCArg::DefaultHint{"not set, fall back to wallet fee estimation"}, "Specify a fee rate in " + CURRENCY_ATOM + "/vB."},
371
904
                    {"verbose", RPCArg::Type::BOOL, RPCArg::Default{false}, "If true, return extra information about the transaction."},
372
904
                },
373
904
                {
374
904
                    RPCResult{"if verbose is not set or set to false",
375
904
                        RPCResult::Type::STR_HEX, "txid", "The transaction id for the send. Only 1 transaction is created regardless of\n"
376
904
                "the number of addresses."
377
904
                    },
378
904
                    RPCResult{"if verbose is set to true",
379
904
                        RPCResult::Type::OBJ, "", "",
380
904
                        {
381
904
                            {RPCResult::Type::STR_HEX, "txid", "The transaction id for the send. Only 1 transaction is created regardless of\n"
382
904
                "the number of addresses."},
383
904
                            {RPCResult::Type::STR, "fee_reason", "The transaction fee reason."}
384
904
                        },
385
904
                    },
386
904
                },
387
904
                RPCExamples{
388
904
            "\nSend two amounts to two different addresses:\n"
389
904
            + HelpExampleCli("sendmany", "\"\" \"{\\\"" + EXAMPLE_ADDRESS[0] + "\\\":0.01,\\\"" + EXAMPLE_ADDRESS[1] + "\\\":0.02}\"") +
390
904
            "\nSend two amounts to two different addresses setting the confirmation and comment:\n"
391
904
            + HelpExampleCli("sendmany", "\"\" \"{\\\"" + EXAMPLE_ADDRESS[0] + "\\\":0.01,\\\"" + EXAMPLE_ADDRESS[1] + "\\\":0.02}\" 6 \"testing\"") +
392
904
            "\nSend two amounts to two different addresses, subtract fee from amount:\n"
393
904
            + HelpExampleCli("sendmany", "\"\" \"{\\\"" + EXAMPLE_ADDRESS[0] + "\\\":0.01,\\\"" + EXAMPLE_ADDRESS[1] + "\\\":0.02}\" 1 \"\" \"[\\\"" + EXAMPLE_ADDRESS[0] + "\\\",\\\"" + EXAMPLE_ADDRESS[1] + "\\\"]\"") +
394
904
            "\nAs a JSON-RPC call\n"
395
904
            + HelpExampleRpc("sendmany", "\"\", {\"" + EXAMPLE_ADDRESS[0] + "\":0.01,\"" + EXAMPLE_ADDRESS[1] + "\":0.02}, 6, \"testing\"")
396
904
                },
397
904
        [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
398
904
{
399
83
    std::shared_ptr<CWallet> const pwallet = GetWalletForJSONRPCRequest(request);
400
83
    if (!pwallet) return UniValue::VNULL;
401
402
    // Make sure the results are valid at least up to the most recent block
403
    // the user could have gotten from another RPC command prior to now
404
83
    pwallet->BlockUntilSyncedToCurrentChain();
405
406
83
    LOCK(pwallet->cs_wallet);
407
408
83
    if (!request.params[0].isNull() && !request.params[0].get_str().empty()) {
409
0
        throw JSONRPCError(RPC_INVALID_PARAMETER, "Dummy value must be set to \"\"");
410
0
    }
411
83
    UniValue sendTo = request.params[1].get_obj();
412
413
83
    std::optional<std::string> comment;
414
83
    if (!request.params[3].isNull() && !request.params[3].get_str().empty())
415
0
        comment = request.params[3].get_str();
416
417
83
    CCoinControl coin_control;
418
83
    if (!request.params[5].isNull()) {
419
0
        coin_control.m_signal_bip125_rbf = request.params[5].get_bool();
420
0
    }
421
422
83
    SetFeeEstimateMode(*pwallet, coin_control, /*conf_target=*/request.params[6], /*estimate_mode=*/request.params[7], /*fee_rate=*/request.params[8], /*override_min_fee=*/false);
423
424
83
    std::vector<CRecipient> recipients = CreateRecipients(
425
83
            ParseOutputs(sendTo),
426
83
            InterpretSubtractFeeFromOutputInstructions(request.params[4], sendTo.getKeys())
427
83
    );
428
83
    const bool verbose{request.params[9].isNull() ? false : request.params[9].get_bool()};
429
430
83
    return SendMoney(*pwallet, coin_control, recipients, comment, /*comment_to=*/std::nullopt, verbose);
431
83
},
432
904
    };
433
904
}
434
435
// Only includes key documentation where the key is snake_case in all RPC methods. MixedCase keys can be added later.
436
static std::vector<RPCArg> FundTxDoc(bool solving_data = true)
437
4.15k
{
438
4.15k
    std::vector<RPCArg> args = {
439
4.15k
        {"conf_target", RPCArg::Type::NUM, RPCArg::DefaultHint{"wallet -txconfirmtarget"}, "Confirmation target in blocks", RPCArgOptions{.also_positional = true}},
440
4.15k
        {"estimate_mode", RPCArg::Type::STR, RPCArg::Default{"unset"}, "The fee estimate mode, must be one of (case insensitive):\n"
441
4.15k
          + FeeModesDetail(std::string("economical mode is used if the transaction is replaceable;\notherwise, conservative mode is used")), RPCArgOptions{.also_positional = true}},
442
4.15k
        {
443
4.15k
            "replaceable", RPCArg::Type::BOOL, RPCArg::DefaultHint{"wallet default"}, "Marks this transaction as BIP125-replaceable.\n"
444
4.15k
            "Allows this transaction to be replaced by a transaction with higher fees"
445
4.15k
        },
446
4.15k
    };
447
4.15k
    if (solving_data) {
448
4.15k
        args.push_back({"solving_data", RPCArg::Type::OBJ, RPCArg::Optional::OMITTED, "Keys and scripts needed for producing a final transaction with a dummy signature.\n"
449
4.15k
        "Used for fee estimation during coin selection.",
450
4.15k
            {
451
4.15k
                {
452
4.15k
                    "pubkeys", RPCArg::Type::ARR, RPCArg::Default{UniValue::VARR}, "Public keys involved in this transaction.",
453
4.15k
                    {
454
4.15k
                        {"pubkey", RPCArg::Type::STR_HEX, RPCArg::Optional::OMITTED, "A public key"},
455
4.15k
                    }
456
4.15k
                },
457
4.15k
                {
458
4.15k
                    "scripts", RPCArg::Type::ARR, RPCArg::Default{UniValue::VARR}, "Scripts involved in this transaction.",
459
4.15k
                    {
460
4.15k
                        {"script", RPCArg::Type::STR_HEX, RPCArg::Optional::OMITTED, "A script"},
461
4.15k
                    }
462
4.15k
                },
463
4.15k
                {
464
4.15k
                    "descriptors", RPCArg::Type::ARR, RPCArg::Default{UniValue::VARR}, "Descriptors that provide solving data for this transaction.",
465
4.15k
                    {
466
4.15k
                        {"descriptor", RPCArg::Type::STR, RPCArg::Optional::OMITTED, "A descriptor"},
467
4.15k
                    }
468
4.15k
                },
469
4.15k
            }
470
4.15k
        });
471
4.15k
    }
472
4.15k
    return args;
473
4.15k
}
474
475
CreatedTransactionResult FundTransaction(CWallet& wallet, const CMutableTransaction& tx, const std::vector<CRecipient>& recipients, const UniValue& options, CCoinControl& coinControl, bool override_min_fee)
476
683
{
477
    // We want to make sure tx.vout is not used now that we are passing outputs as a vector of recipients.
478
    // This sets us up to remove tx completely in a future PR in favor of passing the inputs directly.
479
683
    CHECK_NONFATAL(tx.vout.empty());
480
    // Make sure the results are valid at least up to the most recent block
481
    // the user could have gotten from another RPC command prior to now
482
683
    wallet.BlockUntilSyncedToCurrentChain();
483
484
683
    std::optional<unsigned int> change_position;
485
683
    bool lockUnspents = false;
486
683
    if (!options.isNull()) {
487
648
        if (options.type() == UniValue::VBOOL) {
488
            // backward compatibility bool only fallback, does nothing
489
647
        } else {
490
647
            RPCTypeCheckObj(options,
491
647
                {
492
647
                    {"add_inputs", UniValueType(UniValue::VBOOL)},
493
647
                    {"include_unsafe", UniValueType(UniValue::VBOOL)},
494
647
                    {"add_to_wallet", UniValueType(UniValue::VBOOL)},
495
647
                    {"changeAddress", UniValueType(UniValue::VSTR)},
496
647
                    {"change_address", UniValueType(UniValue::VSTR)},
497
647
                    {"changePosition", UniValueType(UniValue::VNUM)},
498
647
                    {"change_position", UniValueType(UniValue::VNUM)},
499
647
                    {"change_type", UniValueType(UniValue::VSTR)},
500
647
                    {"includeWatching", UniValueType(UniValue::VBOOL)},
501
647
                    {"include_watching", UniValueType(UniValue::VBOOL)},
502
647
                    {"inputs", UniValueType(UniValue::VARR)},
503
647
                    {"lockUnspents", UniValueType(UniValue::VBOOL)},
504
647
                    {"lock_unspents", UniValueType(UniValue::VBOOL)},
505
647
                    {"locktime", UniValueType(UniValue::VNUM)},
506
647
                    {"fee_rate", UniValueType()}, // will be checked by AmountFromValue() in SetFeeEstimateMode()
507
647
                    {"feeRate", UniValueType()}, // will be checked by AmountFromValue() below
508
647
                    {"psbt", UniValueType(UniValue::VBOOL)},
509
647
                    {"solving_data", UniValueType(UniValue::VOBJ)},
510
647
                    {"subtractFeeFromOutputs", UniValueType(UniValue::VARR)},
511
647
                    {"subtract_fee_from_outputs", UniValueType(UniValue::VARR)},
512
647
                    {"replaceable", UniValueType(UniValue::VBOOL)},
513
647
                    {"conf_target", UniValueType(UniValue::VNUM)},
514
647
                    {"estimate_mode", UniValueType(UniValue::VSTR)},
515
647
                    {"minconf", UniValueType(UniValue::VNUM)},
516
647
                    {"maxconf", UniValueType(UniValue::VNUM)},
517
647
                    {"input_weights", UniValueType(UniValue::VARR)},
518
647
                    {"max_tx_weight", UniValueType(UniValue::VNUM)},
519
647
                },
520
647
                true, true);
521
522
647
            if (options.exists("add_inputs")) {
523
174
                coinControl.m_allow_other_inputs = options["add_inputs"].get_bool();
524
174
            }
525
526
647
            if (options.exists("changeAddress") || options.exists("change_address")) {
527
13
                const std::string change_address_str = (options.exists("change_address") ? options["change_address"] : options["changeAddress"]).get_str();
528
13
                CTxDestination dest = DecodeDestination(change_address_str);
529
530
13
                if (!IsValidDestination(dest)) {
531
2
                    throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Change address must be a valid bitcoin address");
532
2
                }
533
534
11
                coinControl.destChange = dest;
535
11
            }
536
537
645
            if (options.exists("changePosition") || options.exists("change_position")) {
538
60
                int pos = (options.exists("change_position") ? options["change_position"] : options["changePosition"]).getInt<int>();
539
60
                if (pos < 0 || (unsigned int)pos > recipients.size()) {
540
1
                    throw JSONRPCError(RPC_INVALID_PARAMETER, "changePosition out of bounds");
541
1
                }
542
59
                change_position = (unsigned int)pos;
543
59
            }
544
545
644
            if (options.exists("change_type")) {
546
99
                if (options.exists("changeAddress") || options.exists("change_address")) {
547
1
                    throw JSONRPCError(RPC_INVALID_PARAMETER, "Cannot specify both change address and address type options");
548
1
                }
549
98
                if (std::optional<OutputType> parsed = ParseOutputType(options["change_type"].get_str())) {
550
96
                    coinControl.m_change_type.emplace(parsed.value());
551
96
                } else {
552
2
                    throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, strprintf("Unknown change type '%s'", options["change_type"].get_str()));
553
2
                }
554
98
            }
555
556
641
            if (options.exists("lockUnspents") || options.exists("lock_unspents")) {
557
4
                lockUnspents = (options.exists("lock_unspents") ? options["lock_unspents"] : options["lockUnspents"]).get_bool();
558
4
            }
559
560
641
            if (options.exists("include_unsafe")) {
561
46
                coinControl.m_include_unsafe_inputs = options["include_unsafe"].get_bool();
562
46
            }
563
564
641
            if (options.exists("feeRate")) {
565
58
                if (options.exists("fee_rate")) {
566
2
                    throw JSONRPCError(RPC_INVALID_PARAMETER, "Cannot specify both fee_rate (" + CURRENCY_ATOM + "/vB) and feeRate (" + CURRENCY_UNIT + "/kvB)");
567
2
                }
568
56
                if (options.exists("conf_target")) {
569
2
                    throw JSONRPCError(RPC_INVALID_PARAMETER, "Cannot specify both conf_target and feeRate. Please provide either a confirmation target in blocks for automatic fee estimation, or an explicit fee rate.");
570
2
                }
571
54
                if (options.exists("estimate_mode")) {
572
2
                    throw JSONRPCError(RPC_INVALID_PARAMETER, "Cannot specify both estimate_mode and feeRate");
573
2
                }
574
52
                coinControl.m_feerate = CFeeRate(AmountFromValue(options["feeRate"]));
575
52
                coinControl.fOverrideFeeRate = true;
576
52
            }
577
578
635
            if (options.exists("replaceable")) {
579
5
                coinControl.m_signal_bip125_rbf = options["replaceable"].get_bool();
580
5
            }
581
582
635
            if (options.exists("minconf")) {
583
9
                coinControl.m_min_depth = options["minconf"].getInt<int>();
584
585
9
                if (coinControl.m_min_depth < 0) {
586
1
                    throw JSONRPCError(RPC_INVALID_PARAMETER, "Negative minconf");
587
1
                }
588
9
            }
589
590
634
            if (options.exists("maxconf")) {
591
4
                coinControl.m_max_depth = options["maxconf"].getInt<int>();
592
593
4
                if (coinControl.m_max_depth < coinControl.m_min_depth) {
594
0
                    throw JSONRPCError(RPC_INVALID_PARAMETER, strprintf("maxconf can't be lower than minconf: %d < %d", coinControl.m_max_depth, coinControl.m_min_depth));
595
0
                }
596
4
            }
597
634
            SetFeeEstimateMode(wallet, coinControl, options["conf_target"], options["estimate_mode"], options["fee_rate"], override_min_fee);
598
634
        }
599
648
    }
600
601
670
    if (options.exists("solving_data")) {
602
14
        const UniValue solving_data = options["solving_data"].get_obj();
603
14
        if (solving_data.exists("pubkeys")) {
604
5
            for (const UniValue& pk_univ : solving_data["pubkeys"].get_array().getValues()) {
605
5
                const CPubKey pubkey = HexToPubKey(pk_univ.get_str());
606
5
                coinControl.m_external_provider.pubkeys.emplace(pubkey.GetID(), pubkey);
607
                // Add witness script for pubkeys
608
5
                const CScript wit_script = GetScriptForDestination(WitnessV0KeyHash(pubkey));
609
5
                coinControl.m_external_provider.scripts.emplace(CScriptID(wit_script), wit_script);
610
5
            }
611
5
        }
612
613
14
        if (solving_data.exists("scripts")) {
614
6
            for (const UniValue& script_univ : solving_data["scripts"].get_array().getValues()) {
615
6
                const std::string& script_str = script_univ.get_str();
616
6
                if (!IsHex(script_str)) {
617
1
                    throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, strprintf("'%s' is not hex", script_str));
618
1
                }
619
5
                std::vector<unsigned char> script_data(ParseHex(script_str));
620
5
                const CScript script(script_data.begin(), script_data.end());
621
5
                coinControl.m_external_provider.scripts.emplace(CScriptID(script), script);
622
5
            }
623
4
        }
624
625
13
        if (solving_data.exists("descriptors")) {
626
8
            for (const UniValue& desc_univ : solving_data["descriptors"].get_array().getValues()) {
627
8
                const std::string& desc_str  = desc_univ.get_str();
628
8
                FlatSigningProvider desc_out;
629
8
                std::string error;
630
8
                std::vector<CScript> scripts_temp;
631
8
                auto descs = Parse(desc_str, desc_out, error, true);
632
8
                if (descs.empty()) {
633
1
                    throw JSONRPCError(RPC_INVALID_PARAMETER, strprintf("Unable to parse descriptor '%s': %s", desc_str, error));
634
1
                }
635
7
                for (auto& desc : descs) {
636
7
                    desc->Expand(0, desc_out, scripts_temp, desc_out);
637
7
                }
638
7
                coinControl.m_external_provider.Merge(std::move(desc_out));
639
7
            }
640
8
        }
641
13
    }
642
643
668
    if (options.exists("input_weights")) {
644
2.49k
        for (const UniValue& input : options["input_weights"].get_array().getValues()) {
645
2.49k
            Txid txid = Txid::FromUint256(ParseHashO(input, "txid"));
646
647
2.49k
            const UniValue& vout_v = input.find_value("vout");
648
2.49k
            if (!vout_v.isNum()) {
649
1
                throw JSONRPCError(RPC_INVALID_PARAMETER, "Invalid parameter, missing vout key");
650
1
            }
651
2.49k
            int vout = vout_v.getInt<int>();
652
2.49k
            if (vout < 0) {
653
1
                throw JSONRPCError(RPC_INVALID_PARAMETER, "Invalid parameter, vout cannot be negative");
654
1
            }
655
656
2.48k
            const UniValue& weight_v = input.find_value("weight");
657
2.48k
            if (!weight_v.isNum()) {
658
1
                throw JSONRPCError(RPC_INVALID_PARAMETER, "Invalid parameter, missing weight key");
659
1
            }
660
2.48k
            int64_t weight = weight_v.getInt<int64_t>();
661
2.48k
            const int64_t min_input_weight = GetTransactionInputWeight(CTxIn());
662
2.48k
            CHECK_NONFATAL(min_input_weight == 165);
663
2.48k
            if (weight < min_input_weight) {
664
2
                throw JSONRPCError(RPC_INVALID_PARAMETER, "Invalid parameter, weight cannot be less than 165 (41 bytes (size of outpoint + sequence + empty scriptSig) * 4 (witness scaling factor)) + 1 (empty witness)");
665
2
            }
666
2.48k
            if (weight > MAX_STANDARD_TX_WEIGHT) {
667
1
                throw JSONRPCError(RPC_INVALID_PARAMETER, strprintf("Invalid parameter, weight cannot be greater than the maximum standard tx weight of %d", MAX_STANDARD_TX_WEIGHT));
668
1
            }
669
670
2.48k
            coinControl.SetInputWeight(COutPoint(txid, vout), weight);
671
2.48k
        }
672
140
    }
673
674
662
    if (options.exists("max_tx_weight")) {
675
10
        coinControl.m_max_tx_weight = options["max_tx_weight"].getInt<int>();
676
10
    }
677
678
662
    if (tx.version == TRUC_VERSION) {
679
36
        if (!coinControl.m_max_tx_weight.has_value() || coinControl.m_max_tx_weight.value() > TRUC_MAX_WEIGHT) {
680
34
            coinControl.m_max_tx_weight = TRUC_MAX_WEIGHT;
681
34
        }
682
36
    }
683
684
662
    if (recipients.empty())
685
0
        throw JSONRPCError(RPC_INVALID_PARAMETER, "TX must have at least one output");
686
687
662
    auto txr = FundTransaction(wallet, tx, recipients, change_position, lockUnspents, coinControl);
688
662
    if (!txr) {
689
91
        throw JSONRPCError(RPC_WALLET_ERROR, ErrorString(txr).original);
690
91
    }
691
571
    return *txr;
692
662
}
693
694
static void SetOptionsInputWeights(const UniValue& inputs, UniValue& options)
695
441
{
696
441
    if (options.exists("input_weights")) {
697
2
        throw JSONRPCError(RPC_INVALID_PARAMETER, "Input weights should be specified in inputs rather than in options.");
698
2
    }
699
439
    if (inputs.size() == 0) {
700
269
        return;
701
269
    }
702
170
    UniValue weights(UniValue::VARR);
703
2.78k
    for (const UniValue& input : inputs.getValues()) {
704
2.78k
        if (input.exists("weight")) {
705
6
            weights.push_back(input);
706
6
        }
707
2.78k
    }
708
170
    options.pushKV("input_weights", std::move(weights));
709
170
}
710
711
RPCMethod fundrawtransaction()
712
1.06k
{
713
1.06k
    return RPCMethod{
714
1.06k
        "fundrawtransaction",
715
1.06k
        "If the transaction has no inputs, they will be automatically selected to meet its out value.\n"
716
1.06k
                "It will add at most one change output to the outputs.\n"
717
1.06k
                "No existing outputs will be modified unless \"subtractFeeFromOutputs\" is specified.\n"
718
1.06k
                "Note that inputs which were signed may need to be resigned after completion since in/outputs have been added.\n"
719
1.06k
                "The inputs added will not be signed, use signrawtransactionwithkey\n"
720
1.06k
                "or signrawtransactionwithwallet for that.\n"
721
1.06k
                "All existing inputs must either have their previous output transaction be in the wallet\n"
722
1.06k
                "or be in the UTXO set. Solving data must be provided for non-wallet inputs.\n"
723
1.06k
                "Note that all inputs selected must be of standard form and P2SH scripts must be\n"
724
1.06k
                "in the wallet using importdescriptors (to calculate fees).\n"
725
1.06k
                "You can see whether this is the case by checking the \"solvable\" field in the listunspent output.\n"
726
1.06k
                "Note that if specifying an exact fee rate, the resulting transaction may have a higher fee rate\n"
727
1.06k
                "if the transaction has unconfirmed inputs. This is because the wallet will attempt to make the\n"
728
1.06k
                "entire package have the given fee rate, not the resulting transaction.\n",
729
1.06k
                {
730
1.06k
                    {"hexstring", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "The hex string of the raw transaction"},
731
1.06k
                    {"options", RPCArg::Type::OBJ_NAMED_PARAMS, RPCArg::Optional::OMITTED, "",
732
1.06k
                        Cat<std::vector<RPCArg>>(
733
1.06k
                        {
734
1.06k
                            {"add_inputs", RPCArg::Type::BOOL, RPCArg::Default{true}, "For a transaction with existing inputs, automatically include more if they are not enough."},
735
1.06k
                            {"include_unsafe", RPCArg::Type::BOOL, RPCArg::Default{false}, "Include inputs that are not safe to spend (unconfirmed transactions from outside keys and unconfirmed replacement transactions).\n"
736
1.06k
                                                          "Warning: the resulting transaction may become invalid if one of the unsafe inputs disappears.\n"
737
1.06k
                                                          "If that happens, you will need to fund the transaction with different inputs and republish it."},
738
1.06k
                            {"minconf", RPCArg::Type::NUM, RPCArg::Default{0}, "If add_inputs is specified, require inputs with at least this many confirmations."},
739
1.06k
                            {"maxconf", RPCArg::Type::NUM, RPCArg::Optional::OMITTED, "If add_inputs is specified, require inputs with at most this many confirmations."},
740
1.06k
                            {"changeAddress", RPCArg::Type::STR, RPCArg::DefaultHint{"automatic"}, "The bitcoin address to receive the change"},
741
1.06k
                            {"changePosition", RPCArg::Type::NUM, RPCArg::DefaultHint{"random"}, "The index of the change output"},
742
1.06k
                            {"change_type", RPCArg::Type::STR, RPCArg::DefaultHint{"set by -changetype"}, "The output type to use. Only valid if changeAddress is not specified. Options are " + FormatAllOutputTypes() + "."},
743
1.06k
                            {"includeWatching", RPCArg::Type::BOOL, RPCArg::Default{false}, "(DEPRECATED) No longer used"},
744
1.06k
                            {"lockUnspents", RPCArg::Type::BOOL, RPCArg::Default{false}, "Lock selected unspent outputs"},
745
1.06k
                            {"fee_rate", RPCArg::Type::AMOUNT, RPCArg::DefaultHint{"not set, fall back to wallet fee estimation"}, "Specify a fee rate in " + CURRENCY_ATOM + "/vB."},
746
1.06k
                            {"feeRate", RPCArg::Type::AMOUNT, RPCArg::DefaultHint{"not set, fall back to wallet fee estimation"}, "Specify a fee rate in " + CURRENCY_UNIT + "/kvB."},
747
1.06k
                            {"subtractFeeFromOutputs", RPCArg::Type::ARR, RPCArg::Default{UniValue::VARR}, "The integers.\n"
748
1.06k
                                                          "The fee will be equally deducted from the amount of each specified output.\n"
749
1.06k
                                                          "Those recipients will receive less bitcoins than you enter in their corresponding amount field.\n"
750
1.06k
                                                          "If no outputs are specified here, the sender pays the fee.",
751
1.06k
                                {
752
1.06k
                                    {"vout_index", RPCArg::Type::NUM, RPCArg::Optional::OMITTED, "The zero-based output index, before a change output is added."},
753
1.06k
                                },
754
1.06k
                            },
755
1.06k
                            {"input_weights", RPCArg::Type::ARR, RPCArg::Optional::OMITTED, "Inputs and their corresponding weights",
756
1.06k
                                {
757
1.06k
                                    {"", RPCArg::Type::OBJ, RPCArg::Optional::OMITTED, "",
758
1.06k
                                        {
759
1.06k
                                            {"txid", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "The transaction id"},
760
1.06k
                                            {"vout", RPCArg::Type::NUM, RPCArg::Optional::NO, "The output index"},
761
1.06k
                                            {"weight", RPCArg::Type::NUM, RPCArg::Optional::NO, "The maximum weight for this input, "
762
1.06k
                                                "including the weight of the outpoint and sequence number. "
763
1.06k
                                                "Note that serialized signature sizes are not guaranteed to be consistent, "
764
1.06k
                                                "so the maximum DER signatures size of 73 bytes should be used when considering ECDSA signatures."
765
1.06k
                                                "Remember to convert serialized sizes to weight units when necessary."},
766
1.06k
                                        },
767
1.06k
                                    },
768
1.06k
                                },
769
1.06k
                             },
770
1.06k
                            {"max_tx_weight", RPCArg::Type::NUM, RPCArg::Default{MAX_STANDARD_TX_WEIGHT}, "The maximum acceptable transaction weight.\n"
771
1.06k
                                                          "Transaction building will fail if this can not be satisfied."},
772
1.06k
                        },
773
1.06k
                        FundTxDoc()),
774
1.06k
                        RPCArgOptions{
775
1.06k
                            .skip_type_check = true,
776
1.06k
                            .oneline_description = "options",
777
1.06k
                        }},
778
1.06k
                    {"iswitness", RPCArg::Type::BOOL, RPCArg::DefaultHint{"depends on heuristic tests"}, "Whether the transaction hex is a serialized witness transaction.\n"
779
1.06k
                        "If iswitness is not present, heuristic tests will be used in decoding.\n"
780
1.06k
                        "If true, only witness deserialization will be tried.\n"
781
1.06k
                        "If false, only non-witness deserialization will be tried.\n"
782
1.06k
                        "This boolean should reflect whether the transaction has inputs\n"
783
1.06k
                        "(e.g. fully valid, or on-chain transactions), if known by the caller."
784
1.06k
                    },
785
1.06k
                },
786
1.06k
                RPCResult{
787
1.06k
                    RPCResult::Type::OBJ, "", "",
788
1.06k
                    {
789
1.06k
                        {RPCResult::Type::STR_HEX, "hex", "The resulting raw transaction (hex-encoded string)"},
790
1.06k
                        {RPCResult::Type::STR_AMOUNT, "fee", "Fee in " + CURRENCY_UNIT + " the resulting transaction pays"},
791
1.06k
                        {RPCResult::Type::NUM, "changepos", "The position of the added change output, or -1"},
792
1.06k
                    }
793
1.06k
                                },
794
1.06k
                                RPCExamples{
795
1.06k
                            "\nCreate a transaction with no inputs\n"
796
1.06k
                            + HelpExampleCli("createrawtransaction", "\"[]\" \"{\\\"myaddress\\\":0.01}\"") +
797
1.06k
                            "\nAdd sufficient unsigned inputs to meet the output value\n"
798
1.06k
                            + HelpExampleCli("fundrawtransaction", "\"rawtransactionhex\"") +
799
1.06k
                            "\nSign the transaction\n"
800
1.06k
                            + HelpExampleCli("signrawtransactionwithwallet", "\"fundedtransactionhex\"") +
801
1.06k
                            "\nSend the transaction\n"
802
1.06k
                            + HelpExampleCli("sendrawtransaction", "\"signedtransactionhex\"")
803
1.06k
                                },
804
1.06k
        [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
805
1.06k
{
806
244
    std::shared_ptr<CWallet> const pwallet = GetWalletForJSONRPCRequest(request);
807
244
    if (!pwallet) return UniValue::VNULL;
808
809
    // parse hex string from parameter
810
244
    CMutableTransaction tx;
811
244
    bool try_witness = request.params[2].isNull() ? true : request.params[2].get_bool();
812
244
    bool try_no_witness = request.params[2].isNull() ? true : !request.params[2].get_bool();
813
244
    if (!DecodeHexTx(tx, request.params[0].get_str(), try_no_witness, try_witness)) {
814
0
        throw JSONRPCError(RPC_DESERIALIZATION_ERROR, "TX decode failed");
815
0
    }
816
244
    UniValue options = request.params[1];
817
244
    std::vector<std::pair<CTxDestination, CAmount>> destinations;
818
11.4k
    for (const auto& tx_out : tx.vout) {
819
11.4k
        CTxDestination dest;
820
11.4k
        ExtractDestination(tx_out.scriptPubKey, dest);
821
11.4k
        destinations.emplace_back(dest, tx_out.nValue);
822
11.4k
    }
823
244
    std::vector<std::string> dummy(destinations.size(), "dummy");
824
244
    std::vector<CRecipient> recipients = CreateRecipients(
825
244
            destinations,
826
244
            InterpretSubtractFeeFromOutputInstructions(options["subtractFeeFromOutputs"], dummy)
827
244
    );
828
244
    CCoinControl coin_control;
829
    // Automatically select (additional) coins. Can be overridden by options.add_inputs.
830
244
    coin_control.m_allow_other_inputs = true;
831
    // Clear tx.vout since it is not meant to be used now that we are passing outputs directly.
832
    // This sets us up for a future PR to completely remove tx from the function signature in favor of passing inputs directly
833
244
    tx.vout.clear();
834
244
    auto txr = FundTransaction(*pwallet, tx, recipients, options, coin_control, /*override_min_fee=*/true);
835
836
244
    UniValue result(UniValue::VOBJ);
837
244
    result.pushKV("hex", EncodeHexTx(*txr.tx));
838
244
    result.pushKV("fee", ValueFromAmount(txr.fee));
839
244
    result.pushKV("changepos", txr.change_pos ? (int)*txr.change_pos : -1);
840
841
244
    return result;
842
244
},
843
1.06k
    };
844
1.06k
}
845
846
RPCMethod signrawtransactionwithwallet()
847
1.13k
{
848
1.13k
    return RPCMethod{
849
1.13k
        "signrawtransactionwithwallet",
850
1.13k
        "Sign inputs for raw transaction (serialized, hex-encoded).\n"
851
1.13k
                "The second optional argument (may be null) is an array of previous transaction outputs that\n"
852
1.13k
                "this transaction depends on but may not yet be in the block chain." +
853
1.13k
        HELP_REQUIRING_PASSPHRASE,
854
1.13k
                {
855
1.13k
                    {"hexstring", RPCArg::Type::STR, RPCArg::Optional::NO, "The transaction hex string"},
856
1.13k
                    {"prevtxs", RPCArg::Type::ARR, RPCArg::Optional::OMITTED, "The previous dependent transaction outputs",
857
1.13k
                        {
858
1.13k
                            {"", RPCArg::Type::OBJ, RPCArg::Optional::OMITTED, "",
859
1.13k
                                {
860
1.13k
                                    {"txid", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "The transaction id"},
861
1.13k
                                    {"vout", RPCArg::Type::NUM, RPCArg::Optional::NO, "The output number"},
862
1.13k
                                    {"scriptPubKey", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "The output script"},
863
1.13k
                                    {"redeemScript", RPCArg::Type::STR_HEX, RPCArg::Optional::OMITTED, "(required for P2SH) redeem script"},
864
1.13k
                                    {"witnessScript", RPCArg::Type::STR_HEX, RPCArg::Optional::OMITTED, "(required for P2WSH or P2SH-P2WSH) witness script"},
865
1.13k
                                    {"amount", RPCArg::Type::AMOUNT, RPCArg::Optional::OMITTED, "(required for Segwit inputs) the amount spent"},
866
1.13k
                                },
867
1.13k
                            },
868
1.13k
                        },
869
1.13k
                    },
870
1.13k
                    {"sighashtype", RPCArg::Type::STR, RPCArg::Default{"DEFAULT for Taproot, ALL otherwise"}, "The signature hash type. Must be one of\n"
871
1.13k
            "       \"DEFAULT\"\n"
872
1.13k
            "       \"ALL\"\n"
873
1.13k
            "       \"NONE\"\n"
874
1.13k
            "       \"SINGLE\"\n"
875
1.13k
            "       \"ALL|ANYONECANPAY\"\n"
876
1.13k
            "       \"NONE|ANYONECANPAY\"\n"
877
1.13k
            "       \"SINGLE|ANYONECANPAY\""},
878
1.13k
                },
879
1.13k
                RPCResult{
880
1.13k
                    RPCResult::Type::OBJ, "", "",
881
1.13k
                    {
882
1.13k
                        {RPCResult::Type::STR_HEX, "hex", "The hex-encoded raw transaction with signature(s)"},
883
1.13k
                        {RPCResult::Type::BOOL, "complete", "If the transaction has a complete set of signatures"},
884
1.13k
                        {RPCResult::Type::ARR, "errors", /*optional=*/true, "Script verification errors (if there are any)",
885
1.13k
                        {
886
1.13k
                            {RPCResult::Type::OBJ, "", "",
887
1.13k
                            {
888
1.13k
                                {RPCResult::Type::STR_HEX, "txid", "The hash of the referenced, previous transaction"},
889
1.13k
                                {RPCResult::Type::NUM, "vout", "The index of the output to spent and used as input"},
890
1.13k
                                {RPCResult::Type::ARR, "witness", "",
891
1.13k
                                {
892
1.13k
                                    {RPCResult::Type::STR_HEX, "witness", ""},
893
1.13k
                                }},
894
1.13k
                                {RPCResult::Type::STR_HEX, "scriptSig", "The hex-encoded signature script"},
895
1.13k
                                {RPCResult::Type::NUM, "sequence", "Script sequence number"},
896
1.13k
                                {RPCResult::Type::STR, "error", "Verification or signing error related to the input"},
897
1.13k
                            }},
898
1.13k
                        }},
899
1.13k
                    }
900
1.13k
                },
901
1.13k
                RPCExamples{
902
1.13k
                    HelpExampleCli("signrawtransactionwithwallet", "\"myhex\"")
903
1.13k
            + HelpExampleRpc("signrawtransactionwithwallet", "\"myhex\"")
904
1.13k
                },
905
1.13k
        [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
906
1.13k
{
907
316
    const std::shared_ptr<const CWallet> pwallet = GetWalletForJSONRPCRequest(request);
908
316
    if (!pwallet) return UniValue::VNULL;
909
910
316
    CMutableTransaction mtx;
911
316
    if (!DecodeHexTx(mtx, request.params[0].get_str())) {
912
0
        throw JSONRPCError(RPC_DESERIALIZATION_ERROR, "TX decode failed. Make sure the tx has at least one input.");
913
0
    }
914
915
    // Sign the transaction
916
316
    LOCK(pwallet->cs_wallet);
917
316
    EnsureWalletIsUnlocked(*pwallet);
918
919
    // Fetch previous transactions (inputs):
920
316
    std::map<COutPoint, Coin> coins;
921
379
    for (const CTxIn& txin : mtx.vin) {
922
379
        coins[txin.prevout]; // Create empty map entry keyed by prevout.
923
379
    }
924
316
    pwallet->chain().findCoins(coins);
925
926
    // Parse the prevtxs array
927
316
    ParsePrevouts(request.params[1], nullptr, coins);
928
929
316
    std::optional<int> nHashType = ParseSighashString(request.params[2]);
930
316
    if (!nHashType) {
931
302
        nHashType = SIGHASH_DEFAULT;
932
302
    }
933
934
    // Script verification errors
935
316
    std::map<int, bilingual_str> input_errors;
936
937
316
    bool complete = pwallet->SignTransaction(mtx, coins, *nHashType, input_errors);
938
316
    UniValue result(UniValue::VOBJ);
939
316
    SignTransactionResultToJSON(mtx, complete, coins, input_errors, result);
940
316
    return result;
941
316
},
942
1.13k
    };
943
1.13k
}
944
945
// Definition of allowed formats of specifying transaction outputs in
946
// `bumpfee`, `psbtbumpfee`, `send` and `walletcreatefundedpsbt` RPCs.
947
static std::vector<RPCArg> OutputsDoc()
948
3.89k
{
949
3.89k
    return
950
3.89k
    {
951
3.89k
        {"", RPCArg::Type::OBJ_USER_KEYS, RPCArg::Optional::OMITTED, "",
952
3.89k
            {
953
3.89k
                {"address", RPCArg::Type::AMOUNT, RPCArg::Optional::NO, "A key-value pair. The key (string) is the bitcoin address,\n"
954
3.89k
                         "the value (float or string) is the amount in " + CURRENCY_UNIT + ""},
955
3.89k
            },
956
3.89k
        },
957
3.89k
        {"", RPCArg::Type::OBJ, RPCArg::Optional::OMITTED, "",
958
3.89k
            {
959
3.89k
                {"data", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "A key-value pair. The key must be \"data\", the value is hex-encoded data that becomes a part of an OP_RETURN output"},
960
3.89k
            },
961
3.89k
        },
962
3.89k
    };
963
3.89k
}
964
965
static RPCMethod bumpfee_helper(std::string method_name)
966
1.80k
{
967
1.80k
    const bool want_psbt = method_name == "psbtbumpfee";
968
1.80k
    const std::string incremental_fee{CFeeRate(DEFAULT_INCREMENTAL_RELAY_FEE).ToString(FeeRateFormat::SAT_VB)};
969
970
1.80k
    return RPCMethod{method_name,
971
1.80k
        "Bumps the fee of a transaction T, replacing it with a new transaction B.\n"
972
1.80k
        + std::string(want_psbt ? "Returns a PSBT instead of creating and signing a new transaction.\n" : "") +
973
1.80k
        "A transaction with the given txid must be in the wallet.\n"
974
1.80k
        "The command will pay the additional fee by reducing change outputs or adding inputs when necessary.\n"
975
1.80k
        "It may add a new change output if one does not already exist.\n"
976
1.80k
        "All inputs in the original transaction will be included in the replacement transaction.\n"
977
1.80k
        "The command will fail if the wallet or mempool contains a transaction that spends one of T's outputs.\n"
978
1.80k
        "By default, the new fee will be calculated automatically using the estimatesmartfee RPC.\n"
979
1.80k
        "The user can specify a confirmation target for estimatesmartfee.\n"
980
1.80k
        "Alternatively, the user can specify a fee rate in " + CURRENCY_ATOM + "/vB for the new transaction.\n"
981
1.80k
        "At a minimum, the new fee rate must be high enough to pay an additional new relay fee (incrementalfee\n"
982
1.80k
        "returned by getnetworkinfo) to enter the node's mempool.\n"
983
1.80k
        "* WARNING: before version 0.21, fee_rate was in " + CURRENCY_UNIT + "/kvB. As of 0.21, fee_rate is in " + CURRENCY_ATOM + "/vB. *\n",
984
1.80k
        {
985
1.80k
            {"txid", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "The txid to be bumped"},
986
1.80k
            {"options", RPCArg::Type::OBJ_NAMED_PARAMS, RPCArg::Optional::OMITTED, "",
987
1.80k
                Cat(
988
1.80k
                {
989
1.80k
                    {"conf_target", RPCArg::Type::NUM, RPCArg::DefaultHint{"wallet -txconfirmtarget"}, "Confirmation target in blocks\n"},
990
1.80k
                    {"fee_rate", RPCArg::Type::AMOUNT, RPCArg::DefaultHint{"not set, fall back to wallet fee estimation"},
991
1.80k
                             "\nSpecify a fee rate in " + CURRENCY_ATOM + "/vB instead of relying on the built-in fee estimator.\n"
992
1.80k
                             "Must be at least " + incremental_fee + " higher than the current transaction fee rate.\n"
993
1.80k
                             "WARNING: before version 0.21, fee_rate was in " + CURRENCY_UNIT + "/kvB. As of 0.21, fee_rate is in " + CURRENCY_ATOM + "/vB.\n"},
994
1.80k
                    {"replaceable", RPCArg::Type::BOOL, RPCArg::Default{true},
995
1.80k
                             "Whether the new transaction should be\n"
996
1.80k
                             "marked bip-125 replaceable. If true, the sequence numbers in the transaction will\n"
997
1.80k
                             "be set to 0xfffffffd. If false, any input sequence numbers in the\n"
998
1.80k
                             "transaction will be set to 0xfffffffe\n"
999
1.80k
                             "so the new transaction will not be explicitly bip-125 replaceable (though it may\n"
1000
1.80k
                             "still be replaceable in practice, for example if it has unconfirmed ancestors which\n"
1001
1.80k
                             "are replaceable).\n"},
1002
1.80k
                    {"estimate_mode", RPCArg::Type::STR, RPCArg::Default{"unset"}, "The fee estimate mode, must be one of (case insensitive):\n"
1003
1.80k
                              + FeeModesDetail(std::string("economical mode is used if the transaction is replaceable;\notherwise, conservative mode is used"))},
1004
1.80k
                    {"outputs", RPCArg::Type::ARR, RPCArg::Default{UniValue::VARR}, "The outputs specified as key-value pairs.\n"
1005
1.80k
                             "Each key may only appear once, i.e. there can only be one 'data' output, and no address may be duplicated.\n"
1006
1.80k
                             "At least one output of either type must be specified.\n"
1007
1.80k
                             "Cannot be provided if 'original_change_index' is specified.",
1008
1.80k
                        OutputsDoc(),
1009
1.80k
                        RPCArgOptions{.skip_type_check = true}},
1010
1.80k
                    {"original_change_index", RPCArg::Type::NUM, RPCArg::DefaultHint{"not set, detect change automatically"}, "The 0-based index of the change output on the original transaction. "
1011
1.80k
                                                                                                                            "The indicated output will be recycled into the new change output on the bumped transaction. "
1012
1.80k
                                                                                                                            "The remainder after paying the recipients and fees will be sent to the output script of the "
1013
1.80k
                                                                                                                            "original change output. The change output’s amount can increase if bumping the transaction "
1014
1.80k
                                                                                                                            "adds new inputs, otherwise it will decrease. Cannot be used in combination with the 'outputs' option."},
1015
1.80k
                },
1016
1.80k
                want_psbt ? std::vector<RPCArg>{{"psbt_version", RPCArg::Type::NUM, RPCArg::Default(2), "The PSBT version number to use."}} : std::vector<RPCArg>()
1017
1.80k
                ),
1018
1.80k
                RPCArgOptions{.oneline_description="options"}},
1019
1.80k
        },
1020
1.80k
        RPCResult{
1021
1.80k
            RPCResult::Type::OBJ, "", "", Cat(
1022
1.80k
                want_psbt ?
1023
831
                std::vector<RPCResult>{{RPCResult::Type::STR, "psbt", "The base64-encoded unsigned PSBT of the new transaction."}} :
1024
1.80k
                std::vector<RPCResult>{{RPCResult::Type::STR_HEX, "txid", "The id of the new transaction."}},
1025
1.80k
            {
1026
1.80k
                {RPCResult::Type::STR_AMOUNT, "origfee", "The fee of the replaced transaction."},
1027
1.80k
                {RPCResult::Type::STR_AMOUNT, "fee", "The fee of the new transaction."},
1028
1.80k
                {RPCResult::Type::ARR, "errors", "Errors encountered during processing (may be empty).",
1029
1.80k
                {
1030
1.80k
                    {RPCResult::Type::STR, "", ""},
1031
1.80k
                }},
1032
1.80k
            })
1033
1.80k
        },
1034
1.80k
        RPCExamples{
1035
1.80k
    "\nBump the fee, get the new transaction\'s " + std::string(want_psbt ? "psbt" : "txid") + "\n" +
1036
1.80k
            HelpExampleCli(method_name, "<txid>")
1037
1.80k
        },
1038
1.80k
        [want_psbt](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
1039
1.80k
{
1040
161
    std::shared_ptr<CWallet> const pwallet = GetWalletForJSONRPCRequest(request);
1041
161
    if (!pwallet) return UniValue::VNULL;
1042
1043
161
    if (pwallet->IsWalletFlagSet(WALLET_FLAG_DISABLE_PRIVATE_KEYS) && !pwallet->IsWalletFlagSet(WALLET_FLAG_EXTERNAL_SIGNER) && !want_psbt) {
1044
1
        throw JSONRPCError(RPC_WALLET_ERROR, "bumpfee is not available with wallets that have private keys disabled. Use psbtbumpfee instead.");
1045
1
    }
1046
1047
160
    Txid hash{Txid::FromUint256(ParseHashV(request.params[0], "txid"))};
1048
1049
160
    CCoinControl coin_control;
1050
    // optional parameters
1051
160
    coin_control.m_signal_bip125_rbf = true;
1052
160
    std::vector<CTxOut> outputs;
1053
1054
160
    std::optional<uint32_t> original_change_index;
1055
1056
160
    uint32_t psbt_version = 2;
1057
1058
160
    if (!request.params[1].isNull()) {
1059
70
        UniValue options = request.params[1];
1060
70
        RPCTypeCheckObj(options,
1061
70
            {
1062
70
                {"confTarget", UniValueType(UniValue::VNUM)},
1063
70
                {"conf_target", UniValueType(UniValue::VNUM)},
1064
70
                {"fee_rate", UniValueType()}, // will be checked by AmountFromValue() in SetFeeEstimateMode()
1065
70
                {"replaceable", UniValueType(UniValue::VBOOL)},
1066
70
                {"estimate_mode", UniValueType(UniValue::VSTR)},
1067
70
                {"outputs", UniValueType()}, // will be checked by AddOutputs()
1068
70
                {"original_change_index", UniValueType(UniValue::VNUM)},
1069
70
                {"psbt_version", UniValueType(UniValue::VNUM)},
1070
70
            },
1071
70
            true, true);
1072
1073
70
        if (options.exists("confTarget") && options.exists("conf_target")) {
1074
1
            throw JSONRPCError(RPC_INVALID_PARAMETER, "confTarget and conf_target options should not both be set. Use conf_target (confTarget is deprecated).");
1075
1
        }
1076
1077
69
        auto conf_target = options.exists("confTarget") ? options["confTarget"] : options["conf_target"];
1078
1079
69
        if (options.exists("replaceable")) {
1080
1
            coin_control.m_signal_bip125_rbf = options["replaceable"].get_bool();
1081
1
        }
1082
69
        SetFeeEstimateMode(*pwallet, coin_control, conf_target, options["estimate_mode"], options["fee_rate"], /*override_min_fee=*/false);
1083
1084
        // Prepare new outputs by creating a temporary tx and calling AddOutputs().
1085
69
        if (!options["outputs"].isNull()) {
1086
11
            if (options["outputs"].isArray() && options["outputs"].empty()) {
1087
1
                throw JSONRPCError(RPC_INVALID_PARAMETER, "Invalid parameter, output argument cannot be an empty array");
1088
1
            }
1089
10
            CMutableTransaction tempTx;
1090
10
            AddOutputs(tempTx, options["outputs"]);
1091
10
            outputs = tempTx.vout;
1092
10
        }
1093
1094
68
        if (options.exists("original_change_index")) {
1095
6
            original_change_index = options["original_change_index"].getInt<uint32_t>();
1096
6
        }
1097
1098
68
        if (options.exists("psbt_version")) {
1099
3
            psbt_version = options["psbt_version"].getInt<uint32_t>();
1100
3
        }
1101
68
        if (psbt_version != 2 && psbt_version != 0) {
1102
1
            throw JSONRPCError(RPC_INVALID_PARAMETER, "The PSBT version can only be 2 or 0");
1103
1
        }
1104
68
    }
1105
1106
    // Make sure the results are valid at least up to the most recent block
1107
    // the user could have gotten from another RPC command prior to now
1108
157
    pwallet->BlockUntilSyncedToCurrentChain();
1109
1110
157
    LOCK(pwallet->cs_wallet);
1111
1112
157
    EnsureWalletIsUnlocked(*pwallet);
1113
1114
1115
157
    std::vector<bilingual_str> errors;
1116
157
    CAmount old_fee;
1117
157
    CAmount new_fee;
1118
157
    CMutableTransaction mtx;
1119
    // Targeting feerate bump.
1120
157
    [&](){
1121
130
        switch (feebumper::CreateRateBumpTransaction(*pwallet, hash, coin_control, errors, old_fee, new_fee, mtx, /*require_mine=*/ !want_psbt, outputs, original_change_index)) {
1122
107
            case feebumper::Result::OK:
1123
107
                return;
1124
0
            case feebumper::Result::INVALID_ADDRESS_OR_KEY:
1125
0
                throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, errors[0].original);
1126
0
            case feebumper::Result::INVALID_REQUEST:
1127
0
                throw JSONRPCError(RPC_INVALID_REQUEST, errors[0].original);
1128
16
            case feebumper::Result::INVALID_PARAMETER:
1129
16
                throw JSONRPCError(RPC_INVALID_PARAMETER, errors[0].original);
1130
6
            case feebumper::Result::WALLET_ERROR:
1131
6
                throw JSONRPCError(RPC_WALLET_ERROR, errors[0].original);
1132
1
            case feebumper::Result::MISC_ERROR:
1133
1
                throw JSONRPCError(RPC_MISC_ERROR, errors[0].original);
1134
130
        } // no default case, so the compiler can warn about missing cases
1135
130
        NONFATAL_UNREACHABLE();
1136
130
    }();
1137
1138
157
    UniValue result(UniValue::VOBJ);
1139
1140
    // For bumpfee, return the new transaction id.
1141
    // For psbtbumpfee, return the base64-encoded unsigned PSBT of the new transaction.
1142
157
    if (!want_psbt) {
1143
98
        if (!feebumper::SignTransaction(*pwallet, mtx)) {
1144
0
            if (pwallet->IsWalletFlagSet(WALLET_FLAG_EXTERNAL_SIGNER)) {
1145
0
                throw JSONRPCError(RPC_WALLET_ERROR, "Transaction incomplete. Try psbtbumpfee instead.");
1146
0
            }
1147
0
            throw JSONRPCError(RPC_WALLET_ERROR, "Can't sign transaction.");
1148
0
        }
1149
1150
98
        Txid txid;
1151
98
        if (feebumper::CommitTransaction(*pwallet, hash, std::move(mtx), errors, txid) != feebumper::Result::OK) {
1152
0
            throw JSONRPCError(RPC_WALLET_ERROR, errors[0].original);
1153
0
        }
1154
1155
98
        result.pushKV("txid", txid.GetHex());
1156
98
    } else {
1157
59
        PartiallySignedTransaction psbtx(mtx, psbt_version);
1158
59
        bool complete = false;
1159
59
        const auto err{pwallet->FillPSBT(psbtx, {.sign = false, .bip32_derivs = true}, complete)};
1160
59
        CHECK_NONFATAL(!err);
1161
59
        CHECK_NONFATAL(!complete);
1162
59
        DataStream ssTx{};
1163
59
        ssTx << psbtx;
1164
59
        result.pushKV("psbt", EncodeBase64(ssTx.str()));
1165
59
    }
1166
1167
157
    result.pushKV("origfee", ValueFromAmount(old_fee));
1168
157
    result.pushKV("fee", ValueFromAmount(new_fee));
1169
157
    UniValue result_errors(UniValue::VARR);
1170
157
    for (const bilingual_str& error : errors) {
1171
0
        result_errors.push_back(error.original);
1172
0
    }
1173
157
    result.pushKV("errors", std::move(result_errors));
1174
1175
157
    return result;
1176
157
},
1177
1.80k
    };
1178
1.80k
}
1179
1180
972
RPCMethod bumpfee() { return bumpfee_helper("bumpfee"); }
1181
831
RPCMethod psbtbumpfee() { return bumpfee_helper("psbtbumpfee"); }
1182
1183
RPCMethod send()
1184
1.03k
{
1185
1.03k
    return RPCMethod{
1186
1.03k
        "send",
1187
1.03k
        "Send a transaction.\n",
1188
1.03k
        {
1189
1.03k
            {"outputs", RPCArg::Type::ARR, RPCArg::Optional::NO, "The outputs specified as key-value pairs.\n"
1190
1.03k
                    "Each key may only appear once, i.e. there can only be one 'data' output, and no address may be duplicated.\n"
1191
1.03k
                    "At least one output of either type must be specified.\n"
1192
1.03k
                    "For convenience, a dictionary, which holds the key-value pairs directly, is also accepted.",
1193
1.03k
                OutputsDoc(),
1194
1.03k
                RPCArgOptions{.skip_type_check = true}},
1195
1.03k
            {"conf_target", RPCArg::Type::NUM, RPCArg::DefaultHint{"wallet -txconfirmtarget"}, "Confirmation target in blocks"},
1196
1.03k
            {"estimate_mode", RPCArg::Type::STR, RPCArg::Default{"unset"}, "The fee estimate mode, must be one of (case insensitive):\n"
1197
1.03k
              + FeeModesDetail(std::string("economical mode is used if the transaction is replaceable;\notherwise, conservative mode is used"))},
1198
1.03k
            {"fee_rate", RPCArg::Type::AMOUNT, RPCArg::DefaultHint{"not set, fall back to wallet fee estimation"}, "Specify a fee rate in " + CURRENCY_ATOM + "/vB."},
1199
1.03k
            {"options", RPCArg::Type::OBJ_NAMED_PARAMS, RPCArg::Optional::OMITTED, "",
1200
1.03k
                Cat<std::vector<RPCArg>>(
1201
1.03k
                {
1202
1.03k
                    {"add_inputs", RPCArg::Type::BOOL, RPCArg::DefaultHint{"false when \"inputs\" are specified, true otherwise"},"Automatically include coins from the wallet to cover the target amount.\n"},
1203
1.03k
                    {"include_unsafe", RPCArg::Type::BOOL, RPCArg::Default{false}, "Include inputs that are not safe to spend (unconfirmed transactions from outside keys and unconfirmed replacement transactions).\n"
1204
1.03k
                                                          "Warning: the resulting transaction may become invalid if one of the unsafe inputs disappears.\n"
1205
1.03k
                                                          "If that happens, you will need to fund the transaction with different inputs and republish it."},
1206
1.03k
                    {"minconf", RPCArg::Type::NUM, RPCArg::Default{0}, "If add_inputs is specified, require inputs with at least this many confirmations."},
1207
1.03k
                    {"maxconf", RPCArg::Type::NUM, RPCArg::Optional::OMITTED, "If add_inputs is specified, require inputs with at most this many confirmations."},
1208
1.03k
                    {"add_to_wallet", RPCArg::Type::BOOL, RPCArg::Default{true}, "When false, returns a serialized transaction which will not be added to the wallet or broadcast"},
1209
1.03k
                    {"change_address", RPCArg::Type::STR, RPCArg::DefaultHint{"automatic"}, "The bitcoin address to receive the change"},
1210
1.03k
                    {"change_position", RPCArg::Type::NUM, RPCArg::DefaultHint{"random"}, "The index of the change output"},
1211
1.03k
                    {"change_type", RPCArg::Type::STR, RPCArg::DefaultHint{"set by -changetype"}, "The output type to use. Only valid if change_address is not specified. Options are " + FormatAllOutputTypes() + "."},
1212
1.03k
                    {"fee_rate", RPCArg::Type::AMOUNT, RPCArg::DefaultHint{"not set, fall back to wallet fee estimation"}, "Specify a fee rate in " + CURRENCY_ATOM + "/vB.", RPCArgOptions{.also_positional = true}},
1213
1.03k
                    {"include_watching", RPCArg::Type::BOOL, RPCArg::Default{"false"}, "(DEPRECATED) No longer used"},
1214
1.03k
                    {"inputs", RPCArg::Type::ARR, RPCArg::Default{UniValue::VARR}, "Specify inputs instead of adding them automatically.",
1215
1.03k
                        {
1216
1.03k
                          {"", RPCArg::Type::OBJ, RPCArg::Optional::OMITTED, "", {
1217
1.03k
                            {"txid", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "The transaction id"},
1218
1.03k
                            {"vout", RPCArg::Type::NUM, RPCArg::Optional::NO, "The output number"},
1219
1.03k
                            {"sequence", RPCArg::Type::NUM, RPCArg::DefaultHint{"depends on the value of the 'replaceable' and 'locktime' arguments"}, "The sequence number"},
1220
1.03k
                            {"weight", RPCArg::Type::NUM, RPCArg::DefaultHint{"Calculated from wallet and solving data"}, "The maximum weight for this input, "
1221
1.03k
                                        "including the weight of the outpoint and sequence number. "
1222
1.03k
                                        "Note that signature sizes are not guaranteed to be consistent, "
1223
1.03k
                                        "so the maximum DER signatures size of 73 bytes should be used when considering ECDSA signatures."
1224
1.03k
                                        "Remember to convert serialized sizes to weight units when necessary."},
1225
1.03k
                          }},
1226
1.03k
                        },
1227
1.03k
                    },
1228
1.03k
                    {"locktime", RPCArg::Type::NUM, RPCArg::DefaultHint{"locktime close to block height to prevent fee sniping"}, "Raw locktime. Non-0 value also locktime-activates inputs"},
1229
1.03k
                    {"lock_unspents", RPCArg::Type::BOOL, RPCArg::Default{false}, "Lock selected unspent outputs"},
1230
1.03k
                    {"psbt", RPCArg::Type::BOOL,  RPCArg::DefaultHint{"automatic"}, "Always return a PSBT, implies add_to_wallet=false."},
1231
1.03k
                    {"subtract_fee_from_outputs", RPCArg::Type::ARR, RPCArg::Default{UniValue::VARR}, "Outputs to subtract the fee from, specified as integer indices.\n"
1232
1.03k
                    "The fee will be equally deducted from the amount of each specified output.\n"
1233
1.03k
                    "Those recipients will receive less bitcoins than you enter in their corresponding amount field.\n"
1234
1.03k
                    "If no outputs are specified here, the sender pays the fee.",
1235
1.03k
                        {
1236
1.03k
                            {"vout_index", RPCArg::Type::NUM, RPCArg::Optional::OMITTED, "The zero-based output index, before a change output is added."},
1237
1.03k
                        },
1238
1.03k
                    },
1239
1.03k
                    {"max_tx_weight", RPCArg::Type::NUM, RPCArg::Default{MAX_STANDARD_TX_WEIGHT}, "The maximum acceptable transaction weight.\n"
1240
1.03k
                                                  "Transaction building will fail if this can not be satisfied."},
1241
1.03k
                },
1242
1.03k
                FundTxDoc()),
1243
1.03k
                RPCArgOptions{.oneline_description="options"}},
1244
1.03k
                {"version", RPCArg::Type::NUM, RPCArg::Default{DEFAULT_WALLET_TX_VERSION}, "Transaction version"},
1245
1.03k
        },
1246
1.03k
        RPCResult{
1247
1.03k
            RPCResult::Type::OBJ, "", "",
1248
1.03k
                {
1249
1.03k
                    {RPCResult::Type::BOOL, "complete", "If the transaction has a complete set of signatures"},
1250
1.03k
                    {RPCResult::Type::STR_HEX, "txid", /*optional=*/true, "The transaction id for the send. Only 1 transaction is created regardless of the number of addresses."},
1251
1.03k
                    {RPCResult::Type::STR_HEX, "hex", /*optional=*/true, "If add_to_wallet is false, the hex-encoded raw transaction with signature(s)"},
1252
1.03k
                    {RPCResult::Type::STR, "psbt", /*optional=*/true, "If more signatures are needed, or if add_to_wallet is false, the base64-encoded (partially) signed transaction"}
1253
1.03k
                }
1254
1.03k
        },
1255
1.03k
        RPCExamples{""
1256
1.03k
        "\nSend 0.1 BTC with a confirmation target of 6 blocks in economical fee estimate mode\n"
1257
1.03k
        + HelpExampleCli("send", "'{\"" + EXAMPLE_ADDRESS[0] + "\": 0.1}' 6 economical\n") +
1258
1.03k
        "Send 0.2 BTC with a fee rate of 1.1 " + CURRENCY_ATOM + "/vB using positional arguments\n"
1259
1.03k
        + HelpExampleCli("send", "'{\"" + EXAMPLE_ADDRESS[0] + "\": 0.2}' null \"unset\" 1.1\n") +
1260
1.03k
        "Send 0.2 BTC with a fee rate of 1 " + CURRENCY_ATOM + "/vB using the options argument\n"
1261
1.03k
        + HelpExampleCli("send", "'{\"" + EXAMPLE_ADDRESS[0] + "\": 0.2}' null \"unset\" null '{\"fee_rate\": 1}'\n") +
1262
1.03k
        "Send 0.3 BTC with a fee rate of 25 " + CURRENCY_ATOM + "/vB using named arguments\n"
1263
1.03k
        + HelpExampleCli("-named send", "outputs='{\"" + EXAMPLE_ADDRESS[0] + "\": 0.3}' fee_rate=25\n") +
1264
1.03k
        "Create a transaction that should confirm the next block, with a specific input, and return result without adding to wallet or broadcasting to the network\n"
1265
1.03k
        + HelpExampleCli("send", "'{\"" + EXAMPLE_ADDRESS[0] + "\": 0.1}' 1 economical null '{\"add_to_wallet\": false, \"inputs\": [{\"txid\":\"a08e6907dbbd3d809776dbfc5d82e371b764ed838b5655e72f463568df1aadf0\", \"vout\":1}]}'")
1266
1.03k
        },
1267
1.03k
        [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
1268
1.03k
        {
1269
216
            std::shared_ptr<CWallet> const pwallet = GetWalletForJSONRPCRequest(request);
1270
216
            if (!pwallet) return UniValue::VNULL;
1271
1272
216
            UniValue options{request.params[4].isNull() ? UniValue::VOBJ : request.params[4]};
1273
216
            InterpretFeeEstimationInstructions(/*conf_target=*/request.params[1], /*estimate_mode=*/request.params[2], /*fee_rate=*/request.params[3], options);
1274
216
            PreventOutdatedOptions(options);
1275
1276
1277
216
            bool rbf{options.exists("replaceable") ? options["replaceable"].get_bool() : pwallet->m_signal_rbf};
1278
216
            UniValue outputs(UniValue::VOBJ);
1279
216
            outputs = NormalizeOutputs(request.params[0]);
1280
216
            std::vector<CRecipient> recipients = CreateRecipients(
1281
216
                    ParseOutputs(outputs),
1282
216
                    InterpretSubtractFeeFromOutputInstructions(options["subtract_fee_from_outputs"], outputs.getKeys())
1283
216
            );
1284
216
            CCoinControl coin_control;
1285
216
            coin_control.m_version = self.Arg<uint32_t>("version");
1286
216
            CMutableTransaction rawTx = ConstructTransaction(options["inputs"], request.params[0], options["locktime"], rbf, coin_control.m_version);
1287
            // Automatically select coins, unless at least one is manually selected. Can
1288
            // be overridden by options.add_inputs.
1289
216
            coin_control.m_allow_other_inputs = rawTx.vin.size() == 0;
1290
216
            if (options.exists("max_tx_weight")) {
1291
0
                coin_control.m_max_tx_weight = options["max_tx_weight"].getInt<int>();
1292
0
            }
1293
1294
216
            SetOptionsInputWeights(options["inputs"], options);
1295
            // Clear tx.vout since it is not meant to be used now that we are passing outputs directly.
1296
            // This sets us up for a future PR to completely remove tx from the function signature in favor of passing inputs directly
1297
216
            rawTx.vout.clear();
1298
216
            auto txr = FundTransaction(*pwallet, rawTx, recipients, options, coin_control, /*override_min_fee=*/false);
1299
1300
216
            CMutableTransaction tx = CMutableTransaction(*txr.tx);
1301
216
            return FinishTransaction(pwallet, options, tx);
1302
216
        }
1303
1.03k
    };
1304
1.03k
}
1305
1306
RPCMethod sendall()
1307
997
{
1308
997
    return RPCMethod{"sendall",
1309
997
        "Spend the value of all (or specific) confirmed UTXOs and unconfirmed change in the wallet to one or more recipients.\n"
1310
997
        "Unconfirmed inbound UTXOs and locked UTXOs will not be spent. Sendall will respect the avoid_reuse wallet flag.\n"
1311
997
        "If your wallet contains many small inputs, either because it received tiny payments or as a result of accumulating change, consider using `send_max` to exclude inputs that are worth less than the fees needed to spend them.\n",
1312
997
        {
1313
997
            {"recipients", RPCArg::Type::ARR, RPCArg::Optional::NO, "The sendall destinations. Each address may only appear once.\n"
1314
997
                "Optionally some recipients can be specified with an amount to perform payments, but at least one address must appear without a specified amount.\n",
1315
997
                {
1316
997
                    {"address", RPCArg::Type::STR, RPCArg::Optional::NO, "A bitcoin address which receives an equal share of the unspecified amount."},
1317
997
                    {"", RPCArg::Type::OBJ_USER_KEYS, RPCArg::Optional::OMITTED, "",
1318
997
                        {
1319
997
                            {"address", RPCArg::Type::AMOUNT, RPCArg::Optional::NO, "A key-value pair. The key (string) is the bitcoin address, the value (float or string) is the amount in " + CURRENCY_UNIT + ""},
1320
997
                        },
1321
997
                    },
1322
997
                },
1323
997
            },
1324
997
            {"conf_target", RPCArg::Type::NUM, RPCArg::DefaultHint{"wallet -txconfirmtarget"}, "Confirmation target in blocks"},
1325
997
            {"estimate_mode", RPCArg::Type::STR, RPCArg::Default{"unset"}, "The fee estimate mode, must be one of (case insensitive):\n"
1326
997
              + FeeModesDetail(std::string("economical mode is used if the transaction is replaceable;\notherwise, conservative mode is used"))},
1327
997
            {"fee_rate", RPCArg::Type::AMOUNT, RPCArg::DefaultHint{"not set, fall back to wallet fee estimation"}, "Specify a fee rate in " + CURRENCY_ATOM + "/vB."},
1328
997
            {
1329
997
                "options", RPCArg::Type::OBJ_NAMED_PARAMS, RPCArg::Optional::OMITTED, "",
1330
997
                Cat<std::vector<RPCArg>>(
1331
997
                    {
1332
997
                        {"add_to_wallet", RPCArg::Type::BOOL, RPCArg::Default{true}, "When false, returns the serialized transaction without broadcasting or adding it to the wallet"},
1333
997
                        {"fee_rate", RPCArg::Type::AMOUNT, RPCArg::DefaultHint{"not set, fall back to wallet fee estimation"}, "Specify a fee rate in " + CURRENCY_ATOM + "/vB.", RPCArgOptions{.also_positional = true}},
1334
997
                        {"include_watching", RPCArg::Type::BOOL, RPCArg::Default{false}, "(DEPRECATED) No longer used"},
1335
997
                        {"inputs", RPCArg::Type::ARR, RPCArg::Default{UniValue::VARR}, "Use exactly the specified inputs to build the transaction. Specifying inputs is incompatible with the send_max, minconf, and maxconf options.",
1336
997
                            {
1337
997
                                {"", RPCArg::Type::OBJ, RPCArg::Optional::OMITTED, "",
1338
997
                                    {
1339
997
                                        {"txid", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "The transaction id"},
1340
997
                                        {"vout", RPCArg::Type::NUM, RPCArg::Optional::NO, "The output number"},
1341
997
                                        {"sequence", RPCArg::Type::NUM, RPCArg::DefaultHint{"depends on the value of the 'replaceable' and 'locktime' arguments"}, "The sequence number"},
1342
997
                                    },
1343
997
                                },
1344
997
                            },
1345
997
                        },
1346
997
                        {"locktime", RPCArg::Type::NUM, RPCArg::DefaultHint{"locktime close to block height to prevent fee sniping"}, "Raw locktime. Non-0 value also locktime-activates inputs"},
1347
997
                        {"lock_unspents", RPCArg::Type::BOOL, RPCArg::Default{false}, "Lock selected unspent outputs"},
1348
997
                        {"psbt", RPCArg::Type::BOOL,  RPCArg::DefaultHint{"automatic"}, "Always return a PSBT, implies add_to_wallet=false."},
1349
997
                        {"send_max", RPCArg::Type::BOOL, RPCArg::Default{false}, "When true, only use UTXOs that can pay for their own fees to maximize the output amount. When 'false' (default), no UTXO is left behind. send_max is incompatible with providing specific inputs."},
1350
997
                        {"minconf", RPCArg::Type::NUM, RPCArg::Default{0}, "Require inputs with at least this many confirmations."},
1351
997
                        {"maxconf", RPCArg::Type::NUM, RPCArg::Optional::OMITTED, "Require inputs with at most this many confirmations."},
1352
997
                        {"version", RPCArg::Type::NUM, RPCArg::Default{DEFAULT_WALLET_TX_VERSION}, "Transaction version"},
1353
997
                    },
1354
997
                    FundTxDoc()
1355
997
                ),
1356
997
                RPCArgOptions{.oneline_description="options"}
1357
997
            },
1358
997
        },
1359
997
        RPCResult{
1360
997
            RPCResult::Type::OBJ, "", "",
1361
997
                {
1362
997
                    {RPCResult::Type::BOOL, "complete", "If the transaction has a complete set of signatures"},
1363
997
                    {RPCResult::Type::STR_HEX, "txid", /*optional=*/true, "The transaction id for the send. Only 1 transaction is created regardless of the number of addresses."},
1364
997
                    {RPCResult::Type::STR_HEX, "hex", /*optional=*/true, "If add_to_wallet is false, the hex-encoded raw transaction with signature(s)"},
1365
997
                    {RPCResult::Type::STR, "psbt", /*optional=*/true, "If more signatures are needed, or if add_to_wallet is false, the base64-encoded (partially) signed transaction"}
1366
997
                }
1367
997
        },
1368
997
        RPCExamples{""
1369
997
        "\nSpend all UTXOs from the wallet with a fee rate of 1 " + CURRENCY_ATOM + "/vB using named arguments\n"
1370
997
        + HelpExampleCli("-named sendall", "recipients='[\"" + EXAMPLE_ADDRESS[0] + "\"]' fee_rate=1\n") +
1371
997
        "Spend all UTXOs with a fee rate of 1.1 " + CURRENCY_ATOM + "/vB using positional arguments\n"
1372
997
        + HelpExampleCli("sendall", "'[\"" + EXAMPLE_ADDRESS[0] + "\"]' null \"unset\" 1.1\n") +
1373
997
        "Spend all UTXOs split into equal amounts to two addresses with a fee rate of 1.5 " + CURRENCY_ATOM + "/vB using the options argument\n"
1374
997
        + HelpExampleCli("sendall", "'[\"" + EXAMPLE_ADDRESS[0] + "\", \"" + EXAMPLE_ADDRESS[1] + "\"]' null \"unset\" null '{\"fee_rate\": 1.5}'\n") +
1375
997
        "Leave dust UTXOs in wallet, spend only UTXOs with positive effective value with a fee rate of 10 " + CURRENCY_ATOM + "/vB using the options argument\n"
1376
997
        + HelpExampleCli("sendall", "'[\"" + EXAMPLE_ADDRESS[0] + "\"]' null \"unset\" null '{\"fee_rate\": 10, \"send_max\": true}'\n") +
1377
997
        "Spend all UTXOs with a fee rate of 1.3 " + CURRENCY_ATOM + "/vB using named arguments and sending a 0.25 " + CURRENCY_UNIT + " to another recipient\n"
1378
997
        + HelpExampleCli("-named sendall", "recipients='[{\"" + EXAMPLE_ADDRESS[1] + "\": 0.25}, \""+ EXAMPLE_ADDRESS[0] + "\"]' fee_rate=1.3\n")
1379
997
        },
1380
997
        [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
1381
997
        {
1382
176
            std::shared_ptr<CWallet> const pwallet{GetWalletForJSONRPCRequest(request)};
1383
176
            if (!pwallet) return UniValue::VNULL;
1384
            // Make sure the results are valid at least up to the most recent block
1385
            // the user could have gotten from another RPC command prior to now
1386
176
            pwallet->BlockUntilSyncedToCurrentChain();
1387
1388
176
            UniValue options{request.params[4].isNull() ? UniValue::VOBJ : request.params[4]};
1389
176
            InterpretFeeEstimationInstructions(/*conf_target=*/request.params[1], /*estimate_mode=*/request.params[2], /*fee_rate=*/request.params[3], options);
1390
176
            PreventOutdatedOptions(options);
1391
1392
1393
176
            std::set<std::string> addresses_without_amount;
1394
176
            UniValue recipient_key_value_pairs(UniValue::VARR);
1395
176
            const UniValue& recipients{request.params[0]};
1396
1.06k
            for (unsigned int i = 0; i < recipients.size(); ++i) {
1397
885
                const UniValue& recipient{recipients[i]};
1398
885
                if (recipient.isStr()) {
1399
876
                    UniValue rkvp(UniValue::VOBJ);
1400
876
                    rkvp.pushKV(recipient.get_str(), 0);
1401
876
                    recipient_key_value_pairs.push_back(std::move(rkvp));
1402
876
                    addresses_without_amount.insert(recipient.get_str());
1403
876
                } else {
1404
9
                    recipient_key_value_pairs.push_back(recipient);
1405
9
                }
1406
885
            }
1407
1408
176
            if (addresses_without_amount.size() == 0) {
1409
2
                throw JSONRPCError(RPC_INVALID_PARAMETER, "Must provide at least one address without a specified amount");
1410
2
            }
1411
1412
174
            CCoinControl coin_control;
1413
1414
174
            SetFeeEstimateMode(*pwallet, coin_control, options["conf_target"], options["estimate_mode"], options["fee_rate"], /*override_min_fee=*/false);
1415
1416
174
            if (options.exists("minconf")) {
1417
7
                if (options["minconf"].getInt<int>() < 0)
1418
1
                {
1419
1
                    throw JSONRPCError(RPC_INVALID_PARAMETER, strprintf("Invalid minconf (minconf cannot be negative): %s", options["minconf"].getInt<int>()));
1420
1
                }
1421
1422
6
                coin_control.m_min_depth = options["minconf"].getInt<int>();
1423
6
            }
1424
1425
173
            if (options.exists("maxconf")) {
1426
2
                coin_control.m_max_depth = options["maxconf"].getInt<int>();
1427
1428
2
                if (coin_control.m_max_depth < coin_control.m_min_depth) {
1429
0
                    throw JSONRPCError(RPC_INVALID_PARAMETER, strprintf("maxconf can't be lower than minconf: %d < %d", coin_control.m_max_depth, coin_control.m_min_depth));
1430
0
                }
1431
2
            }
1432
1433
173
            if (options.exists("version")) {
1434
9
                coin_control.m_version = options["version"].getInt<decltype(coin_control.m_version)>();
1435
9
            }
1436
1437
173
            if (coin_control.m_version == TRUC_VERSION) {
1438
7
                coin_control.m_max_tx_weight = TRUC_MAX_WEIGHT;
1439
166
            } else {
1440
166
                coin_control.m_max_tx_weight = MAX_STANDARD_TX_WEIGHT;
1441
166
            }
1442
1443
173
            const bool rbf{options.exists("replaceable") ? options["replaceable"].get_bool() : pwallet->m_signal_rbf};
1444
1445
173
            FeeCalculation fee_calc_out;
1446
173
            CFeeRate fee_rate{GetMinimumFeeRate(*pwallet, coin_control, &fee_calc_out)};
1447
            // Do not, ever, assume that it's fine to change the fee rate if the user has explicitly
1448
            // provided one
1449
173
            if (coin_control.m_feerate && fee_rate > *coin_control.m_feerate) {
1450
1
                const auto feerate_format = FeeRateFormat::SAT_VB;
1451
1
                auto msg{strprintf("Fee rate (%s) is lower than the minimum fee rate setting (%s).",
1452
1
                    coin_control.m_feerate->ToString(feerate_format),
1453
1
                    fee_rate.ToString(feerate_format))};
1454
1
                if (fee_calc_out.reason == FeeReason::REQUIRED) {
1455
1
                    msg += strprintf("\nConsider modifying -mintxfee (%s) or -minrelaytxfee (%s).",
1456
1
                        pwallet->m_min_fee.ToString(feerate_format),
1457
1
                        pwallet->chain().relayMinFee().ToString(feerate_format));
1458
1
                }
1459
1
                throw JSONRPCError(RPC_INVALID_PARAMETER, msg);
1460
1
            }
1461
172
            if (fee_calc_out.reason == FeeReason::FALLBACK && !pwallet->m_allow_fallback_fee) {
1462
                // eventually allow a fallback fee
1463
0
                throw JSONRPCError(RPC_WALLET_ERROR, "Fee estimation failed. Fallbackfee is disabled. Wait a few blocks or enable -fallbackfee.");
1464
0
            }
1465
1466
172
            CMutableTransaction rawTx{ConstructTransaction(options["inputs"], recipient_key_value_pairs, options["locktime"], rbf, coin_control.m_version)};
1467
172
            LOCK(pwallet->cs_wallet);
1468
1469
172
            CAmount total_input_value(0);
1470
172
            bool send_max{options.exists("send_max") ? options["send_max"].get_bool() : false};
1471
172
            if (options.exists("inputs") && options.exists("send_max")) {
1472
1
                throw JSONRPCError(RPC_INVALID_PARAMETER, "Cannot combine send_max with specific inputs.");
1473
171
            } else if (options.exists("inputs") && (options.exists("minconf") || options.exists("maxconf"))) {
1474
1
                throw JSONRPCError(RPC_INVALID_PARAMETER, "Cannot combine minconf or maxconf with specific inputs.");
1475
170
            } else if (options.exists("inputs")) {
1476
16
                for (const CTxIn& input : rawTx.vin) {
1477
16
                    if (pwallet->IsSpent(input.prevout)) {
1478
2
                        throw JSONRPCError(RPC_INVALID_PARAMETER, strprintf("Input not available. UTXO (%s:%d) was already spent.", input.prevout.hash.ToString(), input.prevout.n));
1479
2
                    }
1480
14
                    const CWalletTx* tx{pwallet->GetWalletTx(input.prevout.hash)};
1481
14
                    if (!tx || input.prevout.n >= tx->tx->vout.size() || !pwallet->IsMine(tx->tx->vout[input.prevout.n])) {
1482
2
                        throw JSONRPCError(RPC_INVALID_PARAMETER, strprintf("Input not found. UTXO (%s:%d) is not part of wallet.", input.prevout.hash.ToString(), input.prevout.n));
1483
2
                    }
1484
12
                    if (pwallet->GetTxDepthInMainChain(*tx) == 0) {
1485
5
                        if (tx->tx->version == TRUC_VERSION && coin_control.m_version != TRUC_VERSION) {
1486
0
                            throw JSONRPCError(RPC_INVALID_PARAMETER, strprintf("Can't spend unconfirmed version 3 pre-selected input with a version %d tx", coin_control.m_version));
1487
5
                        } else if (coin_control.m_version == TRUC_VERSION && tx->tx->version != TRUC_VERSION) {
1488
0
                            throw JSONRPCError(RPC_INVALID_PARAMETER, strprintf("Can't spend unconfirmed version %d pre-selected input with a version 3 tx", tx->tx->version));
1489
0
                        }
1490
5
                    }
1491
12
                    total_input_value += tx->tx->vout[input.prevout.n].nValue;
1492
12
                }
1493
155
            } else {
1494
155
                CoinFilterParams coins_params;
1495
155
                coins_params.min_amount = 0;
1496
2.81k
                for (const COutput& output : AvailableCoins(*pwallet, &coin_control, fee_rate, coins_params).All()) {
1497
2.81k
                    if (send_max && fee_rate.GetFee(output.input_bytes) > output.txout.nValue) {
1498
2
                        continue;
1499
2
                    }
1500
                    // we are spending an unconfirmed TRUC transaction, so lower max weight
1501
2.81k
                    if (output.depth == 0 && coin_control.m_version == TRUC_VERSION) {
1502
4
                        coin_control.m_max_tx_weight = TRUC_CHILD_MAX_WEIGHT;
1503
4
                    }
1504
2.81k
                    CTxIn input(output.outpoint.hash, output.outpoint.n, CScript(), rbf ? MAX_BIP125_RBF_SEQUENCE : CTxIn::MAX_SEQUENCE_NONFINAL);
1505
2.81k
                    rawTx.vin.push_back(input);
1506
2.81k
                    total_input_value += output.txout.nValue;
1507
2.81k
                }
1508
155
            }
1509
1510
166
            std::vector<COutPoint> outpoints_spent;
1511
166
            outpoints_spent.reserve(rawTx.vin.size());
1512
1513
2.82k
            for (const CTxIn& tx_in : rawTx.vin) {
1514
2.82k
                outpoints_spent.push_back(tx_in.prevout);
1515
2.82k
            }
1516
1517
            // estimate final size of tx
1518
166
            const TxSize tx_size{CalculateMaximumSignedTxSize(CTransaction(rawTx), pwallet.get())};
1519
166
            if (tx_size.vsize == -1) {
1520
2
                throw JSONRPCError(RPC_WALLET_ERROR, "Unable to determine the size of the transaction, the wallet contains unsolvable descriptors");
1521
2
            }
1522
164
            const CAmount fee_from_size{fee_rate.GetFee(tx_size.vsize)};
1523
164
            const std::optional<CAmount> total_bump_fees{pwallet->chain().calculateCombinedBumpFee(outpoints_spent, fee_rate)};
1524
164
            CAmount effective_value = total_input_value - fee_from_size - total_bump_fees.value_or(0);
1525
1526
164
            if (fee_from_size > pwallet->m_default_max_tx_fee) {
1527
1
                throw JSONRPCError(RPC_WALLET_ERROR, TransactionErrorString(TransactionError::MAX_FEE_EXCEEDED).original);
1528
1
            }
1529
1530
163
            if (effective_value <= 0) {
1531
33
                if (send_max) {
1532
0
                    throw JSONRPCError(RPC_WALLET_INSUFFICIENT_FUNDS, "Total value of UTXO pool too low to pay for transaction, try using lower feerate.");
1533
33
                } else {
1534
33
                    throw JSONRPCError(RPC_WALLET_INSUFFICIENT_FUNDS, "Total value of UTXO pool too low to pay for transaction. Try using lower feerate or excluding uneconomic UTXOs with 'send_max' option.");
1535
33
                }
1536
33
            }
1537
1538
            // If this transaction is too large, e.g. because the wallet has many UTXOs, it will be rejected by the node's mempool.
1539
130
            if (tx_size.weight > coin_control.m_max_tx_weight) {
1540
3
                throw JSONRPCError(RPC_WALLET_ERROR, "Transaction too large.");
1541
3
            }
1542
1543
127
            CAmount output_amounts_claimed{0};
1544
487
            for (const CTxOut& out : rawTx.vout) {
1545
487
                output_amounts_claimed += out.nValue;
1546
487
            }
1547
1548
127
            if (output_amounts_claimed > total_input_value) {
1549
1
                throw JSONRPCError(RPC_WALLET_INSUFFICIENT_FUNDS, "Assigned more value to outputs than available funds.");
1550
1
            }
1551
1552
126
            const CAmount remainder{effective_value - output_amounts_claimed};
1553
126
            if (remainder < 0) {
1554
1
                throw JSONRPCError(RPC_WALLET_INSUFFICIENT_FUNDS, "Insufficient funds for fees after creating specified outputs.");
1555
1
            }
1556
1557
125
            const CAmount per_output_without_amount{remainder / (long)addresses_without_amount.size()};
1558
1559
125
            bool gave_remaining_to_first{false};
1560
482
            for (CTxOut& out : rawTx.vout) {
1561
482
                CTxDestination dest;
1562
482
                ExtractDestination(out.scriptPubKey, dest);
1563
482
                std::string addr{EncodeDestination(dest)};
1564
482
                if (addresses_without_amount.contains(addr)) {
1565
476
                    out.nValue = per_output_without_amount;
1566
476
                    if (!gave_remaining_to_first) {
1567
123
                        out.nValue += remainder % addresses_without_amount.size();
1568
123
                        gave_remaining_to_first = true;
1569
123
                    }
1570
476
                    if (IsDust(out, pwallet->chain().relayDustFee())) {
1571
                        // Dynamically generated output amount is dust
1572
2
                        throw JSONRPCError(RPC_WALLET_INSUFFICIENT_FUNDS, "Dynamically assigned remainder results in dust output.");
1573
2
                    }
1574
476
                } else {
1575
6
                    if (IsDust(out, pwallet->chain().relayDustFee())) {
1576
                        // Specified output amount is dust
1577
1
                        throw JSONRPCError(RPC_INVALID_PARAMETER, strprintf("Specified output amount to %s is below dust threshold.", addr));
1578
1
                    }
1579
6
                }
1580
482
            }
1581
1582
122
            const bool lock_unspents{options.exists("lock_unspents") ? options["lock_unspents"].get_bool() : false};
1583
122
            if (lock_unspents) {
1584
2
                for (const CTxIn& txin : rawTx.vin) {
1585
2
                    pwallet->LockCoin(txin.prevout, /*persist=*/false);
1586
2
                }
1587
2
            }
1588
1589
122
            return FinishTransaction(pwallet, options, rawTx);
1590
125
        }
1591
997
    };
1592
997
}
1593
1594
RPCMethod walletprocesspsbt()
1595
1.44k
{
1596
1.44k
    return RPCMethod{
1597
1.44k
        "walletprocesspsbt",
1598
1.44k
        "Update a PSBT with input information from our wallet and then sign inputs\n"
1599
1.44k
                "that we can sign for." +
1600
1.44k
        HELP_REQUIRING_PASSPHRASE,
1601
1.44k
                {
1602
1.44k
                    {"psbt", RPCArg::Type::STR, RPCArg::Optional::NO, "The transaction base64 string"},
1603
1.44k
                    {"sign", RPCArg::Type::BOOL, RPCArg::Default{true}, "Also sign the transaction when updating (requires wallet to be unlocked)"},
1604
1.44k
                    {"sighashtype", RPCArg::Type::STR, RPCArg::Default{"DEFAULT for Taproot, ALL otherwise"}, "The signature hash type to sign with if not specified by the PSBT. Must be one of\n"
1605
1.44k
            "       \"DEFAULT\"\n"
1606
1.44k
            "       \"ALL\"\n"
1607
1.44k
            "       \"NONE\"\n"
1608
1.44k
            "       \"SINGLE\"\n"
1609
1.44k
            "       \"ALL|ANYONECANPAY\"\n"
1610
1.44k
            "       \"NONE|ANYONECANPAY\"\n"
1611
1.44k
            "       \"SINGLE|ANYONECANPAY\""},
1612
1.44k
                    {"bip32derivs", RPCArg::Type::BOOL, RPCArg::Default{true}, "Include BIP 32 derivation paths for public keys if we know them"},
1613
1.44k
                    {"finalize", RPCArg::Type::BOOL, RPCArg::Default{true}, "Also finalize inputs if possible"},
1614
1.44k
                },
1615
1.44k
                RPCResult{
1616
1.44k
                    RPCResult::Type::OBJ, "", "",
1617
1.44k
                    {
1618
1.44k
                        {RPCResult::Type::STR, "psbt", "The base64-encoded partially signed transaction"},
1619
1.44k
                        {RPCResult::Type::BOOL, "complete", "If the transaction has a complete set of signatures"},
1620
1.44k
                        {RPCResult::Type::STR_HEX, "hex", /*optional=*/true, "The hex-encoded network transaction if complete"},
1621
1.44k
                    }
1622
1.44k
                },
1623
1.44k
                RPCExamples{
1624
1.44k
                    HelpExampleCli("walletprocesspsbt", "\"psbt\"")
1625
1.44k
                },
1626
1.44k
        [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
1627
1.44k
{
1628
622
    const std::shared_ptr<const CWallet> pwallet = GetWalletForJSONRPCRequest(request);
1629
622
    if (!pwallet) return UniValue::VNULL;
1630
1631
622
    const CWallet& wallet{*pwallet};
1632
    // Make sure the results are valid at least up to the most recent block
1633
    // the user could have gotten from another RPC command prior to now
1634
622
    wallet.BlockUntilSyncedToCurrentChain();
1635
1636
    // Unserialize the transaction
1637
622
    util::Result<PartiallySignedTransaction> psbt_res = DecodeBase64PSBT(request.params[0].get_str());
1638
622
    if (!psbt_res) {
1639
2
        throw JSONRPCError(RPC_DESERIALIZATION_ERROR, strprintf("TX decode failed %s", util::ErrorString(psbt_res).original));
1640
2
    }
1641
620
    PartiallySignedTransaction psbtx = *psbt_res;
1642
1643
    // Get the sighash type
1644
620
    std::optional<int> nHashType = ParseSighashString(request.params[2]);
1645
1646
    // Fill transaction with our data and also sign
1647
620
    bool sign = request.params[1].isNull() ? true : request.params[1].get_bool();
1648
620
    bool bip32derivs = request.params[3].isNull() ? true : request.params[3].get_bool();
1649
620
    bool finalize = request.params[4].isNull() ? true : request.params[4].get_bool();
1650
620
    bool complete = true;
1651
1652
620
    if (sign) EnsureWalletIsUnlocked(*pwallet);
1653
1654
620
    const auto err{wallet.FillPSBT(psbtx, {.sign = sign, .sighash_type = nHashType, .finalize = finalize, .bip32_derivs = bip32derivs}, complete)};
1655
620
    if (err) {
1656
7
        throw JSONRPCPSBTError(*err);
1657
7
    }
1658
1659
613
    UniValue result(UniValue::VOBJ);
1660
613
    DataStream ssTx{};
1661
613
    ssTx << psbtx;
1662
613
    result.pushKV("psbt", EncodeBase64(ssTx.str()));
1663
613
    result.pushKV("complete", complete);
1664
613
    if (complete) {
1665
42
        CMutableTransaction mtx;
1666
        // Returns true if complete, which we already think it is.
1667
42
        CHECK_NONFATAL(FinalizeAndExtractPSBT(psbtx, mtx));
1668
42
        DataStream ssTx_final;
1669
42
        ssTx_final << TX_WITH_WITNESS(mtx);
1670
42
        result.pushKV("hex", HexStr(ssTx_final));
1671
42
    }
1672
1673
613
    return result;
1674
620
},
1675
1.44k
    };
1676
1.44k
}
1677
1678
RPCMethod walletcreatefundedpsbt()
1679
1.05k
{
1680
1.05k
    return RPCMethod{
1681
1.05k
        "walletcreatefundedpsbt",
1682
1.05k
        "Creates and funds a transaction in the Partially Signed Transaction format.\n"
1683
1.05k
                "Implements the Creator and Updater roles.\n"
1684
1.05k
                "All existing inputs must either have their previous output transaction be in the wallet\n"
1685
1.05k
                "or be in the UTXO set. Solving data must be provided for non-wallet inputs.\n",
1686
1.05k
                {
1687
1.05k
                    {"inputs", RPCArg::Type::ARR, RPCArg::Optional::OMITTED, "Leave empty to add inputs automatically. See add_inputs option.",
1688
1.05k
                        {
1689
1.05k
                            {"", RPCArg::Type::OBJ, RPCArg::Optional::OMITTED, "",
1690
1.05k
                                {
1691
1.05k
                                    {"txid", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "The transaction id"},
1692
1.05k
                                    {"vout", RPCArg::Type::NUM, RPCArg::Optional::NO, "The output number"},
1693
1.05k
                                    {"sequence", RPCArg::Type::NUM, RPCArg::DefaultHint{"depends on the value of the 'locktime' and 'options.replaceable' arguments"}, "The sequence number"},
1694
1.05k
                                    {"weight", RPCArg::Type::NUM, RPCArg::DefaultHint{"Calculated from wallet and solving data"}, "The maximum weight for this input, "
1695
1.05k
                                        "including the weight of the outpoint and sequence number. "
1696
1.05k
                                        "Note that signature sizes are not guaranteed to be consistent, "
1697
1.05k
                                        "so the maximum DER signatures size of 73 bytes should be used when considering ECDSA signatures."
1698
1.05k
                                        "Remember to convert serialized sizes to weight units when necessary."},
1699
1.05k
                                },
1700
1.05k
                            },
1701
1.05k
                        },
1702
1.05k
                        },
1703
1.05k
                    {"outputs", RPCArg::Type::ARR, RPCArg::Optional::NO, "The outputs specified as key-value pairs.\n"
1704
1.05k
                            "Each key may only appear once, i.e. there can only be one 'data' output, and no address may be duplicated.\n"
1705
1.05k
                            "At least one output of either type must be specified.\n"
1706
1.05k
                            "For compatibility reasons, a dictionary, which holds the key-value pairs directly, is also\n"
1707
1.05k
                            "accepted as second parameter.",
1708
1.05k
                        OutputsDoc(),
1709
1.05k
                        RPCArgOptions{.skip_type_check = true}},
1710
1.05k
                    {"locktime", RPCArg::Type::NUM, RPCArg::Default{0}, "Raw locktime. Non-0 value also locktime-activates inputs"},
1711
1.05k
                    {"options", RPCArg::Type::OBJ_NAMED_PARAMS, RPCArg::Optional::OMITTED, "",
1712
1.05k
                        Cat<std::vector<RPCArg>>(
1713
1.05k
                        {
1714
1.05k
                            {"add_inputs", RPCArg::Type::BOOL, RPCArg::DefaultHint{"false when \"inputs\" are specified, true otherwise"}, "Automatically include coins from the wallet to cover the target amount.\n"},
1715
1.05k
                            {"include_unsafe", RPCArg::Type::BOOL, RPCArg::Default{false}, "Include inputs that are not safe to spend (unconfirmed transactions from outside keys and unconfirmed replacement transactions).\n"
1716
1.05k
                                                          "Warning: the resulting transaction may become invalid if one of the unsafe inputs disappears.\n"
1717
1.05k
                                                          "If that happens, you will need to fund the transaction with different inputs and republish it."},
1718
1.05k
                            {"minconf", RPCArg::Type::NUM, RPCArg::Default{0}, "If add_inputs is specified, require inputs with at least this many confirmations."},
1719
1.05k
                            {"maxconf", RPCArg::Type::NUM, RPCArg::Optional::OMITTED, "If add_inputs is specified, require inputs with at most this many confirmations."},
1720
1.05k
                            {"changeAddress", RPCArg::Type::STR, RPCArg::DefaultHint{"automatic"}, "The bitcoin address to receive the change"},
1721
1.05k
                            {"changePosition", RPCArg::Type::NUM, RPCArg::DefaultHint{"random"}, "The index of the change output"},
1722
1.05k
                            {"change_type", RPCArg::Type::STR, RPCArg::DefaultHint{"set by -changetype"}, "The output type to use. Only valid if changeAddress is not specified. Options are " + FormatAllOutputTypes() + "."},
1723
1.05k
                            {"includeWatching", RPCArg::Type::BOOL, RPCArg::Default{false}, "(DEPRECATED) No longer used"},
1724
1.05k
                            {"lockUnspents", RPCArg::Type::BOOL, RPCArg::Default{false}, "Lock selected unspent outputs"},
1725
1.05k
                            {"fee_rate", RPCArg::Type::AMOUNT, RPCArg::DefaultHint{"not set, fall back to wallet fee estimation"}, "Specify a fee rate in " + CURRENCY_ATOM + "/vB."},
1726
1.05k
                            {"feeRate", RPCArg::Type::AMOUNT, RPCArg::DefaultHint{"not set, fall back to wallet fee estimation"}, "Specify a fee rate in " + CURRENCY_UNIT + "/kvB."},
1727
1.05k
                            {"subtractFeeFromOutputs", RPCArg::Type::ARR, RPCArg::Default{UniValue::VARR}, "The outputs to subtract the fee from.\n"
1728
1.05k
                                                          "The fee will be equally deducted from the amount of each specified output.\n"
1729
1.05k
                                                          "Those recipients will receive less bitcoins than you enter in their corresponding amount field.\n"
1730
1.05k
                                                          "If no outputs are specified here, the sender pays the fee.",
1731
1.05k
                                {
1732
1.05k
                                    {"vout_index", RPCArg::Type::NUM, RPCArg::Optional::OMITTED, "The zero-based output index, before a change output is added."},
1733
1.05k
                                },
1734
1.05k
                            },
1735
1.05k
                            {"max_tx_weight", RPCArg::Type::NUM, RPCArg::Default{MAX_STANDARD_TX_WEIGHT}, "The maximum acceptable transaction weight.\n"
1736
1.05k
                                                          "Transaction building will fail if this can not be satisfied."},
1737
1.05k
                        },
1738
1.05k
                        FundTxDoc()),
1739
1.05k
                        RPCArgOptions{.oneline_description="options"}},
1740
1.05k
                    {"bip32derivs", RPCArg::Type::BOOL, RPCArg::Default{true}, "Include BIP 32 derivation paths for public keys if we know them"},
1741
1.05k
                    {"version", RPCArg::Type::NUM, RPCArg::Default{DEFAULT_WALLET_TX_VERSION}, "Transaction version"},
1742
1.05k
                    {"psbt_version", RPCArg::Type::NUM, RPCArg::Default(2), "The PSBT version number to use."},
1743
1.05k
                },
1744
1.05k
                RPCResult{
1745
1.05k
                    RPCResult::Type::OBJ, "", "",
1746
1.05k
                    {
1747
1.05k
                        {RPCResult::Type::STR, "psbt", "The resulting raw transaction (base64-encoded string)"},
1748
1.05k
                        {RPCResult::Type::STR_AMOUNT, "fee", "Fee in " + CURRENCY_UNIT + " the resulting transaction pays"},
1749
1.05k
                        {RPCResult::Type::NUM, "changepos", "The position of the added change output, or -1"},
1750
1.05k
                    }
1751
1.05k
                                },
1752
1.05k
                                RPCExamples{
1753
1.05k
                            "\nCreate a PSBT with automatically picked inputs that sends 0.5 BTC to an address and has a fee rate of 2 sat/vB:\n"
1754
1.05k
                            + HelpExampleCli("walletcreatefundedpsbt", "\"[]\" \"[{\\\"" + EXAMPLE_ADDRESS[0] + "\\\":0.5}]\" 0 \"{\\\"add_inputs\\\":true,\\\"fee_rate\\\":2}\"")
1755
1.05k
                            + "\nCreate the same PSBT as the above one instead using named arguments:\n"
1756
1.05k
                            + HelpExampleCli("-named walletcreatefundedpsbt", "outputs=\"[{\\\"" + EXAMPLE_ADDRESS[0] + "\\\":0.5}]\" add_inputs=true fee_rate=2")
1757
1.05k
                                },
1758
1.05k
        [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
1759
1.05k
{
1760
231
    std::shared_ptr<CWallet> const pwallet = GetWalletForJSONRPCRequest(request);
1761
231
    if (!pwallet) return UniValue::VNULL;
1762
1763
231
    CWallet& wallet{*pwallet};
1764
    // Make sure the results are valid at least up to the most recent block
1765
    // the user could have gotten from another RPC command prior to now
1766
231
    wallet.BlockUntilSyncedToCurrentChain();
1767
1768
231
    UniValue options{request.params[3].isNull() ? UniValue::VOBJ : request.params[3]};
1769
1770
231
    CCoinControl coin_control;
1771
231
    coin_control.m_version = self.Arg<uint32_t>("version");
1772
1773
231
    const UniValue &replaceable_arg = options["replaceable"];
1774
231
    const bool rbf{replaceable_arg.isNull() ? wallet.m_signal_rbf : replaceable_arg.get_bool()};
1775
231
    CMutableTransaction rawTx = ConstructTransaction(request.params[0], request.params[1], request.params[2], rbf, coin_control.m_version);
1776
231
    UniValue outputs(UniValue::VOBJ);
1777
231
    outputs = NormalizeOutputs(request.params[1]);
1778
231
    std::vector<CRecipient> recipients = CreateRecipients(
1779
231
            ParseOutputs(outputs),
1780
231
            InterpretSubtractFeeFromOutputInstructions(options["subtractFeeFromOutputs"], outputs.getKeys())
1781
231
    );
1782
    // Automatically select coins, unless at least one is manually selected. Can
1783
    // be overridden by options.add_inputs.
1784
231
    coin_control.m_allow_other_inputs = rawTx.vin.size() == 0;
1785
231
    SetOptionsInputWeights(request.params[0], options);
1786
    // Clear tx.vout since it is not meant to be used now that we are passing outputs directly.
1787
    // This sets us up for a future PR to completely remove tx from the function signature in favor of passing inputs directly
1788
231
    rawTx.vout.clear();
1789
231
    auto txr = FundTransaction(wallet, rawTx, recipients, options, coin_control, /*override_min_fee=*/true);
1790
1791
    // Make a blank psbt
1792
231
    uint32_t psbt_version = 2;
1793
231
    if (!request.params[6].isNull()) {
1794
5
        psbt_version = request.params[6].getInt<int>();
1795
5
    }
1796
231
    if (psbt_version != 2 && psbt_version != 0) {
1797
1
        throw JSONRPCError(RPC_INVALID_PARAMETER, "The PSBT version can only be 2 or 0");
1798
1
    }
1799
1800
230
    PartiallySignedTransaction psbtx(CMutableTransaction(*txr.tx), psbt_version);
1801
1802
    // Fill transaction with out data but don't sign
1803
230
    bool bip32derivs = request.params[4].isNull() ? true : request.params[4].get_bool();
1804
230
    bool complete = true;
1805
230
    const auto err{wallet.FillPSBT(psbtx, {.sign = false, .bip32_derivs = bip32derivs}, complete)};
1806
230
    if (err) {
1807
0
        throw JSONRPCPSBTError(*err);
1808
0
    }
1809
1810
    // Serialize the PSBT
1811
230
    DataStream ssTx{};
1812
230
    ssTx << psbtx;
1813
1814
230
    UniValue result(UniValue::VOBJ);
1815
230
    result.pushKV("psbt", EncodeBase64(ssTx.str()));
1816
230
    result.pushKV("fee", ValueFromAmount(txr.fee));
1817
230
    result.pushKV("changepos", txr.change_pos ? (int)*txr.change_pos : -1);
1818
230
    return result;
1819
230
},
1820
1.05k
    };
1821
1.05k
}
1822
} // namespace wallet