Coverage Report

Created: 2026-07-29 23:27

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/tmp/bitcoin/src/script/sign.cpp
Line
Count
Source
1
// Copyright (c) 2009-2010 Satoshi Nakamoto
2
// Copyright (c) 2009-present The Bitcoin Core developers
3
// Distributed under the MIT software license, see the accompanying
4
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
5
6
#include <script/sign.h>
7
8
#include <addresstype.h>
9
#include <coins.h>
10
#include <consensus/amount.h>
11
#include <hash.h>
12
#include <key.h>
13
#include <musig.h>
14
#include <policy/policy.h>
15
#include <prevector.h>
16
#include <primitives/transaction.h>
17
#include <script/keyorigin.h>
18
#include <script/miniscript.h>
19
#include <script/script.h>
20
#include <script/script_error.h>
21
#include <script/signingprovider.h>
22
#include <script/solver.h>
23
#include <script/verify_flags.h>
24
#include <serialize.h>
25
#include <uint256.h>
26
#include <util/check.h>
27
#include <util/translation.h>
28
#include <util/vector.h>
29
30
#include <algorithm>
31
#include <array>
32
#include <cstddef>
33
#include <functional>
34
#include <iterator>
35
#include <span>
36
#include <string>
37
38
typedef std::vector<unsigned char> valtype;
39
40
MutableTransactionSignatureCreator::MutableTransactionSignatureCreator(const CMutableTransaction& tx, unsigned int input_idx, const CAmount& amount, const SignOptions& options)
41
5.67k
    : m_txto{tx}, nIn{input_idx}, m_options{options}, amount{amount}, checker{&m_txto, nIn, amount, MissingDataBehavior::FAIL},
42
5.67k
      m_txdata(nullptr)
43
5.67k
{
44
5.67k
}
45
46
MutableTransactionSignatureCreator::MutableTransactionSignatureCreator(const CMutableTransaction& tx, unsigned int input_idx, const CAmount& amount, const PrecomputedTransactionData* txdata, const SignOptions& options)
47
82.0k
    : m_txto{tx}, nIn{input_idx}, m_options{options}, amount{amount},
48
82.0k
      checker{txdata ? MutableTransactionSignatureChecker{&m_txto, nIn, amount, *txdata, MissingDataBehavior::FAIL} :
49
82.0k
                       MutableTransactionSignatureChecker{&m_txto, nIn, amount, MissingDataBehavior::FAIL}},
50
82.0k
      m_txdata(txdata)
51
82.0k
{
52
82.0k
}
53
54
bool MutableTransactionSignatureCreator::CreateSig(const SigningProvider& provider, std::vector<unsigned char>& vchSig, const CKeyID& address, const CScript& scriptCode, SigVersion sigversion) const
55
32.0k
{
56
32.0k
    assert(sigversion == SigVersion::BASE || sigversion == SigVersion::WITNESS_V0);
57
58
32.0k
    CKey key;
59
32.0k
    if (!provider.GetKey(address, key))
60
15.4k
        return false;
61
62
    // Signing with uncompressed keys is disabled in witness scripts
63
16.5k
    if (sigversion == SigVersion::WITNESS_V0 && !key.IsCompressed())
64
4
        return false;
65
66
    // Signing without known amount does not work in witness scripts.
67
16.5k
    if (sigversion == SigVersion::WITNESS_V0 && !MoneyRange(amount)) return false;
68
69
    // BASE/WITNESS_V0 signatures don't support explicit SIGHASH_DEFAULT, use SIGHASH_ALL instead.
70
16.5k
    const int hashtype = m_options.sighash_type == SIGHASH_DEFAULT ? SIGHASH_ALL : m_options.sighash_type;
71
72
16.5k
    uint256 hash = SignatureHash(scriptCode, m_txto, nIn, hashtype, amount, sigversion, m_txdata);
73
16.5k
    if (!key.Sign(hash, vchSig))
74
0
        return false;
75
16.5k
    vchSig.push_back((unsigned char)hashtype);
76
16.5k
    return true;
77
16.5k
}
78
79
std::optional<uint256> MutableTransactionSignatureCreator::ComputeSchnorrSignatureHash(const uint256* leaf_hash, SigVersion sigversion) const
80
1.50k
{
81
1.50k
    assert(sigversion == SigVersion::TAPROOT || sigversion == SigVersion::TAPSCRIPT);
82
83
    // BIP341/BIP342 signing needs lots of precomputed transaction data. While some
84
    // (non-SIGHASH_DEFAULT) sighash modes exist that can work with just some subset
85
    // of data present, for now, only support signing when everything is provided.
86
1.50k
    if (!m_txdata || !m_txdata->m_bip341_taproot_ready || !m_txdata->m_spent_outputs_ready) return std::nullopt;
87
88
1.50k
    ScriptExecutionData execdata;
89
1.50k
    execdata.m_annex_init = true;
90
1.50k
    execdata.m_annex_present = false; // Only support annex-less signing for now.
91
1.50k
    if (sigversion == SigVersion::TAPSCRIPT) {
92
703
        execdata.m_codeseparator_pos_init = true;
93
703
        execdata.m_codeseparator_pos = 0xFFFFFFFF; // Only support non-OP_CODESEPARATOR BIP342 signing for now.
94
703
        if (!leaf_hash) return std::nullopt; // BIP342 signing needs leaf hash.
95
703
        execdata.m_tapleaf_hash_init = true;
96
703
        execdata.m_tapleaf_hash = *leaf_hash;
97
703
    }
98
1.50k
    uint256 hash;
99
1.50k
    if (!SignatureHashSchnorr(hash, execdata, m_txto, nIn, m_options.sighash_type, sigversion, *m_txdata, MissingDataBehavior::FAIL)) return std::nullopt;
100
1.50k
    return hash;
101
1.50k
}
102
103
bool MutableTransactionSignatureCreator::CreateSchnorrSig(const SigningProvider& provider, std::vector<unsigned char>& sig, const XOnlyPubKey& pubkey, const uint256* leaf_hash, const uint256* merkle_root, SigVersion sigversion) const
104
116k
{
105
116k
    CKey key;
106
116k
    if (!provider.GetKeyByXOnly(pubkey, key)) return false;
107
108
1.03k
    std::optional<uint256> hash = ComputeSchnorrSignatureHash(leaf_hash, sigversion);
109
1.03k
    if (!hash.has_value()) return false;
110
111
1.03k
    sig.resize(64);
112
    // Use uint256{} as aux_rnd for now.
113
1.03k
    if (!key.SignSchnorr(*hash, sig, merkle_root, {})) return false;
114
1.03k
    if (m_options.sighash_type) sig.push_back(m_options.sighash_type);
115
1.03k
    return true;
116
1.03k
}
117
118
std::vector<uint8_t> MutableTransactionSignatureCreator::CreateMuSig2Nonce(const SigningProvider& provider, const CPubKey& aggregate_pubkey, const CPubKey& script_pubkey, const CPubKey& part_pubkey, const uint256* leaf_hash, const uint256* merkle_root, SigVersion sigversion, const SignatureData& sigdata) const
119
4.86k
{
120
4.86k
    assert(sigversion == SigVersion::TAPROOT || sigversion == SigVersion::TAPSCRIPT);
121
122
    // Retrieve the private key
123
4.86k
    CKey key;
124
4.86k
    if (!provider.GetKey(part_pubkey.GetID(), key)) return {};
125
126
    // Retrieve participant pubkeys
127
151
    auto it = sigdata.musig2_pubkeys.find(aggregate_pubkey);
128
151
    if (it == sigdata.musig2_pubkeys.end()) return {};
129
151
    const std::vector<CPubKey>& pubkeys = it->second;
130
151
    if (std::find(pubkeys.begin(), pubkeys.end(), part_pubkey) == pubkeys.end()) return {};
131
132
    // Compute sighash
133
151
    std::optional<uint256> sighash = ComputeSchnorrSignatureHash(leaf_hash, sigversion);
134
151
    if (!sighash.has_value()) return {};
135
136
151
    MuSig2SecNonce secnonce;
137
151
    std::vector<uint8_t> out = ::CreateMuSig2Nonce(secnonce, *sighash, key, aggregate_pubkey, pubkeys);
138
151
    if (out.empty()) return {};
139
140
    // Store the secnonce in the SigningProvider
141
151
    provider.SetMuSig2SecNonce(MuSig2SessionID(script_pubkey, part_pubkey, *sighash, out), std::move(secnonce));
142
143
151
    return out;
144
151
}
145
146
bool MutableTransactionSignatureCreator::CreateMuSig2PartialSig(const SigningProvider& provider, uint256& partial_sig, const CPubKey& aggregate_pubkey, const CPubKey& script_pubkey, const CPubKey& part_pubkey, const uint256* leaf_hash, const std::vector<std::pair<uint256, bool>>& tweaks, SigVersion sigversion, const SignatureData& sigdata) const
147
10.2k
{
148
10.2k
    assert(sigversion == SigVersion::TAPROOT || sigversion == SigVersion::TAPSCRIPT);
149
150
    // Retrieve private key
151
10.2k
    CKey key;
152
10.2k
    if (!provider.GetKey(part_pubkey.GetID(), key)) return false;
153
154
    // Retrieve participant pubkeys
155
533
    auto it = sigdata.musig2_pubkeys.find(aggregate_pubkey);
156
533
    if (it == sigdata.musig2_pubkeys.end()) return false;
157
533
    const std::vector<CPubKey>& pubkeys = it->second;
158
533
    if (std::find(pubkeys.begin(), pubkeys.end(), part_pubkey) == pubkeys.end()) return {};
159
160
    // Retrieve pubnonces
161
533
    auto this_leaf_aggkey = std::make_pair(script_pubkey, leaf_hash ? *leaf_hash : uint256());
162
533
    auto pubnonce_it = sigdata.musig2_pubnonces.find(this_leaf_aggkey);
163
533
    if (pubnonce_it == sigdata.musig2_pubnonces.end()) return false;
164
473
    const std::map<CPubKey, std::vector<uint8_t>>& pubnonces = pubnonce_it->second;
165
166
    // Check if enough pubnonces
167
473
    if (pubnonces.size() != pubkeys.size()) return false;
168
169
    // Compute sighash
170
248
    std::optional<uint256> sighash = ComputeSchnorrSignatureHash(leaf_hash, sigversion);
171
248
    if (!sighash.has_value()) return false;
172
173
    // Retrieve the secnonce
174
248
    auto part_pubnonce_it = pubnonces.find(part_pubkey);
175
248
    if (part_pubnonce_it == pubnonces.end()) return false;
176
248
    uint256 session_id = MuSig2SessionID(script_pubkey, part_pubkey, *sighash, part_pubnonce_it->second);
177
248
    std::optional<std::reference_wrapper<MuSig2SecNonce>> secnonce = provider.GetMuSig2SecNonce(session_id);
178
248
    if (!secnonce || !secnonce->get().IsValid()) return false;
179
180
    // Compute the sig
181
140
    std::optional<uint256> sig = ::CreateMuSig2PartialSig(*sighash, key, aggregate_pubkey, pubkeys, pubnonces, *secnonce, tweaks);
182
140
    if (!sig) return false;
183
140
    partial_sig = std::move(*sig);
184
185
    // Delete the secnonce now that we're done with it
186
140
    assert(!secnonce->get().IsValid());
187
140
    provider.DeleteMuSig2Session(session_id);
188
189
140
    return true;
190
140
}
191
192
bool MutableTransactionSignatureCreator::CreateMuSig2AggregateSig(const std::vector<CPubKey>& participants, std::vector<uint8_t>& sig, const CPubKey& aggregate_pubkey, const CPubKey& script_pubkey, const uint256* leaf_hash, const std::vector<std::pair<uint256, bool>>& tweaks, SigVersion sigversion, const SignatureData& sigdata) const
193
3.74k
{
194
3.74k
    assert(sigversion == SigVersion::TAPROOT || sigversion == SigVersion::TAPSCRIPT);
195
3.74k
    if (!participants.size()) return false;
196
197
    // Retrieve pubnonces and partial sigs
198
3.74k
    auto this_leaf_aggkey = std::make_pair(script_pubkey, leaf_hash ? *leaf_hash : uint256());
199
3.74k
    auto pubnonce_it = sigdata.musig2_pubnonces.find(this_leaf_aggkey);
200
3.74k
    if (pubnonce_it == sigdata.musig2_pubnonces.end()) return false;
201
3.41k
    const std::map<CPubKey, std::vector<uint8_t>>& pubnonces = pubnonce_it->second;
202
3.41k
    auto partial_sigs_it = sigdata.musig2_partial_sigs.find(this_leaf_aggkey);
203
3.41k
    if (partial_sigs_it == sigdata.musig2_partial_sigs.end()) return false;
204
731
    const std::map<CPubKey, uint256>& partial_sigs = partial_sigs_it->second;
205
206
    // Check if enough pubnonces and partial sigs
207
731
    if (pubnonces.size() != participants.size()) return false;
208
731
    if (partial_sigs.size() != participants.size()) return false;
209
210
    // Compute sighash
211
69
    std::optional<uint256> sighash = ComputeSchnorrSignatureHash(leaf_hash, sigversion);
212
69
    if (!sighash.has_value()) return false;
213
214
69
    std::optional<std::vector<uint8_t>> res = ::CreateMuSig2AggregateSig(participants, aggregate_pubkey, tweaks, *sighash, pubnonces, partial_sigs);
215
69
    if (!res) return false;
216
69
    sig = res.value();
217
69
    if (m_options.sighash_type) sig.push_back(m_options.sighash_type);
218
219
69
    return true;
220
69
}
221
222
static bool GetCScript(const SigningProvider& provider, const SignatureData& sigdata, const CScriptID& scriptid, CScript& script)
223
7.73k
{
224
7.73k
    if (provider.GetCScript(scriptid, script)) {
225
1.94k
        return true;
226
1.94k
    }
227
    // Look for scripts in SignatureData
228
5.78k
    if (CScriptID(sigdata.redeem_script) == scriptid) {
229
3.90k
        script = sigdata.redeem_script;
230
3.90k
        return true;
231
3.90k
    } else if (CScriptID(sigdata.witness_script) == scriptid) {
232
321
        script = sigdata.witness_script;
233
321
        return true;
234
321
    }
235
1.55k
    return false;
236
5.78k
}
237
238
static bool GetPubKey(const SigningProvider& provider, const SignatureData& sigdata, const CKeyID& address, CPubKey& pubkey)
239
75.2k
{
240
    // Look for pubkey in all partial sigs
241
75.2k
    const auto it = sigdata.signatures.find(address);
242
75.2k
    if (it != sigdata.signatures.end()) {
243
90
        pubkey = it->second.first;
244
90
        return true;
245
90
    }
246
    // Look for pubkey in pubkey lists
247
75.1k
    const auto& pk_it = sigdata.misc_pubkeys.find(address);
248
75.1k
    if (pk_it != sigdata.misc_pubkeys.end()) {
249
13.6k
        pubkey = pk_it->second.first;
250
13.6k
        return true;
251
13.6k
    }
252
61.4k
    const auto& tap_pk_it = sigdata.tap_pubkeys.find(address);
253
61.4k
    if (tap_pk_it != sigdata.tap_pubkeys.end()) {
254
304
        pubkey = tap_pk_it->second.GetEvenCorrespondingCPubKey();
255
304
        return true;
256
304
    }
257
    // Query the underlying provider
258
61.1k
    return provider.GetPubKey(address, pubkey);
259
61.4k
}
260
261
static bool CreateSig(const BaseSignatureCreator& creator, SignatureData& sigdata, const SigningProvider& provider, std::vector<unsigned char>& sig_out, const CPubKey& pubkey, const CScript& scriptcode, SigVersion sigversion)
262
32.6k
{
263
32.6k
    CKeyID keyid = pubkey.GetID();
264
32.6k
    const auto it = sigdata.signatures.find(keyid);
265
32.6k
    if (it != sigdata.signatures.end()) {
266
588
        sig_out = it->second.second;
267
588
        return true;
268
588
    }
269
32.0k
    KeyOriginInfo info;
270
32.0k
    if (provider.GetKeyOrigin(keyid, info)) {
271
11.7k
        sigdata.misc_pubkeys.emplace(keyid, std::make_pair(pubkey, std::move(info)));
272
11.7k
    }
273
32.0k
    if (creator.CreateSig(provider, sig_out, keyid, scriptcode, sigversion)) {
274
16.5k
        auto i = sigdata.signatures.emplace(keyid, SigPair(pubkey, sig_out));
275
16.5k
        assert(i.second);
276
16.5k
        return true;
277
16.5k
    }
278
    // Could not make signature or signature not found, add keyid to missing
279
15.4k
    sigdata.missing_sigs.push_back(keyid);
280
15.4k
    return false;
281
32.0k
}
282
283
static bool SignMuSig2(const BaseSignatureCreator& creator, SignatureData& sigdata, const SigningProvider& provider, std::vector<unsigned char>& sig_out, const XOnlyPubKey& script_pubkey, const uint256* merkle_root, const uint256* leaf_hash, SigVersion sigversion)
284
115k
{
285
115k
    Assert(sigversion == SigVersion::TAPROOT || sigversion == SigVersion::TAPSCRIPT);
286
287
    // Lookup derivation paths for the script pubkey
288
115k
    KeyOriginInfo agg_info;
289
115k
    auto misc_pk_it = sigdata.taproot_misc_pubkeys.find(script_pubkey);
290
115k
    if (misc_pk_it != sigdata.taproot_misc_pubkeys.end()) {
291
104k
        agg_info = misc_pk_it->second.second;
292
104k
    }
293
294
115k
    for (const auto& [agg_pub, part_pks] : sigdata.musig2_pubkeys) {
295
11.4k
        if (part_pks.empty()) continue;
296
297
        // Fill participant derivation path info
298
31.3k
        for (const auto& part_pk : part_pks) {
299
31.3k
            KeyOriginInfo part_info;
300
31.3k
            if (provider.GetKeyOrigin(part_pk.GetID(), part_info)) {
301
6.32k
                XOnlyPubKey xonly_part(part_pk);
302
6.32k
                auto it = sigdata.taproot_misc_pubkeys.find(xonly_part);
303
6.32k
                if (it == sigdata.taproot_misc_pubkeys.end()) {
304
133
                    it = sigdata.taproot_misc_pubkeys.emplace(xonly_part, std::make_pair(std::set<uint256>(), part_info)).first;
305
133
                }
306
6.32k
                if (leaf_hash) it->second.first.insert(*leaf_hash);
307
6.32k
            }
308
31.3k
        }
309
310
        // The pubkey in the script may not be the actual aggregate of the participants, but derived from it.
311
        // Check the derivation, and compute the BIP 32 derivation tweaks
312
11.4k
        std::vector<std::pair<uint256, bool>> tweaks;
313
11.4k
        CPubKey plain_pub = agg_pub;
314
11.4k
        if (XOnlyPubKey(agg_pub) != script_pubkey) {
315
10.3k
            if (agg_info.path.empty()) continue;
316
4.81k
            if (agg_info.fingerprint != agg_pub.GetID().fingerprint()) {
317
2.26k
                continue;
318
2.26k
            }
319
            // Get the BIP32 derivation tweaks
320
2.55k
            CExtPubKey extpub = CreateMuSig2SyntheticXpub(agg_pub);
321
5.10k
            for (const int i : agg_info.path) {
322
5.10k
                auto& [t, xonly] = tweaks.emplace_back();
323
5.10k
                xonly = false;
324
5.10k
                if (!extpub.Derive(extpub, i, &t)) {
325
0
                    return false;
326
0
                }
327
5.10k
            }
328
2.55k
            Assert(XOnlyPubKey(extpub.pubkey) == script_pubkey);
329
2.55k
            plain_pub = extpub.pubkey;
330
2.55k
        }
331
332
        // Add the merkle root tweak
333
3.74k
        if (sigversion == SigVersion::TAPROOT && merkle_root) {
334
914
            tweaks.emplace_back(script_pubkey.ComputeTapTweakHash(merkle_root->IsNull() ? nullptr : merkle_root), true);
335
914
            std::optional<std::pair<XOnlyPubKey, bool>> tweaked = script_pubkey.CreateTapTweak(merkle_root->IsNull() ? nullptr : merkle_root);
336
914
            if (!Assume(tweaked)) return false;
337
914
            plain_pub = tweaked->first.GetCPubKeys().at(tweaked->second ? 1 : 0);
338
914
        }
339
340
        // First try to aggregate
341
3.74k
        if (creator.CreateMuSig2AggregateSig(part_pks, sig_out, agg_pub, plain_pub, leaf_hash, tweaks, sigversion, sigdata)) {
342
69
            if (sigversion == SigVersion::TAPROOT) {
343
30
                sigdata.taproot_key_path_sig = sig_out;
344
39
            } else {
345
39
                auto lookup_key = std::make_pair(script_pubkey, leaf_hash ? *leaf_hash : uint256());
346
39
                sigdata.taproot_script_sigs[lookup_key] = sig_out;
347
39
            }
348
69
            continue;
349
69
        }
350
        // Cannot aggregate, try making partial sigs for every participant
351
3.67k
        auto pub_key_leaf_hash = std::make_pair(plain_pub, leaf_hash ? *leaf_hash : uint256());
352
10.2k
        for (const CPubKey& part_pk : part_pks) {
353
10.2k
            uint256 partial_sig;
354
10.2k
            if (creator.CreateMuSig2PartialSig(provider, partial_sig, agg_pub, plain_pub, part_pk, leaf_hash, tweaks, sigversion, sigdata) && Assume(!partial_sig.IsNull())) {
355
140
                sigdata.musig2_partial_sigs[pub_key_leaf_hash].emplace(part_pk, partial_sig);
356
140
            }
357
10.2k
        }
358
        // If there are any partial signatures, continue with next aggregate pubkey
359
3.67k
        auto partial_sigs_it = sigdata.musig2_partial_sigs.find(pub_key_leaf_hash);
360
3.67k
        if (partial_sigs_it != sigdata.musig2_partial_sigs.end() && !partial_sigs_it->second.empty()) {
361
802
            continue;
362
802
        }
363
        // No partial sigs, try to make pubnonces
364
2.86k
        std::map<CPubKey, std::vector<uint8_t>>& pubnonces = sigdata.musig2_pubnonces[pub_key_leaf_hash];
365
7.93k
        for (const CPubKey& part_pk : part_pks) {
366
7.93k
            if (pubnonces.contains(part_pk)) continue;
367
4.86k
            std::vector<uint8_t> pubnonce = creator.CreateMuSig2Nonce(provider, agg_pub, plain_pub, part_pk, leaf_hash, merkle_root, sigversion, sigdata);
368
4.86k
            if (pubnonce.empty()) continue;
369
151
            pubnonces[part_pk] = std::move(pubnonce);
370
151
        }
371
2.86k
    }
372
115k
    return true;
373
115k
}
374
375
static bool CreateTaprootScriptSig(const BaseSignatureCreator& creator, SignatureData& sigdata, const SigningProvider& provider, std::vector<unsigned char>& sig_out, const XOnlyPubKey& pubkey, const uint256& leaf_hash, SigVersion sigversion)
376
100k
{
377
100k
    KeyOriginInfo info;
378
100k
    if (provider.GetKeyOriginByXOnly(pubkey, info)) {
379
47.5k
        auto it = sigdata.taproot_misc_pubkeys.find(pubkey);
380
47.5k
        if (it == sigdata.taproot_misc_pubkeys.end()) {
381
700
            sigdata.taproot_misc_pubkeys.emplace(pubkey, std::make_pair(std::set<uint256>({leaf_hash}), info));
382
46.8k
        } else {
383
46.8k
            it->second.first.insert(leaf_hash);
384
46.8k
        }
385
47.5k
    }
386
387
100k
    auto lookup_key = std::make_pair(pubkey, leaf_hash);
388
100k
    auto it = sigdata.taproot_script_sigs.find(lookup_key);
389
100k
    if (it != sigdata.taproot_script_sigs.end()) {
390
426
        sig_out = it->second;
391
426
        return true;
392
426
    }
393
394
100k
    if (creator.CreateSchnorrSig(provider, sig_out, pubkey, &leaf_hash, nullptr, sigversion)) {
395
438
        sigdata.taproot_script_sigs[lookup_key] = sig_out;
396
100k
    } else if (!SignMuSig2(creator, sigdata, provider, sig_out, pubkey, /*merkle_root=*/nullptr, &leaf_hash, sigversion)) {
397
0
        return false;
398
0
    }
399
400
100k
    return sigdata.taproot_script_sigs.contains(lookup_key);
401
100k
}
402
403
template<typename M, typename K, typename V>
404
miniscript::Availability MsLookupHelper(const M& map, const K& key, V& value)
405
65
{
406
65
    auto it = map.find(key);
407
65
    if (it != map.end()) {
408
33
        value = it->second;
409
33
        return miniscript::Availability::YES;
410
33
    }
411
32
    return miniscript::Availability::NO;
412
65
}
413
414
/**
415
 * Context for solving a Miniscript.
416
 * If enough material (access to keys, hash preimages, ..) is given, produces a valid satisfaction.
417
 */
418
template<typename Pk>
419
struct Satisfier {
420
    using Key = Pk;
421
422
    const SigningProvider& m_provider;
423
    SignatureData& m_sig_data;
424
    const BaseSignatureCreator& m_creator;
425
    const CScript& m_witness_script;
426
    //! The context of the script we are satisfying (either P2WSH or Tapscript).
427
    const miniscript::MiniscriptContext m_script_ctx;
428
429
    explicit Satisfier(const SigningProvider& provider LIFETIMEBOUND, SignatureData& sig_data LIFETIMEBOUND,
430
                       const BaseSignatureCreator& creator LIFETIMEBOUND,
431
                       const CScript& witscript LIFETIMEBOUND,
432
4.33k
                       miniscript::MiniscriptContext script_ctx) : m_provider(provider),
433
4.33k
                                                                   m_sig_data(sig_data),
434
4.33k
                                                                   m_creator(creator),
435
4.33k
                                                                   m_witness_script(witscript),
436
4.33k
                                                                   m_script_ctx(script_ctx) {}
Satisfier<XOnlyPubKey>::Satisfier(SigningProvider const&, SignatureData&, BaseSignatureCreator const&, CScript const&, miniscript::MiniscriptContext)
Line
Count
Source
432
4.11k
                       miniscript::MiniscriptContext script_ctx) : m_provider(provider),
433
4.11k
                                                                   m_sig_data(sig_data),
434
4.11k
                                                                   m_creator(creator),
435
4.11k
                                                                   m_witness_script(witscript),
436
4.11k
                                                                   m_script_ctx(script_ctx) {}
Satisfier<CPubKey>::Satisfier(SigningProvider const&, SignatureData&, BaseSignatureCreator const&, CScript const&, miniscript::MiniscriptContext)
Line
Count
Source
432
220
                       miniscript::MiniscriptContext script_ctx) : m_provider(provider),
433
220
                                                                   m_sig_data(sig_data),
434
220
                                                                   m_creator(creator),
435
220
                                                                   m_witness_script(witscript),
436
220
                                                                   m_script_ctx(script_ctx) {}
437
438
316k
    static bool KeyCompare(const Key& a, const Key& b) {
439
316k
        return a < b;
440
316k
    }
Satisfier<XOnlyPubKey>::KeyCompare(XOnlyPubKey const&, XOnlyPubKey const&)
Line
Count
Source
438
315k
    static bool KeyCompare(const Key& a, const Key& b) {
439
315k
        return a < b;
440
315k
    }
Satisfier<CPubKey>::KeyCompare(CPubKey const&, CPubKey const&)
Line
Count
Source
438
1.28k
    static bool KeyCompare(const Key& a, const Key& b) {
439
1.28k
        return a < b;
440
1.28k
    }
441
442
    //! Get a CPubKey from a key hash. Note the key hash may be of an xonly pubkey.
443
    template<typename I>
444
393
    std::optional<CPubKey> CPubFromPKHBytes(I first, I last) const {
445
393
        assert(last - first == 20);
446
393
        CPubKey pubkey;
447
393
        CKeyID key_id;
448
393
        std::copy(first, last, key_id.begin());
449
393
        if (GetPubKey(m_provider, m_sig_data, key_id, pubkey)) return pubkey;
450
1
        m_sig_data.missing_pubkeys.push_back(key_id);
451
1
        return {};
452
393
    }
std::optional<CPubKey> Satisfier<XOnlyPubKey>::CPubFromPKHBytes<__gnu_cxx::__normal_iterator<unsigned char*, std::vector<unsigned char, std::allocator<unsigned char>>>>(__gnu_cxx::__normal_iterator<unsigned char*, std::vector<unsigned char, std::allocator<unsigned char>>>, __gnu_cxx::__normal_iterator<unsigned char*, std::vector<unsigned char, std::allocator<unsigned char>>>) const
Line
Count
Source
444
318
    std::optional<CPubKey> CPubFromPKHBytes(I first, I last) const {
445
318
        assert(last - first == 20);
446
318
        CPubKey pubkey;
447
318
        CKeyID key_id;
448
318
        std::copy(first, last, key_id.begin());
449
318
        if (GetPubKey(m_provider, m_sig_data, key_id, pubkey)) return pubkey;
450
0
        m_sig_data.missing_pubkeys.push_back(key_id);
451
0
        return {};
452
318
    }
std::optional<CPubKey> Satisfier<CPubKey>::CPubFromPKHBytes<__gnu_cxx::__normal_iterator<unsigned char*, std::vector<unsigned char, std::allocator<unsigned char>>>>(__gnu_cxx::__normal_iterator<unsigned char*, std::vector<unsigned char, std::allocator<unsigned char>>>, __gnu_cxx::__normal_iterator<unsigned char*, std::vector<unsigned char, std::allocator<unsigned char>>>) const
Line
Count
Source
444
75
    std::optional<CPubKey> CPubFromPKHBytes(I first, I last) const {
445
75
        assert(last - first == 20);
446
75
        CPubKey pubkey;
447
75
        CKeyID key_id;
448
75
        std::copy(first, last, key_id.begin());
449
75
        if (GetPubKey(m_provider, m_sig_data, key_id, pubkey)) return pubkey;
450
1
        m_sig_data.missing_pubkeys.push_back(key_id);
451
1
        return {};
452
75
    }
453
454
    //! Conversion to raw public key.
455
392
    std::vector<unsigned char> ToPKBytes(const Key& key) const { return {key.begin(), key.end()}; }
Satisfier<XOnlyPubKey>::ToPKBytes(XOnlyPubKey const&) const
Line
Count
Source
455
318
    std::vector<unsigned char> ToPKBytes(const Key& key) const { return {key.begin(), key.end()}; }
Satisfier<CPubKey>::ToPKBytes(CPubKey const&) const
Line
Count
Source
455
74
    std::vector<unsigned char> ToPKBytes(const Key& key) const { return {key.begin(), key.end()}; }
456
457
    //! Time lock satisfactions.
458
986
    bool CheckAfter(uint32_t value) const { return m_creator.Checker().CheckLockTime(CScriptNum(value)); }
Satisfier<XOnlyPubKey>::CheckAfter(unsigned int) const
Line
Count
Source
458
742
    bool CheckAfter(uint32_t value) const { return m_creator.Checker().CheckLockTime(CScriptNum(value)); }
Satisfier<CPubKey>::CheckAfter(unsigned int) const
Line
Count
Source
458
244
    bool CheckAfter(uint32_t value) const { return m_creator.Checker().CheckLockTime(CScriptNum(value)); }
459
115
    bool CheckOlder(uint32_t value) const { return m_creator.Checker().CheckSequence(CScriptNum(value)); }
Satisfier<XOnlyPubKey>::CheckOlder(unsigned int) const
Line
Count
Source
459
53
    bool CheckOlder(uint32_t value) const { return m_creator.Checker().CheckSequence(CScriptNum(value)); }
Satisfier<CPubKey>::CheckOlder(unsigned int) const
Line
Count
Source
459
62
    bool CheckOlder(uint32_t value) const { return m_creator.Checker().CheckSequence(CScriptNum(value)); }
460
461
    //! Hash preimage satisfactions.
462
17
    miniscript::Availability SatSHA256(const std::vector<unsigned char>& hash, std::vector<unsigned char>& preimage) const {
463
17
        return MsLookupHelper(m_sig_data.sha256_preimages, hash, preimage);
464
17
    }
Unexecuted instantiation: Satisfier<XOnlyPubKey>::SatSHA256(std::vector<unsigned char, std::allocator<unsigned char>> const&, std::vector<unsigned char, std::allocator<unsigned char>>&) const
Satisfier<CPubKey>::SatSHA256(std::vector<unsigned char, std::allocator<unsigned char>> const&, std::vector<unsigned char, std::allocator<unsigned char>>&) const
Line
Count
Source
462
17
    miniscript::Availability SatSHA256(const std::vector<unsigned char>& hash, std::vector<unsigned char>& preimage) const {
463
17
        return MsLookupHelper(m_sig_data.sha256_preimages, hash, preimage);
464
17
    }
465
12
    miniscript::Availability SatRIPEMD160(const std::vector<unsigned char>& hash, std::vector<unsigned char>& preimage) const {
466
12
        return MsLookupHelper(m_sig_data.ripemd160_preimages, hash, preimage);
467
12
    }
Unexecuted instantiation: Satisfier<XOnlyPubKey>::SatRIPEMD160(std::vector<unsigned char, std::allocator<unsigned char>> const&, std::vector<unsigned char, std::allocator<unsigned char>>&) const
Satisfier<CPubKey>::SatRIPEMD160(std::vector<unsigned char, std::allocator<unsigned char>> const&, std::vector<unsigned char, std::allocator<unsigned char>>&) const
Line
Count
Source
465
12
    miniscript::Availability SatRIPEMD160(const std::vector<unsigned char>& hash, std::vector<unsigned char>& preimage) const {
466
12
        return MsLookupHelper(m_sig_data.ripemd160_preimages, hash, preimage);
467
12
    }
468
24
    miniscript::Availability SatHASH256(const std::vector<unsigned char>& hash, std::vector<unsigned char>& preimage) const {
469
24
        return MsLookupHelper(m_sig_data.hash256_preimages, hash, preimage);
470
24
    }
Satisfier<XOnlyPubKey>::SatHASH256(std::vector<unsigned char, std::allocator<unsigned char>> const&, std::vector<unsigned char, std::allocator<unsigned char>>&) const
Line
Count
Source
468
12
    miniscript::Availability SatHASH256(const std::vector<unsigned char>& hash, std::vector<unsigned char>& preimage) const {
469
12
        return MsLookupHelper(m_sig_data.hash256_preimages, hash, preimage);
470
12
    }
Satisfier<CPubKey>::SatHASH256(std::vector<unsigned char, std::allocator<unsigned char>> const&, std::vector<unsigned char, std::allocator<unsigned char>>&) const
Line
Count
Source
468
12
    miniscript::Availability SatHASH256(const std::vector<unsigned char>& hash, std::vector<unsigned char>& preimage) const {
469
12
        return MsLookupHelper(m_sig_data.hash256_preimages, hash, preimage);
470
12
    }
471
12
    miniscript::Availability SatHASH160(const std::vector<unsigned char>& hash, std::vector<unsigned char>& preimage) const {
472
12
        return MsLookupHelper(m_sig_data.hash160_preimages, hash, preimage);
473
12
    }
Unexecuted instantiation: Satisfier<XOnlyPubKey>::SatHASH160(std::vector<unsigned char, std::allocator<unsigned char>> const&, std::vector<unsigned char, std::allocator<unsigned char>>&) const
Satisfier<CPubKey>::SatHASH160(std::vector<unsigned char, std::allocator<unsigned char>> const&, std::vector<unsigned char, std::allocator<unsigned char>>&) const
Line
Count
Source
471
12
    miniscript::Availability SatHASH160(const std::vector<unsigned char>& hash, std::vector<unsigned char>& preimage) const {
472
12
        return MsLookupHelper(m_sig_data.hash160_preimages, hash, preimage);
473
12
    }
474
475
1.33M
    miniscript::MiniscriptContext MsContext() const {
476
1.33M
        return m_script_ctx;
477
1.33M
    }
Satisfier<XOnlyPubKey>::MsContext() const
Line
Count
Source
475
1.33M
    miniscript::MiniscriptContext MsContext() const {
476
1.33M
        return m_script_ctx;
477
1.33M
    }
Satisfier<CPubKey>::MsContext() const
Line
Count
Source
475
3.41k
    miniscript::MiniscriptContext MsContext() const {
476
3.41k
        return m_script_ctx;
477
3.41k
    }
478
};
479
480
/** Miniscript satisfier specific to P2WSH context. */
481
struct WshSatisfier: Satisfier<CPubKey> {
482
    explicit WshSatisfier(const SigningProvider& provider LIFETIMEBOUND, SignatureData& sig_data LIFETIMEBOUND,
483
                          const BaseSignatureCreator& creator LIFETIMEBOUND, const CScript& witscript LIFETIMEBOUND)
484
220
                          : Satisfier(provider, sig_data, creator, witscript, miniscript::MiniscriptContext::P2WSH) {}
485
486
    //! Conversion from a raw compressed public key.
487
    template <typename I>
488
514
    std::optional<CPubKey> FromPKBytes(I first, I last) const {
489
514
        CPubKey pubkey{first, last};
490
514
        if (pubkey.IsValid()) return pubkey;
491
1
        return {};
492
514
    }
493
494
    //! Conversion from a raw compressed public key hash.
495
    template<typename I>
496
75
    std::optional<CPubKey> FromPKHBytes(I first, I last) const {
497
75
        return Satisfier::CPubFromPKHBytes(first, last);
498
75
    }
499
500
    //! Satisfy an ECDSA signature check.
501
587
    miniscript::Availability Sign(const CPubKey& key, std::vector<unsigned char>& sig) const {
502
587
        if (CreateSig(m_creator, m_sig_data, m_provider, sig, key, m_witness_script, SigVersion::WITNESS_V0)) {
503
273
            return miniscript::Availability::YES;
504
273
        }
505
314
        return miniscript::Availability::NO;
506
587
    }
507
};
508
509
/** Miniscript satisfier specific to Tapscript context. */
510
struct TapSatisfier: Satisfier<XOnlyPubKey> {
511
    const uint256& m_leaf_hash;
512
513
    explicit TapSatisfier(const SigningProvider& provider LIFETIMEBOUND, SignatureData& sig_data LIFETIMEBOUND,
514
                          const BaseSignatureCreator& creator LIFETIMEBOUND, const CScript& script LIFETIMEBOUND,
515
                          const uint256& leaf_hash LIFETIMEBOUND)
516
4.11k
                          : Satisfier(provider, sig_data, creator, script, miniscript::MiniscriptContext::TAPSCRIPT),
517
4.11k
                            m_leaf_hash(leaf_hash) {}
518
519
    //! Conversion from a raw xonly public key.
520
    template <typename I>
521
100k
    std::optional<XOnlyPubKey> FromPKBytes(I first, I last) const {
522
100k
        if (last - first != 32) return {};
523
100k
        XOnlyPubKey pubkey;
524
100k
        std::copy(first, last, pubkey.begin());
525
100k
        return pubkey;
526
100k
    }
527
528
    //! Conversion from a raw xonly public key hash.
529
    template<typename I>
530
318
    std::optional<XOnlyPubKey> FromPKHBytes(I first, I last) const {
531
318
        if (auto pubkey = Satisfier::CPubFromPKHBytes(first, last)) return XOnlyPubKey{*pubkey};
532
0
        return {};
533
318
    }
534
535
    //! Satisfy a BIP340 signature check.
536
100k
    miniscript::Availability Sign(const XOnlyPubKey& key, std::vector<unsigned char>& sig) const {
537
100k
        if (CreateTaprootScriptSig(m_creator, m_sig_data, m_provider, sig, key, m_leaf_hash, SigVersion::TAPSCRIPT)) {
538
903
            return miniscript::Availability::YES;
539
903
        }
540
100k
        return miniscript::Availability::NO;
541
100k
    }
542
};
543
544
static bool SignTaprootScript(const SigningProvider& provider, const BaseSignatureCreator& creator, SignatureData& sigdata, int leaf_version, std::span<const unsigned char> script_bytes, std::vector<valtype>& result)
545
4.11k
{
546
    // Only BIP342 tapscript signing is supported for now.
547
4.11k
    if (leaf_version != TAPROOT_LEAF_TAPSCRIPT) return false;
548
549
4.11k
    uint256 leaf_hash = ComputeTapleafHash(leaf_version, script_bytes);
550
4.11k
    CScript script = CScript(script_bytes.begin(), script_bytes.end());
551
552
4.11k
    TapSatisfier ms_satisfier{provider, sigdata, creator, script, leaf_hash};
553
4.11k
    const auto ms = miniscript::FromScript(script, ms_satisfier);
554
4.11k
    return ms && ms->Satisfy(ms_satisfier, result) == miniscript::Availability::YES;
555
4.11k
}
556
557
static bool SignTaproot(const SigningProvider& provider, const BaseSignatureCreator& creator, const WitnessV1Taproot& output, SignatureData& sigdata, std::vector<valtype>& result)
558
8.40k
{
559
8.40k
    TaprootSpendData spenddata;
560
8.40k
    TaprootBuilder builder;
561
562
    // Gather information about this output.
563
8.40k
    if (provider.GetTaprootSpendData(output, spenddata)) {
564
1.50k
        sigdata.tr_spenddata.Merge(spenddata);
565
1.50k
    }
566
8.40k
    if (provider.GetTaprootBuilder(output, builder)) {
567
1.50k
        sigdata.tr_builder = builder;
568
1.50k
    }
569
8.40k
    if (auto agg_keys = provider.GetAllMuSig2ParticipantPubkeys(); !agg_keys.empty()) {
570
506
        sigdata.musig2_pubkeys.insert(agg_keys.begin(), agg_keys.end());
571
506
    }
572
573
574
    // Try key path spending.
575
8.40k
    {
576
8.40k
        KeyOriginInfo internal_key_info;
577
8.40k
        if (provider.GetKeyOriginByXOnly(sigdata.tr_spenddata.internal_key, internal_key_info)) {
578
1.53k
            auto it = sigdata.taproot_misc_pubkeys.find(sigdata.tr_spenddata.internal_key);
579
1.53k
            if (it == sigdata.taproot_misc_pubkeys.end()) {
580
834
                sigdata.taproot_misc_pubkeys.emplace(sigdata.tr_spenddata.internal_key, std::make_pair(std::set<uint256>(), internal_key_info));
581
834
            }
582
1.53k
        }
583
584
8.40k
        KeyOriginInfo output_key_info;
585
8.40k
        if (provider.GetKeyOriginByXOnly(output, output_key_info)) {
586
140
            auto it = sigdata.taproot_misc_pubkeys.find(output);
587
140
            if (it == sigdata.taproot_misc_pubkeys.end()) {
588
44
                sigdata.taproot_misc_pubkeys.emplace(output, std::make_pair(std::set<uint256>(), output_key_info));
589
44
            }
590
140
        }
591
592
15.7k
        auto make_keypath_sig = [&](const XOnlyPubKey& pk, const uint256* merkle_root) {
593
15.7k
            std::vector<unsigned char> sig;
594
15.7k
            if (creator.CreateSchnorrSig(provider, sig, pk, nullptr, merkle_root, SigVersion::TAPROOT)) {
595
596
                sigdata.taproot_key_path_sig = sig;
596
15.1k
            } else {
597
15.1k
                SignMuSig2(creator, sigdata, provider, sig, pk, merkle_root, /*leaf_hash=*/nullptr, SigVersion::TAPROOT);
598
15.1k
            }
599
15.7k
        };
600
601
        // First try signing with internal key
602
8.40k
        if (sigdata.taproot_key_path_sig.size() == 0) {
603
8.17k
            make_keypath_sig(sigdata.tr_spenddata.internal_key, &sigdata.tr_spenddata.merkle_root);
604
8.17k
        }
605
        // Try signing with output key if still no signature
606
8.40k
        if (sigdata.taproot_key_path_sig.size() == 0) {
607
7.59k
            make_keypath_sig(output, nullptr);
608
7.59k
        }
609
8.40k
        if (sigdata.taproot_key_path_sig.size()) {
610
852
            result = Vector(sigdata.taproot_key_path_sig);
611
852
            return true;
612
852
        }
613
8.40k
    }
614
615
    // Try script path spending.
616
7.54k
    std::vector<std::vector<unsigned char>> smallest_result_stack;
617
7.54k
    for (const auto& [key, control_blocks] : sigdata.tr_spenddata.scripts) {
618
4.11k
        const auto& [script, leaf_ver] = key;
619
4.11k
        std::vector<std::vector<unsigned char>> result_stack;
620
4.11k
        if (SignTaprootScript(provider, creator, sigdata, leaf_ver, script, result_stack)) {
621
599
            result_stack.emplace_back(std::begin(script), std::end(script)); // Push the script
622
599
            result_stack.push_back(*control_blocks.begin()); // Push the smallest control block
623
599
            if (smallest_result_stack.size() == 0 ||
624
599
                GetSerializeSize(result_stack) < GetSerializeSize(smallest_result_stack)) {
625
590
                smallest_result_stack = std::move(result_stack);
626
590
            }
627
599
        }
628
4.11k
    }
629
7.54k
    if (smallest_result_stack.size() != 0) {
630
577
        result = std::move(smallest_result_stack);
631
577
        return true;
632
577
    }
633
634
6.97k
    return false;
635
7.54k
}
636
637
/**
638
 * Sign scriptPubKey using signature made with creator.
639
 * Signatures are returned in scriptSigRet (or returns false if scriptPubKey can't be signed),
640
 * unless whichTypeRet is TxoutType::SCRIPTHASH, in which case scriptSigRet is the redemption script.
641
 * Returns false if scriptPubKey could not be completely satisfied.
642
 */
643
static bool SignStep(const SigningProvider& provider, const BaseSignatureCreator& creator, const CScript& scriptPubKey,
644
                     std::vector<valtype>& ret, TxoutType& whichTypeRet, SigVersion sigversion, SignatureData& sigdata)
645
130k
{
646
130k
    CScript scriptRet;
647
130k
    ret.clear();
648
130k
    std::vector<unsigned char> sig;
649
650
130k
    std::vector<valtype> vSolutions;
651
130k
    whichTypeRet = Solver(scriptPubKey, vSolutions);
652
653
130k
    switch (whichTypeRet) {
654
196
    case TxoutType::NONSTANDARD:
655
196
    case TxoutType::NULL_DATA:
656
196
    case TxoutType::WITNESS_UNKNOWN:
657
196
        return false;
658
277
    case TxoutType::PUBKEY:
659
277
        if (!CreateSig(creator, sigdata, provider, sig, CPubKey(vSolutions[0]), scriptPubKey, sigversion)) return false;
660
177
        ret.push_back(std::move(sig));
661
177
        return true;
662
74.8k
    case TxoutType::PUBKEYHASH: {
663
74.8k
        CKeyID keyID = CKeyID(uint160(vSolutions[0]));
664
74.8k
        CPubKey pubkey;
665
74.8k
        if (!GetPubKey(provider, sigdata, keyID, pubkey)) {
666
            // Pubkey could not be found, add to missing
667
45.2k
            sigdata.missing_pubkeys.push_back(keyID);
668
45.2k
            return false;
669
45.2k
        }
670
29.5k
        if (!CreateSig(creator, sigdata, provider, sig, pubkey, scriptPubKey, sigversion)) return false;
671
15.4k
        ret.push_back(std::move(sig));
672
15.4k
        ret.push_back(ToByteVector(pubkey));
673
15.4k
        return true;
674
29.5k
    }
675
6.62k
    case TxoutType::SCRIPTHASH: {
676
6.62k
        uint160 h160{vSolutions[0]};
677
6.62k
        if (GetCScript(provider, sigdata, CScriptID{h160}, scriptRet)) {
678
5.31k
            ret.emplace_back(scriptRet.begin(), scriptRet.end());
679
5.31k
            return true;
680
5.31k
        }
681
        // Could not find redeemScript, add to missing
682
1.31k
        sigdata.missing_redeem_script = h160;
683
1.31k
        return false;
684
6.62k
    }
685
512
    case TxoutType::MULTISIG: {
686
512
        size_t required = vSolutions.front()[0];
687
512
        ret.emplace_back(); // workaround CHECKMULTISIG bug
688
2.68k
        for (size_t i = 1; i < vSolutions.size() - 1; ++i) {
689
2.16k
            CPubKey pubkey = CPubKey(vSolutions[i]);
690
            // We need to always call CreateSig in order to fill sigdata with all
691
            // possible signatures that we can create. This will allow further PSBT
692
            // processing to work as it needs all possible signature and pubkey pairs
693
2.16k
            if (CreateSig(creator, sigdata, provider, sig, pubkey, scriptPubKey, sigversion)) {
694
1.24k
                if (ret.size() < required + 1) {
695
1.19k
                    ret.push_back(std::move(sig));
696
1.19k
                }
697
1.24k
            }
698
2.16k
        }
699
512
        bool ok = ret.size() == required + 1;
700
886
        for (size_t i = 0; i + ret.size() < required + 1; ++i) {
701
374
            ret.emplace_back();
702
374
        }
703
512
        return ok;
704
6.62k
    }
705
38.6k
    case TxoutType::WITNESS_V0_KEYHASH:
706
38.6k
        ret.push_back(vSolutions[0]);
707
38.6k
        return true;
708
709
1.10k
    case TxoutType::WITNESS_V0_SCRIPTHASH:
710
1.10k
        if (GetCScript(provider, sigdata, CScriptID{RIPEMD160(vSolutions[0])}, scriptRet)) {
711
859
            ret.emplace_back(scriptRet.begin(), scriptRet.end());
712
859
            return true;
713
859
        }
714
        // Could not find witnessScript, add to missing
715
244
        sigdata.missing_witness_script = uint256(vSolutions[0]);
716
244
        return false;
717
718
8.40k
    case TxoutType::WITNESS_V1_TAPROOT:
719
8.40k
        return SignTaproot(provider, creator, WitnessV1Taproot(XOnlyPubKey{vSolutions[0]}), sigdata, ret);
720
721
1
    case TxoutType::ANCHOR:
722
1
        return true;
723
130k
    } // no default case, so the compiler can warn about missing cases
724
130k
    assert(false);
725
0
}
726
727
static CScript PushAll(const std::vector<valtype>& values)
728
86.0k
{
729
86.0k
    CScript result;
730
86.0k
    for (const valtype& v : values) {
731
17.4k
        if (v.size() == 0) {
732
247
            result << OP_0;
733
17.1k
        } else if (v.size() == 1 && v[0] >= 1 && v[0] <= 16) {
734
0
            result << CScript::EncodeOP_N(v[0]);
735
17.1k
        } else if (v.size() == 1 && v[0] == 0x81) {
736
0
            result << OP_1NEGATE;
737
17.1k
        } else {
738
17.1k
            result << v;
739
17.1k
        }
740
17.4k
    }
741
86.0k
    return result;
742
86.0k
}
743
744
bool ProduceSignature(const SigningProvider& provider, const BaseSignatureCreator& creator, const CScript& fromPubKey, SignatureData& sigdata)
745
88.2k
{
746
88.2k
    if (sigdata.complete) return true;
747
748
86.0k
    std::vector<valtype> result;
749
86.0k
    TxoutType whichType;
750
86.0k
    bool solved = SignStep(provider, creator, fromPubKey, result, whichType, SigVersion::BASE, sigdata);
751
86.0k
    bool P2SH = false;
752
86.0k
    CScript subscript;
753
754
86.0k
    if (solved && whichType == TxoutType::SCRIPTHASH)
755
5.31k
    {
756
        // Solver returns the subscript that needs to be evaluated;
757
        // the final scriptSig is the signatures from that
758
        // and then the serialized subscript:
759
5.31k
        subscript = CScript(result[0].begin(), result[0].end());
760
5.31k
        sigdata.redeem_script = subscript;
761
5.31k
        solved = solved && SignStep(provider, creator, subscript, result, whichType, SigVersion::BASE, sigdata) && whichType != TxoutType::SCRIPTHASH;
762
5.31k
        P2SH = true;
763
5.31k
    }
764
765
86.0k
    if (solved && whichType == TxoutType::WITNESS_V0_KEYHASH)
766
38.3k
    {
767
38.3k
        CScript witnessscript;
768
38.3k
        witnessscript << OP_DUP << OP_HASH160 << ToByteVector(result[0]) << OP_EQUALVERIFY << OP_CHECKSIG;
769
38.3k
        TxoutType subType;
770
38.3k
        solved = solved && SignStep(provider, creator, witnessscript, result, subType, SigVersion::WITNESS_V0, sigdata);
771
38.3k
        sigdata.scriptWitness.stack = result;
772
38.3k
        sigdata.witness = true;
773
38.3k
        result.clear();
774
38.3k
    }
775
47.6k
    else if (solved && whichType == TxoutType::WITNESS_V0_SCRIPTHASH)
776
848
    {
777
848
        CScript witnessscript(result[0].begin(), result[0].end());
778
848
        sigdata.witness_script = witnessscript;
779
780
848
        TxoutType subType{TxoutType::NONSTANDARD};
781
848
        solved = solved && SignStep(provider, creator, witnessscript, result, subType, SigVersion::WITNESS_V0, sigdata) && subType != TxoutType::SCRIPTHASH && subType != TxoutType::WITNESS_V0_SCRIPTHASH && subType != TxoutType::WITNESS_V0_KEYHASH;
782
783
        // If we couldn't find a solution with the legacy satisfier, try satisfying the script using Miniscript.
784
        // Note we need to check if the result stack is empty before, because it might be used even if the Script
785
        // isn't fully solved. For instance the CHECKMULTISIG satisfaction in SignStep() pushes partial signatures
786
        // and the extractor relies on this behaviour to combine witnesses.
787
848
        if (!solved && result.empty()) {
788
220
            WshSatisfier ms_satisfier{provider, sigdata, creator, witnessscript};
789
220
            const auto ms = miniscript::FromScript(witnessscript, ms_satisfier);
790
220
            solved = ms && ms->Satisfy(ms_satisfier, result) == miniscript::Availability::YES;
791
220
        }
792
848
        result.emplace_back(witnessscript.begin(), witnessscript.end());
793
794
848
        sigdata.scriptWitness.stack = result;
795
848
        sigdata.witness = true;
796
848
        result.clear();
797
46.7k
    } else if (whichType == TxoutType::WITNESS_V1_TAPROOT && !P2SH) {
798
8.39k
        sigdata.witness = true;
799
8.39k
        if (solved) {
800
1.42k
            sigdata.scriptWitness.stack = std::move(result);
801
1.42k
        }
802
8.39k
        result.clear();
803
38.3k
    } else if (solved && whichType == TxoutType::WITNESS_UNKNOWN) {
804
0
        sigdata.witness = true;
805
0
    }
806
807
86.0k
    if (!sigdata.witness) sigdata.scriptWitness.stack.clear();
808
86.0k
    if (P2SH) {
809
5.31k
        result.emplace_back(subscript.begin(), subscript.end());
810
5.31k
    }
811
86.0k
    sigdata.scriptSig = PushAll(result);
812
813
    // Test solution
814
86.0k
    sigdata.complete = solved && VerifyScript(sigdata.scriptSig, fromPubKey, &sigdata.scriptWitness, STANDARD_SCRIPT_VERIFY_FLAGS, creator.Checker());
815
86.0k
    return sigdata.complete;
816
88.2k
}
817
818
namespace {
819
class SignatureExtractorChecker final : public DeferringSignatureChecker
820
{
821
private:
822
    SignatureData& sigdata;
823
824
public:
825
56.1k
    SignatureExtractorChecker(SignatureData& sigdata, BaseSignatureChecker& checker) : DeferringSignatureChecker(checker), sigdata(sigdata) {}
826
827
    bool CheckECDSASignature(const std::vector<unsigned char>& scriptSig, const std::vector<unsigned char>& vchPubKey, const CScript& scriptCode, SigVersion sigversion) const override
828
3.11k
    {
829
3.11k
        if (m_checker.CheckECDSASignature(scriptSig, vchPubKey, scriptCode, sigversion)) {
830
2.38k
            CPubKey pubkey(vchPubKey);
831
2.38k
            sigdata.signatures.emplace(pubkey.GetID(), SigPair(pubkey, scriptSig));
832
2.38k
            return true;
833
2.38k
        }
834
731
        return false;
835
3.11k
    }
836
};
837
838
struct Stacks
839
{
840
    std::vector<valtype> script;
841
    std::vector<valtype> witness;
842
843
    Stacks() = delete;
844
    Stacks(const Stacks&) = delete;
845
56.1k
    explicit Stacks(const SignatureData& data) : witness(data.scriptWitness.stack) {
846
56.1k
        EvalScript(script, data.scriptSig, SCRIPT_VERIFY_STRICTENC, BaseSignatureChecker(), SigVersion::BASE);
847
56.1k
    }
848
};
849
}
850
851
// Extracts signatures and scripts from incomplete scriptSigs. Please do not extend this, use PSBT instead
852
SignatureData DataFromTransaction(const CMutableTransaction& tx, unsigned int nIn, const CTxOut& txout)
853
56.1k
{
854
56.1k
    SignatureData data;
855
56.1k
    assert(tx.vin.size() > nIn);
856
56.1k
    data.scriptSig = tx.vin[nIn].scriptSig;
857
56.1k
    data.scriptWitness = tx.vin[nIn].scriptWitness;
858
56.1k
    Stacks stack(data);
859
860
    // Get signatures
861
56.1k
    MutableTransactionSignatureChecker tx_checker(&tx, nIn, txout.nValue, MissingDataBehavior::FAIL);
862
56.1k
    SignatureExtractorChecker extractor_checker(data, tx_checker);
863
56.1k
    if (VerifyScript(data.scriptSig, txout.scriptPubKey, &data.scriptWitness, STANDARD_SCRIPT_VERIFY_FLAGS, extractor_checker)) {
864
2.24k
        data.complete = true;
865
2.24k
        return data;
866
2.24k
    }
867
868
    // Get scripts
869
53.9k
    std::vector<std::vector<unsigned char>> solutions;
870
53.9k
    TxoutType script_type = Solver(txout.scriptPubKey, solutions);
871
53.9k
    SigVersion sigversion = SigVersion::BASE;
872
53.9k
    CScript next_script = txout.scriptPubKey;
873
874
53.9k
    if (script_type == TxoutType::SCRIPTHASH && !stack.script.empty() && !stack.script.back().empty()) {
875
        // Get the redeemScript
876
30
        CScript redeem_script(stack.script.back().begin(), stack.script.back().end());
877
30
        data.redeem_script = redeem_script;
878
30
        next_script = std::move(redeem_script);
879
880
        // Get redeemScript type
881
30
        script_type = Solver(next_script, solutions);
882
30
        stack.script.pop_back();
883
30
    }
884
53.9k
    if (script_type == TxoutType::WITNESS_V0_SCRIPTHASH && !stack.witness.empty() && !stack.witness.back().empty()) {
885
        // Get the witnessScript
886
38
        CScript witness_script(stack.witness.back().begin(), stack.witness.back().end());
887
38
        data.witness_script = witness_script;
888
38
        next_script = std::move(witness_script);
889
890
        // Get witnessScript type
891
38
        script_type = Solver(next_script, solutions);
892
38
        stack.witness.pop_back();
893
38
        stack.script = std::move(stack.witness);
894
38
        stack.witness.clear();
895
38
        sigversion = SigVersion::WITNESS_V0;
896
38
    }
897
53.9k
    if (script_type == TxoutType::MULTISIG && !stack.script.empty()) {
898
        // Build a map of pubkey -> signature by matching sigs to pubkeys:
899
54
        assert(solutions.size() > 1);
900
54
        unsigned int num_pubkeys = solutions.size()-2;
901
54
        unsigned int last_success_key = 0;
902
303
        for (const valtype& sig : stack.script) {
903
932
            for (unsigned int i = last_success_key; i < num_pubkeys; ++i) {
904
780
                const valtype& pubkey = solutions[i+1];
905
                // We either have a signature for this pubkey, or we have found a signature and it is valid
906
780
                if (data.signatures.contains(CPubKey(pubkey).GetID()) || extractor_checker.CheckECDSASignature(sig, pubkey, next_script, sigversion)) {
907
151
                    last_success_key = i + 1;
908
151
                    break;
909
151
                }
910
780
            }
911
303
        }
912
54
    }
913
914
53.9k
    return data;
915
53.9k
}
916
917
void UpdateInput(CTxIn& input, const SignatureData& data)
918
60.7k
{
919
60.7k
    input.scriptSig = data.scriptSig;
920
60.7k
    input.scriptWitness = data.scriptWitness;
921
60.7k
}
922
923
void SignatureData::MergeSignatureData(SignatureData sigdata)
924
82
{
925
82
    if (complete) return;
926
77
    if (sigdata.complete) {
927
8
        *this = std::move(sigdata);
928
8
        return;
929
8
    }
930
69
    if (redeem_script.empty() && !sigdata.redeem_script.empty()) {
931
13
        redeem_script = sigdata.redeem_script;
932
13
    }
933
69
    if (witness_script.empty() && !sigdata.witness_script.empty()) {
934
16
        witness_script = sigdata.witness_script;
935
16
    }
936
69
    signatures.insert(std::make_move_iterator(sigdata.signatures.begin()), std::make_move_iterator(sigdata.signatures.end()));
937
69
}
938
939
namespace {
940
/** Dummy signature checker which accepts all signatures. */
941
class DummySignatureChecker final : public BaseSignatureChecker
942
{
943
public:
944
1.50k
    DummySignatureChecker() = default;
945
8
    bool CheckECDSASignature(const std::vector<unsigned char>& sig, const std::vector<unsigned char>& vchPubKey, const CScript& scriptCode, SigVersion sigversion) const override { return sig.size() != 0; }
946
0
    bool CheckSchnorrSignature(std::span<const unsigned char> sig, std::span<const unsigned char> pubkey, SigVersion sigversion, ScriptExecutionData& execdata, ScriptError* serror) const override { return sig.size() != 0; }
947
0
    bool CheckLockTime(const CScriptNum& nLockTime) const override { return true; }
948
0
    bool CheckSequence(const CScriptNum& nSequence) const override { return true; }
949
};
950
}
951
952
const BaseSignatureChecker& DUMMY_CHECKER = DummySignatureChecker();
953
954
namespace {
955
class DummySignatureCreator final : public BaseSignatureCreator {
956
private:
957
    char m_r_len = 32;
958
    char m_s_len = 32;
959
public:
960
3.01k
    DummySignatureCreator(char r_len, char s_len) : m_r_len(r_len), m_s_len(s_len) {}
961
7
    const BaseSignatureChecker& Checker() const override { return DUMMY_CHECKER; }
962
    bool CreateSig(const SigningProvider& provider, std::vector<unsigned char>& vchSig, const CKeyID& keyid, const CScript& scriptCode, SigVersion sigversion) const override
963
4
    {
964
        // Create a dummy signature that is a valid DER-encoding
965
4
        vchSig.assign(m_r_len + m_s_len + 7, '\000');
966
4
        vchSig[0] = 0x30;
967
4
        vchSig[1] = m_r_len + m_s_len + 4;
968
4
        vchSig[2] = 0x02;
969
4
        vchSig[3] = m_r_len;
970
4
        vchSig[4] = 0x01;
971
4
        vchSig[4 + m_r_len] = 0x02;
972
4
        vchSig[5 + m_r_len] = m_s_len;
973
4
        vchSig[6 + m_r_len] = 0x01;
974
4
        vchSig[6 + m_r_len + m_s_len] = SIGHASH_ALL;
975
4
        return true;
976
4
    }
977
    bool CreateSchnorrSig(const SigningProvider& provider, std::vector<unsigned char>& sig, const XOnlyPubKey& pubkey, const uint256* leaf_hash, const uint256* tweak, SigVersion sigversion) const override
978
3
    {
979
3
        sig.assign(64, '\000');
980
3
        return true;
981
3
    }
982
    std::vector<uint8_t> CreateMuSig2Nonce(const SigningProvider& provider, const CPubKey& aggregate_pubkey, const CPubKey& script_pubkey, const CPubKey& part_pubkey, const uint256* leaf_hash, const uint256* merkle_root, SigVersion sigversion, const SignatureData& sigdata) const override
983
0
    {
984
0
        std::vector<uint8_t> out;
985
0
        out.assign(MUSIG2_PUBNONCE_SIZE, '\000');
986
0
        return out;
987
0
    }
988
    bool CreateMuSig2PartialSig(const SigningProvider& provider, uint256& partial_sig, const CPubKey& aggregate_pubkey, const CPubKey& script_pubkey, const CPubKey& part_pubkey, const uint256* leaf_hash, const std::vector<std::pair<uint256, bool>>& tweaks, SigVersion sigversion, const SignatureData& sigdata) const override
989
0
    {
990
0
        partial_sig = uint256::ONE;
991
0
        return true;
992
0
    }
993
    bool CreateMuSig2AggregateSig(const std::vector<CPubKey>& participants, std::vector<uint8_t>& sig, const CPubKey& aggregate_pubkey, const CPubKey& script_pubkey, const uint256* leaf_hash, const std::vector<std::pair<uint256, bool>>& tweaks, SigVersion sigversion, const SignatureData& sigdata) const override
994
0
    {
995
0
        sig.assign(64, '\000');
996
0
        return true;
997
0
    }
998
};
999
1000
}
1001
1002
const BaseSignatureCreator& DUMMY_SIGNATURE_CREATOR = DummySignatureCreator(32, 32);
1003
const BaseSignatureCreator& DUMMY_MAXIMUM_SIGNATURE_CREATOR = DummySignatureCreator(33, 32);
1004
1005
bool IsSegWitOutput(const SigningProvider& provider, const CScript& script)
1006
4
{
1007
4
    int version;
1008
4
    valtype program;
1009
4
    if (script.IsWitnessProgram(version, program)) return true;
1010
0
    if (script.IsPayToScriptHash()) {
1011
0
        std::vector<valtype> solutions;
1012
0
        auto whichtype = Solver(script, solutions);
1013
0
        if (whichtype == TxoutType::SCRIPTHASH) {
1014
0
            auto h160 = uint160(solutions[0]);
1015
0
            CScript subscript;
1016
0
            if (provider.GetCScript(CScriptID{h160}, subscript)) {
1017
0
                if (subscript.IsWitnessProgram(version, program)) return true;
1018
0
            }
1019
0
        }
1020
0
    }
1021
0
    return false;
1022
0
}
1023
1024
bool SignTransaction(CMutableTransaction& mtx, const SigningProvider* keystore, const std::map<COutPoint, Coin>& coins, const SignOptions& options, std::map<int, bilingual_str>& input_errors)
1025
18.3k
{
1026
18.3k
    bool fHashSingle = ((options.sighash_type & ~SIGHASH_ANYONECANPAY) == SIGHASH_SINGLE);
1027
1028
    // Use CTransaction for the constant parts of the
1029
    // transaction to avoid rehashing.
1030
18.3k
    const CTransaction txConst(mtx);
1031
1032
18.3k
    PrecomputedTransactionData txdata;
1033
18.3k
    std::vector<CTxOut> spent_outputs;
1034
74.4k
    for (unsigned int i = 0; i < mtx.vin.size(); ++i) {
1035
56.1k
        CTxIn& txin = mtx.vin[i];
1036
56.1k
        auto coin = coins.find(txin.prevout);
1037
56.1k
        if (coin == coins.end() || coin->second.IsSpent()) {
1038
10
            txdata.Init(txConst, /*spent_outputs=*/{}, /*force=*/true);
1039
10
            break;
1040
56.1k
        } else {
1041
56.1k
            spent_outputs.emplace_back(coin->second.out.nValue, coin->second.out.scriptPubKey);
1042
56.1k
        }
1043
56.1k
    }
1044
18.3k
    if (spent_outputs.size() == mtx.vin.size()) {
1045
18.3k
        txdata.Init(txConst, std::move(spent_outputs), true);
1046
18.3k
    }
1047
1048
    // Sign what we can:
1049
74.5k
    for (unsigned int i = 0; i < mtx.vin.size(); ++i) {
1050
56.1k
        CTxIn& txin = mtx.vin[i];
1051
56.1k
        auto coin = coins.find(txin.prevout);
1052
56.1k
        if (coin == coins.end() || coin->second.IsSpent()) {
1053
19
            input_errors[i] = _("Input not found or already spent");
1054
19
            continue;
1055
19
        }
1056
56.1k
        const CScript& prevPubKey = coin->second.out.scriptPubKey;
1057
56.1k
        const CAmount& amount = coin->second.out.nValue;
1058
1059
56.1k
        SignatureData sigdata = DataFromTransaction(mtx, i, coin->second.out);
1060
        // Only sign SIGHASH_SINGLE if there's a corresponding output:
1061
56.1k
        if (!fHashSingle || (i < mtx.vout.size())) {
1062
56.1k
            ProduceSignature(*keystore, MutableTransactionSignatureCreator(mtx, i, amount, &txdata, options), prevPubKey, sigdata);
1063
56.1k
        }
1064
1065
56.1k
        UpdateInput(txin, sigdata);
1066
1067
        // amount must be specified for valid segwit signature
1068
56.1k
        if (amount == MAX_MONEY && !txin.scriptWitness.IsNull()) {
1069
13
            input_errors[i] = _("Missing amount");
1070
13
            continue;
1071
13
        }
1072
1073
56.0k
        ScriptError serror = SCRIPT_ERR_OK;
1074
56.0k
        if (!sigdata.complete && !VerifyScript(txin.scriptSig, prevPubKey, &txin.scriptWitness, STANDARD_SCRIPT_VERIFY_FLAGS, TransactionSignatureChecker(&txConst, i, amount, txdata, MissingDataBehavior::FAIL), &serror)) {
1075
43.8k
            if (serror == SCRIPT_ERR_INVALID_STACK_OPERATION) {
1076
                // Unable to sign input and verification failed (possible attempt to partially sign).
1077
27.1k
                input_errors[i] = Untranslated("Unable to sign input, invalid stack size (possibly missing key)");
1078
27.1k
            } else if (serror == SCRIPT_ERR_SIG_NULLFAIL) {
1079
                // Verification failed (possibly due to insufficient signatures).
1080
72
                input_errors[i] = Untranslated("CHECK(MULTI)SIG failing with non-zero signature (possibly need more signatures)");
1081
16.6k
            } else {
1082
16.6k
                input_errors[i] = Untranslated(ScriptErrorString(serror));
1083
16.6k
            }
1084
43.8k
        } else {
1085
            // If this input succeeds, make sure there is no error set for it
1086
12.2k
            input_errors.erase(i);
1087
12.2k
        }
1088
56.0k
    }
1089
18.3k
    return input_errors.empty();
1090
18.3k
}