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.

13,913 bytes · SHA-256 d6e88ba8a429c377… · View upstream ↗

1// Copyright (c) 2022-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 <chain.h>
6#include <chainparams.h>
7#include <clientversion.h>
8#include <node/blockstorage.h>
9#include <node/context.h>
10#include <node/kernel_notifications.h>
11#include <script/solver.h>
12#include <primitives/block.h>
13#include <util/chaintype.h>
14#include <validation.h>
15
16#include <boost/test/unit_test.hpp>
17#include <test/util/common.h>
18#include <test/util/logging.h>
19#include <test/util/setup_common.h>
20
21using kernel::CBlockFileInfo;
22using node::STORAGE_HEADER_BYTES;
23using node::BlockManager;
24using node::KernelNotifications;
25using node::MAX_BLOCKFILE_SIZE;
26
27// use BasicTestingSetup here for the data directory configuration, setup, and cleanup
28BOOST_FIXTURE_TEST_SUITE(blockmanager_tests, BasicTestingSetup)
29
30BOOST_AUTO_TEST_CASE(blockmanager_find_block_pos)
31{
32    const auto params {CreateChainParams(ArgsManager{}, ChainType::MAIN)};
33    KernelNotifications notifications{Assert(m_node.shutdown_request), m_node.exit_status, *Assert(m_node.warnings)};
34    const BlockManager::Options blockman_opts{
35        .chainparams = *params,
36        .blocks_dir = m_args.GetBlocksDirPath(),
37        .notifications = notifications,
38        .block_tree_db_params = DBParams{
39            .path = m_args.GetDataDirNet() / "blocks" / "index",
40            .cache_bytes = 0,
41        },
42    };
43    BlockManager blockman{*Assert(m_node.shutdown_signal), blockman_opts};
44    // simulate adding a genesis block normally
45    LOCK(::cs_main);
46    BOOST_CHECK_EQUAL(blockman.WriteBlock(params->GenesisBlock(), 0).nPos, STORAGE_HEADER_BYTES);
47    // simulate what happens during reindex
48    // simulate a well-formed genesis block being found at offset 8 in the blk00000.dat file
49    // the block is found at offset 8 because there is an 8 byte serialization header
50    // consisting of 4 magic bytes + 4 length bytes before each block in a well-formed blk file.
51    const FlatFilePos pos{0, STORAGE_HEADER_BYTES};
52    blockman.UpdateBlockInfo(params->GenesisBlock(), 0, pos);
53    // now simulate what happens after reindex for the first new block processed
54    // the actual block contents don't matter, just that it's a block.
55    // verify that the write position is at offset 0x12d.
56    // this is a check to make sure that https://github.com/bitcoin/bitcoin/issues/21379 does not recur
57    // 8 bytes (for serialization header) + 285 (for serialized genesis block) = 293
58    // add another 8 bytes for the second block's serialization header and we get 293 + 8 = 301
59    FlatFilePos actual{blockman.WriteBlock(params->GenesisBlock(), 1)};
60    BOOST_CHECK_EQUAL(actual.nPos, STORAGE_HEADER_BYTES + ::GetSerializeSize(TX_WITH_WITNESS(params->GenesisBlock())) + STORAGE_HEADER_BYTES);
61}
62
63BOOST_FIXTURE_TEST_CASE(blockmanager_scan_unlink_already_pruned_files, TestChain100Setup)
64{
65    // Cap last block file size, and mine new block in a new block file.
66    auto& chainman{*Assert(m_node.chainman)};
67    auto& blockman{chainman.m_blockman};
68    const CBlockIndex* old_tip{WITH_LOCK(chainman.GetMutex(), return chainman.ActiveChain().Tip())};
69    WITH_LOCK(chainman.GetMutex(), blockman.GetBlockFileInfo(old_tip->GetBlockPos().nFile)->nSize = MAX_BLOCKFILE_SIZE);
70    CreateAndProcessBlock({}, GetScriptForRawPubKey(coinbaseKey.GetPubKey()));
71
72    // Prune the older block file, but don't unlink it
73    int file_number;
74    {
75        LOCK(chainman.GetMutex());
76        file_number = old_tip->GetBlockPos().nFile;
77        blockman.PruneOneBlockFile(file_number);
78    }
79
80    const FlatFilePos pos(file_number, 0);
81
82    // Check that the file is not unlinked after ScanAndUnlinkAlreadyPrunedFiles
83    // if m_have_pruned is not yet set
84    WITH_LOCK(chainman.GetMutex(), blockman.ScanAndUnlinkAlreadyPrunedFiles());
85    BOOST_CHECK(!blockman.OpenBlockFile(pos, true).IsNull());
86
87    // Check that the file is unlinked after ScanAndUnlinkAlreadyPrunedFiles
88    // once m_have_pruned is set
89    blockman.m_have_pruned = true;
90    WITH_LOCK(chainman.GetMutex(), blockman.ScanAndUnlinkAlreadyPrunedFiles());
91    BOOST_CHECK(blockman.OpenBlockFile(pos, true).IsNull());
92
93    // Check that calling with already pruned files doesn't cause an error
94    WITH_LOCK(chainman.GetMutex(), blockman.ScanAndUnlinkAlreadyPrunedFiles());
95
96    // Check that the new tip file has not been removed
97    const CBlockIndex* new_tip{WITH_LOCK(chainman.GetMutex(), return chainman.ActiveChain().Tip())};
98    BOOST_CHECK_NE(old_tip, new_tip);
99    const int new_file_number{WITH_LOCK(chainman.GetMutex(), return new_tip->GetBlockPos().nFile)};
100    const FlatFilePos new_pos(new_file_number, 0);
101    BOOST_CHECK(!blockman.OpenBlockFile(new_pos, true).IsNull());
102}
103
104BOOST_FIXTURE_TEST_CASE(blockmanager_block_data_availability, TestChain100Setup)
105{
106    // The goal of the function is to return the first not pruned block in the range [upper_block, lower_block].
107    LOCK(::cs_main);
108    auto& chainman = m_node.chainman;
109    auto& blockman = chainman->m_blockman;
110    const CBlockIndex& tip = *chainman->ActiveTip();
111
112    // Function to prune all blocks from 'last_pruned_block' down to the genesis block
113    const auto& func_prune_blocks = [&](CBlockIndex* last_pruned_block)
114    {
115        LOCK(::cs_main);
116        CBlockIndex* it = last_pruned_block;
117        while (it != nullptr && it->nStatus & BLOCK_HAVE_DATA) {
118            it->nStatus &= ~BLOCK_HAVE_DATA;
119            it = it->pprev;
120        }
121    };
122
123    // 1) Return genesis block when all blocks are available
124    BOOST_CHECK_EQUAL(&blockman.GetFirstBlock(tip, BLOCK_HAVE_DATA), chainman->ActiveChain()[0]);
125    BOOST_CHECK(blockman.CheckBlockDataAvailability(tip, *chainman->ActiveChain()[0]));
126
127    // 2) Check lower_block when all blocks are available
128    CBlockIndex* lower_block = chainman->ActiveChain()[tip.nHeight / 2];
129    BOOST_CHECK(blockman.CheckBlockDataAvailability(tip, *lower_block));
130
131    // Ensure we don't fail due to the expected absence of undo data in the genesis block
132    CBlockIndex* upper_block = chainman->ActiveChain()[2];
133    CBlockIndex* genesis = chainman->ActiveChain()[0];
134    BOOST_CHECK(blockman.CheckBlockDataAvailability(*upper_block, *genesis, BlockStatus{BLOCK_HAVE_DATA | BLOCK_HAVE_UNDO}));
135    // Ensure we detect absence of undo data in the first block
136    chainman->ActiveChain()[1]->nStatus &= ~BLOCK_HAVE_UNDO;
137    BOOST_CHECK(!blockman.CheckBlockDataAvailability(tip, *genesis, BlockStatus{BLOCK_HAVE_DATA | BLOCK_HAVE_UNDO}));
138
139    // Prune half of the blocks
140    int height_to_prune = tip.nHeight / 2;
141    CBlockIndex* first_available_block = chainman->ActiveChain()[height_to_prune + 1];
142    CBlockIndex* last_pruned_block = first_available_block->pprev;
143    func_prune_blocks(last_pruned_block);
144
145    // 3) The last block not pruned is in-between upper-block and the genesis block
146    BOOST_CHECK_EQUAL(&blockman.GetFirstBlock(tip, BLOCK_HAVE_DATA), first_available_block);
147    BOOST_CHECK(blockman.CheckBlockDataAvailability(tip, *first_available_block));
148    BOOST_CHECK(!blockman.CheckBlockDataAvailability(tip, *last_pruned_block));
149
150    // Simulate that the first available block is missing undo data and
151    // detect this by using a status mask.
152    first_available_block->nStatus &= ~BLOCK_HAVE_UNDO;
153    BOOST_CHECK(!blockman.CheckBlockDataAvailability(tip, *first_available_block, BlockStatus{BLOCK_HAVE_DATA | BLOCK_HAVE_UNDO}));
154    BOOST_CHECK(blockman.CheckBlockDataAvailability(tip, *first_available_block, BlockStatus{BLOCK_HAVE_DATA}));
155}
156
157BOOST_FIXTURE_TEST_CASE(blockmanager_block_data_part, TestChain100Setup)
158{
159    LOCK(::cs_main);
160    auto& chainman{m_node.chainman};
161    auto& blockman{chainman->m_blockman};
162    const CBlockIndex& tip{*chainman->ActiveTip()};
163    const FlatFilePos tip_block_pos{tip.GetBlockPos()};
164
165    auto block{blockman.ReadRawBlock(tip_block_pos)};
166    BOOST_REQUIRE(block);
167    BOOST_REQUIRE_GE(block->size(), 200);
168
169    const auto expect_part{[&](size_t offset, size_t size) {
170        auto res{blockman.ReadRawBlock(tip_block_pos, std::pair{offset, size})};
171        BOOST_CHECK(res);
172        const auto& part{res.value()};
173        BOOST_CHECK_EQUAL_COLLECTIONS(part.begin(), part.end(), block->begin() + offset, block->begin() + offset + size);
174    }};
175
176    expect_part(0, 20);
177    expect_part(0, block->size() - 1);
178    expect_part(0, block->size() - 10);
179    expect_part(0, block->size());
180    expect_part(1, block->size() - 1);
181    expect_part(10, 20);
182    expect_part(block->size() - 1, 1);
183}
184
185BOOST_FIXTURE_TEST_CASE(blockmanager_block_data_part_error, TestChain100Setup)
186{
187    LOCK(::cs_main);
188    auto& chainman{m_node.chainman};
189    auto& blockman{chainman->m_blockman};
190    const CBlockIndex& tip{*chainman->ActiveTip()};
191    const FlatFilePos tip_block_pos{tip.GetBlockPos()};
192
193    auto block{blockman.ReadRawBlock(tip_block_pos)};
194    BOOST_REQUIRE(block);
195    BOOST_REQUIRE_GE(block->size(), 200);
196
197    const auto expect_part_error{[&](size_t offset, size_t size) {
198        auto res{blockman.ReadRawBlock(tip_block_pos, std::pair{offset, size})};
199        BOOST_CHECK(!res);
200        BOOST_CHECK_EQUAL(res.error(), node::ReadRawError::BadPartRange);
201    }};
202
203    expect_part_error(0, 0);
204    expect_part_error(0, block->size() + 1);
205    expect_part_error(0, std::numeric_limits<size_t>::max());
206    expect_part_error(1, block->size());
207    expect_part_error(2, block->size() - 1);
208    expect_part_error(block->size() - 1, 2);
209    expect_part_error(block->size() - 2, 3);
210    expect_part_error(block->size() + 1, 0);
211    expect_part_error(block->size() + 1, 1);
212    expect_part_error(block->size() + 2, 2);
213    expect_part_error(block->size(), 0);
214    expect_part_error(block->size(), 1);
215    expect_part_error(std::numeric_limits<size_t>::max(), 1);
216    expect_part_error(std::numeric_limits<size_t>::max(), std::numeric_limits<size_t>::max());
217}
218
219BOOST_FIXTURE_TEST_CASE(blockmanager_readblock_hash_mismatch, TestingSetup)
220{
221    CBlockIndex index;
222    {
223        LOCK(cs_main);
224        const auto tip{m_node.chainman->ActiveTip()};
225        index.nStatus = tip->nStatus;
226        index.nDataPos = tip->nDataPos;
227        index.phashBlock = &uint256::ONE; // mismatched block hash
228    }
229
230    ASSERT_DEBUG_LOG("GetHash() doesn't match index");
231    CBlock block;
232    BOOST_CHECK(!m_node.chainman->m_blockman.ReadBlock(block, index));
233}
234
235BOOST_AUTO_TEST_CASE(blockmanager_flush_block_file)
236{
237    KernelNotifications notifications{Assert(m_node.shutdown_request), m_node.exit_status, *Assert(m_node.warnings)};
238    node::BlockManager::Options blockman_opts{
239        .chainparams = Params(),
240        .blocks_dir = m_args.GetBlocksDirPath(),
241        .notifications = notifications,
242        .block_tree_db_params = DBParams{
243            .path = m_args.GetDataDirNet() / "blocks" / "index",
244            .cache_bytes = 0,
245        },
246    };
247    BlockManager blockman{*Assert(m_node.shutdown_signal), blockman_opts};
248
249    // Test blocks with no transactions, not even a coinbase
250    CBlock block1;

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.