Bitcoin Core  22.99.0
P2P Digital Currency
Classes | Public Member Functions | Static Public Attributes | Private Member Functions | Private Attributes | List of all members
node::BlockAssembler Class Reference

Generate a new block, without valid proof-of-work. More...

#include <miner.h>

Collaboration diagram for node::BlockAssembler:
[legend]

Classes

struct  Options
 

Public Member Functions

 BlockAssembler (CChainState &chainstate, const CTxMemPool &mempool, const CChainParams &params)
 
 BlockAssembler (CChainState &chainstate, const CTxMemPool &mempool, const CChainParams &params, const Options &options)
 
std::unique_ptr< CBlockTemplateCreateNewBlock (const CScript &scriptPubKeyIn)
 Construct a new block template with coinbase to scriptPubKeyIn. More...
 

Static Public Attributes

static std::optional< int64_t > m_last_block_num_txs {}
 
static std::optional< int64_t > m_last_block_weight {}
 

Private Member Functions

void resetBlock ()
 Clear the block's state and prepare for assembling a new block. More...
 
void AddToBlock (CTxMemPool::txiter iter)
 Add a tx to the block. More...
 
void addPackageTxs (int &nPackagesSelected, int &nDescendantsUpdated) EXCLUSIVE_LOCKS_REQUIRED(m_mempool.cs)
 Add transactions based on feerate including unconfirmed ancestors Increments nPackagesSelected / nDescendantsUpdated with corresponding statistics from the package selection (for logging statistics). More...
 
void onlyUnconfirmed (CTxMemPool::setEntries &testSet)
 Remove confirmed (inBlock) entries from given set. More...
 
bool TestPackage (uint64_t packageSize, int64_t packageSigOpsCost) const
 Test if a new package would "fit" in the block. More...
 
bool TestPackageTransactions (const CTxMemPool::setEntries &package) const
 Perform checks on each transaction in a package: locktime, premature-witness, serialized size (if necessary) These checks should always succeed, and they're here only as an extra check in case of suboptimal node configuration. More...
 
bool SkipMapTxEntry (CTxMemPool::txiter it, indexed_modified_transaction_set &mapModifiedTx, CTxMemPool::setEntries &failedTx) EXCLUSIVE_LOCKS_REQUIRED(m_mempool.cs)
 Return true if given transaction from mapTx has already been evaluated, or if the transaction's cached data in mapTx is incorrect. More...
 
void SortForBlock (const CTxMemPool::setEntries &package, std::vector< CTxMemPool::txiter > &sortedEntries)
 Sort the package in an order that is valid to appear in a block. More...
 
int UpdatePackagesForAdded (const CTxMemPool::setEntries &alreadyAdded, indexed_modified_transaction_set &mapModifiedTx) EXCLUSIVE_LOCKS_REQUIRED(m_mempool.cs)
 Add descendants of given transactions to mapModifiedTx with ancestor state updated assuming given transactions are inBlock. More...
 

Private Attributes

std::unique_ptr< CBlockTemplatepblocktemplate
 
bool fIncludeWitness
 
unsigned int nBlockMaxWeight
 
CFeeRate blockMinFeeRate
 
uint64_t nBlockWeight
 
uint64_t nBlockTx
 
uint64_t nBlockSigOpsCost
 
CAmount nFees
 
CTxMemPool::setEntries inBlock
 
int nHeight
 
int64_t m_lock_time_cutoff
 
const CChainParamschainparams
 
const CTxMemPoolm_mempool
 
CChainStatem_chainstate
 

Detailed Description

Generate a new block, without valid proof-of-work.

Definition at line 128 of file miner.h.

Constructor & Destructor Documentation

◆ BlockAssembler() [1/2]

node::BlockAssembler::BlockAssembler ( CChainState chainstate,
const CTxMemPool mempool,
const CChainParams params 
)
explicit

Definition at line 90 of file miner.cpp.

◆ BlockAssembler() [2/2]

node::BlockAssembler::BlockAssembler ( CChainState chainstate,
const CTxMemPool mempool,
const CChainParams params,
const Options options 
)
explicit

Definition at line 65 of file miner.cpp.

Member Function Documentation

◆ addPackageTxs()

void node::BlockAssembler::addPackageTxs ( int &  nPackagesSelected,
int &  nDescendantsUpdated 
)
private

Add transactions based on feerate including unconfirmed ancestors Increments nPackagesSelected / nDescendantsUpdated with corresponding statistics from the package selection (for logging statistics).

Definition at line 320 of file miner.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ AddToBlock()

void node::BlockAssembler::AddToBlock ( CTxMemPool::txiter  iter)
private

Add a tx to the block.

Definition at line 233 of file miner.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ CreateNewBlock()

std::unique_ptr< CBlockTemplate > node::BlockAssembler::CreateNewBlock ( const CScript scriptPubKeyIn)

Construct a new block template with coinbase to scriptPubKeyIn.

Definition at line 107 of file miner.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ onlyUnconfirmed()

void node::BlockAssembler::onlyUnconfirmed ( CTxMemPool::setEntries testSet)
private

Remove confirmed (inBlock) entries from given set.

Definition at line 192 of file miner.cpp.

Here is the caller graph for this function:

◆ resetBlock()

void node::BlockAssembler::resetBlock ( )
private

Clear the block's state and prepare for assembling a new block.

Definition at line 93 of file miner.cpp.

Here is the caller graph for this function:

◆ SkipMapTxEntry()

bool node::BlockAssembler::SkipMapTxEntry ( CTxMemPool::txiter  it,
indexed_modified_transaction_set mapModifiedTx,
CTxMemPool::setEntries failedTx 
)
private

Return true if given transaction from mapTx has already been evaluated, or if the transaction's cached data in mapTx is incorrect.

Definition at line 291 of file miner.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ SortForBlock()

void node::BlockAssembler::SortForBlock ( const CTxMemPool::setEntries package,
std::vector< CTxMemPool::txiter > &  sortedEntries 
)
private

Sort the package in an order that is valid to appear in a block.

Definition at line 299 of file miner.cpp.

Here is the caller graph for this function:

◆ TestPackage()

bool node::BlockAssembler::TestPackage ( uint64_t  packageSize,
int64_t  packageSigOpsCost 
) const
private

Test if a new package would "fit" in the block.

Definition at line 204 of file miner.cpp.

Here is the caller graph for this function:

◆ TestPackageTransactions()

bool node::BlockAssembler::TestPackageTransactions ( const CTxMemPool::setEntries package) const
private

Perform checks on each transaction in a package: locktime, premature-witness, serialized size (if necessary) These checks should always succeed, and they're here only as an extra check in case of suboptimal node configuration.

Definition at line 220 of file miner.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ UpdatePackagesForAdded()

int node::BlockAssembler::UpdatePackagesForAdded ( const CTxMemPool::setEntries alreadyAdded,
indexed_modified_transaction_set mapModifiedTx 
)
private

Add descendants of given transactions to mapModifiedTx with ancestor state updated assuming given transactions are inBlock.

Returns number of updated descendants.

Definition at line 252 of file miner.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

Member Data Documentation

◆ blockMinFeeRate

CFeeRate node::BlockAssembler::blockMinFeeRate
private

Definition at line 137 of file miner.h.

◆ chainparams

const CChainParams& node::BlockAssembler::chainparams
private

Definition at line 150 of file miner.h.

◆ fIncludeWitness

bool node::BlockAssembler::fIncludeWitness
private

Definition at line 135 of file miner.h.

◆ inBlock

CTxMemPool::setEntries node::BlockAssembler::inBlock
private

Definition at line 144 of file miner.h.

◆ m_chainstate

CChainState& node::BlockAssembler::m_chainstate
private

Definition at line 152 of file miner.h.

◆ m_last_block_num_txs

std::optional<int64_t> node::BlockAssembler::m_last_block_num_txs {}
inlinestatic

Definition at line 167 of file miner.h.

◆ m_last_block_weight

std::optional<int64_t> node::BlockAssembler::m_last_block_weight {}
inlinestatic

Definition at line 168 of file miner.h.

◆ m_lock_time_cutoff

int64_t node::BlockAssembler::m_lock_time_cutoff
private

Definition at line 148 of file miner.h.

◆ m_mempool

const CTxMemPool& node::BlockAssembler::m_mempool
private

Definition at line 151 of file miner.h.

◆ nBlockMaxWeight

unsigned int node::BlockAssembler::nBlockMaxWeight
private

Definition at line 136 of file miner.h.

◆ nBlockSigOpsCost

uint64_t node::BlockAssembler::nBlockSigOpsCost
private

Definition at line 142 of file miner.h.

◆ nBlockTx

uint64_t node::BlockAssembler::nBlockTx
private

Definition at line 141 of file miner.h.

◆ nBlockWeight

uint64_t node::BlockAssembler::nBlockWeight
private

Definition at line 140 of file miner.h.

◆ nFees

CAmount node::BlockAssembler::nFees
private

Definition at line 143 of file miner.h.

◆ nHeight

int node::BlockAssembler::nHeight
private

Definition at line 147 of file miner.h.

◆ pblocktemplate

std::unique_ptr<CBlockTemplate> node::BlockAssembler::pblocktemplate
private

Definition at line 132 of file miner.h.


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