Struct EpochCommittees

pub struct EpochCommittees {
    non_epoch_committee: NonEpochCommittee,
    state: HashMap<<SeqTypes as NodeType>::Epoch, EpochCommittee>,
    randomized_committees: BTreeMap<<SeqTypes as NodeType>::Epoch, RandomizedCommittee<StakeTableEntry<PubKey>>>,
    first_epoch: Option<<SeqTypes as NodeType>::Epoch>,
    fetcher: Arc<StakeTableFetcher>,
}

Type to describe DA and Stake memberships

Fields

non_epoch_committee: NonEpochCommittee

Committee used when we’re in pre-epoch state

state: HashMap<<SeqTypes as NodeType>::Epoch, EpochCommittee>

Holds Stake table and da stake

randomized_committees: BTreeMap<<SeqTypes as NodeType>::Epoch, RandomizedCommittee<StakeTableEntry<PubKey>>>

Randomized committees, filled when we receive the DrbResult

first_epoch: Option<<SeqTypes as NodeType>::Epoch>

fetcher: Arc<StakeTableFetcher>

Implementations

impl EpochCommittees

pub fn first_epoch(&self) -> Option<<SeqTypes as NodeType>::Epoch>

pub fn fetcher(&self) -> &StakeTableFetcher

fn update_stake_table( &mut self, epoch: EpochNumber, validators: IndexMap<Address, Validator<BLSPubKey>>, )

Updates Self.stake_table with stake_table for Self.contract_address at l1_block_height. This is intended to be called before calling self.stake() so that Self.stake_table only needs to be updated once in a given life-cycle but may be read from many times.

pub fn validators( &self, epoch: &<SeqTypes as NodeType>::Epoch, ) -> Result<IndexMap<Address, Validator<BLSPubKey>>>

pub fn address( &self, epoch: &<SeqTypes as NodeType>::Epoch, bls_key: BLSPubKey, ) -> Result<Address>

pub fn get_validator_config( &self, epoch: &<SeqTypes as NodeType>::Epoch, key: BLSPubKey, ) -> Result<Validator<BLSPubKey>>

pub fn new_stake( committee_members: Vec<PeerConfig<SeqTypes>>, da_members: Vec<PeerConfig<SeqTypes>>, fetcher: StakeTableFetcher, ) -> Self

pub async fn reload_stake(&mut self, limit: u64)

fn get_stake_table( &self, epoch: &Option<<SeqTypes as NodeType>::Epoch>, ) -> Option<Vec<PeerConfig<SeqTypes>>>

Trait Implementations

impl Clone for EpochCommittees

fn clone(&self) -> EpochCommittees

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EpochCommittees

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

Formats the value using the given formatter.

impl Membership<SeqTypes> for EpochCommittees

fn stake_table( &self, epoch: Option<<SeqTypes as NodeType>::Epoch>, ) -> HSStakeTable<SeqTypes>

Get the stake table for the current view

fn da_stake_table( &self, _epoch: Option<<SeqTypes as NodeType>::Epoch>, ) -> HSStakeTable<SeqTypes>

Get the stake table for the current view

fn committee_members( &self, _view_number: <SeqTypes as NodeType>::View, epoch: Option<<SeqTypes as NodeType>::Epoch>, ) -> BTreeSet<PubKey>

Get all members of the committee for the current view

fn da_committee_members( &self, _view_number: <SeqTypes as NodeType>::View, _epoch: Option<<SeqTypes as NodeType>::Epoch>, ) -> BTreeSet<PubKey>

Get all members of the committee for the current view

fn stake( &self, pub_key: &PubKey, epoch: Option<<SeqTypes as NodeType>::Epoch>, ) -> Option<PeerConfig<SeqTypes>>

Get the stake table entry for a public key

fn da_stake( &self, pub_key: &PubKey, _epoch: Option<<SeqTypes as NodeType>::Epoch>, ) -> Option<PeerConfig<SeqTypes>>

Get the DA stake table entry for a public key

fn has_stake( &self, pub_key: &PubKey, epoch: Option<<SeqTypes as NodeType>::Epoch>, ) -> bool

Check if a node has stake in the committee

fn has_da_stake( &self, pub_key: &PubKey, epoch: Option<<SeqTypes as NodeType>::Epoch>, ) -> bool

Check if a node has stake in the committee

fn lookup_leader( &self, view_number: <SeqTypes as NodeType>::View, epoch: Option<<SeqTypes as NodeType>::Epoch>, ) -> Result<PubKey, Self::Error>

Index the vector of public keys with the current view number

fn total_nodes(&self, epoch: Option<<SeqTypes as NodeType>::Epoch>) -> usize

Get the total number of nodes in the committee

fn da_total_nodes(&self, epoch: Option<<SeqTypes as NodeType>::Epoch>) -> usize

Get the total number of DA nodes in the committee

fn success_threshold( &self, epoch: Option<<SeqTypes as NodeType>::Epoch>, ) -> U256

Get the voting success threshold for the committee

fn da_success_threshold( &self, epoch: Option<<SeqTypes as NodeType>::Epoch>, ) -> U256

Get the voting success threshold for the committee

fn failure_threshold( &self, epoch: Option<<SeqTypes as NodeType>::Epoch>, ) -> U256

Get the voting failure threshold for the committee

fn upgrade_threshold( &self, epoch: Option<<SeqTypes as NodeType>::Epoch>, ) -> U256

Get the voting upgrade threshold for the committee

type Error = LeaderLookupError

The error type returned by methods like lookup_leader.

fn new( _committee_members: Vec<PeerConfig<SeqTypes>>, _da_members: Vec<PeerConfig<SeqTypes>>, ) -> Self

Create a committee

async fn add_epoch_root( &self, epoch: <SeqTypes as NodeType>::Epoch, block_header: Header, ) -> Option<Box<dyn FnOnce(&mut Self) + Send>>

Handles notifications that a new epoch root has been created Is called under a read lock to the Membership. Return a callback with Some to have that callback invoked under a write lock.

fn has_stake_table(&self, epoch: <SeqTypes as NodeType>::Epoch) -> bool

Returns if the stake table is available for the given epoch

fn has_randomized_stake_table( &self, epoch: <SeqTypes as NodeType>::Epoch, ) -> bool

Returns if the randomized stake table is available for the given epoch

async fn get_epoch_root( membership: Arc<RwLock<Self>>, block_height: u64, epoch: <SeqTypes as NodeType>::Epoch, ) -> Result<Leaf2>

Gets the validated block header and epoch number of the epoch root at the given block height

async fn get_epoch_drb( membership: Arc<RwLock<Self>>, block_height: u64, epoch: <SeqTypes as NodeType>::Epoch, ) -> Result<DrbResult>

Gets the DRB result for the given epoch

fn add_drb_result( &mut self, epoch: <SeqTypes as NodeType>::Epoch, drb: DrbResult, )

Called to notify the Membership when a new DRB result has been calculated. Observes the same semantics as add_epoch_root

fn set_first_epoch( &mut self, epoch: <SeqTypes as NodeType>::Epoch, initial_drb_result: DrbResult, )

Called to notify the Membership that Epochs are enabled. Implementations should copy the pre-epoch stake table into epoch and epoch+1 when this is called. The value of initial_drb_result should be used for DRB calculations for epochs (epoch+1) and earlier.

fn total_stake(&self, epoch: Option<<TYPES as NodeType>::Epoch>) -> Uint<256, 4>

fn total_da_stake( &self, epoch: Option<<TYPES as NodeType>::Epoch>, ) -> Uint<256, 4>

fn leader( &self, view: <TYPES as NodeType>::View, epoch: Option<<TYPES as NodeType>::Epoch>, ) -> Result<<TYPES as NodeType>::SignatureKey, Error>

The leader of the committee for view view_number in epoch.