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