Struct EpochMembership 

pub struct EpochMembership<TYPES: NodeType> {
    snapshot: EpochMembershipSnapshot<TYPES>,
    pub coordinator: EpochMembershipCoordinator<TYPES>,
}

Wrapper around a membership that holds a captured snapshot for a given epoch (or the pre-epoch state). All accessors observe one consistent view because the snapshot is held inline.

Fields

snapshot: EpochMembershipSnapshot<TYPES>

The captured snapshot, either per-epoch or pre-epoch.

coordinator: EpochMembershipCoordinator<TYPES>

Underlying coordinator, retained so navigation methods like next_epoch can construct fresh snapshots.

Implementations

impl<TYPES: NodeType> EpochMembership<TYPES>

pub fn epoch(&self) -> Option<EpochNumber>

pub fn next_epoch(&self) -> Result<Self>

pub fn next_epoch_stake_table(&self) -> Result<Self>

pub fn get_new_epoch(&self, epoch: Option<EpochNumber>) -> Result<Self>

async fn get_epoch_root(&self) -> Result<Leaf2<TYPES>>

pub async fn get_epoch_drb(&self) -> Result<DrbResult>

pub fn snapshot( &self, ) -> Option<&<TYPES::Membership as Membership<TYPES>>::Snapshot>

Borrow the per-epoch snapshot, or None for the pre-epoch case.

pub fn non_epoch_snapshot( &self, ) -> Option<&<TYPES::Membership as Membership<TYPES>>::NonEpochSnapshot>

Borrow the pre-epoch snapshot, or None if this is a per-epoch membership.

pub fn add_drb_result(&self, drb_result: DrbResult)

Add the DRB result for this epoch to the membership.

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

pub fn da_stake_table( &self, ) -> impl ExactSizeIterator<Item = &PeerConfig<TYPES>> + Send

pub fn committee_members( &self, view: ViewNumber, ) -> impl ExactSizeIterator<Item = &TYPES::SignatureKey> + Send

pub fn da_committee_members( &self, view: ViewNumber, ) -> impl ExactSizeIterator<Item = &TYPES::SignatureKey> + Send

pub fn stake(&self, key: &TYPES::SignatureKey) -> Option<PeerConfig<TYPES>>

pub fn da_stake(&self, key: &TYPES::SignatureKey) -> Option<PeerConfig<TYPES>>

pub fn has_stake(&self, key: &TYPES::SignatureKey) -> bool

pub fn has_da_stake(&self, key: &TYPES::SignatureKey) -> bool

pub fn leader(&self, view: ViewNumber) -> Result<TYPES::SignatureKey>

The leader for view, returning a HotShot-internal error type.

Errors

Returns an error if the leader cannot be calculated.

pub fn lookup_leader( &self, view: ViewNumber, ) -> Result<TYPES::SignatureKey, <<TYPES as NodeType>::Membership as Membership<TYPES>>::Error>

The leader for view, returning the membership-impl error type.

Errors

Returns the membership-impl error if the leader cannot be calculated.

pub fn total_nodes(&self) -> usize

pub fn da_total_nodes(&self) -> usize

pub fn success_threshold(&self) -> U256

pub fn da_success_threshold(&self) -> U256

pub fn failure_threshold(&self) -> U256

pub fn upgrade_threshold(&self) -> U256

pub fn stake_table_hash( &self, ) -> Option<Commitment<<<<TYPES as NodeType>::Membership as Membership<TYPES>>::Snapshot as MembershipSnapshot<TYPES>>::StakeTableHash>>

Trait Implementations

impl<TYPES: NodeType> Clone for EpochMembership<TYPES>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.