kv

Documentation

Index

• type BlockerIndexer
  • func New(store dbm.DB) *BlockerIndexer
  • func (idx *BlockerIndexer) Has(height int64) (bool, error)
  • func (idx *BlockerIndexer) Index(bh types.EventDataNewBlockHeader) error
  • func (idx *BlockerIndexer) Search(ctx context.Context, q *query.Query) ([]int64, error)

Types

type BlockerIndexer

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

BlockerIndexer implements a block indexer, indexing BeginBlock and EndBlock events with an underlying KV store. Block events are indexed by their height, such that matching search criteria returns the respective block height(s).

func New

func New(store dbm.DB) *BlockerIndexer

func (*BlockerIndexer) Has

func (idx *BlockerIndexer) Has(height int64) (bool, error)

Has returns true if the given height has been indexed. An error is returned upon database query failure.

func (*BlockerIndexer) Index

func (idx *BlockerIndexer) Index(bh types.EventDataNewBlockHeader) error

Index indexes BeginBlock and EndBlock events for a given block by its height. The following is indexed:

primary key: encode(block.height | height) => encode(height) BeginBlock events: encode(eventType.eventAttr|eventValue|height|begin_block) => encode(height) EndBlock events: encode(eventType.eventAttr|eventValue|height|end_block) => encode(height)

func (*BlockerIndexer) Search

func (idx *BlockerIndexer) Search(ctx context.Context, q *query.Query) ([]int64, error)

Search performs a query for block heights that match a given BeginBlock and Endblock event search criteria. The given query can match against zero, one or more block heights. In the case of height queries, i.e. block.height=H, if the height is indexed, that height alone will be returned. An error and nil slice is returned. Otherwise, a non-nil slice and nil error is returned.