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.

8,262 bytes · SHA-256 6a88a5ca2c7df584… · View upstream ↗

1// Copyright (c) 2009-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 <bitcoin-build-config.h> // IWYU pragma: keep
6
7#include <arith_uint256.h>
8#include <chain.h>
9#include <chainparams.h>
10#include <chainparamsbase.h>
11#include <clientversion.h>
12#include <common/args.h>
13#include <common/license_info.h>
14#include <common/system.h>
15#include <compat/compat.h>
16#include <core_io.h>
17#include <crypto/sha256.h>
18#include <streams.h>
19#include <univalue.h>
20#include <util/exception.h>
21#include <util/strencodings.h>
22#include <util/translation.h>
23
24#include <atomic>
25#include <cstdio>
26#include <functional>
27#include <memory>
28#include <thread>
29
30static const int CONTINUE_EXECUTION=-1;
31
32const TranslateFn G_TRANSLATION_FUN{nullptr};
33
34static void SetupBitcoinUtilArgs(ArgsManager &argsman)
35{
36    SetupHelpOptions(argsman);
37
38    argsman.AddArg("-version", "Print version and exit", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
39
40    argsman.AddCommand("grind", "Perform proof of work on hex header string");
41    argsman.AddCommand("getchainparams", "Get hardcoded parameters for the selected chain");
42
43    SetupChainParamsBaseOptions(argsman);
44}
45
46// This function returns either one of EXIT_ codes when it's expected to stop the process or
47// CONTINUE_EXECUTION when it's expected to continue further.
48static int AppInitUtil(ArgsManager& args, int argc, char* argv[])
49{
50    SetupBitcoinUtilArgs(args);
51    std::string error;
52    if (!args.ParseParameters(argc, argv, error)) {
53        tfm::format(std::cerr, "Error parsing command line arguments: %s\n", error);
54        return EXIT_FAILURE;
55    }
56
57    if (HelpRequested(args) || args.GetBoolArg("-version", false)) {
58        // First part of help message is specific to this utility
59        std::string strUsage = CLIENT_NAME " bitcoin-util utility version " + FormatFullVersion() + "\n";
60
61        if (args.GetBoolArg("-version", false)) {
62            strUsage += FormatParagraph(LicenseInfo());
63        } else {
64            strUsage += "\n"
65                "The bitcoin-util tool provides bitcoin related functionality that does not rely on the ability to access a running node. Available [commands] are listed below.\n"
66                "\n"
67                "Usage:  bitcoin-util [options] [command]\n"
68                "or:     bitcoin-util [options] grind <hex-block-header>\n";
69            strUsage += "\n" + args.GetHelpMessage();
70        }
71
72        tfm::format(std::cout, "%s", strUsage);
73
74        if (argc < 2) {
75            tfm::format(std::cerr, "Error: too few parameters\n");
76            return EXIT_FAILURE;
77        }
78        return EXIT_SUCCESS;
79    }
80
81    // Check for chain settings (Params() calls are only valid after this clause)
82    try {
83        SelectParams(args.GetChainType());
84    } catch (const std::exception& e) {
85        tfm::format(std::cerr, "Error: %s\n", e.what());
86        return EXIT_FAILURE;
87    }
88
89    return CONTINUE_EXECUTION;
90}
91
92static void grind_task(uint32_t nBits, CBlockHeader header, uint32_t offset, uint32_t step, std::atomic<bool>& found, uint32_t& proposed_nonce)
93{
94    arith_uint256 target;
95    bool neg, over;
96    target.SetCompact(nBits, &neg, &over);
97    if (target == 0 || neg || over) return;
98    header.nNonce = offset;
99
100    uint32_t finish = std::numeric_limits<uint32_t>::max() - step;
101    finish = finish - (finish % step) + offset;
102
103    while (!found && header.nNonce < finish) {
104        const uint32_t next = (finish - header.nNonce < 5000*step) ? finish : header.nNonce + 5000*step;
105        do {
106            if (UintToArith256(header.GetHash()) <= target) {
107                if (!found.exchange(true)) {
108                    proposed_nonce = header.nNonce;
109                }
110                return;
111            }
112            header.nNonce += step;
113        } while(header.nNonce != next);
114    }
115}
116
117static int Grind(const std::vector<std::string>& args, std::string& strPrint)
118{
119    if (args.size() != 1) {
120        strPrint = "Must specify block header to grind";
121        return EXIT_FAILURE;
122    }
123
124    CBlockHeader header;
125    if (!DecodeHexBlockHeader(header, args[0])) {
126        strPrint = "Could not decode block header";
127        return EXIT_FAILURE;
128    }
129
130    uint32_t nBits = header.nBits;
131    std::atomic<bool> found{false};
132    uint32_t proposed_nonce{};
133
134    std::vector<std::thread> threads;
135    int n_tasks = std::max(1u, std::thread::hardware_concurrency());
136    threads.reserve(n_tasks);
137    for (int i = 0; i < n_tasks; ++i) {
138        threads.emplace_back(grind_task, nBits, header, i, n_tasks, std::ref(found), std::ref(proposed_nonce));
139    }
140    for (auto& t : threads) {
141        t.join();
142    }
143    if (found) {
144        header.nNonce = proposed_nonce;
145    } else {
146        strPrint = "Could not satisfy difficulty target";
147        return EXIT_FAILURE;
148    }
149
150    DataStream ss{};
151    ss << header;
152    strPrint = HexStr(ss);
153    return EXIT_SUCCESS;
154}
155
156static int GetChainParams(const std::vector<std::string>& args, std::string& strPrint)
157{
158    if (!args.empty()) {
159        strPrint = "getchainparams does not take arguments";
160        return EXIT_FAILURE;
161    }
162
163    const auto& params = Params();
164    const auto& consensus = params.GetConsensus();
165
166    UniValue result{UniValue::VOBJ};
167    result.pushKV("chain", params.GetChainTypeString());
168    result.pushKV("test_chain", params.IsTestChain());
169    result.pushKV("genesis", consensus.hashGenesisBlock.GetHex());
170    result.pushKV("subsidy_halving_interval", consensus.nSubsidyHalvingInterval);
171
172    if (consensus.signet_blocks) {
173        UniValue signet{UniValue::VOBJ};
174        signet.pushKV("challenge", HexStr(consensus.signet_challenge));
175        result.pushKV("signet", signet);
176    }
177
178    {
179        UniValue pow{UniValue::VOBJ};
180        pow.pushKV("limit", consensus.powLimit.ToString());
181        if (!consensus.fPowNoRetargeting) {
182            pow.pushKV("target_spacing", TicksSeconds(consensus.PowTargetSpacing()));
183            pow.pushKV("difficulty_retarget_interval", consensus.DifficultyAdjustmentInterval());
184            std::string mindiff_blocks = (consensus.fPowAllowMinDifficultyBlocks ?
185                  (consensus.enforce_BIP94 ? "bip94" : "yes") : "no");
186            pow.pushKV("mindiff_blocks", mindiff_blocks);
187        }
188        result.pushKV("pow", pow);
189    }
190
191    {
192        UniValue net{UniValue::VOBJ};
193        net.pushKV("default_port", params.GetDefaultPort());
194        net.pushKV("magic", HexStr(params.MessageStart()));
195        UniValue dns{UniValue::VARR};
196        for (const auto& seed : params.DNSSeeds()) {
197            dns.push_back(seed);
198        }
199        net.pushKV("dns_seeds", dns);
200        result.pushKV("net", net);
201    }
202
203    {
204        UniValue addr{UniValue::VOBJ};
205        addr.pushKV("bech32_hrp", params.Bech32HRP());
206        result.pushKV("addresses", addr);
207    }
208
209    strPrint = result.write(/*prettyIndent=*/2);
210    return EXIT_SUCCESS;
211}
212
213MAIN_FUNCTION
214{
215    ArgsManager& args = gArgs;
216    SetupEnvironment();
217    SHA256AutoDetect();
218
219    try {
220        int ret = AppInitUtil(args, argc, argv);
221        if (ret != CONTINUE_EXECUTION) {
222            return ret;
223        }
224    } catch (const std::exception& e) {
225        PrintExceptionContinue(&e, "AppInitUtil()");
226        return EXIT_FAILURE;
227    } catch (...) {
228        PrintExceptionContinue(nullptr, "AppInitUtil()");
229        return EXIT_FAILURE;
230    }
231
232    const auto cmd = args.GetCommand();
233    if (!cmd) {
234        tfm::format(std::cerr, "Error: must specify a command\n");
235        return EXIT_FAILURE;
236    }
237
238    int ret = EXIT_FAILURE;
239    std::string strPrint;
240    try {
241        if (cmd->command == "grind") {
242            ret = Grind(cmd->args, strPrint);
243        } else if (cmd->command == "getchainparams") {
244            ret = GetChainParams(cmd->args, strPrint);
245        } else {
246            assert(false); // unknown command should be caught earlier
247        }
248    } catch (const std::exception& e) {
249        strPrint = std::string("error: ") + e.what();
250    } catch (...) {

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.