Merge pull request #948 from SatoshiPortal/develop

5.2.0

Author: ethicnology

CONTRIBUTING.md

@@ -6,11 +6,22 @@ TODO: Describe the branch structure, forking to a personal repository, pull requ
 
 ## Generated files
 
-This project uses flutter freezed. Freezed files are not checked into git and must be generated locally using:
+A `makefile` is available to assist you during the setup of the project and generate all needed files using the command `make setup`.
 
-```
-flutter pub run build_runner watch --delete-conflicting-outputs
-```
+
+## Guidelines
+
+- Keep it simple.
+
+- Write code that's easy to read and maintain think of your teammate who will read it next.
+
+- Suffix your files (`_datasource.dart` `_repository.dart` `_model.dart` `_usecase.dart` `_entity.dart` `_widget.dart` `_page.dart` )
+
+- Avoid creating unnecessary folders. Since most files have descriptive suffixes, only create a folder if you're placing multiple related files inside.
+
+- Avoid abstract classes unless there's a clear current need. Don’t preemptively abstract for hypothetical future cases, start concrete, and refactor when it becomes necessary.
+
+- Favor end-to-end and integration testing at the use case and widget level rather than relying on mocks. Since this is an app project, our priority is to catch real-world issues across layers. Mocking should be used only when necessary
 
 ## Adding a new feature
 

ios/Runner.xcodeproj/project.pbxproj

@@ -488,19 +488,19 @@
 			buildSettings = {
 				ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon;
 				CLANG_ENABLE_MODULES = YES;
-				CURRENT_PROJECT_VERSION = 54;
+				CURRENT_PROJECT_VERSION = 57;
 				DEVELOPMENT_TEAM = BX99T32YGS;
 				ENABLE_BITCODE = NO;
-				FLUTTER_BUILD_NAME = 5.1.0;
-				FLUTTER_BUILD_NUMBER = 54;
+				FLUTTER_BUILD_NAME = 5.1.1;
+				FLUTTER_BUILD_NUMBER = 57;
 				INFOPLIST_FILE = Runner/Info.plist;
 				INFOPLIST_KEY_CFBundleDisplayName = BULL;
 				INFOPLIST_KEY_LSApplicationCategoryType = "public.app-category.finance";
 				LD_RUNPATH_SEARCH_PATHS = (
 					"$(inherited)",
 					"@executable_path/Frameworks",
 				);
-				MARKETING_VERSION = 5.1.0;
+				MARKETING_VERSION = 5.1.1;
 				PRODUCT_BUNDLE_IDENTIFIER = com.bullbitcoin.app;
 				PRODUCT_NAME = "$(TARGET_NAME)";
 				SWIFT_OBJC_BRIDGING_HEADER = "Runner/Runner-Bridging-Header.h";
@@ -678,19 +678,19 @@
 			buildSettings = {
 				ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon;
 				CLANG_ENABLE_MODULES = YES;
-				CURRENT_PROJECT_VERSION = 54;
+				CURRENT_PROJECT_VERSION = 57;
 				DEVELOPMENT_TEAM = BX99T32YGS;
 				ENABLE_BITCODE = NO;
-				FLUTTER_BUILD_NAME = 5.1.0;
-				FLUTTER_BUILD_NUMBER = 54;
+				FLUTTER_BUILD_NAME = 5.1.1;
+				FLUTTER_BUILD_NUMBER = 57;
 				INFOPLIST_FILE = Runner/Info.plist;
 				INFOPLIST_KEY_CFBundleDisplayName = BULL;
 				INFOPLIST_KEY_LSApplicationCategoryType = "public.app-category.finance";
 				LD_RUNPATH_SEARCH_PATHS = (
 					"$(inherited)",
 					"@executable_path/Frameworks",
 				);
-				MARKETING_VERSION = 5.1.0;
+				MARKETING_VERSION = 5.1.1;
 				PRODUCT_BUNDLE_IDENTIFIER = com.bullbitcoin.app;
 				PRODUCT_NAME = "$(TARGET_NAME)";
 				SWIFT_OBJC_BRIDGING_HEADER = "Runner/Runner-Bridging-Header.h";
@@ -706,19 +706,19 @@
 			buildSettings = {
 				ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon;
 				CLANG_ENABLE_MODULES = YES;
-				CURRENT_PROJECT_VERSION = 54;
+				CURRENT_PROJECT_VERSION = 57;
 				DEVELOPMENT_TEAM = BX99T32YGS;
 				ENABLE_BITCODE = NO;
-				FLUTTER_BUILD_NAME = 5.1.0;
-				FLUTTER_BUILD_NUMBER = 54;
+				FLUTTER_BUILD_NAME = 5.1.1;
+				FLUTTER_BUILD_NUMBER = 57;
 				INFOPLIST_FILE = Runner/Info.plist;
 				INFOPLIST_KEY_CFBundleDisplayName = BULL;
 				INFOPLIST_KEY_LSApplicationCategoryType = "public.app-category.finance";
 				LD_RUNPATH_SEARCH_PATHS = (
 					"$(inherited)",
 					"@executable_path/Frameworks",
 				);
-				MARKETING_VERSION = 5.1.0;
+				MARKETING_VERSION = 5.1.1;
 				PRODUCT_BUNDLE_IDENTIFIER = com.bullbitcoin.app;
 				PRODUCT_NAME = "$(TARGET_NAME)";
 				SWIFT_OBJC_BRIDGING_HEADER = "Runner/Runner-Bridging-Header.h";

lib/core/storage/migrations/004_legacy/migration01to02.dart

@@ -34,64 +34,71 @@ Future<void> doMigration0_1to0_2() async {
 
     OldSeed? liquidMainnetSeed;
     bool isDefault = true;
-    log.info('0.1.*: Found ${walletIds.length} wallets');
+    log.info('0.1.*: Starting wallet migration');
 
     for (final walletId in walletIds) {
-      final jsn = hiveDatasource.getValue(walletId as String);
-      if (jsn == null) throw 'Abort';
-
-      Map<String, dynamic> walletObj = jsonDecode(jsn) as Map<String, dynamic>;
-
-      final mnemonicFingerprint = walletObj['mnemonicFingerprint'] as String;
-      final seed = await oldSeedRepository.fetch(
-        fingerprint: mnemonicFingerprint,
-      );
-      final res = await updateWalletObj(walletObj, seed, isDefault);
-      liquidMainnetSeed ??= res.liquidMainnetSeed;
-      walletObj = res.walletObj;
-      if (liquidMainnetSeed != null) {
-        isDefault = false;
+      try {
+        final jsn = hiveDatasource.getValue(walletId as String);
+        if (jsn == null) {
+          log.warning('0.1.*: Wallet data not found for ID: $walletId');
+          continue;
+        }
+
+        Map<String, dynamic> walletObj =
+            jsonDecode(jsn) as Map<String, dynamic>;
+        log.info(
+          '0.1.*: Processing wallet ${walletObj['id']}, type: ${walletObj['type']}, network: ${walletObj['network']}',
+        );
+
+        final mnemonicFingerprint = walletObj['mnemonicFingerprint'] as String;
+        OldSeed? seed;
+        try {
+          seed = await oldSeedRepository.fetch(
+            fingerprint: mnemonicFingerprint,
+          );
+        } catch (e) {
+          log.severe(
+            '0.1.*: Failed to fetch seed for wallet ${walletObj['id']}',
+          );
+        }
+
+        final res = await updateWalletObj(walletObj, seed, isDefault);
+        liquidMainnetSeed ??= res.liquidMainnetSeed;
+        walletObj = res.walletObj;
+        if (liquidMainnetSeed != null) {
+          isDefault = false;
+        }
+
+        log.info(
+          '0.1.*: Updated wallet ${walletObj['id']} to type: ${walletObj['type']}, mainWallet: ${walletObj['mainWallet']}',
+        );
+
+        walletObj = await addIsLiquidFalse(walletObj);
+
+        final w = OldWallet.fromJson(walletObj);
+        wallets.add(w);
+      } catch (e) {
+        log.severe('0.1.*: Error processing wallet $walletId: $e');
+        continue;
       }
-
-      walletObj = await addIsLiquidFalse(walletObj);
-
-      final w = OldWallet.fromJson(walletObj);
-      wallets.add(w);
-      // this loop only adds bitcoin wallets
     }
 
     if (liquidMainnetSeed == null) {
-      throw 'Could not create liquid mainnet wallet. Abort.';
+      throw 'Could not create liquid mainnet wallet. No valid mainnet seed found.';
     }
-    final liqWallet = await createLiquidWallet(liquidMainnetSeed);
 
+    log.info('0.1.*: Creating liquid wallet from mainnet seed');
+    final liqWallet = await createLiquidWallet(liquidMainnetSeed);
     wallets.addAll([liqWallet]);
-
-    // final mainWalletIdx = wallets.indexWhere(
-    //   (w) => !w.isTestnet() && w.isSecure(),
-    // );
-
-    // final liqMainnetIdx = wallets.indexWhere(
-    //   (w) => !w.isTestnet() && w.isInstant(),
-    // );
-
-    // if (mainWalletIdx != -1 && liqMainnetIdx != -1) {
-    //   if (wallets.length > 2) {
-    //     final tempMain = wallets[mainWalletIdx];
-    //     final tempLiq = wallets[liqMainnetIdx];
-    //     wallets.removeAt(mainWalletIdx);
-    //     wallets.removeAt(liqMainnetIdx - 1);
-    //     wallets.insert(0, tempLiq);
-    //     wallets.insert(1, tempMain);
-    //   }
-    // }
+    log.info('0.1.*: Liquid wallet created successfully');
 
     final walletObjs = wallets.map((w) => w.toJson()).toList();
     final List<String> ids = [];
     for (final w in walletObjs) {
       final id = w['id'] as String;
       ids.add(id);
       final _ = await hiveDatasource.saveValue(key: id, value: jsonEncode(w));
+      log.info('0.1.*: Saved migrated wallet $id');
     }
 
     final idsJsn = jsonEncode({
@@ -105,19 +112,22 @@ Future<void> doMigration0_1to0_2() async {
     final walletIdsRawPost = hiveDatasource.getValue(
       OldStorageKeys.wallets.name,
     );
-    if (walletIdsRawPost == null) throw 'No Wallets found';
+    if (walletIdsRawPost == null) throw 'No Wallets found after migration';
 
     final walletIdsPost =
         jsonDecode(walletIdsRawPost)['wallets'] as List<dynamic>;
-    if (walletIdsPost.isEmpty) throw 'No Wallets found';
-    log.info('0.1.*: Updated Wallets-> ${walletIdsPost.length} wallets');
+    if (walletIdsPost.isEmpty) throw 'No Wallets found after migration';
+    log.info(
+      '0.1.*: Migration completed. Total wallets: ${walletIdsPost.length}',
+    );
 
     await secureStorageDatasource.store(
       key: OldStorageKeys.version.name,
       value: '0.2.0',
-    ); // gets overwritten by the exact 0.2.* version later}
-  } catch (e) {
-    log.severe('Legacy Migration Failed: $e');
+    ); // gets overwritten by the exact 0.2.* version later
+  } catch (e, stack) {
+    log.severe('Legacy Migration Failed', error: e, trace: stack);
+    rethrow;
   }
 }
 
@@ -128,6 +138,12 @@ updateWalletObj(
   bool isDefault,
 ) async {
   OldSeed? liquidMainnetSeed;
+  final originalType = walletObj['type'];
+  final network = walletObj['network'];
+
+  log.info(
+    '0.1.*: updateWalletObj - Processing wallet ${walletObj['id']}: type=$originalType, network=$network, isDefault=$isDefault',
+  );
 
   // TODO: Test this assumption
   // Assuming first wallet is to be changed to secure and further wallets to words
@@ -139,23 +155,35 @@ updateWalletObj(
         walletObj['type'] = 'main';
         walletObj['name'] = 'Secure Bitcoin';
         walletObj['mainWallet'] = true;
-
         liquidMainnetSeed = seed;
+        log.info(
+          '0.1.*: Converted mainnet wallet to main type: ${walletObj['id']}',
+        );
       } else {
         walletObj['type'] = 'words';
         walletObj['mainWallet'] = false;
+        log.info(
+          '0.1.*: Converted mainnet wallet to words type: ${walletObj['id']}',
+        );
       }
     } else {
       walletObj['type'] = 'words';
       walletObj['mainWallet'] = false;
+      log.info(
+        '0.1.*: Converted non-mainnet wallet to words type: ${walletObj['id']}',
+      );
     }
-
-    if (walletObj['type'] == 'xpub' || walletObj['type'] == 'coldcard') {
-      walletObj['mainWallet'] = false;
-    }
+  } else if (walletObj['type'] == 'xpub' || walletObj['type'] == 'coldcard') {
+    walletObj['mainWallet'] = false;
+    log.info('0.1.*: Updated watch-only wallet: ${walletObj['id']}');
   }
+
   walletObj.addAll({'baseWalletType': 'Bitcoin'});
 
+  log.info(
+    '0.1.*: Wallet ${walletObj['id']} final state - type: ${walletObj['type']}, mainWallet: ${walletObj['mainWallet']}, baseWalletType: ${walletObj['baseWalletType']}',
+  );
+
   final ({OldSeed? liquidMainnetSeed, Map<String, dynamic> walletObj}) res = (
     liquidMainnetSeed: liquidMainnetSeed,
     walletObj: walletObj,

lib/core/utils/logger.dart

@@ -25,7 +25,7 @@ class Logger {
 
       if (record.stackTrace != null) content.add(record.stackTrace.toString());
 
-      final tsvLine = content.join('\t');
+      final tsvLine = _sanitizeContent(content).join('\t');
 
       // We don't want to keep the info session in memory, they should be written to file
       if (record.level != dep.Level.INFO) session.add(tsvLine);
@@ -64,6 +64,16 @@ class Logger {
     await File(path).writeAsString('$message\n', mode: FileMode.append);
   }
 
+  List<String> _sanitizeContent(List<String> content) {
+    final colors = RegExp(r'\x1B\[[0-9;]*[a-zA-Z]'); // ascii colors
+    final tabNewLine = RegExp(r'[\t\n]'); // no tabs or newlines
+    final sanitizedContent =
+        content
+            .map((e) => e.replaceAll(tabNewLine, ' ').replaceAll(colors, ''))
+            .toList();
+    return sanitizedContent;
+  }
+
   void info(Object? message, {Object? error, StackTrace? trace}) {
     logger.info(message, error, trace);
   }

lib/core/wallet/data/datasources/wallet/impl/lwk_wallet_datasource.dart

@@ -75,43 +75,35 @@ class LwkWalletDatasource implements WalletDatasource {
     required WalletModel wallet,
     required ElectrumServerModel electrumServer,
   }) {
-    try {
-      // TODO: if needed, add these debugPrint to a filterable logger.debug
-      // TODO: to avoid spamming the terminal with recurring prints
-      // debugPrint('Sync requested for wallet: ${wallet.id}');
-      return _activeSyncs.putIfAbsent(wallet.id, () async {
-        try {
-          // debugPrint('New sync started for wallet: ${wallet.id}');
-          _walletSyncStartedController.add(wallet.id);
-          syncExecutions.update(wallet.id, (v) => v + 1, ifAbsent: () => 1);
-          final lwkWallet = await _createPublicWallet(wallet);
-          await lwkWallet.sync_(
-            electrumUrl: electrumServer.url,
-            validateDomain: electrumServer.validateDomain,
-          );
-          // debugPrint('Sync completed for wallet: ${wallet.id}');
-        } catch (e) {
-          if (e is lwk.LwkError) {
-            throw e.msg;
-          } else {
-            rethrow;
-          }
-        } finally {
-          _walletSyncFinishedController.add(wallet.id);
-          // Remove the sync so future syncs can be triggered
-          // Do not await this, as it is not necessary and can cause deadlocks
-          // since it returns the Future from the map.
-          // ignore: unawaited_futures
-          _activeSyncs.remove(wallet.id);
+    // TODO: if needed, add these debugPrint to a filterable logger.debug
+    // TODO: to avoid spamming the terminal with recurring prints
+    //debugPrint('[Sync] Sync requested for wallet: ${wallet.id}');
+    return _activeSyncs.putIfAbsent(wallet.id, () async {
+      try {
+        //debugPrint('[Sync] New sync started for wallet: ${wallet.id}');
+        _walletSyncStartedController.add(wallet.id);
+        syncExecutions.update(wallet.id, (v) => v + 1, ifAbsent: () => 1);
+        final lwkWallet = await _createPublicWallet(wallet);
+        await lwkWallet.sync_(
+          electrumUrl: electrumServer.url,
+          validateDomain: electrumServer.validateDomain,
+        );
+        //debugPrint('[Sync] Sync completed for wallet: ${wallet.id}');
+      } catch (e) {
+        if (e is lwk.LwkError) {
+          throw e.msg;
+        } else {
+          rethrow;
         }
-      });
-    } catch (e) {
-      if (e is lwk.LwkError) {
-        throw e.msg;
-      } else {
-        rethrow;
+      } finally {
+        _walletSyncFinishedController.add(wallet.id);
+        // Remove the sync so future syncs can be triggered
+        // Do not await this, as it is not necessary and can cause deadlocks
+        // since it returns the Future from the map.
+        // ignore: unawaited_futures
+        _activeSyncs.remove(wallet.id);
       }
-    }
+    });
   }
 
   @override