Struct beefy_primitives::Commitment

pub struct Commitment<TBlockNumber> {
    pub payload: Payload,
    pub block_number: TBlockNumber,
    pub validator_set_id: ValidatorSetId,
}

A commitment signed by GRANDPA validators as part of BEEFY protocol.

The commitment contains a payload extracted from the finalized block at height block_number. GRANDPA validators collect signatures on commitments and a stream of such signed commitments (see SignedCommitment) forms the BEEFY protocol.

Fields

payload: Payload

A collection of payloads to be signed, see Payload for details.

One of the payloads should be some form of cumulative representation of the chain (think MMR root hash). Additionally one of the payloads should also contain some details that allow the light client to verify next validator set. The protocol does not enforce any particular format of this data, nor how often it should be present in commitments, however the light client has to be provided with full validator set whenever it performs the transition (i.e. importing first block with validator_set_id incremented).

block_number: TBlockNumber

Finalized block number this commitment is for.

GRANDPA validators agree on a block they create a commitment for and start collecting signatures. This process is called a round. There might be multiple rounds in progress (depending on the block choice rule), however since the payload is supposed to be cumulative, it is not required to import all commitments. BEEFY light client is expected to import at least one commitment per epoch, but is free to import as many as it requires.

validator_set_id: ValidatorSetId

BEEFY validator set supposed to sign this commitment.

Validator set is changing once per epoch. The Light Client must be provided by details about the validator set whenever it’s importing first commitment with a new validator_set_id. Validator set data MUST be verifiable, for instance using payload information.

Trait Implementations

impl<TBlockNumber: Clone> Clone for Commitment<TBlockNumber>

fn clone(&self) -> Commitment<TBlockNumber>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<TBlockNumber: Debug> Debug for Commitment<TBlockNumber>

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

Formats the value using the given formatter.

impl<TBlockNumber> Decode for Commitment<TBlockNumber>where
    TBlockNumber: Decode,

fn decode<__CodecInputEdqy: Input>(
    __codec_input_edqy: &mut __CodecInputEdqy
) -> Result<Self, Error>

Attempt to deserialise the value from input.

fn skip<I>(input: &mut I) -> Result<(), Error>where
    I: Input,

Attempt to skip the encoded value from input.

fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type.

impl<TBlockNumber> Encode for Commitment<TBlockNumber>where
    TBlockNumber: Encode,

fn encode_to<__CodecOutputEdqy: Output + ?Sized>(
    &self,
    __codec_dest_edqy: &mut __CodecOutputEdqy
)

Convert self to a slice and append it to the destination.

fn size_hint(&self) -> usize

If possible give a hint of expected size of the encoding.

fn encode(&self) -> Vec<u8, Global>

Convert self to an owned vector.

fn using_encoded<R, F>(&self, f: F) -> Rwhere
    F: FnOnce(&[u8]) -> R,

Convert self to a slice and then invoke the given closure with it.

fn encoded_size(&self) -> usize

Calculates the encoded size.

impl<TBlockNumber> Ord for Commitment<TBlockNumber>where
    TBlockNumber: Ord,

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl<TBlockNumber: PartialEq> PartialEq<Commitment<TBlockNumber>> for Commitment<TBlockNumber>

fn eq(&self, other: &Commitment<TBlockNumber>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<TBlockNumber> PartialOrd<Commitment<TBlockNumber>> for Commitment<TBlockNumber>where
    TBlockNumber: Ord,

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<TBlockNumber> EncodeLike<Commitment<TBlockNumber>> for Commitment<TBlockNumber>where
    TBlockNumber: Encode,

impl<TBlockNumber: Eq> Eq for Commitment<TBlockNumber>

impl<TBlockNumber> StructuralEq for Commitment<TBlockNumber>

impl<TBlockNumber> StructuralPartialEq for Commitment<TBlockNumber>