Struct ValidatorSet

pub struct ValidatorSet {
    pub total_stake: Option<u64>,
    pub active_validators: Vec<Validator>,
    pub pending_active_validators: Option<MoveTable>,
    pub pending_removals: Vec<u64>,
    pub staking_pool_mappings: Option<MoveTable>,
    pub inactive_validators: Option<MoveTable>,
    pub validator_candidates: Option<MoveTable>,
    pub at_risk_validators: HashMap<String, u64>,
    pub extra_fields: Option<MoveTable>,
}

Fields

total_stake: Option<u64>

Total amount of stake from all active validators at the beginning of the epoch. Written only once per epoch, in advance_epoch function.

active_validators: Vec<Validator>

The current list of active validators.

pending_active_validators: Option<MoveTable>

List of new validator candidates added during the current epoch. They will be processed at the end of the epoch.

key: u64 (index), value: 0x3::validator::Validator

pending_removals: Vec<u64>

Removal requests from the validators. Each element is an index pointing to active_validators.

staking_pool_mappings: Option<MoveTable>

Mappings from staking pool’s ID to the sui address of a validator.

key: address (staking pool Id), value: address (sui address of the validator)

inactive_validators: Option<MoveTable>

Mapping from a staking pool ID to the inactive validator that has that pool as its staking pool. When a validator is deactivated the validator is removed from active_validators it is added to this table so that stakers can continue to withdraw their stake from it.

key: address (staking pool Id), value: 0x3::validator_wrapper::ValidatorWrapper

validator_candidates: Option<MoveTable>

Table storing preactive/candidate validators, mapping their addresses to their Validator structs. When an address calls request_add_validator_candidate, they get added to this table and become a preactive validator. When the candidate has met the min stake requirement, they can call request_add_validator to officially add them to the active validator set active_validators next epoch.

key: address (sui address of the validator), value: 0x3::validator_wrapper::ValidatorWrapper

at_risk_validators: HashMap<String, u64>

Table storing the number of epochs during which a validator’s stake has been below the low stake threshold.

extra_fields: Option<MoveTable>

Any extra fields that’s not defined statically.

Implementations

impl ValidatorSet

pub fn total_stake(&self) -> u64

Returns the value of total_stake, or the default value if total_stake is unset.

Trait Implementations

impl Clone for ValidatorSet

fn clone(&self) -> ValidatorSet

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ValidatorSet

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

Formats the value using the given formatter.

impl Default for ValidatorSet

fn default() -> Self

Returns the “default value” for a type.

impl From<ValidatorSetV1> for ValidatorSet

fn from(_: ValidatorSetV1) -> Self

Converts to this type from the input type.

impl Message for ValidatorSet

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for ValidatorSet

fn eq(&self, other: &ValidatorSet) -> 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 StructuralPartialEq for ValidatorSet