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.

10,466 bytes · SHA-256 faf3572f5d0c1caf… · 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#include <common/args.h> // IWYU pragma: associated
6
7#include <common/settings.h>
8#include <sync.h>
9#include <tinyformat.h>
10#include <univalue.h>
11#include <util/check.h>
12#include <util/fs.h>
13#include <util/log.h>
14#include <util/string.h>
15
16#include <algorithm>
17#include <cstddef>
18#include <fstream>
19#include <iostream>
20#include <list>
21#include <map>
22#include <optional>
23#include <sstream>
24#include <string>
25#include <string_view>
26#include <utility>
27#include <vector>
28
29using util::TrimString;
30using util::TrimStringView;
31
32static bool GetConfigOptions(std::istream& stream, const std::string& filepath, std::string& error, std::vector<std::pair<std::string, std::string>>& options, std::list<SectionInfo>& sections)
33{
34    std::string str, prefix;
35    std::string::size_type pos;
36    int linenr = 1;
37    while (std::getline(stream, str)) {
38        bool used_hash = false;
39        if ((pos = str.find('#')) != std::string::npos) {
40            str = str.substr(0, pos);
41            used_hash = true;
42        }
43        const static std::string pattern = " \t\r\n";
44        str = TrimString(str, pattern);
45        if (!str.empty()) {
46            if (*str.begin() == '[' && *str.rbegin() == ']') {
47                const std::string section = str.substr(1, str.size() - 2);
48                sections.emplace_back(SectionInfo{section, filepath, linenr});
49                prefix = section + '.';
50            } else if (*str.begin() == '-') {
51                error = strprintf("parse error on line %i: %s, options in configuration file must be specified without leading -", linenr, str);
52                return false;
53            } else if ((pos = str.find('=')) != std::string::npos) {
54                std::string name = prefix + TrimString(std::string_view{str}.substr(0, pos), pattern);
55                std::string_view value = TrimStringView(std::string_view{str}.substr(pos + 1), pattern);
56                if (used_hash && name.find("rpcpassword") != std::string::npos) {
57                    error = strprintf("parse error on line %i, using # in rpcpassword can be ambiguous and should be avoided", linenr);
58                    return false;
59                }
60                options.emplace_back(name, value);
61                if ((pos = name.rfind('.')) != std::string::npos && prefix.length() <= pos) {
62                    sections.emplace_back(SectionInfo{name.substr(0, pos), filepath, linenr});
63                }
64            } else {
65                error = strprintf("parse error on line %i: %s", linenr, str);
66                if (str.size() >= 2 && str.starts_with("no")) {
67                    error += strprintf(", if you intended to specify a negated option, use %s=1 instead", str);
68                }
69                return false;
70            }
71        }
72        ++linenr;
73    }
74    return true;
75}
76
77bool IsConfSupported(KeyInfo& key, std::string& error) {
78    if (key.name == "conf") {
79        error = "conf cannot be set in the configuration file; use includeconf= if you want to include additional config files";
80        return false;
81    }
82    if (key.name == "reindex") {
83        // reindex can be set in a config file but it is strongly discouraged as this will cause the node to reindex on
84        // every restart. Allow the config but throw a warning
85        LogWarning("reindex=1 is set in the configuration file, which will significantly slow down startup. Consider removing or commenting out this option for better performance, unless there is currently a condition which makes rebuilding the indexes necessary");
86        return true;
87    }
88    return true;
89}
90
91bool ArgsManager::ReadConfigStream(std::istream& stream, const std::string& filepath, std::string& error, bool ignore_invalid_keys)
92{
93    LOCK(cs_args);
94    std::vector<std::pair<std::string, std::string>> options;
95    if (!GetConfigOptions(stream, filepath, error, options, m_config_sections)) {
96        return false;
97    }
98    for (const std::pair<std::string, std::string>& option : options) {
99        KeyInfo key = InterpretKey(option.first);
100        std::optional<unsigned int> flags = GetArgFlags_('-' + key.name);
101        if (!IsConfSupported(key, error)) return false;
102        if (flags) {
103            std::optional<common::SettingsValue> value = InterpretValue(key, &option.second, *flags, error);
104            if (!value) {
105                return false;
106            }
107            m_settings.ro_config[key.section][key.name].push_back(*value);
108        } else {
109            if (ignore_invalid_keys) {
110                LogWarning("Ignoring unknown configuration value %s", option.first);
111            } else {
112                error = strprintf("Invalid configuration value %s", option.first);
113                return false;
114            }
115        }
116    }
117    return true;
118}
119
120bool ArgsManager::ReadConfigString(const std::string& str_config)
121{
122    std::istringstream streamConfig(str_config);
123    {
124        LOCK(cs_args);
125        m_settings.ro_config.clear();
126        m_config_sections.clear();
127    }
128    std::string error;
129    return ReadConfigStream(streamConfig, "", error);
130}
131
132bool ArgsManager::ReadConfigFiles(std::string& error, bool ignore_invalid_keys)
133{
134    {
135        LOCK(cs_args);
136        m_settings.ro_config.clear();
137        m_config_sections.clear();
138        const auto conf_val = GetPathArg_("-conf", BITCOIN_CONF_FILENAME);
139        m_config_path = (conf_val.is_absolute() || conf_val.empty()) ? conf_val : fsbridge::AbsPathJoin(GetDataDir(/*net_specific=*/false), conf_val);
140    }
141
142    const auto conf_path{GetConfigFilePath()};
143    std::ifstream stream;
144    if (!conf_path.empty()) { // path is empty when -noconf is specified
145        if (fs::is_directory(conf_path)) {
146            error = strprintf("Config file \"%s\" is a directory.", fs::PathToString(conf_path));
147            return false;
148        }
149        stream = std::ifstream{conf_path.std_path()};
150        // If the file is explicitly specified, it must be readable
151        if (IsArgSet("-conf") && !stream.good()) {
152            error = strprintf("specified config file \"%s\" could not be opened.", fs::PathToString(conf_path));
153            return false;
154        }
155    }
156    // ok to not have a config file
157    if (stream.good()) {
158        if (!ReadConfigStream(stream, fs::PathToString(conf_path), error, ignore_invalid_keys)) {
159            return false;
160        }
161        // `-includeconf` cannot be included in the command line arguments except
162        // as `-noincludeconf` (which indicates that no included conf file should be used).
163        bool use_conf_file{true};
164        {
165            LOCK(cs_args);
166            if (auto* includes = common::FindKey(m_settings.command_line_options, "includeconf")) {
167                // ParseParameters() fails if a non-negated -includeconf is passed on the command-line
168                assert(common::SettingsSpan(*includes).last_negated());
169                use_conf_file = false;
170            }
171        }
172        if (use_conf_file) {
173            std::string chain_id = GetChainTypeString();
174            std::vector<std::string> conf_file_names;
175
176            auto add_includes = [&](const std::string& network, size_t skip = 0) {
177                size_t num_values = 0;
178                LOCK(cs_args);
179                if (auto* section = common::FindKey(m_settings.ro_config, network)) {
180                    if (auto* values = common::FindKey(*section, "includeconf")) {
181                        for (size_t i = std::max(skip, common::SettingsSpan(*values).negated()); i < values->size(); ++i) {
182                            conf_file_names.push_back((*values)[i].get_str());
183                        }
184                        num_values = values->size();
185                    }
186                }
187                return num_values;
188            };
189
190            // We haven't set m_network yet (that happens in SelectParams()), so manually check
191            // for network.includeconf args.
192            const size_t chain_includes = add_includes(chain_id);
193            const size_t default_includes = add_includes({});
194
195            for (const std::string& conf_file_name : conf_file_names) {
196                const auto include_conf_path{AbsPathForConfigVal(*this, fs::PathFromString(conf_file_name), /*net_specific=*/false)};
197                if (fs::is_directory(include_conf_path)) {
198                    error = strprintf("Included config file \"%s\" is a directory.", fs::PathToString(include_conf_path));
199                    return false;
200                }
201                std::ifstream conf_file_stream{include_conf_path.std_path()};
202                if (conf_file_stream.good()) {
203                    if (!ReadConfigStream(conf_file_stream, conf_file_name, error, ignore_invalid_keys)) {
204                        return false;
205                    }
206                    LogInfo("Included configuration file %s\n", conf_file_name);
207                } else {
208                    error = "Failed to include configuration file " + conf_file_name;
209                    return false;
210                }
211            }
212
213            // Warn about recursive -includeconf
214            conf_file_names.clear();
215            add_includes(chain_id, /* skip= */ chain_includes);
216            add_includes({}, /* skip= */ default_includes);
217            std::string chain_id_final = GetChainTypeString();
218            if (chain_id_final != chain_id) {
219                // Also warn about recursive includeconf for the chain that was specified in one of the includeconfs
220                add_includes(chain_id_final);
221            }
222            for (const std::string& conf_file_name : conf_file_names) {
223                tfm::format(std::cerr, "warning: -includeconf cannot be used from included files; ignoring -includeconf=%s\n", conf_file_name);
224            }
225        }
226    }
227
228    // If datadir is changed in .conf file:
229    ClearPathCache();
230    if (!CheckDataDirOption(*this)) {
231        error = strprintf("specified data directory \"%s\" does not exist.", GetArg("-datadir", ""));
232        return false;
233    }
234    return true;
235}
236
237fs::path AbsPathForConfigVal(const ArgsManager& args, const fs::path& path, bool net_specific)
238{
239    if (path.is_absolute() || path.empty()) {
240        return path;
241    }
242    return fsbridge::AbsPathJoin(net_specific ? args.GetDataDirNet() : args.GetDataDirBase(), path);
243}
244

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.