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