CW-909-monero-background-sync-investigation

android/app/build.gradle

@@ -64,6 +64,10 @@ android {
         }
     }
 
+    compileOptions {
+        coreLibraryDesugaringEnabled true
+    }
+
     signingConfigs {
        release {
            keyAlias keystoreProperties['keyAlias']
@@ -94,6 +98,7 @@ dependencies {
     testImplementation 'junit:junit:4.12'
     androidTestImplementation 'androidx.test:runner:1.3.0'
     androidTestImplementation 'androidx.test.espresso:espresso-core:3.3.0'
+    coreLibraryDesugaring 'com.android.tools:desugar_jdk_libs:2.0.3'
 }
 configurations {
     implementation.exclude module:'proto-google-common-protos'

android/app/src/main/AndroidManifestBase.xml

@@ -25,6 +25,9 @@
     <uses-permission android:name="android.permission.BLUETOOTH_ADVERTISE" />
 
 
+<!-- background sync -->
+    <uses-permission android:name="android.permission.FOREGROUND_SERVICE_DATA_SYNC" />
+
     <application
         android:name=".Application"
         android:label="${APP_NAME}"
@@ -101,6 +104,10 @@
                 <data android:scheme="nano-gpt" />
             </intent-filter>
         </activity>
+        <service
+            android:name="id.flutter.flutter_background_service.BackgroundService"
+            android:foregroundServiceType="dataSync"
+        />
         <meta-data
                 android:name="flutterEmbedding"
                 android:value="2" />

cw_bitcoin/lib/electrum_wallet.dart

@@ -452,7 +452,7 @@ abstract class ElectrumWalletBase
 
   @action
   @override
-  Future<void> startSync() async {
+  Future<void> startSync({bool isBackgroundSync = false}) async {
     try {
       if (syncStatus is SyncronizingSyncStatus) {
         return;
@@ -471,7 +471,8 @@ abstract class ElectrumWalletBase
       await updateBalance();
       await updateFeeRates();
 
-      _updateFeeRateTimer ??=
+      _updateFeeRateTimer?.cancel();
+      _updateFeeRateTimer =
           Timer.periodic(const Duration(minutes: 1), (timer) async => await updateFeeRates());
 
       if (alwaysScan == true) {
@@ -487,6 +488,19 @@ abstract class ElectrumWalletBase
     }
   }
 
+  @action
+  @override
+  Future<void> stopSync({bool isBackgroundSync = false}) async {
+    syncStatus = NotConnectedSyncStatus();
+    try {
+      await _receiveStream?.cancel();
+      electrumClient.onConnectionStatusChange = null;
+      await electrumClient.close();
+    } catch (_) {}
+    _updateFeeRateTimer?.cancel();
+    _autoSaveTimer?.cancel();
+  }
+
   @action
   Future<void> updateFeeRates() async {
     if (await checkIfMempoolAPIIsEnabled() && type == WalletType.bitcoin) {

cw_bitcoin/lib/litecoin_wallet.dart

@@ -303,7 +303,7 @@ abstract class LitecoinWalletBase extends ElectrumWallet with Store {
 
   @action
   @override
-  Future<void> startSync() async {
+  Future<void> startSync({bool isBackgroundSync = false}) async {
     printV("startSync() called!");
     printV("STARTING SYNC - MWEB ENABLED: $mwebEnabled");
     if (!mwebEnabled) {
@@ -437,12 +437,13 @@ abstract class LitecoinWalletBase extends ElectrumWallet with Store {
 
   @action
   @override
-  Future<void> stopSync() async {
+  Future<void> stopSync({bool isBackgroundSync = false}) async {
     printV("stopSync() called!");
     _syncTimer?.cancel();
     _utxoStream?.cancel();
     _feeRatesTimer?.cancel();
     await CwMweb.stop();
+    await super.stopSync();
     printV("stopped syncing!");
   }
 

cw_core/lib/sync_status.dart

@@ -96,3 +96,12 @@ class LostConnectionSyncStatus extends NotConnectedSyncStatus {
   @override
   String toString() => 'Reconnecting';
 }
+
+// when the application has been paused by the OS:
+class StoppedSyncingSyncStatus extends NotConnectedSyncStatus {
+  @override
+  double progress() => 0.0;
+
+  @override
+  String toString() => 'stopped';
+}

cw_core/lib/wallet_base.dart

@@ -60,14 +60,16 @@ abstract class WalletBase<BalanceType extends Balance, HistoryType extends Trans
 
   bool get isHardwareWallet => walletInfo.isHardwareWallet;
 
+  Future<void> init();
+
   Future<void> connectToNode({required Node node});
 
   // there is a default definition here because only coins with a pow node (nano based) need to override this
   Future<void> connectToPowNode({required Node node}) async {}
 
-  Future<void> startSync();
+  Future<void> startSync({bool isBackgroundSync = false});
 
-  Future<void> stopSync() async {}
+  Future<void> stopSync({bool isBackgroundSync = false}) async {}
 
   Future<PendingTransaction> createTransaction(Object credentials);
 
@@ -100,4 +102,7 @@ abstract class WalletBase<BalanceType extends Balance, HistoryType extends Trans
   Future<bool> verifyMessage(String message, String signature, {String? address = null});
 
   bool isTestnet = false;
+
+  // TODO: use proxy layer
+  Future<void> reopenWallet() async {}
 }

cw_evm/lib/evm_chain_wallet.dart

@@ -299,7 +299,7 @@ abstract class EVMChainWalletBase
 
   @action
   @override
-  Future<void> startSync() async {
+  Future<void> startSync({bool isBackgroundSync = false}) async {
     try {
       syncStatus = AttemptingSyncStatus();
       await _updateBalance();

cw_haven/lib/haven_wallet.dart

@@ -137,7 +137,7 @@ abstract class HavenWalletBase
   }
 
   @override
-  Future<void> startSync() async {
+  Future<void> startSync({bool isBackgroundSync = false}) async {
     try {
       _setInitialHeight();
     } catch (_) {}

cw_monero/lib/api/account_list.dart

@@ -37,7 +37,7 @@ List<monero.SubaddressAccountRow> getAllAccount() {
   int size = monero.SubaddressAccount_getAll_size(subaddressAccount!);
   if (size == 0) {
     monero.Wallet_addSubaddressAccount(wptr!);
-    return getAllAccount();
+    return [];
   }
   return List.generate(size, (index) {
     return monero.SubaddressAccount_getAll_byIndex(subaddressAccount!, index: index);

cw_monero/lib/api/subaddress_list.dart

@@ -1,4 +1,5 @@
 
+import 'package:cw_core/utils/print_verbose.dart';
 import 'package:cw_monero/api/account_list.dart';
 import 'package:cw_monero/api/transaction_history.dart';
 import 'package:cw_monero/api/wallet.dart';
@@ -123,6 +124,10 @@ int numSubaddresses(int subaccountIndex) {
 }
 
 void addSubaddressSync({required int accountIndex, required String label}) {
+  if (monero.Wallet_numSubaddressAccounts(wptr!) <= accountIndex) {
+    printV("accountIndex is out of bounds");
+    return;
+  }
   monero.Wallet_addSubaddress(wptr!, accountIndex: accountIndex, label: label);
   refreshSubaddresses(accountIndex: accountIndex);
 }

cw_monero/lib/api/wallet.dart

@@ -62,15 +62,25 @@ String getSeed() {
 }
 
 String getSeedLegacy(String? language) {
-  final cakepassphrase = getPassphrase();
-  var legacy = monero.Wallet_seed(wptr!, seedOffset: cakepassphrase);
   switch (language) {
-    case "Chinese (Traditional)": language = "Chinese (simplified)"; break;
-    case "Chinese (Simplified)": language = "Chinese (simplified)"; break;
-    case "Korean": language = "English"; break;
-    case "Czech": language = "English"; break;
-    case "Japanese": language = "English"; break;
+    case "Chinese (Traditional)":
+      language = "Chinese (simplified)";
+      break;
+    case "Chinese (Simplified)":
+      language = "Chinese (simplified)";
+      break;
+    case "Korean":
+      language = "English";
+      break;
+    case "Czech":
+      language = "English";
+      break;
+    case "Japanese":
+      language = "English";
+      break;
   }
+  final cakepassphrase = getPassphrase();
+  var legacy = monero.Wallet_seed(wptr!, seedOffset: cakepassphrase);
   if (monero.Wallet_status(wptr!) != 0) {
     monero.Wallet_setSeedLanguage(wptr!, language: language ?? "English");
     legacy = monero.Wallet_seed(wptr!, seedOffset: cakepassphrase);
@@ -86,21 +96,33 @@ String getSeedLegacy(String? language) {
 }
 
 String getPassphrase() {
-  return monero.Wallet_getCacheAttribute(wptr!, key: "cakewallet.passphrase");
+  final toret = monero.Wallet_getCacheAttribute(wptr!, key: "cakewallet.passphrase");
+  monero.Wallet_status(wptr!); // clear status code
+  return toret;
 }
 
 Map<int, Map<int, Map<int, String>>> addressCache = {};
 
 String getAddress({int accountIndex = 0, int addressIndex = 0}) {
-  // printV("getaddress: ${accountIndex}/${addressIndex}: ${monero.Wallet_numSubaddresses(wptr!, accountIndex: accountIndex)}: ${monero.Wallet_address(wptr!, accountIndex: accountIndex, addressIndex: addressIndex)}");
-  while (monero.Wallet_numSubaddresses(wptr!, accountIndex: accountIndex)-1 < addressIndex) {
-    printV("adding subaddress");
+
+  int count = 0;
+
+  while (monero.Wallet_numSubaddresses(wptr!, accountIndex: accountIndex) - 1 < addressIndex) {
+    if (monero.Wallet_numSubaddressAccounts(wptr!) <= accountIndex) {
+      printV("accountIndex is out of bounds");
+      break;
+    }
     monero.Wallet_addSubaddress(wptr!, accountIndex: accountIndex);
+    if (count > 10) {
+      break;
+    }
+    count++;
   }
+
   addressCache[wptr!.address] ??= {};
   addressCache[wptr!.address]![accountIndex] ??= {};
-  addressCache[wptr!.address]![accountIndex]![addressIndex] ??= monero.Wallet_address(wptr!,
-        accountIndex: accountIndex, addressIndex: addressIndex);
+  addressCache[wptr!.address]![accountIndex]![addressIndex] ??=
+      monero.Wallet_address(wptr!, accountIndex: accountIndex, addressIndex: addressIndex);
   return addressCache[wptr!.address]![accountIndex]![addressIndex]!;
 }
 
@@ -155,7 +177,8 @@ Future<bool> setupNodeSync(
 
   if (kDebugMode && debugMonero) {
     monero.Wallet_init3(
-      wptr!, argv0: '',
+      wptr!,
+      argv0: '',
       defaultLogBaseName: 'moneroc',
       console: true,
       logPath: '',
@@ -170,17 +193,29 @@ void startRefreshSync() {
   monero.Wallet_startRefresh(wptr!);
 }
 
+void setupBackgroundSync(
+    {required int backgroundSyncType,
+    required String walletPassword,
+    required String backgroundCachePassword}) {
+  monero.Wallet_setupBackgroundSync(wptr!,
+      backgroundSyncType: backgroundSyncType,
+      walletPassword: walletPassword,
+      backgroundCachePassword: backgroundCachePassword);
+}
+
+
+void stopSync() {
+  monero.Wallet_init(wptr!, daemonAddress: "");
+}
 
 void setRefreshFromBlockHeight({required int height}) =>
-    monero.Wallet_setRefreshFromBlockHeight(wptr!,
-        refresh_from_block_height: height);
+    monero.Wallet_setRefreshFromBlockHeight(wptr!, refresh_from_block_height: height);
 
 void setRecoveringFromSeed({required bool isRecovery}) =>
     monero.Wallet_setRecoveringFromSeed(wptr!, recoveringFromSeed: isRecovery);
 
 final storeMutex = Mutex();
 
-
 int lastStorePointer = 0;
 int lastStoreHeight = 0;
 void storeSync({bool force = false}) async {
@@ -190,7 +225,7 @@ void storeSync({bool force = false}) async {
   });
   if (lastStorePointer == wptr!.address &&
       lastStoreHeight + 5000 > monero.Wallet_blockChainHeight(wptr!) &&
-      !synchronized && 
+      !synchronized &&
       !force) {
     return;
   }
@@ -216,6 +251,10 @@ void closeCurrentWallet() {
   monero.Wallet_stop(wptr!);
 }
 
+void stopWallet() {
+  monero.Wallet_stop(wptr!);
+}
+
 String getSecretViewKey() => monero.Wallet_secretViewKey(wptr!);
 
 String getPublicViewKey() => monero.Wallet_publicViewKey(wptr!);
@@ -250,8 +289,7 @@ class SyncListener {
     _cachedBlockchainHeight = 0;
     _lastKnownBlockHeight = 0;
     _initialSyncHeight = 0;
-    _updateSyncInfoTimer ??=
-        Timer.periodic(Duration(milliseconds: 1200), (_) async {
+    _updateSyncInfoTimer ??= Timer.periodic(Duration(milliseconds: 1200), (_) async {
       if (isNewTransactionExist()) {
         onNewTransaction();
       }
@@ -290,8 +328,8 @@ class SyncListener {
   void stop() => _updateSyncInfoTimer?.cancel();
 }
 
-SyncListener setListeners(void Function(int, int, double) onNewBlock,
-    void Function() onNewTransaction) {
+SyncListener setListeners(
+    void Function(int, int, double) onNewBlock, void Function() onNewTransaction) {
   final listener = SyncListener(onNewBlock, onNewTransaction);
   // setListenerNative();
   return listener;
@@ -353,8 +391,7 @@ String getSubaddressLabel(int accountIndex, int addressIndex) {
       accountIndex: accountIndex, addressIndex: addressIndex);
 }
 
-Future setTrustedDaemon(bool trusted) async =>
-    monero.Wallet_setTrustedDaemon(wptr!, arg: trusted);
+Future setTrustedDaemon(bool trusted) async => monero.Wallet_setTrustedDaemon(wptr!, arg: trusted);
 
 Future<bool> trustedDaemon() async => monero.Wallet_trustedDaemon(wptr!);
 
@@ -363,5 +400,6 @@ String signMessage(String message, {String address = ""}) {
 }
 
 bool verifyMessage(String message, String address, String signature) {
-  return monero.Wallet_verifySignedMessage(wptr!, message: message, address: address, signature: signature);
+  return monero.Wallet_verifySignedMessage(wptr!,
+      message: message, address: address, signature: signature);
 }