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.

222,090 bytes · SHA-256 e3647b0208657c03… · View upstream ↗

1// Copyright (c) 2018-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 <pubkey.h>
6#include <script/descriptor.h>
7#include <script/sign.h>
8#include <test/util/setup_common.h>
9#include <util/check.h>
10#include <util/strencodings.h>
11#include <util/string.h>
12
13#include <boost/test/unit_test.hpp>
14
15#include <optional>
16#include <regex>
17#include <string>
18#include <vector>
19
20using namespace util::hex_literals;
21using util::Split;
22
23namespace {
24
25void CheckUnparsable(const std::string& prv, const std::string& pub, const std::string& expected_error)
26{
27    FlatSigningProvider keys_priv, keys_pub;
28    std::string error;
29    auto parse_priv = Parse(prv, keys_priv, error);
30    auto parse_pub = Parse(pub, keys_pub, error);
31    BOOST_CHECK_MESSAGE(parse_priv.empty(), prv);
32    BOOST_CHECK_MESSAGE(parse_pub.empty(), pub);
33    BOOST_CHECK_EQUAL(error, expected_error);
34}
35
36/** Check that the script is inferred as non-standard */
37void CheckInferRaw(const CScript& script)
38{
39    FlatSigningProvider dummy_provider;
40    std::unique_ptr<Descriptor> desc = InferDescriptor(script, dummy_provider);
41    BOOST_CHECK(desc->ToString().rfind("raw(", 0) == 0);
42}
43
44constexpr int DEFAULT = 0;
45constexpr int RANGE = 1 << 0; // Expected to be ranged descriptor
46constexpr int HARDENED = 1 << 1; // Derivation needs access to private keys
47constexpr int UNSOLVABLE = 1 << 2; // This descriptor is not expected to be solvable
48constexpr int SIGNABLE = 1 << 3; // We can sign with this descriptor (this is not true when actual BIP32 derivation is used, as that's not integrated in our signing code)
49constexpr int DERIVE_HARDENED = 1 << 4; // The final derivation is hardened, i.e. ends with *' or *h
50constexpr int MIXED_PUBKEYS = 1 << 5;
51constexpr int XONLY_KEYS = 1 << 6; // X-only pubkeys are in use (and thus inferring/caching may swap parity of pubkeys/keyids)
52constexpr int MISSING_PRIVKEYS = 1 << 7; // Not all private keys are available. ToPrivateString() will return true if there is at least one private key and HavePrivateKeys() will return `false`.
53constexpr int SIGNABLE_FAILS = 1 << 8; // We can sign with this descriptor, but actually trying to sign will fail
54constexpr int MUSIG = 1 << 9; // This is a MuSig so key counts will have an extra key
55constexpr int MUSIG_DERIVATION = 1 << 10; // MuSig with BIP 328 derivation from the aggregate key
56constexpr int MIXED_MUSIG = 1 << 11; // Both MuSig and normal key expressions are present
57constexpr int UNIQUE_XPUBS = 1 << 12; // Whether the xpub count should be of unique xpubs
58
59/** Compare two descriptors. If only one of them has a checksum, the checksum is ignored. */
60bool EqualDescriptor(std::string a, std::string b)
61{
62    bool a_check = (a.size() > 9 && a[a.size() - 9] == '#');
63    bool b_check = (b.size() > 9 && b[b.size() - 9] == '#');
64    if (a_check != b_check) {
65        if (a_check) a = a.substr(0, a.size() - 9);
66        if (b_check) b = b.substr(0, b.size() - 9);
67    }
68    return a == b;
69}
70
71bool EqualSigningProviders(const FlatSigningProvider& a, const FlatSigningProvider& b)
72{
73    return a.scripts == b.scripts
74        && a.pubkeys == b.pubkeys
75        && a.origins == b.origins
76        && a.keys == b.keys
77        && a.tr_trees == b.tr_trees;
78}
79
80std::string UseHInsteadOfApostrophe(const std::string& desc)
81{
82    std::string ret = desc;
83    while (true) {
84        auto it = ret.find('\'');
85        if (it == std::string::npos) break;
86        ret[it] = 'h';
87    }
88
89    // GetDescriptorChecksum returns "" if the checksum exists but is bad.
90    // Switching apostrophes with 'h' breaks the checksum if it exists - recalculate it and replace the broken one.
91    if (GetDescriptorChecksum(ret) == "") {
92        ret = ret.substr(0, desc.size() - 9);
93        ret += std::string("#") + GetDescriptorChecksum(ret);
94    }
95    return ret;
96}
97
98// Count the number of times the string "xpub" appears in a descriptor string
99static size_t CountXpubs(const std::string& desc)
100{
101    size_t count = 0;
102    size_t p = desc.find("xpub", 0);
103    while (p != std::string::npos) {
104        count++;
105        p = desc.find("xpub", p + 1);
106    }
107    return count;
108}
109//
110// Count the number of unique xpubs in a descriptor string
111static size_t CountUniqueXpubs(const std::string& desc)
112{
113    std::regex xpub_regex("xpub\\w+?(?=/)");
114    auto search_begin = std::sregex_iterator(desc.begin(), desc.end(), xpub_regex);
115    auto search_end = std::sregex_iterator();
116    std::set<std::string> xpubs;
117    for (std::regex_iterator i = search_begin; i != search_end; ++i) {
118        xpubs.emplace(i->str());
119    }
120    return xpubs.size();
121}
122
123const std::set<std::vector<uint32_t>> ONLY_EMPTY{{}};
124
125std::set<CPubKey> GetKeyData(const FlatSigningProvider& provider, int flags) {
126    std::set<CPubKey> ret;
127    for (const auto& [_, pubkey] : provider.pubkeys) {
128        if (flags & XONLY_KEYS) {
129            unsigned char bytes[33];
130            BOOST_CHECK_EQUAL(pubkey.size(), 33);
131            std::copy(pubkey.begin(), pubkey.end(), bytes);
132            bytes[0] = 0x02;
133            CPubKey norm_pubkey{bytes};
134            ret.insert(norm_pubkey);
135        } else {
136            ret.insert(pubkey);
137        }
138    }
139    return ret;
140}
141
142std::set<std::pair<CPubKey, KeyOriginInfo>> GetKeyOriginData(const FlatSigningProvider& provider, int flags) {
143    std::set<CKeyID> ignored;
144    if (flags & MUSIG) {
145        for (const auto& [_, part_pks] : provider.aggregate_pubkeys) {
146            for (const auto& pk : part_pks) {
147                ignored.insert(pk.GetID());
148            }
149        }
150    }
151
152    std::set<std::pair<CPubKey, KeyOriginInfo>> ret;
153    for (const auto& [keyid, data] : provider.origins) {
154        if (ignored.contains(keyid)) continue;
155        if (flags & XONLY_KEYS) {
156            unsigned char bytes[33];
157            BOOST_CHECK_EQUAL(data.first.size(), 33);
158            std::copy(data.first.begin(), data.first.end(), bytes);
159            bytes[0] = 0x02;
160            CPubKey norm_pubkey{bytes};
161            KeyOriginInfo norm_origin = data.second;
162            norm_origin.fingerprint.fill(0); // fingerprints don't necessarily match.
163            ret.emplace(norm_pubkey, norm_origin);
164        } else {
165            ret.insert(data);
166        }
167    }
168    return ret;
169}
170
171void DoCheck(std::string prv, std::string pub, const std::string& norm_pub, int flags,
172             const std::vector<std::vector<std::string>>& scripts, const std::optional<OutputType>& type, std::optional<uint256> op_compat_desc_hash = std::nullopt,
173             const std::set<std::vector<uint32_t>>& paths = ONLY_EMPTY, bool replace_apostrophe_with_h_in_prv=false,
174             bool replace_apostrophe_with_h_in_pub=false, uint32_t spender_nlocktime=0, uint32_t spender_nsequence=CTxIn::SEQUENCE_FINAL,
175             std::map<std::vector<uint8_t>, std::vector<uint8_t>> preimages={},
176             std::optional<std::string> expected_prv = std::nullopt, std::optional<std::string> expected_pub = std::nullopt, int desc_index = 0)
177{
178    FlatSigningProvider keys_priv, keys_pub;
179    std::set<std::vector<uint32_t>> left_paths = paths;
180    std::string error;
181
182    std::vector<std::unique_ptr<Descriptor>> parse_privs;
183    std::vector<std::unique_ptr<Descriptor>> parse_pubs;
184    // Check that parsing succeeds.
185    if (replace_apostrophe_with_h_in_prv) {
186        prv = UseHInsteadOfApostrophe(prv);
187    }
188    parse_privs = Parse(prv, keys_priv, error);
189    BOOST_CHECK_MESSAGE(!parse_privs.empty(), error);
190    if (replace_apostrophe_with_h_in_pub) {
191        pub = UseHInsteadOfApostrophe(pub);
192    }
193    parse_pubs = Parse(pub, keys_pub, error);
194    BOOST_CHECK_MESSAGE(!parse_pubs.empty(), error);
195
196    auto& parse_priv = parse_privs.at(desc_index);
197    auto& parse_pub = parse_pubs.at(desc_index);
198
199    // We must be able to estimate the max satisfaction size for any solvable descriptor top descriptor (but combo).
200    const bool is_nontop_or_nonsolvable{!parse_priv->IsSolvable() || !parse_priv->GetOutputType()};
201    const auto max_sat_maxsig{parse_priv->MaxSatisfactionWeight(true)};
202    const auto max_sat_nonmaxsig{parse_priv->MaxSatisfactionWeight(false)};
203    BOOST_CHECK(max_sat_nonmaxsig <= max_sat_maxsig);
204    const auto max_elems{parse_priv->MaxSatisfactionElems()};
205    const bool is_input_size_info_set{max_sat_maxsig && max_sat_nonmaxsig && max_elems};
206    BOOST_CHECK_MESSAGE(is_input_size_info_set || is_nontop_or_nonsolvable, prv);
207
208    // The ScriptSize() must match the size of the Script string. (ScriptSize() is set for all descs but 'combo()'.)
209    const bool is_combo{!parse_priv->IsSingleType()};
210    BOOST_CHECK_MESSAGE(is_combo || parse_priv->ScriptSize() == scripts[0][0].size() / 2, "Invalid ScriptSize() for " + prv);
211
212    // Check that the correct OutputType is inferred
213    BOOST_CHECK(parse_priv->GetOutputType() == type);
214    BOOST_CHECK(parse_pub->GetOutputType() == type);
215
216    // Check private keys are extracted from the private version but not the public one.
217    BOOST_CHECK(keys_priv.keys.size());
218    BOOST_CHECK(!keys_pub.keys.size());
219    const bool have_all_private_keys = !(flags & MISSING_PRIVKEYS);
220    BOOST_CHECK_EQUAL(parse_priv->HavePrivateKeys(keys_priv), have_all_private_keys);
221    BOOST_CHECK_EQUAL(parse_pub->HavePrivateKeys(keys_priv), have_all_private_keys);
222    BOOST_CHECK(!parse_priv->HavePrivateKeys(keys_pub));
223    BOOST_CHECK(!parse_pub->HavePrivateKeys(keys_pub));
224
225    // If expected_pub is provided, check that the serialize matches that.
226    // Otherwise check that they serialize back to the public version.
227    std::string pub1 = parse_priv->ToString();
228    std::string pub2 = parse_pub->ToString();
229    std::string canonical = UseHInsteadOfApostrophe(pub);
230    if (expected_pub) {
231        BOOST_CHECK_MESSAGE(EqualDescriptor(*expected_pub, pub1), "Private ser: " + pub1 + " Public desc: " + *expected_pub);
232        BOOST_CHECK_MESSAGE(EqualDescriptor(*expected_pub, pub2), "Public ser: " + pub2 + " Public desc: " + *expected_pub);
233        canonical = UseHInsteadOfApostrophe(*expected_pub);
234    } else {
235        BOOST_CHECK_MESSAGE(EqualDescriptor(pub, pub1), "Private ser: " + pub1 + " Public desc: " + pub);
236        BOOST_CHECK_MESSAGE(EqualDescriptor(pub, pub2), "Public ser: " + pub2 + " Public desc: " + pub);
237    }
238
239    std::string priv_canonical = parse_priv->ToCanonicalString();
240    std::string pub_canonical = parse_pub->ToCanonicalString();
241    BOOST_CHECK_MESSAGE(EqualDescriptor(priv_canonical, canonical), "Private ser: " + priv_canonical + " Expected desc: " + canonical);
242    BOOST_CHECK_MESSAGE(EqualDescriptor(pub_canonical, canonical), "Public ser: " + pub_canonical + " Expected desc: " + canonical);
243
244    // Check that the backwards compatibility descriptor hash did not change
245    if (op_compat_desc_hash) {
246        BOOST_CHECK_MESSAGE(CompatDescriptorHash(*parse_priv) == *op_compat_desc_hash, "CompatDescriptorHash() " + CompatDescriptorHash(*parse_priv).ToString() + " does not match for priv " + prv);
247    }
248
249    // Check that both can be serialized with private key back to the private version, but not without private key.
250    if (!(flags & MISSING_PRIVKEYS)) {

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.