v12

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2024-07-172198160.4 KB
System

get/system

Response

epochstring u64 required

The current epoch ID, starting from 0.

epoch_duration_msstring u64 required

The duration of an epoch, in milliseconds.

epoch_start_timestamp_msstring u64 required

Unix timestamp of the current epoch start

inactive_pools_idstring hex required

A 32-byte Sui address, encoded as a hex string.

inactive_pools_sizestring u64 required

Number of inactive staking pools.

max_validator_countstring u64 required

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_stakestring u64 required

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

pending_active_validators_idstring hex required

A 32-byte Sui address, encoded as a hex string.

pending_active_validators_sizestring u64 required

Number of new validators that will join at the end of the epoch.

pending_removalsstring[] required

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

protocol_versionstring u64 required

The current protocol version, starting from 1.

reference_gas_pricestring u64 required

The reference gas price for the current epoch.

safe_modeboolean required

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.

safe_mode_computation_rewardsstring u64 required

Amount of computation rewards accumulated (and not yet distributed) during safe mode.

safe_mode_non_refundable_storage_feestring u64 required

Amount of non-refundable storage fee accumulated during safe mode.

safe_mode_storage_rebatesstring u64 required

Amount of storage rebates accumulated (and not yet burned) during safe mode.

safe_mode_storage_rewardsstring u64 required

Amount of storage rewards accumulated (and not yet distributed) during safe mode.

stake_subsidy_balancestring u64 required

Balance of SUI set aside for stake subsidies that will be drawn down over time.

stake_subsidy_current_distribution_amountstring u64 required

The amount of stake subsidy to be drawn down per epoch. This amount decays and decreases over time.

stake_subsidy_decrease_rateinteger required

The rate at which the distribution amount decays at the end of each period. Expressed in basis points.

stake_subsidy_distribution_counterstring u64 required

This counter may be different from the current epoch number if in some epochs we decide to skip the subsidy.

stake_subsidy_period_lengthstring u64 required

Number of distributions to occur before the distribution amount decays.

stake_subsidy_start_epochstring u64 required

The starting epoch in which stake subsidies start being paid out

staking_pool_mappings_idstring hex required

A 32-byte Sui address, encoded as a hex string.

staking_pool_mappings_sizestring u64 required

Number of staking pool mappings.

storage_fund_non_refundable_balancestring u64 required

The non-refundable portion of the storage fund coming from storage reinvestment, non-refundable storage rebates and any leftover staking rewards.

storage_fund_total_object_storage_rebatesstring u64 required

The storage rebates of all the objects on-chain stored in the storage fund.

system_state_versionstring u64 required

The current version of the system state data structure type.

total_stakestring u64 required

Total amount of stake from all active validators at the beginning of the epoch.

validator_candidates_idstring hex required

A 32-byte Sui address, encoded as a hex string.

validator_candidates_sizestring u64 required

Number of preactive validators.

validator_low_stake_grace_periodstring u64 required

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

validator_low_stake_thresholdstring u64 required

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_thresholdstring u64 required

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

Example response

{
  "active_validators": [
    {
      "address": "0x0000000000000000000000000000000000000000000000000000000000000002",
      "exchange_rates_id": "0x0000000000000000000000000000000000000000000000000000000000000002",
      "operation_cap_id": "0x0000000000000000000000000000000000000000000000000000000000000002",
      "staking_pool_id": "0x0000000000000000000000000000000000000000000000000000000000000002"
    }
  ],
  "inactive_pools_id": "0x0000000000000000000000000000000000000000000000000000000000000002",
  "pending_active_validators_id": "0x0000000000000000000000000000000000000000000000000000000000000002",
  "staking_pool_mappings_id": "0x0000000000000000000000000000000000000000000000000000000000000002",
  "validator_candidates_id": "0x0000000000000000000000000000000000000000000000000000000000000002"
}