package db import ( "errors" "os" "path" "sync" "time" "github.com/boltdb/bolt" pb "github.com/prysmaticlabs/prysm/proto/beacon/p2p/v1" "github.com/sirupsen/logrus" ) var log = logrus.WithField("prefix", "beacondb") // BeaconDB manages the data layer of the beacon chain implementation. // The exposed methods do not have an opinion of the underlying data engine, // but instead reflect the beacon chain logic. // For example, instead of defining get, put, remove // This defines methods such as getBlock, saveBlocksAndAttestations, etc. type BeaconDB struct { // state objects and caches stateLock sync.RWMutex serializedState []byte stateHash [32]byte validatorRegistry []*pb.Validator validatorBalances []uint64 db *bolt.DB DatabasePath string // Beacon block info in memory. highestBlockSlot uint64 // We keep a map of hashes of blocks which failed processing for blacklisting. badBlockHashes map[[32]byte]bool badBlocksLock sync.RWMutex blocks map[[32]byte]*pb.BeaconBlock blocksLock sync.RWMutex // Beacon chain deposits in memory. pendingDeposits []*depositContainer deposits []*depositContainer depositsLock sync.RWMutex chainstartPubkeys map[string]bool chainstartPubkeysLock sync.RWMutex } // Close closes the underlying boltdb database. func (db *BeaconDB) Close() error { return db.db.Close() } func (db *BeaconDB) update(fn func(*bolt.Tx) error) error { return db.db.Update(fn) } func (db *BeaconDB) batch(fn func(*bolt.Tx) error) error { return db.db.Batch(fn) } func (db *BeaconDB) view(fn func(*bolt.Tx) error) error { return db.db.View(fn) } func createBuckets(tx *bolt.Tx, buckets ...[]byte) error { for _, bucket := range buckets { if _, err := tx.CreateBucketIfNotExists(bucket); err != nil { return err } } return nil } // NewDB initializes a new DB. If the genesis block and states do not exist, this method creates it. func NewDB(dirPath string) (*BeaconDB, 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 } db := &BeaconDB{db: boltDB, DatabasePath: dirPath} db.blocks = make(map[[32]byte]*pb.BeaconBlock) if err := db.update(func(tx *bolt.Tx) error { return createBuckets(tx, blockBucket, attestationBucket, attestationTargetBucket, mainChainBucket, histStateBucket, chainInfoBucket, cleanupHistoryBucket, blockOperationsBucket, validatorBucket) }); err != nil { return nil, err } return db, err } // ClearDB removes the previously stored directory at the data directory. func ClearDB(dirPath string) error { if _, err := os.Stat(dirPath); os.IsNotExist(err) { return nil } return os.RemoveAll(dirPath) }