Struct PeersConfig

pub struct PeersConfig {
    pub refill_slots_interval: Duration,
    pub trusted_nodes: Vec<TrustedPeer>,
    pub trusted_nodes_only: bool,
    pub max_backoff_count: u8,
    pub basic_nodes: HashSet<NodeRecord>,
    pub ban_duration: Duration,
    pub ban_list: BanList,
    pub connection_info: ConnectionsConfig,
    pub reputation_weights: ReputationChangeWeights,
    pub backoff_durations: PeerBackoffDurations,
    pub incoming_ip_throttle_duration: Duration,
}

Config type for initiating a PeersManager instance.

Fields

refill_slots_interval: Duration

How often to recheck free slots for outbound connections.

trusted_nodes: Vec<TrustedPeer>

Trusted nodes to connect to or accept from

trusted_nodes_only: bool

Connect to or accept from trusted nodes only?

max_backoff_count: u8

Maximum number of backoff attempts before we give up on a peer and dropping.

The max time spent of a peer before it’s removed from the set is determined by the configured backoff duration and the max backoff count.

With a backoff counter of 5 and a backoff duration of 1h, the minimum time spent of the peer in the table is the sum of all backoffs (1h + 2h + 3h + 4h + 5h = 15h).

Note: this does not apply to trusted peers.

basic_nodes: HashSet<NodeRecord>

Basic nodes to connect to.

ban_duration: Duration

How long to ban bad peers.

ban_list: BanList

Restrictions on PeerIds and Ips.

connection_info: ConnectionsConfig

Restrictions on connections.

reputation_weights: ReputationChangeWeights

How to weigh reputation changes.

backoff_durations: PeerBackoffDurations

How long to backoff peers that we are failed to connect to for non-fatal reasons.

The backoff duration increases with number of backoff attempts.

incoming_ip_throttle_duration: Duration

How long to temporarily ban ips on incoming connection attempts.

This acts as an IP based rate limit.

Implementations

impl PeersConfig

pub fn with_ban_list(self, ban_list: BanList) -> Self

A set of peer_ids and ip addr that we want to never connect to

pub const fn with_ban_duration(self, ban_duration: Duration) -> Self

Configure how long to ban bad peers

pub const fn with_max_outbound(self, max_outbound: usize) -> Self

Maximum allowed outbound connections.

pub const fn with_max_inbound_opt(self, max_inbound: Option<usize>) -> Self

Maximum allowed inbound connections with optional update.

pub const fn with_max_outbound_opt(self, max_outbound: Option<usize>) -> Self

Maximum allowed outbound connections with optional update.

pub const fn with_max_inbound(self, max_inbound: usize) -> Self

Maximum allowed inbound connections.

pub const fn with_max_concurrent_dials( self, max_concurrent_outbound_dials: usize, ) -> Self

Maximum allowed concurrent outbound dials.

pub fn with_trusted_nodes(self, nodes: Vec<TrustedPeer>) -> Self

Nodes to always connect to.

pub const fn with_trusted_nodes_only(self, trusted_only: bool) -> Self

Connect only to trusted nodes.

pub fn with_basic_nodes(self, nodes: HashSet<NodeRecord>) -> Self

Nodes available at launch.

pub const fn with_max_backoff_count(self, max_backoff_count: u8) -> Self

Configures the max allowed backoff count.

pub const fn with_reputation_weights( self, reputation_weights: ReputationChangeWeights, ) -> Self

Configures how to weigh reputation changes.

pub const fn with_backoff_durations( self, backoff_durations: PeerBackoffDurations, ) -> Self

Configures how long to backoff peers that are we failed to connect to for non-fatal reasons

pub const fn max_peers(&self) -> usize

Returns the maximum number of peers, inbound and outbound.

pub fn with_basic_nodes_from_file( self, optional_file: Option<impl AsRef<Path>>, ) -> Result<Self, Error>

Read from file nodes available at launch. Ignored if None.

pub fn test() -> Self

Available on crate feature test-utils only.

Returns settings for testing

Trait Implementations

impl Clone for PeersConfig

fn clone(&self) -> PeersConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PeersConfig

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

Formats the value using the given formatter.

impl Default for PeersConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PeersConfig

where PeersConfig: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for PeersConfig

fn eq(&self, other: &PeersConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for PeersConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for PeersConfig

impl StructuralPartialEq for PeersConfig

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 344 bytes