-
Notifications
You must be signed in to change notification settings - Fork 211
/
proposal_builder.go
366 lines (319 loc) · 9.91 KB
/
proposal_builder.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
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
// Package miner is responsible for creating valid blocks that contain valid activation transactions and transactions
package miner
import (
"context"
"errors"
"fmt"
"sync"
"time"
"golang.org/x/sync/errgroup"
"github.com/spacemeshos/go-spacemesh/codec"
"github.com/spacemeshos/go-spacemesh/common/types"
"github.com/spacemeshos/go-spacemesh/database"
"github.com/spacemeshos/go-spacemesh/events"
"github.com/spacemeshos/go-spacemesh/log"
"github.com/spacemeshos/go-spacemesh/miner/metrics"
"github.com/spacemeshos/go-spacemesh/p2p/pubsub"
"github.com/spacemeshos/go-spacemesh/proposals"
"github.com/spacemeshos/go-spacemesh/signing"
"github.com/spacemeshos/go-spacemesh/sql"
"github.com/spacemeshos/go-spacemesh/sql/ballots"
"github.com/spacemeshos/go-spacemesh/system"
"github.com/spacemeshos/go-spacemesh/timesync"
"github.com/spacemeshos/go-spacemesh/tortoise"
)
const (
buildDurationErrorThreshold = 10 * time.Second
)
var (
errGenesis = errors.New("not building proposals: genesis")
errNotSynced = errors.New("not building proposals: node not synced")
errNoBeacon = errors.New("not building proposals: missing beacon")
)
// ProposalBuilder builds Proposals for a miner.
type ProposalBuilder struct {
logger log.Log
cfg config
sqlDB *sql.Database
startOnce sync.Once
ctx context.Context
cancel context.CancelFunc
eg errgroup.Group
layerTimer chan types.LayerID
msh meshProvider
publisher pubsub.Publisher
signer *signing.EdSigner
conState conservativeState
baseBallotProvider votesEncoder
proposalOracle proposalOracle
beaconProvider system.BeaconGetter
syncer system.SyncStateProvider
}
// config defines configuration for the ProposalBuilder.
type config struct {
layerSize uint32
layersPerEpoch uint32
minerID types.NodeID
txsPerProposal int
}
// defaultConfig for BlockHandler.
func defaultConfig() config {
return config{
txsPerProposal: 100,
}
}
// Opt for configuring ProposalBuilder.
type Opt func(h *ProposalBuilder)
// WithLayerSize defines the average number of proposal per layer.
func WithLayerSize(size uint32) Opt {
return func(pb *ProposalBuilder) {
pb.cfg.layerSize = size
}
}
// WithLayerPerEpoch defines the number of layers per epoch.
func WithLayerPerEpoch(layers uint32) Opt {
return func(pb *ProposalBuilder) {
pb.cfg.layersPerEpoch = layers
}
}
// WithMinerID defines the miner's NodeID.
func WithMinerID(id types.NodeID) Opt {
return func(pb *ProposalBuilder) {
pb.cfg.minerID = id
}
}
// WithTxsPerProposal defines the number of TXs in a Proposal.
func WithTxsPerProposal(numTxs int) Opt {
return func(pb *ProposalBuilder) {
pb.cfg.txsPerProposal = numTxs
}
}
// WithLogger defines the logger.
func WithLogger(logger log.Log) Opt {
return func(pb *ProposalBuilder) {
pb.logger = logger
}
}
func withOracle(o proposalOracle) Opt {
return func(pb *ProposalBuilder) {
pb.proposalOracle = o
}
}
// NewProposalBuilder creates a struct of block builder type.
func NewProposalBuilder(
ctx context.Context,
layerTimer timesync.LayerTimer,
signer *signing.EdSigner,
vrfSigner *signing.VRFSigner,
sqlDB *sql.Database,
atxDB activationDB,
msh meshProvider,
publisher pubsub.Publisher,
bbp votesEncoder,
beaconProvider system.BeaconGetter,
syncer system.SyncStateProvider,
conState conservativeState,
opts ...Opt,
) *ProposalBuilder {
sctx, cancel := context.WithCancel(ctx)
pb := &ProposalBuilder{
logger: log.NewNop(),
cfg: defaultConfig(),
ctx: sctx,
cancel: cancel,
signer: signer,
layerTimer: layerTimer,
msh: msh,
publisher: publisher,
sqlDB: sqlDB,
baseBallotProvider: bbp,
beaconProvider: beaconProvider,
syncer: syncer,
conState: conState,
}
for _, opt := range opts {
opt(pb)
}
if pb.proposalOracle == nil {
pb.proposalOracle = newMinerOracle(pb.cfg.layerSize, pb.cfg.layersPerEpoch, atxDB, vrfSigner, pb.cfg.minerID, pb.logger)
}
return pb
}
// Start starts the loop that listens to layers and build proposals.
func (pb *ProposalBuilder) Start(ctx context.Context) error {
pb.startOnce.Do(func() {
pb.eg.Go(func() error {
pb.createProposalLoop(log.WithNewSessionID(ctx))
return nil
})
})
return nil
}
// Close stops the loop that listens to layers and build proposals.
func (pb *ProposalBuilder) Close() {
pb.cancel()
_ = pb.eg.Wait()
}
func (pb *ProposalBuilder) getRefBallot(epoch types.EpochID) (types.BallotID, error) {
ballotID, err := ballots.GetRefBallot(pb.sqlDB, epoch, pb.signer.PublicKey().Bytes())
if err != nil {
return types.EmptyBallotID, fmt.Errorf("get from refDB: %w", err)
}
return ballotID, nil
}
// stopped returns if we should stop.
func (pb *ProposalBuilder) stopped() bool {
select {
case <-pb.ctx.Done():
return true
default:
return false
}
}
func (pb *ProposalBuilder) createProposal(
ctx context.Context,
layerID types.LayerID,
proofs []types.VotingEligibilityProof,
atxID types.ATXID,
activeSet []types.ATXID,
beacon types.Beacon,
txIDs []types.TransactionID,
votes types.Votes,
) (*types.Proposal, error) {
logger := pb.logger.WithContext(ctx).WithFields(layerID, layerID.GetEpoch())
if !layerID.After(types.GetEffectiveGenesis()) {
logger.Panic("attempt to create proposal during genesis")
}
ib := &types.InnerBallot{
AtxID: atxID,
EligibilityProofs: proofs,
Votes: votes,
LayerIndex: layerID,
}
epoch := layerID.GetEpoch()
refBallot, err := pb.getRefBallot(epoch)
if err != nil {
if !errors.Is(err, database.ErrNotFound) {
logger.With().Error("failed to get ref ballot", log.Err(err))
return nil, fmt.Errorf("get ref ballot: %w", err)
}
logger.With().Debug("creating ballot with active set (reference ballot in epoch)",
log.Int("active_set_size", len(activeSet)))
ib.RefBallot = types.EmptyBallotID
ib.EpochData = &types.EpochData{
ActiveSet: activeSet,
Beacon: beacon,
}
} else {
logger.With().Debug("creating ballot with reference ballot (no active set)",
log.Named("ref_ballot", refBallot))
ib.RefBallot = refBallot
}
mesh, err := pb.msh.GetAggregatedLayerHash(layerID.Sub(1))
if err != nil {
logger.With().Warning("failed to get mesh hash", log.Err(err))
}
p := &types.Proposal{
InnerProposal: types.InnerProposal{
Ballot: types.Ballot{
InnerBallot: *ib,
},
TxIDs: txIDs,
MeshHash: mesh,
},
}
p.Ballot.Signature = pb.signer.Sign(p.Ballot.Bytes())
p.Signature = pb.signer.Sign(p.Bytes())
if err := p.Initialize(); err != nil {
logger.Panic("proposal failed to initialize", log.Err(err))
}
logger.Event().Info("proposal created", log.Inline(p))
return p, nil
}
func (pb *ProposalBuilder) handleLayer(ctx context.Context, layerID types.LayerID) error {
var (
beacon types.Beacon
err error
epoch = layerID.GetEpoch()
logger = pb.logger.WithContext(ctx).WithFields(layerID, epoch)
)
logger.Info("builder got layer")
if layerID.GetEpoch().IsGenesis() {
return errGenesis
}
if !pb.syncer.IsSynced(ctx) {
logger.Info("not synced yet, not building a proposal")
return errNotSynced
}
if beacon, err = pb.beaconProvider.GetBeacon(epoch); err != nil {
logger.With().Info("beacon not available for epoch", log.Err(err))
return errNoBeacon
}
logger.With().Info("miner got beacon to build proposals", beacon)
started := time.Now()
atxID, activeSet, proofs, err := pb.proposalOracle.GetProposalEligibility(layerID, beacon)
if err != nil {
if errors.Is(err, errMinerHasNoATXInPreviousEpoch) {
logger.Info("miner has no ATX in previous epoch. not eligible for proposals")
return fmt.Errorf("miner no ATX: %w", err)
}
logger.With().Error("failed to check for proposal eligibility", log.Err(err))
return fmt.Errorf("proposal eligibility: %w", err)
}
if len(proofs) == 0 {
logger.Info("not eligible for proposal in layer")
return nil
}
votes, err := pb.baseBallotProvider.EncodeVotes(ctx, tortoise.EncodeVotesWithCurrent(layerID))
if err != nil {
return fmt.Errorf("get base ballot: %w", err)
}
logger.With().Info("eligible for one or more proposals in layer", atxID, log.Int("num_proposals", len(proofs)))
txList := pb.conState.SelectProposalTXs(len(proofs))
p, err := pb.createProposal(ctx, layerID, proofs, atxID, activeSet, beacon, txList, *votes)
if err != nil {
logger.With().Error("failed to create new proposal", log.Err(err))
return err
}
pb.saveMetrics(ctx, started, layerID)
if pb.stopped() {
return nil
}
pb.eg.Go(func() error {
// generate a new requestID for the new proposal message
newCtx := log.WithNewRequestID(ctx, layerID, p.ID())
// validation handler, where proposal is persisted, is applied synchronously before
// proposal is sent over the network
data, err := codec.Encode(p)
if err != nil {
logger.With().Panic("failed to serialize proposal", log.Err(err))
}
if err = pb.publisher.Publish(newCtx, proposals.NewProposalProtocol, data); err != nil {
logger.WithContext(newCtx).With().Error("failed to send proposal", log.Err(err))
}
events.ReportProposal(events.ProposalCreated, p)
return nil
})
return nil
}
func (pb *ProposalBuilder) createProposalLoop(ctx context.Context) {
for {
select {
case <-pb.ctx.Done():
return
case layerID := <-pb.layerTimer:
lyrCtx := log.WithNewSessionID(ctx)
if err := pb.handleLayer(lyrCtx, layerID); err != nil {
pb.logger.WithContext(lyrCtx).With().Warning("failed to create proposal", log.Err(err))
}
}
}
}
func (pb *ProposalBuilder) saveMetrics(ctx context.Context, started time.Time, layerID types.LayerID) {
elapsed := time.Since(started)
if elapsed > buildDurationErrorThreshold {
pb.logger.WithContext(ctx).WithFields(layerID, layerID.GetEpoch()).With().
Error("proposal building took too long ", log.Duration("elapsed", elapsed))
}
metrics.ProposalBuildDuration.WithLabelValues().Observe(float64(elapsed / time.Millisecond))
}