Skip to main content

Epoch

Epoch​

struct Epoch

init(epochId:fundInflow:fundOutflow:fundSize:liveObjectSetDigest:netInflow:protocolConfigs:referenceGasPrice:startTimestamp:endTimestamp:systemStateVersion:totalCheckpoints:totalGasFees:totalStakeRewards:totalTransactions:validatorSet:)​

init(epochId: UInt64, fundInflow: String? = nil, fundOutflow: String? = nil, fundSize: String? = nil, liveObjectSetDigest: String? = nil, netInflow: String? = nil, protocolConfigs: ProtocolConfigs? = nil, referenceGasPrice: String? = nil, startTimestamp: String, endTimestamp: String? = nil, systemStateVersion: UInt64? = nil, totalCheckpoints: UInt64? = nil, totalGasFees: String? = nil, totalStakeRewards: String? = nil, totalTransactions: UInt64? = nil, validatorSet: ValidatorSet? = nil)

endTimestamp​

var endTimestamp: String?

The epoch's ending timestamp. Note that this is available only on epochs that have ended. RFC3339 in UTC with format: YYYY-MM-DDTHH:MM:SS.mmmZ

epochId​

var epochId: UInt64

The epoch's id as a sequence number that starts at 0 and is incremented by one at every epoch change.

fundInflow​

var fundInflow: String?

The storage fees paid for transactions executed during the epoch.

fundOutflow​

var fundOutflow: String?

The storage fee rebates paid to users who deleted the data associated with past transactions.

fundSize​

var fundSize: String?

The storage fund available in this epoch. This fund is used to redistribute storage fees from past transactions to future validators.

liveObjectSetDigest​

var liveObjectSetDigest: String?

A commitment by the committee at the end of epoch on the contents of the live object set at that time. This can be used to verify state snapshots.

netInflow​

var netInflow: String?

The difference between the fund inflow and outflow, representing the net amount of storage fees accumulated in this epoch.

protocolConfigs​

var protocolConfigs: ProtocolConfigs?

The epoch's corresponding protocol configuration, including the feature flags and the configuration options.

referenceGasPrice​

var referenceGasPrice: String?

The minimum gas price that a quorum of validators are guaranteed to sign a transaction for.

startTimestamp​

var startTimestamp: String

The epoch's starting timestamp. RFC3339 in UTC with format: YYYY-MM-DDTHH:MM:SS.mmmZ

systemStateVersion​

var systemStateVersion: UInt64?

The value of the version field of 0x5, the 0x3::iota::IotaSystemState object. This version changes whenever the fields contained in the system state object (held in a dynamic field attached to 0x5) change.

totalCheckpoints​

var totalCheckpoints: UInt64?

The total number of checkpoints in this epoch.

totalGasFees​

var totalGasFees: String?

The total amount of gas fees (in IOTA) that were paid in this epoch.

totalStakeRewards​

var totalStakeRewards: String?

The total IOTA rewarded as stake.

totalTransactions​

var totalTransactions: UInt64?

The total number of transaction in this epoch.

validatorSet​

var validatorSet: ValidatorSet?

Validator related properties. For active validators, see active_validators API. For epochs other than the current the data provided refer to the start of the epoch.