Branch data Line data Source code
1 : : // Copyright (c) 2017-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/system.h>
6 : : #include <consensus/validation.h>
7 : : #include <interfaces/chain.h>
8 : : #include <node/types.h>
9 : : #include <policy/fees.h>
10 : : #include <policy/policy.h>
11 : : #include <util/moneystr.h>
12 : : #include <util/rbf.h>
13 : : #include <util/translation.h>
14 : : #include <wallet/coincontrol.h>
15 : : #include <wallet/feebumper.h>
16 : : #include <wallet/fees.h>
17 : : #include <wallet/receive.h>
18 : : #include <wallet/spend.h>
19 : : #include <wallet/wallet.h>
20 : :
21 : : namespace wallet {
22 : : //! Check whether transaction has descendant in wallet or mempool, or has been
23 : : //! mined, or conflicts with a mined transaction. Return a feebumper::Result.
24 : 225 : static feebumper::Result PreconditionChecks(const CWallet& wallet, const CWalletTx& wtx, bool require_mine, std::vector<bilingual_str>& errors) EXCLUSIVE_LOCKS_REQUIRED(wallet.cs_wallet)
25 : : {
26 [ + + ]: 225 : if (wallet.HasWalletSpend(wtx.tx)) {
27 [ + - + - ]: 4 : errors.emplace_back(Untranslated("Transaction has descendants in the wallet"));
28 : 2 : return feebumper::Result::INVALID_PARAMETER;
29 : : }
30 : :
31 : 223 : {
32 [ + + ]: 223 : if (wallet.chain().hasDescendantsInMempool(wtx.GetHash())) {
33 [ + - + - ]: 2 : errors.emplace_back(Untranslated("Transaction has descendants in the mempool"));
34 : 1 : return feebumper::Result::INVALID_PARAMETER;
35 : : }
36 : : }
37 : :
38 [ - + ]: 222 : if (wallet.GetTxDepthInMainChain(wtx) != 0) {
39 [ # # # # ]: 0 : errors.emplace_back(Untranslated("Transaction has been mined, or is conflicted with a mined transaction"));
40 : 0 : return feebumper::Result::WALLET_ERROR;
41 : : }
42 : :
43 [ + + ]: 222 : if (wtx.mapValue.count("replaced_by_txid")) {
44 [ + - + - : 3 : errors.push_back(Untranslated(strprintf("Cannot bump transaction %s which was already bumped by transaction %s", wtx.GetHash().ToString(), wtx.mapValue.at("replaced_by_txid"))));
+ - + - ]
45 : 1 : return feebumper::Result::WALLET_ERROR;
46 : : }
47 : :
48 [ + + ]: 221 : if (require_mine) {
49 : : // check that original tx consists entirely of our inputs
50 : : // if not, we can't bump the fee, because the wallet has no way of knowing the value of the other inputs (thus the fee)
51 : 115 : isminefilter filter = ISMINE_SPENDABLE;
52 [ + + ]: 115 : if (!AllInputsMine(wallet, *wtx.tx, filter)) {
53 [ + - + - ]: 2 : errors.emplace_back(Untranslated("Transaction contains inputs that don't belong to this wallet"));
54 : 1 : return feebumper::Result::WALLET_ERROR;
55 : : }
56 : : }
57 : :
58 : : return feebumper::Result::OK;
59 : : }
60 : :
61 : : //! Check if the user provided a valid feeRate
62 : 32 : static feebumper::Result CheckFeeRate(const CWallet& wallet, const CMutableTransaction& mtx, const CFeeRate& newFeerate, const int64_t maxTxSize, CAmount old_fee, std::vector<bilingual_str>& errors)
63 : : {
64 : : // check that fee rate is higher than mempool's minimum fee
65 : : // (no point in bumping fee if we know that the new tx won't be accepted to the mempool)
66 : : // This may occur if the user set fee_rate or paytxfee too low, if fallbackfee is too low, or, perhaps,
67 : : // in a rare situation where the mempool minimum fee increased significantly since the fee estimation just a
68 : : // moment earlier. In this case, we report an error to the user, who may adjust the fee.
69 : 32 : CFeeRate minMempoolFeeRate = wallet.chain().mempoolMinFee();
70 : :
71 [ - + ]: 32 : if (newFeerate.GetFeePerK() < minMempoolFeeRate.GetFeePerK()) {
72 [ # # ]: 0 : errors.push_back(Untranslated(
73 [ # # ]: 0 : strprintf("New fee rate (%s) is lower than the minimum fee rate (%s) to get into the mempool -- ",
74 [ # # ]: 0 : FormatMoney(newFeerate.GetFeePerK()),
75 [ # # ]: 0 : FormatMoney(minMempoolFeeRate.GetFeePerK()))));
76 : 0 : return feebumper::Result::WALLET_ERROR;
77 : : }
78 : :
79 : 32 : std::vector<COutPoint> reused_inputs;
80 [ + - ]: 32 : reused_inputs.reserve(mtx.vin.size());
81 [ + + ]: 72 : for (const CTxIn& txin : mtx.vin) {
82 [ + - ]: 40 : reused_inputs.push_back(txin.prevout);
83 : : }
84 : :
85 [ + - ]: 32 : std::optional<CAmount> combined_bump_fee = wallet.chain().calculateCombinedBumpFee(reused_inputs, newFeerate);
86 [ - + ]: 32 : if (!combined_bump_fee.has_value()) {
87 [ # # # # ]: 0 : errors.push_back(Untranslated(strprintf("Failed to calculate bump fees, because unconfirmed UTXOs depend on enormous cluster of unconfirmed transactions.")));
88 : : }
89 [ + - + - ]: 32 : CAmount new_total_fee = newFeerate.GetFee(maxTxSize) + combined_bump_fee.value();
90 : :
91 [ + - ]: 32 : CFeeRate incrementalRelayFee = wallet.chain().relayIncrementalFee();
92 : :
93 : : // Min total fee is old fee + relay fee
94 [ + - ]: 32 : CAmount minTotalFee = old_fee + incrementalRelayFee.GetFee(maxTxSize);
95 : :
96 [ + + ]: 32 : if (new_total_fee < minTotalFee) {
97 [ + - + - ]: 33 : errors.push_back(Untranslated(strprintf("Insufficient total fee %s, must be at least %s (oldFee %s + incrementalFee %s)",
98 [ + - + - : 22 : FormatMoney(new_total_fee), FormatMoney(minTotalFee), FormatMoney(old_fee), FormatMoney(incrementalRelayFee.GetFee(maxTxSize)))));
+ - + - +
- ]
99 : 11 : return feebumper::Result::INVALID_PARAMETER;
100 : : }
101 : :
102 [ + - ]: 21 : CAmount requiredFee = GetRequiredFee(wallet, maxTxSize);
103 [ - + ]: 21 : if (new_total_fee < requiredFee) {
104 [ # # # # ]: 0 : errors.push_back(Untranslated(strprintf("Insufficient total fee (cannot be less than required fee %s)",
105 [ # # ]: 0 : FormatMoney(requiredFee))));
106 : 0 : return feebumper::Result::INVALID_PARAMETER;
107 : : }
108 : :
109 : : // Check that in all cases the new fee doesn't violate maxTxFee
110 : 21 : const CAmount max_tx_fee = wallet.m_default_max_tx_fee;
111 [ + + ]: 21 : if (new_total_fee > max_tx_fee) {
112 [ + - + - ]: 3 : errors.push_back(Untranslated(strprintf("Specified or calculated fee %s is too high (cannot be higher than -maxtxfee %s)",
113 [ + - + - ]: 2 : FormatMoney(new_total_fee), FormatMoney(max_tx_fee))));
114 : 1 : return feebumper::Result::WALLET_ERROR;
115 : : }
116 : :
117 : : return feebumper::Result::OK;
118 : 32 : }
119 : :
120 : 89 : static CFeeRate EstimateFeeRate(const CWallet& wallet, const CWalletTx& wtx, const CAmount old_fee, const CCoinControl& coin_control)
121 : : {
122 : : // Get the fee rate of the original transaction. This is calculated from
123 : : // the tx fee/vsize, so it may have been rounded down. Add 1 satoshi to the
124 : : // result.
125 : 89 : int64_t txSize = GetVirtualTransactionSize(*(wtx.tx));
126 : 89 : CFeeRate feerate(old_fee, txSize);
127 : 89 : feerate += CFeeRate(1);
128 : :
129 : : // The node has a configurable incremental relay fee. Increment the fee by
130 : : // the minimum of that and the wallet's conservative
131 : : // WALLET_INCREMENTAL_RELAY_FEE value to future proof against changes to
132 : : // network wide policy for incremental relay fee that our node may not be
133 : : // aware of. This ensures we're over the required relay fee rate
134 : : // (Rule 4). The replacement tx will be at least as large as the
135 : : // original tx, so the total fee will be greater (Rule 3)
136 : 89 : CFeeRate node_incremental_relay_fee = wallet.chain().relayIncrementalFee();
137 [ + - ]: 89 : CFeeRate wallet_incremental_relay_fee = CFeeRate(WALLET_INCREMENTAL_RELAY_FEE);
138 [ + - ]: 178 : feerate += std::max(node_incremental_relay_fee, wallet_incremental_relay_fee);
139 : :
140 : : // Fee rate must also be at least the wallet's GetMinimumFeeRate
141 : 89 : CFeeRate min_feerate(GetMinimumFeeRate(wallet, coin_control, /*feeCalc=*/nullptr));
142 : :
143 : : // Set the required fee rate for the replacement transaction in coin control.
144 [ + + ]: 89 : return std::max(feerate, min_feerate);
145 : : }
146 : :
147 : : namespace feebumper {
148 : :
149 : 0 : bool TransactionCanBeBumped(const CWallet& wallet, const Txid& txid)
150 : : {
151 : 0 : LOCK(wallet.cs_wallet);
152 [ # # ]: 0 : const CWalletTx* wtx = wallet.GetWalletTx(txid);
153 [ # # ]: 0 : if (wtx == nullptr) return false;
154 : :
155 : 0 : std::vector<bilingual_str> errors_dummy;
156 [ # # ]: 0 : feebumper::Result res = PreconditionChecks(wallet, *wtx, /* require_mine=*/ true, errors_dummy);
157 : 0 : return res == feebumper::Result::OK;
158 : 0 : }
159 : :
160 : 129 : Result CreateRateBumpTransaction(CWallet& wallet, const Txid& txid, const CCoinControl& coin_control, std::vector<bilingual_str>& errors,
161 : : CAmount& old_fee, CAmount& new_fee, CMutableTransaction& mtx, bool require_mine, const std::vector<CTxOut>& outputs, std::optional<uint32_t> original_change_index)
162 : : {
163 : : // For now, cannot specify both new outputs to use and an output index to send change
164 [ + + + + ]: 129 : if (!outputs.empty() && original_change_index.has_value()) {
165 [ + - + - ]: 2 : errors.emplace_back(Untranslated("The options 'outputs' and 'original_change_index' are incompatible. You can only either specify a new set of outputs, or designate a change output to be recycled."));
166 : 1 : return Result::INVALID_PARAMETER;
167 : : }
168 : :
169 : : // We are going to modify coin control later, copy to reuse
170 : 128 : CCoinControl new_coin_control(coin_control);
171 : :
172 [ + - ]: 128 : LOCK(wallet.cs_wallet);
173 : 128 : errors.clear();
174 [ + - ]: 128 : auto it = wallet.mapWallet.find(txid);
175 [ + - ]: 128 : if (it == wallet.mapWallet.end()) {
176 [ # # # # : 0 : errors.emplace_back(Untranslated("Invalid or non-wallet transaction id"));
# # ]
177 : 0 : return Result::INVALID_ADDRESS_OR_KEY;
178 : : }
179 [ + + ]: 128 : const CWalletTx& wtx = it->second;
180 : :
181 : : // Make sure that original_change_index is valid
182 [ + + + + ]: 128 : if (original_change_index.has_value() && original_change_index.value() >= wtx.tx->vout.size()) {
183 [ + - + - : 2 : errors.emplace_back(Untranslated("Change position is out of range"));
+ - ]
184 : 1 : return Result::INVALID_PARAMETER;
185 : : }
186 : :
187 : : // Retrieve all of the UTXOs and add them to coin control
188 : : // While we're here, calculate the input amount
189 : 127 : std::map<COutPoint, Coin> coins;
190 : 127 : CAmount input_value = 0;
191 : 127 : std::vector<CTxOut> spent_outputs;
192 [ + + ]: 409 : for (const CTxIn& txin : wtx.tx->vin) {
193 [ + - ]: 282 : coins[txin.prevout]; // Create empty map entry keyed by prevout.
194 : : }
195 [ + - ]: 127 : wallet.chain().findCoins(coins);
196 [ + + ]: 408 : for (const CTxIn& txin : wtx.tx->vin) {
197 [ + - ]: 282 : const Coin& coin = coins.at(txin.prevout);
198 [ + + ]: 282 : if (coin.out.IsNull()) {
199 [ + - + - : 2 : errors.emplace_back(Untranslated(strprintf("%s:%u is already spent", txin.prevout.hash.GetHex(), txin.prevout.n)));
+ - + - ]
200 : 1 : return Result::MISC_ERROR;
201 : : }
202 [ + - ]: 281 : PreselectedInput& preset_txin = new_coin_control.Select(txin.prevout);
203 [ + - + + ]: 281 : if (!wallet.IsMine(txin.prevout)) {
204 [ + - ]: 3 : preset_txin.SetTxOut(coin.out);
205 : : }
206 : 281 : input_value += coin.out.nValue;
207 [ + - ]: 281 : spent_outputs.push_back(coin.out);
208 : : }
209 : :
210 : : // Figure out if we need to compute the input weight, and do so if necessary
211 : 126 : PrecomputedTransactionData txdata;
212 [ + - ]: 126 : txdata.Init(*wtx.tx, std::move(spent_outputs), /* force=*/ true);
213 [ + + ]: 407 : for (unsigned int i = 0; i < wtx.tx->vin.size(); ++i) {
214 [ + - ]: 281 : const CTxIn& txin = wtx.tx->vin.at(i);
215 [ + - ]: 281 : const Coin& coin = coins.at(txin.prevout);
216 : :
217 [ + - + + ]: 281 : if (new_coin_control.IsExternalSelected(txin.prevout)) {
218 : : // For external inputs, we estimate the size using the size of this input
219 : 3 : int64_t input_weight = GetTransactionInputWeight(txin);
220 : : // Because signatures can have different sizes, we need to figure out all of the
221 : : // signature sizes and replace them with the max sized signature.
222 : : // In order to do this, we verify the script with a special SignatureChecker which
223 : : // will observe the signatures verified and record their sizes.
224 : 3 : SignatureWeights weights;
225 [ + - ]: 3 : TransactionSignatureChecker tx_checker(wtx.tx.get(), i, coin.out.nValue, txdata, MissingDataBehavior::FAIL);
226 [ + - ]: 3 : SignatureWeightChecker size_checker(weights, tx_checker);
227 [ + - ]: 3 : VerifyScript(txin.scriptSig, coin.out.scriptPubKey, &txin.scriptWitness, STANDARD_SCRIPT_VERIFY_FLAGS, size_checker);
228 : : // Add the difference between max and current to input_weight so that it represents the largest the input could be
229 [ + - ]: 3 : input_weight += weights.GetWeightDiffToMax();
230 [ + - ]: 3 : new_coin_control.SetInputWeight(txin.prevout, input_weight);
231 : 3 : }
232 : : }
233 : :
234 [ + - ]: 126 : Result result = PreconditionChecks(wallet, wtx, require_mine, errors);
235 [ + + ]: 126 : if (result != Result::OK) {
236 : : return result;
237 : : }
238 : :
239 : : // Calculate the old output amount.
240 : 121 : CAmount output_value = 0;
241 [ + + ]: 453 : for (const auto& old_output : wtx.tx->vout) {
242 : 332 : output_value += old_output.nValue;
243 : : }
244 : :
245 : 121 : old_fee = input_value - output_value;
246 : :
247 : : // Fill in recipients (and preserve a single change key if there
248 : : // is one). If outputs vector is non-empty, replace original
249 : : // outputs with its contents, otherwise use original outputs.
250 : 121 : std::vector<CRecipient> recipients;
251 : 121 : CAmount new_outputs_value = 0;
252 [ + + ]: 121 : const auto& txouts = outputs.empty() ? wtx.tx->vout : outputs;
253 [ + + ]: 349 : for (size_t i = 0; i < txouts.size(); ++i) {
254 [ + - ]: 228 : const CTxOut& output = txouts.at(i);
255 : 228 : CTxDestination dest;
256 [ + - ]: 228 : ExtractDestination(output.scriptPubKey, dest);
257 [ + + + - : 228 : if (original_change_index.has_value() ? original_change_index.value() == i : OutputIsChange(wallet, output)) {
+ + ]
258 [ + - ]: 112 : new_coin_control.destChange = dest;
259 : : } else {
260 [ + - ]: 116 : CRecipient recipient = {dest, output.nValue, false};
261 [ + - ]: 116 : recipients.push_back(recipient);
262 : 116 : }
263 : 228 : new_outputs_value += output.nValue;
264 : 228 : }
265 : :
266 : : // If no recipients, means that we are sending coins to a change address
267 [ + + ]: 121 : if (recipients.empty()) {
268 : : // Just as a sanity check, ensure that the change address exist
269 [ + - ]: 5 : if (std::get_if<CNoDestination>(&new_coin_control.destChange)) {
270 [ # # # # : 0 : errors.emplace_back(Untranslated("Unable to create transaction. Transaction must have at least one recipient"));
# # ]
271 : 0 : return Result::INVALID_PARAMETER;
272 : : }
273 : :
274 : : // Add change as recipient with SFFO flag enabled, so fees are deduced from it.
275 : : // If the output differs from the original tx output (because the user customized it) a new change output will be created.
276 [ + - + - ]: 10 : recipients.emplace_back(CRecipient{new_coin_control.destChange, new_outputs_value, /*fSubtractFeeFromAmount=*/true});
277 : 5 : new_coin_control.destChange = CNoDestination();
278 : : }
279 : :
280 [ + + ]: 121 : if (coin_control.m_feerate) {
281 : : // The user provided a feeRate argument.
282 : : // We calculate this here to avoid compiler warning on the cs_wallet lock
283 : : // We need to make a temporary transaction with no input witnesses as the dummy signer expects them to be empty for external inputs
284 [ + - ]: 32 : CMutableTransaction temp_mtx{*wtx.tx};
285 [ + + ]: 72 : for (auto& txin : temp_mtx.vin) {
286 : 40 : txin.scriptSig.clear();
287 : 40 : txin.scriptWitness.SetNull();
288 : : }
289 [ + - ]: 32 : temp_mtx.vout = txouts;
290 [ + - + - ]: 32 : const int64_t maxTxSize{CalculateMaximumSignedTxSize(CTransaction(temp_mtx), &wallet, &new_coin_control).vsize};
291 [ + - ]: 32 : Result res = CheckFeeRate(wallet, temp_mtx, *new_coin_control.m_feerate, maxTxSize, old_fee, errors);
292 [ + + ]: 32 : if (res != Result::OK) {
293 : 12 : return res;
294 : : }
295 : 32 : } else {
296 : : // The user did not provide a feeRate argument
297 [ + - ]: 89 : new_coin_control.m_feerate = EstimateFeeRate(wallet, wtx, old_fee, new_coin_control);
298 : : }
299 : :
300 : : // Fill in required inputs we are double-spending(all of them)
301 : : // N.B.: bip125 doesn't require all the inputs in the replaced transaction to be
302 : : // used in the replacement transaction, but it's very important for wallets to make
303 : : // sure that happens. If not, it would be possible to bump a transaction A twice to
304 : : // A2 and A3 where A2 and A3 don't conflict (or alternatively bump A to A2 and A2
305 : : // to A3 where A and A3 don't conflict). If both later get confirmed then the sender
306 : : // has accidentally double paid.
307 [ + + ]: 370 : for (const auto& inputs : wtx.tx->vin) {
308 [ + - ]: 261 : new_coin_control.Select(COutPoint(inputs.prevout));
309 : : }
310 : 109 : new_coin_control.m_allow_other_inputs = true;
311 : :
312 : : // We cannot source new unconfirmed inputs(bip125 rule 2)
313 : 109 : new_coin_control.m_min_depth = 1;
314 : :
315 [ + - ]: 109 : auto res = CreateTransaction(wallet, recipients, /*change_pos=*/std::nullopt, new_coin_control, false);
316 [ + + ]: 109 : if (!res) {
317 [ + - + - : 21 : errors.emplace_back(Untranslated("Unable to create transaction.") + Untranslated(" ") + util::ErrorString(res));
+ - + - +
- + - +
- ]
318 : 3 : return Result::WALLET_ERROR;
319 : : }
320 : :
321 : 106 : const auto& txr = *res;
322 : : // Write back new fee if successful
323 : 106 : new_fee = txr.fee;
324 : :
325 : : // Write back transaction
326 [ + - ]: 106 : mtx = CMutableTransaction(*txr.tx);
327 : :
328 : 106 : return Result::OK;
329 : 376 : }
330 : :
331 : 99 : bool SignTransaction(CWallet& wallet, CMutableTransaction& mtx) {
332 : 99 : LOCK(wallet.cs_wallet);
333 : :
334 [ + - + + ]: 99 : if (wallet.IsWalletFlagSet(WALLET_FLAG_EXTERNAL_SIGNER)) {
335 : : // Make a blank psbt
336 [ + - ]: 1 : PartiallySignedTransaction psbtx(mtx);
337 : :
338 : : // First fill transaction with our data without signing,
339 : : // so external signers are not asked to sign more than once.
340 : 1 : bool complete;
341 [ + - ]: 1 : wallet.FillPSBT(psbtx, complete, std::nullopt, /*sign=*/false, /*bip32derivs=*/true);
342 [ + - ]: 1 : auto err{wallet.FillPSBT(psbtx, complete, std::nullopt, /*sign=*/true, /*bip32derivs=*/false)};
343 [ + - ]: 1 : if (err) return false;
344 [ + - ]: 1 : complete = FinalizeAndExtractPSBT(psbtx, mtx);
345 : 1 : return complete;
346 : 1 : } else {
347 [ + - ]: 98 : return wallet.SignTransaction(mtx);
348 : : }
349 : 99 : }
350 : :
351 : 99 : Result CommitTransaction(CWallet& wallet, const Txid& txid, CMutableTransaction&& mtx, std::vector<bilingual_str>& errors, Txid& bumped_txid)
352 : : {
353 : 99 : LOCK(wallet.cs_wallet);
354 [ + - ]: 99 : if (!errors.empty()) {
355 : : return Result::MISC_ERROR;
356 : : }
357 [ - + + - ]: 99 : auto it = txid.IsNull() ? wallet.mapWallet.end() : wallet.mapWallet.find(txid);
358 [ - + ]: 99 : if (it == wallet.mapWallet.end()) {
359 [ # # # # : 0 : errors.emplace_back(Untranslated("Invalid or non-wallet transaction id"));
# # ]
360 : 0 : return Result::MISC_ERROR;
361 : : }
362 [ + - ]: 99 : const CWalletTx& oldWtx = it->second;
363 : :
364 : : // make sure the transaction still has no descendants and hasn't been mined in the meantime
365 [ + - ]: 99 : Result result = PreconditionChecks(wallet, oldWtx, /* require_mine=*/ false, errors);
366 [ + - ]: 99 : if (result != Result::OK) {
367 : : return result;
368 : : }
369 : :
370 : : // commit/broadcast the tx
371 [ + - ]: 99 : CTransactionRef tx = MakeTransactionRef(std::move(mtx));
372 [ + - ]: 99 : mapValue_t mapValue = oldWtx.mapValue;
373 [ + - + - : 99 : mapValue["replaces_txid"] = oldWtx.GetHash().ToString();
+ - ]
374 : :
375 [ + - + - : 396 : wallet.CommitTransaction(tx, std::move(mapValue), oldWtx.vOrderForm);
+ - ]
376 : :
377 : : // mark the original tx as bumped
378 [ + - ]: 99 : bumped_txid = tx->GetHash();
379 [ + - - + ]: 99 : if (!wallet.MarkReplaced(oldWtx.GetHash(), bumped_txid)) {
380 [ # # # # : 0 : errors.emplace_back(Untranslated("Created new bumpfee transaction but could not mark the original transaction as replaced"));
# # ]
381 : : }
382 : 99 : return Result::OK;
383 [ + - ]: 297 : }
384 : :
385 : : } // namespace feebumper
386 : : } // namespace wallet
|
