-
Notifications
You must be signed in to change notification settings - Fork 211
/
blockoracle.go
223 lines (200 loc) · 7.6 KB
/
blockoracle.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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
package miner
import (
"encoding/binary"
"errors"
"fmt"
"github.com/spacemeshos/go-spacemesh/common/types"
"github.com/spacemeshos/go-spacemesh/log"
"github.com/spacemeshos/sha256-simd"
"sort"
"strings"
"sync"
)
type activationDB interface {
GetNodeAtxIDForEpoch(nodeID types.NodeID, targetEpoch types.EpochID) (types.ATXID, error)
GetAtxHeader(id types.ATXID) (*types.ActivationTxHeader, error)
GetIdentity(edID string) (types.NodeID, error)
GetEpochAtxs(epochID types.EpochID) (atxs []types.ATXID)
}
type vrfSigner interface {
Sign(msg []byte) ([]byte, error)
}
// Oracle is the oracle that provides block eligibility proofs for the miner.
type Oracle struct {
committeeSize uint32
genesisActiveSetSize uint32
layersPerEpoch uint16
atxDB activationDB
beaconProvider *EpochBeaconProvider
vrfSigner vrfSigner
nodeID types.NodeID
proofsEpoch types.EpochID
eligibilityProofs map[types.LayerID][]types.BlockEligibilityProof
atxID types.ATXID
isSynced func() bool
eligibilityMutex sync.RWMutex
log log.Log
}
// NewMinerBlockOracle returns a new Oracle.
func NewMinerBlockOracle(committeeSize uint32, genesisActiveSetSize uint32, layersPerEpoch uint16, atxDB activationDB, beaconProvider *EpochBeaconProvider, vrfSigner vrfSigner, nodeID types.NodeID, isSynced func() bool, log log.Log) *Oracle {
return &Oracle{
committeeSize: committeeSize,
genesisActiveSetSize: genesisActiveSetSize,
layersPerEpoch: layersPerEpoch,
atxDB: atxDB,
beaconProvider: beaconProvider,
vrfSigner: vrfSigner,
nodeID: nodeID,
proofsEpoch: ^types.EpochID(0),
isSynced: isSynced,
log: log,
}
}
// BlockEligible returns the ATXID and list of block eligibility proofs for the given layer. It caches proofs for a
// single epoch and only refreshes the cache if eligibility is queried for a different epoch.
func (bo *Oracle) BlockEligible(layerID types.LayerID) (types.ATXID, []types.BlockEligibilityProof, error) {
if !bo.isSynced() {
return types.ATXID{}, nil, fmt.Errorf("cannot calc eligibility, not synced yet")
}
epochNumber := layerID.GetEpoch()
bo.log.Info("asked for eligibility for epoch %d (cached: %d)", epochNumber, bo.proofsEpoch)
if epochNumber.IsGenesis() {
bo.log.Warning("asked for eligibility for epoch 0, cannot create blocks here")
return *types.EmptyATXID, nil, nil
}
if bo.proofsEpoch != epochNumber {
err := bo.calcEligibilityProofs(epochNumber)
if err != nil {
bo.log.Error("failed to calculate eligibility proofs for epoch %v : %v", epochNumber, err)
return *types.EmptyATXID, nil, err
}
}
bo.eligibilityMutex.RLock()
proofs := bo.eligibilityProofs[layerID]
bo.eligibilityMutex.RUnlock()
bo.log.With().Info("eligible for blocks in layer",
bo.nodeID,
layerID,
log.Int("num_blocks", len(proofs)))
return bo.atxID, proofs, nil
}
func (bo *Oracle) calcEligibilityProofs(epochNumber types.EpochID) error {
epochBeacon := bo.beaconProvider.GetBeacon(epochNumber)
// get the previous epochs total ATXs
activeSetSize := uint32(len(bo.atxDB.GetEpochAtxs(epochNumber - 1)))
atx, err := bo.getValidAtxForEpoch(epochNumber)
if err != nil {
if !epochNumber.IsGenesis() {
return fmt.Errorf("failed to get latest ATX: %v", err)
}
} else {
bo.atxID = atx.ID()
}
bo.log.Info("calculating eligibility for epoch %v, active set size %v", epochBeacon, activeSetSize)
if epochNumber.IsGenesis() {
bo.log.Info("genesis epoch detected, using GenesisActiveSetSize (%v)", activeSetSize)
}
numberOfEligibleBlocks, err := getNumberOfEligibleBlocks(activeSetSize, bo.committeeSize, bo.layersPerEpoch)
if err != nil {
bo.log.Error("failed to get number of eligible blocks: %v", err)
return err
}
bo.eligibilityMutex.Lock()
bo.eligibilityProofs = map[types.LayerID][]types.BlockEligibilityProof{}
bo.eligibilityMutex.Unlock()
for counter := uint32(0); counter < numberOfEligibleBlocks; counter++ {
message := serializeVRFMessage(epochBeacon, epochNumber, counter)
vrfSig, err := bo.vrfSigner.Sign(message)
if err != nil {
bo.log.Error("Could not sign message err=%v", err)
return err
}
vrfHash := sha256.Sum256(vrfSig)
eligibleLayer := calcEligibleLayer(epochNumber, bo.layersPerEpoch, vrfHash)
bo.eligibilityMutex.Lock()
bo.eligibilityProofs[eligibleLayer] = append(bo.eligibilityProofs[eligibleLayer], types.BlockEligibilityProof{
J: counter,
Sig: vrfSig,
})
bo.eligibilityMutex.Unlock()
}
bo.proofsEpoch = epochNumber
bo.eligibilityMutex.RLock()
// Sort the layer map so we can print the layer data in order
keys := make([]types.LayerID, len(bo.eligibilityProofs))
i := 0
for k := range bo.eligibilityProofs {
keys[i] = k
i++
}
sort.Slice(keys, func(i, j int) bool {
return uint64(keys[i]) < uint64(keys[j])
})
// Pretty-print the number of blocks per eligible layer
var strs []string
for k := range keys {
strs = append(strs, fmt.Sprintf("Layer %d: %d", keys[k], len(bo.eligibilityProofs[keys[k]])))
}
bo.log.With().Info("eligibility for blocks in epoch",
bo.nodeID,
epochNumber,
log.Uint32("total_num_blocks", numberOfEligibleBlocks),
log.Int("num_layers_eligible", len(bo.eligibilityProofs)),
log.String("layers_and_num_blocks", strings.Join(strs, ", ")))
bo.eligibilityMutex.RUnlock()
return nil
}
func (bo *Oracle) getValidAtxForEpoch(validForEpoch types.EpochID) (*types.ActivationTxHeader, error) {
atxID, err := bo.getATXIDForEpoch(validForEpoch - 1)
if err != nil {
return nil, fmt.Errorf("failed to get ATX ID for target epoch %v: %v", validForEpoch, err)
}
atx, err := bo.atxDB.GetAtxHeader(atxID)
if err != nil {
bo.log.Error("getting ATX failed: %v", err)
return nil, err
}
return atx, nil
}
func calcEligibleLayer(epochNumber types.EpochID, layersPerEpoch uint16, vrfHash [32]byte) types.LayerID {
vrfInteger := binary.LittleEndian.Uint64(vrfHash[:8])
eligibleLayerOffset := vrfInteger % uint64(layersPerEpoch)
return epochNumber.FirstLayer().Add(uint16(eligibleLayerOffset))
}
func getNumberOfEligibleBlocks(activeSetSize, committeeSize uint32, layersPerEpoch uint16) (uint32, error) {
if activeSetSize == 0 {
return 0, errors.New("empty active set not allowed")
}
numberOfEligibleBlocks := committeeSize * uint32(layersPerEpoch) / activeSetSize
if numberOfEligibleBlocks == 0 {
numberOfEligibleBlocks = 1
}
return numberOfEligibleBlocks, nil
}
func (bo *Oracle) getATXIDForEpoch(targetEpoch types.EpochID) (types.ATXID, error) {
latestATXID, err := bo.atxDB.GetNodeAtxIDForEpoch(bo.nodeID, targetEpoch)
if err != nil {
bo.log.With().Info("did not find ATX IDs for node", log.FieldNamed("atx_node_id", bo.nodeID), log.Err(err))
return types.ATXID{}, err
}
bo.log.With().Info("latest atx id found", latestATXID)
return latestATXID, err
}
func serializeVRFMessage(epochBeacon []byte, epochNumber types.EpochID, counter uint32) []byte {
message := make([]byte, len(epochBeacon)+binary.Size(epochNumber)+binary.Size(counter))
copy(message, epochBeacon)
binary.LittleEndian.PutUint64(message[len(epochBeacon):], uint64(epochNumber))
binary.LittleEndian.PutUint32(message[len(epochBeacon)+binary.Size(epochNumber):], counter)
return message
}
// GetEligibleLayers returns a list of layers in which the miner is eligible for at least one block. The list is
// returned in arbitrary order.
func (bo *Oracle) GetEligibleLayers() []types.LayerID {
bo.eligibilityMutex.RLock()
layers := make([]types.LayerID, 0, len(bo.eligibilityProofs))
for layer := range bo.eligibilityProofs {
layers = append(layers, layer)
}
bo.eligibilityMutex.RUnlock()
return layers
}