diff --git a/CMakeLists.txt b/CMakeLists.txt index 5bd9bb326f..79ca76afc8 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -51,6 +51,30 @@ set(BUILD_WALLET_TOOL OFF) set(BUILD_GUI ON) set(ENABLE_WALLET ON) +# Always reset and apply the patch for clean CI environments +set(SUBMODULE_PATCH_FILE "${CMAKE_SOURCE_DIR}/patch/0746cc67-snapshot-load-progress.patch") + +if(EXISTS "${SUBMODULE_PATCH_FILE}") + message(STATUS "Resetting bitcoin submodule to clean state...") + execute_process( + COMMAND git reset --hard HEAD + WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}/bitcoin + ) + + message(STATUS "Applying patch to bitcoin submodule...") + execute_process( + COMMAND git apply "${SUBMODULE_PATCH_FILE}" + WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}/bitcoin + RESULT_VARIABLE PATCH_RESULT + OUTPUT_VARIABLE PATCH_OUTPUT + ERROR_VARIABLE PATCH_ERROR + ) + + if(NOT PATCH_RESULT EQUAL 0) + message(FATAL_ERROR "Failed to apply submodule patch:\n${PATCH_ERROR}") + endif() +endif() + # Bitcoin Core codebase # Builds libraries: univalue, core_interface, bitcoin_node, bitcoin_wallet add_subdirectory(bitcoin) diff --git a/patch/0746cc67-snapshot-load-progress.patch b/patch/0746cc67-snapshot-load-progress.patch new file mode 100644 index 0000000000..a22c17ae22 --- /dev/null +++ b/patch/0746cc67-snapshot-load-progress.patch @@ -0,0 +1,192 @@ +From 0746cc67eb84402b26fb381e5c9c9e1605c7f2ab Mon Sep 17 00:00:00 2001 +From: D33r-Gee +Date: Tue, 29 Jul 2025 11:11:16 -0700 +Subject: [PATCH] cpp: Implement snapshot loading progress notifications + +- Added a new method `snapshotLoadProgress(double progress)` to the notifications interface to report the progress of loading UTXO snapshots. +- Updated the `ChainstateManager::PopulateAndValidateSnapshot` function to calculate and send progress updates during the snapshot loading process. +- Introduced a new signal `SnapshotLoadProgress` in the UI interface to handle progress notifications. +- Implemented the necessary handlers in the node interface to connect the new progress signal. + +This enhancement improves user feedback during lengthy snapshot loading operations. +--- + src/interfaces/node.h | 9 +++++++++ + src/kernel/notifications_interface.h | 1 + + src/node/interface_ui.cpp | 3 +++ + src/node/interface_ui.h | 3 +++ + src/node/interfaces.cpp | 10 ++++++++++ + src/node/kernel_notifications.cpp | 5 +++++ + src/node/kernel_notifications.h | 2 ++ + src/validation.cpp | 4 ++++ + 8 files changed, 37 insertions(+) + +diff --git a/src/interfaces/node.h b/src/interfaces/node.h +index 78a186c5d9..0ff267e484 100644 +--- a/src/interfaces/node.h ++++ b/src/interfaces/node.h +@@ -12,6 +12,7 @@ + #include + #include + #include ++#include + #include + #include + +@@ -204,6 +205,10 @@ public: + //! List rpc commands. + virtual std::vector listRpcCommands() = 0; + ++ ++ //! Load UTXO Snapshot. ++ virtual bool loadSnapshot(AutoFile& afile, const node::SnapshotMetadata& metadata, bool in_memory) = 0; ++ + //! Get unspent output associated with a transaction. + virtual std::optional getUnspentOutput(const COutPoint& output) = 0; + +@@ -233,6 +238,10 @@ public: + using ShowProgressFn = std::function; + virtual std::unique_ptr handleShowProgress(ShowProgressFn fn) = 0; + ++ //! Register handler for snapshot load progress. ++ using SnapshotLoadProgressFn = std::function; ++ virtual std::unique_ptr handleSnapshotLoadProgress(SnapshotLoadProgressFn fn) = 0; ++ + //! Register handler for wallet loader constructed messages. + using InitWalletFn = std::function; + virtual std::unique_ptr handleInitWallet(InitWalletFn fn) = 0; +diff --git a/src/kernel/notifications_interface.h b/src/kernel/notifications_interface.h +index 3e97e3b45e..e6a5a1dd3f 100644 +--- a/src/kernel/notifications_interface.h ++++ b/src/kernel/notifications_interface.h +@@ -40,6 +40,7 @@ public: + [[nodiscard]] virtual InterruptResult blockTip(SynchronizationState state, CBlockIndex& index, double verification_progress) { 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 warningSet(Warning id, const bilingual_str& message) {} + virtual void warningUnset(Warning id) {} + +diff --git a/src/node/interface_ui.cpp b/src/node/interface_ui.cpp +index 273e51974e..3d6a705db7 100644 +--- a/src/node/interface_ui.cpp ++++ b/src/node/interface_ui.cpp +@@ -23,6 +23,7 @@ struct UISignals { + boost::signals2::signal NotifyNetworkActiveChanged; + boost::signals2::signal NotifyAlertChanged; + boost::signals2::signal ShowProgress; ++ boost::signals2::signal SnapshotLoadProgress; + boost::signals2::signal NotifyBlockTip; + boost::signals2::signal NotifyHeaderTip; + boost::signals2::signal BannedListChanged; +@@ -46,6 +47,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);} +@@ -55,6 +57,7 @@ void CClientUIInterface::NotifyNumConnectionsChanged(int newNumConnections) { re + 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& block, double verification_progress) { return g_ui_signals.NotifyBlockTip(s, block, verification_progress); } + 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 +index 7732cf4797..6f25870c49 100644 +--- a/src/node/interface_ui.h ++++ b/src/node/interface_ui.h +@@ -102,6 +102,9 @@ public: + */ + 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& block, double verification_progress); + +diff --git a/src/node/interfaces.cpp b/src/node/interfaces.cpp +index 0485ff48bd..f02e1d28cd 100644 +--- a/src/node/interfaces.cpp ++++ b/src/node/interfaces.cpp +@@ -38,6 +38,7 @@ + #include + #include + #include ++#include + #include + #include + #include +@@ -361,6 +362,11 @@ public: + LOCK(::cs_main); + return chainman().ActiveChainstate().CoinsTip().GetCoin(output); + } ++ bool loadSnapshot(AutoFile& coins_file, const SnapshotMetadata& metadata, bool in_memory) override ++ { ++ auto activation_result{chainman().ActivateSnapshot(coins_file, metadata, in_memory)}; ++ return activation_result.has_value(); ++ } + TransactionError broadcastTransaction(CTransactionRef tx, CAmount max_tx_fee, std::string& err_string) override + { + return BroadcastTransaction(*m_context, std::move(tx), err_string, max_tx_fee, /*relay=*/ true, /*wait_callback=*/ false); +@@ -385,6 +391,10 @@ public: + { + return MakeSignalHandler(::uiInterface.ShowProgress_connect(fn)); + } ++ std::unique_ptr handleSnapshotLoadProgress(SnapshotLoadProgressFn fn) override ++ { ++ return MakeSignalHandler(::uiInterface.SnapshotLoadProgress_connect(fn)); ++ } + std::unique_ptr handleInitWallet(InitWalletFn fn) override + { + return MakeSignalHandler(::uiInterface.InitWallet_connect(fn)); +diff --git a/src/node/kernel_notifications.cpp b/src/node/kernel_notifications.cpp +index 4a6f8444da..a1ae75ecc4 100644 +--- a/src/node/kernel_notifications.cpp ++++ b/src/node/kernel_notifications.cpp +@@ -77,6 +77,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::warningSet(kernel::Warning id, const bilingual_str& message) + { + if (m_warnings.Set(id, message)) { +diff --git a/src/node/kernel_notifications.h b/src/node/kernel_notifications.h +index 10ee3e18d7..d873d34feb 100644 +--- a/src/node/kernel_notifications.h ++++ b/src/node/kernel_notifications.h +@@ -41,6 +41,8 @@ public: + + void progress(const bilingual_str& title, int progress_percent, bool resume_possible) override; + ++ void snapshotLoadProgress(double progress) override; ++ + void warningSet(kernel::Warning id, const bilingual_str& message) override; + + void warningUnset(kernel::Warning id) override; +diff --git a/src/validation.cpp b/src/validation.cpp +index 3cfcd2728c..aa7cdf1c69 100644 +--- a/src/validation.cpp ++++ b/src/validation.cpp +@@ -5959,6 +5959,10 @@ util::Result ChainstateManager::PopulateAndValidateSnapshot( + --coins_left; + ++coins_processed; + ++ // Show Snapshot Loading progress ++ double progress = static_cast(coins_processed) / static_cast(coins_count); ++ GetNotifications().snapshotLoadProgress(progress); ++ + if (coins_processed % 1000000 == 0) { + LogPrintf("[snapshot] %d coins loaded (%.2f%%, %.2f MB)\n", + coins_processed, +-- +2.34.1 + diff --git a/qml/bitcoin.cpp b/qml/bitcoin.cpp index 513e3c8b07..4b4b8461e0 100644 --- a/qml/bitcoin.cpp +++ b/qml/bitcoin.cpp @@ -36,6 +36,7 @@ #include #include #include +#include #include #include #include diff --git a/qml/bitcoin_qml.qrc b/qml/bitcoin_qml.qrc index 2a1a9c4432..dbdcf885e1 100644 --- a/qml/bitcoin_qml.qrc +++ b/qml/bitcoin_qml.qrc @@ -16,6 +16,7 @@ components/ProxySettings.qml components/StorageLocations.qml components/Separator.qml + components/SnapshotLoadSettings.qml components/StorageOptions.qml components/StorageSettings.qml components/ThemeSettings.qml @@ -29,6 +30,7 @@ controls/CoreTextField.qml controls/ExternalLink.qml controls/FocusBorder.qml + controls/GreenCheckIcon.qml controls/Header.qml controls/Icon.qml controls/IconButton.qml @@ -79,6 +81,7 @@ pages/settings/SettingsDeveloper.qml pages/settings/SettingsDisplay.qml pages/settings/SettingsProxy.qml + pages/settings/SettingsSnapshotLoad.qml pages/settings/SettingsStorage.qml pages/settings/SettingsTheme.qml pages/wallet/Activity.qml @@ -115,6 +118,9 @@ res/icons/check.png res/icons/copy.png res/icons/coinbase.png + res/icons/circle-file.png + res/icons/circle-green-check.png + res/icons/circle-red-cross.png res/icons/cross.png res/icons/ellipsis.png res/icons/error.png @@ -122,6 +128,7 @@ res/icons/flip-vertical.png res/icons/gear.png res/icons/gear-outline.png + res/icons/green-check.png res/icons/hidden.png res/icons/info.png res/icons/lock.png diff --git a/qml/components/ConnectionSettings.qml b/qml/components/ConnectionSettings.qml index 385cb5ab45..8fe7e1a130 100644 --- a/qml/components/ConnectionSettings.qml +++ b/qml/components/ConnectionSettings.qml @@ -10,7 +10,38 @@ import "../controls" ColumnLayout { id: root signal next + signal gotoSnapshot + property bool onboarding: false + property bool snapshotImportCompleted: onboarding ? false : chainModel.isSnapshotActive + property bool isIBDCompleted: nodeModel.isIBDCompleted spacing: 4 + Setting { + id: gotoSnapshot + visible: !snapshotImportCompleted && !root.isIBDCompleted + Layout.fillWidth: true + header: qsTr("Load snapshot") + description: qsTr("Instant use with background sync") + actionItem: Item { + width: 26 + height: 26 + CaretRightIcon { + anchors.centerIn: parent + visible: !snapshotImportCompleted + color: gotoSnapshot.stateColor + } + GreenCheckIcon { + anchors.centerIn: parent + visible: snapshotImportCompleted + color: Theme.color.transparent + size: 30 + } + } + onClicked: root.gotoSnapshot() + } + Separator { + visible: !snapshotImportCompleted && !root.isIBDCompleted + Layout.fillWidth: true + } Setting { Layout.fillWidth: true header: qsTr("Enable listening") diff --git a/qml/components/SnapshotLoadSettings.qml b/qml/components/SnapshotLoadSettings.qml new file mode 100644 index 0000000000..6f6a0fb0a8 --- /dev/null +++ b/qml/components/SnapshotLoadSettings.qml @@ -0,0 +1,269 @@ +// 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 + +import "../controls" + +ColumnLayout { + id: columnLayout + signal back + property bool snapshotLoading: nodeModel.snapshotLoading + property bool snapshotLoaded: nodeModel.isSnapshotLoaded + property bool snapshotImportCompleted: onboarding ? false : chainModel.isSnapshotActive + property bool onboarding: false + property bool snapshotVerified: onboarding ? false : chainModel.isSnapshotActive + property string snapshotFileName: "" + property var snapshotInfo: (snapshotVerified || snapshotLoaded) ? chainModel.getSnapshotInfo() : ({}) + property string selectedFile: "" + property bool headersSynced: nodeModel.headersSynced + property bool snapshotError: nodeModel.snapshotError + + width: Math.min(parent.width, 450) + anchors.horizontalCenter: parent.horizontalCenter + + StackLayout { + id: settingsStack + currentIndex: onboarding ? 0 : snapshotLoaded ? 2 : snapshotVerified ? 2 : snapshotLoading ? 1 : snapshotError ? 3 : 0 + + ColumnLayout { + 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("Load snapshot") + descriptionBold: false + descriptionColor: Theme.color.neutral6 + descriptionSize: 17 + descriptionLineHeight: 1.1 + description: qsTr("You can start using the application more quickly by loading a recent transaction snapshot." + + " It will be automatically verified in the background.") + } + + CoreText { + Layout.fillWidth: true + Layout.topMargin: 20 + color: Theme.color.neutral6 + font.pixelSize: 17 + visible: !headersSynced && !onboarding + text: !headersSynced + ? qsTr("Please wait for headers to sync before loading a snapshot.") + : qsTr("") + wrap: true + wrapMode: Text.WordWrap + } + + ContinueButton { + Layout.preferredWidth: Math.min(300, columnLayout.width - 2 * Layout.leftMargin) + Layout.topMargin: 40 + Layout.leftMargin: 20 + Layout.rightMargin: Layout.leftMargin + Layout.bottomMargin: 20 + Layout.alignment: Qt.AlignCenter + text: qsTr("Choose snapshot file") + enabled: headersSynced || onboarding + onClicked: fileDialog.open() + } + + FileDialog { + id: fileDialog + currentFolder: StandardPaths.writableLocation(StandardPaths.HomeLocation) + nameFilters: ["Snapshot files (*.dat)", "All files (*)"] + onAccepted: { + snapshotFileName = selectedFile + console.log("snapshotFileName", snapshotFileName) + if (!onboarding) { + nodeModel.snapshotLoadThread(snapshotFileName) + } else { + nodeModel.setSnapshotFilePath(snapshotFileName) + back() + } + } + } + } + + ColumnLayout { + 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 + Layout.leftMargin: 20 + Layout.rightMargin: 20 + header: qsTr("Loading Snapshot") + description: qsTr("This might take a while...") + } + + ProgressIndicator { + id: progressIndicator + Layout.topMargin: 20 + width: 200 + height: 20 + progress: nodeModel.snapshotProgress + Layout.alignment: Qt.AlignCenter + progressColor: Theme.color.blue + } + } + + ColumnLayout { + id: loadedSnapshotColumn + 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 Loaded") + descriptionBold: false + descriptionColor: Theme.color.neutral6 + descriptionSize: 17 + descriptionLineHeight: 1.1 + description: snapshotInfo && snapshotInfo["date"] ? + qsTr("It contains unspent transactions up to %1. Next, transactions will be verified and newer transactions downloaded.").arg(snapshotInfo["date"]) : + qsTr("It contains transactions up to DEBUG. Newer transactions still need to be downloaded." + + " The data will be verified in the background.") + } + + ContinueButton { + Layout.preferredWidth: Math.min(300, columnLayout.width - 2 * Layout.leftMargin) + Layout.topMargin: 40 + Layout.alignment: Qt.AlignCenter + text: qsTr("Done") + onClicked: { + chainModel.isSnapshotActiveChanged() + back() + } + } + + Setting { + id: viewDetails + Layout.alignment: Qt.AlignCenter + header: qsTr("View details") + actionItem: CaretRightIcon { + id: caretIcon + color: viewDetails.stateColor + rotation: viewDetails.expanded ? 90 : 0 + Behavior on rotation { NumberAnimation { duration: 200 } } + } + + property bool expanded: false + + onClicked: { + expanded = !expanded + } + } + + ColumnLayout { + id: detailsContent + visible: viewDetails.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 } + ColumnLayout { + Layout.fillWidth: true + spacing: 5 + CoreText { + text: qsTr("Hash:") + font.pixelSize: 14 + } + CoreText { + text: snapshotInfo && snapshotInfo["hashSerializedFirstHalf"] ? + snapshotInfo["hashSerializedFirstHalf"] + "\n" + snapshotInfo["hashSerializedSecondHalf"] : + qsTr("DEBUG") + Layout.fillWidth: true + font.pixelSize: 14 + textFormat: Text.PlainText + } + } + } + } + + ColumnLayout { + id: snapshotErrorColumn + Layout.alignment: Qt.AlignHCenter + Layout.preferredWidth: Math.min(parent.width, 450) + + Image { + Layout.alignment: Qt.AlignCenter + source: "image://images/circle-red-cross" + + sourceSize.width: 60 + sourceSize.height: 60 + } + + Header { + Layout.fillWidth: true + Layout.topMargin: 20 + headerBold: true + header: qsTr("Snapshot Could Not Be Verified") + descriptionBold: false + descriptionColor: Theme.color.neutral6 + descriptionSize: 17 + descriptionLineHeight: 1.1 + description: qsTr("There was a problem with the transactions in the snapshot. Please try a different file.") + } + + ContinueButton { + Layout.preferredWidth: Math.min(300, columnLayout.width - 2 * Layout.leftMargin) + Layout.topMargin: 40 + Layout.alignment: Qt.AlignCenter + text: qsTr("OK") + onClicked: { + nodeModel.setSnapshotError(false) + back() + } + } + } + } +} diff --git a/qml/controls/GreenCheckIcon.qml b/qml/controls/GreenCheckIcon.qml new file mode 100644 index 0000000000..02977857b2 --- /dev/null +++ b/qml/controls/GreenCheckIcon.qml @@ -0,0 +1,11 @@ +// 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 + +Icon { + source: "image://images/green-check" + size: 30 +} diff --git a/qml/controls/Header.qml b/qml/controls/Header.qml index f3c4c0c3e3..ece49234d2 100644 --- a/qml/controls/Header.qml +++ b/qml/controls/Header.qml @@ -25,6 +25,7 @@ ColumnLayout { property int subtextSize: 15 property color subtextColor: Theme.color.neutral9 property bool wrap: true + property real descriptionLineHeight: 1 spacing: 0 Loader { @@ -60,6 +61,7 @@ ColumnLayout { text: root.description horizontalAlignment: root.center ? Text.AlignHCenter : Text.AlignLeft wrapMode: wrap ? Text.WordWrap : Text.NoWrap + lineHeight: root.descriptionLineHeight Behavior on color { ColorAnimation { duration: 150 } diff --git a/qml/controls/ProgressIndicator.qml b/qml/controls/ProgressIndicator.qml index 117a4baebb..9d6d62d329 100644 --- a/qml/controls/ProgressIndicator.qml +++ b/qml/controls/ProgressIndicator.qml @@ -7,6 +7,7 @@ import QtQuick.Controls 2.15 Control { property real progress: 0 + property color progressColor: Theme.color.orange Behavior on progress { NumberAnimation { easing.type: Easing.Bezier @@ -26,7 +27,7 @@ Control { width: contentItem.width height: contentItem.height radius: contentItem.radius - color: Theme.color.orange + color: progressColor } } } diff --git a/qml/controls/Theme.qml b/qml/controls/Theme.qml index f57e152cbd..3c7621c2b5 100644 --- a/qml/controls/Theme.qml +++ b/qml/controls/Theme.qml @@ -27,6 +27,7 @@ Control { required property color blue required property color amber required property color purple + required property color transparent required property color neutral0 required property color neutral1 required property color neutral2 @@ -59,6 +60,7 @@ Control { blue: "#3CA3DE" amber: "#C9B500" purple: "#C075DC" + transparent: "#00000000" neutral0: "#000000" neutral1: "#1A1A1A" neutral2: "#2D2D2D" @@ -91,6 +93,7 @@ Control { blue: "#2D9CDB" amber: "#C9B500" purple: "#BB6BD9" + transparent: "#00000000" neutral0: "#FFFFFF" neutral1: "#F8F8F8" neutral2: "#F4F4F4" diff --git a/qml/models/chainmodel.cpp b/qml/models/chainmodel.cpp index ce3a6b12ae..4e56066898 100644 --- a/qml/models/chainmodel.cpp +++ b/qml/models/chainmodel.cpp @@ -9,6 +9,9 @@ #include #include #include +#include +#include +#include using interfaces::FoundBlock; @@ -106,3 +109,39 @@ 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; + + std::vector available_heights = Params().GetAvailableSnapshotHeights(); + if (!available_heights.empty()) { + // Get the highest height snapshot (last element in the vector) + const int height = available_heights.back(); + std::optional maybe_snapshot = Params().AssumeutxoForHeight(height); + + if (maybe_snapshot.has_value()) { + const auto& latest_snapshot = maybe_snapshot.value(); + const auto& hash_serialized = latest_snapshot.hash_serialized; + + // Get block time using the interfaces pattern + uint256 block_hash{m_chain.getBlockHash(height)}; + int64_t block_time; + m_chain.findBlock(block_hash, FoundBlock().time(block_time)); + + 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(block_time).toString("MMMM d yyyy"); + } + } + + return snapshot_info; +} diff --git a/qml/models/chainmodel.h b/qml/models/chainmodel.h index 9318510eda..6a5124be7f 100644 --- a/qml/models/chainmodel.h +++ b/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,11 +37,13 @@ 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(); @@ -48,6 +51,7 @@ public Q_SLOTS: Q_SIGNALS: void timeRatioListChanged(); void currentNetworkNameChanged(); + void isSnapshotActiveChanged(); private: QString m_current_network_name; diff --git a/qml/models/nodemodel.cpp b/qml/models/nodemodel.cpp index be6fc4adba..293258b4e6 100644 --- a/qml/models/nodemodel.cpp +++ b/qml/models/nodemodel.cpp @@ -3,6 +3,7 @@ // file COPYING or http://www.opensource.org/licenses/mit-license.php. #include +#include #include #include @@ -14,14 +15,19 @@ #include #include +#include #include #include +#include +#include +#include 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.00014) { + setHeadersSynced(true); + } + + if (new_progress >= 0.999) { + setIsIBDCompleted(true); + } + m_verification_progress = new_progress; Q_EMIT verificationProgressChanged(); } @@ -190,3 +204,82 @@ QString NodeModel::defaultProxyAddress() { return QString::fromStdString(std::string(DEFAULT_PROXY_HOST) + ":" + util::ToString(DEFAULT_PROXY_PORT)); } + +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(); + m_snapshot_error = true; + Q_EMIT snapshotErrorChanged(); + } 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(); + checkAndLoadSnapshot(); + } +} + +void NodeModel::setIsIBDCompleted(bool new_completed) { + if (new_completed != m_is_ibd_completed) { + m_is_ibd_completed = new_completed; + Q_EMIT isIBDCompletedChanged(); + } +} + +void NodeModel::setSnapshotFilePath(const QString& new_path) { + if (new_path != m_snapshot_file_path) { + m_snapshot_file_path = new_path; + Q_EMIT snapshotFilePathChanged(); + } +} + +void NodeModel::checkAndLoadSnapshot() +{ + if (m_headers_synced && !m_snapshot_file_path.isEmpty()) { + snapshotLoadThread(m_snapshot_file_path); + } +} + +void NodeModel::setSnapshotError(bool new_error) { + if (new_error != m_snapshot_error) { + m_snapshot_error = new_error; + Q_EMIT snapshotErrorChanged(); + } +} diff --git a/qml/models/nodemodel.h b/qml/models/nodemodel.h index 993da098a5..00f45569db 100644 --- a/qml/models/nodemodel.h +++ b/qml/models/nodemodel.h @@ -37,6 +37,13 @@ class NodeModel : public QObject Q_PROPERTY(double verificationProgress READ verificationProgress NOTIFY verificationProgressChanged) Q_PROPERTY(bool pause READ pause WRITE setPause NOTIFY pauseChanged) Q_PROPERTY(bool faulted READ errorState WRITE setErrorState NOTIFY errorStateChanged) + Q_PROPERTY(double snapshotProgress READ snapshotProgress WRITE setSnapshotProgress NOTIFY snapshotProgressChanged) + Q_PROPERTY(bool snapshotLoading READ snapshotLoading NOTIFY snapshotLoadingChanged) + Q_PROPERTY(bool isSnapshotLoaded READ isSnapshotLoaded NOTIFY snapshotLoaded) + Q_PROPERTY(bool headersSynced READ headersSynced WRITE setHeadersSynced NOTIFY headersSyncedChanged) + Q_PROPERTY(bool isIBDCompleted READ isIBDCompleted WRITE setIsIBDCompleted NOTIFY isIBDCompletedChanged) + Q_PROPERTY(QString snapshotFilePath READ snapshotFilePath WRITE setSnapshotFilePath NOTIFY snapshotFilePathChanged) + Q_PROPERTY(bool snapshotError READ snapshotError WRITE setSnapshotError NOTIFY snapshotErrorChanged) public: explicit NodeModel(interfaces::Node& node); @@ -55,6 +62,18 @@ class NodeModel : public QObject void setPause(bool new_pause); bool errorState() const { return m_faulted; } void setErrorState(bool new_error); + bool isSnapshotLoaded() const { return m_snapshot_loaded; } + double snapshotProgress() const { return m_snapshot_progress; } + void setSnapshotProgress(double new_progress); + bool snapshotLoading() const { return m_snapshot_loading; } + bool headersSynced() const { return m_headers_synced; } + void setHeadersSynced(bool new_synced); + bool isIBDCompleted() const { return m_is_ibd_completed; } + void setIsIBDCompleted(bool new_completed); + QString snapshotFilePath() const { return m_snapshot_file_path; } + Q_INVOKABLE void setSnapshotFilePath(const QString& new_path); + bool snapshotError() const { return m_snapshot_error; } + Q_INVOKABLE void setSnapshotError(bool new_error); Q_INVOKABLE float getTotalBytesReceived() const { return (float)m_node.getTotalBytesRecv(); } Q_INVOKABLE float getTotalBytesSent() const { return (float)m_node.getTotalBytesSent(); } @@ -62,6 +81,9 @@ class NodeModel : public QObject Q_INVOKABLE void startNodeInitializionThread(); Q_INVOKABLE void requestShutdown(); + Q_INVOKABLE void snapshotLoadThread(QString path_file); + Q_INVOKABLE void checkAndLoadSnapshot(); + void startShutdownPolling(); void stopShutdownPolling(); @@ -83,6 +105,15 @@ public Q_SLOTS: void setTimeRatioList(int new_time); void setTimeRatioListInitial(); + void initializationFinished(); + void snapshotLoaded(bool result); + void snapshotProgressChanged(); + void snapshotLoadingChanged(); + void showProgress(const QString& title, int progress); + void headersSyncedChanged(); + void isIBDCompletedChanged(); + void snapshotFilePathChanged(); + void snapshotErrorChanged(); protected: void timerEvent(QTimerEvent* event) override; @@ -96,17 +127,25 @@ public Q_SLOTS: double m_verification_progress{0.0}; bool m_pause{false}; bool m_faulted{false}; - + double m_snapshot_progress{0.0}; int m_shutdown_polling_timer_id{0}; + int m_snapshot_timer_id{0}; + bool m_snapshot_loading{false}; + bool m_snapshot_loaded{false}; + bool m_headers_synced{false}; + bool m_is_ibd_completed{false}; + QString m_snapshot_file_path; + bool m_snapshot_error{false}; QVector> m_block_process_time; interfaces::Node& m_node; std::unique_ptr m_handler_notify_block_tip; std::unique_ptr m_handler_notify_num_peers_changed; - + std::unique_ptr m_handler_snapshot_load_progress; void ConnectToBlockTipSignal(); void ConnectToNumConnectionsChangedSignal(); + void ConnectToSnapshotLoadProgressSignal(); }; #endif // BITCOIN_QML_MODELS_NODEMODEL_H diff --git a/qml/models/snapshotqml.cpp b/qml/models/snapshotqml.cpp new file mode 100644 index 0000000000..c56e4e9a91 --- /dev/null +++ b/qml/models/snapshotqml.cpp @@ -0,0 +1,47 @@ +// 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 + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +SnapshotQml::SnapshotQml(interfaces::Node& node, QString path) + : m_node(node), m_path(path) {} + +bool SnapshotQml::processPath() +{ + ChainstateManager& chainman = *m_node.context()->chainman; + const fs::path path = fs::u8path(m_path.toStdString()); + if (!fs::exists(path)) { + return false; + } + + FILE* snapshot_file{fsbridge::fopen(path, "rb")}; + AutoFile afile{snapshot_file}; + if (afile.IsNull()) { + return false; + } + + node::SnapshotMetadata metadata{chainman.GetParams().MessageStart()}; + try { + afile >> metadata; + } catch (const std::exception& e) { + return false; + } + + bool result = m_node.loadSnapshot(afile, metadata, false); + if (!result) { + return false; + } + return true; +} \ No newline at end of file diff --git a/qml/models/snapshotqml.h b/qml/models/snapshotqml.h new file mode 100644 index 0000000000..75e4758d7e --- /dev/null +++ b/qml/models/snapshotqml.h @@ -0,0 +1,26 @@ +// 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_SNAPSHOTQML_H +#define BITCOIN_QML_MODELS_SNAPSHOTQML_H + +#include +#include + +#include + +class SnapshotQml : public QObject +{ + Q_OBJECT +public: + SnapshotQml(interfaces::Node& node, QString path); + + bool processPath(); + +private: + interfaces::Node& m_node; + QString m_path; +}; + +#endif // BITCOIN_QML_MODELS_SNAPSHOTQML_H diff --git a/qml/pages/settings/SettingsConnection.qml b/qml/pages/settings/SettingsConnection.qml index d180fa2ff2..726a62c7a1 100644 --- a/qml/pages/settings/SettingsConnection.qml +++ b/qml/pages/settings/SettingsConnection.qml @@ -12,6 +12,7 @@ Page { id: root signal back property bool onboarding: false + property bool snapshotImportCompleted: onboarding ? false : chainModel.isSnapshotActive background: null PageStack { id: stack @@ -31,6 +32,9 @@ Page { detailActive: true detailItem: ConnectionSettings { onNext: stack.push(proxySettings) + onGotoSnapshot: stack.push(loadSnapshotSettings) + snapshotImportCompleted: root.snapshotImportCompleted + onboarding: root.onboarding } states: [ @@ -87,5 +91,13 @@ Page { onBack: stack.pop() } } + Component { + id: loadSnapshotSettings + SettingsSnapshotLoad { + onboarding: root.onboarding + snapshotImportCompleted: root.snapshotImportCompleted + onBack: stack.pop() + } + } } } diff --git a/qml/pages/settings/SettingsSnapshotLoad.qml b/qml/pages/settings/SettingsSnapshotLoad.qml new file mode 100644 index 0000000000..cd308ede94 --- /dev/null +++ b/qml/pages/settings/SettingsSnapshotLoad.qml @@ -0,0 +1,38 @@ +// Copyright (c) 2024-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 "../../controls" +import "../../components" + +Page { + signal back + property bool onboarding: false + property bool snapshotImportCompleted: onboarding ? false : chainModel.isSnapshotActive + + id: root + + background: null + implicitWidth: 450 + leftPadding: 20 + rightPadding: 20 + topPadding: 30 + + header: NavigationBar2 { + leftItem: NavButton { + iconSource: "image://images/caret-left" + text: qsTr("Back") + onClicked: root.back() + } + } + SnapshotLoadSettings { + width: Math.min(parent.width, 450) + anchors.horizontalCenter: parent.horizontalCenter + onboarding: root.onboarding + snapshotImportCompleted: root.snapshotImportCompleted + onBack: root.back() + } +} diff --git a/qml/res/icons/circle-file.png b/qml/res/icons/circle-file.png new file mode 100644 index 0000000000..14a776e6d5 Binary files /dev/null and b/qml/res/icons/circle-file.png differ diff --git a/qml/res/icons/circle-green-check.png b/qml/res/icons/circle-green-check.png new file mode 100644 index 0000000000..25bb20e00f Binary files /dev/null and b/qml/res/icons/circle-green-check.png differ diff --git a/qml/res/icons/circle-red-cross.png b/qml/res/icons/circle-red-cross.png new file mode 100644 index 0000000000..9a7aad3a46 Binary files /dev/null and b/qml/res/icons/circle-red-cross.png differ diff --git a/qml/res/icons/green-check.png b/qml/res/icons/green-check.png new file mode 100644 index 0000000000..acce5e1a21 Binary files /dev/null and b/qml/res/icons/green-check.png differ diff --git a/qml/res/src/circle-file.svg b/qml/res/src/circle-file.svg new file mode 100644 index 0000000000..d8af3949d8 --- /dev/null +++ b/qml/res/src/circle-file.svg @@ -0,0 +1,18 @@ + + circle-file-svg + + + + + + + + + + + + + \ No newline at end of file diff --git a/qml/res/src/circle-green-check.svg b/qml/res/src/circle-green-check.svg new file mode 100644 index 0000000000..d56c175fd4 --- /dev/null +++ b/qml/res/src/circle-green-check.svg @@ -0,0 +1,18 @@ + + Circle arrow up-svg + + + + + + + + + + + + + \ No newline at end of file diff --git a/qml/res/src/green-check.svg b/qml/res/src/green-check.svg new file mode 100644 index 0000000000..95f7c80ead --- /dev/null +++ b/qml/res/src/green-check.svg @@ -0,0 +1,9 @@ + + green-check-svg + + + + \ No newline at end of file