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.

56,345 bytes · SHA-256 19df519a0ed378a2… · View upstream ↗

1// Copyright (c) 2021-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 <core_io.h>
6#include <hash.h>
7#include <key.h>
8#include <script/miniscript.h>
9#include <script/script.h>
10#include <script/signingprovider.h>
11#include <test/fuzz/FuzzedDataProvider.h>
12#include <test/fuzz/fuzz.h>
13#include <test/fuzz/util.h>
14#include <test/fuzz/util/descriptor.h>
15#include <util/strencodings.h>
16
17#include <algorithm>
18#include <optional>
19
20namespace {
21
22using Fragment = miniscript::Fragment;
23using Node = miniscript::Node<CPubKey>;
24using Type = miniscript::Type;
25using MsCtx = miniscript::MiniscriptContext;
26using miniscript::operator""_mst;
27
28//! Some pre-computed data for more efficient string roundtrips and to simulate challenges.
29struct TestData {
30    typedef CPubKey Key;
31
32    // Precomputed public keys, and a dummy signature for each of them.
33    std::vector<Key> dummy_keys;
34    std::map<Key, int> dummy_key_idx_map;
35    std::map<CKeyID, Key> dummy_keys_map;
36    std::map<Key, std::pair<std::vector<unsigned char>, bool>> dummy_sigs;
37    std::map<XOnlyPubKey, std::pair<std::vector<unsigned char>, bool>> schnorr_sigs;
38
39    // Precomputed hashes of each kind.
40    std::vector<std::vector<unsigned char>> sha256;
41    std::vector<std::vector<unsigned char>> ripemd160;
42    std::vector<std::vector<unsigned char>> hash256;
43    std::vector<std::vector<unsigned char>> hash160;
44    std::map<std::vector<unsigned char>, std::vector<unsigned char>> sha256_preimages;
45    std::map<std::vector<unsigned char>, std::vector<unsigned char>> ripemd160_preimages;
46    std::map<std::vector<unsigned char>, std::vector<unsigned char>> hash256_preimages;
47    std::map<std::vector<unsigned char>, std::vector<unsigned char>> hash160_preimages;
48
49    //! Set the precomputed data.
50    void Init() {
51        unsigned char keydata[32] = {1};
52        // All our signatures sign (and are required to sign) this constant message.
53        constexpr uint256 MESSAGE_HASH{"0000000000000000f5cd94e18b6fe77dd7aca9e35c2b0c9cbd86356c80a71065"};
54        // We don't pass additional randomness when creating a schnorr signature.
55        const auto EMPTY_AUX{uint256::ZERO};
56
57        for (size_t i = 0; i < 256; i++) {
58            keydata[31] = i;
59            CKey privkey;
60            privkey.Set(keydata, keydata + 32, true);
61            const Key pubkey = privkey.GetPubKey();
62
63            dummy_keys.push_back(pubkey);
64            dummy_key_idx_map.emplace(pubkey, i);
65            dummy_keys_map.insert({pubkey.GetID(), pubkey});
66            XOnlyPubKey xonly_pubkey{pubkey};
67            dummy_key_idx_map.emplace(xonly_pubkey, i);
68            uint160 xonly_hash{Hash160(xonly_pubkey)};
69            dummy_keys_map.emplace(xonly_hash, pubkey);
70
71            std::vector<unsigned char> sig, schnorr_sig(64);
72            privkey.Sign(MESSAGE_HASH, sig);
73            sig.push_back(1); // SIGHASH_ALL
74            dummy_sigs.insert({pubkey, {sig, i & 1}});
75            assert(privkey.SignSchnorr(MESSAGE_HASH, schnorr_sig, nullptr, EMPTY_AUX));
76            schnorr_sig.push_back(1); // Maximally-sized signature has sighash byte
77            schnorr_sigs.emplace(XOnlyPubKey{pubkey}, std::make_pair(std::move(schnorr_sig), i & 1));
78
79            std::vector<unsigned char> hash;
80            hash.resize(32);
81            CSHA256().Write(keydata, 32).Finalize(hash.data());
82            sha256.push_back(hash);
83            if (i & 1) sha256_preimages[hash] = std::vector<unsigned char>(keydata, keydata + 32);
84            CHash256().Write(keydata).Finalize(hash);
85            hash256.push_back(hash);
86            if (i & 1) hash256_preimages[hash] = std::vector<unsigned char>(keydata, keydata + 32);
87            hash.resize(20);
88            CRIPEMD160().Write(keydata, 32).Finalize(hash.data());
89            assert(hash.size() == 20);
90            ripemd160.push_back(hash);
91            if (i & 1) ripemd160_preimages[hash] = std::vector<unsigned char>(keydata, keydata + 32);
92            CHash160().Write(keydata).Finalize(hash);
93            hash160.push_back(hash);
94            if (i & 1) hash160_preimages[hash] = std::vector<unsigned char>(keydata, keydata + 32);
95        }
96    }
97
98    //! Get the (Schnorr or ECDSA, depending on context) signature for this pubkey.
99    const std::pair<std::vector<unsigned char>, bool>* GetSig(const MsCtx script_ctx, const Key& key) const {
100        if (!miniscript::IsTapscript(script_ctx)) {
101            const auto it = dummy_sigs.find(key);
102            if (it == dummy_sigs.end()) return nullptr;
103            return &it->second;
104        } else {
105            const auto it = schnorr_sigs.find(XOnlyPubKey{key});
106            if (it == schnorr_sigs.end()) return nullptr;
107            return &it->second;
108        }
109    }
110} TEST_DATA;
111
112/**
113 * Context to parse a Miniscript node to and from Script or text representation.
114 * Uses an integer (an index in the dummy keys array from the test data) as keys in order
115 * to focus on fuzzing the Miniscript nodes' test representation, not the key representation.
116 */
117struct ParserContext {
118    typedef CPubKey Key;
119
120    const MsCtx script_ctx;
121
122    constexpr ParserContext(MsCtx ctx) noexcept : script_ctx(ctx) {}
123
124    bool KeyCompare(const Key& a, const Key& b) const {
125        return a < b;
126    }
127
128    std::optional<std::string> ToString(const Key& key, bool& has_priv_key) const
129    {
130        has_priv_key = false;
131        auto it = TEST_DATA.dummy_key_idx_map.find(key);
132        if (it == TEST_DATA.dummy_key_idx_map.end()) {
133            return HexStr(key);
134        }
135        has_priv_key = true;
136        uint8_t idx = it->second;
137        return HexStr(std::span{&idx, 1});
138    }
139
140    std::vector<unsigned char> ToPKBytes(const Key& key) const {
141        if (!miniscript::IsTapscript(script_ctx)) {
142            return {key.begin(), key.end()};
143        }
144        const XOnlyPubKey xonly_pubkey{key};
145        return {xonly_pubkey.begin(), xonly_pubkey.end()};
146    }
147
148    std::vector<unsigned char> ToPKHBytes(const Key& key) const {
149        if (!miniscript::IsTapscript(script_ctx)) {
150            const auto h = Hash160(key);
151            return {h.begin(), h.end()};
152        }
153        const auto h = Hash160(XOnlyPubKey{key});
154        return {h.begin(), h.end()};
155    }
156
157    std::optional<Key> FromString(std::span<const char>& in) const {
158        if (in.size() != 2) return {};
159        auto idx = ParseHex(std::string(in.begin(), in.end()));
160        if (idx.size() != 1) return {};
161        return TEST_DATA.dummy_keys[idx[0]];
162    }
163
164    template<typename I>
165    std::optional<Key> FromPKBytes(I first, I last) const {
166        if (!miniscript::IsTapscript(script_ctx)) {
167            Key key{first, last};
168            if (key.IsValid()) return key;
169            return {};
170        }
171        if (last - first != 32) return {};
172        XOnlyPubKey xonly_pubkey;
173        std::copy(first, last, xonly_pubkey.begin());
174        return xonly_pubkey.GetEvenCorrespondingCPubKey();
175    }
176
177    template<typename I>
178    std::optional<Key> FromPKHBytes(I first, I last) const {
179        assert(last - first == 20);
180        CKeyID keyid;
181        std::copy(first, last, keyid.begin());
182        const auto it = TEST_DATA.dummy_keys_map.find(keyid);
183        if (it == TEST_DATA.dummy_keys_map.end()) return {};
184        return it->second;
185    }
186
187    MsCtx MsContext() const {
188        return script_ctx;
189    }
190};
191
192//! Context that implements naive conversion from/to script only, for roundtrip testing.
193struct ScriptParserContext {
194    const MsCtx script_ctx;
195
196    constexpr ScriptParserContext(MsCtx ctx) noexcept : script_ctx(ctx) {}
197
198    //! For Script roundtrip we never need the key from a key hash.
199    struct Key {
200        bool is_hash;
201        std::vector<unsigned char> data;
202    };
203
204    bool KeyCompare(const Key& a, const Key& b) const {
205        return a.data < b.data;
206    }
207
208    const std::vector<unsigned char>& ToPKBytes(const Key& key) const
209    {
210        assert(!key.is_hash);
211        return key.data;
212    }
213
214    std::vector<unsigned char> ToPKHBytes(const Key& key) const
215    {
216        if (key.is_hash) return key.data;
217        const auto h = Hash160(key.data);
218        return {h.begin(), h.end()};
219    }
220
221    template<typename I>
222    std::optional<Key> FromPKBytes(I first, I last) const
223    {
224        Key key;
225        key.data.assign(first, last);
226        key.is_hash = false;
227        return key;
228    }
229
230    template<typename I>
231    std::optional<Key> FromPKHBytes(I first, I last) const
232    {
233        Key key;
234        key.data.assign(first, last);
235        key.is_hash = true;
236        return key;
237    }
238
239    MsCtx MsContext() const {
240        return script_ctx;
241    }
242};
243
244//! Context to produce a satisfaction for a Miniscript node using the pre-computed data.
245struct SatisfierContext : ParserContext {
246
247    constexpr SatisfierContext(MsCtx ctx) noexcept : ParserContext(ctx) {}
248
249    // Timelock challenges satisfaction. Make the value (deterministically) vary to explore different
250    // paths.

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.