Struct zebra_consensus::CheckpointList

pub struct CheckpointList(BTreeMap<Height, Hash>);

A list of block height and hash checkpoints.

Checkpoints should be chosen to avoid forks or chain reorganizations, which only happen in the last few hundred blocks in the chain. (zcashd allows chain reorganizations up to 99 blocks, and prunes orphaned side-chains after 288 blocks.)

This is actually a bijective map, but since it is read-only, we use a BTreeMap, and do the value uniqueness check on initialisation.

Tuple Fields

0: BTreeMap<Height, Hash>

Implementations

impl CheckpointList

pub(crate) fn from_list( list: impl IntoIterator<Item = (Height, Hash)>, ) -> Result<Self, BoxError>

Create a new checkpoint list for network from checkpoint_list.

Assumes that the provided genesis checkpoint is correct.

Checkpoint heights and checkpoint hashes must be unique. There must be a checkpoint for a genesis block at block::Height 0. (All other checkpoints are optional.)

pub fn contains(&self, height: Height) -> bool

Return true if there is a checkpoint at height.

See BTreeMap::contains_key() for details.

pub fn hash(&self, height: Height) -> Option<Hash>

Returns the hash corresponding to the checkpoint at height, or None if there is no checkpoint at that height.

See BTreeMap::get() for details.

pub fn max_height(&self) -> Height

Return the block height of the highest checkpoint in the checkpoint list.

If there is only a single checkpoint, then the maximum height will be zero. (The genesis block.)

pub fn min_height_in_range<R>(&self, range: R) -> Option<Height>

where R: RangeBounds<Height>,

Return the block height of the lowest checkpoint in a sub-range.

pub fn max_height_in_range<R>(&self, range: R) -> Option<Height>

where R: RangeBounds<Height>,

Return the block height of the highest checkpoint in a sub-range.

pub fn iter(&self) -> impl Iterator<Item = (&Height, &Hash)>

Returns an iterator over all the checkpoints, in increasing height order.

pub fn prev_checkpoint_index(&self, height: Height) -> usize

Returns the checkpoint at height, as a zero-based index. If height is not a checkpoint height, returns the checkpoint immediately before that height.

pub fn len(&self) -> usize

Returns the number of checkpoints in the list.

Trait Implementations

impl Clone for CheckpointList

fn clone(&self) -> CheckpointList

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CheckpointList

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FromStr for CheckpointList

fn from_str(s: &str) -> Result<Self, Self::Err>

Parse a string into a CheckpointList.

Each line has one checkpoint, consisting of a block::Height and block::Hash, separated by a single space.

Assumes that the provided genesis checkpoint is correct.

type Err = Box<dyn Error + Sync + Send>

The associated error which can be returned from parsing.

impl Hash for CheckpointList

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for CheckpointList

fn eq(&self, other: &CheckpointList) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for CheckpointList

impl StructuralPartialEq for CheckpointList