Struct ValidatorSet

#[non_exhaustive]
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: BTreeMap<String, u64>,
    pub extra_fields: Option<MoveTable>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

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: BTreeMap<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 const TOTAL_STAKE_FIELD: &'static MessageField

pub const ACTIVE_VALIDATORS_FIELD: &'static MessageField

pub const PENDING_ACTIVE_VALIDATORS_FIELD: &'static MessageField

pub const PENDING_REMOVALS_FIELD: &'static MessageField

pub const STAKING_POOL_MAPPINGS_FIELD: &'static MessageField

pub const INACTIVE_VALIDATORS_FIELD: &'static MessageField

pub const VALIDATOR_CANDIDATES_FIELD: &'static MessageField

pub const AT_RISK_VALIDATORS_FIELD: &'static MessageField

pub const EXTRA_FIELDS_FIELD: &'static MessageField

impl ValidatorSet

pub fn path_builder() -> ValidatorSetFieldPathBuilder

impl ValidatorSet

pub const fn const_default() -> Self

pub fn total_stake_opt_mut(&mut self) -> Option<&mut u64>

If total_stake is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn total_stake_mut(&mut self) -> &mut u64

Returns a mutable reference to total_stake. If the field is unset, it is first initialized with the default value.

pub fn total_stake_opt(&self) -> Option<u64>

If total_stake is set, returns Some with the value; otherwise returns None.

pub fn set_total_stake<T: Into<u64>>(&mut self, field: T)

Sets total_stake with the provided value.

pub fn with_total_stake<T: Into<u64>>(self, field: T) -> Self

Sets total_stake with the provided value.

pub fn active_validators(&self) -> &[Validator]

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

pub fn active_validators_mut(&mut self) -> &mut Vec<Validator>

Returns a mutable reference to active_validators. If the field is unset, it is first initialized with the default value.

pub fn set_active_validators(&mut self, field: Vec<Validator>)

Sets active_validators with the provided value.

pub fn with_active_validators(self, field: Vec<Validator>) -> Self

Sets active_validators with the provided value.

pub fn pending_active_validators(&self) -> &MoveTable

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

pub fn pending_active_validators_opt_mut(&mut self) -> Option<&mut MoveTable>

If pending_active_validators is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn pending_active_validators_mut(&mut self) -> &mut MoveTable

Returns a mutable reference to pending_active_validators. If the field is unset, it is first initialized with the default value.

pub fn pending_active_validators_opt(&self) -> Option<&MoveTable>

If pending_active_validators is set, returns Some with the value; otherwise returns None.

pub fn set_pending_active_validators<T: Into<MoveTable>>(&mut self, field: T)

Sets pending_active_validators with the provided value.

pub fn with_pending_active_validators<T: Into<MoveTable>>( self, field: T, ) -> Self

Sets pending_active_validators with the provided value.

pub fn pending_removals(&self) -> &[u64]

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

pub fn pending_removals_mut(&mut self) -> &mut Vec<u64>

Returns a mutable reference to pending_removals. If the field is unset, it is first initialized with the default value.

pub fn set_pending_removals(&mut self, field: Vec<u64>)

Sets pending_removals with the provided value.

pub fn with_pending_removals(self, field: Vec<u64>) -> Self

Sets pending_removals with the provided value.

pub fn staking_pool_mappings(&self) -> &MoveTable

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

pub fn staking_pool_mappings_opt_mut(&mut self) -> Option<&mut MoveTable>

If staking_pool_mappings is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn staking_pool_mappings_mut(&mut self) -> &mut MoveTable

Returns a mutable reference to staking_pool_mappings. If the field is unset, it is first initialized with the default value.

pub fn staking_pool_mappings_opt(&self) -> Option<&MoveTable>

If staking_pool_mappings is set, returns Some with the value; otherwise returns None.

pub fn set_staking_pool_mappings<T: Into<MoveTable>>(&mut self, field: T)

Sets staking_pool_mappings with the provided value.

pub fn with_staking_pool_mappings<T: Into<MoveTable>>(self, field: T) -> Self

Sets staking_pool_mappings with the provided value.

pub fn inactive_validators(&self) -> &MoveTable

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

pub fn inactive_validators_opt_mut(&mut self) -> Option<&mut MoveTable>

If inactive_validators is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn inactive_validators_mut(&mut self) -> &mut MoveTable

Returns a mutable reference to inactive_validators. If the field is unset, it is first initialized with the default value.

pub fn inactive_validators_opt(&self) -> Option<&MoveTable>

If inactive_validators is set, returns Some with the value; otherwise returns None.

pub fn set_inactive_validators<T: Into<MoveTable>>(&mut self, field: T)

Sets inactive_validators with the provided value.

pub fn with_inactive_validators<T: Into<MoveTable>>(self, field: T) -> Self

Sets inactive_validators with the provided value.

pub fn validator_candidates(&self) -> &MoveTable

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

pub fn validator_candidates_opt_mut(&mut self) -> Option<&mut MoveTable>

If validator_candidates is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn validator_candidates_mut(&mut self) -> &mut MoveTable

Returns a mutable reference to validator_candidates. If the field is unset, it is first initialized with the default value.

pub fn validator_candidates_opt(&self) -> Option<&MoveTable>

If validator_candidates is set, returns Some with the value; otherwise returns None.

pub fn set_validator_candidates<T: Into<MoveTable>>(&mut self, field: T)

Sets validator_candidates with the provided value.

pub fn with_validator_candidates<T: Into<MoveTable>>(self, field: T) -> Self

Sets validator_candidates with the provided value.

pub fn at_risk_validators(&self) -> &BTreeMap<String, u64>

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

pub fn at_risk_validators_mut(&mut self) -> &mut BTreeMap<String, u64>

Returns a mutable reference to at_risk_validators. If the field is unset, it is first initialized with the default value.

pub fn set_at_risk_validators(&mut self, field: BTreeMap<String, u64>)

Sets at_risk_validators with the provided value.

pub fn with_at_risk_validators(self, field: BTreeMap<String, u64>) -> Self

Sets at_risk_validators with the provided value.

pub fn extra_fields(&self) -> &MoveTable

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

pub fn extra_fields_opt_mut(&mut self) -> Option<&mut MoveTable>

If extra_fields is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn extra_fields_mut(&mut self) -> &mut MoveTable

Returns a mutable reference to extra_fields. If the field is unset, it is first initialized with the default value.

pub fn extra_fields_opt(&self) -> Option<&MoveTable>

If extra_fields is set, returns Some with the value; otherwise returns None.

pub fn set_extra_fields<T: Into<MoveTable>>(&mut self, field: T)

Sets extra_fields with the provided value.

pub fn with_extra_fields<T: Into<MoveTable>>(self, field: T) -> Self

Sets extra_fields with the provided value.

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 duplicate 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<'de> Deserialize<'de> for ValidatorSet

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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 MessageFields for ValidatorSet

const FIELDS: &'static [&'static MessageField]

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 Serialize for ValidatorSet

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ValidatorSet