pay/src/AccountInfo.h

/*
 * This file is part of the Flowee project
 * Copyright (C) 2020-2024 Tom Zander <tom@flowee.org>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
#ifndef ACCOUNTINFO_H
#define ACCOUNTINFO_H

#include <QObject>
#include "AccountConfig.h"
#include "WalletHistoryModel.h"
#include "WalletSecretsModel.h"

class TransactionInfo;
class QTimer;

class AccountInfo : public QObject
{
    Q_OBJECT
    /// The wallet amount
    Q_PROPERTY(double balanceConfirmed READ balanceConfirmed NOTIFY balanceChanged)
    Q_PROPERTY(double balanceUnconfirmed READ balanceUnconfirmed NOTIFY balanceChanged)
    Q_PROPERTY(double balanceImmature READ balanceImmature NOTIFY balanceChanged)
    Q_PROPERTY(int unspentOutputCount READ unspentOutputCount NOTIFY utxosChanged)
    Q_PROPERTY(int historicalOutputCount READ historicalOutputCount NOTIFY utxosChanged)
    Q_PROPERTY(int id READ id CONSTANT)
    Q_PROPERTY(int lastBlockSynched READ lastBlockSynched NOTIFY lastBlockSynchedChanged)

    /**
     * This is the oldest block that this account ever might have seen transactions at.
     * Essentially the creation date.
     */
    Q_PROPERTY(int accountStartBlockHeight READ accountStartBlockHeight NOTIFY accountStartBlockHeightChanged FINAL)

    /**
     * This is the first block that on this instantiation we need to sync.
     * This property is useful to determine how much we need to sync this session.
     */
    Q_PROPERTY(int initialBlockHeight READ initialBlockHeight NOTIFY lastBlockSynchedChanged)
    Q_PROPERTY(QDateTime lastBlockSynchedTime READ lastBlockSynchedTime NOTIFY lastBlockSynchedChanged)
    /// Return a user-readable indication of the amount of time 'behind' this account is
    Q_PROPERTY(QString timeBehind READ timeBehind NOTIFY lastBlockSynchedChanged)
    Q_PROPERTY(QString name READ name WRITE setName NOTIFY nameChanged)
    Q_PROPERTY(WalletHistoryModel* transactions READ historyModel NOTIFY modelsChanged)
    Q_PROPERTY(WalletSecretsModel* secrets READ secretsModel NOTIFY modelsChanged)
    Q_PROPERTY(bool isPrimaryAccount READ isPrimaryAccount WRITE setPrimaryAccount NOTIFY isPrimaryAccountChanged)
    Q_PROPERTY(bool isUserOwned READ userOwnedWallet NOTIFY userOwnedChanged)
    Q_PROPERTY(bool isSingleAddressAccount READ isSingleAddressAccount NOTIFY encryptionChanged)
    Q_PROPERTY(bool isHDWallet READ isHDWallet NOTIFY encryptionChanged)
    Q_PROPERTY(bool isArchived READ isArchived WRITE setIsArchived NOTIFY isArchivedChanged)
    Q_PROPERTY(QString mnemonic READ hdWalletMnemonic NOTIFY encryptionChanged)
    Q_PROPERTY(bool isElectrumMnemonic READ isElectrumMnemonic NOTIFY encryptionChanged)
    Q_PROPERTY(QString hdDerivationPath READ hdDerivationPath NOTIFY encryptionChanged)
    Q_PROPERTY(QString xpub READ xpub NOTIFY encryptionChanged)
    Q_PROPERTY(QDateTime lastMinedTransaction READ lastMinedTransaction NOTIFY balanceChanged)
    Q_PROPERTY(bool hasFreshTransactions READ hasFreshTransactions WRITE setHasFreshTransactions NOTIFY hasFreshTransactionsChanged)
    Q_PROPERTY(bool needsPinToPay READ needsPinToPay NOTIFY encryptionChanged)
    Q_PROPERTY(bool needsPinToOpen READ needsPinToOpen NOTIFY encryptionChanged)
    Q_PROPERTY(bool isDecrypted READ isDecrypted NOTIFY encryptionChanged)
    /**
     * If true, please count the balance(s) of this wallet in the app-wide balance
     */
    Q_PROPERTY(bool countBalance READ countBalance WRITE setCountBalance NOTIFY neverEmitted)
    Q_PROPERTY(bool allowInstaPay READ allowInstaPay WRITE setAllowInstaPay NOTIFY instaPayAllowedChanged)
    Q_PROPERTY(bool isPrivate READ isPrivate WRITE setIsPrivate NOTIFY neverEmitted)
public:
    AccountInfo(Wallet *wallet, QObject *parent = nullptr);

    /// the wallet-ID (aka the privacysegments segment-id). Application-unique.
    int id() const;

    /// return the current balance, but only confirmed and spendable
    double balanceConfirmed() const;

    /// return the unconfirmed balance, only not yet confirmed outputs are counted
    double balanceUnconfirmed() const;

    /// Return the balanace of coinbases we are not allowed to spend yet
    double balanceImmature() const;

    /// return the amount of UTXOs that hold money
    int unspentOutputCount() const;
    /// return the amount of UTXOs ever created for this account.
    int historicalOutputCount() const;

    void setName(const QString &name);
    QString name() const;

    int lastBlockSynched() const;
    QDateTime lastBlockSynchedTime() const;
    QString timeBehind() const;

    WalletHistoryModel* historyModel();
    WalletSecretsModel* secretsModel();

    /**
     * Sets a account to be the first to open (aka primary).
     */
    void setPrimaryAccount(bool isPrimary);
    /// returns if a wallet is the Primary wallet
    bool isPrimaryAccount() const;

    // maps to Wallet::userOwnedWallet
    bool userOwnedWallet();

    Q_INVOKABLE TransactionInfo* txInfo(int walletIndex, QObject *parent);
    Q_INVOKABLE void encryptPinToPay(const QString &password);
    Q_INVOKABLE void encryptPinToOpen(const QString &password);
    Q_INVOKABLE bool decrypt(const QString &password);
    /// Remove all secrets from the encrypted wallet.
    Q_INVOKABLE void closeWallet();

    Wallet *wallet() const {
        return m_wallet;
    }

    bool isSingleAddressAccount() const;

    /// return true if the wallet is based on a master key and mnemonic seed.
    bool isHDWallet() const;
    /// Return the mnemonic seed that is the basis of this wallet.
    QString hdWalletMnemonic() const;
    /// Return true if the mnemonic seed is in Electrum format
    bool isElectrumMnemonic() const;
    /// Return the derivation base path that is the basis of this wallet.
    QString hdDerivationPath() const;
    /// Return the XPub for this wallet (or empty if its not a HD wallet)
    QString xpub() const;

    /// Return the model that shares more info about the wallets private keys
    WalletSecretsModel *secretsModel() const;

    /// Returns the date of the last timestamped transaction
    QDateTime lastMinedTransaction() const;

    bool isArchived() const;
    void setIsArchived(bool newIsArchived);

    bool hasFreshTransactions() const;
    void setHasFreshTransactions(bool fresh);

    /**
     * Returns true if a PIN is needed to start a payment.
     * This means that the wallet is either partially or fully encrypted.
     */
    bool needsPinToPay() const;
    /**
     * Returns true if a PIN is needed to open the wallet.
     * This means that the wallet is fully encrypted.
     */
    bool needsPinToOpen() const;
    /**
     * Returs true if the wallet is either not encrypted, or currently decrypted.
     */
    bool isDecrypted() const;

    int initialBlockHeight() const;

    bool countBalance() const;
    void setCountBalance(bool newCountBalance);

    Q_INVOKABLE QStringList instaPayLimitCurrencies() const;
    Q_INVOKABLE int fiatInstaPayLimit(const QString &currencyCode) const;
    Q_INVOKABLE void setFiatInstaPayLimit(const QString &currencyCode, int cents);

    bool allowInstaPay() const;
    void setAllowInstaPay(bool newAllowInstaPay);

    bool isPrivate() const;
    void setIsPrivate(bool newIsPrivate);

    // the first blockheight ever used for this account
    int accountStartBlockHeight() const;

signals:
    void balanceChanged();
    void utxosChanged();
    void nameChanged();
    void lastBlockSynchedChanged();
    void timeBehindChanged();
    void isPrimaryAccountChanged();
    void userOwnedChanged();
    void isArchivedChanged();
    void hasFreshTransactionsChanged();
    void encryptionChanged();
    void modelsChanged();
    void instaPayAllowedChanged();
    void instaPayLimitChanged(const QString &currencyCode);
    void neverEmitted(); // to silence the lambs^Warnings
    void accountStartBlockHeightChanged();

    // for the benefit of the portfolio data provider
    void isPrivateChanged();

private slots:
    // callbacks from wallet
    void balanceHasChanged();
    void walletEncryptionChanged();

private:
    Wallet * const m_wallet;
    AccountConfig m_config;
    QTimer *m_closeWalletTimer = nullptr;
    std::unique_ptr<WalletHistoryModel> m_model;
    std::unique_ptr<WalletSecretsModel> m_secretsModel;
    int m_lastTxHeight = -1; ///< last seen tx blockheight.
    int m_accountStartBlockHeight;
    int m_initialBlockHeight;
    bool m_hasFreshTransactions = false;

    friend class WalletSecret;
};

#endif