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.

19,146 bytes · SHA-256 feb7fb1c5985e802… · View upstream ↗

1// Copyright (c) 2023-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#ifndef BITCOIN_COMMON_ARGS_H
6#define BITCOIN_COMMON_ARGS_H
7
8#include <common/settings.h>
9#include <sync.h>
10#include <util/chaintype.h>
11#include <util/fs.h>
12
13#include <concepts>
14#include <cstdint>
15#include <iosfwd>
16#include <list>
17#include <map>
18#include <optional>
19#include <set>
20#include <string>
21#include <string_view>
22#include <variant>
23#include <vector>
24
25class ArgsManager;
26
27extern const char * const BITCOIN_CONF_FILENAME;
28extern const char * const BITCOIN_SETTINGS_FILENAME;
29
30// Return true if -datadir option points to a valid directory or is not specified.
31bool CheckDataDirOption(const ArgsManager& args);
32
33/**
34 * Most paths passed as configuration arguments are treated as relative to
35 * the datadir if they are not absolute.
36 *
37 * @param args Parsed arguments and settings.
38 * @param path The path to be conditionally prefixed with datadir.
39 * @param net_specific Use network specific datadir variant
40 * @return The normalized path.
41 */
42fs::path AbsPathForConfigVal(const ArgsManager& args, const fs::path& path, bool net_specific = true);
43
44inline bool IsSwitchChar(char c)
45{
46#ifdef WIN32
47    return c == '-' || c == '/';
48#else
49    return c == '-';
50#endif
51}
52
53enum class OptionsCategory {
54    OPTIONS,
55    CONNECTION,
56    WALLET,
57    WALLET_DEBUG_TEST,
58    ZMQ,
59    DEBUG_TEST,
60    CHAINPARAMS,
61    NODE_RELAY,
62    BLOCK_CREATION,
63    RPC,
64    GUI,
65    COMMANDS,
66    REGISTER_COMMANDS,
67    CLI_COMMANDS,
68    IPC,
69
70    // Specific to one or more commands (OptionsCategory::COMMANDS)
71    // These are only included in help with their associated commands.
72    COMMAND_OPTIONS,
73
74    HIDDEN // Always the last option to avoid printing these in the help
75};
76
77struct KeyInfo {
78    std::string name;
79    std::string section;
80    bool negated{false};
81};
82
83KeyInfo InterpretKey(std::string key);
84
85std::optional<common::SettingsValue> InterpretValue(const KeyInfo& key, const std::string* value,
86                                                         unsigned int flags, std::string& error);
87
88struct SectionInfo {
89    std::string m_name;
90    std::string m_file;
91    int m_line;
92};
93
94std::string SettingToString(const common::SettingsValue&, const std::string&);
95std::optional<std::string> SettingToString(const common::SettingsValue&);
96
97template <std::integral Int>
98Int SettingTo(const common::SettingsValue&, Int);
99
100template <std::integral Int>
101std::optional<Int> SettingTo(const common::SettingsValue&);
102
103bool SettingToBool(const common::SettingsValue&, bool);
104std::optional<bool> SettingToBool(const common::SettingsValue&);
105
106class ArgsManager
107{
108public:
109    /**
110     * Flags controlling how config and command line arguments are validated and
111     * interpreted.
112     */
113    enum Flags : uint32_t {
114        ALLOW_ANY = 0x01,         //!< disable validation
115        // ALLOW_BOOL = 0x02,     //!< unimplemented, draft implementation in #16545
116        // ALLOW_INT = 0x04,      //!< unimplemented, draft implementation in #16545
117        // ALLOW_STRING = 0x08,   //!< unimplemented, draft implementation in #16545
118        // ALLOW_LIST = 0x10,     //!< unimplemented, draft implementation in #16545
119        DISALLOW_NEGATION = 0x20, //!< disallow -nofoo syntax
120        DISALLOW_ELISION = 0x40,  //!< disallow -foo syntax that doesn't assign any value
121
122        DEBUG_ONLY = 0x100,
123        /* Some options would cause cross-contamination if values for
124         * mainnet were used while running on regtest/testnet (or vice-versa).
125         * Setting them as NETWORK_ONLY ensures that sharing a config file
126         * between mainnet and regtest/testnet won't cause problems due to these
127         * parameters by accident. */
128        NETWORK_ONLY = 0x200,
129        // This argument's value is sensitive (such as a password).
130        SENSITIVE = 0x400,
131        COMMAND = 0x800,
132    };
133
134private:
135    struct Arg
136    {
137        std::string m_help_param;
138        std::string m_help_text;
139        unsigned int m_flags;
140    };
141
142    mutable Mutex cs_args;
143    common::Settings m_settings GUARDED_BY(cs_args);
144    std::vector<std::string> m_command GUARDED_BY(cs_args);
145    std::string m_network GUARDED_BY(cs_args);
146    std::set<std::string> m_network_only_args GUARDED_BY(cs_args);
147    std::map<OptionsCategory, std::map<std::string, Arg>> m_available_args GUARDED_BY(cs_args);
148    std::optional<unsigned int> m_default_flags GUARDED_BY(cs_args){};
149    std::map<std::string, std::set<std::string>> m_command_args GUARDED_BY(cs_args);
150    bool m_accept_any_command GUARDED_BY(cs_args){true};
151    std::list<SectionInfo> m_config_sections GUARDED_BY(cs_args);
152    std::optional<fs::path> m_config_path GUARDED_BY(cs_args);
153    mutable fs::path m_cached_blocks_path GUARDED_BY(cs_args);
154    mutable fs::path m_cached_datadir_path GUARDED_BY(cs_args);
155    mutable fs::path m_cached_network_datadir_path GUARDED_BY(cs_args);
156
157    /**
158     * Returns true if settings values from the default section should be used,
159     * depending on the current network and whether the setting is
160     * network-specific.
161     */
162    bool UseDefaultSection(const std::string& arg) const EXCLUSIVE_LOCKS_REQUIRED(cs_args);
163
164protected:
165    [[nodiscard]] bool ReadConfigStream(std::istream& stream, const std::string& filepath, std::string& error, bool ignore_invalid_keys = false) EXCLUSIVE_LOCKS_REQUIRED(!cs_args);
166    [[nodiscard]] bool ReadConfigString(const std::string& str_config) EXCLUSIVE_LOCKS_REQUIRED(!cs_args);
167
168public:
169    /**
170     * Get setting value.
171     *
172     * Result will be null if setting was unset, true if "-setting" argument was passed
173     * false if "-nosetting" argument was passed, and a string if a "-setting=value"
174     * argument was passed.
175     */
176    common::SettingsValue GetSetting(const std::string& arg) const EXCLUSIVE_LOCKS_REQUIRED(!cs_args);
177
178    /**
179     * Get list of setting values.
180     */
181    std::vector<common::SettingsValue> GetSettingsList(const std::string& arg) const EXCLUSIVE_LOCKS_REQUIRED(!cs_args);
182
183    ArgsManager();
184    ~ArgsManager();
185
186    /**
187     * Select the network in use
188     */
189    void SelectConfigNetwork(const std::string& network) EXCLUSIVE_LOCKS_REQUIRED(!cs_args);
190
191    [[nodiscard]] bool ParseParameters(int argc, const char* const argv[], std::string& error) EXCLUSIVE_LOCKS_REQUIRED(!cs_args);
192
193    /**
194     * Return config file path (read-only)
195     */
196    fs::path GetConfigFilePath() const EXCLUSIVE_LOCKS_REQUIRED(!cs_args);
197    void SetConfigFilePath(fs::path) EXCLUSIVE_LOCKS_REQUIRED(!cs_args);
198    [[nodiscard]] bool ReadConfigFiles(std::string& error, bool ignore_invalid_keys = false) EXCLUSIVE_LOCKS_REQUIRED(!cs_args);
199
200    /**
201     * Log warnings for options in m_section_only_args when
202     * they are specified in the default section but not overridden
203     * on the command line or in a network-specific section in the
204     * config file.
205     */
206    std::set<std::string> GetUnsuitableSectionOnlyArgs() const EXCLUSIVE_LOCKS_REQUIRED(!cs_args);
207
208    /**
209     * Log warnings for unrecognized section names in the config file.
210     */
211    std::list<SectionInfo> GetUnrecognizedSections() const EXCLUSIVE_LOCKS_REQUIRED(!cs_args);
212
213    struct Command {
214        /** The command (if one has been registered with AddCommand), or empty */
215        std::string command;
216        /**
217         * If command is non-empty: Any args that followed it
218         * If command is empty: The unregistered command and any args that followed it
219         */
220        std::vector<std::string> args;
221    };
222    /**
223     * Get the command and command args (returns std::nullopt if no command provided)
224     */
225    std::optional<const Command> GetCommand() const EXCLUSIVE_LOCKS_REQUIRED(!cs_args);
226
227    /**
228     * Check that any command-specific options the user specified are valid
229     * for the given command.
230     *
231     * @param[in] command   The command being run.
232     * @param[out] errors   If non-null, populated with a message for each invalid option.
233     * @return false if any command-specific options were specified that are not valid for this command
234     */
235    bool CheckCommandOptions(const std::string& command, std::vector<std::string>* errors = nullptr) const EXCLUSIVE_LOCKS_REQUIRED(!cs_args);
236
237    /**
238     * Get blocks directory path
239     *
240     * @return Blocks path which is network specific
241     */
242    fs::path GetBlocksDirPath() const EXCLUSIVE_LOCKS_REQUIRED(!cs_args);
243
244    /**
245     * Get data directory path
246     *
247     * @return Absolute path on success, otherwise an empty path when a non-directory path would be returned
248     */
249    fs::path GetDataDirBase() const EXCLUSIVE_LOCKS_REQUIRED(!cs_args);
250

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.