Struct SettingsOpt 

pub struct SettingsOpt {

    pub inbound: Vec<Url>,
    pub outbound_connections: Option<usize>,
    pub inbound_connections: Option<usize>,
    pub magic_bytes: MagicBytes,
    pub external_addrs: Vec<Url>,
    pub peers: Vec<Url>,
    pub seeds: Vec<Url>,
    pub outbound_connect_timeout: Option<u64>,
    pub channel_handshake_timeout: Option<u64>,
    pub channel_heartbeat_interval: Option<u64>,
    pub node_id: String,
    pub active_profiles: Option<Vec<String>>,
    pub mixed_profiles: Option<Vec<String>>,
    pub tor_socks5_proxy: Option<Url>,
    pub nym_socks5_proxy: Option<Url>,
    pub i2p_socks5_proxy: Option<Url>,
    pub localnet: bool,
    pub outbound_peer_discovery_cooloff_time: Option<u64>,
    pub outbound_peer_discovery_attempt_time: Option<u64>,
    pub getaddrs_max: Option<u32>,
    pub p2p_datastore: Option<String>,
    pub hostlist: Option<String>,
    pub greylist_refinery_interval: Option<u64>,
    pub white_connect_percent: Option<usize>,
    pub gold_connect_count: Option<usize>,
    pub slot_preference_strict: bool,
    pub time_with_no_connections: Option<u64>,
    pub blacklist: Vec<(String, Vec<String>, Vec<u16>)>,
    pub ban_policy: BanPolicy,
    pub profiles: HashMap<String, NetworkProfileOpt>,
}

Defines the network settings so we can have P2P configurations in TOML files.

Fields

inbound: Vec<Url>

P2P accept address node listens to for inbound connections

outbound_connections: Option<usize>

Outbound connection slots number

inbound_connections: Option<usize>

Inbound connection slots number

magic_bytes: MagicBytes

Magic bytes used to distinguish P2P distinct networks and avoid nodes bleeding due to user config error.

external_addrs: Vec<Url>

P2P external addresses node advertises so other peers can reach us and connect to us, as long as inbound addresses are also configured

peers: Vec<Url>

Peer nodes to manually connect to

seeds: Vec<Url>

Seed nodes to connect to for peers retrieval and/or advertising our own external addresses

outbound_connect_timeout: Option<u64>

Connection establishment timeout in seconds

channel_handshake_timeout: Option<u64>

Exchange versions (handshake) timeout in seconds

channel_heartbeat_interval: Option<u64>

Ping-pong exchange execution interval in seconds

node_id: String

Only used for debugging. Compromises privacy when set.

active_profiles: Option<Vec<String>>

Preferred transports for outbound connections

mixed_profiles: Option<Vec<String>>

Transports allowed to be mixed (tcp, tcp+tls, tor, tor+tls). When transport is added to this list the corresponding transport in active_profiles is used to connect to the node. Supported mixing scenarios include tor => tcp, tor+tls => tcp+tls, socks5 => tor, socks5 => tcp, socks5+tls => tor+tls, socks5+tls => tcp+tls where the first one overrides the second.

tor_socks5_proxy: Option<Url>

Tor socks5 proxy to connect to when socks5 or socks5+tls are added to active profiles and transport mixing is enabled

nym_socks5_proxy: Option<Url>

Nym socks5 proxy to connect to when socks5 or socks5+tls are added to active profiles and transport mixing is enabled

i2p_socks5_proxy: Option<Url>

I2p Socks5 proxy to connect to i2p eepsite (hidden services)

localnet: bool

If this is true, strictly follow the gold_connect_count and white_connect_percent settings. Otherwise, connect to greylist entries if we have no white or gold connections.

outbound_peer_discovery_cooloff_time: Option<u64>

Cooling off time for peer discovery when unsuccessful

outbound_peer_discovery_attempt_time: Option<u64>

Time between peer discovery attempts

getaddrs_max: Option<u32>

Maximum number of addresses (with preferred transports) to receive from seeds and peers. If undefined, outbound_connections will be used instead.

p2p_datastore: Option<String>

P2P datastore path

hostlist: Option<String>

Hosts .tsv file to use

greylist_refinery_interval: Option<u64>

Pause interval within greylist refinery process

white_connect_percent: Option<usize>

Number of whitelist connections

gold_connect_count: Option<usize>

Number of goldlist connections

slot_preference_strict: bool

Allow localnet hosts

time_with_no_connections: Option<u64>

Number of seconds with no connections after which refinery process is paused.

blacklist: Vec<(String, Vec<String>, Vec<u16>)>

Nodes to avoid interacting with for the duration of the program, in the format [“host”, [“scheme”, “scheme”], [port, port]] If scheme is left empty it will default to “tcp+tls”. If ports are left empty all ports from this peer will be blocked.

ban_policy: BanPolicy

Do not ban nodes that send messages without dispatchers if set to Relaxed. For most uses, should be set to Strict.

profiles: HashMap<String, NetworkProfileOpt>

Network Profile for each transport

Trait Implementations

impl Clone for SettingsOpt

fn clone(&self) -> SettingsOpt

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SettingsOpt

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

Formats the value using the given formatter.

impl Default for SettingsOpt

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SettingsOpt

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl StructOpt for SettingsOpt

fn clap<'a, 'b>() -> App<'a, 'b>

Returns clap::App corresponding to the struct.

fn from_clap(matches: &ArgMatches<'_>) -> Self

Builds the struct from clap::ArgMatches. It’s guaranteed to succeed if matches originates from an App generated by [StructOpt::clap] called on the same type, otherwise it must panic.

fn from_args() -> Self

where Self: Sized,

Builds the struct from the command line arguments (std::env::args_os). Calls clap::Error::exit on failure, printing the error message and aborting the program.

fn from_args_safe() -> Result<Self, Error>

where Self: Sized,

Builds the struct from the command line arguments (std::env::args_os). Unlike [StructOpt::from_args], returns clap::Error on failure instead of aborting the program, so calling .exit is up to you.

fn from_iter<I>(iter: I) -> Self

where Self: Sized, I: IntoIterator, <I as IntoIterator>::Item: Into<OsString> + Clone,

Gets the struct from any iterator such as a Vec of your making. Print the error message and quit the program in case of failure.

fn from_iter_safe<I>(iter: I) -> Result<Self, Error>

where Self: Sized, I: IntoIterator, <I as IntoIterator>::Item: Into<OsString> + Clone,

Gets the struct from any iterator such as a Vec of your making.

impl StructOptToml for SettingsOpt

fn merge<'a>(from_toml: Self, from_args: Self, args: &ArgMatches<'_>) -> Self

where Self: Sized + StructOpt + Deserialize<'a>,

Merge the struct from TOML and the struct from args

fn from_clap_with_toml<'a>( toml_str: &'a str, args: &ArgMatches<'_>, ) -> Result<Self, Error>

where Self: Sized + StructOpt + Deserialize<'a>,

Creates the struct from clap::ArgMatches with initial values from TOML.

fn from_args_with_toml<'a>(toml_str: &'a str) -> Result<Self, Error>

where Self: Sized + StructOpt + Deserialize<'a>,

Creates the struct from command line arguments with initial values from TOML.

fn from_iter_with_toml<'a, I>(toml_str: &'a str, iter: I) -> Result<Self, Error>

where Self: Sized + StructOpt + Deserialize<'a>, I: IntoIterator, <I as IntoIterator>::Item: Into<OsString> + Clone,

Creates the struct from iterator with initial values from TOML.