Struct Committee

pub struct Committee<N: Network> { /* private fields */ }

Implementations

impl<N: Network> Committee<N>

pub fn to_id(&self) -> Result<Field<N>>

Returns the committee ID.

impl<N: Network> Committee<N>

pub fn compute_committee_id( starting_round: u64, members: &IndexMap<Address<N>, (u64, bool, u8)>, total_stake: u64, ) -> Result<Field<N>>

Returns the commmitee ID.

impl<N: Network> Committee<N>

pub const COMMITTEE_LOOKBACK_RANGE: u64 = 100u64

The committee lookback range.

pub const MAX_COMMITTEE_SIZE: u16 = BatchHeader<N>::MAX_CERTIFICATES

The maximum number of members that may be in a committee.

pub fn new_genesis( members: IndexMap<Address<N>, (u64, bool, u8)>, ) -> Result<Self>

Initializes a new Committee instance.

pub fn new( starting_round: u64, members: IndexMap<Address<N>, (u64, bool, u8)>, ) -> Result<Self>

Initializes a new Committee instance.

impl<N: Network> Committee<N>

pub const fn id(&self) -> Field<N>

Returns the committee ID.

pub const fn starting_round(&self) -> u64

Returns the starting round number for this committee.

pub const fn members(&self) -> &IndexMap<Address<N>, (u64, bool, u8)>

Returns the committee members alongside their stake.

pub fn num_members(&self) -> usize

Returns the number of validators in the committee.

pub fn is_committee_member(&self, address: Address<N>) -> bool

Returns true if the given address is in the committee.

pub fn is_committee_member_open(&self, address: Address<N>) -> bool

Returns true if the given address is in the committee and is open.

pub fn get_stake(&self, address: Address<N>) -> u64

Returns the amount of stake for the given address.

pub fn is_availability_threshold_reached( &self, addresses: &HashSet<Address<N>>, ) -> bool

Returns true if the combined stake for the given addresses reaches the availability threshold. This method takes in a HashSet to guarantee that the given addresses are unique.

pub fn is_quorum_threshold_reached( &self, addresses: &HashSet<Address<N>>, ) -> bool

Returns true if the combined stake for the given addresses reaches the quorum threshold. This method takes in a HashSet to guarantee that the given addresses are unique.

pub fn availability_threshold(&self) -> u64

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

pub fn quorum_threshold(&self) -> u64

Returns the amount of stake required to reach a quorum threshold (N - f).

pub const fn total_stake(&self) -> u64

Returns the total amount of stake in the committee.

impl<N: Network> Committee<N>

pub fn get_leader(&self, current_round: u64) -> Result<Address<N>>

Returns the leader address for the current round. Note: This method returns a deterministic result that is SNARK-friendly.

Trait Implementations

impl<N: Clone + Network> Clone for Committee<N>

fn clone(&self) -> Committee<N>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<N: Network> Debug for Committee<N>

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

Prints the committee as a JSON-string.

impl<'de, N: Network> Deserialize<'de> for Committee<N>

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserializes the committee from a JSON-string or buffer.

impl<N: Network> Display for Committee<N>

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

Displays the committee as a JSON-string.

impl<N: Network> FromBytes for Committee<N>

fn read_le<R: Read>(reader: R) -> IoResult<Self>

Reads the committee from the buffer.

fn from_bytes_le(bytes: &[u8]) -> Result<Self, Error>

where Self: Sized,

Returns Self from a byte array in little-endian order.

impl<N: Network> FromStr for Committee<N>

fn from_str(certificate: &str) -> Result<Self, Self::Err>

Initializes the committee from a JSON-string.

type Err = Error

The associated error which can be returned from parsing.

impl<N: PartialEq + Network> PartialEq for Committee<N>

fn eq(&self, other: &Committee<N>) -> 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<N: Network> Serialize for Committee<N>

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serializes the committee to a JSON-string or buffer.

impl<N: Network> ToBytes for Committee<N>

fn write_le<W: Write>(&self, writer: W) -> IoResult<()>

Writes the committee to the buffer.

fn to_bytes_le(&self) -> Result<Vec<u8>, Error>

where Self: Sized,

Returns self as a byte array in little-endian order.

impl<N: Eq + Network> Eq for Committee<N>

impl<N: Network> StructuralPartialEq for Committee<N>