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.

6,527 bytes · SHA-256 22024aa2a0a4e4fb… · View upstream ↗

1// Copyright (c) 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 <boost/test/unit_test.hpp>
6
7#include <chain.h>
8#include <test/util/setup_common.h>
9
10#include <array>
11#include <memory>
12
13BOOST_FIXTURE_TEST_SUITE(chain_tests, BasicTestingSetup)
14
15namespace {
16
17const CBlockIndex* NaiveGetAncestor(const CBlockIndex* a, int height)
18{
19    while (a->nHeight > height) {
20        a = a->pprev;
21    }
22    BOOST_REQUIRE_EQUAL(a->nHeight, height);
23    return a;
24}
25
26const CBlockIndex* NaiveLastCommonAncestor(const CBlockIndex* a, const CBlockIndex* b)
27{
28    while (a->nHeight > b->nHeight) {
29        a = a->pprev;
30    }
31    while (b->nHeight > a->nHeight) {
32        b = b->pprev;
33    }
34    while (a != b) {
35        BOOST_REQUIRE_EQUAL(a->nHeight, b->nHeight);
36        a = a->pprev;
37        b = b->pprev;
38    }
39    BOOST_REQUIRE_EQUAL(a, b);
40    return a;
41}
42
43} // namespace
44
45BOOST_AUTO_TEST_CASE(basic_tests)
46{
47    // An empty chain
48    const CChain chain_0;
49    // A chain with 2 blocks
50    CChain chain_2;
51
52    CBlockIndex genesis;
53    genesis.nHeight = 0;
54    chain_2.SetTip(genesis);
55
56    CBlockIndex bi1;
57    bi1.pprev = &genesis;
58    bi1.nHeight = 1;
59    chain_2.SetTip(bi1);
60
61    BOOST_CHECK_EQUAL(chain_0.Height(), -1);
62    BOOST_CHECK_EQUAL(chain_2.Height(), 1);
63
64    BOOST_CHECK_EQUAL(chain_0.Tip(), nullptr);
65    BOOST_CHECK_EQUAL(chain_2.Tip(), &bi1);
66
67    // Indexer accessor: call with valid and invalid (low & high) values
68    BOOST_CHECK_EQUAL(chain_2[-1], nullptr);
69    BOOST_CHECK_EQUAL(chain_2[0], &genesis);
70    BOOST_CHECK_EQUAL(chain_2[1], &bi1);
71    BOOST_CHECK_EQUAL(chain_2[2], nullptr);
72
73    // Contains: call with contained & non-contained blocks
74    BOOST_CHECK(chain_2.Contains(genesis));
75    BOOST_CHECK(chain_2.Contains(bi1));
76    BOOST_CHECK(!chain_0.Contains(genesis));
77
78    // Call with non-tip & tip blocks
79    BOOST_CHECK_EQUAL(chain_2.Next(genesis), &bi1);
80    BOOST_CHECK_EQUAL(chain_2.Next(bi1), nullptr);
81    BOOST_CHECK_EQUAL(chain_0.Next(genesis), nullptr);
82
83    BOOST_CHECK_EQUAL(chain_2.Genesis(), &genesis);
84    BOOST_CHECK_EQUAL(chain_0.Genesis(), nullptr);
85}
86
87BOOST_AUTO_TEST_CASE(findfork_tests)
88{
89    // Create a forking chain
90    const auto init_branch{[](auto& blocks, CBlockIndex* parent, int start_height) {
91        for (size_t i{0}; i < blocks.size(); ++i) {
92            blocks[i].pprev = i == 0 ? parent : &blocks[i - 1];
93            blocks[i].nHeight = start_height + i;
94        }
95    }};
96
97    const auto check_same{[](const CChain& chain, const auto& blocks) {
98        for (const auto& block : blocks) {
99            BOOST_CHECK_EQUAL(chain.FindFork(block), &block);
100        }
101    }};
102
103    const auto check_fork_point{[](const CChain& chain, const auto& blocks, const CBlockIndex& fork_point) {
104        for (const auto& block : blocks) {
105            BOOST_CHECK_EQUAL(chain.FindFork(block), &fork_point);
106        }
107    }};
108
109    std::array<CBlockIndex, 10> blocks_common;
110    init_branch(blocks_common, nullptr, 0);
111
112    std::array<CBlockIndex, 10> blocks_long;
113    init_branch(blocks_long, &blocks_common.back(), blocks_common.size());
114
115    std::array<CBlockIndex, 5> blocks_short;
116    init_branch(blocks_short, &blocks_common.back(), blocks_common.size());
117
118    // Create a chain with the longer fork
119    CChain chain_long;
120    chain_long.SetTip(blocks_long.back());
121    BOOST_CHECK_EQUAL(chain_long.Height(), 10 + 10 - 1);
122    // Test the blocks in the common part -> result should be the same
123    check_same(chain_long, blocks_common);
124    // Test the blocks on the longer fork -> result should be the same
125    check_same(chain_long, blocks_long);
126    // Test the blocks on the other shorter fork -> result should be the fork point
127    check_fork_point(chain_long, blocks_short, blocks_common.back());
128
129    // Create a chain with the shorter fork
130    CChain chain_short;
131    chain_short.SetTip(blocks_short.back());
132    BOOST_CHECK_EQUAL(chain_short.Height(), 10 + 5 - 1);
133    // Test the blocks in the common part -> result should be the same
134    check_same(chain_short, blocks_common);
135    // Test the blocks on the shorter fork -> result should be the same
136    check_same(chain_short, blocks_short);
137    // Test the blocks on the other longer fork -> result should be the fork point
138    check_fork_point(chain_short, blocks_long, blocks_common.back());
139
140    // Invalid test case. Mixing chains is not supported
141    CBlockIndex block_on_unrelated_chain;
142    BOOST_CHECK_EQUAL(chain_long.FindFork(block_on_unrelated_chain), nullptr);
143}
144
145BOOST_AUTO_TEST_CASE(chain_test)
146{
147    FastRandomContext ctx;
148    std::vector<std::unique_ptr<CBlockIndex>> block_index;
149    // Run 10 iterations of the whole test.
150    for (int i = 0; i < 10; ++i) {
151        block_index.clear();
152        // Create genesis block.
153        auto genesis = std::make_unique<CBlockIndex>();
154        genesis->nHeight = 0;
155        block_index.push_back(std::move(genesis));
156        // Create 10000 more blocks.
157        for (int b = 0; b < 10000; ++b) {
158            auto new_index = std::make_unique<CBlockIndex>();
159            // 95% of blocks build on top of the last block; the others fork off randomly.
160            if (ctx.randrange(20) != 0) {
161                new_index->pprev = block_index.back().get();
162            } else {
163                new_index->pprev = block_index[ctx.randrange(block_index.size())].get();
164            }
165            new_index->nHeight = new_index->pprev->nHeight + 1;
166            new_index->BuildSkip();
167            block_index.push_back(std::move(new_index));
168        }
169        // Run 10000 random GetAncestor queries.
170        for (int q = 0; q < 10000; ++q) {
171            const CBlockIndex* block = block_index[ctx.randrange(block_index.size())].get();
172            unsigned height = ctx.randrange<unsigned>(block->nHeight + 1);
173            const CBlockIndex* result = block->GetAncestor(height);
174            BOOST_CHECK(result == NaiveGetAncestor(block, height));
175        }
176        // Run 10000 random LastCommonAncestor queries.
177        for (int q = 0; q < 10000; ++q) {
178            const CBlockIndex* block1 = block_index[ctx.randrange(block_index.size())].get();
179            const CBlockIndex* block2 = block_index[ctx.randrange(block_index.size())].get();
180            const CBlockIndex* result = LastCommonAncestor(block1, block2);
181            BOOST_CHECK(result == NaiveLastCommonAncestor(block1, block2));
182        }
183    }
184}
185
186BOOST_AUTO_TEST_SUITE_END()
187

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.