Struct phron_finality::sync::forest::Forest

pub struct Forest<I, J>
where
    I: PeerId,
    J: Justification,
{
    vertices: HashMap<BlockId, VertexWithChildren<I, J>>,
    highest_justified: BlockId,
    justified_blocks: HashMap<BlockNumber, BlockId>,
    imported_leaves: HashSet<BlockId>,
    favourite: BlockId,
    root_id: BlockId,
    root_children: HashSet<BlockId>,
    compost_bin: HashSet<BlockId>,
}

Fields

vertices: HashMap<BlockId, VertexWithChildren<I, J>>

highest_justified: BlockId

justified_blocks: HashMap<BlockNumber, BlockId>

imported_leaves: HashSet<BlockId>

favourite: BlockId

root_id: BlockId

root_children: HashSet<BlockId>

compost_bin: HashSet<BlockId>

Implementations

impl<I, J> Forest<I, J>

where I: PeerId, J: Justification,

pub fn new<B, CS>( chain_status: &CS ) -> Result<Self, InitializationError<B, J, CS>>

where B: Block<UnverifiedHeader = <<J as Justification>::Header as Header>::Unverified>, CS: ChainStatus<B, J>,

fn special_state(&self, id: &BlockId) -> Option<SpecialState>

fn get_mut(&mut self, id: &BlockId) -> VertexHandleMut<'_, I, J>

fn get(&self, id: &BlockId) -> VertexHandle<'_, I, J>

fn connect_parent(&mut self, id: &BlockId)

fn set_required(&mut self, id: &BlockId)

fn set_explicitly_required(&mut self, id: &BlockId) -> bool

fn insert_id(&mut self, id: BlockId, holder: Option<I>) -> Result<(), Error>

fn process_header( &mut self, header: &J::Header ) -> Result<(BlockId, BlockId), Error>

pub fn update_block_identifier( &mut self, id: &BlockId, holder: Option<I>, required: bool ) -> Result<bool, Error>

Updates the provider block identifier, returns whether it became a new explicitly required.

pub fn update_header( &mut self, header: &J::Header, holder: Option<I>, required: bool ) -> Result<bool, Error>

Updates the provided header, returns:

1. If required is set whether it became a new explicitly required.
2. Otherwise whether it’s a new descendant of the highest justified.

pub fn update_body(&mut self, header: &J::Header) -> Result<(), Error>

Updates the vertex related to the provided header marking it as imported. Returns errors when it’s impossible to do consistently.

fn try_update_highest_justified(&mut self, id: BlockId) -> bool

Updates the highest_justified if the given id is higher.

pub fn update_justification( &mut self, justification: J, holder: Option<I> ) -> Result<bool, Error>

Updates the provided justification. Returns whether the vertex became the new highest justified header/block.

fn pick_favourite(&mut self)

fn prune(&mut self, id: &BlockId)

fn prune_level(&mut self, level: BlockNumber)

pub fn try_finalize(&mut self, number: &BlockNumber) -> Option<J>

Attempt to finalize one block, returns the correct justification if successful.

fn branch_knowledge(&self, id: BlockId) -> Option<BranchKnowledge>

Returns the BranchKnowledge regarding the given block id, or None if there is no branch at all.

fn prepare_request_info( &self, id: &BlockId, force: bool ) -> Option<(HashSet<I>, BranchKnowledge)>

Prepare additional info required to create a request for the branch. Returns None if we’re not interested in the branch. Can be forced to fake interest, but only for blocks we know about.

pub fn request_interest(&self, id: &BlockId) -> Interest<I>

How much interest we have for requesting the block.

pub fn importable(&self, id: &BlockId) -> bool

Whether we would like to eventually import this block.

fn know_most(&self, id: &BlockId) -> HashSet<I>

pub fn behind_finalization(&self) -> u32

How far behind in finalization are we.

pub fn extension_request(&self) -> ExtensionRequest<I>

Returns an extension request with the appropriate data if either:

1. We know of a justified header for which we do not have a block, or
2. We know of nodes which have children of our favourite block.

pub fn skippable(&self, id: &BlockId) -> bool

Whether this block should be skipped during importing. It either needs to be already imported, or too old to be checked.

pub fn favourite_block(&self) -> BlockId

The ID of the favourite block, i.e. the one for which we will accept imports of children.