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