CW-723-Add-Monero-support-to-the-Shared-Seed-feature-in-Cake (#2131)

* feat: add exodus style bip39 to monero legacy seed

* feat: restore monero wallet from bip39 and add test

* bug: fix wrong naming in CI

* feat: add monero bip39 UI flow

* fix: monero.dart generation

* fix: skip monero_wallet_service tests till CI is fixed

* ci: copy monero_libwallet2_api_c.so to /usr/lib for testing
ci: reduce timeout for cw_monero tests

* fix: monero wallet creation credentials default to bip39 if mnemonic are set

* fix: do not skip monero wallets services test

* fix: Include non bip39 monero wallets on Wallet Group

* fix: null pointer stemming from missing language selector if seed is selected

* fix: Fixes to Bip39 Creation and restore

- Do not restore from 0 for fresh bip39 wallet
- disallow restoring bip39 wallet without date or height

* fix: Fixes to Bip39 restore

- Refresh height is now getting set correctly
- Add new create monero wallet tests
- Add seed-language English for Bip39 Monero wallets
- Fix seed-type naming

* feat (cw_monero): Store monero wallet after bip39 creation

* feat (cw_monero): remove prints from monero_wallet_service_test.dart

* fix: exception during seed language autodetect

* feat (cw_monero): Add support for passphrases on bip39 seeds

* feat (cw_monero): Add support for passphrases on bip39 seeds

* fix: seed language selection for recovering bip39 wallets

* style: improve readability of isLegacySeedOnly in wallet_keys_view_model.dart

* feat: hide monero seed type selector from advanced settings when creating a child wallet

* fix(cw_monero): use named arguments for bip39_seed tests

---------

Co-authored-by: cyan <cyjan@mrcyjanek.net>

Author: konstantinullrich

.github/workflows/pr_test_build_linux.yml

@@ -283,6 +283,9 @@ jobs:
           xmessage -timeout 30 "restore_wallet_through_seeds_flow_test" &
           rm -rf ~/.local/share/com.example.cake_wallet/ ~/Documents/cake_wallet/ ~/cake_wallet
           exec timeout --signal=SIGKILL 900 flutter drive --driver=test_driver/integration_test.dart --target=integration_test/test_suites/restore_wallet_through_seeds_flow_test.dart
+      - name: Test [cw_monero]
+        timeout-minutes: 2
+        run: cd cw_monero && flutter test
       - name: Stop screen recording, encrypt and upload
         if: always()
         run: |

cw_monero/.gitignore

@@ -11,4 +11,5 @@ android/.externalNativeBuild/
 android/.cxx/
 
 macos/cw_monero.podspec
-macos/External/
+macos/External/
+*monero_libwallet2_api_c.*

cw_monero/lib/api/wallet.dart

@@ -62,6 +62,11 @@ String getSeed() {
     }
     return cakepolyseed;
   }
+
+  final bip39 = monero.Wallet_getCacheAttribute(wptr!, key: "cakewallet.seed.bip39");
+
+  if(bip39.isNotEmpty) return bip39;
+
   final legacy = getSeedLegacy(null);
   return legacy;
 }

cw_monero/lib/bip39_seed.dart

@@ -0,0 +1,59 @@
+import 'dart:typed_data';
+
+import 'package:bip32/bip32.dart' as bip32;
+import 'package:bip39/bip39.dart' as bip39;
+import 'package:polyseed/polyseed.dart';
+
+bool isBip39Seed(String mnemonic) => bip39.validateMnemonic(mnemonic);
+
+String getBip39Seed() => bip39.generateMnemonic();
+
+String getLegacySeedFromBip39(String mnemonic,
+  {int accountIndex = 0, String passphrase = ""}) {
+  final seed = bip39.mnemonicToSeed(mnemonic, passphrase: passphrase);
+
+  final bip32KeyPair =
+      bip32.BIP32.fromSeed(seed).derivePath("m/44'/128'/$accountIndex'/0/0");
+
+  final spendKey = _reduceECKey(bip32KeyPair.privateKey!);
+
+  return LegacySeedLang.getByEnglishName("English")
+      .encodePhrase(spendKey.toHexString());
+}
+
+const _ed25519CurveOrder =
+    "1000000000000000000000000000000014DEF9DEA2F79CD65812631A5CF5D3ED";
+
+Uint8List _reduceECKey(Uint8List buffer) {
+  final curveOrder = BigInt.parse(_ed25519CurveOrder, radix: 16);
+  final bigNumber = _readBytes(buffer);
+
+  var result = bigNumber % curveOrder;
+
+  final resultBuffer = Uint8List(32);
+  for (var i = 0; i < 32; i++) {
+    resultBuffer[i] = (result & BigInt.from(0xff)).toInt();
+    result = result >> 8;
+  }
+
+  return resultBuffer;
+}
+
+/// Read BigInt from a little-endian Uint8List
+/// From https://github.com/dart-lang/sdk/issues/32803#issuecomment-387405784
+BigInt _readBytes(Uint8List bytes) {
+  BigInt read(int start, int end) {
+    if (end - start <= 4) {
+      var result = 0;
+      for (int i = end - 1; i >= start; i--) {
+        result = result * 256 + bytes[i];
+      }
+      return BigInt.from(result);
+    }
+    final mid = start + ((end - start) >> 1);
+    return read(start, mid) +
+        read(mid, end) * (BigInt.one << ((mid - start) * 8));
+  }
+
+  return read(0, bytes.length);
+}

cw_monero/lib/monero_wallet_service.dart

@@ -1,6 +1,7 @@
 import 'dart:ffi';
 import 'dart:io';
 
+import 'package:collection/collection.dart';
 import 'package:cw_core/get_height_by_date.dart';
 import 'package:cw_core/monero_wallet_utils.dart';
 import 'package:cw_core/pathForWallet.dart';
@@ -14,29 +15,38 @@ import 'package:cw_core/wallet_type.dart';
 import 'package:cw_monero/api/account_list.dart';
 import 'package:cw_monero/api/wallet_manager.dart' as monero_wallet_manager;
 import 'package:cw_monero/api/wallet_manager.dart';
+import 'package:cw_monero/bip39_seed.dart';
 import 'package:cw_monero/ledger.dart';
 import 'package:cw_monero/monero_wallet.dart';
-import 'package:collection/collection.dart';
 import 'package:hive/hive.dart';
 import 'package:ledger_flutter_plus/ledger_flutter_plus.dart';
 import 'package:monero/monero.dart' as monero;
 import 'package:polyseed/polyseed.dart';
 
+enum MoneroSeedType { polyseed, legacy, bip39 }
+
 class MoneroNewWalletCredentials extends WalletCredentials {
   MoneroNewWalletCredentials(
-      {required String name, required this.language, required this.isPolyseed, String? password, this.passphrase})
+      {required String name,
+      required this.language,
+      required this.seedType,
+      String? password,
+      this.passphrase,
+      this.mnemonic})
       : super(name: name, password: password);
 
   final String language;
-  final bool isPolyseed;
+  final MoneroSeedType seedType;
   final String? passphrase;
+  final String? mnemonic;
 }
 
 class MoneroRestoreWalletFromHardwareCredentials extends WalletCredentials {
-  MoneroRestoreWalletFromHardwareCredentials({required String name,
-    required this.ledgerConnection,
-    int height = 0,
-    String? password})
+  MoneroRestoreWalletFromHardwareCredentials(
+      {required String name,
+      required this.ledgerConnection,
+      int height = 0,
+      String? password})
       : super(name: name, password: password, height: height);
   LedgerConnection ledgerConnection;
 }
@@ -60,13 +70,14 @@ class MoneroWalletLoadingException implements Exception {
 }
 
 class MoneroRestoreWalletFromKeysCredentials extends WalletCredentials {
-  MoneroRestoreWalletFromKeysCredentials({required String name,
-    required String password,
-    required this.language,
-    required this.address,
-    required this.viewKey,
-    required this.spendKey,
-    int height = 0})
+  MoneroRestoreWalletFromKeysCredentials(
+      {required String name,
+      required String password,
+      required this.language,
+      required this.address,
+      required this.viewKey,
+      required this.spendKey,
+      int height = 0})
       : super(name: name, password: password, height: height);
 
   final String language;
@@ -97,27 +108,42 @@ class MoneroWalletService extends WalletService<
   @override
   WalletType getType() => WalletType.monero;
 
-  @override 
-  Future<MoneroWallet> create(MoneroNewWalletCredentials credentials, {bool? isTestnet}) async {
+  @override
+  Future<MoneroWallet> create(MoneroNewWalletCredentials credentials,
+      {bool? isTestnet}) async {
     try {
       final path = await pathForWallet(name: credentials.name, type: getType());
 
-      if (credentials.isPolyseed) {
+      if (credentials.seedType == MoneroSeedType.bip39) {
+        return _restoreFromBip39(
+          path: path,
+          password: credentials.password!,
+          mnemonic: credentials.mnemonic ?? getBip39Seed(),
+          passphrase: credentials.passphrase,
+          walletInfo: credentials.walletInfo!,
+        );
+      }
+
+      if (credentials.seedType == MoneroSeedType.polyseed) {
         final polyseed = Polyseed.create();
         final lang = PolyseedLang.getByEnglishName(credentials.language);
 
-        if (credentials.passphrase != null) polyseed.crypt(credentials.passphrase!);
+        if (credentials.passphrase != null)
+          polyseed.crypt(credentials.passphrase!);
 
-        final heightOverride =
-        getMoneroHeigthByDate(date: DateTime.now().subtract(Duration(days: 2)));
+        final heightOverride = getMoneroHeigthByDate(
+            date: DateTime.now().subtract(Duration(days: 2)));
 
-        return _restoreFromPolyseed(
-            path, credentials.password!, polyseed, credentials.walletInfo!, lang,
+        return _restoreFromPolyseed(path, credentials.password!, polyseed,
+            credentials.walletInfo!, lang,
             overrideHeight: heightOverride, passphrase: credentials.passphrase);
       }
 
       await monero_wallet_manager.createWallet(
-          path: path, password: credentials.password!, language: credentials.language, passphrase: credentials.passphrase??"");
+          path: path,
+          password: credentials.password!,
+          language: credentials.language,
+          passphrase: credentials.passphrase ?? "");
       final wallet = MoneroWallet(
           walletInfo: credentials.walletInfo!,
           unspentCoinsInfo: unspentCoinsInfoSource,
@@ -145,7 +171,8 @@ class MoneroWalletService extends WalletService<
   }
 
   @override
-  Future<MoneroWallet> openWallet(String name, String password, {OpenWalletTry openWalletTry = OpenWalletTry.initial}) async {
+  Future<MoneroWallet> openWallet(String name, String password,
+      {OpenWalletTry openWalletTry = OpenWalletTry.initial}) async {
     try {
       final path = await pathForWallet(name: name, type: getType());
 
@@ -303,8 +330,28 @@ class MoneroWalletService extends WalletService<
       rethrow;
     }
 
+    try {
+      if (isBip39Seed(credentials.mnemonic)) {
+        final path =
+            await pathForWallet(name: credentials.name, type: getType());
+
+        return _restoreFromBip39(
+          path: path,
+          password: credentials.password!,
+          mnemonic: credentials.mnemonic,
+          walletInfo: credentials.walletInfo!,
+          overrideHeight: credentials.height!,
+          passphrase: credentials.passphrase,
+        );
+      }
+    } catch (e) {
+      printV("Bip39 restore failed: $e");
+      rethrow;
+    }
+
     try {
       final path = await pathForWallet(name: credentials.name, type: getType());
+
       monero_wallet_manager.restoreFromSeed(
           path: path,
           password: credentials.password!,
@@ -325,6 +372,50 @@ class MoneroWalletService extends WalletService<
     }
   }
 
+  Future<MoneroWallet> _restoreFromBip39({
+    required String path,
+    required String password,
+    required String mnemonic,
+    required WalletInfo walletInfo,
+    String? passphrase,
+    int? overrideHeight,
+  }) async {
+    walletInfo.derivationInfo = DerivationInfo(
+        derivationType: DerivationType.bip39,
+        derivationPath: "m/44'/128'/0'/0/0",
+    );
+
+    final legacyMnemonic =
+        getLegacySeedFromBip39(mnemonic, passphrase: passphrase ?? "");
+    final height =
+        overrideHeight ?? getMoneroHeigthByDate(date: DateTime.now());
+
+    walletInfo.isRecovery = true;
+    walletInfo.restoreHeight = height;
+
+    monero_wallet_manager.restoreFromSeed(
+      path: path,
+      password: password,
+      passphrase: '',
+      seed: legacyMnemonic,
+      restoreHeight: height,
+    );
+
+    monero.Wallet_setCacheAttribute(wptr!,
+        key: "cakewallet.seed.bip39", value: mnemonic);
+
+    monero.Wallet_store(wptr!);
+
+    final wallet = MoneroWallet(
+      walletInfo: walletInfo,
+      unspentCoinsInfo: unspentCoinsInfoSource,
+      password: password,
+    );
+    await wallet.init();
+
+    return wallet;
+  }
+
   Future<MoneroWallet> restoreFromPolyseed(
       MoneroRestoreWalletFromSeedCredentials credentials) async {
     try {
@@ -344,23 +435,21 @@ class MoneroWalletService extends WalletService<
     }
   }
 
-  Future<MoneroWallet> _restoreFromPolyseed(
-      String path, String password, Polyseed polyseed, WalletInfo walletInfo, PolyseedLang lang,
+  Future<MoneroWallet> _restoreFromPolyseed(String path, String password,
+      Polyseed polyseed, WalletInfo walletInfo, PolyseedLang lang,
       {PolyseedCoin coin = PolyseedCoin.POLYSEED_MONERO,
       int? overrideHeight,
       String? passphrase}) async {
-    
-    if (polyseed.isEncrypted == false &&
-        (passphrase??'') != "") {
+    if (polyseed.isEncrypted == false && (passphrase ?? '') != "") {
       // Fallback to the different passphrase offset method, when a passphrase
       // was provided but the polyseed is not encrypted.
       monero_wallet_manager.restoreWalletFromPolyseedWithOffset(
-        path: path,
-        password: password,
-        seed: polyseed.encode(lang, coin),
-        seedOffset: passphrase??'',
-        language: "English");
-      
+          path: path,
+          password: password,
+          seed: polyseed.encode(lang, coin),
+          seedOffset: passphrase ?? '',
+          language: "English");
+
       final wallet = MoneroWallet(
         walletInfo: walletInfo,
         unspentCoinsInfo: unspentCoinsInfoSource,
@@ -437,7 +526,8 @@ class MoneroWalletService extends WalletService<
 
       if (walletFilesExist(path)) await repairOldAndroidWallet(name);
 
-      await monero_wallet_manager.openWalletAsync({'path': path, 'password': password});
+      await monero_wallet_manager
+          .openWalletAsync({'path': path, 'password': password});
       final walletInfo = walletInfoSource.values
           .firstWhere((info) => info.id == WalletBase.idFor(name, getType()));
       final wallet = MoneroWallet(