Query Epoch Info with Scripts or Events

Updated: 2021/7/29 by

7 min read

Introduction

The epoch contract stores a lot of different state, and the state is constantly changing. As an external party, there are two ways to keep track of these state changes. You can either use Cadence scripts to query the state of the contract at any given time, or you can monitor events that are emitted by the epoch contract to be notified of any important occurances.

Monitor Epoch Service Events

These events can be queried using the Go or JavaScript SDKs to extract useful notifications and information about the state of the epoch preparation protocol.

What is a Service Event?

Service events are special messages that are generated by smart contracts and included in execution results. They enable communication between system smart contracts and the Flow protocol. In other words, they serve as a communication mechanism between the execution state and the protocol state.

Concretely, service events are defined and emitted as events like any other in Cadence. An event is considered a service event when it is:

emitted within the service chunk
emitted from a smart contract deployed to the service account
conformant to an event allowlist

Each block contains a system chunk. For each system chunk, all service events emitted are included in the corresponding execution result.

When verifying the system chunk, verifier nodes will only produce result approvals when the system chunks included in the execution result are correct. Thus, the security of this communication mechanism is enforced by the verification system.

When sealing a block containing a service event, the consensus committee will update the protocol state accordingly, depending on the semantics of the event.

For example, a service event may indicate that a node's stake has diminished to the point where they should be ejected, in which case the consensus committee would mark that node as ejected in the protocol state.

Service events are fundamentally asynchronous, due the lag between block execution and sealing. Consequently they are handled slightly differently than other protocol state updates.

The diagram below illustrates the steps each service event goes through to be included in the protocol state.

Flow Service Event Diagram

For conciseness, we say a service event is sealed when the block in which it was emitted is sealed, and we say a service event is finalized when the block containing the seal is finalized.

Event Descriptions

`EpochSetup`

The Epoch Setup service event is emitted by FlowEpoch.startEpochSetup() when the staking auction phase ends and the Epoch Smart Contracts transition to the Epoch Setup phase. It contains the finalized identity table for the upcoming epoch, as well as timing information for phase changes.

1
pub event EpochSetup (
2

3
    /// The counter for the upcoming epoch. Must be one greater than the
4
    /// counter for the current epoch.
5
    counter: UInt64,
6

7
    /// Identity table for the upcoming epoch with all node information.
8
    /// Includes:
9
    /// nodeID, staking key, networking key, networking address, role,
10
    /// staking information, weight, and more.
11
    nodeInfo: [FlowIDTableStaking.NodeInfo],
12

13
    /// The first view (inclusive) of the upcoming epoch.
14
    firstView: UInt64,
15

16
    /// The last view (inclusive) of the upcoming epoch.
17
    finalView: UInt64,
18

19
    /// The cluster assignment for the upcoming epoch. Each element in the list
20
    /// represents one cluster and contains all the node IDs assigned to that
21
    /// cluster, with their weights and votes
22
    collectorClusters: [FlowClusterQC.Cluster],
23

24
    /// The source of randomness to seed the leader selection algorithm with 
25
    /// for the upcoming epoch.
26
    randomSource: String,
27

28
    /// The deadlines of each phase in the DKG protocol to be completed in the upcoming
29
    /// EpochSetup phase. Deadlines are specified in terms of a consensus view number. 
30
    /// When a DKG participant observes a finalized and sealed block with view greater 
31
    /// than the given deadline, it can safely transition to the next phase. 
32
    DKGPhase1FinalView: UInt64,
33
    DKGPhase2FinalView: UInt64,
34
    DKGPhase3FinalView: UInt64
35
)

`EpochCommit`

The EpochCommit service event is emitted when the Epoch Smart Contracts transition from the Epoch Setup phase to the Epoch Commit phase. It is emitted only when all preparation for the upcoming epoch (QC and DKG) has been completed.

1
pub event EpochCommit (
2

3
    /// The counter for the upcoming epoch. Must be equal to the counter in the
4
    /// previous EpochSetup event.
5
    counter: UInt64,
6

7
    /// The result of the QC aggregation process. Each element contains 
8
    /// all the nodes and votes received for a particular cluster
9
    /// QC stands for quorum certificate that each cluster generates.
10
    clusterQCs: [FlowClusterQC.ClusterQC],
11

12
    /// The resulting public keys from the DKG process, encoded as by the flow-go
13
    /// crypto library, then hex-encoded.
14
    /// Group public key is the first element, followed by the individual keys
15
    dkgPubKeys: [String],
16
)

Query Information with Scripts

The FlowEpoch smart contract stores important metadata about the current, proposed, and previous epochs. Metadata for all historical epochs is stored permenantely in the Epoch Smart Contract's storage.

1
pub struct EpochMetadata {
2

3
    /// The identifier for the epoch
4
    pub let counter: UInt64
5

6
    /// The seed used for generating the epoch setup
7
    pub let seed: String
8

9
    /// The first view of this epoch
10
    pub let startView: UInt64
11

12
    /// The last view of this epoch
13
    pub let endView: UInt64
14

15
    /// The last view of the staking auction
16
    pub let stakingEndView: UInt64
17

18
    /// The total rewards that are paid out for the epoch
19
    pub var totalRewards: UFix64
20

21
    /// The reward amounts that are paid to each individual node and its delegators
22
    pub var rewardAmounts: [FlowIDTableStaking.RewardsBreakdown]
23

24
    /// Tracks if rewards have been paid for this epoch
25
    pub var rewardsPaid: Bool
26

27
    /// The organization of collector node IDs into clusters
28
    /// determined by a round robin sorting algorithm
29
    pub let collectorClusters: [FlowClusterQC.Cluster]
30

31
    /// The Quorum Certificates from the ClusterQC contract
32
    pub var clusterQCs: [FlowClusterQC.ClusterQC]
33

34
    /// The public keys associated with the Distributed Key Generation
35
    /// process that consensus nodes participate in
36
    /// Group key is the last element at index: length - 1
37
    pub var dkgKeys: [String]
38
}

Get Epoch Metadata

The FlowEpoch smart contract provides a public function, FlowEpoch.getEpochMetadata() to query the metadata for a particular epoch.

You can use the Get Epoch Metadata(EP.01) script with the following arguments:

Argument	Type	Description
epochCounter	`UInt64`	The counter of the epoch to get metadata for.

Get Configurable Metadata

The FlowEpoch smart contract also has a set of metadata that is configurable by the admin for phase lengths, number of collector clusters, and inflation percentage.

1
pub struct Config {
2
    /// The number of views in an entire epoch
3
    pub(set) var numViewsInEpoch: UInt64
4

5
    /// The number of views in the staking auction
6
    pub(set) var numViewsInStakingAuction: UInt64
7
    
8
    /// The number of views in each dkg phase
9
    pub(set) var numViewsInDKGPhase: UInt64
10

11
    /// The number of collector clusters in each epoch
12
    pub(set) var numCollectorClusters: UInt16
13

14
    /// Tracks the annualized percentage of FLOW total supply that is minted as rewards at the end of an epoch
15
    /// Calculation for a single epoch would be (totalSupply * FLOWsupplyIncreasePercentage) / 52
16
    pub(set) var FLOWsupplyIncreasePercentage: UFix64
17
}

You can use the Get Configurable Metadata(EP.02) script to get the list of configurable metadata:

This script does not require any arguments.

Get Epoch Counter

The FlowEpoch smart contract always tracks the counter of the current epoch.

You can use the Get Epoch Counter(EP.03) script to get the current epoch counter.

This script does not require any arguments.

Get Epoch Phase

The FlowEpoch smart contract always tracks the active phase of the current epoch.

1
pub enum EpochPhase: UInt8 {
2
    pub case STAKINGAUCTION
3
    pub case EPOCHSETUP
4
    pub case EPOCHCOMMIT
5
}

You can use the Get Epoch Phase(EP.04) script to get the current epoch phase.

This script does not require any arguments.