storage

Documentation

Overview

Package storage contains low level interfaces and common structures for concrete ledger storage engine implementations

Index

• Variables
• type Store

Variables

var (
	// ErrNotFound returns if record/index not found in storage.
	ErrNotFound = errors.New("storage object not found")
)

Types

type Store

type Store interface {
	// SetCurrentPulse stores current pulse number in memory.
	SetCurrentPulse(record.PulseNum)
	// GetCurrentPulse returns current pulse number.
	GetCurrentPulse() record.PulseNum

	GetRecord(*record.Reference) (record.Record, error)
	SetRecord(record.Record) (*record.Reference, error)

	GetClassIndex(*record.Reference) (*index.ClassLifeline, error)
	SetClassIndex(*record.Reference, *index.ClassLifeline) error

	GetObjectIndex(*record.Reference) (*index.ObjectLifeline, error)
	SetObjectIndex(*record.Reference, *index.ObjectLifeline) error

	// GetDrop return Jet's drop by pulse number.
	GetDrop(record.PulseNum) (*jetdrop.JetDrop, error)
	// SetDrop gets previous JetDrop, saves and returns the new one
	// for provided PulseNum.
	SetDrop(record.PulseNum, *jetdrop.JetDrop) (*jetdrop.JetDrop, error)

	// SetEntropy stores given entropy for given pulse in storage.
	//
	// Entropy is used for calculating node roles.
	SetEntropy(record.PulseNum, []byte) error

	// GetEntropy returns entropy from storage for given pulse.
	//
	// Entropy is used for calculating node roles.
	GetEntropy(record.PulseNum) ([]byte, error)
}

Store represents append-only Ledger storage.