CoinStatsIndex Class Reference

CoinStatsIndex maintains statistics on the UTXO set. More...

#include <coinstatsindex.h>

Inheritance diagram for CoinStatsIndex:

Collaboration diagram for CoinStatsIndex:

Public Member Functions
	CoinStatsIndex (std::unique_ptr< interfaces::Chain > chain, size_t n_cache_size, bool f_memory=false, bool f_wipe=false)
interfaces::Chain::NotifyOptions	CustomOptions () override
	Return custom notification options for index.
std::optional< kernel::CCoinsStats >	LookUpStats (const CBlockIndex &block_index) const
Public Member Functions inherited from BaseIndex
	BaseIndex (std::unique_ptr< interfaces::Chain > chain, std::string name)
virtual	~BaseIndex ()
	Destructor interrupts sync thread if running and blocks until it exits.
const std::string &	GetName () const LIFETIMEBOUND
	Get the name of the index for display in logs.
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	Init ()
	Initializes the sync state and registers the instance to the validation interface so that it stays in sync with blockchain updates.
bool	StartBackgroundSync ()
	Starts the initial sync process on a background thread.
void	Sync ()
	Sync the index with the block index starting from the current best block.
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	CustomInit (const std::optional< interfaces::BlockRef > &block) override
	Initialize internal state from the database and block index.
bool	CustomCommit (CDBBatch &batch) override
	Virtual method called internally by Commit that can be overridden to atomically commit more index state.
bool	CustomAppend (const interfaces::BlockInfo &block) override
	Write update index entries for a newly connected block.
bool	CustomRemove (const interfaces::BlockInfo &block) override
	Rewind index by one block during a chain reorg.
BaseIndex::DB &	GetDB () const override
Protected Member Functions inherited from BaseIndex
void	BlockConnected (const kernel::ChainstateRole &role, const std::shared_ptr< const CBlock > &block, const CBlockIndex *pindex) override
	Notifies listeners of a block being connected.
void	ChainStateFlushed (const kernel::ChainstateRole &role, const CBlockLocator &locator) override
	Notifies listeners of the new active block chain on-disk.
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	ActiveTipChange (const CBlockIndex &new_tip, bool is_ibd)
	Notifies listeners any time the block chain tip changes, synchronously.
virtual void	TransactionAddedToMempool (const NewMempoolTransactionInfo &tx, 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	MempoolTransactionsRemovedForBlock (const std::vector< RemovedMempoolTransactionInfo > &txs_removed_for_block, unsigned int nBlockHeight)
virtual void	BlockDisconnected (const std::shared_ptr< const CBlock > &block, const CBlockIndex *pindex)
	Notifies listeners of a block being disconnected Provides the block that was disconnected.
virtual void	BlockChecked (const std::shared_ptr< 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.

Private Member Functions
bool	RevertBlock (const interfaces::BlockInfo &block)
bool	AllowPrune () const override

Private Attributes
std::unique_ptr< BaseIndex::DB >	m_db
MuHash3072	m_muhash
uint64_t	m_transaction_output_count {0}
uint64_t	m_bogo_size {0}
CAmount	m_total_amount {0}
CAmount	m_total_subsidy {0}
arith_uint256	m_total_prevout_spent_amount {0}
arith_uint256	m_total_new_outputs_ex_coinbase_amount {0}
arith_uint256	m_total_coinbase_amount {0}
CAmount	m_total_unspendables_genesis_block {0}
CAmount	m_total_unspendables_bip30 {0}
CAmount	m_total_unspendables_scripts {0}
CAmount	m_total_unspendables_unclaimed_rewards {0}
uint256	m_current_block_hash {}

Additional Inherited Members
Protected Attributes inherited from BaseIndex
std::unique_ptr< interfaces::Chain >	m_chain
Chainstate *	m_chainstate {nullptr}
const std::string	m_name

Detailed Description

CoinStatsIndex maintains statistics on the UTXO set.

Definition at line 30 of file coinstatsindex.h.

Constructor & Destructor Documentation

CoinStatsIndex()

CoinStatsIndex::CoinStatsIndex ( std::unique_ptr< interfaces::Chain > chain, size_t n_cache_size, bool f_memory = false, bool f_wipe = false )

explicit

Definition at line 90 of file coinstatsindex.cpp.

Here is the call graph for this function:

Member Function Documentation

AllowPrune()

bool CoinStatsIndex::AllowPrune ( ) const

inlineoverrideprivatevirtual

Implements BaseIndex.

Definition at line 52 of file coinstatsindex.h.

CustomAppend()

bool CoinStatsIndex::CustomAppend ( const interfaces::BlockInfo & block )

overrideprotectedvirtual

Write update index entries for a newly connected block.

Reimplemented from BaseIndex.

Definition at line 109 of file coinstatsindex.cpp.

Here is the call graph for this function:

CustomCommit()

bool CoinStatsIndex::CustomCommit ( CDBBatch & batch )

overrideprotectedvirtual

Virtual method called internally by Commit that can be overridden to atomically commit more index state.

Reimplemented from BaseIndex.

Definition at line 309 of file coinstatsindex.cpp.

Here is the call graph for this function:

CustomInit()

bool CoinStatsIndex::CustomInit ( const std::optional< interfaces::BlockRef > & block )

overrideprotectedvirtual

Initialize internal state from the database and block index.

Reimplemented from BaseIndex.

Definition at line 263 of file coinstatsindex.cpp.

Here is the call graph for this function:

CustomOptions()

interfaces::Chain::NotifyOptions CoinStatsIndex::CustomOptions ( )

overridevirtual

Return custom notification options for index.

Reimplemented from BaseIndex.

Definition at line 317 of file coinstatsindex.cpp.

CustomRemove()

bool CoinStatsIndex::CustomRemove ( const interfaces::BlockInfo & block )

overrideprotectedvirtual

Rewind index by one block during a chain reorg.

Reimplemented from BaseIndex.

Definition at line 217 of file coinstatsindex.cpp.

Here is the call graph for this function:

GetDB()

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

inlineoverrideprotectedvirtual

Implements BaseIndex.

Definition at line 63 of file coinstatsindex.h.

LookUpStats()

std::optional< CCoinsStats > CoinStatsIndex::LookUpStats

(

const CBlockIndex &

block_index

)

const

Definition at line 237 of file coinstatsindex.cpp.

Here is the call graph for this function:

RevertBlock()

bool CoinStatsIndex::RevertBlock ( const interfaces::BlockInfo & block )

private

Definition at line 327 of file coinstatsindex.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

m_bogo_size

uint64_t CoinStatsIndex::m_bogo_size {0}

private

Definition at line 37 of file coinstatsindex.h.

m_current_block_hash

uint256 CoinStatsIndex::m_current_block_hash {}

private

Definition at line 48 of file coinstatsindex.h.

m_db

std::unique_ptr<BaseIndex::DB> CoinStatsIndex::m_db

private

Definition at line 33 of file coinstatsindex.h.

m_muhash

MuHash3072 CoinStatsIndex::m_muhash

private

Definition at line 35 of file coinstatsindex.h.

m_total_amount

CAmount CoinStatsIndex::m_total_amount {0}

private

Definition at line 38 of file coinstatsindex.h.

m_total_coinbase_amount

arith_uint256 CoinStatsIndex::m_total_coinbase_amount {0}

private

Definition at line 42 of file coinstatsindex.h.

m_total_new_outputs_ex_coinbase_amount

arith_uint256 CoinStatsIndex::m_total_new_outputs_ex_coinbase_amount {0}

private

Definition at line 41 of file coinstatsindex.h.

m_total_prevout_spent_amount

arith_uint256 CoinStatsIndex::m_total_prevout_spent_amount {0}

private

Definition at line 40 of file coinstatsindex.h.

m_total_subsidy

CAmount CoinStatsIndex::m_total_subsidy {0}

private

Definition at line 39 of file coinstatsindex.h.

m_total_unspendables_bip30

CAmount CoinStatsIndex::m_total_unspendables_bip30 {0}

private

Definition at line 44 of file coinstatsindex.h.

m_total_unspendables_genesis_block

CAmount CoinStatsIndex::m_total_unspendables_genesis_block {0}

private

Definition at line 43 of file coinstatsindex.h.

m_total_unspendables_scripts

CAmount CoinStatsIndex::m_total_unspendables_scripts {0}

private

Definition at line 45 of file coinstatsindex.h.

m_total_unspendables_unclaimed_rewards

CAmount CoinStatsIndex::m_total_unspendables_unclaimed_rewards {0}

private

Definition at line 46 of file coinstatsindex.h.

m_transaction_output_count

uint64_t CoinStatsIndex::m_transaction_output_count {0}

private

Definition at line 36 of file coinstatsindex.h.

---

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

• src/index/coinstatsindex.h
• src/index/coinstatsindex.cpp