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.

51,244 bytes · SHA-256 502f951320737128… · View upstream ↗

1// Copyright (c) 2014-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 <addresstype.h>
6#include <clientversion.h>
7#include <coins.h>
8#include <streams.h>
9#include <test/util/coins.h>
10#include <test/util/common.h>
11#include <test/util/poolresourcetester.h>
12#include <test/util/random.h>
13#include <test/util/setup_common.h>
14#include <txdb.h>
15#include <uint256.h>
16#include <undo.h>
17#include <util/byte_units.h>
18#include <util/check.h>
19#include <util/strencodings.h>
20
21#include <map>
22#include <string>
23#include <variant>
24#include <vector>
25
26#include <boost/test/unit_test.hpp>
27
28using namespace util::hex_literals;
29
30int ApplyTxInUndo(Coin&& undo, CCoinsViewCache& view, const COutPoint& out);
31void UpdateCoins(const CTransaction& tx, CCoinsViewCache& inputs, CTxUndo &txundo, int nHeight);
32
33namespace
34{
35
36class CCoinsViewTest : public CoinsViewEmpty
37{
38    FastRandomContext& m_rng;
39    uint256 hashBestBlock_;
40    std::map<COutPoint, Coin> map_;
41
42public:
43    explicit CCoinsViewTest(FastRandomContext& rng) : m_rng{rng} {}
44
45    std::optional<Coin> GetCoin(const COutPoint& outpoint) const override
46    {
47        if (auto it{map_.find(outpoint)}; it != map_.end() && !it->second.IsSpent()) return it->second;
48        return std::nullopt;
49    }
50
51    uint256 GetBestBlock() const override { return hashBestBlock_; }
52
53    void BatchWrite(CoinsViewCacheCursor& cursor, const uint256& block_hash) override
54    {
55        for (auto it{cursor.Begin()}; it != cursor.End(); it = cursor.NextAndMaybeErase(*it)){
56            if (it->second.IsDirty()) {
57                // Same optimization used in CCoinsViewDB is to only write dirty entries.
58                map_[it->first] = it->second.coin;
59                if (it->second.coin.IsSpent() && m_rng.randrange(3) == 0) {
60                    // Randomly delete empty entries on write.
61                    map_.erase(it->first);
62                }
63            }
64        }
65        if (!block_hash.IsNull())
66            hashBestBlock_ = block_hash;
67    }
68};
69
70class CCoinsViewCacheTest : public CCoinsViewCache
71{
72public:
73    explicit CCoinsViewCacheTest(CCoinsView* _base) : CCoinsViewCache(_base) {}
74
75    void SelfTest(bool sanity_check = true) const
76    {
77        // Manually recompute the dynamic usage of the whole data, and compare it.
78        size_t ret = memusage::DynamicUsage(cacheCoins);
79        size_t count = 0;
80        for (const auto& entry : cacheCoins) {
81            ret += entry.second.coin.DynamicMemoryUsage();
82            ++count;
83        }
84        BOOST_CHECK_EQUAL(GetCacheSize(), count);
85        BOOST_CHECK_EQUAL(DynamicMemoryUsage(), ret);
86        if (sanity_check) {
87            SanityCheck();
88        }
89    }
90
91    CCoinsMap& map() const { return cacheCoins; }
92    CoinsCachePair& sentinel() const { return m_sentinel; }
93    size_t& usage() const { return cachedCoinsUsage; }
94    size_t& dirty() const { return m_dirty_count; }
95};
96
97} // namespace
98
99static const unsigned int NUM_SIMULATION_ITERATIONS = 40000;
100
101struct CacheTest : BasicTestingSetup {
102// This is a large randomized insert/remove simulation test on a variable-size
103// stack of caches on top of CCoinsViewTest.
104//
105// It will randomly create/update/delete Coin entries to a tip of caches, with
106// txids picked from a limited list of random 256-bit hashes. Occasionally, a
107// new tip is added to the stack of caches, or the tip is flushed and removed.
108//
109// During the process, booleans are kept to make sure that the randomized
110// operation hits all branches.
111//
112// If fake_best_block is true, assign a random uint256 to mock the recording
113// of best block on flush. This is necessary when using CCoinsViewDB as the base,
114// otherwise we'll hit an assertion in BatchWrite.
115//
116void SimulationTest(CCoinsView* base, bool fake_best_block)
117{
118    // Various coverage trackers.
119    bool removed_all_caches = false;
120    bool reached_4_caches = false;
121    bool added_an_entry = false;
122    bool added_an_unspendable_entry = false;
123    bool removed_an_entry = false;
124    bool updated_an_entry = false;
125    bool found_an_entry = false;
126    bool missed_an_entry = false;
127    bool uncached_an_entry = false;
128    bool flushed_without_erase = false;
129
130    // A simple map to track what we expect the cache stack to represent.
131    std::map<COutPoint, Coin> result;
132
133    // The cache stack.
134    std::vector<std::unique_ptr<CCoinsViewCacheTest>> stack; // A stack of CCoinsViewCaches on top.
135    stack.push_back(std::make_unique<CCoinsViewCacheTest>(base)); // Start with one cache.
136
137    // Use a limited set of random transaction ids, so we do test overwriting entries.
138    std::vector<Txid> txids;
139    txids.resize(NUM_SIMULATION_ITERATIONS / 8);
140    for (unsigned int i = 0; i < txids.size(); i++) {
141        txids[i] = Txid::FromUint256(m_rng.rand256());
142    }
143
144    for (unsigned int i = 0; i < NUM_SIMULATION_ITERATIONS; i++) {
145        // Do a random modification.
146        {
147            auto txid = txids[m_rng.randrange(txids.size())]; // txid we're going to modify in this iteration.
148            Coin& coin = result[COutPoint(txid, 0)];
149
150            // Determine whether to test HaveCoin before or after Access* (or both). As these functions
151            // can influence each other's behaviour by pulling things into the cache, all combinations
152            // are tested.
153            bool test_havecoin_before = m_rng.randbits(2) == 0;
154            bool test_havecoin_after = m_rng.randbits(2) == 0;
155
156            bool result_havecoin = test_havecoin_before ? stack.back()->HaveCoin(COutPoint(txid, 0)) : false;
157
158            // Infrequently, test usage of AccessByTxid instead of AccessCoin - the
159            // former just delegates to the latter and returns the first unspent in a txn.
160            const Coin& entry = (m_rng.randrange(500) == 0) ?
161                AccessByTxid(*stack.back(), txid) : stack.back()->AccessCoin(COutPoint(txid, 0));
162            BOOST_CHECK_EQUAL(coin, entry);
163
164            if (test_havecoin_before) {
165                BOOST_CHECK(result_havecoin == !entry.IsSpent());
166            }
167
168            if (test_havecoin_after) {
169                bool ret = stack.back()->HaveCoin(COutPoint(txid, 0));
170                BOOST_CHECK(ret == !entry.IsSpent());
171            }
172
173            if (m_rng.randrange(5) == 0 || coin.IsSpent()) {
174                Coin newcoin;
175                newcoin.out.nValue = RandMoney(m_rng);
176                newcoin.nHeight = 1;
177
178                // Infrequently test adding unspendable coins.
179                if (m_rng.randrange(16) == 0 && coin.IsSpent()) {
180                    newcoin.out.scriptPubKey.assign(1 + m_rng.randbits(6), OP_RETURN);
181                    BOOST_CHECK(newcoin.out.scriptPubKey.IsUnspendable());
182                    added_an_unspendable_entry = true;
183                } else {
184                    // Random sizes so we can test memory usage accounting
185                    newcoin.out.scriptPubKey.assign(m_rng.randbits(6), 0);
186                    (coin.IsSpent() ? added_an_entry : updated_an_entry) = true;
187                    coin = newcoin;
188                }
189                if (COutPoint op(txid, 0); !stack.back()->map().contains(op) && !newcoin.out.scriptPubKey.IsUnspendable() && m_rng.randbool()) {
190                    stack.back()->EmplaceCoinInternalDANGER(op, std::move(newcoin));
191                } else {
192                    stack.back()->AddCoin(op, std::move(newcoin), /*possible_overwrite=*/!coin.IsSpent() || m_rng.randbool());
193                }
194            } else {
195                // Spend the coin.
196                removed_an_entry = true;
197                coin.Clear();
198                BOOST_CHECK(stack.back()->SpendCoin(COutPoint(txid, 0)));
199            }
200        }
201
202        // Once every 10 iterations, remove a random entry from the cache
203        if (m_rng.randrange(10) == 0) {
204            COutPoint out(txids[m_rng.rand32() % txids.size()], 0);
205            int cacheid = m_rng.rand32() % stack.size();
206            stack[cacheid]->Uncache(out);
207            uncached_an_entry |= !stack[cacheid]->HaveCoinInCache(out);
208        }
209
210        // Once every 1000 iterations and at the end, verify the full cache.
211        if (m_rng.randrange(1000) == 1 || i == NUM_SIMULATION_ITERATIONS - 1) {
212            for (const auto& entry : result) {
213                bool have = stack.back()->HaveCoin(entry.first);
214                const Coin& coin = stack.back()->AccessCoin(entry.first);
215                BOOST_CHECK(have == !coin.IsSpent());
216                BOOST_CHECK_EQUAL(coin, entry.second);
217                if (coin.IsSpent()) {
218                    missed_an_entry = true;
219                } else {
220                    BOOST_CHECK(stack.back()->HaveCoinInCache(entry.first));
221                    found_an_entry = true;
222                }
223            }
224            for (const auto& test : stack) {
225                test->SelfTest();
226            }
227        }
228
229        if (m_rng.randrange(100) == 0) {
230            // Every 100 iterations, flush an intermediate cache
231            if (stack.size() > 1 && m_rng.randbool() == 0) {
232                unsigned int flushIndex = m_rng.randrange(stack.size() - 1);
233                if (fake_best_block) stack[flushIndex]->SetBestBlock(m_rng.rand256());
234                bool should_erase = m_rng.randrange(4) < 3;
235                should_erase ? stack[flushIndex]->Flush() : stack[flushIndex]->Sync();
236                flushed_without_erase |= !should_erase;
237            }
238        }
239        if (m_rng.randrange(100) == 0) {
240            // Every 100 iterations, change the cache stack.
241            if (stack.size() > 0 && m_rng.randbool() == 0) {
242                //Remove the top cache
243                if (fake_best_block) stack.back()->SetBestBlock(m_rng.rand256());
244                bool should_erase = m_rng.randrange(4) < 3;
245                should_erase ? stack.back()->Flush() : stack.back()->Sync();
246                flushed_without_erase |= !should_erase;
247                stack.pop_back();
248            }
249            if (stack.size() == 0 || (stack.size() < 4 && m_rng.randbool())) {
250                //Add a new cache

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.