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,596 bytes · SHA-256 a0e812fad1afc9e0… · View upstream ↗

1// Copyright (c) 2025-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 <clientversion.h>
8#include <common/args.h>
9#include <common/license_info.h>
10#include <common/system.h>
11#include <util/fs.h>
12#include <util/exec.h>
13#include <util/strencodings.h>
14#include <util/translation.h>
15
16#include <iostream>
17#include <string>
18#include <tinyformat.h>
19#include <vector>
20
21const TranslateFn G_TRANSLATION_FUN{nullptr};
22
23static constexpr auto HELP_USAGE = R"(Usage: %s [OPTIONS] COMMAND...
24
25Options:
26  -m, --multiprocess     Run multiprocess binaries bitcoin-node, bitcoin-gui.
27  -M, --monolithic       Run monolithic binaries bitcoind, bitcoin-qt. (Default behavior)
28  -v, --version          Show version information
29  -h, --help             Show full help message
30
31Commands:
32  gui [ARGS]     Start GUI, equivalent to running 'bitcoin-qt [ARGS]' or 'bitcoin-gui [ARGS]'.
33  node [ARGS]    Start node, equivalent to running 'bitcoind [ARGS]' or 'bitcoin-node [ARGS]'.
34  rpc [ARGS]     Call RPC method, equivalent to running 'bitcoin-cli -named [ARGS]'.
35  wallet [ARGS]  Call wallet command, equivalent to running 'bitcoin-wallet [ARGS]'.
36  tx [ARGS]      Manipulate hex-encoded transactions, equivalent to running 'bitcoin-tx [ARGS]'.
37  help           Show full help message.
38)";
39
40static constexpr auto HELP_FULL = R"(
41Additional less commonly used commands:
42  bench [ARGS]      Run bench command, equivalent to running 'bench_bitcoin [ARGS]'.
43  chainstate [ARGS] Run bitcoin kernel chainstate util, equivalent to running 'bitcoin-chainstate [ARGS]'.
44  test [ARGS]       Run unit tests, equivalent to running 'test_bitcoin [ARGS]'.
45  test-gui [ARGS]   Run GUI unit tests, equivalent to running 'test_bitcoin-qt [ARGS]'.
46)";
47
48static constexpr auto HELP_SHORT = R"(
49Run '%s help' to see additional commands (e.g. for testing and debugging).
50)";
51
52struct CommandLine {
53    std::optional<bool> use_multiprocess;
54    bool show_version{false};
55    bool show_help{false};
56    std::string_view command;
57    std::vector<const char*> args;
58};
59
60CommandLine ParseCommandLine(int argc, char* argv[]);
61bool UseMultiprocess(const CommandLine& cmd);
62static void ExecCommand(const std::vector<const char*>& args, std::string_view argv0);
63
64int main(int argc, char* argv[])
65{
66    SetupEnvironment();
67
68    try {
69        CommandLine cmd{ParseCommandLine(argc, argv)};
70        if (cmd.show_version) {
71            tfm::format(std::cout, "%s version %s\n%s", CLIENT_NAME, FormatFullVersion(), FormatParagraph(LicenseInfo()));
72            return EXIT_SUCCESS;
73        }
74
75        std::string exe_name{fs::PathToString(fs::PathFromString(argv[0]).filename())};
76        std::vector<const char*> args;
77        if (cmd.show_help || cmd.command.empty()) {
78            tfm::format(std::cout, HELP_USAGE, exe_name);
79            if (cmd.show_help) {
80                tfm::format(std::cout, HELP_FULL);
81                return EXIT_SUCCESS;
82            } else {
83                tfm::format(std::cout, HELP_SHORT, exe_name);
84                return EXIT_FAILURE;
85            }
86        } else if (cmd.command == "gui") {
87            args.emplace_back(UseMultiprocess(cmd) ? "bitcoin-gui" : "bitcoin-qt");
88        } else if (cmd.command == "node") {
89            args.emplace_back(UseMultiprocess(cmd) ? "bitcoin-node" : "bitcoind");
90        } else if (cmd.command == "rpc") {
91            args.emplace_back("bitcoin-cli");
92            // Since "bitcoin rpc" is a new interface that doesn't need to be
93            // backward compatible, enable -named by default so it is convenient
94            // for callers to use a mix of named and unnamed parameters. Callers
95            // can override this by specifying -nonamed, but it handles parameters
96            // that contain '=' characters, so -nonamed should rarely be needed.
97            args.emplace_back("-named");
98        } else if (cmd.command == "wallet") {
99            args.emplace_back("bitcoin-wallet");
100        } else if (cmd.command == "tx") {
101            args.emplace_back("bitcoin-tx");
102        } else if (cmd.command == "bench") {
103            args.emplace_back("bench_bitcoin");
104        } else if (cmd.command == "chainstate") {
105            args.emplace_back("bitcoin-chainstate");
106        } else if (cmd.command == "test") {
107            args.emplace_back("test_bitcoin");
108        } else if (cmd.command == "test-gui") {
109            args.emplace_back("test_bitcoin-qt");
110        } else if (cmd.command == "util") {
111            args.emplace_back("bitcoin-util");
112        } else {
113            throw std::runtime_error(strprintf("Unrecognized command: '%s'", cmd.command));
114        }
115        if (!args.empty()) {
116            args.insert(args.end(), cmd.args.begin(), cmd.args.end());
117            ExecCommand(args, argv[0]);
118        }
119    } catch (const std::exception& e) {
120        tfm::format(std::cerr, "Error: %s\nTry '%s --help' for more information.\n", e.what(), argv[0]);
121        return EXIT_FAILURE;
122    }
123    return EXIT_SUCCESS;
124}
125
126CommandLine ParseCommandLine(int argc, char* argv[])
127{
128    CommandLine cmd;
129    cmd.args.reserve(argc);
130    for (int i = 1; i < argc; ++i) {
131        std::string_view arg = argv[i];
132        if (!cmd.command.empty()) {
133            cmd.args.emplace_back(argv[i]);
134        } else if (arg == "-m" || arg == "--multiprocess") {
135            cmd.use_multiprocess = true;
136        } else if (arg == "-M" || arg == "--monolithic") {
137            cmd.use_multiprocess = false;
138        } else if (arg == "-v" || arg == "--version") {
139            cmd.show_version = true;
140        } else if (arg == "-h" || arg == "--help" || arg == "help") {
141            cmd.show_help = true;
142        } else if (arg.starts_with("-")) {
143            throw std::runtime_error(strprintf("Unknown option: %s", arg));
144        } else if (!arg.empty()) {
145            cmd.command = arg;
146        }
147    }
148    return cmd;
149}
150
151bool UseMultiprocess(const CommandLine& cmd)
152{
153    // If -m or -M options were explicitly specified, there is no need to
154    // further parse arguments to determine which to use.
155    if (cmd.use_multiprocess) return *cmd.use_multiprocess;
156
157    ArgsManager args;
158    args.SetDefaultFlags(ArgsManager::ALLOW_ANY);
159    std::string error_message;
160    auto argv{cmd.args};
161    argv.insert(argv.begin(), nullptr);
162    if (!args.ParseParameters(argv.size(), argv.data(), error_message)) {
163        tfm::format(std::cerr, "Warning: failed to parse subcommand command line options: %s\n", error_message);
164    }
165    if (!args.ReadConfigFiles(error_message, true)) {
166        tfm::format(std::cerr, "Warning: failed to parse subcommand config: %s\n", error_message);
167    }
168    args.SelectConfigNetwork(args.GetChainTypeString());
169
170    // If any -ipc* options are set these need to be processed by a
171    // multiprocess-capable binary.
172    return args.IsArgSet("-ipcbind") || args.IsArgSet("-ipcconnect") || args.IsArgSet("-ipcfd");
173}
174
175//! Execute the specified bitcoind, bitcoin-qt or other command line in `args`
176//! using src, bin and libexec directory paths relative to this executable, where
177//! the path to this executable is specified in `wrapper_argv0`.
178//!
179//! @param args Command line arguments to execute, where first argument should
180//!             be a relative path to a bitcoind, bitcoin-qt or other executable
181//!             that will be located on the PATH or relative to wrapper_argv0.
182//!
183//! @param wrapper_argv0 String containing first command line argument passed to
184//!                      main() to run the current executable. This is used to
185//!                      help determine the path to the current executable and
186//!                      how to look for new executables.
187//
188//! @note This function doesn't currently print anything but can be debugged
189//! from the command line using strace or dtrace like:
190//!
191//!     strace -e trace=execve -s 10000 build/bin/bitcoin ...
192//!     dtrace -n 'proc:::exec-success  /pid == $target/ { trace(curpsinfo->pr_psargs); }' -c ...
193static void ExecCommand(const std::vector<const char*>& args, std::string_view wrapper_argv0)
194{
195    // Construct argument string for execvp
196    std::vector<const char*> exec_args{args};
197    exec_args.emplace_back(nullptr);
198
199    // Try to call ExecVp with given exe path.
200    auto try_exec = [&](fs::path exe_path, bool allow_notfound = true) {
201        std::string exe_path_str{fs::PathToString(exe_path)};
202        exec_args[0] = exe_path_str.c_str();
203        if (util::ExecVp(exec_args[0], (char*const*)exec_args.data()) == -1) {
204            if (allow_notfound && errno == ENOENT) return false;
205            throw std::system_error(errno, std::system_category(), strprintf("execvp failed to execute '%s'", exec_args[0]));
206        }
207        throw std::runtime_error("execvp returned unexpectedly");
208    };
209
210    // Get the wrapper executable path.
211    const fs::path wrapper_path{util::GetExePath(wrapper_argv0)};
212
213    // Try to resolve any symlinks and figure out the directory containing the wrapper executable.
214    std::error_code ec;
215    auto wrapper_dir{fs::weakly_canonical(wrapper_path, ec)};
216    if (wrapper_dir.empty()) wrapper_dir = wrapper_path; // Restore previous path if weakly_canonical failed.
217    wrapper_dir = wrapper_dir.parent_path();
218
219    // Get path of the executable to be invoked.
220    const fs::path arg0{fs::PathFromString(args[0])};
221
222    // Decide whether to fall back to the operating system to search for the
223    // specified executable. Avoid doing this if it looks like the wrapper
224    // executable was invoked by path, rather than by search, to avoid
225    // unintentionally launching system executables in a local build.
226    // (https://github.com/bitcoin/bitcoin/pull/31375#discussion_r1861814807)
227    const bool fallback_os_search{!fs::PathFromString(std::string{wrapper_argv0}).has_parent_path()};
228
229    // If wrapper is installed in a bin/ directory, look for target executable
230    // in libexec/
231    (wrapper_dir.filename() == "bin" && try_exec(wrapper_dir.parent_path() / "libexec" / arg0.filename())) ||
232#ifdef WIN32
233    // Otherwise check the "daemon" subdirectory in a windows install.
234    (!wrapper_dir.empty() && try_exec(wrapper_dir / "daemon" / arg0.filename())) ||
235#endif
236    // Otherwise look for target executable next to current wrapper
237    (!wrapper_dir.empty() && try_exec(wrapper_dir / arg0.filename(), fallback_os_search)) ||
238    // Otherwise just look on the system path.
239    (fallback_os_search && try_exec(arg0.filename(), false));
240}
241

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.