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.

64,079 bytes · SHA-256 c0871a705871f0a9… · View upstream ↗

1// Copyright (c) 2019-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 <test/util/random.h>
6#include <test/util/setup_common.h>
7#include <boost/test/unit_test.hpp>
8
9#include <addresstype.h>
10#include <core_io.h>
11#include <hash.h>
12#include <pubkey.h>
13#include <uint256.h>
14#include <crypto/ripemd160.h>
15#include <crypto/sha256.h>
16#include <script/interpreter.h>
17#include <script/miniscript.h>
18#include <script/script_error.h>
19#include <script/signingprovider.h>
20
21#include <algorithm>
22#include <cstdint>
23#include <string>
24#include <vector>
25
26using namespace util::hex_literals;
27
28namespace {
29
30/** TestData groups various kinds of precomputed data necessary in this test. */
31struct TestData {
32    //! The only public keys used in this test.
33    std::vector<CPubKey> pubkeys;
34    //! A map from the public keys to their CKeyIDs (faster than hashing every time).
35    std::map<CPubKey, CKeyID> pkhashes;
36    std::map<CKeyID, CPubKey> pkmap;
37    std::map<XOnlyPubKey, CKeyID> xonly_pkhashes;
38    std::map<CPubKey, std::vector<unsigned char>> signatures;
39    std::map<XOnlyPubKey, std::vector<unsigned char>> schnorr_signatures;
40
41    // Various precomputed hashes
42    std::vector<std::vector<unsigned char>> sha256;
43    std::vector<std::vector<unsigned char>> ripemd160;
44    std::vector<std::vector<unsigned char>> hash256;
45    std::vector<std::vector<unsigned char>> hash160;
46    std::map<std::vector<unsigned char>, std::vector<unsigned char>> sha256_preimages;
47    std::map<std::vector<unsigned char>, std::vector<unsigned char>> ripemd160_preimages;
48    std::map<std::vector<unsigned char>, std::vector<unsigned char>> hash256_preimages;
49    std::map<std::vector<unsigned char>, std::vector<unsigned char>> hash160_preimages;
50
51    TestData()
52    {
53        // All our signatures sign (and are required to sign) this constant message.
54        constexpr uint256 MESSAGE_HASH{"0000000000000000f5cd94e18b6fe77dd7aca9e35c2b0c9cbd86356c80a71065"};
55        // We don't pass additional randomness when creating a schnorr signature.
56        const auto EMPTY_AUX{uint256::ZERO};
57
58        // We generate 255 public keys and 255 hashes of each type.
59        for (int i = 1; i <= 255; ++i) {
60            // This 32-byte array functions as both private key data and hash preimage (31 zero bytes plus any nonzero byte).
61            unsigned char keydata[32] = {0};
62            keydata[31] = i;
63
64            // Compute CPubkey and CKeyID
65            CKey key;
66            key.Set(keydata, keydata + 32, true);
67            CPubKey pubkey = key.GetPubKey();
68            CKeyID keyid = pubkey.GetID();
69            pubkeys.push_back(pubkey);
70            pkhashes.emplace(pubkey, keyid);
71            pkmap.emplace(keyid, pubkey);
72            XOnlyPubKey xonly_pubkey{pubkey};
73            uint160 xonly_hash{Hash160(xonly_pubkey)};
74            xonly_pkhashes.emplace(xonly_pubkey, xonly_hash);
75            pkmap.emplace(xonly_hash, pubkey);
76
77            // Compute ECDSA signatures on MESSAGE_HASH with the private keys.
78            std::vector<unsigned char> sig, schnorr_sig(64);
79            BOOST_CHECK(key.Sign(MESSAGE_HASH, sig));
80            sig.push_back(1); // sighash byte
81            signatures.emplace(pubkey, sig);
82            BOOST_CHECK(key.SignSchnorr(MESSAGE_HASH, schnorr_sig, nullptr, EMPTY_AUX));
83            schnorr_sig.push_back(1); // Maximally sized Schnorr sigs have a sighash byte.
84            schnorr_signatures.emplace(XOnlyPubKey{pubkey}, schnorr_sig);
85
86            // Compute various hashes
87            std::vector<unsigned char> hash;
88            hash.resize(32);
89            CSHA256().Write(keydata, 32).Finalize(hash.data());
90            sha256.push_back(hash);
91            sha256_preimages[hash] = std::vector<unsigned char>(keydata, keydata + 32);
92            CHash256().Write(keydata).Finalize(hash);
93            hash256.push_back(hash);
94            hash256_preimages[hash] = std::vector<unsigned char>(keydata, keydata + 32);
95            hash.resize(20);
96            CRIPEMD160().Write(keydata, 32).Finalize(hash.data());
97            ripemd160.push_back(hash);
98            ripemd160_preimages[hash] = std::vector<unsigned char>(keydata, keydata + 32);
99            CHash160().Write(keydata).Finalize(hash);
100            hash160.push_back(hash);
101            hash160_preimages[hash] = std::vector<unsigned char>(keydata, keydata + 32);
102        }
103    }
104};
105
106//! Global TestData object
107std::unique_ptr<const TestData> g_testdata;
108
109//! A classification of leaf conditions in miniscripts (excluding true/false).
110enum class ChallengeType {
111    SHA256,
112    RIPEMD160,
113    HASH256,
114    HASH160,
115    OLDER,
116    AFTER,
117    PK
118};
119
120/* With each leaf condition we associate a challenge number.
121 * For hashes it's just the first 4 bytes of the hash. For pubkeys, it's the last 4 bytes.
122 */
123uint32_t ChallengeNumber(const CPubKey& pubkey) { return ReadLE32(pubkey.data() + 29); }
124uint32_t ChallengeNumber(const std::vector<unsigned char>& hash) { return ReadLE32(hash.data()); }
125
126//! A Challenge is a combination of type of leaf condition and its challenge number.
127typedef std::pair<ChallengeType, uint32_t> Challenge;
128
129/** A class encapulating conversion routing for CPubKey. */
130struct KeyConverter {
131    typedef CPubKey Key;
132
133    const miniscript::MiniscriptContext m_script_ctx;
134
135    constexpr KeyConverter(miniscript::MiniscriptContext ctx) noexcept : m_script_ctx{ctx} {}
136
137    bool KeyCompare(const Key& a, const Key& b) const {
138        return a < b;
139    }
140
141    //! Convert a public key to bytes.
142    std::vector<unsigned char> ToPKBytes(const CPubKey& key) const {
143        if (!miniscript::IsTapscript(m_script_ctx)) {
144            return {key.begin(), key.end()};
145        }
146        const XOnlyPubKey xonly_pubkey{key};
147        return {xonly_pubkey.begin(), xonly_pubkey.end()};
148    }
149
150    //! Convert a public key to its Hash160 bytes (precomputed).
151    std::vector<unsigned char> ToPKHBytes(const CPubKey& key) const {
152        if (!miniscript::IsTapscript(m_script_ctx)) {
153            auto hash = g_testdata->pkhashes.at(key);
154            return {hash.begin(), hash.end()};
155        }
156        const XOnlyPubKey xonly_key{key};
157        auto hash = g_testdata->xonly_pkhashes.at(xonly_key);
158        return {hash.begin(), hash.end()};
159    }
160
161    //! Parse a public key from a range of hex characters.
162    std::optional<Key> FromString(std::span<const char>& in) const {
163        auto bytes = ParseHex(std::string(in.begin(), in.end()));
164        Key key{bytes.begin(), bytes.end()};
165        if (key.IsValid()) return key;
166        return {};
167    }
168
169    template<typename I>
170    std::optional<Key> FromPKBytes(I first, I last) const {
171        if (!miniscript::IsTapscript(m_script_ctx)) {
172            Key key{first, last};
173            if (key.IsValid()) return key;
174            return {};
175        }
176        if (last - first != 32) return {};
177        XOnlyPubKey xonly_pubkey;
178        std::copy(first, last, xonly_pubkey.begin());
179        return xonly_pubkey.GetEvenCorrespondingCPubKey();
180    }
181
182    template<typename I>
183    std::optional<Key> FromPKHBytes(I first, I last) const {
184        assert(last - first == 20);
185        CKeyID keyid;
186        std::copy(first, last, keyid.begin());
187        return g_testdata->pkmap.at(keyid);
188    }
189
190    std::optional<std::string> ToString(const Key& key, bool&) const {
191        return HexStr(ToPKBytes(key));
192    }
193
194    miniscript::MiniscriptContext MsContext() const {
195        return m_script_ctx;
196    }
197};
198
199/** A class that encapsulates all signing/hash revealing operations. */
200struct Satisfier : public KeyConverter {
201
202    Satisfier(miniscript::MiniscriptContext ctx) noexcept : KeyConverter{ctx} {}
203
204    //! Which keys/timelocks/hash preimages are available.
205    std::set<Challenge> supported;
206
207    //! Implement simplified CLTV logic: stack value must exactly match an entry in `supported`.
208    bool CheckAfter(uint32_t value) const {
209        return supported.contains(Challenge(ChallengeType::AFTER, value));
210    }
211
212    //! Implement simplified CSV logic: stack value must exactly match an entry in `supported`.
213    bool CheckOlder(uint32_t value) const {
214        return supported.contains(Challenge(ChallengeType::OLDER, value));
215    }
216
217    //! Produce a signature for the given key.
218    miniscript::Availability Sign(const CPubKey& key, std::vector<unsigned char>& sig) const {
219        if (supported.contains(Challenge(ChallengeType::PK, ChallengeNumber(key)))) {
220            if (!miniscript::IsTapscript(m_script_ctx)) {
221                auto it = g_testdata->signatures.find(key);
222                if (it == g_testdata->signatures.end()) return miniscript::Availability::NO;
223                sig = it->second;
224            } else {
225                auto it = g_testdata->schnorr_signatures.find(XOnlyPubKey{key});
226                if (it == g_testdata->schnorr_signatures.end()) return miniscript::Availability::NO;
227                sig = it->second;
228            }
229            return miniscript::Availability::YES;
230        }
231        return miniscript::Availability::NO;
232    }
233
234    //! Helper function for the various hash based satisfactions.
235    miniscript::Availability SatHash(const std::vector<unsigned char>& hash, std::vector<unsigned char>& preimage, ChallengeType chtype) const {
236        if (!supported.contains(Challenge(chtype, ChallengeNumber(hash)))) return miniscript::Availability::NO;
237        const auto& m =
238            chtype == ChallengeType::SHA256 ? g_testdata->sha256_preimages :
239            chtype == ChallengeType::HASH256 ? g_testdata->hash256_preimages :
240            chtype == ChallengeType::RIPEMD160 ? g_testdata->ripemd160_preimages :
241            g_testdata->hash160_preimages;
242        auto it = m.find(hash);
243        if (it == m.end()) return miniscript::Availability::NO;
244        preimage = it->second;
245        return miniscript::Availability::YES;
246    }
247
248    // Functions that produce the preimage for hashes of various types.
249    miniscript::Availability SatSHA256(const std::vector<unsigned char>& hash, std::vector<unsigned char>& preimage) const { return SatHash(hash, preimage, ChallengeType::SHA256); }
250    miniscript::Availability SatRIPEMD160(const std::vector<unsigned char>& hash, std::vector<unsigned char>& preimage) const { return SatHash(hash, preimage, ChallengeType::RIPEMD160); }

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.