Shared types used across the node, wallet, and GUI code.

Types

Name

Description

ConfigError

Details about a configuration initialization failure.

PSBTFillOptions

Instructions for how a PSBT should be signed or filled with information.

Settings

Stored settings. This struct combines settings from the command line, a read‐only configuration file, and a read‐write runtime settings file.

SettingsSpan

Accessor for list of settings that skips negated values when iterated over. The last boolean false value in the list and all earlier values are considered negated.

Type Aliases

Name

Description

SettingsAbortFn

Callback function to let the user decide whether to abort loading if settings.json file exists and can't be parsed, or to ignore the error and overwrite the file.

SettingsValue

Settings value type (string/integer/boolean/null variant).

Enums

Name

Description

ConfigStatus

Outcome of reading configuration and initializing the data directory.

PSBTError

Error conditions reported while processing a PSBT.

Functions

Name

Description

AmountErrMsg

Build the error message for an invalid amount value.

AmountHighWarn

Build a warning that a configured amount is unusually high.

FeeModeFromString

Parse a fee estimate mode from its string name.

FeeModeInfo

Format a single fee mode and its description.

FeeModes

List the available fee estimate mode names.

FeeModesDetail

Build the detailed help text describing all fee modes.

FindKey

Map lookup helper.

GetSetting

Get settings value from combined sources: forced settings, command line arguments, runtime read‐write settings, and the read‐only config file.

GetSettingsList

Get combined setting value similar to GetSetting(), except if setting was specified multiple times, return a list of all the values specified.

InitConfig

Read config files, and create datadir and settings.json if they don't exist.

InvalidEstimateModeErrorMessage

Return the error message shown when an invalid estimate mode is given.

InvalidPortErrMsg

Build the error message for an invalid port value.

OnlyHasDefaultSectionSetting

Return true if a setting is set in the default config file section, and not overridden by a higher priority command‐line or network section value.

PSBTErrorString

Return a bilingual message describing a PSBT error.

ReadSettings

Read settings file.

ResolveErrMsg

Build the error message for a failed address resolution.

StringForFeeReason

Return a human‐readable description of a fee reason.

TransactionErrorString

Return a bilingual message describing a transaction error.

WriteSettings

Write settings file.

Created with MrDocs