Struct Mailbox 

pub struct Mailbox<S: Scheme, B: Block> { /* private fields */ }

A mailbox for sending messages to the marshal Actor.

Implementations

impl<S: Scheme, B: Block> Mailbox<S, B>

pub async fn get_info( &mut self, identifier: impl Into<Identifier<B::Commitment>>, ) -> Option<(u64, B::Commitment)>

A request to retrieve the information about the highest finalized block.

pub async fn get_block( &mut self, identifier: impl Into<Identifier<B::Commitment>>, ) -> Option<B>

A best-effort attempt to retrieve a given block from local storage. It is not an indication to go fetch the block from the network.

pub async fn get_finalization( &mut self, height: u64, ) -> Option<Finalization<S, B::Commitment>>

A best-effort attempt to retrieve a given Finalization from local storage. It is not an indication to go fetch the Finalization from the network.

pub async fn hint_finalized( &mut self, height: u64, targets: NonEmptyVec<S::PublicKey>, )

Hints that a finalized block may be available at the given height.

This method will request the finalization from the network via the resolver if it is not available locally.

Targets are required because this is typically called when a peer claims to be ahead. By targeting only those peers, we limit who we ask. If a target returns invalid data, they will be blocked by the resolver. If targets don’t respond or return “no data”, they effectively rate-limit themselves.

Calling this multiple times for the same height with different targets will add to the target set if there is an ongoing fetch, allowing more peers to be tried.

This is fire-and-forget: the finalization will be stored in marshal and delivered via the normal finalization flow when available.

pub async fn subscribe( &mut self, round: Option<Round>, commitment: B::Commitment, ) -> Receiver<B>

A request to retrieve a block by its commitment.

If the block is found available locally, the block will be returned immediately.

If the block is not available locally, the request will be registered and the caller will be notified when the block is available. If the block is not finalized, it’s possible that it may never become available.

The oneshot receiver should be dropped to cancel the subscription.

pub async fn ancestry( &mut self, __arg1: (Option<Round>, B::Commitment), ) -> Option<AncestorStream<S, B>>

Returns an AncestorStream over the ancestry of a given block, leading up to genesis.

If the starting block is not found, None is returned.

pub async fn proposed(&mut self, round: Round, block: B)

Proposed requests that a proposed block is sent to all peers.

pub async fn verified(&mut self, round: Round, block: B)

Notifies the actor that a block has been verified.

pub async fn set_floor(&mut self, height: u64)

A request to set the sync floor (conditionally advances if higher).

The sync floor is the latest block that the application has processed. Marshal will not attempt to sync blocks below this height nor deliver blocks below this height to the application.

The default sync floor is height 0.

Trait Implementations

impl<S: Clone + Scheme, B: Clone + Block> Clone for Mailbox<S, B>

fn clone(&self) -> Mailbox<S, B>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S: Scheme, B: Block> Reporter for Mailbox<S, B>

type Activity = Activity<S, <B as Committable>::Commitment>

Activity is specified by the underlying consensus implementation and can be interpreted if desired.

async fn report(&mut self, activity: Self::Activity)

Report some activity observed by the consensus implementation.