@onekeyfe/hd-core 1.2.0-alpha.1 → 1.2.0-alpha.10

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

@@ -1,43 +1,19 @@
 /**
- * 当前 firmware-pro2 子模块的 DevFirmwareTargetType。
- *
- * 注意：仓库里的 hd-transport 生成物暂时仍带旧 target 名称；这里显式按
- * submodules/firmware-pro2/sys/protobuf/onekey_protocol/latest/messages_device.proto
- * 对齐当前子模块，避免运行时取到 undefined。
+ * 当前 firmware-pro2 子模块的 DeviceFirmwareTargetType。
  */
 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,
+  FW_MGMT_TARGET_INVALID: 0,
+  FW_MGMT_TARGET_CRATE: 1,
+  FW_MGMT_TARGET_ROMLOADER: 2,
+  FW_MGMT_TARGET_BOOTLOADER: 3,
+  FW_MGMT_TARGET_APPLICATION_P1: 4,
+  FW_MGMT_TARGET_APPLICATION_P2: 5,
+  FW_MGMT_TARGET_COPROCESSOR: 6,
+  FW_MGMT_TARGET_SE01: 7,
+  FW_MGMT_TARGET_SE02: 8,
+  FW_MGMT_TARGET_SE03: 9,
+  FW_MGMT_TARGET_SE04: 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

@@ -14,3 +14,4 @@ export type {
   ProtocolV2SeStateLabel,
 } from './features';
 export * from './firmware';
+export * from './walletSession';

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

@@ -0,0 +1,83 @@
+import { ERRORS, HardwareErrorCode } from '@onekeyfe/hd-shared';
+
+import type { Device } from '../../device/Device';
+
+const getErrorText = (error: unknown) => {
+  if (error instanceof Error) return `${error.name} ${error.message}`;
+  if (typeof error === 'string') return error;
+  if (error && typeof error === 'object') {
+    const record = error as Record<string, unknown>;
+    return [record.code, record.errorCode, record.message, record.reason]
+      .filter(value => value !== undefined && value !== null)
+      .join(' ');
+  }
+  return String(error ?? '');
+};
+
+export const isProtocolV2InvalidSessionError = (error: unknown) =>
+  getErrorText(error).toLowerCase().includes('failure_invalidsession');
+
+export async function requestProtocolV2DeviceStatus(device: Device) {
+  const { message } = await device.commands.typedCall('DeviceStatusGet', 'DeviceStatus', {});
+  return message;
+}
+
+export async function refreshProtocolV2DeviceStatus(device: Device) {
+  const status = await requestProtocolV2DeviceStatus(device);
+  return device.updateProtocolV2Status(status);
+}
+
+export async function getProtocolV2WalletSession(
+  device: Device,
+  options?: { initSession?: boolean; expectedPassphraseState?: string }
+) {
+  if (device.features?.unlocked === false) {
+    throw ERRORS.TypedError(HardwareErrorCode.RuntimeError, 'Device is locked');
+  }
+
+  if (options?.initSession) {
+    device.clearInternalState();
+  }
+
+  const cachedSessionId =
+    typeof device.getInternalState === 'function' ? device.getInternalState() : undefined;
+
+  try {
+    const { message } = await device.commands.typedCall(
+      'DeviceSessionGet',
+      'DeviceSession',
+      cachedSessionId ? { session_id: cachedSessionId } : {}
+    );
+
+    if (
+      options?.expectedPassphraseState &&
+      options.expectedPassphraseState !== message.btc_test_address
+    ) {
+      device.clearInternalState();
+      throw ERRORS.TypedError(HardwareErrorCode.DeviceCheckPassphraseStateError);
+    }
+
+    if (message.btc_test_address && device.getCurrentPassphraseProtection() !== true) {
+      await refreshProtocolV2DeviceStatus(device);
+    }
+
+    device.updateInternalState(
+      (device.getCurrentPassphraseProtection() ?? false) || Boolean(message.btc_test_address),
+      message.btc_test_address,
+      device.getCurrentDeviceId(),
+      message.session_id,
+      options?.initSession ? null : device.features?.sessionId
+    );
+
+    return {
+      passphraseState: message.btc_test_address,
+      newSession: message.session_id,
+      unlockedAttachPin: device.features?.unlockedAttachPin ?? undefined,
+    };
+  } catch (error) {
+    if (isProtocolV2InvalidSessionError(error)) {
+      device.clearInternalState();
+    }
+    throw error;
+  }
+}

package/src/types/api/firmwareUpdate.ts

@@ -58,42 +58,38 @@ export interface FirmwareUpdateV3Params {
 }
 
 /**
- * firmwareUpdateV4（Protocol V2）按 DevFirmwareTargetType 拆分的目标二进制。
- * 每个字段对应一个固件升级 target，可单独更新，也可任意组合一次更新。
+ * firmwareUpdateV4（Protocol V2）按 DeviceFirmwareTargetType 拆分的目标二进制。
+ * 除 romloader 外，每个字段对应一个 bootloader 可接受的固件升级 target。
  */
 export interface FirmwareUpdateV4Params {
   platform: IPlatform;
   chunkSize?: number;
   firmwareType?: EFirmwareType;
 
-  /** TARGET_MAIN_BOOT = 1 */
+  /** FW_MGMT_TARGET_ROMLOADER = 2；当前 Pro2 bootloader 不接受通过 firmwareUpdateV4 安装 */
   romloaderBinary?: ArrayBuffer;
-  /** TARGET_MAIN_BOOT = 1 */
+  /** FW_MGMT_TARGET_BOOTLOADER = 3 */
   bootloaderBinary?: ArrayBuffer;
-  /** TARGET_MAIN_APP = 0 */
+  /** FW_MGMT_TARGET_APPLICATION_P1 = 4 */
   applicationP1Binary?: ArrayBuffer;
-  /** TARGET_MAIN_APP = 0 */
+  /** FW_MGMT_TARGET_APPLICATION_P2 = 5 */
   applicationP2Binary?: ArrayBuffer;
-  /** TARGET_BT = 2 */
+  /** FW_MGMT_TARGET_COPROCESSOR = 6 */
   coprocessorBinary?: ArrayBuffer;
-  /** TARGET_SE1-4 = 3-6 */
+  /** FW_MGMT_TARGET_SE01-04 = 7-10 */
   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;
+  /**
+   * RESC bundle okpkg 列表，通过 FilesystemFileWrite 直写到 devicePath（vol0:/bundles/...）。
+   * 手动传入模式：SDK 直接 FileWrite 安装，不做版本比对。
+   */
+  resourceBundleFiles?: Array<{
+    binary: ArrayBuffer;
+    devicePath: string;
+  }>;
 }
 
 export declare function firmwareUpdateV3(

package/src/types/api/getDeviceInfo.ts

@@ -24,6 +24,8 @@ export type DeviceInfoStatus = {
   bootloaderMode: boolean | null;
   unlocked: boolean | null;
   passphraseProtection: boolean | null;
+  attachToPinEnabled?: boolean | null;
+  unlockedAttachPin?: boolean | null;
   backupRequired: boolean | null;
   noBackup: boolean | null;
   language: string | null;

package/src/types/api/index.ts

@@ -1,18 +1,15 @@
 import type {
+  deviceFactoryInfoGet,
+  deviceFactoryInfoSet,
   deviceFirmwareUpdate,
-  deviceGetDeviceInfo,
   deviceGetFirmwareUpdateStatus,
-  deviceGetOnboardingStatus,
+  deviceInfoGet,
   deviceReboot,
-  devFirmwareUpdate,
-  devGetDeviceInfo,
-  devGetFirmwareUpdateStatus,
-  devReboot,
+  deviceSessionGet,
+  deviceStatusGet,
   dirList,
   dirMake,
   dirRemove,
-  factoryDeviceInfoSettings,
-  factoryGetDeviceInfo,
   fileDelete,
   fileRead,
   fileWrite,
@@ -23,12 +20,12 @@ import type {
   filesystemFileDelete,
   filesystemFileRead,
   filesystemFileWrite,
-  filesystemFixPermission,
   filesystemFormat,
   filesystemPathInfoQuery,
-  getProtoVersion,
+  filesystemPermissionFix,
   pathInfo,
   ping,
+  protocolInfoRequest,
 } from './protocolV2';
 import type { off, on, removeAllListeners } from './event';
 import type { uiResponse } from './uiResponse';
@@ -36,6 +33,7 @@ import type { init, updateSettings } from './init';
 import type { testInitializeDeviceDuration } from './testInitializeDeviceDuration';
 import type { preInitialize } from './preInitialize';
 import type { getLogs } from './getLogs';
+import type { clearSessionCache } from './sessionCache';
 import type { checkBridgeStatus } from './checkBridgeStatus';
 import type { checkBridgeRelease } from './checkBridgeRelease';
 import type { checkBootloaderRelease } from './checkBootloaderRelease';
@@ -182,6 +180,7 @@ export type {
   DeviceProfileVersions,
 } from './getDeviceInfo';
 export type { GetPassphraseStateParams, GetPassphraseStatePayload } from './getPassphraseState';
+export type { ClearSessionCacheParams, ClearSessionCachePayload } from './sessionCache';
 
 export type CoreApi = {
   /**
@@ -199,6 +198,7 @@ export type CoreApi = {
   updateSettings: typeof updateSettings;
   switchTransport: (env: ConnectSettings['env']) => Promise<{ success: boolean }>;
   getLogs: typeof getLogs;
+  clearSessionCache: typeof clearSessionCache;
 
   /**
    * Test function
@@ -255,20 +255,17 @@ export type CoreApi = {
   /**
    * File system & device control API (Protocol V2 only)
    */
-  getProtoVersion: typeof getProtoVersion;
+  protocolInfoRequest: typeof protocolInfoRequest;
   ping: typeof ping;
   deviceReboot: typeof deviceReboot;
-  deviceGetDeviceInfo: typeof deviceGetDeviceInfo;
-  deviceGetOnboardingStatus: typeof deviceGetOnboardingStatus;
+  deviceInfoGet: typeof deviceInfoGet;
+  deviceStatusGet: typeof deviceStatusGet;
+  deviceSessionGet: typeof deviceSessionGet;
   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;
+  deviceFactoryInfoSet: typeof deviceFactoryInfoSet;
+  deviceFactoryInfoGet: typeof deviceFactoryInfoGet;
+  filesystemPermissionFix: typeof filesystemPermissionFix;
   fileRead: typeof fileRead;
   fileWrite: typeof fileWrite;
   fileDelete: typeof fileDelete;

package/src/types/api/protocolV2.ts

@@ -1,32 +1,37 @@
 import type { CommonParams, Response } from '../params';
 import type {
-  DevFirmwareUpdateStatus,
-  FactoryDeviceInfo,
-  OnboardingStatus,
-  ProtoVersion,
+  DeviceFactoryInfo,
+  DeviceFirmwareUpdateStatus,
+  DeviceSession,
+  DeviceStatus,
+  ProtocolInfo,
   ProtocolV2DeviceInfo,
   Success,
 } from '@onekeyfe/hd-transport';
 import type {
+  DeviceFactoryInfoSetParams,
   DeviceFirmwareUpdateParams,
+  DeviceFirmwareUpdateStatusGetParams,
   DeviceRebootParams,
-  FactoryDeviceInfoSettingsParams,
 } from '../../api/protocol-v2/helpers';
-import type { DeviceGetDeviceInfoParams } from '../../api/protocol-v2/DeviceGetDeviceInfo';
+import type { DeviceInfoGetParams } from '../../api/protocol-v2/DeviceInfoGet';
+import type { DeviceSessionGetParams } from '../../api/protocol-v2/DeviceSessionGet';
 
 // 参数类型单源：以 api/protocol-v2 的实现为准（type-only re-export，无运行时依赖）
 export type {
   DeviceFirmwareTargetInput,
   DeviceFirmwareUpdateParams,
+  DeviceFirmwareUpdateStatusGetParams,
   DeviceRebootParams,
-  FactoryDeviceInfoSettingsParams,
+  DeviceFactoryInfoSetParams,
   RebootTypeInput,
 } from '../../api/protocol-v2/helpers';
 export type {
-  DeviceGetDeviceInfoParams,
-  DeviceGetDeviceInfoTargets,
-  DeviceGetDeviceInfoTypes,
-} from '../../api/protocol-v2/DeviceGetDeviceInfo';
+  DeviceInfoGetParams,
+  DeviceInfoGetTargets,
+  DeviceInfoGetTypes,
+} from '../../api/protocol-v2/DeviceInfoGet';
+export type { DeviceSessionGetParams } from '../../api/protocol-v2/DeviceSessionGet';
 
 // ── Shared response shapes (Protocol V2 file system) ────────────────────
 
@@ -67,10 +72,10 @@ export type PathInfoResult = {
 
 // ── Method signatures ─────────────────────────────────────────────────────
 
-export declare function getProtoVersion(
+export declare function protocolInfoRequest(
   connectId: string,
   params?: CommonParams
-): Response<ProtoVersion>;
+): Response<ProtocolInfo>;
 
 export declare function ping(
   connectId: string,
@@ -82,55 +87,46 @@ export declare function deviceReboot(
   params: CommonParams & DeviceRebootParams
 ): Response<Success>;
 
-export declare function deviceGetDeviceInfo(
+export declare function deviceInfoGet(
   connectId: string,
-  params?: CommonParams & DeviceGetDeviceInfoParams
+  params?: CommonParams & DeviceInfoGetParams
 ): Response<ProtocolV2DeviceInfo>;
 
-export declare function deviceGetOnboardingStatus(
+export declare function deviceStatusGet(
   connectId: string,
   params?: CommonParams
-): Response<OnboardingStatus>;
+): Response<DeviceStatus>;
+
+export declare function deviceSessionGet(
+  connectId: string,
+  params?: CommonParams & DeviceSessionGetParams
+): Response<DeviceSession>;
 
 export declare function deviceFirmwareUpdate(
   connectId: string,
   params: CommonParams & DeviceFirmwareUpdateParams
-): Response<Success | DevFirmwareUpdateStatus>;
+): Response<Success | DeviceFirmwareUpdateStatus>;
 
 export declare function deviceGetFirmwareUpdateStatus(
   connectId: string,
-  params?: CommonParams
-): Response<DevFirmwareUpdateStatus>;
+  params?: CommonParams & DeviceFirmwareUpdateStatusGetParams
+): Response<DeviceFirmwareUpdateStatus>;
 
-export declare function devReboot(
+export declare function deviceFactoryInfoSet(
   connectId: string,
-  params: CommonParams & DeviceRebootParams
+  params: CommonParams & DeviceFactoryInfoSetParams
 ): Response<Success>;
 
-export declare function devGetDeviceInfo(
-  connectId: string,
-  params?: CommonParams & DeviceGetDeviceInfoParams
-): Response<ProtocolV2DeviceInfo>;
-
-export declare function devFirmwareUpdate(
-  connectId: string,
-  params: CommonParams & DeviceFirmwareUpdateParams
-): Response<Success | DevFirmwareUpdateStatus>;
-
-export declare function devGetFirmwareUpdateStatus(
+export declare function deviceFactoryInfoGet(
   connectId: string,
   params?: CommonParams
-): Response<DevFirmwareUpdateStatus>;
+): Response<DeviceFactoryInfo>;
 
-export declare function factoryDeviceInfoSettings(
+export declare function filesystemPermissionFix(
   connectId: string,
-  params: FactoryDeviceInfoSettingsParams
+  params?: CommonParams
 ): Response<Success>;
 
-export declare function factoryGetDeviceInfo(connectId: string): Response<FactoryDeviceInfo>;
-
-export declare function filesystemFixPermission(connectId: string): Response<Success>;
-
 export declare function fileRead(
   connectId: string,
   params: {

package/src/types/api/sessionCache.ts

@@ -0,0 +1,14 @@
+import type { Response } from '../params';
+
+export type ClearSessionCacheParams = {
+  deviceId?: string;
+  passphraseState?: string;
+};
+
+export type ClearSessionCachePayload = {
+  cleared: true;
+};
+
+export declare function clearSessionCache(
+  params?: ClearSessionCacheParams
+): Response<ClearSessionCachePayload>;

package/src/types/device.ts

@@ -157,6 +157,7 @@ export type Features = {
   sdProtection: boolean | null;
   wipeCodeProtection: boolean | null;
   passphraseAlwaysOnDevice: boolean | null;
+  attachToPinEnabled?: boolean | null;
   safetyChecks: string | null;
   autoLockDelayMs: number | null;
   displayRotation: number | null;

package/src/types/params.ts

@@ -14,6 +14,10 @@ export interface CommonParams {
    * Timeout time for single polling
    */
   timeout?: number;
+  /**
+   * Protocol V2 初始化阶段 DeviceInfoGet 超时时间
+   */
+  protocolV2DeviceInfoTimeoutMs?: number;
   /**
    * passphrase state
    */

package/src/types/settings.ts

@@ -34,17 +34,46 @@ export type ConnectSettings = {
   fetchConfig?: boolean;
   extension?: string;
   configFetcher?: (url: string) => Promise<RemoteConfigResponse | null>;
-  /**
-   * 临时开关：Protocol V2 DevGetDeviceInfo 未稳定前用于 mock 设备信息。
-   * 正式 app 可显式设置为 false 以调用真实 DevGetDeviceInfo；固件稳定后删除。
-   */
-  protocolV2DeviceInfoMockEnabled?: boolean;
 };
 
 export type IVersionArray = [number, number, number];
 
 export type ILocale = 'zh-CN' | 'en-US';
 
+export type IProtocolV2FirmwareComponentTarget =
+  | 'ROMLOADER'
+  | 'BOOTLOADER'
+  | 'APPLICATION_P1'
+  | 'APPLICATION_P2'
+  | 'COPROCESSOR'
+  | 'SE01'
+  | 'SE02'
+  | 'SE03'
+  | 'SE04';
+
+export type IProtocolV2FirmwareComponent = {
+  target: IProtocolV2FirmwareComponentTarget;
+  url: string;
+  fingerprint?: string;
+  version?: IVersionArray;
+};
+
+/** Pro2 RESC bundle okpkg 描述，用于 FileWrite 直写方式增量同步资源 */
+export type IProtocolV2ResourceBundle = {
+  /** bundle 名称，如 images / animation / translations / fonts_roobert */
+  name: string;
+  /** 下载 URL */
+  url: string;
+  /** 设备上的目标路径，如 vol0:/bundles/images/images.okpkg */
+  devicePath: string;
+  /** okpkg container 的 payload_version（用于 FileRead 比对跳过） */
+  version?: IVersionArray;
+  /** okpkg container 的 payload_hash（SHA3-512，用于 FileRead 比对） */
+  payloadHash?: string;
+  /** okpkg container 的 header_hash（SHA3-512，用于 FileRead 比对） */
+  headerHash?: string;
+};
+
 /** STM32 firmware config */
 export type IFirmwareReleaseInfo = {
   required: boolean;
@@ -63,6 +92,11 @@ export type IFirmwareReleaseInfo = {
   bootloaderVersion?: IVersionArray;
   displayBootloaderVersion?: IVersionArray;
   bootloaderRelatedFirmwareVersion?: IVersionArray;
+  upgradeType?: 'payload-package-set' | string;
+  components?: Record<string, IProtocolV2FirmwareComponent>;
+  installOrder?: string[];
+  /** Pro2 RESC bundle 列表（FileWrite 直写增量同步模式） */
+  resourceBundles?: IProtocolV2ResourceBundle[];
   bootloaderChangelog?: {
     [k in ILocale]: string;
   };
@@ -88,43 +122,16 @@ export type IBLEFirmwareReleaseInfo = {
   };
 };
 
-type IKnownDevice = Exclude<IDeviceType, 'unknown' | 'pro2'>;
+type IKnownDevice = Exclude<IDeviceType, 'unknown'>;
 
-/**
- * Device firmware configuration map
- *
- * IMPORTANT: This type is used for firmware update logic.
- * - DO NOT remove existing firmware fields
- * - Only ADD new optional firmware fields for new versions
- * - 'firmware' field is required for backward compatibility
- * - 'ble' field is required for BLE firmware updates
- *
- * @example
- * // When adding firmware-v8:
- * // {
- * //   firmware: IFirmwareReleaseInfo[];
- * //   'firmware-v2'?: IFirmwareReleaseInfo[];
- * //   'firmware-v8'?: IFirmwareReleaseInfo[];
- * //   'firmware-v8'?: IFirmwareReleaseInfo[];      // New
- * //   'firmware-btc-v8'?: IFirmwareReleaseInfo[];
- * //   'firmware-btc-v8'?: IFirmwareReleaseInfo[];  // New
- * //   ble: IBLEFirmwareReleaseInfo[];
- * // }
- */
 export type DeviceTypeMap = {
   [k in IKnownDevice]: {
-    /** Base firmware field (required for backward compatibility) */
     firmware: IFirmwareReleaseInfo[];
-    /** Firmware v2 (Touch/Pro specific) */
+    /** Pro2 Protocol V2 payload package set */
+    'firmware-v1'?: IFirmwareReleaseInfo[];
     'firmware-v2'?: IFirmwareReleaseInfo[];
-    /** Universal firmware v7 */
     'firmware-v8'?: IFirmwareReleaseInfo[];
-    /** Bitcoin-only firmware v7 */
     'firmware-btc-v8'?: IFirmwareReleaseInfo[];
-    // Future firmware versions should be added here as optional fields:
-    // 'firmware-v8'?: IFirmwareReleaseInfo[];
-    // 'firmware-btc-v8'?: IFirmwareReleaseInfo[];
-    /** BLE firmware (required) */
     ble: IBLEFirmwareReleaseInfo[];
   };
 };