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.

7,917 bytes · SHA-256 29ce9ee02263d07a… · View upstream ↗

1#!/usr/bin/env python3
2# Copyright (c) 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 IPC (multiprocess) interface."""
6import asyncio
7
8from contextlib import ExitStack
9from test_framework.test_framework import BitcoinTestFramework
10from test_framework.util import assert_equal
11from test_framework.ipc_util import (
12    load_capnp_modules,
13    make_capnp_init_ctx,
14    make_mining_ctx,
15)
16
17# Test may be skipped and not have capnp installed
18try:
19    import capnp  # type: ignore[import] # noqa: F401
20except ModuleNotFoundError:
21    pass
22
23
24class IPCInterfaceTest(BitcoinTestFramework):
25
26    def skip_test_if_missing_module(self):
27        self.skip_if_no_ipc()
28        self.skip_if_no_py_capnp()
29
30    def set_test_params(self):
31        self.num_nodes = 1
32
33    def setup_nodes(self):
34        self.extra_init = [{"ipcbind": True}]
35        super().setup_nodes()
36        # Use this function to also load the capnp modules (we cannot use set_test_params for this,
37        # as it is being called before knowing whether capnp is available).
38        self.capnp_modules = load_capnp_modules(self.config)
39
40    def run_echo_test(self):
41        self.log.info("Running echo test")
42        async def async_routine():
43            ctx, init = await make_capnp_init_ctx(self)
44            self.log.debug("Create Echo proxy object")
45            echo = init.makeEcho(ctx).result
46            self.log.debug("Test a few invocations of echo")
47            for s in ["hallo", "", "haha"]:
48                result_eval = (await echo.echo(ctx, s)).result
49                assert_equal(s, result_eval)
50            self.log.debug("Destroy the Echo object")
51            echo.destroy(ctx)
52        asyncio.run(capnp.run(async_routine()))
53
54    def run_mining_test(self):
55        self.log.info("Running mining test")
56        block_hash_size = 32
57
58        async def async_routine():
59            ctx, mining = await make_mining_ctx(self)
60            self.log.debug("Test simple inspectors")
61            assert (await mining.isTestChain(ctx)).result
62            assert not (await mining.isInitialBlockDownload(ctx)).result
63            blockref = await mining.getTip(ctx)
64            assert blockref.hasResult
65            assert_equal(len(blockref.result.hash), block_hash_size)
66            current_block_height = self.nodes[0].getchaintips()[0]["height"]
67            assert_equal(blockref.result.height, current_block_height)
68
69        asyncio.run(capnp.run(async_routine()))
70
71    def run_deprecated_mining_test(self):
72        self.log.info("Running deprecated mining interface test")
73        async def async_routine():
74            node = self.nodes[0]
75            connection = await capnp.AsyncIoStream.create_unix_connection(node.ipc_socket_path)
76            init = capnp.TwoPartyClient(connection).bootstrap().cast_as(self.capnp_modules['init'].Init)
77            self.log.debug("Calling deprecated makeMiningOld2 should raise an error")
78            try:
79                await init.makeMiningOld2()
80                raise AssertionError("makeMiningOld2 unexpectedly succeeded")
81            except capnp.KjException as e:
82                assert_equal(e.description, "remote exception: std::exception: Old mining interface (@2) not supported. Please update your client!")
83                assert_equal(e.type, "FAILED")
84        asyncio.run(capnp.run(async_routine()))
85
86    def run_unclean_disconnect_test(self):
87        """Test behavior when disconnecting during an IPC call that later
88        returns a non-null interface pointer. This used to cause a crash as
89        reported https://github.com/bitcoin/bitcoin/issues/34250, but now just
90        results in a cancellation log message"""
91        node = self.nodes[0]
92        self.log.info("Running disconnect during BlockTemplate.waitNext")
93        timeout = self.rpc_timeout * 1000.0
94        disconnected_log_check = ExitStack()
95
96        async def async_routine():
97            ctx, mining = await make_mining_ctx(self)
98            self.log.debug("Create a template")
99            opts = self.capnp_modules['mining'].BlockCreateOptions()
100            template = (await mining.createNewBlock(ctx, opts)).result
101
102            self.log.debug("Wait for a new template")
103            waitoptions = self.capnp_modules['mining'].BlockWaitOptions()
104            waitoptions.timeout = timeout
105            waitoptions.feeThreshold = 1
106            with node.assert_debug_log(expected_msgs=["BlockTemplate.waitNext", "IPC server post request"], timeout=2):
107                promise = template.waitNext(ctx, waitoptions)
108                await asyncio.sleep(0.1)
109            disconnected_log_check.enter_context(node.assert_debug_log(expected_msgs=["IPC server: socket disconnected", "canceled while executing"], timeout=2))
110            del promise
111
112        asyncio.run(capnp.run(async_routine()))
113
114        # Wait for socket disconnected log message, then generate a block to
115        # cause the waitNext() call to return a new template. Look for a
116        # canceled IPC log message after waitNext returns.
117        with node.assert_debug_log(expected_msgs=["interrupted (canceled)"], timeout=2):
118            disconnected_log_check.close()
119            self.generate(node, 1)
120
121    def run_thread_busy_test(self):
122        """Test behavior when sending multiple calls to the same server thread
123        which used to cause a crash as reported
124        https://github.com/bitcoin/bitcoin/issues/33923."""
125        node = self.nodes[0]
126        self.log.info("Running thread busy test")
127        timeout = self.rpc_timeout * 1000.0
128
129        async def async_routine():
130            ctx, mining = await make_mining_ctx(self)
131            self.log.debug("Create a template")
132            opts = self.capnp_modules['mining'].BlockCreateOptions()
133            template = (await mining.createNewBlock(ctx, opts)).result
134
135            self.log.debug("Wait for a new template")
136            waitoptions = self.capnp_modules['mining'].BlockWaitOptions()
137            waitoptions.timeout = timeout
138            waitoptions.feeThreshold = 1
139
140            # Make multiple waitNext calls where the first will start to
141            # execute, and the second and third will be posted waiting to
142            # execute. Previously, the third call would fail calling
143            # mp::Waiter::post() because the waiting function slot is occupied,
144            # but now posts are queued.
145            with node.assert_debug_log(expected_msgs=["BlockTemplate.waitNext", "IPC server post request"], timeout=2):
146                promise1 = template.waitNext(ctx, waitoptions)
147                await asyncio.sleep(0.1)
148            with node.assert_debug_log(expected_msgs=["BlockTemplate.waitNext", "IPC server post request"], timeout=2):
149                promise2 = template.waitNext(ctx, waitoptions)
150                await asyncio.sleep(0.1)
151            with node.assert_debug_log(expected_msgs=["BlockTemplate.waitNext", "IPC server post request"], timeout=2):
152                promise3 = template.waitNext(ctx, waitoptions)
153                await asyncio.sleep(0.1)
154
155            # Generate a new block to make the active waitNext calls return, then clean up.
156            with node.assert_debug_log(expected_msgs=["IPC server send response"], timeout=2):
157                self.generate(node, 1, sync_fun=self.no_op)
158            await ((await promise1).result).destroy(ctx)
159            await ((await promise2).result).destroy(ctx)
160            await ((await promise3).result).destroy(ctx)
161            await template.destroy(ctx)
162
163        asyncio.run(capnp.run(async_routine()))
164
165    def run_test(self):
166        self.run_echo_test()
167        self.run_mining_test()
168        self.run_deprecated_mining_test()
169        self.run_unclean_disconnect_test()
170        self.run_thread_busy_test()
171
172if __name__ == '__main__':
173    IPCInterfaceTest(__file__).main()
174

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.