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.

5,904 bytes · SHA-256 7aaae2882c788860… · View upstream ↗

1// Copyright (c) 2021-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#ifndef BITCOIN_TEST_UTIL_CHAINSTATE_H
6#define BITCOIN_TEST_UTIL_CHAINSTATE_H
7
8#include <clientversion.h>
9#include <node/context.h>
10#include <node/utxo_snapshot.h>
11#include <rpc/blockchain.h>
12#include <test/util/setup_common.h>
13#include <util/byte_units.h>
14#include <util/fs.h>
15#include <util/log.h>
16#include <validation.h>
17
18#include <univalue.h>
19
20inline constexpr auto NoMalleation = [](AutoFile& file, node::SnapshotMetadata& meta){};
21
22/**
23 * Create and activate a UTXO snapshot, optionally providing a function to
24 * malleate the snapshot.
25 *
26 * If `reset_chainstate` is true, reset the original chainstate back to the genesis
27 * block. This allows us to simulate more realistic conditions in which a snapshot is
28 * loaded into an otherwise mostly-uninitialized datadir. It also allows us to test
29 * conditions that would otherwise cause shutdowns based on the IBD chainstate going
30 * past the snapshot it generated.
31 */
32template<typename F = decltype(NoMalleation)>
33static bool
34CreateAndActivateUTXOSnapshot(
35    TestingSetup* fixture,
36    F malleation = NoMalleation,
37    bool reset_chainstate = false,
38    bool in_memory_chainstate = false)
39{
40    node::NodeContext& node = fixture->m_node;
41    fs::path root = fixture->m_path_root;
42
43    // Write out a snapshot to the test's tempdir.
44    //
45    int height;
46    WITH_LOCK(::cs_main, height = node.chainman->ActiveHeight());
47    fs::path snapshot_path = root / fs::u8path(tfm::format("test_snapshot.%d.dat", height));
48    FILE* outfile{fsbridge::fopen(snapshot_path, "wb")};
49    AutoFile auto_outfile{outfile};
50
51    UniValue result = CreateUTXOSnapshot(node,
52                                         node.chainman->ActiveChainstate(),
53                                         std::move(auto_outfile), // Will close auto_outfile.
54                                         snapshot_path,
55                                         snapshot_path);
56    LogInfo("Wrote UTXO snapshot to %s: %s",
57            fs::PathToString(snapshot_path.make_preferred()), result.write());
58
59    // Read the written snapshot in and then activate it.
60    //
61    FILE* infile{fsbridge::fopen(snapshot_path, "rb")};
62    AutoFile auto_infile{infile};
63    node::SnapshotMetadata metadata{node.chainman->GetParams().MessageStart()};
64    auto_infile >> metadata;
65
66    malleation(auto_infile, metadata);
67
68    if (reset_chainstate) {
69        {
70            // What follows is code to selectively reset chainstate data without
71            // disturbing the existing BlockManager instance, which is needed to
72            // recognize the headers chain previously generated by the chainstate we're
73            // removing. Without those headers, we can't activate the snapshot below.
74            //
75            // This is a stripped-down version of node::LoadChainstate which
76            // preserves the block index.
77            LOCK(::cs_main);
78            CBlockIndex *orig_tip = node.chainman->ActiveChainstate().m_chain.Tip();
79            uint256 gen_hash = node.chainman->ActiveChainstate().m_chain[0]->GetBlockHash();
80            node.chainman->ResetChainstates();
81            node.chainman->InitializeChainstate(node.mempool.get());
82            Chainstate& chain = node.chainman->ActiveChainstate();
83            Assert(node.chainman->LoadGenesisBlock());
84            // These cache values will be corrected shortly in `MaybeRebalanceCaches`.
85            chain.InitCoinsDB(1_MiB, /*in_memory=*/true, /*should_wipe=*/false);
86            chain.InitCoinsCache(1_MiB);
87            chain.CoinsTip().SetBestBlock(gen_hash);
88            chain.LoadChainTip();
89            node.chainman->MaybeRebalanceCaches();
90
91            // Reset the HAVE_DATA flags below the snapshot height, simulating
92            // never-having-downloaded them in the first place.
93            // TODO: perhaps we could improve this by using pruning to delete
94            // these blocks instead
95            CBlockIndex *pindex = orig_tip;
96            while (pindex && pindex != chain.m_chain.Tip()) {
97                // Remove all data and validity flags by just setting
98                // BLOCK_VALID_TREE. Also reset transaction counts and sequence
99                // ids that are set when blocks are received, to make test setup
100                // more realistic and satisfy consistency checks in
101                // CheckBlockIndex().
102                assert(pindex->IsValid(BlockStatus::BLOCK_VALID_TREE));
103                pindex->nStatus = BlockStatus::BLOCK_VALID_TREE;
104                pindex->nTx = 0;
105                pindex->m_chain_tx_count = 0;
106                pindex->nSequenceId = 0;
107                pindex = pindex->pprev;
108            }
109            chain.PopulateBlockIndexCandidates();
110        }
111        BlockValidationState state;
112        if (!node.chainman->ActiveChainstate().ActivateBestChain(state)) {
113            throw std::runtime_error(strprintf("ActivateBestChain failed. (%s)", state.ToString()));
114        }
115        Assert(
116            0 == WITH_LOCK(node.chainman->GetMutex(), return node.chainman->ActiveHeight()));
117    }
118
119    auto& new_active = node.chainman->ActiveChainstate();
120    auto* tip = new_active.m_chain.Tip();
121
122    // Disconnect a block so that the snapshot chainstate will be ahead, otherwise
123    // it will refuse to activate.
124    //
125    // TODO this is a unittest-specific hack, and we should probably rethink how to
126    // better generate/activate snapshots in unittests.
127    if (tip->pprev) {
128        new_active.m_chain.SetTip(*(tip->pprev));
129    }
130
131    auto res = node.chainman->ActivateSnapshot(auto_infile, metadata, in_memory_chainstate);
132
133    // Restore the old tip.
134    new_active.m_chain.SetTip(*tip);
135    return !!res;
136}
137
138
139#endif // BITCOIN_TEST_UTIL_CHAINSTATE_H
140

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.