READ THE CODE

Inside Bitcoin

The code behind the network, with room to understand it.

Stable release v32.1bitcoin/bitcoin · f0de87f04062 ↗3,020 source files · 47.5 MB stored on the server440 file guides

Release published 2026-10-28 · Snapshot fetched 2026-11-01. Latest stable release at fetch time; development branches and Git history are excluded. Only the selected code window and visible folders load here.

10,570 bytes · SHA-256 73bdad207781b3b7… · View upstream ↗

1// Copyright (c) 2022-present The Bitcoin Core developers
2// Distributed under the MIT software license, see the accompanying
3// file COPYING or https://www.opensource.org/licenses/mit-license.php.
4
5#include <test/util/setup_common.h>
6
7#include <wallet/coinselection.h>
8#include <wallet/spend.h>
9#include <wallet/test/util.h>
10#include <wallet/wallet.h>
11
12#include <boost/test/unit_test.hpp>
13
14namespace wallet {
15BOOST_FIXTURE_TEST_SUITE(group_outputs_tests, TestingSetup)
16
17static int nextLockTime = 0;
18
19static std::shared_ptr<CWallet> NewWallet(const node::NodeContext& m_node)
20{
21    std::unique_ptr<CWallet> wallet = std::make_unique<CWallet>(m_node.chain.get(), "", CreateMockableWalletDatabase());
22    LOCK(wallet->cs_wallet);
23    wallet->SetWalletFlag(WALLET_FLAG_DESCRIPTORS);
24    wallet->SetupDescriptorScriptPubKeyMans();
25    return wallet;
26}
27
28static void addCoin(CoinsResult& coins,
29                     CWallet& wallet,
30                     const CTxDestination& dest,
31                     const CAmount& nValue,
32                     bool is_from_me,
33                     CFeeRate fee_rate = CFeeRate(0),
34                     int depth = 6)
35{
36    CMutableTransaction tx;
37    tx.nLockTime = nextLockTime++;        // so all transactions get different hashes
38    tx.vout.resize(1);
39    tx.vout[0].nValue = nValue;
40    tx.vout[0].scriptPubKey = GetScriptForDestination(dest);
41
42    const auto txid{tx.GetHash()};
43    LOCK(wallet.cs_wallet);
44    auto ret = wallet.mapWallet.emplace(std::piecewise_construct, std::forward_as_tuple(txid), std::forward_as_tuple(MakeTransactionRef(std::move(tx)), TxStateInactive{}));
45    assert(ret.second);
46    CWalletTx& wtx = (*ret.first).second;
47    const auto& txout = wtx.GetTx()->vout.at(0);
48    coins.Add(*Assert(OutputTypeFromDestination(dest)),
49              {COutPoint(wtx.GetHash(), 0),
50                   txout,
51                   depth,
52                   CalculateMaximumSignedInputSize(txout, &wallet, /*coin_control=*/nullptr),
53                   /*solvable=*/ true,
54                   /*safe=*/ true,
55                   wtx.GetTxTime(),
56                   is_from_me,
57                   fee_rate});
58}
59
60 CoinSelectionParams makeSelectionParams(FastRandomContext& rand, bool avoid_partial_spends)
61{
62    return CoinSelectionParams{
63            rand,
64            /*change_output_size=*/ 0,
65            /*change_spend_size=*/ 0,
66            /*min_change_target=*/ CENT,
67            /*effective_feerate=*/ CFeeRate(0),
68            /*long_term_feerate=*/ CFeeRate(0),
69            /*discard_feerate=*/ CFeeRate(0),
70            /*tx_noinputs_size=*/ 0,
71            /*avoid_partial=*/ avoid_partial_spends,
72    };
73}
74
75class GroupVerifier
76{
77public:
78    std::shared_ptr<CWallet> wallet{nullptr};
79    CoinsResult coins_pool;
80    FastRandomContext rand;
81
82    void GroupVerify(const OutputType type,
83                     const CoinEligibilityFilter& filter,
84                     bool avoid_partial_spends,
85                     bool positive_only,
86                     int expected_size)
87    {
88        OutputGroupTypeMap groups = GroupOutputs(*wallet, coins_pool, makeSelectionParams(rand, avoid_partial_spends), {{filter}})[filter];
89        std::vector<OutputGroup>& groups_out = positive_only ? groups.groups_by_type[type].positive_group :
90                                               groups.groups_by_type[type].mixed_group;
91        BOOST_CHECK_EQUAL(groups_out.size(), expected_size);
92    }
93
94    void GroupAndVerify(const OutputType type,
95                        const CoinEligibilityFilter& filter,
96                        int expected_with_partial_spends_size,
97                        int expected_without_partial_spends_size,
98                        bool positive_only)
99    {
100        // First avoid partial spends
101        GroupVerify(type, filter, /*avoid_partial_spends=*/false, positive_only,  expected_with_partial_spends_size);
102        // Second don't avoid partial spends
103        GroupVerify(type, filter, /*avoid_partial_spends=*/true, positive_only, expected_without_partial_spends_size);
104    }
105};
106
107BOOST_AUTO_TEST_CASE(outputs_grouping_tests)
108{
109    const auto& wallet = NewWallet(m_node);
110    GroupVerifier group_verifier;
111    group_verifier.wallet = wallet;
112
113    const CoinEligibilityFilter& BASIC_FILTER{1, 6, 0};
114
115    // #################################################################################
116    // 10 outputs from different txs going to the same script
117    // 1) if partial spends is enabled --> must not be grouped
118    // 2) if partial spends is not enabled --> must be grouped into a single OutputGroup
119    // #################################################################################
120
121    unsigned long GROUP_SIZE = 10;
122    const CTxDestination dest = *Assert(wallet->GetNewDestination(OutputType::BECH32, ""));
123    for (unsigned long i = 0; i < GROUP_SIZE; i++) {
124        addCoin(group_verifier.coins_pool, *wallet, dest, 10 * COIN, /*is_from_me=*/true);
125    }
126
127    group_verifier.GroupAndVerify(OutputType::BECH32,
128                                  BASIC_FILTER,
129                                  /*expected_with_partial_spends_size=*/ GROUP_SIZE,
130                                  /*expected_without_partial_spends_size=*/ 1,
131                                  /*positive_only=*/ true);
132
133    // ####################################################################################
134    // 3) 10 more UTXO are added with a different script --> must be grouped into a single
135    //    group for avoid partial spends and 10 different output groups for partial spends
136    // ####################################################################################
137
138    const CTxDestination dest2 = *Assert(wallet->GetNewDestination(OutputType::BECH32, ""));
139    for (unsigned long i = 0; i < GROUP_SIZE; i++) {
140        addCoin(group_verifier.coins_pool, *wallet, dest2, 5 * COIN, /*is_from_me=*/true);
141    }
142
143    group_verifier.GroupAndVerify(OutputType::BECH32,
144            BASIC_FILTER,
145            /*expected_with_partial_spends_size=*/ GROUP_SIZE * 2,
146            /*expected_without_partial_spends_size=*/ 2,
147            /*positive_only=*/ true);
148
149    // ################################################################################
150    // 4) Now add a negative output --> which will be skipped if "positive_only" is set
151    // ################################################################################
152
153    const CTxDestination dest3 = *Assert(wallet->GetNewDestination(OutputType::BECH32, ""));
154    addCoin(group_verifier.coins_pool, *wallet, dest3, 1, true, CFeeRate(100));
155    BOOST_CHECK(group_verifier.coins_pool.coins[OutputType::BECH32].back().GetEffectiveValue() <= 0);
156
157    // First expect no changes with "positive_only" enabled
158    group_verifier.GroupAndVerify(OutputType::BECH32,
159            BASIC_FILTER,
160            /*expected_with_partial_spends_size=*/ GROUP_SIZE * 2,
161            /*expected_without_partial_spends_size=*/ 2,
162            /*positive_only=*/ true);
163
164    // Then expect changes with "positive_only" disabled
165    group_verifier.GroupAndVerify(OutputType::BECH32,
166            BASIC_FILTER,
167            /*expected_with_partial_spends_size=*/ GROUP_SIZE * 2 + 1,
168            /*expected_without_partial_spends_size=*/ 3,
169            /*positive_only=*/ false);
170
171
172    // ##############################################################################
173    // 5) Try to add a non-eligible UTXO (due not fulfilling the min depth target for
174    //    "not mine" UTXOs) --> it must not be added to any group
175    // ##############################################################################
176
177    const CTxDestination dest4 = *Assert(wallet->GetNewDestination(OutputType::BECH32, ""));
178    addCoin(group_verifier.coins_pool, *wallet, dest4, 6 * COIN,
179            /*is_from_me=*/false, CFeeRate(0), /*depth=*/5);
180
181    // Expect no changes from this round and the previous one (point 4)
182    group_verifier.GroupAndVerify(OutputType::BECH32,
183            BASIC_FILTER,
184            /*expected_with_partial_spends_size=*/ GROUP_SIZE * 2 + 1,
185            /*expected_without_partial_spends_size=*/ 3,
186            /*positive_only=*/ false);
187
188
189    // ##############################################################################
190    // 6) Try to add a non-eligible UTXO (due not fulfilling the min depth target for
191    //    "mine" UTXOs) --> it must not be added to any group
192    // ##############################################################################
193
194    const CTxDestination dest5 = *Assert(wallet->GetNewDestination(OutputType::BECH32, ""));
195    addCoin(group_verifier.coins_pool, *wallet, dest5, 6 * COIN,
196            /*is_from_me=*/true, CFeeRate(0), /*depth=*/0);
197
198    // Expect no changes from this round and the previous one (point 5)
199    group_verifier.GroupAndVerify(OutputType::BECH32,
200            BASIC_FILTER,
201            /*expected_with_partial_spends_size=*/ GROUP_SIZE * 2 + 1,
202            /*expected_without_partial_spends_size=*/ 3,
203            /*positive_only=*/ false);
204
205    // ###########################################################################################
206    // 7) Surpass the OUTPUT_GROUP_MAX_ENTRIES and verify that a second partial group gets created
207    // ###########################################################################################
208
209    const CTxDestination dest7 = *Assert(wallet->GetNewDestination(OutputType::BECH32, ""));
210    uint16_t NUM_SINGLE_ENTRIES = 101;
211    for (unsigned long i = 0; i < NUM_SINGLE_ENTRIES; i++) { // OUTPUT_GROUP_MAX_ENTRIES{100}
212        addCoin(group_verifier.coins_pool, *wallet, dest7, 9 * COIN, /*is_from_me=*/true);
213    }
214
215    // Exclude partial groups only adds one more group to the previous test case (point 6)
216    int PREVIOUS_ROUND_COUNT = GROUP_SIZE * 2 + 1;
217    group_verifier.GroupAndVerify(OutputType::BECH32,
218            BASIC_FILTER,
219            /*expected_with_partial_spends_size=*/ PREVIOUS_ROUND_COUNT + NUM_SINGLE_ENTRIES,
220            /*expected_without_partial_spends_size=*/ 4,
221            /*positive_only=*/ false);
222
223    // Include partial groups should add one more group inside the "avoid partial spends" count
224    const CoinEligibilityFilter& avoid_partial_groups_filter{1, 6, 0, 0, /*include_partial=*/ true};
225    group_verifier.GroupAndVerify(OutputType::BECH32,
226            avoid_partial_groups_filter,
227            /*expected_with_partial_spends_size=*/ PREVIOUS_ROUND_COUNT + NUM_SINGLE_ENTRIES,
228            /*expected_without_partial_spends_size=*/ 5,
229            /*positive_only=*/ false);
230}
231
232BOOST_AUTO_TEST_SUITE_END()
233} // end namespace wallet
234

src/wallet/receive.cpp

src/wallet/coinselection.cpp

src/consensus/validation.h

src/primitives/transaction.cpp

src/script/descriptor.cpp

src/bitcoin-cli.cpp

src/rpc/blockchain.cpp

src/rpc/rawtransaction.cpp

src/init.cpp

src/crypto/sha256.cpp

src/consensus/merkle.h

src/consensus/tx_check.h

src/consensus/tx_verify.h

src/policy/feerate.h

src/policy/feerate.cpp

src/primitives/transaction_identifier.h

src/chainparamsbase.h

src/chainparamsbase.cpp

src/util/moneystr.cpp

src/crypto/ripemd160.h

src/crypto/sha1.h

src/crypto/sha512.h

src/crypto/hmac_sha256.h

src/crypto/hmac_sha512.h

src/crypto/hmac_sha256.cpp

src/crypto/hmac_sha512.cpp

src/crypto/hkdf_sha256_32.h

src/crypto/hkdf_sha256_32.cpp

src/support/cleanse.h

src/support/cleanse.cpp

src/crypto/siphash.cpp

src/crypto/muhash.h

src/crypto/chacha20.h

src/crypto/poly1305.h

src/crypto/chacha20poly1305.h

src/crypto/chacha20poly1305.cpp

src/util/chaintype.cpp

src/util/obfuscation.h

src/util/byte_units.h

src/util/overflow.h

src/blockencodings.cpp

src/net_permissions.cpp

src/policy/packages.cpp

src/policy/rbf.cpp

src/policy/truc_policy.cpp

src/policy/ephemeral_policy.cpp

src/policy/settings.cpp

src/policy/policy.cpp

src/node/transaction.cpp

src/node/coin.cpp

src/rpc/client.cpp

src/rpc/external_signer.cpp

src/rpc/request.cpp

src/rpc/server_util.cpp

src/rpc/fees.cpp

src/rpc/output_script.cpp

src/rpc/rawtransaction_util.cpp

src/rpc/rawtransaction_util.h

src/rpc/register.h

src/rpc/request.h

src/rpc/server_util.h

src/rpc/protocol.h

src/rpc/server.h

src/rpc/signmessage.cpp

src/rpc/txoutproof.cpp

src/rpc/util.cpp

src/rpc/util.h

src/wallet/rpc/addresses.cpp

src/wallet/rpc/backup.cpp

src/wallet/rpc/coins.cpp

src/wallet/rpc/encrypt.cpp

src/wallet/rpc/signmessage.cpp

src/wallet/rpc/util.cpp

src/wallet/rpc/util.h

src/wallet/coincontrol.cpp

src/wallet/coincontrol.h

src/wallet/context.cpp

src/wallet/context.h

src/wallet/crypter.cpp

src/wallet/crypter.h

src/wallet/db.cpp

src/wallet/export.cpp

src/wallet/external_signer_scriptpubkeyman.cpp

src/wallet/rpc/spend.cpp

src/wallet/rpc/transactions.cpp

src/wallet/rpc/wallet.cpp

src/wallet/feebumper.cpp

src/wallet/feebumper.h

src/index/base.h

src/index/base.cpp

src/index/txindex.h

src/index/txindex.cpp

src/index/txindex_key.h

src/index/txospenderindex.h

src/index/txospenderindex.cpp

src/index/blockfilterindex.h

src/index/blockfilterindex.cpp

src/index/coinstatsindex.h

src/index/coinstatsindex.cpp

src/index/db_key.h

src/index/disktxpos.h

src/kernel/chain.cpp

src/kernel/chain.h

src/kernel/checks.cpp

src/kernel/checks.h

src/kernel/context.cpp

src/kernel/context.h

src/kernel/cs_main.cpp

src/kernel/cs_main.h

src/kernel/disconnected_transactions.cpp

src/kernel/disconnected_transactions.h

src/kernel/mempool_removal_reason.cpp

src/kernel/mempool_removal_reason.h

src/kernel/coinstats.cpp

src/kernel/coinstats.h

src/kernel/chainparams.cpp

src/kernel/chainparams.h

src/wallet/sqlite.cpp

src/wallet/sqlite.h

src/wallet/transaction.cpp

src/wallet/transaction.h

src/wallet/dump.cpp

src/wallet/dump.h

src/wallet/init.cpp

src/wallet/walletutil.cpp

src/wallet/walletutil.h

src/wallet/wallettool.cpp

src/wallet/wallettool.h

src/wallet/export.h

src/wallet/migrate.cpp

src/wallet/migrate.h

src/wallet/db.h

src/wallet/walletdb.cpp

src/wallet/interfaces.cpp

src/wallet/scriptpubkeyman.cpp

src/wallet/scriptpubkeyman.h

src/kernel/bitcoinkernel.cpp

src/kernel/bitcoinkernel.h

src/kernel/bitcoinkernel_wrapper.h

src/node/chainstate.cpp

src/node/chainstate.h

src/node/blockstorage.cpp

src/node/blockstorage.h

src/node/mempool_persist.cpp

src/node/mempool_persist.h

src/node/utxo_snapshot.cpp

src/node/utxo_snapshot.h

src/node/kernel_notifications.cpp

src/node/kernel_notifications.h

src/node/blockmanager_args.cpp

src/kernel/blockmanager_opts.h

src/util/expected.cpp

src/policy/settings.h

src/util/types.h

src/kernel/messagestartchars.h

src/kernel/warning.h

src/util/exception.h

src/common/license_info.h

src/node/coins_view_args.h

src/node/database_args.h

src/util/batchpriority.h

src/util/ui_change_type.h

src/node/coins_view_args.cpp

src/node/peerman_args.h

src/util/serfloat.h

src/node/blockmanager_args.h

src/node/database_args.cpp

src/util/overloaded.h

src/interfaces/types.h

src/node/chainstatemanager_args.h

src/node/minisketchwrapper.h

src/util/macros.h

src/util/syserror.h

src/common/run_command.h

src/util/bytevectorhash.cpp

src/node/mempool_persist_args.cpp

src/util/exec.h

src/util/rbf.h

src/crypto/hex_base.h

src/node/mempool_persist_args.h

src/interfaces/echo.h

src/util/any.h

src/util/batchpriority.cpp

src/util/threadnames.h

src/node/coin.h

src/node/mempool_args.h

src/util/asmap.h

src/util/bytevectorhash.h

src/node/context.cpp

src/util/insert.h

src/util/readwritefile.h

src/node/peerman_args.cpp

src/node/interface_ui.cpp

src/interfaces/handler.h

src/node/mining_args.h

src/util/hasher.cpp

src/common/init.h

src/kernel/mempool_limits.h

src/common/system.h

src/crypto/sha3.h

src/util/threadinterrupt.cpp

src/node/protocol_version.h

src/util/exception.cpp

src/common/messages.h

src/node/connection_types.cpp

src/util/bip32.h

src/common/license_info.cpp

src/util/stdmutex.h

src/common/run_command.cpp

src/util/check.cpp

src/util/golombrice.h

src/node/types.h

src/node/timeoffsets.h

src/util/readwritefile.cpp

src/util/fastrange.h

src/util/signalinterrupt.h

src/util/task_runner.h

src/util/syserror.cpp

src/common/interfaces.cpp

src/common/types.h

src/util/threadinterrupt.h

src/kernel/chainstatemanager_opts.h

src/node/psbt.h

src/policy/ephemeral_policy.h

src/util/trace.h

src/common/url.cpp

src/kernel/mempool_options.h

src/util/serfloat.cpp

src/kernel/notifications_interface.h

src/node/timeoffsets.cpp

src/node/warnings.cpp

src/util/hash_type.h

src/crypto/hex_base.cpp

src/node/eviction.h

src/util/tokenbucket.h

src/crypto/aes.h

src/common/pcp.h

src/util/feefrac.cpp

src/node/transaction.h

src/util/threadnames.cpp

src/common/signmessage.h

src/util/exec.cpp

src/util/signalinterrupt.cpp

src/clientversion.cpp

src/common/signmessage.cpp

src/compat/assumptions.h

src/compat/byteswap.h

src/deploymentinfo.cpp

src/deploymentinfo.h

src/deploymentstatus.cpp

src/deploymentstatus.h

src/dummywallet.cpp

src/external_signer.h

src/init/bitcoin-gui.cpp

src/init/bitcoin-node.cpp

src/init/bitcoin-qt.cpp

src/init/bitcoin-wallet.cpp

src/init/bitcoind.cpp

src/init/common.h

src/interfaces/init.h

src/interfaces/ipc.h

src/key_io.h

src/logging/categories.h

src/logging/timer.h

src/mapport.h

src/musig.h

src/net_permissions.h

src/netgroup.h

src/netmessagemaker.h

src/node/chainstatemanager_args.cpp

src/node/connection_types.h

src/node/context.h

src/node/interface_ui.h

src/node/mempool_args.cpp

src/node/mining_args.cpp

src/node/minisketchwrapper.cpp

src/node/txreconciliation.h

src/policy/fees/estimator_args.cpp

src/policy/fees/estimator_args.h

src/policy/fees/estimator_man.cpp

src/policy/fees/estimator_man.h

src/policy/packages.h

src/policy/rbf.h

src/policy/truc_policy.h

src/pow.h

src/primitives/block.cpp

src/randomenv.h

src/rest.h

src/script/keyorigin.h

src/script/parsing.cpp

src/script/parsing.h

src/script/script_error.h

src/script/sigcache.cpp

src/script/sigcache.h

src/script/solver.h

src/script/verify_flags.h

src/semaphore_grant.h

src/signet.h

src/span.h

src/support/allocators/secure.h

src/support/allocators/zeroafterfree.h

src/util/tokenpipe.cpp

src/util/translation.h

src/util/vector.h

src/versionbits.h

src/versionbits_impl.h

src/wallet/external_signer_scriptpubkeyman.h

src/wallet/fees.h

src/wallet/load.h

src/wallet/receive.h

src/wallet/rpc/wallet.h

src/wallet/types.h

src/walletinitinterface.h

src/zmq/zmqabstractnotifier.cpp

Independent explanations by MyBitcoinExplorer. Not affiliated with or endorsed by Bitcoin Core. Guides are educational and do not replace the source or its tests.

Bitcoin Core source © its contributors, distributed under the MIT license. Original notices and bundled third-party licenses are retained in the source tree.