Struct sc_service::config::NetworkConfiguration

pub struct NetworkConfiguration {
    pub net_config_path: Option<PathBuf>,
    pub listen_addresses: Vec<Multiaddr>,
    pub public_addresses: Vec<Multiaddr>,
    pub boot_nodes: Vec<MultiaddrWithPeerId>,
    pub node_key: NodeKeyConfig,
    pub notifications_protocols: Vec<([u8; 4], Cow<'static, str>)>,
    pub request_response_protocols: Vec<ProtocolConfig>,
    pub in_peers: u32,
    pub out_peers: u32,
    pub reserved_nodes: Vec<MultiaddrWithPeerId>,
    pub non_reserved_mode: NonReservedPeerMode,
    pub client_version: String,
    pub node_name: String,
    pub transport: TransportConfig,
    pub max_parallel_downloads: u32,
    pub allow_non_globals_in_dht: bool,
}

Network service configuration.

Fields

net_config_path: Option<PathBuf>

Directory path to store network-specific configuration. None means nothing will be saved.

listen_addresses: Vec<Multiaddr>

Multiaddresses to listen for incoming connections.

public_addresses: Vec<Multiaddr>

Multiaddresses to advertise. Detected automatically if empty.

boot_nodes: Vec<MultiaddrWithPeerId>

List of initial node addresses

node_key: NodeKeyConfig

The node key configuration, which determines the node's network identity keypair.

notifications_protocols: Vec<([u8; 4], Cow<'static, str>)>

List of notifications protocols that the node supports. Must also include a ConsensusEngineId for backwards-compatibility.

request_response_protocols: Vec<ProtocolConfig>

List of request-response protocols that the node supports.

in_peers: u32

Maximum allowed number of incoming connections.

out_peers: u32

Number of outgoing connections we're trying to maintain.

reserved_nodes: Vec<MultiaddrWithPeerId>

List of reserved node addresses.

non_reserved_mode: NonReservedPeerMode

The non-reserved peer mode.

client_version: String

Client identifier. Sent over the wire for debugging purposes.

node_name: String

Name of the node. Sent over the wire for debugging purposes.

transport: TransportConfig

Configuration for the transport layer.

max_parallel_downloads: u32

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

allow_non_globals_in_dht: bool

Should we insert non-global addresses into the DHT?

Implementations

impl NetworkConfiguration

pub fn new<SN, SV>(
    node_name: SN,
    client_version: SV,
    node_key: NodeKeyConfig,
    net_config_path: Option<PathBuf>
) -> NetworkConfiguration where
    SN: Into<String>,
    SV: Into<String>, 

Create new default configuration

pub fn new_local() -> NetworkConfiguration

Create new default configuration for localhost-only connection with random port (useful for testing)

pub fn new_memory() -> NetworkConfiguration

Create new default configuration for localhost-only connection with random port (useful for testing)

Trait Implementations

impl Clone for NetworkConfiguration

fn clone(&self) -> NetworkConfiguration

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NetworkConfiguration

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

Formats the value using the given formatter.