Struct sc_consensus::LongestChain

pub struct LongestChain<B, Block> { /* private fields */ }

Implement Longest Chain Select implementation where ‘longest’ is defined as the highest number of blocks

Implementations

impl<B, Block> LongestChain<B, Block>where
    B: Backend<Block>,
    Block: BlockT,

pub fn new(backend: Arc<B>) -> Self

Instantiate a new LongestChain for Backend B

Trait Implementations

impl<B, Block> Clone for LongestChain<B, Block>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<B, Block> SelectChain<Block> for LongestChain<B, Block>where
    B: Backend<Block>,
    Block: BlockT,

fn leaves<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = Result<Vec<<Block as BlockT>::Hash>, ConsensusError>> + Send + 'async_trait>>where
    Self: 'async_trait,
    'life0: 'async_trait,

Get all leaves of the chain, i.e. block hashes that have no children currently. Leaves that can never be finalized will not be returned.

fn best_chain<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = Result<<Block as BlockT>::Header, ConsensusError>> + Send + 'async_trait>>where
    Self: 'async_trait,
    'life0: 'async_trait,

Among those leaves deterministically pick one chain as the generally best chain to author new blocks upon and probably (but not necessarily) finalize.

fn finality_target<'life0, 'async_trait>(
    &'life0 self,
    base_hash: Block::Hash,
    maybe_max_number: Option<NumberFor<Block>>
) -> Pin<Box<dyn Future<Output = Result<Block::Hash, ConsensusError>> + Send + 'async_trait>>where
    Self: 'async_trait,
    'life0: 'async_trait,

Get the best descendent of base_hash that we should attempt to finalize next, if any. It is valid to return the given base_hash itself if no better descendent exists.