Struct sc_finality_grandpa::GrandpaJustification

pub struct GrandpaJustification<Block: BlockT> { /* private fields */ }

A GRANDPA justification for block finality, it includes a commit message and an ancestry proof including all headers routing all precommit target blocks to the commit target block. Due to the current voting strategy the precommit targets should be the same as the commit target, since honest voters don’t vote past authority set change blocks.

This is meant to be stored in the db and passed around the network to other nodes, and are used by syncing nodes to prove authority set handoffs.

Implementations

impl<Block: BlockT> GrandpaJustification<Block>

pub fn from_commit<C>(
    client: &Arc<C>,
    round: u64,
    commit: Commit<Block>
) -> Result<GrandpaJustification<Block>, Error>where
    C: HeaderBackend<Block>,

Create a GRANDPA justification from the given commit. This method assumes the commit is valid and well-formed.

pub fn decode_and_verify_finalizes(
    encoded: &[u8],
    finalized_target: (Block::Hash, NumberFor<Block>),
    set_id: u64,
    voters: &VoterSet<AuthorityId>
) -> Result<GrandpaJustification<Block>, ClientError>where
    NumberFor<Block>: BlockNumberOps,

Decode a GRANDPA justification and validate the commit and the votes’ ancestry proofs finalize the given block.

pub fn verify(
    &self,
    set_id: u64,
    authorities: &AuthorityList
) -> Result<(), ClientError>where
    NumberFor<Block>: BlockNumberOps,

Validate the commit and the votes’ ancestry proofs.

pub fn target(&self) -> (NumberFor<Block>, Block::Hash)

The target block number and hash that this justifications proves finality for.

Trait Implementations

impl<Block: Clone + BlockT> Clone for GrandpaJustification<Block>where
    Block::Header: Clone,

fn clone(&self) -> GrandpaJustification<Block>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Block: Debug + BlockT> Debug for GrandpaJustification<Block>where
    Block::Header: Debug,

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

Formats the value using the given formatter.

impl<Block: BlockT> Decode for GrandpaJustification<Block>where
    Commit<Block>: Decode,
    Vec<Block::Header>: 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<Block: BlockT> Encode for GrandpaJustification<Block>where
    Commit<Block>: Encode,
    Vec<Block::Header>: 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<Block: PartialEq + BlockT> PartialEq<GrandpaJustification<Block>> for GrandpaJustification<Block>where
    Block::Header: PartialEq,

fn eq(&self, other: &GrandpaJustification<Block>) -> 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<Block: BlockT> EncodeLike<GrandpaJustification<Block>> for GrandpaJustification<Block>where
    Commit<Block>: Encode,
    Vec<Block::Header>: Encode,

impl<Block: Eq + BlockT> Eq for GrandpaJustification<Block>where
    Block::Header: Eq,

impl<Block: BlockT> StructuralEq for GrandpaJustification<Block>

impl<Block: BlockT> StructuralPartialEq for GrandpaJustification<Block>