Trait MembershipSnapshot

Source

pub trait MembershipSnapshot<T: NodeType>:
    Clone
    + Send
    + Sync {
    type Error: Error + Send + Sync + 'static;
    type StakeTableHash: Committable;

Show 22 methods    // Required methods
    fn epoch(&self) -> EpochNumber;
    fn first_epoch(&self) -> Option<EpochNumber>;
    fn has_drb(&self) -> bool;
    fn stake_table(
        &self,
    ) -> impl ExactSizeIterator<Item = &PeerConfig<T>> + Send;
    fn da_stake_table(
        &self,
    ) -> impl ExactSizeIterator<Item = &PeerConfig<T>> + Send;
    fn committee_members(
        &self,
        view: ViewNumber,
    ) -> impl ExactSizeIterator<Item = &T::SignatureKey> + Send;
    fn da_committee_members(
        &self,
        view: ViewNumber,
    ) -> impl ExactSizeIterator<Item = &T::SignatureKey> + Send;
    fn stake(&self, key: &T::SignatureKey) -> Option<PeerConfig<T>>;
    fn da_stake(&self, key: &T::SignatureKey) -> Option<PeerConfig<T>>;
    fn has_stake(&self, key: &T::SignatureKey) -> bool;
    fn has_da_stake(&self, key: &T::SignatureKey) -> bool;
    fn lookup_leader(
        &self,
        view: ViewNumber,
    ) -> Result<T::SignatureKey, Self::Error>;

    // Provided methods
    fn stake_table_hash(&self) -> Option<Commitment<Self::StakeTableHash>> { ... }
    fn total_nodes(&self) -> usize { ... }
    fn da_total_nodes(&self) -> usize { ... }
    fn total_stake(&self) -> U256 { ... }
    fn total_da_stake(&self) -> U256 { ... }
    fn success_threshold(&self) -> U256 { ... }
    fn da_success_threshold(&self) -> U256 { ... }
    fn failure_threshold(&self) -> U256 { ... }
    fn upgrade_threshold(&self) -> U256 { ... }
    fn leader(&self, view: ViewNumber) -> Result<T::SignatureKey> { ... }
}

Expand description

A consistent per-epoch view of a Membership.

Required Associated Types§

Source

type Error: Error + Send + Sync + 'static

Source

type StakeTableHash: Committable

Required Methods§

Source

fn epoch(&self) -> EpochNumber

The epoch this snapshot is bound to.

Source

fn first_epoch(&self) -> Option<EpochNumber>

The first epoch known to the membership (cached at snapshot creation).

Source

fn has_drb(&self) -> bool

Whether a randomized stake table (DRB result) was available for this epoch at the time the snapshot was captured.

Source

fn stake_table(&self) -> impl ExactSizeIterator<Item = &PeerConfig<T>> + Send

The (non-DA) stake table for this epoch.

Iteration order is the stake-table position order — the position of a key in this iterator equals the value returned by the implementation’s get_validator_index (where applicable) and is part of the per-epoch consensus contract.

Source