Bitcoin Core  27.99.0
P2P Digital Currency
walletmodel.h
Go to the documentation of this file.
1 // Copyright (c) 2011-2022 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 #ifndef BITCOIN_QT_WALLETMODEL_H
6 #define BITCOIN_QT_WALLETMODEL_H
7 
8 #include <key.h>
9 
11 
12 #include <interfaces/wallet.h>
14 
15 #include <vector>
16 
17 #include <QObject>
18 
19 enum class OutputType;
20 
21 class AddressTableModel;
22 class ClientModel;
23 class OptionsModel;
24 class PlatformStyle;
26 class SendCoinsRecipient;
29 
30 class CKeyID;
31 class COutPoint;
32 class CPubKey;
33 class uint256;
34 
35 namespace interfaces {
36 class Node;
37 } // namespace interfaces
38 namespace wallet {
39 class CCoinControl;
40 } // namespace wallet
41 
42 QT_BEGIN_NAMESPACE
43 class QTimer;
44 QT_END_NAMESPACE
45 
47 class WalletModel : public QObject
48 {
49  Q_OBJECT
50 
51 public:
52  explicit WalletModel(std::unique_ptr<interfaces::Wallet> wallet, ClientModel& client_model, const PlatformStyle *platformStyle, QObject *parent = nullptr);
53  ~WalletModel();
54 
55  enum StatusCode // Returned by sendCoins
56  {
57  OK,
63  TransactionCreationFailed, // Error returned when wallet is still locked
64  AbsurdFee
65  };
66 
68  {
69  NoKeys, // wallet->IsWalletFlagSet(WALLET_FLAG_DISABLE_PRIVATE_KEYS)
70  Unencrypted, // !wallet->IsCrypted()
71  Locked, // wallet->IsCrypted() && wallet->IsLocked()
72  Unlocked // wallet->IsCrypted() && !wallet->IsLocked()
73  };
74 
79 
81 
82  // Check address for validity
83  bool validateAddress(const QString& address) const;
84 
85  // Return status record for SendCoins, contains error id + information
87  {
88  SendCoinsReturn(StatusCode _status = OK, QString _reasonCommitFailed = "")
89  : status(_status),
90  reasonCommitFailed(_reasonCommitFailed)
91  {
92  }
95  };
96 
97  // prepare transaction for getting txfee before sending coins
99 
100  // Send coins to a list of recipients
101  void sendCoins(WalletModelTransaction& transaction);
102 
103  // Wallet encryption
104  bool setWalletEncrypted(const SecureString& passphrase);
105  // Passphrase only needed when unlocking
106  bool setWalletLocked(bool locked, const SecureString &passPhrase=SecureString());
107  bool changePassphrase(const SecureString &oldPass, const SecureString &newPass);
108 
109  // RAII object for unlocking wallet, returned by requestUnlock()
111  {
112  public:
114  ~UnlockContext();
115 
116  bool isValid() const { return valid; }
117 
118  // Disable unused copy/move constructors/assignments explicitly.
119  UnlockContext(const UnlockContext&) = delete;
123 
124  private:
126  const bool valid;
127  const bool relock;
128  };
129 
131 
132  bool bumpFee(uint256 hash, uint256& new_hash);
133  bool displayAddress(std::string sAddress) const;
134 
135  static bool isWalletEnabled();
136 
137  interfaces::Node& node() const { return m_node; }
138  interfaces::Wallet& wallet() const { return *m_wallet; }
139  ClientModel& clientModel() const { return *m_client_model; }
140  void setClientModel(ClientModel* client_model);
141 
142  QString getWalletName() const;
143  QString getDisplayName() const;
144 
145  bool isMultiwallet() const;
146 
147  void refresh(bool pk_hash_only = false);
148 
150 
151  // Retrieve the cached wallet balance
153 
154  // If coin control has selected outputs, searches the total amount inside the wallet.
155  // Otherwise, uses the wallet's cached available balance.
157 
158 private:
159  std::unique_ptr<interfaces::Wallet> m_wallet;
160  std::unique_ptr<interfaces::Handler> m_handler_unload;
161  std::unique_ptr<interfaces::Handler> m_handler_status_changed;
162  std::unique_ptr<interfaces::Handler> m_handler_address_book_changed;
163  std::unique_ptr<interfaces::Handler> m_handler_transaction_changed;
164  std::unique_ptr<interfaces::Handler> m_handler_show_progress;
165  std::unique_ptr<interfaces::Handler> m_handler_watch_only_changed;
166  std::unique_ptr<interfaces::Handler> m_handler_can_get_addrs_changed;
169 
172 
173  // Wallet has an options model for wallet-specific options
174  // (transaction fee, for example)
176 
180 
181  // Cache some values to be able to detect changes
184  QTimer* timer;
185 
186  // Block hash denoting when the last balance update was done.
188 
189  void subscribeToCoreSignals();
191  void checkBalanceChanged(const interfaces::WalletBalances& new_balances);
192 
193 Q_SIGNALS:
194  // Signal that balance in wallet changed
196 
197  // Encryption status of wallet changed
199 
200  // Signal emitted when wallet needs to be unlocked
201  // It is valid behaviour for listeners to keep the wallet locked after this signal;
202  // this means that the unlocking failed or was cancelled.
204 
205  // Fired when a message should be reported to the user
206  void message(const QString &title, const QString &message, unsigned int style);
207 
208  // Coins sent: from wallet, to recipient, in (serialized) transaction:
209  void coinsSent(WalletModel* wallet, SendCoinsRecipient recipient, QByteArray transaction);
210 
211  // Show progress dialog e.g. for rescan
212  void showProgress(const QString &title, int nProgress);
213 
214  // Watch-only address added
215  void notifyWatchonlyChanged(bool fHaveWatchonly);
216 
217  // Signal that wallet is about to be removed
218  void unload();
219 
220  // Notify that there are now keys in the keypool
222 
223  void timerTimeout();
224 
225 public Q_SLOTS:
226  /* Starts a timer to periodically update the balance */
227  void startPollBalance();
228 
229  /* Wallet status might have changed */
230  void updateStatus();
231  /* New transaction, or transaction changed status */
232  void updateTransaction();
233  /* New, updated or removed address book entry */
234  void updateAddressBook(const QString &address, const QString &label, bool isMine, wallet::AddressPurpose purpose, int status);
235  /* Watch-only added */
236  void updateWatchOnlyFlag(bool fHaveWatchonly);
237  /* Current, immature or unconfirmed balance might have changed - emit 'balanceChanged' if so */
238  void pollBalanceChanged();
239 };
240 
241 #endif // BITCOIN_QT_WALLETMODEL_H
int64_t CAmount
Amount in satoshis (Can be negative)
Definition: amount.h:12
Qt model of the address book in the core.
A reference to a CKey: the Hash160 of its serialized public key.
Definition: pubkey.h:24
An outpoint - a combination of a transaction hash and an index n into its vout.
Definition: transaction.h:29
An encapsulated public key.
Definition: pubkey.h:34
Model for Bitcoin network client.
Definition: clientmodel.h:54
Interface from Qt to configuration data structure for Bitcoin client.
Definition: optionsmodel.h:43
Model for list of recently generated payment requests / bitcoin: URIs.
UI model for the transaction table of a wallet.
UnlockContext(WalletModel *wallet, bool valid, bool relock)
UnlockContext(UnlockContext &&)=delete
UnlockContext & operator=(const UnlockContext &)=delete
UnlockContext & operator=(UnlockContext &&)=delete
UnlockContext(const UnlockContext &)=delete
Interface to Bitcoin wallet from Qt view code.
Definition: walletmodel.h:48
OptionsModel * optionsModel
Definition: walletmodel.h:175
AddressTableModel * addressTableModel
Definition: walletmodel.h:177
RecentRequestsTableModel * getRecentRequestsTableModel() const
EncryptionStatus cachedEncryptionStatus
Definition: walletmodel.h:183
void refresh(bool pk_hash_only=false)
uint256 m_cached_last_update_tip
Definition: walletmodel.h:187
ClientModel * m_client_model
Definition: walletmodel.h:167
std::unique_ptr< interfaces::Handler > m_handler_watch_only_changed
Definition: walletmodel.h:165
interfaces::Node & m_node
Definition: walletmodel.h:168
std::unique_ptr< interfaces::Handler > m_handler_transaction_changed
Definition: walletmodel.h:163
void startPollBalance()
Definition: walletmodel.cpp:60
void pollBalanceChanged()
Definition: walletmodel.cpp:89
AddressTableModel * getAddressTableModel() const
RecentRequestsTableModel * recentRequestsTableModel
Definition: walletmodel.h:179
SendCoinsReturn prepareTransaction(WalletModelTransaction &transaction, const wallet::CCoinControl &coinControl)
bool displayAddress(std::string sAddress) const
TransactionTableModel * transactionTableModel
Definition: walletmodel.h:178
bool setWalletEncrypted(const SecureString &passphrase)
ClientModel & clientModel() const
Definition: walletmodel.h:139
void notifyWatchonlyChanged(bool fHaveWatchonly)
bool changePassphrase(const SecureString &oldPass, const SecureString &newPass)
void showProgress(const QString &title, int nProgress)
bool setWalletLocked(bool locked, const SecureString &passPhrase=SecureString())
void updateAddressBook(const QString &address, const QString &label, bool isMine, wallet::AddressPurpose purpose, int status)
void message(const QString &title, const QString &message, unsigned int style)
bool validateAddress(const QString &address) const
void sendCoins(WalletModelTransaction &transaction)
void setClientModel(ClientModel *client_model)
Definition: walletmodel.cpp:74
void updateStatus()
Definition: walletmodel.cpp:80
CAmount getAvailableBalance(const wallet::CCoinControl *control)
bool isMultiwallet() const
void timerTimeout()
std::unique_ptr< interfaces::Handler > m_handler_can_get_addrs_changed
Definition: walletmodel.h:166
std::unique_ptr< interfaces::Handler > m_handler_unload
Definition: walletmodel.h:160
interfaces::Wallet & wallet() const
Definition: walletmodel.h:138
EncryptionStatus getEncryptionStatus() const
TransactionTableModel * getTransactionTableModel() const
std::unique_ptr< interfaces::Handler > m_handler_status_changed
Definition: walletmodel.h:161
interfaces::WalletBalances m_cached_balances
Definition: walletmodel.h:182
bool fForceCheckBalanceChanged
Definition: walletmodel.h:171
void coinsSent(WalletModel *wallet, SendCoinsRecipient recipient, QByteArray transaction)
QString getDisplayName() const
OptionsModel * getOptionsModel() const
bool bumpFee(uint256 hash, uint256 &new_hash)
void checkBalanceChanged(const interfaces::WalletBalances &new_balances)
void unsubscribeFromCoreSignals()
void requireUnlock()
void updateTransaction()
uint256 getLastBlockProcessed() const
void canGetAddressesChanged()
QTimer * timer
Definition: walletmodel.h:184
bool fHaveWatchOnly
Definition: walletmodel.h:170
WalletModel(std::unique_ptr< interfaces::Wallet > wallet, ClientModel &client_model, const PlatformStyle *platformStyle, QObject *parent=nullptr)
Definition: walletmodel.cpp:39
void updateWatchOnlyFlag(bool fHaveWatchonly)
std::unique_ptr< interfaces::Handler > m_handler_address_book_changed
Definition: walletmodel.h:162
void encryptionStatusChanged()
interfaces::Node & node() const
Definition: walletmodel.h:137
std::unique_ptr< interfaces::Wallet > m_wallet
Definition: walletmodel.h:159
UnlockContext requestUnlock()
void balanceChanged(const interfaces::WalletBalances &balances)
static bool isWalletEnabled()
interfaces::WalletBalances getCachedBalance() const
QString getWalletName() const
std::unique_ptr< interfaces::Handler > m_handler_show_progress
Definition: walletmodel.h:164
void unload()
@ AmountWithFeeExceedsBalance
Definition: walletmodel.h:61
@ TransactionCreationFailed
Definition: walletmodel.h:63
@ AmountExceedsBalance
Definition: walletmodel.h:60
@ DuplicateAddress
Definition: walletmodel.h:62
void subscribeToCoreSignals()
Data model for a walletmodel transaction.
Top-level interface for a bitcoin node (bitcoind process).
Definition: node.h:70
Interface for accessing a wallet.
Definition: wallet.h:61
256-bit opaque blob.
Definition: uint256.h:106
Coin Control Features.
Definition: coincontrol.h:81
AddressPurpose
Address purpose field that has been been stored with wallet sending and receiving addresses since BIP...
Definition: types.h:60
OutputType
Definition: outputtype.h:17
std::basic_string< char, std::char_traits< char >, secure_allocator< char > > SecureString
Definition: secure.h:58
SendCoinsReturn(StatusCode _status=OK, QString _reasonCommitFailed="")
Definition: walletmodel.h:88
Collection of wallet balances.
Definition: wallet.h:372