pub struct NetworkConfiguration {
Show 19 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 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, 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.

§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

source

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

Create new default configuration

source

pub fn new_local() -> NetworkConfiguration

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

source

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

source§

fn clone(&self) -> NetworkConfiguration

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for NetworkConfiguration

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<T> Any for Twhere T: Any,

§

fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

§

fn type_name(&self) -> &'static str

§

impl<T> AnySync for Twhere T: Any + Send + Sync,

§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send + 'static>

source§

impl<T> Borrow<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CheckedConversion for T

source§

fn checked_from<T>(t: T) -> Option<Self>where Self: TryFrom<T>,

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

fn checked_into<T>(self) -> Option<T>where Self: TryInto<T>,

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

impl<T> DynClone for Twhere T: Clone,

source§

fn __clone_box(&self, _: Private) -> *mut ()

source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

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

fn in_current_span(self) -> Instrumented<Self>

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

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

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

fn in_current_span(self) -> Instrumented<Self>

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

impl<T, U> Into<U> for Twhere U: From<T>,

const: unstable · source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, Outer> IsWrappedBy<Outer> for Twhere Outer: AsRef<T> + AsMut<T> + From<T>, T: From<Outer>,

source§

fn from_ref(outer: &Outer) -> &T

Get a reference to the inner from the outer.

source§

fn from_mut(outer: &mut Outer) -> &mut T

Get a mutable reference to the inner from the outer.

§

impl<T> Pointable for T

§

const ALIGN: usize = mem::align_of::<T>()

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

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

impl<T> Same<T> for T

§

type Output = T

Should always be Self
source§

impl<T> SaturatedConversion for T

source§

fn saturated_from<T>(t: T) -> Selfwhere Self: UniqueSaturatedFrom<T>,

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

fn saturated_into<T>(self) -> Twhere Self: UniqueSaturatedInto<T>,

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

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

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

fn clone_into(&self, target: &mut T)

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

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
const: unstable · source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<S, T> UncheckedInto<T> for Swhere T: UncheckedFrom<S>,

source§

fn unchecked_into(self) -> T

The counterpart to unchecked_from.
source§

impl<T, S> UniqueSaturatedInto<T> for Swhere T: Bounded, S: TryInto<T>,

source§

fn unique_saturated_into(self) -> T

Consume self to return an equivalent value of T.
§

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<T> JsonSchemaMaybe for T

§

impl<T> MaybeDebug for Twhere T: Debug,

source§

impl<T> MaybeRefUnwindSafe for Twhere T: RefUnwindSafe,

§

impl<T> MaybeSend for Twhere T: Send,