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.

24,345 bytes · SHA-256 8a411fc030f69b24… · View upstream ↗

1#!/usr/bin/env python3
2# Copyright (c) 2024-present The Bitcoin Core developers
3# Distributed under the MIT software license, see the accompanying
4# file COPYING or http://www.opensource.org/licenses/mit-license.php.
5"""Test cluster mempool accessors and limits"""
6
7from decimal import Decimal
8
9from test_framework.mempool_util import (
10    DEFAULT_CLUSTER_LIMIT,
11    DEFAULT_CLUSTER_SIZE_LIMIT_KVB,
12)
13from test_framework.messages import (
14    COIN,
15)
16from test_framework.test_framework import BitcoinTestFramework
17from test_framework.wallet import (
18    MiniWallet,
19)
20from test_framework.util import (
21    assert_equal,
22    assert_greater_than,
23    assert_greater_than_or_equal,
24    assert_raises_rpc_error,
25)
26
27def weight_to_vsize(weight):
28    # Divide by 4, round up
29    return (weight + 3) // 4
30
31def cleanup(func):
32    def wrapper(self, *args, **kwargs):
33        func(self, *args, **kwargs)
34
35        # Mine blocks to clear the mempool and replenish the wallet's confirmed UTXOs.
36        while (len(self.nodes[0].getrawmempool()) > 0):
37            self.generate(self.nodes[0], 1)
38        self.wallet.rescan_utxos(include_mempool=True)
39    return wrapper
40
41class MempoolClusterTest(BitcoinTestFramework):
42    def set_test_params(self):
43        self.num_nodes = 1
44
45    def add_chain_cluster(self, node, cluster_count, target_vsize=None):
46        """Create a cluster of transactions, with the count specified.
47        The topology is a chain: the i'th transaction depends on the (i-1)'th transaction.
48        Optionally provide a target_vsize for each transaction.
49        """
50        parent_tx = self.wallet.send_self_transfer(from_node=node, confirmed_only=True, target_vsize=target_vsize)
51        utxo_to_spend = parent_tx["new_utxo"]
52        all_txids = [parent_tx["txid"]]
53        all_results = [parent_tx]
54
55        while len(all_results) < cluster_count:
56            next_tx = self.wallet.send_self_transfer(from_node=node, utxo_to_spend=utxo_to_spend, target_vsize=target_vsize)
57            assert next_tx["txid"] in node.getrawmempool()
58
59            # Confirm that each transaction is in the same cluster as the first.
60            assert_equal(node.getmempoolcluster(next_tx['txid']), node.getmempoolcluster(parent_tx['txid']))
61
62            # Confirm that the ancestors are what we expect
63            mempool_ancestors = node.getmempoolancestors(next_tx['txid'])
64            assert_equal(sorted(mempool_ancestors), sorted(all_txids))
65
66            # Confirm that each successive transaction is added as a descendant.
67            assert all([ next_tx["txid"] in node.getmempooldescendants(x) for x in all_txids ])
68
69            # Update for next iteration
70            all_results.append(next_tx)
71            all_txids.append(next_tx["txid"])
72            utxo_to_spend = next_tx["new_utxo"]
73
74        assert_equal(node.getmempoolcluster(parent_tx['txid'])['txcount'], cluster_count)
75        return all_results
76
77    def check_feerate_diagram(self, node):
78        """Sanity check the feerate diagram."""
79        feeratediagram = node.getmempoolfeeratediagram()
80        last_val = {"weight": 0, "fee": 0}
81        for x in feeratediagram:
82            # The weight is always positive, except for the first iteration
83            assert (x['weight'] > 0
84                   or x['fee'] == 0)
85            # Monotonically decreasing fee per weight
86            assert_greater_than_or_equal(last_val['fee'] * x['weight'], x['fee'] * last_val['weight'])
87            last_val = x
88
89    def test_limit_enforcement(self, cluster_submitted, target_vsize_per_tx=None):
90        """
91        the cluster may change as a result of these transactions, so cluster_submitted is mutated accordingly
92        """
93        # Cluster has already been submitted and has at least 3 transactions, otherwise this test won't work.
94        assert_greater_than_or_equal(len(cluster_submitted), 3)
95        node = self.nodes[0]
96        last_result = cluster_submitted[-1]
97
98        # Test that adding one more transaction to the cluster will fail.
99        bad_tx = self.wallet.create_self_transfer(utxo_to_spend=last_result["new_utxo"], target_vsize=target_vsize_per_tx)
100        assert_raises_rpc_error(-26, "too-large-cluster", node.sendrawtransaction, bad_tx["hex"])
101
102        # It should also limit cluster sizes during replacement
103        utxo_to_double_spend = self.wallet.get_utxo(confirmed_only=True)
104        fee = Decimal("0.000001")
105        tx_to_replace = self.wallet.create_self_transfer(utxo_to_spend=utxo_to_double_spend, fee=fee)
106        node.sendrawtransaction(tx_to_replace["hex"])
107
108        # Multiply fee by 5, which should easily cover the cost to replace (but
109        # is still too large a cluster). Otherwise, use the target vsize at
110        # 10sat/vB
111        fee_to_use = target_vsize_per_tx * 10 if target_vsize_per_tx is not None else int(fee * COIN * 5)
112        bad_tx_also_replacement = self.wallet.create_self_transfer_multi(
113            utxos_to_spend=[last_result["new_utxo"], utxo_to_double_spend],
114            target_vsize=target_vsize_per_tx,
115            fee_per_output=fee_to_use,
116        )
117        assert_raises_rpc_error(-26, "too-large-cluster", node.sendrawtransaction, bad_tx_also_replacement["hex"])
118
119        # Replace the last transaction. We are extending the cluster by one, but also removing one: 64 + 1 - 1 = 64
120        # In the case of vsize, it should similarly cancel out.
121        second_to_last_utxo = cluster_submitted[-2]["new_utxo"]
122        fee_to_beat = cluster_submitted[-1]["fee"]
123        vsize_to_use = cluster_submitted[-1]["tx"].get_vsize() if target_vsize_per_tx is not None else None
124        good_tx_replacement = self.wallet.create_self_transfer(utxo_to_spend=second_to_last_utxo, fee=fee_to_beat * 5, target_vsize=vsize_to_use)
125        node.sendrawtransaction(good_tx_replacement["hex"], maxfeerate=0)
126
127        cluster_submitted[-1] = good_tx_replacement
128
129    def test_limit_enforcement_package(self, cluster_submitted):
130        node = self.nodes[0]
131        # Create a package from the second to last transaction.
132        # This shouldn't work because the effect is {max_cluster_count} + 2 - 1 = {max_cluster_count} + 1
133        last_utxo = cluster_submitted[-2]["new_utxo"]
134        fee_to_beat = cluster_submitted[-1]["fee"]
135        # We do not use package RBF here because it has additional restrictions on mempool ancestors.
136        parent_tx_bad = self.wallet.create_self_transfer(utxo_to_spend=last_utxo, fee=fee_to_beat * 5)
137        child_tx_bad = self.wallet.create_self_transfer(utxo_to_spend=parent_tx_bad["new_utxo"])
138        # The parent should be submitted, but the child rejected.
139        result_parent_only = node.submitpackage([parent_tx_bad["hex"], child_tx_bad["hex"]])
140
141        assert parent_tx_bad["txid"] in node.getrawmempool()
142        assert child_tx_bad["txid"] not in node.getrawmempool()
143        assert_equal(result_parent_only["package_msg"], "transaction failed")
144        assert_equal(result_parent_only["tx-results"][child_tx_bad["wtxid"]]["error"], "too-large-cluster")
145        assert_equal(result_parent_only["replaced-transactions"], [cluster_submitted[-1]["txid"]])
146
147        # Now, create a package from the third to last transaction.
148        # This should work because the effect is {max_cluster_count} + 2 - 2 = {max_cluster_count}
149        third_to_last_utxo = cluster_submitted[-3]["new_utxo"]
150        # Tweak locktime to not recreate same tx as its meant to replace, fee needs to be even higher
151        parent_tx_good = self.wallet.create_self_transfer(utxo_to_spend=third_to_last_utxo, locktime=1, fee=fee_to_beat * 10)
152        child_tx_good = self.wallet.create_self_transfer(utxo_to_spend=parent_tx_good["new_utxo"])
153        assert parent_tx_good["txid"] != cluster_submitted[-2]["txid"]
154        assert child_tx_good["txid"] != parent_tx_bad["txid"]
155        result_both_good = node.submitpackage([parent_tx_good["hex"], child_tx_good["hex"]], maxfeerate=0)
156        assert_equal(result_both_good["package_msg"], "success")
157        assert parent_tx_good["txid"] in node.getrawmempool()
158        assert child_tx_good["txid"] in node.getrawmempool()
159        assert_equal(set(result_both_good["replaced-transactions"]), set([parent_tx_bad["txid"], cluster_submitted[-2]["txid"]]))
160
161    @cleanup
162    def test_cluster_count_limit(self, max_cluster_count):
163        node = self.nodes[0]
164        cluster_submitted = self.add_chain_cluster(node, max_cluster_count)
165        self.check_feerate_diagram(node)
166        for result in cluster_submitted:
167            assert_equal(node.getmempoolcluster(result["txid"])['txcount'], max_cluster_count)
168
169        self.log.info("Test that cluster count limit is enforced")
170        self.test_limit_enforcement(cluster_submitted)
171        self.log.info("Test that the resulting cluster count is correctly calculated in a package")
172        self.test_limit_enforcement_package(cluster_submitted)
173
174    @cleanup
175    def test_cluster_size_limit(self, max_cluster_size_vbytes):
176        node = self.nodes[0]
177        # This number should be smaller than the cluster count limit.
178        num_txns = 10
179        # Leave some buffer so it is possible to add a reasonably-sized transaction.
180        target_vsize_per_tx = int((max_cluster_size_vbytes - 500) / num_txns)
181        cluster_submitted = self.add_chain_cluster(node, num_txns, target_vsize_per_tx)
182
183        vsize_remaining = max_cluster_size_vbytes - weight_to_vsize(node.getmempoolcluster(cluster_submitted[0]["txid"])['clusterweight'])
184        self.log.info("Test that cluster size limit is enforced")
185        self.test_limit_enforcement(cluster_submitted, target_vsize_per_tx=vsize_remaining + 4)
186
187        # Try another cluster and add a small transaction: it should succeed
188        last_result = cluster_submitted[-1]
189        small_tx = self.wallet.create_self_transfer(utxo_to_spend=last_result["new_utxo"], target_vsize=vsize_remaining)
190        node.sendrawtransaction(small_tx["hex"])
191
192    @cleanup
193    def test_cluster_merging(self, max_cluster_count):
194        node = self.nodes[0]
195
196        self.log.info(f"Test merging 2 clusters with transaction counts totaling {max_cluster_count}")
197        for num_txns_cluster1 in [1, 5, 10]:
198            # Create a chain of transactions
199            cluster1 = self.add_chain_cluster(node, num_txns_cluster1)
200            for result in cluster1:
201                node.sendrawtransaction(result["hex"])
202            utxo_from_cluster1 = cluster1[-1]["new_utxo"]
203
204            # Make the next cluster, which contains the remaining transactions
205            assert_greater_than(max_cluster_count, num_txns_cluster1)
206            num_txns_cluster2 = max_cluster_count - num_txns_cluster1
207            cluster2 = self.add_chain_cluster(node, num_txns_cluster2)
208            for result in cluster2:
209                node.sendrawtransaction(result["hex"])
210            utxo_from_cluster2 = cluster2[-1]["new_utxo"]
211
212            # Now create a transaction that spends from both clusters, which would merge them.
213            tx_merger = self.wallet.create_self_transfer_multi(utxos_to_spend=[utxo_from_cluster1, utxo_from_cluster2])
214            assert_raises_rpc_error(-26, "too-large-cluster", node.sendrawtransaction, tx_merger["hex"])
215
216            # Spending from the clusters independently should work
217            tx_spending_cluster1 = self.wallet.send_self_transfer(from_node=node, utxo_to_spend=utxo_from_cluster1)
218            tx_spending_cluster2 = self.wallet.send_self_transfer(from_node=node, utxo_to_spend=utxo_from_cluster2)
219            assert tx_spending_cluster1["txid"] in node.getrawmempool()
220            assert tx_spending_cluster2["txid"] in node.getrawmempool()
221
222        self.log.info(f"Test merging {max_cluster_count} clusters with 1 transaction spending from all of them")
223        utxos_to_merge = []
224        for _ in range(max_cluster_count):
225            # Use a confirmed utxo to ensure distinct clusters
226            confirmed_utxo = self.wallet.get_utxo(confirmed_only=True)
227            singleton = self.wallet.send_self_transfer(from_node=node, utxo_to_spend=confirmed_utxo)
228            assert singleton["txid"] in node.getrawmempool()
229            utxos_to_merge.append(singleton["new_utxo"])
230
231        assert_equal(len(utxos_to_merge), max_cluster_count)
232        tx_merger = self.wallet.create_self_transfer_multi(utxos_to_spend=utxos_to_merge)
233        assert_raises_rpc_error(-26, "too-large-cluster", node.sendrawtransaction, tx_merger["hex"])
234
235        # Spending from 1 fewer cluster should work
236        tx_merger_all_but_one = self.wallet.create_self_transfer_multi(utxos_to_spend=utxos_to_merge[:-1])
237        node.sendrawtransaction(tx_merger_all_but_one["hex"])
238        assert tx_merger_all_but_one["txid"] in node.getrawmempool()
239
240    @cleanup
241    def test_cluster_merging_size(self, max_cluster_size_vbytes):
242        node = self.nodes[0]
243
244        self.log.info(f"Test merging clusters with sizes totaling {max_cluster_size_vbytes} vB")
245        num_txns = 10
246        # Leave some buffer so it is possible to add a reasonably-sized transaction.
247        utxos_to_merge = []
248        vsize_remaining = max_cluster_size_vbytes
249        for _ in range(num_txns):
250            confirmed_utxo = self.wallet.get_utxo(confirmed_only=True)

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.