@onekeyfe/hd-core 1.1.27-alpha.4 → 1.1.27-alpha.41

package/src/types/api/protocolV2.ts

@@ -0,0 +1,226 @@
+import type { CommonParams, Response } from '../params';
+import type {
+  DeviceFirmwareTarget,
+  DeviceFirmwareUpdateStatus,
+  DeviceOnboardingStatus,
+  DeviceInfoTargets,
+  DeviceInfoTypes,
+  DeviceRebootType,
+  FactoryDeviceInfo,
+  ProtoVersion,
+  ProtocolV2DeviceInfo,
+  Success,
+} from '@onekeyfe/hd-transport';
+
+// ── Shared response shapes (Protocol V2 file system) ────────────────────
+
+export type FileOpSuccess = { message?: string };
+
+export type FileInfo = {
+  path: string;
+  offset: number;
+  total_size: number;
+  data?: Uint8Array;
+  data_hash?: number;
+  processed_byte?: number;
+  chunks?: number;
+};
+
+export type DirInfo = {
+  path: string;
+  child_dirs?: string;
+  child_files?: string;
+};
+
+export type PathInfoResult = {
+  exist: boolean;
+  size: number;
+  year: number;
+  month: number;
+  day: number;
+  hour: number;
+  minute: number;
+  second: number;
+  readonly?: boolean;
+  hidden?: boolean;
+  system?: boolean;
+  archive?: boolean;
+  directory?: boolean;
+};
+
+export type DeviceRebootParams = {
+  rebootType?: DeviceRebootType | string | number;
+  reboot_type?: DeviceRebootType | string | number;
+};
+
+export type DeviceGetDeviceInfoParams = {
+  targets?: DeviceInfoTargets;
+  types?: DeviceInfoTypes;
+  targetHw?: boolean;
+  targetFw?: boolean;
+  targetBt?: boolean;
+  targetSe1?: boolean;
+  targetSe2?: boolean;
+  targetSe3?: boolean;
+  targetSe4?: boolean;
+  targetStatus?: boolean;
+  includeVersion?: boolean;
+  includeBuildId?: boolean;
+  includeHash?: boolean;
+  includeSpecific?: boolean;
+};
+
+export type DeviceFirmwareUpdateParams = {
+  targets?: DeviceFirmwareTarget[];
+  targetId?: DeviceFirmwareTarget['target_id'] | string | number;
+  target_id?: DeviceFirmwareTarget['target_id'] | string | number;
+  path?: string;
+};
+
+export type FactoryDeviceInfoSettingsParams = {
+  serial_no?: string;
+  serialNo?: string;
+  cpu_info?: string;
+  cpuInfo?: string;
+  pre_firmware?: string;
+  preFirmware?: string;
+};
+
+// ── Method signatures ─────────────────────────────────────────────────────
+
+export declare function fileRead(
+  connectId: string,
+  params: {
+    path: string;
+    offset?: number;
+    totalSize?: number;
+    chunkLen?: number;
+    uiPercentage?: number;
+  }
+): Response<FileInfo>;
+
+export declare function fileWrite(
+  connectId: string,
+  params: {
+    path: string;
+    offset?: number;
+    totalSize?: number;
+    chunkSize?: number;
+    chunkLen?: number;
+    data: ArrayBuffer | Uint8Array | Blob | string;
+    overwrite?: boolean;
+    append?: boolean;
+    uiPercentage?: number;
+  }
+): Response<FileInfo>;
+
+export declare function fileDelete(
+  connectId: string,
+  params: { path: string }
+): Response<FileOpSuccess>;
+
+export declare function dirList(
+  connectId: string,
+  params: { path: string; depth?: number }
+): Response<DirInfo>;
+
+export declare function dirMake(
+  connectId: string,
+  params: { path: string }
+): Response<FileOpSuccess>;
+
+export declare function dirRemove(
+  connectId: string,
+  params: { path: string }
+): Response<FileOpSuccess>;
+
+export declare function pathInfo(
+  connectId: string,
+  params: { path: string }
+): Response<PathInfoResult>;
+
+export declare function getProtoVersion(
+  connectId: string,
+  params?: CommonParams
+): Response<ProtoVersion>;
+
+export declare function ping(
+  connectId: string,
+  params?: CommonParams & { message?: string }
+): Response<Success>;
+
+export declare function deviceReboot(
+  connectId: string,
+  params: CommonParams & DeviceRebootParams
+): Response<Success>;
+
+export declare function deviceGetDeviceInfo(
+  connectId: string,
+  params?: CommonParams & DeviceGetDeviceInfoParams
+): Response<ProtocolV2DeviceInfo>;
+
+export declare function deviceGetOnboardingStatus(
+  connectId: string,
+  params?: CommonParams
+): Response<DeviceOnboardingStatus>;
+
+export declare function deviceFirmwareUpdate(
+  connectId: string,
+  params: CommonParams & DeviceFirmwareUpdateParams
+): Response<Success | DeviceFirmwareUpdateStatus>;
+
+export declare function deviceGetFirmwareUpdateStatus(
+  connectId: string,
+  params?: CommonParams
+): Response<DeviceFirmwareUpdateStatus>;
+
+export declare function factoryDeviceInfoSettings(
+  connectId: string,
+  params: FactoryDeviceInfoSettingsParams
+): Response<Success>;
+
+export declare function factoryGetDeviceInfo(connectId: string): Response<FactoryDeviceInfo>;
+
+export declare function filesystemFixPermission(connectId: string): Response<Success>;
+
+export declare function filesystemFileRead(
+  connectId: string,
+  params: Parameters<typeof fileRead>[1]
+): ReturnType<typeof fileRead>;
+
+export declare function filesystemFileWrite(
+  connectId: string,
+  params: Parameters<typeof fileWrite>[1]
+): ReturnType<typeof fileWrite>;
+
+export declare function filesystemFileDelete(
+  connectId: string,
+  params: Parameters<typeof fileDelete>[1]
+): ReturnType<typeof fileDelete>;
+
+export declare function filesystemDirList(
+  connectId: string,
+  params: Parameters<typeof dirList>[1]
+): ReturnType<typeof dirList>;
+
+export declare function filesystemDirMake(
+  connectId: string,
+  params: Parameters<typeof dirMake>[1]
+): ReturnType<typeof dirMake>;
+
+export declare function filesystemDirRemove(
+  connectId: string,
+  params: Parameters<typeof dirRemove>[1]
+): ReturnType<typeof dirRemove>;
+
+export declare function filesystemPathInfoQuery(
+  connectId: string,
+  params: Parameters<typeof pathInfo>[1]
+): ReturnType<typeof pathInfo>;
+
+export declare function filesystemFormat(connectId: string): Response<Success>;
+
+export declare function filesystemDiskControl(
+  connectId: string,
+  params: CommonParams & { enable: number | string; timeoutMs?: number | string }
+): Response<Success>;

package/src/types/api/searchDevices.ts

@@ -1,4 +1,4 @@
 import type { SearchDevice } from '../device';
-import type { Response } from '../params';
+import type { CommonParams, Response } from '../params';
 
-export declare function searchDevices(): Response<SearchDevice[]>;
+export declare function searchDevices(params?: CommonParams): Response<SearchDevice[]>;

package/src/types/device.ts

@@ -85,7 +85,35 @@ export type SearchDevice = {
 
 export type Device = KnownDevice;
 
-export type Features = PROTO.Features;
+type OnekeyFeatureExtensions = Partial<
+  Pick<
+    PROTO.OnekeyFeatures,
+    | 'onekey_board_build_id'
+    | 'onekey_se02_hash'
+    | 'onekey_se03_hash'
+    | 'onekey_se04_hash'
+    | 'onekey_se02_build_id'
+    | 'onekey_se03_build_id'
+    | 'onekey_se04_build_id'
+    | 'onekey_se01_boot_version'
+    | 'onekey_se02_boot_version'
+    | 'onekey_se03_boot_version'
+    | 'onekey_se04_boot_version'
+    | 'onekey_se01_boot_hash'
+    | 'onekey_se02_boot_hash'
+    | 'onekey_se03_boot_hash'
+    | 'onekey_se04_boot_hash'
+    | 'onekey_se01_boot_build_id'
+    | 'onekey_se02_boot_build_id'
+    | 'onekey_se03_boot_build_id'
+    | 'onekey_se04_boot_build_id'
+  >
+>;
+
+export type Features = PROTO.Features &
+  OnekeyFeatureExtensions & {
+    protocol_version?: number | null;
+  };
 
 export type OnekeyFeatures = PROTO.OnekeyFeatures;
 
@@ -96,7 +124,8 @@ export type IDeviceType =
   | EDeviceType.ClassicPure
   | EDeviceType.Mini
   | EDeviceType.Touch
-  | EDeviceType.Pro;
+  | EDeviceType.Pro
+  | EDeviceType.Pro2;
 
 /**
  * model_classic: 'classic' | 'classic1s' | 'classicpure'
@@ -124,6 +153,7 @@ export const DeviceTypeToModels: { [deviceType in IDeviceType]: IDeviceModel[] }
   [EDeviceType.Mini]: ['model_mini'],
   [EDeviceType.Touch]: ['model_touch'],
   [EDeviceType.Pro]: ['model_touch'],
+  [EDeviceType.Pro2]: [],
   [EDeviceType.Unknown]: [],
 };
 
@@ -136,6 +166,7 @@ export type ITransportStatus = 'valid' | 'outdated';
 export type IVersionRange = {
   min: string;
   max?: string;
+  unsupported?: boolean;
 };
 
 export type DeviceFirmwareRange = {

package/src/types/params.ts

@@ -1,3 +1,5 @@
+import type { HardwareConnectProtocol } from '@onekeyfe/hd-shared';
+
 export interface CommonParams {
   keepSession?: boolean;
   /**
@@ -49,9 +51,9 @@ export interface CommonParams {
   onlyConnectBleDevice?: boolean;
 
   /**
-   * Use pre-initialized device state (BLE only)
+   * Expected transport protocol. If omitted, SDK probes Protocol V1 then Protocol V2.
    */
-  usePreInitialize?: boolean;
+  connectProtocol?: HardwareConnectProtocol;
 }
 
 export type Params<T> = CommonParams & T & { bundle?: undefined };

package/src/types/settings.ts

@@ -83,7 +83,7 @@ export type IBLEFirmwareReleaseInfo = {
   };
 };
 
-type IKnownDevice = Exclude<IDeviceType, 'unknown'>;
+type IKnownDevice = Exclude<IDeviceType, 'unknown' | 'pro2'>;
 
 /**
  * Device firmware configuration map

package/src/utils/deviceFeaturesUtils.ts

@@ -1,11 +1,17 @@
 import semver from 'semver';
 import { isNaN } from 'lodash';
 import { EDeviceType, type EFirmwareType, ERRORS, HardwareErrorCode } from '@onekeyfe/hd-shared';
-import { Enum_Capability } from '@onekeyfe/hd-transport';
+import {
+  Enum_Capability,
+  type GetPassphraseState as GetPassphraseStateMessage,
+} from '@onekeyfe/hd-transport';
 
 import { toHardened } from '../api/helpers/pathUtils';
 import { DeviceModelToTypes, DeviceTypeToModels } from '../types';
-import DataManager, { type IFirmwareField, type MessageVersion } from '../data-manager/DataManager';
+import DataManager, {
+  type IFirmwareField,
+  type ProtocolV1MessageSchema,
+} from '../data-manager/DataManager';
 import { PROTOBUF_MESSAGE_CONFIG } from '../data-manager/MessagesConfig';
 import { getDeviceType } from './deviceInfoUtils';
 import { getDeviceFirmwareVersion } from './deviceVersionUtils';
@@ -15,13 +21,13 @@ import type { Device } from '../device/Device';
 import type { DeviceCommands } from '../device/DeviceCommands';
 import type { Features, SupportFeatureType } from '../types';
 
-export const getSupportMessageVersion = (
+export const getSupportProtocolV1MessageSchema = (
   features: Features | undefined
-): { messages: JSON; messageVersion: MessageVersion } => {
+): { messages: JSON; protocolV1MessageSchema: ProtocolV1MessageSchema } => {
   if (!features)
     return {
-      messages: DataManager.messages.latest,
-      messageVersion: 'latest',
+      messages: DataManager.messages.v1CurrentSchema,
+      protocolV1MessageSchema: 'v1CurrentSchema',
     };
 
   const currentDeviceVersion = getDeviceFirmwareVersion(features).join('.');
@@ -37,18 +43,18 @@ export const getSupportMessageVersion = (
   const sortedDeviceVersionConfigs =
     deviceVersionConfigs?.sort((a, b) => semver.compare(b.minVersion, a.minVersion)) ?? [];
 
-  for (const { minVersion, messageVersion } of sortedDeviceVersionConfigs) {
+  for (const { minVersion, protocolV1MessageSchema } of sortedDeviceVersionConfigs) {
     if (semver.gte(currentDeviceVersion, minVersion)) {
       return {
-        messages: DataManager.messages[messageVersion],
-        messageVersion,
+        messages: DataManager.messages[protocolV1MessageSchema],
+        protocolV1MessageSchema,
       };
     }
   }
 
   return {
-    messages: DataManager.messages.latest,
-    messageVersion: 'latest',
+    messages: DataManager.messages.v1CurrentSchema,
+    protocolV1MessageSchema: 'v1CurrentSchema',
   };
 };
 
@@ -68,7 +74,11 @@ export const supportNewPassphrase = (features?: Features): SupportFeatureType =>
   if (!features) return { support: false };
 
   const deviceType = getDeviceType(features);
-  if (deviceType === EDeviceType.Touch || deviceType === EDeviceType.Pro) {
+  if (
+    deviceType === EDeviceType.Touch ||
+    deviceType === EDeviceType.Pro ||
+    deviceType === EDeviceType.Pro2
+  ) {
     return { support: true };
   }
 
@@ -82,10 +92,13 @@ export const getPassphraseStateWithRefreshDeviceInfo = async (
   options?: {
     expectPassphraseState?: string;
     onlyMainPin?: boolean;
+    allowCreateAttachPin?: boolean;
   }
 ) => {
   const { features, commands } = device;
   const locked = features?.unlocked === false;
+  const deviceType = getDeviceType(features);
+  const isPro2 = deviceType === EDeviceType.Pro2;
 
   const { passphraseState, newSession, unlockedAttachPin } = await getPassphraseState(
     features,
@@ -95,12 +108,12 @@ export const getPassphraseStateWithRefreshDeviceInfo = async (
     }
   );
 
-  const isModeT =
-    getDeviceType(features) === EDeviceType.Touch || getDeviceType(features) === EDeviceType.Pro;
+  const isModeT = deviceType === EDeviceType.Touch || deviceType === EDeviceType.Pro;
 
   // 如果可以获取到 passphraseState，但是设备 features 显示设备未开启 passphrase，需要刷新设备状态
   // if passphraseState can be obtained, but the device features show that the device has not enabled passphrase, the device status needs to be refreshed
-  const needRefreshWithPassphrase = passphraseState && features?.passphrase_protection !== true;
+  const needRefreshWithPassphrase =
+    !isPro2 && passphraseState && features?.passphrase_protection !== true;
   // 如果 Touch/Pro 在之前是锁定状态，刷新设备状态
   // if Touch/Pro was locked before, refresh the device state
   const needRefreshWithLocked = isModeT && locked;
@@ -110,10 +123,19 @@ export const getPassphraseStateWithRefreshDeviceInfo = async (
     await device.getFeatures();
   }
 
+  if (isPro2 && device.features) {
+    if (passphraseState) {
+      device.features.passphrase_protection = true;
+    }
+    if (newSession) {
+      device.features.session_id = newSession;
+    }
+  }
+
   // Attach to pin try to fix internal state
   if (features?.device_id) {
     device.updateInternalState(
-      device.features?.passphrase_protection ?? false,
+      (device.features?.passphrase_protection ?? false) || isPro2,
       passphraseState,
       device.features?.device_id ?? '',
       newSession,
@@ -130,6 +152,7 @@ export const getPassphraseState = async (
   options?: {
     expectPassphraseState?: string;
     onlyMainPin?: boolean;
+    allowCreateAttachPin?: boolean;
   }
 ): Promise<{
   passphraseState: string | undefined;
@@ -148,12 +171,23 @@ export const getPassphraseState = async (
   );
   const supportGetPassphraseState =
     supportAttachPinCapability ||
+    // Pro2 V2 暂未从 features 暴露 capabilities，先直连该方法用于固件联调。
+    deviceType === EDeviceType.Pro2 ||
     (deviceType === EDeviceType.Pro && semver.gte(firmwareVersion.join('.'), '4.15.0'));
 
   if (supportGetPassphraseState) {
-    const { message, type } = await commands.typedCall('GetPassphraseState', 'PassphraseState', {
-      passphrase_state: options?.onlyMainPin ? undefined : options?.expectPassphraseState,
-    });
+    const payload: GetPassphraseStateMessage = options?.onlyMainPin
+      ? { _only_main_pin: true }
+      : { passphrase_state: options?.expectPassphraseState };
+    if (options?.allowCreateAttachPin) {
+      payload.allow_create_attach_pin = true;
+    }
+
+    const { message, type } = await commands.typedCall(
+      'GetPassphraseState',
+      'PassphraseState',
+      payload
+    );
 
     // @ts-expect-error
     if (type === 'CallMethodError') {
@@ -197,7 +231,10 @@ export const supportBatchPublicKey = (
 
   const deviceType = getDeviceType(features);
   // btc batch get public key
-  if (!!options?.includeNode && deviceType === EDeviceType.Pro) {
+  if (
+    !!options?.includeNode &&
+    (deviceType === EDeviceType.Pro || deviceType === EDeviceType.Pro2)
+  ) {
     return semver.gte(currentVersion, '4.14.0');
   }
   if (!!options?.includeNode && deviceType === EDeviceType.Touch) {
@@ -214,7 +251,11 @@ export const supportBatchPublicKey = (
   }
 
   // support batch get public key
-  if (deviceType === EDeviceType.Touch || deviceType === EDeviceType.Pro) {
+  if (
+    deviceType === EDeviceType.Touch ||
+    deviceType === EDeviceType.Pro ||
+    deviceType === EDeviceType.Pro2
+  ) {
     return semver.gte(currentVersion, '3.1.0');
   }
 

package/src/utils/deviceInfoUtils.ts

@@ -27,6 +27,9 @@ export const getDeviceType = (features?: Features): IDeviceType => {
       return EDeviceType.Touch;
     case 'PRO':
       return EDeviceType.Pro;
+    case 'PRO2':
+    case 'pro2':
+      return EDeviceType.Pro2;
     case 'PURE':
       return EDeviceType.ClassicPure;
     default:
@@ -68,13 +71,14 @@ export const getDeviceType = (features?: Features): IDeviceType => {
 export const getDeviceTypeByBleName = (name?: string): IDeviceType => {
   if (!name) return EDeviceType.Unknown;
 
-  if (name.startsWith('BixinKey')) return EDeviceType.Classic;
-  if (name.startsWith('K')) return EDeviceType.Classic;
+  if (/^BixinKey/i.test(name)) return EDeviceType.Classic;
+  if (/^K/i.test(name)) return EDeviceType.Classic;
 
-  if (name.startsWith('T')) return EDeviceType.Touch;
-  if (name.startsWith('Touch')) return EDeviceType.Touch;
+  if (/^T/i.test(name)) return EDeviceType.Touch;
+  if (/^Touch/i.test(name)) return EDeviceType.Touch;
 
-  if (name.startsWith('Pro')) return EDeviceType.Pro;
+  if (/\bPro\s*2\b/i.test(name) || /^Pro2/i.test(name)) return EDeviceType.Pro2;
+  if (/\bPro\b/i.test(name) || /^Pro/i.test(name)) return EDeviceType.Pro;
 
   return EDeviceType.Unknown;
 };
@@ -128,8 +132,8 @@ export const getMethodVersionRange = (
   getVersionRange: (deviceModel: IDeviceType | IDeviceModel) => IVersionRange | undefined
 ): IVersionRange | undefined => {
   const deviceType = getDeviceType(features);
-  let versionRange: IVersionRange | undefined = getVersionRange(deviceType);
 
+  const versionRange = getVersionRange(deviceType);
   if (versionRange) {
     return versionRange;
   }
@@ -142,16 +146,19 @@ export const getMethodVersionRange = (
   ];
   for (const model of modelFallbacks) {
     if (DeviceModelToTypes[model].includes(deviceType)) {
-      versionRange = getVersionRange(model);
+      const versionRange = getVersionRange(model);
       if (versionRange) {
         return versionRange;
       }
     }
   }
 
-  return versionRange;
+  return undefined;
 };
 
+export const isMethodVersionRangeUnsupported = (versionRange?: IVersionRange): boolean =>
+  versionRange?.unsupported === true;
+
 export const getFirmwareType = (features: Features | undefined) => {
   if (!features) {
     return EFirmwareType.Universal;

package/src/utils/index.ts

@@ -11,6 +11,7 @@ export {
   getDeviceUUID,
   getDeviceLabel,
   getMethodVersionRange,
+  isMethodVersionRangeUnsupported,
   getFirmwareType,
 } from './deviceInfoUtils';
 export {

package/__tests__/DeviceCommands.test.ts

@@ -1,99 +0,0 @@
-import { HardwareErrorCode } from '@onekeyfe/hd-shared';
-
-import { DeviceCommands } from '../src/device/DeviceCommands';
-
-jest.mock('../src/data/config', () => ({
-  getSDKVersion: jest.fn(() => '1.0.0'),
-  DEFAULT_DOMAIN: 'https://jssdk.onekey.so/1.0.0/',
-}));
-
-const createCommands = () => {
-  const commands = Object.create(DeviceCommands.prototype) as DeviceCommands;
-  commands.device = {
-    clearCancelableAction: jest.fn(),
-  } as any;
-  return commands;
-};
-
-describe('DeviceCommands failure mapping', () => {
-  it.each([
-    ['ButtonAck', 'Not in Ethereum signing mode'],
-    ['PinMatrixAck', 'Not in Conflux signing mode'],
-  ])('keeps %s unexpected message "%s" as firmware runtime error', async (callType, message) => {
-    const commands = createCommands();
-
-    await expect(
-      commands._filterCommonTypes(
-        {
-          type: 'Failure',
-          message: {
-            code: 'Failure_UnexpectedMessage',
-            message,
-          },
-        } as any,
-        callType as any
-      )
-    ).rejects.toMatchObject({
-      errorCode: HardwareErrorCode.RuntimeError,
-      message: `Failure_UnexpectedMessage,${message}`,
-    });
-  });
-
-  it('keeps the existing NotInSigningMode mapping', async () => {
-    const commands = createCommands();
-
-    await expect(
-      commands._filterCommonTypes(
-        {
-          type: 'Failure',
-          message: {
-            code: 'Failure_UnexpectedMessage',
-            message: 'Not in Signing mode',
-          },
-        } as any,
-        'ButtonAck'
-      )
-    ).rejects.toMatchObject({
-      errorCode: HardwareErrorCode.NotInSigningMode,
-    });
-  });
-
-  it('keeps the existing unexpected passphrase mapping', async () => {
-    const commands = createCommands();
-
-    await expect(
-      commands._filterCommonTypes(
-        {
-          type: 'Failure',
-          message: {
-            code: 'Failure_UnexpectedMessage',
-            message: 'Unexpected message',
-          },
-        } as any,
-        'PassphraseAck'
-      )
-    ).rejects.toMatchObject({
-      errorCode: HardwareErrorCode.UnexpectPassphrase,
-    });
-  });
-
-  it('keeps non signing unexpected messages as runtime errors', async () => {
-    const commands = createCommands();
-
-    await expect(
-      commands._filterCommonTypes(
-        {
-          type: 'Failure',
-          message: {
-            code: 'Failure_UnexpectedMessage',
-            message: 'Not in Reset mode',
-          },
-        } as any,
-        'ButtonAck'
-      )
-    ).rejects.toMatchObject({
-      errorCode: HardwareErrorCode.RuntimeError,
-      message: 'Failure_UnexpectedMessage,Not in Reset mode',
-    });
-  });
-});