cpp: Implement UTXO snapshot loading interface and progress tracking

D33r-Gee · D33r-Gee · commit 508b486cbece · 2025-07-15T09:43:47.000-07:00
- Extend node interface with virtual functions for UTXO snapshot loading
- Add signal mechanism to monitor snapshot loading progress
- Include predefined signet UTXO dataset in chainparams for validation
diff --git a/src/Makefile.qt.include b/src/Makefile.qt.include
@@ -49,6 +49,7 @@ QT_MOC_CPP = \
   qml/models/moc_sendrecipientslistmodel.cpp \
   qml/models/moc_transaction.cpp \
   qml/models/moc_sendrecipient.cpp \
+  qml/models/moc_snapshotqml.cpp \
   qml/models/moc_walletlistmodel.cpp \
   qml/models/moc_walletqmlmodel.cpp \
   qml/models/moc_walletqmlmodel.cpp \
@@ -141,6 +142,7 @@ BITCOIN_QT_H = \
   qml/models/transaction.h \
   qml/models/sendrecipient.h \
   qml/models/sendrecipientslistmodel.h \
+  qml/models/snapshotqml.h \
   qml/models/walletlistmodel.h \
   qml/models/walletqmlmodel.h \
   qml/models/walletqmlmodeltransaction.h \
@@ -343,6 +345,7 @@ BITCOIN_QML_BASE_CPP = \
   qml/models/transaction.cpp \
   qml/models/sendrecipient.cpp \
   qml/models/sendrecipientslistmodel.cpp \
+  qml/models/snapshotqml.cpp \
   qml/models/walletlistmodel.cpp \
   qml/models/walletqmlmodel.cpp \
   qml/models/walletqmlmodeltransaction.cpp \
diff --git a/src/interfaces/node.h b/src/interfaces/node.h
@@ -11,6 +11,7 @@
 #include <net_types.h>                 // For banmap_t
 #include <netaddress.h>                // For Network
 #include <netbase.h>                   // For ConnectionDirection
+#include <node/utxo_snapshot.h>         // For SnapshotMetadata
 #include <support/allocators/secure.h> // For SecureString
 #include <util/translation.h>
 
@@ -208,6 +209,9 @@ class Node
     //! List rpc commands.
     virtual std::vector<std::string> listRpcCommands() = 0;
 
+    //! Load UTXO Snapshot.
+    virtual bool loadSnapshot(AutoFile& afile, const node::SnapshotMetadata& metadata, bool in_memory) = 0;
+
     //! Set RPC timer interface if unset.
     virtual void rpcSetTimerInterfaceIfUnset(RPCTimerInterface* iface) = 0;
 
@@ -243,6 +247,10 @@ class Node
     using ShowProgressFn = std::function<void(const std::string& title, int progress, bool resume_possible)>;
     virtual std::unique_ptr<Handler> handleShowProgress(ShowProgressFn fn) = 0;
 
+    //! Register handler for snapshot load progress.
+    using SnapshotLoadProgressFn = std::function<void(double progress)>;
+    virtual std::unique_ptr<Handler> handleSnapshotLoadProgress(SnapshotLoadProgressFn fn) = 0;
+
     //! Register handler for wallet loader constructed messages.
     using InitWalletFn = std::function<void()>;
     virtual std::unique_ptr<Handler> handleInitWallet(InitWalletFn fn) = 0;
diff --git a/src/kernel/chainparams.cpp b/src/kernel/chainparams.cpp
@@ -371,6 +371,13 @@ class SigNetParams : public CChainParams {
 
         vFixedSeeds.clear();
 
+        m_assumeutxo_data = MapAssumeutxo{
+            {
+                160000,
+                {AssumeutxoHash{uint256S("0x5225141cb62dee63ab3be95f9b03d60801f264010b1816d4bd00618b2736e7be")}, 1278002},
+            },
+        };
+
         base58Prefixes[PUBKEY_ADDRESS] = std::vector<unsigned char>(1,111);
         base58Prefixes[SCRIPT_ADDRESS] = std::vector<unsigned char>(1,196);
         base58Prefixes[SECRET_KEY] =     std::vector<unsigned char>(1,239);
diff --git a/src/kernel/notifications_interface.h b/src/kernel/notifications_interface.h
@@ -40,6 +40,7 @@ class Notifications
     [[nodiscard]] virtual InterruptResult blockTip(SynchronizationState state, CBlockIndex& index) { return {}; }
     virtual void headerTip(SynchronizationState state, int64_t height, int64_t timestamp, bool presync) {}
     virtual void progress(const bilingual_str& title, int progress_percent, bool resume_possible) {}
+    virtual void snapshotLoadProgress(double progress) {}
     virtual void warning(const bilingual_str& warning) {}
 
     //! The flush error notification is sent to notify the user that an error
diff --git a/src/node/interface_ui.cpp b/src/node/interface_ui.cpp
@@ -21,6 +21,7 @@ struct UISignals {
     boost::signals2::signal<CClientUIInterface::NotifyNetworkActiveChangedSig> NotifyNetworkActiveChanged;
     boost::signals2::signal<CClientUIInterface::NotifyAlertChangedSig> NotifyAlertChanged;
     boost::signals2::signal<CClientUIInterface::ShowProgressSig> ShowProgress;
+    boost::signals2::signal<CClientUIInterface::SnapshotLoadProgressSig> SnapshotLoadProgress;
     boost::signals2::signal<CClientUIInterface::NotifyBlockTipSig> NotifyBlockTip;
     boost::signals2::signal<CClientUIInterface::NotifyHeaderTipSig> NotifyHeaderTip;
     boost::signals2::signal<CClientUIInterface::BannedListChangedSig> BannedListChanged;
@@ -44,6 +45,7 @@ ADD_SIGNALS_IMPL_WRAPPER(ShowProgress);
 ADD_SIGNALS_IMPL_WRAPPER(NotifyBlockTip);
 ADD_SIGNALS_IMPL_WRAPPER(NotifyHeaderTip);
 ADD_SIGNALS_IMPL_WRAPPER(BannedListChanged);
+ADD_SIGNALS_IMPL_WRAPPER(SnapshotLoadProgress);
 
 bool CClientUIInterface::ThreadSafeMessageBox(const bilingual_str& message, const std::string& caption, unsigned int style) { return g_ui_signals.ThreadSafeMessageBox(message, caption, style).value_or(false);}
 bool CClientUIInterface::ThreadSafeQuestion(const bilingual_str& message, const std::string& non_interactive_message, const std::string& caption, unsigned int style) { return g_ui_signals.ThreadSafeQuestion(message, non_interactive_message, caption, style).value_or(false);}
@@ -53,6 +55,7 @@ void CClientUIInterface::NotifyNumConnectionsChanged(PeersNumByType newNumConnec
 void CClientUIInterface::NotifyNetworkActiveChanged(bool networkActive) { return g_ui_signals.NotifyNetworkActiveChanged(networkActive); }
 void CClientUIInterface::NotifyAlertChanged() { return g_ui_signals.NotifyAlertChanged(); }
 void CClientUIInterface::ShowProgress(const std::string& title, int nProgress, bool resume_possible) { return g_ui_signals.ShowProgress(title, nProgress, resume_possible); }
+void CClientUIInterface::SnapshotLoadProgress(double progress) { return g_ui_signals.SnapshotLoadProgress(progress); }
 void CClientUIInterface::NotifyBlockTip(SynchronizationState s, const CBlockIndex* i) { return g_ui_signals.NotifyBlockTip(s, i); }
 void CClientUIInterface::NotifyHeaderTip(SynchronizationState s, int64_t height, int64_t timestamp, bool presync) { return g_ui_signals.NotifyHeaderTip(s, height, timestamp, presync); }
 void CClientUIInterface::BannedListChanged() { return g_ui_signals.BannedListChanged(); }
diff --git a/src/node/interface_ui.h b/src/node/interface_ui.h
@@ -110,6 +110,9 @@ class CClientUIInterface
      */
     ADD_SIGNALS_DECL_WRAPPER(ShowProgress, void, const std::string& title, int nProgress, bool resume_possible);
 
+    /** Snapshot load progress. */
+    ADD_SIGNALS_DECL_WRAPPER(SnapshotLoadProgress, void, double progress);
+
     /** New block has been accepted */
     ADD_SIGNALS_DECL_WRAPPER(NotifyBlockTip, void, SynchronizationState, const CBlockIndex*);
 
diff --git a/src/node/interfaces.cpp b/src/node/interfaces.cpp
@@ -29,6 +29,7 @@
 #include <node/context.h>
 #include <node/interface_ui.h>
 #include <node/transaction.h>
+#include <node/utxo_snapshot.h>
 #include <policy/feerate.h>
 #include <policy/fees.h>
 #include <policy/policy.h>
@@ -378,6 +379,10 @@ class NodeImpl : public Node
     {
         return MakeSignalHandler(::uiInterface.ShowProgress_connect(fn));
     }
+    std::unique_ptr<Handler> handleSnapshotLoadProgress(SnapshotLoadProgressFn fn) override
+    {
+        return MakeSignalHandler(::uiInterface.SnapshotLoadProgress_connect(fn));
+    }
     std::unique_ptr<Handler> handleInitWallet(InitWalletFn fn) override
     {
         return MakeSignalHandler(::uiInterface.InitWallet_connect(fn));
@@ -417,6 +422,10 @@ class NodeImpl : public Node
     {
         m_context = context;
     }
+    bool loadSnapshot(AutoFile& afile, const node::SnapshotMetadata& metadata, bool in_memory) override
+    {
+        return chainman().ActivateSnapshot(afile, metadata, in_memory);
+    }
     ArgsManager& args() { return *Assert(Assert(m_context)->args); }
     ChainstateManager& chainman() { return *Assert(m_context->chainman); }
     NodeContext* m_context{nullptr};
@@ -532,7 +541,7 @@ class RpcHandlerImpl : public Handler
 class ChainImpl : public Chain
 {
 public:
-    explicit ChainImpl(NodeContext& node) : m_node(node) {}
+    explicit ChainImpl(node::NodeContext& node) : m_node(node) {}
     std::optional<int> getHeight() override
     {
         const int height{WITH_LOCK(::cs_main, return chainman().ActiveChain().Height())};
diff --git a/src/node/kernel_notifications.cpp b/src/node/kernel_notifications.cpp
@@ -78,6 +78,11 @@ void KernelNotifications::progress(const bilingual_str& title, int progress_perc
     uiInterface.ShowProgress(title.translated, progress_percent, resume_possible);
 }
 
+void KernelNotifications::snapshotLoadProgress(double progress)
+{
+    uiInterface.SnapshotLoadProgress(progress);
+}
+
 void KernelNotifications::warning(const bilingual_str& warning)
 {
     DoWarning(warning);
diff --git a/src/node/kernel_notifications.h b/src/node/kernel_notifications.h
@@ -31,6 +31,8 @@ class KernelNotifications : public kernel::Notifications
 
     void progress(const bilingual_str& title, int progress_percent, bool resume_possible) override;
 
+    void snapshotLoadProgress(double progress) override;
+
     void warning(const bilingual_str& warning) override;
 
     void flushError(const std::string& debug_message) override;
diff --git a/src/qml/components/ConnectionSettings.qml b/src/qml/components/ConnectionSettings.qml
@@ -39,7 +39,7 @@ ColumnLayout {
         onClicked: root.gotoSnapshot()
     }
     Separator {
-            visible: !root.onboarding && !snapshotImportCompleted
+            visible: !root.onboarding && !snapshotImportCompleted && !root.isIBDCompleted
         Layout.fillWidth: true
     }
     Setting {
diff --git a/src/qml/models/chainmodel.cpp b/src/qml/models/chainmodel.cpp
@@ -9,9 +9,13 @@
 #include <QThread>
 #include <QTime>
 #include <interfaces/chain.h>
+#include <node/utxo_snapshot.h>
+#include <kernel/chainparams.h>
+#include <validation.h>
 
 ChainModel::ChainModel(interfaces::Chain& chain)
     : m_chain{chain}
+    //   m_params{Params()}
 {
     QTimer* timer = new QTimer();
     connect(timer, &QTimer::timeout, this, &ChainModel::setCurrentTimeRatio);
@@ -101,3 +105,29 @@ void ChainModel::setCurrentTimeRatio()
 
     Q_EMIT timeRatioListChanged();
 }
+
+// TODO: Change this once a better solution has been found.
+// Using hardcoded snapshot info to display in SnapshotSettings.qml
+QVariantMap ChainModel::getSnapshotInfo() {
+    QVariantMap snapshot_info;
+
+   const MapAssumeutxo& valid_assumeutxos_map = Params().Assumeutxo();
+    if (!valid_assumeutxos_map.empty()) {
+        const int height = valid_assumeutxos_map.rbegin()->first;
+        const auto& hash_serialized = valid_assumeutxos_map.rbegin()->second.hash_serialized;
+        int64_t date = m_chain.getBlockTime(height);
+
+        QString fullHash = QString::fromStdString(hash_serialized.ToString());
+
+        int midPoint = fullHash.length() / 2;
+        QString firstHalf = fullHash.left(midPoint);
+        QString secondHalf = fullHash.mid(midPoint);
+
+        snapshot_info["height"] = height;
+        snapshot_info["hashSerializedFirstHalf"] = firstHalf;
+        snapshot_info["hashSerializedSecondHalf"] = secondHalf;
+        snapshot_info["date"] = QDateTime::fromSecsSinceEpoch(date).toString("MMMM d yyyy");
+    }
+
+    return snapshot_info;
+}
diff --git a/src/qml/models/chainmodel.h b/src/qml/models/chainmodel.h
@@ -27,6 +27,7 @@ class ChainModel : public QObject
     Q_PROPERTY(quint64 assumedBlockchainSize READ assumedBlockchainSize CONSTANT)
     Q_PROPERTY(quint64 assumedChainstateSize READ assumedChainstateSize CONSTANT)
     Q_PROPERTY(QVariantList timeRatioList READ timeRatioList NOTIFY timeRatioListChanged)
+    Q_PROPERTY(bool isSnapshotActive READ isSnapshotActive NOTIFY isSnapshotActiveChanged)
 
 public:
     explicit ChainModel(interfaces::Chain& chain);
@@ -36,18 +37,21 @@ class ChainModel : public QObject
     quint64 assumedBlockchainSize() const { return m_assumed_blockchain_size; };
     quint64 assumedChainstateSize() const { return m_assumed_chainstate_size; };
     QVariantList timeRatioList() const { return m_time_ratio_list; };
-
+    bool isSnapshotActive() const { return m_chain.hasAssumedValidChain(); };
     int timestampAtMeridian();
 
     void setCurrentTimeRatio();
 
+    Q_INVOKABLE QVariantMap getSnapshotInfo();
+
 public Q_SLOTS:
     void setTimeRatioList(int new_time);
     void setTimeRatioListInitial();
 
 Q_SIGNALS:
     void timeRatioListChanged();
     void currentNetworkNameChanged();
+    void isSnapshotActiveChanged();
 
 private:
     QString m_current_network_name;
diff --git a/src/qml/models/nodemodel.cpp b/src/qml/models/nodemodel.cpp
@@ -3,6 +3,7 @@
 // file COPYING or http://www.opensource.org/licenses/mit-license.php.
 
 #include <qml/models/nodemodel.h>
+#include <qml/models/snapshotqml.h>
 
 #include <interfaces/node.h>
 #include <net.h>
@@ -14,14 +15,19 @@
 
 #include <QDateTime>
 #include <QMetaObject>
+#include <QObject>
 #include <QTimerEvent>
 #include <QString>
+#include <QUrl>
+#include <QThread>
+#include <QDebug>
 
 NodeModel::NodeModel(interfaces::Node& node)
     : m_node{node}
 {
     ConnectToBlockTipSignal();
     ConnectToNumConnectionsChangedSignal();
+    ConnectToSnapshotLoadProgressSignal();
 }
 
 void NodeModel::setBlockTipHeight(int new_height)
@@ -80,6 +86,14 @@ void NodeModel::setVerificationProgress(double new_progress)
     if (new_progress != m_verification_progress) {
         setRemainingSyncTime(new_progress);
 
+        if (new_progress >= 0.00001) {
+            setHeadersSynced(true);
+        }
+
+        if (new_progress >= 0.999) {
+            setIsIBDCompleted(true);
+        }
+
         m_verification_progress = new_progress;
         Q_EMIT verificationProgressChanged();
     }
@@ -176,3 +190,58 @@ QString NodeModel::defaultProxyAddress()
 {
     return QString::fromStdString(m_node.defaultProxyAddress());
 }
+
+void NodeModel::ConnectToSnapshotLoadProgressSignal()
+{
+    assert(!m_handler_snapshot_load_progress);
+
+    m_handler_snapshot_load_progress = m_node.handleSnapshotLoadProgress(
+        [this](double progress) {
+            setSnapshotProgress(progress);
+        });
+}
+
+void NodeModel::snapshotLoadThread(QString path_file) {
+    m_snapshot_loading = true;
+    Q_EMIT snapshotLoadingChanged();
+
+    path_file = QUrl(path_file).toLocalFile();
+
+    QThread* snapshot_thread = QThread::create([this, path_file]() {
+        SnapshotQml loader(m_node, path_file);
+        bool result = loader.processPath();
+        if (!result) {
+            m_snapshot_loading = false;
+            Q_EMIT snapshotLoadingChanged();
+        } else {
+            m_snapshot_loaded = true;
+            Q_EMIT snapshotLoaded(result);
+            Q_EMIT snapshotLoadingChanged();
+        }
+    });
+
+    connect(snapshot_thread, &QThread::finished, snapshot_thread, &QThread::deleteLater);
+
+    snapshot_thread->start();
+}
+
+void NodeModel::setSnapshotProgress(double new_progress) {
+    if (new_progress != m_snapshot_progress) {
+        m_snapshot_progress = new_progress;
+        Q_EMIT snapshotProgressChanged();
+    }
+}
+
+void NodeModel::setHeadersSynced(bool new_synced) {
+    if (new_synced != m_headers_synced) {
+        m_headers_synced = new_synced;
+        Q_EMIT headersSyncedChanged();
+    }
+}
+
+void NodeModel::setIsIBDCompleted(bool new_completed) {
+    if (new_completed != m_is_ibd_completed) {
+        m_is_ibd_completed = new_completed;
+        Q_EMIT isIBDCompletedChanged();
+    }
+}
diff --git a/src/qml/models/nodemodel.h b/src/qml/models/nodemodel.h
diff --git a/src/qml/models/snapshotqml.cpp b/src/qml/models/snapshotqml.cpp
diff --git a/src/qml/models/snapshotqml.h b/src/qml/models/snapshotqml.h
diff --git a/src/qml/pages/settings/SettingsConnection.qml b/src/qml/pages/settings/SettingsConnection.qml
diff --git a/src/validation.cpp b/src/validation.cpp

Original file line number	Diff line number	Diff line change
`@@ -29,6 +29,7 @@`
`29`	`29`	`#include <node/context.h>`
`30`	`30`	`#include <node/interface_ui.h>`
`31`	`31`	`#include <node/transaction.h>`
	`32`	`+#include <node/utxo_snapshot.h>`
`32`	`33`	`#include <policy/feerate.h>`
`33`	`34`	`#include <policy/fees.h>`
`34`	`35`	`#include <policy/policy.h>`
`@@ -378,6 +379,10 @@ class NodeImpl : public Node`
`378`	`379`	`{`
`379`	`380`	`return MakeSignalHandler(::uiInterface.ShowProgress_connect(fn));`
`380`	`381`	`}`
	`382`	`+ std::unique_ptr<Handler> handleSnapshotLoadProgress(SnapshotLoadProgressFn fn) override`
	`383`	`+ {`
	`384`	`+ return MakeSignalHandler(::uiInterface.SnapshotLoadProgress_connect(fn));`
	`385`	`+ }`
`381`	`386`	`std::unique_ptr<Handler> handleInitWallet(InitWalletFn fn) override`
`382`	`387`	`{`
`383`	`388`	`return MakeSignalHandler(::uiInterface.InitWallet_connect(fn));`
`@@ -417,6 +422,10 @@ class NodeImpl : public Node`
`417`	`422`	`{`
`418`	`423`	`m_context = context;`
`419`	`424`	`}`
	`425`	`+ bool loadSnapshot(AutoFile& afile, const node::SnapshotMetadata& metadata, bool in_memory) override`
	`426`	`+ {`
	`427`	`+ return chainman().ActivateSnapshot(afile, metadata, in_memory);`
	`428`	`+ }`
`420`	`429`	`ArgsManager& args() { return *Assert(Assert(m_context)->args); }`
`421`	`430`	`ChainstateManager& chainman() { return *Assert(m_context->chainman); }`
`422`	`431`	`NodeContext* m_context{nullptr};`
`@@ -532,7 +541,7 @@ class RpcHandlerImpl : public Handler`
`532`	`541`	`class ChainImpl : public Chain`
`533`	`542`	`{`
`534`	`543`	`public:`
`535`		`- explicit ChainImpl(NodeContext& node) : m_node(node) {}`
	`544`	`+ explicit ChainImpl(node::NodeContext& node) : m_node(node) {}`
`536`	`545`	`std::optional<int> getHeight() override`
`537`	`546`	`{`
`538`	`547`	`const int height{WITH_LOCK(::cs_main, return chainman().ActiveChain().Height())};`
Original file line number	Diff line number	Diff line change
`@@ -78,6 +78,11 @@ void KernelNotifications::progress(const bilingual_str& title, int progress_perc`
`78`	`78`	`uiInterface.ShowProgress(title.translated, progress_percent, resume_possible);`
`79`	`79`	`}`
`80`	`80`
	`81`	`+void KernelNotifications::snapshotLoadProgress(double progress)`
	`82`	`+{`
	`83`	`+ uiInterface.SnapshotLoadProgress(progress);`
	`84`	`+}`
	`85`	`+`
`81`	`86`	`void KernelNotifications::warning(const bilingual_str& warning)`
`82`	`87`	`{`
`83`	`88`	`DoWarning(warning);`
Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,7 @@ ColumnLayout {`
`39`	`39`	`onClicked: root.gotoSnapshot()`
`40`	`40`	`}`
`41`	`41`	`Separator {`
`42`		`- visible: !root.onboarding && !snapshotImportCompleted`
	`42`	`+ visible: !root.onboarding && !snapshotImportCompleted && !root.isIBDCompleted`
`43`	`43`	`Layout.fillWidth: true`
`44`	`44`	`}`
`45`	`45`	`Setting {`