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.

10,263 bytes · SHA-256 1271604e8843b618… · View upstream ↗

1// Copyright (c) 2023-present The Bitcoin Core developers
2// Distributed under the MIT software license, see the accompanying
3// file COPYING or http://www.opensource.org/licenses/mit-license.php.
4
5#include <interfaces/init.h>
6#include <ipc/capnp/mining.capnp.h>
7#include <ipc/capnp/protocol.h>
8#include <ipc/process.h>
9#include <ipc/protocol.h>
10#include <ipc/test/ipc_test.capnp.h>
11#include <ipc/test/ipc_test.capnp.proxy.h>
12#include <ipc/test/ipc_test.h>
13#include <mp/proxy-types.h>
14#include <test/util/common.h>
15#include <test/util/setup_common.h>
16#include <tinyformat.h>
17#include <util/log.h>
18#include <validation.h>
19
20#include <future>
21#include <thread>
22#include <kj/common.h>
23#include <kj/memory.h>
24#include <kj/test.h>
25#include <stdexcept>
26
27#include <boost/test/unit_test.hpp>
28
29static_assert(ipc::capnp::messages::MAX_MONEY == MAX_MONEY);
30static_assert(ipc::capnp::messages::MAX_DOUBLE == std::numeric_limits<double>::max());
31static_assert(ipc::capnp::messages::DEFAULT_BLOCK_RESERVED_WEIGHT == DEFAULT_BLOCK_RESERVED_WEIGHT);
32static_assert(ipc::capnp::messages::DEFAULT_COINBASE_OUTPUT_MAX_ADDITIONAL_SIGOPS == DEFAULT_COINBASE_OUTPUT_MAX_ADDITIONAL_SIGOPS);
33
34//! Remote init class.
35class TestInit : public interfaces::Init
36{
37public:
38    std::unique_ptr<interfaces::Echo> makeEcho() override { return interfaces::MakeEcho(); }
39};
40
41//! Generate a temporary path with temp_directory_path and mkstemp
42static std::string TempPath(std::string_view pattern)
43{
44    std::string temp{fs::PathToString(fs::path{fs::temp_directory_path()} / fs::PathFromString(std::string{pattern}))};
45    temp.push_back('\0');
46    int fd{mkstemp(temp.data())};
47    BOOST_CHECK_GE(fd, 0);
48    BOOST_CHECK_EQUAL(close(fd), 0);
49    temp.resize(temp.size() - 1);
50    fs::remove(fs::PathFromString(temp));
51    return temp;
52}
53
54//! Unit test that tests execution of IPC calls without actually creating a
55//! separate process. This test is primarily intended to verify behavior of type
56//! conversion code that converts C++ objects to Cap'n Proto messages and vice
57//! versa.
58//!
59//! The test creates a thread which creates a FooImplementation object (defined
60//! in ipc_test.h) and a two-way pipe accepting IPC requests which call methods
61//! on the object through FooInterface (defined in ipc_test.capnp).
62void IpcPipeTest()
63{
64    // Setup: create FooImplementation object and listen for FooInterface requests
65    std::promise<std::unique_ptr<mp::ProxyClient<gen::FooInterface>>> foo_promise;
66    std::thread thread([&]() {
67        mp::EventLoop loop("IpcPipeTest", [](bool raise, const std::string& log) { LogInfo("LOG%i: %s", raise, log); });
68        auto pipe = loop.m_io_context.provider->newTwoWayPipe();
69
70        auto connection_client = std::make_unique<mp::Connection>(loop, kj::mv(pipe.ends[0]));
71        auto foo_client = std::make_unique<mp::ProxyClient<gen::FooInterface>>(
72            connection_client->m_rpc_system->bootstrap(mp::ServerVatId().vat_id).castAs<gen::FooInterface>(),
73            connection_client.get(), /* destroy_connection= */ true);
74        (void)connection_client.release();
75        foo_promise.set_value(std::move(foo_client));
76
77        auto connection_server = std::make_unique<mp::Connection>(loop, kj::mv(pipe.ends[1]), [&](mp::Connection& connection) {
78            auto foo_server = kj::heap<mp::ProxyServer<gen::FooInterface>>(std::make_shared<FooImplementation>(), connection);
79            return capnp::Capability::Client(kj::mv(foo_server));
80        });
81        connection_server->onDisconnect([&] { connection_server.reset(); });
82        loop.loop();
83    });
84    std::unique_ptr<mp::ProxyClient<gen::FooInterface>> foo{foo_promise.get_future().get()};
85
86    // Test: make sure arguments were sent and return value is received
87    BOOST_CHECK_EQUAL(foo->add(1, 2), 3);
88
89    COutPoint txout1{Txid::FromUint256(uint256{100}), 200};
90    COutPoint txout2{foo->passOutPoint(txout1)};
91    BOOST_CHECK(txout1 == txout2);
92
93    UniValue uni1{UniValue::VOBJ};
94    uni1.pushKV("i", 1);
95    uni1.pushKV("s", "two");
96    UniValue uni2{foo->passUniValue(uni1)};
97    BOOST_CHECK_EQUAL(uni1.write(), uni2.write());
98
99    CMutableTransaction mtx;
100    mtx.version = 2;
101    mtx.nLockTime = 3;
102    mtx.vin.emplace_back(txout1);
103    mtx.vout.emplace_back(COIN, CScript());
104    CTransactionRef tx1{MakeTransactionRef(mtx)};
105    CTransactionRef tx2{foo->passTransaction(tx1)};
106    BOOST_CHECK(Assert(tx1)->Equals(*Assert(tx2)));
107
108    std::vector<CTransactionRef> txs1;
109    txs1.push_back(tx1);
110    txs1.push_back(nullptr);
111    std::vector<CTransactionRef> txs2(foo->passTransactions(txs1));
112    BOOST_CHECK_EQUAL(txs2.size(), 2);
113    BOOST_CHECK(Assert(txs1[0])->Equals(*Assert(txs2[0])));
114    BOOST_CHECK(!txs2[1]);
115
116    std::vector<char> vec1{'H', 'e', 'l', 'l', 'o'};
117    std::vector<char> vec2{foo->passVectorChar(vec1)};
118    BOOST_CHECK_EQUAL(std::string_view(vec1.begin(), vec1.end()), std::string_view(vec2.begin(), vec2.end()));
119
120    auto script1{CScript() << OP_11};
121    auto script2{foo->passScript(script1)};
122    BOOST_CHECK_EQUAL(HexStr(script1), HexStr(script2));
123
124    // Test cleanup: disconnect and join thread
125    foo.reset();
126    thread.join();
127}
128
129//! Test ipc::Protocol connect() and serve() methods connecting over a socketpair.
130void IpcSocketPairTest()
131{
132    std::unique_ptr<interfaces::Init> init{std::make_unique<TestInit>()};
133    std::unique_ptr<ipc::Protocol> protocol{ipc::capnp::MakeCapnpProtocol("IpcSocketPairTest")};
134    mp::Stream client_stream;
135    std::promise<void> promise;
136    std::thread thread([&]() {
137        protocol->serve(*init, [&] {
138            auto pair{mp::SocketPair()};
139            client_stream = protocol->makeStream(pair[0]);
140            promise.set_value();
141            return protocol->makeStream(pair[1]);
142        });
143    });
144    promise.get_future().wait();
145    std::unique_ptr<interfaces::Init> remote_init{protocol->connect(std::move(client_stream))};
146    std::unique_ptr<interfaces::Echo> remote_echo{remote_init->makeEcho()};
147    BOOST_CHECK_EQUAL(remote_echo->echo("echo test"), "echo test");
148    remote_echo.reset();
149    remote_init.reset();
150    thread.join();
151}
152
153//! Test ipc::Process bind() and connect() methods connecting over a unix socket.
154void IpcSocketTest(const fs::path& datadir)
155{
156    std::unique_ptr<interfaces::Init> init{std::make_unique<TestInit>()};
157    std::unique_ptr<ipc::Protocol> protocol{ipc::capnp::MakeCapnpProtocol("IpcSocketTest")};
158    std::unique_ptr<ipc::Process> process{ipc::MakeProcess()};
159
160    std::string invalid_bind{"invalid:"};
161    BOOST_CHECK_THROW(process->bind(datadir, "test_bitcoin", invalid_bind), std::invalid_argument);
162    BOOST_CHECK_THROW(process->connect(datadir, "test_bitcoin", invalid_bind), std::invalid_argument);
163
164    auto bind_and_listen{[&](const std::string& bind_address) {
165        std::string address{bind_address};
166        mp::SocketId serve_fd = process->bind(datadir, "test_bitcoin", address);
167        BOOST_CHECK_NE(serve_fd, mp::SocketError);
168        BOOST_CHECK_EQUAL(address, bind_address);
169        protocol->listen(serve_fd, *init);
170    }};
171
172    auto connect_and_test{[&](const std::string& connect_address) {
173        std::string address{connect_address};
174        mp::SocketId connect_fd{process->connect(datadir, "test_bitcoin", address)};
175        BOOST_CHECK_EQUAL(address, connect_address);
176        std::unique_ptr<interfaces::Init> remote_init{protocol->connect(protocol->makeStream(connect_fd))};
177        std::unique_ptr<interfaces::Echo> remote_echo{remote_init->makeEcho()};
178        BOOST_CHECK_EQUAL(remote_echo->echo("echo test"), "echo test");
179    }};
180
181    // Need to specify explicit socket addresses outside the data directory, because the data
182    // directory path is so long that the default socket address and any other
183    // addresses in the data directory would fail with errors like:
184    //   Address 'unix' path '"/tmp/test_common_Bitcoin Core/ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff/test_bitcoin.sock"' exceeded maximum socket path length
185    std::vector<std::string> addresses{
186        strprintf("unix:%s", TempPath("bitcoin_sock0_XXXXXX")),
187        strprintf("unix:%s", TempPath("bitcoin_sock1_XXXXXX")),
188    };
189
190    // Bind and listen on multiple addresses
191    for (const auto& address : addresses) {
192        bind_and_listen(address);
193    }
194
195    // Connect and test each address multiple times.
196    for (int i : {0, 1, 0, 0, 1}) {
197        connect_and_test(addresses[i]);
198    }
199}
200
201BOOST_FIXTURE_TEST_SUITE(ipc_tests, BasicTestingSetup)
202BOOST_AUTO_TEST_CASE(ipc_tests)
203{
204    IpcPipeTest();
205    IpcSocketPairTest();
206    IpcSocketTest(m_args.GetDataDirNet());
207}
208
209// Test address parsing.
210BOOST_AUTO_TEST_CASE(parse_address_test)
211{
212    std::unique_ptr<ipc::Process> process{ipc::MakeProcess()};
213    fs::path datadir{"/var/empty/notexist"};
214    auto check_notexist{[](const std::system_error& e) { return e.code() == std::errc::no_such_file_or_directory; }};
215    auto check_address{[&](std::string address, std::string expect_address, std::string expect_error) {
216        if (expect_error.empty()) {
217            BOOST_CHECK_EXCEPTION(process->connect(datadir, "test_bitcoin", address), std::system_error, check_notexist);
218        } else {
219            BOOST_CHECK_EXCEPTION(process->connect(datadir, "test_bitcoin", address), std::invalid_argument, HasReason(expect_error));
220        }
221        BOOST_CHECK_EQUAL(address, expect_address);
222    }};
223    std::string prefix{fs::PathToString(datadir / "")};
224    check_address("unix", "unix:" + prefix + "test_bitcoin.sock", "");
225    check_address("unix:", "unix:" + prefix + "test_bitcoin.sock", "");
226    check_address("unix:path.sock", "unix:" + prefix + "path.sock", "");
227    check_address("unix:0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000.sock",
228                  "unix:" + prefix + "0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000.sock",
229                  "Unix address path \"" + prefix + "0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000.sock\" exceeded maximum socket path length");
230    check_address("invalid", "invalid", "Unrecognized address 'invalid'");
231}
232
233BOOST_AUTO_TEST_SUITE_END()
234

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.