Struct grin_wallet_config::types::WalletConfig

pub struct WalletConfig {
    pub chain_type: Option<ChainTypes>,
    pub api_listen_interface: String,
    pub api_listen_port: u16,
    pub owner_api_listen_port: Option<u16>,
    pub api_secret_path: Option<String>,
    pub node_api_secret_path: Option<String>,
    pub check_node_api_http_addr: String,
    pub owner_api_include_foreign: Option<bool>,
    pub data_file_dir: String,
    pub no_commit_cache: Option<bool>,
    pub tls_certificate_file: Option<String>,
    pub tls_certificate_key: Option<String>,
    pub dark_background_color_scheme: Option<bool>,
    pub keybase_notify_ttl: Option<u16>,
}

Command-line wallet configuration

Fields

chain_type: Option<ChainTypes>

Chain parameters (default to Mainnet if none at the moment)

api_listen_interface: String

The api interface/ip_address that this api server (i.e. this wallet) will run by default this is 127.0.0.1 (and will not accept connections from external clients)

api_listen_port: u16

The port this wallet will run on

owner_api_listen_port: Option<u16>

The port this wallet's owner API will run on

api_secret_path: Option<String>

Location of the secret for basic auth on the Owner API

node_api_secret_path: Option<String>

Location of the node api secret for basic auth on the Grin API

check_node_api_http_addr: String

The api address of a running server node against which transaction inputs will be checked during send

owner_api_include_foreign: Option<bool>

Whether to include foreign API endpoints on the Owner API

data_file_dir: String

The directory in which wallet files are stored

no_commit_cache: Option<bool>

If Some(true), don't cache commits alongside output data speed improvement, but your commits are in the database

tls_certificate_file: Option<String>

TLS certificate file

tls_certificate_key: Option<String>

TLS certificate private key file

dark_background_color_scheme: Option<bool>

Whether to use the black background color scheme for command line if enabled, wallet command output color will be suitable for black background terminal

keybase_notify_ttl: Option<u16>

The exploding lifetime (minutes) for keybase notification on coins received

Methods

impl WalletConfig

pub fn api_listen_addr(&self) -> String

API Listen address

pub fn default_owner_api_listen_port() -> u16

Default listener port

pub fn owner_api_listen_port(&self) -> u16

Use value from config file, defaulting to sensible value if missing.

pub fn owner_api_listen_addr(&self) -> String

Owner API listen address

Trait Implementations

impl Clone for WalletConfig

fn clone(&self) -> WalletConfig

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for WalletConfig

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Default for WalletConfig

fn default() -> WalletConfig

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for WalletConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl PartialEq<WalletConfig> for WalletConfig

fn eq(&self, other: &WalletConfig) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &WalletConfig) -> bool

This method tests for !=.

impl Serialize for WalletConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for WalletConfig