Struct beacon_chain::ForkChoice

pub struct ForkChoice<T: BeaconChainTypes> { /* fields omitted */ }

Methods

impl<T: BeaconChainTypes> ForkChoice<T>

pub fn new(
    store: Arc<T::Store>,
    backend: T::LmdGhost,
    genesis_block_root: Hash256
) -> Self

Instantiate a new fork chooser.

"Genesis" does not necessarily need to be the absolute genesis, it can be some finalized block.

pub fn find_head(&self, chain: &BeaconChain<T>) -> Result<Hash256, Error>

pub fn process_block(
    &self,
    state: &BeaconState<T::EthSpec>,
    block: &BeaconBlock<T::EthSpec>,
    block_root: Hash256
) -> Result<(), Error>

Process all attestations in the given block.

Assumes the block (and therefore it's attestations) are valid. It is a logic error to provide an invalid block.

pub fn process_attestation(
    &self,
    state: &BeaconState<T::EthSpec>,
    attestation: &Attestation<T::EthSpec>,
    block: &BeaconBlock<T::EthSpec>
) -> Result<(), Error>

Process an attestation which references block in attestation.data.beacon_block_root.

Assumes the attestation is valid.

pub fn latest_message(&self, validator_index: usize) -> Option<(Hash256, Slot)>

Returns the latest message for a given validator, if any.

Returns (block_root, block_slot).

pub fn verify_integrity(&self) -> Result<(), String>

Runs an integrity verification function on the underlying fork choice algorithm.

Returns Ok(()) if the underlying fork choice has maintained it's integrity, Err(description) otherwise.

pub fn process_finalization(
    &self,
    finalized_block: &BeaconBlock<T::EthSpec>,
    finalized_block_root: Hash256
) -> Result<(), Error>

Inform the fork choice that the given block (and corresponding root) have been finalized so it may prune it's storage.

finalized_block_root must be the root of finalized_block.