lbrycrd/src/qt/walletmodel.h

174 lines
5.3 KiB
C
Raw Normal View History

#ifndef WALLETMODEL_H
#define WALLETMODEL_H
#include <QObject>
#include "allocators.h" /* for SecureString */
#include "paymentrequestplus.h"
class OptionsModel;
class AddressTableModel;
class TransactionTableModel;
class CWallet;
QT_BEGIN_NAMESPACE
class QTimer;
QT_END_NAMESPACE
2012-03-18 23:14:03 +01:00
class SendCoinsRecipient
2011-07-16 19:01:05 +02:00
{
2012-03-18 23:14:03 +01:00
public:
SendCoinsRecipient() : amount(0) { }
2011-07-16 19:01:05 +02:00
QString address;
QString label;
qint64 amount;
// If from a payment request, paymentRequest.IsInitialized() will be true
PaymentRequestPlus paymentRequest;
QString authenticatedMerchant; // Empty if no authentication or invalid signature/cert/etc.
2011-07-16 19:01:05 +02:00
};
2011-11-13 13:19:52 +01:00
/** Interface to Bitcoin wallet from Qt view code. */
class WalletModel : public QObject
{
Q_OBJECT
public:
explicit WalletModel(CWallet *wallet, OptionsModel *optionsModel, QObject *parent = 0);
~WalletModel();
2011-08-31 16:08:31 +02:00
enum StatusCode // Returned by sendCoins
{
OK,
InvalidAmount,
InvalidAddress,
AmountExceedsBalance,
AmountWithFeeExceedsBalance,
2011-07-16 19:01:05 +02:00
DuplicateAddress,
2011-08-31 16:08:31 +02:00
TransactionCreationFailed, // Error returned when wallet is still locked
2011-07-16 19:01:05 +02:00
TransactionCommitFailed,
Aborted
};
enum EncryptionStatus
{
Unencrypted, // !wallet->IsCrypted()
Locked, // wallet->IsCrypted() && wallet->IsLocked()
Unlocked // wallet->IsCrypted() && !wallet->IsLocked()
};
OptionsModel *getOptionsModel();
AddressTableModel *getAddressTableModel();
TransactionTableModel *getTransactionTableModel();
qint64 getBalance() const;
qint64 getUnconfirmedBalance() const;
qint64 getImmatureBalance() const;
int getNumTransactions() const;
EncryptionStatus getEncryptionStatus() const;
2011-07-16 19:01:05 +02:00
// Check address for validity
bool validateAddress(const QString &address);
// Return status record for SendCoins, contains error id + information
2011-07-16 19:01:05 +02:00
struct SendCoinsReturn
{
SendCoinsReturn(StatusCode status,
qint64 fee=0):
status(status), fee(fee) {}
2011-07-16 19:01:05 +02:00
StatusCode status;
qint64 fee; // is used in case status is "AmountWithFeeExceedsBalance"
2011-07-16 19:01:05 +02:00
};
// Send coins to a list of recipients
2011-07-16 19:01:05 +02:00
SendCoinsReturn sendCoins(const QList<SendCoinsRecipient> &recipients);
// Wallet encryption
bool setWalletEncrypted(bool encrypted, const SecureString &passphrase);
// Passphrase only needed when unlocking
bool setWalletLocked(bool locked, const SecureString &passPhrase=SecureString());
bool changePassphrase(const SecureString &oldPass, const SecureString &newPass);
// Wallet backup
bool backupWallet(const QString &filename);
// RAI object for unlocking wallet, returned by requestUnlock()
class UnlockContext
{
public:
UnlockContext(WalletModel *wallet, bool valid, bool relock);
~UnlockContext();
bool isValid() const { return valid; }
2011-08-31 16:08:31 +02:00
// Copy operator and constructor transfer the context
UnlockContext(const UnlockContext& obj) { CopyFrom(obj); }
UnlockContext& operator=(const UnlockContext& rhs) { CopyFrom(rhs); return *this; }
private:
WalletModel *wallet;
bool valid;
mutable bool relock; // mutable, as it can be set to false by copying
void CopyFrom(const UnlockContext& rhs);
};
UnlockContext requestUnlock();
private:
CWallet *wallet;
// Wallet has an options model for wallet-specific options
// (transaction fee, for example)
OptionsModel *optionsModel;
AddressTableModel *addressTableModel;
TransactionTableModel *transactionTableModel;
2011-08-31 16:08:31 +02:00
// Cache some values to be able to detect changes
qint64 cachedBalance;
qint64 cachedUnconfirmedBalance;
qint64 cachedImmatureBalance;
qint64 cachedNumTransactions;
EncryptionStatus cachedEncryptionStatus;
int cachedNumBlocks;
QTimer *pollTimer;
void subscribeToCoreSignals();
void unsubscribeFromCoreSignals();
void checkBalanceChanged();
signals:
2011-08-31 16:08:31 +02:00
// Signal that balance in wallet changed
void balanceChanged(qint64 balance, qint64 unconfirmedBalance, qint64 immatureBalance);
2011-08-31 16:08:31 +02:00
// Number of transactions in wallet changed
void numTransactionsChanged(int count);
2011-08-31 16:08:31 +02:00
// Encryption status of wallet changed
void encryptionStatusChanged(int status);
2011-08-31 16:08:31 +02:00
// Signal emitted when wallet needs to be unlocked
// It is valid behaviour for listeners to keep the wallet locked after this signal;
// this means that the unlocking failed or was cancelled.
void requireUnlock();
// Asynchronous message notification
void message(const QString &title, const QString &message, unsigned int style);
// Coins sent: from wallet, to recipient, in (serialized) transaction:
void coinsSent(CWallet* wallet, SendCoinsRecipient recipient, QByteArray transaction);
public slots:
/* Wallet status might have changed */
void updateStatus();
/* New transaction, or transaction changed status */
void updateTransaction(const QString &hash, int status);
/* New, updated or removed address book entry */
void updateAddressBook(const QString &address, const QString &label, bool isMine, int status);
/* Current, immature or unconfirmed balance might have changed - emit 'balanceChanged' if so */
void pollBalanceChanged();
};
#endif // WALLETMODEL_H