Struct NetworkHandle

pub struct NetworkHandle<N = EthNetworkPrimitives>
where
    N: NetworkPrimitives,
{ /* private fields */ }

A shareable network frontend. Used to interact with the network.

See also NetworkManager.

Implementations

impl<N> NetworkHandle<N>

where N: NetworkPrimitives,

pub fn peer_id(&self) -> &FixedBytes<64>

Returns the [PeerId] used in the network.

pub fn mode(&self) -> &NetworkMode

Returns the mode of the network, either pow, or pos

pub fn update_status(&self, head: Head)

Update the status of the node.

pub fn announce_block( &self, block: NewBlock<<N as NetworkPrimitives>::Block>, hash: FixedBytes<32>, )

Announce a block over devp2p

Caution: in PoS this is a noop because new blocks are no longer announced over devp2p. Instead they are sent to the node by CL and can be requested over devp2p. Broadcasting new blocks is considered a protocol violation.

pub fn send_request(&self, peer_id: FixedBytes<64>, request: PeerRequest<N>)

Sends a PeerRequest to the given peer’s session.

pub fn send_transactions_hashes( &self, peer_id: FixedBytes<64>, msg: NewPooledTransactionHashes, )

Send transactions hashes to the peer.

pub fn send_transactions( &self, peer_id: FixedBytes<64>, msg: Vec<Arc<<N as NetworkPrimitives>::BroadcastedTransaction>>, )

Send full transactions to the peer

pub fn send_eth_message(&self, peer_id: FixedBytes<64>, message: PeerMessage<N>)

Send eth message to the peer.

pub async fn transactions_handle(&self) -> Option<TransactionsHandle<N>>

Send message to get the TransactionsHandle.

Returns None if no transaction task is installed.

pub async fn shutdown(&self) -> Result<(), RecvError>

Send message to gracefully shutdown node.

This will disconnect all active and pending sessions and prevent new connections to be established.

pub fn set_network_active(&self)

Set network connection state to Active.

New outbound connections will be established if there’s capacity.

pub fn set_network_hibernate(&self)

Set network connection state to Hibernate.

No new outbound connections will be established.

pub fn tx_gossip_disabled(&self) -> bool

Whether tx gossip is disabled

pub fn secret_key(&self) -> &SecretKey

Returns the secret key used for authenticating sessions.

Trait Implementations

impl<N> BlockDownloaderProvider for NetworkHandle<N>

where N: NetworkPrimitives,

type Client = FetchClient<N>

The client this type can provide.

async fn fetch_client( &self, ) -> Result<<NetworkHandle<N> as BlockDownloaderProvider>::Client, RecvError>

Returns a new [BlockClient], used for fetching blocks from peers.

impl<N> Clone for NetworkHandle<N>

where N: Clone + NetworkPrimitives,

fn clone(&self) -> NetworkHandle<N>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<N> Debug for NetworkHandle<N>

where N: Debug + NetworkPrimitives,

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

Formats the value using the given formatter.

impl<N> NetworkEventListenerProvider for NetworkHandle<N>

where N: NetworkPrimitives,

type Primitives = N

The primitive types to use in the PeerRequest used in the stream.

fn event_listener( &self, ) -> EventStream<NetworkEvent<PeerRequest<<NetworkHandle<N> as NetworkEventListenerProvider>::Primitives>>>

Creates a new NetworkEvent listener channel.

fn discovery_listener(&self) -> UnboundedReceiverStream<DiscoveryEvent>

Returns a new DiscoveryEvent stream.

impl<N> NetworkInfo for NetworkHandle<N>

where N: NetworkPrimitives,

fn local_addr(&self) -> SocketAddr

Returns the SocketAddr that listens for incoming connections.

async fn network_status(&self) -> Result<NetworkStatus, NetworkError>

Returns the current status of the network being ran by the local node.

fn chain_id(&self) -> u64

Returns the chain id

fn is_syncing(&self) -> bool

Returns true if the network is undergoing sync.

fn is_initially_syncing(&self) -> bool

Returns true when the node is undergoing the very first Pipeline sync.

impl<N> NetworkPeersEvents for NetworkHandle<N>

where N: NetworkPrimitives,

fn peer_events(&self) -> PeerEventStream

Returns an event stream of peer-specific network events.

impl<N> NetworkProtocols for NetworkHandle<N>

where N: NetworkPrimitives,

fn add_rlpx_sub_protocol(&self, protocol: RlpxSubProtocol)

Adds an additional protocol handler to the RLPx sub-protocol list.

impl<N> NetworkSyncUpdater for NetworkHandle<N>

where N: NetworkPrimitives,

fn update_status(&self, head: Head)

Update the status of the node.

fn update_sync_state(&self, state: SyncState)

Notifies about a SyncState update.

impl<N> Peers for NetworkHandle<N>

where N: NetworkPrimitives,

fn add_peer_kind( &self, peer: FixedBytes<64>, kind: PeerKind, tcp_addr: SocketAddr, udp_addr: Option<SocketAddr>, )

Sends a message to the NetworkManager to add a peer to the known set, with the given kind.

fn remove_peer(&self, peer: FixedBytes<64>, kind: PeerKind)

Sends a message to the NetworkManager to remove a peer from the set corresponding to given kind.

fn disconnect_peer(&self, peer: FixedBytes<64>)

Sends a message to the NetworkManager to disconnect an existing connection to the given peer.

fn disconnect_peer_with_reason( &self, peer: FixedBytes<64>, reason: DisconnectReason, )

Sends a message to the NetworkManager to disconnect an existing connection to the given peer using the provided reason

fn connect_peer_kind( &self, peer_id: FixedBytes<64>, kind: PeerKind, tcp_addr: SocketAddr, udp_addr: Option<SocketAddr>, )

Sends a message to the NetworkManager to connect to the given peer.

fn reputation_change(&self, peer_id: FixedBytes<64>, kind: ReputationChangeKind)

Send a reputation change for the given peer.

fn add_trusted_peer_id(&self, peer: FixedBytes<64>)

Adds a trusted PeerId to the peer set.

async fn get_peers_by_kind( &self, kind: PeerKind, ) -> Result<Vec<PeerInfo>, NetworkError>

Returns the rpc PeerInfo for all connected peers with the given kind.

async fn get_all_peers(&self) -> Result<Vec<PeerInfo>, NetworkError>

Returns the rpc PeerInfo for all connected peers.

async fn get_peer_by_id( &self, peer_id: FixedBytes<64>, ) -> Result<Option<PeerInfo>, NetworkError>

Returns the rpc PeerInfo for the given peer id.

async fn get_peers_by_id( &self, peer_ids: Vec<FixedBytes<64>>, ) -> Result<Vec<PeerInfo>, NetworkError>

Returns the rpc PeerInfo for the given peers if they are connected.

async fn reputation_by_id( &self, peer_id: FixedBytes<64>, ) -> Result<Option<i32>, NetworkError>

Get the reputation of a peer.

fn add_peer(&self, peer: FixedBytes<64>, tcp_addr: SocketAddr)

Adds a peer to the peer set with TCP SocketAddr.

fn add_peer_with_udp( &self, peer: FixedBytes<64>, tcp_addr: SocketAddr, udp_addr: SocketAddr, )

Adds a peer to the peer set with TCP and UDP SocketAddr.

fn add_trusted_peer(&self, peer: FixedBytes<64>, tcp_addr: SocketAddr)

Adds a trusted peer to the peer set with TCP SocketAddr.

fn add_trusted_peer_with_udp( &self, peer: FixedBytes<64>, tcp_addr: SocketAddr, udp_addr: SocketAddr, )

Adds a trusted peer with TCP and UDP SocketAddr to the peer set.

fn get_trusted_peers( &self, ) -> impl Future<Output = Result<Vec<PeerInfo>, NetworkError>> + Send

Returns the rpc PeerInfo for all connected [PeerKind::Trusted] peers.

fn get_basic_peers( &self, ) -> impl Future<Output = Result<Vec<PeerInfo>, NetworkError>> + Send

Returns the rpc PeerInfo for all connected [PeerKind::Basic] peers.

fn connect_peer(&self, peer: FixedBytes<64>, tcp_addr: SocketAddr)

Connect to the given peer. NOTE: if the maximum number out outbound sessions is reached, this won’t do anything. See reth_network::SessionManager::dial_outbound.

impl<N> PeersHandleProvider for NetworkHandle<N>

where N: NetworkPrimitives,

fn peers_handle(&self) -> &PeersHandle

Returns the PeersHandle that can be cloned and shared.

impl<N> PeersInfo for NetworkHandle<N>

where N: NetworkPrimitives,

fn num_connected_peers(&self) -> usize

Returns how many peers the network is currently connected to.

fn local_node_record(&self) -> NodeRecord

Returns the Ethereum Node Record of the node.

fn local_enr(&self) -> Enr<SecretKey>

Returns the local ENR of the node.

impl<N> SyncStateProvider for NetworkHandle<N>

where N: NetworkPrimitives,

fn is_syncing(&self) -> bool

Returns true if the network is undergoing sync.

fn is_initially_syncing(&self) -> bool

Returns true if the network is undergoing an initial (pipeline) sync.

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: 8 bytes