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