Skip to main content

EpochField

@iota/grpc

@iota/grpc / EpochField

Variable: EpochField

const EpochField: object

Defined in: sdk/grpc/src/read-masks.ts:163

Read mask paths for getEpoch. Use epochFeatureFlag and epochAttribute for single protocol config keys.

Type Declaration​

ALL​

readonly ALL: "*" = '*'

Wildcard: every field.

BCS_SYSTEM_STATE​

readonly BCS_SYSTEM_STATE: "bcs_system_state" = 'bcs_system_state'

The BCS-encoded system state.

COMMITTEE​

readonly COMMITTEE: "committee" = 'committee'

The validator committee for this epoch.

END​

readonly END: "end" = 'end'

The end timestamp of the epoch.

EPOCH​

readonly EPOCH: "epoch" = 'epoch'

The epoch number.

EPOCH_CLOSE_PROOF​

readonly EPOCH_CLOSE_PROOF: "epoch_close_proof" = 'epoch_close_proof'

All epoch-close-proof fields.

EPOCH_CLOSE_PROOF_BCS_NEXT_EPOCH_SYSTEM_STATE_OBJECTS​

readonly EPOCH_CLOSE_PROOF_BCS_NEXT_EPOCH_SYSTEM_STATE_OBJECTS: "epoch_close_proof.bcs_next_epoch_system_state_objects" = 'epoch_close_proof.bcs_next_epoch_system_state_objects'

Raw BCS of the next epoch's start-of-epoch system-state objects.

EPOCH_CLOSE_PROOF_CHECKPOINT​

readonly EPOCH_CLOSE_PROOF_CHECKPOINT: "epoch_close_proof.checkpoint" = 'epoch_close_proof.checkpoint'

The certified checkpoint that closed the epoch.

EPOCH_CLOSE_PROOF_END_OF_EPOCH_TRANSACTION_EFFECTS​

readonly EPOCH_CLOSE_PROOF_END_OF_EPOCH_TRANSACTION_EFFECTS: "epoch_close_proof.end_of_epoch_transaction_effects" = 'epoch_close_proof.end_of_epoch_transaction_effects'

Effects of the epoch-change transaction.

EPOCH_CLOSE_PROOF_END_OF_EPOCH_TRANSACTION_EVENTS​

readonly EPOCH_CLOSE_PROOF_END_OF_EPOCH_TRANSACTION_EVENTS: "epoch_close_proof.end_of_epoch_transaction_events" = 'epoch_close_proof.end_of_epoch_transaction_events'

Events emitted by the epoch-change transaction.

FIRST_CHECKPOINT​

readonly FIRST_CHECKPOINT: "first_checkpoint" = 'first_checkpoint'

The first checkpoint in the epoch.

LAST_CHECKPOINT​

readonly LAST_CHECKPOINT: "last_checkpoint" = 'last_checkpoint'

The last checkpoint in the epoch.

PROTOCOL_CONFIG​

readonly PROTOCOL_CONFIG: "protocol_config" = 'protocol_config'

All protocol configuration fields.

PROTOCOL_CONFIG_ATTRIBUTES​

readonly PROTOCOL_CONFIG_ATTRIBUTES: "protocol_config.attributes" = 'protocol_config.attributes'

All protocol attributes.

PROTOCOL_CONFIG_FEATURE_FLAGS​

readonly PROTOCOL_CONFIG_FEATURE_FLAGS: "protocol_config.feature_flags" = 'protocol_config.feature_flags'

All feature flags.

PROTOCOL_CONFIG_PROTOCOL_VERSION​

readonly PROTOCOL_CONFIG_PROTOCOL_VERSION: "protocol_config.protocol_version" = 'protocol_config.protocol_version'

The protocol version.

REFERENCE_GAS_PRICE​

readonly REFERENCE_GAS_PRICE: "reference_gas_price" = 'reference_gas_price'

The reference gas price during the epoch (in NANOS).

START​

readonly START: "start" = 'start'

The start timestamp of the epoch.