@onekeyfe/hd-core 1.2.0-alpha.14 → 1.2.0-alpha.16

package/__tests__/DeviceCommands.test.ts

@@ -1,6 +1,7 @@
 import { HardwareErrorCode } from '@onekeyfe/hd-shared';
 
 import { DeviceCommands } from '../src/device/DeviceCommands';
+import { DEVICE } from '../src/events';
 
 jest.mock('../src/data/config', () => ({
   getSDKVersion: jest.fn(() => '1.0.0'),
@@ -169,3 +170,79 @@ describe('DeviceCommands failure mapping', () => {
     });
   });
 });
+
+describe('DeviceCommands Protocol V2 interactive response compatibility', () => {
+  it('still auto-acks ButtonRequest when no hardware UI listener is registered', async () => {
+    const commands = createCommands();
+    commands.device = {
+      ...commands.device,
+      getCurrentDeviceType: jest.fn(() => 'pro2'),
+      setCancelableAction: jest.fn(),
+      emit: jest.fn(),
+      listenerCount: jest.fn(() => 0),
+    } as any;
+    commands._commonCall = jest.fn().mockResolvedValue({
+      type: 'Success',
+      message: {},
+    }) as any;
+
+    await expect(
+      commands._filterCommonTypes(
+        {
+          type: 'ButtonRequest',
+          message: { code: 'ButtonRequest_PinEntry' },
+        } as any,
+        'GetAddress'
+      )
+    ).resolves.toMatchObject({ type: 'Success' });
+
+    expect(commands.device.emit).toHaveBeenCalledWith(
+      DEVICE.BUTTON,
+      commands.device,
+      expect.objectContaining({ code: 'ButtonRequest_PinEntry' })
+    );
+    expect(commands._commonCall).toHaveBeenCalledWith('ButtonAck', {}, undefined);
+  });
+
+  it('rejects PassphraseRequest when the Pro2 UI listener is not registered', async () => {
+    const commands = createCommands();
+    commands.device = {
+      ...commands.device,
+      listenerCount: jest.fn(() => 0),
+    } as any;
+
+    await expect(
+      commands._filterCommonTypes(
+        {
+          type: 'PassphraseRequest',
+          message: { exists_attach_pin_user: true },
+        } as any,
+        'GetAddress'
+      )
+    ).rejects.toMatchObject({
+      errorCode: HardwareErrorCode.RuntimeError,
+      message: '_promptPassphrase: Passphrase callback not configured',
+    });
+  });
+
+  it('rejects PinMatrixRequest when the Pro2 UI listener is not registered', async () => {
+    const commands = createCommands();
+    commands.device = {
+      ...commands.device,
+      instanceId: 'pro2-test-device',
+      listenerCount: jest.fn(() => 0),
+    } as any;
+
+    await expect(
+      commands._filterCommonTypes(
+        {
+          type: 'PinMatrixRequest',
+          message: { type: 'PinMatrixRequestType_Current' },
+        } as any,
+        'GetAddress'
+      )
+    ).rejects.toMatchObject({
+      errorCode: HardwareErrorCode.RuntimeError,
+    });
+  });
+});

package/__tests__/DeviceEventRegistration.test.ts

@@ -0,0 +1,40 @@
+import { DEVICE } from '../src/events';
+import { registerHardwareUiEventListeners } from '../src/core/deviceEventRegistration';
+
+const handlers = {
+  pin: jest.fn(),
+  button: jest.fn(),
+  passphrase: jest.fn(),
+  passphraseOnDevice: jest.fn(),
+};
+
+const createDevice = (protocolV2: boolean) => ({
+  isProtocolV2: jest.fn(() => protocolV2),
+  on: jest.fn(),
+});
+
+describe('hardware UI event registration', () => {
+  test('keeps all interactive UI events for Protocol V2 devices during compatibility mode', () => {
+    const device = createDevice(true);
+
+    expect(registerHardwareUiEventListeners(device as any, handlers)).toBe(true);
+    expect(device.on.mock.calls.map(([type]) => type)).toEqual([
+      DEVICE.PIN,
+      DEVICE.BUTTON,
+      DEVICE.PASSPHRASE,
+      DEVICE.PASSPHRASE_ON_DEVICE,
+    ]);
+  });
+
+  test('keeps the existing interactive event listeners for Protocol V1 devices', () => {
+    const device = createDevice(false);
+
+    expect(registerHardwareUiEventListeners(device as any, handlers)).toBe(true);
+    expect(device.on.mock.calls.map(([type]) => type)).toEqual([
+      DEVICE.PIN,
+      DEVICE.BUTTON,
+      DEVICE.PASSPHRASE,
+      DEVICE.PASSPHRASE_ON_DEVICE,
+    ]);
+  });
+});

package/dist/core/deviceEventRegistration.d.ts

@@ -0,0 +1,10 @@
+import { DEVICE } from '../events';
+import type { Device, DeviceEvents } from '../device/Device';
+export type HardwareUiEventHandlers = {
+    pin: (...event: DeviceEvents[typeof DEVICE.PIN]) => void;
+    button: (...event: DeviceEvents[typeof DEVICE.BUTTON]) => void;
+    passphrase: (...event: DeviceEvents[typeof DEVICE.PASSPHRASE]) => void;
+    passphraseOnDevice: (...event: DeviceEvents[typeof DEVICE.PASSPHRASE_ON_DEVICE]) => void;
+};
+export declare function registerHardwareUiEventListeners(device: Pick<Device, 'on'>, handlers: HardwareUiEventHandlers): boolean;
+//# sourceMappingURL=deviceEventRegistration.d.ts.map

package/dist/core/deviceEventRegistration.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deviceEventRegistration.d.ts","sourceRoot":"","sources":["../../src/core/deviceEventRegistration.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAEnC,OAAO,KAAK,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAE7D,MAAM,MAAM,uBAAuB,GAAG;IACpC,GAAG,EAAE,CAAC,GAAG,KAAK,EAAE,YAAY,CAAC,OAAO,MAAM,CAAC,GAAG,CAAC,KAAK,IAAI,CAAC;IACzD,MAAM,EAAE,CAAC,GAAG,KAAK,EAAE,YAAY,CAAC,OAAO,MAAM,CAAC,MAAM,CAAC,KAAK,IAAI,CAAC;IAC/D,UAAU,EAAE,CAAC,GAAG,KAAK,EAAE,YAAY,CAAC,OAAO,MAAM,CAAC,UAAU,CAAC,KAAK,IAAI,CAAC;IACvE,kBAAkB,EAAE,CAAC,GAAG,KAAK,EAAE,YAAY,CAAC,OAAO,MAAM,CAAC,oBAAoB,CAAC,KAAK,IAAI,CAAC;CAC1F,CAAC;AAEF,wBAAgB,gCAAgC,CAC9C,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,EAC1B,QAAQ,EAAE,uBAAuB,WAOlC"}

package/dist/core/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/core/index.ts"],"names":[],"mappings":";AACA,OAAO,YAAY,MAAM,QAAQ,CAAC;AAoClC,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAkB1C,OAAO,eAAe,MAAM,2BAA2B,CAAC;AAKxD,OAAO,KAAK,EAAE,eAAe,EAAyB,MAAM,UAAU,CAAC;AACvE,OAAO,KAAK,EAAE,WAAW,EAAmD,MAAM,WAAW,CAAC;AAI9F,OAAO,KAAK,EAAE,6BAA6B,EAAoB,MAAM,wBAAwB,CAAC;AAW9F,MAAM,MAAM,WAAW,GAAG,UAAU,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC;AA+D7D,eAAO,MAAM,OAAO,YAAmB,WAAW,WAAW,WAAW,iBA6EvE,CAAC;AAyzBF,eAAO,MAAM,MAAM,YAAa,WAAW,cAAc,MAAM,SAkF9D,CAAC;AAiFF,eAAO,MAAM,qBAAqB,gFAejC,CAAC;AA0GF,MAAM,CAAC,OAAO,OAAO,IAAK,SAAQ,YAAY;IAC5C,OAAO,CAAC,cAAc,CAAoB;IAE1C,SAAgB,aAAa,EAAE,MAAM,CAAC;IAEtC,OAAO,CAAC,YAAY,CAAsB;IAG1C,OAAO,CAAC,qBAAqB,CAA4B;IAEzD,OAAO,CAAC,iBAAiB,CAAoB;;IAS7C,eAAe,CAAC,WAAW,EAAE,MAAM;IAInC,OAAO,CAAC,cAAc;IAoBhB,aAAa,CAAC,OAAO,EAAE,WAAW;IA+DxC,OAAO;CASR;AAED,eAAO,MAAM,QAAQ,YAGpB,CAAC;AAEF,eAAO,MAAM,aAAa,uBAIzB,CAAC;AAMF,eAAO,MAAM,IAAI,aACL,eAAe,aACd,GAAG,WACL,6BAA6B,8BAoBvC,CAAC;AAEF,eAAO,MAAM,eAAe;SAKrB,eAAe,CAAC,KAAK,CAAC;eAChB,GAAG;;UASf,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/core/index.ts"],"names":[],"mappings":";AACA,OAAO,YAAY,MAAM,QAAQ,CAAC;AAoClC,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAkB1C,OAAO,eAAe,MAAM,2BAA2B,CAAC;AAMxD,OAAO,KAAK,EAAE,eAAe,EAAyB,MAAM,UAAU,CAAC;AACvE,OAAO,KAAK,EAAE,WAAW,EAAmD,MAAM,WAAW,CAAC;AAI9F,OAAO,KAAK,EAAE,6BAA6B,EAAoB,MAAM,wBAAwB,CAAC;AAW9F,MAAM,MAAM,WAAW,GAAG,UAAU,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC;AA+D7D,eAAO,MAAM,OAAO,YAAmB,WAAW,WAAW,WAAW,iBA6EvE,CAAC;AA0zBF,eAAO,MAAM,MAAM,YAAa,WAAW,cAAc,MAAM,SAkF9D,CAAC;AAiFF,eAAO,MAAM,qBAAqB,gFAejC,CAAC;AA0GF,MAAM,CAAC,OAAO,OAAO,IAAK,SAAQ,YAAY;IAC5C,OAAO,CAAC,cAAc,CAAoB;IAE1C,SAAgB,aAAa,EAAE,MAAM,CAAC;IAEtC,OAAO,CAAC,YAAY,CAAsB;IAG1C,OAAO,CAAC,qBAAqB,CAA4B;IAEzD,OAAO,CAAC,iBAAiB,CAAoB;;IAS7C,eAAe,CAAC,WAAW,EAAE,MAAM;IAInC,OAAO,CAAC,cAAc;IAoBhB,aAAa,CAAC,OAAO,EAAE,WAAW;IA+DxC,OAAO;CASR;AAED,eAAO,MAAM,QAAQ,YAGpB,CAAC;AAEF,eAAO,MAAM,aAAa,uBAIzB,CAAC;AAMF,eAAO,MAAM,IAAI,aACL,eAAe,aACd,GAAG,WACL,6BAA6B,8BAoBvC,CAAC;AAEF,eAAO,MAAM,eAAe;SAKrB,eAAe,CAAC,KAAK,CAAC;eAChB,GAAG;;UASf,CAAC"}

package/dist/index.js

@@ -58169,6 +58169,14 @@ class RequestQueue {
     }
 }
 
+function registerHardwareUiEventListeners(device, handlers) {
+    device.on(DEVICE.PIN, handlers.pin);
+    device.on(DEVICE.BUTTON, handlers.button);
+    device.on(DEVICE.PASSPHRASE, handlers.passphrase);
+    device.on(DEVICE.PASSPHRASE_ON_DEVICE, handlers.passphraseOnDevice);
+    return true;
+}
+
 const getMutex = () => {
     const DEFAULT_ID = Symbol();
     const locks = {};
@@ -58445,10 +58453,14 @@ const onCallDevice = (context, message, method) => __awaiter(void 0, void 0, voi
     if (activeRequests.length > 0) {
         Log.warn(`[${method.instanceId}] Device ${device.instanceId} has ${activeRequests.length} active requests:`, activeRequests.map(formatRequestContext));
     }
-    device.on(DEVICE.PIN, onDevicePinHandler);
-    device.on(DEVICE.BUTTON, onDeviceButtonHandler);
-    device.on(DEVICE.PASSPHRASE, message.payload.useEmptyPassphrase ? onEmptyPassphraseHandler : onDevicePassphraseHandler);
-    device.on(DEVICE.PASSPHRASE_ON_DEVICE, onEnterPassphraseOnDeviceHandler);
+    registerHardwareUiEventListeners(device, {
+        pin: onDevicePinHandler,
+        button: onDeviceButtonHandler,
+        passphrase: message.payload.useEmptyPassphrase
+            ? onEmptyPassphraseHandler
+            : onDevicePassphraseHandler,
+        passphraseOnDevice: onEnterPassphraseOnDeviceHandler,
+    });
     device.on(DEVICE.FEATURES, onDeviceFeaturesHandler);
     device.on(DEVICE.SELECT_DEVICE_IN_BOOTLOADER_FOR_WEB_DEVICE, onSelectDeviceInBootloaderForWebDeviceHandler);
     device.on(DEVICE.SELECT_DEVICE_FOR_SWITCH_FIRMWARE_WEB_DEVICE, onSelectDeviceForSwitchFirmwareWebDeviceHandler);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@onekeyfe/hd-core",
-  "version": "1.2.0-alpha.14",
+  "version": "1.2.0-alpha.16",
   "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.2.0-alpha.14",
-    "@onekeyfe/hd-transport": "1.2.0-alpha.14",
+    "@onekeyfe/hd-shared": "1.2.0-alpha.16",
+    "@onekeyfe/hd-transport": "1.2.0-alpha.16",
     "axios": "1.15.2",
     "bignumber.js": "^9.0.2",
     "bytebuffer": "^5.0.1",
@@ -44,5 +44,5 @@
     "@types/w3c-web-usb": "^1.0.10",
     "@types/web-bluetooth": "^0.0.21"
   },
-  "gitHead": "c1edaed6435fb6049c7516c64b298ee62519e797"
+  "gitHead": "2356d951f63a39a46bc995c2090348a383966175"
 }

package/src/core/deviceEventRegistration.ts

@@ -0,0 +1,21 @@
+import { DEVICE } from '../events';
+
+import type { Device, DeviceEvents } from '../device/Device';
+
+export type HardwareUiEventHandlers = {
+  pin: (...event: DeviceEvents[typeof DEVICE.PIN]) => void;
+  button: (...event: DeviceEvents[typeof DEVICE.BUTTON]) => void;
+  passphrase: (...event: DeviceEvents[typeof DEVICE.PASSPHRASE]) => void;
+  passphraseOnDevice: (...event: DeviceEvents[typeof DEVICE.PASSPHRASE_ON_DEVICE]) => void;
+};
+
+export function registerHardwareUiEventListeners(
+  device: Pick<Device, 'on'>,
+  handlers: HardwareUiEventHandlers
+) {
+  device.on(DEVICE.PIN, handlers.pin);
+  device.on(DEVICE.BUTTON, handlers.button);
+  device.on(DEVICE.PASSPHRASE, handlers.passphrase);
+  device.on(DEVICE.PASSPHRASE_ON_DEVICE, handlers.passphraseOnDevice);
+  return true;
+}

package/src/core/index.ts

@@ -55,6 +55,7 @@ import {
 import TransportManager from '../data-manager/TransportManager';
 import DeviceConnector from '../device/DeviceConnector';
 import RequestQueue from './RequestQueue';
+import { registerHardwareUiEventListeners } from './deviceEventRegistration';
 import { getSynchronize } from '../utils/getSynchronize';
 import { runMethodWithUnlockRetry } from '../protocols/protocol-v2/unlockRetry';
 
@@ -395,13 +396,14 @@ const onCallDevice = async (
     );
   }
 
-  device.on(DEVICE.PIN, onDevicePinHandler);
-  device.on(DEVICE.BUTTON, onDeviceButtonHandler);
-  device.on(
-    DEVICE.PASSPHRASE,
-    message.payload.useEmptyPassphrase ? onEmptyPassphraseHandler : onDevicePassphraseHandler
-  );
-  device.on(DEVICE.PASSPHRASE_ON_DEVICE, onEnterPassphraseOnDeviceHandler);
+  registerHardwareUiEventListeners(device, {
+    pin: onDevicePinHandler,
+    button: onDeviceButtonHandler,
+    passphrase: message.payload.useEmptyPassphrase
+      ? onEmptyPassphraseHandler
+      : onDevicePassphraseHandler,
+    passphraseOnDevice: onEnterPassphraseOnDeviceHandler,
+  });
   device.on(DEVICE.FEATURES, onDeviceFeaturesHandler);
   device.on(
     DEVICE.SELECT_DEVICE_IN_BOOTLOADER_FOR_WEB_DEVICE,