Implement background sync for xmr using flutter_daemon (#2094)

* Implement background sync for xmr using flutter_daemon * - initialize app config in background thread - initializeAppConfigs without loading the wallet. * - properly do awaited calls in methodChannel - prevent locking main thread during background sync * add back background sync debug page fix issues caused by xmr wallet being view only (and read only) * changes from review improve starting of bgsync task * update stopBackgroundSync, await listener functions, ensure that listener always start (call _start in constructor) * DO-NOT-MERGE: extre verbose monero logs * stop background service when app is being opened * improve monitoring of background sync * update flutter_daemon to ensure network constraint prevent throwing errors on isBackgroundSyncEnabled check network before syncing * Update lib/main.dart * revert Update main.dart [skip ci] * continously run network check * disable charging requirement, fix status reporting of background sync in UI * Refactor background sync logic, and add UI notifications for battery optimization. Updated flutter_daemon version modified build.gradle for signing config to allow testing in both release and debug modes. * verbose monero only when requested in code. Do not start background sync when battery optimization is on * fix background sync mode not properly reflecting state changes * drop unnecessary dependency --------- Co-authored-by: Omar Hatem <omarh.ismail1@gmail.com>
2025-06-28 12:29:51 +00:00 · 2025-03-21 18:22:00 +01:00 · 2025-03-21 18:22:00 +01:00 · 686580ff78
commit 686580ff78
parent d44621e6c7
60 changed files with 853 additions and 352 deletions
--- a/lib/core/background_sync.dart
+++ b/lib/core/background_sync.dart
@ -0,0 +1,107 @@
+import 'dart:async';
+import 'dart:math';
+
+import 'package:cake_wallet/core/key_service.dart';
+import 'package:cake_wallet/core/wallet_loading_service.dart';
+import 'package:cake_wallet/di.dart';
+import 'package:cake_wallet/store/settings_store.dart';
+import 'package:cake_wallet/view_model/wallet_list/wallet_list_item.dart';
+import 'package:cake_wallet/view_model/wallet_list/wallet_list_view_model.dart';
+import 'package:cw_core/sync_status.dart';
+import 'package:cw_core/utils/print_verbose.dart';
+import 'package:cw_core/wallet_type.dart';
+import 'package:flutter/foundation.dart';
+import 'package:http/http.dart' as http;
+
+class BackgroundSync {
+  Future<void> sync() async {
+    printV("Background sync started");
+    await _syncMonero();
+    printV("Background sync completed");
+  }
+
+  Future<void> _syncMonero() async {
+    final walletLoadingService = getIt.get<WalletLoadingService>();
+    final walletListViewModel = getIt.get<WalletListViewModel>();
+    final settingsStore = getIt.get<SettingsStore>();
+
+
+    final List<WalletListItem> moneroWallets = walletListViewModel.wallets
+        .where((element) => !element.isHardware)
+        .where((element) => [WalletType.monero].contains(element.type))
+        .toList();
+    for (int i = 0; i < moneroWallets.length; i++) {
+      final wallet = await walletLoadingService.load(moneroWallets[i].type, moneroWallets[i].name);
+      int syncedTicks = 0;
+      final keyService = getIt.get<KeyService>();
+      
+      int stuckTicks = 0;
+
+      inner:
+      while (true) {
+        await Future.delayed(const Duration(seconds: 1));
+        final syncStatus = wallet.syncStatus;
+        final progress = syncStatus.progress();
+        if (syncStatus is ConnectedSyncStatus || syncStatus is AttemptingSyncStatus || syncStatus is NotConnectedSyncStatus) {
+          stuckTicks++;
+          if (stuckTicks > 30) {
+            printV("${wallet.name} STUCK SYNCING");
+            break inner;
+          }
+        } else {
+          stuckTicks = 0;
+        }
+        if (syncStatus is NotConnectedSyncStatus) {
+          printV("${wallet.name} NOT CONNECTED");
+          final node = settingsStore.getCurrentNode(wallet.type);
+          await wallet.connectToNode(node: node);
+          await wallet.startBackgroundSync();
+          printV("STARTED SYNC");
+          continue inner;
+        }
+
+        if (progress > 0.999 || syncStatus is SyncedSyncStatus) {
+          syncedTicks++;
+          if (syncedTicks > 5) {
+            syncedTicks = 0;
+            printV("WALLET $i SYNCED");
+            try {
+              await wallet.stopBackgroundSync((await keyService.getWalletPassword(walletName: wallet.name)));
+            } catch (e) {
+              printV("error stopping sync: $e");
+            }
+            break inner;
+          }
+        } else {
+          syncedTicks = 0;
+        }
+        if (kDebugMode) {
+          if (syncStatus is SyncingSyncStatus) {
+            final blocksLeft = syncStatus.blocksLeft;
+            printV("$blocksLeft Blocks Left");
+          } else if (syncStatus is SyncedSyncStatus) {
+            printV("Synced");
+          } else if (syncStatus is SyncedTipSyncStatus) {
+            printV("Scanned Tip: ${syncStatus.tip}");
+          } else if (syncStatus is NotConnectedSyncStatus) {
+            printV("Still Not Connected");
+          } else if (syncStatus is AttemptingSyncStatus) {
+            printV("Attempting Sync");
+          } else if (syncStatus is StartingScanSyncStatus) {
+            printV("Starting Scan");
+          } else if (syncStatus is SyncronizingSyncStatus) {
+            printV("Syncronizing");
+          } else if (syncStatus is FailedSyncStatus) {
+            printV("Failed Sync");
+          } else if (syncStatus is ConnectingSyncStatus) {
+            printV("Connecting");
+          } else {
+            printV("Unknown Sync Status ${syncStatus.runtimeType}");
+          }
+        }
+      }
+      await wallet.stopBackgroundSync(await keyService.getWalletPassword(walletName: wallet.name));
+      await wallet.close(shouldCleanup: true);
+    }
+  }
+}