Skip to main content

Engine

Struct Engine 

Source
pub struct Engine<E: Clock + CryptoRng + Spawner + Storage + Metrics, S: Scheme<D>, L: Config<S>, B: Blocker<PublicKey = S::PublicKey>, D: Digest, A: CertifiableAutomaton<Context = Context<D, S::PublicKey>, Digest = D>, R: Relay<Digest = D, PublicKey = S::PublicKey, Plan = Plan<S::PublicKey>>, F: Reporter<Activity = Activity<S, D>>, T: Strategy> { /* private fields */ }
Expand description

Instance of simplex consensus engine.

Implementations§

Source§

impl<E: Clock + CryptoRng + Spawner + Storage + Metrics, S: Scheme<D>, L: Config<S>, B: Blocker<PublicKey = S::PublicKey>, D: Digest, A: CertifiableAutomaton<Context = Context<D, S::PublicKey>, Digest = D>, R: Relay<Digest = D, PublicKey = S::PublicKey, Plan = Plan<S::PublicKey>>, F: Reporter<Activity = Activity<S, D>>, T: Strategy> Engine<E, S, L, B, D, A, R, F, T>

Source

pub fn new(context: E, cfg: Config<S, L, B, D, A, R, F, T>) -> Self

Create a new simplex consensus engine.

Source

pub fn start( self, vote_network: (impl Sender<PublicKey = S::PublicKey>, impl Receiver<PublicKey = S::PublicKey>), certificate_network: (impl Sender<PublicKey = S::PublicKey>, impl Receiver<PublicKey = S::PublicKey>), resolver_network: (impl Sender<PublicKey = S::PublicKey>, impl Receiver<PublicKey = S::PublicKey>), ) -> Handle<()> ⓘ

Start the simplex consensus engine.

This will also rebuild the state of the engine from provided Journal.

§Network Channels

The engine requires three separate network channels, each carrying votes or certificates to help drive the consensus engine.

§vote_network

Carries individual votes:

  • Notarize: Vote to notarize a proposal
  • Nullify: Vote to skip a view
  • Finalize: Vote to finalize a notarized proposal

These messages are sent to the batcher, which performs batch signature verification, assembles certificates from valid votes, and forwards proposals, certificates, and timeout hints to the voter.

§certificate_network

Carries certificates:

Certificates are broadcast on this channel as soon as they are constructed from collected votes. We separate this from the vote_network to optimistically allow for certificate processing to short-circuit vote processing (if we receive a certificate before processing pending votes, we can skip them).

§resolver_network

Used for request-response certificate fetching. When a node needs to catch up on a view it missed (e.g., to verify a proposal’s parent), it uses this channel to request certificates from peers. The resolver handles retries and peer selection for these requests.

All three channels must be scoped to this engine’s epoch. A message from another epoch blocks the sender on the vote and certificate channels, and the resolver rejects it as invalid, which also blocks the peer.

Auto Trait Implementations§

§

impl<E, S, L, B, D, A, R, F, T> !Freeze for Engine<E, S, L, B, D, A, R, F, T>

§

impl<E, S, L, B, D, A, R, F, T> !RefUnwindSafe for Engine<E, S, L, B, D, A, R, F, T>

§

impl<E, S, L, B, D, A, R, F, T> !UnwindSafe for Engine<E, S, L, B, D, A, R, F, T>

§

impl<E, S, L, B, D, A, R, F, T> Send for Engine<E, S, L, B, D, A, R, F, T>
where Cell<E>: Send, Actor<E, S, <L as Config<S>>::Elector, B, D, A, R, F>: Send, Mailbox<S, D>: Send, Actor<E, S, B, D, F, R, T>: Send, Mailbox<S, D>: Send, Actor<E, S, B, D, T>: Send, Mailbox<S, D>: Send,

§

impl<E, S, L, B, D, A, R, F, T> Sync for Engine<E, S, L, B, D, A, R, F, T>
where Cell<E>: Sync, Actor<E, S, <L as Config<S>>::Elector, B, D, A, R, F>: Sync, Mailbox<S, D>: Sync, Actor<E, S, B, D, F, R, T>: Sync, Mailbox<S, D>: Sync, Actor<E, S, B, D, T>: Sync, Mailbox<S, D>: Sync,

§

impl<E, S, L, B, D, A, R, F, T> Unpin for Engine<E, S, L, B, D, A, R, F, T>
where Cell<E>: Unpin, Actor<E, S, <L as Config<S>>::Elector, B, D, A, R, F>: Unpin, Mailbox<S, D>: Unpin, Actor<E, S, B, D, F, R, T>: Unpin, Mailbox<S, D>: Unpin, Actor<E, S, B, D, T>: Unpin, Mailbox<S, D>: Unpin,

§

impl<E, S, L, B, D, A, R, F, T> UnsafeUnpin for Engine<E, S, L, B, D, A, R, F, T>
where Cell<E>: UnsafeUnpin, Actor<E, S, <L as Config<S>>::Elector, B, D, A, R, F>: UnsafeUnpin, Mailbox<S, D>: UnsafeUnpin, Actor<E, S, B, D, F, R, T>: UnsafeUnpin, Mailbox<S, D>: UnsafeUnpin, Actor<E, S, B, D, T>: UnsafeUnpin, Mailbox<S, D>: UnsafeUnpin,

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

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.

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: Sized + 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: Sized + 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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> Threaded<T> for T

Source§

type Rest = ()

The outputs beyond the threaded value.
Source§

fn split(self) -> (T, ())

Splits into the threaded value and the extra outputs.
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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