qml: Introduce WalletModel and loadWallet functionality

When a user selects a wallet from the WalletSelect menu the
wallet controller can now load the wallet data in and the
name and balance will appear in the WalletBadge

Author: johnny9

src/Makefile.qt.include

@@ -43,8 +43,9 @@ QT_MOC_CPP = \
   qml/models/moc_options_model.cpp \
   qml/models/moc_peerlistsortproxy.cpp \
   qml/models/moc_walletlistmodel.cpp \
+  qml/models/moc_walletqmlmodel.cpp \
   qml/moc_appmode.cpp \
-  qml/moc_walletcontroller.cpp \
+  qml/moc_walletqmlcontroller.cpp \
   qt/moc_addressbookpage.cpp \
   qt/moc_addresstablemodel.cpp \
   qt/moc_askpassphrasedialog.cpp \
@@ -124,12 +125,13 @@ BITCOIN_QT_H = \
   qml/models/options_model.h \
   qml/models/peerlistsortproxy.h \
   qml/models/walletlistmodel.h \
+  qml/models/walletqmlmodel.h \
   qml/appmode.h \
   qml/bitcoin.h \
   qml/guiconstants.h \
   qml/imageprovider.h \
   qml/util.h \
-  qml/walletcontroller.h \
+  qml/walletqmlcontroller.h \
   qt/addressbookpage.h \
   qt/addresstablemodel.h \
   qt/askpassphrasedialog.h \
@@ -314,9 +316,10 @@ BITCOIN_QML_BASE_CPP = \
   qml/models/options_model.cpp \
   qml/models/peerlistsortproxy.cpp \
   qml/models/walletlistmodel.cpp \
+  qml/models/walletqmlmodel.cpp \
   qml/imageprovider.cpp \
   qml/util.cpp \
-  qml/walletcontroller.cpp
+  qml/walletqmlcontroller.cpp
 
 QML_RES_FONTS = \
   qml/res/fonts/Inter-Regular.otf \

src/qml/bitcoin.cpp

@@ -27,9 +27,10 @@
 #include <qml/models/options_model.h>
 #include <qml/models/peerlistsortproxy.h>
 #include <qml/models/walletlistmodel.h>
+#include <qml/models/walletqmlmodel.h>
 #include <qml/imageprovider.h>
 #include <qml/util.h>
-#include <qml/walletcontroller.h>
+#include <qml/walletqmlcontroller.h>
 #include <qt/guiutil.h>
 #include <qt/initexecutor.h>
 #include <qt/networkstyle.h>
@@ -258,8 +259,17 @@ int QmlGuiMain(int argc, char* argv[])
 
     NodeModel node_model{*node};
     InitExecutor init_executor{*node};
+#ifdef ENABLE_WALLET
+    WalletQmlController wallet_controller(*node);
+    QObject::connect(&init_executor, &InitExecutor::initializeResult, &wallet_controller, &WalletQmlController::initialize);
+#endif
     QObject::connect(&node_model, &NodeModel::requestedInitialize, &init_executor, &InitExecutor::initialize);
-    QObject::connect(&node_model, &NodeModel::requestedShutdown, &init_executor, &InitExecutor::shutdown);
+    QObject::connect(&node_model, &NodeModel::requestedShutdown, [&] {
+#ifdef ENABLE_WALLET
+        wallet_controller.unloadWallets();
+#endif
+        init_executor.shutdown();
+    });
     QObject::connect(&init_executor, &InitExecutor::initializeResult, &node_model, &NodeModel::initializeResult);
     QObject::connect(&init_executor, &InitExecutor::shutdownResult, qGuiApp, &QGuiApplication::quit, Qt::QueuedConnection);
     // QObject::connect(&init_executor, &InitExecutor::runawayException, &node_model, &NodeModel::handleRunawayException);
@@ -276,8 +286,12 @@ int QmlGuiMain(int argc, char* argv[])
     QObject::connect(&node_model, &NodeModel::setTimeRatioList, &chain_model, &ChainModel::setTimeRatioList);
     QObject::connect(&node_model, &NodeModel::setTimeRatioListInitial, &chain_model, &ChainModel::setTimeRatioListInitial);
 
+
     qGuiApp->setQuitOnLastWindowClosed(false);
     QObject::connect(qGuiApp, &QGuiApplication::lastWindowClosed, [&] {
+#ifdef ENABLE_WALLET
+        wallet_controller.unloadWallets();
+#endif
         node->startShutdown();
     });
 
@@ -288,8 +302,6 @@ int QmlGuiMain(int argc, char* argv[])
     GUIUtil::LoadFont(":/fonts/inter/regular");
     GUIUtil::LoadFont(":/fonts/inter/semibold");
 
-    WalletController wallet_controller(*node);
-
     QQmlApplicationEngine engine;
 
     QScopedPointer<const NetworkStyle> network_style{NetworkStyle::instantiate(Params().GetChainType())};
@@ -316,6 +328,9 @@ int QmlGuiMain(int argc, char* argv[])
     qmlRegisterType<BlockClockDial>("org.bitcoincore.qt", 1, 0, "BlockClockDial");
     qmlRegisterType<LineGraph>("org.bitcoincore.qt", 1, 0, "LineGraph");
 
+    qmlRegisterUncreatableType<WalletQmlModel>("org.bitcoincore.qt", 1, 0, "WalletQmlModel",
+                                               "WalletQmlModel cannot be instantiated from QML");
+
     engine.load(QUrl(QStringLiteral("qrc:///qml/pages/main.qml")));
     if (engine.rootObjects().isEmpty()) {
         return EXIT_FAILURE;

src/qml/models/walletlistmodel.cpp

@@ -12,7 +12,6 @@ WalletListModel::WalletListModel(interfaces::Node& node, QObject *parent)
 : QAbstractListModel(parent)
 , m_node(node)
 {
-    setSelectedWallet("Singlesig Wallet");
 }
 
 void WalletListModel::listWalletDir()
@@ -32,19 +31,6 @@ void WalletListModel::listWalletDir()
     }
 }
 
-void WalletListModel::setSelectedWallet(QString wallet_name)
-{
-    if (m_selected_wallet != wallet_name) {
-        m_selected_wallet = wallet_name;
-        Q_EMIT selectedWalletChanged();
-    }
-}
-
-QString WalletListModel::selectedWallet() const
-{
-    return m_selected_wallet;
-}
-
 int WalletListModel::rowCount(const QModelIndex &parent) const
 {
     Q_UNUSED(parent);

src/qml/models/walletlistmodel.h

@@ -16,7 +16,6 @@ class Node;
 class WalletListModel : public QAbstractListModel
 {
     Q_OBJECT
-    Q_PROPERTY(QString selectedWallet READ selectedWallet WRITE setSelectedWallet NOTIFY selectedWalletChanged)
 
 public:
     WalletListModel(interfaces::Node& node, QObject *parent = nullptr);
@@ -30,15 +29,9 @@ class WalletListModel : public QAbstractListModel
     QVariant data(const QModelIndex &index, int role = Qt::DisplayRole) const override;
     QHash<int, QByteArray> roleNames() const override;
 
-    void setSelectedWallet(QString wallet_name);
-    QString selectedWallet() const;
-
 public Q_SLOTS:
     void listWalletDir();
 
-Q_SIGNALS:
-    void selectedWalletChanged();
-
 private:
     struct Item {
         QString name;
@@ -48,8 +41,6 @@ public Q_SLOTS:
 
     QList<Item> m_items;
     interfaces::Node& m_node;
-    QString m_selected_wallet;
-
 };
 
 #endif // BITCOIN_QML_MODELS_WALLETLISTMODEL_H

src/qml/models/walletqmlmodel.cpp

@@ -0,0 +1,36 @@
+// Copyright (c) 2024 The Bitcoin Core developers
+// Distributed under the MIT software license, see the accompanying
+// file COPYING or http://www.opensource.org/licenses/mit-license.php.
+
+#include <qml/models/walletqmlmodel.h>
+
+#include <qt/bitcoinunits.h>
+
+#include <QTimer>
+
+WalletQmlModel::WalletQmlModel(std::unique_ptr<interfaces::Wallet> wallet, QObject *parent)
+    : QObject(parent)
+{
+    m_wallet = std::move(wallet);
+}
+
+WalletQmlModel::WalletQmlModel(QObject *parent)
+    : QObject(parent)
+{
+}
+
+QString WalletQmlModel::balance() const
+{
+    if (!m_wallet) {
+        return "0";
+    }
+    return BitcoinUnits::format(BitcoinUnits::Unit::BTC, m_wallet->getBalance());
+}
+
+QString WalletQmlModel::name() const
+{
+    if (!m_wallet) {
+        return QString();
+    }
+    return QString::fromStdString(m_wallet->getWalletName());
+}

src/qml/models/walletqmlmodel.h

@@ -0,0 +1,34 @@
+// Copyright (c) 2024 The Bitcoin Core developers
+// Distributed under the MIT software license, see the accompanying
+// file COPYING or http://www.opensource.org/licenses/mit-license.php.
+
+#ifndef BITCOIN_QML_MODELS_WALLETQMLMODEL_H
+#define BITCOIN_QML_MODELS_WALLETQMLMODEL_H
+
+#include <interfaces/wallet.h>
+
+#include <QObject>
+
+class WalletQmlModel : public QObject
+{
+    Q_OBJECT
+    Q_PROPERTY(QString name READ name NOTIFY nameChanged)
+    Q_PROPERTY(QString balance READ balance NOTIFY balanceChanged)
+
+public:
+    WalletQmlModel(std::unique_ptr<interfaces::Wallet> wallet, QObject *parent = nullptr);
+    WalletQmlModel(QObject *parent = nullptr);
+    ~WalletQmlModel() = default;
+
+    QString name() const;
+    QString balance() const;
+
+Q_SIGNALS:
+    void nameChanged();
+    void balanceChanged();
+
+private:
+    std::unique_ptr<interfaces::Wallet> m_wallet;
+};
+
+#endif // BITCOIN_QML_MODELS_WALLETQMLMODEL_H

src/qml/pages/wallet/DesktopWallets.qml

@@ -24,7 +24,8 @@ Page {
         leftItem: WalletBadge {
             implicitWidth: 154
             implicitHeight: 46
-            text: walletListModel.selectedWallet
+            text: walletController.selectedWallet.name
+            balance: walletController.selectedWallet.balance
 
             MouseArea {
                 anchors.fill: parent

src/qml/pages/wallet/WalletBadge.qml

@@ -13,70 +13,6 @@ import "../../controls"
 Button {
     id: root
 
-    function formatSatoshis(satoshis) {
-        var highlightColor = Theme.color.neutral9
-        var zeroColor = Theme.color.neutral7
-
-        if (root.checked || root.hovered) {
-            highlightColor = zeroColor = Theme.color.orange
-        }
-
-        // Convert satoshis to bitcoins
-        var bitcoins = satoshis / 100000000;
-
-        // Format bitcoins to a fixed 8 decimal places string
-        var bitcoinStr = bitcoins.toFixed(8);
-
-        // Split the bitcoin string into integer and fractional parts
-        var parts = bitcoinStr.split('.');
-
-        // Add spaces for every 3 digits in the integer part
-        parts[0] = parts[0].replace(/\B(?=(\d{3})+(?!\d))/g, ' ');
-
-        // Highlight the first significant digit and all following digits in the integer part
-        var significantFound = false;
-        parts[0] = parts[0].replace(/(\d)/g, function(match) {
-            if (!significantFound && match !== '0') {
-                significantFound = true;
-            }
-            if (significantFound) {
-                return '<font color="' + highlightColor + '">' + match + '</font>';
-            }
-            return match;
-        });
-
-        // Add spaces for every 3 digits in the decimal part
-        parts[1] = parts[1].replace(/\B(?=(\d{3})+(?!\d))/g, ' ');
-        if (significantFound) {
-            parts[1] = '<font color="' + highlightColor + '">' + parts[1] + '</font>';
-        } else {
-            // Highlight the first significant digit and all following digits in the fractional part
-            significantFound = false;
-            parts[1] = parts[1].replace(/(\d)/g, function(match) {
-                if (!significantFound && match !== '0') {
-                    significantFound = true;
-                }
-                if (significantFound) {
-                    return '<font color="' + highlightColor + '">' + match + '</font>';
-                }
-                return match;
-            });
-        }
-
-        // Concatenate the parts back together
-        var formattedBitcoins = parts.join('.');
-
-        // Format the text with the Bitcoin symbol
-        var formattedText = `<font color="${highlightColor}">₿</font> ${formattedBitcoins}`;
-
-        // Highlight zero in a different color if satoshis are zero
-        if (satoshis === 0) {
-            formattedText = `<font color="${zeroColor}">₿ 0.00</font>`;
-        }
-
-        return formattedText;
-    }
-
     property color bgActiveColor: Theme.color.neutral2
     property color textColor: Theme.color.neutral7
     property color textHoverColor: Theme.color.orange
@@ -85,17 +21,17 @@ Button {
     property string iconSource: ""
     property bool showBalance: true
     property bool showIcon: true
+    property string balance: "0.0 000 000"
 
     checkable: true
     hoverEnabled: AppMode.isDesktop
     implicitHeight: 60
-    implicitWidth: 220
+    implicitWidth: contentItem.width
     bottomPadding: 0
     topPadding: 0
     clip: true
 
     contentItem: RowLayout {
-        anchors.fill: parent
         anchors.leftMargin: 5
         anchors.rightMargin: 5
         clip: true
@@ -126,7 +62,7 @@ Button {
             CoreText {
                 id: balanceText
                 visible: root.showBalance
-                text: formatSatoshis(12300)
+                text: "₿ " + root.balance
                 color: Theme.color.neutral7
             }
         }

src/qml/pages/wallet/WalletSelect.qml

@@ -77,11 +77,12 @@ Popup {
                 width: 220
                 height: 32
                 text: name
+                checked: walletController.selectedWallet.name == name
                 ButtonGroup.group: buttonGroup
                 showBalance: false
                 showIcon: false
                 onClicked: {
-                    walletListModel.selectedWallet = name
+                    walletController.setSelectedWallet(name)
                     root.close()
                 }
             }