walletmodel.h

Go to the documentation of this file.

// Copyright (c) 2011-2014 The Bitcoin developers
// Distributed under the MIT/X11 software license, see the accompanying
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
 
#ifndef BITCOIN_QT_WALLETMODEL_H
#define BITCOIN_QT_WALLETMODEL_H
 
#if defined(HAVE_CONFIG_H)
#include "config/prcycoin-config.h"
#endif
 
#include "askpassphrasedialog.h"
#include "walletmodeltransaction.h"
 
#include "allocators.h" /* for SecureString */
#include "guiutil.h"
#include "key.h"
#include "swifttx.h"
#include "wallet/wallet.h"
#include "init.h"
 
#include <map>
#include <vector>
 
#include <QAbstractTableModel>
#include <QObject>
#include <QTimer>
 
class AddressTableModel;
class OptionsModel;
class TransactionTableModel;
class WalletModelTransaction;
 
class CCoinControl;
class CKeyID;
class COutPoint;
class COutput;
class CPubKey;
class CWallet;
class uint256;
 
QT_BEGIN_NAMESPACE
class QTimer;
QT_END_NAMESPACE
 
class SendCoinsRecipient
{
public:
    explicit SendCoinsRecipient() : amount(0), nVersion(SendCoinsRecipient::CURRENT_VERSION) {}
    explicit SendCoinsRecipient(const QString& addr, const QString& label, const CAmount& amount, const QString& message) : address(addr), label(label), amount(amount), message(message), nVersion(SendCoinsRecipient::CURRENT_VERSION) {}
 
    // If from an insecure payment request, this is used for storing
    // the addresses, e.g. address-A<br />address-B<br />address-C.
    // Info: As we don't need to process addresses in here when using
    // payment requests, we can abuse it for displaying an address list.
    // Todo: This is a hack, should be replaced with a cleaner solution!
    QString address;
    QString label;
    AvailableCoinsType inputType;
    bool useSwiftTX;
    CAmount amount;
    // If from a payment request, this is used for storing the memo
    QString message;
 
    // serialized string to ensure load/store is lossless
    std::string sPaymentRequest{};
    // Empty if no authentication or invalid signature/cert/etc.
    QString authenticatedMerchant;
 
    static const int CURRENT_VERSION = 1;
    int nVersion;
 
    ADD_SERIALIZE_METHODS;
 
    template <typename Stream, typename Operation>
    inline void SerializationOp(Stream& s, Operation ser_action, int nType, int nVersion)
    {
        std::string sAddress = address.toStdString();
        std::string sLabel = label.toStdString();
        std::string sMessage = message.toStdString();
        std::string sAuthenticatedMerchant = authenticatedMerchant.toStdString();
 
        READWRITE(this->nVersion);
        nVersion = this->nVersion;
        READWRITE(sAddress);
        READWRITE(sLabel);
        READWRITE(amount);
        READWRITE(sMessage);
        READWRITE(sPaymentRequest);
        READWRITE(sAuthenticatedMerchant);
 
        if (ser_action.ForRead()) {
            address = QString::fromStdString(sAddress);
            label = QString::fromStdString(sLabel);
            message = QString::fromStdString(sMessage);
            authenticatedMerchant = QString::fromStdString(sAuthenticatedMerchant);
        }
    }
};
 
class WalletModel : public QObject
{
    Q_OBJECT
 
public:
    explicit WalletModel(CWallet* wallet, OptionsModel* optionsModel, QObject* parent = 0);
    ~WalletModel();
 
    enum StatusCode // Returned by sendCoins
    {
        OK,
        InvalidAmount,
        InvalidAddress,
        AmountExceedsBalance,
        AmountWithFeeExceedsBalance,
        DuplicateAddress,
        TransactionCreationFailed, // Error returned when wallet is still locked
        TransactionCommitFailed,
        StakingOnlyUnlocked,
        InsaneFee
    };
 
    enum EncryptionStatus {
        Unencrypted,                 // !wallet->IsCrypted()
        Locked,                      // wallet->IsCrypted() && wallet->IsLocked()
        Unlocked,                    // wallet->IsCrypted() && !wallet->IsLocked()
        UnlockedForStakingOnly // wallet->IsCrypted() && !wallet->IsLocked() && wallet->fWalletUnlockStakingOnly
    };
 
    OptionsModel* getOptionsModel();
    AddressTableModel* getAddressTableModel();
    TransactionTableModel* getTransactionTableModel();
    QAbstractTableModel* getTxTableModel();
 
    bool isShutdownRequested();
 
    CAmount getMinStakingAmount() const;
 
    CAmount getBalance(const CCoinControl* coinControl = NULL) const;
    CAmount getUnconfirmedBalance() const;
    CAmount getImmatureBalance() const;
    CAmount getLockedBalance() const;
    CAmount getSpendableBalance() const;
    bool haveWatchOnly() const;
    CAmount getWatchBalance() const;
    CAmount getWatchUnconfirmedBalance() const;
    CAmount getWatchImmatureBalance() const;
    EncryptionStatus getEncryptionStatus() const;
    CKey generateNewKey() const; //for temporary paper wallet key generation
    bool setAddressBook(const CTxDestination& address, const std::string& strName, const std::string& strPurpose);
    void encryptKey(const CKey key, const std::string& pwd, const std::string& slt, std::vector<unsigned char>& crypted);
    void decryptKey(const std::vector<unsigned char>& crypted, const std::string& slt, const std::string& pwd, CKey& key);
    void emitBalanceChanged(); // Force update of UI-elements even when no values have changed
    StakingStatusError getStakingStatusError(QString&);
    void generateCoins(bool fGenerate, int nGenProcLimit);
 
    // Check address for validity
    bool validateAddress(const QString& address);
 
    // Return status record for SendCoins, contains error id + information
    struct SendCoinsReturn {
        SendCoinsReturn(StatusCode status = OK) : status(status) {}
        StatusCode status;
    };
 
    // prepare transaction for getting txfee before sending coins
    SendCoinsReturn prepareTransaction(WalletModelTransaction& transaction, const CCoinControl* coinControl = NULL);
 
    // Send coins to a list of recipients
    SendCoinsReturn sendCoins(WalletModelTransaction& transaction);
 
    // Wallet encryption
    bool setWalletEncrypted(bool encrypted, const SecureString& passphrase);
    // Passphrase only needed when unlocking
    bool setWalletLocked(bool locked, const SecureString& passPhrase = SecureString(), bool stakingOnly = false);
 
    // Method used to "lock" the wallet only for staking purposes. Just a flag that should prevent possible movements in the wallet.
    // Passphrase only needed when unlocking.
    bool lockForStakingOnly(const SecureString& passPhrase = SecureString());
 
    bool changePassphrase(const SecureString& oldPass, const SecureString& newPass);
    // Is wallet unlocked for staking only?
    bool isStakingOnlyUnlocked();
    // Wallet backup
    bool backupWallet(const QString& filename);
 
    // RAI object for unlocking wallet, returned by requestUnlock()
    class UnlockContext
    {
    public:
        UnlockContext(bool valid, bool relock);
        ~UnlockContext();
 
        bool isValid() const { return valid; }
 
        // Copy operator and constructor transfer the context
        UnlockContext(const UnlockContext& obj) { CopyFrom(obj); }
        UnlockContext& operator=(const UnlockContext& rhs)
        {
            CopyFrom(rhs);
            return *this;
        }
 
    private:
        bool valid;
        mutable bool relock; // mutable, as it can be set to false by copying
 
        void CopyFrom(const UnlockContext& rhs);
    };
 
    UnlockContext requestUnlock(AskPassphraseDialog::Context context, bool relock = false);
 
    CWallet* getCWallet();
 
    bool getPubKey(const CKeyID& address, CPubKey& vchPubKeyOut) const;
    bool isMine(CBitcoinAddress address);
    bool getSeedPhrase(std::string &phrase) const;
    void getOutputs(const std::vector<COutPoint>& vOutpoints, std::vector<COutput>& vOutputs);
    bool isSpent(const COutPoint& outpoint) const;
    void listCoins(std::map<QString, std::vector<COutput> >& mapCoins) const;
 
    bool isLockedCoin(uint256 hash, unsigned int n) const;
    void lockCoin(COutPoint& output);
    void unlockCoin(COutPoint& output);
    void listLockedCoins(std::vector<COutPoint>& vOutpts);
 
    std::string GetUniqueWalletBackupName();
    void loadReceiveRequests(std::vector<std::string>& vReceiveRequests);
    bool saveReceiveRequest(const std::string& sAddress, const int64_t nId, const std::string& sRequest);
 
private:
    CWallet* wallet;
    bool fHaveWatchOnly;
    bool fForceCheckBalanceChanged;
 
    // Wallet has an options model for wallet-specific options
    // (transaction fee, for example)
    OptionsModel* optionsModel;
 
    AddressTableModel* addressTableModel;
    TransactionTableModel* transactionTableModel;
    QAbstractTableModel* txTableModel;
 
    // Cache some values to be able to detect changes
    CAmount cachedBalance;
    CAmount cachedUnconfirmedBalance;
    CAmount spendableBalance;
    CAmount cachedImmatureBalance;
    CAmount cachedWatchOnlyBalance;
    CAmount cachedWatchUnconfBalance;
    CAmount cachedWatchImmatureBalance;
    EncryptionStatus cachedEncryptionStatus;
    int cachedNumBlocks;
    int cachedTxLocks;
    QTimer* pollTimer;
 
    void subscribeToCoreSignals();
    void unsubscribeFromCoreSignals();
    bool checkBalanceChanged();
 
Q_SIGNALS:
    // Signal that balance in wallet changed
    void balanceChanged(const CAmount& balance, const CAmount& unconfirmedBalance, const CAmount& immatureBalance, const CAmount& watchOnlyBalance, const CAmount& watchUnconfBalance, const CAmount& watchImmatureBalance);
    void stakingStatusChanged(bool isStaking);
    // Encryption status of wallet changed
    void encryptionStatusChanged(int status);
 
    // 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(AskPassphraseDialog::Context context);
 
    // Fired when a message should be reported to the user
    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);
 
    // Show progress dialog e.g. for rescan
    void showProgress(const QString& title, int nProgress);
 
    // Watch-only address added
    void notifyWatchonlyChanged(bool fHaveWatchonly);
 
    void RefreshRecent();
    void WalletUnlocked();
 
public Q_SLOTS:
    /* Wallet status might have changed */
    void updateStatus();
    /* New transaction, or transaction changed status */
    void updateTransaction();
    /* New, updated or removed address book entry */
    void updateAddressBook(const QString& address, const QString& label, bool isMine, const QString& purpose, int status);
    void updateAddressBook(const QString& pubCoin, const QString& isUsed, int status);
    /* Watch-only added */
    void updateWatchOnlyFlag(bool fHaveWatchonly);
    /* Current, immature or unconfirmed balance might have changed - Q_EMIT 'balanceChanged' if so */
    void pollBalanceChanged();
};
 
namespace WalletUtil
{
// get transaction string maps with keys ["date","address", "amount", "id", "type"]
std::vector<std::map<QString, QString> > getTXs(CWallet* wallet);
std::map<QString, QString> getTx(CWallet* wallet, uint256 hash);
std::map<QString, QString> getTx(CWallet* wallet, CWalletTx tx);
//
QList<QString> getAddressBookData(CWallet* wallet); //return a list of address strings as "description | address"
} // namespace WalletUtil
 
#endif // BITCOIN_QT_WALLETMODEL_H