Hardware wallet support for Ledger

README.md

@@ -4,7 +4,7 @@
 
 Cross-platform non-custodial wallet designed for Alphanet - Network of Momentum Phase 0.
 
-Developed in Flutter using the [Zenon Dart SDK](https://github.com/zenon-network/znn_sdk_dart), `s y r i u s` wallet provides a simple and intuitive interface to interact with Network of Momentum Phase 0.
+Developed in Flutter using the [Zenon Dart SDK](https://github.com/zenon-network/znn_sdk_dart) and [Ledger Wallet for Zenon Dart SDK](https://github.com/hypercore-one/znn_ledger_dart), `s y r i u s` wallet provides a simple and intuitive interface to interact with Network of Momentum Phase 0.
 
 ## Architecture
 
@@ -18,7 +18,7 @@ The wallet has a modular design with native full node integration. There are thr
 
 Follow the instructions to install the [Flutter SDK](https://docs.flutter.dev/get-started/install). Check the [documentation](https://docs.flutter.dev/desktop) in order to setup the Flutter desktop environment.
 
-Learn about the foreign function interface (ffi) [here](https://docs.flutter.dev/development/platform-integration/c-interop) that enables state-of-the art KDF - [Argon2](https://github.com/zenon-network/argon2_ffi), feeless transactions - [PoW links](https://github.com/zenon-network/znn-pow-links-cpp) and native full node integration - [Embedded Node](https://github.com/zenon-network/go-zenon).
+Learn about the foreign function interface (ffi) [here](https://docs.flutter.dev/development/platform-integration/c-interop) that enables state-of-the art KDF - [Argon2](https://github.com/zenon-network/argon2_ffi), feeless transactions - [PoW links](https://github.com/zenon-network/znn-pow-links-cpp), native full node integration - [Embedded Node](https://github.com/zenon-network/go-zenon) and communication library between Ledger devices - [Ledger](https://github.com/hypercore-one/ledger_ffi_rs).
 
 Dependencies:
 
@@ -36,6 +36,11 @@ flutter run --dart-define=WC_PROJECT_ID=walletconnect_project_id -d <os>
 flutter build --dart-define=WC_PROJECT_ID=walletconnect_project_id <os>
 ```
 
+## Linux
+
+Note that on Linux you will need to install an udev rule file with your application for unprivileged users to be able to access HID devices with hidapi. 
+Refer to the [README](udev/) file in the udev directory for an example.
+
 ## Contributing
 
 Please check [CONTRIBUTING](./CONTRIBUTING.md) for more details.

lib/blocs/auto_receive_tx_worker.dart

@@ -9,7 +9,6 @@ import 'package:zenon_syrius_wallet_flutter/main.dart';
 import 'package:zenon_syrius_wallet_flutter/model/model.dart';
 import 'package:zenon_syrius_wallet_flutter/utils/account_block_utils.dart';
 import 'package:zenon_syrius_wallet_flutter/utils/address_utils.dart';
-import 'package:zenon_syrius_wallet_flutter/utils/global.dart';
 import 'package:znn_sdk_dart/znn_sdk_dart.dart';
 
 class AutoReceiveTxWorker extends BaseBloc<WalletNotification> {
@@ -29,25 +28,21 @@ class AutoReceiveTxWorker extends BaseBloc<WalletNotification> {
       running = true;
       Hash currentHash = pool.first;
       try {
-        String toAddress =
+        Address toAddress =
             (await zenon!.ledger.getAccountBlockByHash(currentHash))!
-                .toAddress
-                .toString();
-        KeyPair keyPair = kKeyStore!.getKeyPair(
-          kDefaultAddressList.indexOf(toAddress),
-        );
+                .toAddress;
         AccountBlockTemplate transactionParams = AccountBlockTemplate.receive(
           currentHash,
         );
         AccountBlockTemplate response =
             await AccountBlockUtils.createAccountBlock(
           transactionParams,
           'receive transaction',
-          blockSigningKey: keyPair,
+          address: toAddress,
           waitForRequiredPlasma: true,
         );
         pool.removeFirst();
-        _sendSuccessNotification(response, toAddress);
+        _sendSuccessNotification(response, toAddress.toString());
       } on RpcException catch (e, stackTrace) {
         _sendErrorNotification(e.toString());
         Logger('AutoReceiveTxWorker')

lib/blocs/auto_unlock_htlc_worker.dart

@@ -25,7 +25,7 @@ class AutoUnlockHtlcWorker extends BaseBloc<WalletNotification> {
   }
 
   Future<void> autoUnlock() async {
-    if (pool.isNotEmpty && !running && kKeyStore != null) {
+    if (pool.isNotEmpty && !running && kWalletFile != null) {
       running = true;
       Hash currentHash = pool.first;
       try {
@@ -38,16 +38,13 @@ class AutoUnlockHtlcWorker extends BaseBloc<WalletNotification> {
         if (!kDefaultAddressList.contains(htlc.hashLocked.toString())) {
           throw 'Swap address not in default addresses. Please add the address in the addresses list.';
         }
-        KeyPair? keyPair = kKeyStore!.getKeyPair(
-          kDefaultAddressList.indexOf(htlc.hashLocked.toString()),
-        );
         AccountBlockTemplate transactionParams = zenon!.embedded.htlc
             .unlock(htlc.id, FormatUtils.decodeHexString(swap.preimage!));
         AccountBlockTemplate response =
             await AccountBlockUtils.createAccountBlock(
           transactionParams,
           'complete swap',
-          blockSigningKey: keyPair,
+          address: htlc.hashLocked,
           waitForRequiredPlasma: true,
         );
         _sendSuccessNotification(response, htlc.hashLocked.toString());

lib/blocs/blocs.dart

@@ -4,10 +4,11 @@ export 'auto_receive_tx_worker.dart';
 export 'base_bloc.dart';
 export 'base_bloc_for_reloading_indicator.dart';
 export 'base_bloc_with_refresh_mixin.dart';
-export 'decrypt_key_store_bloc.dart';
+export 'decrypt_wallet_file_bloc.dart';
 export 'hide_widget_status_bloc.dart';
 export 'infinite_scroll_bloc.dart';
-export 'key_store_path_bloc.dart';
+export 'key_store_file_bloc.dart';
+export 'ledger_wallet_file_bloc.dart';
 export 'lock_bloc.dart';
 export 'node_sync_status_bloc.dart';
 export 'notifications_bloc.dart';

lib/blocs/decrypt_wallet_file_bloc.dart

@@ -0,0 +1,15 @@
+import 'package:zenon_syrius_wallet_flutter/blocs/blocs.dart';
+import 'package:zenon_syrius_wallet_flutter/utils/wallet_file.dart';
+import 'package:zenon_syrius_wallet_flutter/utils/wallet_utils.dart';
+
+class DecryptWalletFileBloc extends BaseBloc<WalletFile?> {
+  Future<void> decryptWalletFile(String path, String password) async {
+    try {
+      addEvent(null);
+      final walletFile = await WalletUtils.decryptWalletFile(path, password);
+      addEvent(walletFile);
+    } catch (e, stackTrace) {
+      addError(e, stackTrace);
+    }
+  }
+}

lib/blocs/hide_widget_status_bloc.dart

@@ -2,7 +2,7 @@ import 'package:zenon_syrius_wallet_flutter/blocs/blocs.dart';
 import 'package:zenon_syrius_wallet_flutter/main.dart';
 import 'package:zenon_syrius_wallet_flutter/utils/constants.dart';
 import 'package:zenon_syrius_wallet_flutter/utils/global.dart';
-import 'package:zenon_syrius_wallet_flutter/utils/keystore_utils.dart';
+import 'package:zenon_syrius_wallet_flutter/utils/wallet_utils.dart';
 import 'package:zenon_syrius_wallet_flutter/utils/widget_utils.dart';
 import 'package:znn_sdk_dart/znn_sdk_dart.dart';
 
@@ -15,7 +15,7 @@ class HideWidgetStatusBloc extends BaseBloc<bool?> {
     try {
       addEvent(null);
       if (!isHidden) {
-        await KeyStoreUtils.decryptKeyStoreFile(kKeyStorePath!, password);
+        await WalletUtils.decryptWalletFile(kWalletPath!, password);
       }
       await _markWidgetAsHidden(widgetTitle, isHidden);
       addEvent(isHidden);

lib/blocs/key_store_file_bloc.dart

@@ -0,0 +1,25 @@
+import 'dart:async';
+import 'dart:convert';
+
+import 'package:zenon_syrius_wallet_flutter/blocs/blocs.dart';
+import 'package:zenon_syrius_wallet_flutter/utils/global.dart';
+import 'package:zenon_syrius_wallet_flutter/utils/wallet_utils.dart';
+import 'package:zenon_syrius_wallet_flutter/utils/init_utils.dart';
+import 'package:zenon_syrius_wallet_flutter/utils/wallet_file.dart';
+import 'package:znn_sdk_dart/znn_sdk_dart.dart';
+
+class KeyStoreFileBloc extends BaseBloc<KeyStoreWalletFile?> {
+  Future<void> getKeyStorePath(
+    String mnemonic,
+    String password,
+  ) async {
+    try {
+      await WalletUtils.createKeyStoreWalletFile(mnemonic, password);
+      await InitUtils.initWalletAfterDecryption(
+          Crypto.digest(utf8.encode(password)));
+      addEvent(kWalletFile as KeyStoreWalletFile);
+    } catch (e, stackTrace) {
+      addError(e, stackTrace);
+    }
+  }
+}

lib/blocs/ledger_wallet_file_bloc.dart

@@ -0,0 +1,26 @@
+import 'dart:async';
+import 'dart:convert';
+
+import 'package:zenon_syrius_wallet_flutter/blocs/blocs.dart';
+import 'package:zenon_syrius_wallet_flutter/utils/global.dart';
+import 'package:zenon_syrius_wallet_flutter/utils/wallet_utils.dart';
+import 'package:zenon_syrius_wallet_flutter/utils/init_utils.dart';
+import 'package:zenon_syrius_wallet_flutter/utils/wallet_file.dart';
+import 'package:znn_sdk_dart/znn_sdk_dart.dart';
+
+class LedgerWalletFileBloc extends BaseBloc<LedgerWalletFile?> {
+  Future<void> getLedgerWalletPath(
+    String walletId,
+    String password,
+  ) async {
+    try {
+      await WalletUtils.createLedgerWalletFile(
+          walletId, password);
+      await InitUtils.initWalletAfterDecryption(
+          Crypto.digest(utf8.encode(password)));
+      addEvent(kWalletFile as LedgerWalletFile);
+    } catch (e, stackTrace) {
+      addError(e, stackTrace);
+    }
+  }
+}

lib/blocs/p2p_swap/htlc_swap/complete_htlc_swap_bloc.dart

@@ -30,11 +30,8 @@ class CompleteHtlcSwapBloc extends BaseBloc<HtlcSwap?> {
 
       AccountBlockTemplate transactionParams = zenon!.embedded.htlc.unlock(
           Hash.parse(htlcId), FormatUtils.decodeHexString(swap.preimage!));
-      KeyPair blockSigningKeyPair = kKeyStore!.getKeyPair(
-        kDefaultAddressList.indexOf(swap.selfAddress.toString()),
-      );
       AccountBlockUtils.createAccountBlock(transactionParams, 'complete swap',
-              blockSigningKey: blockSigningKeyPair, waitForRequiredPlasma: true)
+              address: Address.parse(swap.selfAddress), waitForRequiredPlasma: true)
           .then(
         (response) async {
           swap.state = P2pSwapState.completed;

lib/blocs/p2p_swap/htlc_swap/join_htlc_swap_bloc.dart

@@ -6,7 +6,6 @@ import 'package:zenon_syrius_wallet_flutter/utils/account_block_utils.dart';
 import 'package:zenon_syrius_wallet_flutter/utils/address_utils.dart';
 import 'package:zenon_syrius_wallet_flutter/utils/date_time_utils.dart';
 import 'package:zenon_syrius_wallet_flutter/utils/format_utils.dart';
-import 'package:zenon_syrius_wallet_flutter/utils/global.dart';
 import 'package:znn_sdk_dart/znn_sdk_dart.dart';
 
 class JoinHtlcSwapBloc extends BaseBloc<HtlcSwap?> {
@@ -19,7 +18,7 @@ class JoinHtlcSwapBloc extends BaseBloc<HtlcSwap?> {
     required P2pSwapChain fromChain,
     required P2pSwapChain toChain,
     required int counterHtlcExpirationTime,
-  }) {
+  }) async {
     try {
       addEvent(null);
       AccountBlockTemplate transactionParams = zenon!.embedded.htlc.create(
@@ -31,11 +30,8 @@ class JoinHtlcSwapBloc extends BaseBloc<HtlcSwap?> {
         initialHtlc.keyMaxSize,
         initialHtlc.hashLock,
       );
-      KeyPair blockSigningKeyPair = kKeyStore!.getKeyPair(
-        kDefaultAddressList.indexOf(initialHtlc.hashLocked.toString()),
-      );
       AccountBlockUtils.createAccountBlock(transactionParams, 'join swap',
-              blockSigningKey: blockSigningKeyPair, waitForRequiredPlasma: true)
+              address: initialHtlc.hashLocked, waitForRequiredPlasma: true)
           .then(
         (response) async {
           final swap = HtlcSwap(

lib/blocs/p2p_swap/htlc_swap/reclaim_htlc_swap_funds_bloc.dart

@@ -2,24 +2,20 @@ import 'package:zenon_syrius_wallet_flutter/blocs/base_bloc.dart';
 import 'package:zenon_syrius_wallet_flutter/main.dart';
 import 'package:zenon_syrius_wallet_flutter/utils/account_block_utils.dart';
 import 'package:zenon_syrius_wallet_flutter/utils/address_utils.dart';
-import 'package:zenon_syrius_wallet_flutter/utils/global.dart';
 import 'package:znn_sdk_dart/znn_sdk_dart.dart';
 
 class ReclaimHtlcSwapFundsBloc extends BaseBloc<AccountBlockTemplate?> {
   void reclaimFunds({
     required Hash htlcId,
     required Address selfAddress,
-  }) {
+  }) async {
     try {
       addEvent(null);
       AccountBlockTemplate transactionParams =
           zenon!.embedded.htlc.reclaim(htlcId);
-      KeyPair blockSigningKeyPair = kKeyStore!.getKeyPair(
-        kDefaultAddressList.indexOf(selfAddress.toString()),
-      );
       AccountBlockUtils.createAccountBlock(
               transactionParams, 'reclaim swap funds',
-              blockSigningKey: blockSigningKeyPair, waitForRequiredPlasma: true)
+              address: selfAddress, waitForRequiredPlasma: true)
           .then(
         (response) {
           ZenonAddressUtils.refreshBalance();

lib/blocs/p2p_swap/htlc_swap/start_htlc_swap_bloc.dart

@@ -8,7 +8,6 @@ import 'package:zenon_syrius_wallet_flutter/utils/account_block_utils.dart';
 import 'package:zenon_syrius_wallet_flutter/utils/address_utils.dart';
 import 'package:zenon_syrius_wallet_flutter/utils/date_time_utils.dart';
 import 'package:zenon_syrius_wallet_flutter/utils/format_utils.dart';
-import 'package:zenon_syrius_wallet_flutter/utils/global.dart';
 import 'package:znn_sdk_dart/znn_sdk_dart.dart';
 
 class StartHtlcSwapBloc extends BaseBloc<HtlcSwap?> {
@@ -37,11 +36,8 @@ class StartHtlcSwapBloc extends BaseBloc<HtlcSwap?> {
         htlcPreimageMaxLength,
         hashLock.getBytes(),
       );
-      KeyPair blockSigningKeyPair = kKeyStore!.getKeyPair(
-        kDefaultAddressList.indexOf(selfAddress.toString()),
-      );
       AccountBlockUtils.createAccountBlock(transactionParams, 'start swap',
-              blockSigningKey: blockSigningKeyPair, waitForRequiredPlasma: true)
+              address: selfAddress, waitForRequiredPlasma: true)
           .then(
         (response) async {
           final swap = HtlcSwap(

lib/blocs/transfer/send_payment_bloc.dart

@@ -1,7 +1,6 @@
 import 'package:zenon_syrius_wallet_flutter/blocs/blocs.dart';
 import 'package:zenon_syrius_wallet_flutter/utils/account_block_utils.dart';
 import 'package:zenon_syrius_wallet_flutter/utils/address_utils.dart';
-import 'package:zenon_syrius_wallet_flutter/utils/global.dart';
 import 'package:znn_sdk_dart/znn_sdk_dart.dart';
 
 class SendPaymentBloc extends BaseBloc<AccountBlockTemplate?> {
@@ -13,7 +12,7 @@ class SendPaymentBloc extends BaseBloc<AccountBlockTemplate?> {
     List<int>? data,
     Token? token,
     AccountBlockTemplate? block,
-  }) {
+  }) async {
     assert(
       block == null &&
               fromAddress != null &&
@@ -31,13 +30,10 @@ class SendPaymentBloc extends BaseBloc<AccountBlockTemplate?> {
             amount!,
             data,
           );
-      KeyPair blockSigningKeyPair = kKeyStore!.getKeyPair(
-        kDefaultAddressList.indexOf(fromAddress),
-      );
       AccountBlockUtils.createAccountBlock(
         accountBlock,
         'send transaction',
-        blockSigningKey: blockSigningKeyPair,
+        address: Address.parse(fromAddress!),
         waitForRequiredPlasma: true,
       ).then(
         (response) {

lib/model/database/notification_type.dart

@@ -49,4 +49,7 @@ enum NotificationType {
 
   @HiveField(14)
   delete,
+
+  @HiveField(15)
+  confirm,
 }

lib/model/database/wallet_notification.dart

@@ -78,6 +78,9 @@ class WalletNotification extends HiveObject {
         return _getCircledIcon(Icons.link);
       case NotificationType.delete:
         return _getCircledIcon(Icons.delete_forever);
+      case NotificationType.confirm:
+        return _getCircledIcon(Icons.remove_red_eye,
+            iconColor: AppColors.alertNotification);
       default:
         return _getCircledIcon(MaterialCommunityIcons.arrow_top_right);
     }