wallet.h

Go to the documentation of this file.

// Copyright (c) 2018 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_INTERFACES_WALLET_H
#define BITCOIN_INTERFACES_WALLET_H

#include <amount.h>                 // For Amount
#include <primitives/transaction.h> // For CTxOut
#include <pubkey.h> // For CKeyID and CScriptID (definitions needed in CTxDestination instantiation)
#include <script/sighashtype.h>
#include <script/standard.h>           // For CTxDestination
#include <support/allocators/secure.h> // For SecureString
#include <util/message.h>
#include <util/ui_change_type.h>

#include <cstdint>
#include <functional>
#include <map>
#include <memory>
#include <string>
#include <tuple>
#include <utility>
#include <vector>

class CChainParams;
class CCoinControl;
class CKey;
class CMutableTransaction;
class COutPoint;
class CTransaction;
class CWallet;
enum class FeeReason;
enum class OutputType;
enum class TransactionError;
enum isminetype : unsigned int;
struct CRecipient;
struct PartiallySignedTransaction;
typedef uint8_t isminefilter;
struct TxId;
struct bilingual_str;

namespace interfaces {

class Handler;
struct WalletAddress;
struct WalletBalances;
struct WalletTx;
struct WalletTxOut;
struct WalletTxStatus;

using WalletOrderForm = std::vector<std::pair<std::string, std::string>>;
using WalletValueMap = std::map<std::string, std::string>;

class Wallet {
public:
    virtual ~Wallet() {}

    virtual bool encryptWallet(const SecureString &wallet_passphrase) = 0;

    virtual bool isCrypted() = 0;

    virtual bool lock() = 0;

    virtual bool unlock(const SecureString &wallet_passphrase) = 0;

    virtual bool isLocked() = 0;

    virtual bool
    changeWalletPassphrase(const SecureString &old_wallet_passphrase,
                           const SecureString &new_wallet_passphrase) = 0;

    virtual void abortRescan() = 0;

    virtual bool backupWallet(const std::string &filename) = 0;

    virtual std::string getWalletName() = 0;

    virtual const CChainParams &getChainParams() = 0;

    virtual std::set<CTxDestination>
    getLabelAddresses(const std::string &label) = 0;

    // Get a new address.
    virtual bool getNewDestination(const OutputType type,
                                   const std::string label,
                                   CTxDestination &dest) = 0;

    virtual bool getPubKey(const CScript &script, const CKeyID &address,
                           CPubKey &pub_key) = 0;

    virtual SigningResult signMessage(const std::string &message,
                                      const PKHash &pkhash,
                                      std::string &str_sig) = 0;

    virtual bool isSpendable(const CTxDestination &dest) = 0;

    virtual bool haveWatchOnly() = 0;

    virtual bool setAddressBook(const CTxDestination &dest,
                                const std::string &name,
                                const std::string &purpose) = 0;

    // Remove address.
    virtual bool delAddressBook(const CTxDestination &dest) = 0;

    virtual bool getAddress(const CTxDestination &dest, std::string *name,
                            isminetype *is_mine, std::string *purpose) = 0;

    virtual std::vector<WalletAddress> getAddresses() = 0;

    virtual bool addDestData(const CTxDestination &dest, const std::string &key,
                             const std::string &value) = 0;

    virtual bool eraseDestData(const CTxDestination &dest,
                               const std::string &key) = 0;

    virtual std::vector<std::string>
    getDestValues(const std::string &prefix) = 0;

    virtual void lockCoin(const COutPoint &output) = 0;

    virtual void unlockCoin(const COutPoint &output) = 0;

    virtual bool isLockedCoin(const COutPoint &output) = 0;

    virtual void listLockedCoins(std::vector<COutPoint> &outputs) = 0;

    virtual CTransactionRef
    createTransaction(const std::vector<CRecipient> &recipients,
                      const CCoinControl &coin_control, bool sign,
                      int &change_pos, Amount &fee,
                      bilingual_str &fail_reason) = 0;

    virtual void commitTransaction(CTransactionRef tx, WalletValueMap value_map,
                                   WalletOrderForm order_form) = 0;

    virtual bool transactionCanBeAbandoned(const TxId &txid) = 0;

    virtual bool abandonTransaction(const TxId &txid) = 0;

    virtual CTransactionRef getTx(const TxId &txid) = 0;

    virtual WalletTx getWalletTx(const TxId &txid) = 0;

    virtual std::vector<WalletTx> getWalletTxs() = 0;

    virtual bool tryGetTxStatus(const TxId &txid, WalletTxStatus &tx_status,
                                int &num_blocks, int64_t &block_time) = 0;

    virtual WalletTx getWalletTxDetails(const TxId &txid,
                                        WalletTxStatus &tx_status,
                                        WalletOrderForm &order_form,
                                        bool &in_mempool, int &num_blocks) = 0;

    virtual TransactionError fillPSBT(SigHashType sighash_type, bool sign,
                                      bool bip32derivs,
                                      PartiallySignedTransaction &psbtx,
                                      bool &complete) const = 0;

    virtual WalletBalances getBalances() = 0;

    virtual bool tryGetBalances(WalletBalances &balances, int &num_blocks,
                                bool force, int cached_num_blocks) = 0;

    virtual Amount getBalance() = 0;

    virtual Amount getAvailableBalance(const CCoinControl &coin_control) = 0;

    virtual isminetype txinIsMine(const CTxIn &txin) = 0;

    virtual isminetype txoutIsMine(const CTxOut &txout) = 0;

    virtual Amount getDebit(const CTxIn &txin, isminefilter filter) = 0;

    virtual Amount getCredit(const CTxOut &txout, isminefilter filter) = 0;

    using CoinsList = std::map<CTxDestination,
                               std::vector<std::tuple<COutPoint, WalletTxOut>>>;
    virtual CoinsList listCoins() = 0;

    virtual std::vector<WalletTxOut>
    getCoins(const std::vector<COutPoint> &outputs) = 0;

    virtual Amount getRequiredFee(unsigned int tx_bytes) = 0;

    virtual Amount getMinimumFee(unsigned int tx_bytes,
                                 const CCoinControl &coin_control) = 0;

    // Return whether HD enabled.
    virtual bool hdEnabled() = 0;

    // Return whether the wallet is blank.
    virtual bool canGetAddresses() const = 0;

    // Return whether private keys enabled.
    virtual bool privateKeysDisabled() = 0;

    // Get default address type.
    virtual OutputType getDefaultAddressType() = 0;

    // Get default change type.
    virtual OutputType getDefaultChangeType() = 0;

    virtual Amount getDefaultMaxTxFee() = 0;

    // Remove wallet.
    virtual void remove() = 0;

    virtual bool isLegacy() = 0;

    using UnloadFn = std::function<void()>;
    virtual std::unique_ptr<Handler> handleUnload(UnloadFn fn) = 0;

    using ShowProgressFn =
        std::function<void(const std::string &title, int progress)>;
    virtual std::unique_ptr<Handler> handleShowProgress(ShowProgressFn fn) = 0;

    using StatusChangedFn = std::function<void()>;
    virtual std::unique_ptr<Handler>
    handleStatusChanged(StatusChangedFn fn) = 0;

    using AddressBookChangedFn = std::function<void(
        const CTxDestination &address, const std::string &label, bool is_mine,
        const std::string &purpose, ChangeType status)>;
    virtual std::unique_ptr<Handler>
    handleAddressBookChanged(AddressBookChangedFn fn) = 0;

    using TransactionChangedFn =
        std::function<void(const TxId &txid, ChangeType status)>;
    virtual std::unique_ptr<Handler>
    handleTransactionChanged(TransactionChangedFn fn) = 0;

    using WatchOnlyChangedFn = std::function<void(bool have_watch_only)>;
    virtual std::unique_ptr<Handler>
    handleWatchOnlyChanged(WatchOnlyChangedFn fn) = 0;

    using CanGetAddressesChangedFn = std::function<void()>;
    virtual std::unique_ptr<Handler>
    handleCanGetAddressesChanged(CanGetAddressesChangedFn fn) = 0;

    virtual CWallet *wallet() { return nullptr; }
};

struct WalletAddress {
    CTxDestination dest;
    isminetype is_mine;
    std::string name;
    std::string purpose;

    WalletAddress(CTxDestination destIn, isminetype isMineIn,
                  std::string nameIn, std::string purposeIn)
        : dest(std::move(destIn)), is_mine(isMineIn), name(std::move(nameIn)),
          purpose(std::move(purposeIn)) {}
};

struct WalletBalances {
    Amount balance = Amount::zero();
    Amount unconfirmed_balance = Amount::zero();
    Amount immature_balance = Amount::zero();
    bool have_watch_only = false;
    Amount watch_only_balance = Amount::zero();
    Amount unconfirmed_watch_only_balance = Amount::zero();
    Amount immature_watch_only_balance = Amount::zero();

    bool balanceChanged(const WalletBalances &prev) const {
        return balance != prev.balance ||
               unconfirmed_balance != prev.unconfirmed_balance ||
               immature_balance != prev.immature_balance ||
               watch_only_balance != prev.watch_only_balance ||
               unconfirmed_watch_only_balance !=
                   prev.unconfirmed_watch_only_balance ||
               immature_watch_only_balance != prev.immature_watch_only_balance;
    }
};

// Wallet transaction information.
struct WalletTx {
    CTransactionRef tx;
    std::vector<isminetype> txin_is_mine;
    std::vector<isminetype> txout_is_mine;
    std::vector<CTxDestination> txout_address;
    std::vector<isminetype> txout_address_is_mine;
    Amount credit;
    Amount debit;
    Amount change;
    int64_t time;
    std::map<std::string, std::string> value_map;
    bool is_coinbase;
};

struct WalletTxStatus {
    int block_height;
    int blocks_to_maturity;
    int depth_in_main_chain;
    unsigned int time_received;
    uint32_t lock_time;
    bool is_final;
    bool is_trusted;
    bool is_abandoned;
    bool is_coinbase;
    bool is_in_main_chain;
};

struct WalletTxOut {
    CTxOut txout;
    int64_t time;
    int depth_in_main_chain = -1;
    bool is_spent = false;
};

std::unique_ptr<Wallet> MakeWallet(const std::shared_ptr<CWallet> &wallet);

} // namespace interfaces

#endif // BITCOIN_INTERFACES_WALLET_H