Struct EpochMembership

pub struct EpochMembership<TYPES: NodeType> {
    pub epoch: Option<TYPES::Epoch>,
    pub coordinator: EpochMembershipCoordinator<TYPES>,
}

Wrapper around a membership that guarantees that the epoch has a stake table

Fields

epoch: Option<TYPES::Epoch>

Epoch the membership is guaranteed to have a stake table for

coordinator: EpochMembershipCoordinator<TYPES>

Underlying membership

Implementations

impl<TYPES: NodeType> EpochMembership<TYPES>

pub fn epoch(&self) -> Option<TYPES::Epoch>

Get the epoch this membership is good for

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

Get a membership for the next epoch

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

Get a membership for the next epoch

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

async fn get_epoch_root(&self, block_height: u64) -> Result<Leaf2<TYPES>>

Wraps the same named Membership trait fn

async fn get_epoch_drb(&self, block_height: u64) -> Result<DrbResult>

Wraps the same named Membership trait fn

pub async fn stake_table(&self) -> HSStakeTable<TYPES>

Get all participants in the committee (including their stake) for a specific epoch

pub async fn da_stake_table(&self) -> HSStakeTable<TYPES>

Get all participants in the committee (including their stake) for a specific epoch

pub async fn committee_members( &self, view_number: TYPES::View, ) -> BTreeSet<TYPES::SignatureKey>

Get all participants in the committee for a specific view for a specific epoch

pub async fn da_committee_members( &self, view_number: TYPES::View, ) -> BTreeSet<TYPES::SignatureKey>

Get all participants in the committee for a specific view for a specific epoch

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

Get the stake table entry for a public key, returns None if the key is not in the table for a specific epoch

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

Get the DA stake table entry for a public key, returns None if the key is not in the table for a specific epoch

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

See if a node has stake in the committee in a specific epoch

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

See if a node has stake in the committee in a specific epoch

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

The leader of the committee for view view_number in epoch.

Note: this function uses a HotShot-internal error type. You should implement lookup_leader, rather than implementing this function directly.

Errors

Returns an error if the leader cannot be calculated.

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

The leader of the committee for view view_number in epoch.

Note: There is no such thing as a DA leader, so any consumer requiring a leader should call this.

Errors

Returns an error if the leader cannot be calculated

pub async fn total_nodes(&self) -> usize

Returns the number of total nodes in the committee in an epoch epoch

pub async fn da_total_nodes(&self) -> usize

Returns the number of total DA nodes in the committee in an epoch epoch

pub async fn success_threshold(&self) -> U256

Returns the threshold for a specific Membership implementation

pub async fn da_success_threshold(&self) -> U256

Returns the DA threshold for a specific Membership implementation

pub async fn failure_threshold(&self) -> U256

Returns the threshold for a specific Membership implementation

pub async fn upgrade_threshold(&self) -> U256

Returns the threshold required to upgrade the network protocol

pub async fn add_drb_result(&self, drb_result: DrbResult)

Add the epoch result to the membership

Trait Implementations

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

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.