kv

Documentation

Index

• Constants
• Variables
• type Config
• type Store
  • func NewKVStore(ctx context.Context, dirPath string, config *Config) (*Store, error)
  • func (s *Store) ClearDB() error
  • func (s *Store) Close() error
  • func (s *Store) ConsensusInfo(ctx context.Context, epoch uint64) (*eventTypes.MinimalEpochConsensusInfo, error)
  • func (s *Store) ConsensusInfos(fromEpoch uint64) ([]*eventTypes.MinimalEpochConsensusInfo, error)
  • func (s *Store) DatabasePath() string
  • func (s *Store) GetLatestEpoch() uint64
  • func (s *Store) GetLatestHeaderHash() common.Hash
  • func (s *Store) LatestSavedEpoch() uint64
  • func (s *Store) LatestSavedPandoraHeaderHash() common.Hash
  • func (s *Store) LatestSavedPandoraSlot() uint64
  • func (s *Store) LatestSavedVanguardHeaderHash() (hash common.Hash)
  • func (s *Store) LatestSavedVanguardSlot() (latestSlot uint64)
  • func (s *Store) LatestVerifiedRealmSlot() (slot uint64)
  • func (s *Store) PandoraHeaderHash(slot uint64) (*types.HeaderHash, error)
  • func (s *Store) PandoraHeaderHashes(fromSlot uint64, limit uint64) ([]*types.HeaderHash, error)
  • func (s *Store) SaveConsensusInfo(ctx context.Context, consensusInfo *eventTypes.MinimalEpochConsensusInfo) error
  • func (s *Store) SaveLatestEpoch(ctx context.Context) error
  • func (s *Store) SaveLatestPandoraHeaderHash() error
  • func (s *Store) SaveLatestPandoraSlot() error
  • func (s *Store) SaveLatestVanguardHeaderHash() (err error)
  • func (s *Store) SaveLatestVanguardSlot() (err error)
  • func (s *Store) SaveLatestVerifiedRealmSlot(slot uint64) (err error)
  • func (s *Store) SavePandoraHeaderHash(slot uint64, headerHash *types.HeaderHash) error
  • func (s *Store) SaveVanguardHeaderHash(slot uint64, headerHash *types.HeaderHash) (err error)
  • func (s *Store) VanguardHeaderHash(slot uint64) (headerHash *types.HeaderHash, err error)
  • func (s *Store) VanguardHeaderHashes(fromSlot uint64, limit uint64) (vanguardHeaderHashes []*types.HeaderHash, err error)

Constants

const (
	// ConsensusInfosCacheSize with 1024 consensus infos will be 1.5MB.
	ConsensusInfosCacheSize = 1 << 10
	// HeaderHashesCacheSize with
	HeaderHashesCacheSize = 1 << 20
	// OrchestratorNodeDbDirName is the name of the directory containing the orchestrator node database.
	OrchestratorNodeDbDirName = "orchestrator"
	// DatabaseFileName is the name of the orchestrator node database.
	DatabaseFileName = "orchestrator.db"
)

Variables

var (
	EmptyHash                = common.HexToHash("0000000000000000000000000000000000000000000000000000000000000000")
	InvalidExtraDataErr      = errors.New("Invalid extra data")
	InvalidSlot              = errors.New("Invalid slot")
	PandoraHeaderNotFoundErr = errors.New("Pandora header not found")
)

var (
	VanguardHeaderNotFoundErr = errors.New("Vanguard header not found")
)

Types

type Config

type Config struct {
	InitialMMapSize int
}

Config for the bolt db kv store.

type Store

type Store struct {

	// There should be mutex in store
	sync.Mutex
	// contains filtered or unexported fields
}

func NewKVStore

func NewKVStore(ctx context.Context, dirPath string, config *Config) (*Store, error)

NewKVStore initializes a new boltDB key-value store at the directory path specified, creates the kv-buckets based on the schema, and stores an open connection db object as a property of the Store struct.

func (*Store) ClearDB

func (s *Store) ClearDB() error

ClearDB removes the previously stored database in the data directory.

func (*Store) Close

func (s *Store) Close() error

Close closes the underlying BoltDB database.

func (*Store) ConsensusInfo

func (s *Store) ConsensusInfo(ctx context.Context, epoch uint64) (*eventTypes.MinimalEpochConsensusInfo, error)

ConsensusInfo

func (*Store) ConsensusInfos

func (s *Store) ConsensusInfos(fromEpoch uint64) (
	[]*eventTypes.MinimalEpochConsensusInfo, error,
)

ConsensusInfos

func (*Store) DatabasePath

func (s *Store) DatabasePath() string

DatabasePath at which this database writes files.

func (*Store) GetLatestEpoch

func (s *Store) GetLatestEpoch() uint64

GetLatestHeaderHash

func (*Store) GetLatestHeaderHash

func (s *Store) GetLatestHeaderHash() common.Hash

GetLatestHeaderHash

func (*Store) LatestSavedEpoch

func (s *Store) LatestSavedEpoch() uint64

LatestSavedEpoch

func (*Store) LatestSavedPandoraHeaderHash

func (s *Store) LatestSavedPandoraHeaderHash() common.Hash

LatestSavedPandoraHeaderHash

func (*Store) LatestSavedPandoraSlot

func (s *Store) LatestSavedPandoraSlot() uint64

LatestSavedPandoraSlot

func (*Store) LatestSavedVanguardHeaderHash

func (s *Store) LatestSavedVanguardHeaderHash() (hash common.Hash)

func (*Store) LatestSavedVanguardSlot

func (s *Store) LatestSavedVanguardSlot() (latestSlot uint64)

func (*Store) LatestVerifiedRealmSlot

func (s *Store) LatestVerifiedRealmSlot() (slot uint64)

func (*Store) PandoraHeaderHash

func (s *Store) PandoraHeaderHash(slot uint64) (*types.HeaderHash, error)

PanHeader

func (*Store) PandoraHeaderHashes

func (s *Store) PandoraHeaderHashes(fromSlot uint64, limit uint64) ([]*types.HeaderHash, error)

PanHeaders

func (*Store) SaveConsensusInfo

func (s *Store) SaveConsensusInfo(
	ctx context.Context,
	consensusInfo *eventTypes.MinimalEpochConsensusInfo,
) error

SaveConsensusInfo

func (*Store) SaveLatestEpoch

func (s *Store) SaveLatestEpoch(ctx context.Context) error

SaveLatestEpoch

func (*Store) SaveLatestPandoraHeaderHash

func (s *Store) SaveLatestPandoraHeaderHash() error

SaveLatestPandoraHeaderHash

func (*Store) SaveLatestPandoraSlot

func (s *Store) SaveLatestPandoraSlot() error

SaveLatestPanSlot

func (*Store) SaveLatestVanguardHeaderHash

func (s *Store) SaveLatestVanguardHeaderHash() (err error)

func (*Store) SaveLatestVanguardSlot

func (s *Store) SaveLatestVanguardSlot() (err error)

func (*Store) SaveLatestVerifiedRealmSlot

func (s *Store) SaveLatestVerifiedRealmSlot(slot uint64) (err error)

func (*Store) SavePandoraHeaderHash

func (s *Store) SavePandoraHeaderHash(slot uint64, headerHash *types.HeaderHash) error

SavePanHeader

func (*Store) SaveVanguardHeaderHash

func (s *Store) SaveVanguardHeaderHash(slot uint64, headerHash *types.HeaderHash) (err error)

func (*Store) VanguardHeaderHash

func (s *Store) VanguardHeaderHash(slot uint64) (headerHash *types.HeaderHash, err error)

func (*Store) VanguardHeaderHashes

func (s *Store) VanguardHeaderHashes(fromSlot uint64, limit uint64) (vanguardHeaderHashes []*types.HeaderHash, err error)