Struct sc_cli::NetworkParams

pub struct NetworkParams {
    pub bootnodes: Vec<MultiaddrWithPeerId>,
    pub reserved_nodes: Vec<MultiaddrWithPeerId>,
    pub reserved_only: bool,
    pub public_addr: Vec<Multiaddr>,
    pub listen_addr: Vec<Multiaddr>,
    pub port: Option<u16>,
    pub no_private_ipv4: bool,
    pub out_peers: u32,
    pub in_peers: u32,
    pub no_mdns: bool,
    pub max_parallel_downloads: u32,
    pub node_key_params: NodeKeyParams,
    pub no_yamux_flow_control: bool,
    pub discover_local: bool,
}

Parameters used to create the network configuration.

Fields

bootnodes: Vec<MultiaddrWithPeerId>

Specify a list of bootnodes.

reserved_nodes: Vec<MultiaddrWithPeerId>

Specify a list of reserved node addresses.

reserved_only: bool

Whether to only allow connections to/from reserved nodes.

If you are a validator your node might still connect to other validator nodes regardless of whether they are defined as reserved nodes.

public_addr: Vec<Multiaddr>

The public address that other nodes will use to connect to it. This can be used if there's a proxy in front of this node.

listen_addr: Vec<Multiaddr>

Listen on this multiaddress.

port: Option<u16>

Specify p2p protocol TCP port.

no_private_ipv4: bool

Forbid connecting to private IPv4 addresses (as specified in RFC1918), unless the address was passed with --reserved-nodes or --bootnodes.

out_peers: u32

Specify the number of outgoing connections we're trying to maintain.

in_peers: u32

Specify the maximum number of incoming connections we're accepting.

no_mdns: bool

Disable mDNS discovery.

By default, the network will use mDNS to discover other nodes on the local network. This disables it. Automatically implied when using --dev.

max_parallel_downloads: u32

Maximum number of peers from which to ask for the same blocks in parallel.

This allows downloading announced blocks from multiple peers. Decrease to save traffic and risk increased latency.

node_key_params: NodeKeyParams

no_yamux_flow_control: bool

Disable the yamux flow control. This option will be removed in the future once there is enough confidence that this feature is properly working.

discover_local: bool

Enable peer discovery on local networks.

By default this option is true for --dev and false otherwise.

Implementations

impl NetworkParams

pub fn network_config(
    &self,
    chain_spec: &Box<dyn ChainSpec>,
    is_dev: bool,
    net_config_path: Option<PathBuf>,
    client_id: &str,
    node_name: &str,
    node_key: NodeKeyConfig,
    default_listen_port: u16
) -> NetworkConfiguration

Fill the given NetworkConfiguration by looking at the cli parameters.

Trait Implementations

impl Debug for NetworkParams

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

Formats the value using the given formatter.

impl StructOpt for NetworkParams

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

Returns the corresponding clap::App.

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

Creates the struct from clap::ArgMatches. It cannot fail with a parameter generated by clap by construction.

fn from_args() -> Self

Gets the struct from the command line arguments. Print the error message and quit the program in case of failure.

fn from_iter<I>(iter: I) -> Self where
    I: IntoIterator,
    <I as IntoIterator>::Item: Into<OsString>,
    <I as IntoIterator>::Item: 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
    I: IntoIterator,
    <I as IntoIterator>::Item: Into<OsString>,
    <I as IntoIterator>::Item: Clone, 

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

impl StructOptInternal for NetworkParams

fn augment_clap<'a, 'b>(app: App<'a, 'b>) -> App<'a, 'b>

fn is_subcommand() -> bool

fn from_subcommand(_sub: (&'b str, Option<&'b ArgMatches<'a>>)) -> Option<Self>