prysm-pulse/shared/database/database.go

// Package database defines a beacon chain DB service that can be
// initialized with either a persistent db, or an in-memory kv-store.
package database

import (
	"fmt"
	"path/filepath"

	"github.com/ethereum/go-ethereum/ethdb"
	"github.com/sirupsen/logrus"
)

var log = logrus.WithField("prefix", "db")

// DB defines a service for the beacon chain system's persistent storage.
type DB struct {
	_db ethdb.Database
}

// DBConfig specifies configuration options for the db service.
type DBConfig struct {
	DataDir  string
	Name     string
	InMemory bool
}

// NewDB initializes a beaconDB instance.
func NewDB(config *DBConfig) (*DB, error) {
	// Uses default cache and handles values.
	db := &DB{}
	if config.InMemory {
		db._db = NewKVStore()
		return db, nil
	}

	_db, err := ethdb.NewLDBDatabase(filepath.Join(config.DataDir, config.Name), 16, 16)
	if err != nil {
		log.Error(fmt.Sprintf("Could not start beaconDB: %v", err))
		return nil, err
	}
	db._db = _db

	return db, nil
}

// Close closes the database
func (b *DB) Close() {
	b._db.Close()
}

// DB returns the attached ethdb instance.
func (b *DB) DB() ethdb.Database {
	return b._db
}