61 return (LocaleIndependentAtoi<int>(strValue) != 0);
66 return arg.size() > 0 && arg[0] ==
'-' ? arg.substr(1) : arg;
81 size_t option_index = key.find(
'.');
82 if (option_index != std::string::npos) {
83 result.
section = key.substr(0, option_index);
84 key.erase(0, option_index + 1);
86 if (key.starts_with(
"no")) {
106 unsigned int flags, std::string& error)
111 error =
strprintf(
"Negating of -%s is meaningless and therefore forbidden", key.
name);
116 LogPrintf(
"Warning: parsed potentially confusing double-negative -%s=%s\n", key.
name, *value);
122 error =
strprintf(
"Can not set -%s with no value. Please specify value with -%s=value.", key.
name, key.
name);
125 return value ? *value :
"";
136 std::set<std::string> unsuitables;
141 if (m_network.empty())
return std::set<std::string> {};
146 for (
const auto& arg : m_network_only_args) {
148 unsuitables.insert(arg);
157 static const std::set<std::string> available_sections{
166 std::list<SectionInfo> unrecognized = m_config_sections;
167 unrecognized.remove_if([](
const SectionInfo& appeared){
return available_sections.find(appeared.
m_name) != available_sections.end(); });
180 m_settings.command_line_options.clear();
182 for (
int i = 1; i < argc; i++) {
183 std::string key(argv[i]);
190 if (key.starts_with(
"-psn_"))
continue;
193 if (key ==
"-")
break;
194 std::optional<std::string> val;
195 size_t is_index = key.find(
'=');
196 if (is_index != std::string::npos) {
197 val = key.substr(is_index + 1);
207 if (!m_accept_any_command &&
m_command.empty()) {
211 error =
strprintf(
"Invalid command '%s'", argv[i]);
224 if (key.length() > 1 && key[1] ==
'-')
236 error =
strprintf(
"Invalid parameter %s", argv[i]);
240 std::optional<common::SettingsValue> value =
InterpretValue(keyinfo, val ? &*val :
nullptr, *
flags, error);
241 if (!value)
return false;
243 m_settings.command_line_options[keyinfo.
name].push_back(*value);
247 if (
auto* includes =
common::FindKey(m_settings.command_line_options,
"includeconf")) {
251 error =
"-includeconf cannot be used from commandline; -includeconf=" +
values.begin()->write();
261 for (
const auto&
arg_map : m_available_args) {
263 if (search !=
arg_map.second.end()) {
264 return search->second.m_flags;
267 return m_default_flags;
273 m_default_flags =
flags;
279 std::string path_str =
GetArg(arg,
"");
280 if (path_str.empty())
return default_value;
283 return result.has_filename() ? result : result.parent_path();
289 fs::path& path = m_cached_blocks_path;
293 if (!path.empty())
return path;
297 if (!fs::is_directory(path)) {
314 fs::path& path = net_specific ? m_cached_network_datadir_path : m_cached_datadir_path;
317 if (!path.empty())
return path;
319 const fs::path datadir{
GetPathArg(
"-datadir")};
320 if (!datadir.empty()) {
322 if (!fs::is_directory(path)) {
330 if (net_specific && !
BaseParams().DataDir().empty()) {
341 m_cached_datadir_path = fs::path();
342 m_cached_network_datadir_path = fs::path();
343 m_cached_blocks_path = fs::path();
355 if (!m_accept_any_command) {
357 ret.command = *(it++);
361 ret.args.push_back(*(it++));
368 std::vector<std::string> result;
370 result.push_back(value.isFalse() ?
"0" : value.isTrue() ?
"1" : value.get_str());
383 if (settings.empty()) {
395static void SaveErrors(
const std::vector<std::string> errors, std::vector<std::string>* error_out)
397 for (
const auto& error : errors) {
399 error_out->emplace_back(error);
414 m_settings.rw_settings.clear();
415 std::vector<std::string> read_errors;
420 for (
const auto& setting : m_settings.rw_settings) {
423 LogPrintf(
"Ignoring unknown rw_settings value %s\n", setting.first);
431 fs::path path, path_tmp;
433 throw std::logic_error(
"Attempt to write settings file when dynamic settings are disabled.");
437 std::vector<std::string> write_errors;
463 return GetArg(strArg).value_or(strDefault);
474 if (value.
isNull())
return std::nullopt;
475 if (value.
isFalse())
return "0";
476 if (value.
isTrue())
return "1";
488 return GetIntArg(strArg).value_or(nDefault);
499 if (value.
isNull())
return std::nullopt;
501 if (value.
isTrue())
return 1;
503 return LocaleIndependentAtoi<int64_t>(value.
get_str());
524 if (value.
isNull())
return std::nullopt;
553 m_settings.forced_settings[
SettingName(strArg)] = strValue;
558 Assert(
cmd.find(
'=') == std::string::npos);
562 m_accept_any_command =
false;
573 size_t eq_index =
name.find(
'=');
574 if (eq_index == std::string::npos) {
575 eq_index =
name.size();
577 std::string arg_name =
name.substr(0, eq_index);
580 std::map<std::string, Arg>&
arg_map = m_available_args[cat];
585 m_network_only_args.emplace(arg_name);
591 for (
const std::string&
name : names) {
600 m_available_args.clear();
601 m_network_only_args.clear();
607 std::vector<std::string> found{};
609 if (cmds != m_available_args.end()) {
610 for (
const auto& [
cmd, argspec] : cmds->second) {
612 found.push_back(
cmd);
615 if (found.size() > 1) {
616 throw std::runtime_error(
strprintf(
"Only one of %s may be specified.",
util::Join(found,
", ")));
623 const bool show_debug =
GetBoolArg(
"-help-debug",
false);
627 for (
const auto&
arg_map : m_available_args) {
657 if (show_debug) usage +=
HelpMessageGroup(
"Wallet debugging/testing options:");
681 for (
const auto& arg :
arg_map.second) {
684 if (arg.second.m_help_param.empty()) {
687 name = arg.first + arg.second.m_help_param;
712 return std::string(message) + std::string(
"\n\n");
715std::string
HelpMessageOpt(
const std::string &option,
const std::string &message) {
716 return std::string(
optIndent,
' ') + std::string(option) +
717 std::string(
"\n") + std::string(
msgIndent,
' ') +
723 "addrman (use deterministic addrman)",
724 "reindex_after_failure_noninteractive_yes (When asked for a reindex after failure interactively, simulate as-if answered with 'yes')",
725 "bip94 (enforce BIP94 consensus rules)",
731 return std::any_of(options.begin(), options.end(), [test_option](
const auto& option) {
732 return option == test_option;
746 fs::path legacy_path = GetSpecialFolderPath(CSIDL_APPDATA) /
"Bitcoin";
747 if (
fs::exists(legacy_path))
return legacy_path;
750 return GetSpecialFolderPath(CSIDL_LOCAL_APPDATA) /
"Bitcoin";
753 char* pszHome = getenv(
"HOME");
754 if (pszHome ==
nullptr || strlen(pszHome) == 0)
755 pathRet = fs::path(
"/");
757 pathRet = fs::path(pszHome);
760 return pathRet /
"Library/Application Support/Bitcoin";
763 return pathRet /
".bitcoin";
771 return datadir.empty() || fs::is_directory(
fs::absolute(datadir));
777 return *
Assert(m_config_path);
784 m_config_path = path;
789 std::variant<ChainType, std::string> arg =
GetChainArg();
790 if (
auto* parsed = std::get_if<ChainType>(&arg))
return *parsed;
791 throw std::runtime_error(
strprintf(
"Unknown chain %s.", std::get<std::string>(arg)));
797 if (
auto* parsed = std::get_if<ChainType>(&arg))
return ChainTypeToString(*parsed);
798 return std::get<std::string>(arg);
803 auto get_net = [&](
const std::string& arg) {
812 const bool fRegTest = get_net(
"-regtest");
813 const bool fSigNet = get_net(
"-signet");
814 const bool fTestNet = get_net(
"-testnet");
815 const bool fTestNet4 = get_net(
"-testnet4");
816 const auto chain_arg =
GetArg(
"-chain");
818 if ((
int)chain_arg.has_value() + (
int)fRegTest + (
int)fSigNet + (
int)fTestNet + (
int)fTestNet4 > 1) {
819 throw std::runtime_error(
"Invalid combination of -regtest, -signet, -testnet, -testnet4 and -chain. Can use at most one.");
853 const std::string&
prefix,
854 const std::string& section,
855 const std::map<std::string, std::vector<common::SettingsValue>>&
args)
const
857 std::string section_str = section.empty() ?
"" :
"[" + section +
"] ";
858 for (
const auto& arg :
args) {
859 for (
const auto& value : arg.second) {
862 std::string value_str = (*
flags &
SENSITIVE) ?
"****" : value.write();
872 for (
const auto& section : m_settings.ro_config) {
873 logArgsPrefix(
"Config file arg:", section.first, section.second);
875 for (
const auto& setting : m_settings.rw_settings) {
876 LogPrintf(
"Setting file arg: %s = %s\n", setting.first, setting.second.write());
878 logArgsPrefix(
"Command-line arg:",
"", m_settings.command_line_options);
const std::vector< std::string > TEST_OPTIONS_DOC
bool HelpRequested(const ArgsManager &args)
void SetupHelpOptions(ArgsManager &args)
Add help options to the args manager.
fs::path GetDefaultDataDir()
static const int msgIndent
static void SaveErrors(const std::vector< std::string > errors, std::vector< std::string > *error_out)
std::optional< common::SettingsValue > InterpretValue(const KeyInfo &key, const std::string *value, unsigned int flags, std::string &error)
Interpret settings value based on registered flags.
const char *const BITCOIN_SETTINGS_FILENAME
bool CheckDataDirOption(const ArgsManager &args)
std::optional< bool > SettingToBool(const common::SettingsValue &value)
std::optional< std::string > SettingToString(const common::SettingsValue &value)
static const int screenWidth
bool HasTestOption(const ArgsManager &args, const std::string &test_option)
Checks if a particular test option is present in -test command-line arg options.
static std::string SettingName(const std::string &arg)
std::string HelpMessageGroup(const std::string &message)
Format a string to be used as group of options in help messages.
KeyInfo InterpretKey(std::string key)
Parse "name", "section.name", "noname", "section.noname" settings keys.
const char *const BITCOIN_CONF_FILENAME
std::optional< int64_t > SettingToInt(const common::SettingsValue &value)
static bool InterpretBool(const std::string &strValue)
Interpret a string argument as a boolean.
static const int optIndent
std::string HelpMessageOpt(const std::string &option, const std::string &message)
Format a string to be used as option description in help messages.
const CBaseChainParams & BaseParams()
Return the currently selected parameters.
std::optional< ChainType > ChainTypeFromString(std::string_view chain)
std::string ChainTypeToString(ChainType chain)
#define Assert(val)
Identity function.
std::set< std::string > GetUnsuitableSectionOnlyArgs() const
Log warnings for options in m_section_only_args when they are specified in the default section but no...
std::optional< const Command > GetCommand() const
Get the command and command args (returns std::nullopt if no command provided)
bool IsArgNegated(const std::string &strArg) const
Return true if the argument was originally passed as a negated option, i.e.
void logArgsPrefix(const std::string &prefix, const std::string §ion, const std::map< std::string, std::vector< common::SettingsValue > > &args) const
std::list< SectionInfo > GetUnrecognizedSections() const
Log warnings for unrecognized section names in the config file.
@ ALLOW_ANY
disable validation
@ DISALLOW_NEGATION
disallow -nofoo syntax
@ DISALLOW_ELISION
disallow -foo syntax that doesn't assign any value
common::SettingsValue GetSetting(const std::string &arg) const
Get setting value.
bool ReadSettingsFile(std::vector< std::string > *errors=nullptr)
Read settings file.
ChainType GetChainType() const
Returns the appropriate chain type from the program arguments.
void ForceSetArg(const std::string &strArg, const std::string &strValue)
std::string GetChainTypeString() const
Returns the appropriate chain type string from the program arguments.
bool ParseParameters(int argc, const char *const argv[], std::string &error)
std::vector< std::string > GetArgs(const std::string &strArg) const
Return a vector of strings of the given argument.
void CheckMultipleCLIArgs() const
Check CLI command args.
void SetDefaultFlags(std::optional< unsigned int >)
Set default flags to return for an unknown arg.
fs::path GetDataDirNet() const
Get data directory path with appended network identifier.
std::optional< unsigned int > GetArgFlags(const std::string &name) const
Return Flags for known arg.
void SetConfigFilePath(fs::path)
bool GetSettingsPath(fs::path *filepath=nullptr, bool temp=false, bool backup=false) const
Get settings file path, or return false if read-write settings were disabled with -nosettings.
bool SoftSetArg(const std::string &strArg, const std::string &strValue)
Set an argument if it doesn't already have a value.
void SelectConfigNetwork(const std::string &network)
Select the network in use.
std::string GetHelpMessage() const
Get the help string.
void ClearPathCache()
Clear cached directory paths.
bool IsArgSet(const std::string &strArg) const
Return true if the given argument has been manually set.
bool WriteSettingsFile(std::vector< std::string > *errors=nullptr, bool backup=false) const
Write settings file or backup settings file.
int64_t GetIntArg(const std::string &strArg, int64_t nDefault) const
Return integer argument or default value.
void ClearArgs()
Clear available arguments.
fs::path GetDataDirBase() const
Get data directory path.
fs::path GetBlocksDirPath() const
Get blocks directory path.
fs::path GetConfigFilePath() const
Return config file path (read-only)
std::vector< common::SettingsValue > GetSettingsList(const std::string &arg) const
Get list of setting values.
void AddCommand(const std::string &cmd, const std::string &help)
Add subcommand.
std::variant< ChainType, std::string > GetChainArg() const
Return -regtest/-signet/-testnet/-testnet4/-chain= setting as a ChainType enum if a recognized chain ...
void LogArgs() const
Log the config file options and the command line arguments, useful for troubleshooting.
fs::path GetDataDir(bool net_specific) const
Get data directory path.
common::SettingsValue GetPersistentSetting(const std::string &name) const
Get current setting from config file or read/write settings file, ignoring nonpersistent command line...
bool UseDefaultSection(const std::string &arg) const EXCLUSIVE_LOCKS_REQUIRED(cs_args)
Returns true if settings values from the default section should be used, depending on the current net...
std::string GetArg(const std::string &strArg, const std::string &strDefault) const
Return string argument or default value.
bool SoftSetBoolArg(const std::string &strArg, bool fValue)
Set a boolean argument if it doesn't already have a value.
bool GetBoolArg(const std::string &strArg, bool fDefault) const
Return boolean argument or default value.
void AddHiddenArgs(const std::vector< std::string > &args)
Add many hidden arguments.
void AddArg(const std::string &name, const std::string &help, unsigned int flags, const OptionsCategory &cat)
Add argument.
fs::path GetPathArg(std::string arg, const fs::path &default_value={}) const
Return path argument or default value.
const std::string & get_str() const
const std::string & getValStr() const
static path absolute(const path &p)
static bool create_directories(const std::filesystem::path &p)
Create directory (and if necessary its parents), unless the leaf directory already exists or is a sym...
static bool exists(const path &p)
static std::string PathToString(const path &path)
Convert path object to a byte string.
static path PathFromString(const std::string &string)
Convert byte string to path object.
bool RenameOver(fs::path src, fs::path dest)
Rename src to dest.
bool WriteSettings(const fs::path &path, const std::map< std::string, SettingsValue > &values, std::vector< std::string > &errors)
Write settings file.
bool ReadSettings(const fs::path &path, std::map< std::string, SettingsValue > &values, std::vector< std::string > &errors)
Read settings file.
SettingsValue GetSetting(const Settings &settings, const std::string §ion, const std::string &name, bool ignore_default_section_config, bool ignore_nonpersistent, bool get_chain_type)
Get settings value from combined sources: forced settings, command line arguments,...
auto FindKey(Map &&map, Key &&key) -> decltype(&map.at(key))
Map lookup helper.
std::vector< SettingsValue > GetSettingsList(const Settings &settings, const std::string §ion, const std::string &name, bool ignore_default_section_config)
Get combined setting value similar to GetSetting(), except if setting was specified multiple times,...
bool OnlyHasDefaultSectionSetting(const Settings &settings, const std::string §ion, const std::string &name)
Return true if a setting is set in the default config file section, and not overridden by a higher pr...
fs::path AbsPathJoin(const fs::path &base, const fs::path &path)
Helper function for joining two paths.
auto Join(const C &container, const S &separator, UnaryOp unary_op)
Join all container items.
static const int64_t values[]
A selection of numbers that do not trigger int64_t overflow when added/subtracted.
Accessor for list of settings that skips negated values when iterated over.
static struct ArgMap arg_map[]
std::string FormatParagraph(std::string_view in, size_t width, size_t indent)
Format a paragraph of text to a fixed width, adding spaces for indentation to any added line.
std::string ToLower(std::string_view str)
Returns the lowercase equivalent of the given string.