Struct sp_consensus_beefy::witness::SignedCommitmentWitness

pub struct SignedCommitmentWitness<TBlockNumber, TSignatureAccumulator> {
    pub commitment: Commitment<TBlockNumber>,
    pub signed_by: Vec<bool>,
    pub signature_accumulator: TSignatureAccumulator,
}

A light form of SignedCommitment.

This is a light (“witness”) form of the signed commitment. Instead of containing full list of signatures, which might be heavy and expensive to verify, it only contains a bit vector of validators which signed the original SignedCommitment and a merkle root of all signatures.

This can be used by light clients for 2-phase interactive verification (for instance for Ethereum Mainnet), in a commit-reveal like scheme, where first we submit only the signed commitment witness and later on, the client picks only some signatures to verify at random.

Fields

commitment: Commitment<TBlockNumber>

The full content of the commitment.

signed_by: Vec<bool>

The bit vector of validators who signed the commitment.

signature_accumulator: TSignatureAccumulator

Either a merkle root of signatures in the original signed commitment or a single aggregated BLS signature aggregating all original signatures.

Implementations

impl<TBlockNumber, TSignatureAccumulator> SignedCommitmentWitness<TBlockNumber, TSignatureAccumulator>

pub fn from_signed<TSignatureAggregator, TSignature>( signed: SignedCommitment<TBlockNumber, TSignature>, aggregator: TSignatureAggregator, ) -> (Self, Vec<Option<TSignature>>)

where TSignatureAggregator: FnOnce(&[Option<TSignature>]) -> TSignatureAccumulator,

Convert SignedCommitment into SignedCommitmentWitness.

This takes a SignedCommitment, which contains full signatures and converts it into a witness form, which does not contain full signatures, only a bit vector indicating which validators have signed the original SignedCommitment and a merkle root of all signatures.

Returns the full list of signatures along with the witness.

Trait Implementations

impl<TBlockNumber: Debug, TSignatureAccumulator: Debug> Debug for SignedCommitmentWitness<TBlockNumber, TSignatureAccumulator>

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

Formats the value using the given formatter.

impl<TBlockNumber, TSignatureAccumulator> Decode for SignedCommitmentWitness<TBlockNumber, TSignatureAccumulator>

where Commitment<TBlockNumber>: Decode, TSignatureAccumulator: Decode,

fn decode<__CodecInputEdqy: Input>( __codec_input_edqy: &mut __CodecInputEdqy, ) -> 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, TSignatureAccumulator> Encode for SignedCommitmentWitness<TBlockNumber, TSignatureAccumulator>

where Commitment<TBlockNumber>: Encode, TSignatureAccumulator: Encode,

fn size_hint(&self) -> usize

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

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

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

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

Convert self to an owned vector.

fn using_encoded<R, F>(&self, f: F) -> R

where 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: PartialEq, TSignatureAccumulator: PartialEq> PartialEq for SignedCommitmentWitness<TBlockNumber, TSignatureAccumulator>

fn eq( &self, other: &SignedCommitmentWitness<TBlockNumber, TSignatureAccumulator>, ) -> 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, TSignatureAccumulator> EncodeLike for SignedCommitmentWitness<TBlockNumber, TSignatureAccumulator>

where Commitment<TBlockNumber>: Encode, TSignatureAccumulator: Encode,

impl<TBlockNumber: Eq, TSignatureAccumulator: Eq> Eq for SignedCommitmentWitness<TBlockNumber, TSignatureAccumulator>

impl<TBlockNumber, TSignatureAccumulator> StructuralPartialEq for SignedCommitmentWitness<TBlockNumber, TSignatureAccumulator>