Bitcoin Core  24.99.0
P2P Digital Currency
Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
CoinStatsIndex Class Referencefinal

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

#include <coinstatsindex.h>

Inheritance diagram for CoinStatsIndex:
[legend]
Collaboration diagram for CoinStatsIndex:
[legend]

Public Member Functions

 CoinStatsIndex (std::unique_ptr< interfaces::Chain > chain, size_t n_cache_size, bool f_memory=false, bool f_wipe=false)
 
std::optional< kernel::CCoinsStatsLookUpStats (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. More...
 
bool Start ()
 Start initializes the sync state and registers the instance as a ValidationInterface so that it stays in sync with blockchain updates. More...
 
void Stop ()
 Stops the instance from staying in sync with blockchain updates. More...
 
IndexSummary GetSummary () const
 Get a summary of the index and its state. More...
 

Protected Member Functions

bool CustomInit (const std::optional< interfaces::BlockKey > &block) override
 Initialize internal state from the database and block index. More...
 
bool CustomCommit (CDBBatch &batch) override
 Virtual method called internally by Commit that can be overridden to atomically commit more index state. More...
 
bool CustomAppend (const interfaces::BlockInfo &block) override
 Write update index entries for a newly connected block. More...
 
bool CustomRewind (const interfaces::BlockKey &current_tip, const interfaces::BlockKey &new_tip) override
 Rewind index to an earlier chain tip during a chain reorg. More...
 
BaseIndex::DBGetDB () const override
 
- 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. More...
 
void ChainStateFlushed (const CBlockLocator &locator) override
 Notifies listeners of the new active block chain on-disk. More...
 
const std::string & GetName () const LIFETIMEBOUND
 Get the name of the index for display in logs. More...
 
void SetBestBlockIndex (const CBlockIndex *block)
 Update the internal best block index as well as the prune lock. More...
 
- Protected Member Functions inherited from CValidationInterface
 ~CValidationInterface ()=default
 Protected destructor so that instances can only be deleted by derived classes. More...
 
virtual void UpdatedBlockTip (const CBlockIndex *pindexNew, const CBlockIndex *pindexFork, bool fInitialDownload)
 Notifies listeners when the block chain tip advances. More...
 
virtual void TransactionAddedToMempool (const CTransactionRef &tx, uint64_t mempool_sequence)
 Notifies listeners of a transaction having been added to mempool. More...
 
virtual void TransactionRemovedFromMempool (const CTransactionRef &tx, MemPoolRemovalReason reason, uint64_t mempool_sequence)
 Notifies listeners of a transaction leaving mempool. More...
 
virtual void BlockDisconnected (const std::shared_ptr< const CBlock > &block, const CBlockIndex *pindex)
 Notifies listeners of a block being disconnected. More...
 
virtual void BlockChecked (const CBlock &, const BlockValidationState &)
 Notifies listeners of a block validation result. More...
 
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. More...
 

Private Member Functions

bool ReverseBlock (const CBlock &block, const CBlockIndex *pindex)
 
bool AllowPrune () const override
 

Private Attributes

std::unique_ptr< BaseIndex::DBm_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}
 
CAmount m_total_unspendable_amount {0}
 
CAmount m_total_prevout_spent_amount {0}
 
CAmount m_total_new_outputs_ex_coinbase_amount {0}
 
CAmount 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}
 

Additional Inherited Members

- Protected Attributes inherited from BaseIndex
std::unique_ptr< interfaces::Chainm_chain
 
Chainstatem_chainstate {nullptr}
 
const std::string m_name
 

Detailed Description

CoinStatsIndex maintains statistics on the UTXO set.

Definition at line 22 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 107 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 43 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 116 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 396 of file coinstatsindex.cpp.

Here is the call graph for this function:

◆ CustomInit()

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

Initialize internal state from the database and block index.

Reimplemented from BaseIndex.

Definition at line 353 of file coinstatsindex.cpp.

Here is the call graph for this function:

◆ CustomRewind()

bool CoinStatsIndex::CustomRewind ( const interfaces::BlockKey current_tip,
const interfaces::BlockKey new_tip 
)
overrideprotectedvirtual

Rewind index to an earlier chain tip during a chain reorg.

The tip must be an ancestor of the current best block.

Reimplemented from BaseIndex.

Definition at line 270 of file coinstatsindex.cpp.

Here is the call graph for this function:

◆ GetDB()

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

Implements BaseIndex.

Definition at line 54 of file coinstatsindex.h.

◆ LookUpStats()

std::optional< CCoinsStats > CoinStatsIndex::LookUpStats ( const CBlockIndex block_index) const

Definition at line 326 of file coinstatsindex.cpp.

Here is the call graph for this function:

◆ ReverseBlock()

bool CoinStatsIndex::ReverseBlock ( const CBlock block,
const CBlockIndex pindex 
)
private

Definition at line 405 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 29 of file coinstatsindex.h.

◆ m_db

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

Definition at line 25 of file coinstatsindex.h.

◆ m_muhash

MuHash3072 CoinStatsIndex::m_muhash
private

Definition at line 27 of file coinstatsindex.h.

◆ m_total_amount

CAmount CoinStatsIndex::m_total_amount {0}
private

Definition at line 30 of file coinstatsindex.h.

◆ m_total_coinbase_amount

CAmount CoinStatsIndex::m_total_coinbase_amount {0}
private

Definition at line 35 of file coinstatsindex.h.

◆ m_total_new_outputs_ex_coinbase_amount

CAmount CoinStatsIndex::m_total_new_outputs_ex_coinbase_amount {0}
private

Definition at line 34 of file coinstatsindex.h.

◆ m_total_prevout_spent_amount

CAmount CoinStatsIndex::m_total_prevout_spent_amount {0}
private

Definition at line 33 of file coinstatsindex.h.

◆ m_total_subsidy

CAmount CoinStatsIndex::m_total_subsidy {0}
private

Definition at line 31 of file coinstatsindex.h.

◆ m_total_unspendable_amount

CAmount CoinStatsIndex::m_total_unspendable_amount {0}
private

Definition at line 32 of file coinstatsindex.h.

◆ m_total_unspendables_bip30

CAmount CoinStatsIndex::m_total_unspendables_bip30 {0}
private

Definition at line 37 of file coinstatsindex.h.

◆ m_total_unspendables_genesis_block

CAmount CoinStatsIndex::m_total_unspendables_genesis_block {0}
private

Definition at line 36 of file coinstatsindex.h.

◆ m_total_unspendables_scripts

CAmount CoinStatsIndex::m_total_unspendables_scripts {0}
private

Definition at line 38 of file coinstatsindex.h.

◆ m_total_unspendables_unclaimed_rewards

CAmount CoinStatsIndex::m_total_unspendables_unclaimed_rewards {0}
private

Definition at line 39 of file coinstatsindex.h.

◆ m_transaction_output_count

uint64_t CoinStatsIndex::m_transaction_output_count {0}
private

Definition at line 28 of file coinstatsindex.h.


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