-
Notifications
You must be signed in to change notification settings - Fork 84
/
handlers.go
587 lines (490 loc) · 19.1 KB
/
handlers.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
package eventhandler
import (
"bytes"
"encoding/hex"
"errors"
"fmt"
"github.com/attestantio/go-eth2-client/spec/phase0"
spectypes "github.com/bloxapp/ssv-spec/types"
ethcommon "github.com/ethereum/go-ethereum/common"
"github.com/herumi/bls-eth-go-binary/bls"
"go.uber.org/zap"
"github.com/bloxapp/ssv/ekm"
"github.com/bloxapp/ssv/eth/contract"
"github.com/bloxapp/ssv/logging/fields"
"github.com/bloxapp/ssv/operator/duties"
qbftstorage "github.com/bloxapp/ssv/protocol/v2/qbft/storage"
ssvtypes "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/rsaencryption"
)
// b64 encrypted key length is 256
const encryptedKeyLength = 256
var (
ErrAlreadyRegistered = fmt.Errorf("operator registered with the same operator public key")
ErrOperatorDataNotFound = fmt.Errorf("operator data not found")
ErrIncorrectSharesLength = fmt.Errorf("shares length is not correct")
ErrSignatureVerification = fmt.Errorf("signature verification failed")
ErrShareBelongsToDifferentOwner = fmt.Errorf("share already exists and belongs to different owner")
ErrValidatorShareNotFound = fmt.Errorf("validator share not found")
)
// TODO: make sure all handlers are tested properly:
// set up a mock DB where we test that after running the handler we check that the DB state is as expected
func (eh *EventHandler) handleOperatorAdded(txn basedb.Txn, event *contract.ContractOperatorAdded) error {
logger := eh.logger.With(
fields.EventName(OperatorAdded),
fields.TxHash(event.Raw.TxHash),
fields.OperatorID(event.OperatorId),
fields.Owner(event.Owner),
fields.OperatorPubKey(event.PublicKey),
)
logger.Debug("processing event")
od := ®istrystorage.OperatorData{
PublicKey: event.PublicKey,
OwnerAddress: event.Owner,
ID: event.OperatorId,
}
// throw an error if there is an existing operator with the same public key and different operator id
operatorData := eh.operatorData.GetOperatorData()
if operatorData.ID != 0 && bytes.Equal(operatorData.PublicKey, event.PublicKey) && operatorData.ID != event.OperatorId {
logger.Warn("malformed event: operator registered with the same operator public key",
zap.Uint64("expected_operator_id", operatorData.ID))
return &MalformedEventError{Err: ErrAlreadyRegistered}
}
// TODO: consider saving other operators as well
exists, err := eh.nodeStorage.SaveOperatorData(txn, od)
if err != nil {
return fmt.Errorf("save operator data: %w", err)
}
if exists {
logger.Debug("operator data already exists")
return nil
}
ownOperator := bytes.Equal(event.PublicKey, operatorData.PublicKey)
if ownOperator {
eh.operatorData.SetOperatorData(od)
logger = logger.With(zap.Bool("own_operator", ownOperator))
}
eh.metrics.OperatorPublicKey(od.ID, od.PublicKey)
logger.Debug("processed event")
return nil
}
func (eh *EventHandler) handleOperatorRemoved(txn basedb.Txn, event *contract.ContractOperatorRemoved) error {
logger := eh.logger.With(
fields.EventName(OperatorRemoved),
fields.TxHash(event.Raw.TxHash),
fields.OperatorID(event.OperatorId),
)
logger.Debug("processing event")
od, found, err := eh.nodeStorage.GetOperatorData(txn, event.OperatorId)
if err != nil {
return fmt.Errorf("could not get operator data: %w", err)
}
if !found || od == nil {
logger.Warn("malformed event: could not find operator data")
return &MalformedEventError{Err: ErrOperatorDataNotFound}
}
logger = logger.With(
fields.OperatorPubKey(od.PublicKey),
fields.Owner(od.OwnerAddress),
)
// TODO: In original handler we didn't delete operator data, so this behavior was preserved. However we likely need to.
// TODO: Delete operator from all the shares.
// var shares []Share
// for _, s := range nodeStorage.Shares().List() {
// // if operator in committee, delete him from it:
// // shares = append(shares, s)
// }
// nodeStorage.Shares().Save(shares)
// err = eh.nodeStorage.DeleteOperatorData(txn, od.ID)
// if err != nil {
// return err
// }
logger.Debug("processed event")
return nil
}
func (eh *EventHandler) handleValidatorAdded(txn basedb.Txn, event *contract.ContractValidatorAdded) (ownShare *ssvtypes.SSVShare, err error) {
logger := eh.logger.With(
fields.EventName(ValidatorAdded),
fields.TxHash(event.Raw.TxHash),
fields.Owner(event.Owner),
fields.OperatorIDs(event.OperatorIds),
fields.Validator(event.PublicKey),
)
// Get the expected nonce.
nonce, nonceErr := eh.nodeStorage.GetNextNonce(txn, event.Owner)
if nonceErr != nil {
return nil, fmt.Errorf("failed to get next nonce: %w", nonceErr)
}
// Bump nonce. This transaction would be reverted later if the handling fails,
// unless the failure is due to a malformed event.
if err := eh.nodeStorage.BumpNonce(txn, event.Owner); err != nil {
return nil, err
}
if err := eh.validateOperators(txn, event.OperatorIds); err != nil {
return nil, &MalformedEventError{Err: err}
}
// Calculate the expected length of constructed shares based on the number of operator IDs,
// signature length, public key length, and encrypted key length.
operatorCount := len(event.OperatorIds)
signatureOffset := phase0.SignatureLength
pubKeysOffset := phase0.PublicKeyLength*operatorCount + signatureOffset
sharesExpectedLength := encryptedKeyLength*operatorCount + pubKeysOffset
if sharesExpectedLength != len(event.Shares) {
logger.Warn("malformed event: event shares length is not correct",
zap.Int("expected", sharesExpectedLength),
zap.Int("got", len(event.Shares)))
return nil, &MalformedEventError{Err: ErrIncorrectSharesLength}
}
signature := event.Shares[:signatureOffset]
sharePublicKeys := splitBytes(event.Shares[signatureOffset:pubKeysOffset], phase0.PublicKeyLength)
encryptedKeys := splitBytes(event.Shares[pubKeysOffset:], len(event.Shares[pubKeysOffset:])/operatorCount)
// verify sig
if err := verifySignature(signature, event.Owner, event.PublicKey, nonce); err != nil {
logger.Warn("malformed event: failed to verify signature",
zap.String("signature", hex.EncodeToString(signature)),
zap.String("owner", event.Owner.String()),
zap.String("validator_public_key", hex.EncodeToString(event.PublicKey)),
zap.Error(err))
return nil, &MalformedEventError{Err: ErrSignatureVerification}
}
validatorShare := eh.nodeStorage.Shares().Get(txn, event.PublicKey)
if validatorShare == nil {
shareCreated, err := eh.handleShareCreation(txn, event, sharePublicKeys, encryptedKeys)
if err != nil {
var malformedEventError *MalformedEventError
if errors.As(err, &malformedEventError) {
logger.Warn("malformed event", zap.Error(err))
return nil, err
}
eh.metrics.ValidatorError(event.PublicKey)
return nil, err
}
validatorShare = shareCreated
logger.Debug("share not found, created a new one", fields.OperatorID(validatorShare.OperatorID))
} else if event.Owner != validatorShare.OwnerAddress {
// Prevent multiple registration of the same validator with different owner address
// owner A registers validator with public key X (OK)
// owner B registers validator with public key X (NOT OK)
logger.Warn("malformed event: validator share already exists with different owner address",
zap.String("expected", validatorShare.OwnerAddress.String()),
zap.String("got", event.Owner.String()))
return nil, &MalformedEventError{Err: ErrShareBelongsToDifferentOwner}
}
isOperatorShare := validatorShare.BelongsToOperator(eh.operatorData.GetOperatorData().ID)
if isOperatorShare {
eh.metrics.ValidatorInactive(event.PublicKey)
logger = logger.With(zap.Bool("own_validator", isOperatorShare))
if validatorShare.InvalidSecret {
logger = logger.With(zap.Bool("invalid_secret", true))
logger.Debug("registered validator has an invalid share secret, it will not be started")
} else {
ownShare = validatorShare
}
}
logger.Debug("processed event")
return
}
// handleShareCreation is called when a validator was added/updated during registry sync
func (eh *EventHandler) handleShareCreation(
txn basedb.Txn,
validatorEvent *contract.ContractValidatorAdded,
sharePublicKeys [][]byte,
encryptedKeys [][]byte,
) (*ssvtypes.SSVShare, error) {
share, shareSecret, err := eh.validatorAddedEventToShare(
validatorEvent,
eh.shareEncryptionKeyProvider,
eh.operatorData.GetOperatorData(),
sharePublicKeys,
encryptedKeys,
)
if err != nil && !share.Metadata.InvalidSecret {
return share, err
}
if !share.Metadata.InvalidSecret && share.BelongsToOperator(eh.operatorData.GetOperatorData().ID) {
if shareSecret == nil {
return nil, errors.New("could not decode shareSecret")
}
// Save secret key into KeyManager.
if err := eh.keyManager.AddShare(shareSecret); err != nil {
return nil, fmt.Errorf("could not add share secret to key manager: %w", err)
}
}
// Save share.
if err := eh.nodeStorage.Shares().Save(txn, share); err != nil {
return nil, fmt.Errorf("could not save validator share: %w", err)
}
if !share.Metadata.InvalidSecret {
return share, nil
}
return share, err
}
func (eh *EventHandler) validatorAddedEventToShare(
event *contract.ContractValidatorAdded,
shareEncryptionKeyProvider ShareEncryptionKeyProvider,
operatorData *registrystorage.OperatorData,
sharePublicKeys [][]byte,
encryptedKeys [][]byte,
) (*ssvtypes.SSVShare, *bls.SecretKey, error) {
validatorShare := &ssvtypes.SSVShare{}
publicKey, err := ssvtypes.DeserializeBLSPublicKey(event.PublicKey)
if err != nil {
return validatorShare, nil, &MalformedEventError{
Err: fmt.Errorf("failed to deserialize validator public key: %w", err),
}
}
validatorShare.ValidatorPubKey = publicKey.Serialize()
validatorShare.OwnerAddress = event.Owner
var shareSecret *bls.SecretKey
committee := make([]*spectypes.Operator, 0)
for i := range event.OperatorIds {
operatorID := event.OperatorIds[i]
committee = append(committee, &spectypes.Operator{
OperatorID: operatorID,
PubKey: sharePublicKeys[i],
})
if operatorID != operatorData.ID {
continue
}
validatorShare.OperatorID = operatorID
validatorShare.SharePubKey = sharePublicKeys[i]
operatorPrivateKey, found, err := shareEncryptionKeyProvider()
if err != nil {
return nil, nil, fmt.Errorf("could not get operator private key: %w", err)
}
if !found {
return nil, nil, errors.New("could not find operator private key")
}
shareSecret = &bls.SecretKey{}
decryptedSharePrivateKey, err := rsaencryption.DecodeKey(operatorPrivateKey, encryptedKeys[i])
validatorShare.Metadata.InvalidSecret = true
if err != nil {
return validatorShare, nil, &MalformedEventError{
Err: fmt.Errorf("could not decrypt share private key: %w", err),
}
}
if err = shareSecret.SetHexString(string(decryptedSharePrivateKey)); err != nil {
return validatorShare, nil, &MalformedEventError{
Err: fmt.Errorf("could not set decrypted share private key: %w", err),
}
}
if !bytes.Equal(shareSecret.GetPublicKey().Serialize(), validatorShare.SharePubKey) {
return validatorShare, nil, &MalformedEventError{
Err: errors.New("share private key does not match public key"),
}
}
validatorShare.Metadata.InvalidSecret = false
}
validatorShare.Quorum, validatorShare.PartialQuorum = ssvtypes.ComputeQuorumAndPartialQuorum(len(committee))
validatorShare.DomainType = eh.networkConfig.Domain
validatorShare.Committee = committee
validatorShare.Graffiti = []byte("ssv.network")
return validatorShare, shareSecret, nil
}
func (eh *EventHandler) handleValidatorRemoved(txn basedb.Txn, event *contract.ContractValidatorRemoved) (spectypes.ValidatorPK, error) {
logger := eh.logger.With(
fields.EventName(ValidatorRemoved),
fields.TxHash(event.Raw.TxHash),
fields.Owner(event.Owner),
fields.OperatorIDs(event.OperatorIds),
fields.PubKey(event.PublicKey),
)
logger.Debug("processing event")
// TODO: handle metrics
share := eh.nodeStorage.Shares().Get(txn, event.PublicKey)
if share == nil {
logger.Warn("malformed event: could not find validator share")
return nil, &MalformedEventError{Err: ErrValidatorShareNotFound}
}
// Prevent removal of the validator registered with different owner address
// owner A registers validator with public key X (OK)
// owner B registers validator with public key X (NOT OK)
// owner A removes validator with public key X (OK)
// owner B removes validator with public key X (NOT OK)
if event.Owner != share.OwnerAddress {
logger.Warn("malformed event: validator share already exists with different owner address",
zap.String("expected", share.OwnerAddress.String()),
zap.String("got", event.Owner.String()))
return nil, &MalformedEventError{Err: ErrShareBelongsToDifferentOwner}
}
removeDecidedMessages := func(role spectypes.BeaconRole, store qbftstorage.QBFTStore) error {
messageID := spectypes.NewMsgID(eh.networkConfig.Domain, share.ValidatorPubKey, role)
return store.CleanAllInstances(logger, messageID[:])
}
err := eh.storageMap.Each(removeDecidedMessages)
if err != nil {
return nil, fmt.Errorf("could not clean all decided messages: %w", err)
}
if err := eh.nodeStorage.Shares().Delete(txn, share.ValidatorPubKey); err != nil {
return nil, fmt.Errorf("could not remove validator share: %w", err)
}
isOperatorShare := share.BelongsToOperator(eh.operatorData.GetOperatorData().ID)
if isOperatorShare || eh.fullNode {
logger = logger.With(zap.String("validator_pubkey", hex.EncodeToString(share.ValidatorPubKey)))
}
if isOperatorShare {
err = eh.keyManager.RemoveShare(hex.EncodeToString(share.SharePubKey))
if err != nil {
return nil, fmt.Errorf("could not remove share from ekm storage: %w", err)
}
eh.metrics.ValidatorRemoved(event.PublicKey)
logger.Debug("processed event")
return share.ValidatorPubKey, nil
}
logger.Debug("processed event")
return nil, nil
}
func (eh *EventHandler) handleClusterLiquidated(txn basedb.Txn, event *contract.ContractClusterLiquidated) ([]*ssvtypes.SSVShare, error) {
logger := eh.logger.With(
fields.EventName(ClusterLiquidated),
fields.TxHash(event.Raw.TxHash),
fields.Owner(event.Owner),
fields.OperatorIDs(event.OperatorIds),
)
logger.Debug("processing event")
toLiquidate, liquidatedPubKeys, err := eh.processClusterEvent(txn, event.Owner, event.OperatorIds, true)
if err != nil {
return nil, fmt.Errorf("could not process cluster event: %w", err)
}
if len(liquidatedPubKeys) > 0 {
logger = logger.With(zap.Strings("liquidated_validators", liquidatedPubKeys))
}
logger.Debug("processed event")
return toLiquidate, nil
}
func (eh *EventHandler) handleClusterReactivated(txn basedb.Txn, event *contract.ContractClusterReactivated) ([]*ssvtypes.SSVShare, error) {
logger := eh.logger.With(
fields.EventName(ClusterReactivated),
fields.TxHash(event.Raw.TxHash),
fields.Owner(event.Owner),
fields.OperatorIDs(event.OperatorIds),
)
logger.Debug("processing event")
toReactivate, enabledPubKeys, err := eh.processClusterEvent(txn, event.Owner, event.OperatorIds, false)
if err != nil {
return nil, fmt.Errorf("could not process cluster event: %w", err)
}
// bump slashing protection for operator reactivated validators
for _, share := range toReactivate {
if err := eh.keyManager.(ekm.StorageProvider).BumpSlashingProtection(share.SharePubKey); err != nil {
return nil, fmt.Errorf("could not bump slashing protection: %w", err)
}
}
if len(enabledPubKeys) > 0 {
logger = logger.With(zap.Strings("enabled_validators", enabledPubKeys))
}
logger.Debug("processed event")
return toReactivate, nil
}
func (eh *EventHandler) handleFeeRecipientAddressUpdated(txn basedb.Txn, event *contract.ContractFeeRecipientAddressUpdated) (bool, error) {
logger := eh.logger.With(
fields.EventName(FeeRecipientAddressUpdated),
fields.TxHash(event.Raw.TxHash),
fields.Owner(event.Owner),
fields.FeeRecipient(event.RecipientAddress.Bytes()),
)
logger.Debug("processing event")
recipientData, found, err := eh.nodeStorage.GetRecipientData(txn, event.Owner)
if err != nil {
return false, fmt.Errorf("get recipient data: %w", err)
}
if !found || recipientData == nil {
recipientData = ®istrystorage.RecipientData{
Owner: event.Owner,
}
}
copy(recipientData.FeeRecipient[:], event.RecipientAddress.Bytes())
r, err := eh.nodeStorage.SaveRecipientData(txn, recipientData)
if err != nil {
return false, fmt.Errorf("could not save recipient data: %w", err)
}
logger.Debug("processed event")
return r != nil, nil
}
func (eh *EventHandler) handleValidatorExited(txn basedb.Txn, event *contract.ContractValidatorExited) (*duties.ExitDescriptor, error) {
logger := eh.logger.With(
fields.EventName(ValidatorExited),
fields.TxHash(event.Raw.TxHash),
fields.PubKey(event.PublicKey),
fields.OperatorIDs(event.OperatorIds),
)
logger.Debug("processing event")
defer logger.Debug("processed event")
share := eh.nodeStorage.Shares().Get(txn, event.PublicKey)
if share == nil {
logger.Warn("malformed event: could not find validator share")
return nil, &MalformedEventError{Err: ErrValidatorShareNotFound}
}
if event.Owner != share.OwnerAddress {
logger.Warn("malformed event: validator share already exists with different owner address",
zap.String("expected", share.OwnerAddress.String()),
zap.String("got", event.Owner.String()))
return nil, &MalformedEventError{Err: ErrShareBelongsToDifferentOwner}
}
if !share.BelongsToOperator(eh.operatorData.GetOperatorData().ID) {
return nil, nil
}
if share.BeaconMetadata == nil {
return nil, nil
}
pk := phase0.BLSPubKey{}
copy(pk[:], share.ValidatorPubKey)
ed := &duties.ExitDescriptor{
PubKey: pk,
ValidatorIndex: share.BeaconMetadata.Index,
BlockNumber: event.Raw.BlockNumber,
}
return ed, nil
}
func splitBytes(buf []byte, lim int) [][]byte {
var chunk []byte
chunks := make([][]byte, 0, len(buf)/lim+1)
for len(buf) >= lim {
chunk, buf = buf[:lim], buf[lim:]
chunks = append(chunks, chunk)
}
if len(buf) > 0 {
chunks = append(chunks, buf[:])
}
return chunks
}
// processClusterEvent handles registry contract event for cluster
func (eh *EventHandler) processClusterEvent(
txn basedb.Txn,
owner ethcommon.Address,
operatorIDs []uint64,
toLiquidate bool,
) ([]*ssvtypes.SSVShare, []string, error) {
clusterID := ssvtypes.ComputeClusterIDHash(owner, operatorIDs)
shares := eh.nodeStorage.Shares().List(txn, registrystorage.ByClusterID(clusterID))
toUpdate := make([]*ssvtypes.SSVShare, 0)
updatedPubKeys := make([]string, 0)
for _, share := range shares {
isOperatorShare := share.BelongsToOperator(eh.operatorData.GetOperatorData().ID)
if isOperatorShare || eh.fullNode {
updatedPubKeys = append(updatedPubKeys, hex.EncodeToString(share.ValidatorPubKey))
}
if isOperatorShare {
share.Liquidated = toLiquidate
toUpdate = append(toUpdate, share)
}
}
if len(toUpdate) > 0 {
if err := eh.nodeStorage.Shares().Save(txn, toUpdate...); err != nil {
return nil, nil, fmt.Errorf("could not save validator shares: %w", err)
}
}
return toUpdate, updatedPubKeys, nil
}
// MalformedEventError is returned when event is malformed
type MalformedEventError struct {
Err error
}
func (e *MalformedEventError) Error() string {
return e.Err.Error()
}
func (e *MalformedEventError) Unwrap() error {
return e.Err
}