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.

5,181 bytes · SHA-256 dee3ef1acab9fb7f… · View upstream ↗

1// Copyright (c) 2019-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_SETTINGS_H
6#define BITCOIN_COMMON_SETTINGS_H
7
8#include <util/fs.h>
9
10#include <cstddef>
11#include <map>
12#include <string>
13#include <vector>
14
15// Users of this header need to explicitly #include <univalue.h>
16// IWYU pragma: no_include <univalue.h>
17class UniValue; // IWYU pragma: keep
18
19namespace common {
20
21//! Settings value type (string/integer/boolean/null variant).
22//!
23//! @note UniValue is used here for convenience and because it can be easily
24//!       serialized in a readable format. But any other variant type that can
25//!       be assigned strings, int64_t, and bool values and has get_str(),
26//!       getInt<int64_t>(), get_bool(), isNum(), isBool(), isFalse(), isTrue() and
27//!       isNull() methods can be substituted if there's a need to move away
28//!       from UniValue. (An implementation with boost::variant was posted at
29//!       https://github.com/bitcoin/bitcoin/pull/15934/files#r337691812)
30using SettingsValue = UniValue;
31
32//! Stored settings. This struct combines settings from the command line, a
33//! read-only configuration file, and a read-write runtime settings file.
34struct Settings {
35    //! Map of setting name to forced setting value.
36    std::map<std::string, SettingsValue> forced_settings;
37    //! Map of setting name to list of command line values.
38    std::map<std::string, std::vector<SettingsValue>> command_line_options;
39    //! Map of setting name to read-write file setting value.
40    std::map<std::string, SettingsValue> rw_settings;
41    //! Map of config section name and setting name to list of config file values.
42    std::map<std::string, std::map<std::string, std::vector<SettingsValue>>> ro_config;
43};
44
45//! Read settings file.
46bool ReadSettings(const fs::path& path,
47    std::map<std::string, SettingsValue>& values,
48    std::vector<std::string>& errors);
49
50//! Write settings file.
51bool WriteSettings(const fs::path& path,
52    const std::map<std::string, SettingsValue>& values,
53    std::vector<std::string>& errors);
54
55//! Get settings value from combined sources: forced settings, command line
56//! arguments, runtime read-write settings, and the read-only config file.
57//!
58//! @param ignore_default_section_config - ignore values in the default section
59//!                                        of the config file (part before any
60//!                                        [section] keywords)
61//! @param ignore_nonpersistent - ignore non-persistent settings values (forced
62//!                               settings values and values specified on the
63//!                               command line). Only return settings in the
64//!                               read-only config and read-write settings
65//!                               files.
66//! @param get_chain_type - enable special backwards compatible behavior
67//!                         for GetChainType
68SettingsValue GetSetting(const Settings& settings,
69    const std::string& section,
70    const std::string& name,
71    bool ignore_default_section_config,
72    bool ignore_nonpersistent,
73    bool get_chain_type);
74
75//! Get combined setting value similar to GetSetting(), except if setting was
76//! specified multiple times, return a list of all the values specified.
77std::vector<SettingsValue> GetSettingsList(const Settings& settings,
78    const std::string& section,
79    const std::string& name,
80    bool ignore_default_section_config);
81
82//! Return true if a setting is set in the default config file section, and not
83//! overridden by a higher priority command-line or network section value.
84//!
85//! This is used to provide user warnings about values that might be getting
86//! ignored unintentionally.
87bool OnlyHasDefaultSectionSetting(const Settings& settings, const std::string& section, const std::string& name);
88
89//! Accessor for list of settings that skips negated values when iterated over.
90//! The last boolean `false` value in the list and all earlier values are
91//! considered negated.
92struct SettingsSpan {
93    explicit SettingsSpan() = default;
94    explicit SettingsSpan(const SettingsValue& value) noexcept : SettingsSpan(&value, 1) {}
95    explicit SettingsSpan(const SettingsValue* data, size_t size) noexcept : data(data), size(size) {}
96    explicit SettingsSpan(const std::vector<SettingsValue>& vec) noexcept;
97    const SettingsValue* begin() const; //!< Pointer to first non-negated value.
98    const SettingsValue* end() const;   //!< Pointer to end of values.
99    bool empty() const;                 //!< True if there are any non-negated values.
100    bool last_negated() const;          //!< True if the last value is negated.
101    size_t negated() const;             //!< Number of negated values.
102
103    const SettingsValue* data = nullptr;
104    size_t size = 0;
105};
106
107//! Map lookup helper.
108template <typename Map, typename Key>
109auto FindKey(Map&& map, Key&& key) -> decltype(&map.at(key))
110{
111    auto it = map.find(key);
112    return it == map.end() ? nullptr : &it->second;
113}
114
115} // namespace common
116
117#endif // BITCOIN_COMMON_SETTINGS_H
118

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.