feat(cat-voices): localised wallet errors (#3763)

* feat: localized wallet errors

* fix: docs tests

* fix: spelling

* chore: move source code extraction to fallbackApiException

* chore: use _InfoCodeError.tryFrom

Author: damian-molinski

.config/dictionaries/project.dic

@@ -122,6 +122,7 @@ Embedder
 emiride
 emurgo
 encryptor
+endtemplate
 endfunction
 Eternl
 EUTXO

catalyst_voices/packages/internal/catalyst_voices_blocs/lib/src/registration/cubits/recover_cubit.dart

@@ -2,6 +2,7 @@
 
 import 'package:catalyst_voices_blocs/catalyst_voices_blocs.dart';
 import 'package:catalyst_voices_blocs/src/registration/cubits/unlock_password_manager.dart';
+import 'package:catalyst_voices_blocs/src/registration/utils/logger_level_ext.dart';
 import 'package:catalyst_voices_models/catalyst_voices_models.dart';
 import 'package:catalyst_voices_services/catalyst_voices_services.dart';
 import 'package:catalyst_voices_shared/catalyst_voices_shared.dart';
@@ -107,21 +108,13 @@ final class RecoverCubit extends Cubit<RecoverStateData>
       emit(state.copyWith(accountDetails: Optional(Success(accountDetails))));
 
       return true;
-    } on RegistrationException catch (error, stack) {
-      _logger.severe('recover account', error, stack);
-
-      _recoveredAccount = null;
-
-      final exception = LocalizedRegistrationException.from(error);
-      emit(state.copyWith(accountDetails: Optional(Failure(exception))));
-
-      return false;
     } catch (error, stack) {
-      _logger.severe('recover account', error, stack);
+      _logger.log(error.level, 'recover account', error, stack);
 
       _recoveredAccount = null;
 
-      final exception = LocalizedException.create(error);
+      final exception = LocalizedRegistrationException.create(error);
+
       emit(state.copyWith(accountDetails: Optional(Failure(exception))));
 
       return false;

catalyst_voices/packages/internal/catalyst_voices_blocs/lib/src/registration/cubits/wallet_link_cubit.dart

@@ -2,6 +2,7 @@ import 'dart:async';
 
 import 'package:catalyst_cardano/catalyst_cardano.dart';
 import 'package:catalyst_voices_blocs/catalyst_voices_blocs.dart';
+import 'package:catalyst_voices_blocs/src/registration/utils/logger_level_ext.dart';
 import 'package:catalyst_voices_models/catalyst_voices_models.dart';
 import 'package:catalyst_voices_services/catalyst_voices_services.dart';
 import 'package:catalyst_voices_shared/catalyst_voices_shared.dart';
@@ -109,31 +110,8 @@ final class WalletLinkCubit extends Cubit<WalletLinkStateData>
       emit(newState);
 
       return true;
-    } on WalletApiException catch (error, stackTrace) {
-      _logger.log(
-        error.code != WalletApiErrorCode.refused && error.code != WalletApiErrorCode.accountChange
-            ? Level.SEVERE
-            : Level.FINER,
-        'select wallet',
-        error,
-        stackTrace,
-      );
-
-      _selectedWallet = null;
-
-      emit(
-        state.copyWith(
-          selectedWallet: const Optional.empty(),
-          walletConnection: const Optional.empty(),
-          walletSummary: const Optional.empty(),
-        ),
-      );
-
-      emitError(LocalizedWalletLinkException(code: error.code));
-
-      return false;
     } catch (error, stackTrace) {
-      _logger.severe('selectWallet', error, stackTrace);
+      _logger.log(error.level, 'selectWallet', error, stackTrace);
 
       _selectedWallet = null;
 
@@ -145,7 +123,7 @@ final class WalletLinkCubit extends Cubit<WalletLinkStateData>
         ),
       );
 
-      emitError(error);
+      emitError(LocalizedRegistrationException.create(error));
 
       return false;
     }

catalyst_voices/packages/internal/catalyst_voices_blocs/lib/src/registration/registration_cubit.dart

@@ -6,6 +6,7 @@ import 'package:catalyst_voices_blocs/src/registration/cubits/base_profile_cubit
 import 'package:catalyst_voices_blocs/src/registration/cubits/keychain_creation_cubit.dart';
 import 'package:catalyst_voices_blocs/src/registration/cubits/recover_cubit.dart';
 import 'package:catalyst_voices_blocs/src/registration/cubits/wallet_link_cubit.dart';
+import 'package:catalyst_voices_blocs/src/registration/utils/logger_level_ext.dart';
 import 'package:catalyst_voices_models/catalyst_voices_models.dart';
 import 'package:catalyst_voices_services/catalyst_voices_services.dart';
 import 'package:catalyst_voices_shared/catalyst_voices_shared.dart';
@@ -173,17 +174,6 @@ final class RegistrationCubit extends Cubit<RegistrationState>
 
       _progressNotifier.clear();
       nextStep();
-    } on RegistrationException catch (error, stack) {
-      _logger.severe('Submit registration failed', error, stack);
-
-      final exception = LocalizedRegistrationException.from(error);
-
-      _onRegistrationStateDataChanged(
-        _registrationState.copyWith(
-          canSubmitTx: Optional(Failure(exception)),
-          isSubmittingTx: false,
-        ),
-      );
     } on EmailAlreadyUsedException {
       emitSignal(const EmailAlreadyUsedSignal());
 
@@ -196,9 +186,9 @@ final class RegistrationCubit extends Cubit<RegistrationState>
       // have to update their email in the account page.
       nextStep();
     } catch (error, stack) {
-      _logger.severe('Submit registration failed', error, stack);
+      _logger.log(error.level, 'Submit registration failed', error, stack);
 
-      const exception = LocalizedRegistrationUnknownException();
+      final exception = LocalizedRegistrationException.create(error);
 
       _onRegistrationStateDataChanged(
         _registrationState.copyWith(
@@ -283,12 +273,12 @@ final class RegistrationCubit extends Cubit<RegistrationState>
           transactionFee: Optional.of(formattedFee),
         ),
       );
-    } on RegistrationException catch (error, stackTrace) {
-      _logger.severe('Prepare registration', error, stackTrace);
+    } catch (error, stackTrace) {
+      _logger.log(error.level, 'Prepare registration', error, stackTrace);
 
       _transaction = null;
 
-      final exception = LocalizedRegistrationException.from(error);
+      final exception = LocalizedRegistrationException.create(error);
 
       _onRegistrationStateDataChanged(
         _registrationState.copyWith(

catalyst_voices/packages/internal/catalyst_voices_blocs/lib/src/registration/utils/logger_level_ext.dart

@@ -0,0 +1,23 @@
+import 'package:catalyst_cardano/catalyst_cardano.dart';
+import 'package:catalyst_voices_shared/catalyst_voices_shared.dart';
+
+extension LoggerLevelExt on Object {
+  Level get level {
+    final instance = this;
+    if (instance is TxSignException && instance.code == TxSignErrorCode.userDeclined) {
+      return Level.INFO;
+    }
+    if (instance is WalletApiException && instance.code == WalletApiErrorCode.refused) {
+      return Level.INFO;
+    }
+    if (instance is WalletApiException && instance.code == WalletApiErrorCode.accountChange) {
+      return Level.INFO;
+    }
+    if (instance is WalletDataSignException &&
+        instance.code == WalletDataSignErrorCode.userDeclined) {
+      return Level.INFO;
+    }
+
+    return Level.SEVERE;
+  }
+}

catalyst_voices/packages/internal/catalyst_voices_localization/lib/l10n/intl_en.arb

@@ -1296,22 +1296,76 @@
   "@errorValidationTokenNotParsed": {
     "description": "A validation error when user enters input which cannot be parsed into token value."
   },
-  "errorWalletLinkAccountChange": "Wallet account change",
+  "errorWalletLinkAccountChange": "Wallet account has changed.",
   "@errorWalletLinkAccountChange": {
     "description": "Error message shown when wallet account has changed"
   },
-  "errorWalletLinkInternalError": "Wallet authorisation internal error",
+  "errorWalletLinkInternalError": "Wallet error occurred during execution of this API call.",
   "@errorWalletLinkInternalError": {
     "description": "Error message shown when internal error occurs during wallet authorization"
   },
-  "errorWalletLinkInvalidRequest": "Wallet authorisation invalid request",
+  "errorWalletLinkInvalidRequest": "Wallet inputs do not conform to this spec or are otherwise invalid.",
   "@errorWalletLinkInvalidRequest": {
     "description": "Error message shown when wallet authorization request is invalid"
   },
-  "errorWalletLinkRefused": "Wallet authorisation failed",
+  "errorWalletLinkInvalidRequestCode": "Wallet request failed with code {code}.",
+  "@errorWalletLinkInvalidRequestCode": {
+    "description": "Error message shown when wallet authorization request is invalid",
+    "placeholders": {
+      "code": {
+        "type": "int"
+      }
+    }
+  },
+  "errorWalletLinkRefused": "The wallet request was refused due to lack of access.",
   "@errorWalletLinkRefused": {
     "description": "Error message shown when wallet authorization is refused"
   },
+  "errorWalletTxSendRefused": "Wallet refuses to send the tx (could be rate limiting).",
+  "@errorWalletTxSendRefused": {
+    "description": "Error message shown when wallet throws TxSend exception"
+  },
+  "errorWalletTxSendFailure": "Wallet could not send the tx.",
+  "@errorWalletTxSendFailure": {
+    "description": "Error message shown when wallet throws TxSend exception"
+  },
+  "errorWalletTxSignProofGeneration": "Wallet was unable to sign the transaction.",
+  "@errorWalletTxSignProofGeneration": {
+    "description": "Error message shown when wallet throws TxSign exception"
+  },
+  "errorWalletTxSignUserDeclined": "Transaction declined.",
+  "@errorWalletTxSignUserDeclined": {
+    "description": "Error message shown when wallet throws TxSign exception"
+  },
+  "errorWalletTxSignDepreciatedCertificate": "Transaction contains depreciated certificate.",
+  "@errorWalletTxSignDepreciatedCertificate": {
+    "description": "Error message shown when wallet throws TxSign exception"
+  },
+  "errorWalletDataSignProofGeneration": "Wallet was unable to sign the data.",
+  "@errorWalletDataSignProofGeneration": {
+    "description": "Error message shown when wallet throws DataSign exception"
+  },
+  "errorWalletDataSignAddressNotPk": "Wallet was unable to sign the data because of address format.",
+  "@errorWalletDataSignAddressNotPk": {
+    "description": "Error message shown when wallet throws DataSign exception"
+  },
+  "errorWalletDataSignUserDeclined": "Transaction declined.",
+  "@errorWalletDataSignUserDeclined": {
+    "description": "Error message shown when wallet throws DataSign exception"
+  },
+  "errorWalletPaginationMaxSize": "Wallet pagination max size({maxSize}) exceeded.",
+  "@errorWalletPaginationMaxSize": {
+    "description": "Error message shown when wallet throws DataSign exception",
+    "placeholders": {
+      "maxSize": {
+        "type": "int"
+      }
+    }
+  },
+  "errorCardanoWalletUnknown": "Wallet failed unexpectedly.",
+  "@errorCardanoWalletUnknown": {
+    "description": "Generic wallet exception"
+  },
   "eternlWallet": "Eternl Wallet",
   "@eternlWallet": {
     "description": "Name of the eternl wallet"
@@ -2854,10 +2908,6 @@
   "@registrationSeedPhraseNotFound": {
     "description": "Error message shown when attempting to register or recover account but seed phrase was not found"
   },
-  "registrationTransactionFailed": "Transaction failed",
-  "@registrationTransactionFailed": {
-    "description": "Indicates an error when submitting a registration transaction failed."
-  },
   "registrationTransactionFeeDescription": "The creation of a Catalyst account costs, a transaction fee of (0,21 {currency}), be sure your wallet has a minimum of {money}.",
   "@registrationTransactionFeeDescription": {
     "description": "Description for the registration transaction fee",

catalyst_voices/packages/internal/catalyst_voices_models/lib/src/registration/exception/registration_exception.dart

@@ -68,19 +68,3 @@ final class RegistrationRecoverKeychainNotFoundException extends RegistrationExc
   @override
   String toString() => 'RegistrationRecoverKeychainNotFoundException';
 }
-
-/// An exception thrown when attempting to register and the transaction fails.
-final class RegistrationTransactionException extends RegistrationException {
-  const RegistrationTransactionException();
-
-  @override
-  String toString() => 'RegistrationTransactionException';
-}
-
-/// An exception thrown when attempting to register and the transaction fails.
-final class RegistrationUnknownException extends RegistrationException {
-  const RegistrationUnknownException();
-
-  @override
-  String toString() => 'RegistrationUnknownException';
-}

catalyst_voices/packages/internal/catalyst_voices_repositories/test/fixture/voices_document_templates.dart

@@ -23,8 +23,11 @@ class VoicesDocumentsTemplates {
   static Future<Directory> _getDocsRoot() async {
     var dir = Directory.current;
 
+    final blacklisted = ['catalyst_voices'];
+
     while (true) {
-      final list = dir.listSync();
+      final skip = blacklisted.any((path) => dir.path.endsWith(path));
+      final list = skip ? <FileSystemEntity>[] : dir.listSync();
       final docs = list.firstWhereOrNull((e) => e.path.endsWith('/docs'));
       if (docs != null) {
         return Directory(docs.path);