Struct EpochSnapshot 

pub struct EpochSnapshot {
    inner: Arc<EpochSnapshotInner>,
}

A consistent per-epoch view of EpochCommittees.

Returned by Membership::snapshot.

Fields

inner: Arc<EpochSnapshotInner>

Implementations

impl EpochSnapshot

fn new( epoch: EpochNumber, first_epoch: Option<EpochNumber>, committee: Arc<EpochCommittee>, randomized: Option<Arc<RandomizedCommittee<StakeTableEntry<PubKey>>>>, da_committee: Arc<DaCommittee>, ) -> Self

impl EpochSnapshot

pub fn validator_index(&self, key: &PubKey) -> Option<usize>

Index of key in this epoch’s stake table, if present.

pub fn validator_config( &self, key: &BLSPubKey, ) -> Result<&AuthenticatedValidator<BLSPubKey>>

The full validator record (account, stake, delegators, etc.) for key.

pub fn epoch_block_reward(&self) -> Option<RewardAmount>

pub fn validators(&self) -> &AuthenticatedValidatorMap

Trait Implementations

impl Clone for EpochSnapshot

fn clone(&self) -> EpochSnapshot

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EpochSnapshot

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

Formats the value using the given formatter.

impl MembershipSnapshot<SeqTypes> for EpochSnapshot

fn lookup_leader(&self, view: ViewNumber) -> Result<PubKey, Self::Error>

Returns the leader’s public key for a given view number in this epoch.

Errors

Returns LeaderLookupError if first_epoch is unset, the snapshot’s epoch is before first_epoch, or the randomized committee is missing.

type Error = EpochCommitteesError

type StakeTableHash = StakeTableState

fn epoch(&self) -> EpochNumber

The epoch this snapshot is bound to.

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

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

fn has_drb(&self) -> bool

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

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

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

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

The DA stake table for this epoch.

fn committee_members( &self, _: ViewNumber, ) -> impl ExactSizeIterator<Item = &PubKey> + Send

The set of public keys with stake in this epoch, in stake-table order.

fn da_committee_members( &self, _: ViewNumber, ) -> impl ExactSizeIterator<Item = &PubKey> + Send

The set of public keys in the DA committee for this epoch.

fn stake(&self, key: &PubKey) -> Option<PeerConfig<SeqTypes>>

The stake-table entry for key, or None if the key is not in the committee for this epoch.

fn da_stake(&self, key: &PubKey) -> Option<PeerConfig<SeqTypes>>

The DA stake-table entry for key, or None.

fn has_stake(&self, key: &PubKey) -> bool

Whether key has stake in this epoch.

fn has_da_stake(&self, key: &PubKey) -> bool

Whether key has DA stake in this epoch.

fn stake_table_hash(&self) -> Option<Commitment<Self::StakeTableHash>>

The commitment of the stake table for this epoch, if available.

fn total_nodes(&self) -> usize

Number of members in this epoch’s stake table.

fn da_total_nodes(&self) -> usize

Number of members in this epoch’s DA committee.

fn total_stake(&self) -> Uint<256, 4>

Sum of all stake in this epoch.

fn total_da_stake(&self) -> Uint<256, 4>

Sum of all DA stake in this epoch.

fn success_threshold(&self) -> Uint<256, 4>

Quorum (supermajority) threshold for this epoch.

fn da_success_threshold(&self) -> Uint<256, 4>

DA quorum threshold for this epoch.

fn failure_threshold(&self) -> Uint<256, 4>

Failure threshold (1/3 + 1) for this epoch.

fn upgrade_threshold(&self) -> Uint<256, 4>

Threshold required for a protocol upgrade.

fn leader( &self, view: ViewNumber, ) -> Result<<T as NodeType>::SignatureKey, Error>

The leader for view in this epoch, returning a HotShot-internal error type. Default impl wraps Self::lookup_leader.