Struct EpochCommittees 

pub struct EpochCommittees {
    inner: Arc<RwLock<Inner>>,
    fetcher: Arc<Fetcher>,
    update_fixed_block_reward_lock: Arc<Mutex<()>>,
    load_from_storage_lock: Arc<Mutex<()>>,
    storage_read_timeout: Duration,
    epoch_height: BlockNumber,
}

Type to describe DA and Stake memberships.

Fields

inner: Arc<RwLock<Inner>>

fetcher: Arc<Fetcher>

update_fixed_block_reward_lock: Arc<Mutex<()>>

load_from_storage_lock: Arc<Mutex<()>>

storage_read_timeout: Duration

epoch_height: BlockNumber

Implementations

impl EpochCommittees

pub fn epoch_height(&self) -> BlockNumber

pub fn first_epoch(&self) -> EpochNumber

pub fn fetcher(&self) -> &Fetcher

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

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

Find the most recent stake-table entry for key.

Scanns loaded epochs from highest to lowest and falling back to the genesis bootstrap committee.

pub fn latest_account(&self, key: &PubKey) -> Option<Address>

async fn fetch_and_update_fixed_block_reward( &self, epoch: EpochNumber, ) -> Result<RewardAmount>

Fetch the fixed block reward and update it if its None. We used a fixed block reward for version v3 Version v4 uses the dynamic block reward Assumes the stake table contract proxy address does not change

async fn calculate_dynamic_block_reward( &self, epoch: EpochNumber, header: &Header, validators: &AuthenticatedValidatorMap, coordinator: &EpochMembershipCoordinator<SeqTypes>, ) -> Result<Option<RewardAmount>>

Calculates the dynamic block reward for a given block header within an epoch.

The reward is based on a dynamic inflation rate computed from the current stake ratio (p), where p = total_stake / total_supply. The inflation function R(p) is defined piecewise:

• If p <= 0.01: R(p) = 0.03 / sqrt(2 * 0.01)
• Else: R(p) = 0.03 / sqrt(2 * p)

pub fn epoch_block_reward(&self, epoch: EpochNumber) -> Option<RewardAmount>

This function just returns the stored block reward in epoch committee

pub fn get_validator_index( &self, epoch: EpochNumber, bls_key: &PubKey, ) -> Option<usize>

Get the index of a validator’s BLS key in the epoch’s stake table. Returns None if the validator is not in the stake table for this epoch.

The index corresponds to the position in the leader_counts array in V6 headers.

pub fn active_validators( &self, e: EpochNumber, ) -> Result<AuthenticatedValidatorMap>

pub fn address(&self, e: EpochNumber, key: &BLSPubKey) -> Result<Address>

pub fn get_validator_config( &self, epoch: EpochNumber, key: &BLSPubKey, ) -> Result<AuthenticatedValidator<BLSPubKey>>

pub fn new<B: Into<BlockNumber>>( committee_members: Vec<PeerConfig<SeqTypes>>, da_members: Vec<PeerConfig<SeqTypes>>, fixed_block_reward: Option<RewardAmount>, fetcher: Fetcher, epoch_height: B, first_epoch: EpochNumber, ) -> Self

The membership of a chain whose epochs start at first_epoch.

first_epoch and first_epoch + 1 run on the genesis stake table, committee_members, with the initial DRB result.

pub fn with_storage_read_timeout(self, timeout: Duration) -> Self

Override how long load_stake_table may spend on each of its two phases. Mostly for tests.

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

fn map_header<E, F, R>(&self, epoch: E, f: F) -> Option<R>

where E: Into<EpochNumber>, F: FnMut(&Header) -> R,

Get root leaf header for a given epoch

fn seed_first_epoch(&self, epoch: EpochNumber)

Run epoch and epoch + 1 on the genesis stake table with the initial DRB result.

fn randomized_committee( &self, epoch: EpochNumber, drb: DrbResult, ) -> Option<RandomizedCommittee<StakeTableEntry<PubKey>>>

Trait Implementations

impl Clone for EpochCommittees

fn clone(&self) -> EpochCommittees

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EpochCommittees

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

Formats the value using the given formatter.

impl Membership<SeqTypes> for EpochCommittees

async fn load_stake_table(&self, epoch: EpochNumber) -> bool

Load the committee for epoch from storage.

Everything persisted for the epoch is restored: the stake table, the epoch root header, and the randomized committee (rebuilt from the DRB result).

async fn add_epoch_root( &self, block_header: Header, coordinator: &EpochMembershipCoordinator<SeqTypes>, ) -> Result<(), Self::Error>

Adds the epoch committee and block reward for a given epoch, either by fetching from L1 or using local state if available. It also calculates and stores the block reward based on header version.

type Error = EpochCommitteesError

type Snapshot = EpochSnapshot

A consistent per-epoch view, returned by Self::snapshot.

fn snapshot(&self, epoch: EpochNumber) -> Option<Self::Snapshot>

Capture a consistent per-epoch view.

fn genesis_stake_tables(&self) -> Arc<GenesisStakeTables<SeqTypes>>

The stake tables of views before the first epoch.

async fn get_epoch_root( &self, epoch: EpochNumber, coordinator: &EpochMembershipCoordinator<SeqTypes>, ) -> Result<Leaf2, Self::Error>

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

async fn get_epoch_drb( &self, epoch: EpochNumber, coordinator: &EpochMembershipCoordinator<SeqTypes>, ) -> Result<DrbResult, Self::Error>

Gets the DRB result for the given epoch.

fn add_drb_result(&self, epoch: EpochNumber, drb: DrbResult)

Called to notify the Membership when a new DRB result has been calculated.

fn first_epoch(&self) -> EpochNumber

The first epoch, which runs on the genesis stake table.

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

Get the highest epoch for which a stake table is currently in memory, or None if no stake tables are loaded. It is where catchup resumes from, so an implementation that leaves it at None makes catchup rediscover that point one epoch at a time.

fn add_da_committee( &self, first_epoch: EpochNumber, committee: Vec<PeerConfig<SeqTypes>>, )

Register a DA committee that takes effect starting at first_epoch.