Struct reth::network::NetworkHandle

pub struct NetworkHandle { /* private fields */ }
Expand description

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

See also NetworkManager.

Implementations§

§

impl NetworkHandle

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

Returns the [PeerId] used in the network.

pub fn peers_handle(&self) -> &PeersHandle

Returns the PeersHandle that can be cloned and shared.

The PeersHandle can be used to interact with the network’s peer set.

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

Returns a new FetchClient that can be cloned and shared.

The FetchClient is the entrypoint for sending requests to 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, 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)

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<TransactionSigned>>, )

Send full transactions to the peer

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

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 Clone for NetworkHandle

§

fn clone(&self) -> NetworkHandle

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
§

impl Debug for NetworkHandle

§

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

Formats the value using the given formatter. Read more
§

impl NetworkEvents for NetworkHandle

§

fn event_listener(&self) -> EventStream<NetworkEvent>

Creates a new NetworkEvent listener channel.
§

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

Returns a new DiscoveryEvent stream. Read more
§

impl NetworkInfo for NetworkHandle

§

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 NetworkProtocols for NetworkHandle

§

fn add_rlpx_sub_protocol(&self, protocol: RlpxSubProtocol)

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

impl NetworkSyncUpdater for NetworkHandle

§

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 Peers for NetworkHandle

§

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 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. Read more
§

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. Read more
§

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. Read more
§

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

Get the reputation of a peer.
source§

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

Adds a peer to the peer set with UDP SocketAddr.
source§

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.
source§

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

Adds a trusted peer to the peer set with UDP SocketAddr.
source§

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.
source§

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

Returns the rpc PeerInfo for all connected PeerKind::Trusted peers.
source§

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

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

impl PeersInfo for NetworkHandle

§

fn num_connected_peers(&self) -> usize

Returns how many peers the network is currently connected to. Read more
§

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 SyncStateProvider for NetworkHandle

§

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.

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit #126799)
Performs copy-assignment from self to dst. Read more
§

impl<T> Conv for T

§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
source§

impl<T> DynClone for T
where T: Clone,

source§

fn __clone_box(&self, _: Private) -> *mut ()

§

impl<T> FmtForward for T

§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pipe for T
where T: ?Sized,

§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
source§

impl<T> Same for T

§

type Output = T

Should always be Self
§

impl<T> Tap for T

§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
§

impl<T> TryClone for T
where T: Clone,

§

fn try_clone(&self) -> Result<T, Error>

Clones self, possibly returning an error.
§

impl<T> TryConv for T

§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
§

impl<T> ErasedDestructor for T
where T: 'static,

§

impl<T> MaybeDebug for T
where T: Debug,

§

impl<T> MaybeSend for T
where T: Send,

§

impl<T> MaybeSendSync for T

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