Bitcoin Core  22.99.0
P2P Digital Currency
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
CBlockIndex Class Reference

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 <chain.h>

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

Public Member Functions

 CBlockIndex ()
 
 CBlockIndex (const CBlockHeader &block)
 
FlatFilePos GetBlockPos () const
 
FlatFilePos GetUndoPos () const
 
CBlockHeader GetBlockHeader () const
 
uint256 GetBlockHash () const
 
bool HaveTxsDownloaded () const
 Check whether this block's and all previous blocks' transactions have been downloaded (and stored to disk) at some point. More...
 
int64_t GetBlockTime () const
 
int64_t GetBlockTimeMax () const
 
int64_t GetMedianTimePast () const
 
std::string ToString () const
 
bool IsValid (enum BlockStatus nUpTo=BLOCK_VALID_TRANSACTIONS) const
 Check whether this block index entry is valid up to the passed validity level. More...
 
bool IsAssumedValid () const
 
bool RaiseValidity (enum BlockStatus nUpTo)
 Raise the validity level of this block index entry. More...
 
void BuildSkip ()
 Build the skiplist pointer for this entry. More...
 
CBlockIndexGetAncestor (int height)
 Efficiently find an ancestor of this block. More...
 
const CBlockIndexGetAncestor (int height) const
 

Public Attributes

const uint256phashBlock {nullptr}
 pointer to the hash of the block, if any. Memory is owned by this CBlockIndex More...
 
CBlockIndexpprev {nullptr}
 pointer to the index of the predecessor of this block More...
 
CBlockIndexpskip {nullptr}
 pointer to the index of some further predecessor of this block More...
 
int nHeight {0}
 height of the entry in the chain. The genesis block has height 0 More...
 
int nFile {0}
 Which # file this block is stored in (blk?????.dat) More...
 
unsigned int nDataPos {0}
 Byte offset within blk?????.dat where this block's data is stored. More...
 
unsigned int nUndoPos {0}
 Byte offset within rev?????.dat where this block's undo data is stored. More...
 
arith_uint256 nChainWork {}
 (memory only) Total amount of work (expected number of hashes) in the chain up to and including this block More...
 
unsigned int nTx {0}
 Number of transactions in this block. More...
 
unsigned int nChainTx {0}
 (memory only) Number of transactions in the chain up to and including this block. More...
 
uint32_t nStatus {0}
 Verification status of this block. More...
 
int32_t nVersion {0}
 block header More...
 
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. More...
 
unsigned int nTimeMax {0}
 (memory only) Maximum nTime in the chain up to and including this block. More...
 

Static Public Attributes

static constexpr int nMedianTimeSpan = 11
 

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 145 of file chain.h.

Constructor & Destructor Documentation

◆ CBlockIndex() [1/2]

CBlockIndex::CBlockIndex ( )
inline

Definition at line 210 of file chain.h.

◆ CBlockIndex() [2/2]

CBlockIndex::CBlockIndex ( const CBlockHeader block)
inlineexplicit

Definition at line 214 of file chain.h.

Member Function Documentation

◆ BuildSkip()

void CBlockIndex::BuildSkip ( )

Build the skiplist pointer for this entry.

Definition at line 116 of file chain.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 111 of file chain.cpp.

Here is the caller graph for this function:

◆ GetAncestor() [2/2]

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

Definition at line 84 of file chain.cpp.

Here is the call graph for this function:

◆ GetBlockHash()

uint256 CBlockIndex::GetBlockHash ( ) const
inline

Definition at line 254 of file chain.h.

◆ GetBlockHeader()

CBlockHeader CBlockIndex::GetBlockHeader ( ) const
inline

Definition at line 241 of file chain.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GetBlockPos()

FlatFilePos CBlockIndex::GetBlockPos ( ) const
inline

Definition at line 223 of file chain.h.

Here is the caller graph for this function:

◆ GetBlockTime()

int64_t CBlockIndex::GetBlockTime ( ) const
inline

Definition at line 268 of file chain.h.

Here is the caller graph for this function:

◆ GetBlockTimeMax()

int64_t CBlockIndex::GetBlockTimeMax ( ) const
inline

Definition at line 273 of file chain.h.

Here is the caller graph for this function:

◆ GetMedianTimePast()

int64_t CBlockIndex::GetMedianTimePast ( ) const
inline

Definition at line 280 of file chain.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 232 of file chain.h.

Here is the caller graph for this function:

◆ 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 266 of file chain.h.

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 313 of file chain.h.

Here is the caller graph for this function:

◆ IsValid()

bool CBlockIndex::IsValid ( enum BlockStatus  nUpTo = BLOCK_VALID_TRANSACTIONS) const
inline

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

Definition at line 303 of file chain.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ RaiseValidity()

bool CBlockIndex::RaiseValidity ( enum BlockStatus  nUpTo)
inline

Raise the validity level of this block index entry.

Returns true if the validity was changed.

Definition at line 317 of file chain.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ToString()

std::string CBlockIndex::ToString ( ) const
inline

Definition at line 294 of file chain.h.

Here is the call graph for this function:
Here is the caller graph for this function:

Member Data Documentation

◆ hashMerkleRoot

uint256 CBlockIndex::hashMerkleRoot {}

Definition at line 199 of file chain.h.

◆ nBits

uint32_t CBlockIndex::nBits {0}

Definition at line 201 of file chain.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 before 2024 (assuming worst case of 60 byte transactions).

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 187 of file chain.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 170 of file chain.h.

◆ nDataPos

unsigned int CBlockIndex::nDataPos {0}

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

Definition at line 164 of file chain.h.

◆ nFile

int CBlockIndex::nFile {0}

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

Definition at line 161 of file chain.h.

◆ nHeight

int CBlockIndex::nHeight {0}

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

Definition at line 158 of file chain.h.

◆ nMedianTimeSpan

constexpr int CBlockIndex::nMedianTimeSpan = 11
staticconstexpr

Definition at line 278 of file chain.h.

◆ nNonce

uint32_t CBlockIndex::nNonce {0}

Definition at line 202 of file chain.h.

◆ nSequenceId

int32_t CBlockIndex::nSequenceId {0}

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

Definition at line 205 of file chain.h.

◆ nStatus

uint32_t CBlockIndex::nStatus {0}

Verification status of this block.

See enum BlockStatus

Note: this value is modified to show BLOCK_OPT_WITNESS during UTXO snapshot load to avoid the block index being spuriously rewound.

See also
NeedsRedownload
ActivateSnapshot

Definition at line 195 of file chain.h.

◆ nTime

uint32_t CBlockIndex::nTime {0}

Definition at line 200 of file chain.h.

◆ nTimeMax

unsigned int CBlockIndex::nTimeMax {0}

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

Definition at line 208 of file chain.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 177 of file chain.h.

◆ nUndoPos

unsigned int CBlockIndex::nUndoPos {0}

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

Definition at line 167 of file chain.h.

◆ nVersion

int32_t CBlockIndex::nVersion {0}

block header

Definition at line 198 of file chain.h.

◆ phashBlock

const uint256* CBlockIndex::phashBlock {nullptr}

pointer to the hash of the block, if any. Memory is owned by this CBlockIndex

Definition at line 149 of file chain.h.

◆ pprev

CBlockIndex* CBlockIndex::pprev {nullptr}

pointer to the index of the predecessor of this block

Definition at line 152 of file chain.h.

◆ pskip

CBlockIndex* CBlockIndex::pskip {nullptr}

pointer to the index of some further predecessor of this block

Definition at line 155 of file chain.h.


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