Skip to main content

Epoch

Namespace: IotaSdk

public record class Epoch : System.IDisposable, System.IEquatable`1[[IotaSdk.Epoch, IotaSdk, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]

Inheritance ObjectEpoch
Implements IDisposable, IEquatable<Epoch>
Attributes NullableContextAttribute, NullableAttribute

Remarks:

UniFFI Warning: Optional parameters have been reordered because of a C# syntax limitation. Use named parameters for compatibility with future ordering changes.

Properties

EpochId

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

public ulong EpochId { get; init; }

Property Value

UInt64

StartTimestamp

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

public string StartTimestamp { get; init; }

Property Value

String

FundInflow

The storage fees paid for transactions executed during the epoch.

public string? FundInflow { get; init; }

Property Value

String

FundOutflow

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

public string? FundOutflow { get; init; }

Property Value

String

FundSize

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

public string? FundSize { get; init; }

Property Value

String

LiveObjectSetDigest

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.

public string? LiveObjectSetDigest { get; init; }

Property Value

String

NetInflow

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

public string? NetInflow { get; init; }

Property Value

String

ProtocolConfigs

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

public ProtocolConfigs? ProtocolConfigs { get; init; }

Property Value

ProtocolConfigs

ReferenceGasPrice

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

public string? ReferenceGasPrice { get; init; }

Property Value

String

EndTimestamp

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

public string? EndTimestamp { get; init; }

Property Value

String

SystemStateVersion

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.

public ulong? SystemStateVersion { get; init; }

Property Value

UInt64?

TotalCheckpoints

The total number of checkpoints in this epoch.

public ulong? TotalCheckpoints { get; init; }

Property Value

UInt64?

TotalGasFees

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

public string? TotalGasFees { get; init; }

Property Value

String

TotalStakeRewards

The total IOTA rewarded as stake.

public string? TotalStakeRewards { get; init; }

Property Value

String

TotalTransactions

The total number of transaction in this epoch.

public ulong? TotalTransactions { get; init; }

Property Value

UInt64?

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.

public ValidatorSet? ValidatorSet { get; init; }

Property Value

ValidatorSet

Constructors

Epoch(UInt64, String, String, String, String, String, String, ProtocolConfigs, String, String, UInt64?, UInt64?, String, String, UInt64?, ValidatorSet)

public Epoch(ulong EpochId, string StartTimestamp, string? FundInflow = null, string? FundOutflow = null, string? FundSize = null, string? LiveObjectSetDigest = null, string? NetInflow = null, ProtocolConfigs? ProtocolConfigs = null, string? ReferenceGasPrice = null, string? EndTimestamp = null, ulong? SystemStateVersion = null, ulong? TotalCheckpoints = null, string? TotalGasFees = null, string? TotalStakeRewards = null, ulong? TotalTransactions = null, ValidatorSet? ValidatorSet = null)

Parameters

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

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

FundInflow String?
The storage fees paid for transactions executed during the epoch.

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

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

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 String?
The difference between the fund inflow and outflow, representing the net amount of storage fees accumulated in this epoch.

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

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

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

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 UInt64?
The total number of checkpoints in this epoch.

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

TotalStakeRewards String?
The total IOTA rewarded as stake.

TotalTransactions UInt64?
The total number of transaction in this epoch.

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.

Remarks:

UniFFI Warning: Optional parameters have been reordered because of a C# syntax limitation. Use named parameters for compatibility with future ordering changes.

Methods

Dispose()

public void Dispose()