Merge pull request #2205 from oasisprotocol/lw/detect-faulty-firmware

Detect faulty Ledger firmware

Author: lukaw3d

.changelog/2205.bugfix.md

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

extension/src/ExtLedgerAccessPopup/ExtLedgerAccessPopup.tsx

@@ -9,12 +9,13 @@ import { StatusGood } from 'grommet-icons/es6/icons/StatusGood'
 import { Header } from 'app/components/Header'
 import { ErrorFormatter } from 'app/components/ErrorFormatter'
 import { AlertBox } from 'app/components/AlertBox'
-import { WalletErrors } from 'types/errors'
+import { WalletError } from 'types/errors'
 import logotype from '../../../public/Icon Blue 192.png'
 import { CountdownButton } from 'app/components/CountdownButton'
-import TransportWebUSB from '@ledgerhq/hw-transport-webusb'
+import { getUSBTransport } from '../../../src/app/state/importaccounts/saga'
+import { runSaga } from 'redux-saga'
 
-type ConnectionStatus = 'connected' | 'disconnected' | 'connecting' | 'error'
+type ConnectionStatus = 'connected' | 'disconnected' | 'connecting' | WalletError
 type ConnectionStatusIconPros = {
   success?: boolean
   label: string
@@ -48,13 +49,13 @@ export function ExtLedgerAccessPopup() {
   const handleConnect = async () => {
     setConnection('connecting')
     try {
-      await (await TransportWebUSB.create()).close() // Get access permissions
+      await (await runSaga({}, getUSBTransport).toPromise()).close() // Get access permissions
       setConnection('connected')
       // Used to redirect after reopening wallet
       window.localStorage.setItem('oasis_wallet_granted_usb_ledger_timestamp', Date.now().toString())
       setTimeout(() => window.close(), 5_000)
-    } catch {
-      setConnection('error')
+    } catch (e) {
+      setConnection(e as WalletError)
     }
   }
 
@@ -105,15 +106,15 @@ export function ExtLedgerAccessPopup() {
               />
             </Box>
           )}
-          {connection === 'error' && (
+          {connection instanceof WalletError && (
             <Box margin={{ bottom: 'medium' }}>
               <ConnectionStatusIcon
                 success={false}
                 label={t('ledger.extension.failed', 'Connection failed')}
                 withMargin
               />
               <AlertBox status="error">
-                <ErrorFormatter code={WalletErrors.LedgerNoDeviceSelected} />
+                <ErrorFormatter code={connection.type} message={connection.message} />
               </AlertBox>
             </Box>
           )}

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/pages/OpenWalletPage/Features/FromLedger/index.tsx

@@ -6,8 +6,9 @@ import { Button } from 'grommet/es6/components/Button'
 import { Text } from 'grommet/es6/components/Text'
 import { canAccessBle, canAccessNavigatorUsb } from '../../../../lib/ledger'
 import { useTranslation } from 'react-i18next'
-import TransportWebUSB from '@ledgerhq/hw-transport-webusb'
 import { runtimeIs } from 'app/lib/runtimeIs'
+import { runSaga } from 'redux-saga'
+import { getUSBTransport } from '../../../../state/importaccounts/saga'
 
 type SelectOpenMethodProps = {
   openLedgerAccessPopup?: () => void
@@ -38,7 +39,8 @@ export function FromLedger({ openLedgerAccessPopup }: SelectOpenMethodProps) {
       // prompt user to select a ledger device.
       // If TransportWebUSB.create() is rejected then call openLedgerAccessPopup. When user
       // confirms the prompt tell them to come back here. TransportWebUSB.create() will resolve.
-      TransportWebUSB.create()
+      runSaga({}, getUSBTransport)
+        .toPromise()
         .then(t => t.close())
         .then(() => setHasUsbLedgerAccess(true))
         .catch(() => setHasUsbLedgerAccess(false))

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))
 }
@@ -59,15 +71,20 @@ function* getBluetoothTransport(device?: ScanResult) {
   }
 }
 
-function* getUSBTransport() {
+export function* getUSBTransport() {
   const isSupported = yield* call([TransportWebUSB, TransportWebUSB.isSupported])
   if (!isSupported) {
     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',

src/types/typed-redux-runSaga.d.ts

@@ -0,0 +1,24 @@
+/** Improve types - based on typed-redux-saga's fork() */
+import { RunSagaOptions, Task } from 'redux-saga'
+// eslint-disable-next-line no-restricted-imports
+import { SagaReturnType } from 'redux-saga/effects'
+
+interface FixedTask<A> extends Task {
+  result: <T = A>() => T | undefined
+  toPromise: <T = A>() => Promise<T>
+}
+
+declare module 'redux-saga' {
+  /**
+   * Allows starting sagas outside the Redux middleware environment. Useful if you
+   * want to connect a Saga to external input/output, other than store actions.
+   *
+   * `runSaga` returns a Task object. Just like the one returned from a `fork`
+   * effect.
+   */
+  export function runSaga<Action, State, Args extends any[], Fn extends (...args: Args) => any>(
+    options: RunSagaOptions<Action, State>,
+    fn: Fn,
+    ...args: Args
+  ): FixedTask<SagaReturnType<Fn>>
+}