Skip to main content

Type Alias: Epoch

type Epoch = {
  endTimestamp?: string;
  epochId: bigint;
  fundInflow?: string;
  fundOutflow?: string;
  fundSize?: string;
  liveObjectSetDigest?: string;
  netInflow?: string;
  protocolConfigs?: ProtocolConfigs;
  referenceGasPrice?: string;
  startTimestamp: string;
  systemStateVersion?: bigint;
  totalCheckpoints?: bigint;
  totalGasFees?: string;
  totalStakeRewards?: string;
  totalTransactions?: bigint;
  validatorSet?: ValidatorSet;
};

Generated factory for Epoch record objects.

Properties​

endTimestamp?​

optional 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​

epochId: bigint;

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

fundInflow?​

optional fundInflow?: string;

The storage fees paid for transactions executed during the epoch.

fundOutflow?​

optional fundOutflow?: string;

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

fundSize?​

optional fundSize?: string;

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

liveObjectSetDigest?​

optional 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?​

optional netInflow?: string;

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

protocolConfigs?​

optional protocolConfigs?: ProtocolConfigs;

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

referenceGasPrice?​

optional referenceGasPrice?: string;

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

startTimestamp​

startTimestamp: string;

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

systemStateVersion?​

optional systemStateVersion?: bigint;

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?​

optional totalCheckpoints?: bigint;

The total number of checkpoints in this epoch.

totalGasFees?​

optional totalGasFees?: string;

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

totalStakeRewards?​

optional totalStakeRewards?: string;

The total IOTA rewarded as stake.

totalTransactions?​

optional totalTransactions?: bigint;

The total number of transaction in this epoch.

validatorSet?​

optional 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.