Skip to content

Commit

Permalink
Attester proposer slashing store (#4315)
Browse files Browse the repository at this point in the history
* Merge branch 'master' of github.com:prysmaticlabs/prysm into update_validators

# Conflicts:
#	slasher/flags/flags.go
#	slasher/main.go
#	slasher/service/data_update.go
#	slasher/service/service.go
#	slasher/service/service_test.go

* proposal and attester store

* day to status

* comment change

* one bucket

* Merge branch 'master' of github.com:prysmaticlabs/prysm into attester_proposer_slashing_store
# Please enter a commit message to explain why this merge is necessary,
# especially if it merges an updated upstream into a topic branch.
#
# Lines starting with '#' will be ignored, and an empty message aborts
# the commit.

added comments

* comment

* typo fix

* raul review fix

* raul review fix full

* nishant feedback

* test fix

* fix tests and remove update gofmt goimports

* remove blank line in imports

* nishant fixes

* comment and fir delete proposer slashings

* avoid marshal twice

* remove space

* Update slasher/db/attester_slashings.go

Co-Authored-By: terence tsao <terence@prysmaticlabs.com>

* terence feedback

Co-authored-by: prylabs-bulldozer[bot] <58059840+prylabs-bulldozer[bot]@users.noreply.github.com>
Co-authored-by: terence tsao <terence@prysmaticlabs.com>
  • Loading branch information
3 people committed Jan 14, 2020
1 parent 62811e8 commit 0b35743
Show file tree
Hide file tree
Showing 7 changed files with 544 additions and 0 deletions.
5 changes: 5 additions & 0 deletions slasher/db/BUILD.bazel
Expand Up @@ -3,10 +3,12 @@ load("@io_bazel_rules_go//go:def.bzl", "go_library", "go_test")
go_library(
name = "go_default_library",
srcs = [
"attester_slashings.go",
"block_header.go",
"db.go",
"indexed_attestations.go",
"min_max_span.go",
"proposer_slashings.go",
"schema.go",
"setup_db.go",
"validator_id_pubkey.go",
Expand All @@ -16,6 +18,7 @@ go_library(
deps = [
"//proto/slashing:go_default_library",
"//shared/bytesutil:go_default_library",
"//shared/hashutil:go_default_library",
"//shared/params:go_default_library",
"@com_github_boltdb_bolt//:go_default_library",
"@com_github_gogo_protobuf//proto:go_default_library",
Expand All @@ -29,9 +32,11 @@ go_library(
go_test(
name = "go_default_test",
srcs = [
"attester_slashings_test.go",
"block_header_test.go",
"indexed_attestations_test.go",
"min_max_span_test.go",
"proposer_slashings_test.go",
"setup_db_test.go",
"validator_id_pubkey_test.go",
],
Expand Down
114 changes: 114 additions & 0 deletions slasher/db/attester_slashings.go
@@ -0,0 +1,114 @@
package db

import (
"bytes"

"github.com/boltdb/bolt"
"github.com/gogo/protobuf/proto"
"github.com/pkg/errors"
ethpb "github.com/prysmaticlabs/ethereumapis/eth/v1alpha1"
"github.com/prysmaticlabs/prysm/shared/hashutil"
)

func createAttesterSlashing(enc []byte) (*ethpb.AttesterSlashing, error) {
protoSlashing := &ethpb.AttesterSlashing{}
err := proto.Unmarshal(enc, protoSlashing)
if err != nil {
return nil, errors.Wrap(err, "failed to unmarshal encoding")
}
return protoSlashing, nil
}

func toAttesterSlashings(encoded [][]byte) ([]*ethpb.AttesterSlashing, error) {
attesterSlashings := make([]*ethpb.AttesterSlashing, len(encoded))
for i, enc := range encoded {
ps, err := createAttesterSlashing(enc)
if err != nil {
return nil, err
}
attesterSlashings[i] = ps
}
return attesterSlashings, nil
}

// AttesterSlashings accepts a status and returns all slashings with this status.
// returns empty []*ethpb.AttesterSlashing if no slashing has been found with this status.
func (db *Store) AttesterSlashings(status SlashingStatus) ([]*ethpb.AttesterSlashing, error) {
encoded := make([][]byte, 0)
err := db.view(func(tx *bolt.Tx) error {
c := tx.Bucket(slashingBucket).Cursor()
prefix := encodeType(SlashingType(Attestation))
for k, v := c.Seek(prefix); k != nil && bytes.HasPrefix(k, prefix); k, v = c.Next() {
if v[0] == byte(status) {
encoded = append(encoded, v[1:])
}
}
return nil
})
if err != nil {
return nil, err
}
return toAttesterSlashings(encoded)
}

// DeleteAttesterSlashing deletes an attester slashing proof from db.
func (db *Store) DeleteAttesterSlashing(attesterSlashing *ethpb.AttesterSlashing) error {
root, err := hashutil.HashProto(attesterSlashing)
if err != nil {
return errors.Wrap(err, "failed to get hash root of attesterSlashing")
}
return db.update(func(tx *bolt.Tx) error {
bucket := tx.Bucket(slashingBucket)
k := encodeTypeRoot(SlashingType(Attestation), root)
if err != nil {
return errors.Wrap(err, "failed to get key for for attester slashing.")
}
if err := bucket.Delete(k); err != nil {
return errors.Wrap(err, "failed to delete the slashing proof from slashing bucket")
}
return nil
})
}

// HasAttesterSlashing returns true and slashing status if slashing is found in 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)
if err != nil {
return found, status, errors.Wrap(err, "failed to get hash root of attesterSlashing")
}
err = db.view(func(tx *bolt.Tx) error {
b := tx.Bucket(slashingBucket)
enc := b.Get(key)
if enc != nil {
found = true
status = SlashingStatus(enc[0])
}
return nil
})
return found, status, err
}

// SaveAttesterSlashing accepts a slashing proof and its status and writes it to disk.
func (db *Store) SaveAttesterSlashing(status SlashingStatus, slashing *ethpb.AttesterSlashing) error {
enc, err := proto.Marshal(slashing)
if err != nil {
return errors.Wrap(err, "failed to marshal")
}
root := hashutil.Hash(enc)
key := encodeTypeRoot(SlashingType(Attestation), root)
err = db.update(func(tx *bolt.Tx) error {
b := tx.Bucket(slashingBucket)
e := b.Put(key, append([]byte{byte(status)}, enc...))
if e != nil {
return nil
}
return err
})
if err != nil {
return err
}
return err
}
124 changes: 124 additions & 0 deletions slasher/db/attester_slashings_test.go
@@ -0,0 +1,124 @@
package db

import (
"reflect"
"testing"

ethpb "github.com/prysmaticlabs/ethereumapis/eth/v1alpha1"
)

func TestStore_AttesterSlashingNilBucket(t *testing.T) {
db := SetupSlasherDB(t)
defer TeardownSlasherDB(t, db)
as := &ethpb.AttesterSlashing{Attestation_1: &ethpb.IndexedAttestation{Signature: []byte("hello")}}
has, _, err := db.HasAttesterSlashing(as)
if err != nil {
t.Fatalf("HasAttesterSlashing should not return error: %v", err)
}
if has {
t.Fatal("HasAttesterSlashing should return false")
}

p, err := db.AttesterSlashings(SlashingStatus(Active))
if err != nil {
t.Fatalf("failed to get attester slashing: %v", err)
}
if p == nil || len(p) != 0 {
t.Fatalf("get should return empty attester slashing array for a non existent key")
}
}

func TestStore_SaveAttesterSlashing(t *testing.T) {
db := SetupSlasherDB(t)
defer TeardownSlasherDB(t, db)
tests := []struct {
ss SlashingStatus
as *ethpb.AttesterSlashing
}{
{
ss: Active,
as: &ethpb.AttesterSlashing{Attestation_1: &ethpb.IndexedAttestation{Signature: []byte("hello")}},
},
{
ss: Included,
as: &ethpb.AttesterSlashing{Attestation_1: &ethpb.IndexedAttestation{Signature: []byte("hello2")}},
},
{
ss: Reverted,
as: &ethpb.AttesterSlashing{Attestation_1: &ethpb.IndexedAttestation{Signature: []byte("hello3")}},
},
}

for _, tt := range tests {
err := db.SaveAttesterSlashing(tt.ss, tt.as)
if err != nil {
t.Fatalf("save attester slashing failed: %v", err)
}

attesterSlashings, err := db.AttesterSlashings(tt.ss)
if err != nil {
t.Fatalf("failed to get attester slashings: %v", err)
}

if attesterSlashings == nil || !reflect.DeepEqual(attesterSlashings[0], tt.as) {
t.Fatalf("attester slashing: %v should be part of attester slashings response: %v", tt.as, attesterSlashings)
}
}

}

func TestStore_UpdateAttesterSlashingStatus(t *testing.T) {
db := SetupSlasherDB(t)
defer TeardownSlasherDB(t, db)
tests := []struct {
ss SlashingStatus
as *ethpb.AttesterSlashing
}{
{
ss: Active,
as: &ethpb.AttesterSlashing{Attestation_1: &ethpb.IndexedAttestation{Signature: []byte("hello")}},
},
{
ss: Active,
as: &ethpb.AttesterSlashing{Attestation_1: &ethpb.IndexedAttestation{Signature: []byte("hello2")}},
},
{
ss: Active,
as: &ethpb.AttesterSlashing{Attestation_1: &ethpb.IndexedAttestation{Signature: []byte("hello3")}},
},
}

for _, tt := range tests {
err := db.SaveAttesterSlashing(tt.ss, tt.as)
if err != nil {
t.Fatalf("save attester slashing failed: %v", err)
}
}

for _, tt := range tests {
has, st, err := db.HasAttesterSlashing(tt.as)
if err != nil {
t.Fatalf("failed to get attester slashing: %v", err)
}
if !has {
t.Fatalf("failed to find attester slashing: %v", tt.as)
}
if st != tt.ss {
t.Fatalf("failed to find attester slashing with the correct status: %v", tt.as)
}

err = db.SaveAttesterSlashing(SlashingStatus(Included), tt.as)
has, st, err = db.HasAttesterSlashing(tt.as)
if err != nil {
t.Fatalf("failed to get attester slashing: %v", err)
}
if !has {
t.Fatalf("failed to find attester slashing: %v", tt.as)
}
if st != Included {
t.Fatalf("failed to find attester slashing with the correct status: %v", tt.as)
}

}

}
1 change: 1 addition & 0 deletions slasher/db/db.go
Expand Up @@ -87,6 +87,7 @@ func NewKVStore(dirPath string) (*Store, error) {
indexedAttestationsIndicesBucket,
validatorsPublicKeysBucket,
validatorsMinMaxSpanBucket,
slashingBucket,
)
}); err != nil {
return nil, err
Expand Down

0 comments on commit 0b35743

Please sign in to comment.