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.

6,407 bytes · SHA-256 782fd64ad1a9f946… · 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#ifndef BITCOIN_IPC_CAPNP_COMMON_TYPES_H
6#define BITCOIN_IPC_CAPNP_COMMON_TYPES_H
7
8#include <clientversion.h>
9#include <interfaces/types.h>
10#include <primitives/transaction.h>
11#include <serialize.h>
12#include <streams.h>
13#include <univalue.h>
14
15#include <cstddef>
16#include <mp/proxy-types.h>
17#include <mp/type-chrono.h>
18#include <mp/type-context.h>
19#include <mp/type-data.h>
20#include <mp/type-decay.h>
21#include <mp/type-interface.h>
22#include <mp/type-message.h>
23#include <mp/type-number.h>
24#include <mp/type-optional.h>
25#include <mp/type-pointer.h>
26#include <mp/type-string.h>
27#include <mp/type-struct.h>
28#include <mp/type-threadmap.h>
29#include <mp/type-vector.h>
30#include <stdexcept>
31#include <type_traits>
32#include <utility>
33
34namespace ipc {
35namespace capnp {
36//! Construct a ParamStream wrapping a data stream with serialization parameters
37//! needed to pass transaction objects between bitcoin processes.
38//! In the future, more params may be added here to serialize other objects that
39//! require serialization parameters. Params should just be chosen to serialize
40//! objects completely and ensure that serializing and deserializing objects
41//! with the specified parameters produces equivalent objects. It's also
42//! harmless to specify serialization parameters here that are not used.
43template <typename S>
44auto Wrap(S& s)
45{
46    return ParamsStream{s, TX_WITH_WITNESS};
47}
48
49//! Detect if type has a deserialize_type constructor, which is
50//! used to deserialize types like CTransaction that can't be unserialized into
51//! existing objects because they are immutable.
52template <typename T>
53concept Deserializable = std::is_constructible_v<T, ::deserialize_type, ::DataStream&>;
54} // namespace capnp
55} // namespace ipc
56
57//! Functions to serialize / deserialize common bitcoin types.
58namespace mp {
59//! Overload multiprocess library's CustomBuildField hook to allow any
60//! serializable object to be stored in a capnproto Data field or passed to a
61//! capnproto interface. Use Priority<1> so this hook has medium priority, and
62//! higher priority hooks could take precedence over this one.
63template <typename LocalType, typename Value, typename Output>
64void CustomBuildField(TypeList<LocalType>, Priority<1>, InvokeContext& invoke_context, Value&& value, Output&& output)
65// Enable if serializeable and if LocalType is not cv or reference qualified. If
66// LocalType is cv or reference qualified, it is important to fall back to
67// lower-priority Priority<0> implementation of this function that strips cv
68// references, to prevent this CustomBuildField overload from taking precedence
69// over more narrow overloads for specific LocalTypes.
70requires Serializable<LocalType, DataStream> && std::is_same_v<LocalType, std::remove_cv_t<std::remove_reference_t<LocalType>>>
71{
72    DataStream stream;
73    auto wrapper{ipc::capnp::Wrap(stream)};
74    value.Serialize(wrapper);
75    auto result = output.init(stream.size());
76    memcpy(result.begin(), stream.data(), stream.size());
77}
78
79//! Overload multiprocess library's CustomReadField hook to allow any object
80//! with an Unserialize method to be read from a capnproto Data field or
81//! returned from capnproto interface. Use Priority<1> so this hook has medium
82//! priority, and higher priority hooks could take precedence over this one.
83template <typename LocalType, typename Input, typename ReadDest>
84decltype(auto) CustomReadField(TypeList<LocalType>, Priority<1>, InvokeContext& invoke_context, Input&& input, ReadDest&& read_dest)
85requires Unserializable<LocalType, DataStream> && (!ipc::capnp::Deserializable<LocalType>)
86{
87    return read_dest.update([&](auto& value) {
88        if (!input.has()) return;
89        auto data = input.get();
90        SpanReader stream({data.begin(), data.end()});
91        auto wrapper{ipc::capnp::Wrap(stream)};
92        value.Unserialize(wrapper);
93    });
94}
95
96//! Overload multiprocess library's CustomReadField hook to allow any object
97//! with a deserialize constructor to be read from a capnproto Data field or
98//! returned from capnproto interface. Use Priority<1> so this hook has medium
99//! priority, and higher priority hooks could take precedence over this one.
100template <typename LocalType, typename Input, typename ReadDest>
101decltype(auto) CustomReadField(TypeList<LocalType>, Priority<1>, InvokeContext& invoke_context, Input&& input, ReadDest&& read_dest)
102requires ipc::capnp::Deserializable<LocalType>
103{
104    assert(input.has());
105    auto data = input.get();
106    SpanReader stream({data.begin(), data.end()});
107    auto wrapper{ipc::capnp::Wrap(stream)};
108    return read_dest.construct(::deserialize, wrapper);
109}
110
111//! Overload CustomBuildField and CustomReadField to serialize UniValue
112//! parameters and return values as JSON strings.
113template <typename Value, typename Output>
114void CustomBuildField(TypeList<UniValue>, Priority<1>, InvokeContext& invoke_context, Value&& value, Output&& output)
115{
116    std::string str = value.write();
117    auto result = output.init(str.size());
118    memcpy(result.begin(), str.data(), str.size());
119}
120
121template <typename Input, typename ReadDest>
122decltype(auto) CustomReadField(TypeList<UniValue>, Priority<1>, InvokeContext& invoke_context, Input&& input,
123                               ReadDest&& read_dest)
124{
125    return read_dest.update([&](auto& value) {
126        auto data = input.get();
127        if (!value.read(std::string_view{data.begin(), data.size()})) {
128            throw std::runtime_error{"invalid JSON received over IPC"};
129        }
130    });
131}
132
133//! Interpret empty Data fields as null CTransactionRef values. This is safe to
134//! do because no CTransaction is ever serialized as empty Data, and it is
135//! convenient because this allows std::vector<CTransactionRef> to be passed as
136//! List(Data) even if the vector contains null values, and even though Cap'n
137//! Proto does not (currently) allow distinguishing between null and empty Data
138//! values in a List. Interpreting empty Data values as null CTransactionRef
139//! values works well for this purpose.
140template <typename Input>
141bool CustomHasField(TypeList<CTransaction>, InvokeContext& invoke_context, const Input& input)
142{
143    return input.get().size() > 0;
144}
145} // namespace mp
146
147#endif // BITCOIN_IPC_CAPNP_COMMON_TYPES_H
148

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.