Struct SystemState

pub struct SystemState {

    pub version: Option<u64>,
    pub epoch: Option<u64>,
    pub protocol_version: Option<u64>,
    pub validators: Option<ValidatorSet>,
    pub storage_fund: Option<StorageFund>,
    pub parameters: Option<SystemParameters>,
    pub reference_gas_price: Option<u64>,
    pub validator_report_records: Vec<ValidatorReportRecord>,
    pub stake_subsidy: Option<StakeSubsidy>,
    pub safe_mode: Option<bool>,
    pub safe_mode_storage_rewards: Option<u64>,
    pub safe_mode_computation_rewards: Option<u64>,
    pub safe_mode_storage_rebates: Option<u64>,
    pub safe_mode_non_refundable_storage_fee: Option<u64>,
    pub epoch_start_timestamp_ms: Option<u64>,
    pub extra_fields: Option<MoveTable>,
}

Fields

version: Option<u64>

The version of the system state data structure type.

epoch: Option<u64>

The epoch id

protocol_version: Option<u64>

The protocol version

validators: Option<ValidatorSet>

Information about the validators

storage_fund: Option<StorageFund>

Storage Fund info

parameters: Option<SystemParameters>

Set of system config parameters

reference_gas_price: Option<u64>

The reference gas price for this epoch

validator_report_records: Vec<ValidatorReportRecord>

A list of the records of validator reporting each other.

There is an entry in this list for each validator that has been reported at least once. Each record contains all the validators that reported them. If a validator has never been reported they don’t have a record in this list. This lists persists across epoch: a peer continues being in a reported state until the reporter doesn’t explicitly remove their report.

stake_subsidy: Option<StakeSubsidy>

Schedule of stake subsidies given out each epoch.

safe_mode: Option<bool>

Whether the system is running in a downgraded safe mode due to a non-recoverable bug. This is set whenever we failed to execute advance_epoch, and ended up executing advance_epoch_safe_mode. It can be reset once we are able to successfully execute advance_epoch. The rest of the fields starting with safe_mode_ are accumulated during safe mode when advance_epoch_safe_mode is executed. They will eventually be processed once we are out of safe mode.

safe_mode_storage_rewards: Option<u64>

Storage rewards accumulated during safe_mode

safe_mode_computation_rewards: Option<u64>

Computation rewards accumulated during safe_mode

safe_mode_storage_rebates: Option<u64>

Storage rebates paid out during safe_mode

safe_mode_non_refundable_storage_fee: Option<u64>

Nonrefundable storage fees accumulated during safe_mode

epoch_start_timestamp_ms: Option<u64>

Unix timestamp of when this this epoch started

extra_fields: Option<MoveTable>

Any extra fields that’s not defined statically.

Implementations

impl SystemState

pub fn version(&self) -> u64

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

pub fn epoch(&self) -> u64

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

pub fn protocol_version(&self) -> u64

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

pub fn reference_gas_price(&self) -> u64

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

pub fn safe_mode(&self) -> bool

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

pub fn safe_mode_storage_rewards(&self) -> u64

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

pub fn safe_mode_computation_rewards(&self) -> u64

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

pub fn safe_mode_storage_rebates(&self) -> u64

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

pub fn safe_mode_non_refundable_storage_fee(&self) -> u64

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

pub fn epoch_start_timestamp_ms(&self) -> u64

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

Trait Implementations

impl Clone for SystemState

fn clone(&self) -> SystemState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SystemState

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

Formats the value using the given formatter.

impl Default for SystemState

fn default() -> Self

Returns the “default value” for a type.

impl From<SuiSystemState> for SystemState

fn from(value: SuiSystemState) -> Self

Converts to this type from the input type.

impl From<SuiSystemStateInnerV1> for SystemState

fn from(_: SuiSystemStateInnerV1) -> Self

Converts to this type from the input type.

impl From<SuiSystemStateInnerV2> for SystemState

fn from(_: SuiSystemStateInnerV2) -> Self

Converts to this type from the input type.

impl Message for SystemState

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 SystemState

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