Bitcoin Core  24.99.0
P2P Digital Currency
external_signer_scriptpubkeyman.cpp
Go to the documentation of this file.
1 // Copyright (c) 2020-2021 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 <external_signer.h>
8 
9 #include <iostream>
10 #include <memory>
11 #include <stdexcept>
12 #include <string>
13 #include <utility>
14 #include <vector>
15 
16 namespace wallet {
17 bool ExternalSignerScriptPubKeyMan::SetupDescriptor(std::unique_ptr<Descriptor> desc)
18 {
22 
23  int64_t creation_time = GetTime();
24 
25  // Make the descriptor
26  WalletDescriptor w_desc(std::move(desc), creation_time, 0, 0, 0);
27  m_wallet_descriptor = w_desc;
28 
29  // Store the descriptor
31  if (!batch.WriteDescriptor(GetID(), m_wallet_descriptor)) {
32  throw std::runtime_error(std::string(__func__) + ": writing descriptor failed");
33  }
34 
35  // TopUp
36  TopUp();
37 
39  return true;
40 }
41 
43  const std::string command = gArgs.GetArg("-signer", "");
44  if (command == "") throw std::runtime_error(std::string(__func__) + ": restart bitcoind with -signer=<cmd>");
45  std::vector<ExternalSigner> signers;
46  ExternalSigner::Enumerate(command, signers, Params().NetworkIDString());
47  if (signers.empty()) throw std::runtime_error(std::string(__func__) + ": No external signers found");
48  // TODO: add fingerprint argument instead of failing in case of multiple signers.
49  if (signers.size() > 1) throw std::runtime_error(std::string(__func__) + ": More than one external signer found. Please connect only one at a time.");
50  return signers[0];
51 }
52 
53 bool ExternalSignerScriptPubKeyMan::DisplayAddress(const CScript scriptPubKey, const ExternalSigner &signer) const
54 {
55  // TODO: avoid the need to infer a descriptor from inside a descriptor wallet
56  auto provider = GetSolvingProvider(scriptPubKey);
57  auto descriptor = InferDescriptor(scriptPubKey, *provider);
58 
59  signer.DisplayAddress(descriptor->ToString());
60  // TODO inspect result
61  return true;
62 }
63 
64 // If sign is true, transaction must previously have been filled
65 TransactionError ExternalSignerScriptPubKeyMan::FillPSBT(PartiallySignedTransaction& psbt, const PrecomputedTransactionData& txdata, int sighash_type, bool sign, bool bip32derivs, int* n_signed, bool finalize) const
66 {
67  if (!sign) {
68  return DescriptorScriptPubKeyMan::FillPSBT(psbt, txdata, sighash_type, false, bip32derivs, n_signed, finalize);
69  }
70 
71  // Already complete if every input is now signed
72  bool complete = true;
73  for (const auto& input : psbt.inputs) {
74  // TODO: for multisig wallets, we should only care if all _our_ inputs are signed
75  complete &= PSBTInputSigned(input);
76  }
77  if (complete) return TransactionError::OK;
78 
79  std::string strFailReason;
80  if(!GetExternalSigner().SignTransaction(psbt, strFailReason)) {
81  tfm::format(std::cerr, "Failed to sign: %s\n", strFailReason);
83  }
84  if (finalize) FinalizePSBT(psbt); // This won't work in a multisig setup
85  return TransactionError::OK;
86 }
87 } // namespace wallet
const auto command
const CChainParams & Params()
Return the currently selected parameters.
std::string GetArg(const std::string &strArg, const std::string &strDefault) const
Return string argument or default value.
Definition: system.cpp:604
Serialized script, used inside transaction inputs and outputs.
Definition: script.h:411
Enables interaction with an external signing device or service, such as a hardware wallet.
UniValue DisplayAddress(const std::string &descriptor) const
Display address on the device.
static bool Enumerate(const std::string &command, std::vector< ExternalSigner > &signers, const std::string chain)
Obtain a list of signers.
bool SignTransaction(CMutableTransaction &tx, const std::map< COutPoint, Coin > &coins, int sighash, std::map< int, bilingual_str > &input_errors) const override
Creates new signatures and adds them to the transaction.
bool TopUp(unsigned int size=0) override
Fills internal address pool.
std::unique_ptr< SigningProvider > GetSolvingProvider(const CScript &script) const override
TransactionError FillPSBT(PartiallySignedTransaction &psbt, const PrecomputedTransactionData &txdata, int sighash_type=SIGHASH_DEFAULT, bool sign=true, bool bip32derivs=false, int *n_signed=nullptr, bool finalize=true) const override
Adds script and derivation path information to a PSBT, and optionally signs it.
TransactionError FillPSBT(PartiallySignedTransaction &psbt, const PrecomputedTransactionData &txdata, int sighash_type=1, bool sign=true, bool bip32derivs=false, int *n_signed=nullptr, bool finalize=true) const override
Adds script and derivation path information to a PSBT, and optionally signs it.
bool SetupDescriptor(std::unique_ptr< Descriptor >desc)
Provide a descriptor at setup time Returns false if already setup or setup fails, true if setup is su...
bool DisplayAddress(const CScript scriptPubKey, const ExternalSigner &signer) const
WalletStorage & m_storage
Access to the wallet database.
Definition: walletdb.h:188
bool WriteDescriptor(const uint256 &desc_id, const WalletDescriptor &descriptor)
Definition: walletdb.cpp:242
Descriptor with some wallet metadata.
Definition: walletutil.h:77
virtual bool IsWalletFlagSet(uint64_t) const =0
virtual WalletDatabase & GetDatabase() const =0
virtual void UnsetBlankWalletFlag(WalletBatch &)=0
std::unique_ptr< Descriptor > InferDescriptor(const CScript &script, const SigningProvider &provider)
Find a descriptor for the specified script, using information from provider where possible.
TransactionError
Definition: error.h:22
void format(std::ostream &out, const char *fmt, const Args &... args)
Format list of arguments to the stream according to given format string.
Definition: tinyformat.h:1062
Definition: node.h:39
@ WALLET_FLAG_EXTERNAL_SIGNER
Indicates that the wallet needs an external signer.
Definition: walletutil.h:69
@ WALLET_FLAG_DESCRIPTORS
Indicate that this wallet supports DescriptorScriptPubKeyMan.
Definition: walletutil.h:66
bool PSBTInputSigned(const PSBTInput &input)
Checks whether a PSBTInput is already signed.
Definition: psbt.cpp:270
bool FinalizePSBT(PartiallySignedTransaction &psbtx)
Finalizes a PSBT if possible, combining partial signatures.
Definition: psbt.cpp:396
A version of CTransaction with the PSBT format.
Definition: psbt.h:952
std::vector< PSBTInput > inputs
Definition: psbt.h:957
#define LOCK(cs)
Definition: sync.h:261
int64_t GetTime()
Definition: time.cpp:117
ArgsManager gArgs
Definition: system.cpp:86
assert(!tx.IsCoinBase())