#include <rpc/blockchain.h>
#include <blockfilter.h>
#include <chain.h>
#include <chainparams.h>
#include <coins.h>
#include <consensus/amount.h>
#include <consensus/params.h>
#include <consensus/validation.h>
#include <core_io.h>
#include <deploymentinfo.h>
#include <deploymentstatus.h>
#include <fs.h>
#include <hash.h>
#include <index/blockfilterindex.h>
#include <index/coinstatsindex.h>
#include <kernel/coinstats.h>
#include <logging/timer.h>
#include <net.h>
#include <net_processing.h>
#include <node/blockstorage.h>
#include <node/context.h>
#include <node/utxo_snapshot.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 <sync.h>
#include <txdb.h>
#include <txmempool.h>
#include <undo.h>
#include <univalue.h>
#include <util/check.h>
#include <util/strencodings.h>
#include <util/system.h>
#include <util/translation.h>
#include <validation.h>
#include <validationinterface.h>
#include <versionbits.h>
#include <warnings.h>
#include <stdint.h>
#include <condition_variable>
#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)
	Get the difficulty of the net wrt to the 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, TxVerbosity verbosity)
	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 RPCHelpMan	getblockfrompeer ()

static RPCHelpMan	getblockhash ()

static RPCHelpMan	getblockheader ()

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

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

static RPCHelpMan	getblock ()

static RPCHelpMan	pruneblockchain ()

CoinStatsHashType	ParseHashType (const std::string &hash_type_input)

static std::optional< kernel::CCoinsStats >	GetUTXOStats (CCoinsView view, node::BlockManager &blockman, kernel::CoinStatsHashType hash_type, const std::function< void()> &interruption_point={}, const CBlockIndex pindex=nullptr, bool index_requested=true)
	Calculate statistics about the unspent transaction output set. More...

static RPCHelpMan	gettxoutsetinfo ()

static RPCHelpMan	gettxout ()

static RPCHelpMan	verifychain ()

static void	SoftForkDescPushBack (const CBlockIndex *blockindex, UniValue &softforks, const ChainstateManager &chainman, Consensus::BuriedDeployment dep)

static void	SoftForkDescPushBack (const CBlockIndex *blockindex, UniValue &softforks, const ChainstateManager &chainman, Consensus::DeploymentPos id)

RPCHelpMan	getblockchaininfo ()

static RPCHelpMan	getdeploymentinfo ()

static RPCHelpMan	getchaintips ()

static RPCHelpMan	preciousblock ()

static RPCHelpMan	invalidateblock ()

static RPCHelpMan	reconsiderblock ()

static RPCHelpMan	getchaintxstats ()

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

void	CalculatePercentilesByWeight (CAmount result[NUM_GETBLOCKSTATS_PERCENTILES], std::vector< std::pair< CAmount, int64_t >> &scores, int64_t total_weight)
	Used by getblockstats to get feerates at different percentiles by weight. More...

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	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

const RPCResult	getblock_vin

static constexpr size_t	PER_UTXO_OVERHEAD = sizeof(COutPoint) + sizeof(uint32_t) + sizeof(bool)

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 136 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,
		TxVerbosity	verbosity
	)

Block description to JSON.

Definition at line 165 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CalculatePercentilesByWeight()

void CalculatePercentilesByWeight	(	CAmount	result[NUM_GETBLOCKSTATS_PERCENTILES],
		std::vector< std::pair< CAmount, int64_t >> &	scores,
		int64_t	total_weight
	)

Used by getblockstats to get feerates at different percentiles by weight.

Definition at line 1683 of file blockchain.cpp.

Here is the caller graph for this function:

◆ CalculateTruncatedMedian()

template<typename T >

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

static

Definition at line 1668 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 98 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 2329 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 2273 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 223 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 631 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 1202 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetBlockChecked()

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

static

Definition at line 574 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 202 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 2189 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 425 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 475 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 504 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 1723 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

Definition at line 1368 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 1587 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getdeploymentinfo()

static RPCHelpMan getdeploymentinfo ( )

static

Definition at line 1310 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 )

Get the difficulty of the net wrt to the given block index.

Returns: A floating point number that is a multiple of the main net minimum difficulty (4295032833 hashes).

Definition at line 76 of file blockchain.cpp.

Here is the caller graph for this function:

◆ getdifficulty()

static RPCHelpMan getdifficulty ( )

static

Definition at line 405 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gettxout()

static RPCHelpMan gettxout ( )

static

Definition at line 1003 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 852 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 592 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetUTXOStats()

static std::optional<kernel::CCoinsStats> GetUTXOStats	(	CCoinsView *	view,
		node::BlockManager &	blockman,
		kernel::CoinStatsHashType	hash_type,
		const std::function< void()> &	interruption_point = `{}`,
		const CBlockIndex *	pindex = `nullptr`,
		bool	index_requested = `true`
	)

static

Calculate statistics about the unspent transaction output set.

Parameters

[in] index_requested Signals if the coinstatsindex should be used (when available).

Definition at line 827 of file blockchain.cpp.

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 1506 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 108 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ParseHashType()

CoinStatsHashType ParseHashType ( const std::string & hash_type_input )

Definition at line 809 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 1466 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 750 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 1547 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 2403 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 * )

Callback for when block tip changed.

Definition at line 243 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 2022 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 1713 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 1715 of file blockchain.cpp.

Here is the call graph for this function:

◆ SoftForkDescPushBack() [1/2]

static void SoftForkDescPushBack	(	const CBlockIndex *	blockindex,
		UniValue &	softforks,
		const ChainstateManager &	chainman,
		Consensus::BuriedDeployment	dep
	)

static

Definition at line 1115 of file blockchain.cpp.

Here is the call graph for this function:

◆ SoftForkDescPushBack() [2/2]

static void SoftForkDescPushBack	(	const CBlockIndex *	blockindex,
		UniValue &	softforks,
		const ChainstateManager &	chainman,
		Consensus::DeploymentPos	id
	)

static

Definition at line 1130 of file blockchain.cpp.

Here is the call graph for this function:

◆ syncwithvalidationinterfacequeue()

static RPCHelpMan syncwithvalidationinterfacequeue ( )

static

Definition at line 387 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 1085 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 295 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 341 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 253 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 71 of file blockchain.cpp.

◆ cs_blockchange

GlobalMutex cs_blockchange

static

Definition at line 70 of file blockchain.cpp.

◆ g_scan_in_progress

std::atomic<bool> g_scan_in_progress

static

Definition at line 1995 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 1994 of file blockchain.cpp.

◆ g_should_abort_scan

std::atomic<bool> g_should_abort_scan

static

Definition at line 1996 of file blockchain.cpp.

◆ getblock_vin

const RPCResult getblock_vin

Initial value:

{
    RPCResult::Type::ARR, "vin", "",
    {
        {RPCResult::Type::OBJ, "", "",
        {
            {RPCResult::Type::ELISION, "", "The same output as verbosity = 2"},
            {RPCResult::Type::OBJ, "prevout", "(Only if undo information is available)",
            {
                {RPCResult::Type::BOOL, "generated", "Coinbase or not"},
                {RPCResult::Type::NUM, "height", "The height of the prevout"},
                {RPCResult::Type::STR_AMOUNT, "value", "The value in " + CURRENCY_UNIT},
                {RPCResult::Type::OBJ, "scriptPubKey", "",
                {
                    {RPCResult::Type::STR, "asm", "Disassembly of the public key script"},
                    {RPCResult::Type::STR, "desc", "Inferred descriptor for the output"},
                    {RPCResult::Type::STR_HEX, "hex", "The raw public key script bytes, hex-encoded"},
                    {RPCResult::Type::STR, "address", true, "The Bitcoin address (only if a well-defined address exists)"},
                    {RPCResult::Type::STR, "type", "The type (one of: " + GetAllOutputTypes() + ")"},
                }},
            }},
        }},
    }
}

Definition at line 607 of file blockchain.cpp.

◆ PER_UTXO_OVERHEAD

constexpr size_t PER_UTXO_OVERHEAD = sizeof(COutPoint) + sizeof(uint32_t) + sizeof(bool)

static

Definition at line 1721 of file blockchain.cpp.

Classes

Functions

Variables

Function Documentation

◆ blockheaderToJSON()

◆ blockToJSON()

◆ CalculatePercentilesByWeight()

◆ CalculateTruncatedMedian()

◆ ComputeNextBlockAndDepth()

◆ CreateUTXOSnapshot()

◆ dumptxoutset()

◆ getbestblockhash()

◆ getblock()

◆ getblockchaininfo()

◆ GetBlockChecked()

◆ getblockcount()

◆ getblockfilter()

◆ getblockfrompeer()

◆ getblockhash()

◆ getblockheader()

◆ getblockstats()

◆ getchaintips()

◆ getchaintxstats()

◆ getdeploymentinfo()

◆ GetDifficulty()

◆ getdifficulty()

◆ gettxout()

◆ gettxoutsetinfo()

◆ GetUndoChecked()

◆ GetUTXOStats()

◆ GUARDED_BY()

◆ invalidateblock()

◆ ParseHashOrHeight()

◆ ParseHashType()

◆ preciousblock()

◆ pruneblockchain()

◆ reconsiderblock()

◆ RegisterBlockchainRPCCommands()

◆ RPCNotifyBlockChange()

◆ scantxoutset()

◆ SetHasKeys() [1/2]

◆ SetHasKeys() [2/2]

◆ SoftForkDescPushBack() [1/2]

◆ SoftForkDescPushBack() [2/2]

◆ syncwithvalidationinterfacequeue()

◆ verifychain()

◆ waitforblock()

◆ waitforblockheight()

◆ waitfornewblock()

Variable Documentation

◆ cond_blockchange

◆ cs_blockchange

◆ g_scan_in_progress

◆ g_scan_progress

◆ g_should_abort_scan

◆ getblock_vin

◆ PER_UTXO_OVERHEAD