Struct Finalize

pub struct Finalize<V: Variant, D: Digest> {
    pub proposal: Proposal<D>,
    pub proposal_signature: PartialSignature<V>,
}

Finalize represents a validator’s vote to finalize a proposal. This happens after a proposal has been notarized, confirming it as the canonical block for this view. It contains a partial signature on the proposal.

Fields

proposal: Proposal<D>

The proposal to be finalized

proposal_signature: PartialSignature<V>

The validator’s partial signature on the proposal

Implementations

impl<V: Variant, D: Digest> Finalize<V, D>

pub fn new( proposal: Proposal<D>, proposal_signature: PartialSignature<V>, ) -> Self

Creates a new finalize with the given proposal and signature.

pub fn verify(&self, namespace: &[u8], polynomial: &[V::Public]) -> bool

Verifies the PartialSignature on this Finalize.

This ensures that the signature is valid for the given proposal.

pub fn verify_multiple( namespace: &[u8], polynomial: &[V::Public], finalizes: Vec<Finalize<V, D>>, ) -> (Vec<Finalize<V, D>>, Vec<u32>)

Verifies a batch of Finalize messages using BLS aggregate verification.

This function verifies a batch of Finalize messages using BLS aggregate verification. It returns a tuple containing:

• A vector of successfully verified Finalize messages.
• A vector of signer indices for whom verification failed.

pub fn sign(namespace: &[u8], share: &Share, proposal: Proposal<D>) -> Self

Creates a PartialSignature over this Finalize.

Trait Implementations

impl<V: Variant, D: Digest> Attributable for Finalize<V, D>

fn signer(&self) -> u32

Returns the index of the signer (validator) who produced this message.

impl<V: Clone + Variant, D: Clone + Digest> Clone for Finalize<V, D>

fn clone(&self) -> Finalize<V, D>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<V: Debug + Variant, D: Debug + Digest> Debug for Finalize<V, D>

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

Formats the value using the given formatter.

impl<V: Variant, D: Digest> EncodeSize for Finalize<V, D>

fn encode_size(&self) -> usize

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

impl<V: Hash + Variant, D: Hash + Digest> Hash for Finalize<V, 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<V: PartialEq + Variant, D: PartialEq + Digest> PartialEq for Finalize<V, D>

fn eq(&self, other: &Finalize<V, D>) -> 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<V: Variant, D: Digest> Read for Finalize<V, D>

type 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, _: &()) -> Result<Self, Error>

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

impl<V: Variant, D: Digest> Viewable for Finalize<V, D>

fn view(&self) -> View

Returns the view associated with this object.

impl<V: Variant, D: Digest> Write for Finalize<V, D>

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

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

impl<V: Eq + Variant, D: Eq + Digest> Eq for Finalize<V, D>

impl<V: Variant, D: Digest> StructuralPartialEq for Finalize<V, D>