fuel-core-consensus-module 0.48.0

The common code for fuel core consensuses.
Documentation
//! The module provides the functionality that verifies the blocks and headers based
//! on the used consensus.

use crate::block_verifier::config::Config;
use anyhow::ensure;
use fuel_core_poa::ports::Database as PoAVerifierDatabase;
use fuel_core_storage::transactional::AtomicView;
use fuel_core_types::{
    blockchain::{
        SealedBlockHeader,
        block::Block,
        consensus::Consensus,
        header::BlockHeader,
        primitives::DaBlockHeight,
    },
    fuel_types::{
        BlockHeight,
        Bytes32,
    },
    tai64::Tai64,
};

pub mod config;

#[cfg(test)]
mod tests;

/// Verifier is responsible for validation of the blocks and headers.
pub struct Verifier<V> {
    config: Config,
    view_provider: V,
}

impl<V> Verifier<V> {
    /// Creates a new instance of the verifier.
    pub fn new(config: Config, view_provider: V) -> Self {
        Self {
            config,
            view_provider,
        }
    }
}

impl<V> Verifier<V>
where
    V: AtomicView,
    V::LatestView: PoAVerifierDatabase,
{
    /// Verifies **all** fields of the block based on used consensus to produce a block.
    ///
    /// Return an error if the verification failed, otherwise `Ok(())`.
    pub fn verify_block_fields(
        &self,
        consensus: &Consensus,
        block: &Block,
    ) -> anyhow::Result<()> {
        match consensus {
            Consensus::Genesis(_) => {
                let expected_genesis_height = self.config.block_height;
                let expected_genesis_da_height = self.config.da_block_height;
                verify_genesis_block_fields(
                    expected_genesis_height,
                    expected_genesis_da_height,
                    block.header(),
                )
            }
            Consensus::PoA(_) => {
                let view = self.view_provider.latest_view()?;
                fuel_core_poa::verifier::verify_block_fields(&view, block)
            }
            _ => Err(anyhow::anyhow!("Unsupported consensus: {:?}", consensus)),
        }
    }

    /// Verifies the consensus of the block header.
    pub fn verify_consensus(&self, header: &SealedBlockHeader) -> bool {
        let SealedBlockHeader {
            entity: header,
            consensus,
        } = header;
        match consensus {
            Consensus::Genesis(_) => true,
            Consensus::PoA(consensus) => fuel_core_poa::verifier::verify_consensus(
                &self.config.consensus,
                header,
                consensus,
            ),
            _ => false,
        }
    }
}

fn verify_genesis_block_fields(
    expected_genesis_height: BlockHeight,
    expected_genesis_da_height: DaBlockHeight,
    header: &BlockHeader,
) -> anyhow::Result<()> {
    let actual_genesis_height = *header.height();

    ensure!(
        header.prev_root() == &Bytes32::zeroed(),
        "The genesis previous root should be zeroed"
    );
    ensure!(
        header.time() == Tai64::UNIX_EPOCH,
        "The genesis time should be unix epoch time"
    );
    ensure!(
        header.da_height() == expected_genesis_da_height,
        "The genesis `da_height` is not as expected"
    );
    ensure!(
        expected_genesis_height == actual_genesis_height,
        "The genesis height is not as expected"
    );
    Ok(())
}