Bitcoin
|
#include <txmempool.h>
Classes | |
struct | CompareIteratorByHash |
struct | TxLinks |
Public Types | |
typedef boost::multi_index_container< CTxMemPoolEntry, boost::multi_index::indexed_by< boost::multi_index::hashed_unique< mempoolentry_txid, SaltedTxidHasher >, boost::multi_index::ordered_non_unique< boost::multi_index::tag< descendant_score >, boost::multi_index::identity< CTxMemPoolEntry >, CompareTxMemPoolEntryByDescendantScore >, boost::multi_index::ordered_non_unique< boost::multi_index::tag< entry_time >, boost::multi_index::identity< CTxMemPoolEntry >, CompareTxMemPoolEntryByEntryTime >, boost::multi_index::ordered_non_unique< boost::multi_index::tag< ancestor_score >, boost::multi_index::identity< CTxMemPoolEntry >, CompareTxMemPoolEntryByAncestorFee > > > | indexed_transaction_set |
using | txiter = indexed_transaction_set::nth_index< 0 >::type::const_iterator |
typedef std::set< txiter, CompareIteratorByHash > | setEntries |
Public Attributes | |
RecursiveMutex | cs |
std::map< uint256, CAmount > | mapDeltas |
void | cs_main |
boost::signals2::signal< void(CTransactionRef)> | NotifyEntryAdded |
boost::signals2::signal< void(CTransactionRef, MemPoolRemovalReason)> | NotifyEntryRemoved |
Static Public Attributes | |
static const int | ROLLING_FEE_HALFLIFE = 60 * 60 * 12 |
Private Types | |
typedef std::map< txiter, setEntries, CompareIteratorByHash > | cacheMap |
typedef std::map< txiter, TxLinks, CompareIteratorByHash > | txlinksMap |
Private Attributes | |
std::atomic< unsigned int > | nTransactionsUpdated |
Used by getblocktemplate to trigger CreateNewBlock() invocation. More... | |
CBlockPolicyEstimator * | minerPolicyEstimator |
uint64_t | totalTxSize |
sum of all mempool tx's virtual sizes. Differs from serialized tx size since witness data is discounted. Defined in BIP 141. More... | |
uint64_t | cachedInnerUsage |
sum of dynamic memory usage of all the map elements (NOT the maps themselves) More... | |
int64_t | lastRollingFeeUpdate |
bool | blockSinceLastRollingFeeBump |
double | rollingMinimumFeeRate |
minimum fee to get into the pool, decreases exponentially More... | |
txlinksMap | mapLinks |
CTxMemPool stores valid-according-to-the-current-best-chain transactions that may be included in the next block.
Transactions are added when they are seen on the network (or created by the local node), but not all transactions seen are added to the pool. For example, the following new transactions will not be added to the mempool:
CTxMemPool::mapTx, and CTxMemPoolEntry bookkeeping:
mapTx is a boost::multi_index that sorts the mempool on 4 criteria:
Note: the term "descendant" refers to in-mempool transactions that depend on this one, while "ancestor" refers to in-mempool transactions that a given transaction depends on.
In order for the feerate sort to remain correct, we must update transactions in the mempool when new descendants arrive. To facilitate this, we track the set of in-mempool direct parents and direct children in mapLinks. Within each CTxMemPoolEntry, we track the size and fees of all descendants.
Usually when a new transaction is added to the mempool, it has no in-mempool children (because any such children would be an orphan). So in addUnchecked(), we:
When a transaction is removed from the mempool, we must:
These happen in UpdateForRemoveFromMempool(). (Note that when removing a transaction along with its descendants, we must calculate that set of transactions to be removed before doing the removal, or else the mempool can be in an inconsistent state where it's impossible to walk the ancestors of a transaction.)
In the event of a reorg, the assumption that a newly added tx has no in-mempool children is false. In particular, the mempool is in an inconsistent state while new transactions are being added, because there may be descendant transactions of a tx coming from a disconnected block that are unreachable from just looking at transactions in the mempool (the linking transactions may also be in the disconnected block, waiting to be added). Because of this, there's not much benefit in trying to search for in-mempool children in addUnchecked(). Instead, in the special case of transactions being added from a disconnected block, we require the caller to clean up the state, to account for in-mempool, out-of-block descendants for all the in-block transactions by calling UpdateTransactionsFromBlock(). Note that until this is called, the mempool state is not consistent, and in particular mapLinks may not be correct (and therefore functions like CalculateMemPoolAncestors() and CalculateDescendants() that rely on them to walk the mempool are not generally safe to use).
Computational limits:
Updating all in-mempool ancestors of a newly added transaction can be slow, if no bound exists on how many in-mempool ancestors there may be. CalculateMemPoolAncestors() takes configurable limits that are designed to prevent these calculations from being too CPU intensive.
|
private |
typedef boost::multi_index_container< CTxMemPoolEntry, boost::multi_index::indexed_by< boost::multi_index::hashed_unique<mempoolentry_txid, SaltedTxidHasher>, boost::multi_index::ordered_non_unique< boost::multi_index::tag<descendant_score>, boost::multi_index::identity<CTxMemPoolEntry>, CompareTxMemPoolEntryByDescendantScore >, boost::multi_index::ordered_non_unique< boost::multi_index::tag<entry_time>, boost::multi_index::identity<CTxMemPoolEntry>, CompareTxMemPoolEntryByEntryTime >, boost::multi_index::ordered_non_unique< boost::multi_index::tag<ancestor_score>, boost::multi_index::identity<CTxMemPoolEntry>, CompareTxMemPoolEntryByAncestorFee > > > CTxMemPool::indexed_transaction_set |
typedef std::set<txiter, CompareIteratorByHash> CTxMemPool::setEntries |
using CTxMemPool::txiter = indexed_transaction_set::nth_index<0>::type::const_iterator |
|
private |
|
explicit |
Create a new CTxMemPool.
void CTxMemPool::_clear | ( | ) |
void CTxMemPool::AddTransactionsUpdated | ( | unsigned int | n | ) |
void CTxMemPool::addUnchecked | ( | const CTxMemPoolEntry & | entry, |
bool | validFeeEstimate = true |
||
) |
void CTxMemPool::addUnchecked | ( | const CTxMemPoolEntry & | entry, |
setEntries & | setAncestors, | ||
bool | validFeeEstimate = true |
||
) |
void CTxMemPool::CalculateDescendants | ( | txiter | it, |
setEntries & | setDescendants | ||
) | const |
Populate setDescendants with all in-mempool descendants of hash. Assumes that setDescendants includes all in-mempool descendants of anything already in it.
bool CTxMemPool::CalculateMemPoolAncestors | ( | const CTxMemPoolEntry & | entry, |
setEntries & | setAncestors, | ||
uint64_t | limitAncestorCount, | ||
uint64_t | limitAncestorSize, | ||
uint64_t | limitDescendantCount, | ||
uint64_t | limitDescendantSize, | ||
std::string & | errString, | ||
bool | fSearchForParents = true |
||
) | const |
Try to calculate all in-mempool ancestors of entry. (these are all calculated including the tx itself) limitAncestorCount = max number of ancestors limitAncestorSize = max size of ancestors limitDescendantCount = max number of descendants any ancestor can have limitDescendantSize = max size of descendants any ancestor can have errString = populated with error reason if any limits are hit fSearchForParents = whether to search a tx's vin for in-mempool parents, or look up parents from mapLinks. Must be true for entries not in the mempool
void CTxMemPool::check | ( | const CCoinsViewCache * | pcoins | ) | const |
If sanity-checking is turned on, check makes sure the pool is consistent (does not contain two transactions that spend the same inputs, all inputs are in the mapNextTx array). If sanity-checking is turned off, check does nothing.
void CTxMemPool::clear | ( | ) |
void CTxMemPool::ClearPrioritisation | ( | const uint256 | hash | ) |
size_t CTxMemPool::DynamicMemoryUsage | ( | ) | const |
|
inline |
int CTxMemPool::Expire | ( | int64_t | time | ) |
Expire all transaction (and their dependencies) in the mempool older than time. Return the number of removed transactions.
CTransactionRef CTxMemPool::get | ( | const uint256 & | hash | ) | const |
const CTransaction * CTxMemPool::GetConflictTx | ( | const COutPoint & | prevout | ) | const |
Get the transaction in the pool that spends the same prevout
boost::optional< CTxMemPool::txiter > CTxMemPool::GetIter | ( | const uint256 & | txid | ) | const |
Returns an iterator to the given hash, if found
CTxMemPool::setEntries CTxMemPool::GetIterSet | ( | const std::set< uint256 > & | hashes | ) | const |
Translate a set of hashes into a set of pool iterators to avoid repeated lookups
const CTxMemPool::setEntries & CTxMemPool::GetMemPoolChildren | ( | txiter | entry | ) | const |
const CTxMemPool::setEntries & CTxMemPool::GetMemPoolParents | ( | txiter | entry | ) | const |
CFeeRate CTxMemPool::GetMinFee | ( | size_t | sizelimit | ) | const |
The minimum fee to get into the mempool, which may itself not be enough for larger-sized transactions. The incrementalRelayFee policy variable is used to bound the time it takes the fee rate to go back down all the way to 0. When the feerate would otherwise be half of this, it is set to 0 instead.
|
private |
|
inline |
void CTxMemPool::GetTransactionAncestry | ( | const uint256 & | txid, |
size_t & | ancestors, | ||
size_t & | descendants | ||
) | const |
Calculate the ancestor and descendant count for the given transaction. The counts include the transaction itself.
unsigned int CTxMemPool::GetTransactionsUpdated | ( | ) | const |
Value n means that n times in 2^32 we check.
|
inlineprivate |
indexed_transaction_set mapTx CTxMemPool::GUARDED_BY | ( | cs | ) |
All tx witness hashes/entries in mapTx, in random order.
indirectmap<COutPoint, const CTransaction*> mapNextTx CTxMemPool::GUARDED_BY | ( | cs | ) |
bool CTxMemPool::HasNoInputsOf | ( | const CTransaction & | tx | ) | const |
Check that none of this transactions inputs are in the mempool, and thus the tx is not dependent on other mempool transactions to be included in a block.
TxMempoolInfo CTxMemPool::info | ( | const uint256 & | hash | ) | const |
std::vector< TxMempoolInfo > CTxMemPool::infoAll | ( | ) | const |
bool CTxMemPool::IsLoaded | ( | ) | const |
bool CTxMemPool::isSpent | ( | const COutPoint & | outpoint | ) | const |
Affect CreateNewBlock prioritisation of transactions
void CTxMemPool::queryHashes | ( | std::vector< uint256 > & | vtxid | ) | const |
void CTxMemPool::removeConflicts | ( | const CTransaction & | tx | ) |
void CTxMemPool::removeForBlock | ( | const std::vector< CTransactionRef > & | vtx, |
unsigned int | nBlockHeight | ||
) |
Called when a block is connected. Removes from mempool and updates the miner fee estimator.
void CTxMemPool::removeForReorg | ( | const CCoinsViewCache * | pcoins, |
unsigned int | nMemPoolHeight, | ||
int | flags | ||
) |
void CTxMemPool::removeRecursive | ( | const CTransaction & | tx, |
MemPoolRemovalReason | reason = MemPoolRemovalReason::UNKNOWN |
||
) |
void CTxMemPool::RemoveStaged | ( | setEntries & | stage, |
bool | updateDescendants, | ||
MemPoolRemovalReason | reason = MemPoolRemovalReason::UNKNOWN |
||
) |
Remove a set of transactions from the mempool. If a transaction is in this set, then all in-mempool descendants must also be in the set, unless this transaction is being removed for being in a block. Set updateDescendants to true when removing a tx that was in a block, so that any in-mempool descendants have their ancestor state updated.
|
private |
Before calling removeUnchecked for a given transaction, UpdateForRemoveFromMempool must be called on the entire (dependent) set of transactions being removed at the same time. We use each CTxMemPoolEntry's setMemPoolParents in order to walk ancestors of a given transaction that is removed, so we can't remove intermediate transactions in a chain before we've updated all the state for the removal.
void CTxMemPool::SetIsLoaded | ( | bool | loaded | ) |
Sets the current loaded state
|
inline |
|
inline |
|
private |
void CTxMemPool::TrimToSize | ( | size_t | sizelimit, |
std::vector< COutPoint > * | pvNoSpendsRemaining = nullptr |
||
) |
Remove transactions from the mempool until its dynamic size is <= sizelimit. pvNoSpendsRemaining, if set, will be populated with the list of outpoints which are not in mempool which no longer have any spends in this mempool.
|
private |
Update ancestors of hash to add/remove it as a descendant transaction.
|
private |
Sever link between specified transaction and direct children.
|
private |
Set ancestor state for an entry
|
private |
UpdateForDescendants is used by UpdateTransactionsFromBlock to update the descendants for a single transaction that has been added to the mempool but may have child transactions in the mempool, eg during a chain reorg. setExclude is the set of descendant transactions in the mempool that must not be accounted for (because any descendants in setExclude were added to the mempool after the transaction being updated and hence their state is already reflected in the parent state).
cachedDescendants will be updated with the descendants of the transaction being updated, so that future invocations don't need to walk the same transaction again, if encountered in another transaction chain.
|
private |
For each transaction being removed, update ancestors and any direct children. If updateDescendants is true, then also update in-mempool descendants' ancestor state.
void CTxMemPool::UpdateTransactionsFromBlock | ( | const std::vector< uint256 > & | vHashesToUpdate | ) |
When adding transactions from a disconnected block back to the mempool, new mempool entries may have children in the mempool (which is generally not the case when otherwise adding transactions). UpdateTransactionsFromBlock() will find child transactions and update the descendant state for each transaction in vHashesToUpdate (excluding any child transactions present in vHashesToUpdate, which are already accounted for). Note: vHashesToUpdate should be the set of transactions from the disconnected block that have been accepted back into the mempool.
|
mutableprivate |
|
private |
sum of dynamic memory usage of all the map elements (NOT the maps themselves)
|
mutable |
This mutex needs to be locked when accessing mapTx
or other members that are guarded by it.
By design, it is guaranteed that:
cs_main
and mempool.cs
will give a view of mempool that is consistent with current chain tip (ChainActive()
and pcoinsTip
) and is fully populated. Fully populated means that if the current active chain is missing transactions that were present in a previously active chain, all the missing transactions will have been re-added to the mempool and should be present if they meet size and consistency constraints.mempool.cs
without cs_main
will give a view of a mempool consistent with some chain that was active since cs_main
was last locked, and that is fully populated as described above. It is ok for code that only needs to query or remove transactions from the mempool to lock just mempool.cs
without cs_main
.To provide these guarantees, it is necessary to lock both cs_main
and mempool.cs
whenever adding transactions to the mempool and whenever changing the chain tip. It's necessary to keep both mutexes locked until the mempool is consistent with the new chain tip and fully populated.
void CTxMemPool::cs_main |
|
mutableprivate |
|
private |
|
private |
boost::signals2::signal<void (CTransactionRef)> CTxMemPool::NotifyEntryAdded |
boost::signals2::signal<void (CTransactionRef, MemPoolRemovalReason)> CTxMemPool::NotifyEntryRemoved |
|
private |
Used by getblocktemplate to trigger CreateNewBlock() invocation.
|
static |
|
mutableprivate |
minimum fee to get into the pool, decreases exponentially
|
private |
sum of all mempool tx's virtual sizes. Differs from serialized tx size since witness data is discounted. Defined in BIP 141.