mirror of
https://github.com/sigp/lighthouse.git
synced 2026-03-22 22:34:45 +00:00
64 lines
2.2 KiB
Rust
64 lines
2.2 KiB
Rust
mod reduced_tree;
|
|
|
|
use std::sync::Arc;
|
|
use store::Store;
|
|
use types::{BeaconBlock, EthSpec, Hash256, Slot};
|
|
|
|
pub use reduced_tree::ThreadSafeReducedTree;
|
|
|
|
pub type Result<T> = std::result::Result<T, String>;
|
|
|
|
// Note: the `PartialEq` bound is only required for testing. If it becomes a serious annoyance we
|
|
// can remove it.
|
|
pub trait LmdGhost<S: Store<E>, E: EthSpec>: PartialEq + Send + Sync + Sized {
|
|
/// Create a new instance, with the given `store` and `finalized_root`.
|
|
fn new(store: Arc<S>, finalized_block: &BeaconBlock<E>, finalized_root: Hash256) -> Self;
|
|
|
|
/// Process an attestation message from some validator that attests to some `block_hash`
|
|
/// representing a block at some `block_slot`.
|
|
fn process_attestation(
|
|
&self,
|
|
validator_index: usize,
|
|
block_hash: Hash256,
|
|
block_slot: Slot,
|
|
) -> Result<()>;
|
|
|
|
/// Process a block that was seen on the network.
|
|
fn process_block(&self, block: &BeaconBlock<E>, block_hash: Hash256) -> Result<()>;
|
|
|
|
/// Returns the head of the chain, starting the search at `start_block_root` and moving upwards
|
|
/// (in block height).
|
|
fn find_head<F>(
|
|
&self,
|
|
start_block_slot: Slot,
|
|
start_block_root: Hash256,
|
|
weight: F,
|
|
) -> Result<Hash256>
|
|
where
|
|
F: Fn(usize) -> Option<u64> + Copy;
|
|
|
|
/// Provide an indication that the blockchain has been finalized at the given `finalized_block`.
|
|
///
|
|
/// `finalized_block_root` must be the root of `finalized_block`.
|
|
fn update_finalized_root(
|
|
&self,
|
|
finalized_block: &BeaconBlock<E>,
|
|
finalized_block_root: Hash256,
|
|
) -> Result<()>;
|
|
|
|
/// Returns the latest message for a given validator index.
|
|
fn latest_message(&self, validator_index: usize) -> Option<(Hash256, Slot)>;
|
|
|
|
/// Runs an integrity verification function on fork choice algorithm.
|
|
///
|
|
/// Returns `Ok(())` if the underlying fork choice has maintained its integrity,
|
|
/// `Err(description)` otherwise.
|
|
fn verify_integrity(&self) -> Result<()>;
|
|
|
|
/// Encode the `LmdGhost` instance to bytes.
|
|
fn as_bytes(&self) -> Vec<u8>;
|
|
|
|
/// Create a new `LmdGhost` instance given a `store` and encoded bytes.
|
|
fn from_bytes(bytes: &[u8], store: Arc<S>) -> Result<Self>;
|
|
}
|