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