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.

13,214 bytes · SHA-256 c43f9331bf9536d4… · View upstream ↗

1#!/usr/bin/env python3
2# Copyright (c) 2014-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 descendant package tracking code."""
6
7from decimal import Decimal
8
9from test_framework.messages import (
10    DEFAULT_CLUSTER_LIMIT,
11)
12from test_framework.p2p import P2PTxInvStore
13from test_framework.test_framework import BitcoinTestFramework
14from test_framework.util import (
15    assert_equal,
16)
17from test_framework.wallet import MiniWallet
18from test_framework.blocktools import create_empty_fork
19
20# custom limits for node1
21CUSTOM_CLUSTER_LIMIT = 10
22assert CUSTOM_CLUSTER_LIMIT < DEFAULT_CLUSTER_LIMIT
23
24class MempoolPackagesTest(BitcoinTestFramework):
25    def set_test_params(self):
26        self.num_nodes = 2
27        # whitelist peers to speed up tx relay / mempool sync
28        self.noban_tx_relay = True
29        self.extra_args = [
30            [
31            ],
32            [
33                "-limitclustercount={}".format(CUSTOM_CLUSTER_LIMIT),
34            ],
35        ]
36
37    def trigger_reorg(self, fork_blocks, node):
38        """Trigger reorg of the fork blocks."""
39        for block in fork_blocks:
40            node.submitblock(block.serialize().hex())
41        assert_equal(node.getbestblockhash(), fork_blocks[-1].hash_hex)
42
43    def run_test(self):
44        self.wallet = MiniWallet(self.nodes[0])
45        self.wallet.rescan_utxos()
46
47        peer_inv_store = self.nodes[0].add_p2p_connection(P2PTxInvStore()) # keep track of invs
48
49        # DEFAULT_CLUSTER_LIMIT transactions off a confirmed tx should be fine for default node
50        chain = self.wallet.create_self_transfer_chain(chain_length=DEFAULT_CLUSTER_LIMIT)
51        witness_chain = [t["wtxid"] for t in chain]
52        ancestor_vsize = 0
53        ancestor_fees = Decimal(0)
54
55        for i, t in enumerate(chain):
56            ancestor_vsize += t["tx"].get_vsize()
57            ancestor_fees += t["fee"]
58            self.wallet.sendrawtransaction(from_node=self.nodes[0], tx_hex=t["hex"])
59
60        # Wait until mempool transactions have passed initial broadcast (sent inv and received getdata)
61        # Otherwise, getrawmempool may be inconsistent with getmempoolentry if unbroadcast changes in between
62        peer_inv_store.wait_for_broadcast(witness_chain)
63
64        # Check mempool has DEFAULT_CLUSTER_LIMIT transactions in it, and descendant and ancestor
65        # count and fees should look correct
66        mempool = self.nodes[0].getrawmempool(True)
67        assert_equal(len(mempool), DEFAULT_CLUSTER_LIMIT)
68        descendant_count = 1
69        descendant_fees = 0
70        descendant_vsize = 0
71
72        assert_equal(ancestor_vsize, sum([mempool[tx]['vsize'] for tx in mempool]))
73        ancestor_count = DEFAULT_CLUSTER_LIMIT
74        assert_equal(ancestor_fees, sum([mempool[tx]['fees']['base'] for tx in mempool]))
75
76        descendants = []
77        ancestors = [t["txid"] for t in chain]
78        chain = [t["txid"] for t in chain]
79        for x in reversed(chain):
80            # Check that getmempoolentry is consistent with getrawmempool
81            entry = self.nodes[0].getmempoolentry(x)
82            assert_equal(entry, mempool[x])
83
84            # Check that gettxspendingprevout is consistent with getrawmempool
85            witnesstx = self.nodes[0].getrawtransaction(txid=x, verbose=True)
86            for tx_in in witnesstx["vin"]:
87                spending_result = self.nodes[0].gettxspendingprevout([ {'txid' : tx_in["txid"], 'vout' : tx_in["vout"]} ])
88                assert_equal(spending_result, [ {'txid' : tx_in["txid"], 'vout' : tx_in["vout"], 'spendingtxid' : x} ])
89
90            # Check that the descendant calculations are correct
91            assert_equal(entry['descendantcount'], descendant_count)
92            descendant_fees += entry['fees']['base']
93            assert_equal(entry['fees']['modified'], entry['fees']['base'])
94            assert_equal(entry['fees']['descendant'], descendant_fees)
95            descendant_vsize += entry['vsize']
96            assert_equal(entry['descendantsize'], descendant_vsize)
97            descendant_count += 1
98
99            # Check that ancestor calculations are correct
100            assert_equal(entry['ancestorcount'], ancestor_count)
101            assert_equal(entry['fees']['ancestor'], ancestor_fees)
102            assert_equal(entry['ancestorsize'], ancestor_vsize)
103            ancestor_vsize -= entry['vsize']
104            ancestor_fees -= entry['fees']['base']
105            ancestor_count -= 1
106
107            # Check that parent/child list is correct
108            assert_equal(entry['spentby'], descendants[-1:])
109            assert_equal(entry['depends'], ancestors[-2:-1])
110
111            # Check that getmempooldescendants is correct
112            assert_equal(sorted(descendants), sorted(self.nodes[0].getmempooldescendants(x)))
113
114            # Check getmempooldescendants verbose output is correct
115            for descendant, dinfo in self.nodes[0].getmempooldescendants(x, True).items():
116                assert_equal(dinfo['depends'], [chain[chain.index(descendant)-1]])
117                if dinfo['descendantcount'] > 1:
118                    assert_equal(dinfo['spentby'], [chain[chain.index(descendant)+1]])
119                else:
120                    assert_equal(dinfo['spentby'], [])
121            descendants.append(x)
122
123            # Check that getmempoolancestors is correct
124            ancestors.remove(x)
125            assert_equal(sorted(ancestors), sorted(self.nodes[0].getmempoolancestors(x)))
126
127            # Check that getmempoolancestors verbose output is correct
128            for ancestor, ainfo in self.nodes[0].getmempoolancestors(x, True).items():
129                assert_equal(ainfo['spentby'], [chain[chain.index(ancestor)+1]])
130                if ainfo['ancestorcount'] > 1:
131                    assert_equal(ainfo['depends'], [chain[chain.index(ancestor)-1]])
132                else:
133                    assert_equal(ainfo['depends'], [])
134
135
136        # Check that getmempoolancestors/getmempooldescendants correctly handle verbose=true
137        v_ancestors = self.nodes[0].getmempoolancestors(chain[-1], True)
138        assert_equal(len(v_ancestors), len(chain)-1)
139        for x in v_ancestors.keys():
140            assert_equal(mempool[x], v_ancestors[x])
141        assert chain[-1] not in v_ancestors.keys()
142
143        v_descendants = self.nodes[0].getmempooldescendants(chain[0], True)
144        assert_equal(len(v_descendants), len(chain)-1)
145        for x in v_descendants.keys():
146            assert_equal(mempool[x], v_descendants[x])
147        assert chain[0] not in v_descendants.keys()
148
149        # Check that ancestor modified fees includes fee deltas from
150        # prioritisetransaction
151        self.nodes[0].prioritisetransaction(txid=chain[0], fee_delta=1000)
152        ancestor_fees = 0
153        for x in chain:
154            entry = self.nodes[0].getmempoolentry(x)
155            ancestor_fees += entry['fees']['base']
156            assert_equal(entry['fees']['ancestor'], ancestor_fees + Decimal('0.00001'))
157
158        # Undo the prioritisetransaction for later tests
159        self.nodes[0].prioritisetransaction(txid=chain[0], fee_delta=-1000)
160
161        # Check that descendant modified fees includes fee deltas from
162        # prioritisetransaction
163        self.nodes[0].prioritisetransaction(txid=chain[-1], fee_delta=1000)
164
165        descendant_fees = 0
166        for x in reversed(chain):
167            entry = self.nodes[0].getmempoolentry(x)
168            descendant_fees += entry['fees']['base']
169            assert_equal(entry['fees']['descendant'], descendant_fees + Decimal('0.00001'))
170
171        # Check that prioritising a tx before it's added to the mempool works
172        # First clear the mempool by mining a block.
173        self.generate(self.nodes[0], 1)
174        assert_equal(len(self.nodes[0].getrawmempool()), 0)
175        # Prioritise a transaction that has been mined, then add it back to the
176        # mempool by using invalidateblock.
177        self.nodes[0].prioritisetransaction(txid=chain[-1], fee_delta=2000)
178        self.nodes[0].invalidateblock(self.nodes[0].getbestblockhash())
179        # Keep node1's tip synced with node0
180        self.nodes[1].invalidateblock(self.nodes[1].getbestblockhash())
181
182        # Now check that the transaction is in the mempool, with the right modified fee
183        descendant_fees = 0
184        for x in reversed(chain):
185            entry = self.nodes[0].getmempoolentry(x)
186            descendant_fees += entry['fees']['base']
187            if (x == chain[-1]):
188                assert_equal(entry['fees']['modified'], entry['fees']['base'] + Decimal("0.00002"))
189            assert_equal(entry['fees']['descendant'], descendant_fees + Decimal("0.00002"))
190
191        # Now test descendant chain limits
192        tx_children = []
193        # First create one parent tx with 10 children
194        tx_with_children = self.wallet.send_self_transfer_multi(from_node=self.nodes[0], num_outputs=10)
195        parent_transaction = tx_with_children["txid"]
196        transaction_package = tx_with_children["new_utxos"]
197
198        # Sign and send up to MAX_DESCENDANT transactions chained off the parent tx
199        chain = [] # save sent txs for the purpose of checking node1's mempool later (see below)
200        for _ in range(DEFAULT_CLUSTER_LIMIT - 1):
201            utxo = transaction_package.pop(0)
202            new_tx = self.wallet.send_self_transfer_multi(from_node=self.nodes[0], num_outputs=10, utxos_to_spend=[utxo])
203            txid = new_tx["txid"]
204            chain.append(txid)
205            if utxo['txid'] is parent_transaction:
206                tx_children.append(txid)
207            transaction_package.extend(new_tx["new_utxos"])
208
209        mempool = self.nodes[0].getrawmempool(True)
210        assert_equal(mempool[parent_transaction]['descendantcount'], DEFAULT_CLUSTER_LIMIT)
211        assert_equal(sorted(mempool[parent_transaction]['spentby']), sorted(tx_children))
212
213        for child in tx_children:
214            assert_equal(mempool[child]['depends'], [parent_transaction])
215
216        # Check that node1's mempool is as expected, containing:
217        # - parent tx for descendant test
218        # - txs chained off parent tx (-> custom descendant limit)
219        self.wait_until(lambda: len(self.nodes[1].getrawmempool()) == 2*CUSTOM_CLUSTER_LIMIT, timeout=10)
220        mempool0 = self.nodes[0].getrawmempool(False)
221        mempool1 = self.nodes[1].getrawmempool(False)
222        assert set(mempool1).issubset(set(mempool0))
223        assert parent_transaction in mempool1
224        for tx in chain:
225            if tx in mempool1:
226                entry0 = self.nodes[0].getmempoolentry(tx)
227                entry1 = self.nodes[1].getmempoolentry(tx)
228                assert not entry0['unbroadcast']
229                assert not entry1['unbroadcast']
230                assert entry1["descendantcount"] <= CUSTOM_CLUSTER_LIMIT
231                assert_equal(entry1['fees']['base'], entry0['fees']['base'])
232                assert_equal(entry1['vsize'], entry0['vsize'])
233                assert_equal(entry1['depends'], entry0['depends'])
234
235        # Test reorg handling
236        # First, the basics:
237        fork_blocks = create_empty_fork(self.nodes[0])
238        mempool0 = self.nodes[0].getrawmempool(False)
239        self.generate(self.nodes[0], 1)
240        self.trigger_reorg(fork_blocks, self.nodes[0])
241
242        # Check that the txs are returned to the mempool, and that transaction ordering is
243        # unchanged, as it is deterministic.
244        assert_equal(self.nodes[0].getrawmempool(), mempool0)
245
246        # Clean-up the mempool
247        self.generate(self.nodes[0], 1)
248
249        # Now test the case where node1 has a transaction T in its mempool that
250        # depends on transactions A and B which are in a mined block, and the

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.