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