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 Types
enum	{ nMedianTimeSpan =11 }

Public Member Functions
void	SetNull ()

	CBlockIndex ()

	CBlockIndex (const CBlockHeader &block)

CDiskBlockPos	GetBlockPos () const

CDiskBlockPos	GetUndoPos () const

CBlockHeader	GetBlockHeader () const

uint256	GetBlockHash () const

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	RaiseValidity (enum BlockStatus nUpTo)
	Raise the validity level of this block index entry. More...

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

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

const CBlockIndex *	GetAncestor (int height) const

Public Attributes
const uint256 *	phashBlock
	pointer to the hash of the block, if any. Memory is owned by this CBlockIndex More...

CBlockIndex *	pprev
	pointer to the index of the predecessor of this block More...

CBlockIndex *	pskip
	pointer to the index of some further predecessor of this block More...

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

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

unsigned int	nDataPos
	Byte offset within blk?????.dat where this block's data is stored. More...

unsigned int	nUndoPos
	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
	Number of transactions in this block. More...

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

uint32_t	nStatus
	Verification status of this block. See enum BlockStatus. More...

int32_t	nVersion
	block header More...

uint256	hashMerkleRoot

uint32_t	nTime

uint32_t	nBits

uint32_t	nNonce

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

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

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

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
nMedianTimeSpan

Definition at line 309 of file chain.h.

Constructor & Destructor Documentation

◆ CBlockIndex() [1/2]

CBlockIndex::CBlockIndex ( )

inline

Definition at line 247 of file chain.h.

Here is the call graph for this function:

◆ CBlockIndex() [2/2]

CBlockIndex::CBlockIndex ( const CBlockHeader & block )

inlineexplicit

Definition at line 252 of file chain.h.

Here is the call graph for this function:

Member Function Documentation

◆ BuildSkip()

void CBlockIndex::BuildSkip ( )

Build the skiplist pointer for this entry.

Definition at line 115 of file chain.cpp.

◆ GetAncestor() [1/2]

CBlockIndex * CBlockIndex::GetAncestor ( int height )

Efficiently find an ancestor of this block.

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

◆ GetBlockHash()

uint256 CBlockIndex::GetBlockHash ( ) const

inline

Definition at line 294 of file chain.h.

Here is the caller graph for this function:

◆ GetBlockHeader()

CBlockHeader CBlockIndex::GetBlockHeader ( ) const

inline

Definition at line 281 of file chain.h.

Here is the call graph for this function:

◆ GetBlockPos()

CDiskBlockPos CBlockIndex::GetBlockPos ( ) const

inline

Definition at line 263 of file chain.h.

Here is the caller graph for this function:

◆ GetBlockTime()

int64_t CBlockIndex::GetBlockTime ( ) const

inline

Definition at line 299 of file chain.h.

Here is the caller graph for this function:

◆ GetBlockTimeMax()

int64_t CBlockIndex::GetBlockTimeMax ( ) const

inline

Definition at line 304 of file chain.h.

Here is the caller graph for this function:

◆ GetMedianTimePast()

int64_t CBlockIndex::GetMedianTimePast ( ) const

inline

Definition at line 311 of file chain.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetUndoPos()

CDiskBlockPos CBlockIndex::GetUndoPos ( ) const

inline

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

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

Here is the call graph for this function:

◆ SetNull()

void CBlockIndex::SetNull ( )

inline

Definition at line 224 of file chain.h.

◆ ToString()

std::string CBlockIndex::ToString ( ) const

inline

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

◆ nBits

uint32_t CBlockIndex::nBits

Definition at line 215 of file chain.h.

◆ nChainTx

unsigned int CBlockIndex::nChainTx

(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

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

◆ nDataPos

unsigned int CBlockIndex::nDataPos

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

Definition at line 191 of file chain.h.

◆ nFile

int CBlockIndex::nFile

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

Definition at line 188 of file chain.h.

◆ nHeight

int CBlockIndex::nHeight

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

Definition at line 185 of file chain.h.

◆ nNonce

uint32_t CBlockIndex::nNonce

Definition at line 216 of file chain.h.

◆ nSequenceId

int32_t CBlockIndex::nSequenceId

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

Definition at line 219 of file chain.h.

◆ nStatus

uint32_t CBlockIndex::nStatus

Verification status of this block. See enum BlockStatus.

Definition at line 209 of file chain.h.

◆ nTime

uint32_t CBlockIndex::nTime

Definition at line 214 of file chain.h.

◆ nTimeMax

unsigned int CBlockIndex::nTimeMax

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

Definition at line 222 of file chain.h.

◆ nTx

unsigned int CBlockIndex::nTx

Number of transactions in this block.

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

Definition at line 201 of file chain.h.

◆ nUndoPos

unsigned int CBlockIndex::nUndoPos

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

Definition at line 194 of file chain.h.

◆ nVersion

int32_t CBlockIndex::nVersion

block header

Definition at line 212 of file chain.h.

◆ phashBlock

const uint256* CBlockIndex::phashBlock

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

Definition at line 176 of file chain.h.

◆ pprev

CBlockIndex* CBlockIndex::pprev

pointer to the index of the predecessor of this block

Definition at line 179 of file chain.h.

◆ pskip

CBlockIndex* CBlockIndex::pskip

pointer to the index of some further predecessor of this block

Definition at line 182 of file chain.h.

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

src/chain.h
src/chain.cpp

Public Types

Public Member Functions

Public Attributes

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ CBlockIndex() [1/2]

◆ CBlockIndex() [2/2]

Member Function Documentation

◆ BuildSkip()

◆ GetAncestor() [1/2]

◆ GetAncestor() [2/2]

◆ GetBlockHash()

◆ GetBlockHeader()

◆ GetBlockPos()

◆ GetBlockTime()

◆ GetBlockTimeMax()

◆ GetMedianTimePast()

◆ GetUndoPos()

◆ IsValid()

◆ RaiseValidity()

◆ SetNull()

◆ ToString()

Member Data Documentation

◆ hashMerkleRoot

◆ nBits

◆ nChainTx

◆ nChainWork

◆ nDataPos

◆ nFile

◆ nHeight

◆ nNonce

◆ nSequenceId

◆ nStatus

◆ nTime

◆ nTimeMax

◆ nTx

◆ nUndoPos

◆ nVersion

◆ phashBlock

◆ pprev

◆ pskip