Crate bitcoin_argsman

Source

Modules§

base_chain_params
base_options

Structs§

ARG_ADDRINFO
ARG_GENERATE
ARG_GETINFO
ARG_HELP
ARG_NAMED
ARG_NETINFO
ARG_SET_COLOR
ARG_SET_CONF_FILE
ARG_SET_DATADIR
ARG_SET_RPC_CLIENTTIMEOUT
ARG_SET_RPC_CONNECT
ARG_SET_RPC_COOKIEFILE
ARG_SET_RPC_PASSWORD
ARG_SET_RPC_PORT
ARG_SET_RPC_USER
ARG_SET_RPC_WAIT
ARG_SET_RPC_WAITTIMEOUT
ARG_SET_RPC_WALLET
ARG_STDIN
ARG_STDINRPCPASS
ARG_STDINWALLETPASSPHRASE
ARG_VERSION
ArgDescriptor
ArgsManager
ArgsManagerArg
ArgsManagerCommand
ArgsManagerFlags
ArgsManagerInner
BaseChainParams
| BaseChainParams defines the base | parameters (shared between bitcoin-cli | and bitcoind) of a given instance of | the Bitcoin system. |
DEFAULT_BASE_PARAMS
G_ARGS
REGTEST_BASE_PARAMS
SIGNET_BASE_PARAMS
SectionInfo
TESTNET_BASE_PARAMS

Enums§

FormatParagraphError
OptionsCategory

Constants§

BITCOIN_CONF_FILENAME
BITCOIN_SETTINGS_FILENAME
CONTINUE_EXECUTION
DEFAULT_COLOR_SETTING
| Default -color setting. |
DEFAULT_HTTP_CLIENT_TIMEOUT
DEFAULT_MAX_TRIES
| Default max iterations to try in RPC | generatetodescriptor, generatetoaddress, | and generateblock. |
DEFAULT_NAMED
DEFAULT_NBLOCKS
| Default number of blocks to generate | for RPC generatetoaddress. |
DEFAULT_RPCCONNECT
DEFAULT_WAIT_CLIENT_TIMEOUT
MSG_INDENT
OPT_INDENT
SCREEN_WIDTH
UNKNOWN_NETWORK

Functions§

abs_path_for_config_val
| Most paths passed as configuration | arguments are treated as relative to | the datadir if they are not absolute. | | ———– | @param path | | The path to be conditionally prefixed
base_params
| Return the currently selected parameters. | This won’t change after app startup, | except for unit tests. |
check_data_dir_option
| Return true if -datadir option points | to a valid directory or is not specified. |
check_valid
| Check settings value validity according | to flags. | | TODO: Add more meaningful error checks | here in the future | | See “here’s how the flags are meant to | behave” in https://github.com/bitcoin/bitcoin/pull/16097#issuecomment-514627823 |
create_base_chain_params
| Creates and returns | a std::unique_ptr of the | chosen chain. | | ———– | @return | | a CBaseChainParams* of the chosen chain. | @throws a std::runtime_error if the | chain is not supported. |
format_paragraph
| Format a paragraph of text to a fixed | width, adding spaces for indentation | to any added line. |
get_config_file
get_config_options
get_default_data_dir
get_home_dir
help_message_group
| Format a string to be used as group of | options in help messages | | ———– | @param message | | Group name (e.g. “RPC server options:”) | | ———– | @return | | the formatted string |
help_message_opt
| Format a string to be used as option description | in help messages | | ———– | @param option |
interpret_bool
| Interpret a string argument as a boolean. | | The definition of LocaleIndependentAtoi() | requires that non-numeric string values | like “foo”, return 0. This means that | if a user unintentionally supplies | a non-integer argument here, the return | value is always false. This means that | | -foo=false does what the user probably | expects, but -foo=true is well defined | but does not do what they probably expected. | | The return value of LocaleIndependentAtoi(…) | is zero when given input not representable | as an int. | | For a more extensive discussion of this | topic (and a wide range of opinions on | the Right Way to change this code), see | PR12713. |
interpret_option
| Interpret -nofoo as if the user supplied | -foo=0. | | This method also tracks when the -no | form was supplied, and if so, checks | whether there was a double-negative | (-nofoo=0 -> -foo=1). | | If there was not a double negative, it | removes the “no” from the key and returns | false. | | If there was a double negative, it removes | “no” from the key, and returns true. | | If there was no “no”, it returns the string | value untouched. | | Where an option was negated can be later | checked using the | | IsArgNegated() method. One use case | for this is to have a way to disable options | that are not normally boolean (e.g. | using -nodebuglogfile to request that | debug log output is not sent to any file | at all). |
rename_over
save_errors
select_base_params
| Sets the params returned by Params() | to those for the given network. |
setting_name
setup_bitcoin_tx_args
strip_redundant_last_elements_of_path