@onekeyfe/hd-core 1.1.27 → 1.2.0-alpha.0

package/src/protocols/protocol-v2/features.ts

@@ -0,0 +1,180 @@
+import { DevSEState, DevSeType } from '@onekeyfe/hd-transport';
+
+import type { DeviceGetDeviceInfo, DevSEInfo, ProtocolV2DeviceInfo } from '@onekeyfe/hd-transport';
+import type { DeviceCommands } from '../../device/DeviceCommands';
+
+// 单源类型：直接使用 hd-transport 生成的 ProtocolV2DeviceInfo / DevSEInfo /
+// DevFirmwareImageInfo（与 firmware-pro2 proto 一致），不再维护手写副本。
+export type { ProtocolV2DeviceInfo };
+export type { DevFirmwareImageInfo as ProtocolV2FirmwareImageInfo } from '@onekeyfe/hd-transport';
+export type { DevSEInfo as ProtocolV2SEInfo } from '@onekeyfe/hd-transport';
+
+export type ProtocolV2SeStateLabel = 'BOOT' | 'APP_FACTORY' | 'APP';
+
+/**
+ * 传输层解码会把 proto 枚举输出为名称字符串（见 hd-transport 的 messageToJSON），
+ * 但生成类型声明为数值枚举；这里统一兼容两种形态。
+ */
+const normalizeEnumValue = <T extends Record<string | number, string | number>>(
+  enumObject: T,
+  value: number | string | null | undefined
+): string | null => {
+  if (value == null) return null;
+  if (typeof value === 'string') return value;
+  const label = enumObject[value];
+  return typeof label === 'string' ? label : null;
+};
+
+/**
+ * DevSEInfo.state → 可读标签。SDK 内唯一的 SE 状态映射实现，
+ * deviceProfile 与 legacy Features 兼容视图都从这里取。
+ */
+export const getProtocolV2SeState = (se?: DevSEInfo): ProtocolV2SeStateLabel | null => {
+  const label = normalizeEnumValue(DevSEState, se?.state);
+  switch (label) {
+    case 'BOOT':
+      return 'BOOT';
+    case 'APP_FACTORY':
+      return 'APP_FACTORY';
+    case 'APP':
+      return 'APP';
+    default:
+      return null;
+  }
+};
+
+/**
+ * DevSEInfo.type → 可读标签（如 'THD89'）。legacy Features 兼容视图的
+ * onekey_se_type 字段从这里取。
+ */
+export const getProtocolV2SeType = (se?: DevSEInfo): string | null =>
+  normalizeEnumValue(DevSeType, se?.type);
+
+export const PROTOCOL_V2_FEATURES_DEVICE_INFO_REQUEST = {
+  targets: {
+    hw: true,
+    fw: true,
+    bt: true,
+    status: true,
+  },
+  types: {
+    version: true,
+    specific: true,
+  },
+};
+
+/**
+ * 轻量状态刷新请求（每次 run 前使用）。
+ *
+ * status 提供 init_states / label / passphrase_protection 等会在设备端变化的字段；
+ * hw / bt 提供 serialNo / bleName 等身份字段——applyProfileUpdate 对顶层字段是整体
+ * 覆盖语义，缺少 hw/bt 会把已有 profile 的身份字段清空。不含 fw/SE targets，
+ * 单帧请求开销很小。
+ */
+export const PROTOCOL_V2_STATUS_DEVICE_INFO_REQUEST = {
+  targets: {
+    hw: true,
+    bt: true,
+    status: true,
+  },
+  types: {
+    version: true,
+    specific: true,
+  },
+};
+
+export const PROTOCOL_V2_VERSIONS_DEVICE_INFO_REQUEST = {
+  targets: {
+    hw: true,
+    fw: true,
+    bt: true,
+    se1: true,
+    se2: true,
+    se3: true,
+    se4: true,
+    status: true,
+  },
+  types: {
+    version: true,
+    specific: true,
+  },
+};
+
+export const PROTOCOL_V2_FULL_DEVICE_INFO_REQUEST = {
+  targets: {
+    hw: true,
+    fw: true,
+    bt: true,
+    se1: true,
+    se2: true,
+    se3: true,
+    se4: true,
+    status: true,
+  },
+  types: {
+    version: true,
+    build_id: true,
+    hash: true,
+    specific: true,
+  },
+};
+
+export const PROTOCOL_V2_DEVICE_INFO_REQUEST = PROTOCOL_V2_FULL_DEVICE_INFO_REQUEST;
+export const PROTOCOL_V2_DEVICE_INFO_TIMEOUT_MS = 10 * 1000;
+
+/**
+ * 临时开关（默认开启）：当前 Pro2 测试固件 / 早期工程板尚未实现 DevGetDeviceInfo，
+ * 真实调用只会超时失败。开启时跳过 wire 调用，直接返回 mock DeviceInfo；
+ * profile 的身份字段（serialNo/deviceId）由 buildProfileFromProtocolV2 的
+ * fallbackSerialNo（transport path）兜底。
+ *
+ * 固件实现 DevGetDeviceInfo 后：把默认值改回 false（或直接删除开关与 mock）。
+ * 注意：开启期间 FirmwareUpdateV4 的“升级完成版本比对”拿到的也是 mock 版本，
+ * 不能作为升级成功的依据。
+ */
+let protocolV2DeviceInfoMockEnabled = true;
+
+export const setProtocolV2DeviceInfoMock = (enabled: boolean) => {
+  protocolV2DeviceInfoMockEnabled = enabled;
+};
+
+export const isProtocolV2DeviceInfoMockEnabled = () => protocolV2DeviceInfoMockEnabled;
+
+/** 每次调用返回新对象，避免调用方原地修改互相污染。 */
+export const buildMockProtocolV2DeviceInfo = (): ProtocolV2DeviceInfo => ({
+  protocol_version: 2,
+  hw: {
+    // 留空：profile 身份走 fallbackSerialNo（transport path）
+    serial_no: '',
+  },
+  fw: {
+    app: { version: '0.1.0' },
+  },
+  bt: {},
+  status: {
+    init_states: true,
+    language: 'en_US',
+    passphrase_protection: false,
+    bt_enable: true,
+  },
+});
+
+export async function requestProtocolV2DeviceInfo({
+  commands,
+  timeoutMs = PROTOCOL_V2_DEVICE_INFO_TIMEOUT_MS,
+  request = PROTOCOL_V2_FEATURES_DEVICE_INFO_REQUEST,
+}: {
+  commands: DeviceCommands;
+  timeoutMs?: number;
+  request?: DeviceGetDeviceInfo;
+}): Promise<ProtocolV2DeviceInfo> {
+  if (protocolV2DeviceInfoMockEnabled) {
+    return buildMockProtocolV2DeviceInfo();
+  }
+  const { message } = await commands.typedCall('DevGetDeviceInfo', 'DeviceInfo', request, {
+    timeoutMs,
+  });
+  // 'DeviceInfo' 在生成类型里是 V1 DeviceInfo | ProtocolV2DeviceInfo 的合并；
+  // DevGetDeviceInfo 是 V2-only 消息，这里收窄到 V2 形态。
+  return message as ProtocolV2DeviceInfo;
+}

package/src/protocols/protocol-v2/firmware.ts

@@ -0,0 +1,43 @@
+/**
+ * 当前 firmware-pro2 子模块的 DevFirmwareTargetType。
+ *
+ * 注意：仓库里的 hd-transport 生成物暂时仍带旧 target 名称；这里显式按
+ * submodules/firmware-pro2/sys/protobuf/onekey_protocol/latest/messages_device.proto
+ * 对齐当前子模块，避免运行时取到 undefined。
+ */
+export const ProtocolV2FirmwareTargetType = {
+  TARGET_MAIN_APP: 0,
+  TARGET_MAIN_BOOT: 1,
+  TARGET_BT: 2,
+  TARGET_SE1: 3,
+  TARGET_SE2: 4,
+  TARGET_SE3: 5,
+  TARGET_SE4: 6,
+  TARGET_RESOURCE: 10,
+} as const;
+
+export type ProtocolV2FirmwareTargetType =
+  (typeof ProtocolV2FirmwareTargetType)[keyof typeof ProtocolV2FirmwareTargetType];
+
+/**
+ * Map Protocol V2 firmware file name to DevFirmwareUpdate target_id.
+ */
+export function protocolV2FileNameToTargetId(fileName: string): ProtocolV2FirmwareTargetType {
+  const normalized = fileName.toLowerCase();
+  if (normalized.includes('bootloader') || normalized.includes('update_rom')) {
+    return ProtocolV2FirmwareTargetType.TARGET_MAIN_BOOT;
+  }
+  if (
+    normalized.includes('coprocessor') ||
+    normalized.includes('ble') ||
+    normalized.includes('bluetooth') ||
+    normalized.includes('bt')
+  ) {
+    return ProtocolV2FirmwareTargetType.TARGET_BT;
+  }
+  if (normalized.includes('se4')) return ProtocolV2FirmwareTargetType.TARGET_SE4;
+  if (normalized.includes('se3')) return ProtocolV2FirmwareTargetType.TARGET_SE3;
+  if (normalized.includes('se2')) return ProtocolV2FirmwareTargetType.TARGET_SE2;
+  if (normalized.includes('se')) return ProtocolV2FirmwareTargetType.TARGET_SE1;
+  return ProtocolV2FirmwareTargetType.TARGET_MAIN_APP;
+}

package/src/protocols/protocol-v2/index.ts

@@ -0,0 +1,16 @@
+export {
+  PROTOCOL_V2_DEVICE_INFO_REQUEST,
+  PROTOCOL_V2_DEVICE_INFO_TIMEOUT_MS,
+  PROTOCOL_V2_FEATURES_DEVICE_INFO_REQUEST,
+  PROTOCOL_V2_STATUS_DEVICE_INFO_REQUEST,
+  PROTOCOL_V2_VERSIONS_DEVICE_INFO_REQUEST,
+  getProtocolV2SeState,
+  getProtocolV2SeType,
+} from './features';
+export type {
+  ProtocolV2DeviceInfo,
+  ProtocolV2FirmwareImageInfo,
+  ProtocolV2SEInfo,
+  ProtocolV2SeStateLabel,
+} from './features';
+export * from './firmware';

package/src/types/api/export.ts

@@ -28,6 +28,7 @@ export type {
   FirmwareUpdateParams,
   FirmwareUpdateBinaryParams,
   FirmwareUpdateV3Params,
+  FirmwareUpdateV4Params,
 } from './firmwareUpdate';
 export type { AllFirmwareRelease } from './checkAllFirmwareRelease';
 

package/src/types/api/firmwareUpdate.ts

@@ -41,6 +41,7 @@ export declare function firmwareUpdateV2(
 export interface FirmwareUpdateV3Params {
   bleVersion?: number[];
   bleBinary?: ArrayBuffer;
+  chunkSize?: number;
 
   firmwareVersion?: number[];
   firmwareBinary?: ArrayBuffer;
@@ -56,6 +57,45 @@ export interface FirmwareUpdateV3Params {
   platform: IPlatform;
 }
 
+/**
+ * firmwareUpdateV4（Protocol V2）按 DevFirmwareTargetType 拆分的目标二进制。
+ * 每个字段对应一个固件升级 target，可单独更新，也可任意组合一次更新。
+ */
+export interface FirmwareUpdateV4Params {
+  platform: IPlatform;
+  chunkSize?: number;
+  firmwareType?: EFirmwareType;
+
+  /** TARGET_MAIN_BOOT = 1 */
+  romloaderBinary?: ArrayBuffer;
+  /** TARGET_MAIN_BOOT = 1 */
+  bootloaderBinary?: ArrayBuffer;
+  /** TARGET_MAIN_APP = 0 */
+  applicationP1Binary?: ArrayBuffer;
+  /** TARGET_MAIN_APP = 0 */
+  applicationP2Binary?: ArrayBuffer;
+  /** TARGET_BT = 2 */
+  coprocessorBinary?: ArrayBuffer;
+  /** TARGET_SE1-4 = 3-6 */
+  se01Binary?: ArrayBuffer;
+  se02Binary?: ArrayBuffer;
+  se03Binary?: ArrayBuffer;
+  se04Binary?: ArrayBuffer;
+  /** TARGET_RESOURCE = 10（zip 包，解压后逐文件上传） */
+  resourceBinary?: ArrayBuffer;
+  forcedUpdateRes?: boolean;
+
+  /** 按 release 配置自动下载 */
+  firmwareVersion?: number[];
+  bleVersion?: number[];
+  bootloaderVersion?: number[];
+
+  /** legacy 别名：等价 applicationP1Binary */
+  firmwareBinary?: ArrayBuffer;
+  /** legacy 别名：等价 coprocessorBinary */
+  bleBinary?: ArrayBuffer;
+}
+
 export declare function firmwareUpdateV3(
   connectId: string | undefined,
   params: Params<FirmwareUpdateV3Params>
@@ -64,3 +104,12 @@ export declare function firmwareUpdateV3(
   firmwareVersion: string;
   bootloaderVersion: string;
 }>;
+
+export declare function firmwareUpdateV4(
+  connectId: string | undefined,
+  params: Params<FirmwareUpdateV4Params>
+): Response<{
+  bleVersion: string;
+  firmwareVersion: string;
+  bootloaderVersion: string;
+}>;

package/src/types/api/getDeviceInfo.ts

@@ -0,0 +1,99 @@
+import type { CommonParams, Response } from '../params';
+import type { Features, IDeviceType, OnekeyFeatures } from '../device';
+import type { EFirmwareType } from '@onekeyfe/hd-shared';
+import type { ProtocolType, ProtocolV2DeviceInfo } from '@onekeyfe/hd-transport';
+
+// 协议类型单源：从 hd-transport 的 ProtocolType 派生，只额外允许 'unknown'。
+export type DeviceInfoProtocol = ProtocolType | 'unknown';
+
+export type DeviceInfoSource = 'features' | 'onekeyFeatures' | 'deviceInfo';
+
+export type DeviceInfoScope = 'basic' | 'versions' | 'verify' | 'full';
+
+export type GetDeviceInfoParams = {
+  scope?: DeviceInfoScope;
+  refresh?: boolean;
+  includeRaw?: boolean;
+};
+
+export type DeviceInfoMode = 'normal' | 'bootloader' | 'notInitialized' | 'unknown';
+
+export type DeviceInfoStatus = {
+  mode: DeviceInfoMode;
+  initialized: boolean | null;
+  bootloaderMode: boolean | null;
+  unlocked: boolean | null;
+  passphraseProtection: boolean | null;
+  backupRequired: boolean | null;
+  noBackup: boolean | null;
+  language: string | null;
+  bleEnabled: boolean | null;
+};
+
+export type DeviceProfileVersions = {
+  firmware: string | null;
+  bootloader: string | null;
+  board: string | null;
+  ble: string | null;
+  se01?: string | null;
+  se02?: string | null;
+  se03?: string | null;
+  se04?: string | null;
+  se01Boot?: string | null;
+  se02Boot?: string | null;
+  se03Boot?: string | null;
+  se04Boot?: string | null;
+};
+
+export type DeviceProfileVerify = {
+  firmwareBuildId?: string;
+  firmwareHash?: string;
+  bootloaderBuildId?: string;
+  bootloaderHash?: string;
+  boardBuildId?: string;
+  boardHash?: string;
+  bleBuildId?: string;
+  bleHash?: string;
+  se01BuildId?: string;
+  se01Hash?: string;
+  se02BuildId?: string;
+  se02Hash?: string;
+  se03BuildId?: string;
+  se03Hash?: string;
+  se04BuildId?: string;
+  se04Hash?: string;
+  se01BootBuildId?: string;
+  se01BootHash?: string;
+  se02BootBuildId?: string;
+  se02BootHash?: string;
+  se03BootBuildId?: string;
+  se03BootHash?: string;
+  se04BootBuildId?: string;
+  se04BootHash?: string;
+};
+
+export type DeviceProfileRaw = {
+  features?: Features;
+  onekeyFeatures?: OnekeyFeatures;
+  protocolV2DeviceInfo?: ProtocolV2DeviceInfo;
+};
+
+export type DeviceProfile = {
+  protocol: DeviceInfoProtocol;
+  sources: DeviceInfoSource[];
+  deviceType: IDeviceType;
+  firmwareType: EFirmwareType;
+  deviceId: string;
+  serialNo: string;
+  label: string | null;
+  bleName: string | null;
+  status: DeviceInfoStatus;
+  versions: DeviceProfileVersions;
+  verify?: DeviceProfileVerify;
+  raw?: DeviceProfileRaw;
+};
+
+export declare function getDeviceInfo(
+  connectId?: string,
+  params?: CommonParams & GetDeviceInfoParams
+): Response<DeviceProfile>;

package/src/types/api/getPassphraseState.ts

@@ -1,6 +1,17 @@
 import type { CommonParams, Response } from '../params';
 
+export type GetPassphraseStatePayload = {
+  passphrase_state?: string;
+  session_id?: string;
+  unlocked_attach_pin?: boolean;
+  passphrase_protection?: boolean | null;
+};
+
+export type GetPassphraseStateParams = CommonParams & {
+  allowCreateAttachPin?: boolean;
+};
+
 export declare function getPassphraseState(
   connectId?: string,
-  params?: CommonParams
-): Response<string>;
+  params?: GetPassphraseStateParams
+): Response<GetPassphraseStatePayload>;

package/src/types/api/index.ts

@@ -1,3 +1,35 @@
+import type {
+  deviceFirmwareUpdate,
+  deviceGetDeviceInfo,
+  deviceGetFirmwareUpdateStatus,
+  deviceGetOnboardingStatus,
+  deviceReboot,
+  devFirmwareUpdate,
+  devGetDeviceInfo,
+  devGetFirmwareUpdateStatus,
+  devReboot,
+  dirList,
+  dirMake,
+  dirRemove,
+  factoryDeviceInfoSettings,
+  factoryGetDeviceInfo,
+  fileDelete,
+  fileRead,
+  fileWrite,
+  filesystemDirList,
+  filesystemDirMake,
+  filesystemDirRemove,
+  filesystemDiskControl,
+  filesystemFileDelete,
+  filesystemFileRead,
+  filesystemFileWrite,
+  filesystemFixPermission,
+  filesystemFormat,
+  filesystemPathInfoQuery,
+  getProtoVersion,
+  pathInfo,
+  ping,
+} from './protocolV2';
 import type { off, on, removeAllListeners } from './event';
 import type { uiResponse } from './uiResponse';
 import type { init, updateSettings } from './init';
@@ -11,11 +43,17 @@ import type { checkAllFirmwareRelease } from './checkAllFirmwareRelease';
 import type { checkFirmwareTypeAvailable } from './checkFirmwareTypeAvailable';
 import type { searchDevices } from './searchDevices';
 import type { getFeatures } from './getFeatures';
+import type { getDeviceInfo } from './getDeviceInfo';
 import type { getOnekeyFeatures } from './getOnekeyFeatures';
 import type { getPassphraseState } from './getPassphraseState';
 import type { checkFirmwareRelease } from './checkFirmwareRelease';
 import type { checkBLEFirmwareRelease } from './checkBLEFirmwareRelease';
-import type { firmwareUpdate, firmwareUpdateV2, firmwareUpdateV3 } from './firmwareUpdate';
+import type {
+  firmwareUpdate,
+  firmwareUpdateV2,
+  firmwareUpdateV3,
+  firmwareUpdateV4,
+} from './firmwareUpdate';
 import type { promptWebDeviceAccess } from './promptWebDeviceAccess';
 import type { deviceReset } from './deviceReset';
 import type { deviceRecovery } from './deviceRecovery';
@@ -131,6 +169,19 @@ import type { neoSignTransaction } from './neoSignTransaction';
 import type { ConnectSettings } from '../settings';
 
 export * from './export';
+export type {
+  DeviceInfoMode,
+  DeviceInfoProtocol,
+  DeviceInfoScope,
+  DeviceInfoSource,
+  DeviceInfoStatus,
+  DeviceProfile,
+  GetDeviceInfoParams,
+  DeviceProfileRaw,
+  DeviceProfileVerify,
+  DeviceProfileVersions,
+} from './getDeviceInfo';
+export type { GetPassphraseStateParams, GetPassphraseStatePayload } from './getPassphraseState';
 
 export type CoreApi = {
   /**
@@ -170,6 +221,7 @@ export type CoreApi = {
   searchDevices: typeof searchDevices;
   promptWebDeviceAccess: typeof promptWebDeviceAccess;
   getFeatures: typeof getFeatures;
+  getDeviceInfo: typeof getDeviceInfo;
   getOnekeyFeatures: typeof getOnekeyFeatures;
   getPassphraseState: typeof getPassphraseState;
   deviceBackup: typeof deviceBackup;
@@ -197,8 +249,43 @@ export type CoreApi = {
   firmwareUpdate: typeof firmwareUpdate;
   firmwareUpdateV2: typeof firmwareUpdateV2;
   firmwareUpdateV3: typeof firmwareUpdateV3;
+  firmwareUpdateV4: typeof firmwareUpdateV4;
   cipherKeyValue: typeof cipherKeyValue;
 
+  /**
+   * File system & device control API (Protocol V2 only)
+   */
+  getProtoVersion: typeof getProtoVersion;
+  ping: typeof ping;
+  deviceReboot: typeof deviceReboot;
+  deviceGetDeviceInfo: typeof deviceGetDeviceInfo;
+  deviceGetOnboardingStatus: typeof deviceGetOnboardingStatus;
+  deviceFirmwareUpdate: typeof deviceFirmwareUpdate;
+  deviceGetFirmwareUpdateStatus: typeof deviceGetFirmwareUpdateStatus;
+  devReboot: typeof devReboot;
+  devGetDeviceInfo: typeof devGetDeviceInfo;
+  devFirmwareUpdate: typeof devFirmwareUpdate;
+  devGetFirmwareUpdateStatus: typeof devGetFirmwareUpdateStatus;
+  factoryDeviceInfoSettings: typeof factoryDeviceInfoSettings;
+  factoryGetDeviceInfo: typeof factoryGetDeviceInfo;
+  filesystemFixPermission: typeof filesystemFixPermission;
+  fileRead: typeof fileRead;
+  fileWrite: typeof fileWrite;
+  fileDelete: typeof fileDelete;
+  dirList: typeof dirList;
+  dirMake: typeof dirMake;
+  dirRemove: typeof dirRemove;
+  pathInfo: typeof pathInfo;
+  filesystemFileRead: typeof filesystemFileRead;
+  filesystemFileWrite: typeof filesystemFileWrite;
+  filesystemFileDelete: typeof filesystemFileDelete;
+  filesystemDirList: typeof filesystemDirList;
+  filesystemDirMake: typeof filesystemDirMake;
+  filesystemDirRemove: typeof filesystemDirRemove;
+  filesystemPathInfoQuery: typeof filesystemPathInfoQuery;
+  filesystemFormat: typeof filesystemFormat;
+  filesystemDiskControl: typeof filesystemDiskControl;
+
   /**
    * All network function
    */