Coverage Report

Created: 2026-09-02 14:16

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/tmp/bitcoin/src/script/descriptor.cpp
Line
Count
Source
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 <script/descriptor.h>
6
7
#include <addresstype.h>
8
#include <attributes.h>
9
#include <consensus/consensus.h>
10
#include <crypto/hex_base.h>
11
#include <crypto/sha256.h>
12
#include <hash.h>
13
#include <key.h>
14
#include <key_io.h>
15
#include <musig.h>
16
#include <primitives/transaction.h>
17
#include <pubkey.h>
18
#include <script/interpreter.h>
19
#include <script/keyorigin.h>
20
#include <script/miniscript.h>
21
#include <script/parsing.h>
22
#include <script/script.h>
23
#include <script/signingprovider.h>
24
#include <script/solver.h>
25
#include <serialize.h>
26
#include <tinyformat.h>
27
#include <uint256.h>
28
#include <util/bip32.h>
29
#include <util/check.h>
30
#include <util/expected.h>
31
#include <util/strencodings.h>
32
#include <util/string.h>
33
#include <util/vector.h>
34
35
#include <algorithm>
36
#include <compare>
37
#include <iterator>
38
#include <map>
39
#include <memory>
40
#include <numeric>
41
#include <optional>
42
#include <span>
43
#include <stdexcept>
44
#include <string>
45
#include <tuple>
46
#include <unordered_set>
47
#include <utility>
48
#include <vector>
49
50
using util::Split;
51
52
namespace {
53
54
////////////////////////////////////////////////////////////////////////////
55
// Checksum                                                               //
56
////////////////////////////////////////////////////////////////////////////
57
58
// This section implements a checksum algorithm for descriptors with the
59
// following properties:
60
// * Mistakes in a descriptor string are measured in "symbol errors". The higher
61
//   the number of symbol errors, the harder it is to detect:
62
//   * An error substituting a character from 0123456789()[],'/*abcdefgh@:$%{} for
63
//     another in that set always counts as 1 symbol error.
64
//     * Note that hex encoded keys are covered by these characters. Xprvs and
65
//       xpubs use other characters too, but already have their own checksum
66
//       mechanism.
67
//     * Function names like "multi()" use other characters, but mistakes in
68
//       these would generally result in an unparsable descriptor.
69
//   * A case error always counts as 1 symbol error.
70
//   * Any other 1 character substitution error counts as 1 or 2 symbol errors.
71
// * Any 1 symbol error is always detected.
72
// * Any 2 or 3 symbol error in a descriptor of up to 49154 characters is always detected.
73
// * Any 4 symbol error in a descriptor of up to 507 characters is always detected.
74
// * Any 5 symbol error in a descriptor of up to 77 characters is always detected.
75
// * Is optimized to minimize the chance a 5 symbol error in a descriptor up to 387 characters is undetected
76
// * Random errors have a chance of 1 in 2**40 of being undetected.
77
//
78
// These properties are achieved by expanding every group of 3 (non checksum) characters into
79
// 4 GF(32) symbols, over which a cyclic code is defined.
80
81
/*
82
 * Interprets c as 8 groups of 5 bits which are the coefficients of a degree 8 polynomial over GF(32),
83
 * multiplies that polynomial by x, computes its remainder modulo a generator, and adds the constant term val.
84
 *
85
 * This generator is G(x) = x^8 + {30}x^7 + {23}x^6 + {15}x^5 + {14}x^4 + {10}x^3 + {6}x^2 + {12}x + {9}.
86
 * It is chosen to define an cyclic error detecting code which is selected by:
87
 * - Starting from all BCH codes over GF(32) of degree 8 and below, which by construction guarantee detecting
88
 *   3 errors in windows up to 19000 symbols.
89
 * - Taking all those generators, and for degree 7 ones, extend them to degree 8 by adding all degree-1 factors.
90
 * - Selecting just the set of generators that guarantee detecting 4 errors in a window of length 512.
91
 * - Selecting one of those with best worst-case behavior for 5 errors in windows of length up to 512.
92
 *
93
 * The generator and the constants to implement it can be verified using this Sage code:
94
 *   B = GF(2) # Binary field
95
 *   BP.<b> = B[] # Polynomials over the binary field
96
 *   F_mod = b**5 + b**3 + 1
97
 *   F.<f> = GF(32, modulus=F_mod, repr='int') # GF(32) definition
98
 *   FP.<x> = F[] # Polynomials over GF(32)
99
 *   E_mod = x**3 + x + F.fetch_int(8)
100
 *   E.<e> = F.extension(E_mod) # Extension field definition
101
 *   alpha = e**2743 # Choice of an element in extension field
102
 *   for p in divisors(E.order() - 1): # Verify alpha has order 32767.
103
 *       assert((alpha**p == 1) == (p % 32767 == 0))
104
 *   G = lcm([(alpha**i).minpoly() for i in [1056,1057,1058]] + [x + 1])
105
 *   print(G) # Print out the generator
106
 *   for i in [1,2,4,8,16]: # Print out {1,2,4,8,16}*(G mod x^8), packed in hex integers.
107
 *       v = 0
108
 *       for coef in reversed((F.fetch_int(i)*(G % x**8)).coefficients(sparse=True)):
109
 *           v = v*32 + coef.integer_representation()
110
 *       print("0x%x" % v)
111
 */
112
uint64_t PolyMod(uint64_t c, int val)
113
334M
{
114
334M
    uint8_t c0 = c >> 35;
115
334M
    c = ((c & 0x7ffffffff) << 5) ^ val;
116
334M
    if (c0 & 1) c ^= 0xf5dee51989;
117
334M
    if (c0 & 2) c ^= 0xa9fdca3312;
118
334M
    if (c0 & 4) c ^= 0x1bab10e32d;
119
334M
    if (c0 & 8) c ^= 0x3706b1677a;
120
334M
    if (c0 & 16) c ^= 0x644d626ffd;
121
334M
    return c;
122
334M
}
123
124
std::string DescriptorChecksum(const std::span<const char>& span)
125
235k
{
126
    /** A character set designed such that:
127
     *  - The most common 'unprotected' descriptor characters (hex, keypaths) are in the first group of 32.
128
     *  - Case errors cause an offset that's a multiple of 32.
129
     *  - As many alphabetic characters are in the same group (while following the above restrictions).
130
     *
131
     * If p(x) gives the position of a character c in this character set, every group of 3 characters
132
     * (a,b,c) is encoded as the 4 symbols (p(a) & 31, p(b) & 31, p(c) & 31, (p(a) / 32) + 3 * (p(b) / 32) + 9 * (p(c) / 32).
133
     * This means that changes that only affect the lower 5 bits of the position, or only the higher 2 bits, will just
134
     * affect a single symbol.
135
     *
136
     * As a result, within-group-of-32 errors count as 1 symbol, as do cross-group errors that don't affect
137
     * the position within the groups.
138
     */
139
235k
    static const std::string INPUT_CHARSET =
140
235k
        "0123456789()[],'/*abcdefgh@:$%{}"
141
235k
        "IJKLMNOPQRSTUVWXYZ&+-.;<=>?!^_|~"
142
235k
        "ijklmnopqrstuvwxyzABCDEFGH`#\"\\ ";
143
144
    /** The character set for the checksum itself (same as bech32). */
145
235k
    static const std::string CHECKSUM_CHARSET = "qpzry9x8gf2tvdw0s3jn54khce6mua7l";
146
147
235k
    uint64_t c = 1;
148
235k
    int cls = 0;
149
235k
    int clscount = 0;
150
249M
    for (auto ch : span) {
151
249M
        auto pos = INPUT_CHARSET.find(ch);
152
249M
        if (pos == std::string::npos) return "";
153
249M
        c = PolyMod(c, pos & 31); // Emit a symbol for the position inside the group, for every character.
154
249M
        cls = cls * 3 + (pos >> 5); // Accumulate the group numbers
155
249M
        if (++clscount == 3) {
156
            // Emit an extra symbol representing the group numbers, for every 3 characters.
157
82.9M
            c = PolyMod(c, cls);
158
82.9M
            cls = 0;
159
82.9M
            clscount = 0;
160
82.9M
        }
161
249M
    }
162
235k
    if (clscount > 0) c = PolyMod(c, cls);
163
2.11M
    for (int j = 0; j < 8; ++j) c = PolyMod(c, 0); // Shift further to determine the checksum.
164
235k
    c ^= 1; // Prevent appending zeroes from not affecting the checksum.
165
166
235k
    std::string ret(8, ' ');
167
2.11M
    for (int j = 0; j < 8; ++j) ret[j] = CHECKSUM_CHARSET[(c >> (5 * (7 - j))) & 31];
168
235k
    return ret;
169
235k
}
170
171
223k
std::string AddChecksum(const std::string& str) { return str + "#" + DescriptorChecksum(str); }
172
173
////////////////////////////////////////////////////////////////////////////
174
// Internal representation                                                //
175
////////////////////////////////////////////////////////////////////////////
176
177
typedef std::vector<uint32_t> KeyPath;
178
179
/** Interface for public key objects in descriptors. */
180
struct PubkeyProvider
181
{
182
public:
183
    //! Index of this key expression in the descriptor
184
    //! E.g. If this PubkeyProvider is key1 in multi(2, key1, key2, key3), then m_expr_index = 0
185
    const uint32_t m_expr_index;
186
187
826k
    explicit PubkeyProvider(uint32_t exp_index) : m_expr_index(exp_index) {}
188
189
826k
    virtual ~PubkeyProvider() = default;
190
191
    /** Derive a public key and put it into out.
192
     *  read_cache is the cache to read keys from (if not nullptr)
193
     *  write_cache is the cache to write keys to (if not nullptr)
194
     *  Caches are not exclusive but this is not tested. Currently we use them exclusively
195
     */
196
    virtual std::optional<CPubKey> GetPubKey(int pos, const SigningProvider& arg, FlatSigningProvider& out, const DescriptorCache* read_cache = nullptr, DescriptorCache* write_cache = nullptr) const = 0;
197
198
    /** Whether this represent multiple public keys at different positions. */
199
    virtual bool IsRange() const = 0;
200
201
    /** Get the size of the generated public key(s) in bytes (33 or 65). */
202
    virtual size_t GetSize() const = 0;
203
204
    enum class StringType {
205
        PUBLIC,
206
        COMPAT // string calculation that mustn't change over time to stay compatible with previous software versions
207
    };
208
209
    /** Get the descriptor string form. */
210
    virtual std::string ToString(StringType type=StringType::PUBLIC) const = 0;
211
212
    /** Get the descriptor string form including private data (if available in arg).
213
     *  If the private data is not available, the output string in the "out" parameter
214
     *  will not contain any private key information,
215
     *  and this function will return "false".
216
     */
217
    virtual bool ToPrivateString(const SigningProvider& arg, std::string& out) const = 0;
218
219
    /** Get the descriptor string form with the xpub at the last hardened derivation,
220
     *  and always use h for hardened derivation.
221
     */
222
    virtual bool ToNormalizedString(const SigningProvider& arg, std::string& out, const DescriptorCache* cache = nullptr) const = 0;
223
224
    /** Derive a private key, if private data is available in arg and put it into out. */
225
    virtual void GetPrivKey(int pos, const SigningProvider& arg, FlatSigningProvider& out) const = 0;
226
227
    /** Whether private data for this provider is available in arg. */
228
    virtual bool HavePrivateKeys(const SigningProvider& arg) const
229
1.64k
    {
230
1.64k
        FlatSigningProvider tmp_provider;
231
1.64k
        GetPrivKey(/*pos=*/0, arg, tmp_provider);
232
1.64k
        return !tmp_provider.keys.empty();
233
1.64k
    }
234
235
    /** Return the non-extended public key for this PubkeyProvider, if it has one. */
236
    virtual std::optional<CPubKey> GetRootPubKey() const = 0;
237
    /** Return the extended public key for this PubkeyProvider, if it has one. */
238
    virtual std::optional<CExtPubKey> GetRootExtPubKey() const = 0;
239
240
    /** Make a deep copy of this PubkeyProvider */
241
    virtual std::unique_ptr<PubkeyProvider> Clone() const = 0;
242
243
    /** Whether this PubkeyProvider is a BIP 32 extended key that can be derived from */
244
    virtual bool IsBIP32() const = 0;
245
246
    /** Get the count of keys known by this PubkeyProvider. Usually one, but may be more for key aggregation schemes */
247
480
    virtual size_t GetKeyCount() const { return 1; }
248
249
    /** Whether this PubkeyProvider can always provide a public key without cache or private key arguments */
250
    virtual bool CanSelfExpand() const = 0;
251
};
252
253
class OriginPubkeyProvider final : public PubkeyProvider
254
{
255
    KeyOriginInfo m_origin;
256
    std::unique_ptr<PubkeyProvider> m_provider;
257
    bool m_apostrophe;
258
259
    std::string OriginString(StringType type, bool normalized=false) const
260
91.4k
    {
261
        // If StringType==COMPAT, always use the apostrophe to stay compatible with previous versions
262
91.4k
        bool use_apostrophe = (!normalized && m_apostrophe) || type == StringType::COMPAT;
263
91.4k
        return HexStr(m_origin.fingerprint) + FormatHDKeypath(m_origin.path, use_apostrophe);
264
91.4k
    }
265
266
public:
267
393k
    OriginPubkeyProvider(uint32_t exp_index, KeyOriginInfo info, std::unique_ptr<PubkeyProvider> provider, bool apostrophe) : PubkeyProvider(exp_index), m_origin(std::move(info)), m_provider(std::move(provider)), m_apostrophe(apostrophe) {}
268
    std::optional<CPubKey> GetPubKey(int pos, const SigningProvider& arg, FlatSigningProvider& out, const DescriptorCache* read_cache = nullptr, DescriptorCache* write_cache = nullptr) const override
269
63.4k
    {
270
        // Derive into a temporary provider. Another key expression may have already put this
271
        // key into out with its origin prefixed, and prefixing that entry would double it up.
272
63.4k
        FlatSigningProvider subprovider;
273
63.4k
        std::optional<CPubKey> pub = m_provider->GetPubKey(pos, arg, subprovider, read_cache, write_cache);
274
63.4k
        if (!pub) return std::nullopt;
275
63.2k
        const CKeyID keyid{pub->GetID()};
276
63.2k
        Assert(subprovider.pubkeys.contains(keyid));
277
63.2k
        auto& [pubkey, suborigin] = subprovider.origins[keyid];
278
63.2k
        Assert(pubkey == *pub); // m_provider must have a valid origin by this point.
279
63.2k
        suborigin.fingerprint = m_origin.fingerprint;
280
63.2k
        suborigin.path.insert(suborigin.path.begin(), m_origin.path.begin(), m_origin.path.end());
281
63.2k
        auto origin{subprovider.origins.extract(keyid)};
282
63.2k
        out.Merge(std::move(subprovider));
283
        // An explicit origin takes precedence over an implicit one for the same key.
284
63.2k
        out.origins.insert_or_assign(keyid, std::move(origin.mapped()));
285
63.2k
        return pub;
286
63.4k
    }
287
30.2k
    bool IsRange() const override { return m_provider->IsRange(); }
288
55.0k
    size_t GetSize() const override { return m_provider->GetSize(); }
289
190
    bool IsBIP32() const override { return m_provider->IsBIP32(); }
290
90.5k
    std::string ToString(StringType type) const override { return "[" + OriginString(type) + "]" + m_provider->ToString(type); }
291
    bool ToPrivateString(const SigningProvider& arg, std::string& ret) const override
292
105
    {
293
105
        std::string sub;
294
105
        bool has_priv_key{m_provider->ToPrivateString(arg, sub)};
295
105
        ret = "[" + OriginString(StringType::PUBLIC) + "]" + std::move(sub);
296
105
        return has_priv_key;
297
105
    }
298
    bool ToNormalizedString(const SigningProvider& arg, std::string& ret, const DescriptorCache* cache) const override
299
776
    {
300
776
        std::string sub;
301
776
        if (!m_provider->ToNormalizedString(arg, sub, cache)) return false;
302
        // If m_provider is a BIP32PubkeyProvider, we may get a string formatted like a OriginPubkeyProvider
303
        // In that case, we need to strip out the leading square bracket and fingerprint from the substring,
304
        // and append that to our own origin string.
305
776
        if (sub[0] == '[') {
306
4
            sub = sub.substr(9);
307
4
            ret = "[" + OriginString(StringType::PUBLIC, /*normalized=*/true) + std::move(sub);
308
772
        } else {
309
772
            ret = "[" + OriginString(StringType::PUBLIC, /*normalized=*/true) + "]" + std::move(sub);
310
772
        }
311
776
        return true;
312
776
    }
313
    void GetPrivKey(int pos, const SigningProvider& arg, FlatSigningProvider& out) const override
314
3.47k
    {
315
3.47k
        m_provider->GetPrivKey(pos, arg, out);
316
3.47k
    }
317
    std::optional<CPubKey> GetRootPubKey() const override
318
0
    {
319
0
        return m_provider->GetRootPubKey();
320
0
    }
321
    std::optional<CExtPubKey> GetRootExtPubKey() const override
322
0
    {
323
0
        return m_provider->GetRootExtPubKey();
324
0
    }
325
    std::unique_ptr<PubkeyProvider> Clone() const override
326
122
    {
327
122
        return std::make_unique<OriginPubkeyProvider>(m_expr_index, m_origin, m_provider->Clone(), m_apostrophe);
328
122
    }
329
443
    bool CanSelfExpand() const override { return m_provider->CanSelfExpand(); }
330
};
331
332
/** An object representing a parsed constant public key in a descriptor. */
333
class ConstPubkeyProvider final : public PubkeyProvider
334
{
335
    CPubKey m_pubkey;
336
    bool m_xonly;
337
338
    std::optional<CKey> GetPrivKey(const SigningProvider& arg) const
339
53.3k
    {
340
53.3k
        CKey key;
341
53.3k
        if (!(m_xonly ? arg.GetKeyByXOnly(XOnlyPubKey(m_pubkey), key) :
342
53.3k
                        arg.GetKey(m_pubkey.GetID(), key))) return std::nullopt;
343
7.50k
        return key;
344
53.3k
    }
345
346
public:
347
424k
    ConstPubkeyProvider(uint32_t exp_index, const CPubKey& pubkey, bool xonly) : PubkeyProvider(exp_index), m_pubkey(pubkey), m_xonly(xonly) {}
348
    std::optional<CPubKey> GetPubKey(int pos, const SigningProvider&, FlatSigningProvider& out, const DescriptorCache* read_cache = nullptr, DescriptorCache* write_cache = nullptr) const override
349
1.01M
    {
350
1.01M
        KeyOriginInfo info;
351
1.01M
        CKeyID keyid = m_pubkey.GetID();
352
1.01M
        info.fingerprint = keyid.fingerprint();
353
1.01M
        out.origins.emplace(keyid, std::make_pair(m_pubkey, info));
354
1.01M
        out.pubkeys.emplace(keyid, m_pubkey);
355
1.01M
        return m_pubkey;
356
1.01M
    }
357
40.4k
    bool IsRange() const override { return false; }
358
69.4k
    size_t GetSize() const override { return m_pubkey.size(); }
359
8
    bool IsBIP32() const override { return false; }
360
232k
    std::string ToString(StringType type) const override { return m_xonly ? HexStr(m_pubkey).substr(2) : HexStr(m_pubkey); }
361
    bool ToPrivateString(const SigningProvider& arg, std::string& ret) const override
362
417
    {
363
417
        std::optional<CKey> key = GetPrivKey(arg);
364
417
        if (!key) {
365
204
            ret = ToString(StringType::PUBLIC);
366
204
            return false;
367
204
        }
368
213
        ret = EncodeSecret(*key);
369
213
        return true;
370
417
    }
371
    bool ToNormalizedString(const SigningProvider& arg, std::string& ret, const DescriptorCache* cache) const override
372
10.6k
    {
373
10.6k
        ret = ToString(StringType::PUBLIC);
374
10.6k
        return true;
375
10.6k
    }
376
    void GetPrivKey(int pos, const SigningProvider& arg, FlatSigningProvider& out) const override
377
52.9k
    {
378
52.9k
        std::optional<CKey> key = GetPrivKey(arg);
379
52.9k
        if (!key) return;
380
7.28k
        out.keys.emplace(key->GetPubKey().GetID(), *key);
381
7.28k
    }
382
    std::optional<CPubKey> GetRootPubKey() const override
383
12
    {
384
12
        return m_pubkey;
385
12
    }
386
    std::optional<CExtPubKey> GetRootExtPubKey() const override
387
12
    {
388
12
        return std::nullopt;
389
12
    }
390
    std::unique_ptr<PubkeyProvider> Clone() const override
391
30
    {
392
30
        return std::make_unique<ConstPubkeyProvider>(m_expr_index, m_pubkey, m_xonly);
393
30
    }
394
813
    bool CanSelfExpand() const final { return true; }
395
};
396
397
enum class DeriveType {
398
    NON_RANGED,
399
    UNHARDENED_RANGED,
400
    HARDENED_RANGED,
401
};
402
403
/** An object representing a parsed extended public key in a descriptor. */
404
class BIP32PubkeyProvider final : public PubkeyProvider
405
{
406
    // Root xpub, path, and final derivation step type being used, if any
407
    CExtPubKey m_root_extkey;
408
    KeyPath m_path;
409
    DeriveType m_derive;
410
    // Whether ' or h is used in harded derivation
411
    bool m_apostrophe;
412
413
    bool GetExtKey(const SigningProvider& arg, CExtKey& ret) const
414
58.4k
    {
415
58.4k
        CKey key;
416
58.4k
        if (!arg.GetKey(m_root_extkey.pubkey.GetID(), key)) return false;
417
51.5k
        ret.nDepth = m_root_extkey.nDepth;
418
51.5k
        ret.fingerprint = m_root_extkey.fingerprint;
419
51.5k
        ret.nChild = m_root_extkey.nChild;
420
51.5k
        ret.chaincode = m_root_extkey.chaincode;
421
51.5k
        ret.key = key;
422
51.5k
        return true;
423
58.4k
    }
424
425
    // Derives the last xprv
426
    bool GetDerivedExtKey(const SigningProvider& arg, CExtKey& xprv, CExtKey& last_hardened) const
427
57.0k
    {
428
57.0k
        if (!GetExtKey(arg, xprv)) return false;
429
92.2k
        for (auto entry : m_path) {
430
92.2k
            if (!xprv.Derive(xprv, entry)) return false;
431
92.2k
            if (entry >> 31) {
432
75.2k
                last_hardened = xprv;
433
75.2k
            }
434
92.2k
        }
435
50.4k
        return true;
436
50.4k
    }
437
438
    bool IsHardened() const
439
59.0k
    {
440
59.0k
        if (m_derive == DeriveType::HARDENED_RANGED) return true;
441
28.7k
        return HasHardenedDerivation(m_path);
442
59.0k
    }
443
444
public:
445
9.43k
    BIP32PubkeyProvider(uint32_t exp_index, const CExtPubKey& extkey, KeyPath path, DeriveType derive, bool apostrophe) : PubkeyProvider(exp_index), m_root_extkey(extkey), m_path(std::move(path)), m_derive(derive), m_apostrophe(apostrophe) {}
446
501k
    bool IsRange() const override { return m_derive != DeriveType::NON_RANGED; }
447
559
    size_t GetSize() const override { return 33; }
448
419
    bool IsBIP32() const override { return true; }
449
    std::optional<CPubKey> GetPubKey(int pos, const SigningProvider& arg, FlatSigningProvider& out, const DescriptorCache* read_cache = nullptr, DescriptorCache* write_cache = nullptr) const override
450
726k
    {
451
726k
        KeyOriginInfo info;
452
726k
        info.fingerprint = m_root_extkey.id_key_fingerprint();
453
726k
        info.path = m_path;
454
726k
        if (m_derive == DeriveType::UNHARDENED_RANGED) info.path.push_back((uint32_t)pos);
455
726k
        if (m_derive == DeriveType::HARDENED_RANGED) info.path.push_back(((uint32_t)pos) | BIP32_HARDENED_FLAG);
456
457
        // Derive keys or fetch them from cache
458
726k
        CExtPubKey final_extkey = m_root_extkey;
459
726k
        CExtPubKey parent_extkey = m_root_extkey;
460
726k
        CExtPubKey last_hardened_extkey;
461
726k
        bool der = true;
462
726k
        if (read_cache) {
463
668k
            if (!read_cache->GetCachedDerivedExtPubKey(m_expr_index, pos, final_extkey)) {
464
664k
                if (m_derive == DeriveType::HARDENED_RANGED) return std::nullopt;
465
                // Try to get the derivation parent
466
640k
                if (!read_cache->GetCachedParentExtPubKey(m_expr_index, parent_extkey)) return std::nullopt;
467
635k
                final_extkey = parent_extkey;
468
635k
                if (m_derive == DeriveType::UNHARDENED_RANGED) der = parent_extkey.Derive(final_extkey, pos);
469
635k
            }
470
668k
        } else if (IsHardened()) {
471
39.6k
            CExtKey xprv;
472
39.6k
            CExtKey lh_xprv;
473
39.6k
            if (!GetDerivedExtKey(arg, xprv, lh_xprv)) return std::nullopt;
474
39.5k
            parent_extkey = xprv.Neuter();
475
39.5k
            if (m_derive == DeriveType::UNHARDENED_RANGED) der = xprv.Derive(xprv, pos);
476
39.5k
            if (m_derive == DeriveType::HARDENED_RANGED) der = xprv.Derive(xprv, pos | BIP32_HARDENED_FLAG);
477
39.5k
            final_extkey = xprv.Neuter();
478
39.5k
            if (lh_xprv.key.IsValid()) {
479
36.4k
                last_hardened_extkey = lh_xprv.Neuter();
480
36.4k
            }
481
39.5k
        } else {
482
18.0k
            for (auto entry : m_path) {
483
17.9k
                if (!parent_extkey.Derive(parent_extkey, entry)) return std::nullopt;
484
17.9k
            }
485
18.0k
            final_extkey = parent_extkey;
486
18.0k
            if (m_derive == DeriveType::UNHARDENED_RANGED) der = parent_extkey.Derive(final_extkey, pos);
487
18.0k
            assert(m_derive != DeriveType::HARDENED_RANGED);
488
18.0k
        }
489
697k
        if (!der) return std::nullopt;
490
491
697k
        out.origins.emplace(final_extkey.pubkey.GetID(), std::make_pair(final_extkey.pubkey, info));
492
697k
        out.pubkeys.emplace(final_extkey.pubkey.GetID(), final_extkey.pubkey);
493
494
697k
        if (write_cache) {
495
            // Only cache parent if there is any unhardened derivation
496
30.8k
            if (m_derive != DeriveType::HARDENED_RANGED) {
497
6.64k
                write_cache->CacheParentExtPubKey(m_expr_index, parent_extkey);
498
                // Cache last hardened xpub if we have it
499
6.64k
                if (last_hardened_extkey.pubkey.IsValid()) {
500
4.24k
                    write_cache->CacheLastHardenedExtPubKey(m_expr_index, last_hardened_extkey);
501
4.24k
                }
502
24.1k
            } else if (info.path.size() > 0) {
503
24.1k
                write_cache->CacheDerivedExtPubKey(m_expr_index, pos, final_extkey);
504
24.1k
            }
505
30.8k
        }
506
507
697k
        return final_extkey.pubkey;
508
697k
    }
509
    std::string ToString(StringType type, bool normalized) const
510
107k
    {
511
        // If StringType==COMPAT, always use the apostrophe to stay compatible with previous versions
512
107k
        const bool use_apostrophe = (!normalized && m_apostrophe) || type == StringType::COMPAT;
513
107k
        std::string ret = EncodeExtPubKey(m_root_extkey) + FormatHDKeypath(m_path, /*apostrophe=*/use_apostrophe);
514
107k
        if (IsRange()) {
515
101k
            ret += "/*";
516
101k
            if (m_derive == DeriveType::HARDENED_RANGED) ret += use_apostrophe ? '\'' : 'h';
517
101k
        }
518
107k
        return ret;
519
107k
    }
520
    std::string ToString(StringType type=StringType::PUBLIC) const override
521
106k
    {
522
106k
        return ToString(type, /*normalized=*/false);
523
106k
    }
524
    bool ToPrivateString(const SigningProvider& arg, std::string& out) const override
525
1.41k
    {
526
1.41k
        CExtKey key;
527
1.41k
        if (!GetExtKey(arg, key)) {
528
368
            out = ToString(StringType::PUBLIC);
529
368
            return false;
530
368
        }
531
1.04k
        out = EncodeExtKey(key) + FormatHDKeypath(m_path, /*apostrophe=*/m_apostrophe);
532
1.04k
        if (IsRange()) {
533
827
            out += "/*";
534
827
            if (m_derive == DeriveType::HARDENED_RANGED) out += m_apostrophe ? '\'' : 'h';
535
827
        }
536
1.04k
        return true;
537
1.41k
    }
538
    bool ToNormalizedString(const SigningProvider& arg, std::string& out, const DescriptorCache* cache) const override
539
6.89k
    {
540
6.89k
        if (m_derive == DeriveType::HARDENED_RANGED) {
541
283
            out = ToString(StringType::PUBLIC, /*normalized=*/true);
542
543
283
            return true;
544
283
        }
545
        // Step backwards to find the last hardened step in the path
546
6.61k
        int i = (int)m_path.size() - 1;
547
12.5k
        for (; i >= 0; --i) {
548
11.3k
            if (m_path.at(i) >> 31) {
549
5.46k
                break;
550
5.46k
            }
551
11.3k
        }
552
        // Either no derivation or all unhardened derivation
553
6.61k
        if (i == -1) {
554
1.15k
            out = ToString();
555
1.15k
            return true;
556
1.15k
        }
557
        // Get the path to the last hardened stup
558
5.46k
        KeyOriginInfo origin;
559
5.46k
        int k = 0;
560
21.7k
        for (; k <= i; ++k) {
561
            // Add to the path
562
16.2k
            origin.path.push_back(m_path.at(k));
563
16.2k
        }
564
        // Build the remaining path
565
5.46k
        KeyPath end_path;
566
10.8k
        for (; k < (int)m_path.size(); ++k) {
567
5.36k
            end_path.push_back(m_path.at(k));
568
5.36k
        }
569
5.46k
        origin.fingerprint = m_root_extkey.id_key_fingerprint();
570
571
5.46k
        CExtPubKey xpub;
572
5.46k
        CExtKey lh_xprv;
573
        // If we have the cache, just get the parent xpub
574
5.46k
        if (cache != nullptr) {
575
5.40k
            cache->GetCachedLastHardenedExtPubKey(m_expr_index, xpub);
576
5.40k
        }
577
5.46k
        if (!xpub.pubkey.IsValid()) {
578
            // Cache miss, or nor cache, or need privkey
579
54
            CExtKey xprv;
580
54
            if (!GetDerivedExtKey(arg, xprv, lh_xprv)) return false;
581
54
            xpub = lh_xprv.Neuter();
582
54
        }
583
5.46k
        assert(xpub.pubkey.IsValid());
584
585
        // Build the string
586
5.46k
        std::string origin_str = HexStr(origin.fingerprint) + FormatHDKeypath(origin.path);
587
5.46k
        out = "[" + origin_str + "]" + EncodeExtPubKey(xpub) + FormatHDKeypath(end_path);
588
5.46k
        if (IsRange()) {
589
5.34k
            out += "/*";
590
5.34k
            assert(m_derive == DeriveType::UNHARDENED_RANGED);
591
5.34k
        }
592
5.46k
        return true;
593
5.46k
    }
594
    void GetPrivKey(int pos, const SigningProvider& arg, FlatSigningProvider& out) const override
595
17.3k
    {
596
17.3k
        CExtKey extkey;
597
17.3k
        CExtKey dummy;
598
17.3k
        if (!GetDerivedExtKey(arg, extkey, dummy)) return;
599
10.9k
        if (m_derive == DeriveType::UNHARDENED_RANGED && !extkey.Derive(extkey, pos)) return;
600
10.9k
        if (m_derive == DeriveType::HARDENED_RANGED && !extkey.Derive(extkey, pos | BIP32_HARDENED_FLAG)) return;
601
10.9k
        out.keys.emplace(extkey.key.GetPubKey().GetID(), extkey.key);
602
10.9k
    }
603
    std::optional<CPubKey> GetRootPubKey() const override
604
381
    {
605
381
        return std::nullopt;
606
381
    }
607
    std::optional<CExtPubKey> GetRootExtPubKey() const override
608
381
    {
609
381
        return m_root_extkey;
610
381
    }
611
    std::unique_ptr<PubkeyProvider> Clone() const override
612
314
    {
613
314
        return std::make_unique<BIP32PubkeyProvider>(m_expr_index, m_root_extkey, m_path, m_derive, m_apostrophe);
614
314
    }
615
1.32k
    bool CanSelfExpand() const override { return !IsHardened(); }
616
};
617
618
/** PubkeyProvider for a musig() expression */
619
class MuSigPubkeyProvider final : public PubkeyProvider
620
{
621
private:
622
    //! PubkeyProvider for the participants
623
    const std::vector<std::unique_ptr<PubkeyProvider>> m_participants;
624
    //! Derivation path
625
    const KeyPath m_path;
626
    //! PubkeyProvider for the aggregate pubkey if it can be cached (i.e. participants are not ranged)
627
    mutable std::unique_ptr<PubkeyProvider> m_aggregate_provider;
628
    mutable std::optional<CPubKey> m_aggregate_pubkey;
629
    const DeriveType m_derive;
630
    const bool m_ranged_participants;
631
632
5.08k
    bool IsRangedDerivation() const { return m_derive != DeriveType::NON_RANGED; }
633
634
public:
635
    MuSigPubkeyProvider(
636
        uint32_t exp_index,
637
        std::vector<std::unique_ptr<PubkeyProvider>> providers,
638
        KeyPath path,
639
        DeriveType derive
640
    )
641
289
        : PubkeyProvider(exp_index),
642
289
        m_participants(std::move(providers)),
643
289
        m_path(std::move(path)),
644
289
        m_derive(derive),
645
641
        m_ranged_participants(std::any_of(m_participants.begin(), m_participants.end(), [](const auto& pubkey) { return pubkey->IsRange(); }))
646
289
    {
647
289
        if (!Assume(!(m_ranged_participants && IsRangedDerivation()))) {
648
0
            throw std::runtime_error("musig(): Cannot have both ranged participants and ranged derivation");
649
0
        }
650
289
        if (!Assume(m_derive != DeriveType::HARDENED_RANGED)) {
651
0
            throw std::runtime_error("musig(): Cannot have hardened derivation");
652
0
        }
653
289
    }
654
655
    std::optional<CPubKey> GetPubKey(int pos, const SigningProvider& arg, FlatSigningProvider& out, const DescriptorCache* read_cache = nullptr, DescriptorCache* write_cache = nullptr) const override
656
1.67k
    {
657
1.67k
        FlatSigningProvider dummy;
658
        // If the participants are not ranged, we can compute and cache the aggregate pubkey by creating a PubkeyProvider for it
659
1.67k
        if (!m_aggregate_provider && !m_ranged_participants) {
660
            // Retrieve the pubkeys from the providers
661
188
            std::vector<CPubKey> pubkeys;
662
484
            for (const auto& prov : m_participants) {
663
484
                std::optional<CPubKey> pubkey = prov->GetPubKey(0, arg, dummy, read_cache, write_cache);
664
484
                if (!pubkey.has_value()) {
665
6
                    return std::nullopt;
666
6
                }
667
478
                pubkeys.push_back(pubkey.value());
668
478
            }
669
182
            std::sort(pubkeys.begin(), pubkeys.end());
670
671
            // Aggregate the pubkey
672
182
            m_aggregate_pubkey = MuSig2AggregatePubkeys(pubkeys);
673
182
            if (!Assume(m_aggregate_pubkey.has_value())) return std::nullopt;
674
675
            // Make our pubkey provider
676
182
            if (IsRangedDerivation() || !m_path.empty()) {
677
                // Make the synthetic xpub and construct the BIP32PubkeyProvider
678
176
                CExtPubKey extpub = CreateMuSig2SyntheticXpub(m_aggregate_pubkey.value());
679
176
                m_aggregate_provider = std::make_unique<BIP32PubkeyProvider>(m_expr_index, extpub, m_path, m_derive, /*apostrophe=*/false);
680
176
            } else {
681
6
                m_aggregate_provider = std::make_unique<ConstPubkeyProvider>(m_expr_index, m_aggregate_pubkey.value(), /*xonly=*/false);
682
6
            }
683
182
        }
684
685
        // Retrieve all participant pubkeys
686
1.66k
        std::vector<CPubKey> pubkeys;
687
4.19k
        for (const auto& prov : m_participants) {
688
4.19k
            std::optional<CPubKey> pub = prov->GetPubKey(pos, arg, out, read_cache, write_cache);
689
4.19k
            if (!pub) return std::nullopt;
690
4.05k
            pubkeys.emplace_back(*pub);
691
4.05k
        }
692
1.52k
        std::sort(pubkeys.begin(), pubkeys.end());
693
694
1.52k
        CPubKey pubout;
695
1.52k
        if (m_aggregate_provider) {
696
            // When we have a cached aggregate key, we are either returning it or deriving from it
697
            // Either way, we can passthrough to its GetPubKey
698
            // Use a dummy signing provider as private keys do not exist for the aggregate pubkey
699
1.18k
            std::optional<CPubKey> pub = m_aggregate_provider->GetPubKey(pos, dummy, out, read_cache, write_cache);
700
1.18k
            if (!pub) return std::nullopt;
701
1.18k
            pubout = *pub;
702
1.18k
            out.aggregate_pubkeys.emplace(m_aggregate_pubkey.value(), pubkeys);
703
1.18k
        } else {
704
343
            if (!Assume(m_ranged_participants) || !Assume(m_path.empty())) return std::nullopt;
705
            // Compute aggregate key from derived participants
706
343
            std::optional<CPubKey> aggregate_pubkey = MuSig2AggregatePubkeys(pubkeys);
707
343
            if (!aggregate_pubkey) return std::nullopt;
708
343
            pubout = *aggregate_pubkey;
709
710
343
            std::unique_ptr<ConstPubkeyProvider> this_agg_provider = std::make_unique<ConstPubkeyProvider>(m_expr_index, aggregate_pubkey.value(), /*xonly=*/false);
711
343
            this_agg_provider->GetPubKey(0, dummy, out, read_cache, write_cache);
712
343
            out.aggregate_pubkeys.emplace(pubout, pubkeys);
713
343
        }
714
715
1.52k
        if (!Assume(pubout.IsValid())) return std::nullopt;
716
1.52k
        return pubout;
717
1.52k
    }
718
3.00k
    bool IsRange() const override { return IsRangedDerivation() || m_ranged_participants; }
719
    // musig() expressions can only be used in tr() contexts which have 32 byte xonly pubkeys
720
0
    size_t GetSize() const override { return 32; }
721
722
    std::string ToString(StringType type=StringType::PUBLIC) const override
723
1.58k
    {
724
1.58k
        std::string out = "musig(";
725
5.96k
        for (size_t i = 0; i < m_participants.size(); ++i) {
726
4.37k
            const auto& pubkey = m_participants.at(i);
727
4.37k
            if (i) out += ",";
728
4.37k
            out += pubkey->ToString(type);
729
4.37k
        }
730
1.58k
        out += ")";
731
1.58k
        out += FormatHDKeypath(m_path);
732
1.58k
        if (IsRangedDerivation()) {
733
1.21k
            out += "/*";
734
1.21k
        }
735
1.58k
        return out;
736
1.58k
    }
737
    bool ToPrivateString(const SigningProvider& arg, std::string& out) const override
738
67
    {
739
67
        bool any_privkeys = false;
740
67
        out = "musig(";
741
239
        for (size_t i = 0; i < m_participants.size(); ++i) {
742
172
            const auto& pubkey = m_participants.at(i);
743
172
            if (i) out += ",";
744
172
            std::string tmp;
745
172
            if (pubkey->ToPrivateString(arg, tmp)) {
746
84
                any_privkeys = true;
747
84
            }
748
172
            out += tmp;
749
172
        }
750
67
        out += ")";
751
67
        out += FormatHDKeypath(m_path);
752
67
        if (IsRangedDerivation()) {
753
37
            out += "/*";
754
37
        }
755
67
        return any_privkeys;
756
67
    }
757
    bool ToNormalizedString(const SigningProvider& arg, std::string& out, const DescriptorCache* cache = nullptr) const override
758
166
    {
759
166
        out = "musig(";
760
608
        for (size_t i = 0; i < m_participants.size(); ++i) {
761
442
            const auto& pubkey = m_participants.at(i);
762
442
            if (i) out += ",";
763
442
            std::string tmp;
764
442
            if (!pubkey->ToNormalizedString(arg, tmp, cache)) {
765
0
                return false;
766
0
            }
767
442
            out += tmp;
768
442
        }
769
166
        out += ")";
770
166
        out += FormatHDKeypath(m_path);
771
166
        if (IsRangedDerivation()) {
772
119
            out += "/*";
773
119
        }
774
166
        return true;
775
166
    }
776
777
    void GetPrivKey(int pos, const SigningProvider& arg, FlatSigningProvider& out) const override
778
1.59k
    {
779
        // Get the private keys for any participants that we have
780
        // If there is participant derivation, it will be done.
781
        // If there is not, then the participant privkeys will be included directly
782
4.47k
        for (const auto& prov : m_participants) {
783
4.47k
            prov->GetPrivKey(pos, arg, out);
784
4.47k
        }
785
1.59k
    }
786
787
    bool HavePrivateKeys(const SigningProvider& arg) const override
788
229
    {
789
346
        return std::ranges::all_of(m_participants, [&](const auto& prov) { return prov->HavePrivateKeys(arg); });
790
229
    }
791
792
    // Get RootPubKey and GetRootExtPubKey are used to return the single pubkey underlying the pubkey provider
793
    // to be presented to the user in gethdkeys. As this is a multisig construction, there is no single underlying
794
    // pubkey hence nothing should be returned.
795
    // While the aggregate pubkey could be returned as the root (ext)pubkey, it is not a pubkey that anyone should
796
    // be using by itself in a descriptor as it is unspendable without knowing its participants.
797
    std::optional<CPubKey> GetRootPubKey() const override
798
0
    {
799
0
        return std::nullopt;
800
0
    }
801
    std::optional<CExtPubKey> GetRootExtPubKey() const override
802
0
    {
803
0
        return std::nullopt;
804
0
    }
805
806
    std::unique_ptr<PubkeyProvider> Clone() const override
807
29
    {
808
29
        std::vector<std::unique_ptr<PubkeyProvider>> providers;
809
29
        providers.reserve(m_participants.size());
810
78
        for (const std::unique_ptr<PubkeyProvider>& p : m_participants) {
811
78
            providers.emplace_back(p->Clone());
812
78
        }
813
29
        return std::make_unique<MuSigPubkeyProvider>(m_expr_index, std::move(providers), m_path, m_derive);
814
29
    }
815
    bool IsBIP32() const override
816
0
    {
817
        // musig() can only be a BIP 32 key if all participants are bip32 too
818
0
        return std::all_of(m_participants.begin(), m_participants.end(), [](const auto& pubkey) { return pubkey->IsBIP32(); });
819
0
    }
820
    size_t GetKeyCount() const override
821
46
    {
822
46
        return 1 + m_participants.size();
823
46
    }
824
    bool CanSelfExpand() const override
825
138
    {
826
        // Participants must be self expandable for all MuSig expressions to be self expandable; the aggregate pubkey cannot be stored
827
        // in the descriptor cache, so even aggregate-then-derive still requires the self expansion of participants prior to aggregation.
828
318
        for (const auto& key : m_participants) {
829
318
            if (!key->CanSelfExpand()) return false;
830
318
        }
831
114
        return true;
832
138
    }
833
};
834
835
/** Base class for all Descriptor implementations. */
836
class DescriptorImpl : public Descriptor
837
{
838
protected:
839
    //! Public key arguments for this descriptor (size 1 for PK, PKH, WPKH; any size for WSH and Multisig).
840
    const std::vector<std::unique_ptr<PubkeyProvider>> m_pubkey_args;
841
    //! The string name of the descriptor function.
842
    const std::string m_name;
843
    //! Warnings (not including subdescriptors).
844
    std::vector<std::string> m_warnings;
845
846
    //! The sub-descriptor arguments (empty for everything but SH and WSH).
847
    //! In doc/descriptors.md this is referred to as SCRIPT expressions sh(SCRIPT)
848
    //! and wsh(SCRIPT), and distinct from KEY expressions and ADDR expressions.
849
    //! Subdescriptors can only ever generate a single script.
850
    const std::vector<std::unique_ptr<DescriptorImpl>> m_subdescriptor_args;
851
852
    //! Return a serialization of anything except pubkey and script arguments, to be prepended to those.
853
249k
    virtual std::string ToStringExtra() const { return ""; }
854
855
    /** A helper function to construct the scripts for this descriptor.
856
     *
857
     *  This function is invoked once by ExpandHelper.
858
     *
859
     *  @param pubkeys The evaluations of the m_pubkey_args field.
860
     *  @param scripts The evaluations of m_subdescriptor_args (one for each m_subdescriptor_args element).
861
     *  @param out A FlatSigningProvider to put scripts or public keys in that are necessary to the solver.
862
     *             The origin info of the provided pubkeys is automatically added.
863
     *  @return A vector with scriptPubKeys for this descriptor.
864
     */
865
    virtual std::vector<CScript> MakeScripts(const std::vector<CPubKey>& pubkeys, std::span<const CScript> scripts, FlatSigningProvider& out) const = 0;
866
867
public:
868
304k
    DescriptorImpl(std::vector<std::unique_ptr<PubkeyProvider>> pubkeys, const std::string& name) : m_pubkey_args(std::move(pubkeys)), m_name(name), m_subdescriptor_args() {}
869
23.4k
    DescriptorImpl(std::vector<std::unique_ptr<PubkeyProvider>> pubkeys, std::unique_ptr<DescriptorImpl> script, const std::string& name) : m_pubkey_args(std::move(pubkeys)), m_name(name), m_subdescriptor_args(Vector(std::move(script))) {}
870
7.14k
    DescriptorImpl(std::vector<std::unique_ptr<PubkeyProvider>> pubkeys, std::vector<std::unique_ptr<DescriptorImpl>> scripts, const std::string& name) : m_pubkey_args(std::move(pubkeys)), m_name(name), m_subdescriptor_args(std::move(scripts)) {}
871
872
    enum class StringType
873
    {
874
        PUBLIC,
875
        PRIVATE,
876
        NORMALIZED,
877
        COMPAT, // string calculation that mustn't change over time to stay compatible with previous software versions
878
    };
879
880
    // NOLINTNEXTLINE(misc-no-recursion)
881
    bool IsSolvable() const override
882
3.97k
    {
883
3.97k
        for (const auto& arg : m_subdescriptor_args) {
884
1.74k
            if (!arg->IsSolvable()) return false;
885
1.74k
        }
886
3.97k
        return true;
887
3.97k
    }
888
889
    // NOLINTNEXTLINE(misc-no-recursion)
890
    bool HavePrivateKeys(const SigningProvider& arg) const override
891
1.76k
    {
892
1.76k
        if (m_pubkey_args.empty() && m_subdescriptor_args.empty()) return false;
893
894
1.74k
        for (const auto& sub: m_subdescriptor_args) {
895
597
            if (!sub->HavePrivateKeys(arg)) return false;
896
597
        }
897
898
1.52k
        for (const auto& pubkey : m_pubkey_args) {
899
1.52k
            if (!pubkey->HavePrivateKeys(arg)) return false;
900
1.52k
        }
901
902
852
        return true;
903
1.40k
    }
904
905
    // NOLINTNEXTLINE(misc-no-recursion)
906
    bool IsRange() const final
907
461k
    {
908
461k
        for (const auto& pubkey : m_pubkey_args) {
909
430k
            if (pubkey->IsRange()) return true;
910
430k
        }
911
71.9k
        for (const auto& arg : m_subdescriptor_args) {
912
42.2k
            if (arg->IsRange()) return true;
913
42.2k
        }
914
32.4k
        return false;
915
71.9k
    }
916
917
    // NOLINTNEXTLINE(misc-no-recursion)
918
    virtual bool ToStringSubScriptHelper(const SigningProvider* arg, std::string& ret, const StringType type, const DescriptorCache* cache = nullptr) const
919
246k
    {
920
246k
        size_t pos = 0;
921
246k
        bool is_private{type == StringType::PRIVATE};
922
        // For private string output, track if at least one key has a private key available.
923
        // Initialize to true for non-private types.
924
246k
        bool any_success{!is_private};
925
246k
        for (const auto& scriptarg : m_subdescriptor_args) {
926
28.8k
            if (pos++) ret += ",";
927
28.8k
            std::string tmp;
928
28.8k
            bool subscript_res{scriptarg->ToStringHelper(arg, tmp, type, cache)};
929
28.8k
            if (!is_private && !subscript_res) return false;
930
28.8k
            any_success = any_success || subscript_res;
931
28.8k
            ret += tmp;
932
28.8k
        }
933
246k
        return any_success;
934
246k
    }
935
936
    // NOLINTNEXTLINE(misc-no-recursion)
937
    virtual bool ToStringHelper(const SigningProvider* arg, std::string& out, const StringType type, const DescriptorCache* cache = nullptr) const
938
256k
    {
939
256k
        std::string extra = ToStringExtra();
940
256k
        size_t pos = extra.size() > 0 ? 1 : 0;
941
256k
        std::string ret = m_name + "(" + extra;
942
256k
        bool is_private{type == StringType::PRIVATE};
943
        // For private string output, track if at least one key has a private key available.
944
        // Initialize to true for non-private types.
945
256k
        bool any_success{!is_private};
946
947
337k
        for (const auto& pubkey : m_pubkey_args) {
948
337k
            if (pos++) ret += ",";
949
337k
            std::string tmp;
950
337k
            switch (type) {
951
16.6k
                case StringType::NORMALIZED:
952
16.6k
                    if (!pubkey->ToNormalizedString(*arg, tmp, cache)) return false;
953
16.6k
                    break;
954
16.6k
                case StringType::PRIVATE:
955
1.46k
                    any_success = pubkey->ToPrivateString(*arg, tmp) || any_success;
956
1.46k
                    break;
957
301k
                case StringType::PUBLIC:
958
301k
                    tmp = pubkey->ToString();
959
301k
                    break;
960
17.5k
                case StringType::COMPAT:
961
17.5k
                    tmp = pubkey->ToString(PubkeyProvider::StringType::COMPAT);
962
17.5k
                    break;
963
337k
            }
964
337k
            ret += tmp;
965
337k
        }
966
256k
        std::string subscript;
967
256k
        bool subscript_res{ToStringSubScriptHelper(arg, subscript, type, cache)};
968
256k
        if (!is_private && !subscript_res) return false;
969
256k
        any_success = any_success || subscript_res;
970
256k
        if (pos && subscript.size()) ret += ',';
971
256k
        out = std::move(ret) + std::move(subscript) + ")";
972
256k
        return any_success;
973
256k
    }
974
975
    std::string ToString(bool compat_format) const final
976
210k
    {
977
210k
        std::string ret;
978
210k
        ToStringHelper(nullptr, ret, compat_format ? StringType::COMPAT : StringType::PUBLIC);
979
210k
        return AddChecksum(ret);
980
210k
    }
981
982
    bool ToPrivateString(const SigningProvider& arg, std::string& out) const override
983
1.13k
    {
984
1.13k
        bool has_priv_key{ToStringHelper(&arg, out, StringType::PRIVATE)};
985
1.13k
        out = AddChecksum(out);
986
1.13k
        return has_priv_key;
987
1.13k
    }
988
989
    bool ToNormalizedString(const SigningProvider& arg, std::string& out, const DescriptorCache* cache) const override final
990
12.3k
    {
991
12.3k
        bool ret = ToStringHelper(&arg, out, StringType::NORMALIZED, cache);
992
12.3k
        out = AddChecksum(out);
993
12.3k
        return ret;
994
12.3k
    }
995
996
    // NOLINTNEXTLINE(misc-no-recursion)
997
    bool ExpandHelper(int pos, const SigningProvider& arg, const DescriptorCache* read_cache, std::vector<CScript>& output_scripts, FlatSigningProvider& out, DescriptorCache* write_cache) const
998
776k
    {
999
776k
        FlatSigningProvider subprovider;
1000
776k
        std::vector<CPubKey> pubkeys;
1001
776k
        pubkeys.reserve(m_pubkey_args.size());
1002
1003
        // Construct temporary data in `pubkeys`, `subscripts`, and `subprovider` to avoid producing output in case of failure.
1004
1.72M
        for (const auto& p : m_pubkey_args) {
1005
1.72M
            std::optional<CPubKey> pubkey = p->GetPubKey(pos, arg, subprovider, read_cache, write_cache);
1006
1.72M
            if (!pubkey) return false;
1007
1.69M
            pubkeys.push_back(pubkey.value());
1008
1.69M
        }
1009
747k
        std::vector<CScript> subscripts;
1010
747k
        for (const auto& subarg : m_subdescriptor_args) {
1011
168k
            std::vector<CScript> outscripts;
1012
168k
            if (!subarg->ExpandHelper(pos, arg, read_cache, outscripts, subprovider, write_cache)) return false;
1013
168k
            assert(outscripts.size() == 1);
1014
167k
            subscripts.emplace_back(std::move(outscripts[0]));
1015
167k
        }
1016
745k
        out.Merge(std::move(subprovider));
1017
1018
745k
        output_scripts = MakeScripts(pubkeys, std::span{subscripts}, out);
1019
745k
        return true;
1020
747k
    }
1021
1022
    bool Expand(int pos, const SigningProvider& provider, std::vector<CScript>& output_scripts, FlatSigningProvider& out, DescriptorCache* write_cache = nullptr) const final
1023
54.7k
    {
1024
54.7k
        return ExpandHelper(pos, provider, nullptr, output_scripts, out, write_cache);
1025
54.7k
    }
1026
1027
    bool ExpandFromCache(int pos, const DescriptorCache& read_cache, std::vector<CScript>& output_scripts, FlatSigningProvider& out) const final
1028
552k
    {
1029
552k
        return ExpandHelper(pos, DUMMY_SIGNING_PROVIDER, &read_cache, output_scripts, out, nullptr);
1030
552k
    }
1031
1032
    // NOLINTNEXTLINE(misc-no-recursion)
1033
    void ExpandPrivate(int pos, const SigningProvider& provider, FlatSigningProvider& out) const final
1034
21.8k
    {
1035
65.7k
        for (const auto& p : m_pubkey_args) {
1036
65.7k
            p->GetPrivKey(pos, provider, out);
1037
65.7k
        }
1038
21.8k
        for (const auto& arg : m_subdescriptor_args) {
1039
5.49k
            arg->ExpandPrivate(pos, provider, out);
1040
5.49k
        }
1041
21.8k
    }
1042
1043
413
    std::optional<OutputType> GetOutputType() const override { return std::nullopt; }
1044
1045
0
    std::optional<int64_t> ScriptSize() const override { return {}; }
1046
1047
    /** A helper for MaxSatisfactionWeight.
1048
     *
1049
     * @param use_max_sig Whether to assume ECDSA signatures will have a high-r.
1050
     * @return The maximum size of the satisfaction in raw bytes (with no witness meaning).
1051
     */
1052
0
    virtual std::optional<int64_t> MaxSatSize(bool use_max_sig) const { return {}; }
1053
1054
18
    std::optional<int64_t> MaxSatisfactionWeight(bool) const override { return {}; }
1055
1056
4
    std::optional<int64_t> MaxSatisfactionElems() const override { return {}; }
1057
1058
    // NOLINTNEXTLINE(misc-no-recursion)
1059
    void GetPubKeys(std::set<CPubKey>& pubkeys, std::set<CExtPubKey>& ext_pubs) const override
1060
473
    {
1061
473
        for (const auto& p : m_pubkey_args) {
1062
393
            std::optional<CPubKey> pub = p->GetRootPubKey();
1063
393
            if (pub) pubkeys.insert(*pub);
1064
393
            std::optional<CExtPubKey> ext_pub = p->GetRootExtPubKey();
1065
393
            if (ext_pub) ext_pubs.insert(*ext_pub);
1066
393
        }
1067
473
        for (const auto& arg : m_subdescriptor_args) {
1068
83
            arg->GetPubKeys(pubkeys, ext_pubs);
1069
83
        }
1070
473
    }
1071
1072
    virtual std::unique_ptr<DescriptorImpl> Clone() const = 0;
1073
1074
1.20k
    bool HasScripts() const override { return true; }
1075
1076
    // NOLINTNEXTLINE(misc-no-recursion)
1077
1.38k
    std::vector<std::string> Warnings() const override {
1078
1.38k
        std::vector<std::string> all = m_warnings;
1079
1.38k
        for (const auto& sub : m_subdescriptor_args) {
1080
579
            auto sub_w = sub->Warnings();
1081
579
            all.insert(all.end(), sub_w.begin(), sub_w.end());
1082
579
        }
1083
1.38k
        return all;
1084
1.38k
    }
1085
1086
    uint32_t GetMaxKeyExpr() const final
1087
250
    {
1088
250
        uint32_t max_key_expr{0};
1089
250
        std::vector<const DescriptorImpl*> todo = {this};
1090
684
        while (!todo.empty()) {
1091
434
            const DescriptorImpl* desc = todo.back();
1092
434
            todo.pop_back();
1093
526
            for (const auto& p : desc->m_pubkey_args) {
1094
526
                max_key_expr = std::max(max_key_expr, p->m_expr_index);
1095
526
            }
1096
434
            for (const auto& s : desc->m_subdescriptor_args) {
1097
184
                todo.push_back(s.get());
1098
184
            }
1099
434
        }
1100
250
        return max_key_expr;
1101
250
    }
1102
1103
    size_t GetKeyCount() const final
1104
250
    {
1105
250
        size_t count{0};
1106
250
        std::vector<const DescriptorImpl*> todo = {this};
1107
684
        while (!todo.empty()) {
1108
434
            const DescriptorImpl* desc = todo.back();
1109
434
            todo.pop_back();
1110
526
            for (const auto& p : desc->m_pubkey_args) {
1111
526
                count += p->GetKeyCount();
1112
526
            }
1113
434
            for (const auto& s : desc->m_subdescriptor_args) {
1114
184
                todo.push_back(s.get());
1115
184
            }
1116
434
        }
1117
250
        return count;
1118
250
    }
1119
1120
    // NOLINTNEXTLINE(misc-no-recursion)
1121
    bool CanSelfExpand() const override
1122
1.71k
    {
1123
1.95k
        for (const auto& key : m_pubkey_args) {
1124
1.95k
            if (!key->CanSelfExpand()) return false;
1125
1.95k
        }
1126
1.60k
        for (const auto& sub : m_subdescriptor_args) {
1127
633
            if (!sub->CanSelfExpand()) return false;
1128
633
        }
1129
1.53k
        return true;
1130
1.60k
    }
1131
};
1132
1133
/** A parsed addr(A) descriptor. */
1134
class AddressDescriptor final : public DescriptorImpl
1135
{
1136
    const CTxDestination m_destination;
1137
protected:
1138
3.16k
    std::string ToStringExtra() const override { return EncodeDestination(m_destination); }
1139
130
    std::vector<CScript> MakeScripts(const std::vector<CPubKey>&, std::span<const CScript>, FlatSigningProvider&) const override { return Vector(GetScriptForDestination(m_destination)); }
1140
public:
1141
3.15k
    AddressDescriptor(CTxDestination destination) : DescriptorImpl({}, "addr"), m_destination(std::move(destination)) {}
1142
14
    bool IsSolvable() const final { return false; }
1143
1144
    std::optional<OutputType> GetOutputType() const override
1145
33
    {
1146
33
        return OutputTypeFromDestination(m_destination);
1147
33
    }
1148
78
    bool IsSingleType() const final { return true; }
1149
0
    bool ToPrivateString(const SigningProvider& arg, std::string& out) const final { return false; }
1150
1151
0
    std::optional<int64_t> ScriptSize() const override { return GetScriptForDestination(m_destination).size(); }
1152
    std::unique_ptr<DescriptorImpl> Clone() const override
1153
0
    {
1154
0
        return std::make_unique<AddressDescriptor>(m_destination);
1155
0
    }
1156
};
1157
1158
/** A parsed raw(H) descriptor. */
1159
class RawDescriptor final : public DescriptorImpl
1160
{
1161
    const CScript m_script;
1162
protected:
1163
2.12k
    std::string ToStringExtra() const override { return HexStr(m_script); }
1164
2.35k
    std::vector<CScript> MakeScripts(const std::vector<CPubKey>&, std::span<const CScript>, FlatSigningProvider&) const override { return Vector(m_script); }
1165
public:
1166
4.34k
    RawDescriptor(CScript script) : DescriptorImpl({}, "raw"), m_script(std::move(script)) {}
1167
0
    bool IsSolvable() const final { return false; }
1168
1169
    std::optional<OutputType> GetOutputType() const override
1170
5
    {
1171
5
        CTxDestination dest;
1172
5
        ExtractDestination(m_script, dest);
1173
5
        return OutputTypeFromDestination(dest);
1174
5
    }
1175
190
    bool IsSingleType() const final { return true; }
1176
0
    bool ToPrivateString(const SigningProvider& arg, std::string& out) const final { return false; }
1177
1178
0
    std::optional<int64_t> ScriptSize() const override { return m_script.size(); }
1179
1180
    std::unique_ptr<DescriptorImpl> Clone() const override
1181
0
    {
1182
0
        return std::make_unique<RawDescriptor>(m_script);
1183
0
    }
1184
};
1185
1186
/** A parsed pk(P) descriptor. */
1187
class PKDescriptor final : public DescriptorImpl
1188
{
1189
private:
1190
    const bool m_xonly;
1191
protected:
1192
    std::vector<CScript> MakeScripts(const std::vector<CPubKey>& keys, std::span<const CScript>, FlatSigningProvider&) const override
1193
29.9k
    {
1194
29.9k
        if (m_xonly) {
1195
29.6k
            CScript script = CScript() << ToByteVector(XOnlyPubKey(keys[0])) << OP_CHECKSIG;
1196
29.6k
            return Vector(std::move(script));
1197
29.6k
        } else {
1198
310
            return Vector(GetScriptForRawPubKey(keys[0]));
1199
310
        }
1200
29.9k
    }
1201
public:
1202
22.6k
    PKDescriptor(std::unique_ptr<PubkeyProvider> prov, bool xonly = false) : DescriptorImpl(Vector(std::move(prov)), "pk"), m_xonly(xonly) {}
1203
28
    bool IsSingleType() const final { return true; }
1204
1205
11
    std::optional<int64_t> ScriptSize() const override {
1206
11
        return 1 + (m_xonly ? 32 : m_pubkey_args[0]->GetSize()) + 1;
1207
11
    }
1208
1209
64
    std::optional<int64_t> MaxSatSize(bool use_max_sig) const override {
1210
64
        const auto ecdsa_sig_size = use_max_sig ? 72 : 71;
1211
64
        return 1 + (m_xonly ? 65 : ecdsa_sig_size);
1212
64
    }
1213
1214
58
    std::optional<int64_t> MaxSatisfactionWeight(bool use_max_sig) const override {
1215
58
        return *MaxSatSize(use_max_sig) * WITNESS_SCALE_FACTOR;
1216
58
    }
1217
1218
56
    std::optional<int64_t> MaxSatisfactionElems() const override { return 1; }
1219
1220
    std::unique_ptr<DescriptorImpl> Clone() const override
1221
15
    {
1222
15
        return std::make_unique<PKDescriptor>(m_pubkey_args.at(0)->Clone(), m_xonly);
1223
15
    }
1224
};
1225
1226
/** A parsed pkh(P) descriptor. */
1227
class PKHDescriptor final : public DescriptorImpl
1228
{
1229
protected:
1230
    std::vector<CScript> MakeScripts(const std::vector<CPubKey>& keys, std::span<const CScript>, FlatSigningProvider&) const override
1231
143k
    {
1232
143k
        CKeyID id = keys[0].GetID();
1233
143k
        return Vector(GetScriptForDestination(PKHash(id)));
1234
143k
    }
1235
public:
1236
87.7k
    PKHDescriptor(std::unique_ptr<PubkeyProvider> prov) : DescriptorImpl(Vector(std::move(prov)), "pkh") {}
1237
71.9k
    std::optional<OutputType> GetOutputType() const override { return OutputType::LEGACY; }
1238
68.2k
    bool IsSingleType() const final { return true; }
1239
1240
86
    std::optional<int64_t> ScriptSize() const override { return 1 + 1 + 1 + 20 + 1 + 1; }
1241
1242
50.3k
    std::optional<int64_t> MaxSatSize(bool use_max_sig) const override {
1243
50.3k
        const auto sig_size = use_max_sig ? 72 : 71;
1244
50.3k
        return 1 + sig_size + 1 + m_pubkey_args[0]->GetSize();
1245
50.3k
    }
1246
1247
50.2k
    std::optional<int64_t> MaxSatisfactionWeight(bool use_max_sig) const override {
1248
50.2k
        return *MaxSatSize(use_max_sig) * WITNESS_SCALE_FACTOR;
1249
50.2k
    }
1250
1251
50.3k
    std::optional<int64_t> MaxSatisfactionElems() const override { return 2; }
1252
1253
    std::unique_ptr<DescriptorImpl> Clone() const override
1254
0
    {
1255
0
        return std::make_unique<PKHDescriptor>(m_pubkey_args.at(0)->Clone());
1256
0
    }
1257
};
1258
1259
/** A parsed wpkh(P) descriptor. */
1260
class WPKHDescriptor final : public DescriptorImpl
1261
{
1262
protected:
1263
    std::vector<CScript> MakeScripts(const std::vector<CPubKey>& keys, std::span<const CScript>, FlatSigningProvider&) const override
1264
265k
    {
1265
265k
        CKeyID id = keys[0].GetID();
1266
265k
        return Vector(GetScriptForDestination(WitnessV0KeyHash(id)));
1267
265k
    }
1268
public:
1269
167k
    WPKHDescriptor(std::unique_ptr<PubkeyProvider> prov) : DescriptorImpl(Vector(std::move(prov)), "wpkh") {}
1270
150k
    std::optional<OutputType> GetOutputType() const override { return OutputType::BECH32; }
1271
151k
    bool IsSingleType() const final { return true; }
1272
1273
1.65k
    std::optional<int64_t> ScriptSize() const override { return 1 + 1 + 20; }
1274
1275
123k
    std::optional<int64_t> MaxSatSize(bool use_max_sig) const override {
1276
123k
        const auto sig_size = use_max_sig ? 72 : 71;
1277
123k
        return (1 + sig_size + 1 + 33);
1278
123k
    }
1279
1280
121k
    std::optional<int64_t> MaxSatisfactionWeight(bool use_max_sig) const override {
1281
121k
        return MaxSatSize(use_max_sig);
1282
121k
    }
1283
1284
123k
    std::optional<int64_t> MaxSatisfactionElems() const override { return 2; }
1285
1286
    std::unique_ptr<DescriptorImpl> Clone() const override
1287
0
    {
1288
0
        return std::make_unique<WPKHDescriptor>(m_pubkey_args.at(0)->Clone());
1289
0
    }
1290
};
1291
1292
/** A parsed combo(P) descriptor. */
1293
class ComboDescriptor final : public DescriptorImpl
1294
{
1295
protected:
1296
    std::vector<CScript> MakeScripts(const std::vector<CPubKey>& keys, std::span<const CScript>, FlatSigningProvider& out) const override
1297
19.5k
    {
1298
19.5k
        std::vector<CScript> ret;
1299
19.5k
        CKeyID id = keys[0].GetID();
1300
19.5k
        ret.emplace_back(GetScriptForRawPubKey(keys[0])); // P2PK
1301
19.5k
        ret.emplace_back(GetScriptForDestination(PKHash(id))); // P2PKH
1302
19.5k
        if (keys[0].IsCompressed()) {
1303
19.5k
            CScript p2wpkh = GetScriptForDestination(WitnessV0KeyHash(id));
1304
19.5k
            out.scripts.emplace(CScriptID(p2wpkh), p2wpkh);
1305
19.5k
            ret.emplace_back(p2wpkh);
1306
19.5k
            ret.emplace_back(GetScriptForDestination(ScriptHash(p2wpkh))); // P2SH-P2WPKH
1307
19.5k
        }
1308
19.5k
        return ret;
1309
19.5k
    }
1310
public:
1311
669
    ComboDescriptor(std::unique_ptr<PubkeyProvider> prov) : DescriptorImpl(Vector(std::move(prov)), "combo") {}
1312
22.8k
    bool IsSingleType() const final { return false; }
1313
    std::unique_ptr<DescriptorImpl> Clone() const override
1314
0
    {
1315
0
        return std::make_unique<ComboDescriptor>(m_pubkey_args.at(0)->Clone());
1316
0
    }
1317
};
1318
1319
/** A parsed multi(...) or sortedmulti(...) descriptor */
1320
class MultisigDescriptor final : public DescriptorImpl
1321
{
1322
    const int m_threshold;
1323
    const bool m_sorted;
1324
protected:
1325
1.09k
    std::string ToStringExtra() const override { return strprintf("%i", m_threshold); }
1326
18.6k
    std::vector<CScript> MakeScripts(const std::vector<CPubKey>& keys, std::span<const CScript>, FlatSigningProvider&) const override {
1327
18.6k
        if (m_sorted) {
1328
2.83k
            std::vector<CPubKey> sorted_keys(keys);
1329
2.83k
            std::sort(sorted_keys.begin(), sorted_keys.end());
1330
2.83k
            return Vector(GetScriptForMultisig(m_threshold, sorted_keys));
1331
2.83k
        }
1332
15.8k
        return Vector(GetScriptForMultisig(m_threshold, keys));
1333
18.6k
    }
1334
public:
1335
899
    MultisigDescriptor(int threshold, std::vector<std::unique_ptr<PubkeyProvider>> providers, bool sorted = false) : DescriptorImpl(std::move(providers), sorted ? "sortedmulti" : "multi"), m_threshold(threshold), m_sorted(sorted) {}
1336
12
    bool IsSingleType() const final { return true; }
1337
1338
237
    std::optional<int64_t> ScriptSize() const override {
1339
237
        const auto n_keys = m_pubkey_args.size();
1340
734
        auto op = [](int64_t acc, const std::unique_ptr<PubkeyProvider>& pk) { return acc + 1 + pk->GetSize();};
1341
237
        const auto pubkeys_size{std::accumulate(m_pubkey_args.begin(), m_pubkey_args.end(), int64_t{0}, op)};
1342
237
        return 1 + BuildScript(n_keys).size() + BuildScript(m_threshold).size() + pubkeys_size;
1343
237
    }
1344
1345
245
    std::optional<int64_t> MaxSatSize(bool use_max_sig) const override {
1346
245
        const auto sig_size = use_max_sig ? 72 : 71;
1347
245
        return (1 + (1 + sig_size) * m_threshold);
1348
245
    }
1349
1350
16
    std::optional<int64_t> MaxSatisfactionWeight(bool use_max_sig) const override {
1351
16
        return *MaxSatSize(use_max_sig) * WITNESS_SCALE_FACTOR;
1352
16
    }
1353
1354
222
    std::optional<int64_t> MaxSatisfactionElems() const override { return 1 + m_threshold; }
1355
1356
    std::unique_ptr<DescriptorImpl> Clone() const override
1357
0
    {
1358
0
        std::vector<std::unique_ptr<PubkeyProvider>> providers;
1359
0
        providers.reserve(m_pubkey_args.size());
1360
0
        std::transform(m_pubkey_args.begin(), m_pubkey_args.end(), std::back_inserter(providers), [](const std::unique_ptr<PubkeyProvider>& p) { return p->Clone(); });
1361
0
        return std::make_unique<MultisigDescriptor>(m_threshold, std::move(providers), m_sorted);
1362
0
    }
1363
};
1364
1365
/** A parsed (sorted)multi_a(...) descriptor. Always uses x-only pubkeys. */
1366
class MultiADescriptor final : public DescriptorImpl
1367
{
1368
    const int m_threshold;
1369
    const bool m_sorted;
1370
protected:
1371
802
    std::string ToStringExtra() const override { return strprintf("%i", m_threshold); }
1372
6.95k
    std::vector<CScript> MakeScripts(const std::vector<CPubKey>& keys, std::span<const CScript>, FlatSigningProvider&) const override {
1373
6.95k
        CScript ret;
1374
6.95k
        std::vector<XOnlyPubKey> xkeys;
1375
6.95k
        xkeys.reserve(keys.size());
1376
992k
        for (const auto& key : keys) xkeys.emplace_back(key);
1377
6.95k
        if (m_sorted) std::sort(xkeys.begin(), xkeys.end());
1378
6.95k
        ret << ToByteVector(xkeys[0]) << OP_CHECKSIG;
1379
992k
        for (size_t i = 1; i < keys.size(); ++i) {
1380
985k
            ret << ToByteVector(xkeys[i]) << OP_CHECKSIGADD;
1381
985k
        }
1382
6.95k
        ret << m_threshold << OP_NUMEQUAL;
1383
6.95k
        return Vector(std::move(ret));
1384
6.95k
    }
1385
public:
1386
904
    MultiADescriptor(int threshold, std::vector<std::unique_ptr<PubkeyProvider>> providers, bool sorted = false) : DescriptorImpl(std::move(providers), sorted ? "sortedmulti_a" : "multi_a"), m_threshold(threshold), m_sorted(sorted) {}
1387
0
    bool IsSingleType() const final { return true; }
1388
1389
0
    std::optional<int64_t> ScriptSize() const override {
1390
0
        const auto n_keys = m_pubkey_args.size();
1391
0
        return (1 + 32 + 1) * n_keys + BuildScript(m_threshold).size() + 1;
1392
0
    }
1393
1394
0
    std::optional<int64_t> MaxSatSize(bool use_max_sig) const override {
1395
0
        return (1 + 65) * m_threshold + (m_pubkey_args.size() - m_threshold);
1396
0
    }
1397
1398
0
    std::optional<int64_t> MaxSatisfactionElems() const override { return m_pubkey_args.size(); }
1399
1400
    std::unique_ptr<DescriptorImpl> Clone() const override
1401
0
    {
1402
0
        std::vector<std::unique_ptr<PubkeyProvider>> providers;
1403
0
        providers.reserve(m_pubkey_args.size());
1404
0
        for (const auto& arg : m_pubkey_args) {
1405
0
            providers.push_back(arg->Clone());
1406
0
        }
1407
0
        return std::make_unique<MultiADescriptor>(m_threshold, std::move(providers), m_sorted);
1408
0
    }
1409
};
1410
1411
/** A parsed sh(...) descriptor. */
1412
class SHDescriptor final : public DescriptorImpl
1413
{
1414
protected:
1415
    std::vector<CScript> MakeScripts(const std::vector<CPubKey>&, std::span<const CScript> scripts, FlatSigningProvider& out) const override
1416
112k
    {
1417
112k
        auto ret = Vector(GetScriptForDestination(ScriptHash(scripts[0])));
1418
112k
        if (ret.size()) out.scripts.emplace(CScriptID(scripts[0]), scripts[0]);
1419
112k
        return ret;
1420
112k
    }
1421
1422
7.99k
    bool IsSegwit() const { return m_subdescriptor_args[0]->GetOutputType() == OutputType::BECH32; }
1423
1424
public:
1425
22.3k
    SHDescriptor(std::unique_ptr<DescriptorImpl> desc) : DescriptorImpl({}, std::move(desc), "sh") {}
1426
1427
    std::optional<OutputType> GetOutputType() const override
1428
6.19k
    {
1429
6.19k
        assert(m_subdescriptor_args.size() == 1);
1430
6.19k
        if (IsSegwit()) return OutputType::P2SH_SEGWIT;
1431
122
        return OutputType::LEGACY;
1432
6.19k
    }
1433
22.3k
    bool IsSingleType() const final { return true; }
1434
1435
24
    std::optional<int64_t> ScriptSize() const override { return 1 + 1 + 20 + 1; }
1436
1437
1.79k
    std::optional<int64_t> MaxSatisfactionWeight(bool use_max_sig) const override {
1438
1.79k
        if (const auto sat_size = m_subdescriptor_args[0]->MaxSatSize(use_max_sig)) {
1439
1.79k
            if (const auto subscript_size = m_subdescriptor_args[0]->ScriptSize()) {
1440
                // The subscript is never witness data.
1441
1.79k
                const auto subscript_weight = (1 + *subscript_size) * WITNESS_SCALE_FACTOR;
1442
                // The weight depends on whether the inner descriptor is satisfied using the witness stack.
1443
1.79k
                if (IsSegwit()) return subscript_weight + *sat_size;
1444
58
                return subscript_weight + *sat_size * WITNESS_SCALE_FACTOR;
1445
1.79k
            }
1446
1.79k
        }
1447
0
        return {};
1448
1.79k
    }
1449
1450
1.77k
    std::optional<int64_t> MaxSatisfactionElems() const override {
1451
1.77k
        if (const auto sub_elems = m_subdescriptor_args[0]->MaxSatisfactionElems()) return 1 + *sub_elems;
1452
0
        return {};
1453
1.77k
    }
1454
1455
    std::unique_ptr<DescriptorImpl> Clone() const override
1456
0
    {
1457
0
        return std::make_unique<SHDescriptor>(m_subdescriptor_args.at(0)->Clone());
1458
0
    }
1459
};
1460
1461
/** A parsed wsh(...) descriptor. */
1462
class WSHDescriptor final : public DescriptorImpl
1463
{
1464
protected:
1465
    std::vector<CScript> MakeScripts(const std::vector<CPubKey>&, std::span<const CScript> scripts, FlatSigningProvider& out) const override
1466
17.1k
    {
1467
17.1k
        auto ret = Vector(GetScriptForDestination(WitnessV0ScriptHash(scripts[0])));
1468
17.1k
        if (ret.size()) out.scripts.emplace(CScriptID(scripts[0]), scripts[0]);
1469
17.1k
        return ret;
1470
17.1k
    }
1471
public:
1472
1.12k
    WSHDescriptor(std::unique_ptr<DescriptorImpl> desc) : DescriptorImpl({}, std::move(desc), "wsh") {}
1473
923
    std::optional<OutputType> GetOutputType() const override { return OutputType::BECH32; }
1474
1.89k
    bool IsSingleType() const final { return true; }
1475
1476
104
    std::optional<int64_t> ScriptSize() const override { return 1 + 1 + 32; }
1477
1478
405
    std::optional<int64_t> MaxSatSize(bool use_max_sig) const override {
1479
405
        if (const auto sat_size = m_subdescriptor_args[0]->MaxSatSize(use_max_sig)) {
1480
405
            if (const auto subscript_size = m_subdescriptor_args[0]->ScriptSize()) {
1481
405
                return GetSizeOfCompactSize(*subscript_size) + *subscript_size + *sat_size;
1482
405
            }
1483
405
        }
1484
0
        return {};
1485
405
    }
1486
1487
321
    std::optional<int64_t> MaxSatisfactionWeight(bool use_max_sig) const override {
1488
321
        return MaxSatSize(use_max_sig);
1489
321
    }
1490
1491
377
    std::optional<int64_t> MaxSatisfactionElems() const override {
1492
377
        if (const auto sub_elems = m_subdescriptor_args[0]->MaxSatisfactionElems()) return 1 + *sub_elems;
1493
0
        return {};
1494
377
    }
1495
1496
    std::unique_ptr<DescriptorImpl> Clone() const override
1497
0
    {
1498
0
        return std::make_unique<WSHDescriptor>(m_subdescriptor_args.at(0)->Clone());
1499
0
    }
1500
};
1501
1502
/** A parsed tr(...) descriptor. */
1503
class TRDescriptor final : public DescriptorImpl
1504
{
1505
    std::vector<int> m_depths;
1506
protected:
1507
    std::vector<CScript> MakeScripts(const std::vector<CPubKey>& keys, std::span<const CScript> scripts, FlatSigningProvider& out) const override
1508
125k
    {
1509
125k
        TaprootBuilder builder;
1510
125k
        assert(m_depths.size() == scripts.size());
1511
163k
        for (size_t pos = 0; pos < m_depths.size(); ++pos) {
1512
37.3k
            builder.Add(m_depths[pos], scripts[pos], TAPROOT_LEAF_TAPSCRIPT);
1513
37.3k
        }
1514
125k
        if (!builder.IsComplete()) return {};
1515
125k
        assert(keys.size() == 1);
1516
125k
        XOnlyPubKey xpk(keys[0]);
1517
125k
        if (!xpk.IsFullyValid()) return {};
1518
125k
        builder.Finalize(xpk);
1519
125k
        WitnessV1Taproot output = builder.GetOutput();
1520
125k
        out.tr_trees[output] = builder;
1521
125k
        return Vector(GetScriptForDestination(output));
1522
125k
    }
1523
    bool ToStringSubScriptHelper(const SigningProvider* arg, std::string& ret, const StringType type, const DescriptorCache* cache = nullptr) const override
1524
9.94k
    {
1525
9.94k
        if (m_depths.empty()) {
1526
            // If there are no sub-descriptors and a PRIVATE string
1527
            // is requested, return `false` to indicate that the presence
1528
            // of a private key depends solely on the internal key (which is checked
1529
            // in the caller), not on any sub-descriptor. This ensures correct behavior for
1530
            // descriptors like tr(internal_key) when checking for private keys.
1531
7.50k
            return type != StringType::PRIVATE;
1532
7.50k
        }
1533
2.43k
        std::vector<bool> path;
1534
2.43k
        bool is_private{type == StringType::PRIVATE};
1535
        // For private string output, track if at least one key has a private key available.
1536
        // Initialize to true for non-private types.
1537
2.43k
        bool any_success{!is_private};
1538
1539
7.70k
        for (size_t pos = 0; pos < m_depths.size(); ++pos) {
1540
5.27k
            if (pos) ret += ',';
1541
10.5k
            while ((int)path.size() <= m_depths[pos]) {
1542
5.27k
                if (path.size()) ret += '{';
1543
5.27k
                path.push_back(false);
1544
5.27k
            }
1545
5.27k
            std::string tmp;
1546
5.27k
            bool subscript_res{m_subdescriptor_args[pos]->ToStringHelper(arg, tmp, type, cache)};
1547
5.27k
            if (!is_private && !subscript_res) return false;
1548
5.27k
            any_success = any_success || subscript_res;
1549
5.27k
            ret += tmp;
1550
8.10k
            while (!path.empty() && path.back()) {
1551
2.83k
                if (path.size() > 1) ret += '}';
1552
2.83k
                path.pop_back();
1553
2.83k
            }
1554
5.27k
            if (!path.empty()) path.back() = true;
1555
5.27k
        }
1556
2.43k
        return any_success;
1557
2.43k
    }
1558
public:
1559
    TRDescriptor(std::unique_ptr<PubkeyProvider> internal_key, std::vector<std::unique_ptr<DescriptorImpl>> descs, std::vector<int> depths) :
1560
7.14k
        DescriptorImpl(Vector(std::move(internal_key)), std::move(descs), "tr"), m_depths(std::move(depths))
1561
7.14k
    {
1562
7.14k
        assert(m_subdescriptor_args.size() == m_depths.size());
1563
7.14k
    }
1564
9.30k
    std::optional<OutputType> GetOutputType() const override { return OutputType::BECH32M; }
1565
23.2k
    bool IsSingleType() const final { return true; }
1566
1567
32
    std::optional<int64_t> ScriptSize() const override { return 1 + 1 + 32; }
1568
1569
4.02k
    std::optional<int64_t> MaxSatisfactionWeight(bool) const override {
1570
        // FIXME: We assume keypath spend, which can lead to very large underestimations.
1571
4.02k
        return 1 + 65;
1572
4.02k
    }
1573
1574
3.99k
    std::optional<int64_t> MaxSatisfactionElems() const override {
1575
        // FIXME: See above, we assume keypath spend.
1576
3.99k
        return 1;
1577
3.99k
    }
1578
1579
    std::unique_ptr<DescriptorImpl> Clone() const override
1580
0
    {
1581
0
        std::vector<std::unique_ptr<DescriptorImpl>> subdescs;
1582
0
        subdescs.reserve(m_subdescriptor_args.size());
1583
0
        std::transform(m_subdescriptor_args.begin(), m_subdescriptor_args.end(), std::back_inserter(subdescs), [](const std::unique_ptr<DescriptorImpl>& d) { return d->Clone(); });
1584
0
        return std::make_unique<TRDescriptor>(m_pubkey_args.at(0)->Clone(), std::move(subdescs), m_depths);
1585
0
    }
1586
};
1587
1588
/* We instantiate Miniscript here with a simple integer as key type.
1589
 * The value of these key integers are an index in the
1590
 * DescriptorImpl::m_pubkey_args vector.
1591
 */
1592
1593
/**
1594
 * The context for converting a Miniscript descriptor into a Script.
1595
 */
1596
class ScriptMaker {
1597
    //! Keys contained in the Miniscript (the evaluation of DescriptorImpl::m_pubkey_args).
1598
    const std::vector<CPubKey>& m_keys;
1599
    //! The script context we're operating within (Tapscript or P2WSH).
1600
    const miniscript::MiniscriptContext m_script_ctx;
1601
1602
    //! Get the ripemd160(sha256()) hash of this key.
1603
    //! Any key that is valid in a descriptor serializes as 32 bytes within a Tapscript context. So we
1604
    //! must not hash the sign-bit byte in this case.
1605
512
    uint160 GetHash160(uint32_t key) const {
1606
512
        if (miniscript::IsTapscript(m_script_ctx)) {
1607
241
            return Hash160(XOnlyPubKey{m_keys[key]});
1608
241
        }
1609
271
        return m_keys[key].GetID();
1610
512
    }
1611
1612
public:
1613
1.66k
    ScriptMaker(const std::vector<CPubKey>& keys LIFETIMEBOUND, const miniscript::MiniscriptContext script_ctx) : m_keys(keys), m_script_ctx{script_ctx} {}
1614
1615
3.14k
    std::vector<unsigned char> ToPKBytes(uint32_t key) const {
1616
        // In Tapscript keys always serialize as x-only, whether an x-only key was used in the descriptor or not.
1617
3.14k
        if (!miniscript::IsTapscript(m_script_ctx)) {
1618
2.04k
            return {m_keys[key].begin(), m_keys[key].end()};
1619
2.04k
        }
1620
1.09k
        const XOnlyPubKey xonly_pubkey{m_keys[key]};
1621
1.09k
        return {xonly_pubkey.begin(), xonly_pubkey.end()};
1622
3.14k
    }
1623
1624
512
    std::vector<unsigned char> ToPKHBytes(uint32_t key) const {
1625
512
        auto id = GetHash160(key);
1626
512
        return {id.begin(), id.end()};
1627
512
    }
1628
};
1629
1630
/**
1631
 * The context for converting a Miniscript descriptor to its textual form.
1632
 */
1633
class StringMaker {
1634
    //! To convert private keys for private descriptors.
1635
    const SigningProvider* m_arg;
1636
    //! Keys contained in the Miniscript (a reference to DescriptorImpl::m_pubkey_args).
1637
    const std::vector<std::unique_ptr<PubkeyProvider>>& m_pubkeys;
1638
    //! StringType to serialize keys
1639
    const DescriptorImpl::StringType m_type;
1640
    const DescriptorCache* m_cache;
1641
1642
public:
1643
    StringMaker(const SigningProvider* arg LIFETIMEBOUND,
1644
                const std::vector<std::unique_ptr<PubkeyProvider>>& pubkeys LIFETIMEBOUND,
1645
                DescriptorImpl::StringType type,
1646
                const DescriptorCache* cache LIFETIMEBOUND)
1647
1.17k
        : m_arg(arg), m_pubkeys(pubkeys), m_type(type), m_cache(cache) {}
1648
1649
    std::optional<std::string> ToString(uint32_t key, bool& has_priv_key) const
1650
5.48k
    {
1651
5.48k
        std::string ret;
1652
5.48k
        has_priv_key = false;
1653
5.48k
        switch (m_type) {
1654
4.24k
        case DescriptorImpl::StringType::PUBLIC:
1655
4.24k
            ret = m_pubkeys[key]->ToString();
1656
4.24k
            break;
1657
258
        case DescriptorImpl::StringType::PRIVATE:
1658
258
            has_priv_key = m_pubkeys[key]->ToPrivateString(*m_arg, ret);
1659
258
            break;
1660
560
        case DescriptorImpl::StringType::NORMALIZED:
1661
560
            if (!m_pubkeys[key]->ToNormalizedString(*m_arg, ret, m_cache)) return {};
1662
560
            break;
1663
560
        case DescriptorImpl::StringType::COMPAT:
1664
418
            ret = m_pubkeys[key]->ToString(PubkeyProvider::StringType::COMPAT);
1665
418
            break;
1666
5.48k
        }
1667
5.48k
        return ret;
1668
5.48k
    }
1669
};
1670
1671
class MiniscriptDescriptor final : public DescriptorImpl
1672
{
1673
private:
1674
    miniscript::Node<uint32_t> m_node;
1675
1676
protected:
1677
    std::vector<CScript> MakeScripts(const std::vector<CPubKey>& keys, std::span<const CScript> scripts,
1678
                                     FlatSigningProvider& provider) const override
1679
1.66k
    {
1680
1.66k
        const auto script_ctx{m_node.GetMsCtx()};
1681
3.65k
        for (const auto& key : keys) {
1682
3.65k
            if (miniscript::IsTapscript(script_ctx)) {
1683
1.34k
                provider.pubkeys.emplace(Hash160(XOnlyPubKey{key}), key);
1684
2.31k
            } else {
1685
2.31k
                provider.pubkeys.emplace(key.GetID(), key);
1686
2.31k
            }
1687
3.65k
        }
1688
1.66k
        return Vector(m_node.ToScript(ScriptMaker(keys, script_ctx)));
1689
1.66k
    }
1690
1691
public:
1692
    MiniscriptDescriptor(std::vector<std::unique_ptr<PubkeyProvider>> providers, miniscript::Node<uint32_t>&& node)
1693
875
        : DescriptorImpl(std::move(providers), "?"), m_node(std::move(node))
1694
875
    {
1695
        // Traverse miniscript tree for unsafe use of older()
1696
996k
        miniscript::ForEachNode(m_node, [&](const miniscript::Node<uint32_t>& node) {
1697
996k
            if (node.Fragment() == miniscript::Fragment::OLDER) {
1698
251
                const uint32_t raw = node.K();
1699
251
                const uint32_t value_part = raw & ~CTxIn::SEQUENCE_LOCKTIME_TYPE_FLAG;
1700
251
                if (value_part > CTxIn::SEQUENCE_LOCKTIME_MASK) {
1701
4
                    const bool is_time_based = (raw & CTxIn::SEQUENCE_LOCKTIME_TYPE_FLAG) != 0;
1702
4
                    if (is_time_based) {
1703
2
                        m_warnings.push_back(strprintf("time-based relative locktime: older(%u) > (65535 * 512) seconds is unsafe", raw));
1704
2
                    } else {
1705
2
                        m_warnings.push_back(strprintf("height-based relative locktime: older(%u) > 65535 blocks is unsafe", raw));
1706
2
                    }
1707
4
                }
1708
251
            }
1709
996k
        });
1710
875
    }
1711
1712
    bool ToStringHelper(const SigningProvider* arg, std::string& out, const StringType type,
1713
                        const DescriptorCache* cache = nullptr) const override
1714
1.17k
    {
1715
1.17k
        bool has_priv_key{false};
1716
1.17k
        auto res = m_node.ToString(StringMaker(arg, m_pubkey_args, type, cache), has_priv_key);
1717
1.17k
        if (res) out = *res;
1718
1.17k
        if (type == StringType::PRIVATE) {
1719
99
            Assume(res.has_value());
1720
99
            return has_priv_key;
1721
1.08k
        } else {
1722
1.08k
            return res.has_value();
1723
1.08k
        }
1724
1.17k
    }
1725
1726
403
    bool IsSolvable() const override { return true; }
1727
0
    bool IsSingleType() const final { return true; }
1728
1729
154
    std::optional<int64_t> ScriptSize() const override { return m_node.ScriptSize(); }
1730
1731
    std::optional<int64_t> MaxSatSize(bool) const override
1732
154
    {
1733
        // For Miniscript we always assume high-R ECDSA signatures.
1734
154
        return m_node.GetWitnessSize();
1735
154
    }
1736
1737
    std::optional<int64_t> MaxSatisfactionElems() const override
1738
136
    {
1739
136
        return m_node.GetStackSize();
1740
136
    }
1741
1742
    std::unique_ptr<DescriptorImpl> Clone() const override
1743
5
    {
1744
5
        std::vector<std::unique_ptr<PubkeyProvider>> providers;
1745
5
        providers.reserve(m_pubkey_args.size());
1746
5
        for (const auto& arg : m_pubkey_args) {
1747
5
            providers.push_back(arg->Clone());
1748
5
        }
1749
5
        return std::make_unique<MiniscriptDescriptor>(std::move(providers), m_node.Clone());
1750
5
    }
1751
};
1752
1753
/** A parsed rawtr(...) descriptor. */
1754
class RawTRDescriptor final : public DescriptorImpl
1755
{
1756
protected:
1757
    std::vector<CScript> MakeScripts(const std::vector<CPubKey>& keys, std::span<const CScript> scripts, FlatSigningProvider& out) const override
1758
1.60k
    {
1759
1.60k
        assert(keys.size() == 1);
1760
1.60k
        XOnlyPubKey xpk(keys[0]);
1761
1.60k
        if (!xpk.IsFullyValid()) return {};
1762
1.60k
        WitnessV1Taproot output{xpk};
1763
1.60k
        return Vector(GetScriptForDestination(output));
1764
1.60k
    }
1765
public:
1766
15.4k
    RawTRDescriptor(std::unique_ptr<PubkeyProvider> output_key) : DescriptorImpl(Vector(std::move(output_key)), "rawtr") {}
1767
369
    std::optional<OutputType> GetOutputType() const override { return OutputType::BECH32M; }
1768
587
    bool IsSingleType() const final { return true; }
1769
1770
15
    std::optional<int64_t> ScriptSize() const override { return 1 + 1 + 32; }
1771
1772
187
    std::optional<int64_t> MaxSatisfactionWeight(bool) const override {
1773
        // We can't know whether there is a script path, so assume key path spend.
1774
187
        return 1 + 65;
1775
187
    }
1776
1777
172
    std::optional<int64_t> MaxSatisfactionElems() const override {
1778
        // See above, we assume keypath spend.
1779
172
        return 1;
1780
172
    }
1781
1782
    std::unique_ptr<DescriptorImpl> Clone() const override
1783
0
    {
1784
0
        return std::make_unique<RawTRDescriptor>(m_pubkey_args.at(0)->Clone());
1785
0
    }
1786
};
1787
1788
/** A parsed unused(KEY) descriptor */
1789
class UnusedDescriptor final : public DescriptorImpl
1790
{
1791
protected:
1792
12
    std::vector<CScript> MakeScripts(const std::vector<CPubKey>& keys, std::span<const CScript> scripts, FlatSigningProvider& out) const override { return {}; }
1793
public:
1794
18
    UnusedDescriptor(std::unique_ptr<PubkeyProvider> prov) : DescriptorImpl(Vector(std::move(prov)), "unused") {}
1795
16
    bool IsSingleType() const final { return true; }
1796
27
    bool HasScripts() const override { return false; }
1797
1798
    std::unique_ptr<DescriptorImpl> Clone() const override
1799
0
    {
1800
0
        return std::make_unique<UnusedDescriptor>(m_pubkey_args.at(0)->Clone());
1801
0
    }
1802
};
1803
1804
1805
////////////////////////////////////////////////////////////////////////////
1806
// Parser                                                                 //
1807
////////////////////////////////////////////////////////////////////////////
1808
1809
enum class ParseScriptContext {
1810
    TOP,     //!< Top-level context (script goes directly in scriptPubKey)
1811
    P2SH,    //!< Inside sh() (script becomes P2SH redeemScript)
1812
    P2WPKH,  //!< Inside wpkh() (no script, pubkey only)
1813
    P2WSH,   //!< Inside wsh() (script becomes v0 witness script)
1814
    P2TR,    //!< Inside tr() (either internal key, or BIP342 script leaf)
1815
    MUSIG,   //!< Inside musig() (implies P2TR, cannot have nested musig())
1816
};
1817
1818
/**
1819
 * Parse a key path, being passed a split list of elements (the first element is ignored because it is always the key).
1820
 *
1821
 * @param[in] split BIP32 path string, using either ' or h for hardened derivation
1822
 * @param[out] out Vector of parsed key paths
1823
 * @param[out] apostrophe only updated if hardened derivation is found
1824
 * @param[out] error parsing error message
1825
 * @param[in] allow_multipath Allows the parsed path to use the multipath specifier
1826
 * @param[out] has_hardened Records whether the path contains any hardened derivation
1827
 * @returns false if parsing failed
1828
 **/
1829
[[nodiscard]] bool ParseKeyPath(const std::vector<std::span<const char>>& split, std::vector<KeyPath>& out, bool& apostrophe, std::string& error, bool allow_multipath, bool& has_hardened)
1830
13.9k
{
1831
30.3k
    auto parse_elem = [&](std::span<const char> elem) -> std::optional<uint32_t> {
1832
30.3k
        const auto parsed{ParseKeyPathElement(elem)};
1833
30.3k
        if (!parsed) {
1834
16
            error = parsed.error();
1835
16
            return std::nullopt;
1836
16
        }
1837
30.2k
        if (parsed->is_hardened) {
1838
21.8k
            has_hardened = true;
1839
21.8k
            apostrophe = elem.back() == '\'';
1840
21.8k
        }
1841
30.2k
        return parsed->ChildNumber();
1842
30.3k
    };
1843
1844
13.9k
    KeyPath path;
1845
13.9k
    struct MultipathSubstitutes {
1846
13.9k
        size_t placeholder_index;
1847
13.9k
        std::vector<uint32_t> values;
1848
13.9k
    };
1849
13.9k
    std::optional<MultipathSubstitutes> substitutes;
1850
13.9k
    has_hardened = false;
1851
1852
43.7k
    for (size_t i = 1; i < split.size(); ++i) {
1853
29.8k
        const std::span<const char>& elem = split[i];
1854
1855
        // Check if element contains multipath specifier
1856
29.8k
        if (!elem.empty() && elem.front() == '<' && elem.back() == '>') {
1857
332
            if (!allow_multipath) {
1858
2
                error = strprintf("Key path value '%s' specifies multipath in a section where multipath is not allowed", std::string(elem.begin(), elem.end()));
1859
2
                return false;
1860
2
            }
1861
330
            if (substitutes) {
1862
2
                error = "Multiple multipath key path specifiers found";
1863
2
                return false;
1864
2
            }
1865
1866
            // Parse each possible value
1867
328
            std::vector<std::span<const char>> nums = Split(std::span(elem.begin()+1, elem.end()-1), ";");
1868
328
            if (nums.size() < 2) {
1869
4
                error = "Multipath key path specifiers must have at least two items";
1870
4
                return false;
1871
4
            }
1872
1873
324
            substitutes.emplace();
1874
324
            std::unordered_set<uint32_t> seen_substitutes;
1875
763
            for (const auto& num : nums) {
1876
763
                const auto& op_num = parse_elem(num);
1877
763
                if (!op_num) return false;
1878
757
                auto [_, inserted] = seen_substitutes.insert(*op_num);
1879
757
                if (!inserted) {
1880
2
                    error = strprintf("Duplicated key path value %u in multipath specifier", *op_num);
1881
2
                    return false;
1882
2
                }
1883
755
                substitutes->values.emplace_back(*op_num);
1884
755
            }
1885
1886
316
            path.emplace_back(); // Placeholder for multipath segment
1887
316
            substitutes->placeholder_index = path.size() - 1;
1888
29.5k
        } else {
1889
29.5k
            const auto& op_num = parse_elem(elem);
1890
29.5k
            if (!op_num) return false;
1891
29.5k
            path.emplace_back(*op_num);
1892
29.5k
        }
1893
29.8k
    }
1894
1895
13.9k
    if (!substitutes) {
1896
13.5k
        out.emplace_back(std::move(path));
1897
13.5k
    } else {
1898
        // Replace the multipath placeholder with each value while generating paths
1899
743
        for (uint32_t substitute : substitutes->values) {
1900
743
            KeyPath branch_path = path;
1901
743
            branch_path[substitutes->placeholder_index] = substitute;
1902
743
            out.emplace_back(std::move(branch_path));
1903
743
        }
1904
314
    }
1905
13.9k
    return true;
1906
13.9k
}
1907
1908
[[nodiscard]] bool ParseKeyPath(const std::vector<std::span<const char>>& split, std::vector<KeyPath>& out, bool& apostrophe, std::string& error, bool allow_multipath)
1909
13.8k
{
1910
13.8k
    bool dummy;
1911
13.8k
    return ParseKeyPath(split, out, apostrophe, error, allow_multipath, /*has_hardened=*/dummy);
1912
13.8k
}
1913
1914
static DeriveType ParseDeriveType(std::vector<std::span<const char>>& split, bool& apostrophe)
1915
8.72k
{
1916
8.72k
    DeriveType type = DeriveType::NON_RANGED;
1917
8.72k
    if (std::ranges::equal(split.back(), std::span{"*"}.first(1))) {
1918
7.96k
        split.pop_back();
1919
7.96k
        type = DeriveType::UNHARDENED_RANGED;
1920
7.96k
    } else if (std::ranges::equal(split.back(), std::span{"*'"}.first(2)) || std::ranges::equal(split.back(), std::span{"*h"}.first(2))) {
1921
202
        apostrophe = std::ranges::equal(split.back(), std::span{"*'"}.first(2));
1922
202
        split.pop_back();
1923
202
        type = DeriveType::HARDENED_RANGED;
1924
202
    }
1925
8.72k
    return type;
1926
8.72k
}
1927
1928
/** Parse a public key that excludes origin information. */
1929
std::vector<std::unique_ptr<PubkeyProvider>> ParsePubkeyInner(uint32_t& key_exp_index, const std::span<const char>& sp, ParseScriptContext ctx, FlatSigningProvider& out, bool& apostrophe, std::string& error)
1930
28.7k
{
1931
28.7k
    std::vector<std::unique_ptr<PubkeyProvider>> ret;
1932
28.7k
    bool permit_uncompressed = ctx == ParseScriptContext::TOP || ctx == ParseScriptContext::P2SH;
1933
28.7k
    auto split = Split(sp, '/');
1934
28.7k
    std::string str(split[0].begin(), split[0].end());
1935
28.7k
    if (str.size() == 0) {
1936
4
        error = "No key provided";
1937
4
        return {};
1938
4
    }
1939
28.7k
    if (IsSpace(str.front()) || IsSpace(str.back())) {
1940
11
        error = strprintf("Key '%s' is invalid due to whitespace", str);
1941
11
        return {};
1942
11
    }
1943
28.7k
    if (split.size() == 1) {
1944
20.4k
        if (IsHex(str)) {
1945
19.6k
            std::vector<unsigned char> data = ParseHex(str);
1946
19.6k
            CPubKey pubkey(data);
1947
19.6k
            if (pubkey.IsValid() && !pubkey.IsValidNonHybrid()) {
1948
4
                error = "Hybrid public keys are not allowed";
1949
4
                return {};
1950
4
            }
1951
19.6k
            if (pubkey.IsFullyValid()) {
1952
1.08k
                if (permit_uncompressed || pubkey.IsCompressed()) {
1953
1.08k
                    ret.emplace_back(std::make_unique<ConstPubkeyProvider>(key_exp_index, pubkey, false));
1954
1.08k
                    ++key_exp_index;
1955
1.08k
                    return ret;
1956
1.08k
                } else {
1957
4
                    error = "Uncompressed keys are not allowed";
1958
4
                    return {};
1959
4
                }
1960
18.5k
            } else if (data.size() == 32 && ctx == ParseScriptContext::P2TR) {
1961
18.5k
                unsigned char fullkey[33] = {0x02};
1962
18.5k
                std::copy(data.begin(), data.end(), fullkey + 1);
1963
18.5k
                pubkey.Set(std::begin(fullkey), std::end(fullkey));
1964
18.5k
                if (pubkey.IsFullyValid()) {
1965
18.5k
                    ret.emplace_back(std::make_unique<ConstPubkeyProvider>(key_exp_index, pubkey, true));
1966
18.5k
                    ++key_exp_index;
1967
18.5k
                    return ret;
1968
18.5k
                }
1969
18.5k
            }
1970
2
            error = strprintf("Pubkey '%s' is invalid", str);
1971
2
            return {};
1972
19.6k
        }
1973
792
        CKey key = DecodeSecret(str);
1974
792
        if (key.IsValid()) {
1975
463
            if (permit_uncompressed || key.IsCompressed()) {
1976
458
                CPubKey pubkey = key.GetPubKey();
1977
458
                out.keys.emplace(pubkey.GetID(), key);
1978
458
                ret.emplace_back(std::make_unique<ConstPubkeyProvider>(key_exp_index, pubkey, ctx == ParseScriptContext::P2TR));
1979
458
                ++key_exp_index;
1980
458
                return ret;
1981
458
            } else {
1982
5
                error = "Uncompressed keys are not allowed";
1983
5
                return {};
1984
5
            }
1985
463
        }
1986
792
    }
1987
8.61k
    CExtKey extkey = DecodeExtKey(str);
1988
8.61k
    CExtPubKey extpubkey = DecodeExtPubKey(str);
1989
8.61k
    if (!extkey.key.IsValid() && !extpubkey.pubkey.IsValid()) {
1990
3
        error = strprintf("key '%s' is not valid", str);
1991
3
        return {};
1992
3
    }
1993
8.60k
    std::vector<KeyPath> paths;
1994
8.60k
    DeriveType type = ParseDeriveType(split, apostrophe);
1995
8.60k
    if (!ParseKeyPath(split, paths, apostrophe, error, /*allow_multipath=*/true)) return {};
1996
8.58k
    if (extkey.key.IsValid()) {
1997
888
        extpubkey = extkey.Neuter();
1998
888
        out.keys.emplace(extpubkey.pubkey.GetID(), extkey.key);
1999
888
    }
2000
8.94k
    for (auto& path : paths) {
2001
8.94k
        ret.emplace_back(std::make_unique<BIP32PubkeyProvider>(key_exp_index, extpubkey, std::move(path), type, apostrophe));
2002
8.94k
    }
2003
8.58k
    ++key_exp_index;
2004
8.58k
    return ret;
2005
8.60k
}
2006
2007
/** Parse a public key including origin information (if enabled). */
2008
// NOLINTNEXTLINE(misc-no-recursion)
2009
std::vector<std::unique_ptr<PubkeyProvider>> ParsePubkey(uint32_t& key_exp_index, const std::span<const char>& sp, ParseScriptContext ctx, FlatSigningProvider& out, std::string& error)
2010
28.9k
{
2011
28.9k
    std::vector<std::unique_ptr<PubkeyProvider>> ret;
2012
2013
28.9k
    using namespace script;
2014
2015
    // musig cannot be nested inside of an origin
2016
28.9k
    std::span<const char> span = sp;
2017
28.9k
    if (Const("musig(", span, /*skip=*/false)) {
2018
186
        if (ctx != ParseScriptContext::P2TR) {
2019
12
            error = "musig() is only allowed in tr() and rawtr()";
2020
12
            return {};
2021
12
        }
2022
2023
        // Split the span on the end parentheses. The end parentheses must
2024
        // be included in the resulting span so that Expr is happy.
2025
174
        auto split = Split(sp, ')', /*include_sep=*/true);
2026
174
        if (split.size() > 2) {
2027
2
            error = "Too many ')' in musig() expression";
2028
2
            return {};
2029
2
        }
2030
172
        std::span<const char> expr(split.at(0).begin(), split.at(0).end());
2031
172
        if (!Func("musig", expr)) {
2032
0
            error = "Invalid musig() expression";
2033
0
            return {};
2034
0
        }
2035
2036
        // Parse the participant pubkeys
2037
172
        bool any_ranged = false;
2038
172
        bool all_bip32 = true;
2039
172
        std::vector<std::vector<std::unique_ptr<PubkeyProvider>>> providers;
2040
172
        bool any_key_parsed = false;
2041
172
        size_t max_multipath_len = 0;
2042
615
        while (expr.size()) {
2043
443
            if (any_key_parsed && !Const(",", expr)) {
2044
0
                error = strprintf("musig(): expected ',', got '%c'", expr[0]);
2045
0
                return {};
2046
0
            }
2047
443
            auto arg = Expr(expr);
2048
443
            auto pk = ParsePubkey(key_exp_index, arg, ParseScriptContext::MUSIG, out, error);
2049
443
            if (pk.empty()) {
2050
0
                error = strprintf("musig(): %s", error);
2051
0
                return {};
2052
0
            }
2053
443
            any_key_parsed = true;
2054
2055
443
            any_ranged = any_ranged || pk.at(0)->IsRange();
2056
443
            all_bip32 = all_bip32 &&  pk.at(0)->IsBIP32();
2057
2058
443
            max_multipath_len = std::max(max_multipath_len, pk.size());
2059
2060
443
            providers.emplace_back(std::move(pk));
2061
443
        }
2062
172
        if (!any_key_parsed) {
2063
2
            error = "musig(): Must contain key expressions";
2064
2
            return {};
2065
2
        }
2066
2067
        // Parse any derivation
2068
170
        DeriveType deriv_type = DeriveType::NON_RANGED;
2069
170
        std::vector<KeyPath> derivation_multipaths;
2070
170
        if (split.size() == 2 && Const("/", split.at(1), /*skip=*/false)) {
2071
127
            if (!all_bip32) {
2072
4
                error = "musig(): derivation requires all participants to be xpubs or xprvs";
2073
4
                return {};
2074
4
            }
2075
123
            if (any_ranged) {
2076
4
                error = "musig(): Cannot have ranged participant keys if musig() also has derivation";
2077
4
                return {};
2078
4
            }
2079
119
            bool dummy = false;
2080
119
            auto deriv_split = Split(split.at(1), '/');
2081
119
            deriv_type = ParseDeriveType(deriv_split, dummy);
2082
119
            if (deriv_type == DeriveType::HARDENED_RANGED) {
2083
2
                error = "musig(): Cannot have hardened child derivation";
2084
2
                return {};
2085
2
            }
2086
117
            bool has_hardened = false;
2087
117
            if (!ParseKeyPath(deriv_split, derivation_multipaths, dummy, error, /*allow_multipath=*/true, has_hardened)) {
2088
0
                error = "musig(): " + error;
2089
0
                return {};
2090
0
            }
2091
117
            if (has_hardened) {
2092
2
                error = "musig(): cannot have hardened derivation steps";
2093
2
                return {};
2094
2
            }
2095
117
        } else {
2096
43
            derivation_multipaths.emplace_back();
2097
43
        }
2098
2099
        // Makes sure that all providers vectors in providers are the given length, or exactly length 1
2100
        // Length 1 vectors have the single provider cloned until it matches the given length.
2101
158
        const auto& clone_providers = [&providers](size_t length) -> bool {
2102
253
            for (auto& multipath_providers : providers) {
2103
253
                if (multipath_providers.size() == 1) {
2104
360
                    for (size_t i = 1; i < length; ++i) {
2105
194
                        multipath_providers.emplace_back(multipath_providers.at(0)->Clone());
2106
194
                    }
2107
166
                } else if (multipath_providers.size() != length) {
2108
0
                    return false;
2109
0
                }
2110
253
            }
2111
87
            return true;
2112
87
        };
2113
2114
        // Emplace the final MuSigPubkeyProvider into ret with the pubkey providers from the specified provider vectors index
2115
        // and the path from the specified path index
2116
260
        const auto& emplace_final_provider = [&ret, &key_exp_index, &deriv_type, &derivation_multipaths, &providers](size_t vec_idx, size_t path_idx) -> void {
2117
260
            KeyPath& path = derivation_multipaths.at(path_idx);
2118
260
            std::vector<std::unique_ptr<PubkeyProvider>> pubs;
2119
260
            pubs.reserve(providers.size());
2120
715
            for (auto& vec : providers) {
2121
715
                pubs.emplace_back(std::move(vec.at(vec_idx)));
2122
715
            }
2123
260
            ret.emplace_back(std::make_unique<MuSigPubkeyProvider>(key_exp_index, std::move(pubs), path, deriv_type));
2124
260
        };
2125
2126
158
        if (max_multipath_len > 1 && derivation_multipaths.size() > 1) {
2127
2
            error = "musig(): Cannot have multipath participant keys if musig() is also multipath";
2128
2
            return {};
2129
156
        } else if (max_multipath_len > 1) {
2130
32
            if (!clone_providers(max_multipath_len)) {
2131
0
                error = strprintf("musig(): Multipath derivation paths have mismatched lengths");
2132
0
                return {};
2133
0
            }
2134
106
            for (size_t i = 0; i < max_multipath_len; ++i) {
2135
                // Final MuSigPubkeyProvider uses participant pubkey providers at each multipath position, and the first (and only) path
2136
74
                emplace_final_provider(i, 0);
2137
74
            }
2138
124
        } else if (derivation_multipaths.size() > 1) {
2139
            // All key provider vectors should be length 1. Clone them until they have the same length as paths
2140
55
            if (!Assume(clone_providers(derivation_multipaths.size()))) {
2141
0
                error = "musig(): Multipath derivation path with multipath participants is disallowed"; // This error is unreachable due to earlier check
2142
0
                return {};
2143
0
            }
2144
172
            for (size_t i = 0; i < derivation_multipaths.size(); ++i) {
2145
                // Final MuSigPubkeyProvider uses cloned participant pubkey providers, and the multipath derivation paths
2146
117
                emplace_final_provider(i, i);
2147
117
            }
2148
69
        } else {
2149
            // No multipath derivation, MuSigPubkeyProvider uses the first (and only) participant pubkey providers, and the first (and only) path
2150
69
            emplace_final_provider(0, 0);
2151
69
        }
2152
156
        ++key_exp_index; // Increment key expression index for the MuSigPubkeyProvider too
2153
156
        return ret;
2154
158
    }
2155
2156
28.7k
    auto origin_split = Split(sp, ']');
2157
28.7k
    if (origin_split.size() > 2) {
2158
4
        error = "Multiple ']' characters found for a single pubkey";
2159
4
        return {};
2160
4
    }
2161
    // This is set if either the origin or path suffix contains a hardened derivation.
2162
28.7k
    bool apostrophe = false;
2163
28.7k
    if (origin_split.size() == 1) {
2164
23.5k
        return ParsePubkeyInner(key_exp_index, origin_split[0], ctx, out, apostrophe, error);
2165
23.5k
    }
2166
5.21k
    if (origin_split[0].empty() || origin_split[0][0] != '[') {
2167
2
        error = strprintf("Key origin start '[ character expected but not found, got '%c' instead",
2168
2
                          origin_split[0].empty() ? /** empty, implies split char */ ']' : origin_split[0][0]);
2169
2
        return {};
2170
2
    }
2171
5.21k
    auto slash_split = Split(origin_split[0].subspan(1), '/');
2172
5.21k
    if (slash_split[0].size() != 8) {
2173
6
        error = strprintf("Fingerprint is not 4 bytes (%u characters instead of 8 characters)", slash_split[0].size());
2174
6
        return {};
2175
6
    }
2176
5.20k
    std::string fpr_hex = std::string(slash_split[0].begin(), slash_split[0].end());
2177
5.20k
    if (!IsHex(fpr_hex)) {
2178
2
        error = strprintf("Fingerprint '%s' is not hex", fpr_hex);
2179
2
        return {};
2180
2
    }
2181
5.20k
    auto fpr_bytes = ParseHex(fpr_hex);
2182
5.20k
    KeyOriginInfo info;
2183
5.20k
    static_assert(sizeof(info.fingerprint) == 4, "Fingerprint must be 4 bytes");
2184
5.20k
    assert(fpr_bytes.size() == 4);
2185
5.20k
    std::copy_n(fpr_bytes.begin(), info.fingerprint.size(), info.fingerprint.begin());
2186
5.20k
    std::vector<KeyPath> path;
2187
5.20k
    if (!ParseKeyPath(slash_split, path, apostrophe, error, /*allow_multipath=*/false)) return {};
2188
5.20k
    info.path = path.at(0);
2189
5.20k
    auto providers = ParsePubkeyInner(key_exp_index, origin_split[1], ctx, out, apostrophe, error);
2190
5.20k
    if (providers.empty()) return {};
2191
5.19k
    ret.reserve(providers.size());
2192
5.28k
    for (auto& prov : providers) {
2193
5.28k
        ret.emplace_back(std::make_unique<OriginPubkeyProvider>(prov->m_expr_index, info, std::move(prov), apostrophe));
2194
5.28k
    }
2195
5.19k
    return ret;
2196
5.20k
}
2197
2198
std::unique_ptr<PubkeyProvider> InferPubkey(const CPubKey& pubkey, ParseScriptContext ctx, const SigningProvider& provider)
2199
272k
{
2200
    // Key cannot be hybrid
2201
272k
    if (!pubkey.IsValidNonHybrid()) {
2202
7
        return nullptr;
2203
7
    }
2204
    // Uncompressed is only allowed in TOP and P2SH contexts
2205
272k
    if (ctx != ParseScriptContext::TOP && ctx != ParseScriptContext::P2SH && !pubkey.IsCompressed()) {
2206
5
        return nullptr;
2207
5
    }
2208
272k
    std::unique_ptr<PubkeyProvider> key_provider = std::make_unique<ConstPubkeyProvider>(0, pubkey, false);
2209
272k
    KeyOriginInfo info;
2210
272k
    if (provider.GetKeyOrigin(pubkey.GetID(), info)) {
2211
271k
        return std::make_unique<OriginPubkeyProvider>(0, std::move(info), std::move(key_provider), /*apostrophe=*/false);
2212
271k
    }
2213
983
    return key_provider;
2214
272k
}
2215
2216
std::unique_ptr<PubkeyProvider> InferXOnlyPubkey(const XOnlyPubKey& xkey, ParseScriptContext ctx, const SigningProvider& provider)
2217
131k
{
2218
131k
    CPubKey pubkey{xkey.GetEvenCorrespondingCPubKey()};
2219
131k
    std::unique_ptr<PubkeyProvider> key_provider = std::make_unique<ConstPubkeyProvider>(0, pubkey, true);
2220
131k
    KeyOriginInfo info;
2221
131k
    if (provider.GetKeyOriginByXOnly(xkey, info)) {
2222
116k
        return std::make_unique<OriginPubkeyProvider>(0, std::move(info), std::move(key_provider), /*apostrophe=*/false);
2223
116k
    }
2224
14.9k
    return key_provider;
2225
131k
}
2226
2227
/**
2228
 * The context for parsing a Miniscript descriptor (either from Script or from its textual representation).
2229
 */
2230
struct KeyParser {
2231
    //! The Key type is an index in DescriptorImpl::m_pubkey_args
2232
    using Key = uint32_t;
2233
    //! Must not be nullptr if parsing from string.
2234
    FlatSigningProvider* m_out;
2235
    //! Must not be nullptr if parsing from Script.
2236
    const SigningProvider* m_in;
2237
    //! List of multipath expanded keys contained in the Miniscript.
2238
    mutable std::vector<std::vector<std::unique_ptr<PubkeyProvider>>> m_keys;
2239
    //! Used to detect key parsing errors within a Miniscript.
2240
    mutable std::string m_key_parsing_error;
2241
    //! The script context we're operating within (Tapscript or P2WSH).
2242
    const miniscript::MiniscriptContext m_script_ctx;
2243
    //! The current key expression index
2244
    uint32_t& m_expr_index;
2245
2246
    KeyParser(FlatSigningProvider* out LIFETIMEBOUND, const SigningProvider* in LIFETIMEBOUND,
2247
              miniscript::MiniscriptContext ctx, uint32_t& key_exp_index LIFETIMEBOUND)
2248
1.23k
        : m_out(out), m_in(in), m_script_ctx(ctx), m_expr_index(key_exp_index) {}
2249
2250
4.39k
    bool KeyCompare(const Key& a, const Key& b) const {
2251
        // Deriving a hardened step needs the private key, so use the provider that was filled
2252
        // while parsing, or the one we are inferring from, rather than an empty one.
2253
4.39k
        const SigningProvider& provider{m_out ? *m_out : (m_in ? *m_in : DUMMY_SIGNING_PROVIDER)};
2254
4.39k
        const PubkeyProvider& key_a{*m_keys.at(a).at(0)};
2255
4.39k
        const PubkeyProvider& key_b{*m_keys.at(b).at(0)};
2256
4.39k
        FlatSigningProvider out_a, out_b;
2257
4.39k
        const std::optional<CPubKey> pub_a{key_a.GetPubKey(0, provider, out_a)};
2258
4.39k
        const std::optional<CPubKey> pub_b{key_b.GetPubKey(0, provider, out_b)};
2259
4.39k
        if (pub_a && pub_b) return *pub_a < *pub_b;
2260
        // Keys that cannot be derived sort before the ones that can, and are compared by their
2261
        // expression so that two different keys are not taken for duplicates.
2262
17
        if (pub_a.has_value() != pub_b.has_value()) return !pub_a.has_value();
2263
14
        return key_a.ToString() < key_b.ToString();
2264
17
    }
2265
2266
2.04k
    ParseScriptContext ParseContext() const {
2267
2.04k
        switch (m_script_ctx) {
2268
1.38k
            case miniscript::MiniscriptContext::P2WSH: return ParseScriptContext::P2WSH;
2269
657
            case miniscript::MiniscriptContext::TAPSCRIPT: return ParseScriptContext::P2TR;
2270
2.04k
        }
2271
2.04k
        assert(false);
2272
0
    }
2273
2274
    std::optional<Key> FromString(std::span<const char>& in) const
2275
473
    {
2276
473
        assert(m_out);
2277
473
        Key key = m_keys.size();
2278
473
        auto pk = ParsePubkey(m_expr_index, in, ParseContext(), *m_out, m_key_parsing_error);
2279
473
        if (pk.empty()) return {};
2280
471
        m_keys.emplace_back(std::move(pk));
2281
471
        return key;
2282
473
    }
2283
2284
    std::optional<std::string> ToString(const Key& key, bool&) const
2285
38
    {
2286
38
        return m_keys.at(key).at(0)->ToString();
2287
38
    }
2288
2289
    template<typename I> std::optional<Key> FromPKBytes(I begin, I end) const
2290
1.27k
    {
2291
1.27k
        assert(m_in);
2292
1.27k
        Key key = m_keys.size();
2293
1.27k
        if (miniscript::IsTapscript(m_script_ctx) && end - begin == 32) {
2294
354
            XOnlyPubKey pubkey;
2295
354
            std::copy(begin, end, pubkey.begin());
2296
354
            if (auto pubkey_provider = InferXOnlyPubkey(pubkey, ParseContext(), *m_in)) {
2297
354
                m_keys.emplace_back();
2298
354
                m_keys.back().push_back(std::move(pubkey_provider));
2299
354
                return key;
2300
354
            }
2301
921
        } else if (!miniscript::IsTapscript(m_script_ctx)) {
2302
921
            CPubKey pubkey(begin, end);
2303
921
            if (auto pubkey_provider = InferPubkey(pubkey, ParseContext(), *m_in)) {
2304
919
                m_keys.emplace_back();
2305
919
                m_keys.back().push_back(std::move(pubkey_provider));
2306
919
                return key;
2307
919
            }
2308
921
        }
2309
2
        return {};
2310
1.27k
    }
2311
2312
    template<typename I> std::optional<Key> FromPKHBytes(I begin, I end) const
2313
298
    {
2314
298
        assert(end - begin == 20);
2315
298
        assert(m_in);
2316
298
        uint160 hash;
2317
298
        std::copy(begin, end, hash.begin());
2318
298
        CKeyID keyid(hash);
2319
298
        CPubKey pubkey;
2320
298
        if (m_in->GetPubKey(keyid, pubkey)) {
2321
298
            if (auto pubkey_provider = InferPubkey(pubkey, ParseContext(), *m_in)) {
2322
296
                Key key = m_keys.size();
2323
296
                m_keys.emplace_back();
2324
296
                m_keys.back().push_back(std::move(pubkey_provider));
2325
296
                return key;
2326
296
            }
2327
298
        }
2328
2
        return {};
2329
298
    }
2330
2331
997k
    miniscript::MiniscriptContext MsContext() const {
2332
997k
        return m_script_ctx;
2333
997k
    }
2334
};
2335
2336
/** Parse a script in a particular context. */
2337
// NOLINTNEXTLINE(misc-no-recursion)
2338
std::vector<std::unique_ptr<DescriptorImpl>> ParseScript(uint32_t& key_exp_index, std::span<const char>& sp, ParseScriptContext ctx, FlatSigningProvider& out, std::string& error)
2339
14.7k
{
2340
14.7k
    using namespace script;
2341
14.7k
    Assume(ctx == ParseScriptContext::TOP || ctx == ParseScriptContext::P2SH || ctx == ParseScriptContext::P2WSH || ctx == ParseScriptContext::P2TR);
2342
14.7k
    std::vector<std::unique_ptr<DescriptorImpl>> ret;
2343
14.7k
    auto expr = Expr(sp);
2344
14.7k
    if (Func("pk", expr)) {
2345
680
        auto pubkeys = ParsePubkey(key_exp_index, expr, ctx, out, error);
2346
680
        if (pubkeys.empty()) {
2347
12
            error = strprintf("pk(): %s", error);
2348
12
            return {};
2349
12
        }
2350
786
        for (auto& pubkey : pubkeys) {
2351
786
            ret.emplace_back(std::make_unique<PKDescriptor>(std::move(pubkey), ctx == ParseScriptContext::P2TR));
2352
786
        }
2353
668
        return ret;
2354
680
    }
2355
14.0k
    if ((ctx == ParseScriptContext::TOP || ctx == ParseScriptContext::P2SH || ctx == ParseScriptContext::P2WSH) && Func("pkh", expr)) {
2356
1.81k
        auto pubkeys = ParsePubkey(key_exp_index, expr, ctx, out, error);
2357
1.81k
        if (pubkeys.empty()) {
2358
20
            error = strprintf("pkh(): %s", error);
2359
20
            return {};
2360
20
        }
2361
1.81k
        for (auto& pubkey : pubkeys) {
2362
1.81k
            ret.emplace_back(std::make_unique<PKHDescriptor>(std::move(pubkey)));
2363
1.81k
        }
2364
1.79k
        return ret;
2365
1.81k
    }
2366
12.2k
    if (ctx == ParseScriptContext::TOP && Func("combo", expr)) {
2367
674
        auto pubkeys = ParsePubkey(key_exp_index, expr, ctx, out, error);
2368
674
        if (pubkeys.empty()) {
2369
5
            error = strprintf("combo(): %s", error);
2370
5
            return {};
2371
5
        }
2372
669
        for (auto& pubkey : pubkeys) {
2373
669
            ret.emplace_back(std::make_unique<ComboDescriptor>(std::move(pubkey)));
2374
669
        }
2375
669
        return ret;
2376
11.5k
    } else if (Func("combo", expr)) {
2377
2
        error = "Can only have combo() at top level";
2378
2
        return {};
2379
2
    }
2380
11.5k
    const bool multi = Func("multi", expr);
2381
11.5k
    const bool sortedmulti = !multi && Func("sortedmulti", expr);
2382
11.5k
    const bool multi_a = !(multi || sortedmulti) && Func("multi_a", expr);
2383
11.5k
    const bool sortedmulti_a = !(multi || sortedmulti || multi_a) && Func("sortedmulti_a", expr);
2384
11.5k
    if (((ctx == ParseScriptContext::TOP || ctx == ParseScriptContext::P2SH || ctx == ParseScriptContext::P2WSH) && (multi || sortedmulti)) ||
2385
11.5k
        (ctx == ParseScriptContext::P2TR && (multi_a || sortedmulti_a))) {
2386
376
        auto threshold = Expr(expr);
2387
376
        uint32_t thres;
2388
376
        std::vector<std::vector<std::unique_ptr<PubkeyProvider>>> providers; // List of multipath expanded pubkeys
2389
376
        if (const auto maybe_thres{ToIntegral<uint32_t>(std::string_view{threshold.begin(), threshold.end()})}) {
2390
372
            thres = *maybe_thres;
2391
372
        } else {
2392
4
            error = strprintf("Multi threshold '%s' is not valid", std::string(threshold.begin(), threshold.end()));
2393
4
            return {};
2394
4
        }
2395
372
        size_t script_size = 0;
2396
372
        size_t max_providers_len = 0;
2397
19.3k
        while (expr.size()) {
2398
18.9k
            if (!Const(",", expr)) {
2399
1
                error = strprintf("Multi: expected ',', got '%c'", expr[0]);
2400
1
                return {};
2401
1
            }
2402
18.9k
            auto arg = Expr(expr);
2403
18.9k
            auto pks = ParsePubkey(key_exp_index, arg, ctx, out, error);
2404
18.9k
            if (pks.empty()) {
2405
14
                error = strprintf("Multi: %s", error);
2406
14
                return {};
2407
14
            }
2408
18.9k
            script_size += pks.at(0)->GetSize() + 1;
2409
18.9k
            max_providers_len = std::max(max_providers_len, pks.size());
2410
18.9k
            providers.emplace_back(std::move(pks));
2411
18.9k
        }
2412
357
        if ((multi || sortedmulti) && (providers.empty() || providers.size() > MAX_PUBKEYS_PER_MULTISIG)) {
2413
1
            error = strprintf("Cannot have %u keys in multisig; must have between 1 and %d keys, inclusive", providers.size(), MAX_PUBKEYS_PER_MULTISIG);
2414
1
            return {};
2415
356
        } else if ((multi_a || sortedmulti_a) && (providers.empty() || providers.size() > MAX_PUBKEYS_PER_MULTI_A)) {
2416
1
            error = strprintf("Cannot have %u keys in multi_a; must have between 1 and %d keys, inclusive", providers.size(), MAX_PUBKEYS_PER_MULTI_A);
2417
1
            return {};
2418
355
        } else if (thres < 1) {
2419
2
            error = strprintf("Multisig threshold cannot be %d, must be at least 1", thres);
2420
2
            return {};
2421
353
        } else if (thres > providers.size()) {
2422
2
            error = strprintf("Multisig threshold cannot be larger than the number of keys; threshold is %d but only %u keys specified", thres, providers.size());
2423
2
            return {};
2424
2
        }
2425
351
        if (ctx == ParseScriptContext::TOP) {
2426
26
            if (providers.size() > 3) {
2427
2
                error = strprintf("Cannot have %u pubkeys in bare multisig; only at most 3 pubkeys", providers.size());
2428
2
                return {};
2429
2
            }
2430
26
        }
2431
349
        if (ctx == ParseScriptContext::P2SH) {
2432
            // This limits the maximum number of compressed pubkeys to 15.
2433
59
            if (script_size + 3 > MAX_SCRIPT_ELEMENT_SIZE) {
2434
4
                error = strprintf("P2SH script is too large, %d bytes is larger than %d bytes", script_size + 3, MAX_SCRIPT_ELEMENT_SIZE);
2435
4
                return {};
2436
4
            }
2437
59
        }
2438
2439
        // Make sure all vecs are of the same length, or exactly length 1
2440
        // For length 1 vectors, clone key providers until vector is the same length
2441
18.8k
        for (auto& vec : providers) {
2442
18.8k
            if (vec.size() == 1) {
2443
18.8k
                for (size_t i = 1; i < max_providers_len; ++i) {
2444
18
                    vec.emplace_back(vec.at(0)->Clone());
2445
18
                }
2446
18.8k
            } else if (vec.size() != max_providers_len) {
2447
2
                error = strprintf("multi(): Multipath derivation paths have mismatched lengths");
2448
2
                return {};
2449
2
            }
2450
18.8k
        }
2451
2452
        // Build the final descriptors vector
2453
710
        for (size_t i = 0; i < max_providers_len; ++i) {
2454
            // Build final pubkeys vectors by retrieving the i'th subscript for each vector in subscripts
2455
367
            std::vector<std::unique_ptr<PubkeyProvider>> pubs;
2456
367
            pubs.reserve(providers.size());
2457
18.9k
            for (auto& pub : providers) {
2458
18.9k
                pubs.emplace_back(std::move(pub.at(i)));
2459
18.9k
            }
2460
367
            if (multi || sortedmulti) {
2461
235
                ret.emplace_back(std::make_unique<MultisigDescriptor>(thres, std::move(pubs), sortedmulti));
2462
235
            } else {
2463
132
                ret.emplace_back(std::make_unique<MultiADescriptor>(thres, std::move(pubs), sortedmulti_a));
2464
132
            }
2465
367
        }
2466
343
        return ret;
2467
11.1k
    } else if (multi || sortedmulti) {
2468
0
        error = "Can only have multi/sortedmulti at top level, in sh(), or in wsh()";
2469
0
        return {};
2470
11.1k
    } else if (multi_a || sortedmulti_a) {
2471
0
        error = "Can only have multi_a/sortedmulti_a inside tr()";
2472
0
        return {};
2473
0
    }
2474
11.1k
    if ((ctx == ParseScriptContext::TOP || ctx == ParseScriptContext::P2SH) && Func("wpkh", expr)) {
2475
3.70k
        auto pubkeys = ParsePubkey(key_exp_index, expr, ParseScriptContext::P2WPKH, out, error);
2476
3.70k
        if (pubkeys.empty()) {
2477
27
            error = strprintf("wpkh(): %s", error);
2478
27
            return {};
2479
27
        }
2480
3.69k
        for (auto& pubkey : pubkeys) {
2481
3.69k
            ret.emplace_back(std::make_unique<WPKHDescriptor>(std::move(pubkey)));
2482
3.69k
        }
2483
3.67k
        return ret;
2484
7.44k
    } else if (Func("wpkh", expr)) {
2485
3
        error = "Can only have wpkh() at top level or inside sh()";
2486
3
        return {};
2487
3
    }
2488
7.44k
    if (ctx == ParseScriptContext::TOP && Func("sh", expr)) {
2489
1.93k
        auto descs = ParseScript(key_exp_index, expr, ParseScriptContext::P2SH, out, error);
2490
1.93k
        if (descs.empty() || expr.size()) return {};
2491
1.90k
        std::vector<std::unique_ptr<DescriptorImpl>> ret;
2492
1.90k
        ret.reserve(descs.size());
2493
1.92k
        for (auto& desc : descs) {
2494
1.92k
            ret.push_back(std::make_unique<SHDescriptor>(std::move(desc)));
2495
1.92k
        }
2496
1.90k
        return ret;
2497
5.51k
    } else if (Func("sh", expr)) {
2498
6
        error = "Can only have sh() at top level";
2499
6
        return {};
2500
6
    }
2501
5.50k
    if ((ctx == ParseScriptContext::TOP || ctx == ParseScriptContext::P2SH) && Func("wsh", expr)) {
2502
297
        auto descs = ParseScript(key_exp_index, expr, ParseScriptContext::P2WSH, out, error);
2503
297
        if (descs.empty() || expr.size()) return {};
2504
257
        for (auto& desc : descs) {
2505
257
            ret.emplace_back(std::make_unique<WSHDescriptor>(std::move(desc)));
2506
257
        }
2507
245
        return ret;
2508
5.20k
    } else if (Func("wsh", expr)) {
2509
3
        error = "Can only have wsh() at top level or inside sh()";
2510
3
        return {};
2511
3
    }
2512
5.20k
    if (ctx == ParseScriptContext::TOP && Func("addr", expr)) {
2513
97
        CTxDestination dest = DecodeDestination(std::string(expr.begin(), expr.end()));
2514
97
        if (!IsValidDestination(dest)) {
2515
3
            error = "Address is not valid";
2516
3
            return {};
2517
3
        }
2518
94
        ret.emplace_back(std::make_unique<AddressDescriptor>(std::move(dest)));
2519
94
        return ret;
2520
5.10k
    } else if (Func("addr", expr)) {
2521
0
        error = "Can only have addr() at top level";
2522
0
        return {};
2523
0
    }
2524
5.10k
    if (ctx == ParseScriptContext::TOP && Func("tr", expr)) {
2525
2.10k
        auto arg = Expr(expr);
2526
2.10k
        auto internal_keys = ParsePubkey(key_exp_index, arg, ParseScriptContext::P2TR, out, error);
2527
2.10k
        if (internal_keys.empty()) {
2528
20
            error = strprintf("tr(): %s", error);
2529
20
            return {};
2530
20
        }
2531
2.08k
        size_t max_providers_len = internal_keys.size();
2532
2.08k
        std::vector<std::vector<std::unique_ptr<DescriptorImpl>>> subscripts; //!< list of multipath expanded script subexpressions
2533
2.08k
        std::vector<int> depths; //!< depth in the tree of each subexpression (same length subscripts)
2534
2.08k
        if (expr.size()) {
2535
384
            if (!Const(",", expr)) {
2536
0
                error = strprintf("tr: expected ',', got '%c'", expr[0]);
2537
0
                return {};
2538
0
            }
2539
            /** The path from the top of the tree to what we're currently processing.
2540
             * branches[i] == false: left branch in the i'th step from the top; true: right branch.
2541
             */
2542
384
            std::vector<bool> branches;
2543
            // Loop over all provided scripts. In every iteration exactly one script will be processed.
2544
            // Use a do-loop because inside this if-branch we expect at least one script.
2545
844
            do {
2546
                // First process all open braces.
2547
1.32k
                while (Const("{", expr)) {
2548
482
                    branches.push_back(false); // new left branch
2549
482
                    if (branches.size() > TAPROOT_CONTROL_MAX_NODE_COUNT) {
2550
0
                        error = strprintf("tr() supports at most %i nesting levels", TAPROOT_CONTROL_MAX_NODE_COUNT);
2551
0
                        return {};
2552
0
                    }
2553
482
                }
2554
                // Process the actual script expression.
2555
844
                auto sarg = Expr(expr);
2556
844
                subscripts.emplace_back(ParseScript(key_exp_index, sarg, ParseScriptContext::P2TR, out, error));
2557
844
                if (subscripts.back().empty()) return {};
2558
841
                max_providers_len = std::max(max_providers_len, subscripts.back().size());
2559
841
                depths.push_back(branches.size());
2560
                // Process closing braces; one is expected for every right branch we were in.
2561
1.30k
                while (branches.size() && branches.back()) {
2562
460
                    if (!Const("}", expr)) {
2563
0
                        error = strprintf("tr(): expected '}' after script expression");
2564
0
                        return {};
2565
0
                    }
2566
460
                    branches.pop_back(); // move up one level after encountering '}'
2567
460
                }
2568
                // If after that, we're at the end of a left branch, expect a comma.
2569
841
                if (branches.size() && !branches.back()) {
2570
460
                    if (!Const(",", expr)) {
2571
0
                        error = strprintf("tr(): expected ',' after script expression");
2572
0
                        return {};
2573
0
                    }
2574
460
                    branches.back() = true; // And now we're in a right branch.
2575
460
                }
2576
841
            } while (branches.size());
2577
            // After we've explored a whole tree, we must be at the end of the expression.
2578
381
            if (expr.size()) {
2579
0
                error = strprintf("tr(): expected ')' after script expression");
2580
0
                return {};
2581
0
            }
2582
381
        }
2583
2.08k
        assert(TaprootBuilder::ValidDepths(depths));
2584
2585
        // Make sure all vecs are of the same length, or exactly length 1
2586
        // For length 1 vectors, clone subdescs until vector is the same length
2587
2.07k
        for (auto& vec : subscripts) {
2588
839
            if (vec.size() == 1) {
2589
773
                for (size_t i = 1; i < max_providers_len; ++i) {
2590
20
                    vec.emplace_back(vec.at(0)->Clone());
2591
20
                }
2592
753
            } else if (vec.size() != max_providers_len) {
2593
4
                error = strprintf("tr(): Multipath subscripts have mismatched lengths");
2594
4
                return {};
2595
4
            }
2596
839
        }
2597
2598
2.07k
        if (internal_keys.size() > 1 && internal_keys.size() != max_providers_len) {
2599
2
            error = strprintf("tr(): Multipath internal key mismatches multipath subscripts lengths");
2600
2
            return {};
2601
2
        }
2602
2603
2.13k
        while (internal_keys.size() < max_providers_len) {
2604
63
            internal_keys.emplace_back(internal_keys.at(0)->Clone());
2605
63
        }
2606
2607
        // Build the final descriptors vector
2608
4.24k
        for (size_t i = 0; i < max_providers_len; ++i) {
2609
            // Build final subscripts vectors by retrieving the i'th subscript for each vector in subscripts
2610
2.17k
            std::vector<std::unique_ptr<DescriptorImpl>> this_subs;
2611
2.17k
            this_subs.reserve(subscripts.size());
2612
2.17k
            for (auto& subs : subscripts) {
2613
960
                this_subs.emplace_back(std::move(subs.at(i)));
2614
960
            }
2615
2.17k
            ret.emplace_back(std::make_unique<TRDescriptor>(std::move(internal_keys.at(i)), std::move(this_subs), depths));
2616
2.17k
        }
2617
2.07k
        return ret;
2618
2619
2620
3.00k
    } else if (Func("tr", expr)) {
2621
0
        error = "Can only have tr at top level";
2622
0
        return {};
2623
0
    }
2624
3.00k
    if (ctx == ParseScriptContext::TOP && Func("rawtr", expr)) {
2625
81
        auto arg = Expr(expr);
2626
81
        if (expr.size()) {
2627
1
            error = strprintf("rawtr(): only one key expected.");
2628
1
            return {};
2629
1
        }
2630
80
        auto output_keys = ParsePubkey(key_exp_index, arg, ParseScriptContext::P2TR, out, error);
2631
80
        if (output_keys.empty()) {
2632
0
            error = strprintf("rawtr(): %s", error);
2633
0
            return {};
2634
0
        }
2635
123
        for (auto& pubkey : output_keys) {
2636
123
            ret.emplace_back(std::make_unique<RawTRDescriptor>(std::move(pubkey)));
2637
123
        }
2638
80
        return ret;
2639
2.92k
    } else if (Func("rawtr", expr)) {
2640
0
        error = "Can only have rawtr at top level";
2641
0
        return {};
2642
0
    }
2643
2.92k
    if (ctx == ParseScriptContext::TOP && Func("unused", expr)) {
2644
        // Check for only one expression, should not find commas, brackets, or parentheses
2645
25
        auto arg = Expr(expr);
2646
25
        if (expr.size()) {
2647
2
            error = strprintf("unused(): only one key expected");
2648
2
            return {};
2649
2
        }
2650
23
        auto keys = ParsePubkey(key_exp_index, arg, ctx, out, error);
2651
23
        if (keys.empty()) return {};
2652
20
        for (auto& pubkey : keys) {
2653
20
            if (pubkey->IsRange()) {
2654
2
                error = "unused(): key cannot be ranged";
2655
2
                return {};
2656
2
            }
2657
18
            ret.emplace_back(std::make_unique<UnusedDescriptor>(std::move(pubkey)));
2658
18
        }
2659
18
        return ret;
2660
2.90k
    } else if (Func("unused", expr)) {
2661
2
        error = "Can only have unused at top level";
2662
2
        return {};
2663
2
    }
2664
2.89k
    if (ctx == ParseScriptContext::TOP && Func("raw", expr)) {
2665
2.34k
        std::string str(expr.begin(), expr.end());
2666
2.34k
        if (!IsHex(str)) {
2667
2
            error = "Raw script is not hex";
2668
2
            return {};
2669
2
        }
2670
2.34k
        auto bytes = ParseHex(str);
2671
2.34k
        ret.emplace_back(std::make_unique<RawDescriptor>(CScript(bytes.begin(), bytes.end())));
2672
2.34k
        return ret;
2673
2.34k
    } else if (Func("raw", expr)) {
2674
0
        error = "Can only have raw() at top level";
2675
0
        return {};
2676
0
    }
2677
    // Process miniscript expressions.
2678
556
    {
2679
556
        const auto script_ctx{ctx == ParseScriptContext::P2WSH ? miniscript::MiniscriptContext::P2WSH : miniscript::MiniscriptContext::TAPSCRIPT};
2680
556
        KeyParser parser(/*out = */&out, /* in = */nullptr, /* ctx = */script_ctx, key_exp_index);
2681
556
        auto node = miniscript::FromString(std::string(expr.begin(), expr.end()), parser);
2682
556
        if (parser.m_key_parsing_error != "") {
2683
2
            error = std::move(parser.m_key_parsing_error);
2684
2
            return {};
2685
2
        }
2686
554
        if (node) {
2687
197
            if (ctx != ParseScriptContext::P2WSH && ctx != ParseScriptContext::P2TR) {
2688
3
                error = "Miniscript expressions can only be used in wsh or tr.";
2689
3
                return {};
2690
3
            }
2691
194
            if (!node->IsSane() || node->IsNotSatisfiable()) {
2692
                // Try to find the first insane sub for better error reporting.
2693
16
                const auto* insane_node = &node.value();
2694
16
                if (const auto sub = node->FindInsaneSub()) insane_node = sub;
2695
16
                error = *insane_node->ToString(parser);
2696
16
                if (!insane_node->IsValid()) {
2697
4
                    error += " is invalid";
2698
12
                } else if (!node->IsSane()) {
2699
11
                    error += " is not sane";
2700
11
                    if (!insane_node->IsNonMalleable()) {
2701
2
                        error += ": malleable witnesses exist";
2702
9
                    } else if (insane_node == &node.value() && !insane_node->NeedsSignature()) {
2703
3
                        error += ": witnesses without signature exist";
2704
6
                    } else if (!insane_node->CheckTimeLocksMix()) {
2705
2
                        error += ": contains mixes of timelocks expressed in blocks and seconds";
2706
4
                    } else if (!insane_node->CheckDuplicateKey()) {
2707
4
                        error += ": contains duplicate public keys";
2708
4
                    } else if (!insane_node->ValidSatisfactions()) {
2709
0
                        error += ": needs witnesses that may exceed resource limits";
2710
0
                    }
2711
11
                } else {
2712
1
                    error += " is not satisfiable";
2713
1
                }
2714
16
                return {};
2715
16
            }
2716
            // A signature check is required for a miniscript to be sane. Therefore no sane miniscript
2717
            // may have an empty list of public keys.
2718
178
            CHECK_NONFATAL(!parser.m_keys.empty());
2719
            // Make sure all vecs are of the same length, or exactly length 1
2720
            // For length 1 vectors, clone subdescs until vector is the same length
2721
178
            size_t num_multipath = std::max_element(parser.m_keys.begin(), parser.m_keys.end(),
2722
251
                    [](const std::vector<std::unique_ptr<PubkeyProvider>>& a, const std::vector<std::unique_ptr<PubkeyProvider>>& b) {
2723
251
                        return a.size() < b.size();
2724
251
                    })->size();
2725
2726
429
            for (auto& vec : parser.m_keys) {
2727
429
                if (vec.size() == 1) {
2728
384
                    for (size_t i = 1; i < num_multipath; ++i) {
2729
0
                        vec.emplace_back(vec.at(0)->Clone());
2730
0
                    }
2731
384
                } else if (vec.size() != num_multipath) {
2732
2
                    error = strprintf("Miniscript: Multipath derivation paths have mismatched lengths");
2733
2
                    return {};
2734
2
                }
2735
429
            }
2736
2737
            // Build the final descriptors vector
2738
379
            for (size_t i = 0; i < num_multipath; ++i) {
2739
                // Build final pubkeys vectors by retrieving the i'th subscript for each vector in subscripts
2740
203
                std::vector<std::unique_ptr<PubkeyProvider>> pubs;
2741
203
                pubs.reserve(parser.m_keys.size());
2742
466
                for (auto& pub : parser.m_keys) {
2743
466
                    pubs.emplace_back(std::move(pub.at(i)));
2744
466
                }
2745
203
                ret.emplace_back(std::make_unique<MiniscriptDescriptor>(std::move(pubs), node->Clone()));
2746
203
            }
2747
176
            return ret;
2748
178
        }
2749
554
    }
2750
357
    if (ctx == ParseScriptContext::P2SH) {
2751
4
        error = "A function is needed within P2SH";
2752
4
        return {};
2753
353
    } else if (ctx == ParseScriptContext::P2WSH) {
2754
4
        error = "A function is needed within P2WSH";
2755
4
        return {};
2756
4
    }
2757
349
    error = strprintf("'%s' is not a valid descriptor function", std::string(expr.begin(), expr.end()));
2758
349
    return {};
2759
357
}
2760
2761
std::unique_ptr<DescriptorImpl> InferMultiA(const CScript& script, ParseScriptContext ctx, const SigningProvider& provider)
2762
1.06k
{
2763
1.06k
    auto match = MatchMultiA(script);
2764
1.06k
    if (!match) return {};
2765
772
    std::vector<std::unique_ptr<PubkeyProvider>> keys;
2766
772
    keys.reserve(match->second.size());
2767
107k
    for (const auto keyspan : match->second) {
2768
107k
        if (keyspan.size() != 32) return {};
2769
107k
        auto key = InferXOnlyPubkey(XOnlyPubKey{keyspan}, ctx, provider);
2770
107k
        if (!key) return {};
2771
107k
        keys.push_back(std::move(key));
2772
107k
    }
2773
772
    return std::make_unique<MultiADescriptor>(match->first, std::move(keys));
2774
772
}
2775
2776
// NOLINTNEXTLINE(misc-no-recursion)
2777
std::unique_ptr<DescriptorImpl> InferScript(const CScript& script, ParseScriptContext ctx, const SigningProvider& provider)
2778
320k
{
2779
320k
    if (ctx == ParseScriptContext::P2TR && script.size() == 34 && script[0] == 32 && script[33] == OP_CHECKSIG) {
2780
3.34k
        XOnlyPubKey key{std::span{script}.subspan(1, 32)};
2781
3.34k
        return std::make_unique<PKDescriptor>(InferXOnlyPubkey(key, ctx, provider), true);
2782
3.34k
    }
2783
2784
317k
    if (ctx == ParseScriptContext::P2TR) {
2785
1.06k
        auto ret = InferMultiA(script, ctx, provider);
2786
1.06k
        if (ret) return ret;
2787
1.06k
    }
2788
2789
316k
    std::vector<std::vector<unsigned char>> data;
2790
316k
    TxoutType txntype = Solver(script, data);
2791
2792
316k
    if (txntype == TxoutType::PUBKEY && (ctx == ParseScriptContext::TOP || ctx == ParseScriptContext::P2SH || ctx == ParseScriptContext::P2WSH)) {
2793
18.5k
        CPubKey pubkey(data[0]);
2794
18.5k
        if (auto pubkey_provider = InferPubkey(pubkey, ctx, provider)) {
2795
18.5k
            return std::make_unique<PKDescriptor>(std::move(pubkey_provider));
2796
18.5k
        }
2797
18.5k
    }
2798
297k
    if (txntype == TxoutType::PUBKEYHASH && (ctx == ParseScriptContext::TOP || ctx == ParseScriptContext::P2SH || ctx == ParseScriptContext::P2WSH)) {
2799
86.4k
        uint160 hash(data[0]);
2800
86.4k
        CKeyID keyid(hash);
2801
86.4k
        CPubKey pubkey;
2802
86.4k
        if (provider.GetPubKey(keyid, pubkey)) {
2803
85.9k
            if (auto pubkey_provider = InferPubkey(pubkey, ctx, provider)) {
2804
85.9k
                return std::make_unique<PKHDescriptor>(std::move(pubkey_provider));
2805
85.9k
            }
2806
85.9k
        }
2807
86.4k
    }
2808
211k
    if (txntype == TxoutType::WITNESS_V0_KEYHASH && (ctx == ParseScriptContext::TOP || ctx == ParseScriptContext::P2SH)) {
2809
165k
        uint160 hash(data[0]);
2810
165k
        CKeyID keyid(hash);
2811
165k
        CPubKey pubkey;
2812
165k
        if (provider.GetPubKey(keyid, pubkey)) {
2813
163k
            if (auto pubkey_provider = InferPubkey(pubkey, ParseScriptContext::P2WPKH, provider)) {
2814
163k
                return std::make_unique<WPKHDescriptor>(std::move(pubkey_provider));
2815
163k
            }
2816
163k
        }
2817
165k
    }
2818
47.9k
    if (txntype == TxoutType::MULTISIG && (ctx == ParseScriptContext::TOP || ctx == ParseScriptContext::P2SH || ctx == ParseScriptContext::P2WSH)) {
2819
664
        bool ok = true;
2820
664
        std::vector<std::unique_ptr<PubkeyProvider>> providers;
2821
3.30k
        for (size_t i = 1; i + 1 < data.size(); ++i) {
2822
2.63k
            CPubKey pubkey(data[i]);
2823
2.63k
            if (auto pubkey_provider = InferPubkey(pubkey, ctx, provider)) {
2824
2.63k
                providers.push_back(std::move(pubkey_provider));
2825
2.63k
            } else {
2826
0
                ok = false;
2827
0
                break;
2828
0
            }
2829
2.63k
        }
2830
664
        if (ok) return std::make_unique<MultisigDescriptor>((int)data[0][0], std::move(providers));
2831
664
    }
2832
47.2k
    if (txntype == TxoutType::SCRIPTHASH && ctx == ParseScriptContext::TOP) {
2833
20.9k
        uint160 hash(data[0]);
2834
20.9k
        CScriptID scriptid(hash);
2835
20.9k
        CScript subscript;
2836
20.9k
        if (provider.GetCScript(scriptid, subscript)) {
2837
20.3k
            auto sub = InferScript(subscript, ParseScriptContext::P2SH, provider);
2838
20.3k
            if (sub) return std::make_unique<SHDescriptor>(std::move(sub));
2839
20.3k
        }
2840
20.9k
    }
2841
26.8k
    if (txntype == TxoutType::WITNESS_V0_SCRIPTHASH && (ctx == ParseScriptContext::TOP || ctx == ParseScriptContext::P2SH)) {
2842
1.05k
        CScriptID scriptid{RIPEMD160(data[0])};
2843
1.05k
        CScript subscript;
2844
1.05k
        if (provider.GetCScript(scriptid, subscript)) {
2845
883
            auto sub = InferScript(subscript, ParseScriptContext::P2WSH, provider);
2846
883
            if (sub) return std::make_unique<WSHDescriptor>(std::move(sub));
2847
883
        }
2848
1.05k
    }
2849
26.0k
    if (txntype == TxoutType::WITNESS_V1_TAPROOT && ctx == ParseScriptContext::TOP) {
2850
        // Extract x-only pubkey from output.
2851
20.2k
        XOnlyPubKey pubkey;
2852
20.2k
        std::copy(data[0].begin(), data[0].end(), pubkey.begin());
2853
        // Request spending data.
2854
20.2k
        TaprootSpendData tap;
2855
20.2k
        if (provider.GetTaprootSpendData(pubkey, tap)) {
2856
            // If found, convert it back to tree form.
2857
4.96k
            auto tree = InferTaprootTree(tap, pubkey);
2858
4.96k
            if (tree) {
2859
                // If that works, try to infer subdescriptors for all leaves.
2860
4.96k
                bool ok = true;
2861
4.96k
                std::vector<std::unique_ptr<DescriptorImpl>> subscripts; //!< list of script subexpressions
2862
4.96k
                std::vector<int> depths; //!< depth in the tree of each subexpression (same length subscripts)
2863
4.96k
                for (const auto& [depth, script, leaf_ver] : *tree) {
2864
4.41k
                    std::unique_ptr<DescriptorImpl> subdesc;
2865
4.41k
                    if (leaf_ver == TAPROOT_LEAF_TAPSCRIPT) {
2866
4.41k
                        subdesc = InferScript(CScript(script.begin(), script.end()), ParseScriptContext::P2TR, provider);
2867
4.41k
                    }
2868
4.41k
                    if (!subdesc) {
2869
0
                        ok = false;
2870
0
                        break;
2871
4.41k
                    } else {
2872
4.41k
                        subscripts.push_back(std::move(subdesc));
2873
4.41k
                        depths.push_back(depth);
2874
4.41k
                    }
2875
4.41k
                }
2876
4.96k
                if (ok) {
2877
4.96k
                    auto key = InferXOnlyPubkey(tap.internal_key, ParseScriptContext::P2TR, provider);
2878
4.96k
                    return std::make_unique<TRDescriptor>(std::move(key), std::move(subscripts), std::move(depths));
2879
4.96k
                }
2880
4.96k
            }
2881
4.96k
        }
2882
        // If the above doesn't work, construct a rawtr() descriptor with just the encoded x-only pubkey.
2883
15.2k
        if (pubkey.IsFullyValid()) {
2884
15.2k
            auto key = InferXOnlyPubkey(pubkey, ParseScriptContext::P2TR, provider);
2885
15.2k
            if (key) {
2886
15.2k
                return std::make_unique<RawTRDescriptor>(std::move(key));
2887
15.2k
            }
2888
15.2k
        }
2889
15.2k
    }
2890
2891
5.75k
    if (ctx == ParseScriptContext::P2WSH || ctx == ParseScriptContext::P2TR) {
2892
680
        const auto script_ctx{ctx == ParseScriptContext::P2WSH ? miniscript::MiniscriptContext::P2WSH : miniscript::MiniscriptContext::TAPSCRIPT};
2893
680
        uint32_t key_exp_index = 0;
2894
680
        KeyParser parser(/* out = */nullptr, /* in = */&provider, /* ctx = */script_ctx, key_exp_index);
2895
680
        auto node = miniscript::FromScript(script, parser);
2896
680
        if (node && node->IsSane()) {
2897
667
            std::vector<std::unique_ptr<PubkeyProvider>> keys;
2898
667
            keys.reserve(parser.m_keys.size());
2899
1.56k
            for (auto& key : parser.m_keys) {
2900
1.56k
                keys.emplace_back(std::move(key.at(0)));
2901
1.56k
            }
2902
667
            return std::make_unique<MiniscriptDescriptor>(std::move(keys), std::move(*node));
2903
667
        }
2904
680
    }
2905
2906
    // The following descriptors are all top-level only descriptors.
2907
    // So if we are not at the top level, return early.
2908
5.08k
    if (ctx != ParseScriptContext::TOP) return nullptr;
2909
2910
5.06k
    CTxDestination dest;
2911
5.06k
    if (ExtractDestination(script, dest)) {
2912
3.06k
        if (GetScriptForDestination(dest) == script) {
2913
3.06k
            return std::make_unique<AddressDescriptor>(std::move(dest));
2914
3.06k
        }
2915
3.06k
    }
2916
2917
1.99k
    return std::make_unique<RawDescriptor>(script);
2918
5.06k
}
2919
2920
2921
} // namespace
2922
2923
/** Check a descriptor checksum, and update desc to be the checksum-less part. */
2924
bool CheckChecksum(std::span<const char>& sp, bool require_checksum, std::string& error, std::string* out_checksum = nullptr)
2925
11.9k
{
2926
11.9k
    auto check_split = Split(sp, '#');
2927
11.9k
    if (check_split.size() > 2) {
2928
2
        error = "Multiple '#' symbols";
2929
2
        return false;
2930
2
    }
2931
11.9k
    if (check_split.size() == 1 && require_checksum){
2932
7
        error = "Missing checksum";
2933
7
        return false;
2934
7
    }
2935
11.9k
    if (check_split.size() == 2) {
2936
6.68k
        if (check_split[1].size() != 8) {
2937
6
            error = strprintf("Expected 8 character checksum, not %u characters", check_split[1].size());
2938
6
            return false;
2939
6
        }
2940
6.68k
    }
2941
11.9k
    auto checksum = DescriptorChecksum(check_split[0]);
2942
11.9k
    if (checksum.empty()) {
2943
1
        error = "Invalid characters in payload";
2944
1
        return false;
2945
1
    }
2946
11.9k
    if (check_split.size() == 2) {
2947
6.67k
        if (!std::equal(checksum.begin(), checksum.end(), check_split[1].begin())) {
2948
11
            error = strprintf("Provided checksum '%s' does not match computed checksum '%s'", std::string(check_split[1].begin(), check_split[1].end()), checksum);
2949
11
            return false;
2950
11
        }
2951
6.67k
    }
2952
11.9k
    if (out_checksum) *out_checksum = std::move(checksum);
2953
11.9k
    sp = check_split[0];
2954
11.9k
    return true;
2955
11.9k
}
2956
2957
std::vector<std::unique_ptr<Descriptor>> Parse(std::string_view descriptor, FlatSigningProvider& out, std::string& error, bool require_checksum)
2958
11.6k
{
2959
11.6k
    std::span<const char> sp{descriptor};
2960
11.6k
    if (!CheckChecksum(sp, require_checksum, error)) return {};
2961
11.6k
    uint32_t key_exp_index = 0;
2962
11.6k
    auto ret = ParseScript(key_exp_index, sp, ParseScriptContext::TOP, out, error);
2963
11.6k
    if (sp.empty() && !ret.empty()) {
2964
11.0k
        std::vector<std::unique_ptr<Descriptor>> descs;
2965
11.0k
        descs.reserve(ret.size());
2966
11.3k
        for (auto& r : ret) {
2967
11.3k
            descs.emplace_back(std::unique_ptr<Descriptor>(std::move(r)));
2968
11.3k
        }
2969
11.0k
        return descs;
2970
11.0k
    }
2971
532
    return {};
2972
11.6k
}
2973
2974
std::string GetDescriptorChecksum(const std::string& descriptor)
2975
284
{
2976
284
    std::string ret;
2977
284
    std::string error;
2978
284
    std::span<const char> sp{descriptor};
2979
284
    if (!CheckChecksum(sp, false, error, &ret)) return "";
2980
280
    return ret;
2981
284
}
2982
2983
std::unique_ptr<Descriptor> InferDescriptor(const CScript& script, const SigningProvider& provider)
2984
294k
{
2985
294k
    return InferScript(script, ParseScriptContext::TOP, provider);
2986
294k
}
2987
2988
uint256 DescriptorID(const Descriptor& desc)
2989
7.92k
{
2990
7.92k
    std::string desc_str = desc.ToString(/*compat_format=*/true);
2991
7.92k
    uint256 id;
2992
7.92k
    CSHA256().Write((unsigned char*)desc_str.data(), desc_str.size()).Finalize(id.begin());
2993
7.92k
    return id;
2994
7.92k
}
2995
2996
void DescriptorCache::CacheParentExtPubKey(uint32_t key_exp_pos, const CExtPubKey& xpub)
2997
19.9k
{
2998
19.9k
    m_parent_xpubs[key_exp_pos] = xpub;
2999
19.9k
}
3000
3001
void DescriptorCache::CacheDerivedExtPubKey(uint32_t key_exp_pos, uint32_t der_index, const CExtPubKey& xpub)
3002
72.6k
{
3003
72.6k
    auto& xpubs = m_derived_xpubs[key_exp_pos];
3004
72.6k
    xpubs[der_index] = xpub;
3005
72.6k
}
3006
3007
void DescriptorCache::CacheLastHardenedExtPubKey(uint32_t key_exp_pos, const CExtPubKey& xpub)
3008
14.7k
{
3009
14.7k
    m_last_hardened_xpubs[key_exp_pos] = xpub;
3010
14.7k
}
3011
3012
bool DescriptorCache::GetCachedParentExtPubKey(uint32_t key_exp_pos, CExtPubKey& xpub) const
3013
645k
{
3014
645k
    const auto& it = m_parent_xpubs.find(key_exp_pos);
3015
645k
    if (it == m_parent_xpubs.end()) return false;
3016
635k
    xpub = it->second;
3017
635k
    return true;
3018
645k
}
3019
3020
bool DescriptorCache::GetCachedDerivedExtPubKey(uint32_t key_exp_pos, uint32_t der_index, CExtPubKey& xpub) const
3021
693k
{
3022
693k
    const auto& key_exp_it = m_derived_xpubs.find(key_exp_pos);
3023
693k
    if (key_exp_it == m_derived_xpubs.end()) return false;
3024
52.7k
    const auto& der_it = key_exp_it->second.find(der_index);
3025
52.7k
    if (der_it == key_exp_it->second.end()) return false;
3026
4.53k
    xpub = der_it->second;
3027
4.53k
    return true;
3028
52.7k
}
3029
3030
bool DescriptorCache::GetCachedLastHardenedExtPubKey(uint32_t key_exp_pos, CExtPubKey& xpub) const
3031
9.53k
{
3032
9.53k
    const auto& it = m_last_hardened_xpubs.find(key_exp_pos);
3033
9.53k
    if (it == m_last_hardened_xpubs.end()) return false;
3034
5.40k
    xpub = it->second;
3035
5.40k
    return true;
3036
9.53k
}
3037
3038
DescriptorCache DescriptorCache::MergeAndDiff(const DescriptorCache& other)
3039
429k
{
3040
429k
    DescriptorCache diff;
3041
429k
    for (const auto& parent_xpub_pair : other.GetCachedParentExtPubKeys()) {
3042
5.47k
        CExtPubKey xpub;
3043
5.47k
        if (GetCachedParentExtPubKey(parent_xpub_pair.first, xpub)) {
3044
6
            if (xpub != parent_xpub_pair.second) {
3045
0
                throw std::runtime_error(std::string(__func__) + ": New cached parent xpub does not match already cached parent xpub");
3046
0
            }
3047
6
            continue;
3048
6
        }
3049
5.46k
        CacheParentExtPubKey(parent_xpub_pair.first, parent_xpub_pair.second);
3050
5.46k
        diff.CacheParentExtPubKey(parent_xpub_pair.first, parent_xpub_pair.second);
3051
5.46k
    }
3052
429k
    for (const auto& derived_xpub_map_pair : other.GetCachedDerivedExtPubKeys()) {
3053
24.1k
        for (const auto& derived_xpub_pair : derived_xpub_map_pair.second) {
3054
24.1k
            CExtPubKey xpub;
3055
24.1k
            if (GetCachedDerivedExtPubKey(derived_xpub_map_pair.first, derived_xpub_pair.first, xpub)) {
3056
0
                if (xpub != derived_xpub_pair.second) {
3057
0
                    throw std::runtime_error(std::string(__func__) + ": New cached derived xpub does not match already cached derived xpub");
3058
0
                }
3059
0
                continue;
3060
0
            }
3061
24.1k
            CacheDerivedExtPubKey(derived_xpub_map_pair.first, derived_xpub_pair.first, derived_xpub_pair.second);
3062
24.1k
            diff.CacheDerivedExtPubKey(derived_xpub_map_pair.first, derived_xpub_pair.first, derived_xpub_pair.second);
3063
24.1k
        }
3064
24.1k
    }
3065
429k
    for (const auto& lh_xpub_pair : other.GetCachedLastHardenedExtPubKeys()) {
3066
4.12k
        CExtPubKey xpub;
3067
4.12k
        if (GetCachedLastHardenedExtPubKey(lh_xpub_pair.first, xpub)) {
3068
0
            if (xpub != lh_xpub_pair.second) {
3069
0
                throw std::runtime_error(std::string(__func__) + ": New cached last hardened xpub does not match already cached last hardened xpub");
3070
0
            }
3071
0
            continue;
3072
0
        }
3073
4.12k
        CacheLastHardenedExtPubKey(lh_xpub_pair.first, lh_xpub_pair.second);
3074
4.12k
        diff.CacheLastHardenedExtPubKey(lh_xpub_pair.first, lh_xpub_pair.second);
3075
4.12k
    }
3076
429k
    return diff;
3077
429k
}
3078
3079
ExtPubKeyMap DescriptorCache::GetCachedParentExtPubKeys() const
3080
861k
{
3081
861k
    return m_parent_xpubs;
3082
861k
}
3083
3084
std::unordered_map<uint32_t, ExtPubKeyMap> DescriptorCache::GetCachedDerivedExtPubKeys() const
3085
861k
{
3086
861k
    return m_derived_xpubs;
3087
861k
}
3088
3089
ExtPubKeyMap DescriptorCache::GetCachedLastHardenedExtPubKeys() const
3090
860k
{
3091
860k
    return m_last_hardened_xpubs;
3092
860k
}