@onekeyfe/hd-core 1.2.0-alpha.7 → 1.2.0-alpha.71

package/__tests__/device-connector-protocol.test.ts

@@ -0,0 +1,81 @@
+import { HardwareErrorCode } from '@onekeyfe/hd-shared';
+
+import DeviceConnector from '../src/device/DeviceConnector';
+
+jest.mock('../src/data-manager/TransportManager', () => ({
+  __esModule: true,
+  default: {
+    load: jest.fn(),
+    getTransport: jest.fn(),
+  },
+}));
+
+jest.mock('../src/data-manager', () => ({
+  DataManager: {
+    getSettings: jest.fn(() => 'desktop-web-ble'),
+    isBleConnect: jest.fn(() => true),
+  },
+}));
+
+jest.mock('../src/device/DevicePool', () => ({
+  DevicePool: {
+    setConnector: jest.fn(),
+  },
+}));
+
+const transportManagerMock: {
+  default: {
+    getTransport: jest.Mock;
+  };
+} = jest.requireMock('../src/data-manager/TransportManager');
+
+describe('DeviceConnector protocol validation', () => {
+  beforeEach(() => {
+    jest.clearAllMocks();
+  });
+
+  it('reports an explicit transport error when connector initialization ran too early', async () => {
+    transportManagerMock.default.getTransport.mockReturnValue(undefined);
+    const connector = new DeviceConnector();
+
+    await expect(connector.enumerate()).rejects.toMatchObject({
+      errorCode: HardwareErrorCode.TransportNotConfigured,
+    });
+  });
+
+  it('uses the actively probed protocol returned by acquire when the cache was cleared', async () => {
+    const acquire = jest.fn().mockResolvedValue({
+      id: 'pro2-id',
+      path: 'pro2-id',
+      protocolType: 'V2',
+    });
+    transportManagerMock.default.getTransport.mockReturnValue({
+      acquire,
+      getProtocolType: jest.fn(() => undefined),
+    });
+    const connector = new DeviceConnector();
+
+    await expect(connector.acquire('pro2-id', undefined, undefined, 'V2')).resolves.toEqual(
+      expect.objectContaining({ protocolType: 'V2' })
+    );
+    expect(acquire).toHaveBeenCalledWith(
+      expect.objectContaining({ uuid: 'pro2-id', expectedProtocol: 'V2' })
+    );
+  });
+
+  it('still rejects a real mismatch reported by the active protocol probe', async () => {
+    transportManagerMock.default.getTransport.mockReturnValue({
+      acquire: jest.fn().mockResolvedValue({
+        id: 'classic-id',
+        path: 'classic-id',
+        protocolType: 'V1',
+      }),
+      getProtocolType: jest.fn(() => 'V1'),
+    });
+    const connector = new DeviceConnector();
+
+    await expect(connector.acquire('classic-id', undefined, undefined, 'V2')).rejects.toThrow(
+      'Device protocol mismatch: expected V2, detected V1'
+    );
+  });
+});

package/__tests__/device-features-state.test.ts

@@ -0,0 +1,78 @@
+import { mergeDeviceFeaturesPatch } from '../src/device/DeviceFeaturesState';
+
+import type { Features } from '../src/types';
+
+const baseFeatures = {
+  protocol: 'V2',
+  deviceType: 'pro2',
+  firmwareType: 'universal',
+  model: 'pro2',
+  vendor: 'onekey.so',
+  deviceId: null,
+  serialNo: 'P20001',
+  label: 'Old Label',
+  bleName: 'Pro2 0001',
+  capabilities: [],
+  mode: 'normal',
+  initialized: true,
+  bootloaderMode: false,
+  unlocked: true,
+  firmwarePresent: true,
+  passphraseProtection: false,
+  pinProtection: true,
+  backupRequired: false,
+  noBackup: false,
+  unfinishedBackup: false,
+  recoveryMode: false,
+  language: 'en-US',
+  bleEnabled: true,
+  sdCardPresent: null,
+  sdProtection: null,
+  wipeCodeProtection: null,
+  passphraseAlwaysOnDevice: null,
+  safetyChecks: null,
+  autoLockDelayMs: 60_000,
+  displayRotation: null,
+  experimentalFeatures: false,
+  firmwareVersion: '1.0.0',
+  bootloaderVersion: '1.0.0',
+  boardVersion: '1.0.0',
+  bleVersion: '1.0.0',
+  sessionId: null,
+} as Features;
+
+describe('mergeDeviceFeaturesPatch', () => {
+  it('ignores undefined fields instead of clearing cached values', () => {
+    const next = mergeDeviceFeaturesPatch(baseFeatures, {
+      label: undefined,
+      language: 'ja-JP',
+    });
+
+    expect(next).toMatchObject({
+      label: 'Old Label',
+      language: 'ja-JP',
+    });
+  });
+
+  it('allows null to explicitly clear a cached value', () => {
+    const next = mergeDeviceFeaturesPatch(baseFeatures, { label: null });
+
+    expect(next.label).toBeNull();
+  });
+
+  it('returns the same object when no value changes', () => {
+    const next = mergeDeviceFeaturesPatch(baseFeatures, {
+      label: 'Old Label',
+      language: undefined,
+    });
+
+    expect(next).toBe(baseFeatures);
+  });
+
+  it('returns a new object when a defined value changes', () => {
+    const next = mergeDeviceFeaturesPatch(baseFeatures, { label: 'New Label' });
+
+    expect(next).not.toBe(baseFeatures);
+    expect(next.label).toBe('New Label');
+  });
+});

package/__tests__/device-identity.test.ts

@@ -0,0 +1,52 @@
+import { checkLiveDeviceId } from '../src/device/deviceIdentity';
+import ConfluxGetAddress from '../src/api/conflux/ConfluxGetAddress';
+import ConfluxSignMessage from '../src/api/conflux/ConfluxSignMessage';
+import ConfluxSignMessageCIP23 from '../src/api/conflux/ConfluxSignMessageCIP23';
+import ConfluxSignTransaction from '../src/api/conflux/ConfluxSignTransaction';
+import NexaSignTransaction from '../src/api/nexa/NexaSignTransaction';
+
+jest.mock('../src/data/config', () => ({
+  getSDKVersion: jest.fn(() => '1.0.0'),
+  DEFAULT_DOMAIN: 'https://jssdk.onekey.so/1.0.0/',
+}));
+
+describe('live device identity', () => {
+  test.each([
+    ['confluxGetAddress', ConfluxGetAddress],
+    ['confluxSignMessage', ConfluxSignMessage],
+    ['confluxSignMessageCIP23', ConfluxSignMessageCIP23],
+    ['confluxSignTransaction', ConfluxSignTransaction],
+    ['nexaSignTransaction', NexaSignTransaction],
+  ])('%s requires a live device id check', (methodName, Method) => {
+    const method = new Method({ payload: { method: methodName } });
+
+    expect(method.checkDeviceId).toBe(true);
+  });
+
+  test('refreshes Protocol V2 status before comparing the expected device id', async () => {
+    let currentDeviceId = 'OLD_DEVICE_ID';
+    const device = {
+      isProtocolV2: () => true,
+      getDeviceState: jest.fn().mockImplementation(() => {
+        currentDeviceId = 'NEW_DEVICE_ID';
+        return Promise.resolve({ identity: { deviceId: currentDeviceId } });
+      }),
+      checkDeviceId: jest.fn((expected: string) => currentDeviceId === expected),
+    };
+
+    await expect(checkLiveDeviceId(device as never, 'OLD_DEVICE_ID')).resolves.toBe(false);
+    expect(device.getDeviceState).toHaveBeenCalledWith({ refreshSections: ['status'] });
+    expect(device.checkDeviceId).toHaveBeenCalledWith('OLD_DEVICE_ID');
+  });
+
+  test('keeps Protocol V1 identity checks on the Initialize/GetFeatures state', async () => {
+    const device = {
+      isProtocolV2: () => false,
+      getDeviceState: jest.fn(),
+      checkDeviceId: jest.fn(() => true),
+    };
+
+    await expect(checkLiveDeviceId(device as never, 'V1_DEVICE_ID')).resolves.toBe(true);
+    expect(device.getDeviceState).not.toHaveBeenCalled();
+  });
+});

package/__tests__/device-initialize-timeout.test.ts

@@ -0,0 +1,56 @@
+import { Device } from '../src/device/Device';
+import TransportManager from '../src/data-manager/TransportManager';
+
+jest.mock('../src/data/config', () => ({
+  getSDKVersion: jest.fn(() => '1.0.0'),
+  DEFAULT_DOMAIN: 'https://jssdk.onekey.so/1.0.0/',
+}));
+
+function buildV1Device() {
+  const device = Object.create(Device.prototype) as Device;
+  const typedCall = jest.fn(() => Promise.resolve({ message: { device_id: 'device' } }));
+  Object.assign(device, {
+    commands: { typedCall },
+    stateStore: { getState: () => undefined },
+    isProtocolV2: () => false,
+    _updateFeatures: jest.fn(),
+    getInternalState: jest.fn(() => undefined),
+  });
+  return { device, typedCall };
+}
+
+describe('Device.initialize Protocol V1 timeout', () => {
+  beforeEach(() => {
+    jest.spyOn(TransportManager, 'reconfigure').mockResolvedValue(undefined);
+  });
+
+  afterEach(() => {
+    jest.restoreAllMocks();
+  });
+
+  test('passes a custom Initialize timeout through to typedCall', async () => {
+    const { device, typedCall } = buildV1Device();
+
+    await device.initialize({ timeoutMs: 2500 });
+
+    expect(typedCall).toHaveBeenCalledWith(
+      'Initialize',
+      'Features',
+      expect.objectContaining({ is_contains_attach: true }),
+      { timeoutMs: 2500 }
+    );
+  });
+
+  test('keeps the 25s Initialize timeout by default', async () => {
+    const { device, typedCall } = buildV1Device();
+
+    await device.initialize();
+
+    expect(typedCall).toHaveBeenCalledWith(
+      'Initialize',
+      'Features',
+      expect.objectContaining({ is_contains_attach: true }),
+      { timeoutMs: 25 * 1000 }
+    );
+  });
+});

package/__tests__/device-lifecycle-events.test.ts

@@ -0,0 +1,351 @@
+import { HardwareErrorCode } from '@onekeyfe/hd-shared';
+import { TRANSPORT_EVENT } from '@onekeyfe/hd-transport';
+
+import { initConnector, initCore } from '../src/core';
+import { DataManager } from '../src/data-manager';
+import TransportManager from '../src/data-manager/TransportManager';
+import { Device } from '../src/device/Device';
+import { DevicePool } from '../src/device/DevicePool';
+import { CORE_EVENT, DEVICE, IFRAME } from '../src/events';
+
+import type Core from '../src/core';
+import type { CoreMessage } from '../src/events';
+import type { KnownDevice } from '../src/types';
+
+jest.mock('../src/data/config', () => ({
+  getSDKVersion: jest.fn(() => '1.0.0-test'),
+  DEFAULT_DOMAIN: 'https://jssdk.onekey.so/1.0.0-test/',
+}));
+
+const createInitializedDevice = (protocol: 'V1' | 'V2') => {
+  const device = Device.fromDescriptor({
+    id: 'ble-discovery-id',
+    path: 'ble-discovery-id',
+    commType: 'ble',
+    protocolType: protocol,
+  } as never);
+  device.mainId = 'ble-connect-id';
+  device.features = {
+    protocol,
+    deviceType: protocol === 'V2' ? 'pro2' : 'classic',
+    firmwareType: 'universal',
+    deviceId: 'wallet-device-id',
+    serialNo: 'SERIAL-001',
+    label: 'OneKey Test',
+    bleName: 'OneKey Test BLE',
+    capabilities: [],
+    mode: 'normal',
+    initialized: true,
+    bootloaderMode: false,
+    firmwareVersion: '1.2.3',
+    bootloaderVersion: '1.0.0',
+    boardVersion: '1.0.0',
+    bleVersion: '2.3.4',
+  } as never;
+  return device;
+};
+
+describe('public device lifecycle events', () => {
+  let core: Core | undefined;
+
+  beforeEach(() => {
+    DevicePool.resetState();
+    jest.spyOn(TransportManager, 'load').mockImplementation();
+    TransportManager.transport = {
+      stop: jest.fn().mockResolvedValue(undefined),
+    } as never;
+  });
+
+  afterEach(async () => {
+    await core?.dispose();
+    core = undefined;
+    jest.restoreAllMocks();
+  });
+
+  test('registers the shared device lifecycle listeners exactly once', async () => {
+    jest.spyOn(DataManager, 'getSettings').mockReturnValue('react-native' as never);
+    core = initCore();
+    initConnector();
+
+    for (const id of ['first-call', 'second-call']) {
+      await core.handleMessage({
+        id,
+        event: IFRAME.CALL,
+        type: IFRAME.CALL,
+        payload: { method: 'clearSessionCache' },
+      } as CoreMessage);
+    }
+
+    expect(DevicePool.emitter.listenerCount(DEVICE.CONNECT)).toBe(1);
+    expect(DevicePool.emitter.listenerCount(DEVICE.DISCONNECT)).toBe(1);
+  });
+
+  test('keeps shared device lifecycle listeners across a device cache reset', () => {
+    jest.spyOn(DataManager, 'getSettings').mockReturnValue('react-native' as never);
+    core = initCore();
+    initConnector();
+    const messages: CoreMessage[] = [];
+    core.on(CORE_EVENT, message => messages.push(message));
+    const device = createInitializedDevice('V2');
+
+    DevicePool.resetState();
+    DevicePool.emitter.emit(DEVICE.CONNECT, device);
+    DevicePool.emitter.emit(DEVICE.DISCONNECT, device);
+
+    expect(messages.filter(message => message.type === DEVICE.CONNECT)).toHaveLength(1);
+    expect(messages.filter(message => message.type === DEVICE.DISCONNECT)).toHaveLength(1);
+  });
+
+  test('uses a verified cached protocol as a strict expected protocol', async () => {
+    jest.spyOn(DataManager, 'getSettings').mockReturnValue('react-native' as never);
+    const device = Device.fromDescriptor({
+      id: 'ble-id',
+      path: 'ble-id',
+      commType: 'ble',
+      protocolType: 'V1',
+    } as never);
+    const acquire = jest.fn().mockResolvedValue({ uuid: 'ble-id', protocolType: 'V1' });
+    device.deviceConnector = { acquire } as never;
+
+    await device.acquire();
+
+    expect(acquire).toHaveBeenCalledWith('ble-id', undefined, true, 'V1', undefined);
+    expect(device.getProtocol()).toBe('V1');
+    expect(device.originalDescriptor.protocolType).toBe('V1');
+  });
+
+  test('bypasses a cached protocol only for explicit active detection', async () => {
+    jest.spyOn(DataManager, 'getSettings').mockReturnValue('react-native' as never);
+    const device = Device.fromDescriptor({
+      id: 'ble-id',
+      path: 'ble-id',
+      commType: 'ble',
+      protocolType: 'V1',
+    } as never);
+    const acquire = jest.fn().mockResolvedValue({ uuid: 'ble-id', protocolType: 'V2' });
+    device.deviceConnector = { acquire } as never;
+
+    await device.acquire(undefined, { forceProtocolDetection: true });
+
+    expect(acquire).toHaveBeenCalledWith('ble-id', undefined, true, undefined, undefined);
+    expect(device.getProtocol()).toBe('V2');
+    expect(device.originalDescriptor.protocolType).toBe('V2');
+  });
+
+  test('does not reuse a stale protocol when active detection returns no protocol', async () => {
+    jest.spyOn(DataManager, 'getSettings').mockReturnValue('react-native' as never);
+    const device = Device.fromDescriptor({
+      id: 'ble-id',
+      path: 'ble-id',
+      commType: 'ble',
+      protocolType: 'V1',
+    } as never);
+    const acquire = jest.fn().mockResolvedValue({ uuid: 'ble-id' });
+    const release = jest.fn().mockResolvedValue(undefined);
+    device.deviceConnector = { acquire, release } as never;
+    await expect(
+      device.acquire(undefined, {
+        forceProtocolDetection: true,
+        throwOnRunPromiseError: true,
+      })
+    ).rejects.toMatchObject({ errorCode: HardwareErrorCode.RuntimeError });
+    expect(device.originalDescriptor.protocolType).toBe('V1');
+    expect(device.hasDeviceAcquire()).toBe(false);
+    expect(release).toHaveBeenCalledWith('ble-id', false);
+  });
+
+  test('actively reacquires an already connected device without initializing it', async () => {
+    jest.spyOn(DataManager, 'getSettings').mockReturnValue('webusb' as never);
+    const device = Device.fromDescriptor({
+      id: 'usb-device',
+      path: 'usb-device',
+      session: 'old-session',
+      protocolType: 'V1',
+    } as never);
+    device.mainId = 'old-session';
+    device.commands = { disposed: false } as never;
+    const release = jest.spyOn(device, 'release').mockImplementation(() => {
+      device.mainId = null;
+      device.originalDescriptor.session = null;
+      device.commands.disposed = true;
+      return Promise.resolve();
+    });
+    const acquire = jest.spyOn(device, 'acquire').mockImplementation(() => {
+      device.mainId = 'new-session';
+      device.originalDescriptor.session = 'new-session';
+      device.originalDescriptor.protocolType = 'V2';
+      device.commands.disposed = false;
+      return Promise.resolve();
+    });
+    const initialize = jest.spyOn(device, 'initialize').mockResolvedValue(undefined);
+
+    await device.run(() => Promise.resolve(undefined), {
+      forceProtocolDetection: true,
+      skipInitialize: true,
+    });
+
+    expect(release).toHaveBeenCalled();
+    expect(acquire).toHaveBeenCalledWith(undefined, {
+      forceProtocolDetection: true,
+    });
+    expect(initialize).not.toHaveBeenCalled();
+    expect(device.getProtocol()).toBe('V2');
+  });
+
+  test('keeps the freshly probed React Native BLE session until the call completes', async () => {
+    jest.spyOn(DataManager, 'getSettings').mockReturnValue('react-native' as never);
+    const device = Device.fromDescriptor({
+      id: 'ble-device',
+      path: 'ble-device',
+      commType: 'ble',
+      protocolType: 'V1',
+    } as never);
+    device.mainId = 'ble-device';
+    device.commands = { disposed: false } as never;
+    (device as unknown as { deviceAcquired: boolean }).deviceAcquired = true;
+    const release = jest.spyOn(device, 'release').mockResolvedValue(undefined);
+    const run = jest.fn().mockResolvedValue(undefined);
+
+    await device.run(run, {
+      forceProtocolDetection: true,
+      skipInitialize: true,
+    });
+
+    expect(run).toHaveBeenCalledTimes(1);
+    expect(release).toHaveBeenCalledTimes(1);
+  });
+
+  test('keeps an explicit connectProtocol as a strict expected protocol', async () => {
+    jest.spyOn(DataManager, 'getSettings').mockReturnValue('react-native' as never);
+    const device = Device.fromDescriptor({
+      id: 'ble-id',
+      path: 'ble-id',
+      commType: 'ble',
+      protocolType: 'V1',
+    } as never);
+    const acquire = jest.fn().mockResolvedValue({ uuid: 'ble-id', protocolType: 'V2' });
+    device.deviceConnector = { acquire } as never;
+
+    await device.acquire('V2');
+
+    expect(acquire).toHaveBeenCalledWith('ble-id', undefined, true, 'V2', undefined);
+    expect(device.getProtocol()).toBe('V2');
+  });
+
+  test('converts an internal transport disconnect into a public KnownDevice snapshot', () => {
+    jest.spyOn(DataManager, 'getSettings').mockReturnValue('react-native' as never);
+    core = initCore();
+    initConnector();
+    const messages: CoreMessage[] = [];
+    core.on(CORE_EVENT, message => messages.push(message));
+    const device = createInitializedDevice('V2');
+    DevicePool.devicesCache['ble-connect-id'] = device;
+
+    DevicePool.emitter.emit(TRANSPORT_EVENT.DEVICE_DISCONNECT, {
+      id: 'ble-connect-id',
+      connectId: 'ble-connect-id',
+      name: 'OneKey Test BLE',
+    });
+
+    const disconnectMessage = messages.find(message => message.type === DEVICE.DISCONNECT);
+    expect(disconnectMessage?.payload.device).toMatchObject({
+      connectId: 'ble-connect-id',
+      serialNo: 'SERIAL-001',
+      state: { protocol: 'V2' },
+    });
+    expect(() => JSON.stringify(disconnectMessage?.payload.device)).not.toThrow();
+  });
+
+  test('treats an acquired BLE device as reusable until the transport disconnects', async () => {
+    jest.spyOn(DataManager, 'getSettings').mockReturnValue('desktop-web-ble' as never);
+    const device = createInitializedDevice('V2');
+    const acquire = jest.spyOn(device, 'acquire').mockResolvedValue(undefined);
+    (device as unknown as { deviceAcquired: boolean }).deviceAcquired = true;
+    (device as any).commands = { disposed: false };
+
+    expect(device.isUsedHere()).toBe(true);
+    await expect(device.connect('V2')).resolves.toBe(true);
+    expect(acquire).not.toHaveBeenCalled();
+
+    device.markTransportDisconnected();
+    expect(device.isUsedHere()).toBe(false);
+  });
+
+  test('exposes the current transport usage state in public device snapshots', () => {
+    const getSettings = jest
+      .spyOn(DataManager, 'getSettings')
+      .mockReturnValue('desktop-web-ble' as never);
+    const device = createInitializedDevice('V2');
+
+    expect(device.toMessageObject()?.status).toBe('available');
+    expect(device.toMessageObject()?.connectProtocol).toBe('V2');
+
+    (device as unknown as { deviceAcquired: boolean }).deviceAcquired = true;
+    expect(device.toMessageObject()?.status).toBe('used');
+
+    device.markTransportDisconnected();
+    expect(device.toMessageObject()?.status).toBe('available');
+
+    getSettings.mockReturnValue('web' as never);
+    device.originalDescriptor.session = 'external-session';
+    expect(device.toMessageObject()?.status).toBe('occupied');
+  });
+
+  test.each([
+    ['react-native', 'V1'],
+    ['react-native', 'V2'],
+    ['lowlevel', 'V1'],
+    ['lowlevel', 'V2'],
+  ] as const)(
+    'emits KnownDevice snapshots for %s Protocol %s connect and disconnect events',
+    async (env, protocol) => {
+      jest.spyOn(DataManager, 'getSettings').mockReturnValue(env as never);
+      core = initCore();
+      initConnector();
+
+      await core.handleMessage({
+        id: 'register-device-connect-listener',
+        event: IFRAME.CALL,
+        type: IFRAME.CALL,
+        payload: { method: 'clearSessionCache' },
+      } as CoreMessage);
+
+      const messages: CoreMessage[] = [];
+      core.on(CORE_EVENT, message => messages.push(message));
+      const internalDevice = createInitializedDevice(protocol);
+
+      DevicePool.emitter.emit(DEVICE.CONNECT, internalDevice);
+      internalDevice.updateState({ identity: { label: 'Updated label' } }, 'settings-write');
+      DevicePool.emitter.emit(DEVICE.DISCONNECT, internalDevice);
+
+      const connectMessage = messages.find(message => message.type === DEVICE.CONNECT);
+      const disconnectMessage = messages.find(message => message.type === DEVICE.DISCONNECT);
+      const connectedDevice = connectMessage?.payload.device as KnownDevice;
+      const disconnectedDevice = disconnectMessage?.payload.device as KnownDevice;
+
+      expect(connectedDevice).toMatchObject({
+        connectId: 'ble-connect-id',
+        serialNo: 'SERIAL-001',
+        uuid: 'SERIAL-001',
+        status: 'available',
+        label: 'OneKey Test',
+        state: { protocol },
+      });
+      expect(disconnectedDevice).toMatchObject({
+        connectId: 'ble-connect-id',
+        serialNo: 'SERIAL-001',
+        uuid: 'SERIAL-001',
+        status: 'available',
+        label: 'Updated label',
+        state: { protocol },
+      });
+      expect(connectedDevice).not.toBe(internalDevice);
+      expect(connectedDevice).not.toBe(disconnectedDevice);
+      expect(connectedDevice).not.toHaveProperty('run');
+      expect(connectedDevice).not.toHaveProperty('acquire');
+      expect(connectedDevice).not.toHaveProperty('commands');
+      expect(() => JSON.stringify(connectedDevice)).not.toThrow();
+      expect(connectedDevice.label).toBe('OneKey Test');
+    }
+  );
+});