index

package
v1.0.24 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 20, 2023 License: ISC Imports: 22 Imported by: 0

Documentation

Overview

Package indexers implements optional block chain indexes.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func DBFetchTx 

func DBFetchTx(dbTx database.Tx, hash *hash.Hash) (*types.Transaction, error)

dbFetchTx looks up the passed transaction hash in the transaction index and loads it from the database.

func DBFetchTxAndBlock 

func DBFetchTxAndBlock(dbTx database.Tx, hash *hash.Hash) (*types.Transaction, *hash.Hash, error)

func DBPutIndexerTip added in v1.0.19 

func DBPutIndexerTip(dbTx database.Tx, idxKey []byte, h *hash.Hash, order uint32) error

func DropAddrIndex 

func DropAddrIndex(db database.DB, interrupt <-chan struct{}) error

DropAddrIndex drops the address index from the provided database if it exists.

func DropInvalidTxIndex added in v1.0.19 

func DropInvalidTxIndex(db database.DB, interrupt <-chan struct{}) error

func DropTxIndex 

func DropTxIndex(db database.DB, interrupt <-chan struct{}) error

DropTxIndex drops the transaction index from the provided database if it exists. Since the address index relies on it, the address index will also be dropped when it exists.

func IsDuplicateTx added in v1.0.21 

func IsDuplicateTx(dbTx database.Tx, txid *hash.Hash, blockHash *hash.Hash) bool

func UseLogger added in v1.0.19 

func UseLogger(logger l.Logger)

UseLogger uses a specified Logger to output package logging info.

Types

type AddrIndex 

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

AddrIndex implements a transaction by address index. That is to say, it supports querying all transactions that reference a given address because they are either crediting or debiting the address. The returned transactions are ordered according to their order of appearance in the blockchain. In other words, first by block height and then by offset inside the block.

In addition, support is provided for a memory-only index of unconfirmed transactions such as those which are kept in the memory pool before inclusion in a block.

func NewAddrIndex 

func NewAddrIndex(db database.DB) *AddrIndex

NewAddrIndex returns a new instance of an indexer that is used to create a mapping of all addresses in the blockchain to the respective transactions that involve them.

It implements the Indexer interface which plugs into the IndexManager that in turn is used by the blockchain package. This allows the index to be seamlessly maintained along with the chain.

func (*AddrIndex) AddUnconfirmedTx 

func (idx *AddrIndex) AddUnconfirmedTx(tx *types.Tx, pkScripts [][]byte)

AddUnconfirmedTx adds all addresses related to the transaction to the unconfirmed (memory-only) address index.

NOTE: This transaction MUST have already been validated by the memory pool before calling this function with it and have all of the inputs available in the provided utxo view. Failure to do so could result in some or all addresses not being indexed.

This function is safe for concurrent access.

func (*AddrIndex) ConnectBlock 

func (idx *AddrIndex) ConnectBlock(dbTx database.Tx, block *types.SerializedBlock, stxos [][]byte, blk model.Block) error

ConnectBlock is invoked by the index manager when a new block has been connected to the main chain. This indexer adds a mapping for each address the transactions in the block involve.

This is part of the Indexer interface.

func (*AddrIndex) Create 

func (idx *AddrIndex) Create(dbTx database.Tx) error

Create is invoked when the indexer manager determines the index needs to be created for the first time. It creates the bucket for the address index.

This is part of the Indexer interface.

func (*AddrIndex) DisconnectBlock 

func (idx *AddrIndex) DisconnectBlock(dbTx database.Tx, block *types.SerializedBlock, stxos [][]byte) error

DisconnectBlock is invoked by the index manager when a block has been disconnected from the main chain. This indexer removes the address mappings each transaction in the block involve.

This is part of the Indexer interface.

func (*AddrIndex) Init 

func (idx *AddrIndex) Init(chain model.BlockChain) error

Init is only provided to satisfy the Indexer interface as there is nothing to initialize for this index.

This is part of the Indexer interface.

func (*AddrIndex) Key 

func (idx *AddrIndex) Key() []byte

Key returns the database key to use for the index as a byte slice.

This is part of the Indexer interface.

func (*AddrIndex) Name 

func (idx *AddrIndex) Name() string

Name returns the human-readable name of the index.

This is part of the Indexer interface.

func (*AddrIndex) NeedsInputs 

func (idx *AddrIndex) NeedsInputs() bool

NeedsInputs signals that the index requires the referenced inputs in order to properly create the index.

This implements the NeedsInputser interface.

func (*AddrIndex) RemoveUnconfirmedTx 

func (idx *AddrIndex) RemoveUnconfirmedTx(hash *hash.Hash)

RemoveUnconfirmedTx removes the passed transaction from the unconfirmed (memory-only) address index.

This function is safe for concurrent access.

func (*AddrIndex) TxRegionsForAddress 

func (idx *AddrIndex) TxRegionsForAddress(dbTx database.Tx, addr types.Address, numToSkip, numRequested uint32, reverse bool) ([]database.BlockRegion, uint32, error)

TxRegionsForAddress returns a slice of block regions which identify each transaction that involves the passed address according to the specified number to skip, number requested, and whether or not the results should be reversed. It also returns the number actually skipped since it could be less in the case where there are not enough entries.

NOTE: These results only include transactions confirmed in blocks. See the UnconfirmedTxnsForAddress method for obtaining unconfirmed transactions that involve a given address.

This function is safe for concurrent access.

func (*AddrIndex) UnconfirmedTxnsForAddress 

func (idx *AddrIndex) UnconfirmedTxnsForAddress(addr types.Address) []*types.Tx

UnconfirmedTxnsForAddress returns all transactions currently in the unconfirmed (memory-only) address index that involve the passed address. Unsupported address types are ignored and will result in no results.

This function is safe for concurrent access.

type Config added in v1.0.19 

type Config struct {
	TxIndex        bool
	AddrIndex      bool
	InvalidTxIndex bool
}

func DefaultConfig added in v1.0.19 

func DefaultConfig() *Config

func ToConfig added in v1.0.19 

func ToConfig(cfg *config.Config) *Config

type IndexDropper 

type IndexDropper interface {
	DropIndex(db database.DB, interrupt <-chan struct{}) error
}

IndexDropper provides a method to remove an index from the database. Indexers may implement this for a more efficient way of deleting themselves from the database rather than simply dropping a bucket.

type Indexer 

type Indexer interface {
	// Key returns the key of the index as a byte slice.
	Key() []byte

	// Name returns the human-readable name of the index.
	Name() string

	// Create is invoked when the indexer manager determines the index needs
	// to be created for the first time.
	Create(dbTx database.Tx) error

	// Init is invoked when the index manager is first initializing the
	// index.  This differs from the Create method in that it is called on
	// every load, including the case the index was just created.
	Init(chain model.BlockChain) error

	// ConnectBlock is invoked when the index manager is notified that a new
	// block has been connected to the main chain.
	ConnectBlock(dbTx database.Tx, block *types.SerializedBlock, stxos [][]byte, blk model.Block) error

	// DisconnectBlock is invoked when the index manager is notified that a
	// block has been disconnected from the main chain.
	DisconnectBlock(dbTx database.Tx, block *types.SerializedBlock, stxos [][]byte) error
}

Indexer provides a generic interface for an indexer that is managed by an index manager such as the Manager type provided by this package.

type InvalidTxIndex added in v1.0.19 

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

func NewInvalidTxIndex added in v1.0.19 

func NewInvalidTxIndex(consensus model.Consensus) *InvalidTxIndex

func (*InvalidTxIndex) ConnectBlock added in v1.0.19 

func (idx *InvalidTxIndex) ConnectBlock(bid uint64, block *types.SerializedBlock) error

func (*InvalidTxIndex) DisconnectBlock added in v1.0.19 

func (idx *InvalidTxIndex) DisconnectBlock(bid uint64, block *types.SerializedBlock) error

func (*InvalidTxIndex) Get added in v1.0.19 

func (idx *InvalidTxIndex) Get(txid *hash.Hash) (*types.Transaction, error)

func (*InvalidTxIndex) GetIdByHash added in v1.0.19 

func (idx *InvalidTxIndex) GetIdByHash(h *hash.Hash) (*hash.Hash, error)

func (*InvalidTxIndex) Init added in v1.0.19 

func (idx *InvalidTxIndex) Init() error

func (*InvalidTxIndex) Name added in v1.0.19 

func (idx *InvalidTxIndex) Name() string

func (*InvalidTxIndex) UpdateMainTip added in v1.0.19 

func (idx *InvalidTxIndex) UpdateMainTip(bh *hash.Hash, order uint64) error

type Manager 

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

Manager defines an index manager that manages multiple optional indexes and implements the blockchain.IndexManager interface so it can be seamlessly plugged into normal chain processing.

func NewManager 

func NewManager(cfg *Config, consensus model.Consensus) *Manager

NewManager returns a new index manager with the provided indexes enabled.

The manager returned satisfies the blockchain.IndexManager interface and thus cleanly plugs into the normal blockchain processing path.

func (*Manager) AddrIndex added in v1.0.19 

func (m *Manager) AddrIndex() *AddrIndex

func (*Manager) ConnectBlock 

func (m *Manager) ConnectBlock(block *types.SerializedBlock, stxos [][]byte, blk model.Block) error

ConnectBlock must be invoked when a block is extending the main chain. It keeps track of the state of each index it is managing, performs some sanity checks, and invokes each indexer.

This is part of the blockchain.IndexManager interface.

func (*Manager) DisconnectBlock 

func (m *Manager) DisconnectBlock(block *types.SerializedBlock, stxos [][]byte, blk model.Block) error

DisconnectBlock must be invoked when a block is being disconnected from the end of the main chain. It keeps track of the state of each index it is managing, performs some sanity checks, and invokes each indexer to remove the index entries associated with the block.

This is part of the blockchain.IndexManager interface.

func (*Manager) Drop 

func (m *Manager) Drop() error

func (*Manager) GetIndex added in v1.0.19 

func (m *Manager) GetIndex(name string) Indexer

func (*Manager) GetTxBytes added in v1.0.19 

func (m *Manager) GetTxBytes(blockRegion *database.BlockRegion) ([]byte, error)

This is part of the Indexer interface.

func (*Manager) HasTx 

func (m *Manager) HasTx(txid *hash.Hash) bool

func (*Manager) Init 

func (m *Manager) Init() error

Init initializes the enabled indexes. This is called during chain initialization and primarily consists of catching up all indexes to the current best chain tip. This is necessary since each index can be disabled and re-enabled at any time and attempting to catch-up indexes at the same time new blocks are being downloaded would lead to an overall longer time to catch up due to the I/O contention.

This is part of the blockchain.IndexManager interface.

func (*Manager) InvalidTxIndex added in v1.0.19 

func (m *Manager) InvalidTxIndex() *InvalidTxIndex

func (*Manager) IsDuplicateTx 

func (m *Manager) IsDuplicateTx(dbTx database.Tx, txid *hash.Hash, blockHash *hash.Hash) bool

HasTransaction

func (*Manager) TxIndex added in v1.0.19 

func (m *Manager) TxIndex() *TxIndex

func (*Manager) UpdateMainTip added in v1.0.19 

func (m *Manager) UpdateMainTip(bh *hash.Hash, order uint64) error

type NeedsInputser 

type NeedsInputser interface {
	NeedsInputs() bool
}

NeedsInputser provides a generic interface for an indexer to specify the it requires the ability to look up inputs for a transaction.

type TxIndex 

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

TxIndex implements a transaction by hash index. That is to say, it supports querying all transactions by their hash.

func NewTxIndex 

func NewTxIndex(db database.DB) *TxIndex

NewTxIndex returns a new instance of an indexer that is used to create a mapping of the hashes of all transactions in the blockchain to the respective block, location within the block, and size of the transaction.

It implements the Indexer interface which plugs into the IndexManager that in turn is used by the blockchain package. This allows the index to be seamlessly maintained along with the chain.

func (*TxIndex) ConnectBlock 

func (idx *TxIndex) ConnectBlock(dbTx database.Tx, block *types.SerializedBlock, stxos [][]byte, blk model.Block) error

ConnectBlock is invoked by the index manager when a new block has been connected to the main chain. This indexer adds a hash-to-transaction mapping for every transaction in the passed block.

This is part of the Indexer interface.

func (*TxIndex) Create 

func (idx *TxIndex) Create(dbTx database.Tx) error

Name returns the human-readable name of the index.

Create is invoked when the indexer manager determines the index needs to be created for the first time. It creates the buckets for the hash-based transaction index and the internal block ID indexes.

This is part of the Indexer interface.

func (*TxIndex) DisconnectBlock 

func (idx *TxIndex) DisconnectBlock(dbTx database.Tx, block *types.SerializedBlock, stxos [][]byte) error

DisconnectBlock is invoked by the index manager when a block has been disconnected from the main chain. This indexer removes the hash-to-transaction mapping for every transaction in the block.

This is part of the Indexer interface.

func (*TxIndex) GetTxIdByHash 

func (idx *TxIndex) GetTxIdByHash(txhash hash.Hash) (*hash.Hash, error)

func (*TxIndex) Init 

func (idx *TxIndex) Init(chain model.BlockChain) error

Init initializes the hash-based transaction index. In particular, it finds the highest used block ID and stores it for later use when connecting or disconnecting blocks.

This is part of the Indexer interface.

func (*TxIndex) Key 

func (idx *TxIndex) Key() []byte

Key returns the database key to use for the index as a byte slice.

This is part of the Indexer interface.

func (*TxIndex) Name 

func (idx *TxIndex) Name() string

Name returns the human-readable name of the index.

This is part of the Indexer interface.

func (*TxIndex) SetCurOrder added in v1.0.19 

func (idx *TxIndex) SetCurOrder(order int64)

func (*TxIndex) TxBlockRegion 

func (idx *TxIndex) TxBlockRegion(id hash.Hash) (*database.BlockRegion, error)

TxBlockRegion returns the block region for the provided transaction hash from the transaction index. The block region can in turn be used to load the raw transaction bytes. When there is no entry for the provided hash, nil will be returned for the both the entry and the error.

This function is safe for concurrent access.

func (*TxIndex) TxBlockRegionByHash 

func (idx *TxIndex) TxBlockRegionByHash(hash hash.Hash) (*database.BlockRegion, error)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.