The block chain is a tree shaped structure starting with the genesis block at the root, with each block potentially having multiple candidates to be the next block. More...

#include <blockindex.h>

Inheritance diagram for CBlockIndex:

[legend]

Collaboration diagram for CBlockIndex:

[legend]

Public Member Functions
int nFile	GUARDED_BY (::cs_main)
	Which # file this block is stored in (blk?????.dat)

unsigned int nDataPos	GUARDED_BY (::cs_main)
	Byte offset within blk?????.dat where this block's data is stored.

unsigned int nUndoPos	GUARDED_BY (::cs_main)
	Byte offset within rev?????.dat where this block's undo data is stored.

BlockStatus nStatus	GUARDED_BY (::cs_main)
	Verification status of this block. See enum BlockStatus.

	CBlockIndex ()=default

	CBlockIndex (const CBlockHeader &block)

FlatFilePos	GetBlockPos () const EXCLUSIVE_LOCKS_REQUIRED(

FlatFilePos	GetUndoPos () const EXCLUSIVE_LOCKS_REQUIRED(

CBlockHeader	GetBlockHeader () const

BlockHash	GetBlockHash () const

int64_t	GetChainTxCount () const
	Get the number of transaction in the chain so far.

uint64_t	GetChainSize () const
	Get the size of all the blocks in the chain so far.

bool	UpdateChainStats ()
	Update chain tx stats.

bool	HaveTxsDownloaded () const
	Check whether this block's and all previous blocks' transactions have been downloaded (and stored to disk) at some point.

NodeSeconds	Time () const

int64_t	GetBlockTime () const

int64_t	GetBlockTimeMax () const

int64_t	GetHeaderReceivedTime () const

int64_t	GetReceivedTimeDiff () const

int64_t	GetMedianTimePast () const

std::string	ToString () const

bool	IsValid (enum BlockValidity nUpTo=BlockValidity::TRANSACTIONS) const EXCLUSIVE_LOCKS_REQUIRED(
	Check whether this block index entry is valid up to the passed validity level.

bool	IsAssumedValid () const EXCLUSIVE_LOCKS_REQUIRED(

bool	RaiseValidity (enum BlockValidity nUpTo) EXCLUSIVE_LOCKS_REQUIRED(
	Raise the validity level of this block index entry.

void	BuildSkip ()
	Build the skiplist pointer for this entry.

CBlockIndex *	GetAncestor (int height)
	Efficiently find an ancestor of this block.

const CBlockIndex *	GetAncestor (int height) const

Public Attributes
const BlockHash *	phashBlock {nullptr}
	pointer to the hash of the block, if any.

CBlockIndex *	pprev {nullptr}
	pointer to the index of the predecessor of this block

CBlockIndex *	pskip {nullptr}
	pointer to the index of some further predecessor of this block

int	nHeight {0}
	height of the entry in the chain. The genesis block has height 0

arith_uint256	nChainWork {}
	(memory only) Total amount of work (expected number of hashes) in the chain up to and including this block

unsigned int	nTx {0}
	Number of transactions in this block.

unsigned int	nSize {0}
	Size of this block.

unsigned int	nChainTx {0}
	(memory only) Number of transactions in the chain up to and including this block.

int32_t	nVersion {0}
	block header

uint256	hashMerkleRoot {}

uint32_t	nTime {0}

uint32_t	nBits {0}

uint32_t	nNonce {0}

int32_t	nSequenceId {0}
	(memory only) Sequential id assigned to distinguish order in which blocks are received.

int64_t	nTimeReceived {0}
	(memory only) block header metadata

unsigned int	nTimeMax {0}
	(memory only) Maximum nTime in the chain up to and including this block.

Static Public Attributes
static constexpr int	nMedianTimeSpan = 11

Private Attributes
uint64_t	nChainSize {0}
	(memory only) Size of all blocks in the chain up to and including this block.

Detailed Description

The block chain is a tree shaped structure starting with the genesis block at the root, with each block potentially having multiple candidates to be the next block.

A blockindex may have multiple pprev pointing to it, but at most one of them can be part of the currently active branch.

Definition at line 25 of file blockindex.h.

Constructor & Destructor Documentation

◆ CBlockIndex() [1/2]

CBlockIndex::CBlockIndex ( )

explicitdefault

◆ CBlockIndex() [2/2]

CBlockIndex::CBlockIndex ( const CBlockHeader & block )

inlineexplicit

Definition at line 108 of file blockindex.h.

Member Function Documentation

◆ BuildSkip()

void CBlockIndex::BuildSkip ( )

Build the skiplist pointer for this entry.

Definition at line 83 of file blockindex.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetAncestor() [1/2]

CBlockIndex * CBlockIndex::GetAncestor ( int height )

Efficiently find an ancestor of this block.

Definition at line 78 of file blockindex.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetAncestor() [2/2]

const CBlockIndex * CBlockIndex::GetAncestor ( int height ) const

Definition at line 52 of file blockindex.cpp.

Here is the call graph for this function:

◆ GetBlockHash()

BlockHash CBlockIndex::GetBlockHash ( ) const

inline

Definition at line 146 of file blockindex.h.

Here is the call graph for this function:

◆ GetBlockHeader()

CBlockHeader CBlockIndex::GetBlockHeader ( ) const

inline

Definition at line 133 of file blockindex.h.

Here is the call graph for this function:

◆ GetBlockPos()

FlatFilePos CBlockIndex::GetBlockPos ( ) const

inline

Definition at line 113 of file blockindex.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetBlockTime()

int64_t CBlockIndex::GetBlockTime ( ) const

inline

Definition at line 180 of file blockindex.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetBlockTimeMax()

int64_t CBlockIndex::GetBlockTimeMax ( ) const

inline

Definition at line 182 of file blockindex.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetChainSize()

uint64_t CBlockIndex::GetChainSize ( ) const

inline

Get the size of all the blocks in the chain so far.

Definition at line 159 of file blockindex.h.

◆ GetChainTxCount()

int64_t CBlockIndex::GetChainTxCount ( ) const

inline

Get the number of transaction in the chain so far.

Definition at line 154 of file blockindex.h.

Here is the caller graph for this function:

◆ GetHeaderReceivedTime()

int64_t CBlockIndex::GetHeaderReceivedTime ( ) const

inline

Definition at line 184 of file blockindex.h.

Here is the caller graph for this function:

◆ GetMedianTimePast()

int64_t CBlockIndex::GetMedianTimePast ( ) const

inline

Definition at line 192 of file blockindex.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetReceivedTimeDiff()

int64_t CBlockIndex::GetReceivedTimeDiff ( ) const

inline

Definition at line 186 of file blockindex.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetUndoPos()

FlatFilePos CBlockIndex::GetUndoPos ( ) const

inline

Definition at line 123 of file blockindex.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GUARDED_BY() [1/4]

int nFile CBlockIndex::GUARDED_BY ( ::cs_main )

inline

Which # file this block is stored in (blk?????.dat)

Definition at line 41 of file blockindex.h.

◆ GUARDED_BY() [2/4]

unsigned int nDataPos CBlockIndex::GUARDED_BY ( ::cs_main )

inline

Byte offset within blk?????.dat where this block's data is stored.

Definition at line 44 of file blockindex.h.

◆ GUARDED_BY() [3/4]

unsigned int nUndoPos CBlockIndex::GUARDED_BY ( ::cs_main )

inline

Byte offset within rev?????.dat where this block's undo data is stored.

Definition at line 47 of file blockindex.h.

◆ GUARDED_BY() [4/4]

BlockStatus nStatus CBlockIndex::GUARDED_BY ( ::cs_main )

inline

Verification status of this block. See enum BlockStatus.

Definition at line 87 of file blockindex.h.

◆ HaveTxsDownloaded()

bool CBlockIndex::HaveTxsDownloaded ( ) const

inline

Check whether this block's and all previous blocks' transactions have been downloaded (and stored to disk) at some point.

Does not imply the transactions are consensus-valid (ConnectTip might fail) Does not imply the transactions are still stored on disk. (IsBlockPruned might return true)

Definition at line 174 of file blockindex.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsAssumedValid()

bool CBlockIndex::IsAssumedValid ( ) const

inline

Returns: true if the block is assumed-valid; this means it is queued to be validated by a background chainstate.

Definition at line 219 of file blockindex.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsValid()

bool CBlockIndex::IsValid ( enum BlockValidity nUpTo = BlockValidity::TRANSACTIONS ) const

inline

Check whether this block index entry is valid up to the passed validity level.

Definition at line 211 of file blockindex.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ RaiseValidity()

bool CBlockIndex::RaiseValidity ( enum BlockValidity nUpTo )

inline

Raise the validity level of this block index entry.

Returns true if the validity was changed.

Definition at line 226 of file blockindex.h.

Here is the call graph for this function:

◆ Time()

NodeSeconds CBlockIndex::Time ( ) const

inline

Definition at line 176 of file blockindex.h.

Here is the caller graph for this function:

◆ ToString()

std::string CBlockIndex::ToString ( ) const

Definition at line 28 of file blockindex.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UpdateChainStats()

bool CBlockIndex::UpdateChainStats ( )

Update chain tx stats.

Definition at line 34 of file blockindex.cpp.

Here is the caller graph for this function:

Member Data Documentation

◆ hashMerkleRoot

uint256 CBlockIndex::hashMerkleRoot {}

Definition at line 91 of file blockindex.h.

◆ nBits

uint32_t CBlockIndex::nBits {0}

Definition at line 93 of file blockindex.h.

◆ nChainSize

uint64_t CBlockIndex::nChainSize {0}

private

(memory only) Size of all blocks in the chain up to and including this block.

This value will be non-zero only if and only if transactions for this block and all its parents are available.

Definition at line 83 of file blockindex.h.

◆ nChainTx

unsigned int CBlockIndex::nChainTx {0}

(memory only) Number of transactions in the chain up to and including this block.

This value will be non-zero only if and only if transactions for this block and all its parents are available. Change to 64-bit type when necessary; won't happen before 2030

Note: this value is faked during use of a UTXO snapshot because we don't have the underlying block data available during snapshot load.

See also: AssumeutxoData; ActivateSnapshot

Definition at line 77 of file blockindex.h.

◆ nChainWork

arith_uint256 CBlockIndex::nChainWork {}

(memory only) Total amount of work (expected number of hashes) in the chain up to and including this block

Definition at line 51 of file blockindex.h.

◆ nHeight

int CBlockIndex::nHeight {0}

height of the entry in the chain. The genesis block has height 0

Definition at line 38 of file blockindex.h.

◆ nMedianTimeSpan

constexpr int CBlockIndex::nMedianTimeSpan = 11

staticconstexpr

Definition at line 190 of file blockindex.h.

◆ nNonce

uint32_t CBlockIndex::nNonce {0}

Definition at line 94 of file blockindex.h.

◆ nSequenceId

int32_t CBlockIndex::nSequenceId {0}

(memory only) Sequential id assigned to distinguish order in which blocks are received.

Definition at line 98 of file blockindex.h.

◆ nSize

unsigned int CBlockIndex::nSize {0}

Size of this block.

Note: in a potential headers-first mode, this number cannot be relied upon

Definition at line 65 of file blockindex.h.

◆ nTime

uint32_t CBlockIndex::nTime {0}

Definition at line 92 of file blockindex.h.

◆ nTimeMax

unsigned int CBlockIndex::nTimeMax {0}

(memory only) Maximum nTime in the chain up to and including this block.

Definition at line 104 of file blockindex.h.

◆ nTimeReceived

int64_t CBlockIndex::nTimeReceived {0}

(memory only) block header metadata

Definition at line 101 of file blockindex.h.

◆ nTx

unsigned int CBlockIndex::nTx {0}

Number of transactions in this block.

Note: in a potential headers-first mode, this number cannot be relied upon Note: this value is faked during UTXO snapshot load to ensure that LoadBlockIndex() will load index entries for blocks that we lack data for.

See also: ActivateSnapshot

Definition at line 60 of file blockindex.h.

◆ nVersion

int32_t CBlockIndex::nVersion {0}

block header

Definition at line 90 of file blockindex.h.

◆ phashBlock

const BlockHash* CBlockIndex::phashBlock {nullptr}

pointer to the hash of the block, if any.

Memory is owned by this CBlockIndex

Definition at line 29 of file blockindex.h.

◆ pprev

CBlockIndex* CBlockIndex::pprev {nullptr}

pointer to the index of the predecessor of this block

Definition at line 32 of file blockindex.h.

◆ pskip

CBlockIndex* CBlockIndex::pskip {nullptr}

pointer to the index of some further predecessor of this block

Definition at line 35 of file blockindex.h.

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

src/blockindex.h
src/blockindex.cpp

Public Member Functions

Public Attributes

Static Public Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CBlockIndex() [1/2]

◆ CBlockIndex() [2/2]

Member Function Documentation

◆ BuildSkip()

◆ GetAncestor() [1/2]

◆ GetAncestor() [2/2]

◆ GetBlockHash()

◆ GetBlockHeader()

◆ GetBlockPos()

◆ GetBlockTime()

◆ GetBlockTimeMax()

◆ GetChainSize()

◆ GetChainTxCount()

◆ GetHeaderReceivedTime()

◆ GetMedianTimePast()

◆ GetReceivedTimeDiff()

◆ GetUndoPos()

◆ GUARDED_BY() [1/4]

◆ GUARDED_BY() [2/4]

◆ GUARDED_BY() [3/4]

◆ GUARDED_BY() [4/4]

◆ HaveTxsDownloaded()

◆ IsAssumedValid()

◆ IsValid()

◆ RaiseValidity()

◆ Time()

◆ ToString()

◆ UpdateChainStats()

Member Data Documentation

◆ hashMerkleRoot

◆ nBits

◆ nChainSize

◆ nChainTx

◆ nChainWork

◆ nHeight

◆ nMedianTimeSpan

◆ nNonce

◆ nSequenceId

◆ nSize

◆ nTime

◆ nTimeMax

◆ nTimeReceived

◆ nTx

◆ nVersion

◆ phashBlock

◆ pprev

◆ pskip