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