Skip to main content

Epoch

data class Epoch(var epochId: ULong, var fundInflow: String? = null, var fundOutflow: String? = null, var fundSize: String? = null, var liveObjectSetDigest: String? = null, var netInflow: String? = null, var protocolConfigs: ProtocolConfigs? = null, var referenceGasPrice: String? = null, var startTimestamp: String, var endTimestamp: String? = null, var systemStateVersion: ULong? = null, var totalCheckpoints: ULong? = null, var totalGasFees: String? = null, var totalStakeRewards: String? = null, var totalTransactions: ULong? = null, var validatorSet: ValidatorSet? = null) : Disposable

Constructors

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

Properties

NameSummary
endTimestampvar 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
epochIdvar epochId: ULong
The epoch's id as a sequence number that starts at 0 and is incremented by one at every epoch change.
fundInflowvar fundInflow: String?
The storage fees paid for transactions executed during the epoch.
fundOutflowvar fundOutflow: String?
The storage fee rebates paid to users who deleted the data associated with past transactions.
fundSizevar fundSize: String?
The storage fund available in this epoch. This fund is used to redistribute storage fees from past transactions to future validators.
liveObjectSetDigestvar 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.
netInflowvar netInflow: String?
The difference between the fund inflow and outflow, representing the net amount of storage fees accumulated in this epoch.
protocolConfigsvar protocolConfigs: ProtocolConfigs?
The epoch's corresponding protocol configuration, including the feature flags and the configuration options.
referenceGasPricevar referenceGasPrice: String?
The minimum gas price that a quorum of validators are guaranteed to sign a transaction for.
startTimestampvar startTimestamp: String
The epoch's starting timestamp. RFC3339 in UTC with format: YYYY-MM-DDTHH:MM:SS.mmmZ
systemStateVersionvar systemStateVersion: ULong?
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.
totalCheckpointsvar totalCheckpoints: ULong?
The total number of checkpoints in this epoch.
totalGasFeesvar totalGasFees: String?
The total amount of gas fees (in IOTA) that were paid in this epoch.
totalStakeRewardsvar totalStakeRewards: String?
The total IOTA rewarded as stake.
totalTransactionsvar totalTransactions: ULong?
The total number of transaction in this epoch.
validatorSetvar 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.

Functions

NameSummary
destroyopen override fun destroy()