blockdb

Documentation

Overview

Package blockdb provides read/write access to an on-disk block database. blockdb uses Bolt as its underlying database, but this is subject to change.

Index

• Variables
• type DB
  • func Open(filename string) (DB, error)

Variables

var (
	ErrUnknownBlock = errors.New("unknown block")
)

var NilDB nildb

NilDB is a db whose methods are no-ops. Calls to Block will return the zero value of types.Block. Calls to Height will return 0.

Types

type DB

type DB interface {
	Block(types.BlockHeight) (types.Block, error)
	AddBlock(types.Block) error
	RemoveBlock() error
	Height() (types.BlockHeight, error)
	Close() error
}

A DB is a block database. Right now it is equivalent to a []Block.

func Open

func Open(filename string) (DB, error)

Open returns a database ready for use. If the database file does not exist, it will be created. Only one view of a given database file should be open at any one time.