This document outlines the key functions modified or introduced in the recent feature work regarding sync pausing, skipping, minimization behavior, and application exit.
-## `src/libwalletqt/Wallet.cpp`
+## Wallet Backend Operations
-### `syncStatusUpdated(quint64 height, quint64 target)`
-**Role:** Signals the UI about synchronization progress.
-**Modification:**
-- Updated to check for `m_stopHeight` during range syncs.
-- Calls `skipToTip()` if the range sync target is reached.
-- Emits `syncStatus` signal to update the UI.
-- **Note:** Contains a `TODO` regarding the necessity of `updateBalance()`.
-- Emits `syncStatus` signal to update the UI.
-- **Note:** Contains a `TODO` regarding the necessity of `updateBalance()`.
+These functions control the core synchronization logic, blockchain scanning, and connection management causing state changes in the wallet.
### `initAsync(const QString &daemonAddress, bool trustedDaemon, quint64 searchHeight)`
+**Class:** `Wallet` (`src/libwalletqt/Wallet.cpp`)
**Role:** Initializes the wallet asynchronously.
**Details:**
- Sets connection status to `Connecting`.
- On success, if sync is not paused, calls `startRefresh()`.
### `startRefresh()`
+**Class:** `Wallet` (`src/libwalletqt/Wallet.cpp`)
**Role:** Enables the background refresh loop.
**Implementation:**
- Sets `m_refreshEnabled = true`.
- Sets `m_refreshNow = true` to force an immediate check in the refresh thread.
### `pauseRefresh()`
+**Class:** `Wallet` (`src/libwalletqt/Wallet.cpp`)
**Role:** Disables the background refresh loop.
**Implementation:**
- Sets `m_refreshEnabled = false`.
- Used by `setSyncPaused`, `skipToTip`, and other methods that need to interrupt scanning.
### `startRefreshThread()`
+**Class:** `Wallet` (`src/libwalletqt/Wallet.cpp`)
**Role:** The main background loop for wallet synchronization.
**Details:**
- Runs continuously on a separate thread.
- Checks `m_refreshEnabled` every 10 seconds (or immediately if `m_refreshNow` is true).
- Calls `m_walletImpl->refresh()` to fetch blocks.
- Emits `refreshed` signals.
-
+
### `setSyncPaused(bool paused)`
+**Class:** `Wallet` (`src/libwalletqt/Wallet.cpp`)
**Role:** Pauses or resumes the wallet synchronization process.
**Implementation:**
- Sets `m_syncPaused` flag.
- Calls `pauseRefresh()` or `startRefresh()` on the underlying `wallet2` instance.
+### `syncStatusUpdated(quint64 height, quint64 target)`
+**Class:** `Wallet` (`src/libwalletqt/Wallet.cpp`)
+**Role:** Signals the UI about synchronization progress.
+**Modification:**
+- Updated to check for `m_stopHeight` during range syncs.
+- Calls `skipToTip()` if the range sync target is reached.
+- Emits `syncStatus` signal to update the UI.
+- **Note:** Contains a `TODO` regarding the necessity of `updateBalance()`.
+
### `skipToTip()`
+**Class:** `Wallet` (`src/libwalletqt/Wallet.cpp`)
**Role:** Fast-forwards the wallet to the current network tip.
**Usage:** Used when the user wants to skip scanning old blocks (e.g. data saver mode).
**Details:**
- Logs the jump ("Head moving from X to Y").
### `syncDateRange(const QDate &start, const QDate &end)`
+**Class:** `Wallet` (`src/libwalletqt/Wallet.cpp`)
**Role:** Syncs the wallet for a specific date range.
**Workflow:**
- Converts dates to block heights using `RestoreHeightLookup`.
- Enables `m_rangeSyncActive`.
### `fullSync()`
+**Class:** `Wallet` (`src/libwalletqt/Wallet.cpp`)
**Role:** Resets the wallet to scan from the original creation height.
**Details:**
- Retrieves `feather.creation_height` from cache.
- Clears `m_rangeSyncActive`.
- Triggers rescan.
-## `src/MainWindow.cpp`
+## UI Tweaks & Event Handling
+
+These functions handle user interaction, window management, and visual feedback based on backend state.
### `onSyncStatus(quint64 height, quint64 target, bool daemonSync)`
+**Class:** `MainWindow` (`src/MainWindow.cpp`)
**Role:** Updates the status bar with sync progress.
**Modifications:**
- Added detailed logging (escalated to `qWarning` for visibility).
- Formats "Blocks remaining" and "Approximate size".
### `changeEvent(QEvent *event)`
+**Class:** `MainWindow` (`src/MainWindow.cpp`)
**Role:** Handles window state changes (minimization).
**Work:**
- **Reverted Attempt:** Initial `QWindow::visibilityChanged` hook was unreliable on Wayland.
- Handles `lockOnMinimize`.
### `setPausedSyncStatus()`
+**Class:** `MainWindow` (`src/MainWindow.cpp`)
**Role:** Updates UI when sync is explicitly paused.
**Details:**
- Sets status text to "Sync paused".
- Improved logging (`qWarning`).
-## `src/WindowManager.cpp`
+### `onBalanceUpdated(quint64 balance, quint64 spendable)`
+**Class:** `MainWindow` (`src/MainWindow.cpp`)
+**Role:** Updates the displayed balance in the UI.
+**Context:**
+- Triggered by `Wallet::syncStatusUpdated` (indirectly or directly via signal).
+- Ensures balance is fresh on new blocks.
+
+### `toggleVisibility()` (Concept / Tray Logic)
+**Class:** `WindowManager` / `QSystemTrayIcon`
+**Role:** Toggles window show/hide state on tray click.
+**Context:**
+- Integrated into the tray icon left-click handler logic within `DataManager` / `WindowManager` context (specifically `QSystemTrayIcon::activated`).
+- Replaced the "Context Menu" on left click default behavior.
+
+### `buildTrayMenu()`
+**Class:** `WindowManager` (`src/WindowManager.cpp`)
+**Role:** Constructs the context menu for the system tray icon.
+**Modifications:**
+- Updated to support character-based truncation for long wallet names to prevent menu bloat.
### `close()`
+**Class:** `WindowManager` (`src/WindowManager.cpp`)
**Role:** Handles application shutdown.
**Critical Fix:**
- Reordered shutdown logic to close all windows *before* waiting for the global thread pool.
- Prevents deadlocks where background threads (refreshing wallets) would hang waiting for the thread pool while the UI was still partially active.
- Added recursion guard `m_closing` to prevent infinite loops during tray exit.
-### `toggleVisibility()` (Concept)
-**Role:** Toggles window show/hide state.
-**Context:**
-- Integrated into the tray icon left-click handler logic within `DataManager` / `WindowManager` context (specifically `QSystemTrayIcon::activated`).
-- Replaced the "Context Menu" on left click default behavior.
+## Utility & Helper Logic
+
+### `estimateSyncDataSize(quint64 blocks)`
+**Class:** `Utils` (`src/utils/Utils.cpp`)
+**Role:** Estimates the data download size required for synchronization.
+**Formula:** `blocks * 1024` (Bytes). Simplified estimate assuming ~1KB per block for wallet scanning purposes.
+
+### `formatPausedSyncStatus(quint64 blocks)`
+**Class:** `Utils` (`src/utils/Utils.cpp`)
+**Role:** Formats the status string when sync is paused.
+**Key Logic:**
+- Uses `blocksBehind = (daemonHeight > startHeight) ? (daemonHeight - startHeight) : 0;`
+- Displays "Sync X blocks / Y size upon resume".
+
+### `SubaddressProxyModel` Filtering
+**Class:** `SubaddressProxyModel` (`src/model/SubaddressProxyModel.h`)
+**Methods:**
+- `beginFilterChange()`
+- `invalidateFilter()` / `invalidate()` (Qt6 compatibility fix)
+- `endFilterChange()`
+**Role:** Updates the subaddress list view when the user searches or filters.
+**Change:** Updated `invalidateFilter()` (Qt5) to `invalidate()` (Qt6) to resolve deprecation warnings.
+
+### `connectToNode()`
+**Class:** `MainWindow` / `Nodes`
+**Role:** Initiates connection to a remote node.
+**Details:**
+- Manages strict socket lifetime.
+- Triggers `onConnectionStatusChanged` which updates the status bar icons.
+
projects / gamesguru / feather.git / commitdiff