Struct sp_consensus_beefy::SignedCommitment

pub struct SignedCommitment<TBlockNumber, TSignature> {
    pub commitment: Commitment<TBlockNumber>,
    pub signatures: Vec<Option<TSignature>>,
}

A commitment with matching GRANDPA validators’ signatures.

Note that SCALE-encoding of the structure is optimized for size efficiency over the wire, please take a look at custom [Encode] and [Decode] implementations and CompactSignedCommitment struct.

Fields

commitment: Commitment<TBlockNumber>

The commitment signatures are collected for.

signatures: Vec<Option<TSignature>>

GRANDPA validators’ signatures for the commitment.

The length of this Vec must match number of validators in the current set (see Commitment::validator_set_id).

Implementations

impl<TBlockNumber, TSignature> SignedCommitment<TBlockNumber, TSignature>

pub fn signature_count(&self) -> usize

Return the number of collected signatures.

pub fn verify_signatures<'a, TAuthorityId, MsgHash>( &'a self, target_number: TBlockNumber, validator_set: &'a ValidatorSet<TAuthorityId>, ) -> Result<Vec<KnownSignature<&'a TAuthorityId, &'a TSignature>>, u32>

where TBlockNumber: Clone + Encode + PartialEq, TAuthorityId: RuntimeAppPublic<Signature = TSignature> + BeefyAuthorityId<MsgHash>, MsgHash: Hash,

Verify all the commitment signatures against the validator set that was active at the block where the commitment was generated.

Returns the valid validator-signature pairs if the commitment can be verified.

Trait Implementations

impl<TBlockNumber: Clone, TSignature: Clone> Clone for SignedCommitment<TBlockNumber, TSignature>

fn clone(&self) -> SignedCommitment<TBlockNumber, TSignature>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<TBlockNumber: Debug, TSignature: Debug> Debug for SignedCommitment<TBlockNumber, TSignature>

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

Formats the value using the given formatter.

impl<TBlockNumber, TSignature> Decode for SignedCommitment<TBlockNumber, TSignature>

where TBlockNumber: Decode + Clone, TSignature: Decode,

fn decode<I: Input>(input: &mut I) -> Result<Self, Error>

Attempt to deserialise the value from input.

fn decode_into<I>( input: &mut I, dst: &mut MaybeUninit<Self>, ) -> Result<DecodeFinished, Error>

where I: Input,

Attempt to deserialize the value from input into a pre-allocated piece of memory.

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: Debug, TSignature> Display for SignedCommitment<TBlockNumber, TSignature>

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

Formats the value using the given formatter.

impl<TBlockNumber, TSignature> Encode for SignedCommitment<TBlockNumber, TSignature>

where TBlockNumber: Encode + Clone, TSignature: Encode,

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

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

fn size_hint(&self) -> usize

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

fn encode_to<T>(&self, dest: &mut T)

where T: Output + ?Sized,

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

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

Convert self to an owned vector.

fn encoded_size(&self) -> usize

Calculates the encoded size.

impl<N, S> From<SignedCommitment<N, S>> for VersionedFinalityProof<N, S>

fn from(commitment: SignedCommitment<N, S>) -> Self

Converts to this type from the input type.

impl<TBlockNumber: PartialEq, TSignature: PartialEq> PartialEq for SignedCommitment<TBlockNumber, TSignature>

fn eq(&self, other: &SignedCommitment<TBlockNumber, TSignature>) -> 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, TSignature> TypeInfo for SignedCommitment<TBlockNumber, TSignature>

where Commitment<TBlockNumber>: TypeInfo + 'static, Vec<Option<TSignature>>: TypeInfo + 'static, TBlockNumber: TypeInfo + 'static, TSignature: TypeInfo + 'static,

type Identity = SignedCommitment<TBlockNumber, TSignature>

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl<TBlockNumber: Eq, TSignature: Eq> Eq for SignedCommitment<TBlockNumber, TSignature>

impl<TBlockNumber, TSignature> StructuralPartialEq for SignedCommitment<TBlockNumber, TSignature>