Trait Consensus

pub trait Consensus<B: Block>: HeaderValidator<B::Header> {
    type Error;

    // Required methods
    fn validate_body_against_header(
        &self,
        body: &B::Body,
        header: &SealedHeader<B::Header>,
    ) -> Result<(), Self::Error>;
    fn validate_block_pre_execution(
        &self,
        block: &SealedBlock<B>,
    ) -> Result<(), Self::Error>;
}

Consensus is a protocol that chooses canonical chain.

Required Associated Types

type Error

The error type related to consensus.

Required Methods

fn validate_body_against_header( &self, body: &B::Body, header: &SealedHeader<B::Header>, ) -> Result<(), Self::Error>

Ensures that body field values match the header.

fn validate_block_pre_execution( &self, block: &SealedBlock<B>, ) -> Result<(), Self::Error>

Validate a block disregarding world state, i.e. things that can be checked before sender recovery and execution.

See the Yellow Paper sections 4.3.2 “Holistic Validity”, 4.3.4 “Block Header Validity”, and 11.1 “Ommer Validation”.

This should not be called for the genesis block.

Note: validating blocks does not include other validations of the Consensus

Implementations on Foreign Types

impl<'a, B: Block, T: 'a + Consensus<B> + ?Sized> Consensus<B> for &'a T

where &'a T: HeaderValidator<B::Header>,

type Error = <T as Consensus<B>>::Error

fn validate_body_against_header( &self, body: &B::Body, header: &SealedHeader<B::Header>, ) -> Result<(), Self::Error>

fn validate_block_pre_execution( &self, block: &SealedBlock<B>, ) -> Result<(), Self::Error>

impl<B: Block, T: Consensus<B> + ?Sized> Consensus<B> for Arc<T>

where Arc<T>: HeaderValidator<B::Header>,

type Error = <T as Consensus<B>>::Error

fn validate_body_against_header( &self, body: &B::Body, header: &SealedHeader<B::Header>, ) -> Result<(), Self::Error>

fn validate_block_pre_execution( &self, block: &SealedBlock<B>, ) -> Result<(), Self::Error>

Implementors

impl<B: Block> Consensus<B> for NoopConsensus

type Error = ConsensusError

impl<B: Block> Consensus<B> for TestConsensus

Available on crate feature test-utils only.

type Error = ConsensusError