Bitcoin Core 31.99.0
P2P Digital Currency
coinselection.cpp
Go to the documentation of this file.
1// Copyright (c) 2022-present The Bitcoin Core developers
2// Distributed under the MIT software license, see the accompanying
3// file COPYING or http://www.opensource.org/licenses/mit-license.php.
4
5#include <policy/feerate.h>
6#include <policy/policy.h>
9#include <test/fuzz/fuzz.h>
10#include <test/fuzz/util.h>
13
14#include <numeric>
15#include <span>
16#include <vector>
17
18namespace wallet {
19
20static void AddCoin(const CAmount& value, int n_input, int n_input_bytes, int locktime, std::vector<COutput>& coins, CFeeRate fee_rate)
21{
23 tx.vout.resize(n_input + 1);
24 tx.vout[n_input].nValue = value;
25 tx.nLockTime = locktime; // all transactions get different hashes
26 coins.emplace_back(COutPoint(tx.GetHash(), n_input), tx.vout.at(n_input), /*depth=*/0, n_input_bytes, /*solvable=*/true, /*safe=*/true, /*time=*/0, /*from_me=*/true, fee_rate);
27}
28
29// Randomly distribute coins to instances of OutputGroup
30static void GroupCoins(FuzzedDataProvider& fuzzed_data_provider, const std::vector<COutput>& coins, const CoinSelectionParams& coin_params, bool positive_only, std::vector<OutputGroup>& output_groups)
31{
32 auto output_group = OutputGroup(coin_params);
33 bool valid_outputgroup{false};
34 for (auto& coin : coins) {
35 if (!positive_only || (positive_only && coin.GetEffectiveValue() > 0)) {
36 output_group.Insert(std::make_shared<COutput>(coin), /*ancestors=*/0, /*cluster_count=*/0);
37 }
38 // If positive_only was specified, nothing was inserted, leading to an empty output group
39 // that would be invalid for the BnB algorithm
40 valid_outputgroup = !positive_only || output_group.GetSelectionAmount() > 0;
41 if (valid_outputgroup && fuzzed_data_provider.ConsumeBool()) {
42 output_groups.push_back(output_group);
43 output_group = OutputGroup(coin_params);
44 valid_outputgroup = false;
45 }
46 }
47 if (valid_outputgroup) output_groups.push_back(output_group);
48}
49
50static CAmount CreateCoins(FuzzedDataProvider& fuzzed_data_provider, std::vector<COutput>& utxo_pool, CoinSelectionParams& coin_params, int& next_locktime)
51{
52 CAmount total_balance{0};
54 const int n_input{fuzzed_data_provider.ConsumeIntegralInRange<int>(0, 10)};
55 const int n_input_bytes{fuzzed_data_provider.ConsumeIntegralInRange<int>(41, 10000)};
57 if (total_balance + amount >= MAX_MONEY) {
58 break;
59 }
60 AddCoin(amount, n_input, n_input_bytes, ++next_locktime, utxo_pool, coin_params.m_effective_feerate);
61 total_balance += amount;
62 }
63
64 return total_balance;
65}
66
67static SelectionResult ManualSelection(std::vector<COutput>& utxos, const CAmount& total_amount, const bool& subtract_fee_outputs)
68{
69 SelectionResult result(total_amount, SelectionAlgorithm::MANUAL);
70 OutputSet utxo_pool;
71 for (const auto& utxo : utxos) {
72 utxo_pool.insert(std::make_shared<COutput>(utxo));
73 }
74 result.AddInputs(utxo_pool, subtract_fee_outputs);
75 return result;
76}
77
78// Returns true if the result contains an error and the message is not empty
79static bool HasErrorMsg(const util::Result<SelectionResult>& res) { return !util::ErrorString(res).empty(); }
80
81FUZZ_TARGET(coin_grinder)
82{
83 FuzzedDataProvider fuzzed_data_provider{buffer.data(), buffer.size()};
84 std::vector<COutput> utxo_pool;
85
87
89 CoinSelectionParams coin_params{fast_random_context};
91 coin_params.m_long_term_feerate = CFeeRate{ConsumeMoney(fuzzed_data_provider, /*max=*/COIN)};
92 coin_params.m_effective_feerate = CFeeRate{ConsumeMoney(fuzzed_data_provider, /*max=*/COIN)};
93 coin_params.change_output_size = fuzzed_data_provider.ConsumeIntegralInRange<int>(10, 1000);
94 coin_params.change_spend_size = fuzzed_data_provider.ConsumeIntegralInRange<int>(10, 1000);
95 coin_params.m_cost_of_change= coin_params.m_effective_feerate.GetFee(coin_params.change_output_size) + coin_params.m_long_term_feerate.GetFee(coin_params.change_spend_size);
96 coin_params.m_change_fee = coin_params.m_effective_feerate.GetFee(coin_params.change_output_size);
97 // For other results to be comparable to SRD, we must align the change_target with SRD’s hardcoded behavior
98 coin_params.m_min_change_target = CHANGE_LOWER + coin_params.m_change_fee;
99
100 // Create some coins
101 CAmount total_balance{0};
102 CAmount max_spendable{0};
103 int next_locktime{0};
105 const int n_input{fuzzed_data_provider.ConsumeIntegralInRange<int>(0, 10)};
106 const int n_input_bytes{fuzzed_data_provider.ConsumeIntegralInRange<int>(41, 10000)};
108 if (total_balance + amount >= MAX_MONEY) {
109 break;
110 }
111 AddCoin(amount, n_input, n_input_bytes, ++next_locktime, utxo_pool, coin_params.m_effective_feerate);
112 total_balance += amount;
113 CAmount eff_value = amount - coin_params.m_effective_feerate.GetFee(n_input_bytes);
114 max_spendable += eff_value;
115 }
116
117 std::vector<OutputGroup> group_pos;
118 GroupCoins(fuzzed_data_provider, utxo_pool, coin_params, /*positive_only=*/true, group_pos);
119
120 // Run coinselection algorithms
121 auto result_cg = CoinGrinder(group_pos, target, coin_params.m_min_change_target, MAX_STANDARD_TX_WEIGHT);
122 if (target + coin_params.m_min_change_target > max_spendable || HasErrorMsg(result_cg)) return; // We only need to compare algorithms if CoinGrinder has a solution
123 assert(result_cg);
124 if (!result_cg->GetAlgoCompleted()) return; // Bail out if CoinGrinder solution is not optimal
125
126 auto result_srd = SelectCoinsSRD(group_pos, target, coin_params.m_change_fee, fast_random_context, MAX_STANDARD_TX_WEIGHT);
127 if (result_srd && result_srd->GetChange(CHANGE_LOWER, coin_params.m_change_fee) > 0) { // exclude any srd solutions that don’t have change, err on excluding
128 assert(result_srd->GetWeight() >= result_cg->GetWeight());
129 }
130
131 auto result_knapsack = KnapsackSolver(group_pos, target, coin_params.m_min_change_target, fast_random_context, MAX_STANDARD_TX_WEIGHT);
132 if (result_knapsack && result_knapsack->GetChange(CHANGE_LOWER, coin_params.m_change_fee) > 0) { // exclude any knapsack solutions that don’t have change, err on excluding
133 assert(result_knapsack->GetWeight() >= result_cg->GetWeight());
134 }
135}
136
137FUZZ_TARGET(coin_grinder_is_optimal)
138{
139 FuzzedDataProvider fuzzed_data_provider{buffer.data(), buffer.size()};
140
142 CoinSelectionParams coin_params{fast_random_context};
143 coin_params.m_subtract_fee_outputs = false;
144 // Set effective feerate up to MAX_MONEY sats per 1'000'000 vB (2'100'000'000 sat/vB = 21'000 BTC/kvB).
145 coin_params.m_effective_feerate = CFeeRate{ConsumeMoney(fuzzed_data_provider, MAX_MONEY), 1'000'000};
146 coin_params.m_min_change_target = ConsumeMoney(fuzzed_data_provider);
147
148 // Create some coins
149 CAmount max_spendable{0};
150 int next_locktime{0};
151 static constexpr unsigned max_output_groups{16};
152 std::vector<OutputGroup> group_pos;
153 LIMITED_WHILE (fuzzed_data_provider.ConsumeBool(), max_output_groups) {
154 // With maximum m_effective_feerate and n_input_bytes = 1'000'000, input_fee <= MAX_MONEY.
155 const int n_input_bytes{fuzzed_data_provider.ConsumeIntegralInRange<int>(1, 1'000'000)};
156 // Only make UTXOs with positive effective value
157 const CAmount input_fee = coin_params.m_effective_feerate.GetFee(n_input_bytes);
158 // Ensure that each UTXO has at least an effective value of 1 sat
159 const CAmount eff_value{fuzzed_data_provider.ConsumeIntegralInRange<CAmount>(1, MAX_MONEY + group_pos.size() - max_spendable - max_output_groups)};
160 const CAmount amount{eff_value + input_fee};
161 std::vector<COutput> temp_utxo_pool;
162
163 AddCoin(amount, /*n_input=*/0, n_input_bytes, ++next_locktime, temp_utxo_pool, coin_params.m_effective_feerate);
164 max_spendable += eff_value;
165
166 auto output_group = OutputGroup(coin_params);
167 output_group.Insert(std::make_shared<COutput>(temp_utxo_pool.at(0)), /*ancestors=*/0, /*cluster_count=*/0);
168 group_pos.push_back(output_group);
169 }
170 size_t num_groups = group_pos.size();
171 assert(num_groups <= max_output_groups);
172
173 // Only choose targets below max_spendable
174 const CAmount target{fuzzed_data_provider.ConsumeIntegralInRange<CAmount>(1, std::max(CAmount{1}, max_spendable - coin_params.m_min_change_target))};
175
176 // Brute force optimal solution
177 CAmount best_amount{MAX_MONEY};
178 int best_weight{std::numeric_limits<int>::max()};
179 for (uint32_t pattern = 1; (pattern >> num_groups) == 0; ++pattern) {
180 CAmount subset_amount{0};
181 int subset_weight{0};
182 for (unsigned i = 0; i < num_groups; ++i) {
183 if ((pattern >> i) & 1) {
184 subset_amount += group_pos[i].GetSelectionAmount();
185 subset_weight += group_pos[i].m_weight;
186 }
187 }
188 if ((subset_amount >= target + coin_params.m_min_change_target) && (subset_weight < best_weight || (subset_weight == best_weight && subset_amount < best_amount))) {
189 best_weight = subset_weight;
190 best_amount = subset_amount;
191 }
192 }
193
194 if (best_weight < std::numeric_limits<int>::max()) {
195 // Sufficient funds and acceptable weight: CoinGrinder should find at least one solution
196 int high_max_selection_weight = fuzzed_data_provider.ConsumeIntegralInRange<int>(best_weight, std::numeric_limits<int>::max());
197
198 auto result_cg = CoinGrinder(group_pos, target, coin_params.m_min_change_target, high_max_selection_weight);
199 assert(result_cg);
200 assert(result_cg->GetWeight() <= high_max_selection_weight);
201 assert(result_cg->GetSelectedEffectiveValue() >= target + coin_params.m_min_change_target);
202 assert(best_weight < result_cg->GetWeight() || (best_weight == result_cg->GetWeight() && best_amount <= result_cg->GetSelectedEffectiveValue()));
203 if (result_cg->GetAlgoCompleted()) {
204 // If CoinGrinder exhausted the search space, it must return the optimal solution
205 assert(best_weight == result_cg->GetWeight());
206 assert(best_amount == result_cg->GetSelectedEffectiveValue());
207 }
208 }
209
210 // CoinGrinder cannot ever find a better solution than the brute-forced best, or there is none in the first place
211 int low_max_selection_weight = fuzzed_data_provider.ConsumeIntegralInRange<int>(0, best_weight - 1);
212 auto result_cg = CoinGrinder(group_pos, target, coin_params.m_min_change_target, low_max_selection_weight);
213 // Max_weight should have been exceeded, or there were insufficient funds
214 assert(!result_cg);
215}
216
217FUZZ_TARGET(bnb_finds_min_waste)
218{
219 FuzzedDataProvider fuzzed_data_provider{buffer.data(), buffer.size()};
220
222 CoinSelectionParams coin_params{fast_random_context};
223 coin_params.m_subtract_fee_outputs = false;
224 // Set effective feerate up to 10'000'000 sats per kvB (10'000 sat/vB).
225 coin_params.m_effective_feerate = CFeeRate{ConsumeMoney(fuzzed_data_provider, 10'000'000), 1'000};
226 coin_params.m_long_term_feerate = CFeeRate{ConsumeMoney(fuzzed_data_provider, 10'000'000), 1'000};
227 coin_params.m_discard_feerate = CFeeRate{ConsumeMoney(fuzzed_data_provider, 10'000'000), 1'000};
228 coin_params.m_cost_of_change = ConsumeMoney(fuzzed_data_provider);
229
230 coin_params.change_output_size = fuzzed_data_provider.ConsumeIntegralInRange(1, MAX_SCRIPT_SIZE);
231 coin_params.m_change_fee = coin_params.m_effective_feerate.GetFee(coin_params.change_output_size);
232 coin_params.change_spend_size = fuzzed_data_provider.ConsumeIntegralInRange<int>(41, 1000);
233 const auto change_spend_fee{coin_params.m_discard_feerate.GetFee(coin_params.change_spend_size)};
234 coin_params.m_cost_of_change = coin_params.m_change_fee + change_spend_fee;
235 CScript change_out_script = CScript() << std::vector<unsigned char>(coin_params.change_output_size, OP_TRUE);
236 const auto dust{GetDustThreshold(CTxOut{/*nValueIn=*/0, change_out_script}, coin_params.m_discard_feerate)};
237 coin_params.min_viable_change = std::max(change_spend_fee + 1, dust);
238
239 // Create some coins
240 CAmount max_spendable{0};
241 int next_locktime{0};
242 // Too many output groups (>17?) would make it possible to generate UTXO
243 // pool and target combinations that cannot be completely searched by BnB
244 // before running into the attempt limit (see BnB "Exhaust..." test). The
245 // brute force search also gets exponentially more expensive with bigger
246 // UTXO pools.
247 // Choose 1–16 of 16 provides ample fuzzing space.
248 static constexpr unsigned max_output_groups{16};
249 std::vector<OutputGroup> group_pos;
250 LIMITED_WHILE (fuzzed_data_provider.ConsumeBool(), max_output_groups) {
251 // With maximum m_effective_feerate 10'000 s/vB and n_input_bytes = 20'000 B, input_fee <= MAX_MONEY.
252 const int n_input_bytes{fuzzed_data_provider.ConsumeIntegralInRange<int>(1, 20'000)};
253 const CAmount input_fee = coin_params.m_effective_feerate.GetFee(n_input_bytes);
254 // Ensure that each UTXO has at least an effective value of 1 sat
255 const CAmount eff_value{fuzzed_data_provider.ConsumeIntegralInRange<CAmount>(1, MAX_MONEY + group_pos.size() - max_spendable - max_output_groups)};
256 const CAmount amount{eff_value + input_fee};
257 std::vector<COutput> temp_utxo_pool;
258
259 AddCoin(amount, /*n_input=*/0, n_input_bytes, ++next_locktime, temp_utxo_pool, coin_params.m_effective_feerate);
260 max_spendable += eff_value;
261
262 auto output_group = OutputGroup(coin_params);
263 output_group.Insert(std::make_shared<COutput>(temp_utxo_pool.at(0)), /*ancestors=*/0, /*cluster_count=*/0);
264 group_pos.push_back(output_group);
265 }
266 size_t num_groups = group_pos.size();
267 assert(num_groups <= max_output_groups);
268
269 // Only choose targets below max_spendable
270 const CAmount target{fuzzed_data_provider.ConsumeIntegralInRange<CAmount>(1, std::max(CAmount{1}, max_spendable - coin_params.m_cost_of_change))};
271
272 // Brute force optimal solution (lowest waste, but cannot be superset of another solution)
273 std::vector<uint32_t> solutions;
274 CAmount best_waste{std::numeric_limits<int64_t>::max()};
275 int best_weight{std::numeric_limits<int>::max()};
276 for (uint32_t pattern = 1; (pattern >> num_groups) == 0; ++pattern) {
277 // BnB does not permit adding more inputs to a solution, i.e. a superset of a solution cannot ever be a solution.
278 // The search pattern guarantees that any superset will only be visited after all its subsets have been traversed.
279 bool is_superset = false;
280 for (uint32_t sol : solutions) {
281 if ((pattern & sol) == sol) {
282 is_superset = true;
283 break;
284 }
285 }
286 if (is_superset) {
287 continue;
288 }
289
290 CAmount subset_amount{0};
291 CAmount subset_waste{0};
292 int subset_weight{0};
293 for (unsigned i = 0; i < num_groups; ++i) {
294 if ((pattern >> i) & 1) {
295 subset_amount += group_pos[i].GetSelectionAmount();
296 subset_waste += group_pos[i].fee - group_pos[i].long_term_fee;
297 subset_weight += group_pos[i].m_weight;
298 }
299 }
300 if (subset_amount >= target && subset_amount <= target + coin_params.m_cost_of_change) {
301 solutions.push_back(pattern);
302 // Add the excess (overselection that gets dropped to fees) to waste score
303 CAmount excess = subset_amount - target;
304 subset_waste += excess;
306
307 for (unsigned i = 0; i < num_groups; ++i) {
308 if ((pattern >> i) & 1) {
309 result_bf.AddInput(group_pos[i]);
310 }
311 }
312 if (subset_waste < best_waste) {
313 best_waste = subset_waste;
314 result_bf.RecalculateWaste(coin_params.min_viable_change, coin_params.m_cost_of_change, coin_params.m_change_fee);
315 assert(result_bf.GetWaste() == best_waste);
316 best_weight = subset_weight;
317 }
318 }
319 }
320
321 int high_max_selection_weight = fuzzed_data_provider.ConsumeIntegralInRange<int>(best_weight, std::numeric_limits<int>::max());
322 auto result_bnb = SelectCoinsBnB(group_pos, target, coin_params.m_cost_of_change, high_max_selection_weight);
323
324 if (!solutions.size() || !result_bnb) {
325 // Either both BnB and Brute Force find a solution or neither does.
326 assert(!result_bnb == !solutions.size());
327 } else {
328 // If brute forcing found a solution with an acceptable weight, BnB must find at least one solution with at most 16 output groups
329 assert(result_bnb);
330 result_bnb->RecalculateWaste(coin_params.min_viable_change, coin_params.m_cost_of_change, coin_params.m_change_fee);
331 assert(result_bnb->GetWeight() <= high_max_selection_weight);
332 assert(result_bnb->GetSelectedEffectiveValue() >= target);
333 assert(result_bnb->GetSelectedEffectiveValue() <= target + coin_params.m_cost_of_change);
334 assert(best_waste <= result_bnb->GetWaste());
335 if (result_bnb->GetAlgoCompleted()) {
336 // If BnB exhausted the search space, it must return an optimal solution (tied on waste score)
337 assert(best_waste == result_bnb->GetWaste());
338 }
339 }
340}
341
343 BNB,
344 SRD,
345 KNAPSACK,
346};
347
348template<CoinSelectionAlgorithm Algorithm>
349void FuzzCoinSelectionAlgorithm(std::span<const uint8_t> buffer) {
351 FuzzedDataProvider fuzzed_data_provider{buffer.data(), buffer.size()};
352 std::vector<COutput> utxo_pool;
353
354 const CFeeRate long_term_fee_rate{ConsumeMoney(fuzzed_data_provider, /*max=*/COIN)};
355 const CFeeRate effective_fee_rate{ConsumeMoney(fuzzed_data_provider, /*max=*/COIN)};
356 // Discard feerate must be at least dust relay feerate
359 const bool subtract_fee_outputs{fuzzed_data_provider.ConsumeBool()};
360
362 CoinSelectionParams coin_params{fast_random_context};
363 coin_params.m_subtract_fee_outputs = subtract_fee_outputs;
364 coin_params.m_long_term_feerate = long_term_fee_rate;
365 coin_params.m_effective_feerate = effective_fee_rate;
366 coin_params.change_output_size = fuzzed_data_provider.ConsumeIntegralInRange(1, MAX_SCRIPT_SIZE);
367 coin_params.m_change_fee = effective_fee_rate.GetFee(coin_params.change_output_size);
368 coin_params.m_discard_feerate = discard_fee_rate;
369 coin_params.change_spend_size = fuzzed_data_provider.ConsumeIntegralInRange<int>(41, 1000);
370 const auto change_spend_fee{coin_params.m_discard_feerate.GetFee(coin_params.change_spend_size)};
371 coin_params.m_cost_of_change = coin_params.m_change_fee + change_spend_fee;
372 CScript change_out_script = CScript() << std::vector<unsigned char>(coin_params.change_output_size, OP_TRUE);
373 const auto dust{GetDustThreshold(CTxOut{/*nValueIn=*/0, change_out_script}, coin_params.m_discard_feerate)};
374 coin_params.min_viable_change = std::max(change_spend_fee + 1, dust);
375
376 int next_locktime{0};
377 CAmount total_balance{CreateCoins(fuzzed_data_provider, utxo_pool, coin_params, next_locktime)};
378
379 std::vector<OutputGroup> group_pos;
380 GroupCoins(fuzzed_data_provider, utxo_pool, coin_params, /*positive_only=*/true, group_pos);
381
382 int max_selection_weight = fuzzed_data_provider.ConsumeIntegralInRange<int>(0, std::numeric_limits<int>::max());
383
384 std::optional<SelectionResult> result;
385
386 if constexpr (Algorithm == CoinSelectionAlgorithm::BNB) {
387 if (!coin_params.m_subtract_fee_outputs) {
388 auto result_bnb = SelectCoinsBnB(group_pos, target, coin_params.m_cost_of_change, max_selection_weight);
389 if (result_bnb) {
390 result = *result_bnb;
391 assert(result_bnb->GetChange(coin_params.min_viable_change, coin_params.m_change_fee) == 0);
392 assert(result_bnb->GetSelectedValue() >= target);
393 assert(result_bnb->GetWeight() <= max_selection_weight);
394 (void)result_bnb->GetShuffledInputVector();
395 (void)result_bnb->GetInputSet();
396 }
397 }
398 }
399
400 if constexpr (Algorithm == CoinSelectionAlgorithm::SRD) {
401 auto result_srd = SelectCoinsSRD(group_pos, target, coin_params.m_change_fee, fast_random_context, max_selection_weight);
402 if (result_srd) {
403 result = *result_srd;
404 assert(result_srd->GetSelectedValue() >= target);
405 assert(result_srd->GetChange(CHANGE_LOWER, coin_params.m_change_fee) > 0);
406 assert(result_srd->GetWeight() <= max_selection_weight);
407 result_srd->SetBumpFeeDiscount(ConsumeMoney(fuzzed_data_provider));
408 result_srd->RecalculateWaste(coin_params.min_viable_change, coin_params.m_cost_of_change, coin_params.m_change_fee);
409 (void)result_srd->GetShuffledInputVector();
410 (void)result_srd->GetInputSet();
411 }
412 }
413
414 if constexpr (Algorithm == CoinSelectionAlgorithm::KNAPSACK) {
415 std::vector<OutputGroup> group_all;
416 GroupCoins(fuzzed_data_provider, utxo_pool, coin_params, /*positive_only=*/false, group_all);
417
418 for (const OutputGroup& group : group_all) {
420 (void)group.EligibleForSpending(filter);
421 }
422
423 CAmount change_target{GenerateChangeTarget(target, coin_params.m_change_fee, fast_random_context)};
424 auto result_knapsack = KnapsackSolver(group_all, target, change_target, fast_random_context, max_selection_weight);
425 // If the total balance is sufficient for the target and we are not using
426 // effective values, Knapsack should always find a solution (unless the selection exceeded the max tx weight).
427 if (total_balance >= target && subtract_fee_outputs && !HasErrorMsg(result_knapsack)) {
428 assert(result_knapsack);
429 }
430 if (result_knapsack) {
431 result = *result_knapsack;
432 assert(result_knapsack->GetSelectedValue() >= target);
433 assert(result_knapsack->GetWeight() <= max_selection_weight);
434 result_knapsack->SetBumpFeeDiscount(ConsumeMoney(fuzzed_data_provider));
435 result_knapsack->RecalculateWaste(coin_params.min_viable_change, coin_params.m_cost_of_change, coin_params.m_change_fee);
436 (void)result_knapsack->GetShuffledInputVector();
437 (void)result_knapsack->GetInputSet();
438 }
439 }
440
441 std::vector<COutput> utxos;
442 CAmount new_total_balance{CreateCoins(fuzzed_data_provider, utxos, coin_params, next_locktime)};
443 if (new_total_balance > 0) {
444 OutputSet new_utxo_pool;
445 for (const auto& utxo : utxos) {
446 new_utxo_pool.insert(std::make_shared<COutput>(utxo));
447 }
448 if (result) {
449 const auto weight{result->GetWeight()};
450 result->AddInputs(new_utxo_pool, subtract_fee_outputs);
451 assert(result->GetWeight() > weight);
452 }
453 }
454
455 std::vector<COutput> manual_inputs;
456 CAmount manual_balance{CreateCoins(fuzzed_data_provider, manual_inputs, coin_params, next_locktime)};
457 if (manual_balance == 0) return;
458 auto manual_selection{ManualSelection(manual_inputs, manual_balance, coin_params.m_subtract_fee_outputs)};
459 if (result) {
460 const CAmount old_target{result->GetTarget()};
461 const OutputSet input_set{result->GetInputSet()};
462 const int old_weight{result->GetWeight()};
463 result->Merge(manual_selection);
464 assert(result->GetInputSet().size() == input_set.size() + manual_inputs.size());
465 assert(result->GetTarget() == old_target + manual_selection.GetTarget());
466 assert(result->GetWeight() == old_weight + manual_selection.GetWeight());
467 }
468}
469
470FUZZ_TARGET(coinselection_bnb) {
471 FuzzCoinSelectionAlgorithm<CoinSelectionAlgorithm::BNB>(buffer);
472}
473
474FUZZ_TARGET(coinselection_srd) {
475 FuzzCoinSelectionAlgorithm<CoinSelectionAlgorithm::SRD>(buffer);
476}
477
478FUZZ_TARGET(coinselection_knapsack) {
479 FuzzCoinSelectionAlgorithm<CoinSelectionAlgorithm::KNAPSACK>(buffer);
480}
481
482} // namespace wallet
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
static constexpr CAmount COIN
The amount of satoshis in one BTC.
Definition: amount.h:15
Fee rate in satoshis per virtualbyte: CAmount / vB the feerate is represented internally as FeeFrac.
Definition: feerate.h:32
An outpoint - a combination of a transaction hash and an index n into its vout.
Definition: transaction.h:29
Serialized script, used inside transaction inputs and outputs.
Definition: script.h:406
An output of a transaction.
Definition: transaction.h:140
Fast randomness source.
Definition: random.h:386
T ConsumeIntegralInRange(T min, T max)
LIMITED_WHILE(provider.remaining_bytes(), 10000)
bilingual_str ErrorString(const Result< T > &result)
Definition: result.h:93
static CAmount CreateCoins(FuzzedDataProvider &fuzzed_data_provider, std::vector< COutput > &utxo_pool, CoinSelectionParams &coin_params, int &next_locktime)
static void AddCoin(const CAmount &value, int n_input, int n_input_bytes, int locktime, std::vector< COutput > &coins, CFeeRate fee_rate)
static constexpr CAmount CHANGE_LOWER
lower bound for randomly-chosen target change amount
Definition: coinselection.h:23
util::Result< SelectionResult > SelectCoinsBnB(std::vector< OutputGroup > &utxo_pool, const CAmount &selection_target, const CAmount &cost_of_change, int max_selection_weight)
util::Result< SelectionResult > CoinGrinder(std::vector< OutputGroup > &utxo_pool, const CAmount &selection_target, CAmount change_target, int max_selection_weight)
std::vector< OutputGroup > & GroupCoins(const std::vector< COutput > &available_coins, bool subtract_fee_outputs=false)
void FuzzCoinSelectionAlgorithm(std::span< const uint8_t > buffer)
std::set< std::shared_ptr< COutput >, OutputPtrComparator > OutputSet
util::Result< SelectionResult > KnapsackSolver(std::vector< OutputGroup > &groups, const CAmount &nTargetValue, CAmount change_target, FastRandomContext &rng, int max_selection_weight)
static SelectionResult ManualSelection(std::vector< COutput > &utxos, const CAmount &total_amount, const bool &subtract_fee_outputs)
FUZZ_TARGET(coin_grinder)
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...
static bool HasErrorMsg(const util::Result< SelectionResult > &res)
Definition: spend.cpp:696
CoinSelectionAlgorithm
util::Result< SelectionResult > SelectCoinsSRD(const std::vector< OutputGroup > &utxo_pool, CAmount target_value, CAmount change_fee, FastRandomContext &rng, int max_selection_weight)
Select coins by Single Random Draw (SRD).
CAmount GetDustThreshold(const CTxOut &txout, const CFeeRate &dustRelayFeeIn)
Definition: policy.cpp:27
static constexpr unsigned int DUST_RELAY_TX_FEE
Min feerate for defining dust.
Definition: policy.h:68
static constexpr int32_t MAX_STANDARD_TX_WEIGHT
The maximum weight for transactions we're willing to relay/mine.
Definition: policy.h:38
static const int MAX_SCRIPT_SIZE
Definition: script.h:41
@ OP_TRUE
Definition: script.h:85
A mutable version of CTransaction.
Definition: transaction.h:358
std::vector< CTxOut > vout
Definition: transaction.h:360
Txid GetHash() const
Compute the hash of this CMutableTransaction.
Definition: transaction.cpp:69
bool empty() const
Definition: translation.h:35
Parameters for filtering which OutputGroups we may use in coin selection.
Parameters for one iteration of Coin Selection.
bool m_subtract_fee_outputs
Indicate that we are subtracting the fee from outputs.
CFeeRate m_effective_feerate
The targeted feerate of the transaction being built.
A group of UTXOs paid to the same output script.
void AddInputs(const OutputSet &inputs, bool subtract_fee_outputs)
void RecalculateWaste(CAmount min_viable_change, CAmount change_cost, CAmount change_fee)
Calculates and stores the waste for this result given the cost of change and the opportunity cost of ...
void AddInput(const OutputGroup &group)
CAmount GetTarget() const
CAmount GetWaste() const
SeedRandomStateForTest(SeedRand::ZEROS)
CAmount ConsumeMoney(FuzzedDataProvider &fuzzed_data_provider, const std::optional< CAmount > &max) noexcept
Definition: util.cpp:29
uint256 ConsumeUInt256(FuzzedDataProvider &fuzzed_data_provider) noexcept
Definition: util.h:195
@ ZEROS
Seed with a compile time constant of zeros.
assert(!tx.IsCoinBase())
FuzzedDataProvider & fuzzed_data_provider
Definition: fees.cpp:39