Struct sc_network::config::NetworkConfiguration
source · pub struct NetworkConfiguration {Show 19 fields
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 default_peers_set: SetConfig,
pub default_peers_set_num_full: u32,
pub client_version: String,
pub node_name: String,
pub transport: TransportConfig,
pub max_parallel_downloads: u32,
pub max_blocks_per_request: u32,
pub sync_mode: SyncMode,
pub enable_dht_random_walk: bool,
pub allow_non_globals_in_dht: bool,
pub kademlia_disjoint_query_paths: bool,
pub kademlia_replication_factor: NonZeroUsize,
pub ipfs_server: bool,
pub yamux_window_size: Option<u32>,
}
Expand description
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.
default_peers_set: SetConfig
Configuration for the default set of nodes used for block syncing and transactions.
default_peers_set_num_full: u32
Number of substreams to reserve for full nodes for block syncing and transactions. Any other slot will be dedicated to light nodes.
This value is implicitly capped to default_set.out_peers + default_set.in_peers
.
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.
max_blocks_per_request: u32
Maximum number of blocks per request.
sync_mode: SyncMode
Initial syncing mode.
enable_dht_random_walk: bool
True if Kademlia random discovery should be enabled.
If true, the node will automatically randomly walk the DHT in order to find new peers.
allow_non_globals_in_dht: bool
Should we insert non-global addresses into the DHT?
kademlia_disjoint_query_paths: bool
Require iterative Kademlia DHT queries to use disjoint paths for increased resiliency in the presence of potentially adversarial nodes.
kademlia_replication_factor: NonZeroUsize
Kademlia replication factor determines to how many closest peers a record is replicated to.
Discovery mechanism requires successful replication to all
kademlia_replication_factor
peers to consider record successfully put.
ipfs_server: bool
Enable serving block data over IPFS bitswap.
yamux_window_size: Option<u32>
Size of Yamux receive window of all substreams. None
for the default (256kiB).
Any value less than 256kiB is invalid.
Context
By design, notifications substreams on top of Yamux connections only allow up to N
bytes
to be transferred at a time, where N
is the Yamux receive window size configurable here.
This means, in practice, that every N
bytes must be acknowledged by the receiver before
the sender can send more data. The maximum bandwidth of each notifications substream is
therefore N / round_trip_time
.
It is recommended to leave this to None
, and use a request-response protocol instead if
a large amount of data must be transferred. The reason why the value is configurable is
that some Substrate users mis-use notification protocols to send large amounts of data.
As such, this option isn’t designed to stay and will likely get removed in the future.
Note that configuring a value here isn’t a modification of the Yamux protocol, but rather a modification of the way the implementation works. Different nodes with different configured values remain compatible with each other.
Implementations§
source§impl NetworkConfiguration
impl NetworkConfiguration
sourcepub fn new<SN: Into<String>, SV: Into<String>>(
node_name: SN,
client_version: SV,
node_key: NodeKeyConfig,
net_config_path: Option<PathBuf>
) -> Self
pub fn new<SN: Into<String>, SV: Into<String>>( node_name: SN, client_version: SV, node_key: NodeKeyConfig, net_config_path: Option<PathBuf> ) -> Self
Create new default configuration
sourcepub fn new_local() -> NetworkConfiguration
pub fn new_local() -> NetworkConfiguration
Create new default configuration for localhost-only connection with random port (useful for testing)
sourcepub fn new_memory() -> NetworkConfiguration
pub fn new_memory() -> NetworkConfiguration
Create new default configuration for localhost-only connection with random port (useful for testing)
Trait Implementations§
source§impl Clone for NetworkConfiguration
impl Clone for NetworkConfiguration
source§fn clone(&self) -> NetworkConfiguration
fn clone(&self) -> NetworkConfiguration
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl RefUnwindSafe for NetworkConfiguration
impl Send for NetworkConfiguration
impl Sync for NetworkConfiguration
impl Unpin for NetworkConfiguration
impl UnwindSafe for NetworkConfiguration
Blanket Implementations§
source§impl<T> CheckedConversion for T
impl<T> CheckedConversion for T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T, Outer> IsWrappedBy<Outer> for Twhere
Outer: AsRef<T> + AsMut<T> + From<T>,
T: From<Outer>,
impl<T, Outer> IsWrappedBy<Outer> for Twhere Outer: AsRef<T> + AsMut<T> + From<T>, T: From<Outer>,
§impl<T> Pointable for T
impl<T> Pointable for T
source§impl<T> SaturatedConversion for T
impl<T> SaturatedConversion for T
source§fn saturated_from<T>(t: T) -> Selfwhere
Self: UniqueSaturatedFrom<T>,
fn saturated_from<T>(t: T) -> Selfwhere Self: UniqueSaturatedFrom<T>,
source§fn saturated_into<T>(self) -> Twhere
Self: UniqueSaturatedInto<T>,
fn saturated_into<T>(self) -> Twhere Self: UniqueSaturatedInto<T>,
T
. Read moresource§impl<S, T> UncheckedInto<T> for Swhere
T: UncheckedFrom<S>,
impl<S, T> UncheckedInto<T> for Swhere T: UncheckedFrom<S>,
source§fn unchecked_into(self) -> T
fn unchecked_into(self) -> T
unchecked_from
.source§impl<T, S> UniqueSaturatedInto<T> for Swhere
T: Bounded,
S: TryInto<T>,
impl<T, S> UniqueSaturatedInto<T> for Swhere T: Bounded, S: TryInto<T>,
source§fn unique_saturated_into(self) -> T
fn unique_saturated_into(self) -> T
T
.