Struct Nullification 

pub struct Nullification<S: Scheme> {
    pub round: Round,
    pub certificate: S::Certificate,
}

Aggregated nullification certificate recovered from nullify votes. When a view is nullified, consensus moves to the first view of the next term without finalizing a block (the next view when term_length is 1); a nullification covers the nullified view and the rest of its term.

Fields

round: Round

The round in which this nullification is made.

certificate: S::Certificate

The recovered certificate for the nullification.

Implementations

impl<S: Scheme> Nullification<S>

pub fn max_encode_size(participants: u32) -> usize

Returns an upper bound on the encoded size of a nullification for a committee of at most participants.

pub fn from_owned_nullifies<I>( scheme: &S, nullifies: NonEmpty<I>, strategy: &impl Strategy, ) -> Result<Self, AssemblyError>

where I: Iterator<Item = Nullify<S>> + Send,

Builds a nullification certificate from non-empty owned nullify votes from the same round, consuming the votes to avoid cloning each attestation.

pub fn from_nullifies<'a, I>( scheme: &S, nullifies: NonEmpty<I>, strategy: &impl Strategy, ) -> Result<Self, AssemblyError>

where I: Iterator<Item = &'a Nullify<S>> + Send,

Builds a nullification certificate from non-empty nullify votes from the same round.

pub fn verify<R: CryptoRng, D: Digest>( &self, rng: &mut R, scheme: &impl CertificateVerifier<D, Certificate = S::Certificate>, strategy: &impl Strategy, ) -> bool

Verifies the nullification certificate against the provided signing scheme.

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

pub const fn round(&self) -> Round

Returns the round associated with this nullification.

Trait Implementations

impl<S: Clone + Scheme> Clone for Nullification<S>

where S::Certificate: Clone,

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S: Debug + Scheme> Debug for Nullification<S>

where S::Certificate: Debug,

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

Formats the value using the given formatter.

impl<S: Scheme> EncodeSize for Nullification<S>

fn encode_size(&self) -> usize

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

fn encode_inline_size(&self) -> usize

Returns the encoded size excluding bytes passed to BufsMut::push during Write::write_bufs. Used to size the fixed working buffer for inline writes, so it must not be less than the bytes written inline. Override alongside Write::write_bufs for types where large byte fields go via push, or the working buffer will over-allocate.

impl<S: Scheme> Epochable for Nullification<S>

fn epoch(&self) -> Epoch

Returns the epoch associated with this object.

impl<S: Scheme> Eq for Nullification<S>

impl<S: Scheme> Hash for Nullification<S>

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> PartialEq for Nullification<S>

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

Equality operator ==.

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

Inequality operator !=.

impl<S: Scheme> Read for Nullification<S>

type Cfg = <<S as Verifier>::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<S: Scheme> Viewable for Nullification<S>

fn view(&self) -> View

Returns the view associated with this object.

impl<S: Scheme> Write for Nullification<S>

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

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

fn write_bufs(&self, buf: &mut impl BufsMut)

Writes to a BufsMut, allowing existing byte chunks to be appended via BufsMut::push instead of written inline. Must encode to the same format as Write::write. Defaults to Write::write.