mirror of https://github.com/bitcoin/bitcoin
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
67 lines
2.7 KiB
67 lines
2.7 KiB
// Copyright (c) 2018-2021 The Bitcoin Core developers
|
|
// Distributed under the MIT software license, see the accompanying
|
|
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
|
|
|
|
#ifndef BITCOIN_EXTERNAL_SIGNER_H
|
|
#define BITCOIN_EXTERNAL_SIGNER_H
|
|
|
|
#include <common/system.h>
|
|
#include <univalue.h>
|
|
|
|
#include <string>
|
|
#include <vector>
|
|
|
|
struct PartiallySignedTransaction;
|
|
|
|
//! Enables interaction with an external signing device or service, such as
|
|
//! a hardware wallet. See doc/external-signer.md
|
|
class ExternalSigner
|
|
{
|
|
private:
|
|
//! The command which handles interaction with the external signer.
|
|
std::string m_command;
|
|
|
|
//! Bitcoin mainnet, testnet, etc
|
|
std::string m_chain;
|
|
|
|
std::string NetworkArg() const;
|
|
|
|
public:
|
|
//! @param[in] command the command which handles interaction with the external signer
|
|
//! @param[in] fingerprint master key fingerprint of the signer
|
|
//! @param[in] chain "main", "test", "regtest" or "signet"
|
|
//! @param[in] name device name
|
|
ExternalSigner(const std::string& command, const std::string chain, const std::string& fingerprint, const std::string name);
|
|
|
|
//! Master key fingerprint of the signer
|
|
std::string m_fingerprint;
|
|
|
|
//! Name of signer
|
|
std::string m_name;
|
|
|
|
//! Obtain a list of signers. Calls `<command> enumerate`.
|
|
//! @param[in] command the command which handles interaction with the external signer
|
|
//! @param[in,out] signers vector to which new signers (with a unique master key fingerprint) are added
|
|
//! @param chain "main", "test", "regtest" or "signet"
|
|
//! @returns success
|
|
static bool Enumerate(const std::string& command, std::vector<ExternalSigner>& signers, const std::string chain);
|
|
|
|
//! Display address on the device. Calls `<command> displayaddress --desc <descriptor>`.
|
|
//! @param[in] descriptor Descriptor specifying which address to display.
|
|
//! Must include a public key or xpub, as well as key origin.
|
|
UniValue DisplayAddress(const std::string& descriptor) const;
|
|
|
|
//! Get receive and change Descriptor(s) from device for a given account.
|
|
//! Calls `<command> getdescriptors --account <account>`
|
|
//! @param[in] account which BIP32 account to use (e.g. `m/44'/0'/account'`)
|
|
//! @returns see doc/external-signer.md
|
|
UniValue GetDescriptors(const int account);
|
|
|
|
//! Sign PartiallySignedTransaction on the device.
|
|
//! Calls `<command> signtransaction` and passes the PSBT via stdin.
|
|
//! @param[in,out] psbt PartiallySignedTransaction to be signed
|
|
bool SignTransaction(PartiallySignedTransaction& psbt, std::string& error);
|
|
};
|
|
|
|
#endif // BITCOIN_EXTERNAL_SIGNER_H
|