Struct SystemParameters

#[non_exhaustive]
pub struct SystemParameters {
    pub epoch_duration_ms: Option<u64>,
    pub stake_subsidy_start_epoch: Option<u64>,
    pub min_validator_count: Option<u64>,
    pub max_validator_count: Option<u64>,
    pub min_validator_joining_stake: Option<u64>,
    pub validator_low_stake_threshold: Option<u64>,
    pub validator_very_low_stake_threshold: Option<u64>,
    pub validator_low_stake_grace_period: Option<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.

epoch_duration_ms: Option<u64>

The duration of an epoch, in milliseconds.

stake_subsidy_start_epoch: Option<u64>

The starting epoch in which stake subsidies start being paid out

min_validator_count: Option<u64>

Minimum number of active validators at any moment.

max_validator_count: Option<u64>

Maximum number of active validators at any moment. We do not allow the number of validators in any epoch to go above this.

min_validator_joining_stake: Option<u64>

Deprecated. Lower-bound on the amount of stake required to become a validator.

validator_low_stake_threshold: Option<u64>

Deprecated. Validators with stake amount below validator_low_stake_threshold are considered to have low stake and will be escorted out of the validator set after being below this threshold for more than validator_low_stake_grace_period number of epochs.

validator_very_low_stake_threshold: Option<u64>

Deprecated. Validators with stake below validator_very_low_stake_threshold will be removed immediately at epoch change, no grace period.

validator_low_stake_grace_period: Option<u64>

A validator can have stake below validator_low_stake_threshold for this many epochs before being kicked out.

extra_fields: Option<MoveTable>

Any extra fields that are not defined statically.

Implementations

impl SystemParameters

pub const EPOCH_DURATION_MS_FIELD: &'static MessageField

pub const STAKE_SUBSIDY_START_EPOCH_FIELD: &'static MessageField

pub const MIN_VALIDATOR_COUNT_FIELD: &'static MessageField

pub const MAX_VALIDATOR_COUNT_FIELD: &'static MessageField

pub const MIN_VALIDATOR_JOINING_STAKE_FIELD: &'static MessageField

pub const VALIDATOR_LOW_STAKE_THRESHOLD_FIELD: &'static MessageField

pub const VALIDATOR_VERY_LOW_STAKE_THRESHOLD_FIELD: &'static MessageField

pub const VALIDATOR_LOW_STAKE_GRACE_PERIOD_FIELD: &'static MessageField

pub const EXTRA_FIELDS_FIELD: &'static MessageField

impl SystemParameters

pub fn path_builder() -> SystemParametersFieldPathBuilder

impl SystemParameters

pub const fn const_default() -> Self

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

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

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

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

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

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

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

Sets epoch_duration_ms with the provided value.

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

Sets epoch_duration_ms with the provided value.

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

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

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

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

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

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

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

Sets stake_subsidy_start_epoch with the provided value.

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

Sets stake_subsidy_start_epoch with the provided value.

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

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

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

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

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

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

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

Sets min_validator_count with the provided value.

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

Sets min_validator_count with the provided value.

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

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

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

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

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

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

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

Sets max_validator_count with the provided value.

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

Sets max_validator_count with the provided value.

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

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

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

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

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

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

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

Sets min_validator_joining_stake with the provided value.

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

Sets min_validator_joining_stake with the provided value.

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

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

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

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

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

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

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

Sets validator_low_stake_threshold with the provided value.

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

Sets validator_low_stake_threshold with the provided value.

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

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

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

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

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

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

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

Sets validator_very_low_stake_threshold with the provided value.

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

Sets validator_very_low_stake_threshold with the provided value.

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

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

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

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

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

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

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

Sets validator_low_stake_grace_period with the provided value.

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

Sets validator_low_stake_grace_period 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 SystemParameters

pub fn epoch_duration_ms(&self) -> u64

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

pub fn stake_subsidy_start_epoch(&self) -> u64

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

pub fn min_validator_count(&self) -> u64

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

pub fn max_validator_count(&self) -> u64

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

pub fn min_validator_joining_stake(&self) -> u64

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

pub fn validator_low_stake_threshold(&self) -> u64

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

pub fn validator_very_low_stake_threshold(&self) -> u64

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

pub fn validator_low_stake_grace_period(&self) -> u64

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

Trait Implementations

impl Clone for SystemParameters

fn clone(&self) -> SystemParameters

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SystemParameters

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

Formats the value using the given formatter.

impl Default for SystemParameters

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SystemParameters

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for SystemParameters

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 SystemParameters

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

impl PartialEq for SystemParameters

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

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 SystemParameters