Branch data Line data Source code
1 : : // Copyright (c) 2021-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 <algorithm>
6 : : #include <common/args.h>
7 : : #include <common/messages.h>
8 : : #include <common/system.h>
9 : : #include <consensus/amount.h>
10 : : #include <consensus/validation.h>
11 : : #include <interfaces/chain.h>
12 : : #include <node/types.h>
13 : : #include <numeric>
14 : : #include <policy/policy.h>
15 : : #include <primitives/transaction.h>
16 : : #include <script/script.h>
17 : : #include <script/signingprovider.h>
18 : : #include <script/solver.h>
19 : : #include <util/check.h>
20 : : #include <util/moneystr.h>
21 : : #include <util/rbf.h>
22 : : #include <util/trace.h>
23 : : #include <util/translation.h>
24 : : #include <wallet/coincontrol.h>
25 : : #include <wallet/fees.h>
26 : : #include <wallet/receive.h>
27 : : #include <wallet/spend.h>
28 : : #include <wallet/transaction.h>
29 : : #include <wallet/wallet.h>
30 : :
31 : : #include <cmath>
32 : :
33 : : using common::StringForFeeReason;
34 : : using common::TransactionErrorString;
35 : : using interfaces::FoundBlock;
36 : : using node::TransactionError;
37 : :
38 : : TRACEPOINT_SEMAPHORE(coin_selection, selected_coins);
39 : : TRACEPOINT_SEMAPHORE(coin_selection, normal_create_tx_internal);
40 : : TRACEPOINT_SEMAPHORE(coin_selection, attempting_aps_create_tx);
41 : : TRACEPOINT_SEMAPHORE(coin_selection, aps_create_tx_internal);
42 : :
43 : : namespace wallet {
44 : : static constexpr size_t OUTPUT_GROUP_MAX_ENTRIES{100};
45 : :
46 : : /** Whether the descriptor represents, directly or not, a witness program. */
47 : 212325 : static bool IsSegwit(const Descriptor& desc) {
48 [ + + ]: 212325 : if (const auto typ = desc.GetOutputType()) return *typ != OutputType::LEGACY;
49 : : return false;
50 : : }
51 : :
52 : : /** Whether to assume ECDSA signatures' will be high-r. */
53 : 200610 : static bool UseMaxSig(const std::optional<CTxIn>& txin, const CCoinControl* coin_control) {
54 : : // Use max sig if watch only inputs were used or if this particular input is an external input
55 : : // to ensure a sufficient fee is attained for the requested feerate.
56 [ + + + + : 200610 : return coin_control && (coin_control->fAllowWatchOnly || (txin && coin_control->IsExternalSelected(txin->prevout)));
+ + + + ]
57 : : }
58 : :
59 : : /** Get the size of an input (in witness units) once it's signed.
60 : : *
61 : : * @param desc The output script descriptor of the coin spent by this input.
62 : : * @param txin Optionally the txin to estimate the size of. Used to determine the size of ECDSA signatures.
63 : : * @param coin_control Information about the context to determine the size of ECDSA signatures.
64 : : * @param tx_is_segwit Whether the transaction has at least a single input spending a segwit coin.
65 : : * @param can_grind_r Whether the signer will be able to grind the R of the signature.
66 : : */
67 : 200624 : static std::optional<int64_t> MaxInputWeight(const Descriptor& desc, const std::optional<CTxIn>& txin,
68 : : const CCoinControl* coin_control, const bool tx_is_segwit,
69 : : const bool can_grind_r) {
70 [ + + + + : 201347 : if (const auto sat_weight = desc.MaxSatisfactionWeight(!can_grind_r || UseMaxSig(txin, coin_control))) {
+ + ]
71 [ + - ]: 200621 : if (const auto elems_count = desc.MaxSatisfactionElems()) {
72 : 200621 : const bool is_segwit = IsSegwit(desc);
73 : : // Account for the size of the scriptsig and the number of elements on the witness stack. Note
74 : : // that if any input in the transaction is spending a witness program, we need to specify the
75 : : // witness stack size for every input regardless of whether it is segwit itself.
76 : : // NOTE: this also works in case of mixed scriptsig-and-witness such as in p2sh-wrapped segwit v0
77 : : // outputs. In this case the size of the scriptsig length will always be one (since the redeemScript
78 : : // is always a push of the witness program in this case, which is smaller than 253 bytes).
79 [ + + + + ]: 200621 : const int64_t scriptsig_len = is_segwit ? 1 : GetSizeOfCompactSize(*sat_weight / WITNESS_SCALE_FACTOR);
80 [ - + + + ]: 200621 : const int64_t witstack_len = is_segwit ? GetSizeOfCompactSize(*elems_count) : (tx_is_segwit ? 1 : 0);
81 : : // previous txid + previous vout + sequence + scriptsig len + witstack size + scriptsig or witness
82 : : // NOTE: sat_weight already accounts for the witness discount accordingly.
83 : 200621 : return (32 + 4 + 4 + scriptsig_len) * WITNESS_SCALE_FACTOR + witstack_len + *sat_weight;
84 : : }
85 : : }
86 : :
87 : 3 : return {};
88 : : }
89 : :
90 : 295798 : int CalculateMaximumSignedInputSize(const CTxOut& txout, const COutPoint outpoint, const SigningProvider* provider, bool can_grind_r, const CCoinControl* coin_control)
91 : : {
92 [ + + ]: 295798 : if (!provider) return -1;
93 : :
94 [ + - ]: 185731 : if (const auto desc = InferDescriptor(txout.scriptPubKey, *provider)) {
95 [ + - + + ]: 371462 : if (const auto weight = MaxInputWeight(*desc, {}, coin_control, true, can_grind_r)) {
96 [ + - ]: 185728 : return static_cast<int>(GetVirtualTransactionSize(*weight, 0, 0));
97 : : }
98 : 185728 : }
99 : :
100 : 3 : return -1;
101 : : }
102 : :
103 : 122282 : int CalculateMaximumSignedInputSize(const CTxOut& txout, const CWallet* wallet, const CCoinControl* coin_control)
104 : : {
105 : 122282 : const std::unique_ptr<SigningProvider> provider = wallet->GetSolvingProvider(txout.scriptPubKey);
106 [ + - + - ]: 244564 : return CalculateMaximumSignedInputSize(txout, COutPoint(), provider.get(), wallet->CanGrindR(), coin_control);
107 : 122282 : }
108 : :
109 : : /** Infer a descriptor for the given output script. */
110 : 26597 : static std::unique_ptr<Descriptor> GetDescriptor(const CWallet* wallet, const CCoinControl* coin_control,
111 : : const CScript script_pubkey)
112 : : {
113 : 26597 : MultiSigningProvider providers;
114 [ + - + + ]: 53138 : for (const auto spkman: wallet->GetScriptPubKeyMans(script_pubkey)) {
115 [ + - + - ]: 26541 : providers.AddProvider(spkman->GetSolvingProvider(script_pubkey));
116 : 0 : }
117 [ + + ]: 26597 : if (coin_control) {
118 [ + - + - : 24001 : providers.AddProvider(std::make_unique<FlatSigningProvider>(coin_control->m_external_provider));
- + ]
119 : : }
120 [ + - ]: 26597 : return InferDescriptor(script_pubkey, providers);
121 : 26597 : }
122 : :
123 : : /** Infer the maximum size of this input after it will be signed. */
124 : 16396 : static std::optional<int64_t> GetSignedTxinWeight(const CWallet* wallet, const CCoinControl* coin_control,
125 : : const CTxIn& txin, const CTxOut& txo, const bool tx_is_segwit,
126 : : const bool can_grind_r)
127 : : {
128 : : // If weight was provided, use that.
129 : 16396 : std::optional<int64_t> weight;
130 [ + + + + ]: 16396 : if (coin_control && (weight = coin_control->GetInputWeight(txin.prevout))) {
131 : 1503 : return weight.value();
132 : : }
133 : :
134 : : // Otherwise, use the maximum satisfaction size provided by the descriptor.
135 [ + - ]: 14893 : std::unique_ptr<Descriptor> desc{GetDescriptor(wallet, coin_control, txo.scriptPubKey)};
136 [ + - + - : 29786 : if (desc) return MaxInputWeight(*desc, {txin}, coin_control, tx_is_segwit, can_grind_r);
+ - ]
137 : :
138 : 0 : return {};
139 : 14893 : }
140 : :
141 : : // txouts needs to be in the order of tx.vin
142 : 3438 : TxSize CalculateMaximumSignedTxSize(const CTransaction &tx, const CWallet *wallet, const std::vector<CTxOut>& txouts, const CCoinControl* coin_control)
143 : : {
144 : : // version + nLockTime + input count + output count
145 [ + + + + ]: 3442 : int64_t weight = (4 + 4 + GetSizeOfCompactSize(tx.vin.size()) + GetSizeOfCompactSize(tx.vout.size())) * WITNESS_SCALE_FACTOR;
146 : : // Whether any input spends a witness program. Necessary to run before the next loop over the
147 : : // inputs in order to accurately compute the compactSize length for the witness data per input.
148 : 3438 : bool is_segwit = std::any_of(txouts.begin(), txouts.end(), [&](const CTxOut& txo) {
149 [ + - ]: 11704 : std::unique_ptr<Descriptor> desc{GetDescriptor(wallet, coin_control, txo.scriptPubKey)};
150 [ + - + - ]: 11704 : if (desc) return IsSegwit(*desc);
151 : : return false;
152 : 11704 : });
153 : : // Segwit marker and flag
154 [ + + ]: 3438 : if (is_segwit) weight += 2;
155 : :
156 : : // Add the size of the transaction outputs.
157 [ + + ]: 46687 : for (const auto& txo : tx.vout) weight += GetSerializeSize(txo) * WITNESS_SCALE_FACTOR;
158 : :
159 : : // Add the size of the transaction inputs as if they were signed.
160 [ + + ]: 19834 : for (uint32_t i = 0; i < txouts.size(); i++) {
161 : 16396 : const auto txin_weight = GetSignedTxinWeight(wallet, coin_control, tx.vin[i], txouts[i], is_segwit, wallet->CanGrindR());
162 [ - + ]: 16396 : if (!txin_weight) return TxSize{-1, -1};
163 [ - + ]: 16396 : assert(*txin_weight > -1);
164 : 16396 : weight += *txin_weight;
165 : : }
166 : :
167 : : // It's ok to use 0 as the number of sigops since we never create any pathological transaction.
168 : 3438 : return TxSize{GetVirtualTransactionSize(weight, 0, 0), weight};
169 : : }
170 : :
171 : 3438 : TxSize CalculateMaximumSignedTxSize(const CTransaction &tx, const CWallet *wallet, const CCoinControl* coin_control)
172 : : {
173 : 3438 : std::vector<CTxOut> txouts;
174 : : // Look up the inputs. The inputs are either in the wallet, or in coin_control.
175 [ + + ]: 19834 : for (const CTxIn& input : tx.vin) {
176 [ + - ]: 16396 : const auto mi = wallet->mapWallet.find(input.prevout.hash);
177 : : // Can not estimate size without knowing the input details
178 [ + + ]: 16396 : if (mi != wallet->mapWallet.end()) {
179 [ - + ]: 16360 : assert(input.prevout.n < mi->second.tx->vout.size());
180 [ + - + - ]: 16360 : txouts.emplace_back(mi->second.tx->vout.at(input.prevout.n));
181 [ + - ]: 36 : } else if (coin_control) {
182 [ + - ]: 36 : const auto& txout{coin_control->GetExternalOutput(input.prevout)};
183 [ - + ]: 36 : if (!txout) return TxSize{-1, -1};
184 [ + - ]: 36 : txouts.emplace_back(*txout);
185 : 36 : } else {
186 : 0 : return TxSize{-1, -1};
187 : : }
188 : : }
189 [ + - ]: 3438 : return CalculateMaximumSignedTxSize(tx, wallet, txouts, coin_control);
190 : 3438 : }
191 : :
192 : 1486 : size_t CoinsResult::Size() const
193 : : {
194 : 1486 : size_t size{0};
195 [ + + ]: 3783 : for (const auto& it : coins) {
196 : 2297 : size += it.second.size();
197 : : }
198 : 1486 : return size;
199 : : }
200 : :
201 : 2658 : std::vector<COutput> CoinsResult::All() const
202 : : {
203 : 2658 : std::vector<COutput> all;
204 [ + - ]: 2658 : all.reserve(coins.size());
205 [ + + ]: 5415 : for (const auto& it : coins) {
206 [ + - ]: 2757 : all.insert(all.end(), it.second.begin(), it.second.end());
207 : : }
208 : 2658 : return all;
209 : 0 : }
210 : :
211 : 707 : void CoinsResult::Clear() {
212 : 707 : coins.clear();
213 : 707 : }
214 : :
215 : 4 : void CoinsResult::Erase(const std::unordered_set<COutPoint, SaltedOutpointHasher>& coins_to_remove)
216 : : {
217 [ + + ]: 8 : for (auto& [type, vec] : coins) {
218 : 4 : auto remove_it = std::remove_if(vec.begin(), vec.end(), [&](const COutput& coin) {
219 : : // remove it if it's on the set
220 [ + + ]: 17 : if (coins_to_remove.count(coin.outpoint) == 0) return false;
221 : :
222 : : // update cached amounts
223 : 5 : total_amount -= coin.txout.nValue;
224 [ + - ]: 5 : if (coin.HasEffectiveValue()) total_effective_amount = *total_effective_amount - coin.GetEffectiveValue();
225 : : return true;
226 : : });
227 : 4 : vec.erase(remove_it, vec.end());
228 : : }
229 : 4 : }
230 : :
231 : 20 : void CoinsResult::Shuffle(FastRandomContext& rng_fast)
232 : : {
233 [ + + ]: 56 : for (auto& it : coins) {
234 : 36 : std::shuffle(it.second.begin(), it.second.end(), rng_fast);
235 : : }
236 : 20 : }
237 : :
238 : 289812 : void CoinsResult::Add(OutputType type, const COutput& out)
239 : : {
240 : 289812 : coins[type].emplace_back(out);
241 : 289812 : total_amount += out.txout.nValue;
242 [ + + ]: 289812 : if (out.HasEffectiveValue()) {
243 [ + - ]: 510936 : total_effective_amount = total_effective_amount.has_value() ?
244 : 510936 : *total_effective_amount + out.GetEffectiveValue() : out.GetEffectiveValue();
245 : : }
246 : 289812 : }
247 : :
248 : 173497 : static OutputType GetOutputType(TxoutType type, bool is_from_p2sh)
249 : : {
250 [ + + + + ]: 173497 : switch (type) {
251 : : case TxoutType::WITNESS_V1_TAPROOT:
252 : : return OutputType::BECH32M;
253 : 123993 : case TxoutType::WITNESS_V0_KEYHASH:
254 : 123993 : case TxoutType::WITNESS_V0_SCRIPTHASH:
255 [ + + ]: 123993 : if (is_from_p2sh) return OutputType::P2SH_SEGWIT;
256 : 114910 : else return OutputType::BECH32;
257 : 46093 : case TxoutType::SCRIPTHASH:
258 : 46093 : case TxoutType::PUBKEYHASH:
259 : 46093 : return OutputType::LEGACY;
260 : 33 : default:
261 : 33 : return OutputType::UNKNOWN;
262 : : }
263 : : }
264 : :
265 : : // Fetch and validate the coin control selected inputs.
266 : : // Coins could be internal (from the wallet) or external.
267 : 451 : util::Result<PreSelectedInputs> FetchSelectedInputs(const CWallet& wallet, const CCoinControl& coin_control,
268 : : const CoinSelectionParams& coin_selection_params)
269 : : {
270 [ + - ]: 451 : PreSelectedInputs result;
271 [ + - ]: 451 : const bool can_grind_r = wallet.CanGrindR();
272 [ + - + - ]: 451 : std::map<COutPoint, CAmount> map_of_bump_fees = wallet.chain().calculateIndividualBumpFees(coin_control.ListSelected(), coin_selection_params.m_effective_feerate);
273 [ + - + + ]: 6077 : for (const COutPoint& outpoint : coin_control.ListSelected()) {
274 [ + - + + ]: 5629 : int64_t input_bytes = coin_control.GetInputWeight(outpoint).value_or(-1);
275 [ + - ]: 2503 : if (input_bytes != -1) {
276 [ + - ]: 2503 : input_bytes = GetVirtualTransactionSize(input_bytes, 0, 0);
277 : : }
278 : 5629 : CTxOut txout;
279 [ + - + + ]: 5629 : if (auto ptr_wtx = wallet.GetWalletTx(outpoint.hash)) {
280 : : // Clearly invalid input, fail
281 [ - + ]: 5589 : if (ptr_wtx->tx->vout.size() <= outpoint.n) {
282 [ # # # # ]: 0 : return util::Error{strprintf(_("Invalid pre-selected input %s"), outpoint.ToString())};
283 : : }
284 [ + - ]: 5589 : txout = ptr_wtx->tx->vout.at(outpoint.n);
285 [ + + ]: 5589 : if (input_bytes == -1) {
286 [ + - ]: 3111 : input_bytes = CalculateMaximumSignedInputSize(txout, &wallet, &coin_control);
287 : : }
288 : : } else {
289 : : // The input is external. We did not find the tx in mapWallet.
290 [ + - ]: 40 : const auto out{coin_control.GetExternalOutput(outpoint)};
291 [ - + ]: 40 : if (!out) {
292 [ # # # # ]: 0 : return util::Error{strprintf(_("Not found pre-selected input %s"), outpoint.ToString())};
293 : : }
294 : :
295 : 40 : txout = *out;
296 : 40 : }
297 : :
298 [ + + ]: 3151 : if (input_bytes == -1) {
299 [ + - ]: 19 : input_bytes = CalculateMaximumSignedInputSize(txout, outpoint, &coin_control.m_external_provider, can_grind_r, &coin_control);
300 : : }
301 : :
302 [ + + ]: 19 : if (input_bytes == -1) {
303 [ + - + - ]: 9 : return util::Error{strprintf(_("Not solvable pre-selected input %s"), outpoint.ToString())}; // Not solvable, can't estimate size for fee
304 : : }
305 : :
306 : : /* Set some defaults for depth, spendable, solvable, safe, time, and from_me as these don't matter for preset inputs since no selection is being done. */
307 [ + - ]: 5626 : COutput output(outpoint, txout, /*depth=*/ 0, input_bytes, /*spendable=*/ true, /*solvable=*/ true, /*safe=*/ true, /*time=*/ 0, /*from_me=*/ false, coin_selection_params.m_effective_feerate);
308 [ + - ]: 5626 : output.ApplyBumpFee(map_of_bump_fees.at(output.outpoint));
309 [ + - ]: 5626 : result.Insert(output, coin_selection_params.m_subtract_fee_outputs);
310 : 5629 : }
311 : 448 : return result;
312 : 451 : }
313 : :
314 : 3723 : CoinsResult AvailableCoins(const CWallet& wallet,
315 : : const CCoinControl* coinControl,
316 : : std::optional<CFeeRate> feerate,
317 : : const CoinFilterParams& params)
318 : : {
319 : 3723 : AssertLockHeld(wallet.cs_wallet);
320 : :
321 [ + - ]: 3723 : CoinsResult result;
322 : : // Either the WALLET_FLAG_AVOID_REUSE flag is not set (in which case we always allow), or we default to avoiding, and only in the case where
323 : : // a coin control object is provided, and has the avoid address reuse flag set to false, do we allow already used addresses
324 [ + - + + : 3723 : bool allow_used_addresses = !wallet.IsWalletFlagSet(WALLET_FLAG_AVOID_REUSE) || (coinControl && !coinControl->m_avoid_address_reuse);
+ - + + ]
325 [ + + ]: 3689 : const int min_depth = {coinControl ? coinControl->m_min_depth : DEFAULT_MIN_DEPTH};
326 : 7437 : const int max_depth = {coinControl ? coinControl->m_max_depth : DEFAULT_MAX_DEPTH};
327 [ + + ]: 3714 : const bool only_safe = {coinControl ? !coinControl->m_include_unsafe_inputs : true};
328 [ + - ]: 3723 : const bool can_grind_r = wallet.CanGrindR();
329 : 3723 : std::vector<COutPoint> outpoints;
330 : :
331 : 3723 : std::set<uint256> trusted_parents;
332 [ + + + - ]: 658909 : for (const auto& entry : wallet.mapWallet)
333 : : {
334 : 655186 : const uint256& txid = entry.first;
335 : 655186 : const CWalletTx& wtx = entry.second;
336 : :
337 [ + + + + : 655186 : if (wallet.IsTxImmatureCoinBase(wtx) && !params.include_immature_coinbase)
+ - ]
338 : 220743 : continue;
339 : :
340 [ + - ]: 434443 : int nDepth = wallet.GetTxDepthInMainChain(wtx);
341 [ + + ]: 434443 : if (nDepth < 0)
342 : 4151 : continue;
343 : :
344 : : // We should not consider coins which aren't at least in our mempool
345 : : // It's possible for these to be conflicted via ancestors which we may never be able to detect
346 [ + + + - : 430292 : if (nDepth == 0 && !wtx.InMempool())
+ + ]
347 : 4594 : continue;
348 : :
349 [ + - ]: 425698 : bool safeTx = CachedTxIsTrusted(wallet, wtx, trusted_parents);
350 : :
351 : : // We should not consider coins from transactions that are replacing
352 : : // other transactions.
353 : : //
354 : : // Example: There is a transaction A which is replaced by bumpfee
355 : : // transaction B. In this case, we want to prevent creation of
356 : : // a transaction B' which spends an output of B.
357 : : //
358 : : // Reason: If transaction A were initially confirmed, transactions B
359 : : // and B' would no longer be valid, so the user would have to create
360 : : // a new transaction C to replace B'. However, in the case of a
361 : : // one-block reorg, transactions B' and C might BOTH be accepted,
362 : : // when the user only wanted one of them. Specifically, there could
363 : : // be a 1-block reorg away from the chain where transactions A and C
364 : : // were accepted to another chain where B, B', and C were all
365 : : // accepted.
366 [ + + + - : 496023 : if (nDepth == 0 && wtx.mapValue.count("replaces_txid")) {
+ + + + ]
367 : 148 : safeTx = false;
368 : : }
369 : :
370 : : // Similarly, we should not consider coins from transactions that
371 : : // have been replaced. In the example above, we would want to prevent
372 : : // creation of a transaction A' spending an output of A, because if
373 : : // transaction B were initially confirmed, conflicting with A and
374 : : // A', we wouldn't want to the user to create a transaction D
375 : : // intending to replace A', but potentially resulting in a scenario
376 : : // where A, A', and D could all be accepted (instead of just B and
377 : : // D, or just A and A' like the user would want).
378 [ + + + - : 496023 : if (nDepth == 0 && wtx.mapValue.count("replaced_by_txid")) {
+ + + + ]
379 : 1 : safeTx = false;
380 : : }
381 : :
382 [ + + ]: 425698 : if (only_safe && !safeTx) {
383 : 1975 : continue;
384 : : }
385 : :
386 [ + + ]: 423723 : if (nDepth < min_depth || nDepth > max_depth) {
387 : 3947 : continue;
388 : : }
389 : :
390 [ + - ]: 419776 : bool tx_from_me = CachedTxIsFromMe(wallet, wtx, ISMINE_ALL);
391 : :
392 [ + + ]: 1563453 : for (unsigned int i = 0; i < wtx.tx->vout.size(); i++) {
393 [ + + ]: 1143677 : const CTxOut& output = wtx.tx->vout[i];
394 [ + + ]: 1143677 : const COutPoint outpoint(Txid::FromUint256(txid), i);
395 : :
396 [ + + - + ]: 1143677 : if (output.nValue < params.min_amount || output.nValue > params.max_amount)
397 : 153686 : continue;
398 : :
399 : : // Skip manually selected coins (the caller can fetch them directly)
400 [ + + + - : 989991 : if (coinControl && coinControl->HasSelected() && coinControl->IsSelected(outpoint))
+ + + - +
+ ]
401 : 4010 : continue;
402 : :
403 [ + - + + : 985981 : if (wallet.IsLockedCoin(outpoint) && params.skip_locked)
+ + ]
404 : 372 : continue;
405 : :
406 [ + - + + ]: 985609 : if (wallet.IsSpent(outpoint))
407 : 462698 : continue;
408 : :
409 [ + - ]: 522911 : isminetype mine = wallet.IsMine(output);
410 : :
411 [ + + ]: 522911 : if (mine == ISMINE_NO) {
412 : 349414 : continue;
413 : : }
414 : :
415 [ + + + - : 173497 : if (!allow_used_addresses && wallet.IsSpentKey(output.scriptPubKey)) {
+ - ]
416 : 0 : continue;
417 : : }
418 : :
419 [ + - ]: 173497 : std::unique_ptr<SigningProvider> provider = wallet.GetSolvingProvider(output.scriptPubKey);
420 : :
421 [ + - ]: 173497 : int input_bytes = CalculateMaximumSignedInputSize(output, COutPoint(), provider.get(), can_grind_r, coinControl);
422 : : // Because CalculateMaximumSignedInputSize infers a solvable descriptor to get the satisfaction size,
423 : : // it is safe to assume that this input is solvable if input_bytes is greater than -1.
424 : 173497 : bool solvable = input_bytes > -1;
425 [ - + - - : 173497 : bool spendable = ((mine & ISMINE_SPENDABLE) != ISMINE_NO) || (((mine & ISMINE_WATCH_ONLY) != ISMINE_NO) && (coinControl && coinControl->fAllowWatchOnly && solvable));
- - - - -
- ]
426 : :
427 : : // Filter by spendable outputs only
428 [ # # ]: 0 : if (!spendable && params.only_spendable) continue;
429 : :
430 : : // Obtain script type
431 : 173497 : std::vector<std::vector<uint8_t>> script_solutions;
432 [ + - ]: 173497 : TxoutType type = Solver(output.scriptPubKey, script_solutions);
433 : :
434 : : // If the output is P2SH and solvable, we want to know if it is
435 : : // a P2SH (legacy) or one of P2SH-P2WPKH, P2SH-P2WSH (P2SH-Segwit). We can determine
436 : : // this from the redeemScript. If the output is not solvable, it will be classified
437 : : // as a P2SH (legacy), since we have no way of knowing otherwise without the redeemScript
438 : 173497 : bool is_from_p2sh{false};
439 [ + + ]: 173497 : if (type == TxoutType::SCRIPTHASH && solvable) {
440 : 9100 : CScript script;
441 [ + - - + ]: 9100 : if (!provider->GetCScript(CScriptID(uint160(script_solutions[0])), script)) continue;
442 [ + - ]: 9100 : type = Solver(script, script_solutions);
443 : 9100 : is_from_p2sh = true;
444 : 9100 : }
445 : :
446 [ + - ]: 173497 : result.Add(GetOutputType(type, is_from_p2sh),
447 [ + - + - ]: 173497 : COutput(outpoint, output, nDepth, input_bytes, spendable, solvable, safeTx, wtx.GetTxTime(), tx_from_me, feerate));
448 : :
449 [ + - ]: 173497 : outpoints.push_back(outpoint);
450 : :
451 : : // Checks the sum amount of all UTXO's.
452 [ - + ]: 173497 : if (params.min_sum_amount != MAX_MONEY) {
453 [ # # ]: 0 : if (result.GetTotalAmount() >= params.min_sum_amount) {
454 : : return result;
455 : : }
456 : : }
457 : :
458 : : // Checks the maximum number of UTXO's.
459 [ - + - - : 173497 : if (params.max_count > 0 && result.Size() >= params.max_count) {
- - ]
460 : : return result;
461 : : }
462 : 173497 : }
463 : : }
464 : :
465 [ + + ]: 3723 : if (feerate.has_value()) {
466 [ + - ]: 3348 : std::map<COutPoint, CAmount> map_of_bump_fees = wallet.chain().calculateIndividualBumpFees(outpoints, feerate.value());
467 : :
468 [ + + ]: 8486 : for (auto& [_, outputs] : result.coins) {
469 [ + + ]: 144291 : for (auto& output : outputs) {
470 [ + - ]: 139153 : output.ApplyBumpFee(map_of_bump_fees.at(output.outpoint));
471 : : }
472 : : }
473 : 3348 : }
474 : :
475 : : return result;
476 : 3723 : }
477 : :
478 : 365 : CoinsResult AvailableCoinsListUnspent(const CWallet& wallet, const CCoinControl* coinControl, CoinFilterParams params)
479 : : {
480 : 365 : params.only_spendable = false;
481 : 365 : return AvailableCoins(wallet, coinControl, /*feerate=*/ std::nullopt, params);
482 : : }
483 : :
484 : 5 : const CTxOut& FindNonChangeParentOutput(const CWallet& wallet, const COutPoint& outpoint)
485 : : {
486 : 5 : AssertLockHeld(wallet.cs_wallet);
487 : 5 : const CWalletTx* wtx{Assert(wallet.GetWalletTx(outpoint.hash))};
488 : :
489 : 5 : const CTransaction* ptx = wtx->tx.get();
490 : 5 : int n = outpoint.n;
491 [ + - + - ]: 7 : while (OutputIsChange(wallet, ptx->vout[n]) && ptx->vin.size() > 0) {
492 : 7 : const COutPoint& prevout = ptx->vin[0].prevout;
493 : 7 : const CWalletTx* it = wallet.GetWalletTx(prevout.hash);
494 [ + - + - : 9 : if (!it || it->tx->vout.size() <= prevout.n ||
+ + ]
495 : 2 : !wallet.IsMine(it->tx->vout[prevout.n])) {
496 : : break;
497 : : }
498 : 2 : ptx = it->tx.get();
499 : 2 : n = prevout.n;
500 : : }
501 : 5 : return ptx->vout[n];
502 : : }
503 : :
504 : 3 : std::map<CTxDestination, std::vector<COutput>> ListCoins(const CWallet& wallet)
505 : : {
506 : 3 : AssertLockHeld(wallet.cs_wallet);
507 : :
508 [ + - ]: 3 : std::map<CTxDestination, std::vector<COutput>> result;
509 : :
510 [ + - ]: 3 : CCoinControl coin_control;
511 : 3 : CoinFilterParams coins_params;
512 : 3 : coins_params.only_spendable = false;
513 : 3 : coins_params.skip_locked = false;
514 [ + - + - : 8 : for (const COutput& coin : AvailableCoins(wallet, &coin_control, /*feerate=*/std::nullopt, coins_params).All()) {
+ + ]
515 : 5 : CTxDestination address;
516 [ - + - - : 5 : if ((coin.spendable || (wallet.IsWalletFlagSet(WALLET_FLAG_DISABLE_PRIVATE_KEYS) && coin.solvable))) {
- - - - ]
517 [ + - + - : 5 : if (!ExtractDestination(FindNonChangeParentOutput(wallet, coin.outpoint).scriptPubKey, address)) {
+ - ]
518 : : // For backwards compatibility, we convert P2PK output scripts into PKHash destinations
519 [ - + ]: 5 : if (auto pk_dest = std::get_if<PubKeyDestination>(&address)) {
520 [ + - ]: 5 : address = PKHash(pk_dest->GetPubKey());
521 : : } else {
522 : 0 : continue;
523 : : }
524 : : }
525 [ + - + - ]: 5 : result[address].emplace_back(coin);
526 : : }
527 : 8 : }
528 : 3 : return result;
529 : 3 : }
530 : :
531 : 6509 : FilteredOutputGroups GroupOutputs(const CWallet& wallet,
532 : : const CoinsResult& coins,
533 : : const CoinSelectionParams& coin_sel_params,
534 : : const std::vector<SelectionFilter>& filters,
535 : : std::vector<OutputGroup>& ret_discarded_groups)
536 : : {
537 [ + + ]: 6509 : FilteredOutputGroups filtered_groups;
538 : :
539 [ + + ]: 6509 : if (!coin_sel_params.m_avoid_partial_spends) {
540 : : // Allowing partial spends means no grouping. Each COutput gets its own OutputGroup
541 [ + + ]: 10761 : for (const auto& [type, outputs] : coins.coins) {
542 [ + + ]: 522641 : for (const COutput& output : outputs) {
543 : : // Get mempool info
544 : 516899 : size_t ancestors, descendants;
545 [ + - ]: 516899 : wallet.chain().getTransactionAncestry(output.outpoint.hash, ancestors, descendants);
546 : :
547 : : // Create a new group per output and add it to the all groups vector
548 [ + - ]: 516899 : OutputGroup group(coin_sel_params);
549 [ + - + - ]: 516899 : group.Insert(std::make_shared<COutput>(output), ancestors, descendants);
550 : :
551 : : // Each filter maps to a different set of groups
552 : 516899 : bool accepted = false;
553 [ + + ]: 1839844 : for (const auto& sel_filter : filters) {
554 : 1322945 : const auto& filter = sel_filter.filter;
555 [ + - + + ]: 1322945 : if (!group.EligibleForSpending(filter)) continue;
556 [ + - + - ]: 1265987 : filtered_groups[filter].Push(group, type, /*insert_positive=*/true, /*insert_mixed=*/true);
557 : : accepted = true;
558 : : }
559 [ + + + - ]: 516899 : if (!accepted) ret_discarded_groups.emplace_back(group);
560 : 516899 : }
561 : : }
562 : : return filtered_groups;
563 : : }
564 : :
565 : : // We want to combine COutputs that have the same scriptPubKey into single OutputGroups
566 : : // except when there are more than OUTPUT_GROUP_MAX_ENTRIES COutputs grouped in an OutputGroup.
567 : : // To do this, we maintain a map where the key is the scriptPubKey and the value is a vector of OutputGroups.
568 : : // For each COutput, we check if the scriptPubKey is in the map, and if it is, the COutput is added
569 : : // to the last OutputGroup in the vector for the scriptPubKey. When the last OutputGroup has
570 : : // OUTPUT_GROUP_MAX_ENTRIES COutputs, a new OutputGroup is added to the end of the vector.
571 : 1490 : typedef std::map<std::pair<CScript, OutputType>, std::vector<OutputGroup>> ScriptPubKeyToOutgroup;
572 : 121742 : const auto& insert_output = [&](
573 : : const std::shared_ptr<COutput>& output, OutputType type, size_t ancestors, size_t descendants,
574 : : ScriptPubKeyToOutgroup& groups_map) {
575 [ + - ]: 120252 : std::vector<OutputGroup>& groups = groups_map[std::make_pair(output->txout.scriptPubKey,type)];
576 : :
577 [ + + ]: 120252 : if (groups.size() == 0) {
578 : : // No OutputGroups for this scriptPubKey yet, add one
579 : 75738 : groups.emplace_back(coin_sel_params);
580 : : }
581 : :
582 : : // Get the last OutputGroup in the vector so that we can add the COutput to it
583 : : // A pointer is used here so that group can be reassigned later if it is full.
584 : 120252 : OutputGroup* group = &groups.back();
585 : :
586 : : // Check if this OutputGroup is full. We limit to OUTPUT_GROUP_MAX_ENTRIES when using -avoidpartialspends
587 : : // to avoid surprising users with very high fees.
588 [ + + ]: 120252 : if (group->m_outputs.size() >= OUTPUT_GROUP_MAX_ENTRIES) {
589 : : // The last output group is full, add a new group to the vector and use that group for the insertion
590 : 228 : groups.emplace_back(coin_sel_params);
591 : 228 : group = &groups.back();
592 : : }
593 : :
594 : 120252 : group->Insert(output, ancestors, descendants);
595 : 120252 : };
596 : :
597 : 1490 : ScriptPubKeyToOutgroup spk_to_groups_map;
598 : 1490 : ScriptPubKeyToOutgroup spk_to_positive_groups_map;
599 [ + + ]: 3791 : for (const auto& [type, outs] : coins.coins) {
600 [ + + ]: 62436 : for (const COutput& output : outs) {
601 : 60135 : size_t ancestors, descendants;
602 [ + - ]: 60135 : wallet.chain().getTransactionAncestry(output.outpoint.hash, ancestors, descendants);
603 : :
604 [ + - ]: 60135 : const auto& shared_output = std::make_shared<COutput>(output);
605 : : // Filter for positive only before adding the output
606 [ + + ]: 60135 : if (output.GetEffectiveValue() > 0) {
607 [ + - ]: 60117 : insert_output(shared_output, type, ancestors, descendants, spk_to_positive_groups_map);
608 : : }
609 : :
610 : : // 'All' groups
611 [ + - ]: 60135 : insert_output(shared_output, type, ancestors, descendants, spk_to_groups_map);
612 : 60135 : }
613 : : }
614 : :
615 : : // Now we go through the entire maps and pull out the OutputGroups
616 : 4470 : const auto& push_output_groups = [&](const ScriptPubKeyToOutgroup& groups_map, bool positive_only) {
617 [ + + ]: 78718 : for (const auto& [script, groups] : groups_map) {
618 : : // Go through the vector backwards. This allows for the first item we deal with being the partial group.
619 [ + + ]: 151704 : for (auto group_it = groups.rbegin(); group_it != groups.rend(); group_it++) {
620 : 75966 : const OutputGroup& group = *group_it;
621 : :
622 : : // Each filter maps to a different set of groups
623 : 75966 : bool accepted = false;
624 [ + + ]: 531602 : for (const auto& sel_filter : filters) {
625 : 455636 : const auto& filter = sel_filter.filter;
626 [ + + ]: 455636 : if (!group.EligibleForSpending(filter)) continue;
627 : :
628 : : // Don't include partial groups if there are full groups too and we don't want partial groups
629 [ + + + + : 350954 : if (group_it == groups.rbegin() && groups.size() > 1 && !filter.m_include_partial_groups) {
+ + ]
630 : 124 : continue;
631 : : }
632 : :
633 : 350830 : OutputType type = script.second;
634 : : // Either insert the group into the positive-only groups or the mixed ones.
635 : 350830 : filtered_groups[filter].Push(group, type, positive_only, /*insert_mixed=*/!positive_only);
636 : 350830 : accepted = true;
637 : : }
638 [ + + ]: 75966 : if (!accepted) ret_discarded_groups.emplace_back(group);
639 : : }
640 : : }
641 : 4470 : };
642 : :
643 [ + - ]: 1490 : push_output_groups(spk_to_groups_map, /*positive_only=*/ false);
644 [ + - ]: 1490 : push_output_groups(spk_to_positive_groups_map, /*positive_only=*/ true);
645 : :
646 : 1490 : return filtered_groups;
647 : 1490 : }
648 : :
649 : 3427 : FilteredOutputGroups GroupOutputs(const CWallet& wallet,
650 : : const CoinsResult& coins,
651 : : const CoinSelectionParams& params,
652 : : const std::vector<SelectionFilter>& filters)
653 : : {
654 : 3427 : std::vector<OutputGroup> unused;
655 [ + - ]: 6854 : return GroupOutputs(wallet, coins, params, filters, unused);
656 : 3427 : }
657 : :
658 : : // Returns true if the result contains an error and the message is not empty
659 : 11246 : static bool HasErrorMsg(const util::Result<SelectionResult>& res) { return !util::ErrorString(res).empty(); }
660 : :
661 : 3507 : util::Result<SelectionResult> AttemptSelection(interfaces::Chain& chain, const CAmount& nTargetValue, OutputGroupTypeMap& groups,
662 : : const CoinSelectionParams& coin_selection_params, bool allow_mixed_output_types)
663 : : {
664 : : // Run coin selection on each OutputType and compute the Waste Metric
665 : 3507 : std::vector<SelectionResult> results;
666 [ + - + + ]: 8416 : for (auto& [type, group] : groups.groups_by_type) {
667 [ + - ]: 4961 : auto result{ChooseSelectionResult(chain, nTargetValue, group, coin_selection_params)};
668 : : // If any specific error message appears here, then something particularly wrong happened.
669 [ + - + + ]: 4961 : if (HasErrorMsg(result)) return result; // So let's return the specific error.
670 : : // Append the favorable result.
671 [ + + + - ]: 4909 : if (result) results.push_back(*result);
672 : 4909 : }
673 : : // If we have at least one solution for funding the transaction without mixing, choose the minimum one according to waste metric
674 : : // and return the result
675 [ + + + - : 6464 : if (results.size() > 0) return *std::min_element(results.begin(), results.end());
+ - ]
676 : :
677 : : // If we can't fund the transaction from any individual OutputType, run coin selection one last time
678 : : // over all available coins, which would allow mixing.
679 : : // If TypesCount() <= 1, there is nothing to mix.
680 [ + + + + ]: 446 : if (allow_mixed_output_types && groups.TypesCount() > 1) {
681 [ + - ]: 64 : return ChooseSelectionResult(chain, nTargetValue, groups.all_groups, coin_selection_params);
682 : : }
683 : : // Either mixing is not allowed and we couldn't find a solution from any single OutputType, or mixing was allowed and we still couldn't
684 : : // find a solution using all available coins
685 : 764 : return util::Error();
686 : 3507 : };
687 : :
688 : 5025 : util::Result<SelectionResult> ChooseSelectionResult(interfaces::Chain& chain, const CAmount& nTargetValue, Groups& groups, const CoinSelectionParams& coin_selection_params)
689 : : {
690 : : // Vector of results. We will choose the best one based on waste.
691 : 5025 : std::vector<SelectionResult> results;
692 : 5025 : std::vector<util::Result<SelectionResult>> errors;
693 : 10874 : auto append_error = [&] (util::Result<SelectionResult>&& result) {
694 : : // If any specific error message appears here, then something different from a simple "no selection found" happened.
695 : : // Let's save it, so it can be retrieved to the user if no other selection algorithm succeeded.
696 [ + + ]: 5849 : if (HasErrorMsg(result)) {
697 : 91 : errors.emplace_back(std::move(result));
698 : : }
699 : 10874 : };
700 : :
701 : : // Maximum allowed weight for selected coins.
702 [ + + ]: 5025 : int max_transaction_weight = coin_selection_params.m_max_tx_weight.value_or(MAX_STANDARD_TX_WEIGHT);
703 : 5025 : int tx_weight_no_input = coin_selection_params.tx_noinputs_size * WITNESS_SCALE_FACTOR;
704 : 5025 : int max_selection_weight = max_transaction_weight - tx_weight_no_input;
705 [ + + ]: 5025 : if (max_selection_weight <= 0) {
706 [ + - ]: 36 : return util::Error{_("Maximum transaction weight is less than transaction weight without inputs")};
707 : : }
708 : :
709 : : // SFFO frequently causes issues in the context of changeless input sets: skip BnB when SFFO is active
710 [ + + ]: 5013 : if (!coin_selection_params.m_subtract_fee_outputs) {
711 [ + - + + ]: 3587 : if (auto bnb_result{SelectCoinsBnB(groups.positive_group, nTargetValue, coin_selection_params.m_cost_of_change, max_selection_weight)}) {
712 [ + - ]: 114 : results.push_back(*bnb_result);
713 [ + - ]: 7060 : } else append_error(std::move(bnb_result));
714 : : }
715 : :
716 : : // Deduct change weight because remaining Coin Selection algorithms can create change output
717 : 5013 : int change_outputs_weight = coin_selection_params.change_output_size * WITNESS_SCALE_FACTOR;
718 : 5013 : max_selection_weight -= change_outputs_weight;
719 [ + + + - ]: 5013 : if (max_selection_weight < 0 && results.empty()) {
720 [ + - ]: 18 : return util::Error{_("Maximum transaction weight is too low, can not accommodate change output")};
721 : : }
722 : :
723 : : // The knapsack solver has some legacy behavior where it will spend dust outputs. We retain this behavior, so don't filter for positive only here.
724 [ + - + + ]: 5007 : if (auto knapsack_result{KnapsackSolver(groups.mixed_group, nTargetValue, coin_selection_params.m_min_change_target, coin_selection_params.rng_fast, max_selection_weight)}) {
725 [ + - ]: 4018 : results.push_back(*knapsack_result);
726 [ + - ]: 989 : } else append_error(std::move(knapsack_result));
727 : :
728 [ + + ]: 5007 : if (coin_selection_params.m_effective_feerate > CFeeRate{3 * coin_selection_params.m_long_term_feerate}) { // Minimize input set for feerates of at least 3×LTFRE (default: 30 ṩ/vB+)
729 [ + - + + ]: 818 : if (auto cg_result{CoinGrinder(groups.positive_group, nTargetValue, coin_selection_params.m_min_change_target, max_selection_weight)}) {
730 [ + - ]: 470 : cg_result->RecalculateWaste(coin_selection_params.min_viable_change, coin_selection_params.m_cost_of_change, coin_selection_params.m_change_fee);
731 [ + - ]: 470 : results.push_back(*cg_result);
732 : : } else {
733 [ + - ]: 348 : append_error(std::move(cg_result));
734 : 818 : }
735 : : }
736 : :
737 [ + - + + ]: 5007 : if (auto srd_result{SelectCoinsSRD(groups.positive_group, nTargetValue, coin_selection_params.m_change_fee, coin_selection_params.rng_fast, max_selection_weight)}) {
738 [ + - ]: 3968 : results.push_back(*srd_result);
739 [ + - ]: 1039 : } else append_error(std::move(srd_result));
740 : :
741 [ + + ]: 5007 : if (results.empty()) {
742 : : // No solution found, retrieve the first explicit error (if any).
743 : : // future: add 'severity level' to errors so the worst one can be retrieved instead of the first one.
744 [ + + ]: 1944 : return errors.empty() ? util::Error() : std::move(errors.front());
745 : : }
746 : :
747 : : // If the chosen input set has unconfirmed inputs, check for synergies from overlapping ancestry
748 [ + + ]: 12588 : for (auto& result : results) {
749 : 8570 : std::vector<COutPoint> outpoints;
750 [ + - + - ]: 8570 : std::set<std::shared_ptr<COutput>> coins = result.GetInputSet();
751 : 8570 : CAmount summed_bump_fees = 0;
752 [ + + ]: 153605 : for (auto& coin : coins) {
753 [ + + ]: 145035 : if (coin->depth > 0) continue; // Bump fees only exist for unconfirmed inputs
754 [ + - ]: 1725 : outpoints.push_back(coin->outpoint);
755 : 1725 : summed_bump_fees += coin->ancestor_bump_fees;
756 : : }
757 [ + - ]: 8570 : std::optional<CAmount> combined_bump_fee = chain.calculateCombinedBumpFee(outpoints, coin_selection_params.m_effective_feerate);
758 [ - + ]: 8570 : if (!combined_bump_fee.has_value()) {
759 [ # # ]: 0 : return util::Error{_("Failed to calculate bump fees, because unconfirmed UTXOs depend on enormous cluster of unconfirmed transactions.")};
760 : : }
761 [ + + ]: 8570 : CAmount bump_fee_overestimate = summed_bump_fees - combined_bump_fee.value();
762 [ + + ]: 8570 : if (bump_fee_overestimate) {
763 [ + - ]: 16 : result.SetBumpFeeDiscount(bump_fee_overestimate);
764 : : }
765 [ + - ]: 8570 : result.RecalculateWaste(coin_selection_params.min_viable_change, coin_selection_params.m_cost_of_change, coin_selection_params.m_change_fee);
766 : 8570 : }
767 : :
768 : : // Choose the result with the least waste
769 : : // If the waste is the same, choose the one which spends more inputs.
770 [ + - + - ]: 8036 : return *std::min_element(results.begin(), results.end());
771 : 5025 : }
772 : :
773 : 3461 : util::Result<SelectionResult> SelectCoins(const CWallet& wallet, CoinsResult& available_coins, const PreSelectedInputs& pre_set_inputs,
774 : : const CAmount& nTargetValue, const CCoinControl& coin_control,
775 : : const CoinSelectionParams& coin_selection_params)
776 : : {
777 : : // Deduct preset inputs amount from the search target
778 : 3461 : CAmount selection_target = nTargetValue - pre_set_inputs.total_amount;
779 : :
780 : : // Return if automatic coin selection is disabled, and we don't cover the selection target
781 [ + + + + ]: 3461 : if (!coin_control.m_allow_other_inputs && selection_target > 0) {
782 : 24 : return util::Error{_("The preselected coins total amount does not cover the transaction target. "
783 : 12 : "Please allow other inputs to be automatically selected or include more coins manually")};
784 : : }
785 : :
786 : : // Return if we can cover the target only with the preset inputs
787 [ + + ]: 3449 : if (selection_target <= 0) {
788 [ + - ]: 353 : SelectionResult result(nTargetValue, SelectionAlgorithm::MANUAL);
789 [ + - ]: 353 : result.AddInputs(pre_set_inputs.coins, coin_selection_params.m_subtract_fee_outputs);
790 [ + - ]: 353 : result.RecalculateWaste(coin_selection_params.min_viable_change, coin_selection_params.m_cost_of_change, coin_selection_params.m_change_fee);
791 : 353 : return result;
792 : 353 : }
793 : :
794 : : // Return early if we cannot cover the target with the wallet's UTXO.
795 : : // We use the total effective value if we are not subtracting fee from outputs and 'available_coins' contains the data.
796 [ + + ]: 3096 : CAmount available_coins_total_amount = coin_selection_params.m_subtract_fee_outputs ? available_coins.GetTotalAmount() :
797 [ + - ]: 2476 : (available_coins.GetEffectiveTotalAmount().has_value() ? *available_coins.GetEffectiveTotalAmount() : 0);
798 [ + + ]: 3096 : if (selection_target > available_coins_total_amount) {
799 : 28 : return util::Error(); // Insufficient funds
800 : : }
801 : :
802 : : // Start wallet Coin Selection procedure
803 : 3082 : auto op_selection_result = AutomaticCoinSelection(wallet, available_coins, selection_target, coin_selection_params);
804 [ + + ]: 3082 : if (!op_selection_result) return op_selection_result;
805 : :
806 : : // If needed, add preset inputs to the automatic coin selection result
807 [ + + ]: 3071 : if (!pre_set_inputs.coins.empty()) {
808 [ + - ]: 80 : SelectionResult preselected(pre_set_inputs.total_amount, SelectionAlgorithm::MANUAL);
809 [ + - ]: 80 : preselected.AddInputs(pre_set_inputs.coins, coin_selection_params.m_subtract_fee_outputs);
810 [ + - ]: 80 : op_selection_result->Merge(preselected);
811 : 80 : op_selection_result->RecalculateWaste(coin_selection_params.min_viable_change,
812 : 80 : coin_selection_params.m_cost_of_change,
813 [ + - ]: 80 : coin_selection_params.m_change_fee);
814 : :
815 : : // Verify we haven't exceeded the maximum allowed weight
816 [ + + ]: 80 : int max_inputs_weight = coin_selection_params.m_max_tx_weight.value_or(MAX_STANDARD_TX_WEIGHT) - (coin_selection_params.tx_noinputs_size * WITNESS_SCALE_FACTOR);
817 [ + + ]: 80 : if (op_selection_result->GetWeight() > max_inputs_weight) {
818 [ + - ]: 4 : return util::Error{_("The combination of the pre-selected inputs and the wallet automatic inputs selection exceeds the transaction maximum weight. "
819 : 2 : "Please try sending a smaller amount or manually consolidating your wallet's UTXOs")};
820 : : }
821 : 80 : }
822 : 3069 : return op_selection_result;
823 : 3082 : }
824 : :
825 : 3082 : util::Result<SelectionResult> AutomaticCoinSelection(const CWallet& wallet, CoinsResult& available_coins, const CAmount& value_to_select, const CoinSelectionParams& coin_selection_params)
826 : : {
827 : 3082 : unsigned int limit_ancestor_count = 0;
828 : 3082 : unsigned int limit_descendant_count = 0;
829 : 3082 : wallet.chain().getPackageLimits(limit_ancestor_count, limit_descendant_count);
830 [ - + ]: 3082 : const size_t max_ancestors = (size_t)std::max<int64_t>(1, limit_ancestor_count);
831 [ - + ]: 3082 : const size_t max_descendants = (size_t)std::max<int64_t>(1, limit_descendant_count);
832 [ + - ]: 3082 : const bool fRejectLongChains = gArgs.GetBoolArg("-walletrejectlongchains", DEFAULT_WALLET_REJECT_LONG_CHAINS);
833 : :
834 : : // Cases where we have 101+ outputs all pointing to the same destination may result in
835 : : // privacy leaks as they will potentially be deterministically sorted. We solve that by
836 : : // explicitly shuffling the outputs before processing
837 [ + + + + ]: 3082 : if (coin_selection_params.m_avoid_partial_spends && available_coins.Size() > OUTPUT_GROUP_MAX_ENTRIES) {
838 : 20 : available_coins.Shuffle(coin_selection_params.rng_fast);
839 : : }
840 : :
841 : : // Coin Selection attempts to select inputs from a pool of eligible UTXOs to fund the
842 : : // transaction at a target feerate. If an attempt fails, more attempts may be made using a more
843 : : // permissive CoinEligibilityFilter.
844 : 3082 : {
845 : : // Place coins eligibility filters on a scope increasing order.
846 : 3082 : std::vector<SelectionFilter> ordered_filters{
847 : : // If possible, fund the transaction with confirmed UTXOs only. Prefer at least six
848 : : // confirmations on outputs received from other wallets and only spend confirmed change.
849 : : {CoinEligibilityFilter(1, 6, 0), /*allow_mixed_output_types=*/false},
850 : : {CoinEligibilityFilter(1, 1, 0)},
851 : 3082 : };
852 : : // Fall back to using zero confirmation change (but with as few ancestors in the mempool as
853 : : // possible) if we cannot fund the transaction otherwise.
854 [ + + ]: 3082 : if (wallet.m_spend_zero_conf_change) {
855 [ + - ]: 3080 : ordered_filters.push_back({CoinEligibilityFilter(0, 1, 2)});
856 [ + + + + : 9198 : ordered_filters.push_back({CoinEligibilityFilter(0, 1, std::min(size_t{4}, max_ancestors/3), std::min(size_t{4}, max_descendants/3))});
+ - ]
857 [ + - ]: 3080 : ordered_filters.push_back({CoinEligibilityFilter(0, 1, max_ancestors/2, max_descendants/2)});
858 : : // If partial groups are allowed, relax the requirement of spending OutputGroups (groups
859 : : // of UTXOs sent to the same address, which are obviously controlled by a single wallet)
860 : : // in their entirety.
861 [ + - ]: 3080 : ordered_filters.push_back({CoinEligibilityFilter(0, 1, max_ancestors-1, max_descendants-1, /*include_partial=*/true)});
862 : : // Try with unsafe inputs if they are allowed. This may spend unconfirmed outputs
863 : : // received from other wallets.
864 [ + + ]: 3080 : if (coin_selection_params.m_include_unsafe_inputs) {
865 [ + - ]: 7 : ordered_filters.push_back({CoinEligibilityFilter(/*conf_mine=*/0, /*conf_theirs*/0, max_ancestors-1, max_descendants-1, /*include_partial=*/true)});
866 : : }
867 : : // Try with unlimited ancestors/descendants. The transaction will still need to meet
868 : : // mempool ancestor/descendant policy to be accepted to mempool and broadcasted, but
869 : : // OutputGroups use heuristics that may overestimate ancestor/descendant counts.
870 [ + + ]: 3080 : if (!fRejectLongChains) {
871 [ + - ]: 58 : ordered_filters.push_back({CoinEligibilityFilter(0, 1, std::numeric_limits<uint64_t>::max(),
872 : : std::numeric_limits<uint64_t>::max(),
873 : : /*include_partial=*/true)});
874 : : }
875 : : }
876 : :
877 : : // Group outputs and map them by coin eligibility filter
878 : 3082 : std::vector<OutputGroup> discarded_groups;
879 [ + - ]: 3082 : FilteredOutputGroups filtered_groups = GroupOutputs(wallet, available_coins, coin_selection_params, ordered_filters, discarded_groups);
880 : :
881 : : // Check if we still have enough balance after applying filters (some coins might be discarded)
882 : 3082 : CAmount total_discarded = 0;
883 : 3082 : CAmount total_unconf_long_chain = 0;
884 [ + + ]: 3112 : for (const auto& group : discarded_groups) {
885 [ + - ]: 30 : total_discarded += group.GetSelectionAmount();
886 [ + + + + : 30 : if (group.m_ancestors >= max_ancestors || group.m_descendants >= max_descendants) total_unconf_long_chain += group.GetSelectionAmount();
+ - ]
887 : : }
888 : :
889 [ + + ]: 3082 : if (CAmount total_amount = available_coins.GetTotalAmount() - total_discarded < value_to_select) {
890 : : // Special case, too-long-mempool cluster.
891 [ + + ]: 2 : if (total_amount + total_unconf_long_chain > value_to_select) {
892 [ + - ]: 3 : return util::Error{_("Unconfirmed UTXOs are available, but spending them creates a chain of transactions that will be rejected by the mempool")};
893 : : }
894 : 2 : return util::Error{}; // General "Insufficient Funds"
895 : : }
896 : :
897 : : // Walk-through the filters until the solution gets found.
898 : : // If no solution is found, return the first detailed error (if any).
899 : : // future: add "error level" so the worst one can be picked instead.
900 : 3080 : std::vector<util::Result<SelectionResult>> res_detailed_errors;
901 [ + + ]: 5221 : for (const auto& select_filter : ordered_filters) {
902 : 5212 : auto it = filtered_groups.find(select_filter.filter);
903 [ + + ]: 5212 : if (it == filtered_groups.end()) continue;
904 : 7014 : if (auto res{AttemptSelection(wallet.chain(), value_to_select, it->second,
905 [ + - + + ]: 3507 : coin_selection_params, select_filter.allow_mixed_output_types)}) {
906 : 3071 : return res; // result found
907 : : } else {
908 : : // If any specific error message appears here, then something particularly wrong might have happened.
909 : : // Save the error and continue the selection process. So if no solutions gets found, we can return
910 : : // the detailed error to the upper layers.
911 [ + - + + : 436 : if (HasErrorMsg(res)) res_detailed_errors.emplace_back(std::move(res));
+ - ]
912 : 3507 : }
913 : : }
914 : :
915 : : // Return right away if we have a detailed error
916 [ + - ]: 9 : if (!res_detailed_errors.empty()) return std::move(res_detailed_errors.front());
917 : :
918 : :
919 : : // General "Insufficient Funds"
920 : 0 : return util::Error{};
921 : 6162 : }
922 : : }
923 : :
924 : 2612 : static bool IsCurrentForAntiFeeSniping(interfaces::Chain& chain, const uint256& block_hash)
925 : : {
926 [ + - ]: 2612 : if (chain.isInitialBlockDownload()) {
927 : : return false;
928 : : }
929 : 2612 : constexpr int64_t MAX_ANTI_FEE_SNIPING_TIP_AGE = 8 * 60 * 60; // in seconds
930 : 2612 : int64_t block_time;
931 : 2612 : CHECK_NONFATAL(chain.findBlock(block_hash, FoundBlock().time(block_time)));
932 [ + + ]: 2612 : if (block_time < (GetTime() - MAX_ANTI_FEE_SNIPING_TIP_AGE)) {
933 : 8 : return false;
934 : : }
935 : : return true;
936 : : }
937 : :
938 : : /**
939 : : * Set a height-based locktime for new transactions (uses the height of the
940 : : * current chain tip unless we are not synced with the current chain
941 : : */
942 : 2612 : static void DiscourageFeeSniping(CMutableTransaction& tx, FastRandomContext& rng_fast,
943 : : interfaces::Chain& chain, const uint256& block_hash, int block_height)
944 : : {
945 : : // All inputs must be added by now
946 [ - + ]: 2612 : assert(!tx.vin.empty());
947 : : // Discourage fee sniping.
948 : : //
949 : : // For a large miner the value of the transactions in the best block and
950 : : // the mempool can exceed the cost of deliberately attempting to mine two
951 : : // blocks to orphan the current best block. By setting nLockTime such that
952 : : // only the next block can include the transaction, we discourage this
953 : : // practice as the height restricted and limited blocksize gives miners
954 : : // considering fee sniping fewer options for pulling off this attack.
955 : : //
956 : : // A simple way to think about this is from the wallet's point of view we
957 : : // always want the blockchain to move forward. By setting nLockTime this
958 : : // way we're basically making the statement that we only want this
959 : : // transaction to appear in the next block; we don't want to potentially
960 : : // encourage reorgs by allowing transactions to appear at lower heights
961 : : // than the next block in forks of the best chain.
962 : : //
963 : : // Of course, the subsidy is high enough, and transaction volume low
964 : : // enough, that fee sniping isn't a problem yet, but by implementing a fix
965 : : // now we ensure code won't be written that makes assumptions about
966 : : // nLockTime that preclude a fix later.
967 [ + + ]: 2612 : if (IsCurrentForAntiFeeSniping(chain, block_hash)) {
968 : 2604 : tx.nLockTime = block_height;
969 : :
970 : : // Secondly occasionally randomly pick a nLockTime even further back, so
971 : : // that transactions that are delayed after signing for whatever reason,
972 : : // e.g. high-latency mix networks and some CoinJoin implementations, have
973 : : // better privacy.
974 [ + + ]: 5208 : if (rng_fast.randrange(10) == 0) {
975 [ - + ]: 572 : tx.nLockTime = std::max(0, int(tx.nLockTime) - int(rng_fast.randrange(100)));
976 : : }
977 : : } else {
978 : : // If our chain is lagging behind, we can't discourage fee sniping nor help
979 : : // the privacy of high-latency transactions. To avoid leaking a potentially
980 : : // unique "nLockTime fingerprint", set nLockTime to a constant.
981 : 8 : tx.nLockTime = 0;
982 : : }
983 : : // Sanity check all values
984 [ - + ]: 2612 : assert(tx.nLockTime < LOCKTIME_THRESHOLD); // Type must be block height
985 [ - + ]: 2612 : assert(tx.nLockTime <= uint64_t(block_height));
986 [ + + ]: 11255 : for (const auto& in : tx.vin) {
987 : : // Can not be FINAL for locktime to work
988 [ - + ]: 8643 : assert(in.nSequence != CTxIn::SEQUENCE_FINAL);
989 : : // May be MAX NONFINAL to disable both BIP68 and BIP125
990 [ + + ]: 8643 : if (in.nSequence == CTxIn::MAX_SEQUENCE_NONFINAL) continue;
991 : : // May be MAX BIP125 to disable BIP68 and enable BIP125
992 [ + - ]: 8436 : if (in.nSequence == MAX_BIP125_RBF_SEQUENCE) continue;
993 : : // The wallet does not support any other sequence-use right now.
994 : 0 : assert(false);
995 : : }
996 : 2612 : }
997 : :
998 : 39915 : size_t GetSerializeSizeForRecipient(const CRecipient& recipient)
999 : : {
1000 [ + - ]: 39915 : return ::GetSerializeSize(CTxOut(recipient.nAmount, GetScriptForDestination(recipient.dest)));
1001 : : }
1002 : :
1003 : 39915 : bool IsDust(const CRecipient& recipient, const CFeeRate& dustRelayFee)
1004 : : {
1005 [ + - + - ]: 39915 : return ::IsDust(CTxOut(recipient.nAmount, GetScriptForDestination(recipient.dest)), dustRelayFee);
1006 : : }
1007 : :
1008 : 3385 : static util::Result<CreatedTransactionResult> CreateTransactionInternal(
1009 : : CWallet& wallet,
1010 : : const std::vector<CRecipient>& vecSend,
1011 : : std::optional<unsigned int> change_pos,
1012 : : const CCoinControl& coin_control,
1013 : : bool sign) EXCLUSIVE_LOCKS_REQUIRED(wallet.cs_wallet)
1014 : : {
1015 : 3385 : AssertLockHeld(wallet.cs_wallet);
1016 : :
1017 : 3385 : FastRandomContext rng_fast;
1018 [ + - ]: 3385 : CMutableTransaction txNew; // The resulting transaction that we make
1019 : :
1020 [ + + ]: 3385 : if (coin_control.m_version) {
1021 : 759 : txNew.version = coin_control.m_version.value();
1022 : : }
1023 : :
1024 [ + + ]: 3385 : CoinSelectionParams coin_selection_params{rng_fast}; // Parameters for coin selection, init with dummy
1025 : 3385 : coin_selection_params.m_avoid_partial_spends = coin_control.m_avoid_partial_spends;
1026 : 3385 : coin_selection_params.m_include_unsafe_inputs = coin_control.m_include_unsafe_inputs;
1027 [ + + + - ]: 3394 : coin_selection_params.m_max_tx_weight = coin_control.m_max_tx_weight.value_or(MAX_STANDARD_TX_WEIGHT);
1028 : 3385 : int minimum_tx_weight = MIN_STANDARD_TX_NONWITNESS_SIZE * WITNESS_SCALE_FACTOR;
1029 [ + - + + : 3385 : if (coin_selection_params.m_max_tx_weight.value() < minimum_tx_weight || coin_selection_params.m_max_tx_weight.value() > MAX_STANDARD_TX_WEIGHT) {
+ + ]
1030 [ + - ]: 9 : return util::Error{strprintf(_("Maximum transaction weight must be between %d and %d"), minimum_tx_weight, MAX_STANDARD_TX_WEIGHT)};
1031 : : }
1032 : : // Set the long term feerate estimate to the wallet's consolidate feerate
1033 : 3382 : coin_selection_params.m_long_term_feerate = wallet.m_consolidate_feerate;
1034 : : // Static vsize overhead + outputs vsize. 4 nVersion, 4 nLocktime, 1 input count, 1 witness overhead (dummy, flag, stack size)
1035 [ + + ]: 3382 : coin_selection_params.tx_noinputs_size = 10 + GetSizeOfCompactSize(vecSend.size()); // bytes for output count
1036 : :
1037 : 3382 : CAmount recipients_sum = 0;
1038 [ + + + - ]: 3382 : const OutputType change_type = wallet.TransactionChangeType(coin_control.m_change_type ? *coin_control.m_change_type : wallet.m_default_change_type, vecSend);
1039 : 3382 : ReserveDestination reservedest(&wallet, change_type);
1040 : 3382 : unsigned int outputs_to_subtract_fee_from = 0; // The number of outputs which we are subtracting the fee from
1041 [ + + ]: 43297 : for (const auto& recipient : vecSend) {
1042 [ + - + - : 39915 : if (IsDust(recipient, wallet.chain().relayDustFee())) {
- + ]
1043 [ # # ]: 0 : return util::Error{_("Transaction amount too small")};
1044 : : }
1045 : :
1046 : : // Include the fee cost for outputs.
1047 [ + - ]: 39915 : coin_selection_params.tx_noinputs_size += GetSerializeSizeForRecipient(recipient);
1048 : 39915 : recipients_sum += recipient.nAmount;
1049 : :
1050 [ + + ]: 39915 : if (recipient.fSubtractFeeFromAmount) {
1051 : 640 : outputs_to_subtract_fee_from++;
1052 : 640 : coin_selection_params.m_subtract_fee_outputs = true;
1053 : : }
1054 : : }
1055 : :
1056 : : // Create change script that will be used if we need change
1057 : 3382 : CScript scriptChange;
1058 [ + - ]: 3382 : bilingual_str error; // possible error str
1059 : :
1060 : : // coin control: send change to custom address
1061 [ + - ]: 3382 : if (!std::get_if<CNoDestination>(&coin_control.destChange)) {
1062 [ + - ]: 3386 : scriptChange = GetScriptForDestination(coin_control.destChange);
1063 : : } else { // no coin control: send change to newly generated address
1064 : : // Note: We use a new key here to keep it from being obvious which side is the change.
1065 : : // The drawback is that by not reusing a previous key, the change may be lost if a
1066 : : // backup is restored, if the backup doesn't have the new private key for the change.
1067 : : // If we reused the old key, it would be possible to add code to look for and
1068 : : // rediscover unknown transactions that were written with keys of ours to recover
1069 : : // post-backup change.
1070 : :
1071 : : // Reserve a new key pair from key pool. If it fails, provide a dummy
1072 : : // destination in case we don't need change.
1073 : 1689 : CTxDestination dest;
1074 [ + - ]: 1689 : auto op_dest = reservedest.GetReservedDestination(true);
1075 [ + + ]: 1689 : if (!op_dest) {
1076 [ + - + - : 84 : error = _("Transaction needs a change address, but we can't generate it.") + Untranslated(" ") + util::ErrorString(op_dest);
+ - + - ]
1077 : : } else {
1078 [ + - ]: 1675 : dest = *op_dest;
1079 [ + - ]: 3350 : scriptChange = GetScriptForDestination(dest);
1080 : : }
1081 : : // A valid destination implies a change script (and
1082 : : // vice-versa). An empty change script will abort later, if the
1083 : : // change keypool ran out, but change is required.
1084 [ + - + + : 2013 : CHECK_NONFATAL(IsValidDestination(dest) != scriptChange.empty());
+ - ]
1085 : 1689 : }
1086 [ + - ]: 3382 : CTxOut change_prototype_txout(0, scriptChange);
1087 : 3382 : coin_selection_params.change_output_size = GetSerializeSize(change_prototype_txout);
1088 : :
1089 : : // Get size of spending the change output
1090 [ + - ]: 3382 : int change_spend_size = CalculateMaximumSignedInputSize(change_prototype_txout, &wallet, /*coin_control=*/nullptr);
1091 : : // If the wallet doesn't know how to sign change output, assume p2sh-p2wpkh
1092 : : // as lower-bound to allow BnB to do it's thing
1093 [ + + ]: 3382 : if (change_spend_size == -1) {
1094 : 24 : coin_selection_params.change_spend_size = DUMMY_NESTED_P2WPKH_INPUT_SIZE;
1095 : : } else {
1096 : 3358 : coin_selection_params.change_spend_size = change_spend_size;
1097 : : }
1098 : :
1099 : : // Set discard feerate
1100 [ + - ]: 3382 : coin_selection_params.m_discard_feerate = GetDiscardRate(wallet);
1101 : :
1102 : : // Get the fee rate to use effective values in coin selection
1103 : 3382 : FeeCalculation feeCalc;
1104 [ + - ]: 3382 : coin_selection_params.m_effective_feerate = GetMinimumFeeRate(wallet, coin_control, &feeCalc);
1105 : : // Do not, ever, assume that it's fine to change the fee rate if the user has explicitly
1106 : : // provided one
1107 [ + + + + ]: 3382 : if (coin_control.m_feerate && coin_selection_params.m_effective_feerate > *coin_control.m_feerate) {
1108 [ + - + - : 63 : return util::Error{strprintf(_("Fee rate (%s) is lower than the minimum fee rate setting (%s)"), coin_control.m_feerate->ToString(FeeEstimateMode::SAT_VB), coin_selection_params.m_effective_feerate.ToString(FeeEstimateMode::SAT_VB))};
+ - ]
1109 : : }
1110 [ + + + + ]: 3361 : if (feeCalc.reason == FeeReason::FALLBACK && !wallet.m_allow_fallback_fee) {
1111 : : // eventually allow a fallback fee
1112 [ + - ]: 9 : return util::Error{strprintf(_("Fee estimation failed. Fallbackfee is disabled. Wait a few blocks or enable %s."), "-fallbackfee")};
1113 : : }
1114 : :
1115 : : // Calculate the cost of change
1116 : : // Cost of change is the cost of creating the change output + cost of spending the change output in the future.
1117 : : // For creating the change output now, we use the effective feerate.
1118 : : // For spending the change output in the future, we use the discard feerate for now.
1119 : : // So cost of change = (change output size * effective feerate) + (size of spending change output * discard feerate)
1120 [ + - ]: 3358 : coin_selection_params.m_change_fee = coin_selection_params.m_effective_feerate.GetFee(coin_selection_params.change_output_size);
1121 [ + - ]: 3358 : coin_selection_params.m_cost_of_change = coin_selection_params.m_discard_feerate.GetFee(coin_selection_params.change_spend_size) + coin_selection_params.m_change_fee;
1122 : :
1123 [ + - ]: 3358 : coin_selection_params.m_min_change_target = GenerateChangeTarget(std::floor(recipients_sum / vecSend.size()), coin_selection_params.m_change_fee, rng_fast);
1124 : :
1125 : : // The smallest change amount should be:
1126 : : // 1. at least equal to dust threshold
1127 : : // 2. at least 1 sat greater than fees to spend it at m_discard_feerate
1128 [ + - ]: 3358 : const auto dust = GetDustThreshold(change_prototype_txout, coin_selection_params.m_discard_feerate);
1129 [ + - ]: 3358 : const auto change_spend_fee = coin_selection_params.m_discard_feerate.GetFee(coin_selection_params.change_spend_size);
1130 [ + + ]: 3358 : coin_selection_params.min_viable_change = std::max(change_spend_fee + 1, dust);
1131 : :
1132 : : // Include the fees for things that aren't inputs, excluding the change output
1133 [ + + + - ]: 3358 : const CAmount not_input_fees = coin_selection_params.m_effective_feerate.GetFee(coin_selection_params.m_subtract_fee_outputs ? 0 : coin_selection_params.tx_noinputs_size);
1134 : 3358 : CAmount selection_target = recipients_sum + not_input_fees;
1135 : :
1136 : : // This can only happen if feerate is 0, and requested destinations are value of 0 (e.g. OP_RETURN)
1137 : : // and no pre-selected inputs. This will result in 0-input transaction, which is consensus-invalid anyways
1138 [ + + + - : 3358 : if (selection_target == 0 && !coin_control.HasSelected()) {
- + ]
1139 [ + - ]: 3 : return util::Error{_("Transaction requires one destination of non-zero value, a non-zero feerate, or a pre-selected input")};
1140 : : }
1141 : :
1142 : : // Fetch manually selected coins
1143 [ + - ]: 3357 : PreSelectedInputs preset_inputs;
1144 [ + - + + ]: 3357 : if (coin_control.HasSelected()) {
1145 [ + - ]: 450 : auto res_fetch_inputs = FetchSelectedInputs(wallet, coin_control, coin_selection_params);
1146 [ + + + - ]: 456 : if (!res_fetch_inputs) return util::Error{util::ErrorString(res_fetch_inputs)};
1147 [ + - ]: 447 : preset_inputs = *res_fetch_inputs;
1148 : 450 : }
1149 : :
1150 : : // Fetch wallet available coins if "other inputs" are
1151 : : // allowed (coins automatically selected by the wallet)
1152 [ + + ]: 3354 : CoinsResult available_coins;
1153 [ + + ]: 3354 : if (coin_control.m_allow_other_inputs) {
1154 [ + - ]: 6536 : available_coins = AvailableCoins(wallet, &coin_control, coin_selection_params.m_effective_feerate);
1155 : : }
1156 : :
1157 : : // Choose coins to use
1158 [ + - ]: 3354 : auto select_coins_res = SelectCoins(wallet, available_coins, preset_inputs, /*nTargetValue=*/selection_target, coin_control, coin_selection_params);
1159 [ + + ]: 3354 : if (!select_coins_res) {
1160 : : // 'SelectCoins' either returns a specific error message or, if empty, means a general "Insufficient funds".
1161 [ + - ]: 37 : const bilingual_str& err = util::ErrorString(select_coins_res);
1162 [ + + + - : 111 : return util::Error{err.empty() ?_("Insufficient funds") : err};
+ - ]
1163 : 37 : }
1164 : 3317 : const SelectionResult& result = *select_coins_res;
1165 : : TRACEPOINT(coin_selection, selected_coins,
1166 : : wallet.GetName().c_str(),
1167 : : GetAlgorithmName(result.GetAlgo()).c_str(),
1168 : : result.GetTarget(),
1169 : : result.GetWaste(),
1170 : 3317 : result.GetSelectedValue());
1171 : :
1172 : : // vouts to the payees
1173 [ + - ]: 3317 : txNew.vout.reserve(vecSend.size() + 1); // + 1 because of possible later insert
1174 [ + + ]: 43162 : for (const auto& recipient : vecSend)
1175 : : {
1176 [ + - + - ]: 79690 : txNew.vout.emplace_back(recipient.nAmount, GetScriptForDestination(recipient.dest));
1177 : : }
1178 [ + - ]: 3317 : const CAmount change_amount = result.GetChange(coin_selection_params.min_viable_change, coin_selection_params.m_change_fee);
1179 [ + + ]: 3317 : if (change_amount > 0) {
1180 [ + - ]: 3247 : CTxOut newTxOut(change_amount, scriptChange);
1181 [ + + ]: 3247 : if (!change_pos) {
1182 : : // Insert change txn at random position:
1183 : 3179 : change_pos = rng_fast.randrange(txNew.vout.size() + 1);
1184 [ - + ]: 68 : } else if ((unsigned int)*change_pos > txNew.vout.size()) {
1185 [ # # ]: 0 : return util::Error{_("Transaction change output index out of range")};
1186 : : }
1187 [ + - ]: 3247 : txNew.vout.insert(txNew.vout.begin() + *change_pos, newTxOut);
1188 : 3247 : } else {
1189 [ + + ]: 70 : change_pos = std::nullopt;
1190 : : }
1191 : :
1192 : : // Shuffle selected coins and fill in final vin
1193 [ + - ]: 3317 : std::vector<std::shared_ptr<COutput>> selected_coins = result.GetShuffledInputVector();
1194 : :
1195 [ + - + + : 3317 : if (coin_control.HasSelected() && coin_control.HasSelectedOrder()) {
+ + ]
1196 : : // When there are preselected inputs, we need to move them to be the first UTXOs
1197 : : // and have them be in the order selected. We can use stable_sort for this, where we
1198 : : // compare with the positions stored in coin_control. The COutputs that have positions
1199 : : // will be placed before those that don't, and those positions will be in order.
1200 [ + - ]: 428 : std::stable_sort(selected_coins.begin(), selected_coins.end(),
1201 : 15220 : [&coin_control](const std::shared_ptr<COutput>& a, const std::shared_ptr<COutput>& b) {
1202 : 15220 : auto a_pos = coin_control.GetSelectionPos(a->outpoint);
1203 : 15220 : auto b_pos = coin_control.GetSelectionPos(b->outpoint);
1204 [ + + + + ]: 15220 : if (a_pos.has_value() && b_pos.has_value()) {
1205 : 14700 : return a_pos.value() < b_pos.value();
1206 [ + + + - ]: 520 : } else if (a_pos.has_value() && !b_pos.has_value()) {
1207 : 83 : return true;
1208 : : } else {
1209 : : return false;
1210 : : }
1211 : : });
1212 : : }
1213 : :
1214 : : // The sequence number is set to non-maxint so that DiscourageFeeSniping
1215 : : // works.
1216 : : //
1217 : : // BIP125 defines opt-in RBF as any nSequence < maxint-1, so
1218 : : // we use the highest possible value in that range (maxint-2)
1219 : : // to avoid conflicting with other possible uses of nSequence,
1220 : : // and in the spirit of "smallest possible change from prior
1221 : : // behavior."
1222 : 3317 : bool use_anti_fee_sniping = true;
1223 [ + + + + ]: 6634 : const uint32_t default_sequence{coin_control.m_signal_bip125_rbf.value_or(wallet.m_signal_rbf) ? MAX_BIP125_RBF_SEQUENCE : CTxIn::MAX_SEQUENCE_NONFINAL};
1224 [ + - ]: 3317 : txNew.vin.reserve(selected_coins.size());
1225 [ + + ]: 17209 : for (const auto& coin : selected_coins) {
1226 [ + - ]: 13892 : std::optional<uint32_t> sequence = coin_control.GetSequence(coin->outpoint);
1227 [ + + ]: 13892 : if (sequence) {
1228 : : // If an input has a preset sequence, we can't do anti-fee-sniping
1229 : 1753 : use_anti_fee_sniping = false;
1230 : : }
1231 [ + + + - ]: 15645 : txNew.vin.emplace_back(coin->outpoint, CScript{}, sequence.value_or(default_sequence));
1232 : :
1233 [ + - ]: 13892 : auto scripts = coin_control.GetScripts(coin->outpoint);
1234 [ + + ]: 13892 : if (scripts.first) {
1235 : 1753 : txNew.vin.back().scriptSig = *scripts.first;
1236 : : }
1237 [ + + ]: 13892 : if (scripts.second) {
1238 [ + - ]: 13892 : txNew.vin.back().scriptWitness = *scripts.second;
1239 : : }
1240 : 13892 : }
1241 [ + + ]: 3317 : if (coin_control.m_locktime) {
1242 : 705 : txNew.nLockTime = coin_control.m_locktime.value();
1243 : : // If we have a locktime set, we can't use anti-fee-sniping
1244 : 705 : use_anti_fee_sniping = false;
1245 : : }
1246 [ + - ]: 3317 : if (use_anti_fee_sniping) {
1247 [ + - ]: 2612 : DiscourageFeeSniping(txNew, rng_fast, wallet.chain(), wallet.GetLastBlockHash(), wallet.GetLastBlockHeight());
1248 : : }
1249 : :
1250 : : // Calculate the transaction fee
1251 [ + - + - ]: 3317 : TxSize tx_sizes = CalculateMaximumSignedTxSize(CTransaction(txNew), &wallet, &coin_control);
1252 : 3317 : int nBytes = tx_sizes.vsize;
1253 [ - + ]: 3317 : if (nBytes == -1) {
1254 [ # # ]: 0 : return util::Error{_("Missing solving data for estimating transaction size")};
1255 : : }
1256 [ + - + - ]: 3317 : CAmount fee_needed = coin_selection_params.m_effective_feerate.GetFee(nBytes) + result.GetTotalBumpFees();
1257 : 3317 : const CAmount output_value = CalculateOutputValue(txNew);
1258 : 3317 : Assume(recipients_sum + change_amount == output_value);
1259 [ + - ]: 3317 : CAmount current_fee = result.GetSelectedValue() - output_value;
1260 : :
1261 : : // Sanity check that the fee cannot be negative as that means we have more output value than input value
1262 [ - + ]: 3317 : if (current_fee < 0) {
1263 [ # # # # ]: 0 : return util::Error{Untranslated(STR_INTERNAL_BUG("Fee paid < 0"))};
1264 : : }
1265 : :
1266 : : // If there is a change output and we overpay the fees then increase the change to match the fee needed
1267 [ + + + + ]: 3317 : if (change_pos && fee_needed < current_fee) {
1268 [ + - ]: 1383 : auto& change = txNew.vout.at(*change_pos);
1269 : 1383 : change.nValue += current_fee - fee_needed;
1270 [ + - ]: 1383 : current_fee = result.GetSelectedValue() - CalculateOutputValue(txNew);
1271 [ - + ]: 1383 : if (fee_needed != current_fee) {
1272 [ # # # # ]: 0 : return util::Error{Untranslated(STR_INTERNAL_BUG("Change adjustment: Fee needed != fee paid"))};
1273 : : }
1274 : : }
1275 : :
1276 : : // Reduce output values for subtractFeeFromAmount
1277 [ + + ]: 3317 : if (coin_selection_params.m_subtract_fee_outputs) {
1278 : 628 : CAmount to_reduce = fee_needed - current_fee;
1279 : 628 : unsigned int i = 0;
1280 : 628 : bool fFirst = true;
1281 [ + + ]: 1267 : for (const auto& recipient : vecSend)
1282 : : {
1283 [ + + + + ]: 640 : if (change_pos && i == *change_pos) {
1284 : 295 : ++i;
1285 : : }
1286 [ + + ]: 640 : CTxOut& txout = txNew.vout[i];
1287 : :
1288 [ + + ]: 640 : if (recipient.fSubtractFeeFromAmount)
1289 : : {
1290 : 638 : txout.nValue -= to_reduce / outputs_to_subtract_fee_from; // Subtract fee equally from each selected recipient
1291 : :
1292 [ + + ]: 638 : if (fFirst) // first receiver pays the remainder not divisible by output count
1293 : : {
1294 : 628 : fFirst = false;
1295 : 628 : txout.nValue -= to_reduce % outputs_to_subtract_fee_from;
1296 : : }
1297 : :
1298 : : // Error if this output is reduced to be below dust
1299 [ + - + - : 638 : if (IsDust(txout, wallet.chain().relayDustFee())) {
+ + ]
1300 [ + - ]: 1 : if (txout.nValue < 0) {
1301 [ + - ]: 3 : return util::Error{_("The transaction amount is too small to pay the fee")};
1302 : : } else {
1303 [ # # ]: 0 : return util::Error{_("The transaction amount is too small to send after the fee has been deducted")};
1304 : : }
1305 : : }
1306 : : }
1307 : 639 : ++i;
1308 : : }
1309 [ + - ]: 627 : current_fee = result.GetSelectedValue() - CalculateOutputValue(txNew);
1310 [ - + ]: 627 : if (fee_needed != current_fee) {
1311 [ # # # # ]: 0 : return util::Error{Untranslated(STR_INTERNAL_BUG("SFFO: Fee needed != fee paid"))};
1312 : : }
1313 : : }
1314 : :
1315 : : // fee_needed should now always be less than or equal to the current fees that we pay.
1316 : : // If it is not, it is a bug.
1317 [ - + ]: 3316 : if (fee_needed > current_fee) {
1318 [ # # # # ]: 0 : return util::Error{Untranslated(STR_INTERNAL_BUG("Fee needed > fee paid"))};
1319 : : }
1320 : :
1321 : : // Give up if change keypool ran out and change is required
1322 [ + + + + : 3966 : if (scriptChange.empty() && change_pos) {
+ + ]
1323 [ + - ]: 6 : return util::Error{error};
1324 : : }
1325 : :
1326 [ + + + - : 3314 : if (sign && !wallet.SignTransaction(txNew)) {
+ - ]
1327 [ # # ]: 0 : return util::Error{_("Signing transaction failed")};
1328 : : }
1329 : :
1330 : : // Return the constructed transaction data.
1331 [ + - ]: 3314 : CTransactionRef tx = MakeTransactionRef(std::move(txNew));
1332 : :
1333 : : // Limit size
1334 [ + + - + ]: 3314 : if ((sign && GetTransactionWeight(*tx) > MAX_STANDARD_TX_WEIGHT) ||
1335 [ + + ]: 916 : (!sign && tx_sizes.weight > MAX_STANDARD_TX_WEIGHT))
1336 : : {
1337 [ + - ]: 6 : return util::Error{_("Transaction too large")};
1338 : : }
1339 : :
1340 [ + + ]: 3312 : if (current_fee > wallet.m_default_max_tx_fee) {
1341 [ + - ]: 57 : return util::Error{TransactionErrorString(TransactionError::MAX_FEE_EXCEEDED)};
1342 : : }
1343 : :
1344 [ + - + - : 3293 : if (gArgs.GetBoolArg("-walletrejectlongchains", DEFAULT_WALLET_REJECT_LONG_CHAINS)) {
+ + ]
1345 : : // Lastly, ensure this tx will pass the mempool's chain limits
1346 [ + - ]: 3231 : auto result = wallet.chain().checkChainLimits(tx);
1347 [ + + ]: 3231 : if (!result) {
1348 [ + - ]: 3 : return util::Error{util::ErrorString(result)};
1349 : : }
1350 : 3231 : }
1351 : :
1352 : : // Before we return success, we assume any change key will be used to prevent
1353 : : // accidental reuse.
1354 [ + - ]: 3292 : reservedest.KeepDestination();
1355 : :
1356 [ + - + - : 3292 : wallet.WalletLogPrintf("Coin Selection: Algorithm:%s, Waste Metric Score:%d\n", GetAlgorithmName(result.GetAlgo()), result.GetWaste());
+ - ]
1357 [ + - ]: 3292 : wallet.WalletLogPrintf("Fee Calculation: Fee:%d Bytes:%u Tgt:%d (requested %d) Reason:\"%s\" Decay %.5f: Estimation: (%g - %g) %.2f%% %.1f/(%.1f %d mem %.1f out) Fail: (%g - %g) %.2f%% %.1f/(%.1f %d mem %.1f out)\n",
1358 : 0 : current_fee, nBytes, feeCalc.returnedTarget, feeCalc.desiredTarget, StringForFeeReason(feeCalc.reason), feeCalc.est.decay,
1359 : : feeCalc.est.pass.start, feeCalc.est.pass.end,
1360 [ + - ]: 3292 : (feeCalc.est.pass.totalConfirmed + feeCalc.est.pass.inMempool + feeCalc.est.pass.leftMempool) > 0.0 ? 100 * feeCalc.est.pass.withinTarget / (feeCalc.est.pass.totalConfirmed + feeCalc.est.pass.inMempool + feeCalc.est.pass.leftMempool) : 0.0,
1361 : : feeCalc.est.pass.withinTarget, feeCalc.est.pass.totalConfirmed, feeCalc.est.pass.inMempool, feeCalc.est.pass.leftMempool,
1362 : : feeCalc.est.fail.start, feeCalc.est.fail.end,
1363 [ + + + + ]: 3292 : (feeCalc.est.fail.totalConfirmed + feeCalc.est.fail.inMempool + feeCalc.est.fail.leftMempool) > 0.0 ? 100 * feeCalc.est.fail.withinTarget / (feeCalc.est.fail.totalConfirmed + feeCalc.est.fail.inMempool + feeCalc.est.fail.leftMempool) : 0.0,
1364 : : feeCalc.est.fail.withinTarget, feeCalc.est.fail.totalConfirmed, feeCalc.est.fail.inMempool, feeCalc.est.fail.leftMempool);
1365 [ + - - + : 9876 : return CreatedTransactionResult(tx, current_fee, change_pos, feeCalc);
+ - ]
1366 : 23559 : }
1367 : :
1368 : 1767 : util::Result<CreatedTransactionResult> CreateTransaction(
1369 : : CWallet& wallet,
1370 : : const std::vector<CRecipient>& vecSend,
1371 : : std::optional<unsigned int> change_pos,
1372 : : const CCoinControl& coin_control,
1373 : : bool sign)
1374 : : {
1375 [ - + ]: 1767 : if (vecSend.empty()) {
1376 : 0 : return util::Error{_("Transaction must have at least one recipient")};
1377 : : }
1378 : :
1379 [ - + - + : 8508 : if (std::any_of(vecSend.cbegin(), vecSend.cend(), [](const auto& recipient){ return recipient.nAmount < 0; })) {
- + - + -
+ - + - +
- + ]
1380 : 0 : return util::Error{_("Transaction amounts must not be negative")};
1381 : : }
1382 : :
1383 : 1767 : LOCK(wallet.cs_wallet);
1384 : :
1385 [ + - ]: 1767 : auto res = CreateTransactionInternal(wallet, vecSend, change_pos, coin_control, sign);
1386 : : TRACEPOINT(coin_selection, normal_create_tx_internal,
1387 : : wallet.GetName().c_str(),
1388 : : bool(res),
1389 : : res ? res->fee : 0,
1390 : 1767 : res && res->change_pos.has_value() ? int32_t(*res->change_pos) : -1);
1391 [ + + ]: 1767 : if (!res) return res;
1392 : 1678 : const auto& txr_ungrouped = *res;
1393 : : // try with avoidpartialspends unless it's enabled already
1394 [ + + + - : 1678 : if (txr_ungrouped.fee > 0 /* 0 means non-functional fee rate estimation */ && wallet.m_max_aps_fee > -1 && !coin_control.m_avoid_partial_spends) {
+ + ]
1395 : 1618 : TRACEPOINT(coin_selection, attempting_aps_create_tx, wallet.GetName().c_str());
1396 [ + - ]: 1618 : CCoinControl tmp_cc = coin_control;
1397 : 1618 : tmp_cc.m_avoid_partial_spends = true;
1398 : :
1399 : : // Reuse the change destination from the first creation attempt to avoid skipping BIP44 indexes
1400 [ + + ]: 1618 : if (txr_ungrouped.change_pos) {
1401 [ + - ]: 1583 : ExtractDestination(txr_ungrouped.tx->vout[*txr_ungrouped.change_pos].scriptPubKey, tmp_cc.destChange);
1402 : : }
1403 : :
1404 [ + - ]: 1618 : auto txr_grouped = CreateTransactionInternal(wallet, vecSend, change_pos, tmp_cc, sign);
1405 : : // if fee of this alternative one is within the range of the max fee, we use this one
1406 [ + + ]: 3232 : const bool use_aps{txr_grouped.has_value() ? (txr_grouped->fee <= txr_ungrouped.fee + wallet.m_max_aps_fee) : false};
1407 : : TRACEPOINT(coin_selection, aps_create_tx_internal,
1408 : : wallet.GetName().c_str(),
1409 : : use_aps,
1410 : : txr_grouped.has_value(),
1411 : : txr_grouped.has_value() ? txr_grouped->fee : 0,
1412 : 1618 : txr_grouped.has_value() && txr_grouped->change_pos.has_value() ? int32_t(*txr_grouped->change_pos) : -1);
1413 [ + + ]: 1618 : if (txr_grouped) {
1414 : 3228 : wallet.WalletLogPrintf("Fee non-grouped = %lld, grouped = %lld, using %s\n",
1415 [ + + + - ]: 1870 : txr_ungrouped.fee, txr_grouped->fee, use_aps ? "grouped" : "non-grouped");
1416 [ + + ]: 1614 : if (use_aps) return txr_grouped;
1417 : : }
1418 : 1618 : }
1419 : 320 : return res;
1420 [ + - ]: 3534 : }
1421 : :
1422 : 427 : util::Result<CreatedTransactionResult> FundTransaction(CWallet& wallet, const CMutableTransaction& tx, const std::vector<CRecipient>& vecSend, std::optional<unsigned int> change_pos, bool lockUnspents, CCoinControl coinControl)
1423 : : {
1424 : : // We want to make sure tx.vout is not used now that we are passing outputs as a vector of recipients.
1425 : : // This sets us up to remove tx completely in a future PR in favor of passing the inputs directly.
1426 [ - + ]: 427 : assert(tx.vout.empty());
1427 : :
1428 : : // Set the user desired locktime
1429 : 427 : coinControl.m_locktime = tx.nLockTime;
1430 : :
1431 : : // Set the user desired version
1432 : 427 : coinControl.m_version = tx.version;
1433 : :
1434 : : // Acquire the locks to prevent races to the new locked unspents between the
1435 : : // CreateTransaction call and LockCoin calls (when lockUnspents is true).
1436 : 427 : LOCK(wallet.cs_wallet);
1437 : :
1438 : : // Fetch specified UTXOs from the UTXO set to get the scriptPubKeys and values of the outputs being selected
1439 : : // and to match with the given solving_data. Only used for non-wallet outputs.
1440 : 427 : std::map<COutPoint, Coin> coins;
1441 [ + + ]: 3090 : for (const CTxIn& txin : tx.vin) {
1442 [ + - ]: 2663 : coins[txin.prevout]; // Create empty map entry keyed by prevout.
1443 : : }
1444 [ + - ]: 427 : wallet.chain().findCoins(coins);
1445 : :
1446 [ + + ]: 3089 : for (const CTxIn& txin : tx.vin) {
1447 : 2663 : const auto& outPoint = txin.prevout;
1448 [ + - ]: 2663 : PreselectedInput& preset_txin = coinControl.Select(outPoint);
1449 [ + - + + ]: 2663 : if (!wallet.IsMine(outPoint)) {
1450 [ + - + + ]: 24 : if (coins[outPoint].out.IsNull()) {
1451 [ + - ]: 3 : return util::Error{_("Unable to find UTXO for external input")};
1452 : : }
1453 : :
1454 : : // The input was not in the wallet, but is in the UTXO set, so select as external
1455 [ + - + - ]: 23 : preset_txin.SetTxOut(coins[outPoint].out);
1456 : : }
1457 [ + - ]: 2662 : preset_txin.SetSequence(txin.nSequence);
1458 [ + - ]: 2662 : preset_txin.SetScriptSig(txin.scriptSig);
1459 [ + - ]: 2662 : preset_txin.SetScriptWitness(txin.scriptWitness);
1460 : : }
1461 : :
1462 [ + - ]: 426 : auto res = CreateTransaction(wallet, vecSend, change_pos, coinControl, false);
1463 [ + + ]: 426 : if (!res) {
1464 : 68 : return res;
1465 : : }
1466 : :
1467 [ + + ]: 358 : if (lockUnspents) {
1468 [ + + ]: 8 : for (const CTxIn& txin : res->tx->vin) {
1469 [ + - ]: 4 : wallet.LockCoin(txin.prevout);
1470 : : }
1471 : : }
1472 : :
1473 : 358 : return res;
1474 [ + - ]: 1280 : }
1475 : : } // namespace wallet
|
