-
Notifications
You must be signed in to change notification settings - Fork 174
/
dkg.go
58 lines (48 loc) · 2.42 KB
/
dkg.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
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
package storage
import (
"github.com/onflow/flow-go/crypto"
"github.com/onflow/flow-go/model/flow"
)
// DKGState is the storage interface for storing all artifacts and state
// related to the DKG process, including the latest state of a running or
// completed DKG, and computed beacon keys.
type DKGState interface {
// SetDKGStarted sets the flag indicating the DKG has started for the given epoch.
// Error returns: storage.ErrAlreadyExists
SetDKGStarted(epochCounter uint64) error
// GetDKGStarted checks whether the DKG has been started for the given epoch.
// No errors expected during normal operation.
GetDKGStarted(epochCounter uint64) (bool, error)
// SetDKGEndState stores that the DKG has ended, and its end state.
// Error returns: storage.ErrAlreadyExists
SetDKGEndState(epochCounter uint64, endState flow.DKGEndState) error
// GetDKGEndState retrieves the end state for the given DKG.
// Error returns: storage.ErrNotFound
GetDKGEndState(epochCounter uint64) (flow.DKGEndState, error)
// InsertMyBeaconPrivateKey stores the random beacon private key for an epoch.
//
// CAUTION: these keys are stored before they are validated against the
// canonical key vector and may not be valid for use in signing. Use SafeBeaconKeys
// to guarantee only keys safe for signing are returned
// Error returns: storage.ErrAlreadyExists
InsertMyBeaconPrivateKey(epochCounter uint64, key crypto.PrivateKey) error
// RetrieveMyBeaconPrivateKey retrieves the random beacon private key for an epoch.
//
// CAUTION: these keys are stored before they are validated against the
// canonical key vector and may not be valid for use in signing. Use SafeBeaconKeys
// to guarantee only keys safe for signing are returned
// Error returns: storage.ErrNotFound
RetrieveMyBeaconPrivateKey(epochCounter uint64) (crypto.PrivateKey, error)
}
// SafeBeaconKeys is a safe way to access beacon keys.
type SafeBeaconKeys interface {
// RetrieveMyBeaconPrivateKey retrieves my beacon private key for the given
// epoch, only if my key has been confirmed valid and safe for use.
//
// Returns:
// * (key, true, nil) if the key is present and confirmed valid
// * (nil, false, nil) if no key was generated or the key has been marked invalid (by SetDKGEnded)
// * (nil, false, error) for any other condition, or exception
// Error returns: storage.ErrNotFound
RetrieveMyBeaconPrivateKey(epochCounter uint64) (key crypto.PrivateKey, safe bool, err error)
}