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
}

Batch groups together multiple Index operations to be performed at the same time. NOTE: Batch is NOT thread-safe and must not be modified after starting its execution.

func NewBatch

func NewBatch(n int) *Batch

NewBatch creates a new Batch.

func (*Batch) Add

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

Add or update an 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 {

	// AddBatch 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

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

TxIndexer interface defines methods to index and search transactions.