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 server440 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.

12,629 bytes · SHA-256 37ea31b19c4a18b6… · View upstream ↗

1// Copyright (c) 2022-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#include <test/util/txmempool.h>
6
7#include <chainparams.h>
8#include <node/context.h>
9#include <node/mempool_args.h>
10#include <policy/rbf.h>
11#include <policy/truc_policy.h>
12#include <txmempool.h>
13#include <test/util/transaction_utils.h>
14#include <util/check.h>
15#include <util/time.h>
16#include <util/translation.h>
17#include <validation.h>
18
19using node::NodeContext;
20
21CTxMemPool::Options MemPoolOptionsForTest(const NodeContext& node)
22{
23    CTxMemPool::Options mempool_opts{
24        // Default to always checking mempool regardless of
25        // chainparams.DefaultConsistencyChecks for tests
26        .check_ratio = 1,
27        .signals = node.validation_signals.get(),
28    };
29    const auto result{ApplyArgsManOptions(*node.args, ::Params(), mempool_opts)};
30    Assert(result);
31    return mempool_opts;
32}
33
34CTxMemPoolEntry TestMemPoolEntryHelper::FromTx(const CMutableTransaction& tx) const
35{
36    return FromTx(MakeTransactionRef(tx));
37}
38
39CTxMemPoolEntry TestMemPoolEntryHelper::FromTx(const CTransactionRef& tx) const
40{
41    return CTxMemPoolEntry{tx, nFee, TicksSinceEpoch<std::chrono::seconds>(time), nHeight, m_sequence, spendsCoinbase, sigOpCost, lp};
42}
43
44std::optional<std::string> CheckPackageMempoolAcceptResult(const Package& txns,
45                                                           const PackageMempoolAcceptResult& result,
46                                                           bool expect_valid,
47                                                           const CTxMemPool* mempool)
48{
49    if (expect_valid) {
50        if (result.m_state.IsInvalid()) {
51            return strprintf("Package validation unexpectedly failed: %s", result.m_state.ToString());
52        }
53    } else {
54        if (result.m_state.IsValid()) {
55            return strprintf("Package validation unexpectedly succeeded. %s", result.m_state.ToString());
56        }
57    }
58    if (result.m_state.GetResult() != PackageValidationResult::PCKG_POLICY && txns.size() != result.m_tx_results.size()) {
59        return strprintf("txns size %u does not match tx results size %u", txns.size(), result.m_tx_results.size());
60    }
61    for (const auto& tx : txns) {
62        const auto& wtxid = tx->GetWitnessHash();
63        if (!result.m_tx_results.contains(wtxid)) {
64            return strprintf("result not found for tx %s", wtxid.ToString());
65        }
66
67        const auto& atmp_result = result.m_tx_results.at(wtxid);
68        const bool valid{atmp_result.m_result_type == MempoolAcceptResult::ResultType::VALID};
69        if (expect_valid && atmp_result.m_state.IsInvalid()) {
70            return strprintf("tx %s unexpectedly failed: %s", wtxid.ToString(), atmp_result.m_state.ToString());
71        }
72
73        // Each subpackage is allowed MAX_REPLACEMENT_CANDIDATES replacements (only checking individually here)
74        if (atmp_result.m_replaced_transactions.size() > MAX_REPLACEMENT_CANDIDATES) {
75            return strprintf("tx %s result replaced too many transactions",
76                                wtxid.ToString());
77        }
78
79        // Replacements can't happen for subpackages larger than 2
80        if (!atmp_result.m_replaced_transactions.empty() &&
81            atmp_result.m_wtxids_fee_calculations.has_value() && atmp_result.m_wtxids_fee_calculations.value().size() > 2) {
82             return strprintf("tx %s was part of a too-large package RBF subpackage",
83                                wtxid.ToString());
84        }
85
86        if (!atmp_result.m_replaced_transactions.empty() && mempool) {
87            LOCK(mempool->cs);
88            // If replacements occurred and it used 2 transactions, this is a package RBF and should result in a cluster of size 2
89            if (atmp_result.m_wtxids_fee_calculations.has_value() && atmp_result.m_wtxids_fee_calculations.value().size() == 2) {
90                const auto cluster = mempool->GatherClusters({tx->GetHash()});
91                if (cluster.size() != 2) return strprintf("tx %s has too many ancestors or descendants for a package rbf", wtxid.ToString());
92            }
93        }
94
95        // m_vsize and m_base_fees should exist iff the result was VALID or MEMPOOL_ENTRY
96        const bool mempool_entry{atmp_result.m_result_type == MempoolAcceptResult::ResultType::MEMPOOL_ENTRY};
97        if (atmp_result.m_base_fees.has_value() != (valid || mempool_entry)) {
98            return strprintf("tx %s result should %shave m_base_fees", wtxid.ToString(), valid || mempool_entry ? "" : "not ");
99        }
100        if (atmp_result.m_vsize.has_value() != (valid || mempool_entry)) {
101            return strprintf("tx %s result should %shave m_vsize", wtxid.ToString(), valid || mempool_entry ? "" : "not ");
102        }
103
104        // m_other_wtxid should exist iff the result was DIFFERENT_WITNESS
105        const bool diff_witness{atmp_result.m_result_type == MempoolAcceptResult::ResultType::DIFFERENT_WITNESS};
106        if (atmp_result.m_other_wtxid.has_value() != diff_witness) {
107            return strprintf("tx %s result should %shave m_other_wtxid", wtxid.ToString(), diff_witness ? "" : "not ");
108        }
109
110        // m_effective_feerate and m_wtxids_fee_calculations should exist iff the result was valid
111        // or if the failure was TX_RECONSIDERABLE
112        const bool valid_or_reconsiderable{atmp_result.m_result_type == MempoolAcceptResult::ResultType::VALID ||
113                    atmp_result.m_state.GetResult() == TxValidationResult::TX_RECONSIDERABLE};
114        if (atmp_result.m_effective_feerate.has_value() != valid_or_reconsiderable) {
115            return strprintf("tx %s result should %shave m_effective_feerate",
116                                    wtxid.ToString(), valid ? "" : "not ");
117        }
118        if (atmp_result.m_wtxids_fee_calculations.has_value() != valid_or_reconsiderable) {
119            return strprintf("tx %s result should %shave m_effective_feerate",
120                                    wtxid.ToString(), valid ? "" : "not ");
121        }
122
123        if (mempool) {
124            // The tx by txid should be in the mempool iff the result was not INVALID.
125            const bool txid_in_mempool{atmp_result.m_result_type != MempoolAcceptResult::ResultType::INVALID};
126            if (mempool->exists(tx->GetHash()) != txid_in_mempool) {
127                return strprintf("tx %s should %sbe in mempool", wtxid.ToString(), txid_in_mempool ? "" : "not ");
128            }
129            // Additionally, if the result was DIFFERENT_WITNESS, we shouldn't be able to find the tx in mempool by wtxid.
130            if (tx->HasWitness() && atmp_result.m_result_type == MempoolAcceptResult::ResultType::DIFFERENT_WITNESS) {
131                if (mempool->exists(wtxid)) {
132                    return strprintf("wtxid %s should not be in mempool", wtxid.ToString());
133                }
134            }
135            for (const auto& tx_ref : atmp_result.m_replaced_transactions) {
136                if (mempool->exists(tx_ref->GetHash())) {
137                    return strprintf("tx %s should not be in mempool as it was replaced", tx_ref->GetWitnessHash().ToString());
138                }
139            }
140        }
141    }
142    return std::nullopt;
143}
144
145void CheckMempoolEphemeralInvariants(const CTxMemPool& tx_pool)
146{
147    LOCK(tx_pool.cs);
148    for (const auto& tx_info : tx_pool.infoAll()) {
149        const auto& entry = *Assert(tx_pool.GetEntry(tx_info.tx->GetHash()));
150
151        std::vector<uint32_t> dust_indexes = GetDust(*tx_info.tx, tx_pool.m_opts.dust_relay_feerate);
152
153        Assert(dust_indexes.size() < 2);
154
155        if (dust_indexes.empty()) continue;
156
157        // Transaction must have no base fee
158        Assert(entry.GetFee() == 0 && entry.GetModifiedFee() == 0);
159
160        // Transaction has single dust; make sure it's swept or will not be mined
161        const auto& children = tx_pool.GetChildren(entry);
162
163        // Multiple children should never happen as non-dust-spending child
164        // can get mined as package
165        Assert(children.size() < 2);
166
167        if (children.empty()) {
168            // No children and no fees; modified fees aside won't get mined so it's fine
169            // Happens naturally if child spend is RBF cycled away.
170            continue;
171        }
172
173        // Only-child should be spending the dust
174        const auto& only_child = children.begin()->get().GetTx();
175        COutPoint dust_outpoint{tx_info.tx->GetHash(), dust_indexes[0]};
176        Assert(std::any_of(only_child.vin.begin(), only_child.vin.end(), [&dust_outpoint](const CTxIn& txin) {
177            return txin.prevout == dust_outpoint;
178            }));
179    }
180}
181
182void CheckMempoolTRUCInvariants(const CTxMemPool& tx_pool)
183{
184    LOCK(tx_pool.cs);
185    for (const auto& tx_info : tx_pool.infoAll()) {
186        const auto& entry = *Assert(tx_pool.GetEntry(tx_info.tx->GetHash()));
187        auto [desc_count, desc_size, desc_fees] = tx_pool.CalculateDescendantData(entry);
188        auto [anc_count, anc_size, anc_fees] = tx_pool.CalculateAncestorData(entry);
189
190        if (tx_info.tx->version == TRUC_VERSION) {
191            // Check that special maximum virtual size is respected
192            Assert(entry.GetTxSize() <= TRUC_MAX_VSIZE);
193
194            // Check that special TRUC ancestor/descendant limits and rules are always respected
195            Assert(desc_count <= TRUC_DESCENDANT_LIMIT);
196            Assert(anc_count <= TRUC_ANCESTOR_LIMIT);
197            Assert(desc_size <= TRUC_MAX_VSIZE + TRUC_CHILD_MAX_VSIZE);
198            Assert(anc_size <= TRUC_MAX_VSIZE + TRUC_CHILD_MAX_VSIZE);
199            // If this transaction has at least 1 ancestor, it's a "child" and has restricted weight.
200            if (anc_count > 1) {
201                Assert(entry.GetTxSize() <= TRUC_CHILD_MAX_VSIZE);
202                // All TRUC transactions must only have TRUC unconfirmed parents.
203                const auto& parents = tx_pool.GetParents(entry);
204                Assert(parents.begin()->get().GetSharedTx()->version == TRUC_VERSION);
205            }
206        } else if (anc_count > 1) {
207            // All non-TRUC transactions must only have non-TRUC unconfirmed parents.
208            for (const auto& parent : tx_pool.GetParents(entry)) {
209                Assert(parent.get().GetSharedTx()->version != TRUC_VERSION);
210            }
211        }
212    }
213}
214
215void TryAddToMempool(CTxMemPool& tx_pool, const CTxMemPoolEntry& entry)
216{
217    LOCK2(cs_main, tx_pool.cs);
218    auto changeset = tx_pool.GetChangeSet();
219    changeset->StageAddition(entry.GetSharedTx(), entry.GetFee(),
220            entry.GetTime().count(), entry.GetHeight(), entry.GetSequence(),
221            entry.GetSpendsCoinbase(), entry.GetSigOpCost(), entry.GetLockPoints());
222    if (changeset->CheckMemPoolPolicyLimits()) changeset->Apply();
223}
224
225void MockMempoolMinFee(const CFeeRate& target_feerate, CTxMemPool& mempool)
226{
227    LOCK2(cs_main, mempool.cs);
228    // Transactions in the mempool will affect the new minimum feerate.
229    assert(mempool.size() == 0);
230    // The target feerate cannot be too low...
231    // ...otherwise the transaction's feerate will need to be negative.
232    assert(target_feerate > mempool.m_opts.incremental_relay_feerate);
233    // ...otherwise this is not meaningful. The feerate policy uses the maximum of both feerates.
234    assert(target_feerate > mempool.m_opts.min_relay_feerate);
235
236    // Manually create an invalid transaction. Manually set the fee in the CTxMemPoolEntry to
237    // achieve the exact target feerate.
238    CMutableTransaction mtx{};
239    mtx.vin.emplace_back(COutPoint{Txid::FromUint256(uint256{123}), 0});
240    mtx.vout.emplace_back(1 * COIN, GetScriptForDestination(WitnessV0ScriptHash(CScript() << OP_TRUE)));
241    // Set a large size so that the fee evaluated at target_feerate (which is usually in sats/kvB) is an integer.
242    // Otherwise, GetMinFee() may end up slightly different from target_feerate.
243    BulkTransaction(mtx, 4000);
244    const auto tx{MakeTransactionRef(mtx)};
245    LockPoints lp;
246    // The new mempool min feerate is equal to the removed package's feerate + incremental feerate.
247    const auto tx_fee = target_feerate.GetFee(GetVirtualTransactionSize(*tx)) -
248        mempool.m_opts.incremental_relay_feerate.GetFee(GetVirtualTransactionSize(*tx));
249    {
250        auto changeset = mempool.GetChangeSet();

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

src/clientversion.cpp

src/common/signmessage.cpp

src/compat/assumptions.h

src/compat/byteswap.h

src/deploymentinfo.cpp

src/deploymentinfo.h

src/deploymentstatus.cpp

src/deploymentstatus.h

src/dummywallet.cpp

src/external_signer.h

src/init/bitcoin-gui.cpp

src/init/bitcoin-node.cpp

src/init/bitcoin-qt.cpp

src/init/bitcoin-wallet.cpp

src/init/bitcoind.cpp

src/init/common.h

src/interfaces/init.h

src/interfaces/ipc.h

src/key_io.h

src/logging/categories.h

src/logging/timer.h

src/mapport.h

src/musig.h

src/net_permissions.h

src/netgroup.h

src/netmessagemaker.h

src/node/chainstatemanager_args.cpp

src/node/connection_types.h

src/node/context.h

src/node/interface_ui.h

src/node/mempool_args.cpp

src/node/mining_args.cpp

src/node/minisketchwrapper.cpp

src/node/txreconciliation.h

src/policy/fees/estimator_args.cpp

src/policy/fees/estimator_args.h

src/policy/fees/estimator_man.cpp

src/policy/fees/estimator_man.h

src/policy/packages.h

src/policy/rbf.h

src/policy/truc_policy.h

src/pow.h

src/primitives/block.cpp

src/randomenv.h

src/rest.h

src/script/keyorigin.h

src/script/parsing.cpp

src/script/parsing.h

src/script/script_error.h

src/script/sigcache.cpp

src/script/sigcache.h

src/script/solver.h

src/script/verify_flags.h

src/semaphore_grant.h

src/signet.h

src/span.h

src/support/allocators/secure.h

src/support/allocators/zeroafterfree.h

src/util/tokenpipe.cpp

src/util/translation.h

src/util/vector.h

src/versionbits.h

src/versionbits_impl.h

src/wallet/external_signer_scriptpubkeyman.h

src/wallet/fees.h

src/wallet/load.h

src/wallet/receive.h

src/wallet/rpc/wallet.h

src/wallet/types.h

src/walletinitinterface.h

src/zmq/zmqabstractnotifier.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.