logs

Documentation

Index

• Constants
• type DB
  • func NewFromEntryStore(logger log.Logger, m Metrics, store entrydb.EntryStore[EntryType, Entry], ...) (*DB, error)
  • func NewFromFile(logger log.Logger, m Metrics, path string, trimToLastSealed bool) (*DB, error)
  • func (db *DB) AddLog(logHash common.Hash, parentBlock eth.BlockID, logIdx uint32, ...) error
  • func (db *DB) Close() error
  • func (db *DB) Contains(blockNum uint64, logIdx uint32, logHash common.Hash) (types.BlockSeal, error)
  • func (db *DB) FindSealedBlock(number uint64) (seal types.BlockSeal, err error)
  • func (db *DB) Get(blockNum uint64, logIdx uint32) (common.Hash, error)
  • func (db *DB) IteratorStartingAt(sealedNum uint64, logsSince uint32) (Iterator, error)
  • func (db *DB) LatestSealedBlockNum() (n uint64, ok bool)
  • func (db *DB) OpenBlock(blockNum uint64) (ref eth.BlockRef, logCount uint32, execMsgs map[uint32]*types.ExecutingMessage, ...)
  • func (db *DB) Rewind(newHeadBlockNum uint64) error
  • func (db *DB) SealBlock(parentHash common.Hash, block eth.BlockID, timestamp uint64) error
  • func (db *DB) StartingBlock() (seal types.BlockSeal, err error)
• type Entry
  • func (e Entry) Type() EntryType
• type EntryBinary
  • func (EntryBinary) Append(dest []byte, e *Entry) []byte
  • func (EntryBinary) EntrySize() int
  • func (EntryBinary) ReadAt(dest *Entry, r io.ReaderAt, at int64) (n int, err error)
• type EntryObj
• type EntryType
  • func (x EntryType) String() string
• type EntryTypeFlag
  • func (x *EntryTypeFlag) Add(v EntryTypeFlag)
  • func (x EntryTypeFlag) Any(v EntryTypeFlag) bool
  • func (x *EntryTypeFlag) Remove(v EntryTypeFlag)
  • func (x EntryTypeFlag) String() string
• type Iterator
• type IteratorState
• type Metrics

Constants

const EntrySize = 34

Types

type DB

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

DB implements an append only database for log data and cross-chain dependencies.

To keep the append-only format, reduce data size, and support reorg detection and registering of executing-messages:

Use a fixed 24 bytes per entry.

Data is an append-only log, that can be binary searched for any necessary event data.

func NewFromEntryStore

func NewFromEntryStore(logger log.Logger, m Metrics, store entrydb.EntryStore[EntryType, Entry], trimToLastSealed bool) (*DB, error)

func NewFromFile

func NewFromFile(logger log.Logger, m Metrics, path string, trimToLastSealed bool) (*DB, error)

func (*DB) AddLog

func (db *DB) AddLog(logHash common.Hash, parentBlock eth.BlockID, logIdx uint32, execMsg *types.ExecutingMessage) error

func (*DB) Close

func (db *DB) Close() error

func (*DB) Contains

func (db *DB) Contains(blockNum uint64, logIdx uint32, logHash common.Hash) (types.BlockSeal, error)

Contains returns no error iff the specified logHash is recorded in the specified blockNum and logIdx. If the log is out of reach, then ErrFuture is returned. If the log is determined to conflict with the canonical chain, then ErrConflict is returned. logIdx is the index of the log in the array of all logs in the block. This can be used to check the validity of cross-chain interop events. The block-seal of the blockNum block, that the log was included in, is returned. This seal may be fully zeroed, without error, if the block isn't fully known yet.

func (*DB) FindSealedBlock

func (db *DB) FindSealedBlock(number uint64) (seal types.BlockSeal, err error)

FindSealedBlock finds the requested block, to check if it exists, returning the next index after it where things continue from. returns ErrFuture if the block is too new to be able to tell returns ErrDifferent if the known block does not match

func (*DB) Get

func (db *DB) Get(blockNum uint64, logIdx uint32) (common.Hash, error)

Get returns the hash of the log at the specified blockNum (of the sealed block) and logIdx (of the log after the block), or an error if the log is not found.

func (*DB) IteratorStartingAt

func (db *DB) IteratorStartingAt(sealedNum uint64, logsSince uint32) (Iterator, error)

func (*DB) LatestSealedBlockNum

func (db *DB) LatestSealedBlockNum() (n uint64, ok bool)

LatestSealedBlockNum returns the block number of the block that was last sealed, or ok=false if there is no sealed block (i.e. empty DB)

func (*DB) OpenBlock

func (db *DB) OpenBlock(blockNum uint64) (ref eth.BlockRef, logCount uint32, execMsgs map[uint32]*types.ExecutingMessage, retErr error)

OpenBlock returns the Executing Messages for the block at the given number. it returns identification of the block, the parent block, and the executing messages.

func (*DB) Rewind

func (db *DB) Rewind(newHeadBlockNum uint64) error

Rewind the database to remove any blocks after headBlockNum The block at headBlockNum itself is not removed.

func (*DB) SealBlock

func (db *DB) SealBlock(parentHash common.Hash, block eth.BlockID, timestamp uint64) error

func (*DB) StartingBlock

func (db *DB) StartingBlock() (seal types.BlockSeal, err error)

StartingBlock returns the first block seal in the DB, if any.

type Entry

type Entry [EntrySize]byte

func (Entry) Type

func (e Entry) Type() EntryType

type EntryBinary

type EntryBinary struct{}

func (EntryBinary) Append

func (EntryBinary) Append(dest []byte, e *Entry) []byte

func (EntryBinary) EntrySize

func (EntryBinary) EntrySize() int

func (EntryBinary) ReadAt

func (EntryBinary) ReadAt(dest *Entry, r io.ReaderAt, at int64) (n int, err error)

type EntryObj

type EntryObj interface {
	// contains filtered or unexported methods
}

type EntryType

type EntryType uint8

const (
	TypeSearchCheckpoint EntryType = iota
	TypeCanonicalHash
	TypeInitiatingEvent
	TypeExecutingLink
	TypeExecutingCheck
	TypePadding
)

func (EntryType) String

func (x EntryType) String() string

type EntryTypeFlag

type EntryTypeFlag uint8

const (
	FlagSearchCheckpoint EntryTypeFlag = 1 << TypeSearchCheckpoint
	FlagCanonicalHash    EntryTypeFlag = 1 << TypeCanonicalHash
	FlagInitiatingEvent  EntryTypeFlag = 1 << TypeInitiatingEvent
	FlagExecutingLink    EntryTypeFlag = 1 << TypeExecutingLink
	FlagExecutingCheck   EntryTypeFlag = 1 << TypeExecutingCheck
	FlagPadding          EntryTypeFlag = 1 << TypePadding
	// for additional padding
	FlagPadding2 EntryTypeFlag = FlagPadding << 1
)

func (*EntryTypeFlag) Add

func (x *EntryTypeFlag) Add(v EntryTypeFlag)

func (EntryTypeFlag) Any

func (x EntryTypeFlag) Any(v EntryTypeFlag) bool

func (*EntryTypeFlag) Remove

func (x *EntryTypeFlag) Remove(v EntryTypeFlag)

func (EntryTypeFlag) String

func (x EntryTypeFlag) String() string

type Iterator

type Iterator interface {
	End() error
	NextInitMsg() error
	NextExecMsg() error
	NextBlock() error
	TraverseConditional(traverseConditionalFn) error
	IteratorState
}

type IteratorState

type IteratorState interface {
	NextIndex() entrydb.EntryIdx
	SealedBlock() (hash common.Hash, num uint64, ok bool)
	SealedTimestamp() (timestamp uint64, ok bool)
	InitMessage() (hash common.Hash, logIndex uint32, ok bool)
	ExecMessage() *types.ExecutingMessage
}

type Metrics

type Metrics interface {
	RecordDBEntryCount(kind string, count int64)
	RecordDBSearchEntriesRead(count int64)
}