commonware_p2p::authenticated::discovery

Struct Oracle

pub struct Oracle<E: Spawner + Metrics, C: PublicKey> { /* private fields */ }

Expand description

Mechanism to register authorized peers.

Peers that are not explicitly authorized will be blocked by commonware-p2p.

Implementations§

Source §

impl<E: Spawner + Metrics, C: PublicKey> Oracle<E, C>

Source

pub async fn register(&mut self, index: u64, peers: Vec<C>)

Register a set of authorized peers at a given index.

These peer sets are used to construct a bit vector (sorted by public key) to share knowledge about dialable IPs. If a peer does not yet have an index associated with a bit vector, the discovery message will be dropped.

§Parameters

index - Index of the set of authorized peers (like a blockchain height). Should be monotonically increasing.
peers - Vector of authorized peers at an index (does not need to be sorted).

Trait Implementations§

Source §

impl<E: Spawner + Metrics, C: PublicKey> Blocker for Oracle<E, C>

Source §

type PublicKey = C

Public key type used to identify peers.

Source §

async fn block(&mut self, public_key: Self::PublicKey)

Block a peer, disconnecting them if currently connected and preventing future connections.

Source §

impl<E: Clone + Spawner + Metrics, C: Clone + PublicKey> Clone for Oracle<E, C>

Source §

fn clone(&self) -> Oracle<E, C>

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

§

impl<E, C> !UnwindSafe for Oracle<E, C>

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 §

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

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

Source §

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.

Source §

impl<T> FutureExt for T

Source §

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more

Source §

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext 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 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

Source §