blocks

Documentation

Index

• type BlockWithRoot
  • func WithRoot(spec *beacon.Spec, block *beacon.SignedBeaconBlock) *BlockWithRoot
• type DB
• type DBID
• type DBMap
  • func (dbm *DBMap) Create(id DBID, path string, spec *beacon.Spec) (db DB, err error)
  • func (dbm *DBMap) Find(id DBID) (db DB, ok bool)
  • func (dbm *DBMap) List() (out []DBID)
  • func (dbm *DBMap) Remove(id DBID) (existed bool)
• type DBStats
• type DBs
• type FileDB
  • func (db *FileDB) Export(root beacon.Root, w io.Writer) (exists bool, err error)
  • func (db *FileDB) Get(root beacon.Root, dest *beacon.SignedBeaconBlock) (exists bool, err error)
  • func (db *FileDB) Import(r io.Reader) (exists bool, err error)
  • func (db *FileDB) List() (out []beacon.Root)
  • func (db *FileDB) Path() string
  • func (db *FileDB) Remove(root beacon.Root) (exists bool, err error)
  • func (db *FileDB) Size(root beacon.Root) (size uint64, exists bool)
  • func (db *FileDB) Spec() *beacon.Spec
  • func (db *FileDB) Stats() DBStats
  • func (db *FileDB) Store(ctx context.Context, block *BlockWithRoot) (exists bool, err error)
  • func (db *FileDB) Stream(root beacon.Root) (r io.ReadCloser, size uint64, exists bool, err error)
• type MemDB
  • func (db *MemDB) Export(root beacon.Root, w io.Writer) (exists bool, err error)
  • func (db *MemDB) Get(root beacon.Root, dest *beacon.SignedBeaconBlock) (exists bool, err error)
  • func (db *MemDB) Import(r io.Reader) (exists bool, err error)
  • func (db *MemDB) List() (out []beacon.Root)
  • func (db *MemDB) Path() string
  • func (db *MemDB) Remove(root beacon.Root) (exists bool, err error)
  • func (db *MemDB) Size(root beacon.Root) (size uint64, exists bool)
  • func (db *MemDB) Spec() *beacon.Spec
  • func (db *MemDB) Stats() DBStats
  • func (db *MemDB) Store(ctx context.Context, block *BlockWithRoot) (exists bool, err error)
  • func (db *MemDB) Stream(root beacon.Root) (r io.ReadCloser, size uint64, exists bool, err error)

Types

type BlockWithRoot

type BlockWithRoot struct {
	// Root of the Block.Message
	Root beacon.Root
	// Block, with signature
	Block *beacon.SignedBeaconBlock
}

func WithRoot

func WithRoot(spec *beacon.Spec, block *beacon.SignedBeaconBlock) *BlockWithRoot

type DB

type DB interface {
	// Store, only for trusted blocks, to persist a block in the DB.
	// The block is stored in serialized form, so the original instance may be mutated after storing it.
	// This is an efficient convenience method for using Import.
	// Returns exists=true if the block exists (previously), false otherwise. If error, it may not be accurate.
	// Returns slashable=true if exists=true, but the signatures are different. The existing block is kept.
	Store(ctx context.Context, block *BlockWithRoot) (exists bool, err error)
	// Import inserts a SignedBeaconBlock, read directly from the reader stream.
	// Returns exists=true if the block exists (previously), false otherwise. If error, it may not be accurate.
	// Returns slashable=true if exists=true, but the signatures are different. The existing block is kept.
	Import(r io.Reader) (exists bool, err error)
	// Get, an efficient convenience method for getting a block through Export. The block is safe to modify.
	// The data at the pointer is mutated to the new block.
	// Returns exists=true if the block exists, false otherwise. If error, it may not be accurate.
	Get(root beacon.Root, dest *beacon.SignedBeaconBlock) (exists bool, err error)
	// Size quickly checks the size of a block, without dealing with the full block.
	// Returns exists=true if the block exists, false otherwise. If error, it may not be accurate.
	Size(root beacon.Root) (size uint64, exists bool)
	// Export outputs the requested SignedBeaconBlock to the writer in SSZ.
	// Returns exists=true if the block exists, false otherwise. If error, it may not be accurate.
	Export(root beacon.Root, w io.Writer) (exists bool, err error)
	// Stream is used to stream the contents by getting a reader and total size to read
	Stream(root beacon.Root) (r io.ReadCloser, size uint64, exists bool, err error)
	// Remove removes a block from the DB. Removing a block that does not exist is safe.
	// Returns exists=true if the block exists (previously), false otherwise. If error, it may not be accurate.
	Remove(root beacon.Root) (exists bool, err error)
	// Stats shows some database statistics such as latest write key and entry count.
	Stats() DBStats
	// List all known block roots
	List() []beacon.Root
	// Get Path
	Path() string
	// Spec of states
	Spec() *beacon.Spec
}

type DBID

type DBID string

type DBMap

type DBMap struct {
	// contains filtered or unexported fields
}

func (*DBMap) Create

func (dbm *DBMap) Create(id DBID, path string, spec *beacon.Spec) (db DB, err error)

func (*DBMap) Find

func (dbm *DBMap) Find(id DBID) (db DB, ok bool)

func (*DBMap) List

func (dbm *DBMap) List() (out []DBID)

func (*DBMap) Remove

func (dbm *DBMap) Remove(id DBID) (existed bool)

type DBStats

type DBStats struct {
	Count     int64
	LastWrite beacon.Root
}

type DBs

type DBs interface {
	Find(id DBID) (db DB, ok bool)
	// Create a new database. An empty path creates a memory DB.
	Create(id DBID, path string, spec *beacon.Spec) (db DB, err error)
	Remove(id DBID) (existed bool)
	List() []DBID
}

type FileDB

type FileDB struct {
	BasePath string
	// contains filtered or unexported fields
}

func (*FileDB) Export

func (db *FileDB) Export(root beacon.Root, w io.Writer) (exists bool, err error)

func (*FileDB) Get

func (db *FileDB) Get(root beacon.Root, dest *beacon.SignedBeaconBlock) (exists bool, err error)

func (*FileDB) Import

func (db *FileDB) Import(r io.Reader) (exists bool, err error)

func (*FileDB) List

func (db *FileDB) List() (out []beacon.Root)

func (*FileDB) Path

func (db *FileDB) Path() string

func (*FileDB) Remove

func (db *FileDB) Remove(root beacon.Root) (exists bool, err error)

func (*FileDB) Size

func (db *FileDB) Size(root beacon.Root) (size uint64, exists bool)

func (*FileDB) Spec

func (db *FileDB) Spec() *beacon.Spec

func (*FileDB) Stats

func (db *FileDB) Stats() DBStats

func (*FileDB) Store

func (db *FileDB) Store(ctx context.Context, block *BlockWithRoot) (exists bool, err error)

func (*FileDB) Stream

func (db *FileDB) Stream(root beacon.Root) (r io.ReadCloser, size uint64, exists bool, err error)

type MemDB

type MemDB struct {
	// contains filtered or unexported fields
}

func (*MemDB) Export

func (db *MemDB) Export(root beacon.Root, w io.Writer) (exists bool, err error)

func (*MemDB) Get

func (db *MemDB) Get(root beacon.Root, dest *beacon.SignedBeaconBlock) (exists bool, err error)

func (*MemDB) Import

func (db *MemDB) Import(r io.Reader) (exists bool, err error)

func (*MemDB) List

func (db *MemDB) List() (out []beacon.Root)

func (*MemDB) Path

func (db *MemDB) Path() string

func (*MemDB) Remove

func (db *MemDB) Remove(root beacon.Root) (exists bool, err error)

func (*MemDB) Size

func (db *MemDB) Size(root beacon.Root) (size uint64, exists bool)

func (*MemDB) Spec

func (db *MemDB) Spec() *beacon.Spec

func (*MemDB) Stats

func (db *MemDB) Stats() DBStats

func (*MemDB) Store

func (db *MemDB) Store(ctx context.Context, block *BlockWithRoot) (exists bool, err error)

func (*MemDB) Stream

func (db *MemDB) Stream(root beacon.Root) (r io.ReadCloser, size uint64, exists bool, err error)