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 server340 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.

34,092 bytes · SHA-256 502a01297124ac28… · View upstream ↗

1// Copyright (c) 2009-2010 Satoshi Nakamoto
2// Copyright (c) 2009-present The Bitcoin Core developers
3// Distributed under the MIT software license, see the accompanying
4// file COPYING or http://www.opensource.org/licenses/mit-license.php.
5
6#include <common/args.h>
7
8#include <chainparamsbase.h>
9#include <common/settings.h>
10#include <sync.h>
11#include <tinyformat.h>
12#include <univalue.h>
13#include <util/chaintype.h>
14#include <util/check.h>
15#include <util/fs.h>
16#include <util/fs_helpers.h>
17#include <util/log.h>
18#include <util/strencodings.h>
19#include <util/string.h>
20
21#ifdef WIN32
22#include <shlobj.h>
23#endif
24
25#include <algorithm>
26#include <cstdlib>
27#include <cstring>
28#include <map>
29#include <optional>
30#include <stdexcept>
31#include <string>
32#include <utility>
33#include <variant>
34
35const char * const BITCOIN_CONF_FILENAME = "bitcoin.conf";
36const char * const BITCOIN_SETTINGS_FILENAME = "settings.json";
37
38ArgsManager gArgs;
39
40/**
41 * Interpret a string argument as a boolean.
42 *
43 * The definition of LocaleIndependentAtoi<int>() requires that non-numeric string values
44 * like "foo", return 0. This means that if a user unintentionally supplies a
45 * non-integer argument here, the return value is always false. This means that
46 * -foo=false does what the user probably expects, but -foo=true is well defined
47 * but does not do what they probably expected.
48 *
49 * The return value of LocaleIndependentAtoi<int>(...) is zero when given input not
50 * representable as an int.
51 *
52 * For a more extensive discussion of this topic (and a wide range of opinions
53 * on the Right Way to change this code), see PR12713.
54 */
55static bool InterpretBool(const std::string& strValue)
56{
57    if (strValue.empty())
58        return true;
59    return (LocaleIndependentAtoi<int>(strValue) != 0);
60}
61
62static std::string SettingName(const std::string& arg)
63{
64    return arg.size() > 0 && arg[0] == '-' ? arg.substr(1) : arg;
65}
66
67/**
68 * Parse "name", "section.name", "noname", "section.noname" settings keys.
69 *
70 * @note Where an option was negated can be later checked using the
71 * IsArgNegated() method. One use case for this is to have a way to disable
72 * options that are not normally boolean (e.g. using -nodebuglogfile to request
73 * that debug log output is not sent to any file at all).
74 */
75KeyInfo InterpretKey(std::string key)
76{
77    KeyInfo result;
78    // Split section name from key name for keys like "testnet.foo" or "regtest.bar"
79    size_t option_index = key.find('.');
80    if (option_index != std::string::npos) {
81        result.section = key.substr(0, option_index);
82        key.erase(0, option_index + 1);
83    }
84    if (key.starts_with("no")) {
85        key.erase(0, 2);
86        result.negated = true;
87    }
88    result.name = key;
89    return result;
90}
91
92/**
93 * Interpret settings value based on registered flags.
94 *
95 * @param[in]   key      key information to know if key was negated
96 * @param[in]   value    string value of setting to be parsed
97 * @param[in]   flags    ArgsManager registered argument flags
98 * @param[out]  error    Error description if settings value is not valid
99 *
100 * @return parsed settings value if it is valid, otherwise nullopt accompanied
101 * by a descriptive error string
102 */
103std::optional<common::SettingsValue> InterpretValue(const KeyInfo& key, const std::string* value,
104                                                  unsigned int flags, std::string& error)
105{
106    // Return negated settings as false values.
107    if (key.negated) {
108        if (flags & ArgsManager::DISALLOW_NEGATION) {
109            error = strprintf("Negating of -%s is meaningless and therefore forbidden", key.name);
110            return std::nullopt;
111        }
112        // Double negatives like -nofoo=0 are supported (but discouraged)
113        if (value && !InterpretBool(*value)) {
114            LogWarning("Parsed potentially confusing double-negative -%s=%s", key.name, *value);
115            return true;
116        }
117        return false;
118    }
119    if (!value && (flags & ArgsManager::DISALLOW_ELISION)) {
120        error = strprintf("Can not set -%s with no value. Please specify value with -%s=value.", key.name, key.name);
121        return std::nullopt;
122    }
123    return value ? *value : "";
124}
125
126// Define default constructor and destructor that are not inline, so code instantiating this class doesn't need to
127// #include class definitions for all members.
128// For example, m_settings has an internal dependency on univalue.
129ArgsManager::ArgsManager() = default;
130ArgsManager::~ArgsManager() = default;
131
132std::set<std::string> ArgsManager::GetUnsuitableSectionOnlyArgs() const
133{
134    std::set<std::string> unsuitables;
135
136    LOCK(cs_args);
137
138    // if there's no section selected, don't worry
139    if (m_network.empty()) return std::set<std::string> {};
140
141    // if it's okay to use the default section for this network, don't worry
142    if (m_network == ChainTypeToString(ChainType::MAIN)) return std::set<std::string> {};
143
144    for (const auto& arg : m_network_only_args) {
145        if (OnlyHasDefaultSectionSetting(m_settings, m_network, SettingName(arg))) {
146            unsuitables.insert(arg);
147        }
148    }
149    return unsuitables;
150}
151
152std::list<SectionInfo> ArgsManager::GetUnrecognizedSections() const
153{
154    // Section names to be recognized in the config file.
155    static const std::set<std::string> available_sections{
156        ChainTypeToString(ChainType::REGTEST),
157        ChainTypeToString(ChainType::SIGNET),
158        ChainTypeToString(ChainType::TESTNET),
159        ChainTypeToString(ChainType::TESTNET4),
160        ChainTypeToString(ChainType::MAIN),
161    };
162
163    LOCK(cs_args);
164    std::list<SectionInfo> unrecognized = m_config_sections;
165    unrecognized.remove_if([](const SectionInfo& appeared){ return available_sections.contains(appeared.m_name); });
166    return unrecognized;
167}
168
169void ArgsManager::SelectConfigNetwork(const std::string& network)
170{
171    LOCK(cs_args);
172    m_network = network;
173}
174
175bool ArgsManager::ParseParameters(int argc, const char* const argv[], std::string& error)
176{
177    LOCK(cs_args);
178    m_settings.command_line_options.clear();
179
180    for (int i = 1; i < argc; i++) {
181        std::string key(argv[i]);
182
183#ifdef __APPLE__
184        // At the first time when a user gets the "App downloaded from the
185        // internet" warning, and clicks the Open button, macOS passes
186        // a unique process serial number (PSN) as -psn_... command-line
187        // argument, which we filter out.
188        if (key.starts_with("-psn_")) continue;
189#endif
190
191        if (key == "-") break; //bitcoin-tx using stdin
192        std::optional<std::string> val;
193        size_t is_index = key.find('=');
194        if (is_index != std::string::npos) {
195            val = key.substr(is_index + 1);
196            key.erase(is_index);
197        }
198#ifdef WIN32
199        key = ToLower(key);
200        if (key[0] == '/')
201            key[0] = '-';
202#endif
203
204        if (key[0] != '-') {
205            if (!m_accept_any_command && m_command.empty()) {
206                // The first non-dash arg is a registered command
207                std::optional<unsigned int> flags = GetArgFlags_(key);
208                if (!flags || !(*flags & ArgsManager::COMMAND)) {
209                    error = strprintf("Invalid command '%s'", argv[i]);
210                    return false;
211                }
212            }
213            m_command.push_back(key);
214            while (++i < argc) {
215                // The remaining args are command args
216                m_command.emplace_back(argv[i]);
217            }
218            break;
219        }
220
221        // Transform --foo to -foo
222        if (key.length() > 1 && key[1] == '-')
223            key.erase(0, 1);
224
225        // Transform -foo to foo
226        key.erase(0, 1);
227        KeyInfo keyinfo = InterpretKey(key);
228        std::optional<unsigned int> flags = GetArgFlags_('-' + keyinfo.name);
229
230        // Unknown command line options and command line options with dot
231        // characters (which are returned from InterpretKey with nonempty
232        // section strings) are not valid.
233        if (!flags || !keyinfo.section.empty()) {
234            error = strprintf("Invalid parameter %s", argv[i]);
235            return false;
236        }
237
238        std::optional<common::SettingsValue> value = InterpretValue(keyinfo, val ? &*val : nullptr, *flags, error);
239        if (!value) return false;
240
241        m_settings.command_line_options[keyinfo.name].push_back(*value);
242    }
243
244    // we do not allow -includeconf from command line, only -noincludeconf
245    if (auto* includes = common::FindKey(m_settings.command_line_options, "includeconf")) {
246        const common::SettingsSpan values{*includes};
247        // Range may be empty if -noincludeconf was passed
248        if (!values.empty()) {
249            error = "-includeconf cannot be used from commandline; -includeconf=" + values.begin()->write();
250            return false; // pick first value as example

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

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.