CTxMemPoolEntry stores data about the corresponding transaction, as well as data about all in-mempool transactions that depend on the transaction ("descendant" transactions). More...

#include <txmempool.h>

Collaboration diagram for CTxMemPoolEntry:

[legend]

Public Types
typedef std::reference_wrapper< const CTxMemPoolEntry >	CTxMemPoolEntryRef

typedef std::set< CTxMemPoolEntryRef, CompareIteratorByHash >	Parents

typedef std::set< CTxMemPoolEntryRef, CompareIteratorByHash >	Children

Public Member Functions
	CTxMemPoolEntry (const CTransactionRef &tx, CAmount fee, int64_t time, unsigned int entry_height, bool spends_coinbase, int64_t sigops_cost, LockPoints lp)

const CTransaction &	GetTx () const

CTransactionRef	GetSharedTx () const

const CAmount &	GetFee () const

size_t	GetTxSize () const

size_t	GetTxWeight () const

std::chrono::seconds	GetTime () const

unsigned int	GetHeight () const

int64_t	GetSigOpCost () const

int64_t	GetModifiedFee () const

size_t	DynamicMemoryUsage () const

const LockPoints &	GetLockPoints () const

void	UpdateDescendantState (int64_t modifySize, CAmount modifyFee, int64_t modifyCount)

void	UpdateAncestorState (int64_t modifySize, CAmount modifyFee, int64_t modifyCount, int64_t modifySigOps)

void	UpdateFeeDelta (int64_t feeDelta)

void	UpdateLockPoints (const LockPoints &lp)

uint64_t	GetCountWithDescendants () const

uint64_t	GetSizeWithDescendants () const

CAmount	GetModFeesWithDescendants () const

bool	GetSpendsCoinbase () const

uint64_t	GetCountWithAncestors () const

uint64_t	GetSizeWithAncestors () const

CAmount	GetModFeesWithAncestors () const

int64_t	GetSigOpCostWithAncestors () const

const Parents &	GetMemPoolParentsConst () const

const Children &	GetMemPoolChildrenConst () const

Parents &	GetMemPoolParents () const

Children &	GetMemPoolChildren () const

Public Attributes
size_t	vTxHashesIdx
	Index in mempool's vTxHashes. More...

Epoch::Marker	m_epoch_marker
	epoch when last touched, useful for graph algorithms More...

Private Attributes
const CTransactionRef	tx

Parents	m_parents

Children	m_children

const CAmount	nFee
	Cached to avoid expensive parent-transaction lookups. More...

const size_t	nTxWeight
	... and avoid recomputing tx weight (also used for GetTxSize()) More...

const size_t	nUsageSize
	... and total memory usage More...

const int64_t	nTime
	Local time when entering the mempool. More...

const unsigned int	entryHeight
	Chain height when entering the mempool. More...

const bool	spendsCoinbase
	keep track of transactions that spend a coinbase More...

const int64_t	sigOpCost
	Total sigop cost. More...

int64_t	feeDelta {0}
	Used for determining the priority of the transaction for mining in a block. More...

LockPoints	lockPoints
	Track the height and time at which tx was final. More...

uint64_t	nCountWithDescendants {1}
	number of descendant transactions More...

uint64_t	nSizeWithDescendants
	... and size More...

CAmount	nModFeesWithDescendants
	... and total fees (all including us) More...

uint64_t	nCountWithAncestors {1}

uint64_t	nSizeWithAncestors

CAmount	nModFeesWithAncestors

int64_t	nSigOpCostWithAncestors

Detailed Description

CTxMemPoolEntry stores data about the corresponding transaction, as well as data about all in-mempool transactions that depend on the transaction ("descendant" transactions).

When a new entry is added to the mempool, we update the descendant state (nCountWithDescendants, nSizeWithDescendants, and nModFeesWithDescendants) for all ancestors of the newly added transaction.

Definition at line 79 of file txmempool.h.

Member Typedef Documentation

◆ Children

typedef std::set<CTxMemPoolEntryRef, CompareIteratorByHash> CTxMemPoolEntry::Children

Definition at line 85 of file txmempool.h.

◆ CTxMemPoolEntryRef

typedef std::reference_wrapper<const CTxMemPoolEntry> CTxMemPoolEntry::CTxMemPoolEntryRef

Definition at line 82 of file txmempool.h.

◆ Parents

typedef std::set<CTxMemPoolEntryRef, CompareIteratorByHash> CTxMemPoolEntry::Parents

Definition at line 84 of file txmempool.h.

Constructor & Destructor Documentation

◆ CTxMemPoolEntry()

CTxMemPoolEntry::CTxMemPoolEntry	(	const CTransactionRef &	tx,
		CAmount	fee,
		int64_t	time,
		unsigned int	entry_height,
		bool	spends_coinbase,
		int64_t	sigops_cost,
		LockPoints	lp
	)

Definition at line 77 of file txmempool.cpp.

Member Function Documentation

◆ DynamicMemoryUsage()

size_t CTxMemPoolEntry::DynamicMemoryUsage ( ) const

inline

Definition at line 129 of file txmempool.h.

◆ GetCountWithAncestors()

uint64_t CTxMemPoolEntry::GetCountWithAncestors ( ) const

inline

Definition at line 148 of file txmempool.h.

◆ GetCountWithDescendants()

uint64_t CTxMemPoolEntry::GetCountWithDescendants ( ) const

inline

Definition at line 142 of file txmempool.h.

◆ GetFee()

const CAmount & CTxMemPoolEntry::GetFee ( ) const

inline

Definition at line 122 of file txmempool.h.

Here is the caller graph for this function:

◆ GetHeight()

unsigned int CTxMemPoolEntry::GetHeight ( ) const

inline

Definition at line 126 of file txmempool.h.

Here is the caller graph for this function:

◆ GetLockPoints()

const LockPoints & CTxMemPoolEntry::GetLockPoints ( ) const

inline

Definition at line 130 of file txmempool.h.

◆ GetMemPoolChildren()

Children & CTxMemPoolEntry::GetMemPoolChildren ( ) const

inline

Definition at line 156 of file txmempool.h.

◆ GetMemPoolChildrenConst()

const Children & CTxMemPoolEntry::GetMemPoolChildrenConst ( ) const

inline

Definition at line 154 of file txmempool.h.

Here is the caller graph for this function:

◆ GetMemPoolParents()

Parents & CTxMemPoolEntry::GetMemPoolParents ( ) const

inline

Definition at line 155 of file txmempool.h.

◆ GetMemPoolParentsConst()

const Parents & CTxMemPoolEntry::GetMemPoolParentsConst ( ) const

inline

Definition at line 153 of file txmempool.h.

◆ GetModFeesWithAncestors()

CAmount CTxMemPoolEntry::GetModFeesWithAncestors ( ) const

inline

Definition at line 150 of file txmempool.h.

◆ GetModFeesWithDescendants()

CAmount CTxMemPoolEntry::GetModFeesWithDescendants ( ) const

inline

Definition at line 144 of file txmempool.h.

Here is the caller graph for this function:

◆ GetModifiedFee()

int64_t CTxMemPoolEntry::GetModifiedFee ( ) const

inline

Definition at line 128 of file txmempool.h.

Here is the caller graph for this function:

◆ GetSharedTx()

CTransactionRef CTxMemPoolEntry::GetSharedTx ( ) const

inline

Definition at line 121 of file txmempool.h.

◆ GetSigOpCost()

int64_t CTxMemPoolEntry::GetSigOpCost ( ) const

inline

Definition at line 127 of file txmempool.h.

◆ GetSigOpCostWithAncestors()

int64_t CTxMemPoolEntry::GetSigOpCostWithAncestors ( ) const

inline

Definition at line 151 of file txmempool.h.

◆ GetSizeWithAncestors()

uint64_t CTxMemPoolEntry::GetSizeWithAncestors ( ) const

inline

Definition at line 149 of file txmempool.h.

◆ GetSizeWithDescendants()

uint64_t CTxMemPoolEntry::GetSizeWithDescendants ( ) const

inline

Definition at line 143 of file txmempool.h.

Here is the caller graph for this function:

◆ GetSpendsCoinbase()

bool CTxMemPoolEntry::GetSpendsCoinbase ( ) const

inline

Definition at line 146 of file txmempool.h.

◆ GetTime()

std::chrono::seconds CTxMemPoolEntry::GetTime ( ) const

inline

Definition at line 125 of file txmempool.h.

Here is the caller graph for this function:

◆ GetTx()

const CTransaction & CTxMemPoolEntry::GetTx ( ) const

inline

Definition at line 120 of file txmempool.h.

Here is the caller graph for this function:

◆ GetTxSize()

size_t CTxMemPoolEntry::GetTxSize ( ) const

Definition at line 107 of file txmempool.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetTxWeight()

size_t CTxMemPoolEntry::GetTxWeight ( ) const

inline

Definition at line 124 of file txmempool.h.

◆ UpdateAncestorState()

void CTxMemPoolEntry::UpdateAncestorState	(	int64_t	modifySize,
		CAmount	modifyFee,
		int64_t	modifyCount,
		int64_t	modifySigOps
	)

Definition at line 436 of file txmempool.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UpdateDescendantState()

void CTxMemPoolEntry::UpdateDescendantState	(	int64_t	modifySize,
		CAmount	modifyFee,
		int64_t	modifyCount
	)

Definition at line 427 of file txmempool.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UpdateFeeDelta()

void CTxMemPoolEntry::UpdateFeeDelta ( int64_t feeDelta )

Definition at line 95 of file txmempool.cpp.

Here is the caller graph for this function:

◆ UpdateLockPoints()

void CTxMemPoolEntry::UpdateLockPoints ( const LockPoints & lp )

Definition at line 102 of file txmempool.cpp.

Here is the caller graph for this function:

Member Data Documentation

◆ entryHeight

const unsigned int CTxMemPoolEntry::entryHeight

private

Chain height when entering the mempool.

Definition at line 95 of file txmempool.h.

◆ feeDelta

int64_t CTxMemPoolEntry::feeDelta {0}

private

Used for determining the priority of the transaction for mining in a block.

Definition at line 98 of file txmempool.h.

◆ lockPoints

LockPoints CTxMemPoolEntry::lockPoints

private

Track the height and time at which tx was final.

Definition at line 99 of file txmempool.h.

◆ m_children

Children CTxMemPoolEntry::m_children

mutableprivate

Definition at line 90 of file txmempool.h.

◆ m_epoch_marker

Epoch::Marker CTxMemPoolEntry::m_epoch_marker

mutable

epoch when last touched, useful for graph algorithms

Definition at line 159 of file txmempool.h.

◆ m_parents

Parents CTxMemPoolEntry::m_parents

mutableprivate

Definition at line 89 of file txmempool.h.

◆ nCountWithAncestors

uint64_t CTxMemPoolEntry::nCountWithAncestors {1}

private

Definition at line 109 of file txmempool.h.

◆ nCountWithDescendants

uint64_t CTxMemPoolEntry::nCountWithDescendants {1}

private

number of descendant transactions

Definition at line 104 of file txmempool.h.

◆ nFee

const CAmount CTxMemPoolEntry::nFee

private

Cached to avoid expensive parent-transaction lookups.

Definition at line 91 of file txmempool.h.

◆ nModFeesWithAncestors

CAmount CTxMemPoolEntry::nModFeesWithAncestors

private

Definition at line 111 of file txmempool.h.

◆ nModFeesWithDescendants

CAmount CTxMemPoolEntry::nModFeesWithDescendants

private

... and total fees (all including us)

Definition at line 106 of file txmempool.h.

◆ nSigOpCostWithAncestors

int64_t CTxMemPoolEntry::nSigOpCostWithAncestors

private

Definition at line 112 of file txmempool.h.

◆ nSizeWithAncestors

uint64_t CTxMemPoolEntry::nSizeWithAncestors

private

Definition at line 110 of file txmempool.h.

◆ nSizeWithDescendants

uint64_t CTxMemPoolEntry::nSizeWithDescendants

private

... and size

Definition at line 105 of file txmempool.h.

◆ nTime

const int64_t CTxMemPoolEntry::nTime

private

Local time when entering the mempool.

Definition at line 94 of file txmempool.h.

◆ nTxWeight

const size_t CTxMemPoolEntry::nTxWeight

private

... and avoid recomputing tx weight (also used for GetTxSize())

Definition at line 92 of file txmempool.h.

◆ nUsageSize

const size_t CTxMemPoolEntry::nUsageSize

private

... and total memory usage

Definition at line 93 of file txmempool.h.

◆ sigOpCost

const int64_t CTxMemPoolEntry::sigOpCost

private

Total sigop cost.

Definition at line 97 of file txmempool.h.

◆ spendsCoinbase

const bool CTxMemPoolEntry::spendsCoinbase

private

keep track of transactions that spend a coinbase

Definition at line 96 of file txmempool.h.

◆ tx

const CTransactionRef CTxMemPoolEntry::tx

private

Definition at line 88 of file txmempool.h.

◆ vTxHashesIdx

size_t CTxMemPoolEntry::vTxHashesIdx

mutable

Index in mempool's vTxHashes.

Definition at line 158 of file txmempool.h.

The documentation for this class was generated from the following files:

src/txmempool.h
src/txmempool.cpp

Public Types

Public Member Functions

Public Attributes

Private Attributes

Detailed Description

Member Typedef Documentation

◆ Children

◆ CTxMemPoolEntryRef

◆ Parents

Constructor & Destructor Documentation

◆ CTxMemPoolEntry()

Member Function Documentation

◆ DynamicMemoryUsage()

◆ GetCountWithAncestors()

◆ GetCountWithDescendants()

◆ GetFee()

◆ GetHeight()

◆ GetLockPoints()

◆ GetMemPoolChildren()

◆ GetMemPoolChildrenConst()

◆ GetMemPoolParents()

◆ GetMemPoolParentsConst()

◆ GetModFeesWithAncestors()

◆ GetModFeesWithDescendants()

◆ GetModifiedFee()

◆ GetSharedTx()

◆ GetSigOpCost()

◆ GetSigOpCostWithAncestors()

◆ GetSizeWithAncestors()

◆ GetSizeWithDescendants()

◆ GetSpendsCoinbase()

◆ GetTime()

◆ GetTx()

◆ GetTxSize()

◆ GetTxWeight()

◆ UpdateAncestorState()

◆ UpdateDescendantState()

◆ UpdateFeeDelta()

◆ UpdateLockPoints()

Member Data Documentation

◆ entryHeight

◆ feeDelta

◆ lockPoints

◆ m_children

◆ m_epoch_marker

◆ m_parents

◆ nCountWithAncestors

◆ nCountWithDescendants

◆ nFee

◆ nModFeesWithAncestors

◆ nModFeesWithDescendants

◆ nSigOpCostWithAncestors

◆ nSizeWithAncestors

◆ nSizeWithDescendants

◆ nTime

◆ nTxWeight

◆ nUsageSize

◆ sigOpCost

◆ spendsCoinbase

◆ tx

◆ vTxHashesIdx