reth_network_types/peers/
config.rs

Help
1//! Configuration for peering.
2
3use std::{
4    collections::HashSet,
5    io::{self, ErrorKind},
6    path::Path,
7    time::Duration,
8};
9
10use reth_net_banlist::BanList;
11use reth_network_peers::{NodeRecord, TrustedPeer};
12use tracing::info;
13
14use crate::{BackoffKind, ReputationChangeWeights};
15
16/// Maximum number of available slots for outbound sessions.
17pub const DEFAULT_MAX_COUNT_PEERS_OUTBOUND: u32 = 100;
18
19/// Maximum number of available slots for inbound sessions.
20pub const DEFAULT_MAX_COUNT_PEERS_INBOUND: u32 = 30;
21
22/// Maximum number of available slots for concurrent outgoing dials.
23///
24/// This restricts how many outbound dials can be performed concurrently.
25pub const DEFAULT_MAX_COUNT_CONCURRENT_OUTBOUND_DIALS: usize = 15;
26
27/// A temporary timeout for ips on incoming connection attempts.
28pub const INBOUND_IP_THROTTLE_DURATION: Duration = Duration::from_secs(30);
29
30/// The durations to use when a backoff should be applied to a peer.
31///
32/// See also [`BackoffKind`].
33#[derive(Debug, Clone, Copy, PartialEq, Eq)]
34#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
35pub struct PeerBackoffDurations {
36    /// Applies to connection problems where there is a chance that they will be resolved after the
37    /// short duration.
38    #[cfg_attr(feature = "serde", serde(with = "humantime_serde"))]
39    pub low: Duration,
40    /// Applies to more severe connection problems where there is a lower chance that they will be
41    /// resolved.
42    #[cfg_attr(feature = "serde", serde(with = "humantime_serde"))]
43    pub medium: Duration,
44    /// Intended for spammers, or bad peers in general.
45    #[cfg_attr(feature = "serde", serde(with = "humantime_serde"))]
46    pub high: Duration,
47    /// Maximum total backoff duration.
48    #[cfg_attr(feature = "serde", serde(with = "humantime_serde"))]
49    pub max: Duration,
50}
51
52impl PeerBackoffDurations {
53    /// Returns the corresponding [`Duration`]
54    pub const fn backoff(&self, kind: BackoffKind) -> Duration {
55        match kind {
56            BackoffKind::Low => self.low,
57            BackoffKind::Medium => self.medium,
58            BackoffKind::High => self.high,
59        }
60    }
61
62    /// Returns the timestamp until which we should backoff.
63    ///
64    /// The Backoff duration is capped by the configured maximum backoff duration.
65    pub fn backoff_until(&self, kind: BackoffKind, backoff_counter: u8) -> std::time::Instant {
66        let backoff_time = self.backoff(kind);
67        let backoff_time = backoff_time + backoff_time * backoff_counter as u32;
68        let now = std::time::Instant::now();
69        now + backoff_time.min(self.max)
70    }
71
72    /// Returns durations for testing.
73    #[cfg(any(test, feature = "test-utils"))]
74    pub const fn test() -> Self {
75        Self {
76            low: Duration::from_millis(200),
77            medium: Duration::from_millis(200),
78            high: Duration::from_millis(200),
79            max: Duration::from_millis(200),
80        }
81    }
82}
83
84impl Default for PeerBackoffDurations {
85    fn default() -> Self {
86        Self {
87            low: Duration::from_secs(30),
88            // 3min
89            medium: Duration::from_secs(60 * 3),
90            // 15min
91            high: Duration::from_secs(60 * 15),
92            // 1h
93            max: Duration::from_secs(60 * 60),
94        }
95    }
96}
97
98/// Tracks stats about connected nodes
99#[derive(Debug, Clone, PartialEq, Eq)]
100#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize), serde(default))]
101pub struct ConnectionsConfig {
102    /// Maximum allowed outbound connections.
103    pub max_outbound: usize,
104    /// Maximum allowed inbound connections.
105    pub max_inbound: usize,
106    /// Maximum allowed concurrent outbound dials.
107    #[cfg_attr(feature = "serde", serde(default))]
108    pub max_concurrent_outbound_dials: usize,
109}
110
111impl Default for ConnectionsConfig {
112    fn default() -> Self {
113        Self {
114            max_outbound: DEFAULT_MAX_COUNT_PEERS_OUTBOUND as usize,
115            max_inbound: DEFAULT_MAX_COUNT_PEERS_INBOUND as usize,
116            max_concurrent_outbound_dials: DEFAULT_MAX_COUNT_CONCURRENT_OUTBOUND_DIALS,
117        }
118    }
119}
120
121/// Config type for initiating a `PeersManager` instance.
122#[derive(Debug, Clone, PartialEq, Eq)]
123#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
124#[cfg_attr(feature = "serde", serde(default))]
125pub struct PeersConfig {
126    /// How often to recheck free slots for outbound connections.
127    #[cfg_attr(feature = "serde", serde(with = "humantime_serde"))]
128    pub refill_slots_interval: Duration,
129    /// Trusted nodes to connect to or accept from
130    pub trusted_nodes: Vec<TrustedPeer>,
131    /// Connect to or accept from trusted nodes only?
132    #[cfg_attr(feature = "serde", serde(alias = "connect_trusted_nodes_only"))]
133    pub trusted_nodes_only: bool,
134    /// Maximum number of backoff attempts before we give up on a peer and dropping.
135    ///
136    /// The max time spent of a peer before it's removed from the set is determined by the
137    /// configured backoff duration and the max backoff count.
138    ///
139    /// With a backoff counter of 5 and a backoff duration of 1h, the minimum time spent of the
140    /// peer in the table is the sum of all backoffs (1h + 2h + 3h + 4h + 5h = 15h).
141    ///
142    /// Note: this does not apply to trusted peers.
143    pub max_backoff_count: u8,
144    /// Basic nodes to connect to.
145    #[cfg_attr(feature = "serde", serde(skip))]
146    pub basic_nodes: HashSet<NodeRecord>,
147    /// How long to ban bad peers.
148    #[cfg_attr(feature = "serde", serde(with = "humantime_serde"))]
149    pub ban_duration: Duration,
150    /// Restrictions on `PeerIds` and Ips.
151    #[cfg_attr(feature = "serde", serde(skip))]
152    pub ban_list: BanList,
153    /// Restrictions on connections.
154    pub connection_info: ConnectionsConfig,
155    /// How to weigh reputation changes.
156    pub reputation_weights: ReputationChangeWeights,
157    /// How long to backoff peers that we are failed to connect to for non-fatal reasons.
158    ///
159    /// The backoff duration increases with number of backoff attempts.
160    pub backoff_durations: PeerBackoffDurations,
161    /// How long to temporarily ban ips on incoming connection attempts.
162    ///
163    /// This acts as an IP based rate limit.
164    #[cfg_attr(feature = "serde", serde(default, with = "humantime_serde"))]
165    pub incoming_ip_throttle_duration: Duration,
166}
167
168impl Default for PeersConfig {
169    fn default() -> Self {
170        Self {
171            refill_slots_interval: Duration::from_millis(5_000),
172            connection_info: Default::default(),
173            reputation_weights: Default::default(),
174            ban_list: Default::default(),
175            // Ban peers for 12h
176            ban_duration: Duration::from_secs(60 * 60 * 12),
177            backoff_durations: Default::default(),
178            trusted_nodes: Default::default(),
179            trusted_nodes_only: false,
180            basic_nodes: Default::default(),
181            max_backoff_count: 5,
182            incoming_ip_throttle_duration: INBOUND_IP_THROTTLE_DURATION,
183        }
184    }
185}
186
187impl PeersConfig {
188    /// A set of `peer_ids` and ip addr that we want to never connect to
189    pub fn with_ban_list(mut self, ban_list: BanList) -> Self {
190        self.ban_list = ban_list;
191        self
192    }
193
194    /// Configure how long to ban bad peers
195    pub const fn with_ban_duration(mut self, ban_duration: Duration) -> Self {
196        self.ban_duration = ban_duration;
197        self
198    }
199
200    /// Configure how long to refill outbound slots
201    pub const fn with_refill_slots_interval(mut self, interval: Duration) -> Self {
202        self.refill_slots_interval = interval;
203        self
204    }
205
206    /// Maximum allowed outbound connections.
207    pub const fn with_max_outbound(mut self, max_outbound: usize) -> Self {
208        self.connection_info.max_outbound = max_outbound;
209        self
210    }
211
212    /// Maximum allowed inbound connections with optional update.
213    pub const fn with_max_inbound_opt(mut self, max_inbound: Option<usize>) -> Self {
214        if let Some(max_inbound) = max_inbound {
215            self.connection_info.max_inbound = max_inbound;
216        }
217        self
218    }
219
220    /// Maximum allowed outbound connections with optional update.
221    pub const fn with_max_outbound_opt(mut self, max_outbound: Option<usize>) -> Self {
222        if let Some(max_outbound) = max_outbound {
223            self.connection_info.max_outbound = max_outbound;
224        }
225        self
226    }
227
228    /// Maximum allowed inbound connections.
229    pub const fn with_max_inbound(mut self, max_inbound: usize) -> Self {
230        self.connection_info.max_inbound = max_inbound;
231        self
232    }
233
234    /// Maximum allowed concurrent outbound dials.
235    pub const fn with_max_concurrent_dials(mut self, max_concurrent_outbound_dials: usize) -> Self {
236        self.connection_info.max_concurrent_outbound_dials = max_concurrent_outbound_dials;
237        self
238    }
239
240    /// Nodes to always connect to.
241    pub fn with_trusted_nodes(mut self, nodes: Vec<TrustedPeer>) -> Self {
242        self.trusted_nodes = nodes;
243        self
244    }
245
246    /// Connect only to trusted nodes.
247    pub const fn with_trusted_nodes_only(mut self, trusted_only: bool) -> Self {
248        self.trusted_nodes_only = trusted_only;
249        self
250    }
251
252    /// Nodes available at launch.
253    pub fn with_basic_nodes(mut self, nodes: HashSet<NodeRecord>) -> Self {
254        self.basic_nodes = nodes;
255        self
256    }
257
258    /// Configures the max allowed backoff count.
259    pub const fn with_max_backoff_count(mut self, max_backoff_count: u8) -> Self {
260        self.max_backoff_count = max_backoff_count;
261        self
262    }
263
264    /// Configures how to weigh reputation changes.
265    pub const fn with_reputation_weights(
266        mut self,
267        reputation_weights: ReputationChangeWeights,
268    ) -> Self {
269        self.reputation_weights = reputation_weights;
270        self
271    }
272
273    /// Configures how long to backoff peers that are we failed to connect to for non-fatal reasons
274    pub const fn with_backoff_durations(mut self, backoff_durations: PeerBackoffDurations) -> Self {
275        self.backoff_durations = backoff_durations;
276        self
277    }
278
279    /// Returns the maximum number of peers, inbound and outbound.
280    pub const fn max_peers(&self) -> usize {
281        self.connection_info.max_outbound + self.connection_info.max_inbound
282    }
283
284    /// Read from file nodes available at launch. Ignored if None.
285    pub fn with_basic_nodes_from_file(
286        self,
287        optional_file: Option<impl AsRef<Path>>,
288    ) -> Result<Self, io::Error> {
289        let Some(file_path) = optional_file else { return Ok(self) };
290        let reader = match std::fs::File::open(file_path.as_ref()) {
291            Ok(file) => io::BufReader::new(file),
292            Err(e) if e.kind() == ErrorKind::NotFound => return Ok(self),
293            Err(e) => Err(e)?,
294        };
295        info!(target: "net::peers", file = %file_path.as_ref().display(), "Loading saved peers");
296        let nodes: HashSet<NodeRecord> = serde_json::from_reader(reader)?;
297        Ok(self.with_basic_nodes(nodes))
298    }
299
300    /// Returns settings for testing
301    #[cfg(any(test, feature = "test-utils"))]
302    pub fn test() -> Self {
303        Self {
304            refill_slots_interval: Duration::from_millis(100),
305            backoff_durations: PeerBackoffDurations::test(),
306            ban_duration: Duration::from_millis(200),
307            ..Default::default()
308        }
309    }
310}
reth_network_types/peers/config.rs

reth_network_types/peers/
config.rs
