READ THE CODE

Inside Bitcoin

The code behind the network, with room to understand it.

Stable release v32.1bitcoin/bitcoin · f0de87f04062 ↗3,020 source files · 47.5 MB stored on the server340 file guides

Release published 2026-10-28 · Snapshot fetched 2026-11-01. Latest stable release at fetch time; development branches and Git history are excluded. Only the selected code window and visible folders load here.

7,957 bytes · SHA-256 84ac29cbdd1a8ca7… · View upstream ↗

1// Copyright (c) 2009-present The Bitcoin Core developers
2// Distributed under the MIT software license, see the accompanying
3// file COPYING or http://www.opensource.org/licenses/mit-license.php.
4
5#ifndef BITCOIN_KERNEL_MEMPOOL_ENTRY_H
6#define BITCOIN_KERNEL_MEMPOOL_ENTRY_H
7
8#include <consensus/amount.h>
9#include <consensus/validation.h>
10#include <core_memusage.h>
11#include <policy/policy.h>
12#include <policy/settings.h>
13#include <primitives/transaction.h>
14#include <txgraph.h>
15#include <util/overflow.h>
16#include <util/time.h>
17
18#include <cstddef>
19#include <cstdint>
20#include <functional>
21#include <memory>
22#include <set>
23
24class CBlockIndex;
25
26struct LockPoints {
27    // Will be set to the blockchain height and median time past
28    // values that would be necessary to satisfy all relative locktime
29    // constraints (BIP68) of this tx given our view of block chain history
30    int height{0};
31    int64_t time{0};
32    // As long as the current chain descends from the highest height block
33    // containing one of the inputs used in the calculation, then the cached
34    // values are still valid even after a reorg.
35    CBlockIndex* maxInputBlock{nullptr};
36};
37
38struct CompareIteratorByHash {
39    // SFINAE for T where T is either a pointer type (e.g., a txiter) or a reference_wrapper<T>
40    // (e.g. a wrapped CTxMemPoolEntry&)
41    template <typename T>
42    bool operator()(const std::reference_wrapper<T>& a, const std::reference_wrapper<T>& b) const
43    {
44        return a.get().GetTx().GetHash() < b.get().GetTx().GetHash();
45    }
46    template <typename T>
47    bool operator()(const T& a, const T& b) const
48    {
49        return a->GetTx().GetHash() < b->GetTx().GetHash();
50    }
51};
52
53/** \class CTxMemPoolEntry
54 *
55 * CTxMemPoolEntry stores data about the corresponding transaction, as well
56 * as data about all in-mempool transactions that depend on the transaction
57 * ("descendant" transactions).
58 *
59 * When a new entry is added to the mempool, we update the descendant state
60 * (m_count_with_descendants, nSizeWithDescendants, and nModFeesWithDescendants) for
61 * all ancestors of the newly added transaction.
62 *
63 */
64
65class CTxMemPoolEntry : public TxGraph::Ref
66{
67public:
68    typedef std::reference_wrapper<const CTxMemPoolEntry> CTxMemPoolEntryRef;
69
70private:
71    CTxMemPoolEntry(const CTxMemPoolEntry&) = delete;
72
73    const CTransactionRef tx;
74    const CAmount nFee;             //!< Cached to avoid expensive parent-transaction lookups
75    const int32_t nTxWeight;         //!< ... and avoid recomputing tx weight (also used for GetTxSize())
76    const size_t nUsageSize;        //!< ... and total memory usage
77    const int64_t nTime;            //!< Local time when entering the mempool
78    const uint64_t entry_sequence;  //!< Sequence number used to determine whether this transaction is too recent for relay
79    const unsigned int entryHeight; //!< Chain height when entering the mempool
80    const bool spendsCoinbase;      //!< keep track of transactions that spend a coinbase
81    const int64_t sigOpCost;        //!< Total sigop cost
82    mutable CAmount m_modified_fee; //!< Used for determining the priority of the transaction for mining in a block
83    mutable LockPoints lockPoints;  //!< Track the height and time at which tx was final
84
85public:
86    virtual ~CTxMemPoolEntry() = default;
87    CTxMemPoolEntry(const CTransactionRef& tx, CAmount fee,
88                    int64_t time, unsigned int entry_height, uint64_t entry_sequence,
89                    bool spends_coinbase,
90                    int64_t sigops_cost, LockPoints lp)
91        : tx{tx},
92          nFee{fee},
93          nTxWeight{GetTransactionWeight(*tx)},
94          nUsageSize{RecursiveDynamicUsage(tx)},
95          nTime{time},
96          entry_sequence{entry_sequence},
97          entryHeight{entry_height},
98          spendsCoinbase{spends_coinbase},
99          sigOpCost{sigops_cost},
100          m_modified_fee{nFee},
101          lockPoints{lp} {}
102
103    CTxMemPoolEntry& operator=(const CTxMemPoolEntry&) = delete;
104    CTxMemPoolEntry(CTxMemPoolEntry&&) = default;
105    CTxMemPoolEntry& operator=(CTxMemPoolEntry&&) = delete;
106
107    const CTransaction& GetTx() const { return *this->tx; }
108    CTransactionRef GetSharedTx() const { return this->tx; }
109    const CAmount& GetFee() const { return nFee; }
110    int32_t GetTxSize() const
111    {
112        return GetVirtualTransactionSize(nTxWeight, sigOpCost, ::nBytesPerSigOp);
113    }
114    int32_t GetAdjustedWeight() const { return GetSigOpsAdjustedWeight(nTxWeight, sigOpCost, ::nBytesPerSigOp); }
115    int32_t GetTxWeight() const { return nTxWeight; }
116    std::chrono::seconds GetTime() const { return std::chrono::seconds{nTime}; }
117    unsigned int GetHeight() const { return entryHeight; }
118    uint64_t GetSequence() const { return entry_sequence; }
119    int64_t GetSigOpCost() const { return sigOpCost; }
120    CAmount GetModifiedFee() const { return m_modified_fee; }
121    size_t DynamicMemoryUsage() const { return nUsageSize; }
122    const LockPoints& GetLockPoints() const { return lockPoints; }
123
124    // Updates the modified fees with descendants/ancestors.
125    void UpdateModifiedFee(CAmount fee_diff) const
126    {
127        m_modified_fee = SaturatingAdd(m_modified_fee, fee_diff);
128    }
129
130    // Update the LockPoints after a reorg
131    void UpdateLockPoints(const LockPoints& lp) const
132    {
133        lockPoints = lp;
134    }
135
136    bool GetSpendsCoinbase() const { return spendsCoinbase; }
137
138    mutable size_t idx_randomized; //!< Index in mempool's txns_randomized
139};
140
141using CTxMemPoolEntryRef = CTxMemPoolEntry::CTxMemPoolEntryRef;
142
143struct TransactionInfo {
144    const CTransactionRef m_tx;
145    /* The fee the transaction paid */
146    const CAmount m_fee;
147    /**
148     * The virtual transaction size.
149     *
150     * This is a policy field which considers the sigop cost of the
151     * transaction as well as its weight, and reinterprets it as bytes.
152     *
153     * It is the primary metric by which the mining algorithm selects
154     * transactions.
155     */
156    const int64_t m_virtual_transaction_size;
157    /* The block height the transaction entered the mempool */
158    const unsigned int txHeight;
159
160    TransactionInfo(const CTransactionRef& tx, const CAmount& fee, const int64_t vsize, const unsigned int height)
161        : m_tx{tx},
162          m_fee{fee},
163          m_virtual_transaction_size{vsize},
164          txHeight{height} {}
165};
166
167struct RemovedMempoolTransactionInfo {
168    TransactionInfo info;
169    explicit RemovedMempoolTransactionInfo(const CTxMemPoolEntry& entry)
170        : info{entry.GetSharedTx(), entry.GetFee(), entry.GetTxSize(), entry.GetHeight()} {}
171};
172
173struct NewMempoolTransactionInfo {
174    TransactionInfo info;
175    /*
176     * This boolean indicates whether the transaction was added
177     * without enforcing mempool fee limits.
178     */
179    const bool m_mempool_limit_bypassed;
180    /* This boolean indicates whether the transaction is part of a package. */
181    const bool m_submitted_in_package;
182    /*
183     * This boolean indicates whether the blockchain is up to date when the
184     * transaction is added to the mempool.
185     */
186    const bool m_chainstate_is_current;
187    /* Indicates whether the transaction has unconfirmed parents. */
188    const bool m_has_no_mempool_parents;
189
190    explicit NewMempoolTransactionInfo(const CTransactionRef& tx, const CAmount& fee,
191                                       const int64_t vsize, const unsigned int height,
192                                       const bool mempool_limit_bypassed, const bool submitted_in_package,
193                                       const bool chainstate_is_current,
194                                       const bool has_no_mempool_parents)
195        : info{tx, fee, vsize, height},
196          m_mempool_limit_bypassed{mempool_limit_bypassed},
197          m_submitted_in_package{submitted_in_package},
198          m_chainstate_is_current{chainstate_is_current},
199          m_has_no_mempool_parents{has_no_mempool_parents} {}
200};
201
202#endif // BITCOIN_KERNEL_MEMPOOL_ENTRY_H
203

src/wallet/receive.cpp

src/wallet/coinselection.cpp

src/consensus/validation.h

src/primitives/transaction.cpp

src/script/descriptor.cpp

src/bitcoin-cli.cpp

src/rpc/blockchain.cpp

src/rpc/rawtransaction.cpp

src/init.cpp

src/crypto/sha256.cpp

src/consensus/merkle.h

src/consensus/tx_check.h

src/consensus/tx_verify.h

src/policy/feerate.h

src/policy/feerate.cpp

src/primitives/transaction_identifier.h

src/chainparamsbase.h

src/chainparamsbase.cpp

src/util/moneystr.cpp

src/crypto/ripemd160.h

src/crypto/sha1.h

src/crypto/sha512.h

src/crypto/hmac_sha256.h

src/crypto/hmac_sha512.h

src/crypto/hmac_sha256.cpp

src/crypto/hmac_sha512.cpp

src/crypto/hkdf_sha256_32.h

src/crypto/hkdf_sha256_32.cpp

src/support/cleanse.h

src/support/cleanse.cpp

src/crypto/siphash.cpp

src/crypto/muhash.h

src/crypto/chacha20.h

src/crypto/poly1305.h

src/crypto/chacha20poly1305.h

src/crypto/chacha20poly1305.cpp

src/util/chaintype.cpp

src/util/obfuscation.h

src/util/byte_units.h

src/util/overflow.h

src/blockencodings.cpp

src/net_permissions.cpp

src/policy/packages.cpp

src/policy/rbf.cpp

src/policy/truc_policy.cpp

src/policy/ephemeral_policy.cpp

src/policy/settings.cpp

src/policy/policy.cpp

src/node/transaction.cpp

src/node/coin.cpp

src/rpc/client.cpp

src/rpc/external_signer.cpp

src/rpc/request.cpp

src/rpc/server_util.cpp

src/rpc/fees.cpp

src/rpc/output_script.cpp

src/rpc/rawtransaction_util.cpp

src/rpc/rawtransaction_util.h

src/rpc/register.h

src/rpc/request.h

src/rpc/server_util.h

src/rpc/protocol.h

src/rpc/server.h

src/rpc/signmessage.cpp

src/rpc/txoutproof.cpp

src/rpc/util.cpp

src/rpc/util.h

src/wallet/rpc/addresses.cpp

src/wallet/rpc/backup.cpp

src/wallet/rpc/coins.cpp

src/wallet/rpc/encrypt.cpp

src/wallet/rpc/signmessage.cpp

src/wallet/rpc/util.cpp

src/wallet/rpc/util.h

src/wallet/coincontrol.cpp

src/wallet/coincontrol.h

src/wallet/context.cpp

src/wallet/context.h

src/wallet/crypter.cpp

src/wallet/crypter.h

src/wallet/db.cpp

src/wallet/export.cpp

src/wallet/external_signer_scriptpubkeyman.cpp

src/wallet/rpc/spend.cpp

src/wallet/rpc/transactions.cpp

src/wallet/rpc/wallet.cpp

src/wallet/feebumper.cpp

src/wallet/feebumper.h

src/index/base.h

src/index/base.cpp

src/index/txindex.h

src/index/txindex.cpp

src/index/txindex_key.h

src/index/txospenderindex.h

src/index/txospenderindex.cpp

src/index/blockfilterindex.h

src/index/blockfilterindex.cpp

src/index/coinstatsindex.h

src/index/coinstatsindex.cpp

src/index/db_key.h

src/index/disktxpos.h

src/kernel/chain.cpp

src/kernel/chain.h

src/kernel/checks.cpp

src/kernel/checks.h

src/kernel/context.cpp

src/kernel/context.h

src/kernel/cs_main.cpp

src/kernel/cs_main.h

src/kernel/disconnected_transactions.cpp

src/kernel/disconnected_transactions.h

src/kernel/mempool_removal_reason.cpp

src/kernel/mempool_removal_reason.h

src/kernel/coinstats.cpp

src/kernel/coinstats.h

src/kernel/chainparams.cpp

src/kernel/chainparams.h

src/wallet/sqlite.cpp

src/wallet/sqlite.h

src/wallet/transaction.cpp

src/wallet/transaction.h

src/wallet/dump.cpp

src/wallet/dump.h

src/wallet/init.cpp

src/wallet/walletutil.cpp

src/wallet/walletutil.h

src/wallet/wallettool.cpp

src/wallet/wallettool.h

src/wallet/export.h

src/wallet/migrate.cpp

src/wallet/migrate.h

src/wallet/db.h

src/wallet/walletdb.cpp

src/wallet/interfaces.cpp

src/wallet/scriptpubkeyman.cpp

src/wallet/scriptpubkeyman.h

src/kernel/bitcoinkernel.cpp

src/kernel/bitcoinkernel.h

src/kernel/bitcoinkernel_wrapper.h

src/node/chainstate.cpp

src/node/chainstate.h

src/node/blockstorage.cpp

src/node/blockstorage.h

src/node/mempool_persist.cpp

src/node/mempool_persist.h

src/node/utxo_snapshot.cpp

src/node/utxo_snapshot.h

src/node/kernel_notifications.cpp

src/node/kernel_notifications.h

src/node/blockmanager_args.cpp

src/kernel/blockmanager_opts.h

src/util/expected.cpp

src/policy/settings.h

src/util/types.h

src/kernel/messagestartchars.h

src/kernel/warning.h

src/util/exception.h

src/common/license_info.h

src/node/coins_view_args.h

src/node/database_args.h

src/util/batchpriority.h

src/util/ui_change_type.h

src/node/coins_view_args.cpp

src/node/peerman_args.h

src/util/serfloat.h

src/node/blockmanager_args.h

src/node/database_args.cpp

src/util/overloaded.h

src/interfaces/types.h

src/node/chainstatemanager_args.h

src/node/minisketchwrapper.h

src/util/macros.h

src/util/syserror.h

src/common/run_command.h

src/util/bytevectorhash.cpp

src/node/mempool_persist_args.cpp

src/util/exec.h

src/util/rbf.h

src/crypto/hex_base.h

src/node/mempool_persist_args.h

src/interfaces/echo.h

src/util/any.h

src/util/batchpriority.cpp

src/util/threadnames.h

src/node/coin.h

src/node/mempool_args.h

src/util/asmap.h

src/util/bytevectorhash.h

src/node/context.cpp

src/util/insert.h

src/util/readwritefile.h

src/node/peerman_args.cpp

src/node/interface_ui.cpp

src/interfaces/handler.h

src/node/mining_args.h

src/util/hasher.cpp

src/common/init.h

src/kernel/mempool_limits.h

src/common/system.h

src/crypto/sha3.h

src/util/threadinterrupt.cpp

src/node/protocol_version.h

src/util/exception.cpp

src/common/messages.h

src/node/connection_types.cpp

src/util/bip32.h

src/common/license_info.cpp

src/util/stdmutex.h

src/common/run_command.cpp

src/util/check.cpp

src/util/golombrice.h

src/node/types.h

src/node/timeoffsets.h

src/util/readwritefile.cpp

src/util/fastrange.h

src/util/signalinterrupt.h

src/util/task_runner.h

src/util/syserror.cpp

src/common/interfaces.cpp

src/common/types.h

src/util/threadinterrupt.h

src/kernel/chainstatemanager_opts.h

src/node/psbt.h

src/policy/ephemeral_policy.h

src/util/trace.h

src/common/url.cpp

src/kernel/mempool_options.h

src/util/serfloat.cpp

src/kernel/notifications_interface.h

src/node/timeoffsets.cpp

src/node/warnings.cpp

src/util/hash_type.h

src/crypto/hex_base.cpp

src/node/eviction.h

src/util/tokenbucket.h

src/crypto/aes.h

src/common/pcp.h

src/util/feefrac.cpp

src/node/transaction.h

src/util/threadnames.cpp

src/common/signmessage.h

src/util/exec.cpp

src/util/signalinterrupt.cpp

Independent explanations by MyBitcoinExplorer. Not affiliated with or endorsed by Bitcoin Core. Guides are educational and do not replace the source or its tests.

Bitcoin Core source © its contributors, distributed under the MIT license. Original notices and bundled third-party licenses are retained in the source tree.