TxIndex Class Reference

TxIndex is used to look up transactions included in the blockchain by ID. More...

#include <txindex.h>

Inheritance diagram for TxIndex:

Collaboration diagram for TxIndex:

Classes
class	DB
	Access to the txindex database (indexes/txindex/) More...

Public Member Functions
	TxIndex (size_t n_cache_size, bool f_memory=false, bool f_wipe=false)
	Constructs the index, which becomes available to be queried.
virtual	~TxIndex () override
bool	FindTx (const TxId &txid, BlockHash &block_hash, CTransactionRef &tx) const
	Look up a transaction by identifier.
Public Member Functions inherited from BaseIndex
virtual	~BaseIndex ()
	Destructor interrupts sync thread if running and blocks until it exits.
bool BlockUntilSyncedToCurrentChain() const LOCKS_EXCLUDED(void	Interrupt ()
	Blocks the current thread until the index is caught up to the current state of the block chain.
bool	Start (Chainstate &active_chainstate)
	Start initializes the sync state and registers the instance as a ValidationInterface so that it stays in sync with blockchain updates.
void	Stop ()
	Stops the instance from staying in sync with blockchain updates.
IndexSummary	GetSummary () const
	Get a summary of the index and its state.

Protected Member Functions
bool	WriteBlock (const CBlock &block, const CBlockIndex *pindex) override
	Write update index entries for a newly connected block.
BaseIndex::DB &	GetDB () const override
const char *	GetName () const override
	Get the name of the index for display in logs.
Protected Member Functions inherited from BaseIndex
void	BlockConnected (const std::shared_ptr< const CBlock > &block, const CBlockIndex *pindex) override
	Notifies listeners of a block being connected.
void	ChainStateFlushed (const CBlockLocator &locator) override
	Notifies listeners of the new active block chain on-disk.
const CBlockIndex *	CurrentIndex ()
virtual bool	Init ()
	Initialize internal state from the database and block index.
virtual bool	CommitInternal (CDBBatch &batch)
	Virtual method called internally by Commit that can be overridden to atomically commit more index state.
virtual bool	Rewind (const CBlockIndex *current_tip, const CBlockIndex *new_tip)
	Rewind index to an earlier chain tip during a chain reorg.
void	SetBestBlockIndex (const CBlockIndex *block)
	Update the internal best block index as well as the prune lock.
Protected Member Functions inherited from CValidationInterface
	~CValidationInterface ()=default
	Protected destructor so that instances can only be deleted by derived classes.
virtual void	UpdatedBlockTip (const CBlockIndex *pindexNew, const CBlockIndex *pindexFork, bool fInitialDownload)
	Notifies listeners when the block chain tip advances.
virtual void	TransactionAddedToMempool (const CTransactionRef &tx, std::shared_ptr< const std::vector< Coin > > spent_coins, uint64_t mempool_sequence)
	Notifies listeners of a transaction having been added to mempool.
virtual void	TransactionRemovedFromMempool (const CTransactionRef &tx, MemPoolRemovalReason reason, uint64_t mempool_sequence)
	Notifies listeners of a transaction leaving mempool.
virtual void	BlockDisconnected (const std::shared_ptr< const CBlock > &block, const CBlockIndex *pindex)
	Notifies listeners of a block being disconnected.
virtual void	BlockChecked (const CBlock &, const BlockValidationState &)
	Notifies listeners of a block validation result.
virtual void	NewPoWValidBlock (const CBlockIndex *pindex, const std::shared_ptr< const CBlock > &block)
	Notifies listeners that a block which builds directly on our current tip has been received and connected to the headers tree, though not validated yet.
virtual void	BlockFinalized (const CBlockIndex *pindex)
virtual void	BlockInvalidated (const CBlockIndex *pindex, const std::shared_ptr< const CBlock > &block)

Private Member Functions
bool	AllowPrune () const override

Private Attributes
const std::unique_ptr< DB >	m_db

Additional Inherited Members
Protected Attributes inherited from BaseIndex
Chainstate *	m_chainstate {nullptr}

Detailed Description

TxIndex is used to look up transactions included in the blockchain by ID.

The index is written to a LevelDB database and records the filesystem location of each transaction by transaction ID.

Definition at line 22 of file txindex.h.

Constructor & Destructor Documentation

TxIndex()

TxIndex::TxIndex ( size_t  n_cache_size, bool  f_memory = false, bool  f_wipe = false  )

explicit

Constructs the index, which becomes available to be queried.

Definition at line 49 of file txindex.cpp.

~TxIndex()

TxIndex::~TxIndex ( )

overridevirtual

Definition at line 52 of file txindex.cpp.

Member Function Documentation

AllowPrune()

bool TxIndex::AllowPrune ( ) const

inlineoverrideprivatevirtual

Implements BaseIndex.

Definition at line 29 of file txindex.h.

FindTx()

bool TxIndex::FindTx	(	const TxId &	txid,
		BlockHash &	block_hash,
		CTransactionRef &	tx
	)		const

Look up a transaction by identifier.

Parameters

[in]	txid	The ID of the transaction to be returned.
[out]	block_hash	The hash of the block the transaction is found in.
[out]	tx	The transaction itself.

Returns

true if transaction is found, false otherwise

Definition at line 75 of file txindex.cpp.

Here is the call graph for this function:

GetDB()

BaseIndex::DB & TxIndex::GetDB ( ) const

overrideprotectedvirtual

Implements BaseIndex.

Definition at line 71 of file txindex.cpp.

GetName()

const char * TxIndex::GetName ( ) const

inlineoverrideprotectedvirtual

Get the name of the index for display in logs.

Implements BaseIndex.

Definition at line 36 of file txindex.h.

WriteBlock()

bool TxIndex::WriteBlock ( const CBlock &  block, const CBlockIndex *  pindex  )

overrideprotectedvirtual

Write update index entries for a newly connected block.

Reimplemented from BaseIndex.

Definition at line 54 of file txindex.cpp.

Here is the call graph for this function:

Member Data Documentation

m_db

const std::unique_ptr<DB> TxIndex::m_db

private

Definition at line 27 of file txindex.h.

---

The documentation for this class was generated from the following files:

• src/index/txindex.h
• src/index/txindex.cpp