Coverage Report

Created: 2026-05-30 09:47

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/tmp/bitcoin/src/wallet/external_signer_scriptpubkeyman.cpp
Line
Count
Source
1
// Copyright (c) 2020-present The Bitcoin Core developers
2
// Distributed under the MIT software license, see the accompanying
3
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
4
5
#include <chainparams.h>
6
#include <common/args.h>
7
#include <common/system.h>
8
#include <external_signer.h>
9
#include <node/types.h>
10
#include <wallet/external_signer_scriptpubkeyman.h>
11
12
#include <iostream>
13
#include <key_io.h>
14
#include <memory>
15
#include <stdexcept>
16
#include <string>
17
#include <univalue.h>
18
#include <utility>
19
#include <vector>
20
21
using common::PSBTError;
22
23
namespace wallet {
24
std::unique_ptr<ExternalSignerScriptPubKeyMan> ExternalSignerScriptPubKeyMan::LoadFromStorage(WalletStorage& storage, WalletDescriptor& descriptor, int64_t keypool_size, const KeyMap& keys, const CryptedKeyMap& ckeys)
25
8
{
26
8
    return std::unique_ptr<ExternalSignerScriptPubKeyMan>(new ExternalSignerScriptPubKeyMan(storage, descriptor, keypool_size, keys, ckeys));
27
8
}
28
29
std::unique_ptr<ExternalSignerScriptPubKeyMan> ExternalSignerScriptPubKeyMan::CreateNew(WalletStorage& storage, WalletBatch& batch, int64_t keypool_size, std::unique_ptr<Descriptor> desc)
30
16
{
31
16
    auto spkm = std::unique_ptr<ExternalSignerScriptPubKeyMan>(new ExternalSignerScriptPubKeyMan(storage, keypool_size));
32
33
16
    LOCK(spkm->cs_desc_man);
34
16
    assert(storage.IsWalletFlagSet(WALLET_FLAG_DESCRIPTORS));
35
16
    assert(storage.IsWalletFlagSet(WALLET_FLAG_EXTERNAL_SIGNER));
36
37
16
    int64_t creation_time = GetTime();
38
39
    // Make the descriptor
40
16
    WalletDescriptor w_desc(std::move(desc), creation_time, 0, 0, 0);
41
16
    spkm->m_wallet_descriptor = w_desc;
42
43
    // Store the descriptor
44
16
    if (!batch.WriteDescriptor(spkm->GetID(), spkm->m_wallet_descriptor)) {
45
0
        throw std::runtime_error(std::string(__func__) + ": writing descriptor failed");
46
0
    }
47
48
    // TopUp
49
16
    spkm->TopUpWithDB(batch);
50
51
16
    storage.UnsetBlankWalletFlag(batch);
52
16
    return spkm;
53
16
}
54
55
14
 util::Result<ExternalSigner> ExternalSignerScriptPubKeyMan::GetExternalSigner() {
56
14
    const std::string command = gArgs.GetArg("-signer", "");
57
14
    if (command == "") return util::Error{Untranslated("restart bitcoind with -signer=<cmd>")};
58
14
    std::vector<ExternalSigner> signers;
59
14
    ExternalSigner::Enumerate(command, signers, Params().GetChainTypeString());
60
14
    if (signers.empty()) return util::Error{Untranslated("No external signers found")};
61
    // TODO: add fingerprint argument instead of failing in case of multiple signers.
62
13
    if (signers.size() > 1) return util::Error{Untranslated("More than one external signer found. Please connect only one at a time.")};
63
12
    return signers[0];
64
13
}
65
66
util::Result<void> ExternalSignerScriptPubKeyMan::DisplayAddress(const CTxDestination& dest, const ExternalSigner &signer) const
67
4
{
68
    // TODO: avoid the need to infer a descriptor from inside a descriptor wallet
69
4
    const CScript& scriptPubKey = GetScriptForDestination(dest);
70
4
    auto provider = GetSolvingProvider(scriptPubKey);
71
4
    auto descriptor = InferDescriptor(scriptPubKey, *provider);
72
73
4
    const UniValue& result = signer.DisplayAddress(descriptor->ToString());
74
75
4
    const UniValue& error = result.find_value("error");
76
4
    if (error.isStr()) return util::Error{strprintf(_("Signer returned error: %s"), error.getValStr())};
77
78
4
    const UniValue& ret_address = result.find_value("address");
79
4
    if (!ret_address.isStr()) return util::Error{_("Signer did not echo address")};
80
81
4
    if (ret_address.getValStr() != EncodeDestination(dest)) {
82
1
        return util::Error{strprintf(_("Signer echoed unexpected address %s"), ret_address.getValStr())};
83
1
    }
84
85
3
    return util::Result<void>();
86
4
}
87
88
// If sign is true, transaction must previously have been filled
89
std::optional<PSBTError> ExternalSignerScriptPubKeyMan::FillPSBT(PartiallySignedTransaction& psbt, const PrecomputedTransactionData& txdata, const common::PSBTFillOptions& options, int* n_signed) const
90
57
{
91
57
    if (!options.sign) {
92
32
        return DescriptorScriptPubKeyMan::FillPSBT(psbt, txdata, options, n_signed);
93
32
    }
94
95
    // Already complete if every input is now signed
96
25
    bool complete = true;
97
25
    for (const auto& input : psbt.inputs) {
98
25
        complete &= PSBTInputSigned(input);
99
25
    }
100
25
    if (complete) return {};
101
102
4
    auto signer{GetExternalSigner()};
103
4
    if (!signer) {
104
1
        LogWarning("%s", util::ErrorString(signer).original);
105
1
        return PSBTError::EXTERNAL_SIGNER_NOT_FOUND;
106
1
    }
107
108
3
    std::string failure_reason;
109
3
    if(!signer->SignTransaction(psbt, failure_reason)) {
110
0
        LogWarning("Failed to sign: %s\n", failure_reason);
111
0
        return PSBTError::EXTERNAL_SIGNER_FAILED;
112
0
    }
113
3
    if (options.finalize) FinalizePSBT(psbt); // This won't work in a multisig setup
114
3
    return {};
115
3
}
116
} // namespace wallet