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