txindex

Documentation

Index

• Variables
• type Batch
  • func NewBatch(n int) *Batch
  • func (b *Batch) Add(result types.TxResult) error
  • func (b *Batch) Size() int
• type TxIndexer

Variables

var ErrorEmptyHash = errors.New("Transaction hash cannot be empty")

ErrorEmptyHash indicates empty hash

Types

type Batch

type Batch struct {
	Ops []types.TxResult
}

A Batch groups together multiple Index operations you would like performed at the same time. The Batch structure is NOT thread-safe. You should only perform operations on a batch from a single thread at a time. Once batch execution has started, you may not modify it.

func NewBatch

func NewBatch(n int) *Batch

NewBatch creates a new Batch.

func (*Batch) Add

func (b *Batch) Add(result types.TxResult) error

Index adds or updates entry for the given result.Index.

func (*Batch) Size

func (b *Batch) Size() int

Size returns the total number of operations inside the batch.

type TxIndexer

type TxIndexer interface {

	// Batch analyzes, indexes or stores a batch of transactions.
	//
	// NOTE We do not specify Index method for analyzing a single transaction
	// here because it bears heavy perfomance loses. Almost all advanced indexers
	// support batching.
	AddBatch(b *Batch) error

	// Tx returns specified transaction or nil if the transaction is not indexed
	// or stored.
	Get(hash []byte) (*types.TxResult, error)
}

Indexer interface defines methods to index and search transactions.