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