IotaSystemStateSummaryV1
@iota/iota-sdk / client / IotaSystemStateSummaryV1
Interface: IotaSystemStateSummaryV1
Defined in: sdk/typescript/src/client/types/generated.ts:781
This is the JSON-RPC type for the
IotaSystemStateV1 object. It flattens all
fields to make them top-level fields such that it as minimum dependencies to the internal data
structures of the IOTA system state type.
Properties
activeValidators
activeValidators:
IotaValidatorSummary[]
Defined in: sdk/typescript/src/client/types/generated.ts:783
The list of active validators in the current epoch.
atRiskValidators
atRiskValidators: [
string,string][]
Defined in: sdk/typescript/src/client/types/generated.ts:785
Map storing the number of epochs for which each validator has been below the low stake threshold.
epoch
epoch:
string
Defined in: sdk/typescript/src/client/types/generated.ts:787
The current epoch ID, starting from 0.
epochDurationMs
epochDurationMs:
string
Defined in: sdk/typescript/src/client/types/generated.ts:789
The duration of an epoch, in milliseconds.
epochStartTimestampMs
epochStartTimestampMs:
string
Defined in: sdk/typescript/src/client/types/generated.ts:791
Unix timestamp of the current epoch start
inactivePoolsId
inactivePoolsId:
string
Defined in: sdk/typescript/src/client/types/generated.ts:796
ID of the object that maps from a staking pool ID to the inactive validator that has that pool as its staking pool.
inactivePoolsSize
inactivePoolsSize:
string
Defined in: sdk/typescript/src/client/types/generated.ts:798
Number of inactive staking pools.
iotaTotalSupply
iotaTotalSupply:
string
Defined in: sdk/typescript/src/client/types/generated.ts:800
The current IOTA supply.
iotaTreasuryCapId
iotaTreasuryCapId:
string
Defined in: sdk/typescript/src/client/types/generated.ts:802
The TreasuryCap<IOTA> object ID.
maxValidatorCount
maxValidatorCount:
string
Defined in: sdk/typescript/src/client/types/generated.ts:807
Maximum number of active validators at any moment. We do not allow the number of validators in any epoch to go above this.
minValidatorCount
minValidatorCount:
string
Defined in: sdk/typescript/src/client/types/generated.ts:812
Minimum number of active validators at any moment. We do not allow the number of validators in any epoch to go under this.
minValidatorJoiningStake
minValidatorJoiningStake:
string
Defined in: sdk/typescript/src/client/types/generated.ts:814
Lower-bound on the amount of stake required to become a validator.
pendingActiveValidatorsId
pendingActiveValidatorsId:
string
Defined in: sdk/typescript/src/client/types/generated.ts:816
ID of the object that contains the list of new validators that will join at the end of the epoch.
pendingActiveValidatorsSize
pendingActiveValidatorsSize:
string
Defined in: sdk/typescript/src/client/types/generated.ts:818
Number of new validators that will join at the end of the epoch.
pendingRemovals
pendingRemovals:
string[]
Defined in: sdk/typescript/src/client/types/generated.ts:820
Removal requests from the validators. Each element is an index pointing to active_validators.
protocolVersion
protocolVersion:
string
Defined in: sdk/typescript/src/client/types/generated.ts:822
The current protocol version, starting from 1.
referenceGasPrice
referenceGasPrice:
string
Defined in: sdk/typescript/src/client/types/generated.ts:824
The reference gas price for the current epoch.
safeMode
safeMode:
boolean
Defined in: sdk/typescript/src/client/types/generated.ts:830
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.
safeModeComputationRewards
safeModeComputationRewards:
string
Defined in: sdk/typescript/src/client/types/generated.ts:832
Amount of computation rewards accumulated (and not yet distributed) during safe mode.
safeModeNonRefundableStorageFee
safeModeNonRefundableStorageFee:
string
Defined in: sdk/typescript/src/client/types/generated.ts:834
Amount of non-refundable storage fee accumulated during safe mode.
safeModeStorageCharges
safeModeStorageCharges:
string
Defined in: sdk/typescript/src/client/types/generated.ts:836
Amount of storage charges accumulated (and not yet distributed) during safe mode.
safeModeStorageRebates
safeModeStorageRebates:
string
Defined in: sdk/typescript/src/client/types/generated.ts:838
Amount of storage rebates accumulated (and not yet burned) during safe mode.
stakingPoolMappingsId
stakingPoolMappingsId:
string
Defined in: sdk/typescript/src/client/types/generated.ts:840
ID of the object that maps from staking pool's ID to the iota address of a validator.
stakingPoolMappingsSize
stakingPoolMappingsSize:
string
Defined in: sdk/typescript/src/client/types/generated.ts:842
Number of staking pool mappings.
storageFundNonRefundableBalance
storageFundNonRefundableBalance:
string
Defined in: sdk/typescript/src/client/types/generated.ts:847
The non-refundable portion of the storage fund coming from non-refundable storage rebates and any leftover staking rewards.
storageFundTotalObjectStorageRebates
storageFundTotalObjectStorageRebates:
string
Defined in: sdk/typescript/src/client/types/generated.ts:849
The storage rebates of all the objects on-chain stored in the storage fund.
systemStateVersion
systemStateVersion:
string
Defined in: sdk/typescript/src/client/types/generated.ts:851
The current version of the system state data structure type.
totalStake
totalStake:
string
Defined in: sdk/typescript/src/client/types/generated.ts:853
Total amount of stake from all active validators at the beginning of the epoch.
validatorCandidatesId
validatorCandidatesId:
string
Defined in: sdk/typescript/src/client/types/generated.ts:858
ID of the object that stores preactive validators, mapping their addresses to their Validator
structs.
validatorCandidatesSize
validatorCandidatesSize:
string
Defined in: sdk/typescript/src/client/types/generated.ts:860
Number of preactive validators.
validatorLowStakeGracePeriod
validatorLowStakeGracePeriod:
string
Defined in: sdk/typescript/src/client/types/generated.ts:865
A validator can have stake below validator_low_stake_threshold for this many epochs before being
kicked out.
validatorLowStakeThreshold
validatorLowStakeThreshold:
string
Defined in: sdk/typescript/src/client/types/generated.ts:871
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.
validatorReportRecords
validatorReportRecords: [
string,string[]][]
Defined in: sdk/typescript/src/client/types/generated.ts:873
A map storing the records of validator reporting each other.
validatorVeryLowStakeThreshold
validatorVeryLowStakeThreshold:
string
Defined in: sdk/typescript/src/client/types/generated.ts:878
Validators with stake below validator_very_low_stake_threshold will be removed immediately at
epoch change, no grace period.