fix: switch firmware using new tips (#633)

Author: wabicai

packages/connect-examples/electron-example/package.json

@@ -2,7 +2,7 @@
   "name": "hardware-example",
   "productName": "HardwareExample",
   "executableName": "onekey-hardware-example",
-  "version": "1.1.21-alpha.2",
+  "version": "1.1.21-alpha.3",
   "author": "OneKey",
   "description": "End-to-end encrypted workspaces for teams",
   "main": "dist/index.js",
@@ -22,7 +22,7 @@
     "ts:check": "yarn tsc --noEmit"
   },
   "dependencies": {
-    "@onekeyfe/hd-transport-electron": "1.1.21-alpha.2",
+    "@onekeyfe/hd-transport-electron": "1.1.21-alpha.3",
     "@stoprocent/noble": "2.3.4",
     "debug": "4.3.4",
     "electron-is-dev": "^3.0.1",

packages/connect-examples/expo-example/package.json

@@ -1,6 +1,6 @@
 {
   "name": "expo-example",
-  "version": "1.1.21-alpha.2",
+  "version": "1.1.21-alpha.3",
   "scripts": {
     "start": "cross-env CONNECT_SRC=https://localhost:8087/ yarn expo start --dev-client",
     "android": "yarn expo run:android",
@@ -19,10 +19,10 @@
     "@noble/ed25519": "^2.1.0",
     "@noble/hashes": "^1.3.3",
     "@noble/secp256k1": "^1.7.1",
-    "@onekeyfe/hd-ble-sdk": "1.1.21-alpha.2",
-    "@onekeyfe/hd-common-connect-sdk": "1.1.21-alpha.2",
-    "@onekeyfe/hd-core": "1.1.21-alpha.2",
-    "@onekeyfe/hd-web-sdk": "1.1.21-alpha.2",
+    "@onekeyfe/hd-ble-sdk": "1.1.21-alpha.3",
+    "@onekeyfe/hd-common-connect-sdk": "1.1.21-alpha.3",
+    "@onekeyfe/hd-core": "1.1.21-alpha.3",
+    "@onekeyfe/hd-web-sdk": "1.1.21-alpha.3",
     "@onekeyfe/react-native-ble-utils": "^0.1.3",
     "@polkadot/util-crypto": "13.1.1",
     "@react-native-async-storage/async-storage": "1.21.0",

packages/connect-examples/expo-example/src/components/HandleSDKEvents.tsx

@@ -44,6 +44,10 @@ export default function HandleSDKEvents() {
   const { sdk: SDK, lowLevelSDK: HardwareLowLevelSDK, type } = useContext(HardwareSDKContext);
   const [showPinInput, setShowPinInput] = useState(false);
   const [showWebUsbAuthorize, setShowWebUsbAuthorize] = useState(false);
+  const [webUsbResponseType, setWebUsbResponseType] = useState<
+    | typeof UI_RESPONSE.SELECT_DEVICE_IN_BOOTLOADER_FOR_WEB_DEVICE
+    | typeof UI_RESPONSE.SELECT_DEVICE_FOR_SWITCH_FIRMWARE_WEB_DEVICE
+  >(UI_RESPONSE.SELECT_DEVICE_IN_BOOTLOADER_FOR_WEB_DEVICE);
   const [showBluetoothPermission, setShowBluetoothPermission] = useState(false);
   const [bluetoothErrorType, setBluetoothErrorType] = useState<BluetoothErrorType>('permission');
 
@@ -73,13 +77,13 @@ export default function HandleSDKEvents() {
     (device: USBDevice) => {
       console.log('webUsbSuccess: ', device);
       SDK?.uiResponse({
-        type: UI_RESPONSE.SELECT_DEVICE_IN_BOOTLOADER_FOR_WEB_DEVICE,
+        type: webUsbResponseType,
         payload: {
           deviceId: device.serialNumber ?? '',
         },
       });
     },
-    [SDK]
+    [SDK, webUsbResponseType]
   );
 
   const onWebUsbCancel = useCallback(() => {
@@ -155,6 +159,11 @@ export default function HandleSDKEvents() {
           }, 2000);
         }
         if (message.type === UI_REQUEST.REQUEST_DEVICE_IN_BOOTLOADER_FOR_WEB_DEVICE) {
+          setWebUsbResponseType(UI_RESPONSE.SELECT_DEVICE_IN_BOOTLOADER_FOR_WEB_DEVICE);
+          setShowWebUsbAuthorize(true);
+        }
+        if (message.type === UI_REQUEST.REQUEST_DEVICE_FOR_SWITCH_FIRMWARE_WEB_DEVICE) {
+          setWebUsbResponseType(UI_RESPONSE.SELECT_DEVICE_FOR_SWITCH_FIRMWARE_WEB_DEVICE);
           setShowWebUsbAuthorize(true);
         }
         if (message.type === UI_REQUEST.BLUETOOTH_POWERED_OFF) {

packages/connect-examples/expo-playground/app/components/providers/SDKProvider.tsx

@@ -53,6 +53,10 @@ export const SDKProvider: React.FC<SDKProviderProps> = ({ children }) => {
   const { setDeviceAction, clearDeviceAction, updateSdkInitState } = useDeviceStore();
   const initializationRef = useRef<boolean>(false);
   const [webUsbModalOpen, setWebUsbModalOpen] = React.useState(false);
+  const [webUsbResponseType, setWebUsbResponseType] = React.useState<
+    | typeof UI_RESPONSE.SELECT_DEVICE_IN_BOOTLOADER_FOR_WEB_DEVICE
+    | typeof UI_RESPONSE.SELECT_DEVICE_FOR_SWITCH_FIRMWARE_WEB_DEVICE
+  >(UI_RESPONSE.SELECT_DEVICE_IN_BOOTLOADER_FOR_WEB_DEVICE);
   const lastSdkRef = useRef<CoreApi | null>(null);
 
   const setupSDKEventListeners = useCallback(
@@ -108,6 +112,12 @@ export const SDKProvider: React.FC<SDKProviderProps> = ({ children }) => {
 
           case UI_REQUEST.REQUEST_DEVICE_IN_BOOTLOADER_FOR_WEB_DEVICE: {
             // Open modal; actual requestDevice() will be called in button onClick handler to satisfy user gesture
+            setWebUsbResponseType(UI_RESPONSE.SELECT_DEVICE_IN_BOOTLOADER_FOR_WEB_DEVICE);
+            setWebUsbModalOpen(true);
+            break;
+          }
+          case UI_REQUEST.REQUEST_DEVICE_FOR_SWITCH_FIRMWARE_WEB_DEVICE: {
+            setWebUsbResponseType(UI_RESPONSE.SELECT_DEVICE_FOR_SWITCH_FIRMWARE_WEB_DEVICE);
             setWebUsbModalOpen(true);
             break;
           }
@@ -214,13 +224,13 @@ export const SDKProvider: React.FC<SDKProviderProps> = ({ children }) => {
         open={webUsbModalOpen}
         onOpenChange={setWebUsbModalOpen}
         onSuccess={device => {
-          logInfo('WebUSB device selected for bootloader (modal)', {
+          logInfo('WebUSB device selected (modal)', {
             serialNumber: device?.serialNumber ?? '',
             vendorId: device?.vendorId,
             productId: device?.productId,
           });
           lastSdkRef.current?.uiResponse({
-            type: UI_RESPONSE.SELECT_DEVICE_IN_BOOTLOADER_FOR_WEB_DEVICE,
+            type: webUsbResponseType,
             payload: { deviceId: device?.serialNumber ?? '' },
           });
         }}

packages/connect-examples/expo-playground/app/components/ui/DeviceActionAnimation.tsx

@@ -86,6 +86,7 @@ const DeviceActionAnimation: React.FC<DeviceActionAnimationProps> = ({
 
       case UI_REQUEST.REQUEST_PIN:
       case UI_REQUEST.REQUEST_DEVICE_IN_BOOTLOADER_FOR_WEB_DEVICE:
+      case UI_REQUEST.REQUEST_DEVICE_FOR_SWITCH_FIRMWARE_WEB_DEVICE:
         switch (deviceModel) {
           case 'classic':
             return enterPinOnClassic;

packages/connect-examples/expo-playground/package.json

@@ -1,6 +1,6 @@
 {
   "name": "onekey-hardware-playground",
-  "version": "1.1.21-alpha.2",
+  "version": "1.1.21-alpha.3",
   "private": true,
   "sideEffects": [
     "app/utils/shim.js",
@@ -17,9 +17,9 @@
   },
   "dependencies": {
     "@noble/hashes": "^1.8.0",
-    "@onekeyfe/hd-common-connect-sdk": "1.1.21-alpha.2",
-    "@onekeyfe/hd-core": "1.1.21-alpha.2",
-    "@onekeyfe/hd-shared": "1.1.21-alpha.2",
+    "@onekeyfe/hd-common-connect-sdk": "1.1.21-alpha.3",
+    "@onekeyfe/hd-core": "1.1.21-alpha.3",
+    "@onekeyfe/hd-shared": "1.1.21-alpha.3",
     "@radix-ui/react-checkbox": "^1.3.2",
     "@radix-ui/react-dialog": "^1.1.14",
     "@radix-ui/react-dropdown-menu": "^2.1.15",

packages/core/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@onekeyfe/hd-core",
-  "version": "1.1.21-alpha.2",
+  "version": "1.1.21-alpha.3",
   "description": "Core processes and APIs for communicating with OneKey hardware devices.",
   "author": "OneKey",
   "homepage": "https://github.com/OneKeyHQ/hardware-js-sdk#readme",
@@ -25,8 +25,8 @@
     "url": "https://github.com/OneKeyHQ/hardware-js-sdk/issues"
   },
   "dependencies": {
-    "@onekeyfe/hd-shared": "1.1.21-alpha.2",
-    "@onekeyfe/hd-transport": "1.1.21-alpha.2",
+    "@onekeyfe/hd-shared": "1.1.21-alpha.3",
+    "@onekeyfe/hd-transport": "1.1.21-alpha.3",
     "axios": "1.12.2",
     "bignumber.js": "^9.0.2",
     "bytebuffer": "^5.0.1",

packages/core/src/api/FirmwareUpdateV3.ts

@@ -41,6 +41,8 @@ export const MIN_UPDATE_V3_BOOTLOADER_VERSION = '2.8.0';
 export default class FirmwareUpdateV3 extends FirmwareUpdateBaseMethod<FirmwareUpdateV3Params> {
   checkPromise: Deferred<any> | null = null;
 
+  private isSwitchFirmware = false;
+
   init() {
     this.allowDeviceMode = [UI_REQUEST.BOOTLOADER, UI_REQUEST.NOT_INITIALIZE];
     this.requireDeviceMode = [];
@@ -91,6 +93,7 @@ export default class FirmwareUpdateV3 extends FirmwareUpdateBaseMethod<FirmwareU
 
     const deviceFirmwareType = getFirmwareType(features);
     const firmwareType = this.params.firmwareType ?? deviceFirmwareType;
+    this.isSwitchFirmware = firmwareType !== deviceFirmwareType;
 
     let resourceBinary: ArrayBuffer | null = null;
     let fwBinaryMap: { fileName: string; binary: ArrayBuffer }[] = [];
@@ -468,6 +471,17 @@ export default class FirmwareUpdateV3 extends FirmwareUpdateBaseMethod<FirmwareU
     return '';
   }
 
+  private canPromptWebUsbSwitchFirmwareReconnect(): boolean {
+    if (!this.isSwitchFirmware) {
+      return false;
+    }
+    return (
+      DataManager.isBrowserWebUsb(DataManager.getSettings('env')) &&
+      !this.payload.skipWebDevicePrompt &&
+      this.device.listenerCount(DEVICE.SELECT_DEVICE_FOR_SWITCH_FIRMWARE_WEB_DEVICE) > 0
+    );
+  }
+
   /**
    * @description Reconnect device - While update with bootloader, it will reconnect device
    * @param {number} timeout - The timeout for the reconnection
@@ -503,17 +517,14 @@ export default class FirmwareUpdateV3 extends FirmwareUpdateBaseMethod<FirmwareU
           const deviceDiff = await this.device.deviceConnector?.enumerate();
           const devicesDescriptor = deviceDiff?.descriptors ?? [];
 
-          const canPromptWebUsbBootloader =
-            DataManager.isBrowserWebUsb(DataManager.getSettings('env')) &&
-            !this.payload.skipWebDevicePrompt &&
-            this.device.listenerCount(DEVICE.SELECT_DEVICE_IN_BOOTLOADER_FOR_WEB_DEVICE) > 0;
+          const canPromptSwitchFirmwareReconnect = this.canPromptWebUsbSwitchFirmwareReconnect();
 
-          if (canPromptWebUsbBootloader) {
+          if (canPromptSwitchFirmwareReconnect) {
             webUsbCheckCount += 1;
             if (webUsbCheckCount > 4) {
-              this.postTipMessage(FirmwareUpdateTipMessage.SelectDeviceInBootloaderForWebDevice);
+              this.postTipMessage(FirmwareUpdateTipMessage.SwitchFirmwareReconnectDevice);
               try {
-                await this._promptDeviceInBootloaderForWebDevice();
+                await this._promptDeviceForSwitchFirmwareWebDevice();
               } catch (e) {
                 Log.log('WebUSB re-authorization failed: ', e);
               }

packages/core/src/api/firmware/FirmwareUpdateBaseMethod.ts

@@ -110,6 +110,24 @@ export class FirmwareUpdateBaseMethod<Params> extends BaseMethod<Params> {
     });
   }
 
+  protected async _promptDeviceForSwitchFirmwareWebDevice() {
+    return new Promise((resolve, reject) => {
+      if (this.device.listenerCount(DEVICE.SELECT_DEVICE_FOR_SWITCH_FIRMWARE_WEB_DEVICE) > 0) {
+        this.device.emit(
+          DEVICE.SELECT_DEVICE_FOR_SWITCH_FIRMWARE_WEB_DEVICE,
+          this.device,
+          (err, deviceId) => {
+            if (err) {
+              reject(err);
+            } else {
+              resolve(deviceId);
+            }
+          }
+        );
+      }
+    });
+  }
+
   checkDeviceToBootloader(connectId: string | undefined) {
     this.checkPromise = createDeferred();
     const env = DataManager.getSettings('env');

packages/core/src/core/index.ts

@@ -323,6 +323,10 @@ const onCallDevice = async (
     DEVICE.SELECT_DEVICE_IN_BOOTLOADER_FOR_WEB_DEVICE,
     onSelectDeviceInBootloaderForWebDeviceHandler
   );
+  device.on(
+    DEVICE.SELECT_DEVICE_FOR_SWITCH_FIRMWARE_WEB_DEVICE,
+    onSelectDeviceForSwitchFirmwareWebDeviceHandler
+  );
 
   try {
     if (method.connectId) {
@@ -1098,6 +1102,23 @@ const onSelectDeviceInBootloaderForWebDeviceHandler = async (
   callback(null, uiResp.payload.deviceId);
 };
 
+const onSelectDeviceForSwitchFirmwareWebDeviceHandler = async (
+  ...[device, callback]: [...DeviceEvents['select_device_for_switch_firmware_web_device']]
+) => {
+  Log.debug('onSelectDeviceForSwitchFirmwareWebDeviceHandler');
+  const uiPromise = createUiPromise(
+    UI_RESPONSE.SELECT_DEVICE_FOR_SWITCH_FIRMWARE_WEB_DEVICE,
+    device
+  );
+  postMessage(
+    createUiMessage(UI_REQUEST.REQUEST_DEVICE_FOR_SWITCH_FIRMWARE_WEB_DEVICE, {
+      device: device.toMessageObject() as KnownDevice,
+    })
+  );
+  const uiResp = await uiPromise.promise;
+  callback(null, uiResp.payload.deviceId);
+};
+
 /**
  * Emit message to listener (parent).
  * Clear method reference from _callMethods
@@ -1169,7 +1190,8 @@ export default class Core extends EventEmitter {
     switch (message.type) {
       case UI_RESPONSE.RECEIVE_PIN:
       case UI_RESPONSE.RECEIVE_PASSPHRASE:
-      case UI_RESPONSE.SELECT_DEVICE_IN_BOOTLOADER_FOR_WEB_DEVICE: {
+      case UI_RESPONSE.SELECT_DEVICE_IN_BOOTLOADER_FOR_WEB_DEVICE:
+      case UI_RESPONSE.SELECT_DEVICE_FOR_SWITCH_FIRMWARE_WEB_DEVICE: {
         const uiPromise = findUiPromise(message.type);
         if (uiPromise) {
           Log.log('receive UI Response: ', message.type);