Module sc_network::config

Configuration of the networking layer.

The Params struct is the struct that must be passed in order to initialize the networking. See the documentation of Params.

Re-exports

• pub use crate::discovery::DEFAULT_KADEMLIA_REPLICATION_FACTOR;
• pub use crate::request_responses::IncomingRequest;
• pub use crate::request_responses::OutgoingResponse;
• pub use crate::request_responses::ProtocolConfig as RequestResponseConfig;
• pub use crate::types::ProtocolName;
• pub use libp2p::multiaddr;
• pub use libp2p::identity;

Modules

• ed25519
  Ed25519 keys.

Macros

• build_multiaddr
  Easy way for a user to create a Multiaddr.

Structs

• FullNetworkConfiguration
  Full network configuration.
• Multiaddr
  Representation of a Multiaddr.
• MultiaddrWithPeerId
  Address of a node, including its identity.
• NetworkConfiguration
  Network service configuration.
• NonDefaultSetConfig
  Extension to SetConfig for sets that aren’t the default set.
• NotificationHandshake
  Custom handshake for the notification protocol
• NotificationsSink
  Sink connected directly to the node background task. Allows sending notifications to the peer.
• Params
  Network initialization parameters.
• PeerId
  Identifier of a peer of the network.
• ProtocolId
  Protocol name prefix, transmitted on the wire for legacy protocol names. I.e., dot in /dot/sync/2. Should be unique for each chain. Always UTF-8. Deprecated in favour of genesis hash & fork ID based protocol names.
• Roles
  Bitmask of the roles that a node fulfills.
• SetConfig
  Configuration for a set of nodes.

Enums

• Keypair
  Identity keypair of a node.
• NodeKeyConfig
  The configuration of a node’s secret key, describing the type of key and how it is obtained. A node’s identity keypair is the result of the evaluation of the node key configuration.
• NonReservedPeerMode
  The policy for connections to non-reserved peers.
• ParseErr
  Error that can be generated by parse_str_addr.
• Role
  Role of the local node.
• Secret
  The configuration options for obtaining a secret key K.
• SyncMode
  Sync operation mode.
• TransportConfig
  Configuration for the transport layer.

Traits

• ExHashT
  Minimum Requirements for a Hash within Networking
• WarpSyncProvider
  Warp sync backend. Handles retrieving and verifying warp sync proofs.

Functions

• parse_addr
  Splits a Multiaddress into a Multiaddress and PeerId.
• parse_str_addr
  Parses a string address and splits it into Multiaddress and PeerId, if valid.

Type Definitions

• Ed25519Secret
  The options for obtaining a Ed25519 secret key.