#include <rpc/blockchain.h>
#include <blockfilter.h>
#include <chain.h>
#include <chainparams.h>
#include <chainparamsbase.h>
#include <clientversion.h>
#include <coins.h>
#include <common/args.h>
#include <consensus/amount.h>
#include <consensus/params.h>
#include <consensus/validation.h>
#include <core_io.h>
#include <deploymentinfo.h>
#include <deploymentstatus.h>
#include <flatfile.h>
#include <hash.h>
#include <index/blockfilterindex.h>
#include <index/coinstatsindex.h>
#include <interfaces/mining.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/transaction.h>
#include <node/utxo_snapshot.h>
#include <node/warnings.h>
#include <primitives/transaction.h>
#include <rpc/server.h>
#include <rpc/server_util.h>
#include <rpc/util.h>
#include <script/descriptor.h>
#include <serialize.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/fs.h>
#include <util/strencodings.h>
#include <util/translation.h>
#include <validation.h>
#include <validationinterface.h>
#include <versionbits.h>
#include <stdint.h>
#include <condition_variable>
#include <iterator>
#include <memory>
#include <mutex>
#include <optional>
#include <vector>

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

class	CoinsViewScanReserver

class	BlockFiltersScanReserver

class	NetworkDisable
	RAII class that disables the network in its constructor and enables it in its destructor. More...

class	TemporaryRollback
	RAII class that temporarily rolls back the local chain in it's constructor and rolls it forward again in it's destructor. More...

Functions
std::tuple< std::unique_ptr< CCoinsViewCursor >, CCoinsStats, const CBlockIndex * > PrepareUTXOSnapshot(Chainstate &chainstate, const std::function< void()> &interruption_point={}) EXCLUSIVE_LOCKS_REQUIRED(UniValue	WriteUTXOSnapshot (Chainstate &chainstate, CCoinsViewCursor pcursor, CCoinsStats maybe_stats, const CBlockIndex *tip, AutoFile &afile, const fs::path &path, const fs::path &temppath, const std::function< void()> &interruption_point={})

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, const uint256 pow_limit)
	Block header to JSON. More...

UniValue	blockToJSON (BlockManager &blockman, const CBlock &block, const CBlockIndex &tip, const CBlockIndex &blockindex, TxVerbosity verbosity, const uint256 pow_limit)
	Block description to JSON. More...

static RPCHelpMan	getblockcount ()

static RPCHelpMan	getbestblockhash ()

static RPCHelpMan	waitfornewblock ()

static RPCHelpMan	waitforblock ()

static RPCHelpMan	waitforblockheight ()

static RPCHelpMan	syncwithvalidationinterfacequeue ()

static RPCHelpMan	getdifficulty ()

static RPCHelpMan	getblockfrompeer ()

static RPCHelpMan	getblockhash ()

static RPCHelpMan	getblockheader ()

void	CheckBlockDataAvailability (BlockManager &blockman, const CBlockIndex &blockindex, bool check_for_undo)

static CBlock	GetBlockChecked (BlockManager &blockman, const CBlockIndex &blockindex)

static std::vector< uint8_t >	GetRawBlockChecked (BlockManager &blockman, const CBlockIndex &blockindex)

static CBlockUndo	GetUndoChecked (BlockManager &blockman, const CBlockIndex &blockindex)

static RPCHelpMan	getblock ()

std::optional< int >	GetPruneHeight (const BlockManager &blockman, const CChain &chain)
	Return height of highest block that has been pruned, or std::nullopt if no blocks have been pruned. More...

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

RPCHelpMan	getdeploymentinfo ()

static RPCHelpMan	getchaintips ()

static RPCHelpMan	preciousblock ()

void	InvalidateBlock (ChainstateManager &chainman, const uint256 block_hash)

static RPCHelpMan	invalidateblock ()

void	ReconsiderBlock (ChainstateManager &chainman, uint256 block_hash)

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 bool	CheckBlockFilterMatches (BlockManager &blockman, const CBlockIndex &blockindex, const GCSFilter::ElementSet &needles)

static RPCHelpMan	scanblocks ()

static RPCHelpMan	getdescriptoractivity ()

static RPCHelpMan	getblockfilter ()

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

std::tuple< std::unique_ptr< CCoinsViewCursor >, CCoinsStats, const CBlockIndex * >	PrepareUTXOSnapshot (Chainstate &chainstate, const std::function< void()> &interruption_point)

UniValue	CreateUTXOSnapshot (node::NodeContext &node, Chainstate &chainstate, AutoFile &afile, const fs::path &path, const fs::path &tmppath)
	Test-only helper to create UTXO snapshots given a chainstate and a file handle. More...

static RPCHelpMan	loadtxoutset ()

static RPCHelpMan	getchainstates ()

void	RegisterBlockchainRPCCommands (CRPCTable &t)

Variables
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

static const auto	scan_action_arg_desc

static const auto	scan_objects_arg_desc

static const auto	scan_result_abort

static const auto	scan_result_status_none

static const auto	scan_result_status_some

static std::atomic< int >	g_scanfilter_progress
	RAII object to prevent concurrency issue when scanning blockfilters. More...

static std::atomic< int >	g_scanfilter_progress_height

static std::atomic< bool >	g_scanfilter_in_progress

static std::atomic< bool >	g_scanfilter_should_abort_scan

const std::vector< RPCResult >	RPCHelpForChainstate

Function Documentation

◆ blockheaderToJSON()

UniValue blockheaderToJSON	(	const CBlockIndex &	tip,
		const CBlockIndex &	blockindex,
		const uint256	pow_limit
	)

Block header to JSON.

Definition at line 150 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,
		const uint256	pow_limit
	)

Block description to JSON.

Definition at line 180 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 1823 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 1808 of file blockchain.cpp.

Here is the caller graph for this function:

◆ CheckBlockDataAvailability()

void CheckBlockDataAvailability	(	BlockManager &	blockman,
		const CBlockIndex &	blockindex,
		bool	check_for_undo
	)

Definition at line 622 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CheckBlockFilterMatches()

static bool CheckBlockFilterMatches	(	BlockManager &	blockman,
		const CBlockIndex &	blockindex,
		const GCSFilter::ElementSet &	needles
	)

static

Definition at line 2407 of file blockchain.cpp.

Here is the call graph for this function:

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

Test-only helper to create UTXO snapshots given a chainstate and a file handle.

Returns: a UniValue map containing metadata about the snapshot.

Definition at line 3232 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 2969 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 241 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 716 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 1306 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 &	blockindex
	)

static

Definition at line 637 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 220 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 2849 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 467 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 522 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 551 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 1863 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getchainstates()

static RPCHelpMan getchainstates ( )

static

Definition at line 3337 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 1489 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 1717 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getdeploymentinfo()

RPCHelpMan getdeploymentinfo ( )

Definition at line 1431 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getdescriptoractivity()

static RPCHelpMan getdescriptoractivity ( )

static

Definition at line 2620 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 447 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 92 of file blockchain.cpp.

Here is the caller graph for this function:

◆ GetPruneHeight()

std::optional< int > GetPruneHeight	(	const BlockManager &	blockman,
		const CChain &	chain
	)

Return height of highest block that has been pruned, or std::nullopt if no blocks have been pruned.

Definition at line 830 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetRawBlockChecked()

static std::vector< uint8_t > GetRawBlockChecked	(	BlockManager &	blockman,
		const CBlockIndex &	blockindex
	)

static

Definition at line 654 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 1110 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 955 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 &	blockindex
	)

static

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

Here is the caller graph for this function:

◆ invalidateblock()

static RPCHelpMan invalidateblock ( )

static

Definition at line 1648 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ InvalidateBlock()

void InvalidateBlock	(	ChainstateManager &	chainman,
		const uint256	block_hash
	)

Definition at line 1627 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ loadtxoutset()

static RPCHelpMan loadtxoutset ( )

static

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PrepareUTXOSnapshot()

std::tuple< std::unique_ptr< CCoinsViewCursor >, CCoinsStats, const CBlockIndex * > PrepareUTXOSnapshot	(	Chainstate &	chainstate,
		const std::function< void()> &	interruption_point
	)

Definition at line 3119 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 855 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 1692 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ReconsiderBlock()

void ReconsiderBlock	(	ChainstateManager &	chainman,
		uint256	block_hash
	)

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ scanblocks()

static RPCHelpMan scanblocks ( )

static

Definition at line 2432 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 2218 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 1853 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 1855 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 1219 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 1234 of file blockchain.cpp.

Here is the call graph for this function:

◆ syncwithvalidationinterfacequeue()

static RPCHelpMan syncwithvalidationinterfacequeue ( )

static

Definition at line 428 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 1189 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 306 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 366 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 261 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ WriteUTXOSnapshot()

UniValue WriteUTXOSnapshot	(	Chainstate &	chainstate,
		CCoinsViewCursor *	pcursor,
		CCoinsStats *	maybe_stats,
		const CBlockIndex *	tip,
		AutoFile &	afile,
		const fs::path &	path,
		const fs::path &	temppath,
		const std::function< void()> &	interruption_point = `{}`
	)

Definition at line 3156 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

◆ g_scan_in_progress

std::atomic<bool> g_scan_in_progress

static

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

◆ g_scanfilter_in_progress

std::atomic<bool> g_scanfilter_in_progress

static

Definition at line 2382 of file blockchain.cpp.

◆ g_scanfilter_progress

std::atomic<int> g_scanfilter_progress

static

RAII object to prevent concurrency issue when scanning blockfilters.

Definition at line 2380 of file blockchain.cpp.

◆ g_scanfilter_progress_height

std::atomic<int> g_scanfilter_progress_height

static

Definition at line 2381 of file blockchain.cpp.

◆ g_scanfilter_should_abort_scan

std::atomic<bool> g_scanfilter_should_abort_scan

static

Definition at line 2383 of file blockchain.cpp.

◆ g_should_abort_scan

std::atomic<bool> g_should_abort_scan

static

Definition at line 2158 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 output script"},
                    {RPCResult::Type::STR, "desc", "Inferred descriptor for the output"},
                    {RPCResult::Type::STR_HEX, "hex", "The raw output 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 692 of file blockchain.cpp.

◆ PER_UTXO_OVERHEAD

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

staticconstexpr

Definition at line 1861 of file blockchain.cpp.

◆ RPCHelpForChainstate

const std::vector<RPCResult> RPCHelpForChainstate

Initial value:

{
    {RPCResult::Type::NUM, "blocks", "number of blocks in this chainstate"},
    {RPCResult::Type::STR_HEX, "bestblockhash", "blockhash of the tip"},
    {RPCResult::Type::STR_HEX, "bits", "nBits: compact representation of the block difficulty target"},
    {RPCResult::Type::STR_HEX, "target", "The difficulty target"},
    {RPCResult::Type::NUM, "difficulty", "difficulty of the tip"},
    {RPCResult::Type::NUM, "verificationprogress", "progress towards the network tip"},
    {RPCResult::Type::STR_HEX, "snapshot_blockhash", true, "the base block of the snapshot this chainstate is based on, if any"},
    {RPCResult::Type::NUM, "coins_db_cache_bytes", "size of the coinsdb cache"},
    {RPCResult::Type::NUM, "coins_tip_cache_bytes", "size of the coinstip cache"},
    {RPCResult::Type::BOOL, "validated", "whether the chainstate is fully validated. True if all blocks in the chainstate were validated, false if the chain is based on a snapshot and the snapshot has not yet been validated."},
}

Definition at line 3324 of file blockchain.cpp.

◆ scan_action_arg_desc

const auto scan_action_arg_desc

static

Initial value:

= RPCArg{
    "action", RPCArg::Type::STR, RPCArg::Optional::NO, "The action to execute\n"
        "\"start\" for starting a scan\n"
        "\"abort\" for aborting the current scan (returns true when abort was successful)\n"
        "\"status\" for progress report (in %) of the current scan"
}

Definition at line 2184 of file blockchain.cpp.

◆ scan_objects_arg_desc

const auto scan_objects_arg_desc

static

Initial value:

= RPCArg{
    "scanobjects", RPCArg::Type::ARR, RPCArg::Optional::OMITTED, "Array of scan objects. Required for \"start\" action\n"
        "Every scan object is either a string descriptor or an object:",
    {
        {"descriptor", RPCArg::Type::STR, RPCArg::Optional::OMITTED, "An output descriptor"},
        {"", RPCArg::Type::OBJ, RPCArg::Optional::OMITTED, "An object with output descriptor and metadata",
            {
                {"desc", RPCArg::Type::STR, RPCArg::Optional::NO, "An output descriptor"},
                {"range", RPCArg::Type::RANGE, RPCArg::Default{1000}, "The range of HD chain indexes to explore (either end or [begin,end])"},
            }},
    },
    RPCArgOptions{.oneline_description="[scanobjects,...]"},
}

Definition at line 2191 of file blockchain.cpp.

◆ scan_result_abort

const auto scan_result_abort

static

Initial value:

= RPCResult{
    "when action=='abort'", RPCResult::Type::BOOL, "success",
    "True if scan will be aborted (not necessarily before this RPC returns), or false if there is no scan to abort"
}

Definition at line 2205 of file blockchain.cpp.

◆ scan_result_status_none

const auto scan_result_status_none

static

Initial value:

= RPCResult{
    "when action=='status' and no scan is in progress - possibly already completed", RPCResult::Type::NONE, "", ""
}

Definition at line 2209 of file blockchain.cpp.

◆ scan_result_status_some

const auto scan_result_status_some

static

Initial value:

= RPCResult{
    "when action=='status' and a scan is currently in progress", RPCResult::Type::OBJ, "", "",
    {{RPCResult::Type::NUM, "progress", "Approximate percent complete"},}
}

Definition at line 2212 of file blockchain.cpp.

Classes

Functions

Variables

Function Documentation

◆ blockheaderToJSON()

◆ blockToJSON()

◆ CalculatePercentilesByWeight()

◆ CalculateTruncatedMedian()

◆ CheckBlockDataAvailability()

◆ CheckBlockFilterMatches()

◆ ComputeNextBlockAndDepth()

◆ CreateUTXOSnapshot()

◆ dumptxoutset()

◆ getbestblockhash()

◆ getblock()

◆ getblockchaininfo()

◆ GetBlockChecked()

◆ getblockcount()

◆ getblockfilter()

◆ getblockfrompeer()

◆ getblockhash()

◆ getblockheader()

◆ getblockstats()

◆ getchainstates()

◆ getchaintips()

◆ getchaintxstats()

◆ getdeploymentinfo()

◆ getdescriptoractivity()

◆ getdifficulty()

◆ GetDifficulty()

◆ GetPruneHeight()

◆ GetRawBlockChecked()

◆ gettxout()

◆ gettxoutsetinfo()

◆ GetUndoChecked()

◆ GetUTXOStats()

◆ invalidateblock()

◆ InvalidateBlock()

◆ loadtxoutset()

◆ ParseHashOrHeight()

◆ ParseHashType()

◆ preciousblock()

◆ PrepareUTXOSnapshot()

◆ pruneblockchain()

◆ reconsiderblock()

◆ ReconsiderBlock()

◆ RegisterBlockchainRPCCommands()

◆ scanblocks()

◆ scantxoutset()

◆ SetHasKeys() [1/2]

◆ SetHasKeys() [2/2]

◆ SoftForkDescPushBack() [1/2]

◆ SoftForkDescPushBack() [2/2]

◆ syncwithvalidationinterfacequeue()

◆ verifychain()

◆ waitforblock()

◆ waitforblockheight()

◆ waitfornewblock()

◆ WriteUTXOSnapshot()

Variable Documentation

◆ g_scan_in_progress

◆ g_scan_progress

◆ g_scanfilter_in_progress

◆ g_scanfilter_progress

◆ g_scanfilter_progress_height

◆ g_scanfilter_should_abort_scan

◆ g_should_abort_scan

◆ getblock_vin

◆ PER_UTXO_OVERHEAD

◆ RPCHelpForChainstate

◆ scan_action_arg_desc

◆ scan_objects_arg_desc

◆ scan_result_abort

◆ scan_result_status_none

◆ scan_result_status_some