Cleanup slasher codebase (#4698)

* First wave of changes
* More changes
* More renames, changes
* Fix errors
* Merge branch 'master' of https://github.com/prysmaticlabs/Prysm into cleanup-slasher
* Fix errors, more cleaning
* Merge branch 'master' of https://github.com/prysmaticlabs/Prysm into cleanup-slasher
* Merge branch 'master' into cleanup-slasher
* fix err
* Merge branch 'cleanup-slasher' of https://github.com/0xKiwi/Prysm into cleanup-slasher
* Fix strings
* More cleanup
* Merge branch 'master' of https://github.com/prysmaticlabs/Prysm into cleanup-slasher
* Fix interface
* Fix
* Merge branch 'master' into cleanup-slasher
* Merge branch 'master' into cleanup-slasher
* Merge branch 'master' into cleanup-slasher
* Address comments
* Merge branch 'master' of https://github.com/prysmaticlabs/Prysm into cleanup-slasher
* Merge branch 'cleanup-slasher' of https://github.com/0xKiwi/Prysm into cleanup-slasher

slasher/db/attester_slashings.go

@@ -11,7 +11,7 @@ import (
 	"github.com/prysmaticlabs/prysm/shared/hashutil"
 )
 
-func createAttesterSlashing(enc []byte) (*ethpb.AttesterSlashing, error) {
+func unmarshalAttSlashing(enc []byte) (*ethpb.AttesterSlashing, error) {
 	protoSlashing := &ethpb.AttesterSlashing{}
 	err := proto.Unmarshal(enc, protoSlashing)
 	if err != nil {
@@ -20,10 +20,10 @@ func createAttesterSlashing(enc []byte) (*ethpb.AttesterSlashing, error) {
 	return protoSlashing, nil
 }
 
-func toAttesterSlashings(encoded [][]byte) ([]*ethpb.AttesterSlashing, error) {
+func unmarshalAttSlashings(encoded [][]byte) ([]*ethpb.AttesterSlashing, error) {
 	attesterSlashings := make([]*ethpb.AttesterSlashing, len(encoded))
 	for i, enc := range encoded {
-		ps, err := createAttesterSlashing(enc)
+		ps, err := unmarshalAttSlashing(enc)
 		if err != nil {
 			return nil, err
 		}
@@ -49,7 +49,7 @@ func (db *Store) AttesterSlashings(status SlashingStatus) ([]*ethpb.AttesterSlas
 	if err != nil {
 		return nil, err
 	}
-	return toAttesterSlashings(encoded)
+	return unmarshalAttSlashings(encoded)
 }
 
 // DeleteAttesterSlashing deletes an attester slashing proof from db.
@@ -71,15 +71,15 @@ func (db *Store) DeleteAttesterSlashing(attesterSlashing *ethpb.AttesterSlashing
 	})
 }
 
-// HasAttesterSlashing returns true and slashing status if slashing is found in db.
+// HasAttesterSlashing returns true and slashing status if a slashing is found in the db.
 func (db *Store) HasAttesterSlashing(slashing *ethpb.AttesterSlashing) (bool, SlashingStatus, error) {
-	root, err := hashutil.HashProto(slashing)
 	var status SlashingStatus
 	var found bool
-	key := encodeTypeRoot(SlashingType(Attestation), root)
+	root, err := hashutil.HashProto(slashing)
 	if err != nil {
 		return found, status, errors.Wrap(err, "failed to get hash root of attesterSlashing")
 	}
+	key := encodeTypeRoot(SlashingType(Attestation), root)
 	err = db.view(func(tx *bolt.Tx) error {
 		b := tx.Bucket(slashingBucket)
 		enc := b.Get(key)
@@ -117,9 +117,10 @@ func (db *Store) SaveAttesterSlashings(status SlashingStatus, slashings []*ethpb
 		if err != nil {
 			return errors.Wrap(err, "failed to marshal")
 		}
-		root := hashutil.Hash(enc[i])
-		key[i] = encodeTypeRoot(SlashingType(Attestation), root)
+		encHash := hashutil.Hash(enc[i])
+		key[i] = encodeTypeRoot(SlashingType(Attestation), encHash)
 	}
+
 	return db.update(func(tx *bolt.Tx) error {
 		b := tx.Bucket(slashingBucket)
 		for i := 0; i < len(enc); i++ {

slasher/db/block_header.go

@@ -11,7 +11,7 @@ import (
 	"github.com/prysmaticlabs/prysm/shared/params"
 )
 
-func createBlockHeader(enc []byte) (*ethpb.SignedBeaconBlockHeader, error) {
+func unmarshalBlockHeader(enc []byte) (*ethpb.SignedBeaconBlockHeader, error) {
 	protoBlockHeader := &ethpb.SignedBeaconBlockHeader{}
 	err := proto.Unmarshal(enc, protoBlockHeader)
 	if err != nil {
@@ -28,7 +28,7 @@ func (db *Store) BlockHeader(epoch uint64, validatorID uint64) ([]*ethpb.SignedB
 		c := tx.Bucket(historicBlockHeadersBucket).Cursor()
 		prefix := encodeEpochValidatorID(epoch, validatorID)
 		for k, v := c.Seek(prefix); k != nil && bytes.HasPrefix(k, prefix); k, v = c.Next() {
-			bh, err := createBlockHeader(v)
+			bh, err := unmarshalBlockHeader(v)
 			if err != nil {
 				return err
 			}
@@ -68,35 +68,34 @@ func (db *Store) SaveBlockHeader(epoch uint64, validatorID uint64, blockHeader *
 	err = db.update(func(tx *bolt.Tx) error {
 		bucket := tx.Bucket(historicBlockHeadersBucket)
 		if err := bucket.Put(key, enc); err != nil {
-			return errors.Wrap(err, "failed to include the block header in the historic block header bucket")
+			return errors.Wrap(err, "failed to include block header in the historical bucket")
 		}
 
 		return err
 	})
 
-	// prune history to max size every 10th epoch
+	// Prune block header history every 10th epoch.
 	if epoch%params.BeaconConfig().PruneSlasherStoragePeriod == 0 {
-		err = db.PruneHistory(epoch, params.BeaconConfig().WeakSubjectivityPeriod)
+		err = db.pruneBlockHistory(epoch, params.BeaconConfig().WeakSubjectivityPeriod)
 	}
 	return err
 }
 
 // DeleteBlockHeader deletes a block header using the epoch and validator id.
 func (db *Store) DeleteBlockHeader(epoch uint64, validatorID uint64, blockHeader *ethpb.SignedBeaconBlockHeader) error {
-
 	key := encodeEpochValidatorIDSig(epoch, validatorID, blockHeader.Signature)
 
 	return db.update(func(tx *bolt.Tx) error {
 		bucket := tx.Bucket(historicBlockHeadersBucket)
 		if err := bucket.Delete(key); err != nil {
-			return errors.Wrap(err, "failed to delete the block header from historic block header bucket")
+			return errors.Wrap(err, "failed to delete the block header from historical bucket")
 		}
 		return bucket.Delete(key)
 	})
 }
 
-// PruneHistory leaves only records younger then history size.
-func (db *Store) PruneHistory(currentEpoch uint64, historySize uint64) error {
+// pruneBlockHistory leaves only records younger then history size.
+func (db *Store) pruneBlockHistory(currentEpoch uint64, historySize uint64) error {
 	pruneTill := int64(currentEpoch) - int64(historySize)
 	if pruneTill <= 0 {
 		return nil
@@ -106,7 +105,7 @@ func (db *Store) PruneHistory(currentEpoch uint64, historySize uint64) error {
 		c := tx.Bucket(historicBlockHeadersBucket).Cursor()
 		for k, _ := c.First(); k != nil && bytesutil.FromBytes8(k[:8]) <= uint64(pruneTill); k, _ = c.Next() {
 			if err := bucket.Delete(k); err != nil {
-				return errors.Wrap(err, "failed to delete the block header from historic block header bucket")
+				return errors.Wrap(err, "failed to delete the block header from historical bucket")
 			}
 		}
 		return nil

slasher/db/block_header_test.go

@@ -247,7 +247,7 @@ func TestPruneHistoryBlkHdr(t *testing.T) {
 	}
 	currentEpoch := uint64(3)
 	historyToKeep := uint64(2)
-	err := db.PruneHistory(currentEpoch, historyToKeep)
+	err := db.pruneBlockHistory(currentEpoch, historyToKeep)
 	if err != nil {
 		t.Fatalf("failed to prune: %v", err)
 	}