common Namespace Reference

Classes
struct	ConfigError

Typedefs
using	SettingsAbortFn = std::function< bool(const bilingual_str &message, const std::vector< std::string > &details)>
	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. More...

Enumerations
enum class	ConfigStatus { FAILED , FAILED_WRITE , ABORTED }
enum class	PSBTError { MISSING_INPUTS , SIGHASH_MISMATCH , UNSUPPORTED }

Functions
std::optional< ConfigError >	InitConfig (ArgsManager &args, SettingsAbortFn settings_abort_fn=nullptr)
	Read config files, and create datadir and settings.json if they don't exist. More...
bilingual_str	PSBTErrorString (PSBTError err)
bilingual_str	TransactionErrorString (const TransactionError error)
bilingual_str	ResolveErrMsg (const std::string &optname, const std::string &strBind)
bilingual_str	InvalidPortErrMsg (const std::string &optname, const std::string &invalid_value)
bilingual_str	AmountHighWarn (const std::string &optname)
bilingual_str	AmountErrMsg (const std::string &optname, const std::string &strValue)
bilingual_str	TransactionErrorString (node::TransactionError error)

Typedef Documentation

SettingsAbortFn

using common::SettingsAbortFn = typedef std::function<bool( const bilingual_str &message, const std::vector<std::string> &details)>

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.

Definition at line 36 of file init.h.

Enumeration Type Documentation

ConfigStatus

enum class common::ConfigStatus

strong

Enumerator
FAILED	Failed generically.
FAILED_WRITE	Failed to write settings.json.
ABORTED	Aborted by user.

Definition at line 18 of file init.h.

PSBTError

enum class common::PSBTError

strong

Enumerator
MISSING_INPUTS
SIGHASH_MISMATCH
UNSUPPORTED

Definition at line 17 of file types.h.

Function Documentation

AmountErrMsg()

bilingual_str common::AmountErrMsg	(	const std::string &	optname,
		const std::string &	strValue
	)

Definition at line 73 of file messages.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

AmountHighWarn()

bilingual_str common::AmountHighWarn

(

const std::string &

optname

)

Definition at line 69 of file messages.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

InitConfig()

std::optional< ConfigError > common::InitConfig	(	ArgsManager &	args,
		SettingsAbortFn	settings_abort_fn
	)

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

Definition at line 19 of file init.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

InvalidPortErrMsg()

bilingual_str common::InvalidPortErrMsg	(	const std::string &	optname,
		const std::string &	invalid_value
	)

Definition at line 63 of file messages.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

PSBTErrorString()

bilingual_str common::PSBTErrorString

(

PSBTError

err

)

Definition at line 22 of file messages.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

ResolveErrMsg()

bilingual_str common::ResolveErrMsg	(	const std::string &	optname,
		const std::string &	strBind
	)

Definition at line 58 of file messages.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

TransactionErrorString() [1/2]

bilingual_str common::TransactionErrorString

(

const TransactionError

error

)

Definition at line 36 of file messages.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

TransactionErrorString() [2/2]

bilingual_str common::TransactionErrorString

(

node::TransactionError

error

)