Struct Committee 

pub struct Committee {
    pub epoch: EpochId,
    pub voting_rights: Vec<(AuthorityName, StakeUnit)>,
    /* private fields */
}

Fields

epoch: EpochId

voting_rights: Vec<(AuthorityName, StakeUnit)>

Implementations

impl Committee

pub fn new( epoch: EpochId, voting_rights: BTreeMap<AuthorityName, StakeUnit>, ) -> Self

pub fn from_committee_members( epoch: EpochId, members: &[ValidatorCommitteeMember], ) -> Self

Build a committee for epoch from a [ValidatorCommitteeMember] list.

pub fn committee_members(&self) -> Vec<ValidatorCommitteeMember>

The committee’s voting rights expressed as a [ValidatorCommitteeMember] list used by EndOfEpochData.

pub fn new_for_testing_with_normalized_voting_power( epoch: EpochId, voting_weights: BTreeMap<AuthorityName, StakeUnit>, ) -> Self

Normalize the given weights to TOTAL_VOTING_POWER and create the committee. Used for testing only: a production system is using the voting weights of the Iota System object.

pub fn load_inner( voting_rights: &[(AuthorityName, StakeUnit)], ) -> (HashMap<AuthorityName, AuthorityPublicKey>, HashMap<AuthorityName, usize>)

pub fn authority_index(&self, author: &AuthorityName) -> Option<u32>

pub fn authority_by_index(&self, index: u32) -> Option<&AuthorityName>

pub fn epoch(&self) -> EpochId

pub fn public_key( &self, authority: &AuthorityName, ) -> IotaResult<&AuthorityPublicKey>

pub fn sample(&self) -> &AuthorityName

Samples authorities by weight

pub fn choose_multiple_weighted_iter( &self, count: usize, ) -> impl Iterator<Item = &AuthorityName>

pub fn total_votes(&self) -> StakeUnit

pub fn quorum_threshold(&self) -> StakeUnit

pub fn validity_threshold(&self) -> StakeUnit

pub fn threshold<const STRENGTH: bool>(&self) -> StakeUnit

pub fn effective_threshold(&self, buffer_stake_bps: u64) -> StakeUnit

Calculates the effective threshold for protocol version selection. This is the quorum threshold plus a buffer stake based on the given basis points.

The buffer is calculated as: f * buffer_stake_bps / 10000, rounded up where f = total_votes - quorum_threshold

buffer_stake_bps is clamped to a maximum of 10000.

pub fn num_members(&self) -> usize

pub fn members(&self) -> impl Iterator<Item = &(AuthorityName, StakeUnit)>

pub fn names(&self) -> impl Iterator<Item = &AuthorityName>

pub fn stakes(&self) -> impl Iterator<Item = StakeUnit> + '_

pub fn stake_by_index(&self, index: u32) -> Option<StakeUnit>

Returns the stake of the authority at the given index, or None if out of bounds.

pub fn authority_exists(&self, name: &AuthorityName) -> bool

pub fn shuffle_by_stake_from_tx_digest( &self, tx_digest: &TransactionDigest, ) -> Vec<AuthorityName>

Derive a seed deterministically from the transaction digest and shuffle the validators.

pub fn new_simple_test_committee_of_size( size: usize, ) -> (Self, Vec<AuthorityKeyPair>)

pub fn new_simple_test_committee() -> (Self, Vec<AuthorityKeyPair>)

Generate a simple committee with 4 validators each with equal voting stake of 1.

Trait Implementations

impl Clone for Committee

fn clone(&self) -> Committee

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CommitteeTrait<AuthorityPublicKeyBytes> for Committee

fn shuffle_by_stake_with_rng( &self, preferences: Option<&BTreeSet<AuthorityName>>, restrict_to: Option<&BTreeSet<AuthorityName>>, rng: &mut impl Rng, ) -> Vec<AuthorityName>

fn weight(&self, author: &AuthorityName) -> StakeUnit

fn shuffle_by_stake( &self, preferences: Option<&BTreeSet<K>>, restrict_to: Option<&BTreeSet<K>>, ) -> Vec<K>

impl Debug for Committee

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Committee

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Committee

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

Formats the value using the given formatter.

impl From<Committee> for ValidatorCommittee

fn from(value: Committee) -> Self

Converts to this type from the input type.

impl From<ValidatorCommittee> for Committee

fn from(value: ValidatorCommittee) -> Self

Converts to this type from the input type.

impl Hash for Committee

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Committee

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Committee

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Committee