src/qt/walletmodel.h

   1 #ifndef WALLETMODEL_H
   2 #define WALLETMODEL_H
   3
   4 #include <QObject>
   5 #include <vector>
   6 #include <map>
   7
   8 #include "allocators.h" /* for SecureString */
   9
  10 class OptionsModel;
  11 class AddressTableModel;
  12 class TransactionTableModel;
  13 class CWallet;
  14 class CKeyID;
  15 class CPubKey;
  16 class COutput;
  17 class COutPoint;
  18 class uint256;
  19 class CCoinControl;
  20
  21 QT_BEGIN_NAMESPACE
  22 class QTimer;
  23 QT_END_NAMESPACE
  24
  25 class SendCoinsRecipient
  26 {
  27 public:
  28     QString address;
  29     QString label;
  30     qint64 amount;
  31 };
  32
  33 /** Interface to Bitcoin wallet from Qt view code. */
  34 class WalletModel : public QObject
  35 {
  36     Q_OBJECT
  37
  38 public:
  39     explicit WalletModel(CWallet *wallet, OptionsModel *optionsModel, QObject *parent = 0);
  40     ~WalletModel();
  41
  42     enum StatusCode // Returned by sendCoins
  43     {
  44         OK,
  45         InvalidAmount,
  46         InvalidAddress,
  47         AmountExceedsBalance,
  48         AmountWithFeeExceedsBalance,
  49         DuplicateAddress,
  50         TransactionCreationFailed, // Error returned when wallet is still locked
  51         TransactionCommitFailed,
  52         Aborted
  53     };
  54
  55     enum EncryptionStatus
  56     {
  57         Unencrypted,  // !wallet->IsCrypted()
  58         Locked,       // wallet->IsCrypted() && wallet->IsLocked()
  59         Unlocked      // wallet->IsCrypted() && !wallet->IsLocked()
  60     };
  61
  62     OptionsModel *getOptionsModel();
  63     AddressTableModel *getAddressTableModel();
  64     TransactionTableModel *getTransactionTableModel();
  65
  66     qint64 getBalance() const;
  67     qint64 getStake() const;
  68     qint64 getUnconfirmedBalance() const;
  69     qint64 getImmatureBalance() const;
  70     int getNumTransactions() const;
  71     EncryptionStatus getEncryptionStatus() const;
  72
  73     // Check address for validity
  74     bool validateAddress(const QString &address);
  75
  76     // Return status record for SendCoins, contains error id + information
  77     struct SendCoinsReturn
  78     {
  79         SendCoinsReturn(StatusCode status=Aborted,
  80                          qint64 fee=0,
  81                          QString hex=QString()):
  82             status(status), fee(fee), hex(hex) {}
  83         StatusCode status;
  84         qint64 fee; // is used in case status is "AmountWithFeeExceedsBalance"
  85         QString hex; // is filled with the transaction hash if status is "OK"
  86     };
  87
  88     // Send coins to a list of recipients
  89     SendCoinsReturn sendCoins(const QList<SendCoinsRecipient> &recipients, const CCoinControl *coinControl=NULL);
  90
  91     // Wallet encryption
  92     bool setWalletEncrypted(bool encrypted, const SecureString &passphrase);
  93     // Passphrase only needed when unlocking
  94     bool setWalletLocked(bool locked, const SecureString &passPhrase=SecureString());
  95     bool changePassphrase(const SecureString &oldPass, const SecureString &newPass);
  96     // Wallet backup
  97     bool backupWallet(const QString &filename);
  98
  99     // RAI object for unlocking wallet, returned by requestUnlock()
 100     class UnlockContext
 101     {
 102     public:
 103         UnlockContext(WalletModel *wallet, bool valid, bool relock);
 104         ~UnlockContext();
 105
 106         bool isValid() const { return valid; }
 107
 108         // Copy operator and constructor transfer the context
 109         UnlockContext(const UnlockContext& obj) { CopyFrom(obj); }
 110         UnlockContext& operator=(const UnlockContext& rhs) { CopyFrom(rhs); return *this; }
 111     private:
 112         WalletModel *wallet;
 113         bool valid;
 114         mutable bool relock; // mutable, as it can be set to false by copying
 115
 116         void CopyFrom(const UnlockContext& rhs);
 117     };
 118
 119     UnlockContext requestUnlock();
 120
 121     bool getPubKey(const CKeyID &address, CPubKey& vchPubKeyOut) const;
 122     void getOutputs(const std::vector<COutPoint>& vOutpoints, std::vector<COutput>& vOutputs);
 123     void listCoins(std::map<QString, std::vector<COutput> >& mapCoins) const;
 124     bool isLockedCoin(uint256 hash, unsigned int n) const;
 125     void lockCoin(COutPoint& output);
 126     void unlockCoin(COutPoint& output);
 127     void listLockedCoins(std::vector<COutPoint>& vOutpts);
 128
 129 private:
 130     CWallet *wallet;
 131
 132     // Wallet has an options model for wallet-specific options
 133     // (transaction fee, for example)
 134     OptionsModel *optionsModel;
 135
 136     AddressTableModel *addressTableModel;
 137     TransactionTableModel *transactionTableModel;
 138
 139     // Cache some values to be able to detect changes
 140     qint64 cachedBalance;
 141     qint64 cachedStake;
 142     qint64 cachedUnconfirmedBalance;
 143     qint64 cachedImmatureBalance;
 144     qint64 cachedNumTransactions;
 145     EncryptionStatus cachedEncryptionStatus;
 146     int cachedNumBlocks;
 147
 148     QTimer *pollTimer;
 149
 150     void subscribeToCoreSignals();
 151     void unsubscribeFromCoreSignals();
 152     void checkBalanceChanged();
 153
 154
 155 public slots:
 156     /* Wallet status might have changed */
 157     void updateStatus();
 158     /* New transaction, or transaction changed status */
 159     void updateTransaction(const QString &hash, int status);
 160     /* New, updated or removed address book entry */
 161     void updateAddressBook(const QString &address, const QString &label, bool isMine, int status);
 162     /* Current, immature or unconfirmed balance might have changed - emit 'balanceChanged' if so */
 163     void pollBalanceChanged();
 164
 165 signals:
 166     // Signal that balance in wallet changed
 167     void balanceChanged(qint64 balance, qint64 stake, qint64 unconfirmedBalance, qint64 immatureBalance);
 168
 169     // Number of transactions in wallet changed
 170     void numTransactionsChanged(int count);
 171
 172     // Encryption status of wallet changed
 173     void encryptionStatusChanged(int status);
 174
 175     // Signal emitted when wallet needs to be unlocked
 176     // It is valid behaviour for listeners to keep the wallet locked after this signal;
 177     // this means that the unlocking failed or was cancelled.
 178     void requireUnlock();
 179
 180     // Asynchronous error notification
 181     void error(const QString &title, const QString &message, bool modal);
 182 };
 183
 184
 185 #endif // WALLETMODEL_H