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.

26,423 bytes · SHA-256 4440acc2ed18471f… · View upstream ↗

1#!/usr/bin/env python3
2# Copyright (c) 2015-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 ZMQ notification interface."""
6import os
7import struct
8import tempfile
9from io import BytesIO
10
11from test_framework.address import (
12    ADDRESS_BCRT1_P2WSH_OP_TRUE,
13    ADDRESS_BCRT1_UNSPENDABLE,
14)
15from test_framework.blocktools import (
16    add_witness_commitment,
17    create_block,
18)
19from test_framework.test_framework import BitcoinTestFramework
20from test_framework.messages import (
21    CBlock,
22    hash256,
23    tx_from_hex,
24)
25from test_framework.util import (
26    assert_equal,
27    assert_raises_rpc_error,
28    ensure_for,
29    p2p_port,
30)
31from test_framework.wallet import (
32    MiniWallet,
33)
34from test_framework.netutil import test_ipv6_local, test_unix_socket
35
36
37# Test may be skipped and not have zmq installed
38try:
39    import zmq
40except ImportError:
41    pass
42
43def hash256_reversed(byte_str):
44    return hash256(byte_str)[::-1]
45
46class ZMQSubscriber:
47    def __init__(self, socket, topic):
48        self.sequence = None  # no sequence number received yet
49        self.socket = socket
50        self.topic = topic
51
52        self.socket.setsockopt(zmq.SUBSCRIBE, self.topic)
53
54    # Receive message from publisher and verify that topic and sequence match
55    def _receive_from_publisher_and_check(self):
56        topic, body, seq = self.socket.recv_multipart()
57        # Topic should match the subscriber topic.
58        assert_equal(topic, self.topic)
59        # Sequence should be incremental.
60        received_seq = struct.unpack('<I', seq)[-1]
61        if self.sequence is None:
62            self.sequence = received_seq
63        else:
64            assert_equal(received_seq, self.sequence)
65        self.sequence += 1
66        return body
67
68    def receive(self):
69        return self._receive_from_publisher_and_check()
70
71    def receive_sequence(self):
72        body = self._receive_from_publisher_and_check()
73        hash = body[:32].hex()
74        label = chr(body[32])
75        mempool_sequence = None if len(body) != 32+1+8 else struct.unpack("<Q", body[32+1:])[0]
76        if mempool_sequence is not None:
77            assert label in ("A", "R")
78        else:
79            assert label in ("D", "C")
80        return (hash, label, mempool_sequence)
81
82
83class ZMQTestSetupBlock:
84    """Helper class for setting up a ZMQ test via the "sync up" procedure.
85    Generates a block on the specified node on instantiation and provides a
86    method to check whether a ZMQ notification matches, i.e. the event was
87    caused by this generated block.  Assumes that a notification either contains
88    the generated block's hash, it's (coinbase) transaction id, the raw block or
89    raw transaction data.
90    """
91    def __init__(self, test_framework, node):
92        self.block_hash = test_framework.generate(node, 1, sync_fun=test_framework.no_op)[0]
93        coinbase = node.getblock(self.block_hash, 2)['tx'][0]
94        self.tx_hash = coinbase['txid']
95        self.raw_tx = coinbase['hex']
96        self.raw_block = node.getblock(self.block_hash, 0)
97
98    def caused_notification(self, notification):
99        return (
100            self.block_hash in notification
101            or self.tx_hash in notification
102            or self.raw_block in notification
103            or self.raw_tx in notification
104        )
105
106
107class ZMQTest (BitcoinTestFramework):
108    def set_test_params(self):
109        self.num_nodes = 2
110        # whitelist peers to speed up tx relay / mempool sync
111        self.noban_tx_relay = True
112        self.zmq_port_base = p2p_port(self.num_nodes + 1)
113
114    def skip_test_if_missing_module(self):
115        self.skip_if_no_py3_zmq()
116        self.skip_if_no_bitcoind_zmq()
117
118    def run_test(self):
119        self.wallet = MiniWallet(self.nodes[0])
120        self.ctx = zmq.Context()
121        try:
122            self.test_basic()
123            if test_unix_socket():
124                self.test_basic(unix=True)
125            else:
126                self.log.info("Skipping ipc test, because UNIX sockets are not supported.")
127            self.test_sequence()
128            self.test_mempool_sync()
129            self.test_reorg()
130            self.test_multiple_interfaces()
131            self.test_ipv6()
132        finally:
133            # Destroy the ZMQ context.
134            self.log.debug("Destroying ZMQ context")
135            self.ctx.destroy(linger=None)
136
137    # Restart node with the specified zmq notifications enabled, subscribe to
138    # all of them and return the corresponding ZMQSubscriber objects.
139    def setup_zmq_test(self, services, *, recv_timeout=60, sync_blocks=True, ipv6=False):
140        subscribers = []
141        for topic, address in services:
142            socket = self.ctx.socket(zmq.SUB)
143            if ipv6:
144                socket.setsockopt(zmq.IPV6, 1)
145            subscribers.append(ZMQSubscriber(socket, topic.encode()))
146
147        self.restart_node(0, [f"-zmqpub{topic}={address.replace('ipc://', 'unix:')}" for topic, address in services])
148
149        for i, sub in enumerate(subscribers):
150            sub.socket.connect(services[i][1])
151
152        # Ensure that all zmq publisher notification interfaces are ready by
153        # running the following "sync up" procedure:
154        #   1. Generate a block on the node
155        #   2. Try to receive the corresponding notification on all subscribers
156        #   3. If all subscribers get the message within the timeout (1 second),
157        #      we are done, otherwise repeat starting from step 1
158        for sub in subscribers:
159            sub.socket.set(zmq.RCVTIMEO, 1000)
160        while True:
161            test_block = ZMQTestSetupBlock(self, self.nodes[0])
162            recv_failed = False
163            for sub in subscribers:
164                try:
165                    while not test_block.caused_notification(sub.receive().hex()):
166                        self.log.debug("Ignoring sync-up notification for previously generated block.")
167                except zmq.error.Again:
168                    self.log.debug("Didn't receive sync-up notification, trying again.")
169                    recv_failed = True
170            if not recv_failed:
171                self.log.debug("ZMQ sync-up completed, all subscribers are ready.")
172                break
173
174        # set subscriber's desired timeout for the test
175        for sub in subscribers:
176            sub.socket.set(zmq.RCVTIMEO, int(recv_timeout * self.options.timeout_factor * 1000))
177
178        self.connect_nodes(0, 1)
179        if sync_blocks:
180            self.sync_blocks()
181
182        return subscribers
183
184    def test_basic(self, unix = False):
185        self.log.info(f"Running basic test with {'ipc' if unix else 'tcp'} protocol")
186
187        # Invalid zmq arguments don't take down the node, see #17185.
188        self.restart_node(0, ["-zmqpubrawtx=foo", "-zmqpubhashtx=bar"])
189
190        address = f"tcp://127.0.0.1:{self.zmq_port_base}"
191
192        if unix:
193            # Use the shortest temp path possible since paths may have as little as 92-char limit
194            socket_path = tempfile.NamedTemporaryFile().name
195            address = f"ipc://{socket_path}"
196
197        subs = self.setup_zmq_test([(topic, address) for topic in ["hashblock", "hashtx", "rawblock", "rawtx"]])
198
199        hashblock = subs[0]
200        hashtx = subs[1]
201        rawblock = subs[2]
202        rawtx = subs[3]
203
204        num_blocks = 5
205        self.log.info(f"Generate {num_blocks} blocks (and {num_blocks} coinbase txes)")
206        genhashes = self.generatetoaddress(self.nodes[0], num_blocks, ADDRESS_BCRT1_UNSPENDABLE)
207
208        for x in range(num_blocks):
209            # Should receive the coinbase txid.
210            txid = hashtx.receive()
211
212            # Should receive the coinbase raw transaction.
213            tx = tx_from_hex(rawtx.receive().hex())
214            assert_equal(tx.txid_hex, txid.hex())
215
216            # Should receive the generated raw block.
217            hex = rawblock.receive()
218            block = CBlock()
219            block.deserialize(BytesIO(hex))
220            assert block.is_valid()
221            assert_equal(block.vtx[0].txid_hex, tx.txid_hex)
222            assert_equal(len(block.vtx), 1)
223            assert_equal(genhashes[x], hash256_reversed(hex[:80]).hex())
224
225            # Should receive the generated block hash.
226            hash = hashblock.receive().hex()
227            assert_equal(genhashes[x], hash)
228            # The block should only have the coinbase txid.
229            assert_equal([txid.hex()], self.nodes[1].getblock(hash)["tx"])
230
231
232        self.log.info("Wait for tx from second node")
233        payment_tx = self.wallet.send_self_transfer(from_node=self.nodes[1])
234        payment_txid = payment_tx['txid']
235        self.sync_all()
236        # Should receive the broadcasted txid.
237        txid = hashtx.receive()
238        assert_equal(payment_txid, txid.hex())
239
240        # Should receive the broadcasted raw transaction.
241        hex = rawtx.receive()
242        assert_equal(payment_tx['wtxid'], hash256_reversed(hex).hex())
243
244        # Mining the block with this tx should result in second notification
245        # after coinbase tx notification
246        self.generatetoaddress(self.nodes[0], 1, ADDRESS_BCRT1_UNSPENDABLE)
247        hashtx.receive()
248        txid = hashtx.receive()
249        assert_equal(payment_txid, txid.hex())
250

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.