Coverage Report

Created: 2025-04-09 20:14

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