tree

Documentation

Index

• Variables
• type MetadataDatabase
• type Options
  • func StartingAtBlockHeight(blockHeight uint64) Options
  • func WithInMemoryDatabase() Options
  • func WithLevelDBDatabase(vegaPaths paths.Paths) Options
  • func WithMaxNumberOfSnapshotsToKeep(max uint64) Options
• type SnapshotsDatabase
• type Tree
  • func New(log *logging.Logger, opts ...Options) (*Tree, error)
  • func (t *Tree) AddSnapshot(s *types.Snapshot) error
  • func (t *Tree) AddState(key []byte, state []byte)
  • func (t *Tree) AsPayloads() ([]*types.Payload, error)
  • func (t *Tree) AsProtoPayloads() ([]*snapshotpb.Payload, error)
  • func (t *Tree) FindImmutableTreeByHeight(blockHeight uint64) (*iavl.ImmutableTree, error)
  • func (t *Tree) HasSnapshotsLoaded() bool
  • func (t *Tree) Hash() []byte
  • func (t *Tree) ListLatestSnapshots(maxLengthOfSnapshotList uint64) ([]*tmtypes.Snapshot, error)
  • func (t *Tree) Release()
  • func (t *Tree) RemoveKey(key []byte) (bool, error)
  • func (t *Tree) SaveVersion() error
  • func (t *Tree) WorkingHash() []byte

Variables

var (
	ErrDatabasesAreAlreadyInitialized    = errors.New("the databases are already initialized")
	ErrMinimumNumberOfSnapshotsToKeepIs1 = errors.New("the minimum number of snapshots to keep is 1")
)

Types

type MetadataDatabase

type MetadataDatabase interface {
	Save(int64, *tmtypes.Snapshot) error
	Load(int64) (*tmtypes.Snapshot, error)
	Close() error
	Clear() error
	IsEmpty() bool
	FindVersionByBlockHeight(uint64) (int64, error)
	Delete(int64) error
	DeleteRange(fromVersion, toVersion int64) error
}

type Options

type Options func(t *Tree) error

func StartingAtBlockHeight

func StartingAtBlockHeight(blockHeight uint64) Options

func WithInMemoryDatabase

func WithInMemoryDatabase() Options

func WithLevelDBDatabase

func WithLevelDBDatabase(vegaPaths paths.Paths) Options

func WithMaxNumberOfSnapshotsToKeep

func WithMaxNumberOfSnapshotsToKeep(max uint64) Options

type SnapshotsDatabase

type SnapshotsDatabase interface {
	cometbftdb.DB
	Clear() error
}

type Tree

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

Tree is a high-level structure that abstract the management of the AVL away from the snapshot engine. It ensure the snapshot and metadata databases are in-sync, and old snapshots are removed when exceeding the maximum number to keep configured. When created, it will automatically remove old local snapshots and load the ones left. When the tree is no longer used, the resources it holds must be released by calling Release().

func New

func New(log *logging.Logger, opts ...Options) (*Tree, error)

func (*Tree) AddSnapshot

func (t *Tree) AddSnapshot(s *types.Snapshot) error

func (*Tree) AddState

func (t *Tree) AddState(key []byte, state []byte)

func (*Tree) AsPayloads

func (t *Tree) AsPayloads() ([]*types.Payload, error)

func (*Tree) AsProtoPayloads

func (t *Tree) AsProtoPayloads() ([]*snapshotpb.Payload, error)

func (*Tree) FindImmutableTreeByHeight

func (t *Tree) FindImmutableTreeByHeight(blockHeight uint64) (*iavl.ImmutableTree, error)

func (*Tree) HasSnapshotsLoaded

func (t *Tree) HasSnapshotsLoaded() bool

func (*Tree) Hash

func (t *Tree) Hash() []byte

func (*Tree) ListLatestSnapshots

func (t *Tree) ListLatestSnapshots(maxLengthOfSnapshotList uint64) ([]*tmtypes.Snapshot, error)

func (*Tree) Release

func (t *Tree) Release()

func (*Tree) RemoveKey

func (t *Tree) RemoveKey(key []byte) (bool, error)

func (*Tree) SaveVersion

func (t *Tree) SaveVersion() error

func (*Tree) WorkingHash

func (t *Tree) WorkingHash() []byte