Coverage Report

Created: 2026-09-14 20:36

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