Update comments in txmempool to be doxygen compatible
Fix typo in Read() error message
This commit is contained in:
Michael Ford
parent
3d3ce7421e
commit
7329fdd1ba
2 changed files with 47 additions and 35 deletions
|
|
@ -1,6 +1,6 @@
|
|||
// Copyright (c) 2009-2010 Satoshi Nakamoto
|
||||
// Copyright (c) 2009-2013 The Bitcoin developers
|
||||
// Distributed under the MIT/X11 software license, see the accompanying
|
||||
// Copyright (c) 2009-2014 The Bitcoin developers
|
||||
// Distributed under the MIT software license, see the accompanying
|
||||
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
|
||||
|
||||
#include "txmempool.h"
|
||||
|
|
@ -45,9 +45,9 @@ CTxMemPoolEntry::GetPriority(unsigned int currentHeight) const
|
|||
return dResult;
|
||||
}
|
||||
|
||||
//
|
||||
// Keep track of fee/priority for transactions confirmed within N blocks
|
||||
//
|
||||
/**
|
||||
* Keep track of fee/priority for transactions confirmed within N blocks
|
||||
*/
|
||||
class CBlockAverage
|
||||
{
|
||||
private:
|
||||
|
|
@ -86,8 +86,10 @@ public:
|
|||
return prioritySamples.size();
|
||||
}
|
||||
|
||||
// Used as belt-and-suspenders check when reading to detect
|
||||
// file corruption
|
||||
/**
|
||||
* Used as belt-and-suspenders check when reading to detect
|
||||
* file corruption
|
||||
*/
|
||||
bool AreSane(const std::vector<CFeeRate>& vecFee, const CFeeRate& minRelayFee)
|
||||
{
|
||||
BOOST_FOREACH(CFeeRate fee, vecFee)
|
||||
|
|
@ -139,16 +141,20 @@ public:
|
|||
class CMinerPolicyEstimator
|
||||
{
|
||||
private:
|
||||
// Records observed averages transactions that confirmed within one block, two blocks,
|
||||
// three blocks etc.
|
||||
/**
|
||||
* Records observed averages transactions that confirmed within one block, two blocks,
|
||||
* three blocks etc.
|
||||
*/
|
||||
std::vector<CBlockAverage> history;
|
||||
std::vector<CFeeRate> sortedFeeSamples;
|
||||
std::vector<double> sortedPrioritySamples;
|
||||
|
||||
int nBestSeenHeight;
|
||||
|
||||
// nBlocksAgo is 0 based, i.e. transactions that confirmed in the highest seen block are
|
||||
// nBlocksAgo == 0, transactions in the block before that are nBlocksAgo == 1 etc.
|
||||
/**
|
||||
* nBlocksAgo is 0 based, i.e. transactions that confirmed in the highest seen block are
|
||||
* nBlocksAgo == 0, transactions in the block before that are nBlocksAgo == 1 etc.
|
||||
*/
|
||||
void seenTxConfirm(const CFeeRate& feeRate, const CFeeRate& minRelayFee, double dPriority, int nBlocksAgo)
|
||||
{
|
||||
// Last entry records "everything else".
|
||||
|
|
@ -248,7 +254,9 @@ public:
|
|||
}
|
||||
}
|
||||
|
||||
// Can return CFeeRate(0) if we don't have any data for that many blocks back. nBlocksToConfirm is 1 based.
|
||||
/**
|
||||
* Can return CFeeRate(0) if we don't have any data for that many blocks back. nBlocksToConfirm is 1 based.
|
||||
*/
|
||||
CFeeRate estimateFee(int nBlocksToConfirm)
|
||||
{
|
||||
nBlocksToConfirm--;
|
||||
|
|
@ -332,7 +340,7 @@ public:
|
|||
size_t numEntries;
|
||||
filein >> numEntries;
|
||||
if (numEntries <= 0 || numEntries > 10000)
|
||||
throw runtime_error("Corrupt estimates file. Must have between 1 and 10k entires.");
|
||||
throw runtime_error("Corrupt estimates file. Must have between 1 and 10k entries.");
|
||||
|
||||
std::vector<CBlockAverage> fileHistory;
|
||||
|
||||
|
|
@ -462,7 +470,9 @@ void CTxMemPool::removeConflicts(const CTransaction &tx, std::list<CTransaction>
|
|||
}
|
||||
}
|
||||
|
||||
// Called when a block is connected. Removes from mempool and updates the miner fee estimator.
|
||||
/**
|
||||
* Called when a block is connected. Removes from mempool and updates the miner fee estimator.
|
||||
*/
|
||||
void CTxMemPool::removeForBlock(const std::vector<CTransaction>& vtx, unsigned int nBlockHeight,
|
||||
std::list<CTransaction>& conflicts)
|
||||
{
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
// Copyright (c) 2009-2010 Satoshi Nakamoto
|
||||
// Copyright (c) 2009-2013 The Bitcoin developers
|
||||
// Distributed under the MIT/X11 software license, see the accompanying
|
||||
// Copyright (c) 2009-2014 The Bitcoin developers
|
||||
// Distributed under the MIT software license, see the accompanying
|
||||
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
|
||||
|
||||
#ifndef BITCOIN_TXMEMPOOL_H
|
||||
|
|
@ -25,19 +25,19 @@ inline bool AllowFree(double dPriority)
|
|||
/** Fake height value used in CCoins to signify they are only in the memory pool (since 0.8) */
|
||||
static const unsigned int MEMPOOL_HEIGHT = 0x7FFFFFFF;
|
||||
|
||||
/*
|
||||
/**
|
||||
* CTxMemPool stores these:
|
||||
*/
|
||||
class CTxMemPoolEntry
|
||||
{
|
||||
private:
|
||||
CTransaction tx;
|
||||
CAmount nFee; // Cached to avoid expensive parent-transaction lookups
|
||||
size_t nTxSize; // ... and avoid recomputing tx size
|
||||
size_t nModSize; // ... and modified size for priority
|
||||
int64_t nTime; // Local time when entering the mempool
|
||||
double dPriority; // Priority when entering the mempool
|
||||
unsigned int nHeight; // Chain height when entering the mempool
|
||||
CAmount nFee; //! Cached to avoid expensive parent-transaction lookups
|
||||
size_t nTxSize; //! ... and avoid recomputing tx size
|
||||
size_t nModSize; //! ... and modified size for priority
|
||||
int64_t nTime; //! Local time when entering the mempool
|
||||
double dPriority; //! Priority when entering the mempool
|
||||
unsigned int nHeight; //! Chain height when entering the mempool
|
||||
|
||||
public:
|
||||
CTxMemPoolEntry(const CTransaction& _tx, const CAmount& _nFee,
|
||||
|
|
@ -68,7 +68,7 @@ public:
|
|||
bool IsNull() const { return (ptx == NULL && n == (uint32_t) -1); }
|
||||
};
|
||||
|
||||
/*
|
||||
/**
|
||||
* CTxMemPool stores valid-according-to-the-current-best-chain
|
||||
* transactions that may be included in the next block.
|
||||
*
|
||||
|
|
@ -81,12 +81,12 @@ public:
|
|||
class CTxMemPool
|
||||
{
|
||||
private:
|
||||
bool fSanityCheck; // Normally false, true if -checkmempool or -regtest
|
||||
bool fSanityCheck; //! Normally false, true if -checkmempool or -regtest
|
||||
unsigned int nTransactionsUpdated;
|
||||
CMinerPolicyEstimator* minerPolicyEstimator;
|
||||
|
||||
CFeeRate minRelayFee; // Passed to constructor to avoid dependency on main
|
||||
uint64_t totalTxSize; // sum of all mempool tx' byte sizes
|
||||
CFeeRate minRelayFee; //! Passed to constructor to avoid dependency on main
|
||||
uint64_t totalTxSize; //! sum of all mempool tx' byte sizes
|
||||
|
||||
public:
|
||||
mutable CCriticalSection cs;
|
||||
|
|
@ -97,7 +97,7 @@ public:
|
|||
CTxMemPool(const CFeeRate& _minRelayFee);
|
||||
~CTxMemPool();
|
||||
|
||||
/*
|
||||
/**
|
||||
* 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,
|
||||
|
|
@ -141,19 +141,21 @@ public:
|
|||
|
||||
bool lookup(uint256 hash, CTransaction& result) const;
|
||||
|
||||
// Estimate fee rate needed to get into the next
|
||||
// nBlocks
|
||||
/** Estimate fee rate needed to get into the next nBlocks */
|
||||
CFeeRate estimateFee(int nBlocks) const;
|
||||
// Estimate priority needed to get into the next
|
||||
// nBlocks
|
||||
|
||||
/** Estimate priority needed to get into the next nBlocks */
|
||||
double estimatePriority(int nBlocks) const;
|
||||
// Write/Read estimates to disk
|
||||
|
||||
/** Write/Read estimates to disk */
|
||||
bool WriteFeeEstimates(CAutoFile& fileout) const;
|
||||
bool ReadFeeEstimates(CAutoFile& filein);
|
||||
};
|
||||
|
||||
/** CCoinsView that brings transactions from a memorypool into view.
|
||||
It does not check for spendings by memory pool transactions. */
|
||||
/**
|
||||
* CCoinsView that brings transactions from a memorypool into view.
|
||||
* It does not check for spendings by memory pool transactions.
|
||||
*/
|
||||
class CCoinsViewMemPool : public CCoinsViewBacked
|
||||
{
|
||||
protected:
|
||||
|
|
|
|||
Loading…
Reference in a new issue