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