blockchain.h File Reference

#include <amount.h>
#include <core_io.h>
#include <streams.h>
#include <sync.h>
#include <any>
#include <stdint.h>
#include <vector>

Include dependency graph for blockchain.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
double	GetDifficulty (const CBlockIndex *blockindex)
	Get the difficulty of the net wrt to the given block index. More...
void	RPCNotifyBlockChange (const CBlockIndex *)
	Callback for when block tip changed. More...
UniValue	blockToJSON (const CBlock &block, const CBlockIndex *tip, const CBlockIndex *blockindex, bool txDetails=false) LOCKS_EXCLUDED(cs_main)
	Block description to JSON. More...
UniValue	MempoolInfoToJSON (const CTxMemPool &pool)
	Mempool information to JSON. More...
UniValue	MempoolToJSON (const CTxMemPool &pool, bool verbose=false, bool include_mempool_sequence=false)
	Mempool to JSON. More...
UniValue	blockheaderToJSON (const CBlockIndex *tip, const CBlockIndex *blockindex) LOCKS_EXCLUDED(cs_main)
	Block header to JSON. More...
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...
void	ScriptPubKeyToUniv (const CScript &scriptPubKey, UniValue &out, bool fIncludeHex)
void	TxToUniv (const CTransaction &tx, const uint256 &hashBlock, UniValue &entry, bool include_hex=true, int serialize_flags=0, const CTxUndo *txundo=nullptr)
NodeContext &	EnsureAnyNodeContext (const std::any &context)
CTxMemPool &	EnsureMemPool (const NodeContext &node)
CTxMemPool &	EnsureAnyMemPool (const std::any &context)
ChainstateManager &	EnsureChainman (const NodeContext &node)
ChainstateManager &	EnsureAnyChainman (const std::any &context)
CBlockPolicyEstimator &	EnsureFeeEstimator (const NodeContext &node)
CBlockPolicyEstimator &	EnsureAnyFeeEstimator (const std::any &context)
UniValue	CreateUTXOSnapshot (NodeContext &node, CChainState &chainstate, CAutoFile &afile)
	Helper to create UTXO snapshots given a chainstate and a file handle. More...

Variables
RecursiveMutex	cs_main
	Mutex to guard access to validation specific variables, such as reading or changing the chainstate. More...
static constexpr int	NUM_GETBLOCKSTATS_PERCENTILES = 5

Function Documentation

blockheaderToJSON()

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

Block header to JSON.

Definition at line 173 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

blockToJSON()

UniValue blockToJSON	(	const CBlock &	block,
		const CBlockIndex *	tip,
		const CBlockIndex *	blockindex,
		bool	txDetails = false
	)

Block description to JSON.

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

Here is the caller graph for this function:

CreateUTXOSnapshot()

UniValue CreateUTXOSnapshot	(	NodeContext &	node,
		CChainState &	chainstate,
		CAutoFile &	afile
	)

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

Returns

a UniValue map containing metadata about the snapshot.

Definition at line 2568 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

EnsureAnyChainman()

ChainstateManager& EnsureAnyChainman

(

const std::any &

context

)

Definition at line 94 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

EnsureAnyFeeEstimator()

CBlockPolicyEstimator& EnsureAnyFeeEstimator

(

const std::any &

context

)

Definition at line 107 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

EnsureAnyMemPool()

CTxMemPool& EnsureAnyMemPool

(

const std::any &

context

)

Definition at line 81 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

EnsureAnyNodeContext()

NodeContext& EnsureAnyNodeContext

(

const std::any &

context

)

Definition at line 64 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

EnsureChainman()

ChainstateManager& EnsureChainman

(

const NodeContext &

node

)

Definition at line 86 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

EnsureFeeEstimator()

CBlockPolicyEstimator& EnsureFeeEstimator

(

const NodeContext &

node

)

Definition at line 99 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

EnsureMemPool()

CTxMemPool& EnsureMemPool

(

const NodeContext &

node

)

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

Here is the caller graph for this function:

MempoolInfoToJSON()

UniValue MempoolInfoToJSON

(

const CTxMemPool &

pool

)

Mempool information to JSON.

Definition at line 1634 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 = false,
		bool	include_mempool_sequence = false
	)

Mempool to JSON.

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

Here is the call graph for this function:

Here is the caller graph for this function:

ScriptPubKeyToUniv()

void ScriptPubKeyToUniv	(	const CScript &	scriptPubKey,
		UniValue &	out,
		bool	fIncludeHex
	)

Definition at line 1927 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

TxToUniv()

void TxToUniv	(	const CTransaction &	tx,
		const uint256 &	hashBlock,
		UniValue &	entry,
		bool	include_hex = true,
		int	serialize_flags = 0,
		const CTxUndo *	txundo = nullptr
	)

Definition at line 1932 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

cs_main

RecursiveMutex cs_main

Mutex to guard access to validation specific variables, such as reading or changing the chainstate.

This may also need to be locked when updating the transaction pool, e.g. on AcceptToMemoryPool. See CTxMemPool::cs comment for details.

The transaction pool has a separate lock to allow reading from it and the chainstate at the same time.

Definition at line 115 of file validation.cpp.

NUM_GETBLOCKSTATS_PERCENTILES

constexpr int NUM_GETBLOCKSTATS_PERCENTILES = 5

static

Definition at line 28 of file blockchain.h.