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