2019-08-11 00:50:10 +00:00
|
|
|
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
|
2019-08-15 21:41:51 +00:00
|
|
|
databasePath string
|
2019-08-11 00:50:10 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// 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
|
|
|
|
}
|
|
|
|
|
2019-08-15 21:41:51 +00:00
|
|
|
kv := &Store{db: boltDB, databasePath: dirPath}
|
2019-08-11 00:50:10 +00:00
|
|
|
|
|
|
|
if err := kv.db.Update(func(tx *bolt.Tx) error {
|
2019-08-12 19:33:07 +00:00
|
|
|
return createBuckets(tx, validatorsBucket, attestationsBucket, blocksBucket, stateBucket)
|
2019-08-11 00:50:10 +00:00
|
|
|
}); err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
|
|
|
|
return kv, err
|
|
|
|
}
|
|
|
|
|
|
|
|
// ClearDB removes the previously stored directory at the data directory.
|
|
|
|
func (k *Store) ClearDB() error {
|
2019-08-15 21:41:51 +00:00
|
|
|
if _, err := os.Stat(k.databasePath); os.IsNotExist(err) {
|
2019-08-11 00:50:10 +00:00
|
|
|
return nil
|
|
|
|
}
|
2019-08-15 21:41:51 +00:00
|
|
|
return os.RemoveAll(k.databasePath)
|
2019-08-11 00:50:10 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// Close closes the underlying BoltDB database.
|
|
|
|
func (k *Store) Close() error {
|
|
|
|
return k.db.Close()
|
|
|
|
}
|
2019-08-12 19:33:07 +00:00
|
|
|
|
2019-08-15 21:41:51 +00:00
|
|
|
// DatabasePath at which this database writes files.
|
|
|
|
func (k *Store) DatabasePath() string {
|
|
|
|
return k.databasePath
|
|
|
|
}
|
|
|
|
|
2019-08-12 19:33:07 +00:00
|
|
|
func createBuckets(tx *bolt.Tx, buckets ...[]byte) error {
|
|
|
|
for _, bucket := range buckets {
|
|
|
|
if _, err := tx.CreateBucketIfNotExists(bucket); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return nil
|
|
|
|
}
|