#include <rpc/blockchain.h>
#include <blockfilter.h>
#include <chain.h>
#include <chainparams.h>
#include <coins.h>
#include <config.h>
#include <consensus/amount.h>
#include <consensus/params.h>
#include <consensus/validation.h>
#include <core_io.h>
#include <fs.h>
#include <hash.h>
#include <index/blockfilterindex.h>
#include <index/coinstatsindex.h>
#include <logging/timer.h>
#include <net.h>
#include <net_processing.h>
#include <node/blockstorage.h>
#include <node/coinstats.h>
#include <node/context.h>
#include <node/utxo_snapshot.h>
#include <policy/policy.h>
#include <policy/settings.h>
#include <primitives/transaction.h>
#include <rpc/server.h>
#include <rpc/server_util.h>
#include <rpc/util.h>
#include <script/descriptor.h>
#include <streams.h>
#include <txdb.h>
#include <txmempool.h>
#include <undo.h>
#include <util/check.h>
#include <util/strencodings.h>
#include <util/translation.h>
#include <validation.h>
#include <validationinterface.h>
#include <warnings.h>
#include <condition_variable>
#include <cstdint>
#include <memory>
#include <mutex>

Include dependency graph for blockchain.cpp:

Classes
struct	CUpdatedBlock

struct	CompareBlocksByHeight
	Comparison function for sorting the getchaintips heads. More...

class	CoinsViewScanReserver

Functions
static CUpdatedBlock latestblock	GUARDED_BY (cs_blockchange)

double	GetDifficulty (const CBlockIndex *blockindex)
	Calculate the difficulty for a given block index. More...

static int	ComputeNextBlockAndDepth (const CBlockIndex tip, const CBlockIndex blockindex, const CBlockIndex *&next)

static const CBlockIndex *	ParseHashOrHeight (const UniValue &param, ChainstateManager &chainman)

UniValue	blockheaderToJSON (const CBlockIndex tip, const CBlockIndex blockindex)
	Block header to JSON. More...

UniValue	blockToJSON (BlockManager &blockman, const CBlock &block, const CBlockIndex tip, const CBlockIndex blockindex, bool txDetails)
	Block description to JSON. More...

static RPCHelpMan	getblockcount ()

static RPCHelpMan	getbestblockhash ()

void	RPCNotifyBlockChange (const CBlockIndex *pindex)
	Callback for when block tip changed. More...

static RPCHelpMan	waitfornewblock ()

static RPCHelpMan	waitforblock ()

static RPCHelpMan	waitforblockheight ()

static RPCHelpMan	syncwithvalidationinterfacequeue ()

static RPCHelpMan	getdifficulty ()

static std::vector< RPCResult >	MempoolEntryDescription ()

static void	entryToJSON (const CTxMemPool &pool, UniValue &info, const CTxMemPoolEntry &e) EXCLUSIVE_LOCKS_REQUIRED(pool.cs)

UniValue	MempoolToJSON (const CTxMemPool &pool, bool verbose, bool include_mempool_sequence)
	Mempool to JSON. More...

static RPCHelpMan	getrawmempool ()

static RPCHelpMan	getmempoolancestors ()

static RPCHelpMan	getmempooldescendants ()

static RPCHelpMan	getmempoolentry ()

static RPCHelpMan	getblockfrompeer ()

static RPCHelpMan	getblockhash ()

static RPCHelpMan	getblockheader ()

static CBlock	GetBlockChecked (const Config &config, BlockManager &blockman, const CBlockIndex *pblockindex)

static CBlockUndo	GetUndoChecked (BlockManager &blockman, const CBlockIndex *pblockindex)

static RPCHelpMan	getblock ()

static RPCHelpMan	pruneblockchain ()

static CoinStatsHashType	ParseHashType (const std::string &hash_type_input)

static RPCHelpMan	gettxoutsetinfo ()

RPCHelpMan	gettxout ()

static RPCHelpMan	verifychain ()

RPCHelpMan	getblockchaininfo ()

static RPCHelpMan	getchaintips ()

UniValue	MempoolInfoToJSON (const CTxMemPool &pool)
	Mempool information to JSON. More...

static RPCHelpMan	getmempoolinfo ()

static RPCHelpMan	preciousblock ()

static RPCHelpMan	invalidateblock ()

RPCHelpMan	parkblock ()

static RPCHelpMan	reconsiderblock ()

RPCHelpMan	unparkblock ()

static RPCHelpMan	getchaintxstats ()

template<typename T >
static T	CalculateTruncatedMedian (std::vector< T > &scores)

template<typename T >
static bool	SetHasKeys (const std::set< T > &set)

template<typename T , typename Tk , typename... Args>
static bool	SetHasKeys (const std::set< T > &set, const Tk &key, const Args &...args)

static RPCHelpMan	getblockstats ()

static RPCHelpMan	savemempool ()

static RPCHelpMan	scantxoutset ()

static RPCHelpMan	getblockfilter ()

static RPCHelpMan	dumptxoutset ()
	Serialize the UTXO set to a file for loading elsewhere. More...

UniValue	CreateUTXOSnapshot (NodeContext &node, Chainstate &chainstate, AutoFile &afile, const fs::path &path, const fs::path &temppath)
	Helper to create UTXO snapshots given a chainstate and a file handle. More...

void	RegisterBlockchainRPCCommands (CRPCTable &t)

Variables
static GlobalMutex	cs_blockchange

static std::condition_variable	cond_blockchange

static constexpr size_t	PER_UTXO_OVERHEAD

static std::atomic< int >	g_scan_progress
	RAII object to prevent concurrency issue when scanning the txout set. More...

static std::atomic< bool >	g_scan_in_progress

static std::atomic< bool >	g_should_abort_scan

Function Documentation

◆ blockheaderToJSON()

UniValue blockheaderToJSON	(	const CBlockIndex *	tip,
		const CBlockIndex *	blockindex
	)

Block header to JSON.

Definition at line 133 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ blockToJSON()

UniValue blockToJSON	(	BlockManager &	blockman,
		const CBlock &	block,
		const CBlockIndex *	tip,
		const CBlockIndex *	blockindex,
		bool	txDetails
	)

Block description to JSON.

Definition at line 167 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CalculateTruncatedMedian()

template<typename T >

static T CalculateTruncatedMedian ( std::vector< T > & scores )

static

Definition at line 2317 of file blockchain.cpp.

Here is the caller graph for this function:

◆ ComputeNextBlockAndDepth()

static int ComputeNextBlockAndDepth	(	const CBlockIndex *	tip,
		const CBlockIndex *	blockindex,
		const CBlockIndex *&	next
	)

static

Definition at line 90 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CreateUTXOSnapshot()

UniValue CreateUTXOSnapshot	(	node::NodeContext &	node,
		Chainstate &	chainstate,
		AutoFile &	afile,
		const fs::path &	path,
		const fs::path &	tmppath
	)

Helper to create UTXO snapshots given a chainstate and a file handle.

Returns: a UniValue map containing metadata about the snapshot.

Definition at line 3100 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ dumptxoutset()

static RPCHelpMan dumptxoutset ( )

static

Serialize the UTXO set to a file for loading elsewhere.

See also: SnapshotMetadata

Definition at line 3042 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ entryToJSON()

static void entryToJSON	(	const CTxMemPool &	pool,
		UniValue &	info,
		const CTxMemPoolEntry &	e
	)

static

Definition at line 499 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getbestblockhash()

static RPCHelpMan getbestblockhash ( )

static

Definition at line 218 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getblock()

static RPCHelpMan getblock ( )

static

Definition at line 1042 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getblockchaininfo()

RPCHelpMan getblockchaininfo ( )

Definition at line 1650 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetBlockChecked()

static CBlock GetBlockChecked	(	const Config &	config,
		BlockManager &	blockman,
		const CBlockIndex *	pblockindex
	)

static

Definition at line 1000 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getblockcount()

static RPCHelpMan getblockcount ( )

static

Definition at line 200 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getblockfilter()

static RPCHelpMan getblockfilter ( )

static

Definition at line 2941 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getblockfrompeer()

static RPCHelpMan getblockfrompeer ( )

static

Definition at line 823 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getblockhash()

static RPCHelpMan getblockhash ( )

static

Definition at line 875 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getblockheader()

static RPCHelpMan getblockheader ( )

static

Definition at line 904 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getblockstats()

static RPCHelpMan getblockstats ( )

static

Definition at line 2344 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getchaintips()

static RPCHelpMan getchaintips ( )

static

Idea: The set of chain tips is the active chain tip, plus orphan blocks which do not have another orphan building off of them. Algorithm:

Make one pass through BlockIndex(), picking out the orphan blocks, and also storing a set of the orphan block's pprev pointers.
Iterate through the orphan blocks. If the block isn't pointed to by another orphan, it is a chain tip.
Add the active chain tip

Definition at line 1763 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getchaintxstats()

static RPCHelpMan getchaintxstats ( )

static

Definition at line 2204 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getdifficulty()

static RPCHelpMan getdifficulty ( )

static

Definition at line 441 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetDifficulty()

double GetDifficulty ( const CBlockIndex * blockindex )

Calculate the difficulty for a given block index.

Get the required difficulty of the next block w/r/t the given block index.

Definition at line 72 of file blockchain.cpp.

Here is the caller graph for this function:

◆ getmempoolancestors()

static RPCHelpMan getmempoolancestors ( )

static

Definition at line 646 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getmempooldescendants()

static RPCHelpMan getmempooldescendants ( )

static

Definition at line 717 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getmempoolentry()

static RPCHelpMan getmempoolentry ( )

static

Definition at line 791 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getmempoolinfo()

static RPCHelpMan getmempoolinfo ( )

static

Definition at line 1908 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getrawmempool()

static RPCHelpMan getrawmempool ( )

static

Definition at line 580 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gettxout()

RPCHelpMan gettxout ( )

Definition at line 1507 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gettxoutsetinfo()

static RPCHelpMan gettxoutsetinfo ( )

static

Definition at line 1270 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetUndoChecked()

static CBlockUndo GetUndoChecked	(	BlockManager &	blockman,
		const CBlockIndex *	pblockindex
	)

static

Definition at line 1023 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GUARDED_BY()

static CUpdatedBlock latestblock GUARDED_BY ( cs_blockchange )

static

◆ invalidateblock()

static RPCHelpMan invalidateblock ( )

static

Definition at line 1995 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ MempoolEntryDescription()

static std::vector<RPCResult> MempoolEntryDescription ( )

static

Definition at line 461 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ MempoolInfoToJSON()

UniValue MempoolInfoToJSON ( const CTxMemPool & pool )

Mempool information to JSON.

Definition at line 1888 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ MempoolToJSON()

UniValue MempoolToJSON	(	const CTxMemPool &	pool,
		bool	verbose,
		bool	include_mempool_sequence
	)

Mempool to JSON.

Definition at line 536 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parkblock()

RPCHelpMan parkblock ( )

Definition at line 2041 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ParseHashOrHeight()

static const CBlockIndex* ParseHashOrHeight	(	const UniValue &	param,
		ChainstateManager &	chainman
	)

static

Definition at line 101 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ParseHashType()

static CoinStatsHashType ParseHashType ( const std::string & hash_type_input )

static

Definition at line 1256 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ preciousblock()

static RPCHelpMan preciousblock ( )

static

Definition at line 1949 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ pruneblockchain()

static RPCHelpMan pruneblockchain ( )

static

Definition at line 1180 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ reconsiderblock()

static RPCHelpMan reconsiderblock ( )

static

Definition at line 2094 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ RegisterBlockchainRPCCommands()

void RegisterBlockchainRPCCommands ( CRPCTable & t )

Definition at line 3179 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ RPCNotifyBlockChange()

void RPCNotifyBlockChange ( const CBlockIndex * pindex )

Callback for when block tip changed.

Definition at line 236 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ savemempool()

static RPCHelpMan savemempool ( )

static

Definition at line 2610 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ scantxoutset()

static RPCHelpMan scantxoutset ( )

static

Definition at line 2717 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetHasKeys() [1/2]

template<typename T >

static bool SetHasKeys ( const std::set< T > & set )

inlinestatic

Definition at line 2331 of file blockchain.cpp.

Here is the caller graph for this function:

◆ SetHasKeys() [2/2]

template<typename T , typename Tk , typename... Args>

static bool SetHasKeys	(	const std::set< T > &	set,
		const Tk &	key,
		const Args &...	args
	)

inlinestatic

Definition at line 2335 of file blockchain.cpp.

Here is the call graph for this function:

◆ syncwithvalidationinterfacequeue()

static RPCHelpMan syncwithvalidationinterfacequeue ( )

static

Definition at line 424 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ unparkblock()

RPCHelpMan unparkblock ( )

Definition at line 2139 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ verifychain()

static RPCHelpMan verifychain ( )

static

Definition at line 1611 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ waitforblock()

static RPCHelpMan waitforblock ( )

static

Definition at line 302 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ waitforblockheight()

static RPCHelpMan waitforblockheight ( )

static

Definition at line 364 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ waitfornewblock()

static RPCHelpMan waitfornewblock ( )

static

Definition at line 245 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

◆ cond_blockchange

std::condition_variable cond_blockchange

static

Definition at line 66 of file blockchain.cpp.

◆ cs_blockchange

GlobalMutex cs_blockchange

static

Definition at line 65 of file blockchain.cpp.

◆ g_scan_in_progress

std::atomic<bool> g_scan_in_progress

static

Definition at line 2692 of file blockchain.cpp.

◆ g_scan_progress

std::atomic<int> g_scan_progress

static

RAII object to prevent concurrency issue when scanning the txout set.

Definition at line 2691 of file blockchain.cpp.

◆ g_should_abort_scan

std::atomic<bool> g_should_abort_scan

static

Definition at line 2693 of file blockchain.cpp.

◆ PER_UTXO_OVERHEAD

constexpr size_t PER_UTXO_OVERHEAD

staticconstexpr

Initial value:

=

sizeof(COutPoint) + sizeof(uint32_t) + sizeof(bool)

COutPoint

An outpoint - a combination of a transaction hash and an index n into its vout.

Definition: transaction.h:20

Definition at line 2341 of file blockchain.cpp.

Classes

Functions

Variables

Function Documentation

◆ blockheaderToJSON()

◆ blockToJSON()

◆ CalculateTruncatedMedian()

◆ ComputeNextBlockAndDepth()

◆ CreateUTXOSnapshot()

◆ dumptxoutset()

◆ entryToJSON()

◆ getbestblockhash()

◆ getblock()

◆ getblockchaininfo()

◆ GetBlockChecked()

◆ getblockcount()

◆ getblockfilter()

◆ getblockfrompeer()

◆ getblockhash()

◆ getblockheader()

◆ getblockstats()

◆ getchaintips()

◆ getchaintxstats()

◆ getdifficulty()

◆ GetDifficulty()

◆ getmempoolancestors()

◆ getmempooldescendants()

◆ getmempoolentry()

◆ getmempoolinfo()

◆ getrawmempool()

◆ gettxout()

◆ gettxoutsetinfo()

◆ GetUndoChecked()

◆ GUARDED_BY()

◆ invalidateblock()

◆ MempoolEntryDescription()

◆ MempoolInfoToJSON()

◆ MempoolToJSON()

◆ parkblock()

◆ ParseHashOrHeight()

◆ ParseHashType()

◆ preciousblock()

◆ pruneblockchain()

◆ reconsiderblock()

◆ RegisterBlockchainRPCCommands()

◆ RPCNotifyBlockChange()

◆ savemempool()

◆ scantxoutset()

◆ SetHasKeys() [1/2]

◆ SetHasKeys() [2/2]

◆ syncwithvalidationinterfacequeue()

◆ unparkblock()

◆ verifychain()

◆ waitforblock()

◆ waitforblockheight()

◆ waitfornewblock()

Variable Documentation

◆ cond_blockchange

◆ cs_blockchange

◆ g_scan_in_progress

◆ g_scan_progress

◆ g_should_abort_scan

◆ PER_UTXO_OVERHEAD