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.

7,497 bytes · SHA-256 5ae4c4d309a344d8… · View upstream ↗

1// Copyright (c) 2024-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 <coins.h>
6
7#include <boost/test/unit_test.hpp>
8
9#include <list>
10
11BOOST_AUTO_TEST_SUITE(coinscachepair_tests)
12
13static constexpr auto NUM_NODES{4};
14
15std::list<CoinsCachePair> CreatePairs(CoinsCachePair& sentinel)
16{
17    std::list<CoinsCachePair> nodes;
18    for (auto i{0}; i < NUM_NODES; ++i) {
19        nodes.emplace_back();
20
21        auto node{std::prev(nodes.end())};
22        CCoinsCacheEntry::SetDirty(*node, sentinel);
23
24        BOOST_CHECK(node->second.IsDirty());
25        BOOST_CHECK(!node->second.IsFresh());
26        BOOST_CHECK_EQUAL(node->second.Next(), &sentinel);
27        BOOST_CHECK_EQUAL(sentinel.second.Prev(), &(*node));
28
29        if (i > 0) {
30            BOOST_CHECK_EQUAL(std::prev(node)->second.Next(), &(*node));
31            BOOST_CHECK_EQUAL(node->second.Prev(), &(*std::prev(node)));
32        }
33    }
34    return nodes;
35}
36
37BOOST_AUTO_TEST_CASE(linked_list_iteration)
38{
39    CoinsCachePair sentinel;
40    sentinel.second.SelfRef(sentinel);
41    auto nodes{CreatePairs(sentinel)};
42
43    // Check iterating through pairs is identical to iterating through a list
44    auto node{sentinel.second.Next()};
45    for (const auto& expected : nodes) {
46        BOOST_CHECK_EQUAL(&expected, node);
47        node = node->second.Next();
48    }
49    BOOST_CHECK_EQUAL(node, &sentinel);
50
51    // Check iterating through pairs is identical to iterating through a list
52    // Clear the state during iteration
53    node = sentinel.second.Next();
54    for (const auto& expected : nodes) {
55        BOOST_CHECK_EQUAL(&expected, node);
56        auto next = node->second.Next();
57        node->second.SetClean();
58        node = next;
59    }
60    BOOST_CHECK_EQUAL(node, &sentinel);
61    // Check that sentinel's next and prev are itself
62    BOOST_CHECK_EQUAL(sentinel.second.Next(), &sentinel);
63    BOOST_CHECK_EQUAL(sentinel.second.Prev(), &sentinel);
64
65    // Delete the nodes from the list to make sure there are no dangling pointers
66    for (auto it{nodes.begin()}; it != nodes.end(); it = nodes.erase(it)) {
67        BOOST_CHECK(!it->second.IsDirty());
68        BOOST_CHECK(!it->second.IsFresh());
69    }
70}
71
72BOOST_AUTO_TEST_CASE(linked_list_iterate_erase)
73{
74    CoinsCachePair sentinel;
75    sentinel.second.SelfRef(sentinel);
76    auto nodes{CreatePairs(sentinel)};
77
78    // Check iterating through pairs is identical to iterating through a list
79    // Erase the nodes as we iterate through, but don't clear state
80    // The state will be cleared by the CCoinsCacheEntry's destructor
81    auto node{sentinel.second.Next()};
82    for (auto expected{nodes.begin()}; expected != nodes.end(); expected = nodes.erase(expected)) {
83        BOOST_CHECK_EQUAL(&(*expected), node);
84        node = node->second.Next();
85    }
86    BOOST_CHECK_EQUAL(node, &sentinel);
87
88    // Check that sentinel's next and prev are itself
89    BOOST_CHECK_EQUAL(sentinel.second.Next(), &sentinel);
90    BOOST_CHECK_EQUAL(sentinel.second.Prev(), &sentinel);
91}
92
93BOOST_AUTO_TEST_CASE(linked_list_random_deletion)
94{
95    CoinsCachePair sentinel;
96    sentinel.second.SelfRef(sentinel);
97    auto nodes{CreatePairs(sentinel)};
98
99    // Create linked list sentinel->n1->n2->n3->n4->sentinel
100    auto n1{nodes.begin()};
101    auto n2{std::next(n1)};
102    auto n3{std::next(n2)};
103    auto n4{std::next(n3)};
104
105    // Delete n2
106    // sentinel->n1->n3->n4->sentinel
107    nodes.erase(n2);
108    // Check that n1 now points to n3, and n3 still points to n4
109    // Also check that state was not altered
110    BOOST_CHECK(n1->second.IsDirty());
111    BOOST_CHECK(!n1->second.IsFresh());
112    BOOST_CHECK_EQUAL(n1->second.Next(), &(*n3));
113    BOOST_CHECK(n3->second.IsDirty());
114    BOOST_CHECK(!n3->second.IsFresh());
115    BOOST_CHECK_EQUAL(n3->second.Next(), &(*n4));
116    BOOST_CHECK_EQUAL(n3->second.Prev(), &(*n1));
117
118    // Delete n1
119    // sentinel->n3->n4->sentinel
120    nodes.erase(n1);
121    // Check that sentinel now points to n3, and n3 still points to n4
122    // Also check that state was not altered
123    BOOST_CHECK(n3->second.IsDirty());
124    BOOST_CHECK(!n3->second.IsFresh());
125    BOOST_CHECK_EQUAL(sentinel.second.Next(), &(*n3));
126    BOOST_CHECK_EQUAL(n3->second.Next(), &(*n4));
127    BOOST_CHECK_EQUAL(n3->second.Prev(), &sentinel);
128
129    // Delete n4
130    // sentinel->n3->sentinel
131    nodes.erase(n4);
132    // Check that sentinel still points to n3, and n3 points to sentinel
133    // Also check that state was not altered
134    BOOST_CHECK(n3->second.IsDirty());
135    BOOST_CHECK(!n3->second.IsFresh());
136    BOOST_CHECK_EQUAL(sentinel.second.Next(), &(*n3));
137    BOOST_CHECK_EQUAL(n3->second.Next(), &sentinel);
138    BOOST_CHECK_EQUAL(sentinel.second.Prev(), &(*n3));
139
140    // Delete n3
141    // sentinel->sentinel
142    nodes.erase(n3);
143    // Check that sentinel's next and prev are itself
144    BOOST_CHECK_EQUAL(sentinel.second.Next(), &sentinel);
145    BOOST_CHECK_EQUAL(sentinel.second.Prev(), &sentinel);
146}
147
148BOOST_AUTO_TEST_CASE(linked_list_set_state)
149{
150    CoinsCachePair sentinel;
151    sentinel.second.SelfRef(sentinel);
152    CoinsCachePair n1;
153    CoinsCachePair n2;
154
155    // Check that setting DIRTY inserts it into linked list and sets state
156    CCoinsCacheEntry::SetDirty(n1, sentinel);
157    BOOST_CHECK(n1.second.IsDirty());
158    BOOST_CHECK(!n1.second.IsFresh());
159    BOOST_CHECK_EQUAL(n1.second.Next(), &sentinel);
160    BOOST_CHECK_EQUAL(n1.second.Prev(), &sentinel);
161    BOOST_CHECK_EQUAL(sentinel.second.Next(), &n1);
162    BOOST_CHECK_EQUAL(sentinel.second.Prev(), &n1);
163
164    // Check that setting FRESH on new node inserts it after n1
165    CCoinsCacheEntry::SetFresh(n2, sentinel);
166    BOOST_CHECK(n2.second.IsFresh());
167    BOOST_CHECK(!n2.second.IsDirty());
168    BOOST_CHECK_EQUAL(n2.second.Next(), &sentinel);
169    BOOST_CHECK_EQUAL(n2.second.Prev(), &n1);
170    BOOST_CHECK_EQUAL(n1.second.Next(), &n2);
171    BOOST_CHECK_EQUAL(sentinel.second.Prev(), &n2);
172
173    // Check that we can set extra state, but they don't change our position
174    CCoinsCacheEntry::SetFresh(n1, sentinel);
175    BOOST_CHECK(n1.second.IsDirty());
176    BOOST_CHECK(n1.second.IsFresh());
177    BOOST_CHECK_EQUAL(n1.second.Next(), &n2);
178    BOOST_CHECK_EQUAL(n1.second.Prev(), &sentinel);
179    BOOST_CHECK_EQUAL(sentinel.second.Next(), &n1);
180    BOOST_CHECK_EQUAL(n2.second.Prev(), &n1);
181
182    // Check that we can clear state then re-set it
183    n1.second.SetClean();
184    BOOST_CHECK(!n1.second.IsDirty());
185    BOOST_CHECK(!n1.second.IsFresh());
186    BOOST_CHECK_EQUAL(sentinel.second.Next(), &n2);
187    BOOST_CHECK_EQUAL(sentinel.second.Prev(), &n2);
188    BOOST_CHECK_EQUAL(n2.second.Next(), &sentinel);
189    BOOST_CHECK_EQUAL(n2.second.Prev(), &sentinel);
190
191    // Calling `SetClean` a second time has no effect
192    n1.second.SetClean();
193    BOOST_CHECK(!n1.second.IsDirty());
194    BOOST_CHECK(!n1.second.IsFresh());
195    BOOST_CHECK_EQUAL(sentinel.second.Next(), &n2);
196    BOOST_CHECK_EQUAL(sentinel.second.Prev(), &n2);
197    BOOST_CHECK_EQUAL(n2.second.Next(), &sentinel);
198    BOOST_CHECK_EQUAL(n2.second.Prev(), &sentinel);
199
200    // Adding DIRTY re-inserts it after n2
201    CCoinsCacheEntry::SetDirty(n1, sentinel);
202    BOOST_CHECK(n1.second.IsDirty());
203    BOOST_CHECK(!n1.second.IsFresh());
204    BOOST_CHECK_EQUAL(n2.second.Next(), &n1);
205    BOOST_CHECK_EQUAL(n1.second.Prev(), &n2);
206    BOOST_CHECK_EQUAL(n1.second.Next(), &sentinel);
207    BOOST_CHECK_EQUAL(sentinel.second.Prev(), &n1);
208}
209
210BOOST_AUTO_TEST_SUITE_END()
211

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.