Struct Finalization 

pub struct Finalization<S: Scheme, D: Digest> {
    pub proposal: Proposal<D>,
    pub certificate: S::Certificate,
}

Aggregated finalization certificate recovered from finalize votes. When a proposal is finalized, it becomes the canonical block for its view.

Some signing schemes embed an additional randomness seed in the certificate (used for leader rotation), it can be accessed via Scheme::seed.

Fields

proposal: Proposal<D>

The proposal that has been finalized.

certificate: S::Certificate

The recovered certificate for the proposal.

Implementations

impl<S: Scheme, D: Digest> Finalization<S, D>

pub fn from_finalizes<'a>( scheme: &S, finalizes: impl IntoIterator<Item = &'a Finalize<S, D>>, ) -> Option<Self>

Builds a finalization certificate from finalize votes for the same proposal.

pub fn round(&self) -> Round

Returns the round associated with the finalized proposal.

impl<S: Scheme, D: Digest> Finalization<S, D>

pub fn verify<R: Rng + CryptoRng>( &self, rng: &mut R, scheme: &S, namespace: &[u8], ) -> bool

Verifies the finalization certificate against the provided signing scheme.

This ensures that the certificate is valid for the claimed proposal.

Trait Implementations

impl<S: Clone + Scheme, D: Clone + Digest> Clone for Finalization<S, D>

where S::Certificate: Clone,

fn clone(&self) -> Finalization<S, D>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S: Debug + Scheme, D: Debug + Digest> Debug for Finalization<S, D>

where S::Certificate: Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<S: Scheme, D: Digest> EncodeSize for Finalization<S, D>

fn encode_size(&self) -> usize

Returns the encoded size of this value (in bytes).

impl<S: Scheme, D: Digest> Epochable for Finalization<S, D>

type Epoch = u64

Epoch is the type used to indicate a contiguous sequence of views in which the set of validators is constant.

fn epoch(&self) -> Epoch

Returns the epoch associated with this object.

impl<S: Scheme, D: Digest> Hash for Finalization<S, D>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<S: Scheme, D: Digest> PartialEq for Finalization<S, D>

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<S: Scheme, D: Digest> Read for Finalization<S, D>

type Cfg = <<S as Scheme>::Certificate as Read>::Cfg

The Cfg type parameter allows passing configuration during the read process. This is crucial for safely decoding untrusted data, for example, by providing size limits for collections or strings.

fn read_cfg(reader: &mut impl Buf, cfg: &Self::Cfg) -> Result<Self, Error>

Reads a value from the buffer using the provided configuration cfg.

impl<P: PublicKey, V: Variant, D: Digest> Seedable<V> for Finalization<Scheme<P, V>, D>

fn seed(&self) -> Seed<V>

Returns the seed associated with this object.

impl<S: Scheme, D: Digest> Viewable for Finalization<S, D>

type View = u64

View is the type used to indicate the in-progress consensus decision.

fn view(&self) -> View

Returns the view associated with this object.

impl<S: Scheme, D: Digest> Write for Finalization<S, D>

fn write(&self, writer: &mut impl BufMut)

Writes the binary representation of self to the provided buffer buf.

impl<S: Scheme, D: Digest> Eq for Finalization<S, D>