Skip to main content

Module sui_system::sui_system_state_inner

use std::address;
use std::ascii;
use std::bcs;
use std::internal;
use std::option;
use std::string;
use std::type_name;
use std::u128;
use std::u64;
use std::vector;
use sui::accumulator;
use sui::accumulator_settlement;
use sui::address;
use sui::bag;
use sui::balance;
use sui::bcs;
use sui::coin;
use sui::config;
use sui::deny_list;
use sui::dynamic_field;
use sui::dynamic_object_field;
use sui::event;
use sui::funds_accumulator;
use sui::hash;
use sui::hex;
use sui::object;
use sui::party;
use sui::priority_queue;
use sui::protocol_config;
use sui::sui;
use sui::table;
use sui::table_vec;
use sui::transfer;
use sui::tx_context;
use sui::types;
use sui::url;
use sui::vec_map;
use sui::vec_set;
use sui::versioned;
use sui_system::stake_subsidy;
use sui_system::staking_pool;
use sui_system::storage_fund;
use sui_system::validator;
use sui_system::validator_cap;
use sui_system::validator_set;
use sui_system::validator_wrapper;
use sui_system::voting_power;

Struct ExecutionTimeObservationChunkKey​

public struct ExecutionTimeObservationChunkKey has copy, drop, store
Click to open
Fields
chunk_index: u64

Struct SystemParameters​

A list of system config parameters.

public struct SystemParameters has store
Click to open
Fields
epoch_duration_ms: u64
The duration of an epoch, in milliseconds.
stake_subsidy_start_epoch: u64
The starting epoch in which stake subsidies start being paid out
max_validator_count: u64
Deprecated.
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: u64
Deprecated.
Lower-bound on the amount of stake required to become a validator.
validator_low_stake_threshold: u64
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: 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: u64
A validator can have stake below validator_low_stake_threshold for this many epochs before being kicked out.
extra_fields: sui::bag::Bag
Any extra fields that's not defined statically.

Struct SystemParametersV2​

Added min_validator_count.

public struct SystemParametersV2 has store
Click to open
Fields
epoch_duration_ms: u64
The duration of an epoch, in milliseconds.
stake_subsidy_start_epoch: u64
The starting epoch in which stake subsidies start being paid out
min_validator_count: u64
Minimum number of active validators at any moment.
max_validator_count: 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: u64
Deprecated.
Lower-bound on the amount of stake required to become a validator.
validator_low_stake_threshold: 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: 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: u64
A validator can have stake below validator_low_stake_threshold for this many epochs before being kicked out.
extra_fields: sui::bag::Bag
Any extra fields that's not defined statically.

Struct SuiSystemStateInner​

The top-level object containing all information of the Sui system.

public struct SuiSystemStateInner has store
Click to open
Fields
epoch: u64
The current epoch ID, starting from 0.
protocol_version: u64
The current protocol version, starting from 1.
system_state_version: u64
The current version of the system state data structure type.
This is always the same as SuiSystemState.version. Keeping a copy here so that we know what version it is by inspecting SuiSystemStateInner as well.
validators: sui_system::validator_set::ValidatorSet
Contains all information about the validators.
storage_fund: sui_system::storage_fund::StorageFund
The storage fund.
parameters: sui_system::sui_system_state_inner::SystemParameters
A list of system config parameters.
reference_gas_price: u64
The reference gas price for the current epoch.
validator_report_records: sui::vec_map::VecMap<address, sui::vec_set::VecSet<address>>
A map storing the records of validator reporting each other.
There is an entry in the map for each validator that has been reported at least once. The entry VecSet contains all the validators that reported them. If a validator has never been reported they don't have an entry in this map.
This map persists across epoch: a peer continues being in a reported state until the reporter doesn't explicitly remove their report.
Note that in case we want to support validator address change in future, the reports should be based on validator ids
stake_subsidy: sui_system::stake_subsidy::StakeSubsidy
Schedule of stake subsidies given out each epoch.
safe_mode: 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: sui::balance::Balance<sui::sui::SUI>
safe_mode_computation_rewards: sui::balance::Balance<sui::sui::SUI>
safe_mode_storage_rebates: u64
safe_mode_non_refundable_storage_fee: u64
epoch_start_timestamp_ms: u64
Unix timestamp of the current epoch start
extra_fields: sui::bag::Bag
Any extra fields that's not defined statically.

Struct SuiSystemStateInnerV2​

Uses SystemParametersV2 as the parameters.

public struct SuiSystemStateInnerV2 has store
Click to open
Fields
epoch: u64
The current epoch ID, starting from 0.
protocol_version: u64
The current protocol version, starting from 1.
system_state_version: u64
The current version of the system state data structure type.
This is always the same as SuiSystemState.version. Keeping a copy here so that we know what version it is by inspecting SuiSystemStateInner as well.
validators: sui_system::validator_set::ValidatorSet
Contains all information about the validators.
storage_fund: sui_system::storage_fund::StorageFund
The storage fund.
parameters: sui_system::sui_system_state_inner::SystemParametersV2
A list of system config parameters.
reference_gas_price: u64
The reference gas price for the current epoch.
validator_report_records: sui::vec_map::VecMap<address, sui::vec_set::VecSet<address>>
A map storing the records of validator reporting each other.
There is an entry in the map for each validator that has been reported at least once. The entry VecSet contains all the validators that reported them. If a validator has never been reported they don't have an entry in this map.
This map persists across epoch: a peer continues being in a reported state until the reporter doesn't explicitly remove their report.
Note that in case we want to support validator address change in future, the reports should be based on validator ids
stake_subsidy: sui_system::stake_subsidy::StakeSubsidy
Schedule of stake subsidies given out each epoch.
safe_mode: 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: sui::balance::Balance<sui::sui::SUI>
safe_mode_computation_rewards: sui::balance::Balance<sui::sui::SUI>
safe_mode_storage_rebates: u64
safe_mode_non_refundable_storage_fee: u64
epoch_start_timestamp_ms: u64
Unix timestamp of the current epoch start
extra_fields: sui::bag::Bag
Any extra fields that's not defined statically.

Struct SystemEpochInfoEvent​

Event containing system-level epoch information, emitted during the epoch advancement transaction.

public struct SystemEpochInfoEvent has copy, drop
Click to open
Fields
epoch: u64
protocol_version: u64
reference_gas_price: u64
total_stake: u64
storage_fund_reinvestment: u64
storage_charge: u64
storage_rebate: u64
storage_fund_balance: u64
stake_subsidy_amount: u64
total_gas_fees: u64
total_stake_rewards_distributed: u64
leftover_storage_fund_inflow: u64

Constants​

const ENotValidator: u64 = 0;

const ELimitExceeded: u64 = 1;

const ENotSystemAddress: u64 = 2;

const ECannotReportOneself: u64 = 3;

const EReportRecordNotFound: u64 = 4;

const EBpsTooLarge: u64 = 5;

const ESafeModeGasNotProcessed: u64 = 7;

const EAdvancedToWrongEpoch: u64 = 8;

const BASIS_POINT_DENOMINATOR: u64 = 10000;

const ACTIVE_VALIDATOR_ONLY: u8 = 1;

const ACTIVE_OR_PENDING_VALIDATOR: u8 = 2;

const ANY_VALIDATOR: u8 = 3;

const SYSTEM_STATE_VERSION_V1: u64 = 1;

const EXTRA_FIELD_EXECUTION_TIME_ESTIMATES_KEY: u64 = 0;

const EXTRA_FIELD_EXECUTION_TIME_ESTIMATES_CHUNK_COUNT_KEY: u64 = 1;

Function create​

Create a new SuiSystemState object and make it shared.
This function will be called only once in genesis.

public(package) fun create(validators: vector<sui_system::validator::Validator>, initial_storage_fund: sui::balance::Balance<sui::sui::SUI>, protocol_version: u64, epoch_start_timestamp_ms: u64, parameters: sui_system::sui_system_state_inner::SystemParameters, stake_subsidy: sui_system::stake_subsidy::StakeSubsidy, ctx: &mut sui::tx_context::TxContext): sui_system::sui_system_state_inner::SuiSystemStateInner

Function create_system_parameters​

public(package) fun create_system_parameters(epoch_duration_ms: u64, stake_subsidy_start_epoch: u64, max_validator_count: u64, min_validator_joining_stake: u64, validator_low_stake_threshold: u64, validator_very_low_stake_threshold: u64, validator_low_stake_grace_period: u64, ctx: &mut sui::tx_context::TxContext): sui_system::sui_system_state_inner::SystemParameters

Function v1_to_v2​

public(package) fun v1_to_v2(self: sui_system::sui_system_state_inner::SuiSystemStateInner): sui_system::sui_system_state_inner::SuiSystemStateInnerV2

Function request_add_validator_candidate​

Can be called by anyone who wishes to become a validator candidate and starts accruing delegated stakes in their staking pool. Once they have at least MIN_VALIDATOR_JOINING_STAKE amount of stake they can call request_add_validator to officially become an active validator at the next epoch.
Aborts if the caller is already a pending or active validator, or a validator candidate.
Note: proof_of_possession MUST be a valid signature using sui_address and protocol_pubkey_bytes.
To produce a valid PoP, run [fn test_proof_of_possession].

public(package) fun request_add_validator_candidate(self: &mut sui_system::sui_system_state_inner::SuiSystemStateInnerV2, pubkey_bytes: vector<u8>, network_pubkey_bytes: vector<u8>, worker_pubkey_bytes: vector<u8>, proof_of_possession: vector<u8>, name: vector<u8>, description: vector<u8>, image_url: vector<u8>, project_url: vector<u8>, net_address: vector<u8>, p2p_address: vector<u8>, primary_address: vector<u8>, worker_address: vector<u8>, gas_price: u64, commission_rate: u64, ctx: &mut sui::tx_context::TxContext)

Function request_remove_validator_candidate​

Called by a validator candidate to remove themselves from the candidacy. After this call their staking pool becomes deactivate.

public(package) fun request_remove_validator_candidate(self: &mut sui_system::sui_system_state_inner::SuiSystemStateInnerV2, ctx: &mut sui::tx_context::TxContext)

Function request_add_validator​

Called by a validator candidate to add themselves to the active validator set beginning next epoch.
Aborts if the validator is a duplicate with one of the pending or active validators, or if the amount of stake the validator has doesn't meet the min threshold, or if the number of new validators for the next epoch has already reached the maximum.

public(package) fun request_add_validator(self: &mut sui_system::sui_system_state_inner::SuiSystemStateInnerV2, ctx: &sui::tx_context::TxContext)

Function request_remove_validator​

A validator can call this function to request a removal in the next epoch.
We use the sender of ctx to look up the validator (i.e. sender must match the sui_address in the validator).
At the end of the epoch, the validator object will be returned to the sui_address of the validator.

public(package) fun request_remove_validator(self: &mut sui_system::sui_system_state_inner::SuiSystemStateInnerV2, ctx: &sui::tx_context::TxContext)

Function request_set_gas_price​

A validator can call this function to submit a new gas price quote, to be used for the reference gas price calculation at the end of the epoch.

public(package) fun request_set_gas_price(self: &mut sui_system::sui_system_state_inner::SuiSystemStateInnerV2, cap: &sui_system::validator_cap::UnverifiedValidatorOperationCap, new_gas_price: u64)

Function set_candidate_validator_gas_price​

This function is used to set new gas price for candidate validators

public(package) fun set_candidate_validator_gas_price(self: &mut sui_system::sui_system_state_inner::SuiSystemStateInnerV2, cap: &sui_system::validator_cap::UnverifiedValidatorOperationCap, new_gas_price: u64)

Function request_set_commission_rate​

A validator can call this function to set a new commission rate, updated at the end of the epoch.

public(package) fun request_set_commission_rate(self: &mut sui_system::sui_system_state_inner::SuiSystemStateInnerV2, new_commission_rate: u64, ctx: &sui::tx_context::TxContext)

Function set_candidate_validator_commission_rate​

This function is used to set new commission rate for candidate validators

public(package) fun set_candidate_validator_commission_rate(self: &mut sui_system::sui_system_state_inner::SuiSystemStateInnerV2, new_commission_rate: u64, ctx: &sui::tx_context::TxContext)

Function request_add_stake​

Add stake to a validator's staking pool.

public(package) fun request_add_stake(self: &mut sui_system::sui_system_state_inner::SuiSystemStateInnerV2, stake: sui::coin::Coin<sui::sui::SUI>, validator_address: address, ctx: &mut sui::tx_context::TxContext): sui_system::staking_pool::StakedSui

Function request_add_stake_mul_coin​

Add stake to a validator's staking pool using multiple coins.

public(package) fun request_add_stake_mul_coin(self: &mut sui_system::sui_system_state_inner::SuiSystemStateInnerV2, stakes: vector<sui::coin::Coin<sui::sui::SUI>>, stake_amount: std::option::Option<u64>, validator_address: address, ctx: &mut sui::tx_context::TxContext): sui_system::staking_pool::StakedSui

Function request_withdraw_stake​

Withdraw some portion of a stake from a validator's staking pool.

public(package) fun request_withdraw_stake(self: &mut sui_system::sui_system_state_inner::SuiSystemStateInnerV2, staked_sui: sui_system::staking_pool::StakedSui, ctx: &sui::tx_context::TxContext): sui::balance::Balance<sui::sui::SUI>

Function convert_to_fungible_staked_sui​

public(package) fun convert_to_fungible_staked_sui(self: &mut sui_system::sui_system_state_inner::SuiSystemStateInnerV2, staked_sui: sui_system::staking_pool::StakedSui, ctx: &mut sui::tx_context::TxContext): sui_system::staking_pool::FungibleStakedSui

Function redeem_fungible_staked_sui​

public(package) fun redeem_fungible_staked_sui(self: &mut sui_system::sui_system_state_inner::SuiSystemStateInnerV2, fungible_staked_sui: sui_system::staking_pool::FungibleStakedSui, ctx: &sui::tx_context::TxContext): sui::balance::Balance<sui::sui::SUI>

Function report_validator​

Report a validator as a bad or non-performant actor in the system.
Succeeds if all the following are satisfied:

  1. both the reporter in cap and the input reportee_addr are active validators.
  2. reporter and reportee not the same address.
  3. the cap object is still valid.
    This function is idempotent.
public(package) fun report_validator(self: &mut sui_system::sui_system_state_inner::SuiSystemStateInnerV2, cap: &sui_system::validator_cap::UnverifiedValidatorOperationCap, reportee_addr: address)

Function undo_report_validator​

Undo a report_validator action. Aborts if

  1. the reportee is not a currently active validator or
  2. the sender has not previously reported the reportee_addr, or
  3. the cap is not valid
public(package) fun undo_report_validator(self: &mut sui_system::sui_system_state_inner::SuiSystemStateInnerV2, cap: &sui_system::validator_cap::UnverifiedValidatorOperationCap, reportee_addr: address)

Function report_validator_impl​

fun report_validator_impl(verified_cap: sui_system::validator_cap::ValidatorOperationCap, reportee_addr: address, validator_report_records: &mut sui::vec_map::VecMap<address, sui::vec_set::VecSet<address>>)

Function undo_report_validator_impl​

fun undo_report_validator_impl(verified_cap: sui_system::validator_cap::ValidatorOperationCap, reportee_addr: address, validator_report_records: &mut sui::vec_map::VecMap<address, sui::vec_set::VecSet<address>>)

Function rotate_operation_cap​

Create a new UnverifiedValidatorOperationCap, transfer it to the validator and registers it. The original object is thus revoked.

public(package) fun rotate_operation_cap(self: &mut sui_system::sui_system_state_inner::SuiSystemStateInnerV2, ctx: &mut sui::tx_context::TxContext)

Function update_validator_name​

Update a validator's name.

Unlike description and image_url, name is checked against both active and pending validators and must be unique in the system.

For candidate validators, the name is not checked for duplicates.

public(package) fun update_validator_name(self: &mut sui_system::sui_system_state_inner::SuiSystemStateInnerV2, name: vector<u8>, ctx: &sui::tx_context::TxContext)

Function update_validator_description​

Update a validator's description.
Never checked for duplicates.

public(package) fun update_validator_description(self: &mut sui_system::sui_system_state_inner::SuiSystemStateInnerV2, description: vector<u8>, ctx: &sui::tx_context::TxContext)

Function update_validator_image_url​

Update a validator's image url.
Never checked for duplicates.

public(package) fun update_validator_image_url(self: &mut sui_system::sui_system_state_inner::SuiSystemStateInnerV2, image_url: vector<u8>, ctx: &sui::tx_context::TxContext)

Function update_validator_project_url​

Update a candidate or an active/pending validator's project url.
Never checked for duplicates.

public(package) fun update_validator_project_url(self: &mut sui_system::sui_system_state_inner::SuiSystemStateInnerV2, project_url: vector<u8>, ctx: &sui::tx_context::TxContext)

Function update_validator_next_epoch_network_address​

Update a validator's network address.
The change will only take effects starting from the next epoch.

Aborts if there's a duplicate network address in the system.

public(package) fun update_validator_next_epoch_network_address(self: &mut sui_system::sui_system_state_inner::SuiSystemStateInnerV2, network_address: vector<u8>, ctx: &sui::tx_context::TxContext)

Function update_candidate_validator_network_address​

Update candidate validator's network address.
Not checked for duplicates. Uniqueness check is performed in request_add_validator.

public(package) fun update_candidate_validator_network_address(self: &mut sui_system::sui_system_state_inner::SuiSystemStateInnerV2, network_address: vector<u8>, ctx: &sui::tx_context::TxContext)

Function update_validator_next_epoch_p2p_address​

Update a validator's p2p address.
The change will only take effects starting from the next epoch.

Aborts if there's a duplicate p2p address in the system.

public(package) fun update_validator_next_epoch_p2p_address(self: &mut sui_system::sui_system_state_inner::SuiSystemStateInnerV2, p2p_address: vector<u8>, ctx: &sui::tx_context::TxContext)

Function update_candidate_validator_p2p_address​

Update candidate validator's p2p address.
Not checked for duplicates. Uniqueness check is performed in request_add_validator.

public(package) fun update_candidate_validator_p2p_address(self: &mut sui_system::sui_system_state_inner::SuiSystemStateInnerV2, p2p_address: vector<u8>, ctx: &sui::tx_context::TxContext)

Function update_validator_next_epoch_primary_address​

Update a validator's narwhal primary address.
The change will only take effects starting from the next epoch.

Aborts if there's a duplicate primary address in the system.

public(package) fun update_validator_next_epoch_primary_address(self: &mut sui_system::sui_system_state_inner::SuiSystemStateInnerV2, primary_address: vector<u8>, ctx: &sui::tx_context::TxContext)

Function update_candidate_validator_primary_address​

Update candidate validator's narwhal primary address.
Not checked for duplicates. Uniqueness check is performed in request_add_validator.

public(package) fun update_candidate_validator_primary_address(self: &mut sui_system::sui_system_state_inner::SuiSystemStateInnerV2, primary_address: vector<u8>, ctx: &sui::tx_context::TxContext)

Function update_validator_next_epoch_worker_address​

Update a validator's narwhal worker address.
The change will only take effects starting from the next epoch.

Aborts if there's a duplicate worker address in the system.

public(package) fun update_validator_next_epoch_worker_address(self: &mut sui_system::sui_system_state_inner::SuiSystemStateInnerV2, worker_address: vector<u8>, ctx: &sui::tx_context::TxContext)

Function update_candidate_validator_worker_address​

Update candidate validator's narwhal worker address.
Not checked for duplicates. Uniqueness check is performed in request_add_validator.

public(package) fun update_candidate_validator_worker_address(self: &mut sui_system::sui_system_state_inner::SuiSystemStateInnerV2, worker_address: vector<u8>, ctx: &sui::tx_context::TxContext)

Function update_validator_next_epoch_protocol_pubkey​

Update a validator's public key of protocol key and proof of possession.
The change will only take effects starting from the next epoch.

Aborts if there's a duplicate protocol public key in the system.

public(package) fun update_validator_next_epoch_protocol_pubkey(self: &mut sui_system::sui_system_state_inner::SuiSystemStateInnerV2, protocol_pubkey: vector<u8>, proof_of_possession: vector<u8>, ctx: &sui::tx_context::TxContext)

Function update_candidate_validator_protocol_pubkey​

Update candidate validator's public key of protocol key and proof of possession.
Not checked for duplicates. Uniqueness check is performed in request_add_validator.

public(package) fun update_candidate_validator_protocol_pubkey(self: &mut sui_system::sui_system_state_inner::SuiSystemStateInnerV2, protocol_pubkey: vector<u8>, proof_of_possession: vector<u8>, ctx: &sui::tx_context::TxContext)

Function update_validator_next_epoch_worker_pubkey​

Update a validator's public key of worker key.
The change will only take effects starting from the next epoch.

Aborts if there's a duplicate worker public key in the system.

public(package) fun update_validator_next_epoch_worker_pubkey(self: &mut sui_system::sui_system_state_inner::SuiSystemStateInnerV2, worker_pubkey: vector<u8>, ctx: &sui::tx_context::TxContext)

Function update_candidate_validator_worker_pubkey​

Update candidate validator's public key of worker key.
Not checked for duplicates. Uniqueness check is performed in request_add_validator.

public(package) fun update_candidate_validator_worker_pubkey(self: &mut sui_system::sui_system_state_inner::SuiSystemStateInnerV2, worker_pubkey: vector<u8>, ctx: &sui::tx_context::TxContext)

Function update_validator_next_epoch_network_pubkey​

Update a validator's public key of network key.
The change will only take effects starting from the next epoch.

Aborts if there's a duplicate network public key in the system.

public(package) fun update_validator_next_epoch_network_pubkey(self: &mut sui_system::sui_system_state_inner::SuiSystemStateInnerV2, network_pubkey: vector<u8>, ctx: &sui::tx_context::TxContext)

Function update_candidate_validator_network_pubkey​

Update candidate validator's public key of network key.
Not checked for duplicates. Uniqueness check is performed in request_add_validator.

public(package) fun update_candidate_validator_network_pubkey(self: &mut sui_system::sui_system_state_inner::SuiSystemStateInnerV2, network_pubkey: vector<u8>, ctx: &sui::tx_context::TxContext)

Function advance_epoch​

This function should be called at the end of an epoch, and advances the system to the next epoch.
It does the following things:

  1. Add storage charge to the storage fund.
  2. Burn the storage rebates from the storage fund. These are already refunded to transaction sender's gas coins.
  3. Distribute computation charge to validator stake.
  4. Update all validators.
public(package) fun advance_epoch(self: &mut sui_system::sui_system_state_inner::SuiSystemStateInnerV2, new_epoch: u64, next_protocol_version: u64, storage_reward: sui::balance::Balance<sui::sui::SUI>, computation_reward: sui::balance::Balance<sui::sui::SUI>, storage_rebate_amount: u64, non_refundable_storage_fee_amount: u64, storage_fund_reinvest_rate: u64, reward_slashing_rate: u64, epoch_start_timestamp_ms: u64, accumulator_storage_fund_amount: u64, ctx: &mut sui::tx_context::TxContext): sui::balance::Balance<sui::sui::SUI>

Function epoch​

Return the current epoch number. Useful for applications that need a coarse-grained concept of time, since epochs are ever-increasing and epoch changes are intended to happen every 24 hours.

public(package) fun epoch(self: &sui_system::sui_system_state_inner::SuiSystemStateInnerV2): u64

Function protocol_version​

public(package) fun protocol_version(self: &sui_system::sui_system_state_inner::SuiSystemStateInnerV2): u64

Function system_state_version​

public(package) fun system_state_version(self: &sui_system::sui_system_state_inner::SuiSystemStateInnerV2): u64

Function genesis_system_state_version​

This function always return the genesis system state version, which is used to create the system state in genesis.
It should never change for a given network.

public(package) fun genesis_system_state_version(): u64

Function epoch_start_timestamp_ms​

Returns unix timestamp of the start of current epoch

public(package) fun epoch_start_timestamp_ms(self: &sui_system::sui_system_state_inner::SuiSystemStateInnerV2): u64

Function validator_stake_amount​

Returns the total amount staked with validator_addr.
Aborts if validator_addr is not an active validator.

public(package) fun validator_stake_amount(self: &sui_system::sui_system_state_inner::SuiSystemStateInnerV2, validator_addr: address): u64

Function active_validator_voting_powers​

Returns the voting power for validator_addr.
Aborts if validator_addr is not an active validator.

public(package) fun active_validator_voting_powers(self: &sui_system::sui_system_state_inner::SuiSystemStateInnerV2): sui::vec_map::VecMap<address, u64>

Function validator_staking_pool_id​

Returns the staking pool id of a given validator.
Aborts if validator_addr is not an active validator.

public(package) fun validator_staking_pool_id(self: &sui_system::sui_system_state_inner::SuiSystemStateInnerV2, validator_addr: address): sui::object::ID

Function validator_staking_pool_mappings​

Returns reference to the staking pool mappings that map pool ids to active validator addresses

public(package) fun validator_staking_pool_mappings(self: &sui_system::sui_system_state_inner::SuiSystemStateInnerV2): &sui::table::Table<sui::object::ID, address>

Function get_reporters_of​

Returns all the validators who are currently reporting addr

public(package) fun get_reporters_of(self: &sui_system::sui_system_state_inner::SuiSystemStateInnerV2, addr: address): sui::vec_set::VecSet<address>

Function get_storage_fund_total_balance​

public(package) fun get_storage_fund_total_balance(self: &sui_system::sui_system_state_inner::SuiSystemStateInnerV2): u64

Function get_storage_fund_object_rebates​

public(package) fun get_storage_fund_object_rebates(self: &sui_system::sui_system_state_inner::SuiSystemStateInnerV2): u64

Function validator_address_by_pool_id​

public(package) fun validator_address_by_pool_id(self: &mut sui_system::sui_system_state_inner::SuiSystemStateInnerV2, pool_id: &sui::object::ID): address

Function pool_exchange_rates​

public(package) fun pool_exchange_rates(self: &mut sui_system::sui_system_state_inner::SuiSystemStateInnerV2, pool_id: sui::object::ID): &sui::table::Table<u64, sui_system::staking_pool::PoolTokenExchangeRate>

Function active_validator_addresses​

public(package) fun active_validator_addresses(self: &sui_system::sui_system_state_inner::SuiSystemStateInnerV2): vector<address>

Function extract_coin_balance​

Extract required Balance from vector of Coin, transfer the remainder back to sender.

fun extract_coin_balance(coins: vector<sui::coin::Coin<sui::sui::SUI>>, amount: std::option::Option<u64>, ctx: &mut sui::tx_context::TxContext): sui::balance::Balance<sui::sui::SUI>

Function store_execution_time_estimates​

public(package) fun store_execution_time_estimates(self: &mut sui_system::sui_system_state_inner::SuiSystemStateInnerV2, estimates: vector<u8>)

Function store_execution_time_estimates_v2​

public(package) fun store_execution_time_estimates_v2(self: &mut sui_system::sui_system_state_inner::SuiSystemStateInnerV2, estimate_chunks: vector<vector<u8>>)

Function validators​

Return the current validator set

public(package) fun validators(self: &sui_system::sui_system_state_inner::SuiSystemStateInnerV2): &sui_system::validator_set::ValidatorSet

Function validators_mut​

public(package) fun validators_mut(self: &mut sui_system::sui_system_state_inner::SuiSystemStateInnerV2): &mut sui_system::validator_set::ValidatorSet

Function extra_fields​

public(package) fun extra_fields(self: &sui_system::sui_system_state_inner::SuiSystemStateInnerV2): &sui::bag::Bag

Function extra_fields_mut​

public(package) fun extra_fields_mut(self: &mut sui_system::sui_system_state_inner::SuiSystemStateInnerV2): &mut sui::bag::Bag

Macro function mul_div​

macro fun mul_div($a: u64, $b: u64, $c: u64): u64