Marshaled

Struct Marshaled 

Source
pub struct Marshaled<E, S, A, B, ES>
where E: Rng + Spawner + Metrics + Clock, S: Scheme, A: Application<E>, B: Block, ES: Epocher,
{ /* private fields */ }
Expand description

An Application adapter that handles epoch transitions and validates block ancestry.

This wrapper intercepts consensus operations to enforce epoch boundaries and validate block ancestry. It prevents blocks from being produced outside their valid epoch, handles the special case of re-proposing boundary blocks during epoch transitions, and ensures all blocks have valid parent linkage and contiguous heights.

§Ancestry Validation

Applications wrapped by Marshaled can rely on the following ancestry checks being performed automatically during verification:

  • Parent commitment matches the consensus context’s expected parent
  • Block height is exactly one greater than the parent’s height

Verifying only the immediate parent is sufficient since the parent itself must have been notarized by consensus, which guarantees it was verified and accepted by a quorum. This means the entire ancestry chain back to genesis is transitively validated.

Applications do not need to re-implement these checks in their own verification logic.

Implementations§

Source§

impl<E, S, A, B, ES> Marshaled<E, S, A, B, ES>
where E: Rng + Spawner + Metrics + Clock, S: Scheme, A: Application<E, Block = B, Context = Context<B::Commitment, S::PublicKey>>, B: Block, ES: Epocher,

Source

pub fn new( context: E, application: A, marshal: Mailbox<S, B>, epocher: ES, ) -> Self

Creates a new Marshaled wrapper.

Trait Implementations§

Source§

impl<E, S, A, B, ES> Automaton for Marshaled<E, S, A, B, ES>
where E: Rng + Spawner + Metrics + Clock, S: Scheme, A: VerifyingApplication<E, Block = B, SigningScheme = S, Context = Context<B::Commitment, S::PublicKey>>, B: Block, ES: Epocher,

Source§

async fn genesis(&mut self, epoch: Epoch) -> Self::Digest

Returns the genesis commitment for a given epoch.

For epoch 0, this returns the application’s genesis block commitment. For subsequent epochs, it returns the commitment of the last block from the previous epoch, which serves as the genesis block for the new epoch.

§Panics

Panics if a non-zero epoch is requested but the previous epoch’s final block is not available in storage. This indicates a critical error in the consensus engine startup sequence, as engines must always have the genesis block before starting.

Source§

async fn propose( &mut self, consensus_context: Context<Self::Digest, S::PublicKey>, ) -> Receiver<Self::Digest>

Proposes a new block or re-proposes the epoch boundary block.

This method builds a new block from the underlying application unless the parent block is the last block in the current epoch. When at an epoch boundary, it re-proposes the boundary block to avoid creating blocks that would be invalidated by the epoch transition.

The proposal operation is spawned in a background task and returns a receiver that will contain the proposed block’s commitment when ready. The built block is cached for later broadcasting.

Source§

async fn verify( &mut self, context: Context<Self::Digest, S::PublicKey>, digest: Self::Digest, ) -> Receiver<bool>

Verifies a proposed block within epoch boundaries.

This method validates that:

  1. The block is within the current epoch (unless it’s a boundary block re-proposal)
  2. Re-proposals are only allowed for the last block in an epoch
  3. The block’s parent commitment matches the consensus context’s expected parent
  4. The block’s height is exactly one greater than the parent’s height
  5. The underlying application’s verification logic passes

Verification is spawned in a background task and returns a receiver that will contain the verification result. Valid blocks are reported to the marshal as verified.

Source§

type Digest = <B as Committable>::Commitment

Hash of an arbitrary payload.
Source§

type Context = Context<<Marshaled<E, S, A, B, ES> as Automaton>::Digest, <S as Scheme>::PublicKey>

Context is metadata provided by the consensus engine associated with a given payload. Read more
Source§

impl<E, S, A, B, ES> CertifiableAutomaton for Marshaled<E, S, A, B, ES>
where E: Rng + Spawner + Metrics + Clock, S: Scheme, A: VerifyingApplication<E, Block = B, SigningScheme = S, Context = Context<B::Commitment, S::PublicKey>>, B: Block, ES: Epocher,

Source§

fn certify( &mut self, _payload: Self::Digest, ) -> impl Future<Output = Receiver<bool>> + Send

Determine whether a verified payload is safe to commit. Read more
Source§

impl<E, S, A, B, ES> Clone for Marshaled<E, S, A, B, ES>
where E: Rng + Spawner + Metrics + Clock + Clone, S: Scheme + Clone, A: Application<E> + Clone, B: Block + Clone, ES: Epocher + Clone,

Source§

fn clone(&self) -> Marshaled<E, S, A, B, ES>

Returns a duplicate of the value. Read more
1.0.0§

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

Performs copy-assignment from source. Read more
Source§

impl<E, S, A, B, ES> Relay for Marshaled<E, S, A, B, ES>
where E: Rng + Spawner + Metrics + Clock, S: Scheme, A: Application<E, Block = B, Context = Context<B::Commitment, S::PublicKey>>, B: Block, ES: Epocher,

Source§

async fn broadcast(&mut self, commitment: Self::Digest)

Broadcasts a previously built block to the network.

This uses the cached block from the last proposal operation. If no block was built or the commitment does not match the cached block, the broadcast is skipped with a warning.

Source§

type Digest = <B as Committable>::Commitment

Hash of an arbitrary payload.
Source§

impl<E, S, A, B, ES> Reporter for Marshaled<E, S, A, B, ES>
where E: Rng + Spawner + Metrics + Clock, S: Scheme, A: Application<E, Block = B, Context = Context<B::Commitment, S::PublicKey>> + Reporter<Activity = Update<B>>, B: Block, ES: Epocher,

Source§

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

Relays a report to the underlying Application.

Source§

type Activity = <A as Reporter>::Activity

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

Auto Trait Implementations§

§

impl<E, S, A, B, ES> Freeze for Marshaled<E, S, A, B, ES>
where E: Freeze, A: Freeze, ES: Freeze,

§

impl<E, S, A, B, ES> !RefUnwindSafe for Marshaled<E, S, A, B, ES>

§

impl<E, S, A, B, ES> Send for Marshaled<E, S, A, B, ES>

§

impl<E, S, A, B, ES> Sync for Marshaled<E, S, A, B, ES>
where A: Sync,

§

impl<E, S, A, B, ES> Unpin for Marshaled<E, S, A, B, ES>
where E: Unpin, A: Unpin, ES: Unpin,

§

impl<E, S, A, B, ES> !UnwindSafe for Marshaled<E, S, A, B, ES>

Blanket Implementations§

§

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

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

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

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

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

§

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

Mutably borrows from an owned value. Read more
§

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

§

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
§

impl<T> From<T> for T

§

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
§

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

§

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§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

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

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

Source§

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

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

Source§

type Output = T

Should always be Self
§

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

§

type Owned = T

The resulting type after obtaining ownership.
§

fn to_owned(&self) -> T

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

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

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

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

§

type Error = Infallible

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

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

Performs the conversion.
§

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

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

Performs the conversion.
Source§

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

Source§

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

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,