prysm-pulse/beacon-chain/db/kv/kv.go
Raul Jordan 6bd8ae8f67
Implement Validator DB Methods (#3172)
* begin db interface

* define the database interface

* interface definition simplifications

* include latest message proto

* modify pbs

* rem kv folder

* add filter interface

* lint

* ctx package is great

* interface getting better

* ctx everywhere...it's everywhere!

* block roots method

* new kv store initialization

* comments

* gaz

* implement interface

* refactor for proper naming conventions

* add todos

* proper comments

* rem unused

* add schema

* implementation simplicity

* has validator latest vote func impl

* retrieve validator latest vote

* has idx

* implement missing validator methods

* missing validator methods and test helpers

* validator index crud tests

* validator tests

* all buckets

* refactor with ok bool

* all tests passing, fmt, imports
2019-08-12 14:33:07 -05:00

67 lines
1.7 KiB
Go

package kv
import (
"os"
"path"
"time"
"github.com/boltdb/bolt"
"github.com/pkg/errors"
)
// Store defines an implementation of the Prysm Database interface
// using BoltDB as the underlying persistent kv-store for eth2.
type Store struct {
db *bolt.DB
DatabasePath string
}
// NewKVStore initializes a new boltDB key-value store at the directory
// path specified, creates the kv-buckets based on the schema, and stores
// an open connection db object as a property of the Store struct.
func NewKVStore(dirPath string) (*Store, error) {
if err := os.MkdirAll(dirPath, 0700); err != nil {
return nil, err
}
datafile := path.Join(dirPath, "beaconchain.db")
boltDB, err := bolt.Open(datafile, 0600, &bolt.Options{Timeout: 1 * time.Second})
if err != nil {
if err == bolt.ErrTimeout {
return nil, errors.New("cannot obtain database lock, database may be in use by another process")
}
return nil, err
}
kv := &Store{db: boltDB, DatabasePath: dirPath}
if err := kv.db.Update(func(tx *bolt.Tx) error {
return createBuckets(tx, validatorsBucket, attestationsBucket, blocksBucket, stateBucket)
}); err != nil {
return nil, err
}
return kv, err
}
// ClearDB removes the previously stored directory at the data directory.
func (k *Store) ClearDB() error {
if _, err := os.Stat(k.DatabasePath); os.IsNotExist(err) {
return nil
}
return os.RemoveAll(k.DatabasePath)
}
// Close closes the underlying BoltDB database.
func (k *Store) Close() error {
return k.db.Close()
}
func createBuckets(tx *bolt.Tx, buckets ...[]byte) error {
for _, bucket := range buckets {
if _, err := tx.CreateBucketIfNotExists(bucket); err != nil {
return err
}
}
return nil
}