logdb

Documentation

Index

• Constants
• type Event
• type EventCriteria
• type EventFilter
• type LogDB
  • func New(path string, createAdditionalIndexes bool, maxReadConns uint64) (logDB *LogDB, err error)
  • func NewMem() (*LogDB, error)
  • func (db *LogDB) Close() (err error)
  • func (db *LogDB) EnableMetrics()
  • func (db *LogDB) FilterEvents(ctx context.Context, filter *EventFilter) ([]*Event, error)
  • func (db *LogDB) FilterTransfers(ctx context.Context, filter *TransferFilter) ([]*Transfer, error)
  • func (db *LogDB) HasBlockID(id thor.Bytes32) (bool, error)
  • func (db *LogDB) NewWriter() *Writer
  • func (db *LogDB) NewWriterSyncOff() *Writer
  • func (db *LogDB) NewestBlockID() (thor.Bytes32, error)
  • func (db *LogDB) Path() string
• type Options
• type Order
• type Range
• type Transfer
• type TransferCriteria
• type TransferFilter
• type Writer
  • func (w *Writer) Commit() (err error)
  • func (w *Writer) Rollback() (err error)
  • func (w *Writer) Truncate(blockNum uint32) error
  • func (w *Writer) UncommittedCount() int
  • func (w *Writer) Write(b *block.Block, receipts tx.Receipts) error

Constants

const (
	MaxBlockNumber = blockNumMask
)

Adjust these constants based on your bit allocation requirements 64th bit is the sign bit so we have 63 bits to use

Types

type Event

type Event struct {
	BlockNumber uint32
	LogIndex    uint32
	BlockID     thor.Bytes32
	BlockTime   uint64
	TxID        thor.Bytes32
	TxIndex     uint32
	TxOrigin    thor.Address // contract caller
	ClauseIndex uint32
	Address     thor.Address // always a contract address
	Topics      [5]*thor.Bytes32
	Data        []byte
}

Event represents tx.Event that can be stored in db.

type EventCriteria

type EventCriteria struct {
	Address *thor.Address // always a contract address
	Topics  [5]*thor.Bytes32
}

type EventFilter

type EventFilter struct {
	CriteriaSet []*EventCriteria
	Range       *Range
	Options     *Options
	Order       Order // default asc
}

EventFilter filter

type LogDB

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

func New

func New(path string, createAdditionalIndexes bool, maxReadConns uint64) (logDB *LogDB, err error)

New create or open log db at given path.

func NewMem

func NewMem() (*LogDB, error)

NewMem create a log db in ram. Unlike the file-based database, this implementation: 1. Uses synchronous=off for faster writes in memory 2. Uses a single connection with minimal transaction overhead 3. Optimizes for in-memory performance Note: In-memory database uses cache=shared so all connections share data

func (*LogDB) Close

func (db *LogDB) Close() (err error)

Close close the log db.

func (*LogDB) EnableMetrics

func (db *LogDB) EnableMetrics()

EnableMetrics registers a pull collector exporting the readDB connection pool stats, sampled on scrape at most once per readDBStatsSampleInterval. No-op unless Prometheus is initialized; call once per LogDB.

func (*LogDB) FilterEvents

func (db *LogDB) FilterEvents(ctx context.Context, filter *EventFilter) ([]*Event, error)

func (*LogDB) FilterTransfers

func (db *LogDB) FilterTransfers(ctx context.Context, filter *TransferFilter) ([]*Transfer, error)

func (*LogDB) HasBlockID

func (db *LogDB) HasBlockID(id thor.Bytes32) (bool, error)

HasBlockID query whether given block id related logs were written. Uses writeDB since this is called during write operations.

func (*LogDB) NewWriter

func (db *LogDB) NewWriter() *Writer

NewWriter creates a log writer.

func (*LogDB) NewWriterSyncOff

func (db *LogDB) NewWriterSyncOff() *Writer

NewWriterSyncOff creates a log writer which applied 'pragma synchronous = off'.

func (*LogDB) NewestBlockID

func (db *LogDB) NewestBlockID() (thor.Bytes32, error)

NewestBlockID query newest written block id. Uses writeDB since this is called during write operations.

func (*LogDB) Path

func (db *LogDB) Path() string

type Options

type Options struct {
	Offset uint64
	Limit  uint64
}

type Order

type Order string

const (
	ASC  Order = "asc"
	DESC Order = "desc"
)

type Range

type Range struct {
	From uint32
	To   uint32
}

type Transfer

type Transfer struct {
	BlockNumber uint32
	LogIndex    uint32
	BlockID     thor.Bytes32
	BlockTime   uint64
	TxID        thor.Bytes32
	TxIndex     uint32
	TxOrigin    thor.Address
	ClauseIndex uint32
	Sender      thor.Address
	Recipient   thor.Address
	Amount      *big.Int
}

Transfer represents tx.Transfer that can be stored in db.

type TransferCriteria

type TransferCriteria struct {
	TxOrigin  *thor.Address // who send transaction
	Sender    *thor.Address // who transferred tokens
	Recipient *thor.Address // who received tokens
}

type TransferFilter

type TransferFilter struct {
	CriteriaSet []*TransferCriteria
	Range       *Range
	Options     *Options
	Order       Order // default asc
}

type Writer

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

Writer is the transactional log writer.

func (*Writer) Commit

func (w *Writer) Commit() (err error)

Commit commits accumulated logs.

func (*Writer) Rollback

func (w *Writer) Rollback() (err error)

Rollback rollback all uncommitted logs.

func (*Writer) Truncate

func (w *Writer) Truncate(blockNum uint32) error

Truncate truncates the database by deleting logs after blockNum (included).

func (*Writer) UncommittedCount

func (w *Writer) UncommittedCount() int

UncommittedCount returns the count of uncommitted logs.

func (*Writer) Write

func (w *Writer) Write(b *block.Block, receipts tx.Receipts) error

Write writes all logs of the given block.