Struct Mailbox 

pub struct Mailbox<S: Scheme, V: Variant> { /* private fields */ }

A mailbox for sending messages to the marshal Actor.

Implementations

impl<S: Scheme, V: Variant> Mailbox<S, V>

pub async fn get_info( &self, identifier: impl Into<Identifier<<V::Block as Digestible>::Digest>>, ) -> Option<(Height, <V::Block as Digestible>::Digest)>

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

pub async fn get_block( &self, identifier: impl Into<Identifier<<V::Block as Digestible>::Digest>>, ) -> Option<V::Block>

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( &self, height: Height, ) -> Option<Finalization<S, V::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( &self, height: Height, 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.

The height must be covered by both the epocher and the provider. If the epocher cannot map the height to an epoch, or the provider cannot supply a scheme for that epoch, the hint is silently dropped.

pub async fn subscribe_by_digest( &self, round: Option<Round>, digest: <V::Block as Digestible>::Digest, ) -> Receiver<V::Block>

Subscribe to a block by its digest.

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 subscribe_by_commitment( &self, round: Option<Round>, commitment: V::Commitment, ) -> Receiver<V::Block>

Subscribe to 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( &self, __arg1: (Option<Round>, <V::Block as Digestible>::Digest), ) -> Option<AncestorStream<Self, V::ApplicationBlock>>

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(&self, round: Round, block: V::Block)

Requests that a proposed block is sent to peers.

pub async fn verified(&self, round: Round, block: V::Block)

Notifies the actor that a block has been verified.

pub async fn set_floor(&self, height: Height)

Sets the sync starting point (advances if higher than current).

Marshal will sync and deliver blocks starting at floor + 1. Data below the floor is pruned.

To prune data without affecting the sync starting point (say at some trailing depth from tip), use Self::prune instead.

The default floor is 0.

pub async fn prune(&self, height: Height)

Prunes finalized blocks and certificates below the given height.

Unlike Self::set_floor, this does not affect the sync starting point. The height must be at or below the current floor (last processed height), otherwise the prune request is ignored.

A prune request for a height above marshal’s current floor is dropped.

pub async fn forward( &self, round: Round, commitment: V::Commitment, peers: Vec<S::PublicKey>, )

Forward a block to a set of peers.

Trait Implementations

impl<S: Scheme, V: Variant> BlockProvider for Mailbox<S, V>

type Block = <V as Variant>::ApplicationBlock

The block type the provider fetches.

async fn fetch_block( self, digest: <V::Block as Digestible>::Digest, ) -> Option<Self::Block>

A request to retrieve a block by its digest.

impl<S: Clone + Scheme, V: Clone + Variant> Clone for Mailbox<S, V>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S: Scheme, V: Variant> Reporter for Mailbox<S, V>

type Activity = Activity<S, <V as Variant>::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.