-
Notifications
You must be signed in to change notification settings - Fork 84
/
controller.go
771 lines (675 loc) · 29.9 KB
/
controller.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
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
package validator
import (
"context"
"crypto/rsa"
"encoding/hex"
"sync"
"time"
"github.com/attestantio/go-eth2-client/spec/phase0"
specqbft "github.com/bloxapp/ssv-spec/qbft"
specssv "github.com/bloxapp/ssv-spec/ssv"
spectypes "github.com/bloxapp/ssv-spec/types"
"github.com/ethereum/go-ethereum/common"
"github.com/jellydator/ttlcache/v3"
"github.com/pkg/errors"
"github.com/prysmaticlabs/prysm/v4/async/event"
"go.uber.org/zap"
"github.com/bloxapp/ssv/eth1"
"github.com/bloxapp/ssv/eth1/abiparser"
"github.com/bloxapp/ssv/ibft/storage"
"github.com/bloxapp/ssv/logging"
"github.com/bloxapp/ssv/logging/fields"
"github.com/bloxapp/ssv/network"
forksfactory "github.com/bloxapp/ssv/network/forks/factory"
nodestorage "github.com/bloxapp/ssv/operator/storage"
forksprotocol "github.com/bloxapp/ssv/protocol/forks"
beaconprotocol "github.com/bloxapp/ssv/protocol/v2/blockchain/beacon"
"github.com/bloxapp/ssv/protocol/v2/message"
p2pprotocol "github.com/bloxapp/ssv/protocol/v2/p2p"
"github.com/bloxapp/ssv/protocol/v2/qbft"
qbftcontroller "github.com/bloxapp/ssv/protocol/v2/qbft/controller"
"github.com/bloxapp/ssv/protocol/v2/qbft/roundtimer"
utilsprotocol "github.com/bloxapp/ssv/protocol/v2/queue"
"github.com/bloxapp/ssv/protocol/v2/queue/worker"
"github.com/bloxapp/ssv/protocol/v2/ssv/runner"
"github.com/bloxapp/ssv/protocol/v2/ssv/validator"
"github.com/bloxapp/ssv/protocol/v2/sync/handlers"
"github.com/bloxapp/ssv/protocol/v2/types"
registrystorage "github.com/bloxapp/ssv/registry/storage"
"github.com/bloxapp/ssv/storage/basedb"
"github.com/bloxapp/ssv/utils/tasks"
)
//go:generate mockgen -package=mocks -destination=./mocks/controller.go -source=./controller.go
const (
metadataBatchSize = 100
networkRouterConcurrency = 2048
)
// ShareEncryptionKeyProvider is a function that returns the operator private key
type ShareEncryptionKeyProvider = func() (*rsa.PrivateKey, bool, error)
type GetRecipientDataFunc func(owner common.Address) (*registrystorage.RecipientData, bool, error)
// ShareEventHandlerFunc is a function that handles event in an extended mode
type ShareEventHandlerFunc func(share *types.SSVShare)
// ControllerOptions for creating a validator controller
type ControllerOptions struct {
Context context.Context
DB basedb.IDb
SignatureCollectionTimeout time.Duration `yaml:"SignatureCollectionTimeout" env:"SIGNATURE_COLLECTION_TIMEOUT" env-default:"5s" env-description:"Timeout for signature collection after consensus"`
MetadataUpdateInterval time.Duration `yaml:"MetadataUpdateInterval" env:"METADATA_UPDATE_INTERVAL" env-default:"12m" env-description:"Interval for updating metadata"`
HistorySyncBatchSize int `yaml:"HistorySyncBatchSize" env:"HISTORY_SYNC_BATCH_SIZE" env-default:"25" env-description:"Maximum number of messages to sync in a single batch"`
MinPeers int `yaml:"MinimumPeers" env:"MINIMUM_PEERS" env-default:"2" env-description:"The required minimum peers for sync"`
BeaconNetwork beaconprotocol.Network
Network network.P2PNetwork
Beacon beaconprotocol.BeaconNode
ShareEncryptionKeyProvider ShareEncryptionKeyProvider
FullNode bool `yaml:"FullNode" env:"FULLNODE" env-default:"false" env-description:"Save decided history rather than just highest messages"`
Exporter bool `yaml:"Exporter" env:"EXPORTER" env-default:"false" env-description:""`
BuilderProposals bool `yaml:"BuilderProposals" env:"BUILDER_PROPOSALS" env-default:"false" env-description:"Use external builders to produce blocks"`
KeyManager spectypes.KeyManager
OperatorData *registrystorage.OperatorData
RegistryStorage nodestorage.Storage
ForkVersion forksprotocol.ForkVersion
NewDecidedHandler qbftcontroller.NewDecidedHandler
DutyRoles []spectypes.BeaconRole
// worker flags
WorkersCount int `yaml:"MsgWorkersCount" env:"MSG_WORKERS_COUNT" env-default:"256" env-description:"Number of goroutines to use for message workers"`
QueueBufferSize int `yaml:"MsgWorkerBufferSize" env:"MSG_WORKER_BUFFER_SIZE" env-default:"1024" env-description:"Buffer size for message workers"`
GasLimit uint64
}
// Controller represent the validators controller,
// it takes care of bootstrapping, updating and managing existing validators and their shares
type Controller interface {
ListenToEth1Events(logger *zap.Logger, feed *event.Feed)
StartValidators(logger *zap.Logger)
ActiveValidatorIndices(logger *zap.Logger) []phase0.ValidatorIndex
GetValidator(pubKey string) (*validator.Validator, bool)
UpdateValidatorMetaDataLoop(logger *zap.Logger)
StartNetworkHandlers(logger *zap.Logger)
Eth1EventHandler(logger *zap.Logger, ongoingSync bool) eth1.SyncEventHandler
GetOperatorShares() []*types.SSVShare
// GetValidatorStats returns stats of validators, including the following:
// - the amount of validators in the network
// - the amount of active validators (i.e. not slashed or existed)
// - the amount of validators assigned to this operator
GetValidatorStats() (uint64, uint64, uint64, error)
GetOperatorData() *registrystorage.OperatorData
//OnFork(forkVersion forksprotocol.ForkVersion) error
}
// EventHandler represents the interface for compatible storage event handlers
type EventHandler interface {
GetEventData(txHash common.Hash) (*registrystorage.EventData, bool, error)
SaveEventData(txHash common.Hash) error
GetNextNonce(owner common.Address) (registrystorage.Nonce, error)
BumpNonce(owner common.Address) error
}
type nonCommitteeValidator struct {
*validator.NonCommitteeValidator
sync.Mutex
}
// controller implements Controller
type controller struct {
context context.Context
eventHandler EventHandler
sharesStorage registrystorage.Shares
operatorsStorage registrystorage.Operators
recipientsStorage registrystorage.Recipients
ibftStorageMap *storage.QBFTStores
beacon beaconprotocol.BeaconNode
keyManager spectypes.KeyManager
shareEncryptionKeyProvider ShareEncryptionKeyProvider
operatorData *registrystorage.OperatorData
validatorsMap *validatorsMap
validatorOptions *validator.Options
metadataUpdateQueue utilsprotocol.Queue
metadataUpdateInterval time.Duration
operatorsIDs *sync.Map
network network.P2PNetwork
forkVersion forksprotocol.ForkVersion
messageRouter *messageRouter
messageWorker *worker.Worker
historySyncBatchSize int
// nonCommittees is a cache of initialized nonCommitteeValidator instances
nonCommitteeValidators *ttlcache.Cache[spectypes.MessageID, *nonCommitteeValidator]
nonCommitteeMutex sync.Mutex
}
// NewController creates a new validator controller instance
func NewController(logger *zap.Logger, options ControllerOptions) Controller {
logger.Debug("CreatingController", zap.Bool("full_node", options.FullNode), fields.BuilderProposals(options.BuilderProposals))
storageMap := storage.NewStores()
storageMap.Add(spectypes.BNRoleAttester, storage.New(options.DB, spectypes.BNRoleAttester.String(), options.ForkVersion))
storageMap.Add(spectypes.BNRoleProposer, storage.New(options.DB, spectypes.BNRoleProposer.String(), options.ForkVersion))
storageMap.Add(spectypes.BNRoleAggregator, storage.New(options.DB, spectypes.BNRoleAggregator.String(), options.ForkVersion))
storageMap.Add(spectypes.BNRoleSyncCommittee, storage.New(options.DB, spectypes.BNRoleSyncCommittee.String(), options.ForkVersion))
storageMap.Add(spectypes.BNRoleSyncCommitteeContribution, storage.New(options.DB, spectypes.BNRoleSyncCommitteeContribution.String(), options.ForkVersion))
storageMap.Add(spectypes.BNRoleValidatorRegistration, storage.New(options.DB, spectypes.BNRoleValidatorRegistration.String(), options.ForkVersion))
// lookup in a map that holds all relevant operators
operatorsIDs := &sync.Map{}
msgID := forksfactory.NewFork(options.ForkVersion).MsgID()
workerCfg := &worker.Config{
Ctx: options.Context,
WorkersCount: options.WorkersCount,
Buffer: options.QueueBufferSize,
}
validatorOptions := &validator.Options{ //TODO add vars
Network: options.Network,
Beacon: options.Beacon,
BeaconNetwork: options.BeaconNetwork.BeaconNetwork,
Storage: storageMap,
//Share: nil, // set per validator
Signer: options.KeyManager,
//Mode: validator.ModeRW // set per validator
DutyRunners: nil, // set per validator
NewDecidedHandler: options.NewDecidedHandler,
FullNode: options.FullNode,
Exporter: options.Exporter,
BuilderProposals: options.BuilderProposals,
GasLimit: options.GasLimit,
}
// If full node, increase queue size to make enough room
// for history sync batches to be pushed whole.
if options.FullNode {
size := options.HistorySyncBatchSize * 2
if size > validator.DefaultQueueSize {
validatorOptions.QueueSize = size
}
}
ctrl := controller{
sharesStorage: options.RegistryStorage.Shares(),
operatorsStorage: options.RegistryStorage,
recipientsStorage: options.RegistryStorage,
eventHandler: options.RegistryStorage,
ibftStorageMap: storageMap,
context: options.Context,
beacon: options.Beacon,
shareEncryptionKeyProvider: options.ShareEncryptionKeyProvider,
operatorData: options.OperatorData,
keyManager: options.KeyManager,
network: options.Network,
forkVersion: options.ForkVersion,
validatorsMap: newValidatorsMap(options.Context, validatorOptions),
validatorOptions: validatorOptions,
metadataUpdateQueue: tasks.NewExecutionQueue(10 * time.Millisecond),
metadataUpdateInterval: options.MetadataUpdateInterval,
operatorsIDs: operatorsIDs,
messageRouter: newMessageRouter(msgID),
messageWorker: worker.NewWorker(logger, workerCfg),
historySyncBatchSize: options.HistorySyncBatchSize,
nonCommitteeValidators: ttlcache.New(
ttlcache.WithTTL[spectypes.MessageID, *nonCommitteeValidator](time.Minute * 13),
),
}
// Start automatic expired item deletion in nonCommitteeValidators.
go ctrl.nonCommitteeValidators.Start()
return &ctrl
}
// setupNetworkHandlers registers all the required handlers for sync protocols
func (c *controller) setupNetworkHandlers(logger *zap.Logger) error {
syncHandlers := []*p2pprotocol.SyncHandler{
p2pprotocol.WithHandler(
p2pprotocol.LastDecidedProtocol,
handlers.LastDecidedHandler(logger, c.ibftStorageMap, c.network),
),
}
if c.validatorOptions.FullNode {
syncHandlers = append(
syncHandlers,
p2pprotocol.WithHandler(
p2pprotocol.DecidedHistoryProtocol,
// TODO: extract maxBatch to config
handlers.HistoryHandler(logger, c.ibftStorageMap, c.network, c.historySyncBatchSize),
),
)
}
logger.Debug("setting up network handlers",
zap.Int("count", len(syncHandlers)),
zap.Bool("full_node", c.validatorOptions.FullNode),
zap.Bool("exporter", c.validatorOptions.Exporter),
zap.Int("queue_size", c.validatorOptions.QueueSize))
c.network.RegisterHandlers(logger, syncHandlers...)
return nil
}
func (c *controller) GetOperatorShares() []*types.SSVShare {
return c.sharesStorage.List(registrystorage.ByOperatorID(c.operatorData.ID), registrystorage.ByActiveValidator())
}
func (c *controller) GetOperatorData() *registrystorage.OperatorData {
return c.operatorData
}
func (c *controller) GetValidatorStats() (uint64, uint64, uint64, error) {
allShares := c.sharesStorage.List()
operatorShares := uint64(0)
active := uint64(0)
for _, s := range allShares {
if ok := s.BelongsToOperator(c.operatorData.ID); ok {
operatorShares++
}
if s.HasBeaconMetadata() && s.BeaconMetadata.IsAttesting() {
active++
}
}
return uint64(len(allShares)), active, operatorShares, nil
}
func (c *controller) handleRouterMessages(logger *zap.Logger) {
ctx, cancel := context.WithCancel(c.context)
defer cancel()
ch := c.messageRouter.GetMessageChan()
for {
select {
case <-ctx.Done():
logger.Debug("router message handler stopped")
return
case msg := <-ch:
// TODO temp solution to prevent getting event msgs from network. need to to add validation in p2p
if msg.MsgType == message.SSVEventMsgType {
continue
}
pk := msg.GetID().GetPubKey()
hexPK := hex.EncodeToString(pk)
if v, ok := c.validatorsMap.GetValidator(hexPK); ok {
v.HandleMessage(logger, &msg)
} else {
if msg.MsgType != spectypes.SSVConsensusMsgType {
continue // not supporting other types
}
if !c.messageWorker.TryEnqueue(&msg) { // start to save non committee decided messages only post fork
logger.Warn("Failed to enqueue post consensus message: buffer is full")
}
}
}
}
}
var nonCommitteeValidatorTTLs = map[spectypes.BeaconRole]phase0.Slot{
spectypes.BNRoleAttester: 64,
spectypes.BNRoleProposer: 4,
spectypes.BNRoleAggregator: 4,
spectypes.BNRoleSyncCommittee: 4,
spectypes.BNRoleSyncCommitteeContribution: 4,
}
func (c *controller) handleWorkerMessages(logger *zap.Logger, msg *spectypes.SSVMessage) error {
// Get or create a nonCommitteeValidator for this MessageID, and lock it to prevent
// other handlers from processing
var ncv *nonCommitteeValidator
err := func() error {
c.nonCommitteeMutex.Lock()
defer c.nonCommitteeMutex.Unlock()
item := c.nonCommitteeValidators.Get(msg.GetID())
if item != nil {
ncv = item.Value()
} else {
// Create a new nonCommitteeValidator and cache it.
share := c.sharesStorage.Get(msg.GetID().GetPubKey())
if share == nil {
return errors.Errorf("could not find validator [%s]", hex.EncodeToString(msg.GetID().GetPubKey()))
}
opts := *c.validatorOptions
opts.SSVShare = share
ncv = &nonCommitteeValidator{
NonCommitteeValidator: validator.NewNonCommitteeValidator(logger, msg.GetID(), opts),
}
ttlSlots := nonCommitteeValidatorTTLs[msg.MsgID.GetRoleType()]
c.nonCommitteeValidators.Set(
msg.GetID(),
ncv,
time.Duration(ttlSlots)*c.beacon.GetBeaconNetwork().SlotDurationSec(),
)
}
ncv.Lock()
return nil
}()
if err != nil {
return err
}
// Process the message.
defer ncv.Unlock()
ncv.ProcessMessage(logger, msg)
return nil
}
// ListenToEth1Events is listening to events coming from eth1 client
func (c *controller) ListenToEth1Events(logger *zap.Logger, feed *event.Feed) {
logger = logger.Named(logging.NameController)
cn := make(chan *eth1.Event)
sub := feed.Subscribe(cn)
defer sub.Unsubscribe()
handler := c.Eth1EventHandler(logger, true)
for {
select {
case e := <-cn:
logFields, err := handler(*e)
_ = eth1.HandleEventResult(logger, *e, logFields, err, true)
case err := <-sub.Err():
logger.Warn("event feed subscription error", zap.Error(err))
}
}
}
// StartValidators loads all persisted shares and setup the corresponding validators
func (c *controller) StartValidators(logger *zap.Logger) {
logger = logger.Named(logging.NameController)
if c.validatorOptions.Exporter {
c.setupNonCommitteeValidators(logger)
return
}
shares := c.sharesStorage.List(registrystorage.ByOperatorID(c.operatorData.ID), registrystorage.ByNotLiquidated())
if len(shares) == 0 {
logger.Info("could not find validators")
return
}
c.setupValidators(logger, shares)
}
// setupValidators setup and starts validators from the given shares.
// shares w/o validator's metadata won't start, but the metadata will be fetched and the validator will start afterwards
func (c *controller) setupValidators(logger *zap.Logger, shares []*types.SSVShare) {
logger.Info("starting validators setup...", zap.Int("shares count", len(shares)))
var started int
var errs []error
var fetchMetadata [][]byte
for _, validatorShare := range shares {
isStarted, err := c.onShareStart(logger, validatorShare)
if err != nil {
logger.Warn("could not start validator", fields.PubKey(validatorShare.ValidatorPubKey), zap.Error(err))
errs = append(errs, err)
}
if !isStarted && err == nil {
// Fetch metadata, if needed.
fetchMetadata = append(fetchMetadata, validatorShare.ValidatorPubKey)
}
if isStarted {
started++
}
}
logger.Info("setup validators done", zap.Int("map size", c.validatorsMap.Size()),
zap.Int("failures", len(errs)), zap.Int("missing metadata", len(fetchMetadata)),
zap.Int("shares count", len(shares)), zap.Int("started", started))
// Try to fetch metadata once for validators that don't have it.
if len(fetchMetadata) > 0 {
go func() {
logger.Debug("updating validators metadata", zap.Int("count", len(fetchMetadata)))
if err := beaconprotocol.UpdateValidatorsMetadata(logger, fetchMetadata, c, c.beacon, c.onMetadataUpdated); err != nil {
logger.Warn("could not update all validators", zap.Error(err))
}
}()
}
}
// setupNonCommitteeValidators trigger SyncHighestDecided for each validator
// to start consensus flow which would save the highest decided instance
// and sync any gaps (in protocol/v2/qbft/controller/decided.go).
func (c *controller) setupNonCommitteeValidators(logger *zap.Logger) {
// Subscribe to all subnets.
err := c.network.SubscribeAll(logger)
if err != nil {
logger.Error("failed to subscribe to all subnets", zap.Error(err))
return
}
nonCommitteeShares := c.sharesStorage.List(registrystorage.ByNotLiquidated())
if len(nonCommitteeShares) == 0 {
logger.Info("could not find non-committee validators")
return
}
for _, validatorShare := range nonCommitteeShares {
opts := *c.validatorOptions
opts.SSVShare = validatorShare
allRoles := []spectypes.BeaconRole{
spectypes.BNRoleAttester,
spectypes.BNRoleAggregator,
spectypes.BNRoleProposer,
spectypes.BNRoleSyncCommittee,
spectypes.BNRoleSyncCommitteeContribution,
}
for _, role := range allRoles {
messageID := spectypes.NewMsgID(types.GetDefaultDomain(), validatorShare.ValidatorPubKey, role)
err := c.network.SyncHighestDecided(messageID)
if err != nil {
logger.Error("failed to sync highest decided", zap.Error(err))
}
}
}
}
// StartNetworkHandlers init msg worker that handles network messages
func (c *controller) StartNetworkHandlers(logger *zap.Logger) {
logger = logger.Named(logging.NameController)
// first, set stream handlers
if err := c.setupNetworkHandlers(logger); err != nil {
logger.Panic("could not register stream handlers", zap.Error(err))
}
c.network.UseMessageRouter(c.messageRouter)
for i := 0; i < networkRouterConcurrency; i++ {
go c.handleRouterMessages(logger)
}
c.messageWorker.UseHandler(c.handleWorkerMessages)
}
// UpdateValidatorMetadata updates a given validator with metadata (implements ValidatorMetadataStorage)
func (c *controller) UpdateValidatorMetadata(logger *zap.Logger, pk string, metadata *beaconprotocol.ValidatorMetadata) error {
if metadata == nil {
return errors.New("could not update empty metadata")
}
// Save metadata to share storage.
err := c.sharesStorage.(beaconprotocol.ValidatorMetadataStorage).UpdateValidatorMetadata(logger, pk, metadata)
if err != nil {
return errors.Wrap(err, "could not update validator metadata")
}
// Update metadata in memory, and start validator if needed.
if v, found := c.validatorsMap.GetValidator(pk); found {
v.Share.BeaconMetadata = metadata
_, err := c.startValidator(logger, v)
if err != nil {
logger.Warn("could not start validator", zap.Error(err))
}
} else {
logger.Info("starting new validator", zap.String("pubKey", pk))
pkBytes, err := hex.DecodeString(pk)
if err != nil {
return errors.Wrap(err, "could not decode public key")
}
share := c.sharesStorage.Get(pkBytes)
if share == nil {
return errors.New("share was not found")
}
started, err := c.onShareStart(logger, share)
if err != nil {
return errors.Wrap(err, "could not start validator")
}
if started {
logger.Debug("started share after metadata update", zap.Bool("started", started))
}
}
return nil
}
// GetValidator returns a validator instance from validatorsMap
func (c *controller) GetValidator(pubKey string) (*validator.Validator, bool) {
return c.validatorsMap.GetValidator(pubKey)
}
// ActiveValidatorIndices returns a list of all the active validators indices
// and fetch indices for missing once (could be first time attesting or non active once)
func (c *controller) ActiveValidatorIndices(logger *zap.Logger) []phase0.ValidatorIndex {
logger = logger.Named(logging.NameController)
indices := make([]phase0.ValidatorIndex, 0, len(c.validatorsMap.validatorsMap))
err := c.validatorsMap.ForEach(func(v *validator.Validator) error {
// Beacon node throws error when trying to fetch duties for non-existing validators.
if v.Share.BeaconMetadata.IsAttesting() {
indices = append(indices, v.Share.BeaconMetadata.Index)
}
return nil
})
if err != nil {
logger.Warn("failed to get all validators public keys", zap.Error(err))
}
return indices
}
// onMetadataUpdated is called when validator's metadata was updated
func (c *controller) onMetadataUpdated(logger *zap.Logger, pk string, meta *beaconprotocol.ValidatorMetadata) {
if meta == nil {
return
}
logger = logger.With(zap.String("pk", pk))
if v, exist := c.GetValidator(pk); exist {
// update share object owned by the validator
// TODO: check if this updates running validators
if !v.Share.BeaconMetadata.Equals(meta) {
v.Share.BeaconMetadata.Status = meta.Status
v.Share.BeaconMetadata.Balance = meta.Balance
logger.Debug("metadata was updated")
}
_, err := c.startValidator(logger, v)
if err != nil {
logger.Warn("could not start validator after metadata update",
zap.String("pk", pk), zap.Error(err), zap.Any("metadata", meta))
}
return
}
}
// onShareCreate is called when a validator was added/updated during registry sync
func (c *controller) onShareCreate(logger *zap.Logger, validatorEvent abiparser.ValidatorAddedEvent) (*types.SSVShare, error) {
share, shareSecret, err := ShareFromValidatorEvent(
validatorEvent,
c.shareEncryptionKeyProvider,
c.operatorData,
)
if err != nil {
return nil, errors.Wrap(err, "could not extract validator share from event")
}
if share.BelongsToOperator(c.operatorData.ID) {
if shareSecret == nil {
return nil, errors.New("could not decode shareSecret")
}
logger := logger.With(fields.PubKey(share.ValidatorPubKey))
// get metadata
if updated, err := UpdateShareMetadata(share, c.beacon); err != nil {
logger.Warn("could not add validator metadata", zap.Error(err))
} else if !updated {
logger.Warn("could not find validator metadata")
}
// save secret key
if err := c.keyManager.AddShare(shareSecret); err != nil {
return nil, errors.Wrap(err, "could not add share secret to key manager")
}
}
// save validator data
if err := c.sharesStorage.Save(share); err != nil {
return nil, errors.Wrap(err, "could not save validator share")
}
return share, nil
}
// onShareRemove is called when a validator was removed
// TODO: think how we can make this function atomic (i.e. failing wouldn't stop the removal of the share)
func (c *controller) onShareRemove(pk string, removeSecret bool) error {
// remove from validatorsMap
v := c.validatorsMap.RemoveValidator(pk)
// stop instance
if v != nil {
v.Stop()
}
// remove the share secret from key-manager
if removeSecret {
if err := c.keyManager.RemoveShare(pk); err != nil {
return errors.Wrap(err, "could not remove share secret from key manager")
}
}
return nil
}
func (c *controller) onShareStart(logger *zap.Logger, share *types.SSVShare) (bool, error) {
if !share.HasBeaconMetadata() { // fetching index and status in case not exist
logger.Warn("skipping validator until it becomes active", fields.PubKey(share.ValidatorPubKey))
return false, nil
}
if err := SetShareFeeRecipient(logger, share, c.recipientsStorage.GetRecipientData); err != nil {
return false, errors.Wrap(err, "could not set share fee recipient")
}
// Start a committee validator.
v, err := c.validatorsMap.GetOrCreateValidator(logger.Named("validatorsMap"), share)
if err != nil {
return false, errors.Wrap(err, "could not get or create validator")
}
return c.startValidator(logger, v)
}
// startValidator will start the given validator if applicable
func (c *controller) startValidator(logger *zap.Logger, v *validator.Validator) (bool, error) {
ReportValidatorStatus(hex.EncodeToString(v.Share.ValidatorPubKey), v.Share.BeaconMetadata, logger)
if v.Share.BeaconMetadata.Index == 0 {
return false, errors.New("could not start validator: index not found")
}
if err := v.Start(logger); err != nil {
metricsValidatorStatus.WithLabelValues(hex.EncodeToString(v.Share.ValidatorPubKey)).Set(float64(validatorStatusError))
return false, errors.Wrap(err, "could not start validator")
}
return true, nil
}
// UpdateValidatorMetaDataLoop updates metadata of validators in an interval
func (c *controller) UpdateValidatorMetaDataLoop(logger *zap.Logger) {
logger = logger.Named(logging.NameController)
go c.metadataUpdateQueue.Start()
for {
time.Sleep(c.metadataUpdateInterval)
shares := c.sharesStorage.List(registrystorage.ByOperatorID(c.operatorData.ID), registrystorage.ByNotLiquidated())
var pks [][]byte
for _, share := range shares {
pks = append(pks, share.ValidatorPubKey)
}
logger.Debug("updating metadata in loop", zap.Int("shares count", len(shares)))
beaconprotocol.UpdateValidatorsMetadataBatch(logger, pks, c.metadataUpdateQueue, c,
c.beacon, c.onMetadataUpdated, metadataBatchSize)
}
}
// SetupRunners initializes duty runners for the given validator
func SetupRunners(ctx context.Context, logger *zap.Logger, options validator.Options) runner.DutyRunners {
if options.SSVShare == nil || options.SSVShare.BeaconMetadata == nil {
logger.Error("missing validator metadata", zap.String("validator", hex.EncodeToString(options.SSVShare.ValidatorPubKey)))
return runner.DutyRunners{} // TODO need to find better way to fix it
}
runnersType := []spectypes.BeaconRole{
spectypes.BNRoleAttester,
spectypes.BNRoleProposer,
spectypes.BNRoleAggregator,
spectypes.BNRoleSyncCommittee,
spectypes.BNRoleSyncCommitteeContribution,
spectypes.BNRoleValidatorRegistration,
}
domainType := types.GetDefaultDomain()
buildController := func(role spectypes.BeaconRole, valueCheckF specqbft.ProposedValueCheckF) *qbftcontroller.Controller {
config := &qbft.Config{
Signer: options.Signer,
SigningPK: options.SSVShare.ValidatorPubKey, // TODO right val?
Domain: domainType,
ValueCheckF: nil, // sets per role type
ProposerF: func(state *specqbft.State, round specqbft.Round) spectypes.OperatorID {
leader := specqbft.RoundRobinProposer(state, round)
//logger.Debug("leader", zap.Int("operator_id", int(leader)))
return leader
},
Storage: options.Storage.Get(role),
Network: options.Network,
Timer: roundtimer.New(ctx, nil),
}
config.ValueCheckF = valueCheckF
identifier := spectypes.NewMsgID(types.GetDefaultDomain(), options.SSVShare.Share.ValidatorPubKey, role)
qbftCtrl := qbftcontroller.NewController(identifier[:], &options.SSVShare.Share, domainType, config, options.FullNode)
qbftCtrl.NewDecidedHandler = options.NewDecidedHandler
return qbftCtrl
}
runners := runner.DutyRunners{}
for _, role := range runnersType {
switch role {
case spectypes.BNRoleAttester:
valCheck := specssv.AttesterValueCheckF(options.Signer, options.BeaconNetwork, options.SSVShare.Share.ValidatorPubKey, options.SSVShare.BeaconMetadata.Index, options.SSVShare.SharePubKey)
qbftCtrl := buildController(spectypes.BNRoleAttester, valCheck)
runners[role] = runner.NewAttesterRunnner(options.BeaconNetwork, &options.SSVShare.Share, qbftCtrl, options.Beacon, options.Network, options.Signer, valCheck, 0)
case spectypes.BNRoleProposer:
proposedValueCheck := specssv.ProposerValueCheckF(options.Signer, options.BeaconNetwork, options.SSVShare.Share.ValidatorPubKey, options.SSVShare.BeaconMetadata.Index, options.SSVShare.SharePubKey, options.BuilderProposals)
qbftCtrl := buildController(spectypes.BNRoleProposer, proposedValueCheck)
runners[role] = runner.NewProposerRunner(options.BeaconNetwork, &options.SSVShare.Share, qbftCtrl, options.Beacon, options.Network, options.Signer, proposedValueCheck, 0)
runners[role].(*runner.ProposerRunner).ProducesBlindedBlocks = options.BuilderProposals // apply blinded block flag
case spectypes.BNRoleAggregator:
aggregatorValueCheckF := specssv.AggregatorValueCheckF(options.Signer, options.BeaconNetwork, options.SSVShare.Share.ValidatorPubKey, options.SSVShare.BeaconMetadata.Index)
qbftCtrl := buildController(spectypes.BNRoleAggregator, aggregatorValueCheckF)
runners[role] = runner.NewAggregatorRunner(options.BeaconNetwork, &options.SSVShare.Share, qbftCtrl, options.Beacon, options.Network, options.Signer, aggregatorValueCheckF, 0)
case spectypes.BNRoleSyncCommittee:
syncCommitteeValueCheckF := specssv.SyncCommitteeValueCheckF(options.Signer, options.BeaconNetwork, options.SSVShare.ValidatorPubKey, options.SSVShare.BeaconMetadata.Index)
qbftCtrl := buildController(spectypes.BNRoleSyncCommittee, syncCommitteeValueCheckF)
runners[role] = runner.NewSyncCommitteeRunner(options.BeaconNetwork, &options.SSVShare.Share, qbftCtrl, options.Beacon, options.Network, options.Signer, syncCommitteeValueCheckF, 0)
case spectypes.BNRoleSyncCommitteeContribution:
syncCommitteeContributionValueCheckF := specssv.SyncCommitteeContributionValueCheckF(options.Signer, options.BeaconNetwork, options.SSVShare.Share.ValidatorPubKey, options.SSVShare.BeaconMetadata.Index)
qbftCtrl := buildController(spectypes.BNRoleSyncCommitteeContribution, syncCommitteeContributionValueCheckF)
runners[role] = runner.NewSyncCommitteeAggregatorRunner(options.BeaconNetwork, &options.SSVShare.Share, qbftCtrl, options.Beacon, options.Network, options.Signer, syncCommitteeContributionValueCheckF, 0)
case spectypes.BNRoleValidatorRegistration:
qbftCtrl := buildController(spectypes.BNRoleValidatorRegistration, nil)
runners[role] = runner.NewValidatorRegistrationRunner(spectypes.PraterNetwork, &options.SSVShare.Share, qbftCtrl, options.Beacon, options.Network, options.Signer)
}
}
return runners
}