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