Struct narwhal_config::Committee

pub struct Committee {
    pub authorities: BTreeMap<PublicKey, Authority>,
    pub epoch: Epoch,
}

Fields

authorities: BTreeMap<PublicKey, Authority>

The authorities of epoch.

epoch: Epoch

The epoch number of this committee

Implementations

impl Committee

pub fn epoch(&self) -> Epoch

Returns the current epoch.

pub fn keys(&self) -> Vec<&PublicKey>

Returns the keys in the committee

pub fn authorities(&self) -> impl Iterator<Item = (&PublicKey, &Authority)>

pub fn size(&self) -> usize

Returns the number of authorities.

pub fn stake(&self, name: &PublicKey) -> Stake

Return the stake of a specific authority.

pub fn quorum_threshold(&self) -> Stake

Returns the stake required to reach a quorum (2f+1).

pub fn validity_threshold(&self) -> Stake

Returns the stake required to reach availability (f+1).

pub fn leader(&self, seed: u64) -> PublicKey

Returns a leader node as a weighted choice seeded by the provided integer

pub fn primary(&self, to: &PublicKey) -> Result<Multiaddr, ConfigError>

Returns the primary address of the target primary.

pub fn network_key(
    &self,
    pk: &PublicKey
) -> Result<NetworkPublicKey, ConfigError>

pub fn others_primaries(
    &self,
    myself: &PublicKey
) -> Vec<(PublicKey, Multiaddr, NetworkPublicKey)>

Return all the network addresses in the committee.

pub fn network_diff<'a>(&'a self, other: &'a Self) -> HashSet<&'_ Multiaddr>

Return the network addresses that are present in the current committee but that are absent from the new committee (provided as argument).

pub fn update_primary_network_info(
    &mut self,
    new_info: BTreeMap<PublicKey, (Stake, Multiaddr)>
) -> Result<(), Vec<CommitteeUpdateError>>

Update the networking information of some of the primaries. The arguments are a full vector of authorities which Public key and Stake must match the one stored in the current Committee. Any discrepancy will generate no update and return a vector of errors.

Trait Implementations

impl Clone for Committee

fn clone(&self) -> Committee

Returns a copy of the value.

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

Performs copy-assignment from source.

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 PartialEq<Committee> for Committee

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

This method tests for self and other values to be equal, and is used by ==.

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

This method 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

impl StructuralEq for Committee

impl StructuralPartialEq for Committee