mirror of
https://github.com/paradigmxyz/reth.git
synced 2026-01-29 17:18:08 -05:00
122 lines
3.9 KiB
Rust
122 lines
3.9 KiB
Rust
#![warn(missing_docs, unreachable_pub)]
|
|
#![deny(unused_must_use, rust_2018_idioms)]
|
|
#![doc(test(
|
|
no_crate_inject,
|
|
attr(deny(warnings, rust_2018_idioms), allow(dead_code, unused_variables))
|
|
))]
|
|
|
|
//! Reth network interface definitions.
|
|
//!
|
|
//! Provides abstractions for the reth-network crate.
|
|
|
|
use async_trait::async_trait;
|
|
use reth_eth_wire::DisconnectReason;
|
|
use reth_primitives::{NodeRecord, PeerId, H256, U256};
|
|
use std::net::SocketAddr;
|
|
|
|
#[cfg(feature = "serde")]
|
|
use serde::{Deserialize, Serialize};
|
|
|
|
pub use error::NetworkError;
|
|
pub use reputation::{Reputation, ReputationChangeKind};
|
|
|
|
/// Network Error
|
|
pub mod error;
|
|
/// Reputation score
|
|
pub mod reputation;
|
|
|
|
#[cfg(feature = "test-utils")]
|
|
/// Implementation of network traits for testing purposes.
|
|
pub mod test_utils;
|
|
|
|
/// Provides general purpose information about the network.
|
|
#[async_trait]
|
|
pub trait NetworkInfo: Send + Sync {
|
|
/// Returns the [`SocketAddr`] that listens for incoming connections.
|
|
fn local_addr(&self) -> SocketAddr;
|
|
|
|
/// Returns the current status of the network being ran by the local node.
|
|
async fn network_status(&self) -> Result<NetworkStatus, NetworkError>;
|
|
|
|
/// Returns the chain id
|
|
fn chain_id(&self) -> u64;
|
|
}
|
|
|
|
/// Provides general purpose information about Peers in the network.
|
|
pub trait PeersInfo: Send + Sync {
|
|
/// Returns how many peers the network is currently connected to.
|
|
///
|
|
/// Note: this should only include established connections and _not_ ongoing attempts.
|
|
fn num_connected_peers(&self) -> usize;
|
|
|
|
/// Returns the Ethereum Node Record of the node.
|
|
fn local_node_record(&self) -> NodeRecord;
|
|
}
|
|
|
|
/// Provides an API for managing the peers of the network.
|
|
pub trait Peers: PeersInfo {
|
|
/// Adds a peer to the peer set.
|
|
fn add_peer(&self, peer: PeerId, addr: SocketAddr) {
|
|
self.add_peer_kind(peer, PeerKind::Basic, addr);
|
|
}
|
|
|
|
/// Adds a trusted peer to the peer set.
|
|
fn add_trusted_peer(&self, peer: PeerId, addr: SocketAddr) {
|
|
self.add_peer_kind(peer, PeerKind::Trusted, addr);
|
|
}
|
|
|
|
/// Adds a peer to the known peer set, with the given kind.
|
|
fn add_peer_kind(&self, peer: PeerId, kind: PeerKind, addr: SocketAddr);
|
|
|
|
/// Removes a peer from the peer set that corresponds to given kind.
|
|
fn remove_peer(&self, peer: PeerId, kind: PeerKind);
|
|
|
|
/// Disconnect an existing connection to the given peer.
|
|
fn disconnect_peer(&self, peer: PeerId);
|
|
|
|
/// Disconnect an existing connection to the given peer using the provided reason
|
|
fn disconnect_peer_with_reason(&self, peer: PeerId, reason: DisconnectReason);
|
|
|
|
/// Send a reputation change for the given peer.
|
|
fn reputation_change(&self, peer_id: PeerId, kind: ReputationChangeKind);
|
|
}
|
|
|
|
/// Represents the kind of peer
|
|
#[derive(Debug, Clone, Copy, Default, Eq, PartialEq)]
|
|
pub enum PeerKind {
|
|
/// Basic peer kind.
|
|
#[default]
|
|
Basic,
|
|
/// Trusted peer.
|
|
Trusted,
|
|
}
|
|
|
|
/// The status of the network being ran by the local node.
|
|
#[derive(Clone, Debug, PartialEq, Eq)]
|
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
|
pub struct NetworkStatus {
|
|
/// The local node client version.
|
|
pub client_version: String,
|
|
/// The current ethereum protocol version
|
|
pub protocol_version: u64,
|
|
/// Information about the Ethereum Wire Protocol.
|
|
pub eth_protocol_info: EthProtocolInfo,
|
|
}
|
|
/// Information about the Ethereum Wire Protocol (ETH)
|
|
#[derive(Clone, Debug, PartialEq, Eq)]
|
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
|
pub struct EthProtocolInfo {
|
|
/// The current difficulty at the head of the chain.
|
|
#[cfg_attr(
|
|
feature = "serde",
|
|
serde(deserialize_with = "reth_primitives::serde_helper::deserialize_json_u256")
|
|
)]
|
|
pub difficulty: U256,
|
|
/// The block hash of the head of the chain.
|
|
pub head: H256,
|
|
/// Network ID in base 10.
|
|
pub network: u64,
|
|
/// Genesis block of the current chain.
|
|
pub genesis: H256,
|
|
}
|