dcr: Always fetch the current dir path.

On ios devices the path will change between updates breaking decred.
Never save the path and always check to ensure it is up to date.
Previous wallets were also not creating a directory in the correct
place. Move those when found.

Author: JoeGruffins

cw_decred/lib/wallet.dart

@@ -5,6 +5,8 @@ import 'package:path/path.dart' as p;
 import 'package:cw_core/exceptions.dart';
 import 'package:cw_core/transaction_direction.dart';
 import 'package:cw_core/utils/print_verbose.dart';
+import 'package:cw_core/pathForWallet.dart';
+import 'package:cw_core/wallet_type.dart';
 import 'package:cw_decred/amount_format.dart';
 import 'package:cw_decred/pending_transaction.dart';
 import 'package:cw_decred/transaction_credentials.dart';
@@ -307,9 +309,10 @@ abstract class DecredWalletBase
       persistantPeer = addr;
       await _libwallet.closeWallet(walletInfo.name);
       final network = isTestnet ? "testnet" : "mainnet";
+      final dirPath = await pathForWalletDir(name: walletInfo.name, type: WalletType.decred);
       final config = {
         "name": walletInfo.name,
-        "datadir": walletInfo.dirPath,
+        "datadir": dirPath,
         "net": network,
         "unsyncedaddrs": true,
       };
@@ -605,22 +608,22 @@ abstract class DecredWalletBase
 
     final sourceDir = Directory(currentDirPath);
     final targetDir = Directory(newDirPath);
-    
+
     if (!targetDir.existsSync()) {
       await targetDir.create(recursive: true);
     }
-    
+
     await for (final entity in sourceDir.list(recursive: true)) {
-      final relativePath = entity.path.substring(sourceDir.path.length+1);
+      final relativePath = entity.path.substring(sourceDir.path.length + 1);
       final targetPath = p.join(targetDir.path, relativePath);
-      
+
       if (entity is File) {
         await entity.rename(targetPath);
       } else if (entity is Directory) {
         await Directory(targetPath).create(recursive: true);
       }
     }
-    
+
     await sourceDir.delete(recursive: true);
   }
 

cw_decred/lib/wallet_service.dart

@@ -8,6 +8,7 @@ import 'package:cw_core/wallet_service.dart';
 import 'package:cw_core/pathForWallet.dart';
 import 'package:cw_core/wallet_info.dart';
 import 'package:cw_core/wallet_type.dart';
+import 'package:path/path.dart';
 import 'package:hive/hive.dart';
 import 'package:collection/collection.dart';
 import 'package:cw_core/unspent_coins_info.dart';
@@ -57,42 +58,89 @@ class DecredWalletService extends WalletService<
   @override
   Future<DecredWallet> create(DecredNewWalletCredentials credentials, {bool? isTestnet}) async {
     await this.init();
+    final dirPath = await pathForWalletDir(name: credentials.walletInfo!.name, type: getType());
+    final network = isTestnet == true ? testnet : mainnet;
     final config = {
       "name": credentials.walletInfo!.name,
-      "datadir": credentials.walletInfo!.dirPath,
+      "datadir": dirPath,
       "pass": credentials.password!,
-      "net": isTestnet == true ? testnet : mainnet,
+      "net": network,
       "unsyncedaddrs": true,
     };
     await libwallet!.createWallet(jsonEncode(config));
     final di = DerivationInfo(
         derivationPath: isTestnet == true ? seedRestorePathTestnet : seedRestorePath);
     credentials.walletInfo!.derivationInfo = di;
+    credentials.walletInfo!.network = network;
+    // ios will move our wallet directory when updating. Since we must
+    // recalculate the new path every time we open the wallet, ensure this path
+    // is not used. An older wallet will have a directory here which is a
+    // condition for moving the wallet when opening, so this must be kept blank
+    // going forward.
+    credentials.walletInfo!.dirPath = "";
+    credentials.walletInfo!.path = "";
     final wallet = DecredWallet(credentials.walletInfo!, credentials.password!,
         this.unspentCoinsInfoSource, libwallet!, closeLibwallet);
     await wallet.init();
     return wallet;
   }
 
+  void copyDirectorySync(Directory source, Directory destination) {
+    /// create destination folder if not exist
+    if (!destination.existsSync()) {
+      destination.createSync(recursive: true);
+    }
+
+    /// get all files from source (recursive: false is important here)
+    source.listSync(recursive: false).forEach((entity) {
+      final newPath = destination.path + Platform.pathSeparator + basename(entity.path);
+      if (entity is File) {
+        entity.rename(newPath);
+      } else if (entity is Directory) {
+        copyDirectorySync(entity, Directory(newPath));
+      }
+    });
+  }
+
+  Future<void> moveWallet(String fromPath, String toPath) async {
+    final oldWalletDir = new Directory(fromPath);
+    final newWalletDir = new Directory(toPath);
+    copyDirectorySync(oldWalletDir, newWalletDir);
+    await oldWalletDir.delete(recursive: true);
+  }
+
   @override
   Future<DecredWallet> openWallet(String name, String password) async {
     final walletInfo = walletInfoSource.values
         .firstWhereOrNull((info) => info.id == WalletBase.idFor(name, getType()))!;
-    final network = walletInfo.derivationInfo?.derivationPath == seedRestorePathTestnet ||
-            walletInfo.derivationInfo?.derivationPath == pubkeyRestorePathTestnet
-        ? testnet
-        : mainnet;
+    if (walletInfo.network == null || walletInfo.network == "") {
+      walletInfo.network = walletInfo.derivationInfo?.derivationPath == seedRestorePathTestnet ||
+              walletInfo.derivationInfo?.derivationPath == pubkeyRestorePathTestnet
+          ? testnet
+          : mainnet;
+    }
 
     await this.init();
-    final walletDirExists = Directory(walletInfo.dirPath).existsSync();
-    if (!walletDirExists) {
-      walletInfo.dirPath = await pathForWalletDir(name: name, type: getType());
+
+    // Cake wallet version 4.27.0 and earlier gave a wallet dir that did not
+    // match the name. Move those to the correct place.
+    final dirPath = await pathForWalletDir(name: name, type: getType());
+    if (walletInfo.dirPath != "") {
+      // On ios the stored dir no longer exists. We can only trust the basename.
+      final randomBasename = basename(walletInfo.dirPath);
+      final oldDir = await pathForWalletDir(name: randomBasename, type: getType());
+      if (oldDir != dirPath) {
+        await this.moveWallet(oldDir, dirPath);
+      }
+      // Clear the path so this does not trigger again.
+      walletInfo.dirPath = "";
+      walletInfo.path = "";
     }
 
     final config = {
-      "name": walletInfo.name,
-      "datadir": walletInfo.dirPath,
-      "net": network,
+      "name": name,
+      "datadir": dirPath,
+      "net": walletInfo.network,
       "unsyncedaddrs": true,
     };
     await libwallet!.loadWallet(jsonEncode(config));
@@ -127,12 +175,11 @@ class DecredWalletService extends WalletService<
 
     await currentWallet.renameWalletFiles(newName);
 
-    final newDirPath = await pathForWalletDir(name: newName, type: getType());
     final newWalletInfo = currentWalletInfo;
     newWalletInfo.id = WalletBase.idFor(newName, getType());
     newWalletInfo.name = newName;
-    newWalletInfo.dirPath = newDirPath;
-    newWalletInfo.network = network;
+    newWalletInfo.dirPath = "";
+    newWalletInfo.path = "";
 
     await walletInfoSource.put(currentWalletInfo.key, newWalletInfo);
   }
@@ -141,18 +188,23 @@ class DecredWalletService extends WalletService<
   Future<DecredWallet> restoreFromSeed(DecredRestoreWalletFromSeedCredentials credentials,
       {bool? isTestnet}) async {
     await this.init();
+    final network = isTestnet == true ? testnet : mainnet;
+    final dirPath = await pathForWalletDir(name: credentials.walletInfo!.name, type: getType());
     final config = {
       "name": credentials.walletInfo!.name,
-      "datadir": credentials.walletInfo!.dirPath,
+      "datadir": dirPath,
       "pass": credentials.password!,
       "mnemonic": credentials.mnemonic,
-      "net": isTestnet == true ? testnet : mainnet,
+      "net": network,
       "unsyncedaddrs": true,
     };
     await libwallet!.createWallet(jsonEncode(config));
     final di = DerivationInfo(
         derivationPath: isTestnet == true ? seedRestorePathTestnet : seedRestorePath);
     credentials.walletInfo!.derivationInfo = di;
+    credentials.walletInfo!.network = network;
+    credentials.walletInfo!.dirPath = "";
+    credentials.walletInfo!.path = "";
     final wallet = DecredWallet(credentials.walletInfo!, credentials.password!,
         this.unspentCoinsInfoSource, libwallet!, closeLibwallet);
     await wallet.init();
@@ -165,17 +217,22 @@ class DecredWalletService extends WalletService<
   Future<DecredWallet> restoreFromKeys(DecredRestoreWalletFromPubkeyCredentials credentials,
       {bool? isTestnet}) async {
     await this.init();
+    final network = isTestnet == true ? testnet : mainnet;
+    final dirPath = await pathForWalletDir(name: credentials.walletInfo!.name, type: getType());
     final config = {
       "name": credentials.walletInfo!.name,
-      "datadir": credentials.walletInfo!.dirPath,
+      "datadir": dirPath,
       "pubkey": credentials.pubkey,
-      "net": isTestnet == true ? testnet : mainnet,
+      "net": network,
       "unsyncedaddrs": true,
     };
     await libwallet!.createWatchOnlyWallet(jsonEncode(config));
     final di = DerivationInfo(
         derivationPath: isTestnet == true ? pubkeyRestorePathTestnet : pubkeyRestorePath);
     credentials.walletInfo!.derivationInfo = di;
+    credentials.walletInfo!.network = network;
+    credentials.walletInfo!.dirPath = "";
+    credentials.walletInfo!.path = "";
     final wallet = DecredWallet(credentials.walletInfo!, credentials.password!,
         this.unspentCoinsInfoSource, libwallet!, closeLibwallet);
     await wallet.init();