Struct lumina_node::p2p::P2p

source ·
pub struct P2p<S>
where S: Store + 'static,
{ /* private fields */ }
Expand description

Component responsible for the peer to peer networking handling.

Implementations§

source§

impl<S> P2p<S>
where S: Store,

source

pub fn start(args: P2pArgs<S>) -> Result<Self, P2pError>

Creates and starts a new p2p handler.

source

pub fn mocked() -> (Self, MockP2pHandle)

Creates and starts a new mocked p2p handler.

source

pub async fn stop(&self) -> Result<(), P2pError>

Stop the P2p.

source

pub fn local_peer_id(&self) -> &PeerId

Local peer ID on the p2p network.

source

pub fn header_sub_watcher(&self) -> Receiver<Option<ExtendedHeader>>

Watcher for the latest verified network head headers announced on header-sub.

source

pub fn peer_tracker_info_watcher(&self) -> Receiver<PeerTrackerInfo>

Watcher for the current PeerTrackerInfo.

source

pub fn peer_tracker_info(&self) -> Ref<'_, PeerTrackerInfo>

A reference to the current PeerTrackerInfo.

source

pub async fn init_header_sub( &self, head: ExtendedHeader ) -> Result<(), P2pError>

Initializes header-sub protocol with a given subjective_head.

source

pub async fn wait_connected(&self) -> Result<(), P2pError>

Wait until the node is connected to any peer.

source

pub async fn wait_connected_trusted(&self) -> Result<(), P2pError>

Wait until the node is connected to any trusted peer.

source

pub async fn network_info(&self) -> Result<NetworkInfo, P2pError>

Get current [NetworkInfo].

source

pub async fn header_ex_request( &self, request: HeaderRequest ) -> Result<Vec<ExtendedHeader>, P2pError>

Send a request on the header-ex protocol.

source

pub async fn get_head_header(&self) -> Result<ExtendedHeader, P2pError>

Request the head header on the header-ex protocol.

source

pub async fn get_header(&self, hash: Hash) -> Result<ExtendedHeader, P2pError>

Request the header by hash on the header-ex protocol.

source

pub async fn get_header_by_height( &self, height: u64 ) -> Result<ExtendedHeader, P2pError>

Request the header by height on the header-ex protocol.

source

pub async fn get_verified_headers_range( &self, from: &ExtendedHeader, amount: u64 ) -> Result<Vec<ExtendedHeader>, P2pError>

Request the headers following the one given with the header-ex protocol.

First header from the requested range will be verified against the provided one, then each subsequent is verified against the previous one.

source

pub async fn listeners(&self) -> Result<Vec<Multiaddr>, P2pError>

Get the addresses where P2p listens on for incoming connections.

source

pub async fn connected_peers(&self) -> Result<Vec<PeerId>, P2pError>

Get the list of connected peers.

source

pub async fn set_peer_trust( &self, peer_id: PeerId, is_trusted: bool ) -> Result<(), P2pError>

Alter the trust status for a given peer.

Trait Implementations§

source§

impl<S> Debug for P2p<S>
where S: Store + 'static + Debug,

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<S> !RefUnwindSafe for P2p<S>

§

impl<S> Send for P2p<S>

§

impl<S> Sync for P2p<S>

§

impl<S> Unpin for P2p<S>
where S: Unpin,

§

impl<S> !UnwindSafe for P2p<S>

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
§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

§

fn implicit( self, class: Class, constructed: bool, tag: u32 ) -> TaggedParser<'a, Implicit, Self, E>

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> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

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.

§

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

impl<T> Same for T

§

type Output = T

Should always be Self
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

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