Skip to content

Commit

Permalink
wip: Add minimal support for loading signet UTXO snapshots
Browse files Browse the repository at this point in the history
        Adds minimal wiring to connect QML GUI to loading a signet UTXO snapshot via
        the connection settings. Modifies src/interfaces/node.h, src/node/interfaces.cpp
        and chainparams.cpp (temporarily for signet snapshot testing)
        to implement snapshot loading functionality through the node model.

        Current limitations:
        - Not integrated with onboarding process
        - Requires manual navigation to connection settings after initial startup
        - Snapshot verification progress uses a regex to extract Pre-Synchronizing progress

        Testing:
        1. Start the node
        2. Complete onboarding
        3. Navigate to connection settings
        4. Load snapshot from provided interface
  • Loading branch information
D33r-Gee committed Nov 4, 2024
1 parent c97d2a1 commit 955c65d
Show file tree
Hide file tree
Showing 10 changed files with 244 additions and 25 deletions.
10 changes: 10 additions & 0 deletions src/interfaces/node.h
Original file line number Diff line number Diff line change
Expand Up @@ -199,6 +199,16 @@ class Node
//! List rpc commands.
virtual std::vector<std::string> listRpcCommands() = 0;

//! Load UTXO Snapshot.
virtual bool snapshotLoad(const std::string& path_string) = 0;

//! Set snapshot progress callback.
using SnapshotProgressFn = std::function<void(double progress)>;
virtual void setSnapshotProgressCallback(SnapshotProgressFn fn) = 0;

//! Notify snapshot progress.
virtual void notifySnapshotProgress(double progress) = 0;

//! Set RPC timer interface if unset.
virtual void rpcSetTimerInterfaceIfUnset(RPCTimerInterface* iface) = 0;

Expand Down
7 changes: 7 additions & 0 deletions src/kernel/chainparams.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand Down
98 changes: 96 additions & 2 deletions src/node/interfaces.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down Expand Up @@ -58,7 +59,7 @@
#include <memory>
#include <optional>
#include <utility>

#include <regex>
#include <boost/signals2/signal.hpp>

using interfaces::BlockTip;
Expand Down Expand Up @@ -395,6 +396,99 @@ class NodeImpl : public Node
{
m_context = context;
}
SnapshotProgressFn m_snapshot_progress_callback{nullptr};
void setSnapshotProgressCallback(SnapshotProgressFn fn) override
{
m_snapshot_progress_callback = std::move(fn);
}
void notifySnapshotProgress(double progress) override
{
if (m_snapshot_progress_callback) m_snapshot_progress_callback(progress);
}
bool snapshotLoad(const std::string& path_string) override
{
// Set up log message parsing
LogInstance().PushBackCallback([this](const std::string& str) {
static const std::regex progress_regex(R"(\[snapshot\] (\d+) coins loaded \(([0-9.]+)%.*\))");
static const std::regex sync_progress_regex(R"(Synchronizing blockheaders, height: (\d+) \(~([\d.]+)%\))");

std::smatch matches;
if (std::regex_search(str, matches, progress_regex)) {
try {
double percentage = std::stod(matches[2]);
// Convert percentage to 0-1 range and notify through callback
notifySnapshotProgress(percentage / 100.0);
} catch (...) {
// Handle parsing errors
}
} else if (std::regex_search(str, matches, sync_progress_regex)) {
try {
double percentage = std::stod(matches[2]);
// Convert percentage to 0-1 range and notify through callback
notifySnapshotProgress(percentage / 100.0);
} catch (...) {
// Handle parsing errors
}
}
});

const fs::path path = fs::u8path(path_string);
if (!fs::exists(path)) {
LogPrintf("[loadsnapshot] Snapshot file %s does not exist\n", path.u8string());
return false;
}

AutoFile afile{fsbridge::fopen(path, "rb")};
if (afile.IsNull()) {
LogPrintf("[loadsnapshot] Failed to open snapshot file %s\n", path.u8string());
return false;
}

SnapshotMetadata metadata;
try {
afile >> metadata;
} catch (const std::exception& e) {
LogPrintf("[loadsnapshot] Failed to read snapshot metadata: %s\n", e.what());
return false;
}

const uint256& base_blockhash = metadata.m_base_blockhash;
LogPrintf("[loadsnapshot] Waiting for blockheader %s in headers chain before snapshot activation\n",
base_blockhash.ToString());

if (!m_context->chainman) {
LogPrintf("[loadsnapshot] Chainman is null\n");
return false;
}

ChainstateManager& chainman = *m_context->chainman;
CBlockIndex* snapshot_start_block = nullptr;

// Wait for the block to appear in the block index
constexpr int max_wait_seconds = 600; // 10 minutes
for (int i = 0; i < max_wait_seconds; ++i) {
snapshot_start_block = WITH_LOCK(::cs_main, return chainman.m_blockman.LookupBlockIndex(base_blockhash));
if (snapshot_start_block) break;
std::this_thread::sleep_for(std::chrono::seconds(1));
}

if (!snapshot_start_block) {
LogPrintf("[loadsnapshot] Timed out waiting for snapshot start blockheader %s\n", base_blockhash.ToString());
return false;
}

// Activate the snapshot
if (!chainman.ActivateSnapshot(afile, metadata, false)) {
LogPrintf("[loadsnapshot] Unable to load UTXO snapshot %s\n", path.u8string());
return false;
}

CBlockIndex* new_tip = WITH_LOCK(::cs_main, return chainman.ActiveTip());
LogPrintf("[loadsnapshot] Loaded %d coins from snapshot %s at height %d\n",
metadata.m_coins_count, new_tip->GetBlockHash().ToString(), new_tip->nHeight);

return true;
}
ArgsManager& args() { return *Assert(Assert(m_context)->args); }
ChainstateManager& chainman() { return *Assert(m_context->chainman); }
NodeContext* m_context{nullptr};
Expand Down Expand Up @@ -510,7 +604,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())};
Expand Down
18 changes: 16 additions & 2 deletions src/qml/components/ConnectionSettings.qml
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,24 @@ import "../controls"
ColumnLayout {
id: root
signal next
property bool snapshotImported: false
property bool snapshotImported: onboarding ? false : chainModel.isSnapshotActive
property bool onboarding: false

Component.onCompleted: {
if (!onboarding) {
snapshotImported = chainModel.isSnapshotActive
} else {
snapshotImported = false
}
}

function setSnapshotImported(imported) {
snapshotImported = imported
}
spacing: 4
Setting {
id: gotoSnapshot
visible: !root.onboarding
Layout.fillWidth: true
header: qsTr("Load snapshot")
description: qsTr("Instant use with background sync")
Expand All @@ -40,7 +51,10 @@ ColumnLayout {
connectionSwipe.incrementCurrentIndex()
}
}
Separator { Layout.fillWidth: true }
Separator {
visible: !root.onboarding
Layout.fillWidth: true
}
Setting {
Layout.fillWidth: true
header: qsTr("Enable listening")
Expand Down
61 changes: 54 additions & 7 deletions src/qml/components/SnapshotSettings.qml
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,22 @@
import QtQuick 2.15
import QtQuick.Controls 2.15
import QtQuick.Layouts 1.15
import QtQuick.Dialogs 1.3

import "../controls"

ColumnLayout {
signal snapshotImportCompleted()
property int snapshotVerificationCycles: 0
property real snapshotVerificationProgress: 0
property bool snapshotVerified: false
property bool onboarding: false
property bool snapshotVerified: onboarding ? false : chainModel.isSnapshotActive

id: columnLayout
width: Math.min(parent.width, 450)
anchors.horizontalCenter: parent.horizontalCenter


// TODO: Remove this once the verification progress is available
Timer {
id: snapshotSimulationTimer
interval: 50 // Update every 50ms
Expand All @@ -29,7 +31,7 @@ ColumnLayout {
snapshotVerificationProgress += 0.01
} else {
snapshotVerificationCycles++
if (snapshotVerificationCycles < 1) {
if (snapshotVerificationCycles < 3) {
snapshotVerificationProgress = 0
} else {
running = false
Expand All @@ -42,7 +44,7 @@ ColumnLayout {

StackLayout {
id: settingsStack
currentIndex: 0
currentIndex: onboarding ? 0 : snapshotVerified ? 2 : 0

ColumnLayout {
Layout.alignment: Qt.AlignHCenter
Expand Down Expand Up @@ -78,8 +80,22 @@ ColumnLayout {
Layout.alignment: Qt.AlignCenter
text: qsTr("Choose snapshot file")
onClicked: {
settingsStack.currentIndex = 1
snapshotSimulationTimer.start()
fileDialog.open()
}
}

FileDialog {
id: fileDialog
folder: shortcuts.home
selectMultiple: false
onAccepted: {
console.log("File chosen:", fileDialog.fileUrls)
var snapshotFileName = fileDialog.fileUrl.toString()
console.log("Snapshot file name:", snapshotFileName)
if (snapshotFileName.endsWith(".dat")) {
nodeModel.initializeSnapshot(true, snapshotFileName)
settingsStack.currentIndex = 1
}
}
}
}
Expand Down Expand Up @@ -109,10 +125,34 @@ ColumnLayout {
Layout.topMargin: 20
width: 200
height: 20
progress: snapshotVerificationProgress
// TODO: uncomment this once the verification progress is available
// progress: nodeModel.verificationProgress
progress: 0
Layout.alignment: Qt.AlignCenter
progressColor: Theme.color.blue
}

Connections {
target: nodeModel
// TODO: uncomment this once the verification progress is available
// function onVerificationProgressChanged() {
// progressIndicator.progress = nodeModel.verificationProgress
// }
function onSnapshotProgressChanged() {
progressIndicator.progress = nodeModel.snapshotProgress
}
function onSnapshotLoaded(success) {
if (success) {
chainModel.isSnapshotActiveChanged()
snapshotVerified = chainModel.isSnapshotActive
progressIndicator.progress = 1
settingsStack.currentIndex = 2 // Move to the "Snapshot Loaded" page
} else {
// Handle snapshot loading failure
console.error("Snapshot loading failed")
}
}
}
}

ColumnLayout {
Expand All @@ -137,6 +177,7 @@ ColumnLayout {
descriptionColor: Theme.color.neutral6
descriptionSize: 17
descriptionLineHeight: 1.1
// TODO: Update this description once the snapshot is verified
description: qsTr("It contains transactions up to January 12, 2024. Newer transactions still need to be downloaded." +
" The data will be verified in the background.")
}
Expand All @@ -153,6 +194,9 @@ ColumnLayout {
}
}

// TODO: Update this with the actual snapshot details
// TODO: uncomment this once the snapshot details are available
/*
Setting {
id: viewDetails
Layout.alignment: Qt.AlignCenter
Expand Down Expand Up @@ -188,17 +232,20 @@ ColumnLayout {
font.pixelSize: 14
}
CoreText {
// TODO: Update this with the actual block height
text: qsTr("200,000")
Layout.alignment: Qt.AlignRight
font.pixelSize: 14
}
}
Separator { Layout.fillWidth: true }
CoreText {
// TODO: Update this with the actual snapshot file hash
text: qsTr("Hash: 0x1234567890abcdef...")
font.pixelSize: 14
}
}
*/
}
}
}
5 changes: 4 additions & 1 deletion src/qml/models/chainmodel.h
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
#include <QString>
#include <QTimer>
#include <QVariant>
#include <QDebug>

namespace interfaces {
class FoundBlock;
Expand All @@ -27,6 +28,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);
Expand All @@ -36,7 +38,7 @@ 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();
Expand All @@ -48,6 +50,7 @@ public Q_SLOTS:
Q_SIGNALS:
void timeRatioListChanged();
void currentNetworkNameChanged();
void isSnapshotActiveChanged();

private:
QString m_current_network_name;
Expand Down
Loading

0 comments on commit 955c65d

Please sign in to comment.