Bitcoin derivations (#1089)

* - Update and Fix Conflicts with main * Add Balances for ERC20 tokens * Fix conflicts with main * Add erc20 abi json * Add send erc20 tokens initial function * add missing getHeightByDate in Haven [skip ci] * Allow contacts and wallets from the same tag * Add Shiba Inu icon * Add send ERC-20 tokens initial flow * Add missing import in generated file * Add initial approach for transaction sending for ERC-20 tokens * Refactor signing/sending transactions * Add initial flow for transactions subscription * Refactor signing/sending transactions * Add home settings icon * Fix conflicts with main * Initial flow for home settings * Add logic flow for adding erc20 tokens * Fix initial UI * Finalize UI for Tokens * Integrate UI with Ethereum flow * Add "Enable/Disable" feature for ERC20 tokens * Add initial Erc20 tokens * Add Sorting and Pin Native Token features * Fix price sorting * Sort tokens list as well when Sort criteria changes * - Improve sorting balances flow - Add initial add token from search bar flow * Fix Accounts Popup UI * Fix Pin native token * Fix Enabling/Disabling tokens Fix sorting by fiat once app is opened Improve token availability mechanism * Fix deleting token Fix renaming tokens * Fix issue with search * Add more tokens * - Fix scroll issue - Add ERC20 tokens placeholder image in picker * - Separate and organize default erc20 tokens - Fix scrolling - Add token placeholder images in picker - Sort disabled tokens alphabetically * Change BNB token initial availability [skip ci] * Fix Conflicts with main * Fix Conflicts with main * Add Verse ERC20 token to the initial tokens list * Add rename wallet to Ethereum * Integrate EtherScan API for fetching address transactions Generate Ethereum specific secrets in Ethereum package * Adjust transactions fiat price for ERC20 tokens * Free Up GitHub Actions Ubuntu Runner Disk Space * Free Up GitHub Actions Ubuntu Runner Disk space (trial 2) * Fix Transaction Fee display * Save transaction history * Enhance loading time for erc20 tokens transactions * Minor Fixes and Enhancements * Fix sending erc20 fix block explorer issue * Fix int overflow * Fix transaction amount conversions * Minor: `slow` -> `Slow` [skip-ci] * initial changes * more base config stuff * config changes * successfully builds! * save * successfully add nano wallet * save * seed generation * receive screen + node screen working * tx history working and fiat fixes * balance working * derivation updates * nano-unfinished * sends working * remove fees from send screen, send and receive transactions working * fixes + auto receive incoming txs * fix for scanning QR codes * save * update translations * fixes * more fixes * more strings * small fix * fix github actions workflow * potential fix * potential fix * ci/cd fix * change rep working * seed generation fixes * fixes * save * change rep screen functional * save * banano changes * fixes, start adding ui for PoW * pow node changes * update translations * fix * account changing barely working * save * disable account generation * small fix * save * UI work * save * fixes after merge main * fixes * remove monero stuff, work on derivation ui * lots of fixes + finish up seed derivation * last minute fixes * node related fixes * more fixes * small fix * more fixes * fixes * pretty big refactor for pow, still some bugs * finally works! * get transactions after send * fix * merge conflict fixes * save * fix pow node showing up twice * done * initial changes * small fix * more merge fixes * fixes * more fixes * fix * save * fix manage pow nodes setting appearing on other wallets * fix contact bug * fixes * fiat fixes * save * save * save * save * updates * cleanup * restore fix * fixes * remove deprecated alert * fix * small fix * remove outdated warning * electrum restore fixes * fixes * fixes * fix * derivation fixes * nano fixes pt.1 * nano fixes pt.2 * bip39 fixes * pownode refactor * nodes pages fixes * observer fix * ssl fix * remove old references * remove unused imports * code cleanup * small fix * small potential fix * save * derivation fixes * deterministic fix * fix pt.2 * derivation class fixes * review fixes from nano that also apply here * formatting * stuff that should've stayed deleted * post merge fixes * remove problematic imports and duplicate changes * Delete lib/nano/nano.dart * move wallet restore page proxy code to the view model * fix dashboard page indicators being the same color * debatably better refactoring of derivationInfo, migration needed * additional refactor improvements * blanket comment some stuff out to narrow down this issue * refactor fixes * fix nano exchange * fix , bug, i.e. replace , with . when making a nano transaction * fix nano sending, update restore page wording, and other minor fixes * write migration for existing bitcoin and nano wallets * merge fixes * minor fixes * use default derivation type when restoring from qr code * fixes for restoring * fixes * fixes * merge fix * Fix issues with Creating Electrum and Restoring Bip39 * updates & fixes * Add missing case for no transactions BIP39 wallet restore * Make the default BIP39 the 84 derivation path * Add Samourai Deposit * litecoin mnemonic error fix * Bip39 passphrase support (#1412) * save * passphrase working * fix for when loading wallets + translation update * minor fix * Fix Nano * minor fix [skip ci] --------- Co-authored-by: OmarHatem <[email protected]> * change error state seed conditions into throwables [skip ci] * litecoin fixes * Bip39 minor enhancements (#1416) * minor enhancements * rename bitcoin_derivations -> electrum_derivations * Remove duplicate derivations handle default case * minor fix * Enable passphrase for Litecoin * obscure text of passphrase --------- Co-authored-by: OmarHatem <[email protected]> Co-authored-by: Justin Ehrenhofer <[email protected]> Co-authored-by: fossephate <[email protected]>
cake-tech · Apr 30, 2024 · 509b92e · 509b92e
1 parent 9e4a7f4
commit 509b92e
Show file tree

Hide file tree

Showing 60 changed files with 905 additions and 338 deletions.
diff --git a/assets/nano_pow_node_list.yml b/assets/nano_pow_node_list.yml
@@ -6,4 +6,4 @@
   uri: workers.perish.co
 -
   uri: worker.nanoriver.cc
-  useSSL: true
+  useSSL: true
diff --git a/cw_bitcoin/lib/bitcoin_mnemonic.dart b/cw_bitcoin/lib/bitcoin_mnemonic.dart
@@ -90,8 +90,7 @@ List<bool> prefixMatches(String source, List<String> prefixes) {
   return prefixes.map((prefix) => hx.startsWith(prefix.toLowerCase())).toList();
 }
 
-Future<String> generateMnemonic(
-    {int strength = 264, String prefix = segwit}) async {
+Future<String> generateElectrumMnemonic({int strength = 264, String prefix = segwit}) async {
   final wordBitlen = logBase(wordlist.length, 2).ceil();
   final wordCount = strength / wordBitlen;
   final byteCount = ((wordCount * wordBitlen).ceil() / 8).ceil();
@@ -106,22 +105,29 @@ Future<String> generateMnemonic(
   return result;
 }
 
+Future<bool> checkIfMnemonicIsElectrum2(String mnemonic) async {
+  return prefixMatches(mnemonic, [segwit]).first;
+}
+
+Future<String> getMnemonicHash(String mnemonic) async {
+  final hmacSha512 = Hmac(sha512, utf8.encode('Seed version'));
+  final digest = hmacSha512.convert(utf8.encode(normalizeText(mnemonic)));
+  final hx = digest.toString();
+  return hx;
+}
+
 Future<Uint8List> mnemonicToSeedBytes(String mnemonic, {String prefix = segwit}) async {
-  final pbkdf2 = cryptography.Pbkdf2(
-      macAlgorithm: cryptography.Hmac.sha512(),
-      iterations: 2048,
-      bits: 512);
+  final pbkdf2 =
+      cryptography.Pbkdf2(macAlgorithm: cryptography.Hmac.sha512(), iterations: 2048, bits: 512);
   final text = normalizeText(mnemonic);
   // pbkdf2.deriveKey(secretKey: secretKey, nonce: nonce)
   final key = await pbkdf2.deriveKey(
-      secretKey: cryptography.SecretKey(text.codeUnits),
-      nonce: 'electrum'.codeUnits);
+      secretKey: cryptography.SecretKey(text.codeUnits), nonce: 'electrum'.codeUnits);
   final bytes = await key.extractBytes();
   return Uint8List.fromList(bytes);
 }
 
-bool matchesAnyPrefix(String mnemonic) =>
-    prefixMatches(mnemonic, [segwit]).any((el) => el);
+bool matchesAnyPrefix(String mnemonic) => prefixMatches(mnemonic, [segwit]).any((el) => el);
 
 bool validateMnemonic(String mnemonic, {String prefix = segwit}) {
   try {
@@ -208,10 +214,8 @@ String removeCJKSpaces(String source) {
 }
 
 String normalizeText(String source) {
-  final res = removeCombiningCharacters(unorm.nfkd(source).toLowerCase())
-      .trim()
-      .split('/\s+/')
-      .join(' ');
+  final res =
+      removeCombiningCharacters(unorm.nfkd(source).toLowerCase()).trim().split('/\s+/').join(' ');
 
   return removeCJKSpaces(res);
 }

diff --git a/cw_bitcoin/lib/bitcoin_wallet.dart b/cw_bitcoin/lib/bitcoin_wallet.dart
@@ -12,6 +12,7 @@ import 'package:cw_core/wallet_info.dart';
 import 'package:cw_bitcoin/bitcoin_address_record.dart';
 import 'package:cw_bitcoin/electrum_balance.dart';
 import 'package:cw_bitcoin/bitcoin_wallet_addresses.dart';
+import 'package:bip39/bip39.dart' as bip39;
 
 part 'bitcoin_wallet.g.dart';
 
@@ -30,8 +31,10 @@ abstract class BitcoinWalletBase extends ElectrumWallet with Store {
     ElectrumBalance? initialBalance,
     Map<String, int>? initialRegularAddressIndex,
     Map<String, int>? initialChangeAddressIndex,
+    String? passphrase,
   }) : super(
             mnemonic: mnemonic,
+            passphrase: passphrase,
             password: password,
             walletInfo: walletInfo,
             unspentCoinsInfo: unspentCoinsInfo,
@@ -44,14 +47,19 @@ abstract class BitcoinWalletBase extends ElectrumWallet with Store {
             initialBalance: initialBalance,
             seedBytes: seedBytes,
             currency: CryptoCurrency.btc) {
+    // in a standard BIP44 wallet, mainHd derivation path = m/84'/0'/0'/0 (account 0, index unspecified here)
+    // the sideHd derivation path = m/84'/0'/0'/1 (account 1, index unspecified here)
+    String derivationPath = walletInfo.derivationInfo!.derivationPath!;
+    String sideDerivationPath = derivationPath.substring(0, derivationPath.length - 1) + "1";
+    final hd = bitcoin.HDWallet.fromSeed(seedBytes, network: networkType);
     walletAddresses = BitcoinWalletAddresses(
       walletInfo,
       electrumClient: electrumClient,
       initialAddresses: initialAddresses,
       initialRegularAddressIndex: initialRegularAddressIndex,
       initialChangeAddressIndex: initialChangeAddressIndex,
-      mainHd: hd,
-      sideHd: bitcoin.HDWallet.fromSeed(seedBytes, network: networkType).derivePath("m/0'/1"),
+      mainHd: hd.derivePath(derivationPath),
+      sideHd: hd.derivePath(sideDerivationPath),
       network: networkParam ?? network,
     );
     autorun((_) {
@@ -64,21 +72,37 @@ abstract class BitcoinWalletBase extends ElectrumWallet with Store {
     required String password,
     required WalletInfo walletInfo,
     required Box<UnspentCoinsInfo> unspentCoinsInfo,
+    String? passphrase,
     String? addressPageType,
     BasedUtxoNetwork? network,
     List<BitcoinAddressRecord>? initialAddresses,
     ElectrumBalance? initialBalance,
     Map<String, int>? initialRegularAddressIndex,
     Map<String, int>? initialChangeAddressIndex,
   }) async {
+    late Uint8List seedBytes;
+
+    switch (walletInfo.derivationInfo?.derivationType) {
+      case DerivationType.bip39:
+        seedBytes = await bip39.mnemonicToSeed(
+          mnemonic,
+          passphrase: passphrase ?? "",
+        );
+        break;
+      case DerivationType.electrum:
+      default:
+        seedBytes = await mnemonicToSeedBytes(mnemonic);
+        break;
+    }
     return BitcoinWallet(
       mnemonic: mnemonic,
+      passphrase: passphrase ?? "",
       password: password,
       walletInfo: walletInfo,
       unspentCoinsInfo: unspentCoinsInfo,
       initialAddresses: initialAddresses,
       initialBalance: initialBalance,
-      seedBytes: await mnemonicToSeedBytes(mnemonic),
+      seedBytes: seedBytes,
       initialRegularAddressIndex: initialRegularAddressIndex,
       initialChangeAddressIndex: initialChangeAddressIndex,
       addressPageType: addressPageType,
@@ -97,14 +121,38 @@ abstract class BitcoinWalletBase extends ElectrumWallet with Store {
         : BitcoinNetwork.mainnet;
     final snp = await ElectrumWalletSnapshot.load(name, walletInfo.type, password, network);
 
+    walletInfo.derivationInfo ??= DerivationInfo(
+      derivationType: snp.derivationType ?? DerivationType.electrum,
+      derivationPath: snp.derivationPath,
+    );
+
+    // set the default if not present:
+    walletInfo.derivationInfo!.derivationPath = snp.derivationPath ?? "m/0'/1";
+
+    late Uint8List seedBytes;
+
+    switch (walletInfo.derivationInfo!.derivationType) {
+      case DerivationType.electrum:
+        seedBytes = await mnemonicToSeedBytes(snp.mnemonic);
+        break;
+      case DerivationType.bip39:
+      default:
+        seedBytes = await bip39.mnemonicToSeed(
+          snp.mnemonic,
+          passphrase: snp.passphrase ?? '',
+        );
+        break;
+    }
+
     return BitcoinWallet(
       mnemonic: snp.mnemonic,
       password: password,
+      passphrase: snp.passphrase,
       walletInfo: walletInfo,
       unspentCoinsInfo: unspentCoinsInfo,
       initialAddresses: snp.addresses,
       initialBalance: snp.balance,
-      seedBytes: await mnemonicToSeedBytes(snp.mnemonic),
+      seedBytes: seedBytes,
       initialRegularAddressIndex: snp.regularAddressIndex,
       initialChangeAddressIndex: snp.changeAddressIndex,
       addressPageType: snp.addressPageType,

diff --git a/cw_bitcoin/lib/bitcoin_wallet_creation_credentials.dart b/cw_bitcoin/lib/bitcoin_wallet_creation_credentials.dart
@@ -2,14 +2,35 @@ import 'package:cw_core/wallet_credentials.dart';
 import 'package:cw_core/wallet_info.dart';
 
 class BitcoinNewWalletCredentials extends WalletCredentials {
-  BitcoinNewWalletCredentials({required String name, WalletInfo? walletInfo})
-      : super(name: name, walletInfo: walletInfo);
+  BitcoinNewWalletCredentials(
+      {required String name,
+      WalletInfo? walletInfo,
+      DerivationType? derivationType,
+      String? derivationPath})
+      : super(
+          name: name,
+          walletInfo: walletInfo,
+        );
 }
 
 class BitcoinRestoreWalletFromSeedCredentials extends WalletCredentials {
-  BitcoinRestoreWalletFromSeedCredentials(
-      {required String name, required String password, required this.mnemonic, WalletInfo? walletInfo})
-      : super(name: name, password: password, walletInfo: walletInfo);
+  BitcoinRestoreWalletFromSeedCredentials({
+    required String name,
+    required String password,
+    required this.mnemonic,
+    WalletInfo? walletInfo,
+    required DerivationType derivationType,
+    required String derivationPath,
+    String? passphrase,
+  }) : super(
+            name: name,
+            password: password,
+            passphrase: passphrase,
+            walletInfo: walletInfo,
+            derivationInfo: DerivationInfo(
+              derivationType: derivationType,
+              derivationPath: derivationPath,
+            ));
 
   final String mnemonic;
 }
@@ -20,4 +41,4 @@ class BitcoinRestoreWalletFromWIFCredentials extends WalletCredentials {
       : super(name: name, password: password, walletInfo: walletInfo);
 
   final String wif;
-}
+}
diff --git a/cw_bitcoin/lib/bitcoin_wallet_service.dart b/cw_bitcoin/lib/bitcoin_wallet_service.dart
@@ -12,6 +12,7 @@ import 'package:cw_core/wallet_info.dart';
 import 'package:cw_core/wallet_type.dart';
 import 'package:hive/hive.dart';
 import 'package:collection/collection.dart';
+import 'package:bip39/bip39.dart' as bip39;
 
 class BitcoinWalletService extends WalletService<BitcoinNewWalletCredentials,
     BitcoinRestoreWalletFromSeedCredentials, BitcoinRestoreWalletFromWIFCredentials> {
@@ -29,8 +30,9 @@ class BitcoinWalletService extends WalletService<BitcoinNewWalletCredentials,
     credentials.walletInfo?.network = network.value;
 
     final wallet = await BitcoinWalletBase.create(
-      mnemonic: await generateMnemonic(),
+      mnemonic: await generateElectrumMnemonic(),
       password: credentials.password!,
+      passphrase: credentials.passphrase,
       walletInfo: credentials.walletInfo!,
       unspentCoinsInfo: unspentCoinsInfoSource,
       network: network,
@@ -105,7 +107,7 @@ class BitcoinWalletService extends WalletService<BitcoinNewWalletCredentials,
   @override
   Future<BitcoinWallet> restoreFromSeed(BitcoinRestoreWalletFromSeedCredentials credentials,
       {bool? isTestnet}) async {
-    if (!validateMnemonic(credentials.mnemonic)) {
+    if (!validateMnemonic(credentials.mnemonic) && !bip39.validateMnemonic(credentials.mnemonic)) {
       throw BitcoinMnemonicIsIncorrectException();
     }
 
@@ -114,6 +116,7 @@ class BitcoinWalletService extends WalletService<BitcoinNewWalletCredentials,
 
     final wallet = await BitcoinWalletBase.create(
       password: credentials.password!,
+      passphrase: credentials.passphrase,
       mnemonic: credentials.mnemonic,
       walletInfo: credentials.walletInfo!,
       unspentCoinsInfo: unspentCoinsInfoSource,

diff --git a/cw_bitcoin/lib/electrum_derivations.dart b/cw_bitcoin/lib/electrum_derivations.dart
@@ -0,0 +1,104 @@
+import 'package:cw_core/wallet_info.dart';
+
+Map<DerivationType, List<DerivationInfo>> electrum_derivations = {
+  DerivationType.electrum: [
+    DerivationInfo(
+      derivationType: DerivationType.electrum,
+      derivationPath: "m/0'/0",
+      description: "Electrum",
+      scriptType: "p2wpkh",
+    ),
+  ],
+  DerivationType.bip39: [
+    DerivationInfo(
+      derivationType: DerivationType.bip39,
+      derivationPath: "m/44'/0'/0'",
+      description: "Standard BIP44",
+      scriptType: "p2pkh",
+    ),
+    DerivationInfo(
+      derivationType: DerivationType.bip39,
+      derivationPath: "m/49'/0'/0'",
+      description: "Standard BIP49 compatibility segwit",
+      scriptType: "p2wpkh-p2sh",
+    ),
+    DerivationInfo(
+      derivationType: DerivationType.bip39,
+      derivationPath: "m/84'/0'/0'",
+      description: "Standard BIP84 native segwit",
+      scriptType: "p2wpkh",
+    ),
+    DerivationInfo(
+      derivationType: DerivationType.bip39,
+      derivationPath: "m/0'",
+      description: "Non-standard legacy",
+      scriptType: "p2pkh",
+    ),
+    DerivationInfo(
+      derivationType: DerivationType.bip39,
+      derivationPath: "m/0'",
+      description: "Non-standard compatibility segwit",
+      scriptType: "p2wpkh-p2sh",
+    ),
+    DerivationInfo(
+      derivationType: DerivationType.bip39,
+      derivationPath: "m/0'",
+      description: "Non-standard native segwit",
+      scriptType: "p2wpkh",
+    ),
+    DerivationInfo(
+      derivationType: DerivationType.bip39,
+      derivationPath: "m/44'/0'/0'",
+      description: "Samourai Deposit",
+      scriptType: "p2wpkh",
+    ),
+    DerivationInfo(
+      derivationType: DerivationType.bip39,
+      derivationPath: "m/49'/0'/0'",
+      description: "Samourai Deposit",
+      scriptType: "p2wpkh",
+    ),
+    DerivationInfo(
+      derivationType: DerivationType.bip39,
+      derivationPath: "m/84'/0'/2147483644'",
+      description: "Samourai Bad Bank (toxic change)",
+      scriptType: "p2wpkh",
+    ),
+    DerivationInfo(
+      derivationType: DerivationType.bip39,
+      derivationPath: "m/84'/0'/2147483645'",
+      description: "Samourai Whirlpool Pre Mix",
+      scriptType: "p2wpkh",
+    ),
+    DerivationInfo(
+      derivationType: DerivationType.bip39,
+      derivationPath: "m/84'/0'/2147483646'",
+      description: "Samourai Whirlpool Post Mix",
+      scriptType: "p2wpkh",
+    ),
+    DerivationInfo(
+      derivationType: DerivationType.bip39,
+      derivationPath: "m/44'/0'/2147483647'",
+      description: "Samourai Ricochet legacy",
+      scriptType: "p2pkh",
+    ),
+    DerivationInfo(
+      derivationType: DerivationType.bip39,
+      derivationPath: "m/49'/0'/2147483647'",
+      description: "Samourai Ricochet compatibility segwit",
+      scriptType: "p2wpkh-p2sh",
+    ),
+    DerivationInfo(
+      derivationType: DerivationType.bip39,
+      derivationPath: "m/84'/0'/2147483647'",
+      description: "Samourai Ricochet native segwit",
+      scriptType: "p2wpkh",
+    ),
+    DerivationInfo(
+      derivationType: DerivationType.bip39,
+      derivationPath: "m/84'/2'/0'",
+      description: "Default Litecoin",
+      scriptType: "p2wpkh",
+    ),
+  ],
+};