Coverage Report

Created: 2026-06-16 16:41

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 <cstddef>
32
#include <functional>
33
#include <iterator>
34
#include <span>
35
#include <string>
36
37
typedef std::vector<unsigned char> valtype;
38
39
MutableTransactionSignatureCreator::MutableTransactionSignatureCreator(const CMutableTransaction& tx, unsigned int input_idx, const CAmount& amount, const SignOptions& options)
40
5.66k
    : m_txto{tx}, nIn{input_idx}, m_options{options}, amount{amount}, checker{&m_txto, nIn, amount, MissingDataBehavior::FAIL},
41
5.66k
      m_txdata(nullptr)
42
5.66k
{
43
5.66k
}
44
45
MutableTransactionSignatureCreator::MutableTransactionSignatureCreator(const CMutableTransaction& tx, unsigned int input_idx, const CAmount& amount, const PrecomputedTransactionData* txdata, const SignOptions& options)
46
66.2k
    : m_txto{tx}, nIn{input_idx}, m_options{options}, amount{amount},
47
66.2k
      checker{txdata ? MutableTransactionSignatureChecker{&m_txto, nIn, amount, *txdata, MissingDataBehavior::FAIL} :
48
66.2k
                       MutableTransactionSignatureChecker{&m_txto, nIn, amount, MissingDataBehavior::FAIL}},
49
66.2k
      m_txdata(txdata)
50
66.2k
{
51
66.2k
}
52
53
bool MutableTransactionSignatureCreator::CreateSig(const SigningProvider& provider, std::vector<unsigned char>& vchSig, const CKeyID& address, const CScript& scriptCode, SigVersion sigversion) const
54
31.5k
{
55
31.5k
    assert(sigversion == SigVersion::BASE || sigversion == SigVersion::WITNESS_V0);
56
57
31.5k
    CKey key;
58
31.5k
    if (!provider.GetKey(address, key))
59
15.2k
        return false;
60
61
    // Signing with uncompressed keys is disabled in witness scripts
62
16.3k
    if (sigversion == SigVersion::WITNESS_V0 && !key.IsCompressed())
63
4
        return false;
64
65
    // Signing without known amount does not work in witness scripts.
66
16.3k
    if (sigversion == SigVersion::WITNESS_V0 && !MoneyRange(amount)) return false;
67
68
    // BASE/WITNESS_V0 signatures don't support explicit SIGHASH_DEFAULT, use SIGHASH_ALL instead.
69
16.3k
    const int hashtype = m_options.sighash_type == SIGHASH_DEFAULT ? SIGHASH_ALL : m_options.sighash_type;
70
71
16.3k
    uint256 hash = SignatureHash(scriptCode, m_txto, nIn, hashtype, amount, sigversion, m_txdata);
72
16.3k
    if (!key.Sign(hash, vchSig))
73
0
        return false;
74
16.3k
    vchSig.push_back((unsigned char)hashtype);
75
16.3k
    return true;
76
16.3k
}
77
78
std::optional<uint256> MutableTransactionSignatureCreator::ComputeSchnorrSignatureHash(const uint256* leaf_hash, SigVersion sigversion) const
79
1.51k
{
80
1.51k
    assert(sigversion == SigVersion::TAPROOT || sigversion == SigVersion::TAPSCRIPT);
81
82
    // BIP341/BIP342 signing needs lots of precomputed transaction data. While some
83
    // (non-SIGHASH_DEFAULT) sighash modes exist that can work with just some subset
84
    // of data present, for now, only support signing when everything is provided.
85
1.51k
    if (!m_txdata || !m_txdata->m_bip341_taproot_ready || !m_txdata->m_spent_outputs_ready) return std::nullopt;
86
87
1.51k
    ScriptExecutionData execdata;
88
1.51k
    execdata.m_annex_init = true;
89
1.51k
    execdata.m_annex_present = false; // Only support annex-less signing for now.
90
1.51k
    if (sigversion == SigVersion::TAPSCRIPT) {
91
738
        execdata.m_codeseparator_pos_init = true;
92
738
        execdata.m_codeseparator_pos = 0xFFFFFFFF; // Only support non-OP_CODESEPARATOR BIP342 signing for now.
93
738
        if (!leaf_hash) return std::nullopt; // BIP342 signing needs leaf hash.
94
738
        execdata.m_tapleaf_hash_init = true;
95
738
        execdata.m_tapleaf_hash = *leaf_hash;
96
738
    }
97
1.51k
    uint256 hash;
98
1.51k
    if (!SignatureHashSchnorr(hash, execdata, m_txto, nIn, m_options.sighash_type, sigversion, *m_txdata, MissingDataBehavior::FAIL)) return std::nullopt;
99
1.51k
    return hash;
100
1.51k
}
101
102
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
103
108k
{
104
108k
    CKey key;
105
108k
    if (!provider.GetKeyByXOnly(pubkey, key)) return false;
106
107
1.04k
    std::optional<uint256> hash = ComputeSchnorrSignatureHash(leaf_hash, sigversion);
108
1.04k
    if (!hash.has_value()) return false;
109
110
1.04k
    sig.resize(64);
111
    // Use uint256{} as aux_rnd for now.
112
1.04k
    if (!key.SignSchnorr(*hash, sig, merkle_root, {})) return false;
113
1.04k
    if (m_options.sighash_type) sig.push_back(m_options.sighash_type);
114
1.04k
    return true;
115
1.04k
}
116
117
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
118
4.91k
{
119
4.91k
    assert(sigversion == SigVersion::TAPROOT || sigversion == SigVersion::TAPSCRIPT);
120
121
    // Retrieve the private key
122
4.91k
    CKey key;
123
4.91k
    if (!provider.GetKey(part_pubkey.GetID(), key)) return {};
124
125
    // Retrieve participant pubkeys
126
151
    auto it = sigdata.musig2_pubkeys.find(aggregate_pubkey);
127
151
    if (it == sigdata.musig2_pubkeys.end()) return {};
128
151
    const std::vector<CPubKey>& pubkeys = it->second;
129
151
    if (std::find(pubkeys.begin(), pubkeys.end(), part_pubkey) == pubkeys.end()) return {};
130
131
    // Compute sighash
132
151
    std::optional<uint256> sighash = ComputeSchnorrSignatureHash(leaf_hash, sigversion);
133
151
    if (!sighash.has_value()) return {};
134
135
151
    MuSig2SecNonce secnonce;
136
151
    std::vector<uint8_t> out = ::CreateMuSig2Nonce(secnonce, *sighash, key, aggregate_pubkey, pubkeys);
137
151
    if (out.empty()) return {};
138
139
    // Store the secnonce in the SigningProvider
140
151
    provider.SetMuSig2SecNonce(MuSig2SessionID(script_pubkey, part_pubkey, *sighash, out), std::move(secnonce));
141
142
151
    return out;
143
151
}
144
145
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
146
10.1k
{
147
10.1k
    assert(sigversion == SigVersion::TAPROOT || sigversion == SigVersion::TAPSCRIPT);
148
149
    // Retrieve private key
150
10.1k
    CKey key;
151
10.1k
    if (!provider.GetKey(part_pubkey.GetID(), key)) return false;
152
153
    // Retrieve participant pubkeys
154
533
    auto it = sigdata.musig2_pubkeys.find(aggregate_pubkey);
155
533
    if (it == sigdata.musig2_pubkeys.end()) return false;
156
533
    const std::vector<CPubKey>& pubkeys = it->second;
157
533
    if (std::find(pubkeys.begin(), pubkeys.end(), part_pubkey) == pubkeys.end()) return {};
158
159
    // Retrieve pubnonces
160
533
    auto this_leaf_aggkey = std::make_pair(script_pubkey, leaf_hash ? *leaf_hash : uint256());
161
533
    auto pubnonce_it = sigdata.musig2_pubnonces.find(this_leaf_aggkey);
162
533
    if (pubnonce_it == sigdata.musig2_pubnonces.end()) return false;
163
485
    const std::map<CPubKey, std::vector<uint8_t>>& pubnonces = pubnonce_it->second;
164
165
    // Check if enough pubnonces
166
485
    if (pubnonces.size() != pubkeys.size()) return false;
167
168
    // Compute sighash
169
248
    std::optional<uint256> sighash = ComputeSchnorrSignatureHash(leaf_hash, sigversion);
170
248
    if (!sighash.has_value()) return false;
171
172
    // Retrieve the secnonce
173
248
    auto part_pubnonce_it = pubnonces.find(part_pubkey);
174
248
    if (part_pubnonce_it == pubnonces.end()) return false;
175
248
    uint256 session_id = MuSig2SessionID(script_pubkey, part_pubkey, *sighash, part_pubnonce_it->second);
176
248
    std::optional<std::reference_wrapper<MuSig2SecNonce>> secnonce = provider.GetMuSig2SecNonce(session_id);
177
248
    if (!secnonce || !secnonce->get().IsValid()) return false;
178
179
    // Compute the sig
180
140
    std::optional<uint256> sig = ::CreateMuSig2PartialSig(*sighash, key, aggregate_pubkey, pubkeys, pubnonces, *secnonce, tweaks);
181
140
    if (!sig) return false;
182
140
    partial_sig = std::move(*sig);
183
184
    // Delete the secnonce now that we're done with it
185
140
    assert(!secnonce->get().IsValid());
186
140
    provider.DeleteMuSig2Session(session_id);
187
188
140
    return true;
189
140
}
190
191
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
192
3.74k
{
193
3.74k
    assert(sigversion == SigVersion::TAPROOT || sigversion == SigVersion::TAPSCRIPT);
194
3.74k
    if (!participants.size()) return false;
195
196
    // Retrieve pubnonces and partial sigs
197
3.74k
    auto this_leaf_aggkey = std::make_pair(script_pubkey, leaf_hash ? *leaf_hash : uint256());
198
3.74k
    auto pubnonce_it = sigdata.musig2_pubnonces.find(this_leaf_aggkey);
199
3.74k
    if (pubnonce_it == sigdata.musig2_pubnonces.end()) return false;
200
3.42k
    const std::map<CPubKey, std::vector<uint8_t>>& pubnonces = pubnonce_it->second;
201
3.42k
    auto partial_sigs_it = sigdata.musig2_partial_sigs.find(this_leaf_aggkey);
202
3.42k
    if (partial_sigs_it == sigdata.musig2_partial_sigs.end()) return false;
203
679
    const std::map<CPubKey, uint256>& partial_sigs = partial_sigs_it->second;
204
205
    // Check if enough pubnonces and partial sigs
206
679
    if (pubnonces.size() != participants.size()) return false;
207
679
    if (partial_sigs.size() != participants.size()) return false;
208
209
    // Compute sighash
210
69
    std::optional<uint256> sighash = ComputeSchnorrSignatureHash(leaf_hash, sigversion);
211
69
    if (!sighash.has_value()) return false;
212
213
69
    std::optional<std::vector<uint8_t>> res = ::CreateMuSig2AggregateSig(participants, aggregate_pubkey, tweaks, *sighash, pubnonces, partial_sigs);
214
69
    if (!res) return false;
215
69
    sig = res.value();
216
69
    if (m_options.sighash_type) sig.push_back(m_options.sighash_type);
217
218
69
    return true;
219
69
}
220
221
static bool GetCScript(const SigningProvider& provider, const SignatureData& sigdata, const CScriptID& scriptid, CScript& script)
222
7.67k
{
223
7.67k
    if (provider.GetCScript(scriptid, script)) {
224
1.91k
        return true;
225
1.91k
    }
226
    // Look for scripts in SignatureData
227
5.75k
    if (CScriptID(sigdata.redeem_script) == scriptid) {
228
3.84k
        script = sigdata.redeem_script;
229
3.84k
        return true;
230
3.84k
    } else if (CScriptID(sigdata.witness_script) == scriptid) {
231
279
        script = sigdata.witness_script;
232
279
        return true;
233
279
    }
234
1.62k
    return false;
235
5.75k
}
236
237
static bool GetPubKey(const SigningProvider& provider, const SignatureData& sigdata, const CKeyID& address, CPubKey& pubkey)
238
59.0k
{
239
    // Look for pubkey in all partial sigs
240
59.0k
    const auto it = sigdata.signatures.find(address);
241
59.0k
    if (it != sigdata.signatures.end()) {
242
71
        pubkey = it->second.first;
243
71
        return true;
244
71
    }
245
    // Look for pubkey in pubkey lists
246
59.0k
    const auto& pk_it = sigdata.misc_pubkeys.find(address);
247
59.0k
    if (pk_it != sigdata.misc_pubkeys.end()) {
248
13.5k
        pubkey = pk_it->second.first;
249
13.5k
        return true;
250
13.5k
    }
251
45.5k
    const auto& tap_pk_it = sigdata.tap_pubkeys.find(address);
252
45.5k
    if (tap_pk_it != sigdata.tap_pubkeys.end()) {
253
265
        pubkey = tap_pk_it->second.GetEvenCorrespondingCPubKey();
254
265
        return true;
255
265
    }
256
    // Query the underlying provider
257
45.2k
    return provider.GetPubKey(address, pubkey);
258
45.5k
}
259
260
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)
261
32.1k
{
262
32.1k
    CKeyID keyid = pubkey.GetID();
263
32.1k
    const auto it = sigdata.signatures.find(keyid);
264
32.1k
    if (it != sigdata.signatures.end()) {
265
568
        sig_out = it->second.second;
266
568
        return true;
267
568
    }
268
31.5k
    KeyOriginInfo info;
269
31.5k
    if (provider.GetKeyOrigin(keyid, info)) {
270
11.9k
        sigdata.misc_pubkeys.emplace(keyid, std::make_pair(pubkey, std::move(info)));
271
11.9k
    }
272
31.5k
    if (creator.CreateSig(provider, sig_out, keyid, scriptcode, sigversion)) {
273
16.3k
        auto i = sigdata.signatures.emplace(keyid, SigPair(pubkey, sig_out));
274
16.3k
        assert(i.second);
275
16.3k
        return true;
276
16.3k
    }
277
    // Could not make signature or signature not found, add keyid to missing
278
15.2k
    sigdata.missing_sigs.push_back(keyid);
279
15.2k
    return false;
280
31.5k
}
281
282
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)
283
107k
{
284
107k
    Assert(sigversion == SigVersion::TAPROOT || sigversion == SigVersion::TAPSCRIPT);
285
286
    // Lookup derivation paths for the script pubkey
287
107k
    KeyOriginInfo agg_info;
288
107k
    auto misc_pk_it = sigdata.taproot_misc_pubkeys.find(script_pubkey);
289
107k
    if (misc_pk_it != sigdata.taproot_misc_pubkeys.end()) {
290
97.3k
        agg_info = misc_pk_it->second.second;
291
97.3k
    }
292
293
107k
    for (const auto& [agg_pub, part_pks] : sigdata.musig2_pubkeys) {
294
11.6k
        if (part_pks.empty()) continue;
295
296
        // Fill participant derivation path info
297
31.5k
        for (const auto& part_pk : part_pks) {
298
31.5k
            KeyOriginInfo part_info;
299
31.5k
            if (provider.GetKeyOrigin(part_pk.GetID(), part_info)) {
300
6.33k
                XOnlyPubKey xonly_part(part_pk);
301
6.33k
                auto it = sigdata.taproot_misc_pubkeys.find(xonly_part);
302
6.33k
                if (it == sigdata.taproot_misc_pubkeys.end()) {
303
133
                    it = sigdata.taproot_misc_pubkeys.emplace(xonly_part, std::make_pair(std::set<uint256>(), part_info)).first;
304
133
                }
305
6.33k
                if (leaf_hash) it->second.first.insert(*leaf_hash);
306
6.33k
            }
307
31.5k
        }
308
309
        // The pubkey in the script may not be the actual aggregate of the participants, but derived from it.
310
        // Check the derivation, and compute the BIP 32 derivation tweaks
311
11.6k
        std::vector<std::pair<uint256, bool>> tweaks;
312
11.6k
        CPubKey plain_pub = agg_pub;
313
11.6k
        if (XOnlyPubKey(agg_pub) != script_pubkey) {
314
10.5k
            if (agg_info.path.empty()) continue;
315
            // Compute and compare fingerprint
316
5.00k
            CKeyID keyid = agg_pub.GetID();
317
5.00k
            if (!std::equal(agg_info.fingerprint, agg_info.fingerprint + sizeof(agg_info.fingerprint), keyid.data())) {
318
2.39k
                continue;
319
2.39k
            }
320
            // Get the BIP32 derivation tweaks
321
2.60k
            CExtPubKey extpub = CreateMuSig2SyntheticXpub(agg_pub);
322
5.21k
            for (const int i : agg_info.path) {
323
5.21k
                auto& [t, xonly] = tweaks.emplace_back();
324
5.21k
                xonly = false;
325
5.21k
                if (!extpub.Derive(extpub, i, &t)) {
326
0
                    return false;
327
0
                }
328
5.21k
            }
329
2.60k
            Assert(XOnlyPubKey(extpub.pubkey) == script_pubkey);
330
2.60k
            plain_pub = extpub.pubkey;
331
2.60k
        }
332
333
        // Add the merkle root tweak
334
3.74k
        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.74k
        if (creator.CreateMuSig2AggregateSig(part_pks, sig_out, agg_pub, plain_pub, leaf_hash, tweaks, sigversion, sigdata)) {
343
69
            if (sigversion == SigVersion::TAPROOT) {
344
30
                sigdata.taproot_key_path_sig = sig_out;
345
39
            } else {
346
39
                auto lookup_key = std::make_pair(script_pubkey, leaf_hash ? *leaf_hash : uint256());
347
39
                sigdata.taproot_script_sigs[lookup_key] = sig_out;
348
39
            }
349
69
            continue;
350
69
        }
351
        // Cannot aggregate, try making partial sigs for every participant
352
3.68k
        auto pub_key_leaf_hash = std::make_pair(plain_pub, leaf_hash ? *leaf_hash : uint256());
353
10.1k
        for (const CPubKey& part_pk : part_pks) {
354
10.1k
            uint256 partial_sig;
355
10.1k
            if (creator.CreateMuSig2PartialSig(provider, partial_sig, agg_pub, plain_pub, part_pk, leaf_hash, tweaks, sigversion, sigdata) && Assume(!partial_sig.IsNull())) {
356
140
                sigdata.musig2_partial_sigs[pub_key_leaf_hash].emplace(part_pk, partial_sig);
357
140
            }
358
10.1k
        }
359
        // If there are any partial signatures, continue with next aggregate pubkey
360
3.68k
        auto partial_sigs_it = sigdata.musig2_partial_sigs.find(pub_key_leaf_hash);
361
3.68k
        if (partial_sigs_it != sigdata.musig2_partial_sigs.end() && !partial_sigs_it->second.empty()) {
362
750
            continue;
363
750
        }
364
        // No partial sigs, try to make pubnonces
365
2.93k
        std::map<CPubKey, std::vector<uint8_t>>& pubnonces = sigdata.musig2_pubnonces[pub_key_leaf_hash];
366
8.09k
        for (const CPubKey& part_pk : part_pks) {
367
8.09k
            if (pubnonces.contains(part_pk)) continue;
368
4.91k
            std::vector<uint8_t> pubnonce = creator.CreateMuSig2Nonce(provider, agg_pub, plain_pub, part_pk, leaf_hash, merkle_root, sigversion, sigdata);
369
4.91k
            if (pubnonce.empty()) continue;
370
151
            pubnonces[part_pk] = std::move(pubnonce);
371
151
        }
372
2.93k
    }
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
94.0k
{
378
94.0k
    KeyOriginInfo info;
379
94.0k
    if (provider.GetKeyOriginByXOnly(pubkey, info)) {
380
46.6k
        auto it = sigdata.taproot_misc_pubkeys.find(pubkey);
381
46.6k
        if (it == sigdata.taproot_misc_pubkeys.end()) {
382
705
            sigdata.taproot_misc_pubkeys.emplace(pubkey, std::make_pair(std::set<uint256>({leaf_hash}), info));
383
45.9k
        } else {
384
45.9k
            it->second.first.insert(leaf_hash);
385
45.9k
        }
386
46.6k
    }
387
388
94.0k
    auto lookup_key = std::make_pair(pubkey, leaf_hash);
389
94.0k
    auto it = sigdata.taproot_script_sigs.find(lookup_key);
390
94.0k
    if (it != sigdata.taproot_script_sigs.end()) {
391
498
        sig_out = it->second;
392
498
        return true;
393
498
    }
394
395
93.5k
    if (creator.CreateSchnorrSig(provider, sig_out, pubkey, &leaf_hash, nullptr, sigversion)) {
396
473
        sigdata.taproot_script_sigs[lookup_key] = sig_out;
397
93.0k
    } else if (!SignMuSig2(creator, sigdata, provider, sig_out, pubkey, /*merkle_root=*/nullptr, &leaf_hash, sigversion)) {
398
0
        return false;
399
0
    }
400
401
93.5k
    return sigdata.taproot_script_sigs.contains(lookup_key);
402
93.5k
}
403
404
template<typename M, typename K, typename V>
405
miniscript::Availability MsLookupHelper(const M& map, const K& key, V& value)
406
64
{
407
64
    auto it = map.find(key);
408
64
    if (it != map.end()) {
409
32
        value = it->second;
410
32
        return miniscript::Availability::YES;
411
32
    }
412
32
    return miniscript::Availability::NO;
413
64
}
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.37k
                       miniscript::MiniscriptContext script_ctx) : m_provider(provider),
434
4.37k
                                                                   m_sig_data(sig_data),
435
4.37k
                                                                   m_creator(creator),
436
4.37k
                                                                   m_witness_script(witscript),
437
4.37k
                                                                   m_script_ctx(script_ctx) {}
Satisfier<XOnlyPubKey>::Satisfier(SigningProvider const&, SignatureData&, BaseSignatureCreator const&, CScript const&, miniscript::MiniscriptContext)
Line
Count
Source
433
4.17k
                       miniscript::MiniscriptContext script_ctx) : m_provider(provider),
434
4.17k
                                                                   m_sig_data(sig_data),
435
4.17k
                                                                   m_creator(creator),
436
4.17k
                                                                   m_witness_script(witscript),
437
4.17k
                                                                   m_script_ctx(script_ctx) {}
Satisfier<CPubKey>::Satisfier(SigningProvider const&, SignatureData&, BaseSignatureCreator const&, CScript const&, miniscript::MiniscriptContext)
Line
Count
Source
433
201
                       miniscript::MiniscriptContext script_ctx) : m_provider(provider),
434
201
                                                                   m_sig_data(sig_data),
435
201
                                                                   m_creator(creator),
436
201
                                                                   m_witness_script(witscript),
437
201
                                                                   m_script_ctx(script_ctx) {}
438
439
293k
    static bool KeyCompare(const Key& a, const Key& b) {
440
293k
        return a < b;
441
293k
    }
Satisfier<XOnlyPubKey>::KeyCompare(XOnlyPubKey const&, XOnlyPubKey const&)
Line
Count
Source
439
292k
    static bool KeyCompare(const Key& a, const Key& b) {
440
292k
        return a < b;
441
292k
    }
Satisfier<CPubKey>::KeyCompare(CPubKey const&, CPubKey const&)
Line
Count
Source
439
995
    static bool KeyCompare(const Key& a, const Key& b) {
440
995
        return a < b;
441
995
    }
442
443
    //! Get a CPubKey from a key hash. Note the key hash may be of an xonly pubkey.
444
    template<typename I>
445
325
    std::optional<CPubKey> CPubFromPKHBytes(I first, I last) const {
446
325
        assert(last - first == 20);
447
325
        CPubKey pubkey;
448
325
        CKeyID key_id;
449
325
        std::copy(first, last, key_id.begin());
450
325
        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
325
    }
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
279
    std::optional<CPubKey> CPubFromPKHBytes(I first, I last) const {
446
279
        assert(last - first == 20);
447
279
        CPubKey pubkey;
448
279
        CKeyID key_id;
449
279
        std::copy(first, last, key_id.begin());
450
279
        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
279
    }
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
46
    std::optional<CPubKey> CPubFromPKHBytes(I first, I last) const {
446
46
        assert(last - first == 20);
447
46
        CPubKey pubkey;
448
46
        CKeyID key_id;
449
46
        std::copy(first, last, key_id.begin());
450
46
        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
46
    }
454
455
    //! Conversion to raw public key.
456
324
    std::vector<unsigned char> ToPKBytes(const Key& key) const { return {key.begin(), key.end()}; }
Satisfier<XOnlyPubKey>::ToPKBytes(XOnlyPubKey const&) const
Line
Count
Source
456
279
    std::vector<unsigned char> ToPKBytes(const Key& key) const { return {key.begin(), key.end()}; }
Satisfier<CPubKey>::ToPKBytes(CPubKey const&) const
Line
Count
Source
456
45
    std::vector<unsigned char> ToPKBytes(const Key& key) const { return {key.begin(), key.end()}; }
457
458
    //! Time lock satisfactions.
459
1.00k
    bool CheckAfter(uint32_t value) const { return m_creator.Checker().CheckLockTime(CScriptNum(value)); }
Satisfier<XOnlyPubKey>::CheckAfter(unsigned int) const
Line
Count
Source
459
758
    bool CheckAfter(uint32_t value) const { return m_creator.Checker().CheckLockTime(CScriptNum(value)); }
Satisfier<CPubKey>::CheckAfter(unsigned int) const
Line
Count
Source
459
242
    bool CheckAfter(uint32_t value) const { return m_creator.Checker().CheckLockTime(CScriptNum(value)); }
460
92
    bool CheckOlder(uint32_t value) const { return m_creator.Checker().CheckSequence(CScriptNum(value)); }
Satisfier<XOnlyPubKey>::CheckOlder(unsigned int) const
Line
Count
Source
460
42
    bool CheckOlder(uint32_t value) const { return m_creator.Checker().CheckSequence(CScriptNum(value)); }
Satisfier<CPubKey>::CheckOlder(unsigned int) const
Line
Count
Source
460
50
    bool CheckOlder(uint32_t value) const { return m_creator.Checker().CheckSequence(CScriptNum(value)); }
461
462
    //! Hash preimage satisfactions.
463
16
    miniscript::Availability SatSHA256(const std::vector<unsigned char>& hash, std::vector<unsigned char>& preimage) const {
464
16
        return MsLookupHelper(m_sig_data.sha256_preimages, hash, preimage);
465
16
    }
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
16
    miniscript::Availability SatSHA256(const std::vector<unsigned char>& hash, std::vector<unsigned char>& preimage) const {
464
16
        return MsLookupHelper(m_sig_data.sha256_preimages, hash, preimage);
465
16
    }
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
4.30M
    miniscript::MiniscriptContext MsContext() const {
477
4.30M
        return m_script_ctx;
478
4.30M
    }
Satisfier<XOnlyPubKey>::MsContext() const
Line
Count
Source
476
4.29M
    miniscript::MiniscriptContext MsContext() const {
477
4.29M
        return m_script_ctx;
478
4.29M
    }
Satisfier<CPubKey>::MsContext() const
Line
Count
Source
476
3.16k
    miniscript::MiniscriptContext MsContext() const {
477
3.16k
        return m_script_ctx;
478
3.16k
    }
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
201
                          : Satisfier(provider, sig_data, creator, witscript, miniscript::MiniscriptContext::P2WSH) {}
486
487
    //! Conversion from a raw compressed public key.
488
    template <typename I>
489
481
    std::optional<CPubKey> FromPKBytes(I first, I last) const {
490
481
        CPubKey pubkey{first, last};
491
481
        if (pubkey.IsValid()) return pubkey;
492
1
        return {};
493
481
    }
494
495
    //! Conversion from a raw compressed public key hash.
496
    template<typename I>
497
46
    std::optional<CPubKey> FromPKHBytes(I first, I last) const {
498
46
        return Satisfier::CPubFromPKHBytes(first, last);
499
46
    }
500
501
    //! Satisfy an ECDSA signature check.
502
525
    miniscript::Availability Sign(const CPubKey& key, std::vector<unsigned char>& sig) const {
503
525
        if (CreateSig(m_creator, m_sig_data, m_provider, sig, key, m_witness_script, SigVersion::WITNESS_V0)) {
504
249
            return miniscript::Availability::YES;
505
249
        }
506
276
        return miniscript::Availability::NO;
507
525
    }
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.17k
                          : Satisfier(provider, sig_data, creator, script, miniscript::MiniscriptContext::TAPSCRIPT),
518
4.17k
                            m_leaf_hash(leaf_hash) {}
519
520
    //! Conversion from a raw xonly public key.
521
    template <typename I>
522
93.7k
    std::optional<XOnlyPubKey> FromPKBytes(I first, I last) const {
523
93.7k
        if (last - first != 32) return {};
524
93.7k
        XOnlyPubKey pubkey;
525
93.7k
        std::copy(first, last, pubkey.begin());
526
93.7k
        return pubkey;
527
93.7k
    }
528
529
    //! Conversion from a raw xonly public key hash.
530
    template<typename I>
531
279
    std::optional<XOnlyPubKey> FromPKHBytes(I first, I last) const {
532
279
        if (auto pubkey = Satisfier::CPubFromPKHBytes(first, last)) return XOnlyPubKey{*pubkey};
533
0
        return {};
534
279
    }
535
536
    //! Satisfy a BIP340 signature check.
537
94.0k
    miniscript::Availability Sign(const XOnlyPubKey& key, std::vector<unsigned char>& sig) const {
538
94.0k
        if (CreateTaprootScriptSig(m_creator, m_sig_data, m_provider, sig, key, m_leaf_hash, SigVersion::TAPSCRIPT)) {
539
1.01k
            return miniscript::Availability::YES;
540
1.01k
        }
541
92.9k
        return miniscript::Availability::NO;
542
94.0k
    }
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.17k
{
547
    // Only BIP342 tapscript signing is supported for now.
548
4.17k
    if (leaf_version != TAPROOT_LEAF_TAPSCRIPT) return false;
549
550
4.17k
    uint256 leaf_hash = ComputeTapleafHash(leaf_version, script_bytes);
551
4.17k
    CScript script = CScript(script_bytes.begin(), script_bytes.end());
552
553
4.17k
    TapSatisfier ms_satisfier{provider, sigdata, creator, script, leaf_hash};
554
4.17k
    const auto ms = miniscript::FromScript(script, ms_satisfier);
555
4.17k
    return ms && ms->Satisfy(ms_satisfier, result) == miniscript::Availability::YES;
556
4.17k
}
557
558
static bool SignTaproot(const SigningProvider& provider, const BaseSignatureCreator& creator, const WitnessV1Taproot& output, SignatureData& sigdata, std::vector<valtype>& result)
559
7.90k
{
560
7.90k
    TaprootSpendData spenddata;
561
7.90k
    TaprootBuilder builder;
562
563
    // Gather information about this output.
564
7.90k
    if (provider.GetTaprootSpendData(output, spenddata)) {
565
1.45k
        sigdata.tr_spenddata.Merge(spenddata);
566
1.45k
    }
567
7.90k
    if (provider.GetTaprootBuilder(output, builder)) {
568
1.45k
        sigdata.tr_builder = builder;
569
1.45k
    }
570
7.90k
    if (auto agg_keys = provider.GetAllMuSig2ParticipantPubkeys(); !agg_keys.empty()) {
571
506
        sigdata.musig2_pubkeys.insert(agg_keys.begin(), agg_keys.end());
572
506
    }
573
574
575
    // Try key path spending.
576
7.90k
    {
577
7.90k
        KeyOriginInfo internal_key_info;
578
7.90k
        if (provider.GetKeyOriginByXOnly(sigdata.tr_spenddata.internal_key, internal_key_info)) {
579
1.50k
            auto it = sigdata.taproot_misc_pubkeys.find(sigdata.tr_spenddata.internal_key);
580
1.50k
            if (it == sigdata.taproot_misc_pubkeys.end()) {
581
795
                sigdata.taproot_misc_pubkeys.emplace(sigdata.tr_spenddata.internal_key, std::make_pair(std::set<uint256>(), internal_key_info));
582
795
            }
583
1.50k
        }
584
585
7.90k
        KeyOriginInfo output_key_info;
586
7.90k
        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
46
                sigdata.taproot_misc_pubkeys.emplace(output, std::make_pair(std::set<uint256>(), output_key_info));
590
46
            }
591
144
        }
592
593
14.8k
        auto make_keypath_sig = [&](const XOnlyPubKey& pk, const uint256* merkle_root) {
594
14.8k
            std::vector<unsigned char> sig;
595
14.8k
            if (creator.CreateSchnorrSig(provider, sig, pk, nullptr, merkle_root, SigVersion::TAPROOT)) {
596
568
                sigdata.taproot_key_path_sig = sig;
597
14.2k
            } else {
598
14.2k
                SignMuSig2(creator, sigdata, provider, sig, pk, merkle_root, /*leaf_hash=*/nullptr, SigVersion::TAPROOT);
599
14.2k
            }
600
14.8k
        };
601
602
        // First try signing with internal key
603
7.90k
        if (sigdata.taproot_key_path_sig.size() == 0) {
604
7.69k
            make_keypath_sig(sigdata.tr_spenddata.internal_key, &sigdata.tr_spenddata.merkle_root);
605
7.69k
        }
606
        // Try signing with output key if still no signature
607
7.90k
        if (sigdata.taproot_key_path_sig.size() == 0) {
608
7.15k
            make_keypath_sig(output, nullptr);
609
7.15k
        }
610
7.90k
        if (sigdata.taproot_key_path_sig.size()) {
611
808
            result = Vector(sigdata.taproot_key_path_sig);
612
808
            return true;
613
808
        }
614
7.90k
    }
615
616
    // Try script path spending.
617
7.10k
    std::vector<std::vector<unsigned char>> smallest_result_stack;
618
7.10k
    for (const auto& [key, control_blocks] : sigdata.tr_spenddata.scripts) {
619
4.17k
        const auto& [script, leaf_ver] = key;
620
4.17k
        std::vector<std::vector<unsigned char>> result_stack;
621
4.17k
        if (SignTaprootScript(provider, creator, sigdata, leaf_ver, script, result_stack)) {
622
666
            result_stack.emplace_back(std::begin(script), std::end(script)); // Push the script
623
666
            result_stack.push_back(*control_blocks.begin()); // Push the smallest control block
624
666
            if (smallest_result_stack.size() == 0 ||
625
666
                GetSerializeSize(result_stack) < GetSerializeSize(smallest_result_stack)) {
626
656
                smallest_result_stack = std::move(result_stack);
627
656
            }
628
666
        }
629
4.17k
    }
630
7.10k
    if (smallest_result_stack.size() != 0) {
631
640
        result = std::move(smallest_result_stack);
632
640
        return true;
633
640
    }
634
635
6.46k
    return false;
636
7.10k
}
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
113k
{
647
113k
    CScript scriptRet;
648
113k
    ret.clear();
649
113k
    std::vector<unsigned char> sig;
650
651
113k
    std::vector<valtype> vSolutions;
652
113k
    whichTypeRet = Solver(scriptPubKey, vSolutions);
653
654
113k
    switch (whichTypeRet) {
655
185
    case TxoutType::NONSTANDARD:
656
185
    case TxoutType::NULL_DATA:
657
185
    case TxoutType::WITNESS_UNKNOWN:
658
185
        return false;
659
265
    case TxoutType::PUBKEY:
660
265
        if (!CreateSig(creator, sigdata, provider, sig, CPubKey(vSolutions[0]), scriptPubKey, sigversion)) return false;
661
177
        ret.push_back(std::move(sig));
662
177
        return true;
663
58.7k
    case TxoutType::PUBKEYHASH: {
664
58.7k
        CKeyID keyID = CKeyID(uint160(vSolutions[0]));
665
58.7k
        CPubKey pubkey;
666
58.7k
        if (!GetPubKey(provider, sigdata, keyID, pubkey)) {
667
            // Pubkey could not be found, add to missing
668
29.4k
            sigdata.missing_pubkeys.push_back(keyID);
669
29.4k
            return false;
670
29.4k
        }
671
29.2k
        if (!CreateSig(creator, sigdata, provider, sig, pubkey, scriptPubKey, sigversion)) return false;
672
15.2k
        ret.push_back(std::move(sig));
673
15.2k
        ret.push_back(ToByteVector(pubkey));
674
15.2k
        return true;
675
29.2k
    }
676
6.64k
    case TxoutType::SCRIPTHASH: {
677
6.64k
        uint160 h160{vSolutions[0]};
678
6.64k
        if (GetCScript(provider, sigdata, CScriptID{h160}, scriptRet)) {
679
5.24k
            ret.emplace_back(scriptRet.begin(), scriptRet.end());
680
5.24k
            return true;
681
5.24k
        }
682
        // Could not find redeemScript, add to missing
683
1.40k
        sigdata.missing_redeem_script = h160;
684
1.40k
        return false;
685
6.64k
    }
686
480
    case TxoutType::MULTISIG: {
687
480
        size_t required = vSolutions.front()[0];
688
480
        ret.emplace_back(); // workaround CHECKMULTISIG bug
689
2.58k
        for (size_t i = 1; i < vSolutions.size() - 1; ++i) {
690
2.10k
            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.10k
            if (CreateSig(creator, sigdata, provider, sig, pubkey, scriptPubKey, sigversion)) {
695
1.23k
                if (ret.size() < required + 1) {
696
1.19k
                    ret.push_back(std::move(sig));
697
1.19k
                }
698
1.23k
            }
699
2.10k
        }
700
480
        bool ok = ret.size() == required + 1;
701
830
        for (size_t i = 0; i + ret.size() < required + 1; ++i) {
702
350
            ret.emplace_back();
703
350
        }
704
480
        return ok;
705
6.64k
    }
706
37.9k
    case TxoutType::WITNESS_V0_KEYHASH:
707
37.9k
        ret.push_back(vSolutions[0]);
708
37.9k
        return true;
709
710
1.02k
    case TxoutType::WITNESS_V0_SCRIPTHASH:
711
1.02k
        if (GetCScript(provider, sigdata, CScriptID{RIPEMD160(vSolutions[0])}, scriptRet)) {
712
799
            ret.emplace_back(scriptRet.begin(), scriptRet.end());
713
799
            return true;
714
799
        }
715
        // Could not find witnessScript, add to missing
716
226
        sigdata.missing_witness_script = uint256(vSolutions[0]);
717
226
        return false;
718
719
7.90k
    case TxoutType::WITNESS_V1_TAPROOT:
720
7.90k
        return SignTaproot(provider, creator, WitnessV1Taproot(XOnlyPubKey{vSolutions[0]}), sigdata, ret);
721
722
1
    case TxoutType::ANCHOR:
723
1
        return true;
724
113k
    } // no default case, so the compiler can warn about missing cases
725
113k
    assert(false);
726
0
}
727
728
static CScript PushAll(const std::vector<valtype>& values)
729
69.4k
{
730
69.4k
    CScript result;
731
69.4k
    for (const valtype& v : values) {
732
17.1k
        if (v.size() == 0) {
733
241
            result << OP_0;
734
16.9k
        } else if (v.size() == 1 && v[0] >= 1 && v[0] <= 16) {
735
0
            result << CScript::EncodeOP_N(v[0]);
736
16.9k
        } else if (v.size() == 1 && v[0] == 0x81) {
737
0
            result << OP_1NEGATE;
738
16.9k
        } else {
739
16.9k
            result << v;
740
16.9k
        }
741
17.1k
    }
742
69.4k
    return result;
743
69.4k
}
744
745
bool ProduceSignature(const SigningProvider& provider, const BaseSignatureCreator& creator, const CScript& fromPubKey, SignatureData& sigdata)
746
72.3k
{
747
72.3k
    if (sigdata.complete) return true;
748
749
69.4k
    std::vector<valtype> result;
750
69.4k
    TxoutType whichType;
751
69.4k
    bool solved = SignStep(provider, creator, fromPubKey, result, whichType, SigVersion::BASE, sigdata);
752
69.4k
    bool P2SH = false;
753
69.4k
    CScript subscript;
754
755
69.4k
    if (solved && whichType == TxoutType::SCRIPTHASH)
756
5.24k
    {
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.24k
        subscript = CScript(result[0].begin(), result[0].end());
761
5.24k
        sigdata.redeem_script = subscript;
762
5.24k
        solved = solved && SignStep(provider, creator, subscript, result, whichType, SigVersion::BASE, sigdata) && whichType != TxoutType::SCRIPTHASH;
763
5.24k
        P2SH = true;
764
5.24k
    }
765
766
69.4k
    if (solved && whichType == TxoutType::WITNESS_V0_KEYHASH)
767
37.7k
    {
768
37.7k
        CScript witnessscript;
769
37.7k
        witnessscript << OP_DUP << OP_HASH160 << ToByteVector(result[0]) << OP_EQUALVERIFY << OP_CHECKSIG;
770
37.7k
        TxoutType subType;
771
37.7k
        solved = solved && SignStep(provider, creator, witnessscript, result, subType, SigVersion::WITNESS_V0, sigdata);
772
37.7k
        sigdata.scriptWitness.stack = result;
773
37.7k
        sigdata.witness = true;
774
37.7k
        result.clear();
775
37.7k
    }
776
31.7k
    else if (solved && whichType == TxoutType::WITNESS_V0_SCRIPTHASH)
777
789
    {
778
789
        CScript witnessscript(result[0].begin(), result[0].end());
779
789
        sigdata.witness_script = witnessscript;
780
781
789
        TxoutType subType{TxoutType::NONSTANDARD};
782
789
        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
789
        if (!solved && result.empty()) {
789
201
            WshSatisfier ms_satisfier{provider, sigdata, creator, witnessscript};
790
201
            const auto ms = miniscript::FromScript(witnessscript, ms_satisfier);
791
201
            solved = ms && ms->Satisfy(ms_satisfier, result) == miniscript::Availability::YES;
792
201
        }
793
789
        result.emplace_back(witnessscript.begin(), witnessscript.end());
794
795
789
        sigdata.scriptWitness.stack = result;
796
789
        sigdata.witness = true;
797
789
        result.clear();
798
30.9k
    } else if (whichType == TxoutType::WITNESS_V1_TAPROOT && !P2SH) {
799
7.90k
        sigdata.witness = true;
800
7.90k
        if (solved) {
801
1.44k
            sigdata.scriptWitness.stack = std::move(result);
802
1.44k
        }
803
7.90k
        result.clear();
804
23.0k
    } else if (solved && whichType == TxoutType::WITNESS_UNKNOWN) {
805
0
        sigdata.witness = true;
806
0
    }
807
808
69.4k
    if (!sigdata.witness) sigdata.scriptWitness.stack.clear();
809
69.4k
    if (P2SH) {
810
5.24k
        result.emplace_back(subscript.begin(), subscript.end());
811
5.24k
    }
812
69.4k
    sigdata.scriptSig = PushAll(result);
813
814
    // Test solution
815
69.4k
    sigdata.complete = solved && VerifyScript(sigdata.scriptSig, fromPubKey, &sigdata.scriptWitness, STANDARD_SCRIPT_VERIFY_FLAGS, creator.Checker());
816
69.4k
    return sigdata.complete;
817
72.3k
}
818
819
namespace {
820
class SignatureExtractorChecker final : public DeferringSignatureChecker
821
{
822
private:
823
    SignatureData& sigdata;
824
825
public:
826
42.6k
    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.88k
    {
830
3.88k
        if (m_checker.CheckECDSASignature(scriptSig, vchPubKey, scriptCode, sigversion)) {
831
3.09k
            CPubKey pubkey(vchPubKey);
832
3.09k
            sigdata.signatures.emplace(pubkey.GetID(), SigPair(pubkey, scriptSig));
833
3.09k
            return true;
834
3.09k
        }
835
796
        return false;
836
3.88k
    }
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
42.6k
    explicit Stacks(const SignatureData& data) : witness(data.scriptWitness.stack) {
847
42.6k
        EvalScript(script, data.scriptSig, SCRIPT_VERIFY_STRICTENC, BaseSignatureChecker(), SigVersion::BASE);
848
42.6k
    }
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
42.6k
{
855
42.6k
    SignatureData data;
856
42.6k
    assert(tx.vin.size() > nIn);
857
42.6k
    data.scriptSig = tx.vin[nIn].scriptSig;
858
42.6k
    data.scriptWitness = tx.vin[nIn].scriptWitness;
859
42.6k
    Stacks stack(data);
860
861
    // Get signatures
862
42.6k
    MutableTransactionSignatureChecker tx_checker(&tx, nIn, txout.nValue, MissingDataBehavior::FAIL);
863
42.6k
    SignatureExtractorChecker extractor_checker(data, tx_checker);
864
42.6k
    if (VerifyScript(data.scriptSig, txout.scriptPubKey, &data.scriptWitness, STANDARD_SCRIPT_VERIFY_FLAGS, extractor_checker)) {
865
2.96k
        data.complete = true;
866
2.96k
        return data;
867
2.96k
    }
868
869
    // Get scripts
870
39.6k
    std::vector<std::vector<unsigned char>> solutions;
871
39.6k
    TxoutType script_type = Solver(txout.scriptPubKey, solutions);
872
39.6k
    SigVersion sigversion = SigVersion::BASE;
873
39.6k
    CScript next_script = txout.scriptPubKey;
874
875
39.6k
    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
39.6k
    if (script_type == TxoutType::WITNESS_V0_SCRIPTHASH && !stack.witness.empty() && !stack.witness.back().empty()) {
886
        // Get the witnessScript
887
47
        CScript witness_script(stack.witness.back().begin(), stack.witness.back().end());
888
47
        data.witness_script = witness_script;
889
47
        next_script = std::move(witness_script);
890
891
        // Get witnessScript type
892
47
        script_type = Solver(next_script, solutions);
893
47
        stack.witness.pop_back();
894
47
        stack.script = std::move(stack.witness);
895
47
        stack.witness.clear();
896
47
        sigversion = SigVersion::WITNESS_V0;
897
47
    }
898
39.6k
    if (script_type == TxoutType::MULTISIG && !stack.script.empty()) {
899
        // Build a map of pubkey -> signature by matching sigs to pubkeys:
900
63
        assert(solutions.size() > 1);
901
63
        unsigned int num_pubkeys = solutions.size()-2;
902
63
        unsigned int last_success_key = 0;
903
330
        for (const valtype& sig : stack.script) {
904
1.00k
            for (unsigned int i = last_success_key; i < num_pubkeys; ++i) {
905
834
                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
834
                if (data.signatures.contains(CPubKey(pubkey).GetID()) || extractor_checker.CheckECDSASignature(sig, pubkey, next_script, sigversion)) {
908
160
                    last_success_key = i + 1;
909
160
                    break;
910
160
                }
911
834
            }
912
330
        }
913
63
    }
914
915
39.6k
    return data;
916
39.6k
}
917
918
void UpdateInput(CTxIn& input, const SignatureData& data)
919
47.2k
{
920
47.2k
    input.scriptSig = data.scriptSig;
921
47.2k
    input.scriptWitness = data.scriptWitness;
922
47.2k
}
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.49k
    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
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; }
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
2.99k
    DummySignatureCreator(char r_len, char s_len) : m_r_len(r_len), m_s_len(s_len) {}
962
7
    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
3
    {
980
3
        sig.assign(64, '\000');
981
3
        return true;
982
3
    }
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
0
{
1008
0
    int version;
1009
0
    valtype program;
1010
0
    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
16.7k
{
1027
16.7k
    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
16.7k
    const CTransaction txConst(mtx);
1032
1033
16.7k
    PrecomputedTransactionData txdata;
1034
16.7k
    std::vector<CTxOut> spent_outputs;
1035
59.3k
    for (unsigned int i = 0; i < mtx.vin.size(); ++i) {
1036
42.6k
        CTxIn& txin = mtx.vin[i];
1037
42.6k
        auto coin = coins.find(txin.prevout);
1038
42.6k
        if (coin == coins.end() || coin->second.IsSpent()) {
1039
10
            txdata.Init(txConst, /*spent_outputs=*/{}, /*force=*/true);
1040
10
            break;
1041
42.5k
        } else {
1042
42.5k
            spent_outputs.emplace_back(coin->second.out.nValue, coin->second.out.scriptPubKey);
1043
42.5k
        }
1044
42.6k
    }
1045
16.7k
    if (spent_outputs.size() == mtx.vin.size()) {
1046
16.7k
        txdata.Init(txConst, std::move(spent_outputs), true);
1047
16.7k
    }
1048
1049
    // Sign what we can:
1050
59.3k
    for (unsigned int i = 0; i < mtx.vin.size(); ++i) {
1051
42.6k
        CTxIn& txin = mtx.vin[i];
1052
42.6k
        auto coin = coins.find(txin.prevout);
1053
42.6k
        if (coin == coins.end() || coin->second.IsSpent()) {
1054
19
            input_errors[i] = _("Input not found or already spent");
1055
19
            continue;
1056
19
        }
1057
42.5k
        const CScript& prevPubKey = coin->second.out.scriptPubKey;
1058
42.5k
        const CAmount& amount = coin->second.out.nValue;
1059
1060
42.5k
        SignatureData sigdata = DataFromTransaction(mtx, i, coin->second.out);
1061
        // Only sign SIGHASH_SINGLE if there's a corresponding output:
1062
42.5k
        if (!fHashSingle || (i < mtx.vout.size())) {
1063
42.5k
            ProduceSignature(*keystore, MutableTransactionSignatureCreator(mtx, i, amount, &txdata, options), prevPubKey, sigdata);
1064
42.5k
        }
1065
1066
42.5k
        UpdateInput(txin, sigdata);
1067
1068
        // amount must be specified for valid segwit signature
1069
42.5k
        if (amount == MAX_MONEY && !txin.scriptWitness.IsNull()) {
1070
15
            input_errors[i] = _("Missing amount");
1071
15
            continue;
1072
15
        }
1073
1074
42.5k
        ScriptError serror = SCRIPT_ERR_OK;
1075
42.5k
        if (!sigdata.complete && !VerifyScript(txin.scriptSig, prevPubKey, &txin.scriptWitness, STANDARD_SCRIPT_VERIFY_FLAGS, TransactionSignatureChecker(&txConst, i, amount, txdata, MissingDataBehavior::FAIL), &serror)) {
1076
29.7k
            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.6k
            } else if (serror == SCRIPT_ERR_SIG_NULLFAIL) {
1080
                // Verification failed (possibly due to insufficient signatures).
1081
81
                input_errors[i] = Untranslated("CHECK(MULTI)SIG failing with non-zero signature (possibly need more signatures)");
1082
17.5k
            } else {
1083
17.5k
                input_errors[i] = Untranslated(ScriptErrorString(serror));
1084
17.5k
            }
1085
29.7k
        } else {
1086
            // If this input succeeds, make sure there is no error set for it
1087
12.8k
            input_errors.erase(i);
1088
12.8k
        }
1089
42.5k
    }
1090
16.7k
    return input_errors.empty();
1091
16.7k
}