mirror of
https://github.com/bitcoin/bitcoin.git
synced 2025-01-26 11:13:23 -03:00
4d05d3f3b4
Add TransactionError to node namespace and include it directly instead of relying on indirect include through common/messages.h This is a followup to a previous commit which moved the TransactionError enum. These changes were done in a separate followup just to keep the previous commit more minimal and easy to review.
456 lines
15 KiB
C++
456 lines
15 KiB
C++
// Copyright (c) 2018-2022 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 <addresstype.h>
|
|
#include <common/signmessage.h>
|
|
#include <consensus/amount.h>
|
|
#include <interfaces/chain.h>
|
|
#include <pubkey.h>
|
|
#include <script/script.h>
|
|
#include <support/allocators/secure.h>
|
|
#include <util/fs.h>
|
|
#include <util/result.h>
|
|
#include <util/ui_change_type.h>
|
|
|
|
#include <cstdint>
|
|
#include <functional>
|
|
#include <map>
|
|
#include <memory>
|
|
#include <string>
|
|
#include <tuple>
|
|
#include <type_traits>
|
|
#include <utility>
|
|
#include <vector>
|
|
|
|
class CFeeRate;
|
|
class CKey;
|
|
enum class FeeReason;
|
|
enum class OutputType;
|
|
struct PartiallySignedTransaction;
|
|
struct bilingual_str;
|
|
namespace common {
|
|
enum class PSBTError;
|
|
} // namespace common
|
|
namespace node {
|
|
enum class TransactionError;
|
|
} // namespace node
|
|
namespace wallet {
|
|
class CCoinControl;
|
|
class CWallet;
|
|
enum class AddressPurpose;
|
|
enum isminetype : unsigned int;
|
|
struct CRecipient;
|
|
struct WalletContext;
|
|
using isminefilter = std::underlying_type<isminetype>::type;
|
|
} // namespace wallet
|
|
|
|
namespace interfaces {
|
|
|
|
class Handler;
|
|
struct WalletAddress;
|
|
struct WalletBalances;
|
|
struct WalletTx;
|
|
struct WalletTxOut;
|
|
struct WalletTxStatus;
|
|
struct WalletMigrationResult;
|
|
|
|
using WalletOrderForm = std::vector<std::pair<std::string, std::string>>;
|
|
using WalletValueMap = std::map<std::string, std::string>;
|
|
|
|
//! Interface for accessing a wallet.
|
|
class Wallet
|
|
{
|
|
public:
|
|
virtual ~Wallet() {}
|
|
|
|
//! Encrypt wallet.
|
|
virtual bool encryptWallet(const SecureString& wallet_passphrase) = 0;
|
|
|
|
//! Return whether wallet is encrypted.
|
|
virtual bool isCrypted() = 0;
|
|
|
|
//! Lock wallet.
|
|
virtual bool lock() = 0;
|
|
|
|
//! Unlock wallet.
|
|
virtual bool unlock(const SecureString& wallet_passphrase) = 0;
|
|
|
|
//! Return whether wallet is locked.
|
|
virtual bool isLocked() = 0;
|
|
|
|
//! Change wallet passphrase.
|
|
virtual bool changeWalletPassphrase(const SecureString& old_wallet_passphrase,
|
|
const SecureString& new_wallet_passphrase) = 0;
|
|
|
|
//! Abort a rescan.
|
|
virtual void abortRescan() = 0;
|
|
|
|
//! Back up wallet.
|
|
virtual bool backupWallet(const std::string& filename) = 0;
|
|
|
|
//! Get wallet name.
|
|
virtual std::string getWalletName() = 0;
|
|
|
|
// Get a new address.
|
|
virtual util::Result<CTxDestination> getNewDestination(const OutputType type, const std::string& label) = 0;
|
|
|
|
//! Get public key.
|
|
virtual bool getPubKey(const CScript& script, const CKeyID& address, CPubKey& pub_key) = 0;
|
|
|
|
//! Sign message
|
|
virtual SigningResult signMessage(const std::string& message, const PKHash& pkhash, std::string& str_sig) = 0;
|
|
|
|
//! Return whether wallet has private key.
|
|
virtual bool isSpendable(const CTxDestination& dest) = 0;
|
|
|
|
//! Return whether wallet has watch only keys.
|
|
virtual bool haveWatchOnly() = 0;
|
|
|
|
//! Add or update address.
|
|
virtual bool setAddressBook(const CTxDestination& dest, const std::string& name, const std::optional<wallet::AddressPurpose>& purpose) = 0;
|
|
|
|
// Remove address.
|
|
virtual bool delAddressBook(const CTxDestination& dest) = 0;
|
|
|
|
//! Look up address in wallet, return whether exists.
|
|
virtual bool getAddress(const CTxDestination& dest,
|
|
std::string* name,
|
|
wallet::isminetype* is_mine,
|
|
wallet::AddressPurpose* purpose) = 0;
|
|
|
|
//! Get wallet address list.
|
|
virtual std::vector<WalletAddress> getAddresses() = 0;
|
|
|
|
//! Get receive requests.
|
|
virtual std::vector<std::string> getAddressReceiveRequests() = 0;
|
|
|
|
//! Save or remove receive request.
|
|
virtual bool setAddressReceiveRequest(const CTxDestination& dest, const std::string& id, const std::string& value) = 0;
|
|
|
|
//! Display address on external signer
|
|
virtual util::Result<void> displayAddress(const CTxDestination& dest) = 0;
|
|
|
|
//! Lock coin.
|
|
virtual bool lockCoin(const COutPoint& output, const bool write_to_db) = 0;
|
|
|
|
//! Unlock coin.
|
|
virtual bool unlockCoin(const COutPoint& output) = 0;
|
|
|
|
//! Return whether coin is locked.
|
|
virtual bool isLockedCoin(const COutPoint& output) = 0;
|
|
|
|
//! List locked coins.
|
|
virtual void listLockedCoins(std::vector<COutPoint>& outputs) = 0;
|
|
|
|
//! Create transaction.
|
|
virtual util::Result<CTransactionRef> createTransaction(const std::vector<wallet::CRecipient>& recipients,
|
|
const wallet::CCoinControl& coin_control,
|
|
bool sign,
|
|
int& change_pos,
|
|
CAmount& fee) = 0;
|
|
|
|
//! Commit transaction.
|
|
virtual void commitTransaction(CTransactionRef tx,
|
|
WalletValueMap value_map,
|
|
WalletOrderForm order_form) = 0;
|
|
|
|
//! Return whether transaction can be abandoned.
|
|
virtual bool transactionCanBeAbandoned(const uint256& txid) = 0;
|
|
|
|
//! Abandon transaction.
|
|
virtual bool abandonTransaction(const uint256& txid) = 0;
|
|
|
|
//! Return whether transaction can be bumped.
|
|
virtual bool transactionCanBeBumped(const uint256& txid) = 0;
|
|
|
|
//! Create bump transaction.
|
|
virtual bool createBumpTransaction(const uint256& txid,
|
|
const wallet::CCoinControl& coin_control,
|
|
std::vector<bilingual_str>& errors,
|
|
CAmount& old_fee,
|
|
CAmount& new_fee,
|
|
CMutableTransaction& mtx) = 0;
|
|
|
|
//! Sign bump transaction.
|
|
virtual bool signBumpTransaction(CMutableTransaction& mtx) = 0;
|
|
|
|
//! Commit bump transaction.
|
|
virtual bool commitBumpTransaction(const uint256& txid,
|
|
CMutableTransaction&& mtx,
|
|
std::vector<bilingual_str>& errors,
|
|
uint256& bumped_txid) = 0;
|
|
|
|
//! Get a transaction.
|
|
virtual CTransactionRef getTx(const uint256& txid) = 0;
|
|
|
|
//! Get transaction information.
|
|
virtual WalletTx getWalletTx(const uint256& txid) = 0;
|
|
|
|
//! Get list of all wallet transactions.
|
|
virtual std::set<WalletTx> getWalletTxs() = 0;
|
|
|
|
//! Try to get updated status for a particular transaction, if possible without blocking.
|
|
virtual bool tryGetTxStatus(const uint256& txid,
|
|
WalletTxStatus& tx_status,
|
|
int& num_blocks,
|
|
int64_t& block_time) = 0;
|
|
|
|
//! Get transaction details.
|
|
virtual WalletTx getWalletTxDetails(const uint256& txid,
|
|
WalletTxStatus& tx_status,
|
|
WalletOrderForm& order_form,
|
|
bool& in_mempool,
|
|
int& num_blocks) = 0;
|
|
|
|
//! Fill PSBT.
|
|
virtual std::optional<common::PSBTError> fillPSBT(int sighash_type,
|
|
bool sign,
|
|
bool bip32derivs,
|
|
size_t* n_signed,
|
|
PartiallySignedTransaction& psbtx,
|
|
bool& complete) = 0;
|
|
|
|
//! Get balances.
|
|
virtual WalletBalances getBalances() = 0;
|
|
|
|
//! Get balances if possible without blocking.
|
|
virtual bool tryGetBalances(WalletBalances& balances, uint256& block_hash) = 0;
|
|
|
|
//! Get balance.
|
|
virtual CAmount getBalance() = 0;
|
|
|
|
//! Get available balance.
|
|
virtual CAmount getAvailableBalance(const wallet::CCoinControl& coin_control) = 0;
|
|
|
|
//! Return whether transaction input belongs to wallet.
|
|
virtual wallet::isminetype txinIsMine(const CTxIn& txin) = 0;
|
|
|
|
//! Return whether transaction output belongs to wallet.
|
|
virtual wallet::isminetype txoutIsMine(const CTxOut& txout) = 0;
|
|
|
|
//! Return debit amount if transaction input belongs to wallet.
|
|
virtual CAmount getDebit(const CTxIn& txin, wallet::isminefilter filter) = 0;
|
|
|
|
//! Return credit amount if transaction input belongs to wallet.
|
|
virtual CAmount getCredit(const CTxOut& txout, wallet::isminefilter filter) = 0;
|
|
|
|
//! Return AvailableCoins + LockedCoins grouped by wallet address.
|
|
//! (put change in one group with wallet address)
|
|
using CoinsList = std::map<CTxDestination, std::vector<std::tuple<COutPoint, WalletTxOut>>>;
|
|
virtual CoinsList listCoins() = 0;
|
|
|
|
//! Return wallet transaction output information.
|
|
virtual std::vector<WalletTxOut> getCoins(const std::vector<COutPoint>& outputs) = 0;
|
|
|
|
//! Get required fee.
|
|
virtual CAmount getRequiredFee(unsigned int tx_bytes) = 0;
|
|
|
|
//! Get minimum fee.
|
|
virtual CAmount getMinimumFee(unsigned int tx_bytes,
|
|
const wallet::CCoinControl& coin_control,
|
|
int* returned_target,
|
|
FeeReason* reason) = 0;
|
|
|
|
//! Get tx confirm target.
|
|
virtual unsigned int getConfirmTarget() = 0;
|
|
|
|
// Return whether HD enabled.
|
|
virtual bool hdEnabled() = 0;
|
|
|
|
// Return whether the wallet is blank.
|
|
virtual bool canGetAddresses() = 0;
|
|
|
|
// Return whether private keys enabled.
|
|
virtual bool privateKeysDisabled() = 0;
|
|
|
|
// Return whether the wallet contains a Taproot scriptPubKeyMan
|
|
virtual bool taprootEnabled() = 0;
|
|
|
|
// Return whether wallet uses an external signer.
|
|
virtual bool hasExternalSigner() = 0;
|
|
|
|
// Get default address type.
|
|
virtual OutputType getDefaultAddressType() = 0;
|
|
|
|
//! Get max tx fee.
|
|
virtual CAmount getDefaultMaxTxFee() = 0;
|
|
|
|
// Remove wallet.
|
|
virtual void remove() = 0;
|
|
|
|
//! Return whether is a legacy wallet
|
|
virtual bool isLegacy() = 0;
|
|
|
|
//! Register handler for unload message.
|
|
using UnloadFn = std::function<void()>;
|
|
virtual std::unique_ptr<Handler> handleUnload(UnloadFn fn) = 0;
|
|
|
|
//! Register handler for show progress messages.
|
|
using ShowProgressFn = std::function<void(const std::string& title, int progress)>;
|
|
virtual std::unique_ptr<Handler> handleShowProgress(ShowProgressFn fn) = 0;
|
|
|
|
//! Register handler for status changed messages.
|
|
using StatusChangedFn = std::function<void()>;
|
|
virtual std::unique_ptr<Handler> handleStatusChanged(StatusChangedFn fn) = 0;
|
|
|
|
//! Register handler for address book changed messages.
|
|
using AddressBookChangedFn = std::function<void(const CTxDestination& address,
|
|
const std::string& label,
|
|
bool is_mine,
|
|
wallet::AddressPurpose purpose,
|
|
ChangeType status)>;
|
|
virtual std::unique_ptr<Handler> handleAddressBookChanged(AddressBookChangedFn fn) = 0;
|
|
|
|
//! Register handler for transaction changed messages.
|
|
using TransactionChangedFn = std::function<void(const uint256& txid, ChangeType status)>;
|
|
virtual std::unique_ptr<Handler> handleTransactionChanged(TransactionChangedFn fn) = 0;
|
|
|
|
//! Register handler for watchonly changed messages.
|
|
using WatchOnlyChangedFn = std::function<void(bool have_watch_only)>;
|
|
virtual std::unique_ptr<Handler> handleWatchOnlyChanged(WatchOnlyChangedFn fn) = 0;
|
|
|
|
//! Register handler for keypool changed messages.
|
|
using CanGetAddressesChangedFn = std::function<void()>;
|
|
virtual std::unique_ptr<Handler> handleCanGetAddressesChanged(CanGetAddressesChangedFn fn) = 0;
|
|
|
|
//! Return pointer to internal wallet class, useful for testing.
|
|
virtual wallet::CWallet* wallet() { return nullptr; }
|
|
};
|
|
|
|
//! Wallet chain client that in addition to having chain client methods for
|
|
//! starting up, shutting down, and registering RPCs, also has additional
|
|
//! methods (called by the GUI) to load and create wallets.
|
|
class WalletLoader : public ChainClient
|
|
{
|
|
public:
|
|
//! Create new wallet.
|
|
virtual util::Result<std::unique_ptr<Wallet>> createWallet(const std::string& name, const SecureString& passphrase, uint64_t wallet_creation_flags, std::vector<bilingual_str>& warnings) = 0;
|
|
|
|
//! Load existing wallet.
|
|
virtual util::Result<std::unique_ptr<Wallet>> loadWallet(const std::string& name, std::vector<bilingual_str>& warnings) = 0;
|
|
|
|
//! Return default wallet directory.
|
|
virtual std::string getWalletDir() = 0;
|
|
|
|
//! Restore backup wallet
|
|
virtual util::Result<std::unique_ptr<Wallet>> restoreWallet(const fs::path& backup_file, const std::string& wallet_name, std::vector<bilingual_str>& warnings) = 0;
|
|
|
|
//! Migrate a wallet
|
|
virtual util::Result<WalletMigrationResult> migrateWallet(const std::string& name, const SecureString& passphrase) = 0;
|
|
|
|
//! Return available wallets in wallet directory.
|
|
virtual std::vector<std::string> listWalletDir() = 0;
|
|
|
|
//! Return interfaces for accessing wallets (if any).
|
|
virtual std::vector<std::unique_ptr<Wallet>> getWallets() = 0;
|
|
|
|
//! Register handler for load wallet messages. This callback is triggered by
|
|
//! createWallet and loadWallet above, and also triggered when wallets are
|
|
//! loaded at startup or by RPC.
|
|
using LoadWalletFn = std::function<void(std::unique_ptr<Wallet> wallet)>;
|
|
virtual std::unique_ptr<Handler> handleLoadWallet(LoadWalletFn fn) = 0;
|
|
|
|
//! Return pointer to internal context, useful for testing.
|
|
virtual wallet::WalletContext* context() { return nullptr; }
|
|
};
|
|
|
|
//! Information about one wallet address.
|
|
struct WalletAddress
|
|
{
|
|
CTxDestination dest;
|
|
wallet::isminetype is_mine;
|
|
wallet::AddressPurpose purpose;
|
|
std::string name;
|
|
|
|
WalletAddress(CTxDestination dest, wallet::isminetype is_mine, wallet::AddressPurpose purpose, std::string name)
|
|
: dest(std::move(dest)), is_mine(is_mine), purpose(std::move(purpose)), name(std::move(name))
|
|
{
|
|
}
|
|
};
|
|
|
|
//! Collection of wallet balances.
|
|
struct WalletBalances
|
|
{
|
|
CAmount balance = 0;
|
|
CAmount unconfirmed_balance = 0;
|
|
CAmount immature_balance = 0;
|
|
bool have_watch_only = false;
|
|
CAmount watch_only_balance = 0;
|
|
CAmount unconfirmed_watch_only_balance = 0;
|
|
CAmount immature_watch_only_balance = 0;
|
|
|
|
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<wallet::isminetype> txin_is_mine;
|
|
std::vector<wallet::isminetype> txout_is_mine;
|
|
std::vector<bool> txout_is_change;
|
|
std::vector<CTxDestination> txout_address;
|
|
std::vector<wallet::isminetype> txout_address_is_mine;
|
|
CAmount credit;
|
|
CAmount debit;
|
|
CAmount change;
|
|
int64_t time;
|
|
std::map<std::string, std::string> value_map;
|
|
bool is_coinbase;
|
|
|
|
bool operator<(const WalletTx& a) const { return tx->GetHash() < a.tx->GetHash(); }
|
|
};
|
|
|
|
//! Updated transaction status.
|
|
struct WalletTxStatus
|
|
{
|
|
int block_height;
|
|
int blocks_to_maturity;
|
|
int depth_in_main_chain;
|
|
unsigned int time_received;
|
|
uint32_t lock_time;
|
|
bool is_trusted;
|
|
bool is_abandoned;
|
|
bool is_coinbase;
|
|
bool is_in_main_chain;
|
|
};
|
|
|
|
//! Wallet transaction output.
|
|
struct WalletTxOut
|
|
{
|
|
CTxOut txout;
|
|
int64_t time;
|
|
int depth_in_main_chain = -1;
|
|
bool is_spent = false;
|
|
};
|
|
|
|
//! Migrated wallet info
|
|
struct WalletMigrationResult
|
|
{
|
|
std::unique_ptr<Wallet> wallet;
|
|
std::optional<std::string> watchonly_wallet_name;
|
|
std::optional<std::string> solvables_wallet_name;
|
|
fs::path backup_path;
|
|
};
|
|
|
|
//! Return implementation of Wallet interface. This function is defined in
|
|
//! dummywallet.cpp and throws if the wallet component is not compiled.
|
|
std::unique_ptr<Wallet> MakeWallet(wallet::WalletContext& context, const std::shared_ptr<wallet::CWallet>& wallet);
|
|
|
|
//! Return implementation of ChainClient interface for a wallet loader. This
|
|
//! function will be undefined in builds where ENABLE_WALLET is false.
|
|
std::unique_ptr<WalletLoader> MakeWalletLoader(Chain& chain, ArgsManager& args);
|
|
|
|
} // namespace interfaces
|
|
|
|
#endif // BITCOIN_INTERFACES_WALLET_H
|