Detect faulty Ledger firmware

Author: lukaw3d

.changelog/2205.bugfix.md

@@ -0,0 +1 @@
+Detect faulty ledger firmware

src/app/components/ErrorFormatter/index.tsx

@@ -93,6 +93,23 @@ export function ErrorFormatter(props: Props) {
       'errors.LedgerDerivedDifferentAccount',
       'This account does not belong to the currently connected Ledger.',
     ),
+    [WalletErrors.LedgerLikelyFaultyFirmware]: (
+      <Trans
+        i18nKey="errors.LedgerLikelyFaultyFirmware"
+        t={t}
+        defaults="Connecting to Ledger timed out. This is likely due to faulty Ledger firmware: Nano X 2.5.0, Nano S Plus 1.4.0, Stax 1.8.0, Flex 1.4.0. We suggest <WorkaroundsHelp>some workarounds here</WorkaroundsHelp>."
+        components={{
+          WorkaroundsHelp: (
+            <Anchor
+              href="https://github.com/oasisprotocol/wallet/issues/2198#issuecomment-3177012146"
+              target="_blank"
+              rel="noopener"
+              style={{ display: 'inline' }}
+            />
+          ),
+        }}
+      />
+    ),
     [WalletErrors.LedgerUnknownError]: t('errors.unknownLedgerError', 'Unknown ledger error: {{message}}', {
       message,
     }),

src/app/state/importaccounts/saga.ts

@@ -23,6 +23,18 @@ import BleTransport from '@oasisprotocol/ionic-ledger-hw-transport-ble/lib'
 import { ScanResult } from '@capacitor-community/bluetooth-le'
 import { getChainContext } from '../network/saga'
 
+class TransportWebUSBDetectLedgerLikelyFaultyFirmware extends TransportWebUSB {
+  static async open(a: any) {
+    const response = await Promise.race([
+      super.open(a),
+      new Promise<never>((resolve, reject) =>
+        setTimeout(() => reject(new WalletError(WalletErrors.LedgerLikelyFaultyFirmware, 'timeout')), 8_000),
+      ),
+    ])
+    return response
+  }
+}
+
 function* setStep(step: ImportAccountsStep) {
   yield* put(importAccountsActions.setStep(step))
 }
@@ -65,9 +77,14 @@ export function* getUSBTransport() {
     throw new WalletError(WalletErrors.USBTransportNotSupported, 'TransportWebUSB unsupported')
   }
   try {
-    return yield* call([TransportWebUSB, TransportWebUSB.create])
+    return yield* call([
+      TransportWebUSBDetectLedgerLikelyFaultyFirmware,
+      TransportWebUSBDetectLedgerLikelyFaultyFirmware.create,
+    ])
   } catch (e: any) {
-    if (e.message.match(/No device selected/)) {
+    if (e instanceof WalletError) {
+      throw e
+    } else if (e.message.match(/No device selected/)) {
       throw new WalletError(WalletErrors.LedgerNoDeviceSelected, e.message)
     } else {
       throw new WalletError(WalletErrors.USBTransportError, e.message)

src/locales/en/translation.json

@@ -152,6 +152,7 @@
   },
   "errors": {
     "LedgerDerivedDifferentAccount": "This account does not belong to the currently connected Ledger.",
+    "LedgerLikelyFaultyFirmware": "Connecting to Ledger timed out. This is likely due to faulty Ledger firmware: Nano X 2.5.0, Nano S Plus 1.4.0, Stax 1.8.0, Flex 1.4.0. We suggest <WorkaroundsHelp>some workarounds here</WorkaroundsHelp>.",
     "LedgerOasisAppIsNotOpen": "Oasis App on Ledger is closed.",
     "bluetoothTransportNotSupported": "Bluetooth may be turned off or your current platform does not support Bluetooth capability.",
     "cannotSendToSelf": "Cannot send to yourself",

src/types/errors.ts

@@ -28,6 +28,7 @@ export enum WalletErrors {
   LedgerTransactionRejected = 'transaction_rejected',
   LedgerAppVersionNotSupported = 'ledger_version_not_supported',
   LedgerDerivedDifferentAccount = 'ledger_derived_different_account',
+  LedgerLikelyFaultyFirmware = 'ledger_likely_faulty_firmware',
   IndexerAPIError = 'indexer_api_error',
   DisconnectedError = 'disconnected_error',
   ParaTimesUnknownError = 'para_times_unknown_error',