Enum Activity

pub enum Activity<V: Variant, D: Digest> {
    Notarize(Notarize<V, D>),
    Notarization(Notarization<V, D>),
    Nullify(Nullify<V>),
    Nullification(Nullification<V>),
    Finalize(Finalize<V, D>),
    Finalization(Finalization<V, D>),
    ConflictingNotarize(ConflictingNotarize<V, D>),
    ConflictingFinalize(ConflictingFinalize<V, D>),
    NullifyFinalize(NullifyFinalize<V, D>),
}

Activity represents all possible activities that can occur in the consensus protocol. This includes both regular consensus messages and fault evidence.

Some activities issued by consensus are not verified. To determine if an activity has been verified, use the verified method.

Warning

After collecting t PartialSignatures for the same Activity, an attacker can derive the PartialSignature for the n-t remaining participants.

For this reason, it is not sound to use PartialSignature-backed Activity to reward participants for their contributions (as an attacker, for example, could forge contributions from offline participants).

Variants

Notarize(Notarize<V, D>)

A single validator notarize over a proposal

Notarization(Notarization<V, D>)

A threshold signature for a notarization

Nullify(Nullify<V>)

A single validator nullify to skip the current view

Nullification(Nullification<V>)

A threshold signature for a nullification

Finalize(Finalize<V, D>)

A single validator finalize over a proposal

Finalization(Finalization<V, D>)

A threshold signature for a finalization

ConflictingNotarize(ConflictingNotarize<V, D>)

Evidence of a validator sending conflicting notarizes (Byzantine behavior)

ConflictingFinalize(ConflictingFinalize<V, D>)

Evidence of a validator sending conflicting finalizes (Byzantine behavior)

NullifyFinalize(NullifyFinalize<V, D>)

Evidence of a validator sending both nullify and finalize for the same view (Byzantine behavior)

Implementations

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

pub fn verified(&self) -> bool

Indicates whether the activity has been verified by consensus.

Trait Implementations

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

fn clone(&self) -> Activity<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 Activity<V, D>

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

Formats the value using the given formatter.

impl<V: Variant, D: Digest> EncodeSize for Activity<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 Activity<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 Activity<V, D>

fn eq(&self, other: &Activity<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 Activity<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 Activity<V, D>

fn view(&self) -> View

Returns the view associated with this object.

impl<V: Variant, D: Digest> Write for Activity<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 Activity<V, D>

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