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.

45,288 bytes · SHA-256 f84b52d752a07b2c… · View upstream ↗

1// Copyright (c) 2019-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 <chainparams.h>
6#include <consensus/validation.h>
7#include <kernel/disconnected_transactions.h>
8#include <node/chainstatemanager_args.h>
9#include <node/kernel_notifications.h>
10#include <node/utxo_snapshot.h>
11#include <random.h>
12#include <rpc/blockchain.h>
13#include <sync.h>
14#include <test/util/chainstate.h>
15#include <test/util/common.h>
16#include <test/util/logging.h>
17#include <test/util/random.h>
18#include <test/util/setup_common.h>
19#include <test/util/validation.h>
20#include <uint256.h>
21#include <util/byte_units.h>
22#include <util/result.h>
23#include <util/vector.h>
24#include <validation.h>
25#include <validationinterface.h>
26
27#include <tinyformat.h>
28
29#include <vector>
30
31#include <boost/test/unit_test.hpp>
32
33using node::BlockManager;
34using node::KernelNotifications;
35using node::SnapshotMetadata;
36
37BOOST_FIXTURE_TEST_SUITE(validation_chainstatemanager_tests, TestingSetup)
38
39//! Basic tests for ChainstateManager.
40//!
41//! First create a legacy (IBD) chainstate, then create a snapshot chainstate.
42BOOST_FIXTURE_TEST_CASE(chainstatemanager, TestChain100Setup)
43{
44    ChainstateManager& manager = *m_node.chainman;
45
46    BOOST_CHECK(WITH_LOCK(::cs_main, return !manager.CurrentChainstate().m_from_snapshot_blockhash));
47
48    // Create a legacy (IBD) chainstate.
49    //
50    Chainstate& c1 = manager.ActiveChainstate();
51
52    BOOST_CHECK(WITH_LOCK(::cs_main, return !manager.CurrentChainstate().m_from_snapshot_blockhash));
53    {
54        LOCK(manager.GetMutex());
55        BOOST_CHECK_EQUAL(manager.m_chainstates.size(), 1);
56        BOOST_CHECK_EQUAL(manager.m_chainstates[0].get(), &c1);
57    }
58
59    auto& active_chain = WITH_LOCK(manager.GetMutex(), return manager.ActiveChain());
60    BOOST_CHECK_EQUAL(&active_chain, &c1.m_chain);
61
62    // Get to a valid assumeutxo tip (per chainparams);
63    mineBlocks(10);
64    BOOST_CHECK_EQUAL(WITH_LOCK(manager.GetMutex(), return manager.ActiveHeight()), 110);
65    auto active_tip = WITH_LOCK(manager.GetMutex(), return manager.ActiveTip());
66    auto exp_tip = c1.m_chain.Tip();
67    BOOST_CHECK_EQUAL(active_tip, exp_tip);
68
69    BOOST_CHECK(WITH_LOCK(::cs_main, return !manager.CurrentChainstate().m_from_snapshot_blockhash));
70
71    // Create a snapshot-based chainstate.
72    //
73    const uint256 snapshot_blockhash = active_tip->GetBlockHash();
74    Chainstate& c2{WITH_LOCK(::cs_main, return manager.AddChainstate(std::make_unique<Chainstate>(nullptr, manager.m_blockman, manager, snapshot_blockhash)))};
75    c2.InitCoinsDB(
76        /*cache_size_bytes=*/8_MiB, /*in_memory=*/true, /*should_wipe=*/false);
77    {
78        LOCK(::cs_main);
79        c2.InitCoinsCache(8_MiB);
80        c2.CoinsTip().SetBestBlock(active_tip->GetBlockHash());
81        for (const auto& cs : manager.m_chainstates) {
82            cs->ClearBlockIndexCandidates();
83        }
84        c2.LoadChainTip();
85        for (const auto& cs : manager.m_chainstates) {
86            cs->PopulateBlockIndexCandidates();
87        }
88    }
89    BlockValidationState _;
90    BOOST_CHECK(c2.ActivateBestChain(_, nullptr));
91
92    BOOST_CHECK_EQUAL(WITH_LOCK(::cs_main, return *manager.CurrentChainstate().m_from_snapshot_blockhash), snapshot_blockhash);
93    BOOST_CHECK(WITH_LOCK(::cs_main, return manager.CurrentChainstate().m_assumeutxo == Assumeutxo::UNVALIDATED));
94    BOOST_CHECK_EQUAL(&c2, &manager.ActiveChainstate());
95    BOOST_CHECK(&c1 != &manager.ActiveChainstate());
96    {
97        LOCK(manager.GetMutex());
98        BOOST_CHECK_EQUAL(manager.m_chainstates.size(), 2);
99        BOOST_CHECK_EQUAL(manager.m_chainstates[0].get(), &c1);
100        BOOST_CHECK_EQUAL(manager.m_chainstates[1].get(), &c2);
101    }
102
103    auto& active_chain2 = WITH_LOCK(manager.GetMutex(), return manager.ActiveChain());
104    BOOST_CHECK_EQUAL(&active_chain2, &c2.m_chain);
105
106    BOOST_CHECK_EQUAL(WITH_LOCK(manager.GetMutex(), return manager.ActiveHeight()), 110);
107    mineBlocks(1);
108    BOOST_CHECK_EQUAL(WITH_LOCK(manager.GetMutex(), return manager.ActiveHeight()), 111);
109    BOOST_CHECK_EQUAL(WITH_LOCK(manager.GetMutex(), return c1.m_chain.Height()), 110);
110
111    auto active_tip2 = WITH_LOCK(manager.GetMutex(), return manager.ActiveTip());
112    BOOST_CHECK_EQUAL(active_tip, active_tip2->pprev);
113    BOOST_CHECK_EQUAL(active_tip, c1.m_chain.Tip());
114    BOOST_CHECK_EQUAL(active_tip2, c2.m_chain.Tip());
115
116    // Let scheduler events finish running to avoid accessing memory that is going to be unloaded
117    m_node.validation_signals->SyncWithValidationInterfaceQueue();
118}
119
120BOOST_FIXTURE_TEST_CASE(chainstatemanager_delete_chainstate_no_mempool, ChainTestingSetup)
121{
122    auto& manager{*Assert(m_node.chainman)};
123    auto& validated{WITH_LOCK(::cs_main, return manager.InitializeChainstate(/*mempool=*/nullptr))};
124    auto& snapshot{WITH_LOCK(::cs_main, return manager.AddChainstate(std::make_unique<Chainstate>(nullptr, manager.m_blockman, manager, uint256::ONE)))};
125    WITH_LOCK(::cs_main, validated.SetTargetBlock(nullptr));
126    BOOST_CHECK(WITH_LOCK(::cs_main, return manager.DeleteChainstate(snapshot))); // Accept Kernel's null mempool
127}
128
129//! Test rebalancing the caches associated with each chainstate.
130BOOST_FIXTURE_TEST_CASE(chainstatemanager_rebalance_caches, TestChain100Setup)
131{
132    ChainstateManager& manager = *m_node.chainman;
133
134    size_t max_cache = 10000;
135    manager.m_total_coinsdb_cache = max_cache;
136    manager.m_total_coinstip_cache = max_cache;
137
138    std::vector<Chainstate*> chainstates;
139
140    // Create a legacy (IBD) chainstate.
141    //
142    Chainstate& c1 = manager.ActiveChainstate();
143    chainstates.push_back(&c1);
144    {
145        LOCK(::cs_main);
146        c1.InitCoinsCache(8_MiB);
147        manager.MaybeRebalanceCaches();
148    }
149
150    BOOST_CHECK_EQUAL(c1.m_coinstip_cache_size_bytes, max_cache);
151    BOOST_CHECK_EQUAL(c1.m_coinsdb_cache_size_bytes, max_cache);
152
153    // Create a snapshot-based chainstate.
154    //
155    CBlockIndex* snapshot_base{WITH_LOCK(manager.GetMutex(), return manager.ActiveChain()[manager.ActiveChain().Height() / 2])};
156    Chainstate& c2{WITH_LOCK(::cs_main, return manager.AddChainstate(std::make_unique<Chainstate>(nullptr, manager.m_blockman, manager, *snapshot_base->phashBlock)))};
157    chainstates.push_back(&c2);
158    c2.InitCoinsDB(
159        /*cache_size_bytes=*/8_MiB, /*in_memory=*/true, /*should_wipe=*/false);
160
161    // Reset IBD state so IsInitialBlockDownload() returns true and causes
162    // MaybeRebalanceCaches() to prioritize the snapshot chainstate, giving it
163    // more cache space than the snapshot chainstate. Calling ResetIbd() is
164    // necessary because m_cached_is_ibd is already latched to false before
165    // the test starts due to the test setup. After ResetIbd() is called,
166    // IsInitialBlockDownload() will return true because at this point the active
167    // chainstate has a null chain tip.
168    static_cast<TestChainstateManager&>(manager).ResetIbd();
169
170    {
171        LOCK(::cs_main);
172        c2.InitCoinsCache(8_MiB);
173        manager.MaybeRebalanceCaches();
174    }
175
176    BOOST_CHECK_EQUAL(c1.m_coinstip_cache_size_bytes, size_t(max_cache * 0.05));
177    BOOST_CHECK_EQUAL(c1.m_coinsdb_cache_size_bytes, size_t(max_cache * 0.05));
178    BOOST_CHECK_EQUAL(c2.m_coinstip_cache_size_bytes, size_t(max_cache * 0.95));
179    BOOST_CHECK_EQUAL(c2.m_coinsdb_cache_size_bytes, size_t(max_cache * 0.95));
180}
181
182BOOST_FIXTURE_TEST_CASE(chainstatemanager_ibd_exit_after_loading_blocks, ChainTestingSetup)
183{
184    CBlockIndex tip;
185    ChainstateManager& chainman{*Assert(m_node.chainman)};
186    auto apply{[&](bool cached_is_ibd, bool loading_blocks, bool tip_exists, bool enough_work, bool tip_recent) {
187        LOCK(::cs_main);
188        chainman.ResetChainstates();
189        chainman.InitializeChainstate(m_node.mempool.get());
190
191        const auto recent_time{Now<NodeSeconds>() - chainman.m_options.max_tip_age};
192
193        chainman.m_cached_is_ibd.store(cached_is_ibd, std::memory_order_relaxed);
194        chainman.m_blockman.m_importing = loading_blocks;
195        if (tip_exists) {
196            tip.nChainWork = chainman.MinimumChainWork() - (enough_work ? 0 : 1);
197            tip.nTime = (recent_time - (tip_recent ? 0h : 100h)).time_since_epoch().count();
198            chainman.ActiveChain().SetTip(tip);
199        } else {
200            assert(!chainman.ActiveChain().Tip());
201        }
202        chainman.UpdateIBDStatus();
203    }};
204
205    for (const bool cached_is_ibd : {false, true}) {
206        for (const bool loading_blocks : {false, true}) {
207            for (const bool tip_exists : {false, true}) {
208                for (const bool enough_work : {false, true}) {
209                    for (const bool tip_recent : {false, true}) {
210                        apply(cached_is_ibd, loading_blocks, tip_exists, enough_work, tip_recent);
211                        const bool expected_ibd = cached_is_ibd && (loading_blocks || !tip_exists || !enough_work || !tip_recent);
212                        BOOST_CHECK_EQUAL(chainman.IsInitialBlockDownload(), expected_ibd);
213                    }
214                }
215            }
216        }
217    }
218}
219
220struct SnapshotTestSetup : TestChain100Setup {
221    // Run with coinsdb on the filesystem to support, e.g., moving invalidated
222    // chainstate dirs to "*_invalid".
223    //
224    // Note that this means the tests run considerably slower than in-memory DB
225    // tests, but we can't otherwise test this functionality since it relies on
226    // destructive filesystem operations.
227    SnapshotTestSetup() : TestChain100Setup{
228                              {},
229                              {
230                                  .coins_db_in_memory = false,
231                                  .block_tree_db_in_memory = false,
232                              },
233                          }
234    {
235    }
236
237    std::tuple<Chainstate*, Chainstate*> SetupSnapshot()
238    {
239        ChainstateManager& chainman = *Assert(m_node.chainman);
240
241        {
242            LOCK(::cs_main);
243            BOOST_CHECK(!chainman.CurrentChainstate().m_from_snapshot_blockhash);
244            BOOST_CHECK(!node::FindAssumeutxoChainstateDir(chainman.m_options.datadir));
245        }
246
247        size_t initial_size;
248        size_t initial_total_coins{100};
249
250        // Make some initial assertions about the contents of the chainstate.

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.