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 <hash.h>
8 : : #include <key_io.h>
9 : : #include <pubkey.h>
10 : : #include <script/miniscript.h>
11 : : #include <script/parsing.h>
12 : : #include <script/script.h>
13 : : #include <script/signingprovider.h>
14 : : #include <script/solver.h>
15 : : #include <uint256.h>
16 : :
17 : : #include <common/args.h>
18 : : #include <span.h>
19 : : #include <util/bip32.h>
20 : : #include <util/check.h>
21 : : #include <util/strencodings.h>
22 : : #include <util/vector.h>
23 : :
24 : : #include <algorithm>
25 : : #include <memory>
26 : : #include <numeric>
27 : : #include <optional>
28 : : #include <string>
29 : : #include <vector>
30 : :
31 : : using util::Split;
32 : :
33 : : namespace {
34 : :
35 : : ////////////////////////////////////////////////////////////////////////////
36 : : // Checksum //
37 : : ////////////////////////////////////////////////////////////////////////////
38 : :
39 : : // This section implements a checksum algorithm for descriptors with the
40 : : // following properties:
41 : : // * Mistakes in a descriptor string are measured in "symbol errors". The higher
42 : : // the number of symbol errors, the harder it is to detect:
43 : : // * An error substituting a character from 0123456789()[],'/*abcdefgh@:$%{} for
44 : : // another in that set always counts as 1 symbol error.
45 : : // * Note that hex encoded keys are covered by these characters. Xprvs and
46 : : // xpubs use other characters too, but already have their own checksum
47 : : // mechanism.
48 : : // * Function names like "multi()" use other characters, but mistakes in
49 : : // these would generally result in an unparsable descriptor.
50 : : // * A case error always counts as 1 symbol error.
51 : : // * Any other 1 character substitution error counts as 1 or 2 symbol errors.
52 : : // * Any 1 symbol error is always detected.
53 : : // * Any 2 or 3 symbol error in a descriptor of up to 49154 characters is always detected.
54 : : // * Any 4 symbol error in a descriptor of up to 507 characters is always detected.
55 : : // * Any 5 symbol error in a descriptor of up to 77 characters is always detected.
56 : : // * Is optimized to minimize the chance a 5 symbol error in a descriptor up to 387 characters is undetected
57 : : // * Random errors have a chance of 1 in 2**40 of being undetected.
58 : : //
59 : : // These properties are achieved by expanding every group of 3 (non checksum) characters into
60 : : // 4 GF(32) symbols, over which a cyclic code is defined.
61 : :
62 : : /*
63 : : * Interprets c as 8 groups of 5 bits which are the coefficients of a degree 8 polynomial over GF(32),
64 : : * multiplies that polynomial by x, computes its remainder modulo a generator, and adds the constant term val.
65 : : *
66 : : * 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}.
67 : : * It is chosen to define an cyclic error detecting code which is selected by:
68 : : * - Starting from all BCH codes over GF(32) of degree 8 and below, which by construction guarantee detecting
69 : : * 3 errors in windows up to 19000 symbols.
70 : : * - Taking all those generators, and for degree 7 ones, extend them to degree 8 by adding all degree-1 factors.
71 : : * - Selecting just the set of generators that guarantee detecting 4 errors in a window of length 512.
72 : : * - Selecting one of those with best worst-case behavior for 5 errors in windows of length up to 512.
73 : : *
74 : : * The generator and the constants to implement it can be verified using this Sage code:
75 : : * B = GF(2) # Binary field
76 : : * BP.<b> = B[] # Polynomials over the binary field
77 : : * F_mod = b**5 + b**3 + 1
78 : : * F.<f> = GF(32, modulus=F_mod, repr='int') # GF(32) definition
79 : : * FP.<x> = F[] # Polynomials over GF(32)
80 : : * E_mod = x**3 + x + F.fetch_int(8)
81 : : * E.<e> = F.extension(E_mod) # Extension field definition
82 : : * alpha = e**2743 # Choice of an element in extension field
83 : : * for p in divisors(E.order() - 1): # Verify alpha has order 32767.
84 : : * assert((alpha**p == 1) == (p % 32767 == 0))
85 : : * G = lcm([(alpha**i).minpoly() for i in [1056,1057,1058]] + [x + 1])
86 : : * print(G) # Print out the generator
87 : : * for i in [1,2,4,8,16]: # Print out {1,2,4,8,16}*(G mod x^8), packed in hex integers.
88 : : * v = 0
89 : : * for coef in reversed((F.fetch_int(i)*(G % x**8)).coefficients(sparse=True)):
90 : : * v = v*32 + coef.integer_representation()
91 : : * print("0x%x" % v)
92 : : */
93 : 629523497 : uint64_t PolyMod(uint64_t c, int val)
94 : : {
95 : 629523497 : uint8_t c0 = c >> 35;
96 : 629523497 : c = ((c & 0x7ffffffff) << 5) ^ val;
97 [ + + ]: 629523497 : if (c0 & 1) c ^= 0xf5dee51989;
98 [ + + ]: 629523497 : if (c0 & 2) c ^= 0xa9fdca3312;
99 [ + + ]: 629523497 : if (c0 & 4) c ^= 0x1bab10e32d;
100 [ + + ]: 629523497 : if (c0 & 8) c ^= 0x3706b1677a;
101 [ + + ]: 629523497 : if (c0 & 16) c ^= 0x644d626ffd;
102 : 629523497 : return c;
103 : : }
104 : :
105 : 2210017 : std::string DescriptorChecksum(const std::span<const char>& span)
106 : : {
107 : : /** A character set designed such that:
108 : : * - The most common 'unprotected' descriptor characters (hex, keypaths) are in the first group of 32.
109 : : * - Case errors cause an offset that's a multiple of 32.
110 : : * - As many alphabetic characters are in the same group (while following the above restrictions).
111 : : *
112 : : * If p(x) gives the position of a character c in this character set, every group of 3 characters
113 : : * (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).
114 : : * This means that changes that only affect the lower 5 bits of the position, or only the higher 2 bits, will just
115 : : * affect a single symbol.
116 : : *
117 : : * As a result, within-group-of-32 errors count as 1 symbol, as do cross-group errors that don't affect
118 : : * the position within the groups.
119 : : */
120 : 2210017 : static const std::string INPUT_CHARSET =
121 : : "0123456789()[],'/*abcdefgh@:$%{}"
122 : : "IJKLMNOPQRSTUVWXYZ&+-.;<=>?!^_|~"
123 [ + + + - : 2210027 : "ijklmnopqrstuvwxyzABCDEFGH`#\"\\ ";
+ - ]
124 : :
125 : : /** The character set for the checksum itself (same as bech32). */
126 [ + + + - : 2210027 : static const std::string CHECKSUM_CHARSET = "qpzry9x8gf2tvdw0s3jn54khce6mua7l";
+ - ]
127 : :
128 : 2210017 : uint64_t c = 1;
129 : 2210017 : int cls = 0;
130 : 2210017 : int clscount = 0;
131 [ + + ]: 460249809 : for (auto ch : span) {
132 : 458039986 : auto pos = INPUT_CHARSET.find(ch);
133 [ + + ]: 458039986 : if (pos == std::string::npos) return "";
134 : 458039792 : c = PolyMod(c, pos & 31); // Emit a symbol for the position inside the group, for every character.
135 : 458039792 : cls = cls * 3 + (pos >> 5); // Accumulate the group numbers
136 [ + + ]: 458039792 : if (++clscount == 3) {
137 : : // Emit an extra symbol representing the group numbers, for every 3 characters.
138 : 151773164 : c = PolyMod(c, cls);
139 : 151773164 : cls = 0;
140 : 151773164 : clscount = 0;
141 : : }
142 : : }
143 [ + + ]: 2209823 : if (clscount > 0) c = PolyMod(c, cls);
144 [ + + ]: 19888407 : for (int j = 0; j < 8; ++j) c = PolyMod(c, 0); // Shift further to determine the checksum.
145 : 2209823 : c ^= 1; // Prevent appending zeroes from not affecting the checksum.
146 : :
147 : 2209823 : std::string ret(8, ' ');
148 [ + + ]: 19888407 : for (int j = 0; j < 8; ++j) ret[j] = CHECKSUM_CHARSET[(c >> (5 * (7 - j))) & 31];
149 : 2209823 : return ret;
150 : 2209823 : }
151 : :
152 [ + - + - ]: 4343498 : std::string AddChecksum(const std::string& str) { return str + "#" + DescriptorChecksum(str); }
153 : :
154 : : ////////////////////////////////////////////////////////////////////////////
155 : : // Internal representation //
156 : : ////////////////////////////////////////////////////////////////////////////
157 : :
158 : : typedef std::vector<uint32_t> KeyPath;
159 : :
160 : : /** Interface for public key objects in descriptors. */
161 : : struct PubkeyProvider
162 : : {
163 : : protected:
164 : : //! Index of this key expression in the descriptor
165 : : //! E.g. If this PubkeyProvider is key1 in multi(2, key1, key2, key3), then m_expr_index = 0
166 : : uint32_t m_expr_index;
167 : :
168 : : public:
169 : 8816484 : explicit PubkeyProvider(uint32_t exp_index) : m_expr_index(exp_index) {}
170 : :
171 : 0 : virtual ~PubkeyProvider() = default;
172 : :
173 : : /** Compare two public keys represented by this provider.
174 : : * Used by the Miniscript descriptors to check for duplicate keys in the script.
175 : : */
176 : 180639 : bool operator<(PubkeyProvider& other) const {
177 [ + - ]: 180639 : CPubKey a, b;
178 : 180639 : SigningProvider dummy;
179 [ + - ]: 180639 : KeyOriginInfo dummy_info;
180 : :
181 [ + - ]: 180639 : GetPubKey(0, dummy, a, dummy_info);
182 [ + - ]: 180639 : other.GetPubKey(0, dummy, b, dummy_info);
183 : :
184 : 180639 : return a < b;
185 : 180639 : }
186 : :
187 : : /** Derive a public key.
188 : : * read_cache is the cache to read keys from (if not nullptr)
189 : : * write_cache is the cache to write keys to (if not nullptr)
190 : : * Caches are not exclusive but this is not tested. Currently we use them exclusively
191 : : */
192 : : virtual bool GetPubKey(int pos, const SigningProvider& arg, CPubKey& key, KeyOriginInfo& info, const DescriptorCache* read_cache = nullptr, DescriptorCache* write_cache = nullptr) const = 0;
193 : :
194 : : /** Whether this represent multiple public keys at different positions. */
195 : : virtual bool IsRange() const = 0;
196 : :
197 : : /** Get the size of the generated public key(s) in bytes (33 or 65). */
198 : : virtual size_t GetSize() const = 0;
199 : :
200 : : enum class StringType {
201 : : PUBLIC,
202 : : COMPAT // string calculation that mustn't change over time to stay compatible with previous software versions
203 : : };
204 : :
205 : : /** Get the descriptor string form. */
206 : : virtual std::string ToString(StringType type=StringType::PUBLIC) const = 0;
207 : :
208 : : /** Get the descriptor string form including private data (if available in arg). */
209 : : virtual bool ToPrivateString(const SigningProvider& arg, std::string& out) const = 0;
210 : :
211 : : /** Get the descriptor string form with the xpub at the last hardened derivation,
212 : : * and always use h for hardened derivation.
213 : : */
214 : : virtual bool ToNormalizedString(const SigningProvider& arg, std::string& out, const DescriptorCache* cache = nullptr) const = 0;
215 : :
216 : : /** Derive a private key, if private data is available in arg. */
217 : : virtual bool GetPrivKey(int pos, const SigningProvider& arg, CKey& key) const = 0;
218 : :
219 : : /** Return the non-extended public key for this PubkeyProvider, if it has one. */
220 : : virtual std::optional<CPubKey> GetRootPubKey() const = 0;
221 : : /** Return the extended public key for this PubkeyProvider, if it has one. */
222 : : virtual std::optional<CExtPubKey> GetRootExtPubKey() const = 0;
223 : :
224 : : /** Make a deep copy of this PubkeyProvider */
225 : : virtual std::unique_ptr<PubkeyProvider> Clone() const = 0;
226 : : };
227 : :
228 : : class OriginPubkeyProvider final : public PubkeyProvider
229 : : {
230 : : KeyOriginInfo m_origin;
231 : : std::unique_ptr<PubkeyProvider> m_provider;
232 : : bool m_apostrophe;
233 : :
234 : 1102579 : std::string OriginString(StringType type, bool normalized=false) const
235 : : {
236 : : // If StringType==COMPAT, always use the apostrophe to stay compatible with previous versions
237 [ + + + + : 1102579 : bool use_apostrophe = (!normalized && m_apostrophe) || type == StringType::COMPAT;
+ + ]
238 [ + - + - ]: 2205158 : return HexStr(m_origin.fingerprint) + FormatHDKeypath(m_origin.path, use_apostrophe);
239 : : }
240 : :
241 : : public:
242 : 4108743 : 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) {}
243 : 1241348 : bool GetPubKey(int pos, const SigningProvider& arg, CPubKey& key, KeyOriginInfo& info, const DescriptorCache* read_cache = nullptr, DescriptorCache* write_cache = nullptr) const override
244 : : {
245 [ + + ]: 1241348 : if (!m_provider->GetPubKey(pos, arg, key, info, read_cache, write_cache)) return false;
246 : 1212847 : std::copy(std::begin(m_origin.fingerprint), std::end(m_origin.fingerprint), info.fingerprint);
247 : 1212847 : info.path.insert(info.path.begin(), m_origin.path.begin(), m_origin.path.end());
248 : 1212847 : return true;
249 : : }
250 : 1072283 : bool IsRange() const override { return m_provider->IsRange(); }
251 : 1033302 : size_t GetSize() const override { return m_provider->GetSize(); }
252 [ + - + - : 3211536 : std::string ToString(StringType type) const override { return "[" + OriginString(type) + "]" + m_provider->ToString(type); }
+ - ]
253 : 2194 : bool ToPrivateString(const SigningProvider& arg, std::string& ret) const override
254 : : {
255 [ + - ]: 2194 : std::string sub;
256 [ + - + + ]: 2194 : if (!m_provider->ToPrivateString(arg, sub)) return false;
257 [ + - + - : 4040 : ret = "[" + OriginString(StringType::PUBLIC) + "]" + std::move(sub);
+ - ]
258 : 2020 : return true;
259 : 2194 : }
260 : 30179 : bool ToNormalizedString(const SigningProvider& arg, std::string& ret, const DescriptorCache* cache) const override
261 : : {
262 [ + - ]: 30179 : std::string sub;
263 [ + - + + ]: 30179 : if (!m_provider->ToNormalizedString(arg, sub, cache)) return false;
264 : : // If m_provider is a BIP32PubkeyProvider, we may get a string formatted like a OriginPubkeyProvider
265 : : // In that case, we need to strip out the leading square bracket and fingerprint from the substring,
266 : : // and append that to our own origin string.
267 [ + + ]: 30047 : if (sub[0] == '[') {
268 [ + - ]: 11608 : sub = sub.substr(9);
269 [ + - + - : 11608 : ret = "[" + OriginString(StringType::PUBLIC, /*normalized=*/true) + std::move(sub);
+ - ]
270 : : } else {
271 [ + - + - : 36878 : ret = "[" + OriginString(StringType::PUBLIC, /*normalized=*/true) + "]" + std::move(sub);
+ - ]
272 : : }
273 : : return true;
274 : 30179 : }
275 : 76951 : bool GetPrivKey(int pos, const SigningProvider& arg, CKey& key) const override
276 : : {
277 : 76951 : return m_provider->GetPrivKey(pos, arg, key);
278 : : }
279 : 0 : std::optional<CPubKey> GetRootPubKey() const override
280 : : {
281 : 0 : return m_provider->GetRootPubKey();
282 : : }
283 : 0 : std::optional<CExtPubKey> GetRootExtPubKey() const override
284 : : {
285 : 0 : return m_provider->GetRootExtPubKey();
286 : : }
287 : 14496 : std::unique_ptr<PubkeyProvider> Clone() const override
288 : : {
289 [ + - - + ]: 14496 : return std::make_unique<OriginPubkeyProvider>(m_expr_index, m_origin, m_provider->Clone(), m_apostrophe);
290 : : }
291 : : };
292 : :
293 : : /** An object representing a parsed constant public key in a descriptor. */
294 : 0 : class ConstPubkeyProvider final : public PubkeyProvider
295 : : {
296 : : CPubKey m_pubkey;
297 : : bool m_xonly;
298 : :
299 : : public:
300 : 4355369 : ConstPubkeyProvider(uint32_t exp_index, const CPubKey& pubkey, bool xonly) : PubkeyProvider(exp_index), m_pubkey(pubkey), m_xonly(xonly) {}
301 : 1002646 : bool GetPubKey(int pos, const SigningProvider& arg, CPubKey& key, KeyOriginInfo& info, const DescriptorCache* read_cache = nullptr, DescriptorCache* write_cache = nullptr) const override
302 : : {
303 : 1002646 : key = m_pubkey;
304 [ + + ]: 1002646 : info.path.clear();
305 : 1002646 : CKeyID keyid = m_pubkey.GetID();
306 : 1002646 : std::copy(keyid.begin(), keyid.begin() + sizeof(info.fingerprint), info.fingerprint);
307 : 1002646 : return true;
308 : : }
309 : 160802 : bool IsRange() const override { return false; }
310 : 1093783 : size_t GetSize() const override { return m_pubkey.size(); }
311 [ + + + - ]: 1506027 : std::string ToString(StringType type) const override { return m_xonly ? HexStr(m_pubkey).substr(2) : HexStr(m_pubkey); }
312 : 14841 : bool ToPrivateString(const SigningProvider& arg, std::string& ret) const override
313 : : {
314 : 14841 : CKey key;
315 [ + - + + ]: 14841 : if (!GetPrivKey(/*pos=*/0, arg, key)) return false;
316 [ + - ]: 10047 : ret = EncodeSecret(key);
317 : 10047 : return true;
318 : 14841 : }
319 : 113841 : bool ToNormalizedString(const SigningProvider& arg, std::string& ret, const DescriptorCache* cache) const override
320 : : {
321 : 113841 : ret = ToString(StringType::PUBLIC);
322 : 113841 : return true;
323 : : }
324 : 128494 : bool GetPrivKey(int pos, const SigningProvider& arg, CKey& key) const override
325 : : {
326 [ + + ]: 128494 : return m_xonly ? arg.GetKeyByXOnly(XOnlyPubKey(m_pubkey), key) :
327 : 32928 : arg.GetKey(m_pubkey.GetID(), key);
328 : : }
329 : 0 : std::optional<CPubKey> GetRootPubKey() const override
330 : : {
331 : 0 : return m_pubkey;
332 : : }
333 : 0 : std::optional<CExtPubKey> GetRootExtPubKey() const override
334 : : {
335 : 0 : return std::nullopt;
336 : : }
337 : 96114 : std::unique_ptr<PubkeyProvider> Clone() const override
338 : : {
339 : 96114 : return std::make_unique<ConstPubkeyProvider>(m_expr_index, m_pubkey, m_xonly);
340 : : }
341 : : };
342 : :
343 : : enum class DeriveType {
344 : : NO,
345 : : UNHARDENED,
346 : : HARDENED,
347 : : };
348 : :
349 : : /** An object representing a parsed extended public key in a descriptor. */
350 : : class BIP32PubkeyProvider final : public PubkeyProvider
351 : : {
352 : : // Root xpub, path, and final derivation step type being used, if any
353 : : CExtPubKey m_root_extkey;
354 : : KeyPath m_path;
355 : : DeriveType m_derive;
356 : : // Whether ' or h is used in harded derivation
357 : : bool m_apostrophe;
358 : :
359 : 475623 : bool GetExtKey(const SigningProvider& arg, CExtKey& ret) const
360 : : {
361 : 475623 : CKey key;
362 [ + - + - : 475623 : if (!arg.GetKey(m_root_extkey.pubkey.GetID(), key)) return false;
+ + ]
363 : 396011 : ret.nDepth = m_root_extkey.nDepth;
364 : 396011 : std::copy(m_root_extkey.vchFingerprint, m_root_extkey.vchFingerprint + sizeof(ret.vchFingerprint), ret.vchFingerprint);
365 : 396011 : ret.nChild = m_root_extkey.nChild;
366 : 396011 : ret.chaincode = m_root_extkey.chaincode;
367 [ + - ]: 396011 : ret.key = key;
368 : : return true;
369 : 475623 : }
370 : :
371 : : // Derives the last xprv
372 : 436251 : bool GetDerivedExtKey(const SigningProvider& arg, CExtKey& xprv, CExtKey& last_hardened) const
373 : : {
374 [ + + ]: 436251 : if (!GetExtKey(arg, xprv)) return false;
375 [ + + ]: 736191 : for (auto entry : m_path) {
376 [ + - ]: 371984 : if (!xprv.Derive(xprv, entry)) return false;
377 [ + + ]: 371984 : if (entry >> 31) {
378 : 102072 : last_hardened = xprv;
379 : : }
380 : : }
381 : : return true;
382 : : }
383 : :
384 : 520200 : bool IsHardened() const
385 : : {
386 [ + + ]: 520200 : if (m_derive == DeriveType::HARDENED) return true;
387 [ + + ]: 825908 : for (auto entry : m_path) {
388 [ + + ]: 382981 : if (entry >> 31) return true;
389 : : }
390 : : return false;
391 : : }
392 : :
393 : : public:
394 : 352372 : 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) {}
395 : 3163207 : bool IsRange() const override { return m_derive != DeriveType::NO; }
396 : 116537 : size_t GetSize() const override { return 33; }
397 : 1969916 : bool GetPubKey(int pos, const SigningProvider& arg, CPubKey& key_out, KeyOriginInfo& final_info_out, const DescriptorCache* read_cache = nullptr, DescriptorCache* write_cache = nullptr) const override
398 : : {
399 : : // Info of parent of the to be derived pubkey
400 [ + - ]: 1969916 : KeyOriginInfo parent_info;
401 [ + - ]: 1969916 : CKeyID keyid = m_root_extkey.pubkey.GetID();
402 : 1969916 : std::copy(keyid.begin(), keyid.begin() + sizeof(parent_info.fingerprint), parent_info.fingerprint);
403 [ + - ]: 1969916 : parent_info.path = m_path;
404 : :
405 : : // Info of the derived key itself which is copied out upon successful completion
406 [ + - ]: 1969916 : KeyOriginInfo final_info_out_tmp = parent_info;
407 [ + + + - ]: 1969916 : if (m_derive == DeriveType::UNHARDENED) final_info_out_tmp.path.push_back((uint32_t)pos);
408 [ + + + - ]: 1969916 : if (m_derive == DeriveType::HARDENED) final_info_out_tmp.path.push_back(((uint32_t)pos) | 0x80000000L);
409 : :
410 : : // Derive keys or fetch them from cache
411 : 1969916 : CExtPubKey final_extkey = m_root_extkey;
412 : 1969916 : CExtPubKey parent_extkey = m_root_extkey;
413 [ + + ]: 1969916 : CExtPubKey last_hardened_extkey;
414 : 1969916 : bool der = true;
415 [ + + ]: 1969916 : if (read_cache) {
416 [ + - + + ]: 1449716 : if (!read_cache->GetCachedDerivedExtPubKey(m_expr_index, pos, final_extkey)) {
417 [ + + ]: 1411342 : if (m_derive == DeriveType::HARDENED) return false;
418 : : // Try to get the derivation parent
419 [ + - + + ]: 1408383 : if (!read_cache->GetCachedParentExtPubKey(m_expr_index, parent_extkey)) return false;
420 : 1381137 : final_extkey = parent_extkey;
421 [ + + + - ]: 1381137 : if (m_derive == DeriveType::UNHARDENED) der = parent_extkey.Derive(final_extkey, pos);
422 : : }
423 [ + + ]: 520200 : } else if (IsHardened()) {
424 [ + - ]: 77273 : CExtKey xprv;
425 : 77273 : CExtKey lh_xprv;
426 [ + - + + ]: 77273 : if (!GetDerivedExtKey(arg, xprv, lh_xprv)) return false;
427 [ + - ]: 63144 : parent_extkey = xprv.Neuter();
428 [ + + + - ]: 63144 : if (m_derive == DeriveType::UNHARDENED) der = xprv.Derive(xprv, pos);
429 [ + + + - ]: 63144 : if (m_derive == DeriveType::HARDENED) der = xprv.Derive(xprv, pos | 0x80000000UL);
430 [ + - ]: 63144 : final_extkey = xprv.Neuter();
431 [ + + ]: 63144 : if (lh_xprv.key.IsValid()) {
432 [ + - ]: 30244 : last_hardened_extkey = lh_xprv.Neuter();
433 : : }
434 : 77273 : } else {
435 [ + + ]: 776092 : for (auto entry : m_path) {
436 [ + - + - ]: 333165 : if (!parent_extkey.Derive(parent_extkey, entry)) return false;
437 : : }
438 : 442927 : final_extkey = parent_extkey;
439 [ + + + - ]: 442927 : if (m_derive == DeriveType::UNHARDENED) der = parent_extkey.Derive(final_extkey, pos);
440 [ - + ]: 442927 : assert(m_derive != DeriveType::HARDENED);
441 : : }
442 [ + - ]: 1513472 : if (!der) return false;
443 : :
444 [ + - ]: 1925582 : final_info_out = final_info_out_tmp;
445 : 1925582 : key_out = final_extkey.pubkey;
446 : :
447 [ + + ]: 1925582 : if (write_cache) {
448 : : // Only cache parent if there is any unhardened derivation
449 [ + + ]: 407718 : if (m_derive != DeriveType::HARDENED) {
450 [ + - ]: 374629 : write_cache->CacheParentExtPubKey(m_expr_index, parent_extkey);
451 : : // Cache last hardened xpub if we have it
452 [ + + ]: 374629 : if (last_hardened_extkey.pubkey.IsValid()) {
453 [ + - ]: 30055 : write_cache->CacheLastHardenedExtPubKey(m_expr_index, last_hardened_extkey);
454 : : }
455 [ + - ]: 33089 : } else if (final_info_out.path.size() > 0) {
456 [ + - ]: 33089 : write_cache->CacheDerivedExtPubKey(m_expr_index, pos, final_extkey);
457 : : }
458 : : }
459 : :
460 : : return true;
461 : 1969916 : }
462 : 1838806 : std::string ToString(StringType type, bool normalized) const
463 : : {
464 : : // If StringType==COMPAT, always use the apostrophe to stay compatible with previous versions
465 [ + + + + : 1838806 : const bool use_apostrophe = (!normalized && m_apostrophe) || type == StringType::COMPAT;
+ + ]
466 [ + - + - ]: 3677612 : std::string ret = EncodeExtPubKey(m_root_extkey) + FormatHDKeypath(m_path, /*apostrophe=*/use_apostrophe);
467 [ + + ]: 1838806 : if (IsRange()) {
468 [ + - ]: 1131150 : ret += "/*";
469 [ + + + + ]: 1131150 : if (m_derive == DeriveType::HARDENED) ret += use_apostrophe ? '\'' : 'h';
470 : : }
471 : 1838806 : return ret;
472 : 0 : }
473 : 1822994 : std::string ToString(StringType type=StringType::PUBLIC) const override
474 : : {
475 : 1607802 : return ToString(type, /*normalized=*/false);
476 : : }
477 : 39372 : bool ToPrivateString(const SigningProvider& arg, std::string& out) const override
478 : : {
479 [ + - ]: 39372 : CExtKey key;
480 [ + - + + ]: 39372 : if (!GetExtKey(arg, key)) return false;
481 [ + - + - : 31804 : out = EncodeExtKey(key) + FormatHDKeypath(m_path, /*apostrophe=*/m_apostrophe);
+ - ]
482 [ + + ]: 31804 : if (IsRange()) {
483 [ + - ]: 2255 : out += "/*";
484 [ + + + + ]: 40405 : if (m_derive == DeriveType::HARDENED) out += m_apostrophe ? '\'' : 'h';
485 : : }
486 : : return true;
487 : 39372 : }
488 : 260167 : bool ToNormalizedString(const SigningProvider& arg, std::string& out, const DescriptorCache* cache) const override
489 : : {
490 [ + + ]: 260167 : if (m_derive == DeriveType::HARDENED) {
491 : 15812 : out = ToString(StringType::PUBLIC, /*normalized=*/true);
492 : :
493 : 15812 : return true;
494 : : }
495 : : // Step backwards to find the last hardened step in the path
496 : 244355 : int i = (int)m_path.size() - 1;
497 [ + + ]: 440915 : for (; i >= 0; --i) {
498 [ + + ]: 225723 : if (m_path.at(i) >> 31) {
499 : : break;
500 : : }
501 : : }
502 : : // Either no derivation or all unhardened derivation
503 [ + + ]: 244355 : if (i == -1) {
504 : 215192 : out = ToString();
505 : 215192 : return true;
506 : : }
507 : : // Get the path to the last hardened stup
508 : 29163 : KeyOriginInfo origin;
509 : 29163 : int k = 0;
510 [ + + ]: 70011 : for (; k <= i; ++k) {
511 : : // Add to the path
512 [ + - + - ]: 40848 : origin.path.push_back(m_path.at(k));
513 : : }
514 : : // Build the remaining path
515 : 29163 : KeyPath end_path;
516 [ + + ]: 32363 : for (; k < (int)m_path.size(); ++k) {
517 [ + - + - ]: 3200 : end_path.push_back(m_path.at(k));
518 : : }
519 : : // Get the fingerprint
520 [ + - ]: 29163 : CKeyID id = m_root_extkey.pubkey.GetID();
521 : 29163 : std::copy(id.begin(), id.begin() + 4, origin.fingerprint);
522 : :
523 [ + + ]: 29163 : CExtPubKey xpub;
524 [ + + ]: 29163 : CExtKey lh_xprv;
525 : : // If we have the cache, just get the parent xpub
526 [ + + ]: 29163 : if (cache != nullptr) {
527 [ + - ]: 1329 : cache->GetCachedLastHardenedExtPubKey(m_expr_index, xpub);
528 : : }
529 [ + + ]: 29163 : if (!xpub.pubkey.IsValid()) {
530 : : // Cache miss, or nor cache, or need privkey
531 [ + - ]: 28852 : CExtKey xprv;
532 [ + - + + ]: 28852 : if (!GetDerivedExtKey(arg, xprv, lh_xprv)) return false;
533 [ + - ]: 27362 : xpub = lh_xprv.Neuter();
534 : 28852 : }
535 [ - + ]: 27673 : assert(xpub.pubkey.IsValid());
536 : :
537 : : // Build the string
538 [ + - + - : 55346 : std::string origin_str = HexStr(origin.fingerprint) + FormatHDKeypath(origin.path);
+ - ]
539 [ + - + - : 55346 : out = "[" + origin_str + "]" + EncodeExtPubKey(xpub) + FormatHDKeypath(end_path);
+ - + - +
- ]
540 [ + + ]: 27673 : if (IsRange()) {
541 [ + - ]: 236 : out += "/*";
542 [ - + ]: 236 : assert(m_derive == DeriveType::UNHARDENED);
543 : : }
544 : 27673 : return true;
545 : 56836 : }
546 : 330126 : bool GetPrivKey(int pos, const SigningProvider& arg, CKey& key) const override
547 : : {
548 [ + - ]: 330126 : CExtKey extkey;
549 : 330126 : CExtKey dummy;
550 [ + - + + ]: 330126 : if (!GetDerivedExtKey(arg, extkey, dummy)) return false;
551 [ + + + - : 273701 : if (m_derive == DeriveType::UNHARDENED && !extkey.Derive(extkey, pos)) return false;
+ - ]
552 [ + + + - : 273701 : if (m_derive == DeriveType::HARDENED && !extkey.Derive(extkey, pos | 0x80000000UL)) return false;
+ - ]
553 [ + - ]: 273701 : key = extkey.key;
554 : : return true;
555 : 330126 : }
556 : 0 : std::optional<CPubKey> GetRootPubKey() const override
557 : : {
558 : 0 : return std::nullopt;
559 : : }
560 : 0 : std::optional<CExtPubKey> GetRootExtPubKey() const override
561 : : {
562 : 0 : return m_root_extkey;
563 : : }
564 : 201620 : std::unique_ptr<PubkeyProvider> Clone() const override
565 : : {
566 [ - + ]: 201620 : return std::make_unique<BIP32PubkeyProvider>(m_expr_index, m_root_extkey, m_path, m_derive, m_apostrophe);
567 : : }
568 : : };
569 : :
570 : : /** Base class for all Descriptor implementations. */
571 : : class DescriptorImpl : public Descriptor
572 : : {
573 : : protected:
574 : : //! Public key arguments for this descriptor (size 1 for PK, PKH, WPKH; any size for WSH and Multisig).
575 : : const std::vector<std::unique_ptr<PubkeyProvider>> m_pubkey_args;
576 : : //! The string name of the descriptor function.
577 : : const std::string m_name;
578 : :
579 : : //! The sub-descriptor arguments (empty for everything but SH and WSH).
580 : : //! In doc/descriptors.m this is referred to as SCRIPT expressions sh(SCRIPT)
581 : : //! and wsh(SCRIPT), and distinct from KEY expressions and ADDR expressions.
582 : : //! Subdescriptors can only ever generate a single script.
583 : : const std::vector<std::unique_ptr<DescriptorImpl>> m_subdescriptor_args;
584 : :
585 : : //! Return a serialization of anything except pubkey and script arguments, to be prepended to those.
586 : 1627945 : virtual std::string ToStringExtra() const { return ""; }
587 : :
588 : : /** A helper function to construct the scripts for this descriptor.
589 : : *
590 : : * This function is invoked once by ExpandHelper.
591 : : *
592 : : * @param pubkeys The evaluations of the m_pubkey_args field.
593 : : * @param scripts The evaluations of m_subdescriptor_args (one for each m_subdescriptor_args element).
594 : : * @param out A FlatSigningProvider to put scripts or public keys in that are necessary to the solver.
595 : : * The origin info of the provided pubkeys is automatically added.
596 : : * @return A vector with scriptPubKeys for this descriptor.
597 : : */
598 : : virtual std::vector<CScript> MakeScripts(const std::vector<CPubKey>& pubkeys, std::span<const CScript> scripts, FlatSigningProvider& out) const = 0;
599 : :
600 : : public:
601 [ + - ]: 4439654 : DescriptorImpl(std::vector<std::unique_ptr<PubkeyProvider>> pubkeys, const std::string& name) : m_pubkey_args(std::move(pubkeys)), m_name(name), m_subdescriptor_args() {}
602 [ + - + - ]: 2186090 : 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))) {}
603 [ + - ]: 415382 : 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)) {}
604 : :
605 : : enum class StringType
606 : : {
607 : : PUBLIC,
608 : : PRIVATE,
609 : : NORMALIZED,
610 : : COMPAT, // string calculation that mustn't change over time to stay compatible with previous software versions
611 : : };
612 : :
613 : : // NOLINTNEXTLINE(misc-no-recursion)
614 : 25456 : bool IsSolvable() const override
615 : : {
616 [ + + ]: 50258 : for (const auto& arg : m_subdescriptor_args) {
617 [ + - ]: 24802 : if (!arg->IsSolvable()) return false;
618 : : }
619 : : return true;
620 : : }
621 : :
622 : : // NOLINTNEXTLINE(misc-no-recursion)
623 : 1627526 : bool IsRange() const final
624 : : {
625 [ + + ]: 2004632 : for (const auto& pubkey : m_pubkey_args) {
626 [ + + ]: 1425726 : if (pubkey->IsRange()) return true;
627 : : }
628 [ + + ]: 628596 : for (const auto& arg : m_subdescriptor_args) {
629 [ + + ]: 541610 : if (arg->IsRange()) return true;
630 : : }
631 : : return false;
632 : : }
633 : :
634 : : // NOLINTNEXTLINE(misc-no-recursion)
635 : 2385879 : virtual bool ToStringSubScriptHelper(const SigningProvider* arg, std::string& ret, const StringType type, const DescriptorCache* cache = nullptr) const
636 : : {
637 : 2385879 : size_t pos = 0;
638 [ + + ]: 2893828 : for (const auto& scriptarg : m_subdescriptor_args) {
639 [ - + ]: 514926 : if (pos++) ret += ",";
640 [ + - ]: 514926 : std::string tmp;
641 [ + - + + ]: 514926 : if (!scriptarg->ToStringHelper(arg, tmp, type, cache)) return false;
642 [ + - ]: 1015898 : ret += tmp;
643 : 514926 : }
644 : : return true;
645 : : }
646 : :
647 : : // NOLINTNEXTLINE(misc-no-recursion)
648 : 2682459 : virtual bool ToStringHelper(const SigningProvider* arg, std::string& out, const StringType type, const DescriptorCache* cache = nullptr) const
649 : : {
650 : 2682459 : std::string extra = ToStringExtra();
651 [ + + ]: 2682459 : size_t pos = extra.size() > 0 ? 1 : 0;
652 [ + - + - ]: 2682459 : std::string ret = m_name + "(" + extra;
653 [ + + ]: 5297305 : for (const auto& pubkey : m_pubkey_args) {
654 [ + + + - ]: 2623632 : if (pos++) ret += ",";
655 [ + + + + : 2623632 : std::string tmp;
- ]
656 [ + + + + : 2623632 : switch (type) {
- ]
657 : 374008 : case StringType::NORMALIZED:
658 [ + - + + ]: 374008 : if (!pubkey->ToNormalizedString(*arg, tmp, cache)) return false;
659 : : break;
660 : 39964 : case StringType::PRIVATE:
661 [ + - + + ]: 39964 : if (!pubkey->ToPrivateString(*arg, tmp)) return false;
662 : : break;
663 : 2136347 : case StringType::PUBLIC:
664 [ + - ]: 2136347 : tmp = pubkey->ToString();
665 : 2136347 : break;
666 : 73313 : case StringType::COMPAT:
667 [ + - ]: 73313 : tmp = pubkey->ToString(PubkeyProvider::StringType::COMPAT);
668 : 73313 : break;
669 : : }
670 [ + - ]: 5229692 : ret += tmp;
671 : 2623632 : }
672 [ + - ]: 5347346 : std::string subscript;
673 [ + - + + ]: 2673673 : if (!ToStringSubScriptHelper(arg, subscript, type, cache)) return false;
674 [ + + + + : 2663679 : if (pos && subscript.size()) ret += ',';
+ - ]
675 [ + - ]: 5327358 : out = std::move(ret) + std::move(subscript) + ")";
676 : 2663679 : return true;
677 : 2682459 : }
678 : :
679 : 2134878 : std::string ToString(bool compat_format) const final
680 : : {
681 [ + + ]: 2134878 : std::string ret;
682 [ + + + - ]: 4240823 : ToStringHelper(nullptr, ret, compat_format ? StringType::COMPAT : StringType::PUBLIC);
683 [ + - ]: 2134878 : return AddChecksum(ret);
684 : 2134878 : }
685 : :
686 : 16991 : bool ToPrivateString(const SigningProvider& arg, std::string& out) const override
687 : : {
688 : 16991 : bool ret = ToStringHelper(&arg, out, StringType::PRIVATE);
689 : 16991 : out = AddChecksum(out);
690 : 16991 : return ret;
691 : : }
692 : :
693 : 19880 : bool ToNormalizedString(const SigningProvider& arg, std::string& out, const DescriptorCache* cache) const override final
694 : : {
695 : 19880 : bool ret = ToStringHelper(&arg, out, StringType::NORMALIZED, cache);
696 : 19880 : out = AddChecksum(out);
697 : 19880 : return ret;
698 : : }
699 : :
700 : : // NOLINTNEXTLINE(misc-no-recursion)
701 : 1630736 : bool ExpandHelper(int pos, const SigningProvider& arg, const DescriptorCache* read_cache, std::vector<CScript>& output_scripts, FlatSigningProvider& out, DescriptorCache* write_cache) const
702 : : {
703 : 1630736 : std::vector<std::pair<CPubKey, KeyOriginInfo>> entries;
704 [ + - ]: 1630736 : entries.reserve(m_pubkey_args.size());
705 : :
706 : : // Construct temporary data in `entries`, `subscripts`, and `subprovider` to avoid producing output in case of failure.
707 [ + + ]: 4209827 : for (const auto& p : m_pubkey_args) {
708 [ + - ]: 2611284 : entries.emplace_back();
709 [ + - + + ]: 2611284 : if (!p->GetPubKey(pos, arg, entries.back().first, entries.back().second, read_cache, write_cache)) return false;
710 : : }
711 : 1598543 : std::vector<CScript> subscripts;
712 : 1598543 : FlatSigningProvider subprovider;
713 [ + + ]: 2126548 : for (const auto& subarg : m_subdescriptor_args) {
714 : 537828 : std::vector<CScript> outscripts;
715 [ + - + + ]: 537828 : if (!subarg->ExpandHelper(pos, arg, read_cache, outscripts, subprovider, write_cache)) return false;
716 [ - + ]: 528005 : assert(outscripts.size() == 1);
717 [ + - ]: 528005 : subscripts.emplace_back(std::move(outscripts[0]));
718 : 537828 : }
719 [ + - ]: 1588720 : out.Merge(std::move(subprovider));
720 : :
721 : 1588720 : std::vector<CPubKey> pubkeys;
722 [ + - ]: 1588720 : pubkeys.reserve(entries.size());
723 [ + + ]: 4100744 : for (auto& entry : entries) {
724 [ + - ]: 2512024 : pubkeys.push_back(entry.first);
725 [ + - + - ]: 5024048 : out.origins.emplace(entry.first.GetID(), std::make_pair<CPubKey, KeyOriginInfo>(CPubKey(entry.first), std::move(entry.second)));
726 : : }
727 : :
728 [ + - ]: 3177440 : output_scripts = MakeScripts(pubkeys, std::span{subscripts}, out);
729 : 1588720 : return true;
730 : 1630736 : }
731 : :
732 : 47116 : bool Expand(int pos, const SigningProvider& provider, std::vector<CScript>& output_scripts, FlatSigningProvider& out, DescriptorCache* write_cache = nullptr) const final
733 : : {
734 : 47116 : return ExpandHelper(pos, provider, nullptr, output_scripts, out, write_cache);
735 : : }
736 : :
737 : 1045792 : bool ExpandFromCache(int pos, const DescriptorCache& read_cache, std::vector<CScript>& output_scripts, FlatSigningProvider& out) const final
738 : : {
739 : 1045792 : return ExpandHelper(pos, DUMMY_SIGNING_PROVIDER, &read_cache, output_scripts, out, nullptr);
740 : : }
741 : :
742 : : // NOLINTNEXTLINE(misc-no-recursion)
743 : 96947 : void ExpandPrivate(int pos, const SigningProvider& provider, FlatSigningProvider& out) const final
744 : : {
745 [ + + ]: 540726 : for (const auto& p : m_pubkey_args) {
746 : 443779 : CKey key;
747 [ + - + + ]: 443779 : if (!p->GetPrivKey(pos, provider, key)) continue;
748 [ + - + - : 347465 : out.keys.emplace(key.GetPubKey().GetID(), key);
+ - ]
749 : 443779 : }
750 [ + + ]: 125589 : for (const auto& arg : m_subdescriptor_args) {
751 : 28642 : arg->ExpandPrivate(pos, provider, out);
752 : : }
753 : 96947 : }
754 : :
755 : 7107 : std::optional<OutputType> GetOutputType() const override { return std::nullopt; }
756 : :
757 : 0 : std::optional<int64_t> ScriptSize() const override { return {}; }
758 : :
759 : : /** A helper for MaxSatisfactionWeight.
760 : : *
761 : : * @param use_max_sig Whether to assume ECDSA signatures will have a high-r.
762 : : * @return The maximum size of the satisfaction in raw bytes (with no witness meaning).
763 : : */
764 : 0 : virtual std::optional<int64_t> MaxSatSize(bool use_max_sig) const { return {}; }
765 : :
766 : 1640 : std::optional<int64_t> MaxSatisfactionWeight(bool) const override { return {}; }
767 : :
768 : 820 : std::optional<int64_t> MaxSatisfactionElems() const override { return {}; }
769 : :
770 : : // NOLINTNEXTLINE(misc-no-recursion)
771 : 0 : void GetPubKeys(std::set<CPubKey>& pubkeys, std::set<CExtPubKey>& ext_pubs) const override
772 : : {
773 [ # # ]: 0 : for (const auto& p : m_pubkey_args) {
774 : 0 : std::optional<CPubKey> pub = p->GetRootPubKey();
775 [ # # ]: 0 : if (pub) pubkeys.insert(*pub);
776 : 0 : std::optional<CExtPubKey> ext_pub = p->GetRootExtPubKey();
777 [ # # ]: 0 : if (ext_pub) ext_pubs.insert(*ext_pub);
778 : : }
779 [ # # ]: 0 : for (const auto& arg : m_subdescriptor_args) {
780 : 0 : arg->GetPubKeys(pubkeys, ext_pubs);
781 : : }
782 : 0 : }
783 : :
784 : : virtual std::unique_ptr<DescriptorImpl> Clone() const = 0;
785 : : };
786 : :
787 : : /** A parsed addr(A) descriptor. */
788 : : class AddressDescriptor final : public DescriptorImpl
789 : : {
790 : : const CTxDestination m_destination;
791 : : protected:
792 : 268297 : std::string ToStringExtra() const override { return EncodeDestination(m_destination); }
793 [ + - ]: 66 : std::vector<CScript> MakeScripts(const std::vector<CPubKey>&, std::span<const CScript>, FlatSigningProvider&) const override { return Vector(GetScriptForDestination(m_destination)); }
794 : : public:
795 [ + - ]: 268336 : AddressDescriptor(CTxDestination destination) : DescriptorImpl({}, "addr"), m_destination(std::move(destination)) {}
796 : 0 : bool IsSolvable() const final { return false; }
797 : :
798 : 64 : std::optional<OutputType> GetOutputType() const override
799 : : {
800 : 64 : return OutputTypeFromDestination(m_destination);
801 : : }
802 : 128 : bool IsSingleType() const final { return true; }
803 : 2 : bool ToPrivateString(const SigningProvider& arg, std::string& out) const final { return false; }
804 : :
805 [ # # ]: 0 : std::optional<int64_t> ScriptSize() const override { return GetScriptForDestination(m_destination).size(); }
806 : 0 : std::unique_ptr<DescriptorImpl> Clone() const override
807 : : {
808 [ # # ]: 0 : return std::make_unique<AddressDescriptor>(m_destination);
809 : : }
810 : : };
811 : :
812 : : /** A parsed raw(H) descriptor. */
813 : : class RawDescriptor final : public DescriptorImpl
814 : : {
815 : : const CScript m_script;
816 : : protected:
817 [ + + ]: 1499494 : std::string ToStringExtra() const override { return HexStr(m_script); }
818 : 1596 : std::vector<CScript> MakeScripts(const std::vector<CPubKey>&, std::span<const CScript>, FlatSigningProvider&) const override { return Vector(m_script); }
819 : : public:
820 [ + - ]: 749150 : RawDescriptor(CScript script) : DescriptorImpl({}, "raw"), m_script(std::move(script)) {}
821 : 225 : bool IsSolvable() const final { return false; }
822 : :
823 : 1734 : std::optional<OutputType> GetOutputType() const override
824 : : {
825 : 1734 : CTxDestination dest;
826 [ + - ]: 1734 : ExtractDestination(m_script, dest);
827 [ + - ]: 1734 : return OutputTypeFromDestination(dest);
828 : 1734 : }
829 : 2136 : bool IsSingleType() const final { return true; }
830 : 342 : bool ToPrivateString(const SigningProvider& arg, std::string& out) const final { return false; }
831 : :
832 [ + + ]: 224 : std::optional<int64_t> ScriptSize() const override { return m_script.size(); }
833 : :
834 : 0 : std::unique_ptr<DescriptorImpl> Clone() const override
835 : : {
836 [ # # ]: 0 : return std::make_unique<RawDescriptor>(m_script);
837 : : }
838 : : };
839 : :
840 : : /** A parsed pk(P) descriptor. */
841 : : class PKDescriptor final : public DescriptorImpl
842 : : {
843 : : private:
844 : : const bool m_xonly;
845 : : protected:
846 : 8191 : std::vector<CScript> MakeScripts(const std::vector<CPubKey>& keys, std::span<const CScript>, FlatSigningProvider&) const override
847 : : {
848 [ + + ]: 8191 : if (m_xonly) {
849 [ + - + - ]: 5985 : CScript script = CScript() << ToByteVector(XOnlyPubKey(keys[0])) << OP_CHECKSIG;
850 [ + - ]: 5985 : return Vector(std::move(script));
851 : 5985 : } else {
852 [ + - ]: 4412 : return Vector(GetScriptForRawPubKey(keys[0]));
853 : : }
854 : : }
855 : : public:
856 [ + - + - ]: 31387 : PKDescriptor(std::unique_ptr<PubkeyProvider> prov, bool xonly = false) : DescriptorImpl(Vector(std::move(prov)), "pk"), m_xonly(xonly) {}
857 : 576 : bool IsSingleType() const final { return true; }
858 : :
859 : 793 : std::optional<int64_t> ScriptSize() const override {
860 [ + - ]: 793 : return 1 + (m_xonly ? 32 : m_pubkey_args[0]->GetSize()) + 1;
861 : : }
862 : :
863 : 1030 : std::optional<int64_t> MaxSatSize(bool use_max_sig) const override {
864 [ - + ]: 578 : const auto ecdsa_sig_size = use_max_sig ? 72 : 71;
865 [ + - + - ]: 1030 : return 1 + (m_xonly ? 65 : ecdsa_sig_size);
866 : : }
867 : :
868 : 452 : std::optional<int64_t> MaxSatisfactionWeight(bool use_max_sig) const override {
869 [ - + ]: 452 : return *MaxSatSize(use_max_sig) * WITNESS_SCALE_FACTOR;
870 : : }
871 : :
872 : 515 : std::optional<int64_t> MaxSatisfactionElems() const override { return 1; }
873 : :
874 : 1134 : std::unique_ptr<DescriptorImpl> Clone() const override
875 : : {
876 [ + - - + ]: 1134 : return std::make_unique<PKDescriptor>(m_pubkey_args.at(0)->Clone(), m_xonly);
877 : : }
878 : : };
879 : :
880 : : /** A parsed pkh(P) descriptor. */
881 : : class PKHDescriptor final : public DescriptorImpl
882 : : {
883 : : protected:
884 : 230880 : std::vector<CScript> MakeScripts(const std::vector<CPubKey>& keys, std::span<const CScript>, FlatSigningProvider& out) const override
885 : : {
886 : 230880 : CKeyID id = keys[0].GetID();
887 : 230880 : out.pubkeys.emplace(id, keys[0]);
888 [ + - + - ]: 461760 : return Vector(GetScriptForDestination(PKHash(id)));
889 : : }
890 : : public:
891 [ + - + - ]: 1056379 : PKHDescriptor(std::unique_ptr<PubkeyProvider> prov) : DescriptorImpl(Vector(std::move(prov)), "pkh") {}
892 : 1140316 : std::optional<OutputType> GetOutputType() const override { return OutputType::LEGACY; }
893 : 174685 : bool IsSingleType() const final { return true; }
894 : :
895 : 706 : std::optional<int64_t> ScriptSize() const override { return 1 + 1 + 1 + 20 + 1 + 1; }
896 : :
897 : 1012066 : std::optional<int64_t> MaxSatSize(bool use_max_sig) const override {
898 [ + + ]: 1012066 : const auto sig_size = use_max_sig ? 72 : 71;
899 : 1012066 : return 1 + sig_size + 1 + m_pubkey_args[0]->GetSize();
900 : : }
901 : :
902 : 1011548 : std::optional<int64_t> MaxSatisfactionWeight(bool use_max_sig) const override {
903 : 1011548 : return *MaxSatSize(use_max_sig) * WITNESS_SCALE_FACTOR;
904 : : }
905 : :
906 : 1011615 : std::optional<int64_t> MaxSatisfactionElems() const override { return 2; }
907 : :
908 : 0 : std::unique_ptr<DescriptorImpl> Clone() const override
909 : : {
910 [ # # # # ]: 0 : return std::make_unique<PKHDescriptor>(m_pubkey_args.at(0)->Clone());
911 : : }
912 : : };
913 : :
914 : : /** A parsed wpkh(P) descriptor. */
915 : : class WPKHDescriptor final : public DescriptorImpl
916 : : {
917 : : protected:
918 : 494840 : std::vector<CScript> MakeScripts(const std::vector<CPubKey>& keys, std::span<const CScript>, FlatSigningProvider& out) const override
919 : : {
920 : 494840 : CKeyID id = keys[0].GetID();
921 : 494840 : out.pubkeys.emplace(id, keys[0]);
922 [ + - + - ]: 989680 : return Vector(GetScriptForDestination(WitnessV0KeyHash(id)));
923 : : }
924 : : public:
925 [ + - + - ]: 2259660 : WPKHDescriptor(std::unique_ptr<PubkeyProvider> prov) : DescriptorImpl(Vector(std::move(prov)), "wpkh") {}
926 : 4577689 : std::optional<OutputType> GetOutputType() const override { return OutputType::BECH32; }
927 : 21625 : bool IsSingleType() const final { return true; }
928 : :
929 : 2136798 : std::optional<int64_t> ScriptSize() const override { return 1 + 1 + 20; }
930 : :
931 : 2221745 : std::optional<int64_t> MaxSatSize(bool use_max_sig) const override {
932 [ + + ]: 2136428 : const auto sig_size = use_max_sig ? 72 : 71;
933 : 2221745 : return (1 + sig_size + 1 + 33);
934 : : }
935 : :
936 : 85317 : std::optional<int64_t> MaxSatisfactionWeight(bool use_max_sig) const override {
937 [ + + ]: 85317 : return MaxSatSize(use_max_sig);
938 : : }
939 : :
940 : 2221264 : std::optional<int64_t> MaxSatisfactionElems() const override { return 2; }
941 : :
942 : 0 : std::unique_ptr<DescriptorImpl> Clone() const override
943 : : {
944 [ # # # # ]: 0 : return std::make_unique<WPKHDescriptor>(m_pubkey_args.at(0)->Clone());
945 : : }
946 : : };
947 : :
948 : : /** A parsed combo(P) descriptor. */
949 : : class ComboDescriptor final : public DescriptorImpl
950 : : {
951 : : protected:
952 : 2222 : std::vector<CScript> MakeScripts(const std::vector<CPubKey>& keys, std::span<const CScript>, FlatSigningProvider& out) const override
953 : : {
954 : 2222 : std::vector<CScript> ret;
955 [ + - ]: 2222 : CKeyID id = keys[0].GetID();
956 [ + - ]: 2222 : out.pubkeys.emplace(id, keys[0]);
957 [ + - + - ]: 2222 : ret.emplace_back(GetScriptForRawPubKey(keys[0])); // P2PK
958 [ + - + - : 4444 : ret.emplace_back(GetScriptForDestination(PKHash(id))); // P2PKH
+ - ]
959 [ + + ]: 2222 : if (keys[0].IsCompressed()) {
960 [ + - ]: 2206 : CScript p2wpkh = GetScriptForDestination(WitnessV0KeyHash(id));
961 [ + - + - ]: 2206 : out.scripts.emplace(CScriptID(p2wpkh), p2wpkh);
962 [ + - ]: 2206 : ret.emplace_back(p2wpkh);
963 [ + - + - : 4412 : ret.emplace_back(GetScriptForDestination(ScriptHash(p2wpkh))); // P2SH-P2WPKH
+ - ]
964 : 2206 : }
965 : 2222 : return ret;
966 : 0 : }
967 : : public:
968 [ + - + - ]: 1010 : ComboDescriptor(std::unique_ptr<PubkeyProvider> prov) : DescriptorImpl(Vector(std::move(prov)), "combo") {}
969 : 1381 : bool IsSingleType() const final { return false; }
970 : 0 : std::unique_ptr<DescriptorImpl> Clone() const override
971 : : {
972 [ # # # # ]: 0 : return std::make_unique<ComboDescriptor>(m_pubkey_args.at(0)->Clone());
973 : : }
974 : : };
975 : :
976 : : /** A parsed multi(...) or sortedmulti(...) descriptor */
977 : : class MultisigDescriptor final : public DescriptorImpl
978 : : {
979 : : const int m_threshold;
980 : : const bool m_sorted;
981 : : protected:
982 : 28727 : std::string ToStringExtra() const override { return strprintf("%i", m_threshold); }
983 : 6142 : std::vector<CScript> MakeScripts(const std::vector<CPubKey>& keys, std::span<const CScript>, FlatSigningProvider&) const override {
984 [ + + ]: 6142 : if (m_sorted) {
985 : 3272 : std::vector<CPubKey> sorted_keys(keys);
986 : 3272 : std::sort(sorted_keys.begin(), sorted_keys.end());
987 [ + - + - ]: 6544 : return Vector(GetScriptForMultisig(m_threshold, sorted_keys));
988 : 3272 : }
989 [ + - ]: 5740 : return Vector(GetScriptForMultisig(m_threshold, keys));
990 : : }
991 : : public:
992 [ + + + - ]: 49772 : 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) {}
993 : 495 : bool IsSingleType() const final { return true; }
994 : :
995 : 4536 : std::optional<int64_t> ScriptSize() const override {
996 : 4536 : const auto n_keys = m_pubkey_args.size();
997 : 58374 : auto op = [](int64_t acc, const std::unique_ptr<PubkeyProvider>& pk) { return acc + 1 + pk->GetSize();};
998 : 4536 : const auto pubkeys_size{std::accumulate(m_pubkey_args.begin(), m_pubkey_args.end(), int64_t{0}, op)};
999 [ - + + - ]: 9072 : return 1 + BuildScript(n_keys).size() + BuildScript(m_threshold).size() + pubkeys_size;
1000 : : }
1001 : :
1002 : 4724 : std::optional<int64_t> MaxSatSize(bool use_max_sig) const override {
1003 [ - + ]: 4360 : const auto sig_size = use_max_sig ? 72 : 71;
1004 : 4724 : return (1 + (1 + sig_size) * m_threshold);
1005 : : }
1006 : :
1007 : 364 : std::optional<int64_t> MaxSatisfactionWeight(bool use_max_sig) const override {
1008 [ - + ]: 364 : return *MaxSatSize(use_max_sig) * WITNESS_SCALE_FACTOR;
1009 : : }
1010 : :
1011 : 2362 : std::optional<int64_t> MaxSatisfactionElems() const override { return 1 + m_threshold; }
1012 : :
1013 : 0 : std::unique_ptr<DescriptorImpl> Clone() const override
1014 : : {
1015 : 0 : std::vector<std::unique_ptr<PubkeyProvider>> providers;
1016 [ # # ]: 0 : providers.reserve(m_pubkey_args.size());
1017 [ # # ]: 0 : std::transform(m_pubkey_args.begin(), m_pubkey_args.end(), providers.begin(), [](const std::unique_ptr<PubkeyProvider>& p) { return p->Clone(); });
1018 [ # # # # ]: 0 : return std::make_unique<MultisigDescriptor>(m_threshold, std::move(providers), m_sorted);
1019 : 0 : }
1020 : : };
1021 : :
1022 : : /** A parsed (sorted)multi_a(...) descriptor. Always uses x-only pubkeys. */
1023 : : class MultiADescriptor final : public DescriptorImpl
1024 : : {
1025 : : const int m_threshold;
1026 : : const bool m_sorted;
1027 : : protected:
1028 : 7743 : std::string ToStringExtra() const override { return strprintf("%i", m_threshold); }
1029 : 5954 : std::vector<CScript> MakeScripts(const std::vector<CPubKey>& keys, std::span<const CScript>, FlatSigningProvider&) const override {
1030 : 5954 : CScript ret;
1031 : 5954 : std::vector<XOnlyPubKey> xkeys;
1032 [ + - ]: 5954 : xkeys.reserve(keys.size());
1033 [ + - + + ]: 1327081 : for (const auto& key : keys) xkeys.emplace_back(key);
1034 [ + + ]: 5954 : if (m_sorted) std::sort(xkeys.begin(), xkeys.end());
1035 [ + - + - ]: 5954 : ret << ToByteVector(xkeys[0]) << OP_CHECKSIG;
1036 [ + + ]: 1321127 : for (size_t i = 1; i < keys.size(); ++i) {
1037 [ + - + - ]: 2630346 : ret << ToByteVector(xkeys[i]) << OP_CHECKSIGADD;
1038 : : }
1039 [ + - + - ]: 5954 : ret << m_threshold << OP_NUMEQUAL;
1040 [ + - ]: 5954 : return Vector(std::move(ret));
1041 : 5954 : }
1042 : : public:
1043 [ + + + - ]: 8504 : 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) {}
1044 : 0 : bool IsSingleType() const final { return true; }
1045 : :
1046 : 0 : std::optional<int64_t> ScriptSize() const override {
1047 : 0 : const auto n_keys = m_pubkey_args.size();
1048 [ # # ]: 0 : return (1 + 32 + 1) * n_keys + BuildScript(m_threshold).size() + 1;
1049 : : }
1050 : :
1051 : 0 : std::optional<int64_t> MaxSatSize(bool use_max_sig) const override {
1052 : 0 : return (1 + 65) * m_threshold + (m_pubkey_args.size() - m_threshold);
1053 : : }
1054 : :
1055 : 0 : std::optional<int64_t> MaxSatisfactionElems() const override { return m_pubkey_args.size(); }
1056 : :
1057 : 283 : std::unique_ptr<DescriptorImpl> Clone() const override
1058 : : {
1059 : 283 : std::vector<std::unique_ptr<PubkeyProvider>> providers;
1060 [ + - ]: 283 : providers.reserve(m_pubkey_args.size());
1061 [ + + ]: 3501 : for (const auto& arg : m_pubkey_args) {
1062 [ + - ]: 6436 : providers.push_back(arg->Clone());
1063 : : }
1064 [ + - - + ]: 566 : return std::make_unique<MultiADescriptor>(m_threshold, std::move(providers), m_sorted);
1065 : 283 : }
1066 : : };
1067 : :
1068 : : /** A parsed sh(...) descriptor. */
1069 : : class SHDescriptor final : public DescriptorImpl
1070 : : {
1071 : : protected:
1072 : 475751 : std::vector<CScript> MakeScripts(const std::vector<CPubKey>&, std::span<const CScript> scripts, FlatSigningProvider& out) const override
1073 : : {
1074 [ + - + - ]: 951502 : auto ret = Vector(GetScriptForDestination(ScriptHash(scripts[0])));
1075 [ + - + - : 475751 : if (ret.size()) out.scripts.emplace(CScriptID(scripts[0]), scripts[0]);
+ - ]
1076 : 475751 : return ret;
1077 : 0 : }
1078 : :
1079 [ + + ]: 4488658 : bool IsSegwit() const { return m_subdescriptor_args[0]->GetOutputType() == OutputType::BECH32; }
1080 : :
1081 : : public:
1082 [ + - ]: 2172054 : SHDescriptor(std::unique_ptr<DescriptorImpl> desc) : DescriptorImpl({}, std::move(desc), "sh") {}
1083 : :
1084 : 2347610 : std::optional<OutputType> GetOutputType() const override
1085 : : {
1086 [ - + ]: 2347610 : assert(m_subdescriptor_args.size() == 1);
1087 [ + + ]: 2347610 : if (IsSegwit()) return OutputType::P2SH_SEGWIT;
1088 : 3299 : return OutputType::LEGACY;
1089 : : }
1090 : 362764 : bool IsSingleType() const final { return true; }
1091 : :
1092 : 2314 : std::optional<int64_t> ScriptSize() const override { return 1 + 1 + 20 + 1; }
1093 : :
1094 : 2141048 : std::optional<int64_t> MaxSatisfactionWeight(bool use_max_sig) const override {
1095 [ + - ]: 2141048 : if (const auto sat_size = m_subdescriptor_args[0]->MaxSatSize(use_max_sig)) {
1096 [ + - ]: 2141048 : if (const auto subscript_size = m_subdescriptor_args[0]->ScriptSize()) {
1097 : : // The subscript is never witness data.
1098 : 2141048 : const auto subscript_weight = (1 + *subscript_size) * WITNESS_SCALE_FACTOR;
1099 : : // The weight depends on whether the inner descriptor is satisfied using the witness stack.
1100 [ + + ]: 2141048 : if (IsSegwit()) return subscript_weight + *sat_size;
1101 : 1906 : return subscript_weight + *sat_size * WITNESS_SCALE_FACTOR;
1102 : : }
1103 : : }
1104 : 0 : return {};
1105 : : }
1106 : :
1107 : 2138654 : std::optional<int64_t> MaxSatisfactionElems() const override {
1108 [ + - ]: 2138654 : if (const auto sub_elems = m_subdescriptor_args[0]->MaxSatisfactionElems()) return 1 + *sub_elems;
1109 : 0 : return {};
1110 : : }
1111 : :
1112 : 0 : std::unique_ptr<DescriptorImpl> Clone() const override
1113 : : {
1114 [ # # # # ]: 0 : return std::make_unique<SHDescriptor>(m_subdescriptor_args.at(0)->Clone());
1115 : : }
1116 : : };
1117 : :
1118 : : /** A parsed wsh(...) descriptor. */
1119 : : class WSHDescriptor final : public DescriptorImpl
1120 : : {
1121 : : protected:
1122 : 15838 : std::vector<CScript> MakeScripts(const std::vector<CPubKey>&, std::span<const CScript> scripts, FlatSigningProvider& out) const override
1123 : : {
1124 [ + - + - ]: 31676 : auto ret = Vector(GetScriptForDestination(WitnessV0ScriptHash(scripts[0])));
1125 [ + - + - : 15838 : if (ret.size()) out.scripts.emplace(CScriptID(scripts[0]), scripts[0]);
+ - ]
1126 : 15838 : return ret;
1127 : 0 : }
1128 : : public:
1129 [ + - ]: 14036 : WSHDescriptor(std::unique_ptr<DescriptorImpl> desc) : DescriptorImpl({}, std::move(desc), "wsh") {}
1130 : 17897 : std::optional<OutputType> GetOutputType() const override { return OutputType::BECH32; }
1131 : 12938 : bool IsSingleType() const final { return true; }
1132 : :
1133 : 7813 : std::optional<int64_t> ScriptSize() const override { return 1 + 1 + 32; }
1134 : :
1135 : 13310 : std::optional<int64_t> MaxSatSize(bool use_max_sig) const override {
1136 [ + - ]: 13310 : if (const auto sat_size = m_subdescriptor_args[0]->MaxSatSize(use_max_sig)) {
1137 [ + - ]: 13310 : if (const auto subscript_size = m_subdescriptor_args[0]->ScriptSize()) {
1138 [ + + ]: 17716 : return GetSizeOfCompactSize(*subscript_size) + *subscript_size + *sat_size;
1139 : : }
1140 : : }
1141 : 0 : return {};
1142 : : }
1143 : :
1144 : 10596 : std::optional<int64_t> MaxSatisfactionWeight(bool use_max_sig) const override {
1145 : 10596 : return MaxSatSize(use_max_sig);
1146 : : }
1147 : :
1148 : 6655 : std::optional<int64_t> MaxSatisfactionElems() const override {
1149 [ + - ]: 6655 : if (const auto sub_elems = m_subdescriptor_args[0]->MaxSatisfactionElems()) return 1 + *sub_elems;
1150 : 0 : return {};
1151 : : }
1152 : :
1153 : 0 : std::unique_ptr<DescriptorImpl> Clone() const override
1154 : : {
1155 [ # # # # ]: 0 : return std::make_unique<WSHDescriptor>(m_subdescriptor_args.at(0)->Clone());
1156 : : }
1157 : : };
1158 : :
1159 : : /** A parsed tr(...) descriptor. */
1160 : : class TRDescriptor final : public DescriptorImpl
1161 : : {
1162 : : std::vector<int> m_depths;
1163 : : protected:
1164 : 309969 : std::vector<CScript> MakeScripts(const std::vector<CPubKey>& keys, std::span<const CScript> scripts, FlatSigningProvider& out) const override
1165 : : {
1166 [ - + ]: 309969 : TaprootBuilder builder;
1167 [ - + ]: 309969 : assert(m_depths.size() == scripts.size());
1168 [ + + ]: 345699 : for (size_t pos = 0; pos < m_depths.size(); ++pos) {
1169 [ + + + - ]: 71460 : builder.Add(m_depths[pos], scripts[pos], TAPROOT_LEAF_TAPSCRIPT);
1170 : : }
1171 [ - + ]: 309969 : if (!builder.IsComplete()) return {};
1172 [ - + ]: 309969 : assert(keys.size() == 1);
1173 : 309969 : XOnlyPubKey xpk(keys[0]);
1174 [ + - - + ]: 309969 : if (!xpk.IsFullyValid()) return {};
1175 [ + - ]: 309969 : builder.Finalize(xpk);
1176 [ + - ]: 309969 : WitnessV1Taproot output = builder.GetOutput();
1177 [ + - + - ]: 309969 : out.tr_trees[output] = builder;
1178 [ + - + - ]: 309969 : out.pubkeys.emplace(keys[0].GetID(), keys[0]);
1179 [ + - + - ]: 619938 : return Vector(GetScriptForDestination(output));
1180 : 309969 : }
1181 : 287794 : bool ToStringSubScriptHelper(const SigningProvider* arg, std::string& ret, const StringType type, const DescriptorCache* cache = nullptr) const override
1182 : : {
1183 [ + + ]: 287794 : if (m_depths.empty()) return true;
1184 : 18770 : std::vector<bool> path;
1185 [ + + ]: 55833 : for (size_t pos = 0; pos < m_depths.size(); ++pos) {
1186 [ + + + - ]: 40080 : if (pos) ret += ',';
1187 [ + + ]: 81586 : while ((int)path.size() <= m_depths[pos]) {
1188 [ + + + - ]: 41506 : if (path.size()) ret += '{';
1189 [ + - ]: 41506 : path.push_back(false);
1190 : : }
1191 [ + - ]: 40080 : std::string tmp;
1192 [ + - + + ]: 40080 : if (!m_subdescriptor_args[pos]->ToStringHelper(arg, tmp, type, cache)) return false;
1193 [ + - ]: 37063 : ret += tmp;
1194 [ + - + + ]: 58192 : while (!path.empty() && path.back()) {
1195 [ + - + - ]: 21129 : if (path.size() > 1) ret += '}';
1196 : 21129 : path.pop_back();
1197 : : }
1198 [ + - ]: 37063 : if (!path.empty()) path.back() = true;
1199 : 40080 : }
1200 : : return true;
1201 : 18770 : }
1202 : : public:
1203 : 415382 : TRDescriptor(std::unique_ptr<PubkeyProvider> internal_key, std::vector<std::unique_ptr<DescriptorImpl>> descs, std::vector<int> depths) :
1204 [ + - + - : 415382 : DescriptorImpl(Vector(std::move(internal_key)), std::move(descs), "tr"), m_depths(std::move(depths))
- + ]
1205 : : {
1206 [ - + ]: 415382 : assert(m_subdescriptor_args.size() == m_depths.size());
1207 : 415382 : }
1208 : 526012 : std::optional<OutputType> GetOutputType() const override { return OutputType::BECH32M; }
1209 : 240381 : bool IsSingleType() const final { return true; }
1210 : :
1211 : 6644 : std::optional<int64_t> ScriptSize() const override { return 1 + 1 + 32; }
1212 : :
1213 : 401695 : std::optional<int64_t> MaxSatisfactionWeight(bool) const override {
1214 : : // FIXME: We assume keypath spend, which can lead to very large underestimations.
1215 : 401695 : return 1 + 65;
1216 : : }
1217 : :
1218 : 394591 : std::optional<int64_t> MaxSatisfactionElems() const override {
1219 : : // FIXME: See above, we assume keypath spend.
1220 : 394591 : return 1;
1221 : : }
1222 : :
1223 : 0 : std::unique_ptr<DescriptorImpl> Clone() const override
1224 : : {
1225 : 0 : std::vector<std::unique_ptr<DescriptorImpl>> subdescs;
1226 [ # # ]: 0 : subdescs.reserve(m_subdescriptor_args.size());
1227 [ # # ]: 0 : std::transform(m_subdescriptor_args.begin(), m_subdescriptor_args.end(), subdescs.begin(), [](const std::unique_ptr<DescriptorImpl>& d) { return d->Clone(); });
1228 [ # # # # : 0 : return std::make_unique<TRDescriptor>(m_pubkey_args.at(0)->Clone(), std::move(subdescs), m_depths);
# # # # ]
1229 : 0 : }
1230 : : };
1231 : :
1232 : : /* We instantiate Miniscript here with a simple integer as key type.
1233 : : * The value of these key integers are an index in the
1234 : : * DescriptorImpl::m_pubkey_args vector.
1235 : : */
1236 : :
1237 : : /**
1238 : : * The context for converting a Miniscript descriptor into a Script.
1239 : : */
1240 : : class ScriptMaker {
1241 : : //! Keys contained in the Miniscript (the evaluation of DescriptorImpl::m_pubkey_args).
1242 : : const std::vector<CPubKey>& m_keys;
1243 : : //! The script context we're operating within (Tapscript or P2WSH).
1244 : : const miniscript::MiniscriptContext m_script_ctx;
1245 : :
1246 : : //! Get the ripemd160(sha256()) hash of this key.
1247 : : //! Any key that is valid in a descriptor serializes as 32 bytes within a Tapscript context. So we
1248 : : //! must not hash the sign-bit byte in this case.
1249 : 4776 : uint160 GetHash160(uint32_t key) const {
1250 [ + + ]: 4776 : if (miniscript::IsTapscript(m_script_ctx)) {
1251 : 3848 : return Hash160(XOnlyPubKey{m_keys[key]});
1252 : : }
1253 : 928 : return m_keys[key].GetID();
1254 : : }
1255 : :
1256 : : public:
1257 : 36771 : ScriptMaker(const std::vector<CPubKey>& keys LIFETIMEBOUND, const miniscript::MiniscriptContext script_ctx) : m_keys(keys), m_script_ctx{script_ctx} {}
1258 : :
1259 : 67908 : std::vector<unsigned char> ToPKBytes(uint32_t key) const {
1260 : : // In Tapscript keys always serialize as x-only, whether an x-only key was used in the descriptor or not.
1261 [ + + ]: 67908 : if (!miniscript::IsTapscript(m_script_ctx)) {
1262 : 38784 : return {m_keys[key].begin(), m_keys[key].end()};
1263 : : }
1264 : 29124 : const XOnlyPubKey xonly_pubkey{m_keys[key]};
1265 : 29124 : return {xonly_pubkey.begin(), xonly_pubkey.end()};
1266 : : }
1267 : :
1268 : 4776 : std::vector<unsigned char> ToPKHBytes(uint32_t key) const {
1269 : 4776 : auto id = GetHash160(key);
1270 : 4776 : return {id.begin(), id.end()};
1271 : : }
1272 : : };
1273 : :
1274 : : /**
1275 : : * The context for converting a Miniscript descriptor to its textual form.
1276 : : */
1277 : : class StringMaker {
1278 : : //! To convert private keys for private descriptors.
1279 : : const SigningProvider* m_arg;
1280 : : //! Keys contained in the Miniscript (a reference to DescriptorImpl::m_pubkey_args).
1281 : : const std::vector<std::unique_ptr<PubkeyProvider>>& m_pubkeys;
1282 : : //! Whether to serialize keys as private or public.
1283 : : bool m_private;
1284 : :
1285 : : public:
1286 : 44296 : StringMaker(const SigningProvider* arg LIFETIMEBOUND, const std::vector<std::unique_ptr<PubkeyProvider>>& pubkeys LIFETIMEBOUND, bool priv)
1287 : 44296 : : m_arg(arg), m_pubkeys(pubkeys), m_private(priv) {}
1288 : :
1289 : 120154 : std::optional<std::string> ToString(uint32_t key) const
1290 : : {
1291 [ + + ]: 120154 : std::string ret;
1292 [ + + ]: 120154 : if (m_private) {
1293 [ + - + + ]: 14249 : if (!m_pubkeys[key]->ToPrivateString(*m_arg, ret)) return {};
1294 : : } else {
1295 [ + - ]: 105905 : ret = m_pubkeys[key]->ToString();
1296 : : }
1297 : 115088 : return ret;
1298 : 120154 : }
1299 : : };
1300 : :
1301 : : class MiniscriptDescriptor final : public DescriptorImpl
1302 : : {
1303 : : private:
1304 : : miniscript::NodeRef<uint32_t> m_node;
1305 : :
1306 : : protected:
1307 : 36771 : std::vector<CScript> MakeScripts(const std::vector<CPubKey>& keys, std::span<const CScript> scripts,
1308 : : FlatSigningProvider& provider) const override
1309 : : {
1310 : 36771 : const auto script_ctx{m_node->GetMsCtx()};
1311 [ + + ]: 109455 : for (const auto& key : keys) {
1312 [ + + ]: 72684 : if (miniscript::IsTapscript(script_ctx)) {
1313 : 32972 : provider.pubkeys.emplace(Hash160(XOnlyPubKey{key}), key);
1314 : : } else {
1315 : 39712 : provider.pubkeys.emplace(key.GetID(), key);
1316 : : }
1317 : : }
1318 [ + - ]: 73542 : return Vector(m_node->ToScript(ScriptMaker(keys, script_ctx)));
1319 : : }
1320 : :
1321 : : public:
1322 : 35428 : MiniscriptDescriptor(std::vector<std::unique_ptr<PubkeyProvider>> providers, miniscript::NodeRef<uint32_t> node)
1323 [ + - ]: 35428 : : DescriptorImpl(std::move(providers), "?"), m_node(std::move(node)) {}
1324 : :
1325 : 44296 : bool ToStringHelper(const SigningProvider* arg, std::string& out, const StringType type,
1326 : : const DescriptorCache* cache = nullptr) const override
1327 : : {
1328 [ + + ]: 44296 : if (const auto res = m_node->ToString(StringMaker(arg, m_pubkey_args, type == StringType::PRIVATE))) {
1329 [ + - ]: 39230 : out = *res;
1330 : 39230 : return true;
1331 : 39230 : }
1332 : 5066 : return false;
1333 : : }
1334 : :
1335 : 15923 : bool IsSolvable() const override { return true; }
1336 : 0 : bool IsSingleType() const final { return true; }
1337 : :
1338 : 9760 : std::optional<int64_t> ScriptSize() const override { return m_node->ScriptSize(); }
1339 : :
1340 : 9760 : std::optional<int64_t> MaxSatSize(bool) const override {
1341 : : // For Miniscript we always assume high-R ECDSA signatures.
1342 [ + - ]: 9760 : return m_node->GetWitnessSize();
1343 : : }
1344 : :
1345 : 4880 : std::optional<int64_t> MaxSatisfactionElems() const override {
1346 [ + - ]: 4880 : return m_node->GetStackSize();
1347 : : }
1348 : :
1349 : 7464 : std::unique_ptr<DescriptorImpl> Clone() const override
1350 : : {
1351 : 7464 : std::vector<std::unique_ptr<PubkeyProvider>> providers;
1352 [ + - ]: 7464 : providers.reserve(m_pubkey_args.size());
1353 [ + + ]: 15049 : for (const auto& arg : m_pubkey_args) {
1354 [ + - ]: 15170 : providers.push_back(arg->Clone());
1355 : : }
1356 [ + - + - : 14928 : return std::make_unique<MiniscriptDescriptor>(std::move(providers), m_node->Clone());
- + ]
1357 : 7464 : }
1358 : : };
1359 : :
1360 : : /** A parsed rawtr(...) descriptor. */
1361 : : class RawTRDescriptor final : public DescriptorImpl
1362 : : {
1363 : : protected:
1364 : 533 : std::vector<CScript> MakeScripts(const std::vector<CPubKey>& keys, std::span<const CScript> scripts, FlatSigningProvider& out) const override
1365 : : {
1366 [ - + ]: 533 : assert(keys.size() == 1);
1367 : 533 : XOnlyPubKey xpk(keys[0]);
1368 [ - + ]: 533 : if (!xpk.IsFullyValid()) return {};
1369 [ + - ]: 533 : WitnessV1Taproot output{xpk};
1370 [ + - + - ]: 1066 : return Vector(GetScriptForDestination(output));
1371 : : }
1372 : : public:
1373 [ + - + - ]: 7445 : RawTRDescriptor(std::unique_ptr<PubkeyProvider> output_key) : DescriptorImpl(Vector(std::move(output_key)), "rawtr") {}
1374 : 494 : std::optional<OutputType> GetOutputType() const override { return OutputType::BECH32M; }
1375 : 597 : bool IsSingleType() const final { return true; }
1376 : :
1377 : 152 : std::optional<int64_t> ScriptSize() const override { return 1 + 1 + 32; }
1378 : :
1379 : 324 : std::optional<int64_t> MaxSatisfactionWeight(bool) const override {
1380 : : // We can't know whether there is a script path, so assume key path spend.
1381 : 324 : return 1 + 65;
1382 : : }
1383 : :
1384 : 162 : std::optional<int64_t> MaxSatisfactionElems() const override {
1385 : : // See above, we assume keypath spend.
1386 : 162 : return 1;
1387 : : }
1388 : :
1389 : 0 : std::unique_ptr<DescriptorImpl> Clone() const override
1390 : : {
1391 [ # # # # ]: 0 : return std::make_unique<RawTRDescriptor>(m_pubkey_args.at(0)->Clone());
1392 : : }
1393 : : };
1394 : :
1395 : : ////////////////////////////////////////////////////////////////////////////
1396 : : // Parser //
1397 : : ////////////////////////////////////////////////////////////////////////////
1398 : :
1399 : : enum class ParseScriptContext {
1400 : : TOP, //!< Top-level context (script goes directly in scriptPubKey)
1401 : : P2SH, //!< Inside sh() (script becomes P2SH redeemScript)
1402 : : P2WPKH, //!< Inside wpkh() (no script, pubkey only)
1403 : : P2WSH, //!< Inside wsh() (script becomes v0 witness script)
1404 : : P2TR, //!< Inside tr() (either internal key, or BIP342 script leaf)
1405 : : };
1406 : :
1407 : 239431 : std::optional<uint32_t> ParseKeyPathNum(std::span<const char> elem, bool& apostrophe, std::string& error)
1408 : : {
1409 : 239431 : bool hardened = false;
1410 [ + + ]: 239431 : if (elem.size() > 0) {
1411 [ + + ]: 239424 : const char last = elem[elem.size() - 1];
1412 [ + + ]: 239424 : if (last == '\'' || last == 'h') {
1413 : 88593 : elem = elem.first(elem.size() - 1);
1414 : 88593 : hardened = true;
1415 : 88593 : apostrophe = last == '\'';
1416 : : }
1417 : : }
1418 : 239431 : uint32_t p;
1419 [ + - + + ]: 239431 : if (!ParseUInt32(std::string(elem.begin(), elem.end()), &p)) {
1420 [ + - ]: 67 : error = strprintf("Key path value '%s' is not a valid uint32", std::string(elem.begin(), elem.end()));
1421 : 67 : return std::nullopt;
1422 [ + + ]: 239364 : } else if (p > 0x7FFFFFFFUL) {
1423 : 7 : error = strprintf("Key path value %u is out of range", p);
1424 : 7 : return std::nullopt;
1425 : : }
1426 : :
1427 : 239357 : return std::make_optional<uint32_t>(p | (((uint32_t)hardened) << 31));
1428 : : }
1429 : :
1430 : : /**
1431 : : * Parse a key path, being passed a split list of elements (the first element is ignored because it is always the key).
1432 : : *
1433 : : * @param[in] split BIP32 path string, using either ' or h for hardened derivation
1434 : : * @param[out] out Vector of parsed key paths
1435 : : * @param[out] apostrophe only updated if hardened derivation is found
1436 : : * @param[out] error parsing error message
1437 : : * @param[in] allow_multipath Allows the parsed path to use the multipath specifier
1438 : : * @returns false if parsing failed
1439 : : **/
1440 : 174723 : [[nodiscard]] bool ParseKeyPath(const std::vector<std::span<const char>>& split, std::vector<KeyPath>& out, bool& apostrophe, std::string& error, bool allow_multipath)
1441 : : {
1442 : 174723 : KeyPath path;
1443 : 2957 : struct MultipathSubstitutes {
1444 : : size_t placeholder_index;
1445 : : std::vector<uint32_t> values;
1446 : : };
1447 : 174723 : std::optional<MultipathSubstitutes> substitutes;
1448 : :
1449 [ + + ]: 388913 : for (size_t i = 1; i < split.size(); ++i) {
1450 [ + + ]: 214316 : const std::span<const char>& elem = split[i];
1451 : :
1452 : : // Check if element contains multipath specifier
1453 [ + + + + : 214316 : if (!elem.empty() && elem.front() == '<' && elem.back() == '>') {
+ + ]
1454 [ + + ]: 3000 : if (!allow_multipath) {
1455 [ + - + - ]: 74 : error = strprintf("Key path value '%s' specifies multipath in a section where multipath is not allowed", std::string(elem.begin(), elem.end()));
1456 : 37 : return false;
1457 : : }
1458 [ + + ]: 2963 : if (substitutes) {
1459 [ + - ]: 174723 : error = "Multiple multipath key path specifiers found";
1460 : : return false;
1461 : : }
1462 : :
1463 : : // Parse each possible value
1464 [ + - ]: 2961 : std::vector<std::span<const char>> nums = Split(std::span(elem.begin()+1, elem.end()-1), ";");
1465 [ + + ]: 2961 : if (nums.size() < 2) {
1466 [ + - ]: 22 : error = "Multipath key path specifiers must have at least two items";
1467 : : return false;
1468 : : }
1469 : :
1470 : 2957 : substitutes.emplace();
1471 : 2957 : std::unordered_set<uint32_t> seen_substitutes;
1472 [ + + ]: 31054 : for (const auto& num : nums) {
1473 [ + - ]: 28115 : const auto& op_num = ParseKeyPathNum(num, apostrophe, error);
1474 [ + + ]: 28115 : if (!op_num) return false;
1475 [ + - + + ]: 28106 : auto [_, inserted] = seen_substitutes.insert(*op_num);
1476 [ + + ]: 28106 : if (!inserted) {
1477 [ + - ]: 9 : error = strprintf("Duplicated key path value %u in multipath specifier", *op_num);
1478 : 9 : return false;
1479 : : }
1480 [ + - ]: 28097 : substitutes->values.emplace_back(*op_num);
1481 : : }
1482 : :
1483 [ + - ]: 2939 : path.emplace_back(); // Placeholder for multipath segment
1484 : 2939 : substitutes->placeholder_index = path.size() - 1;
1485 : 2979 : } else {
1486 [ + - ]: 211316 : const auto& op_num = ParseKeyPathNum(elem, apostrophe, error);
1487 [ + + ]: 211316 : if (!op_num) return false;
1488 [ + - ]: 211251 : path.emplace_back(*op_num);
1489 : : }
1490 : : }
1491 : :
1492 [ + + ]: 174597 : if (!substitutes) {
1493 [ + - ]: 171660 : out.emplace_back(std::move(path));
1494 : : } else {
1495 : : // Replace the multipath placeholder with each value while generating paths
1496 [ + + ]: 30958 : for (uint32_t substitute : substitutes->values) {
1497 [ + - ]: 28021 : KeyPath branch_path = path;
1498 [ + - ]: 28021 : branch_path[substitutes->placeholder_index] = substitute;
1499 [ + - ]: 28021 : out.emplace_back(std::move(branch_path));
1500 : 28021 : }
1501 : : }
1502 : : return true;
1503 : 174723 : }
1504 : :
1505 : : /** Parse a public key that excludes origin information. */
1506 : 208464 : 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)
1507 : : {
1508 : 208464 : std::vector<std::unique_ptr<PubkeyProvider>> ret;
1509 : 208464 : bool permit_uncompressed = ctx == ParseScriptContext::TOP || ctx == ParseScriptContext::P2SH;
1510 [ + - ]: 208464 : auto split = Split(sp, '/');
1511 [ + - + + ]: 416928 : std::string str(split[0].begin(), split[0].end());
1512 [ + + ]: 208464 : if (str.size() == 0) {
1513 [ + - ]: 41 : error = "No key provided";
1514 : 41 : return {};
1515 : : }
1516 [ + + + + ]: 208423 : if (IsSpace(str.front()) || IsSpace(str.back())) {
1517 [ + - ]: 11 : error = strprintf("Key '%s' is invalid due to whitespace", str);
1518 : 11 : return {};
1519 : : }
1520 [ + + ]: 208412 : if (split.size() == 1) {
1521 [ + - + + ]: 112955 : if (IsHex(str)) {
1522 [ + - ]: 36968 : std::vector<unsigned char> data = ParseHex(str);
1523 : 36968 : CPubKey pubkey(data);
1524 [ + + + + ]: 36968 : if (pubkey.IsValid() && !pubkey.IsValidNonHybrid()) {
1525 [ + - ]: 10 : error = "Hybrid public keys are not allowed";
1526 : 10 : return {};
1527 : : }
1528 [ + - + + ]: 36958 : if (pubkey.IsFullyValid()) {
1529 [ + + + + ]: 20416 : if (permit_uncompressed || pubkey.IsCompressed()) {
1530 [ + - + - ]: 20413 : ret.emplace_back(std::make_unique<ConstPubkeyProvider>(key_exp_index, pubkey, false));
1531 : 20413 : return ret;
1532 : : } else {
1533 [ + - ]: 3 : error = "Uncompressed keys are not allowed";
1534 : 3 : return {};
1535 : : }
1536 [ + + + + ]: 16542 : } else if (data.size() == 32 && ctx == ParseScriptContext::P2TR) {
1537 : 16477 : unsigned char fullkey[33] = {0x02};
1538 : 16477 : std::copy(data.begin(), data.end(), fullkey + 1);
1539 : 16477 : pubkey.Set(std::begin(fullkey), std::end(fullkey));
1540 [ + - + + ]: 16477 : if (pubkey.IsFullyValid()) {
1541 [ + - + - ]: 16467 : ret.emplace_back(std::make_unique<ConstPubkeyProvider>(key_exp_index, pubkey, true));
1542 : 16467 : return ret;
1543 : : }
1544 : : }
1545 [ + - ]: 75 : error = strprintf("Pubkey '%s' is invalid", str);
1546 : 75 : return {};
1547 : 36968 : }
1548 [ + - ]: 75987 : CKey key = DecodeSecret(str);
1549 [ + + ]: 75987 : if (key.IsValid()) {
1550 [ + + - + ]: 45497 : if (permit_uncompressed || key.IsCompressed()) {
1551 [ + - ]: 45497 : CPubKey pubkey = key.GetPubKey();
1552 [ + - + - ]: 45497 : out.keys.emplace(pubkey.GetID(), key);
1553 [ + - + - ]: 45497 : ret.emplace_back(std::make_unique<ConstPubkeyProvider>(key_exp_index, pubkey, ctx == ParseScriptContext::P2TR));
1554 : 45497 : return ret;
1555 : : } else {
1556 [ # # ]: 0 : error = "Uncompressed keys are not allowed";
1557 : 0 : return {};
1558 : : }
1559 : : }
1560 : 75987 : }
1561 [ + - ]: 125947 : CExtKey extkey = DecodeExtKey(str);
1562 [ + - ]: 125947 : CExtPubKey extpubkey = DecodeExtPubKey(str);
1563 [ + + + + ]: 125947 : if (!extkey.key.IsValid() && !extpubkey.pubkey.IsValid()) {
1564 [ + - ]: 218 : error = strprintf("key '%s' is not valid", str);
1565 : 218 : return {};
1566 : : }
1567 : 125729 : std::vector<KeyPath> paths;
1568 : 125729 : DeriveType type = DeriveType::NO;
1569 [ + + ]: 125729 : if (std::ranges::equal(split.back(), std::span{"*"}.first(1))) {
1570 : 27350 : split.pop_back();
1571 : 27350 : type = DeriveType::UNHARDENED;
1572 [ + + + + ]: 98379 : } else if (std::ranges::equal(split.back(), std::span{"*'"}.first(2)) || std::ranges::equal(split.back(), std::span{"*h"}.first(2))) {
1573 : 6824 : apostrophe = std::ranges::equal(split.back(), std::span{"*'"}.first(2));
1574 : 6824 : split.pop_back();
1575 : 6824 : type = DeriveType::HARDENED;
1576 : : }
1577 [ + - + + ]: 125729 : if (!ParseKeyPath(split, paths, apostrophe, error, /*allow_multipath=*/true)) return {};
1578 [ + + ]: 125668 : if (extkey.key.IsValid()) {
1579 [ + - ]: 111807 : extpubkey = extkey.Neuter();
1580 [ + - + - ]: 111807 : out.keys.emplace(extpubkey.pubkey.GetID(), extkey.key);
1581 : : }
1582 [ + + ]: 276420 : for (auto& path : paths) {
1583 [ + - + - ]: 301504 : ret.emplace_back(std::make_unique<BIP32PubkeyProvider>(key_exp_index, extpubkey, std::move(path), type, apostrophe));
1584 : : }
1585 : 125668 : return ret;
1586 : 460140 : }
1587 : :
1588 : : /** Parse a public key including origin information (if enabled). */
1589 : 208564 : 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)
1590 : : {
1591 : 208564 : std::vector<std::unique_ptr<PubkeyProvider>> ret;
1592 [ + - ]: 208564 : auto origin_split = Split(sp, ']');
1593 [ + + ]: 208564 : if (origin_split.size() > 2) {
1594 [ + - ]: 9 : error = "Multiple ']' characters found for a single pubkey";
1595 : 9 : return {};
1596 : : }
1597 : : // This is set if either the origin or path suffix contains a hardened derivation.
1598 : 208555 : bool apostrophe = false;
1599 [ + + ]: 208555 : if (origin_split.size() == 1) {
1600 [ + - ]: 159535 : return ParsePubkeyInner(key_exp_index, origin_split[0], ctx, out, apostrophe, error);
1601 : : }
1602 [ + + + + ]: 49020 : if (origin_split[0].empty() || origin_split[0][0] != '[') {
1603 : 36 : error = strprintf("Key origin start '[ character expected but not found, got '%c' instead",
1604 [ + + + - ]: 12 : origin_split[0].empty() ? /** empty, implies split char */ ']' : origin_split[0][0]);
1605 : 12 : return {};
1606 : : }
1607 [ + - ]: 49008 : auto slash_split = Split(origin_split[0].subspan(1), '/');
1608 [ + + ]: 49008 : if (slash_split[0].size() != 8) {
1609 [ + - ]: 8 : error = strprintf("Fingerprint is not 4 bytes (%u characters instead of 8 characters)", slash_split[0].size());
1610 : 8 : return {};
1611 : : }
1612 [ + - + - ]: 98000 : std::string fpr_hex = std::string(slash_split[0].begin(), slash_split[0].end());
1613 [ + - + + ]: 49000 : if (!IsHex(fpr_hex)) {
1614 [ + - ]: 6 : error = strprintf("Fingerprint '%s' is not hex", fpr_hex);
1615 : 6 : return {};
1616 : : }
1617 [ + - ]: 48994 : auto fpr_bytes = ParseHex(fpr_hex);
1618 [ - + ]: 48994 : KeyOriginInfo info;
1619 : 48994 : static_assert(sizeof(info.fingerprint) == 4, "Fingerprint must be 4 bytes");
1620 [ - + ]: 48994 : assert(fpr_bytes.size() == 4);
1621 : 48994 : std::copy(fpr_bytes.begin(), fpr_bytes.end(), info.fingerprint);
1622 : 48994 : std::vector<KeyPath> path;
1623 [ + - + + ]: 48994 : if (!ParseKeyPath(slash_split, path, apostrophe, error, /*allow_multipath=*/false)) return {};
1624 [ + - + - ]: 48929 : info.path = path.at(0);
1625 [ + - ]: 48929 : auto providers = ParsePubkeyInner(key_exp_index, origin_split[1], ctx, out, apostrophe, error);
1626 [ + + ]: 48929 : if (providers.empty()) return {};
1627 [ + - ]: 48890 : ret.reserve(providers.size());
1628 [ + + ]: 97988 : for (auto& prov : providers) {
1629 [ + - + - ]: 98196 : ret.emplace_back(std::make_unique<OriginPubkeyProvider>(key_exp_index, info, std::move(prov), apostrophe));
1630 : : }
1631 : 48890 : return ret;
1632 : 355566 : }
1633 : :
1634 : 3466628 : std::unique_ptr<PubkeyProvider> InferPubkey(const CPubKey& pubkey, ParseScriptContext ctx, const SigningProvider& provider)
1635 : : {
1636 : : // Key cannot be hybrid
1637 [ + + ]: 3466628 : if (!pubkey.IsValidNonHybrid()) {
1638 : 3464 : return nullptr;
1639 : : }
1640 : : // Uncompressed is only allowed in TOP and P2SH contexts
1641 [ + + - + ]: 3463164 : if (ctx != ParseScriptContext::TOP && ctx != ParseScriptContext::P2SH && !pubkey.IsCompressed()) {
1642 : 0 : return nullptr;
1643 : : }
1644 : 3463164 : std::unique_ptr<PubkeyProvider> key_provider = std::make_unique<ConstPubkeyProvider>(0, pubkey, false);
1645 [ + - ]: 3463164 : KeyOriginInfo info;
1646 [ + - + - : 3463164 : if (provider.GetKeyOrigin(pubkey.GetID(), info)) {
+ + ]
1647 [ + - - + ]: 3338429 : return std::make_unique<OriginPubkeyProvider>(0, std::move(info), std::move(key_provider), /*apostrophe=*/false);
1648 : : }
1649 : 124735 : return key_provider;
1650 : 3463164 : }
1651 : :
1652 : 713714 : std::unique_ptr<PubkeyProvider> InferXOnlyPubkey(const XOnlyPubKey& xkey, ParseScriptContext ctx, const SigningProvider& provider)
1653 : : {
1654 : 713714 : CPubKey pubkey{xkey.GetEvenCorrespondingCPubKey()};
1655 : 713714 : std::unique_ptr<PubkeyProvider> key_provider = std::make_unique<ConstPubkeyProvider>(0, pubkey, true);
1656 [ + - ]: 713714 : KeyOriginInfo info;
1657 [ + - + + ]: 713714 : if (provider.GetKeyOriginByXOnly(xkey, info)) {
1658 [ + - - + ]: 706720 : return std::make_unique<OriginPubkeyProvider>(0, std::move(info), std::move(key_provider), /*apostrophe=*/false);
1659 : : }
1660 : 6994 : return key_provider;
1661 : 713714 : }
1662 : :
1663 : : /**
1664 : : * The context for parsing a Miniscript descriptor (either from Script or from its textual representation).
1665 : : */
1666 : 24758 : struct KeyParser {
1667 : : //! The Key type is an index in DescriptorImpl::m_pubkey_args
1668 : : using Key = uint32_t;
1669 : : //! Must not be nullptr if parsing from string.
1670 : : FlatSigningProvider* m_out;
1671 : : //! Must not be nullptr if parsing from Script.
1672 : : const SigningProvider* m_in;
1673 : : //! List of multipath expanded keys contained in the Miniscript.
1674 : : mutable std::vector<std::vector<std::unique_ptr<PubkeyProvider>>> m_keys;
1675 : : //! Used to detect key parsing errors within a Miniscript.
1676 : : mutable std::string m_key_parsing_error;
1677 : : //! The script context we're operating within (Tapscript or P2WSH).
1678 : : const miniscript::MiniscriptContext m_script_ctx;
1679 : : //! The number of keys that were parsed before starting to parse this Miniscript descriptor.
1680 : : uint32_t m_offset;
1681 : :
1682 : 24758 : KeyParser(FlatSigningProvider* out LIFETIMEBOUND, const SigningProvider* in LIFETIMEBOUND,
1683 : : miniscript::MiniscriptContext ctx, uint32_t offset = 0)
1684 : 24758 : : m_out(out), m_in(in), m_script_ctx(ctx), m_offset(offset) {}
1685 : :
1686 : 180639 : bool KeyCompare(const Key& a, const Key& b) const {
1687 : 180639 : return *m_keys.at(a).at(0) < *m_keys.at(b).at(0);
1688 : : }
1689 : :
1690 : 66649 : ParseScriptContext ParseContext() const {
1691 [ + - + ]: 66649 : switch (m_script_ctx) {
1692 : : case miniscript::MiniscriptContext::P2WSH: return ParseScriptContext::P2WSH;
1693 : 34934 : case miniscript::MiniscriptContext::TAPSCRIPT: return ParseScriptContext::P2TR;
1694 : : }
1695 : 0 : assert(false);
1696 : : }
1697 : :
1698 : 36642 : template<typename I> std::optional<Key> FromString(I begin, I end) const
1699 : : {
1700 [ - + ]: 36642 : assert(m_out);
1701 : 36642 : Key key = m_keys.size();
1702 : 36642 : auto pk = ParsePubkey(m_offset + key, {&*begin, &*end}, ParseContext(), *m_out, m_key_parsing_error);
1703 [ + + ]: 36642 : if (pk.empty()) return {};
1704 [ + - ]: 36510 : m_keys.emplace_back(std::move(pk));
1705 : 36510 : return key;
1706 : 36642 : }
1707 : :
1708 : 12649 : std::optional<std::string> ToString(const Key& key) const
1709 : : {
1710 : 12649 : return m_keys.at(key).at(0)->ToString();
1711 : : }
1712 : :
1713 : 28746 : template<typename I> std::optional<Key> FromPKBytes(I begin, I end) const
1714 : : {
1715 [ - + ]: 28746 : assert(m_in);
1716 : 28746 : Key key = m_keys.size();
1717 [ + + + - ]: 28746 : if (miniscript::IsTapscript(m_script_ctx) && end - begin == 32) {
1718 : 13487 : XOnlyPubKey pubkey;
1719 : 13487 : std::copy(begin, end, pubkey.begin());
1720 [ + - ]: 13487 : if (auto pubkey_provider = InferXOnlyPubkey(pubkey, ParseContext(), *m_in)) {
1721 [ + - ]: 13487 : m_keys.emplace_back();
1722 [ + - ]: 13487 : m_keys.back().push_back(std::move(pubkey_provider));
1723 : 13487 : return key;
1724 : : }
1725 [ + - ]: 15259 : } else if (!miniscript::IsTapscript(m_script_ctx)) {
1726 : 15259 : CPubKey pubkey(begin, end);
1727 [ + + ]: 15259 : if (auto pubkey_provider = InferPubkey(pubkey, ParseContext(), *m_in)) {
1728 [ + - ]: 15251 : m_keys.emplace_back();
1729 [ + - ]: 15251 : m_keys.back().push_back(std::move(pubkey_provider));
1730 : 15251 : return key;
1731 : : }
1732 : : }
1733 : 8 : return {};
1734 : : }
1735 : :
1736 [ - + ]: 1262 : template<typename I> std::optional<Key> FromPKHBytes(I begin, I end) const
1737 : : {
1738 [ - + ]: 1262 : assert(end - begin == 20);
1739 [ - + ]: 1262 : assert(m_in);
1740 : 1262 : uint160 hash;
1741 : 1262 : std::copy(begin, end, hash.begin());
1742 : 1262 : CKeyID keyid(hash);
1743 : 1262 : CPubKey pubkey;
1744 [ + + ]: 1262 : if (m_in->GetPubKey(keyid, pubkey)) {
1745 [ + - ]: 1261 : if (auto pubkey_provider = InferPubkey(pubkey, ParseContext(), *m_in)) {
1746 [ + - ]: 1261 : Key key = m_keys.size();
1747 [ + - ]: 1261 : m_keys.emplace_back();
1748 [ + - ]: 1261 : m_keys.back().push_back(std::move(pubkey_provider));
1749 : 1261 : return key;
1750 : : }
1751 : : }
1752 : 1 : return {};
1753 : : }
1754 : :
1755 : 3792682 : miniscript::MiniscriptContext MsContext() const {
1756 [ + - + - : 3792682 : return m_script_ctx;
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + + +
- + - ]
1757 : : }
1758 : : };
1759 : :
1760 : : /** Parse a script in a particular context. */
1761 : : // NOLINTNEXTLINE(misc-no-recursion)
1762 : 55592 : std::vector<std::unique_ptr<DescriptorImpl>> ParseScript(uint32_t& key_exp_index, std::span<const char>& sp, ParseScriptContext ctx, FlatSigningProvider& out, std::string& error)
1763 : : {
1764 : 55592 : using namespace script;
1765 [ + + - ]: 111184 : Assume(ctx == ParseScriptContext::TOP || ctx == ParseScriptContext::P2SH || ctx == ParseScriptContext::P2WSH || ctx == ParseScriptContext::P2TR);
1766 : 55592 : std::vector<std::unique_ptr<DescriptorImpl>> ret;
1767 [ + - ]: 55592 : auto expr = Expr(sp);
1768 [ + - + - : 55592 : if (Func("pk", expr)) {
+ + ]
1769 [ + - ]: 5233 : auto pubkeys = ParsePubkey(key_exp_index, expr, ctx, out, error);
1770 [ + + ]: 5233 : if (pubkeys.empty()) {
1771 [ + - ]: 153 : error = strprintf("pk(): %s", error);
1772 : 153 : return {};
1773 : : }
1774 : 5080 : ++key_exp_index;
1775 [ + + ]: 10959 : for (auto& pubkey : pubkeys) {
1776 [ + - + - ]: 11758 : ret.emplace_back(std::make_unique<PKDescriptor>(std::move(pubkey), ctx == ParseScriptContext::P2TR));
1777 : : }
1778 : 5080 : return ret;
1779 : 5233 : }
1780 [ + + + - : 95364 : if ((ctx == ParseScriptContext::TOP || ctx == ParseScriptContext::P2SH || ctx == ParseScriptContext::P2WSH) && Func("pkh", expr)) {
+ - + + +
+ ]
1781 [ + - ]: 6485 : auto pubkeys = ParsePubkey(key_exp_index, expr, ctx, out, error);
1782 [ + + ]: 6485 : if (pubkeys.empty()) {
1783 [ + - ]: 13 : error = strprintf("pkh(): %s", error);
1784 : 13 : return {};
1785 : : }
1786 : 6472 : ++key_exp_index;
1787 [ + + ]: 13408 : for (auto& pubkey : pubkeys) {
1788 [ + - + - ]: 13872 : ret.emplace_back(std::make_unique<PKHDescriptor>(std::move(pubkey)));
1789 : : }
1790 : 6472 : return ret;
1791 : 6485 : }
1792 [ + + + - : 72559 : if (ctx == ParseScriptContext::TOP && Func("combo", expr)) {
+ - + + +
+ ]
1793 [ + - ]: 385 : auto pubkeys = ParsePubkey(key_exp_index, expr, ctx, out, error);
1794 [ + + ]: 385 : if (pubkeys.empty()) {
1795 [ + - ]: 14 : error = strprintf("combo(): %s", error);
1796 : 14 : return {};
1797 : : }
1798 : 371 : ++key_exp_index;
1799 [ + + ]: 1381 : for (auto& pubkey : pubkeys) {
1800 [ + - + - ]: 2020 : ret.emplace_back(std::make_unique<ComboDescriptor>(std::move(pubkey)));
1801 : : }
1802 : 371 : return ret;
1803 [ + - + - : 43874 : } else if (Func("combo", expr)) {
+ + ]
1804 [ + - ]: 5 : error = "Can only have combo() at top level";
1805 : 5 : return {};
1806 : : }
1807 [ + - + - ]: 43484 : const bool multi = Func("multi", expr);
1808 [ + + + - : 86307 : const bool sortedmulti = !multi && Func("sortedmulti", expr);
+ - + + ]
1809 [ + + + - : 85880 : const bool multi_a = !(multi || sortedmulti) && Func("multi_a", expr);
+ - + + ]
1810 [ + + + + : 85010 : const bool sortedmulti_a = !(multi || sortedmulti || multi_a) && Func("sortedmulti_a", expr);
+ - + - +
+ ]
1811 [ + + + + : 43484 : if (((ctx == ParseScriptContext::TOP || ctx == ParseScriptContext::P2SH || ctx == ParseScriptContext::P2WSH) && (multi || sortedmulti)) ||
+ + + + ]
1812 [ + + + + ]: 5354 : (ctx == ParseScriptContext::P2TR && (multi_a || sortedmulti_a))) {
1813 [ + - ]: 2397 : auto threshold = Expr(expr);
1814 : 2397 : uint32_t thres;
1815 : 2397 : std::vector<std::vector<std::unique_ptr<PubkeyProvider>>> providers; // List of multipath expanded pubkeys
1816 [ + - + - : 4794 : if (!ParseUInt32(std::string(threshold.begin(), threshold.end()), &thres)) {
+ + ]
1817 [ + - + - ]: 174 : error = strprintf("Multi threshold '%s' is not valid", std::string(threshold.begin(), threshold.end()));
1818 : 87 : return {};
1819 : : }
1820 : 2310 : size_t script_size = 0;
1821 : 2310 : size_t max_providers_len = 0;
1822 [ + + ]: 141397 : while (expr.size()) {
1823 [ + - + - : 139209 : if (!Const(",", expr)) {
+ + ]
1824 [ + - ]: 5 : error = strprintf("Multi: expected ',', got '%c'", expr[0]);
1825 : 5 : return {};
1826 : : }
1827 [ + - ]: 139204 : auto arg = Expr(expr);
1828 [ + - ]: 139204 : auto pks = ParsePubkey(key_exp_index, arg, ctx, out, error);
1829 [ + + ]: 139204 : if (pks.empty()) {
1830 [ + - ]: 117 : error = strprintf("Multi: %s", error);
1831 : 117 : return {};
1832 : : }
1833 [ + - + - ]: 139087 : script_size += pks.at(0)->GetSize() + 1;
1834 [ + + ]: 139087 : max_providers_len = std::max(max_providers_len, pks.size());
1835 [ + - ]: 139087 : providers.emplace_back(std::move(pks));
1836 : 139087 : key_exp_index++;
1837 : 139204 : }
1838 [ + + + + : 2188 : if ((multi || sortedmulti) && (providers.empty() || providers.size() > MAX_PUBKEYS_PER_MULTISIG)) {
+ + + + ]
1839 [ + - ]: 19 : error = strprintf("Cannot have %u keys in multisig; must have between 1 and %d keys, inclusive", providers.size(), MAX_PUBKEYS_PER_MULTISIG);
1840 : 19 : return {};
1841 [ + + + + : 2169 : } else if ((multi_a || sortedmulti_a) && (providers.empty() || providers.size() > MAX_PUBKEYS_PER_MULTI_A)) {
+ + + + ]
1842 [ + - ]: 7 : error = strprintf("Cannot have %u keys in multi_a; must have between 1 and %d keys, inclusive", providers.size(), MAX_PUBKEYS_PER_MULTI_A);
1843 : 7 : return {};
1844 [ + + ]: 2162 : } else if (thres < 1) {
1845 [ + - ]: 5 : error = strprintf("Multisig threshold cannot be %d, must be at least 1", thres);
1846 : 5 : return {};
1847 [ + + ]: 2157 : } else if (thres > providers.size()) {
1848 [ + - ]: 11 : error = strprintf("Multisig threshold cannot be larger than the number of keys; threshold is %d but only %u keys specified", thres, providers.size());
1849 : 11 : return {};
1850 : : }
1851 [ + + ]: 2146 : if (ctx == ParseScriptContext::TOP) {
1852 [ + + ]: 185 : if (providers.size() > 3) {
1853 [ + - ]: 9 : error = strprintf("Cannot have %u pubkeys in bare multisig; only at most 3 pubkeys", providers.size());
1854 : 9 : return {};
1855 : : }
1856 : : }
1857 [ + + ]: 2137 : if (ctx == ParseScriptContext::P2SH) {
1858 : : // This limits the maximum number of compressed pubkeys to 15.
1859 [ + + ]: 319 : if (script_size + 3 > MAX_SCRIPT_ELEMENT_SIZE) {
1860 [ + - ]: 7 : error = strprintf("P2SH script is too large, %d bytes is larger than %d bytes", script_size + 3, MAX_SCRIPT_ELEMENT_SIZE);
1861 : 7 : return {};
1862 : : }
1863 : : }
1864 : :
1865 : : // Make sure all vecs are of the same length, or exactly length 1
1866 : : // For length 1 vectors, clone key providers until vector is the same length
1867 [ + + ]: 132027 : for (auto& vec : providers) {
1868 [ + + ]: 129901 : if (vec.size() == 1) {
1869 [ + + ]: 400508 : for (size_t i = 1; i < max_providers_len; ++i) {
1870 [ + - + - : 271020 : vec.emplace_back(vec.at(0)->Clone());
+ - ]
1871 : : }
1872 [ + + ]: 413 : } else if (vec.size() != max_providers_len) {
1873 [ + - ]: 4 : error = strprintf("multi(): Multipath derivation paths have mismatched lengths");
1874 : 4 : return {};
1875 : : }
1876 : : }
1877 : :
1878 : : // Build the final descriptors vector
1879 [ + + ]: 7785 : for (size_t i = 0; i < max_providers_len; ++i) {
1880 : : // Build final pubkeys vectors by retrieving the i'th subscript for each vector in subscripts
1881 : 5659 : std::vector<std::unique_ptr<PubkeyProvider>> pubs;
1882 [ + - ]: 5659 : pubs.reserve(providers.size());
1883 [ + + ]: 411192 : for (auto& pub : providers) {
1884 [ + - + - ]: 405533 : pubs.emplace_back(std::move(pub.at(i)));
1885 : : }
1886 [ + + + + ]: 5659 : if (multi || sortedmulti) {
1887 [ + - + - ]: 5836 : ret.emplace_back(std::make_unique<MultisigDescriptor>(thres, std::move(pubs), sortedmulti));
1888 : : } else {
1889 [ + - + - ]: 5482 : ret.emplace_back(std::make_unique<MultiADescriptor>(thres, std::move(pubs), sortedmulti_a));
1890 : : }
1891 : 5659 : }
1892 : 2126 : return ret;
1893 [ + + + + ]: 43484 : } else if (multi || sortedmulti) {
1894 [ + - ]: 10 : error = "Can only have multi/sortedmulti at top level, in sh(), or in wsh()";
1895 : 10 : return {};
1896 [ + + + + ]: 41077 : } else if (multi_a || sortedmulti_a) {
1897 [ + - ]: 10 : error = "Can only have multi_a/sortedmulti_a inside tr()";
1898 : 10 : return {};
1899 : : }
1900 [ + + + - : 75401 : if ((ctx == ParseScriptContext::TOP || ctx == ParseScriptContext::P2SH) && Func("wpkh", expr)) {
+ - + + +
+ ]
1901 [ + - ]: 12166 : auto pubkeys = ParsePubkey(key_exp_index, expr, ParseScriptContext::P2WPKH, out, error);
1902 [ + + ]: 12166 : if (pubkeys.empty()) {
1903 [ + - ]: 14 : error = strprintf("wpkh(): %s", error);
1904 : 14 : return {};
1905 : : }
1906 : 12152 : key_exp_index++;
1907 [ + + ]: 24818 : for (auto& pubkey : pubkeys) {
1908 [ + - + - ]: 25332 : ret.emplace_back(std::make_unique<WPKHDescriptor>(std::move(pubkey)));
1909 : : }
1910 : 12152 : return ret;
1911 [ + - + - : 41067 : } else if (Func("wpkh", expr)) {
+ + ]
1912 [ + - ]: 5 : error = "Can only have wpkh() at top level or inside sh()";
1913 : 5 : return {};
1914 : : }
1915 [ + + + - : 50747 : if (ctx == ParseScriptContext::TOP && Func("sh", expr)) {
+ - + + +
+ ]
1916 [ + - ]: 6827 : auto descs = ParseScript(key_exp_index, expr, ParseScriptContext::P2SH, out, error);
1917 [ + + + + ]: 6827 : if (descs.empty() || expr.size()) return {};
1918 : 6672 : std::vector<std::unique_ptr<DescriptorImpl>> ret;
1919 [ + - ]: 6672 : ret.reserve(descs.size());
1920 [ + + ]: 15421 : for (auto& desc : descs) {
1921 [ + - + - : 8749 : ret.push_back(std::make_unique<SHDescriptor>(std::move(desc)));
- + ]
1922 : : }
1923 : 6672 : return ret;
1924 [ + - + - : 28896 : } else if (Func("sh", expr)) {
+ + ]
1925 [ + - ]: 5 : error = "Can only have sh() at top level";
1926 : 5 : return {};
1927 : : }
1928 [ + + + - : 37400 : if ((ctx == ParseScriptContext::TOP || ctx == ParseScriptContext::P2SH) && Func("wsh", expr)) {
+ - + + +
+ ]
1929 [ + - ]: 3160 : auto descs = ParseScript(key_exp_index, expr, ParseScriptContext::P2WSH, out, error);
1930 [ + + + + ]: 3160 : if (descs.empty() || expr.size()) return {};
1931 [ + + ]: 9098 : for (auto& desc : descs) {
1932 [ + - + - ]: 14928 : ret.emplace_back(std::make_unique<WSHDescriptor>(std::move(desc)));
1933 : : }
1934 : 1634 : return ret;
1935 [ + - + - : 22064 : } else if (Func("wsh", expr)) {
+ + ]
1936 [ + - ]: 5 : error = "Can only have wsh() at top level or inside sh()";
1937 : 5 : return {};
1938 : : }
1939 [ + + + - : 31029 : if (ctx == ParseScriptContext::TOP && Func("addr", expr)) {
+ - + + +
+ ]
1940 [ + - + - ]: 1050 : CTxDestination dest = DecodeDestination(std::string(expr.begin(), expr.end()));
1941 [ + - + + ]: 525 : if (!IsValidDestination(dest)) {
1942 [ + - ]: 502 : error = "Address is not valid";
1943 : 502 : return {};
1944 : : }
1945 [ + - + - ]: 23 : ret.emplace_back(std::make_unique<AddressDescriptor>(std::move(dest)));
1946 : 23 : return ret;
1947 [ + - + - : 18899 : } else if (Func("addr", expr)) {
+ + ]
1948 [ + - ]: 5 : error = "Can only have addr() at top level";
1949 : 5 : return {};
1950 : : }
1951 [ + + + - : 29974 : if (ctx == ParseScriptContext::TOP && Func("tr", expr)) {
+ - + + +
+ ]
1952 [ + - ]: 8380 : auto arg = Expr(expr);
1953 [ + - ]: 8380 : auto internal_keys = ParsePubkey(key_exp_index, arg, ParseScriptContext::P2TR, out, error);
1954 [ + + ]: 8380 : if (internal_keys.empty()) {
1955 [ + - ]: 66 : error = strprintf("tr(): %s", error);
1956 : 66 : return {};
1957 : : }
1958 [ + + ]: 8314 : size_t max_providers_len = internal_keys.size();
1959 : 8314 : ++key_exp_index;
1960 : 8314 : std::vector<std::vector<std::unique_ptr<DescriptorImpl>>> subscripts; //!< list of multipath expanded script subexpressions
1961 : 8314 : std::vector<int> depths; //!< depth in the tree of each subexpression (same length subscripts)
1962 [ + + ]: 8314 : if (expr.size()) {
1963 [ + - + - : 1843 : if (!Const(",", expr)) {
+ + ]
1964 [ + - ]: 12 : error = strprintf("tr: expected ',', got '%c'", expr[0]);
1965 : 12 : return {};
1966 : : }
1967 : : /** The path from the top of the tree to what we're currently processing.
1968 : : * branches[i] == false: left branch in the i'th step from the top; true: right branch.
1969 : : */
1970 : 1831 : std::vector<bool> branches;
1971 : : // Loop over all provided scripts. In every iteration exactly one script will be processed.
1972 : : // Use a do-loop because inside this if-branch we expect at least one script.
1973 : : do {
1974 : : // First process all open braces.
1975 [ + - + - : 18802 : while (Const("{", expr)) {
+ + ]
1976 [ + - ]: 10704 : branches.push_back(false); // new left branch
1977 [ + + ]: 10704 : if (branches.size() > TAPROOT_CONTROL_MAX_NODE_COUNT) {
1978 [ + - ]: 12 : error = strprintf("tr() supports at most %i nesting levels", TAPROOT_CONTROL_MAX_NODE_COUNT);
1979 : 12 : return {};
1980 : : }
1981 : : }
1982 : : // Process the actual script expression.
1983 [ + - ]: 8098 : auto sarg = Expr(expr);
1984 [ + - + - ]: 8098 : subscripts.emplace_back(ParseScript(key_exp_index, sarg, ParseScriptContext::P2TR, out, error));
1985 [ + + ]: 8098 : if (subscripts.back().empty()) return {};
1986 [ + + ]: 7691 : max_providers_len = std::max(max_providers_len, subscripts.back().size());
1987 [ + - ]: 7691 : depths.push_back(branches.size());
1988 : : // Process closing braces; one is expected for every right branch we were in.
1989 [ + + + + ]: 10690 : while (branches.size() && branches.back()) {
1990 [ + - + + : 3012 : if (!Const("}", expr)) {
+ - ]
1991 [ + - ]: 13 : error = strprintf("tr(): expected '}' after script expression");
1992 : 13 : return {};
1993 : : }
1994 : 2999 : branches.pop_back(); // move up one level after encountering '}'
1995 : : }
1996 : : // If after that, we're at the end of a left branch, expect a comma.
1997 [ + + + - ]: 7678 : if (branches.size() && !branches.back()) {
1998 [ + - + - : 6297 : if (!Const(",", expr)) {
+ + ]
1999 [ + - ]: 18 : error = strprintf("tr(): expected ',' after script expression");
2000 : 18 : return {};
2001 : : }
2002 : 6279 : branches.back() = true; // And now we're in a right branch.
2003 : : }
2004 [ + + ]: 7660 : } while (branches.size());
2005 : : // After we've explored a whole tree, we must be at the end of the expression.
2006 [ + + ]: 1381 : if (expr.size()) {
2007 [ + - ]: 11 : error = strprintf("tr(): expected ')' after script expression");
2008 : 11 : return {};
2009 : : }
2010 : 1831 : }
2011 [ + - - + ]: 7841 : assert(TaprootBuilder::ValidDepths(depths));
2012 : :
2013 : : // Make sure all vecs are of the same length, or exactly length 1
2014 : : // For length 1 vectors, clone subdescs until vector is the same length
2015 [ + + ]: 11809 : for (auto& vec : subscripts) {
2016 [ + + ]: 3971 : if (vec.size() == 1) {
2017 [ + + ]: 12572 : for (size_t i = 1; i < max_providers_len; ++i) {
2018 [ + - + - : 8881 : vec.emplace_back(vec.at(0)->Clone());
+ - ]
2019 : : }
2020 [ + + ]: 280 : } else if (vec.size() != max_providers_len) {
2021 [ + - ]: 3 : error = strprintf("tr(): Multipath subscripts have mismatched lengths");
2022 : 3 : return {};
2023 : : }
2024 : : }
2025 : :
2026 [ + + + + ]: 7838 : if (internal_keys.size() > 1 && internal_keys.size() != max_providers_len) {
2027 [ + - ]: 1 : error = strprintf("tr(): Multipath internal key mismatches multipath subscripts lengths");
2028 : 1 : return {};
2029 : : }
2030 : :
2031 [ + + ]: 12204 : while (internal_keys.size() < max_providers_len) {
2032 [ + - + - : 4367 : internal_keys.emplace_back(internal_keys.at(0)->Clone());
+ - ]
2033 : : }
2034 : :
2035 : : // Build the final descriptors vector
2036 [ + + ]: 21820 : for (size_t i = 0; i < max_providers_len; ++i) {
2037 : : // Build final subscripts vectors by retrieving the i'th subscript for each vector in subscripts
2038 : 13983 : std::vector<std::unique_ptr<DescriptorImpl>> this_subs;
2039 [ + - ]: 13983 : this_subs.reserve(subscripts.size());
2040 [ + + ]: 31144 : for (auto& subs : subscripts) {
2041 [ + - + - ]: 17161 : this_subs.emplace_back(std::move(subs.at(i)));
2042 : : }
2043 [ + - + - : 13983 : ret.emplace_back(std::make_unique<TRDescriptor>(std::move(internal_keys.at(i)), std::move(this_subs), depths));
+ - ]
2044 : 13983 : }
2045 : 7837 : return ret;
2046 : :
2047 : :
2048 [ + - + - : 18369 : } else if (Func("tr", expr)) {
+ + ]
2049 [ + - ]: 5 : error = "Can only have tr at top level";
2050 : 5 : return {};
2051 : : }
2052 [ + + + - : 13209 : if (ctx == ParseScriptContext::TOP && Func("rawtr", expr)) {
+ - + + +
+ ]
2053 [ + - ]: 74 : auto arg = Expr(expr);
2054 [ + + ]: 74 : if (expr.size()) {
2055 [ + - ]: 5 : error = strprintf("rawtr(): only one key expected.");
2056 : 5 : return {};
2057 : : }
2058 [ + - ]: 69 : auto output_keys = ParsePubkey(key_exp_index, arg, ParseScriptContext::P2TR, out, error);
2059 [ + + ]: 69 : if (output_keys.empty()) {
2060 [ + - ]: 10 : error = strprintf("rawtr(): %s", error);
2061 : 10 : return {};
2062 : : }
2063 : 59 : ++key_exp_index;
2064 [ + + ]: 357 : for (auto& pubkey : output_keys) {
2065 [ + - + - ]: 596 : ret.emplace_back(std::make_unique<RawTRDescriptor>(std::move(pubkey)));
2066 : : }
2067 : 59 : return ret;
2068 [ + - + - : 9979 : } else if (Func("rawtr", expr)) {
+ + ]
2069 [ + - ]: 5 : error = "Can only have rawtr at top level";
2070 : 5 : return {};
2071 : : }
2072 [ + + + - : 13056 : if (ctx == ParseScriptContext::TOP && Func("raw", expr)) {
+ - + + +
+ ]
2073 [ + - + - ]: 2724 : std::string str(expr.begin(), expr.end());
2074 [ + - + + ]: 1362 : if (!IsHex(str)) {
2075 [ + - ]: 7 : error = "Raw script is not hex";
2076 : 7 : return {};
2077 : : }
2078 [ + - ]: 1355 : auto bytes = ParseHex(str);
2079 [ + - + - ]: 2710 : ret.emplace_back(std::make_unique<RawDescriptor>(CScript(bytes.begin(), bytes.end())));
2080 : 1355 : return ret;
2081 [ + - + - : 11260 : } else if (Func("raw", expr)) {
+ + ]
2082 [ + - ]: 5 : error = "Can only have raw() at top level";
2083 : 5 : return {};
2084 : : }
2085 : : // Process miniscript expressions.
2086 : 8538 : {
2087 : 8538 : const auto script_ctx{ctx == ParseScriptContext::P2WSH ? miniscript::MiniscriptContext::P2WSH : miniscript::MiniscriptContext::TAPSCRIPT};
2088 [ + - ]: 8538 : KeyParser parser(/*out = */&out, /* in = */nullptr, /* ctx = */script_ctx, key_exp_index);
2089 [ + - + - ]: 17076 : auto node = miniscript::FromString(std::string(expr.begin(), expr.end()), parser);
2090 [ + + ]: 8538 : if (parser.m_key_parsing_error != "") {
2091 : 132 : error = std::move(parser.m_key_parsing_error);
2092 : 132 : return {};
2093 : : }
2094 [ + + ]: 8406 : if (node) {
2095 [ + + ]: 6839 : if (ctx != ParseScriptContext::P2WSH && ctx != ParseScriptContext::P2TR) {
2096 [ + - ]: 484 : error = "Miniscript expressions can only be used in wsh or tr.";
2097 : 484 : return {};
2098 : : }
2099 [ + + + + ]: 6355 : if (!node->IsSane() || node->IsNotSatisfiable()) {
2100 : : // Try to find the first insane sub for better error reporting.
2101 [ + - ]: 1425 : auto insane_node = node.get();
2102 [ + - + + ]: 1425 : if (const auto sub = node->FindInsaneSub()) insane_node = sub;
2103 [ + - + - : 2850 : if (const auto str = insane_node->ToString(parser)) error = *str;
+ - ]
2104 [ + + ]: 1425 : if (!insane_node->IsValid()) {
2105 [ + - ]: 829 : error += " is invalid";
2106 [ + + ]: 596 : } else if (!node->IsSane()) {
2107 [ + - ]: 488 : error += " is not sane";
2108 [ + + ]: 488 : if (!insane_node->IsNonMalleable()) {
2109 [ + - ]: 90 : error += ": malleable witnesses exist";
2110 [ + + + + ]: 398 : } else if (insane_node == node.get() && !insane_node->NeedsSignature()) {
2111 [ + - ]: 79 : error += ": witnesses without signature exist";
2112 [ + + ]: 319 : } else if (!insane_node->CheckTimeLocksMix()) {
2113 [ + - ]: 32 : error += ": contains mixes of timelocks expressed in blocks and seconds";
2114 [ + - ]: 287 : } else if (!insane_node->CheckDuplicateKey()) {
2115 [ + - ]: 226 : error += ": contains duplicate public keys";
2116 [ + + ]: 61 : } else if (!insane_node->ValidSatisfactions()) {
2117 [ + - ]: 30 : error += ": needs witnesses that may exceed resource limits";
2118 : : }
2119 : : } else {
2120 [ + - ]: 108 : error += " is not satisfiable";
2121 : : }
2122 : 1425 : return {};
2123 : : }
2124 : : // A signature check is required for a miniscript to be sane. Therefore no sane miniscript
2125 : : // may have an empty list of public keys.
2126 [ + - ]: 4930 : CHECK_NONFATAL(!parser.m_keys.empty());
2127 : 4930 : key_exp_index += parser.m_keys.size();
2128 : : // Make sure all vecs are of the same length, or exactly length 1
2129 : : // For length 1 vectors, clone subdescs until vector is the same length
2130 : 4930 : size_t num_multipath = std::max_element(parser.m_keys.begin(), parser.m_keys.end(),
2131 : 5065 : [](const std::vector<std::unique_ptr<PubkeyProvider>>& a, const std::vector<std::unique_ptr<PubkeyProvider>>& b) {
2132 [ + + ]: 5065 : return a.size() < b.size();
2133 : 4930 : })->size();
2134 : :
2135 [ + + ]: 14902 : for (auto& vec : parser.m_keys) {
2136 [ + + ]: 9978 : if (vec.size() == 1) {
2137 [ + + ]: 19860 : for (size_t i = 1; i < num_multipath; ++i) {
2138 [ + - + - : 10410 : vec.emplace_back(vec.at(0)->Clone());
+ - ]
2139 : : }
2140 [ + + ]: 528 : } else if (vec.size() != num_multipath) {
2141 [ + - ]: 6 : error = strprintf("Miniscript: Multipath derivation paths have mismatched lengths");
2142 : 6 : return {};
2143 : : }
2144 : : }
2145 : :
2146 : : // Build the final descriptors vector
2147 [ + + ]: 17114 : for (size_t i = 0; i < num_multipath; ++i) {
2148 : : // Build final pubkeys vectors by retrieving the i'th subscript for each vector in subscripts
2149 : 12190 : std::vector<std::unique_ptr<PubkeyProvider>> pubs;
2150 [ + - ]: 12190 : pubs.reserve(parser.m_keys.size());
2151 [ + + ]: 39829 : for (auto& pub : parser.m_keys) {
2152 [ + - + - ]: 27639 : pubs.emplace_back(std::move(pub.at(i)));
2153 : : }
2154 [ + - + - : 24380 : ret.emplace_back(std::make_unique<MiniscriptDescriptor>(std::move(pubs), node->Clone()));
+ - ]
2155 : 12190 : }
2156 : 4924 : return ret;
2157 : : }
2158 : 15509 : }
2159 [ + + ]: 1567 : if (ctx == ParseScriptContext::P2SH) {
2160 [ + - ]: 21 : error = "A function is needed within P2SH";
2161 : 21 : return {};
2162 [ + + ]: 1546 : } else if (ctx == ParseScriptContext::P2WSH) {
2163 [ + - ]: 200 : error = "A function is needed within P2WSH";
2164 : 200 : return {};
2165 : : }
2166 [ + - + - ]: 2692 : error = strprintf("'%s' is not a valid descriptor function", std::string(expr.begin(), expr.end()));
2167 : 1346 : return {};
2168 : 55592 : }
2169 : :
2170 : 12878 : std::unique_ptr<DescriptorImpl> InferMultiA(const CScript& script, ParseScriptContext ctx, const SigningProvider& provider)
2171 : : {
2172 : 12878 : auto match = MatchMultiA(script);
2173 [ + + ]: 12878 : if (!match) return {};
2174 : 2030 : std::vector<std::unique_ptr<PubkeyProvider>> keys;
2175 [ + - ]: 2030 : keys.reserve(match->second.size());
2176 [ + + ]: 291532 : for (const auto keyspan : match->second) {
2177 [ - + ]: 289502 : if (keyspan.size() != 32) return {};
2178 [ + - ]: 289502 : auto key = InferXOnlyPubkey(XOnlyPubKey{keyspan}, ctx, provider);
2179 [ - + ]: 289502 : if (!key) return {};
2180 [ + - ]: 289502 : keys.push_back(std::move(key));
2181 : 289502 : }
2182 [ + - - + ]: 2030 : return std::make_unique<MultiADescriptor>(match->first, std::move(keys));
2183 : 14908 : }
2184 : :
2185 : : // NOLINTNEXTLINE(misc-no-recursion)
2186 : 6956480 : std::unique_ptr<DescriptorImpl> InferScript(const CScript& script, ParseScriptContext ctx, const SigningProvider& provider)
2187 : : {
2188 [ + + + + : 6956480 : if (ctx == ParseScriptContext::P2TR && script.size() == 34 && script[0] == 32 && script[33] == OP_CHECKSIG) {
+ + + + -
+ ]
2189 : 2179 : XOnlyPubKey key{std::span{script}.subspan(1, 32)};
2190 [ + - - + ]: 2179 : return std::make_unique<PKDescriptor>(InferXOnlyPubkey(key, ctx, provider), true);
2191 : : }
2192 : :
2193 [ + + ]: 6954301 : if (ctx == ParseScriptContext::P2TR) {
2194 : 12878 : auto ret = InferMultiA(script, ctx, provider);
2195 [ + + ]: 12878 : if (ret) return ret;
2196 : 12878 : }
2197 : :
2198 : 6952271 : std::vector<std::vector<unsigned char>> data;
2199 [ + - ]: 6952271 : TxoutType txntype = Solver(script, data);
2200 : :
2201 [ + + + - ]: 6952271 : if (txntype == TxoutType::PUBKEY && (ctx == ParseScriptContext::TOP || ctx == ParseScriptContext::P2SH || ctx == ParseScriptContext::P2WSH)) {
2202 : 24027 : CPubKey pubkey(data[0]);
2203 [ + - + + ]: 24027 : if (auto pubkey_provider = InferPubkey(pubkey, ctx, provider)) {
2204 [ + - - + ]: 22195 : return std::make_unique<PKDescriptor>(std::move(pubkey_provider));
2205 : 24027 : }
2206 : : }
2207 [ + + + + ]: 6930076 : if (txntype == TxoutType::PUBKEYHASH && (ctx == ParseScriptContext::TOP || ctx == ParseScriptContext::P2SH || ctx == ParseScriptContext::P2WSH)) {
2208 : 1069526 : uint160 hash(data[0]);
2209 [ + - ]: 1069526 : CKeyID keyid(hash);
2210 [ + - ]: 1069526 : CPubKey pubkey;
2211 [ + - + + ]: 1069526 : if (provider.GetPubKey(keyid, pubkey)) {
2212 [ + - + - ]: 1049443 : if (auto pubkey_provider = InferPubkey(pubkey, ctx, provider)) {
2213 [ + - - + ]: 1049443 : return std::make_unique<PKHDescriptor>(std::move(pubkey_provider));
2214 : 1049443 : }
2215 : : }
2216 : : }
2217 [ + + ]: 5880633 : if (txntype == TxoutType::WITNESS_V0_KEYHASH && (ctx == ParseScriptContext::TOP || ctx == ParseScriptContext::P2SH)) {
2218 : 2298989 : uint160 hash(data[0]);
2219 [ + - ]: 2298989 : CKeyID keyid(hash);
2220 [ + - ]: 2298989 : CPubKey pubkey;
2221 [ + - + + ]: 2298989 : if (provider.GetPubKey(keyid, pubkey)) {
2222 [ + - + - ]: 2246994 : if (auto pubkey_provider = InferPubkey(pubkey, ParseScriptContext::P2WPKH, provider)) {
2223 [ + - - + ]: 2246994 : return std::make_unique<WPKHDescriptor>(std::move(pubkey_provider));
2224 : 2246994 : }
2225 : : }
2226 : : }
2227 [ + + + - ]: 3633639 : if (txntype == TxoutType::MULTISIG && (ctx == ParseScriptContext::TOP || ctx == ParseScriptContext::P2SH || ctx == ParseScriptContext::P2WSH)) {
2228 : 24511 : bool ok = true;
2229 : 24511 : std::vector<std::unique_ptr<PubkeyProvider>> providers;
2230 [ + + ]: 152531 : for (size_t i = 1; i + 1 < data.size(); ++i) {
2231 : 129644 : CPubKey pubkey(data[i]);
2232 [ + - + + ]: 129644 : if (auto pubkey_provider = InferPubkey(pubkey, ctx, provider)) {
2233 [ + - ]: 128020 : providers.push_back(std::move(pubkey_provider));
2234 : : } else {
2235 : 1624 : ok = false;
2236 : 1624 : break;
2237 : 129644 : }
2238 : : }
2239 [ + - - + ]: 22887 : if (ok) return std::make_unique<MultisigDescriptor>((int)data[0][0], std::move(providers));
2240 : 24511 : }
2241 [ + + ]: 3610752 : if (txntype == TxoutType::SCRIPTHASH && ctx == ParseScriptContext::TOP) {
2242 : 2278200 : uint160 hash(data[0]);
2243 [ + - ]: 2278200 : CScriptID scriptid(hash);
2244 : 2278200 : CScript subscript;
2245 [ + - + + ]: 2278200 : if (provider.GetCScript(scriptid, subscript)) {
2246 [ + - ]: 2163306 : auto sub = InferScript(subscript, ParseScriptContext::P2SH, provider);
2247 [ + + + - : 2163306 : if (sub) return std::make_unique<SHDescriptor>(std::move(sub));
- + ]
2248 : 2163306 : }
2249 : 2278200 : }
2250 [ + + ]: 1447447 : if (txntype == TxoutType::WITNESS_V0_SCRIPTHASH && (ctx == ParseScriptContext::TOP || ctx == ParseScriptContext::P2SH)) {
2251 [ + - ]: 65489 : CScriptID scriptid{RIPEMD160(data[0])};
2252 : 65489 : CScript subscript;
2253 [ + - + + ]: 65489 : if (provider.GetCScript(scriptid, subscript)) {
2254 [ + - ]: 7010 : auto sub = InferScript(subscript, ParseScriptContext::P2WSH, provider);
2255 [ + + + - : 7010 : if (sub) return std::make_unique<WSHDescriptor>(std::move(sub));
- + ]
2256 : 7010 : }
2257 : 65489 : }
2258 [ + + ]: 1440875 : if (txntype == TxoutType::WITNESS_V1_TAPROOT && ctx == ParseScriptContext::TOP) {
2259 : : // Extract x-only pubkey from output.
2260 : 411891 : XOnlyPubKey pubkey;
2261 : 411891 : std::copy(data[0].begin(), data[0].end(), pubkey.begin());
2262 : : // Request spending data.
2263 [ + - ]: 411891 : TaprootSpendData tap;
2264 [ + - + + ]: 411891 : if (provider.GetTaprootSpendData(pubkey, tap)) {
2265 : : // If found, convert it back to tree form.
2266 [ + - ]: 401419 : auto tree = InferTaprootTree(tap, pubkey);
2267 [ + + ]: 401419 : if (tree) {
2268 : : // If that works, try to infer subdescriptors for all leaves.
2269 : 401407 : bool ok = true;
2270 : 401407 : std::vector<std::unique_ptr<DescriptorImpl>> subscripts; //!< list of script subexpressions
2271 : 401407 : std::vector<int> depths; //!< depth in the tree of each subexpression (same length subscripts)
2272 [ + - + + ]: 416456 : for (const auto& [depth, script, leaf_ver] : *tree) {
2273 : 15057 : std::unique_ptr<DescriptorImpl> subdesc;
2274 [ + - ]: 15057 : if (leaf_ver == TAPROOT_LEAF_TAPSCRIPT) {
2275 [ + - ]: 30114 : subdesc = InferScript(CScript(script.begin(), script.end()), ParseScriptContext::P2TR, provider);
2276 : : }
2277 [ + + ]: 15057 : if (!subdesc) {
2278 : 8 : ok = false;
2279 : 8 : break;
2280 : : } else {
2281 [ + - ]: 15049 : subscripts.push_back(std::move(subdesc));
2282 [ + - ]: 15049 : depths.push_back(depth);
2283 : : }
2284 : 15057 : }
2285 : 8 : if (ok) {
2286 [ + - ]: 401399 : auto key = InferXOnlyPubkey(tap.internal_key, ParseScriptContext::P2TR, provider);
2287 [ + - - + ]: 401399 : return std::make_unique<TRDescriptor>(std::move(key), std::move(subscripts), std::move(depths));
2288 : 401399 : }
2289 : 401407 : }
2290 : 401419 : }
2291 : : // If the above doesn't work, construct a rawtr() descriptor with just the encoded x-only pubkey.
2292 [ + - + + ]: 10492 : if (pubkey.IsFullyValid()) {
2293 [ + - ]: 7147 : auto key = InferXOnlyPubkey(pubkey, ParseScriptContext::P2TR, provider);
2294 [ + - ]: 7147 : if (key) {
2295 [ + - - + ]: 7147 : return std::make_unique<RawTRDescriptor>(std::move(key));
2296 : : }
2297 : 7147 : }
2298 : 411891 : }
2299 : :
2300 [ + + ]: 1032329 : if (ctx == ParseScriptContext::P2WSH || ctx == ParseScriptContext::P2TR) {
2301 : 16220 : const auto script_ctx{ctx == ParseScriptContext::P2WSH ? miniscript::MiniscriptContext::P2WSH : miniscript::MiniscriptContext::TAPSCRIPT};
2302 [ + - ]: 16220 : KeyParser parser(/* out = */nullptr, /* in = */&provider, /* ctx = */script_ctx);
2303 [ + - ]: 16220 : auto node = miniscript::FromScript(script, parser);
2304 [ + + + + ]: 16220 : if (node && node->IsSane()) {
2305 : 15774 : std::vector<std::unique_ptr<PubkeyProvider>> keys;
2306 [ + - ]: 15774 : keys.reserve(parser.m_keys.size());
2307 [ + + ]: 44598 : for (auto& key : parser.m_keys) {
2308 [ + - + - ]: 28824 : keys.emplace_back(std::move(key.at(0)));
2309 : : }
2310 [ + - - + ]: 15774 : return std::make_unique<MiniscriptDescriptor>(std::move(keys), std::move(node));
2311 : 15774 : }
2312 : 32440 : }
2313 : :
2314 : : // The following descriptors are all top-level only descriptors.
2315 : : // So if we are not at the top level, return early.
2316 [ + + ]: 1016555 : if (ctx != ParseScriptContext::TOP) return nullptr;
2317 : :
2318 : 1016108 : CTxDestination dest;
2319 [ + - + + ]: 1016108 : if (ExtractDestination(script, dest)) {
2320 [ + - + - ]: 268313 : if (GetScriptForDestination(dest) == script) {
2321 [ + - - + ]: 268313 : return std::make_unique<AddressDescriptor>(std::move(dest));
2322 : : }
2323 : : }
2324 : :
2325 [ + - - + ]: 747795 : return std::make_unique<RawDescriptor>(script);
2326 : 6952271 : }
2327 : :
2328 : :
2329 : : } // namespace
2330 : :
2331 : : /** Check a descriptor checksum, and update desc to be the checksum-less part. */
2332 : 40511 : bool CheckChecksum(std::span<const char>& sp, bool require_checksum, std::string& error, std::string* out_checksum = nullptr)
2333 : : {
2334 : 40511 : auto check_split = Split(sp, '#');
2335 [ + + ]: 40511 : if (check_split.size() > 2) {
2336 [ + - ]: 32 : error = "Multiple '#' symbols";
2337 : : return false;
2338 : : }
2339 [ + + + + ]: 40479 : if (check_split.size() == 1 && require_checksum){
2340 [ + - ]: 40511 : error = "Missing checksum";
2341 : : return false;
2342 : : }
2343 [ + + ]: 38289 : if (check_split.size() == 2) {
2344 [ + + ]: 75 : if (check_split[1].size() != 8) {
2345 [ + - ]: 21 : error = strprintf("Expected 8 character checksum, not %u characters", check_split[1].size());
2346 : 21 : return false;
2347 : : }
2348 : : }
2349 [ + - ]: 38268 : auto checksum = DescriptorChecksum(check_split[0]);
2350 [ + + ]: 38268 : if (checksum.empty()) {
2351 [ + - ]: 38268 : error = "Invalid characters in payload";
2352 : : return false;
2353 : : }
2354 [ + + ]: 38074 : if (check_split.size() == 2) {
2355 [ + + ]: 50 : if (!std::equal(checksum.begin(), checksum.end(), check_split[1].begin())) {
2356 [ + - + - ]: 22 : error = strprintf("Provided checksum '%s' does not match computed checksum '%s'", std::string(check_split[1].begin(), check_split[1].end()), checksum);
2357 : 11 : return false;
2358 : : }
2359 : : }
2360 [ + + ]: 38063 : if (out_checksum) *out_checksum = std::move(checksum);
2361 : 38063 : sp = check_split[0];
2362 : 38063 : return true;
2363 : 78779 : }
2364 : :
2365 : 39851 : std::vector<std::unique_ptr<Descriptor>> Parse(const std::string& descriptor, FlatSigningProvider& out, std::string& error, bool require_checksum)
2366 : : {
2367 : 39851 : std::span<const char> sp{descriptor};
2368 [ + + ]: 39851 : if (!CheckChecksum(sp, require_checksum, error)) return {};
2369 : 37507 : uint32_t key_exp_index = 0;
2370 : 37507 : auto ret = ParseScript(key_exp_index, sp, ParseScriptContext::TOP, out, error);
2371 [ + + + + ]: 37507 : if (sp.size() == 0 && !ret.empty()) {
2372 : 32605 : std::vector<std::unique_ptr<Descriptor>> descs;
2373 [ + - ]: 32605 : descs.reserve(ret.size());
2374 [ + + ]: 79702 : for (auto& r : ret) {
2375 [ + - ]: 47097 : descs.emplace_back(std::unique_ptr<Descriptor>(std::move(r)));
2376 : : }
2377 : 32605 : return descs;
2378 : 32605 : }
2379 : 4902 : return {};
2380 : 37507 : }
2381 : :
2382 : 660 : std::string GetDescriptorChecksum(const std::string& descriptor)
2383 : : {
2384 [ + - ]: 660 : std::string ret;
2385 : 660 : std::string error;
2386 [ + - ]: 660 : std::span<const char> sp{descriptor};
2387 [ + - + + : 660 : if (!CheckChecksum(sp, false, error, &ret)) return "";
+ - ]
2388 : 556 : return ret;
2389 : 660 : }
2390 : :
2391 : 4771107 : std::unique_ptr<Descriptor> InferDescriptor(const CScript& script, const SigningProvider& provider)
2392 : : {
2393 : 4771107 : return InferScript(script, ParseScriptContext::TOP, provider);
2394 : : }
2395 : :
2396 : 28933 : uint256 DescriptorID(const Descriptor& desc)
2397 : : {
2398 : 28933 : std::string desc_str = desc.ToString(/*compat_format=*/true);
2399 : 28933 : uint256 id;
2400 [ + - + - : 28933 : CSHA256().Write((unsigned char*)desc_str.data(), desc_str.size()).Finalize(id.begin());
+ - ]
2401 : 28933 : return id;
2402 : 28933 : }
2403 : :
2404 : 492018 : void DescriptorCache::CacheParentExtPubKey(uint32_t key_exp_pos, const CExtPubKey& xpub)
2405 : : {
2406 : 492018 : m_parent_xpubs[key_exp_pos] = xpub;
2407 : 492018 : }
2408 : :
2409 : 73038 : void DescriptorCache::CacheDerivedExtPubKey(uint32_t key_exp_pos, uint32_t der_index, const CExtPubKey& xpub)
2410 : : {
2411 : 73038 : auto& xpubs = m_derived_xpubs[key_exp_pos];
2412 : 73038 : xpubs[der_index] = xpub;
2413 : 73038 : }
2414 : :
2415 : 31341 : void DescriptorCache::CacheLastHardenedExtPubKey(uint32_t key_exp_pos, const CExtPubKey& xpub)
2416 : : {
2417 : 31341 : m_last_hardened_xpubs[key_exp_pos] = xpub;
2418 : 31341 : }
2419 : :
2420 : 1613590 : bool DescriptorCache::GetCachedParentExtPubKey(uint32_t key_exp_pos, CExtPubKey& xpub) const
2421 : : {
2422 : 1613590 : const auto& it = m_parent_xpubs.find(key_exp_pos);
2423 [ + + ]: 1613590 : if (it == m_parent_xpubs.end()) return false;
2424 : 1542449 : xpub = it->second;
2425 : 1542449 : return true;
2426 : : }
2427 : :
2428 : 1474894 : bool DescriptorCache::GetCachedDerivedExtPubKey(uint32_t key_exp_pos, uint32_t der_index, CExtPubKey& xpub) const
2429 : : {
2430 : 1474894 : const auto& key_exp_it = m_derived_xpubs.find(key_exp_pos);
2431 [ + + ]: 1474894 : if (key_exp_it == m_derived_xpubs.end()) return false;
2432 : 63208 : const auto& der_it = key_exp_it->second.find(der_index);
2433 [ + + ]: 63208 : if (der_it == key_exp_it->second.end()) return false;
2434 : 44035 : xpub = der_it->second;
2435 : 44035 : return true;
2436 : : }
2437 : :
2438 : 3402 : bool DescriptorCache::GetCachedLastHardenedExtPubKey(uint32_t key_exp_pos, CExtPubKey& xpub) const
2439 : : {
2440 : 3402 : const auto& it = m_last_hardened_xpubs.find(key_exp_pos);
2441 [ + + ]: 3402 : if (it == m_last_hardened_xpubs.end()) return false;
2442 : 1741 : xpub = it->second;
2443 : 1741 : return true;
2444 : : }
2445 : :
2446 : 393170 : DescriptorCache DescriptorCache::MergeAndDiff(const DescriptorCache& other)
2447 : : {
2448 : 393170 : DescriptorCache diff;
2449 [ + - + + : 515027 : for (const auto& parent_xpub_pair : other.GetCachedParentExtPubKeys()) {
+ - ]
2450 [ + - ]: 121857 : CExtPubKey xpub;
2451 [ + + + - ]: 121857 : if (GetCachedParentExtPubKey(parent_xpub_pair.first, xpub)) {
2452 [ - + ]: 84000 : if (xpub != parent_xpub_pair.second) {
2453 [ # # # # ]: 0 : throw std::runtime_error(std::string(__func__) + ": New cached parent xpub does not match already cached parent xpub");
2454 : : }
2455 : 84000 : continue;
2456 : : }
2457 [ + - ]: 37857 : CacheParentExtPubKey(parent_xpub_pair.first, parent_xpub_pair.second);
2458 [ + - ]: 37857 : diff.CacheParentExtPubKey(parent_xpub_pair.first, parent_xpub_pair.second);
2459 : 0 : }
2460 [ + - + + ]: 411410 : for (const auto& derived_xpub_map_pair : other.GetCachedDerivedExtPubKeys()) {
2461 [ + + + - ]: 36480 : for (const auto& derived_xpub_pair : derived_xpub_map_pair.second) {
2462 [ + - ]: 18240 : CExtPubKey xpub;
2463 [ - + + - ]: 18240 : if (GetCachedDerivedExtPubKey(derived_xpub_map_pair.first, derived_xpub_pair.first, xpub)) {
2464 [ # # ]: 0 : if (xpub != derived_xpub_pair.second) {
2465 [ # # # # ]: 0 : throw std::runtime_error(std::string(__func__) + ": New cached derived xpub does not match already cached derived xpub");
2466 : : }
2467 : 0 : continue;
2468 : : }
2469 [ + - ]: 18240 : CacheDerivedExtPubKey(derived_xpub_map_pair.first, derived_xpub_pair.first, derived_xpub_pair.second);
2470 [ + - ]: 18240 : diff.CacheDerivedExtPubKey(derived_xpub_map_pair.first, derived_xpub_pair.first, derived_xpub_pair.second);
2471 : : }
2472 : 0 : }
2473 [ + - + + : 395243 : for (const auto& lh_xpub_pair : other.GetCachedLastHardenedExtPubKeys()) {
+ - ]
2474 [ + - ]: 2073 : CExtPubKey xpub;
2475 [ + + + - ]: 2073 : if (GetCachedLastHardenedExtPubKey(lh_xpub_pair.first, xpub)) {
2476 [ - + ]: 1430 : if (xpub != lh_xpub_pair.second) {
2477 [ # # # # ]: 0 : throw std::runtime_error(std::string(__func__) + ": New cached last hardened xpub does not match already cached last hardened xpub");
2478 : : }
2479 : 1430 : continue;
2480 : : }
2481 [ + - ]: 643 : CacheLastHardenedExtPubKey(lh_xpub_pair.first, lh_xpub_pair.second);
2482 [ + - ]: 643 : diff.CacheLastHardenedExtPubKey(lh_xpub_pair.first, lh_xpub_pair.second);
2483 : 0 : }
2484 : 393170 : return diff;
2485 : 0 : }
2486 : :
2487 : 831518 : ExtPubKeyMap DescriptorCache::GetCachedParentExtPubKeys() const
2488 : : {
2489 : 831518 : return m_parent_xpubs;
2490 : : }
2491 : :
2492 : 831518 : std::unordered_map<uint32_t, ExtPubKeyMap> DescriptorCache::GetCachedDerivedExtPubKeys() const
2493 : : {
2494 : 831518 : return m_derived_xpubs;
2495 : : }
2496 : :
2497 : 786340 : ExtPubKeyMap DescriptorCache::GetCachedLastHardenedExtPubKeys() const
2498 : : {
2499 : 786340 : return m_last_hardened_xpubs;
2500 : : }
|
