@onekeyfe/hd-core 1.2.0-alpha.2 → 1.2.0-alpha.21

package/__tests__/device-wallet-session-store.test.ts

@@ -0,0 +1,213 @@
+import ClearSessionCache from '../src/api/ClearSessionCache';
+import {
+  DeviceWalletSessionStore,
+  deviceWalletSessionStore,
+} from '../src/device/DeviceWalletSessionStore';
+import { Device } from '../src/device/Device';
+import { createCoreApi } from '../src/inject';
+
+jest.mock('../src/data/config', () => ({
+  getSDKVersion: jest.fn(() => '1.0.0'),
+  DEFAULT_DOMAIN: 'https://jssdk.onekey.so/1.0.0/',
+}));
+
+describe('DeviceWalletSessionStore', () => {
+  test('requires passphraseState for wallet session lookup', () => {
+    const store = new DeviceWalletSessionStore();
+    store.set('device-1', 'hidden-a', 'session-a');
+
+    expect(store.get('device-1', undefined)).toBeUndefined();
+    expect(store.get('device-1', 'hidden-a')).toBe('session-a');
+  });
+
+  test('isolates wallets and devices', () => {
+    const store = new DeviceWalletSessionStore();
+    store.set('device-1', 'hidden-a', 'session-a');
+    store.set('device-1', 'hidden-b', 'session-b');
+    store.set('device-2', 'hidden-a', 'session-c');
+
+    expect(store.get('device-1', 'hidden-a')).toBe('session-a');
+    expect(store.get('device-1', 'hidden-b')).toBe('session-b');
+    expect(store.get('device-2', 'hidden-a')).toBe('session-c');
+  });
+
+  test('keeps pending sessions unreadable until wallet binding', () => {
+    const store = new DeviceWalletSessionStore();
+    store.setPending('device-1', 'pending-session');
+
+    expect(store.get('device-1', undefined)).toBeUndefined();
+    expect(store.getPending('device-1')).toBe('pending-session');
+  });
+
+  test('migrates descriptor keys to stable device ids', () => {
+    const store = new DeviceWalletSessionStore();
+    store.set('ble-path', 'hidden-a', 'session-a');
+    store.setPending('ble-path', 'pending-session');
+
+    store.reconcileDeviceIdentity({
+      temporaryKey: 'ble-path',
+      nextDeviceId: 'stable-device-id',
+    });
+
+    expect(store.get('ble-path', 'hidden-a')).toBeUndefined();
+    expect(store.get('stable-device-id', 'hidden-a')).toBe('session-a');
+    expect(store.getPending('ble-path')).toBeUndefined();
+    expect(store.getPending('stable-device-id')).toBe('pending-session');
+  });
+
+  test('drops sessions from an old stable identity without overwriting the new device', () => {
+    const store = new DeviceWalletSessionStore();
+    store.set('device-a', 'hidden-a', 'session-a');
+    store.setPending('device-a', 'pending-a');
+    store.set('device-b', 'hidden-a', 'session-b');
+    store.setPending('device-b', 'pending-b');
+
+    store.reconcileDeviceIdentity({
+      temporaryKey: 'ble-path',
+      previousDeviceId: 'device-a',
+      nextDeviceId: 'device-b',
+    });
+
+    expect(store.get('device-a', 'hidden-a')).toBeUndefined();
+    expect(store.getPending('device-a')).toBeUndefined();
+    expect(store.get('device-b', 'hidden-a')).toBe('session-b');
+    expect(store.getPending('device-b')).toBe('pending-b');
+  });
+
+  test('clears one wallet, one device, or all sessions', () => {
+    const store = new DeviceWalletSessionStore();
+    store.set('device-1', 'hidden-a', 'session-a');
+    store.set('device-1', 'hidden-b', 'session-b');
+    store.set('device-2', 'hidden-a', 'session-c');
+
+    store.delete('device-1', 'hidden-a');
+    expect(store.get('device-1', 'hidden-a')).toBeUndefined();
+    expect(store.get('device-1', 'hidden-b')).toBe('session-b');
+
+    store.deleteDevice('device-1');
+    expect(store.get('device-1', 'hidden-b')).toBeUndefined();
+    expect(store.get('device-2', 'hidden-a')).toBe('session-c');
+
+    store.clear();
+    expect(store.get('device-2', 'hidden-a')).toBeUndefined();
+  });
+});
+
+describe('ClearSessionCache', () => {
+  beforeEach(() => {
+    deviceWalletSessionStore.clear();
+  });
+
+  test('uses DeviceWalletSessionStore as the only cache source', async () => {
+    deviceWalletSessionStore.set('device-1', 'hidden-a', 'session-a');
+    deviceWalletSessionStore.set('device-2', 'hidden-a', 'session-b');
+
+    const method = new ClearSessionCache({
+      payload: {
+        method: 'clearSessionCache',
+        deviceId: 'device-1',
+        passphraseState: 'hidden-a',
+      },
+    });
+    method.init();
+    await method.run();
+
+    expect(deviceWalletSessionStore.get('device-1', 'hidden-a')).toBeUndefined();
+    expect(deviceWalletSessionStore.get('device-2', 'hidden-a')).toBe('session-b');
+  });
+
+  test('keeps legacy Features session fields as projections of the store', async () => {
+    const device = Device.fromDescriptor({ id: 'one', path: 'one' } as never);
+    device.features = {
+      protocol: 'V1',
+      deviceId: 'device-1',
+      passphraseState: 'hidden-a',
+      sessionId: 'session-a',
+      session_id: 'session-a',
+      raw: {
+        protocolV1Features: {
+          sessionId: 'session-a',
+          session_id: 'session-a',
+        },
+      },
+    } as never;
+
+    expect(device.state).not.toHaveProperty('session');
+    expect(device.features).toMatchObject({
+      sessionId: 'session-a',
+      session_id: 'session-a',
+      passphraseState: 'hidden-a',
+    });
+
+    const method = new ClearSessionCache({
+      payload: {
+        method: 'clearSessionCache',
+        deviceId: 'device-1',
+        passphraseState: 'hidden-a',
+      },
+    });
+    method.init();
+    await method.run();
+
+    expect(device.features?.sessionId).toBeNull();
+    expect(device.features?.session_id).toBeNull();
+    expect(device.state?.raw?.protocolV1Features).toMatchObject({
+      sessionId: 'session-a',
+      session_id: 'session-a',
+    });
+  });
+
+  test('clears one wallet without using a device', async () => {
+    deviceWalletSessionStore.set('device-1', 'hidden-a', 'session-a');
+    deviceWalletSessionStore.set('device-1', 'hidden-b', 'session-b');
+    const method = new ClearSessionCache({
+      payload: {
+        method: 'clearSessionCache',
+        deviceId: 'device-1',
+        passphraseState: 'hidden-a',
+      },
+    });
+
+    method.init();
+
+    expect(method.useDevice).toBe(false);
+    await expect(method.run()).resolves.toEqual({ cleared: true });
+    expect(deviceWalletSessionStore.get('device-1', 'hidden-a')).toBeUndefined();
+    expect(deviceWalletSessionStore.get('device-1', 'hidden-b')).toBe('session-b');
+  });
+
+  test('clears one device or the full runtime store', async () => {
+    deviceWalletSessionStore.set('device-1', 'hidden-a', 'session-a');
+    deviceWalletSessionStore.set('device-2', 'hidden-a', 'session-b');
+
+    const clearDevice = new ClearSessionCache({
+      payload: { method: 'clearSessionCache', deviceId: 'device-1' },
+    });
+    clearDevice.init();
+    await clearDevice.run();
+
+    expect(deviceWalletSessionStore.get('device-1', 'hidden-a')).toBeUndefined();
+    expect(deviceWalletSessionStore.get('device-2', 'hidden-a')).toBe('session-b');
+
+    const clearAll = new ClearSessionCache({
+      payload: { method: 'clearSessionCache' },
+    });
+    clearAll.init();
+    await clearAll.run();
+
+    expect(deviceWalletSessionStore.get('device-2', 'hidden-a')).toBeUndefined();
+  });
+
+  test('routes cache clearing through the active CoreApi call channel', async () => {
+    const call = jest.fn().mockResolvedValue({ success: true, payload: { cleared: true } });
+    const api = createCoreApi(call as any);
+
+    await api.clearSessionCache({ deviceId: 'device-1', passphraseState: 'hidden-a' });
+
+    expect(call).toHaveBeenCalledWith({
+      method: 'clearSessionCache',
+      deviceId: 'device-1',
+      passphraseState: 'hidden-a',
+    });
+  });
+});

package/__tests__/deviceFeaturesUtils.test.ts

@@ -0,0 +1,39 @@
+import { EDeviceType } from '@onekeyfe/hd-shared';
+
+import DataManager from '../src/data-manager/DataManager';
+import {
+  getSupportProtocolV1MessageSchema,
+  supportInputPinOnSoftware,
+} from '../src/utils/deviceFeaturesUtils';
+
+import type { Features } from '../src/types';
+
+jest.mock('../src/data/config', () => ({
+  getSDKVersion: () => '1.0.0',
+  DEFAULT_DOMAIN: 'https://jssdk.onekey.so/1.0.0/',
+}));
+
+describe('getSupportProtocolV1MessageSchema', () => {
+  test('Classic Pure 在无主固件的 Bootloader 模式下使用当前协议结构', () => {
+    const features = {
+      deviceType: EDeviceType.ClassicPure,
+      bootloaderMode: true,
+      firmwarePresent: false,
+      firmwareVersion: '2.0.8',
+    } as Features;
+
+    const result = getSupportProtocolV1MessageSchema(features);
+
+    expect(result.protocolV1MessageSchema).toBe('v1CurrentSchema');
+    expect(result.messages).toBe(DataManager.messages.v1CurrentSchema);
+  });
+
+  test('Pro2 never supports entering PIN in software', () => {
+    const features = {
+      deviceType: EDeviceType.Pro2,
+      firmwareVersion: '9.9.9',
+    } as Features;
+
+    expect(supportInputPinOnSoftware(features)).toEqual({ support: false });
+  });
+});

package/__tests__/deviceSettings.test.ts

@@ -0,0 +1,103 @@
+import { EDeviceType } from '@onekeyfe/hd-shared';
+
+import {
+  getAutoLockOptions,
+  getAutoShutDownOptions,
+  getDeviceSettingsCapabilities,
+  getLanguageConfig,
+  mapLanguageFromProtocolV2,
+  mapLanguageToProtocolV2,
+  PROTOCOL_V2_NEVER_TIMEOUT_MS,
+} from '../src/utils/deviceSettings';
+
+describe('Pro 2 device settings options', () => {
+  test('returns stable SDK keys plus Pro2-only BCP-47 languages', () => {
+    expect(getLanguageConfig(EDeviceType.Pro2)).toEqual([
+      { code: 'en', label: 'English' },
+      { code: 'zh_cn', label: '简体中文' },
+      { code: 'zh_hk', label: '繁體中文' },
+      { code: 'ja', label: '日本語' },
+      { code: 'ko', label: '한국어' },
+      { code: 'fr', label: 'Français' },
+      { code: 'de', label: 'Deutsch' },
+      { code: 'ru', label: 'Russian' },
+      { code: 'es', label: 'Spanish' },
+      { code: 'it', label: 'Italiano' },
+      { code: 'pt_br', label: 'Portuguese (Brazil)' },
+      { code: 'zh-Hant-TW', label: '繁體中文（台灣）' },
+      { code: 'vi-Latn-VN', label: 'Tiếng Việt' },
+      { code: 'tr-Latn-TR', label: 'Türkçe' },
+      { code: 'id-Latn-ID', label: 'Bahasa Indonesia' },
+      { code: 'fil-Latn-PH', label: 'Filipino' },
+      { code: 'uk-Cyrl-UA', label: 'Українська' },
+    ]);
+  });
+
+  test('maps shared language keys and preserves Pro2-only BCP-47 tags', () => {
+    expect(mapLanguageToProtocolV2('en')).toBe('en-Latn-US');
+    expect(mapLanguageToProtocolV2('zh_cn')).toBe('zh-Hans-CN');
+    expect(mapLanguageToProtocolV2('pt_br')).toBe('pt-Latn-BR');
+    expect(mapLanguageToProtocolV2('vi-Latn-VN')).toBe('vi-Latn-VN');
+    expect(mapLanguageToProtocolV2(undefined)).toBeUndefined();
+  });
+
+  test('maps Protocol V2 tags back to the shared SDK language keys', () => {
+    expect(mapLanguageFromProtocolV2('en-Latn-US')).toBe('en');
+    expect(mapLanguageFromProtocolV2('zh-Hans-CN')).toBe('zh_cn');
+    expect(mapLanguageFromProtocolV2('pt-Latn-BR')).toBe('pt_br');
+    expect(mapLanguageFromProtocolV2('vi-Latn-VN')).toBe('vi-Latn-VN');
+    expect(mapLanguageFromProtocolV2(undefined)).toBeUndefined();
+  });
+
+  test('returns the firmware-supported auto-lock delays', () => {
+    expect(getAutoLockOptions(EDeviceType.Pro2, 'V2')).toEqual([
+      { label: '30 seconds', valueMs: 30_000 },
+      { label: '1 minute', valueMs: 60_000 },
+      { label: '2 minutes', valueMs: 120_000 },
+      { label: '5 minutes', valueMs: 300_000 },
+      { label: '10 minutes', valueMs: 600_000 },
+      { label: '30 minutes', valueMs: 1_800_000 },
+      { label: 'Never', valueMs: PROTOCOL_V2_NEVER_TIMEOUT_MS },
+    ]);
+  });
+
+  test('returns the firmware-supported auto-shutdown delays', () => {
+    expect(getAutoShutDownOptions(EDeviceType.Pro2, 'V2')).toEqual([
+      { label: '1 minute', valueMs: 60_000 },
+      { label: '2 minutes', valueMs: 120_000 },
+      { label: '5 minutes', valueMs: 300_000 },
+      { label: '10 minutes', valueMs: 600_000 },
+      { label: '30 minutes', valueMs: 1_800_000 },
+      { label: 'Never', valueMs: PROTOCOL_V2_NEVER_TIMEOUT_MS },
+    ]);
+  });
+
+  test('keeps the legacy and Protocol V2 never values protocol-specific', () => {
+    expect(getAutoLockOptions(EDeviceType.Pro, 'V1').slice(-1)[0]).toEqual({
+      label: 'Never',
+      valueMs: 0,
+    });
+    expect(getAutoLockOptions(EDeviceType.Pro2, 'V2').slice(-1)[0]).toEqual({
+      label: 'Never',
+      valueMs: PROTOCOL_V2_NEVER_TIMEOUT_MS,
+    });
+  });
+
+  test('returns one capability model for Protocol V1 and V2 consumers', () => {
+    const v1 = getDeviceSettingsCapabilities(EDeviceType.Pro, 'V1');
+    const v2 = getDeviceSettingsCapabilities(EDeviceType.Pro2, 'V2');
+
+    expect(v1.supportedFields).toEqual(
+      expect.arrayContaining(['label', 'safetyChecks', 'experimentalFeatures'])
+    );
+    expect(v1.supportedFields).not.toContain('brightness');
+    expect(v2.supportedFields).toEqual(
+      expect.arrayContaining(['label', 'brightness', 'airgapMode'])
+    );
+    expect(v2.supportedFields).not.toContain('safetyChecks');
+    expect(v2.ranges.brightness).toEqual({ min: 10, max: 100 });
+    expect(v1.safetyCheckOptions.map(option => option.value)).toEqual([0, 1, 2]);
+    expect(v2.safetyCheckOptions).toEqual([]);
+    expect(v2.onDeviceConfirmationFields).toEqual(['usePassphrase', 'airgapMode']);
+  });
+});

package/__tests__/evmLedgerLegacySafety.test.ts

@@ -4,6 +4,9 @@ import EVMGetPublicKey from '../src/api/evm/EVMGetPublicKey';
 import { findMethod } from '../src/api/utils';
 import { getDeviceType, getFirmwareType, getMethodVersionRange } from '../src/utils';
 import { getDeviceFirmwareVersion } from '../src/utils/deviceVersionUtils';
+import { Enum_SafetyCheckLevel } from '@onekeyfe/hd-transport';
+
+import type { EDeviceType } from '@onekeyfe/hd-shared';
 
 jest.mock('../src/data/config', () => ({
   getSDKVersion: jest.fn(() => '1.0.0'),
@@ -18,7 +21,8 @@ const createDevice = (onekeyDeviceType: string) => {
   const typedCall = jest.fn();
   const features = {
     onekey_device_type: onekeyDeviceType,
-    safety_checks: 'Strict',
+    deviceType: onekeyDeviceType.toLowerCase() as EDeviceType,
+    safety_checks: Enum_SafetyCheckLevel.Strict,
   };
   return {
     typedCall,
@@ -27,7 +31,7 @@ const createDevice = (onekeyDeviceType: string) => {
       commands: {
         typedCall,
       },
-      // BaseMethod 通过 Device accessor 读取设备状态，stub 复用真实工具函数保持映射一致
+      // BaseMethod reads state through Device accessors; reuse production mappers in the stub.
       isProtocolV2: () => false,
       getCurrentDeviceType: () => getDeviceType(features as any),
       getCurrentSafetyChecks: () => features.safety_checks,
@@ -65,7 +69,7 @@ describe('EVM Ledger legacy path safety checks', () => {
       await method.checkSafetyLevelOnTestNet();
 
       expect(typedCall).toHaveBeenCalledWith('ApplySettings', 'Success', {
-        safety_checks: 'PromptTemporarily',
+        safety_checks: Enum_SafetyCheckLevel.PromptTemporarily,
       });
     }
   );
@@ -84,7 +88,7 @@ describe('EVM Ledger legacy path safety checks', () => {
     await method.checkSafetyLevelOnTestNet();
 
     expect(typedCall).toHaveBeenCalledWith('ApplySettings', 'Success', {
-      safety_checks: 'PromptTemporarily',
+      safety_checks: Enum_SafetyCheckLevel.PromptTemporarily,
     });
   });
 
@@ -133,7 +137,7 @@ describe('EVM Ledger legacy path safety checks', () => {
     );
 
     expect(typedCall).toHaveBeenCalledWith('ApplySettings', 'Success', {
-      safety_checks: 'PromptTemporarily',
+      safety_checks: Enum_SafetyCheckLevel.PromptTemporarily,
     });
 
     runSpy.mockRestore();
@@ -213,7 +217,7 @@ describe('EVM Ledger legacy path safety checks', () => {
 
     expect(typedCall).toHaveBeenCalledTimes(1);
     expect(typedCall).toHaveBeenCalledWith('ApplySettings', 'Success', {
-      safety_checks: 'PromptTemporarily',
+      safety_checks: Enum_SafetyCheckLevel.PromptTemporarily,
     });
 
     runSpy.mockRestore();

package/__tests__/evmSignTypedData.test.ts

@@ -497,3 +497,83 @@ describe('EVMSignTypedData — hasClassicFamilyTypedDataFormatViolations', () =>
     });
   });
 });
+
+describe('EVMSignTypedData — OneKey Pro Safe Protocol V1', () => {
+  it('收到 Pro 的 Safe 请求后按 EthereumGnosisSafeTxAck 字段回传', async () => {
+    const data = {
+      types: {
+        EIP712Domain: [
+          { name: 'chainId', type: 'uint256' },
+          { name: 'verifyingContract', type: 'address' },
+        ],
+        SafeTx: [
+          { name: 'to', type: 'address' },
+          { name: 'value', type: 'uint256' },
+          { name: 'data', type: 'bytes' },
+          { name: 'operation', type: 'uint8' },
+          { name: 'safeTxGas', type: 'uint256' },
+          { name: 'baseGas', type: 'uint256' },
+          { name: 'gasPrice', type: 'uint256' },
+          { name: 'gasToken', type: 'address' },
+          { name: 'refundReceiver', type: 'address' },
+          { name: 'nonce', type: 'uint256' },
+        ],
+      },
+      primaryType: 'SafeTx',
+      domain: {
+        chainId: '0x89',
+        verifyingContract: '0x673f21761c5400531a37554a602fe0407addd0dd',
+      },
+      message: {
+        to: '0x5618207d27d78f09f61a5d92190d58c453feb4b7',
+        value: '1000',
+        data: '0x001234',
+        operation: '1',
+        safeTxGas: '256',
+        baseGas: '0',
+        gasPrice: '15',
+        gasToken: '0x0000000000000000000000000000000000000000',
+        refundReceiver: '0x0000000000000000000000000000000000000000',
+        nonce: '2',
+      },
+    } as EthereumSignTypedDataMessage<EthereumSignTypedDataTypes>;
+    const method = createMethod(data);
+    const typedCall = jest.fn().mockResolvedValue({
+      type: 'EthereumTypedDataSignatureOneKey',
+      message: {
+        address: '0x5618207d27d78f09f61a5d92190d58c453feb4b7',
+        signature: 'abcd',
+      },
+    });
+
+    const result = await method.handleSignTypedData({
+      typedCall: typedCall as any,
+      signData: data,
+      response: { type: 'EthereumGnosisSafeTxRequest', message: {} } as any,
+      supportTrezor: false,
+    });
+
+    expect(typedCall).toHaveBeenCalledWith(
+      'EthereumGnosisSafeTxAck',
+      ['EthereumTypedDataSignature', 'EthereumTypedDataSignatureOneKey'],
+      {
+        to: '0x5618207d27d78f09f61a5d92190d58c453feb4b7',
+        value: '03e8',
+        data: '1234',
+        operation: 1,
+        safeTxGas: '0100',
+        baseGas: '00',
+        gasPrice: '0f',
+        gasToken: '0x0000000000000000000000000000000000000000',
+        refundReceiver: '0x0000000000000000000000000000000000000000',
+        nonce: '02',
+        chain_id: 137,
+        verifyingContract: '0x673f21761c5400531a37554a602fe0407addd0dd',
+      }
+    );
+    expect(result).toEqual({
+      address: '0x5618207d27d78f09f61a5d92190d58c453feb4b7',
+      signature: 'abcd',
+    });
+  });
+});

package/__tests__/filesystemValidation.test.ts

@@ -0,0 +1,53 @@
+import { HardwareErrorCode } from '@onekeyfe/hd-shared';
+
+import { validateProtocolV2FilesystemPath } from '../src/api/helpers/filesystemValidation';
+
+jest.mock('../src/data/config', () => ({
+  getSDKVersion: jest.fn(() => '1.0.0'),
+  DEFAULT_DOMAIN: 'https://jssdk.onekey.so/1.0.0/',
+}));
+
+describe('validateProtocolV2FilesystemPath', () => {
+  test('兼容并保留设备现有的卷内相对路径格式', () => {
+    expect(validateProtocolV2FilesystemPath('vol1:test.bin', 'path')).toBe('vol1:test.bin');
+  });
+
+  test('目录查询可以使用卷根目录', () => {
+    expect(
+      validateProtocolV2FilesystemPath('VOL1:', 'path', {
+        allowVolumeRoot: true,
+      })
+    ).toBe('vol1:');
+  });
+
+  test.each([
+    'vol1:/../firmware.bin',
+    'vol1:/wallets/./test.bin',
+    'vol1:/wallets//test.bin',
+    'vol1:\\wallets\\test.bin',
+    'vol2:/test.bin',
+    '/test.bin',
+  ])('拒绝不安全或未知范围的路径：%s', path => {
+    expect(() => validateProtocolV2FilesystemPath(path, 'path')).toThrow(
+      expect.objectContaining({
+        errorCode: HardwareErrorCode.CallMethodInvalidParameter,
+      })
+    );
+  });
+
+  test('文件操作不允许使用卷根目录', () => {
+    expect(() => validateProtocolV2FilesystemPath('vol1:', 'path')).toThrow(
+      expect.objectContaining({
+        errorCode: HardwareErrorCode.CallMethodInvalidParameter,
+      })
+    );
+  });
+
+  test('按 UTF-8 字节数拒绝超出设备最小路径缓冲区的路径', () => {
+    expect(() => validateProtocolV2FilesystemPath(`vol1:/${'测'.repeat(41)}`, 'path')).toThrow(
+      expect.objectContaining({
+        errorCode: HardwareErrorCode.CallMethodInvalidParameter,
+      })
+    );
+  });
+});