Dash Core Source Documentation (0.16.0.1)

Find detailed information regarding the Dash Core source code.

CChainState stores and provides an API to update our local knowledge of the current best chain and header tree. More...

+ Collaboration diagram for CChainState:

Public Member Functions

bool LoadBlockIndex (const Consensus::Params &consensus_params, CBlockTreeDB &blocktree)
 
bool ActivateBestChain (CValidationState &state, const CChainParams &chainparams, std::shared_ptr< const CBlock > pblock)
 Make the best chain active, in multiple steps. More...
 
bool AcceptBlockHeader (const CBlockHeader &block, CValidationState &state, const CChainParams &chainparams, CBlockIndex **ppindex)
 
bool AcceptBlock (const std::shared_ptr< const CBlock > &pblock, CValidationState &state, const CChainParams &chainparams, CBlockIndex **ppindex, bool fRequested, const CDiskBlockPos *dbp, bool *fNewBlock)
 Store block on disk. More...
 
DisconnectResult DisconnectBlock (const CBlock &block, const CBlockIndex *pindex, CCoinsViewCache &view)
 Undo the effects of this block (with given index) on the UTXO set represented by coins. More...
 
bool ConnectBlock (const CBlock &block, CValidationState &state, CBlockIndex *pindex, CCoinsViewCache &view, const CChainParams &chainparams, bool fJustCheck=false)
 Apply the effects of this block (with given index) on the UTXO set represented by coins. More...
 
bool DisconnectTip (CValidationState &state, const CChainParams &chainparams, DisconnectedBlockTransactions *disconnectpool)
 Disconnect chainActive's tip. More...
 
bool PreciousBlock (CValidationState &state, const CChainParams &params, CBlockIndex *pindex)
 
bool InvalidateBlock (CValidationState &state, const CChainParams &chainparams, CBlockIndex *pindex)
 
bool ResetBlockFailureFlags (CBlockIndex *pindex)
 
bool ReplayBlocks (const CChainParams &params, CCoinsView *view)
 
bool RewindBlockIndex (const CChainParams &params)
 
bool LoadGenesisBlock (const CChainParams &chainparams)
 
bool AddGenesisBlock (const CChainParams &chainparams, const CBlock &block, CValidationState &state)
 
void PruneBlockIndexCandidates ()
 Delete all entries in setBlockIndexCandidates that are worse than the current tip. More...
 
void UnloadBlockIndex ()
 

Public Attributes

CChain chainActive
 
BlockMap mapBlockIndex
 
PrevBlockMap mapPrevBlockIndex
 
std::multimap< CBlockIndex *, CBlockIndex * > mapBlocksUnlinked
 
CBlockIndexpindexBestInvalid = nullptr
 

Private Member Functions

bool ActivateBestChainStep (CValidationState &state, const CChainParams &chainparams, CBlockIndex *pindexMostWork, const std::shared_ptr< const CBlock > &pblock, bool &fInvalidFound, ConnectTrace &connectTrace)
 Try to make some progress towards making pindexMostWork the active block. More...
 
bool ConnectTip (CValidationState &state, const CChainParams &chainparams, CBlockIndex *pindexNew, const std::shared_ptr< const CBlock > &pblock, ConnectTrace &connectTrace, DisconnectedBlockTransactions &disconnectpool)
 Connect a new block to chainActive. More...
 
CBlockIndexAddToBlockIndex (const CBlockHeader &block, enum BlockStatus nStatus=BLOCK_VALID_TREE)
 
CBlockIndexInsertBlockIndex (const uint256 &hash)
 Create a new block index entry for a given block hash. More...
 
void CheckBlockIndex (const Consensus::Params &consensusParams)
 
void InvalidBlockFound (CBlockIndex *pindex, const CValidationState &state)
 
CBlockIndexFindMostWorkChain ()
 Return the tip of the chain with the most work in it, that isn't known to be invalid (it's however far from certain to be valid). More...
 
bool ReceivedBlockTransactions (const CBlock &block, CValidationState &state, CBlockIndex *pindexNew, const CDiskBlockPos &pos)
 Mark a block as having its data received and checked (up to BLOCK_VALID_TRANSACTIONS). More...
 
bool RollforwardBlock (const CBlockIndex *pindex, CCoinsViewCache &inputs, const CChainParams &params)
 Apply the effects of a block on the utxo cache, ignoring that it may already have been applied. More...
 

Private Attributes

std::set< CBlockIndex *, CBlockIndexWorkComparator > setBlockIndexCandidates
 The set of all CBlockIndex entries with BLOCK_VALID_TRANSACTIONS (for itself and all ancestors) and as good as our current tip or better. More...
 
CCriticalSection cs_nBlockSequenceId
 Every received block is assigned a unique and increasing identifier, so we know which one to give priority in case of a fork. More...
 
int32_t nBlockSequenceId = 1
 Blocks loaded from disk are assigned id 0, so start the counter at 1. More...
 
int32_t nBlockReverseSequenceId = -1
 Decreasing counter (used by subsequent preciousblock calls). More...
 
arith_uint256 nLastPreciousChainwork = 0
 chainwork for the last block that preciousblock has been applied to. More...
 
std::set< CBlockIndex * > g_failed_blocks
 In order to efficiently track invalidity of headers, we keep the set of blocks which we tried to connect and found to be invalid here (ie which were set to BLOCK_FAILED_VALID since the last restart). More...
 

Detailed Description

CChainState stores and provides an API to update our local knowledge of the current best chain and header tree.

It generally provides access to the current block tree, as well as functions to provide new data, which it will appropriately validate and incorporate in its state as necessary.

Eventually, the API here is targeted at being exposed externally as a consumable libconsensus library, so any functions added must only call other class member functions, pure functions in other parts of the consensus library, callbacks via the validation interface, or read/write-to-disk functions (eventually this will also be via callbacks).

Definition at line 117 of file validation.cpp.

Member Function Documentation

◆ AcceptBlock()

◆ AcceptBlockHeader()

◆ ActivateBestChain()

◆ ActivateBestChainStep()

bool CChainState::ActivateBestChainStep ( CValidationState state,
const CChainParams chainparams,
CBlockIndex pindexMostWork,
const std::shared_ptr< const CBlock > &  pblock,
bool &  fInvalidFound,
ConnectTrace connectTrace 
)
private

◆ AddGenesisBlock()

bool CChainState::AddGenesisBlock ( const CChainParams chainparams,
const CBlock block,
CValidationState state 
)

◆ AddToBlockIndex()

◆ CheckBlockIndex()

◆ ConnectBlock()

bool CChainState::ConnectBlock ( const CBlock block,
CValidationState state,
CBlockIndex pindex,
CCoinsViewCache view,
const CChainParams chainparams,
bool  fJustCheck = false 
)

Apply the effects of this block (with given index) on the UTXO set represented by coins.

Validity checks that depend on the UTXO set are also done; ConnectBlock() can fail if those validity checks fail (among other reasons).

DASH: Check superblock start

END DASH

Definition at line 1983 of file validation.cpp.

References CCoinsViewCache::AccessCoin(), CCheckQueueControl< T >::Add(), AssertLockHeld(), prevector< N, T, Size, Diff >::begin(), BCLog::BENCHMARK, Consensus::Params::BIP34Hash, Consensus::Params::BIP34Height, BLOCK_VALID_SCRIPTS, llmq::chainLocksHandler, CheckBlock(), CheckInputs(), Consensus::CheckTxInputs(), cs_main, Consensus::DEPLOYMENT_CSV, Consensus::Params::DIP0001Height, Consensus::Params::DIP0003Height, CValidationState::DoS(), prevector< N, T, Size, Diff >::end(), error(), evoDb, fAddressIndex, flags, FormatStateMessage(), fSpentIndex, fTimestampIndex, CBlockIndex::GetAncestor(), CCoinsViewCache::GetBestBlock(), CBlockIndex::GetBlockHash(), GetBlockProofEquivalentTime(), GetBlockScriptFlags(), GetBlockSubsidy(), llmq::CInstantSendManager::GetConflictingLock(), CChainParams::GetConsensus(), CBlockHeader::GetHash(), CTransaction::GetHash(), GetTimeMicros(), GetTransactionSigOpCount(), llmq::CChainLocksHandler::HasConflictingChainLock(), COutPoint::hash, Hash160(), hashAssumeValid, Consensus::Params::hashGenesisBlock, CCoinsViewCache::HaveCoin(), IsBlockPayeeValid(), IsBlockValueValid(), CTransaction::IsCoinBase(), base_blob< BITS >::IsNull(), CScript::IsPayToPublicKey(), CScript::IsPayToPublicKeyHash(), CScript::IsPayToScriptHash(), CSporkManager::IsSporkActive(), CBlockIndex::IsValid(), LOCK, LOCKTIME_VERIFY_SEQUENCE, LogPrint, LogPrintf, mapBlockIndex, MaxBlockSigOps(), MICRO, MILLI, MoneyRange(), COutPoint::n, CBlockIndex::nBits, nBlocksTotal, CBlockIndex::nChainWork, Coin::nHeight, CBlockIndex::nHeight, nMinimumChainWork, nScriptCheckThreads, Consensus::Params::nSuperblockStartBlock, Consensus::Params::nSuperblockStartHash, CBlockIndex::nTime, nTimeCallbacks, nTimeCheck, nTimeConnect, nTimeDashSpecific, nTimeForks, nTimeIndex, nTimeISFilter, nTimePayeeValid, nTimeProcessSpecial, nTimeSubsidy, nTimeValueValid, nTimeVerify, CTxOut::nValue, Coin::out, Params(), pblocktree, CBlockIndex::phashBlock, pindexBestHeader, CBlockIndex::pprev, CTxIn::prevout, ProcessSpecialTxsInBlock(), llmq::quorumInstantSendManager, CBlockIndex::RaiseValidity(), REJECT_INVALID, llmq::CInstantSendManager::RemoveChainLockConflictingLock(), scriptcheckqueue, CTxOut::scriptPubKey, SequenceLocks(), SerializeHash(), CCoinsViewCache::SetBestBlock(), base_blob< BITS >::SetNull(), SPORK_3_INSTANTSEND_BLOCK_FILTERING, sporkManager, THRESHOLD_ACTIVE, base_blob< BITS >::ToString(), uint256S(), UpdateCoins(), versionbitscache, VersionBitsState(), CTransaction::vin, CTransaction::vout, CBlock::vtx, CBlockUndo::vtxundo, CCheckQueueControl< T >::Wait(), WriteTxIndexDataForBlock(), and WriteUndoDataForBlock().

Referenced by ConnectTip(), TestBlockValidity(), and CVerifyDB::VerifyDB().

◆ ConnectTip()

bool CChainState::ConnectTip ( CValidationState state,
const CChainParams chainparams,
CBlockIndex pindexNew,
const std::shared_ptr< const CBlock > &  pblock,
ConnectTrace connectTrace,
DisconnectedBlockTransactions disconnectpool 
)
private

◆ DisconnectBlock()

◆ DisconnectTip()

bool CChainState::DisconnectTip ( CValidationState state,
const CChainParams chainparams,
DisconnectedBlockTransactions disconnectpool 
)

Disconnect chainActive's tip.

After calling, the mempool will be in an inconsistent state, with transactions from disconnected blocks being added to disconnectpool. You should make the mempool consistent again by calling UpdateMempoolForReorg. with cs_main held.

If disconnectpool is nullptr, then no disconnected transactions are added to disconnectpool (note that the caller is responsible for mempool consistency in any case).

Definition at line 2615 of file validation.cpp.

References DisconnectedBlockTransactions::addTransaction(), BCLog::BENCHMARK, CMainSignals::BlockDisconnected(), chainActive, DISCONNECT_OK, DisconnectBlock(), DisconnectedBlockTransactions::DynamicMemoryUsage(), error(), evoDb, FLUSH_STATE_IF_NEEDED, FlushStateToDisk(), CBlockIndex::GetBlockHash(), CChainParams::GetConsensus(), GetMainSignals(), GetTimeMicros(), LogPrint, MAX_DISCONNECTED_TX_POOL_SIZE, mempool, MILLI, pcoinsTip, CBlockIndex::pprev, DisconnectedBlockTransactions::queuedTx, ReadBlockFromDisk(), DisconnectedBlockTransactions::removeEntry(), CTxMemPool::removeRecursive(), REORG, CChain::SetTip(), CChain::Tip(), base_blob< BITS >::ToString(), and UpdateTip().

Referenced by ActivateBestChainStep(), and InvalidateBlock().

◆ FindMostWorkChain()

CBlockIndex * CChainState::FindMostWorkChain ( )
private

Return the tip of the chain with the most work in it, that isn't known to be invalid (it's however far from certain to be valid).

Definition at line 2803 of file validation.cpp.

References BLOCK_FAILED_CHILD, BLOCK_FAILED_MASK, BLOCK_HAVE_DATA, chainActive, CChain::Contains(), mapBlocksUnlinked, CBlockIndex::nChainTx, CBlockIndex::nChainWork, CBlockIndex::nHeight, CBlockIndex::nStatus, pindexBestInvalid, CBlockIndex::pprev, and setBlockIndexCandidates.

Referenced by ActivateBestChain().

◆ InsertBlockIndex()

CBlockIndex * CChainState::InsertBlockIndex ( const uint256 hash)
private

Create a new block index entry for a given block hash.

Definition at line 4070 of file validation.cpp.

References base_blob< BITS >::IsNull(), and mapBlockIndex.

◆ InvalidateBlock()

◆ InvalidBlockFound()

void CChainState::InvalidBlockFound ( CBlockIndex pindex,
const CValidationState state 
)
private

◆ LoadBlockIndex()

◆ LoadGenesisBlock()

◆ PreciousBlock()

◆ PruneBlockIndexCandidates()

void CChainState::PruneBlockIndexCandidates ( )

Delete all entries in setBlockIndexCandidates that are worse than the current tip.

Definition at line 2858 of file validation.cpp.

References chainActive, setBlockIndexCandidates, and CChain::Tip().

Referenced by ActivateBestChainStep(), LoadChainTip(), and PreciousBlock().

◆ ReceivedBlockTransactions()

bool CChainState::ReceivedBlockTransactions ( const CBlock block,
CValidationState state,
CBlockIndex pindexNew,
const CDiskBlockPos pos 
)
private

◆ ReplayBlocks()

◆ ResetBlockFailureFlags()

◆ RewindBlockIndex()

bool CChainState::RewindBlockIndex ( const CChainParams params)

◆ RollforwardBlock()

bool CChainState::RollforwardBlock ( const CBlockIndex pindex,
CCoinsViewCache inputs,
const CChainParams params 
)
private

Apply the effects of a block on the utxo cache, ignoring that it may already have been applied.

Definition at line 4351 of file validation.cpp.

References AddCoins(), error(), FormatStateMessage(), CBlockIndex::GetBlockHash(), CChainParams::GetConsensus(), CBlockIndex::nHeight, CTxIn::prevout, ProcessSpecialTxsInBlock(), ReadBlockFromDisk(), CCoinsViewCache::SpendCoin(), base_blob< BITS >::ToString(), and CBlock::vtx.

Referenced by ReplayBlocks().

◆ UnloadBlockIndex()

void CChainState::UnloadBlockIndex ( )

Definition at line 4455 of file validation.cpp.

References g_failed_blocks, nBlockSequenceId, and setBlockIndexCandidates.

Referenced by UnloadBlockIndex().

Member Data Documentation

◆ chainActive

◆ cs_nBlockSequenceId

CCriticalSection CChainState::cs_nBlockSequenceId
private

Every received block is assigned a unique and increasing identifier, so we know which one to give priority in case of a fork.

Definition at line 130 of file validation.cpp.

Referenced by ReceivedBlockTransactions().

◆ g_failed_blocks

std::set<CBlockIndex*> CChainState::g_failed_blocks
private

In order to efficiently track invalidity of headers, we keep the set of blocks which we tried to connect and found to be invalid here (ie which were set to BLOCK_FAILED_VALID since the last restart).

We can then walk this set and check if a new header is a descendant of something in this set, preventing us from having to walk mapBlockIndex when we try to connect a bad block and fail.

While this is more complicated than marking everything which descends from an invalid block as invalid at the time we discover it to be invalid, doing so would require walking all of mapBlockIndex to find all descendants. Since this case should be very rare, keeping track of all BLOCK_FAILED_VALID blocks in a set should be just fine and work just as well.

Because we already walk mapBlockIndex in height-order at startup, we go ahead and mark descendants of invalid blocks as FAILED_CHILD at that time, instead of putting things in this set.

Definition at line 156 of file validation.cpp.

Referenced by AcceptBlockHeader(), InvalidateBlock(), InvalidBlockFound(), ResetBlockFailureFlags(), and UnloadBlockIndex().

◆ mapBlockIndex

◆ mapBlocksUnlinked

std::multimap<CBlockIndex*, CBlockIndex*> CChainState::mapBlocksUnlinked

◆ mapPrevBlockIndex

PrevBlockMap CChainState::mapPrevBlockIndex

Definition at line 161 of file validation.cpp.

Referenced by AddToBlockIndex(), and LoadBlockIndex().

◆ nBlockReverseSequenceId

int32_t CChainState::nBlockReverseSequenceId = -1
private

Decreasing counter (used by subsequent preciousblock calls).

Definition at line 134 of file validation.cpp.

Referenced by PreciousBlock().

◆ nBlockSequenceId

int32_t CChainState::nBlockSequenceId = 1
private

Blocks loaded from disk are assigned id 0, so start the counter at 1.

Definition at line 132 of file validation.cpp.

Referenced by ReceivedBlockTransactions(), and UnloadBlockIndex().

◆ nLastPreciousChainwork

arith_uint256 CChainState::nLastPreciousChainwork = 0
private

chainwork for the last block that preciousblock has been applied to.

Definition at line 136 of file validation.cpp.

Referenced by PreciousBlock().

◆ pindexBestInvalid

CBlockIndex* CChainState::pindexBestInvalid = nullptr

◆ setBlockIndexCandidates

std::set<CBlockIndex*, CBlockIndexWorkComparator> CChainState::setBlockIndexCandidates
private

The set of all CBlockIndex entries with BLOCK_VALID_TRANSACTIONS (for itself and all ancestors) and as good as our current tip or better.

Entries may be failed, though, and pruning nodes may be missing the data for the block.

Definition at line 124 of file validation.cpp.

Referenced by CheckBlockIndex(), FindMostWorkChain(), InvalidateBlock(), InvalidBlockFound(), LoadBlockIndex(), PreciousBlock(), PruneBlockIndexCandidates(), ReceivedBlockTransactions(), ResetBlockFailureFlags(), and UnloadBlockIndex().


The documentation for this class was generated from the following file:
Released under the MIT license