8 #include "allocators.h" /* for SecureString */
11 class AddressTableModel;
12 class TransactionTableModel;
25 class SendCoinsRecipient
33 /** Interface to Bitcoin wallet from Qt view code. */
34 class WalletModel : public QObject
39 explicit WalletModel(CWallet *wallet, OptionsModel *optionsModel, QObject *parent = 0);
42 enum StatusCode // Returned by sendCoins
48 AmountWithFeeExceedsBalance,
50 TransactionCreationFailed, // Error returned when wallet is still locked
51 TransactionCommitFailed,
57 Unencrypted, // !wallet->IsCrypted()
58 Locked, // wallet->IsCrypted() && wallet->IsLocked()
59 Unlocked // wallet->IsCrypted() && !wallet->IsLocked()
62 OptionsModel *getOptionsModel();
63 AddressTableModel *getAddressTableModel();
64 TransactionTableModel *getTransactionTableModel();
66 qint64 getBalance() const;
67 qint64 getStake() const;
68 qint64 getUnconfirmedBalance() const;
69 qint64 getImmatureBalance() const;
70 int getNumTransactions() const;
71 EncryptionStatus getEncryptionStatus() const;
73 // Check address for validity
74 bool validateAddress(const QString &address);
76 // Return status record for SendCoins, contains error id + information
77 struct SendCoinsReturn
79 SendCoinsReturn(StatusCode status=Aborted,
81 QString hex=QString()):
82 status(status), fee(fee), hex(hex) {}
84 qint64 fee; // is used in case status is "AmountWithFeeExceedsBalance"
85 QString hex; // is filled with the transaction hash if status is "OK"
88 // Send coins to a list of recipients
89 SendCoinsReturn sendCoins(const QList<SendCoinsRecipient> &recipients, const CCoinControl *coinControl=NULL);
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);
97 bool backupWallet(const QString &filename);
99 // RAI object for unlocking wallet, returned by requestUnlock()
103 UnlockContext(WalletModel *wallet, bool valid, bool relock);
106 bool isValid() const { return valid; }
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; }
114 mutable bool relock; // mutable, as it can be set to false by copying
116 void CopyFrom(const UnlockContext& rhs);
119 UnlockContext requestUnlock();
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);
132 // Wallet has an options model for wallet-specific options
133 // (transaction fee, for example)
134 OptionsModel *optionsModel;
136 AddressTableModel *addressTableModel;
137 TransactionTableModel *transactionTableModel;
139 // Cache some values to be able to detect changes
140 qint64 cachedBalance;
142 qint64 cachedUnconfirmedBalance;
143 qint64 cachedImmatureBalance;
144 qint64 cachedNumTransactions;
145 EncryptionStatus cachedEncryptionStatus;
150 void subscribeToCoreSignals();
151 void unsubscribeFromCoreSignals();
152 void checkBalanceChanged();
156 /* Wallet status might have changed */
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();
166 // Signal that balance in wallet changed
167 void balanceChanged(qint64 balance, qint64 stake, qint64 unconfirmedBalance, qint64 immatureBalance);
169 // Number of transactions in wallet changed
170 void numTransactionsChanged(int count);
172 // Encryption status of wallet changed
173 void encryptionStatusChanged(int status);
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();
180 // Asynchronous error notification
181 void error(const QString &title, const QString &message, bool modal);
185 #endif // WALLETMODEL_H