1use crate::{
2 config::NetworkMode, message::PeerMessage, protocol::RlpxSubProtocol,
3 swarm::NetworkConnectionState, transactions::TransactionsHandle, FetchClient,
4};
5use alloy_primitives::B256;
6use enr::Enr;
7use futures::StreamExt;
8use parking_lot::Mutex;
9use reth_discv4::{Discv4, NatResolver};
10use reth_discv5::Discv5;
11use reth_eth_wire::{
12 BlockRangeUpdate, DisconnectReason, EthNetworkPrimitives, NetworkPrimitives,
13 NewPooledTransactionHashes, SharedTransactions,
14};
15use reth_ethereum_forks::Head;
16use reth_network_api::{
17 events::{NetworkPeersEvents, PeerEvent, PeerEventStream},
18 test_utils::{PeersHandle, PeersHandleProvider},
19 BlockDownloaderProvider, DiscoveryEvent, NetworkError, NetworkEvent,
20 NetworkEventListenerProvider, NetworkInfo, NetworkStatus, PeerInfo, PeerRequest, Peers,
21 PeersInfo,
22};
23use reth_network_p2p::sync::{NetworkSyncUpdater, SyncState, SyncStateProvider};
24use reth_network_peers::{NodeRecord, PeerId};
25use reth_network_types::{PeerAddr, PeerKind, Reputation, ReputationChangeKind};
26use reth_tokio_util::{EventSender, EventStream};
27use secp256k1::SecretKey;
28use std::{
29 net::SocketAddr,
30 sync::{
31 atomic::{AtomicBool, AtomicU64, AtomicUsize, Ordering},
32 Arc,
33 },
34};
35use tokio::sync::{
36 mpsc::{self, UnboundedSender},
37 oneshot,
38};
39use tokio_stream::wrappers::UnboundedReceiverStream;
40
41#[derive(Clone, Debug)]
45pub struct NetworkHandle<N: NetworkPrimitives = EthNetworkPrimitives> {
46 inner: Arc<NetworkInner<N>>,
48}
49
50impl<N: NetworkPrimitives> NetworkHandle<N> {
53 #[expect(clippy::too_many_arguments)]
55 pub(crate) fn new(
56 num_active_peers: Arc<AtomicUsize>,
57 listener_address: Arc<Mutex<SocketAddr>>,
58 to_manager_tx: UnboundedSender<NetworkHandleMessage<N>>,
59 secret_key: SecretKey,
60 local_peer_id: PeerId,
61 peers: PeersHandle,
62 network_mode: NetworkMode,
63 chain_id: Arc<AtomicU64>,
64 tx_gossip_disabled: bool,
65 discv4: Option<Discv4>,
66 discv5: Option<Discv5>,
67 event_sender: EventSender<NetworkEvent<PeerRequest<N>>>,
68 nat: Option<NatResolver>,
69 ) -> Self {
70 let inner = NetworkInner {
71 num_active_peers,
72 to_manager_tx,
73 listener_address,
74 secret_key,
75 local_peer_id,
76 peers,
77 network_mode,
78 is_syncing: Arc::new(AtomicBool::new(false)),
79 initial_sync_done: Arc::new(AtomicBool::new(false)),
80 chain_id,
81 tx_gossip_disabled,
82 discv4,
83 discv5,
84 event_sender,
85 nat,
86 };
87 Self { inner: Arc::new(inner) }
88 }
89
90 pub fn peer_id(&self) -> &PeerId {
92 &self.inner.local_peer_id
93 }
94
95 fn manager(&self) -> &UnboundedSender<NetworkHandleMessage<N>> {
96 &self.inner.to_manager_tx
97 }
98
99 pub fn mode(&self) -> &NetworkMode {
101 &self.inner.network_mode
102 }
103
104 pub(crate) fn send_message(&self, msg: NetworkHandleMessage<N>) {
106 let _ = self.inner.to_manager_tx.send(msg);
107 }
108
109 pub fn update_status(&self, head: Head) {
111 self.send_message(NetworkHandleMessage::StatusUpdate { head });
112 }
113
114 pub fn announce_block(&self, block: N::NewBlockPayload, hash: B256) {
120 self.send_message(NetworkHandleMessage::AnnounceBlock(block, hash))
121 }
122
123 pub fn send_request(&self, peer_id: PeerId, request: PeerRequest<N>) {
125 self.send_message(NetworkHandleMessage::EthRequest { peer_id, request })
126 }
127
128 pub fn send_transactions_hashes(&self, peer_id: PeerId, msg: NewPooledTransactionHashes) {
130 self.send_message(NetworkHandleMessage::SendPooledTransactionHashes { peer_id, msg })
131 }
132
133 pub fn send_transactions(&self, peer_id: PeerId, msg: Vec<Arc<N::BroadcastedTransaction>>) {
135 self.send_message(NetworkHandleMessage::SendTransaction {
136 peer_id,
137 msg: SharedTransactions(msg),
138 })
139 }
140
141 pub fn send_eth_message(&self, peer_id: PeerId, message: PeerMessage<N>) {
143 self.send_message(NetworkHandleMessage::EthMessage { peer_id, message })
144 }
145
146 pub async fn transactions_handle(&self) -> Option<TransactionsHandle<N>> {
150 let (tx, rx) = oneshot::channel();
151 let _ = self.manager().send(NetworkHandleMessage::GetTransactionsHandle(tx));
152 rx.await.unwrap()
153 }
154
155 pub async fn shutdown(&self) -> Result<(), oneshot::error::RecvError> {
160 let (tx, rx) = oneshot::channel();
161 self.send_message(NetworkHandleMessage::Shutdown(tx));
162 rx.await
163 }
164
165 pub fn set_network_active(&self) {
169 self.set_network_conn(NetworkConnectionState::Active);
170 }
171
172 pub fn set_network_hibernate(&self) {
176 self.set_network_conn(NetworkConnectionState::Hibernate);
177 }
178
179 fn set_network_conn(&self, network_conn: NetworkConnectionState) {
181 self.send_message(NetworkHandleMessage::SetNetworkState(network_conn));
182 }
183
184 pub fn tx_gossip_disabled(&self) -> bool {
186 self.inner.tx_gossip_disabled
187 }
188
189 pub fn secret_key(&self) -> &SecretKey {
191 &self.inner.secret_key
192 }
193}
194
195impl<N: NetworkPrimitives> NetworkPeersEvents for NetworkHandle<N> {
198 fn peer_events(&self) -> PeerEventStream {
200 let peer_events = self.inner.event_sender.new_listener().map(|event| match event {
201 NetworkEvent::Peer(peer_event) => peer_event,
202 NetworkEvent::ActivePeerSession { info, .. } => PeerEvent::SessionEstablished(info),
203 });
204 PeerEventStream::new(peer_events)
205 }
206}
207
208impl<N: NetworkPrimitives> NetworkEventListenerProvider for NetworkHandle<N> {
209 type Primitives = N;
210
211 fn event_listener(&self) -> EventStream<NetworkEvent<PeerRequest<Self::Primitives>>> {
212 self.inner.event_sender.new_listener()
213 }
214
215 fn discovery_listener(&self) -> UnboundedReceiverStream<DiscoveryEvent> {
216 let (tx, rx) = mpsc::unbounded_channel();
217 let _ = self.manager().send(NetworkHandleMessage::DiscoveryListener(tx));
218 UnboundedReceiverStream::new(rx)
219 }
220}
221
222impl<N: NetworkPrimitives> NetworkProtocols for NetworkHandle<N> {
223 fn add_rlpx_sub_protocol(&self, protocol: RlpxSubProtocol) {
224 self.send_message(NetworkHandleMessage::AddRlpxSubProtocol(protocol))
225 }
226}
227
228impl<N: NetworkPrimitives> PeersInfo for NetworkHandle<N> {
229 fn num_connected_peers(&self) -> usize {
230 self.inner.num_active_peers.load(Ordering::Relaxed)
231 }
232
233 fn local_node_record(&self) -> NodeRecord {
234 if let Some(discv4) = &self.inner.discv4 {
235 discv4.node_record()
238 } else if let Some(discv5) = self.inner.discv5.as_ref() {
239 if let Some(external) =
241 self.inner.nat.clone().and_then(|nat| nat.as_external_ip(discv5.local_port()))
242 {
243 NodeRecord::new((external, discv5.local_port()).into(), *self.peer_id())
244 } else {
245 self.inner.discv5.as_ref().and_then(|d| d.node_record()).unwrap_or_else(|| {
247 NodeRecord::new(
248 (std::net::IpAddr::V4(std::net::Ipv4Addr::LOCALHOST), discv5.local_port())
249 .into(),
250 *self.peer_id(),
251 )
252 })
253 }
254 .with_tcp_port(self.inner.listener_address.lock().port())
256 } else {
257 let mut socket_addr = *self.inner.listener_address.lock();
258
259 let external_ip =
260 self.inner.nat.clone().and_then(|nat| nat.as_external_ip(socket_addr.port()));
261
262 if let Some(ip) = external_ip {
263 socket_addr.set_ip(ip)
265 } else if socket_addr.ip().is_unspecified() {
266 if socket_addr.ip().is_ipv4() {
268 socket_addr.set_ip(std::net::IpAddr::V4(std::net::Ipv4Addr::LOCALHOST));
269 } else {
270 socket_addr.set_ip(std::net::IpAddr::V6(std::net::Ipv6Addr::LOCALHOST));
271 }
272 }
273
274 NodeRecord::new(socket_addr, *self.peer_id())
275 }
276 }
277
278 fn local_enr(&self) -> Enr<SecretKey> {
279 let local_node_record = self.local_node_record();
280 let mut builder = Enr::builder();
281 builder.ip(local_node_record.address);
282 if local_node_record.address.is_ipv4() {
283 builder.udp4(local_node_record.udp_port);
284 builder.tcp4(local_node_record.tcp_port);
285
286 if let Some(discv5) = self.inner.discv5.as_ref() {
288 let discv5_enr = discv5.local_enr();
289 if let Some(ip6) = discv5_enr.ip6() {
290 builder.ip6(ip6);
291 }
292 if let Some(udp6) = discv5_enr.udp6() {
293 builder.udp6(udp6);
294 }
295 if let Some(tcp6) = discv5_enr.tcp6() {
296 builder.tcp6(tcp6);
297 }
298 }
299 } else {
300 builder.udp6(local_node_record.udp_port);
301 builder.tcp6(local_node_record.tcp_port);
302 }
303
304 builder.build(&self.inner.secret_key).expect("valid enr")
305 }
306}
307
308impl<N: NetworkPrimitives> Peers for NetworkHandle<N> {
309 fn add_trusted_peer_id(&self, peer: PeerId) {
310 self.send_message(NetworkHandleMessage::AddTrustedPeerId(peer));
311 }
312
313 fn add_peer_kind(
316 &self,
317 peer: PeerId,
318 kind: PeerKind,
319 tcp_addr: SocketAddr,
320 udp_addr: Option<SocketAddr>,
321 ) {
322 let addr = PeerAddr::new(tcp_addr, udp_addr);
323 self.send_message(NetworkHandleMessage::AddPeerAddress(peer, kind, addr));
324 }
325
326 async fn get_peers_by_kind(&self, kind: PeerKind) -> Result<Vec<PeerInfo>, NetworkError> {
327 let (tx, rx) = oneshot::channel();
328 let _ = self.manager().send(NetworkHandleMessage::GetPeerInfosByPeerKind(kind, tx));
329 Ok(rx.await?)
330 }
331
332 async fn get_all_peers(&self) -> Result<Vec<PeerInfo>, NetworkError> {
333 let (tx, rx) = oneshot::channel();
334 let _ = self.manager().send(NetworkHandleMessage::GetPeerInfos(tx));
335 Ok(rx.await?)
336 }
337
338 async fn get_peer_by_id(&self, peer_id: PeerId) -> Result<Option<PeerInfo>, NetworkError> {
339 let (tx, rx) = oneshot::channel();
340 let _ = self.manager().send(NetworkHandleMessage::GetPeerInfoById(peer_id, tx));
341 Ok(rx.await?)
342 }
343
344 async fn get_peers_by_id(&self, peer_ids: Vec<PeerId>) -> Result<Vec<PeerInfo>, NetworkError> {
345 let (tx, rx) = oneshot::channel();
346 let _ = self.manager().send(NetworkHandleMessage::GetPeerInfosByIds(peer_ids, tx));
347 Ok(rx.await?)
348 }
349
350 fn remove_peer(&self, peer: PeerId, kind: PeerKind) {
353 self.send_message(NetworkHandleMessage::RemovePeer(peer, kind))
354 }
355
356 fn disconnect_peer(&self, peer: PeerId) {
359 self.send_message(NetworkHandleMessage::DisconnectPeer(peer, None))
360 }
361
362 fn disconnect_peer_with_reason(&self, peer: PeerId, reason: DisconnectReason) {
365 self.send_message(NetworkHandleMessage::DisconnectPeer(peer, Some(reason)))
366 }
367
368 fn connect_peer_kind(
374 &self,
375 peer_id: PeerId,
376 kind: PeerKind,
377 tcp_addr: SocketAddr,
378 udp_addr: Option<SocketAddr>,
379 ) {
380 self.send_message(NetworkHandleMessage::ConnectPeer(
381 peer_id,
382 kind,
383 PeerAddr::new(tcp_addr, udp_addr),
384 ))
385 }
386
387 fn reputation_change(&self, peer_id: PeerId, kind: ReputationChangeKind) {
389 self.send_message(NetworkHandleMessage::ReputationChange(peer_id, kind));
390 }
391
392 async fn reputation_by_id(&self, peer_id: PeerId) -> Result<Option<Reputation>, NetworkError> {
393 let (tx, rx) = oneshot::channel();
394 let _ = self.manager().send(NetworkHandleMessage::GetReputationById(peer_id, tx));
395 Ok(rx.await?)
396 }
397}
398
399impl<N: NetworkPrimitives> PeersHandleProvider for NetworkHandle<N> {
400 fn peers_handle(&self) -> &PeersHandle {
401 &self.inner.peers
402 }
403}
404
405impl<N: NetworkPrimitives> NetworkInfo for NetworkHandle<N> {
406 fn local_addr(&self) -> SocketAddr {
407 *self.inner.listener_address.lock()
408 }
409
410 async fn network_status(&self) -> Result<NetworkStatus, NetworkError> {
411 let (tx, rx) = oneshot::channel();
412 let _ = self.manager().send(NetworkHandleMessage::GetStatus(tx));
413 rx.await.map_err(Into::into)
414 }
415
416 fn chain_id(&self) -> u64 {
417 self.inner.chain_id.load(Ordering::Relaxed)
418 }
419
420 fn is_syncing(&self) -> bool {
421 SyncStateProvider::is_syncing(self)
422 }
423
424 fn is_initially_syncing(&self) -> bool {
425 SyncStateProvider::is_initially_syncing(self)
426 }
427}
428
429impl<N: NetworkPrimitives> SyncStateProvider for NetworkHandle<N> {
430 fn is_syncing(&self) -> bool {
431 self.inner.is_syncing.load(Ordering::Relaxed)
432 }
433 fn is_initially_syncing(&self) -> bool {
435 if self.inner.initial_sync_done.load(Ordering::Relaxed) {
436 return false
437 }
438 self.inner.is_syncing.load(Ordering::Relaxed)
439 }
440}
441
442impl<N: NetworkPrimitives> NetworkSyncUpdater for NetworkHandle<N> {
443 fn update_sync_state(&self, state: SyncState) {
444 let future_state = state.is_syncing();
445 let prev_state = self.inner.is_syncing.swap(future_state, Ordering::Relaxed);
446 let syncing_to_idle_state_transition = prev_state && !future_state;
447 if syncing_to_idle_state_transition {
448 self.inner.initial_sync_done.store(true, Ordering::Relaxed);
449 }
450 }
451
452 fn update_status(&self, head: Head) {
454 self.send_message(NetworkHandleMessage::StatusUpdate { head });
455 }
456
457 fn update_block_range(&self, update: reth_eth_wire::BlockRangeUpdate) {
459 self.send_message(NetworkHandleMessage::InternalBlockRangeUpdate(update));
460 }
461}
462
463impl<N: NetworkPrimitives> BlockDownloaderProvider for NetworkHandle<N> {
464 type Client = FetchClient<N>;
465
466 async fn fetch_client(&self) -> Result<Self::Client, oneshot::error::RecvError> {
467 let (tx, rx) = oneshot::channel();
468 let _ = self.manager().send(NetworkHandleMessage::FetchClient(tx));
469 rx.await
470 }
471}
472
473#[derive(Debug)]
474struct NetworkInner<N: NetworkPrimitives = EthNetworkPrimitives> {
475 num_active_peers: Arc<AtomicUsize>,
477 to_manager_tx: UnboundedSender<NetworkHandleMessage<N>>,
479 listener_address: Arc<Mutex<SocketAddr>>,
481 secret_key: SecretKey,
483 local_peer_id: PeerId,
485 peers: PeersHandle,
487 network_mode: NetworkMode,
489 is_syncing: Arc<AtomicBool>,
491 initial_sync_done: Arc<AtomicBool>,
493 chain_id: Arc<AtomicU64>,
495 tx_gossip_disabled: bool,
497 discv4: Option<Discv4>,
499 discv5: Option<Discv5>,
501 event_sender: EventSender<NetworkEvent<PeerRequest<N>>>,
503 nat: Option<NatResolver>,
505}
506
507pub trait NetworkProtocols: Send + Sync {
509 fn add_rlpx_sub_protocol(&self, protocol: RlpxSubProtocol);
511}
512
513#[derive(Debug)]
515pub(crate) enum NetworkHandleMessage<N: NetworkPrimitives = EthNetworkPrimitives> {
516 AddTrustedPeerId(PeerId),
518 AddPeerAddress(PeerId, PeerKind, PeerAddr),
520 RemovePeer(PeerId, PeerKind),
522 DisconnectPeer(PeerId, Option<DisconnectReason>),
524 AnnounceBlock(N::NewBlockPayload, B256),
526 SendTransaction {
528 peer_id: PeerId,
530 msg: SharedTransactions<N::BroadcastedTransaction>,
532 },
533 SendPooledTransactionHashes {
535 peer_id: PeerId,
537 msg: NewPooledTransactionHashes,
539 },
540 EthRequest {
542 peer_id: PeerId,
544 request: PeerRequest<N>,
546 },
547 EthMessage {
549 peer_id: PeerId,
551 message: PeerMessage<N>,
553 },
554 ReputationChange(PeerId, ReputationChangeKind),
556 FetchClient(oneshot::Sender<FetchClient<N>>),
558 StatusUpdate {
560 head: Head,
562 },
563 GetStatus(oneshot::Sender<NetworkStatus>),
565 GetPeerInfosByIds(Vec<PeerId>, oneshot::Sender<Vec<PeerInfo>>),
567 GetPeerInfos(oneshot::Sender<Vec<PeerInfo>>),
569 GetPeerInfoById(PeerId, oneshot::Sender<Option<PeerInfo>>),
571 GetPeerInfosByPeerKind(PeerKind, oneshot::Sender<Vec<PeerInfo>>),
573 GetReputationById(PeerId, oneshot::Sender<Option<Reputation>>),
575 GetTransactionsHandle(oneshot::Sender<Option<TransactionsHandle<N>>>),
577 Shutdown(oneshot::Sender<()>),
579 SetNetworkState(NetworkConnectionState),
581 DiscoveryListener(UnboundedSender<DiscoveryEvent>),
583 AddRlpxSubProtocol(RlpxSubProtocol),
585 ConnectPeer(PeerId, PeerKind, PeerAddr),
587 InternalBlockRangeUpdate(BlockRangeUpdate),
589}