[#common]
= common
:mrdocs:

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

== Types

[cols="1,4"]
|===
| Name| Description
| xref:common/ConfigError.adoc[`ConfigError`] 
| Details about a configuration initialization failure.
| xref:common/PSBTFillOptions.adoc[`PSBTFillOptions`] 
| Instructions for how a PSBT should be signed or filled with information.
| xref:common/Settings.adoc[`Settings`] 
| Stored settings. This struct combines settings from the command line, a read‐only configuration file, and a read‐write runtime settings file.
| xref:common/SettingsSpan.adoc[`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

[cols="1,4"]
|===
| Name| Description
| xref:common/SettingsAbortFn.adoc[`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.
| xref:common/SettingsValue.adoc[`SettingsValue`] 
| Settings value type (string/integer/boolean/null variant).
|===


== Enums

[cols="1,4"]
|===
| Name| Description
| xref:common/ConfigStatus.adoc[`ConfigStatus`] 
| Outcome of reading configuration and initializing the data directory.
| xref:common/PSBTError.adoc[`PSBTError`] 
| Error conditions reported while processing a PSBT.
|===


== Functions

[cols="1,4"]
|===
| Name| Description
| xref:common/AmountErrMsg.adoc[`AmountErrMsg`] 
| Build the error message for an invalid amount value.
| xref:common/AmountHighWarn.adoc[`AmountHighWarn`] 
| Build a warning that a configured amount is unusually high.
| xref:common/FeeModeFromString.adoc[`FeeModeFromString`] 
| Parse a fee estimate mode from its string name.
| xref:common/FeeModeInfo.adoc[`FeeModeInfo`] 
| Format a single fee mode and its description.
| xref:common/FeeModes.adoc[`FeeModes`] 
| List the available fee estimate mode names.
| xref:common/FeeModesDetail.adoc[`FeeModesDetail`] 
| Build the detailed help text describing all fee modes.
| xref:common/FindKey.adoc[`FindKey`] 
| Map lookup helper.
| xref:common/GetSetting.adoc[`GetSetting`] 
| Get settings value from combined sources: forced settings, command line arguments, runtime read‐write settings, and the read‐only config file.
| xref:common/GetSettingsList.adoc[`GetSettingsList`] 
| Get combined setting value similar to GetSetting(), except if setting was specified multiple times, return a list of all the values specified.
| xref:common/InitConfig.adoc[`InitConfig`] 
| Read config files, and create datadir and settings.json if they don't exist.
| xref:common/InvalidEstimateModeErrorMessage.adoc[`InvalidEstimateModeErrorMessage`] 
| Return the error message shown when an invalid estimate mode is given.
| xref:common/InvalidPortErrMsg.adoc[`InvalidPortErrMsg`] 
| Build the error message for an invalid port value.
| xref:common/OnlyHasDefaultSectionSetting.adoc[`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.
| xref:common/PSBTErrorString.adoc[`PSBTErrorString`] 
| Return a bilingual message describing a PSBT error.
| xref:common/ReadSettings.adoc[`ReadSettings`] 
| Read settings file.
| xref:common/ResolveErrMsg.adoc[`ResolveErrMsg`] 
| Build the error message for a failed address resolution.
| xref:common/StringForFeeReason.adoc[`StringForFeeReason`] 
| Return a human‐readable description of a fee reason.
| xref:common/TransactionErrorString.adoc[`TransactionErrorString`] 
| Return a bilingual message describing a transaction error.
| xref:common/WriteSettings.adoc[`WriteSettings`] 
| Write settings file.
|===



[.small]#Created with https://www.mrdocs.com[MrDocs]#