prysm-pulse/beacon-chain/db/kv/state_summary.go
Ivan Martinez d9fea7cb8c
[QSP] Deduplicate functions for audit best practices (#6476)
* Deduplicate DB functions and getters

* Rename function

* Reduce to prestons suggestions

* Fix bug

* Fix

* Start changing state db funcs

* Fix tests

* Change return

* Add checks

* Fix test

* Fix

* Nishant comment

* Fix

* Fix

* Fix

* Fix

Co-authored-by: prylabs-bulldozer[bot] <58059840+prylabs-bulldozer[bot]@users.noreply.github.com>
2020-07-07 11:29:25 -05:00

81 lines
2.1 KiB
Go

package kv
import (
"context"
pb "github.com/prysmaticlabs/prysm/proto/beacon/p2p/v1"
bolt "go.etcd.io/bbolt"
"go.opencensus.io/trace"
)
// SaveStateSummary saves a state summary object to the DB.
func (kv *Store) SaveStateSummary(ctx context.Context, summary *pb.StateSummary) error {
ctx, span := trace.StartSpan(ctx, "BeaconDB.SaveStateSummary")
defer span.End()
return kv.SaveStateSummaries(ctx, []*pb.StateSummary{summary})
}
// SaveStateSummaries saves state summary objects to the DB.
func (kv *Store) SaveStateSummaries(ctx context.Context, summaries []*pb.StateSummary) error {
ctx, span := trace.StartSpan(ctx, "BeaconDB.SaveStateSummaries")
defer span.End()
return kv.db.Update(func(tx *bolt.Tx) error {
bucket := tx.Bucket(stateSummaryBucket)
for _, summary := range summaries {
enc, err := encode(ctx, summary)
if err != nil {
return err
}
if err := bucket.Put(summary.Root, enc); err != nil {
return err
}
}
return nil
})
}
// StateSummary returns the state summary object from the db using input block root.
func (kv *Store) StateSummary(ctx context.Context, blockRoot [32]byte) (*pb.StateSummary, error) {
ctx, span := trace.StartSpan(ctx, "BeaconDB.StateSummary")
defer span.End()
enc, err := kv.stateSummaryBytes(ctx, blockRoot)
if err != nil {
return nil, err
}
if len(enc) == 0 {
return nil, nil
}
summary := &pb.StateSummary{}
if err := decode(ctx, enc, summary); err != nil {
return nil, err
}
return summary, nil
}
// HasStateSummary returns true if a state summary exists in DB.
func (kv *Store) HasStateSummary(ctx context.Context, blockRoot [32]byte) bool {
ctx, span := trace.StartSpan(ctx, "BeaconDB.HasStateSummary")
defer span.End()
enc, err := kv.stateSummaryBytes(ctx, blockRoot)
if err != nil {
panic(err)
}
return len(enc) > 0
}
func (kv *Store) stateSummaryBytes(ctx context.Context, blockRoot [32]byte) ([]byte, error) {
ctx, span := trace.StartSpan(ctx, "BeaconDB.stateSummaryBytes")
defer span.End()
var enc []byte
err := kv.db.View(func(tx *bolt.Tx) error {
bucket := tx.Bucket(stateSummaryBucket)
enc = bucket.Get(blockRoot[:])
return nil
})
return enc, err
}