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.

7,795 bytes · SHA-256 2362bfb2fa203ee3… · 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// The bitcoin-chainstate executable serves to surface the dependencies required
6// by a program wishing to use Bitcoin Core's consensus engine as it is right
7// now.
8//
9// DEVELOPER NOTE: Since this is a "demo-only", experimental, etc. executable,
10//                 it may diverge from Bitcoin Core's coding style.
11//
12// It is part of the libbitcoinkernel project.
13
14#include <kernel/bitcoinkernel_wrapper.h>
15
16#include <cassert>
17#include <charconv>
18#include <filesystem>
19#include <iostream>
20#include <optional>
21#include <string>
22#include <string_view>
23#include <vector>
24
25using namespace btck;
26
27std::vector<std::byte> hex_string_to_byte_vec(std::string_view hex)
28{
29    std::vector<std::byte> bytes;
30    bytes.reserve(hex.length() / 2);
31
32    for (size_t i{0}; i < hex.length(); i += 2) {
33        uint8_t byte_value;
34        auto [ptr, ec] = std::from_chars(hex.data() + i, hex.data() + i + 2, byte_value, 16);
35
36        if (ec != std::errc{} || ptr != hex.data() + i + 2) {
37            throw std::invalid_argument("Invalid hex character");
38        }
39        bytes.push_back(static_cast<std::byte>(byte_value));
40    }
41    return bytes;
42}
43
44class KernelLog
45{
46public:
47    void LogMessage(std::string_view message)
48    {
49        std::cout << "kernel: " << message;
50    }
51};
52
53class TestValidationInterface : public ValidationInterface
54{
55public:
56    TestValidationInterface() = default;
57
58    std::optional<std::string> m_expected_valid_block = std::nullopt;
59
60    void BlockChecked(Block block, BlockValidationStateView state) override
61    {
62        auto mode{state.GetValidationMode()};
63        switch (mode) {
64        case ValidationMode::VALID: {
65            std::cout << "Valid block" << std::endl;
66            return;
67        }
68        case ValidationMode::INVALID: {
69            std::cout << "Invalid block: ";
70            auto result{state.GetBlockValidationResult()};
71            switch (result) {
72            case BlockValidationResult::UNSET:
73                std::cout << "initial value. Block has not yet been rejected" << std::endl;
74                break;
75            case BlockValidationResult::HEADER_LOW_WORK:
76                std::cout << "the block header may be on a too-little-work chain" << std::endl;
77                break;
78            case BlockValidationResult::CONSENSUS:
79                std::cout << "invalid by consensus rules" << std::endl;
80                break;
81            case BlockValidationResult::CACHED_INVALID:
82                std::cout << "this block was cached as being invalid and we didn't store the reason why" << std::endl;
83                break;
84            case BlockValidationResult::INVALID_HEADER:
85                std::cout << "invalid proof of work or time too old" << std::endl;
86                break;
87            case BlockValidationResult::MUTATED:
88                std::cout << "the block's data didn't match the data committed to by the PoW" << std::endl;
89                break;
90            case BlockValidationResult::MISSING_PREV:
91                std::cout << "We don't have the previous block the checked one is built on" << std::endl;
92                break;
93            case BlockValidationResult::INVALID_PREV:
94                std::cout << "A block this one builds on is invalid" << std::endl;
95                break;
96            case BlockValidationResult::TIME_FUTURE:
97                std::cout << "block timestamp was > 2 hours in the future (or our clock is bad)" << std::endl;
98                break;
99            }
100            return;
101        }
102        case ValidationMode::INTERNAL_ERROR: {
103            std::cout << "Internal error" << std::endl;
104            return;
105        }
106        }
107    }
108};
109
110class TestKernelNotifications : public KernelNotifications
111{
112public:
113    void BlockTipHandler(SynchronizationState, const BlockTreeEntry, double) override
114    {
115        std::cout << "Block tip changed" << std::endl;
116    }
117
118    void ProgressHandler(std::string_view title, int progress_percent, bool resume_possible) override
119    {
120        std::cout << "Made progress: " << title << " " << progress_percent << "%" << std::endl;
121    }
122
123    void WarningSetHandler(Warning warning, std::string_view message) override
124    {
125        std::cout << message << std::endl;
126    }
127
128    void WarningUnsetHandler(Warning warning) override
129    {
130        std::cout << "Warning unset: " << static_cast<std::underlying_type_t<Warning>>(warning) << std::endl;
131    }
132
133    void FlushErrorHandler(std::string_view error) override
134    {
135        std::cout << error << std::endl;
136    }
137
138    void FatalErrorHandler(std::string_view error) override
139    {
140        std::cout << error << std::endl;
141    }
142};
143
144int main(int argc, char* argv[])
145{
146    // SETUP: Argument parsing and handling
147    const bool has_regtest_flag{argc == 3 && std::string(argv[1]) == "-regtest"};
148    if (argc < 2 || argc > 3 || (argc == 3 && !has_regtest_flag)) {
149        std::cerr
150            << "Usage: " << argv[0] << " [-regtest] DATADIR" << std::endl
151            << "Display DATADIR information, and process hex-encoded blocks on standard input." << std::endl
152            << "Uses mainnet parameters by default, regtest with -regtest flag" << std::endl
153            << std::endl
154            << "IMPORTANT: THIS EXECUTABLE IS EXPERIMENTAL, FOR TESTING ONLY, AND EXPECTED TO" << std::endl
155            << "           BREAK IN FUTURE VERSIONS. DO NOT USE ON YOUR ACTUAL DATADIR." << std::endl;
156        return 1;
157    }
158    std::filesystem::path abs_datadir{std::filesystem::absolute(argv[argc-1])};
159    std::filesystem::create_directories(abs_datadir);
160
161    btck_LoggingOptions logging_options = {
162        .log_timestamps = true,
163        .log_time_micros = false,
164        .log_threadnames = false,
165        .log_sourcelocations = false,
166        .always_print_category_levels = true,
167    };
168
169    logging_set_options(logging_options);
170
171    Logger logger{std::make_unique<KernelLog>()};
172
173    ContextOptions options{};
174    ChainParams params{has_regtest_flag ? ChainType::REGTEST : ChainType::MAINNET};
175    options.SetChainParams(params);
176
177    options.SetNotifications(std::make_shared<TestKernelNotifications>());
178    options.SetValidationInterface(std::make_shared<TestValidationInterface>());
179
180    Context context{options};
181
182    ChainstateManagerOptions chainman_opts{context, abs_datadir.string(), (abs_datadir / "blocks").string()};
183    chainman_opts.SetWorkerThreads(4);
184
185    std::unique_ptr<ChainMan> chainman;
186    try {
187        chainman = std::make_unique<ChainMan>(context, chainman_opts);
188    } catch (std::exception&) {
189        std::cerr << "Failed to instantiate ChainMan, exiting" << std::endl;
190        return 1;
191    }
192
193    std::cout << "Enter the block you want to validate on the next line:" << std::endl;
194
195    for (std::string line; std::getline(std::cin, line);) {
196        if (line.empty()) {
197            std::cerr << "Empty line found, try again:" << std::endl;
198            continue;
199        }
200
201        auto raw_block{hex_string_to_byte_vec(line)};
202        std::unique_ptr<Block> block;
203        try {
204            block = std::make_unique<Block>(raw_block);
205        } catch (std::exception&) {
206            std::cerr << "Block decode failed, try again:" << std::endl;
207            continue;
208        }
209
210        bool new_block = false;
211        bool accepted = chainman->ProcessBlock(*block, &new_block);
212        if (accepted) {
213            std::cerr << "Block has not yet been rejected" << std::endl;
214        } else {
215            std::cerr << "Block was not accepted" << std::endl;
216        }
217        if (!new_block) {
218            std::cerr << "Block is a duplicate" << std::endl;
219        }
220    }
221}
222

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.