qml: Introduce Generate Snapshot page and wiring

This commit adds the Snapshot Gen files to the Connection Settings page. It wires the generate snapshot functionality through the node model and expands the snapshot qml worker class.

Author: D33r-Gee

src/Makefile.qt.include

@@ -382,6 +382,7 @@ QML_RES_QML = \
   qml/components/NetworkIndicator.qml \
   qml/components/ProxySettings.qml \
   qml/components/Separator.qml \
+  qml/components/SnapshotGenSettings.qml \
   qml/components/SnapshotSettings.qml \
   qml/components/StorageLocations.qml \
   qml/components/StorageOptions.qml \
@@ -439,6 +440,7 @@ QML_RES_QML = \
   qml/pages/settings/SettingsDisplay.qml \
   qml/pages/settings/SettingsProxy.qml \
   qml/pages/settings/SettingsSnapshot.qml \
+  qml/pages/settings/SettingsSnapshotGen.qml \
   qml/pages/settings/SettingsStorage.qml \
   qml/pages/settings/SettingsTheme.qml \
   qml/pages/wallet/CreateBackup.qml \

src/qml/bitcoin_qml.qrc

@@ -15,6 +15,7 @@
         <file>components/ProxySettings.qml</file>
         <file>components/StorageLocations.qml</file>
         <file>components/Separator.qml</file>
+        <file>components/SnapshotGenSettings.qml</file>
         <file>components/SnapshotSettings.qml</file>
         <file>components/StorageOptions.qml</file>
         <file>components/StorageSettings.qml</file>
@@ -70,6 +71,7 @@
         <file>pages/settings/SettingsDeveloper.qml</file>
         <file>pages/settings/SettingsDisplay.qml</file>
         <file>pages/settings/SettingsProxy.qml</file>
+        <file>pages/settings/SettingsSnapshotGen.qml</file>
         <file>pages/settings/SettingsSnapshot.qml</file>
         <file>pages/settings/SettingsStorage.qml</file>
         <file>pages/settings/SettingsTheme.qml</file>

src/qml/components/ConnectionSettings.qml

@@ -11,10 +11,40 @@ ColumnLayout {
     id: root
     signal next
     signal gotoSnapshot
+    signal gotoGenerateSnapshot
     property bool snapshotImportCompleted: chainModel.isSnapshotActive
     property bool onboarding: false
+    property bool generateSnapshot: false
+    property bool isSnapshotGenerated: nodeModel.isSnapshotGenerated
 
     spacing: 4
+    Setting {
+        id: gotoGenerateSnapshot
+        visible: !root.onboarding
+        Layout.fillWidth: true
+        header: qsTr("Generate snapshot")
+        description: qsTr("Speed up the setup of other nodes")
+        actionItem: Item {
+            width: 26
+            height: 26
+            CaretRightIcon {
+                anchors.centerIn: parent
+                color: gotoGenerateSnapshot.stateColor
+            }
+        }
+        onClicked: {
+            if (!nodeModel.isSnapshotFileExists()) {
+                root.generateSnapshot = true
+                root.gotoGenerateSnapshot()
+            } else {
+                root.gotoGenerateSnapshot()
+            }
+        }
+    }
+    Separator {
+        visible: !root.onboarding
+        Layout.fillWidth: true
+    }
     Setting {
         id: gotoSnapshot
         visible: !root.onboarding

src/qml/components/SnapshotGenSettings.qml

@@ -0,0 +1,208 @@
+// Copyright (c) 2023-present The Bitcoin Core developers
+// Distributed under the MIT software license, see the accompanying
+// file COPYING or http://www.opensource.org/licenses/mit-license.php.
+
+import QtQuick 2.15
+import QtQuick.Controls 2.15
+import QtQuick.Layouts 1.15
+import QtQuick.Dialogs 1.3
+
+import "../controls"
+import "../controls/utils.js" as Utils
+
+
+ColumnLayout {
+    id: columnLayout
+    signal back
+    property bool onboarding: false
+    property bool generateSnapshot: false
+    property string selectedFile: ""
+    property bool snapshotGenerating: nodeModel.snapshotGenerating
+    property bool isPruned: optionsModel.prune
+    property bool isIBDCompleted: nodeModel.isIBDCompleted
+    property bool isSnapshotGenerated: nodeModel.isSnapshotGenerated
+    property var snapshotInfo: isSnapshotGenerated ? chainModel.getSnapshotInfo() : ({})
+    property bool isRewinding: nodeModel.isRewinding
+
+
+    width: Math.min(parent.width, 450)
+    anchors.horizontalCenter: parent.horizontalCenter
+
+    StackLayout {
+        id: genSettingsStack
+        currentIndex: snapshotGenerating ? 1 : isSnapshotGenerated ? 2 : generateSnapshot ? 0 : onboarding ? 0 : 0
+
+        ColumnLayout {
+            // index: 0
+            Layout.alignment: Qt.AlignHCenter
+            Layout.preferredWidth: Math.min(parent.width, 450)
+
+            Image {
+                Layout.alignment: Qt.AlignCenter
+                source: "image://images/circle-file"
+                sourceSize.width: 200
+                sourceSize.height: 200
+            }
+
+            Header {
+                Layout.fillWidth: true
+                Layout.topMargin: 20
+                headerBold: true
+                header: qsTr("Generate snapshot")
+                descriptionBold: false
+                descriptionColor: Theme.color.neutral6
+                descriptionSize: 17
+                descriptionLineHeight: 1.1
+                description: isPruned ? qsTr("A snapshot captures the current state of bitcoin transactions on the network. It can be imported into other bitcoin nodes to speed up the initial setup.\n\nCannot generate snapshot when pruning is enabled") : isIBDCompleted ? qsTr("A snapshot captures the current state of bitcoin transactions on the network. It can be imported into other bitcoin nodes to speed up the initial setup.\n\nYou can generate a snapshot of the current chain state.") : qsTr("A snapshot captures the current state of bitcoin transactions on the network. It can be imported into other bitcoin nodes to speed up the initial setup.\n\nSnapshot generation is available once the initial block download is complete.")
+            }
+
+            ContinueButton {
+                Layout.preferredWidth: Math.min(300, columnLayout.width - 2 * Layout.leftMargin)
+                Layout.topMargin: 40
+                Layout.alignment: Qt.AlignCenter
+                text: qsTr("Generate")
+                enabled: !isPruned && isIBDCompleted
+                onClicked: {
+                    nodeModel.generateSnapshotThread()
+                    console.log("UI Is Snapshot generated", isSnapshotGenerated)
+                }
+            }
+        }
+
+        ColumnLayout {
+            // index: 1
+            Layout.alignment: Qt.AlignHCenter
+            Layout.preferredWidth: Math.min(parent.width, 450)
+
+            Image {
+                Layout.alignment: Qt.AlignCenter
+                source: "image://images/circle-file"
+                sourceSize.width: 200
+                sourceSize.height: 200
+            }
+
+            Header {
+                Layout.fillWidth: true
+                Layout.topMargin: 20
+                headerBold: true
+                header: qsTr("Generating Snapshot")
+                description: isRewinding ? qsTr("Rewinding...\nThis might take a while...") : qsTr("Restoring...\nThis might take a while...")
+            }
+
+            ProgressIndicator {
+                id: generatingProgressIndicator
+                Layout.topMargin: 20
+                width: 200
+                height: 20
+                progress: nodeModel.snapshotGenerating ? nodeModel.rewindProgress : 0
+                Layout.alignment: Qt.AlignCenter
+                progressColor: Theme.color.blue
+            }
+        }
+
+        ColumnLayout {
+            // index: 2
+            id: snapshotGeneratedColumn
+            Layout.alignment: Qt.AlignHCenter
+            Layout.preferredWidth: Math.min(parent.width, 450)
+
+            Image {
+                Layout.alignment: Qt.AlignCenter
+                source: "image://images/circle-green-check"
+                sourceSize.width: 60
+                sourceSize.height: 60
+            }
+
+            Header {
+                Layout.fillWidth: true
+                Layout.topMargin: 20
+                headerBold: true
+                header: qsTr("Snapshot Generated")
+                descriptionBold: false
+                descriptionColor: Theme.color.neutral6
+                descriptionSize: 17
+                descriptionLineHeight: 1.1
+                description: snapshotInfo && snapshotInfo["date"] ?
+                    qsTr("It contains transactions up to %1." +
+                    " You can use this snapshot to quickstart other nodes.").arg(snapshotInfo["date"])
+                    : qsTr("It contains transactions up to DEBUG. You can use this snapshot to quickstart other nodes.")
+            }
+
+            TextButton {
+                Layout.alignment: Qt.AlignCenter
+                text: qsTr("Generate new snapshot")
+                onClicked: {
+                    nodeModel.generateSnapshotThread()
+                }
+            }
+
+            ContinueButton {
+                Layout.preferredWidth: Math.min(300, columnLayout.width - 2 * Layout.leftMargin)
+                Layout.topMargin: 20
+                Layout.alignment: Qt.AlignCenter
+                text: qsTr("View file")
+                borderColor: Theme.color.neutral6
+                backgroundColor: "transparent"
+                onClicked: viewSnapshotFileDialog.open()
+            }
+
+            FileDialog {
+                id: viewSnapshotFileDialog
+                folder: nodeModel.getSnapshotDirectory()
+                selectMultiple: false
+                selectExisting: true
+                nameFilters: ["Snapshot files (*.dat)", "All files (*)"]
+            }
+
+            Setting {
+                id: snapshotGeneratedViewDetails
+                Layout.alignment: Qt.AlignCenter
+                header: qsTr("View details")
+                actionItem: CaretRightIcon {
+                    id: snapshotGeneratedCaretIcon
+                    color: snapshotGeneratedViewDetails.stateColor
+                    rotation: snapshotGeneratedViewDetails.expanded ? 90 : 0
+                    Behavior on rotation { NumberAnimation { duration: 200 } }
+                }
+
+                property bool expanded: false
+
+                onClicked: {
+                    expanded = !expanded
+                }
+            }
+
+            ColumnLayout {
+                id: snapshotGeneratedDetailsContent
+                visible: snapshotGeneratedViewDetails.expanded
+                Layout.preferredWidth: Math.min(300, parent.width - 2 * Layout.leftMargin)
+                Layout.alignment: Qt.AlignCenter
+                Layout.leftMargin: 80
+                Layout.rightMargin: 80
+                Layout.topMargin: 10
+                spacing: 10
+                // TODO: make sure the block height number aligns right
+                RowLayout {
+                    CoreText {
+                        text: qsTr("Block Height:")
+                        Layout.alignment: Qt.AlignLeft
+                        font.pixelSize: 14
+                    }
+                    CoreText {
+                        text: snapshotInfo && snapshotInfo["height"] ?
+                            snapshotInfo["height"] : qsTr("DEBUG")
+                        Layout.alignment: Qt.AlignRight
+                        font.pixelSize: 14
+                    }
+                }
+                Separator { Layout.fillWidth: true }
+                CoreText {
+                    text: snapshotInfo && snapshotInfo["hashSerialized"] ?
+                        qsTr("Hash: %1").arg(snapshotInfo["hashSerialized"].substring(0, 13) + "...") :
+                        qsTr("Hash: DEBUG")
+                    font.pixelSize: 14
+                }
+            }
+        }
+    }
+}

src/qml/models/nodemodel.cpp

@@ -28,6 +28,7 @@ NodeModel::NodeModel(interfaces::Node& node)
     ConnectToBlockTipSignal();
     ConnectToNumConnectionsChangedSignal();
     ConnectToSnapshotLoadProgressSignal();
+    ConnectToRewindProgressSignal();
 }
 
 void NodeModel::setBlockTipHeight(int new_height)
@@ -157,7 +158,9 @@ void NodeModel::ConnectToBlockTipSignal()
             QMetaObject::invokeMethod(this, [=] {
                 setBlockTipHeight(tip.block_height);
                 setVerificationProgress(verification_progress);
-
+                if (verification_progress >= 0.99) {
+                    setIBDCompleted(true);
+                }
                 Q_EMIT setTimeRatioList(tip.block_time);
             });
         });
@@ -193,6 +196,20 @@ void NodeModel::ConnectToSnapshotLoadProgressSignal()
         });
 }
 
+void NodeModel::ConnectToRewindProgressSignal()
+{
+    assert(!m_handler_rewind_progress);
+
+    m_handler_rewind_progress = m_node.handleRewindProgress(
+        [this](double progress) {
+            if (isRewinding()) {
+                setRewindProgress(1.0 - progress);
+            } else {
+                setRewindProgress(progress);
+            }
+        });
+}
+
 void NodeModel::snapshotLoadThread(QString path_file) {
     m_snapshot_loading = true;
     Q_EMIT snapshotLoadingChanged();
@@ -223,3 +240,71 @@ void NodeModel::setSnapshotProgress(double new_progress) {
         Q_EMIT snapshotProgressChanged();
     }
 }
+
+void NodeModel::cancelSnapshotGeneration() {
+    m_snapshot_cancel = true;
+    m_snapshot_generating = false;
+    Q_EMIT snapshotGeneratingChanged();
+}
+
+void NodeModel::generateSnapshotThread() {
+    QString path_file = "";
+    m_snapshot_generating = true;
+    Q_EMIT snapshotGeneratingChanged();
+
+    QThread* generate_snapshot_thread = QThread::create([this, path_file]() {
+        SnapshotQml generator(m_node, path_file);
+        generator.setSnapshotCancel(&m_snapshot_cancel);
+        connect(&generator, &SnapshotQml::isRewindingChanged, this, [this, &generator]() {
+            setIsRewinding(generator.isRewinding());
+        });
+        generator.SnapshotGen();
+        m_snapshot_generating = false;
+        Q_EMIT snapshotGeneratingChanged();
+        setIsSnapshotGenerated(true);
+    });
+
+    connect(generate_snapshot_thread, &QThread::finished, generate_snapshot_thread, &QThread::deleteLater);
+
+    generate_snapshot_thread->start();
+}
+
+QUrl NodeModel::getSnapshotDirectory() {
+    return QUrl::fromLocalFile(SnapshotQml(m_node, "").getSnapshotDirectory());
+}
+
+bool NodeModel::isSnapshotFileExists() {
+    bool result = SnapshotQml(m_node, "").isSnapshotFileExists();
+    if (result) {
+        setIsSnapshotGenerated(true);
+    }
+    return result;
+}
+
+void NodeModel::setIBDCompleted(bool completed) {
+    if (completed != m_is_ibd_completed) {
+        m_is_ibd_completed = completed;
+        Q_EMIT isIBDCompletedChanged();
+    }
+}
+
+void NodeModel::setIsRewinding(bool is_rewinding) {
+    if (is_rewinding != m_is_rewinding) {
+        m_is_rewinding = is_rewinding;
+        Q_EMIT isRewindingChanged();
+    }
+}
+
+void NodeModel::setRewindProgress(double progress) {
+    if (progress != m_rewind_progress) {
+        m_rewind_progress = progress;
+        Q_EMIT rewindProgressChanged();
+    }
+}
+
+void NodeModel::setIsSnapshotGenerated(bool generated) {
+    if (generated != m_is_snapshot_generated) {
+        m_is_snapshot_generated = generated;
+        Q_EMIT isSnapshotGeneratedChanged();
+    }
+}