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.

4,870 bytes · SHA-256 41bc6b8f59fa38a6… · View upstream ↗

1#!/usr/bin/env python3
2# Copyright (c) 2026-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 the private-broadcast queue size cap: submissions beyond the cap are
6rejected (the queue is not modified), rather than evicting existing entries.
7"""
8
9from test_framework.test_framework import BitcoinTestFramework
10from test_framework.util import assert_equal, assert_raises_rpc_error
11from test_framework.wallet import MiniWallet
12
13
14# Must match PrivateBroadcast::MAX_TRANSACTIONS
15MAX_TRANSACTIONS = 10_000
16OVER_CAP = 5
17
18
19class PrivateBroadcastCapTest(BitcoinTestFramework):
20    def set_test_params(self):
21        self.num_nodes = 1
22        # -privatebroadcast is incompatible with the framework's default
23        # -connect=0; allow autoconnect (no actual peers will succeed though).
24        self.disable_autoconnect = False
25        self.extra_args = [[
26            "-privatebroadcast",
27            # Fake I2P reachability so the privatebroadcast startup precondition passes.
28            "-i2psam=127.0.0.1:1",
29            "-proxy=127.0.0.1:1",
30        ]]
31
32    def setup_network(self):
33        # Skip the framework's default connect_nodes loop. We have a single
34        # node and don't need any peer connections.
35        self.setup_nodes()
36
37    def run_test(self):
38        node = self.nodes[0]
39        wallet = MiniWallet(node)
40        # Mature one coinbase to spend.
41        self.generate(wallet, 101)
42
43        # Build a parent that fans out to MAX_TRANSACTIONS + OVER_CAP outputs.
44        # Inject it directly via generateblock since -privatebroadcast bypasses
45        # the mempool
46        utxo = wallet.get_utxo()
47        parent = wallet.create_self_transfer_multi(
48            utxos_to_spend=[utxo],
49            num_outputs=MAX_TRANSACTIONS + OVER_CAP,
50            fee_per_output=500,
51        )
52        self.generateblock(node, wallet.get_address(), [parent["hex"]])
53
54        children = [wallet.create_self_transfer(utxo_to_spend=u)
55                    for u in parent["new_utxos"]]
56        assert_equal(len(children), MAX_TRANSACTIONS + OVER_CAP)
57
58        # Fill the queue exactly to the cap; every distinct submission succeeds.
59        self.log.info(f"Filling private broadcast queue to cap ({MAX_TRANSACTIONS} txns)")
60        for child in children[:MAX_TRANSACTIONS]:
61            node.sendrawtransaction(child["hex"])
62
63        pbinfo = node.getprivatebroadcastinfo()
64        assert_equal(len(pbinfo["transactions"]), MAX_TRANSACTIONS)
65        present_wtxids = {t["wtxid"] for t in pbinfo["transactions"]}
66        for i, child in enumerate(children[:MAX_TRANSACTIONS]):
67            assert child["wtxid"] in present_wtxids, \
68                f"tx index {i} (wtxid={child['wtxid']}) should be in the queue"
69
70        # Further distinct submissions are rejected with an RPC error, and the
71        # queue is left unchanged (nothing evicted to make room).
72        self.log.info(f"Submitting {OVER_CAP} more; each should be rejected (queue full)")
73        for child in children[MAX_TRANSACTIONS:]:
74            assert_raises_rpc_error(-37, "Private broadcast queue is full",
75                                    node.sendrawtransaction, child["hex"])
76
77        assert_equal(pbinfo["transactions"], node.getprivatebroadcastinfo()["transactions"])
78
79        self.log.info("Checking abortprivatebroadcast frees a slot for a new submission")
80        abort_res = node.abortprivatebroadcast(children[1]["txid"])
81        assert_equal([t["wtxid"] for t in abort_res["removed_transactions"]],
82                     [children[1]["wtxid"]])
83        wtxids = {t["wtxid"] for t in node.getprivatebroadcastinfo()["transactions"]}
84        assert_equal(len(wtxids), MAX_TRANSACTIONS - 1)
85        assert children[1]["wtxid"] not in wtxids, "aborted tx should be gone from the queue"
86
87        new_child = children[MAX_TRANSACTIONS]  # first previously-rejected tx
88        node.sendrawtransaction(new_child["hex"])
89        wtxids = {t["wtxid"] for t in node.getprivatebroadcastinfo()["transactions"]}
90        assert_equal(len(wtxids), MAX_TRANSACTIONS)
91        assert new_child["wtxid"] in wtxids, "freed slot should now hold the new tx"
92        assert children[1]["wtxid"] not in wtxids, "aborted tx should not reappear"
93
94        # Re-submitting an already-queued transaction is a no-op, not an error,
95        # even when the queue is full.
96        self.log.info("Re-submitting an already-queued tx should not error")
97        node.sendrawtransaction(children[0]["hex"])
98        wtxids = {t["wtxid"] for t in node.getprivatebroadcastinfo()["transactions"]}
99        assert_equal(len(wtxids), MAX_TRANSACTIONS)
100        assert children[0]["wtxid"] in wtxids, "re-submitted tx should remain queued"
101
102if __name__ == "__main__":
103    PrivateBroadcastCapTest(__file__).main()
104

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.