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,697 bytes · SHA-256 9dcbdce2accc6d0f… · View upstream ↗

1// Copyright (c) 2020-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 <blockfilter.h>
7#include <chain.h>
8#include <chainparams.h>
9#include <coins.h>
10#include <common/args.h>
11#include <consensus/validation.h>
12#include <index/base.h>
13#include <index/blockfilterindex.h>
14#include <index/coinstatsindex.h>
15#include <index/txindex.h>
16#include <index/txospenderindex.h>
17#include <interfaces/chain.h>
18#include <kernel/types.h>
19#include <key.h>
20#include <node/context.h>
21#include <primitives/block.h>
22#include <script/script.h>
23#include <sync.h>
24#include <test/util/mining.h>
25#include <test/util/setup_common.h>
26#include <test/util/time.h>
27#include <test/util/validation.h>
28#include <tinyformat.h>
29#include <util/byte_units.h>
30#include <util/check.h>
31#include <util/fs.h>
32#include <validation.h>
33
34#include <boost/test/unit_test.hpp>
35
36#include <chrono>
37#include <functional>
38#include <future>
39#include <memory>
40#include <string>
41#include <thread>
42#include <utility>
43#include <vector>
44
45using kernel::ChainstateRole;
46
47using IndexFactory = std::function<std::unique_ptr<BaseIndex>(node::NodeContext&)>;
48
49static const std::vector<std::pair<std::string, IndexFactory>> INDEX_FACTORIES{
50    {"coinstatsindex", [](node::NodeContext& node) -> std::unique_ptr<BaseIndex> {
51        return std::make_unique<CoinStatsIndex>(interfaces::MakeChain(node), /*n_cache_size=*/1_MiB); }},
52    {"txindex", [](node::NodeContext& node) -> std::unique_ptr<BaseIndex> {
53        return std::make_unique<TxIndex>(interfaces::MakeChain(node), /*n_cache_size=*/1_MiB); }},
54    {"txospenderindex", [](node::NodeContext& node) -> std::unique_ptr<BaseIndex> {
55        return std::make_unique<TxoSpenderIndex>(interfaces::MakeChain(node), /*n_cache_size=*/1_MiB); }},
56    {"blockfilterindex", [](node::NodeContext& node) -> std::unique_ptr<BaseIndex> {
57        return std::make_unique<BlockFilterIndex>(interfaces::MakeChain(node), BlockFilterType::BASIC, /*n_cache_size=*/1_MiB); }},
58};
59
60// Tests of generic BaseIndex functionality that is independent of which
61// concrete index is being used.
62BOOST_AUTO_TEST_SUITE(baseindex_tests)
63
64// Test that the index does not commit ahead of the chainstate's last
65// flushed block. If it did, a subsequent unclean shutdown would corrupt
66// the index, because during reverting it would require blocks that were
67// never flushed to disk.
68BOOST_FIXTURE_TEST_CASE(baseindex_no_commit_ahead_of_flush, TestChain100Setup)
69{
70    Chainstate& chainstate = Assert(m_node.chainman)->ActiveChainstate();
71    for (const auto& [index_name, make_index] : INDEX_FACTORIES) {
72        BOOST_TEST_INFO_SCOPE(index_name);
73        const int tip_height{WITH_LOCK(cs_main, return m_node.chainman->ActiveChain().Tip()->nHeight)};
74        auto sync_index = [&](bool do_flush, int expected_sync_height, int expected_commit_height) {
75            auto index{make_index(m_node)};
76            BOOST_REQUIRE(index->Init());
77            index->Sync();
78            if (do_flush) {
79                chainstate.ForceFlushStateToDisk();
80                m_node.chain->context()->validation_signals->SyncWithValidationInterfaceQueue();
81            }
82            BOOST_CHECK_EQUAL(index->GetSummary().best_block_height, expected_sync_height);
83            index->Stop();
84            // Reload index to see which block data was actually committed.
85            BOOST_REQUIRE(index->Init());
86            BOOST_CHECK_EQUAL(index->GetSummary().best_block_height, expected_commit_height);
87
88            // Drain in-flight validation callbacks before destroying the index.
89            m_node.chain->context()->validation_signals->SyncWithValidationInterfaceQueue();
90            // shutdown sequence (c.f. Shutdown() in init.cpp)
91            index->Stop();
92        };
93
94        // Part 1: Sync, then "crash" (stop without flushing). Models a node that
95        // started up, had its index catch up, but never flushed before going down.
96        // The end-of-sync Commit() runs at the chain tip but m_last_flushed_block
97        // is null, so it is skipped.
98        sync_index(false, tip_height, 0);
99
100        // Part 2: Restart cleanly. Sync, force a chainstate flush, and drain the
101        // validation queue so the index's ChainStateFlushed callback runs.
102        // Now m_last_flushed_block == tip and the index can commit.
103        sync_index(true, tip_height, tip_height);
104
105        // Part 3: Connect a new block on the chain without flushing
106        // (m_last_flushed_block stays at tip_height). For a real node this would
107        // happen in parallel with Sync(). Here we do it before Sync() to make the
108        // race state deterministic.
109        CreateAndProcessBlock({}, CScript() << OP_TRUE);
110        sync_index(false, tip_height + 1, tip_height);
111    }
112}
113
114// Test shutdown between BlockConnected and ChainStateFlushed notifications,
115// make sure index is not corrupted and reloads at the last committed height.
116BOOST_FIXTURE_TEST_CASE(index_unclean_shutdown, TestChain100Setup)
117{
118    Chainstate& chainstate = Assert(m_node.chainman)->ActiveChainstate();
119    const CChainParams& params = Params();
120    const int tip_height{WITH_LOCK(cs_main, return chainstate.m_chain.Height())};
121    chainstate.ForceFlushStateToDisk();
122    // Drain the notification before registering any index.
123    m_node.chain->context()->validation_signals->SyncWithValidationInterfaceQueue();
124    for (const auto& [index_name, make_index] : INDEX_FACTORIES) {
125        BOOST_TEST_INFO_SCOPE(index_name);
126        {
127            auto index{make_index(m_node)};
128            BOOST_REQUIRE(index->Init());
129            index->Sync();
130            std::shared_ptr<const CBlock> new_block;
131            CBlockIndex* new_block_index = nullptr;
132            {
133                const CScript script_pub_key{CScript() << ToByteVector(coinbaseKey.GetPubKey()) << OP_CHECKSIG};
134                const CBlock block = this->CreateBlock({}, script_pub_key);
135
136                new_block = std::make_shared<CBlock>(block);
137
138                LOCK(cs_main);
139                BlockValidationState state;
140                BOOST_CHECK(CheckBlock(block, state, params.GetConsensus()));
141                BOOST_CHECK(m_node.chainman->AcceptBlock(new_block, state, &new_block_index, true, nullptr, nullptr, true));
142                CCoinsViewCache view(&chainstate.CoinsTip());
143                BOOST_CHECK(chainstate.ConnectBlock(block, state, new_block_index, view));
144            }
145            // Send block connected notification, then stop the index without
146            // sending a chainstate flushed notification. Prior to #24138, this
147            // would cause the index to be corrupted and fail to reload.
148            ValidationInterfaceTest::BlockConnected(ChainstateRole{}, *index, new_block, new_block_index);
149            index->Stop();
150        }
151
152        {
153            auto index{make_index(m_node)};
154            BOOST_REQUIRE(index->Init());
155            // Make sure the index reloads from the pre-crash commit.
156            BOOST_CHECK_EQUAL(index->GetSummary().best_block_height, tip_height);
157            BOOST_REQUIRE(index->StartBackgroundSync());
158            index->Stop();
159        }
160    }
161}
162
163class IndexReorgCrash : public BaseIndex
164{
165private:
166    FakeNodeClock& m_clock;
167    std::unique_ptr<BaseIndex::DB> m_db;
168    std::shared_future<void> m_blocker;
169    int m_blocking_height;
170
171public:
172    explicit IndexReorgCrash(std::unique_ptr<interfaces::Chain> chain, std::shared_future<void> blocker, int blocking_height, FakeNodeClock& clock)
173        : BaseIndex(std::move(chain), "test index", "testidx"), m_clock(clock), m_blocker(blocker), m_blocking_height(blocking_height)
174    {
175        const fs::path path = gArgs.GetDataDirNet() / "index";
176        fs::create_directories(path);
177        m_db = std::make_unique<BaseIndex::DB>(path / "db", /*n_cache_size=*/0, /*f_memory=*/true, /*f_wipe=*/false);
178    }
179
180    bool AllowPrune() const override { return false; }
181    BaseIndex::DB& GetDB() const override { return *m_db; }
182
183    bool CustomAppend(const interfaces::BlockInfo& block) override
184    {
185        // Simulate a delay so new blocks can get connected during the initial sync
186        if (block.height == m_blocking_height) m_blocker.wait();
187
188        // Move mock time forward so the best index gets updated only when we are not at the blocking height
189        if (block.height == m_blocking_height - 1 || block.height > m_blocking_height) {
190            m_clock += 31s;
191        }
192
193        return true;
194    }
195};
196
197BOOST_FIXTURE_TEST_CASE(index_reorg_crash, TestChain100Setup)
198{
199    std::promise<void> promise;
200    std::shared_future<void> blocker(promise.get_future());
201    int blocking_height = WITH_LOCK(cs_main, return m_node.chainman->ActiveChain().Tip()->nHeight);
202
203    IndexReorgCrash index{interfaces::MakeChain(m_node), blocker, blocking_height, m_clock};
204    BOOST_REQUIRE(index.Init());
205    BOOST_REQUIRE(index.StartBackgroundSync());
206
207    auto func_wait_until = [&](int height, std::chrono::milliseconds timeout) {
208        auto deadline = std::chrono::steady_clock::now() + timeout;
209        while (index.GetSummary().best_block_height < height) {
210            if (std::chrono::steady_clock::now() > deadline) {
211                BOOST_FAIL(strprintf("Timeout waiting for index height %d (current: %d)", height, index.GetSummary().best_block_height));
212                return;
213            }
214            std::this_thread::sleep_for(100ms);
215        }
216    };
217
218    // Wait until the index is one block before the fork point
219    func_wait_until(blocking_height - 1, /*timeout=*/5s);
220
221    // Create a fork to trigger the reorg
222    std::vector<std::shared_ptr<CBlock>> fork;
223    const CBlockIndex* prev_tip = WITH_LOCK(cs_main, return m_node.chainman->ActiveChain().Tip()->pprev);
224    BOOST_REQUIRE(BuildChain(m_node, prev_tip, GetScriptForDestination(PKHash(GenerateRandomKey().GetPubKey())), 3, fork));
225
226    for (const auto& block : fork) {
227        BOOST_REQUIRE(m_node.chainman->ProcessNewBlock(block, /*force_processing=*/true, /*min_pow_checked=*/true, nullptr));
228    }
229
230    // The index thread is blocked and not done
231    BOOST_CHECK(!index.GetSummary().synced);
232
233    // Unblock the index thread so it can process the reorg
234    promise.set_value();
235    // Wait for the index to reach the new tip
236    func_wait_until(blocking_height + 2, 5s);
237
238    // Drain unused BlockConnected events, to avoid unsafe memory races during destruction
239    m_node.chain->context()->validation_signals->SyncWithValidationInterfaceQueue();
240    // shutdown sequence (c.f. Shutdown() in init.cpp)
241    index.Stop();
242}
243
244BOOST_AUTO_TEST_SUITE_END()
245

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.