Struct sc_service::config::NetworkConfiguration[][src]

pub struct NetworkConfiguration {
Show 18 fields pub net_config_path: Option<PathBuf>, pub listen_addresses: Vec<Multiaddr, Global>, pub public_addresses: Vec<Multiaddr, Global>, pub boot_nodes: Vec<MultiaddrWithPeerId, Global>, pub node_key: NodeKeyConfig, pub request_response_protocols: Vec<ProtocolConfig, Global>, pub default_peers_set: SetConfig, pub extra_sets: Vec<NonDefaultSetConfig, Global>, pub client_version: String, pub node_name: String, pub transport: TransportConfig, pub max_parallel_downloads: 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 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, Global>

Multiaddresses to listen for incoming connections.

public_addresses: Vec<Multiaddr, Global>

Multiaddresses to advertise. Detected automatically if empty.

boot_nodes: Vec<MultiaddrWithPeerId, Global>

List of initial node addresses

node_key: NodeKeyConfig

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

request_response_protocols: Vec<ProtocolConfig, Global>

List of request-response protocols that the node supports.

default_peers_set: SetConfig

Configuration for the default set of nodes used for block syncing and transactions.

extra_sets: Vec<NonDefaultSetConfig, Global>

Configuration for extra sets of nodes.

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.

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.

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

Create new default configuration

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

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

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Convert from a value of T into an equivalent instance of Option<Self>. Read more

Consume self to return Some equivalent value of Option<T>. Read more

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait. Read more

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait. Read more

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s. Read more

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s. Read more

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait. Read more

Performs the conversion.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Performs the conversion.

Get a reference to the inner from the outer.

Get a mutable reference to the inner from the outer.

The alignment of pointer.

The type for initializers.

Initializes a with the given initializer. Read more

Dereferences the given pointer. Read more

Mutably dereferences the given pointer. Read more

Drops the object pointed to by the given pointer. Read more

Should always be Self

Convert from a value of T into an equivalent instance of Self. Read more

Consume self to return an equivalent value of T. Read more

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

Get the TypeId of this object.

The counterpart to unchecked_from.

Consume self to return an equivalent value of T.

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more