-
Notifications
You must be signed in to change notification settings - Fork 174
/
epochs.go
38 lines (31 loc) · 1.51 KB
/
epochs.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
package module
import (
"context"
"github.com/onflow/flow-go/consensus/hotstuff/model"
"github.com/onflow/flow-go/state/protocol"
)
// ClusterRootQCVoter is responsible for submitting a vote to the cluster QC
// contract to coordinate generation of a valid root quorum certificate for the
// next epoch.
type ClusterRootQCVoter interface {
// Vote handles the full procedure of generating a vote, submitting it to the
// epoch smart contract, and verifying submission. Returns an error only if
// there is a critical error that would make it impossible for the vote to be
// submitted. Otherwise, exits when the vote has been successfully submitted.
//
// It is safe to run Vote multiple times within a single setup phase.
Vote(context.Context, protocol.Epoch) error
}
// QCContractClient enables interacting with the cluster QC aggregator smart
// contract. This contract is deployed to the service account as part of a
// collection of smart contracts that facilitate and manage epoch transitions.
type QCContractClient interface {
// SubmitVote submits the given vote to the cluster QC aggregator smart
// contract. This function returns only once the transaction has been
// processed by the network. An error is returned if the transaction has
// failed and should be re-submitted.
SubmitVote(ctx context.Context, vote *model.Vote) error
// Voted returns true if we have successfully submitted a vote to the
// cluster QC aggregator smart contract for the current epoch.
Voted(ctx context.Context) (bool, error)
}