@onekeyfe/hd-core 1.1.34-alpha.3 → 1.1.34-alpha.4

package/src/types/device.ts

@@ -1,12 +1,8 @@
-import { EDeviceType, type EFirmwareType } from '@onekeyfe/hd-shared';
+import { EDeviceType } from '@onekeyfe/hd-shared';
 
 import type { IVersionArray } from './settings';
 import type { PROTO } from '../constants';
-import type {
-  OneKeyDeviceCommType,
-  ProtocolV2DeviceInfo,
-  DeviceStatus as ProtocolV2DeviceStatus,
-} from '@onekeyfe/hd-transport';
+import type { OneKeyDeviceCommType } from '@onekeyfe/hd-transport';
 
 export type DeviceStatus = 'available' | 'occupied' | 'used';
 
@@ -27,12 +23,6 @@ export type UnavailableCapabilities = { [key: string]: UnavailableCapability };
 
 export type KnownDevice = {
   connectId: string | null;
-  /**
-   * Stable physical-device identity. Current SDK responses always include this
-   * value; it remains optional in the type during the uuid compatibility window.
-   */
-  serialNo?: string;
-  /** @deprecated Use serialNo instead. */
   uuid: string;
   deviceId: string | null;
   deviceType: IDeviceType | null;
@@ -43,9 +33,7 @@ export type KnownDevice = {
   name: string;
   error?: typeof undefined;
   mode: EOneKeyDeviceMode;
-  features?: Features;
-  /** Unified SDK device-state snapshot; features remains a legacy projection. */
-  state?: DeviceState;
+  features: PROTO.Features;
   unavailableCapabilities: UnavailableCapabilities;
   bleFirmwareVersion: IVersionArray | null;
   firmwareVersion: IVersionArray | null;
@@ -58,17 +46,6 @@ export type KnownDevice = {
 
 export type SearchDevice = {
   connectId: string | null;
-  /**
-   * Available after device initialization. BLE discovery does not connect to the
-   * device, so it returns null until a later initialized device response. Current
-   * SDK responses always include the field; it remains optional in the type during
-   * the uuid compatibility window.
-   */
-  serialNo?: string | null;
-  /**
-   * @deprecated Ambiguous legacy identifier. Use serialNo for hardware identity
-   * and connectId for transport routing.
-   */
   uuid: string;
   deviceId: string | null;
   deviceType: IDeviceType;
@@ -108,242 +85,7 @@ export type SearchDevice = {
 
 export type Device = KnownDevice;
 
-export type DeviceFeaturesProtocol = 'V1' | 'V2' | 'unknown';
-
-export type DeviceFeaturesMode =
-  | 'normal'
-  | 'bootloader'
-  | 'romloader'
-  | 'notInitialized'
-  | 'backupMode'
-  | 'unknown';
-
-export type DeviceFeaturesVerify = {
-  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 DeviceFeaturesRaw = {
-  protocolV1Features?: PROTO.Features;
-  protocolV1OneKeyFeatures?: OnekeyFeatures;
-  protocolV2DeviceInfo?: ProtocolV2DeviceInfo;
-  protocolV2DeviceStatus?: ProtocolV2DeviceStatus;
-};
-
-export type DeviceFeaturesRawPatch = {
-  [Key in keyof DeviceFeaturesRaw]?: DeviceFeaturesRaw[Key] | null;
-};
-
-export type DeviceStateProtocol = DeviceFeaturesProtocol;
-export type DeviceStateMode = DeviceFeaturesMode;
-export type DeviceStateSection = 'identity' | 'status' | 'settings' | 'versions' | 'verification';
-
-export type DeviceStateUpdateSource =
-  | 'initialize'
-  | 'device-info'
-  | 'device-status'
-  | 'apply-settings'
-  | 'change-pin'
-  | 'lock'
-  | 'unlock'
-  | 'passphrase'
-  | 'session-clear'
-  | 'firmware-update'
-  | 'transport-reconnect'
-  | 'compatibility';
-
-export type DeviceStateIdentity = {
-  deviceType: IDeviceType;
-  firmwareType: EFirmwareType;
-  model: string | null;
-  vendor: string | null;
-  deviceId: string | null;
-  serialNo: string;
-  label: string | null;
-  bleName: string | null;
-};
-
-export type DeviceStateStatus = {
-  mode: DeviceStateMode;
-  initialized: boolean | null;
-  unlocked: boolean | null;
-  firmwarePresent: boolean | null;
-  backupRequired: boolean | null;
-  noBackup: boolean | null;
-  unfinishedBackup: boolean | null;
-  recoveryMode: boolean | null;
-  passphraseProtection: boolean | null;
-  pinProtection: boolean | null;
-  attachToPinEnabled: boolean | null;
-  unlockedAttachPin: boolean | null;
-};
-
-export type DeviceStateSettings = {
-  language: string | null;
-  bleEnabled: boolean | null;
-  sdCardPresent: boolean | null;
-  sdProtection: boolean | null;
-  wipeCodeProtection: boolean | null;
-  passphraseAlwaysOnDevice: boolean | null;
-  safetyChecks: string | null;
-  autoLockDelayMs: number | null;
-  autoShutdownDelayMs: number | null;
-  displayRotation: number | null;
-  experimentalFeatures: boolean | null;
-  wallpaperPath: string | null;
-  brightness: number | null;
-  animationEnabled: boolean | null;
-  tapToWake: boolean | null;
-  hapticFeedback: boolean | null;
-  deviceNameDisplayEnabled: boolean | null;
-  airgapMode: boolean | null;
-  fidoEnabled: boolean | null;
-  usbLockEnabled: boolean | null;
-  randomKeypad: boolean | null;
-};
-
-export type DeviceStateVersions = {
-  firmware: string | null;
-  bootloader: string | null;
-  board: string | null;
-  ble: string | null;
-  /** @deprecated Kept for legacy consumers; new code should read se01. */
-  se?: 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 DeviceState = {
-  schemaVersion: 1;
-  revision: number;
-  updatedAt: number;
-  protocol: DeviceStateProtocol;
-  /** Device-message protocol version, independent of the SDK V1/V2 protocol family. */
-  protocolVersion: number | null;
-  identity: DeviceStateIdentity;
-  status: DeviceStateStatus;
-  settings: DeviceStateSettings;
-  versions: DeviceStateVersions;
-  capabilities: Array<number | string>;
-  verification?: Partial<DeviceFeaturesVerify>;
-};
-
-export type DeviceStatePatch = {
-  protocol?: DeviceStateProtocol;
-  protocolVersion?: number | null;
-  identity?: Partial<DeviceStateIdentity>;
-  status?: Partial<DeviceStateStatus>;
-  settings?: Partial<DeviceStateSettings>;
-  versions?: Partial<DeviceStateVersions>;
-  capabilities?: Array<number | string>;
-  verification?: DeviceFeaturesVerify;
-  raw?: DeviceFeaturesRawPatch;
-};
-
-export type DeviceStateEvent = {
-  connectId: string | null;
-  state: DeviceState;
-  revision: number;
-  source: DeviceStateUpdateSource;
-  changedKeys: string[];
-};
-
-export type NormalizedFeatures = {
-  protocol: DeviceFeaturesProtocol;
-  protocolVersion?: number | null;
-  deviceType: IDeviceType;
-  firmwareType: EFirmwareType;
-  model: string | null;
-  vendor: string | null;
-  deviceId: string | null;
-  serialNo: string;
-  label: string | null;
-  bleName: string | null;
-  capabilities: Array<number | string>;
-  mode: DeviceFeaturesMode;
-  initialized: boolean | null;
-  bootloaderMode: boolean | null;
-  unlocked: boolean | null;
-  firmwarePresent: boolean | null;
-  passphraseProtection: boolean | null;
-  pinProtection: boolean | null;
-  backupRequired: boolean | null;
-  noBackup: boolean | null;
-  unfinishedBackup: boolean | null;
-  recoveryMode: boolean | null;
-  language: string | null;
-  bleEnabled: boolean | null;
-  sdCardPresent: boolean | null;
-  sdProtection: boolean | null;
-  wipeCodeProtection: boolean | null;
-  passphraseAlwaysOnDevice: boolean | null;
-  attachToPinEnabled?: boolean | null;
-  safetyChecks: string | null;
-  autoLockDelayMs: number | null;
-  autoShutdownDelayMs: number | null;
-  displayRotation: number | null;
-  experimentalFeatures: boolean | null;
-  wallpaperPath: string | null;
-  brightness: number | null;
-  animationEnabled: boolean | null;
-  tapToWake: boolean | null;
-  hapticFeedback: boolean | null;
-  deviceNameDisplayEnabled: boolean | null;
-  airgapMode: boolean | null;
-  fidoEnabled: boolean | null;
-  usbLockEnabled: boolean | null;
-  randomKeypad: boolean | null;
-  firmwareVersion: string | null;
-  bootloaderVersion: string | null;
-  boardVersion: string | null;
-  bleVersion: string | null;
-  se01Version?: string | null;
-  se02Version?: string | null;
-  se03Version?: string | null;
-  se04Version?: string | null;
-  se01BootVersion?: string | null;
-  se02BootVersion?: string | null;
-  se03BootVersion?: string | null;
-  se04BootVersion?: string | null;
-  seVersion?: string | null;
-  verify?: DeviceFeaturesVerify;
-  sessionId: string | null;
-  passphraseState?: string;
-  unlockedAttachPin?: boolean;
-  raw?: DeviceFeaturesRaw;
-};
-
-export type Features = NormalizedFeatures &
-  Partial<Omit<PROTO.Features, keyof NormalizedFeatures>> &
-  Partial<Omit<PROTO.OnekeyFeatures, keyof NormalizedFeatures | keyof PROTO.Features>>;
+export type Features = PROTO.Features;
 
 export type OnekeyFeatures = PROTO.OnekeyFeatures;
 
@@ -354,8 +96,7 @@ export type IDeviceType =
   | EDeviceType.ClassicPure
   | EDeviceType.Mini
   | EDeviceType.Touch
-  | EDeviceType.Pro
-  | EDeviceType.Pro2;
+  | EDeviceType.Pro;
 
 /**
  * model_classic: 'classic' | 'classic1s' | 'classicpure'
@@ -383,7 +124,6 @@ export const DeviceTypeToModels: { [deviceType in IDeviceType]: IDeviceModel[] }
   [EDeviceType.Mini]: ['model_mini'],
   [EDeviceType.Touch]: ['model_touch'],
   [EDeviceType.Pro]: ['model_touch'],
-  [EDeviceType.Pro2]: [],
   [EDeviceType.Unknown]: [],
 };
 
@@ -396,7 +136,6 @@ export type ITransportStatus = 'valid' | 'outdated';
 export type IVersionRange = {
   min: string;
   max?: string;
-  unsupported?: boolean;
 };
 
 export type DeviceFirmwareRange = {

package/src/types/params.ts

@@ -1,5 +1,3 @@
-import type { HardwareConnectProtocol } from '@onekeyfe/hd-shared';
-
 export interface CommonParams {
   keepSession?: boolean;
   /**
@@ -14,10 +12,6 @@ export interface CommonParams {
    * Timeout time for single polling
    */
   timeout?: number;
-  /**
-   * DeviceInfoGet timeout during Protocol V2 initialization.
-   */
-  protocolV2DeviceInfoTimeoutMs?: number;
   /**
    * passphrase state
    */
@@ -58,11 +52,6 @@ export interface CommonParams {
    * Use pre-initialized device state (BLE only)
    */
   usePreInitialize?: boolean;
-
-  /**
-   * Expected transport protocol. If omitted, SDK probes Protocol V1 then Protocol V2.
-   */
-  connectProtocol?: HardwareConnectProtocol;
 }
 
 export type Params<T> = CommonParams & T & { bundle?: undefined };

package/src/types/settings.ts

@@ -31,8 +31,6 @@ export type ConnectSettings = {
   timestamp: number;
   isFrame?: boolean;
   preRelease?: boolean;
-  firmwareManifestMode?: 'sdk-managed' | 'external-only';
-  preloadedConfig?: RemoteConfigResponse;
   fetchConfig?: boolean;
   extension?: string;
   configFetcher?: (url: string) => Promise<RemoteConfigResponse | null>;
@@ -42,43 +40,6 @@ 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;
-  expectedSize?: number;
-  version?: IVersionArray;
-};
-
-/** Pro2 RESC bundle okpkg descriptor for incremental FileWrite synchronization. */
-export type IProtocolV2ResourceBundle = {
-  /** Bundle name, such as images, animation, translations, or fonts_roobert. */
-  name: string;
-  /** Download URL. */
-  url: string;
-  fingerprint?: string;
-  expectedSize?: number;
-  /** Device target path, such as vol0:/bundles/images/images.okpkg. */
-  devicePath: string;
-  /** okpkg payload_version used to skip matching content after FileRead. */
-  version?: IVersionArray;
-  /** okpkg payload_hash used for SHA3-512 comparison after FileRead. */
-  payloadHash?: string;
-  /** okpkg header_hash used for SHA3-512 comparison after FileRead. */
-  headerHash?: string;
-};
-
 /** STM32 firmware config */
 export type IFirmwareReleaseInfo = {
   required: boolean;
@@ -90,29 +51,17 @@ export type IFirmwareReleaseInfo = {
   firmwareType?: EFirmwareType;
   /** Firmware UI resource */
   resource?: string;
-  resourceFingerprint?: string;
-  resourceExpectedSize?: number;
   /** Firmware full UI resource */
   fullResource?: string;
-  fullResourceFingerprint?: string;
-  fullResourceExpectedSize?: number;
   fullResourceRange?: string[];
   bootloaderResource?: string;
-  bootloaderFingerprint?: string;
-  bootloaderExpectedSize?: number;
   bootloaderVersion?: IVersionArray;
   displayBootloaderVersion?: IVersionArray;
   bootloaderRelatedFirmwareVersion?: IVersionArray;
-  upgradeType?: 'payload-package-set' | string;
-  components?: Record<string, IProtocolV2FirmwareComponent>;
-  installOrder?: string[];
-  /** Pro2 RESC bundles for incremental direct FileWrite synchronization. */
-  resourceBundles?: IProtocolV2ResourceBundle[];
   bootloaderChangelog?: {
     [k in ILocale]: string;
   };
   fingerprint: string;
-  expectedSize?: number;
   version: IVersionArray;
   changelog: {
     [k in ILocale]: string;
@@ -128,7 +77,6 @@ export type IBLEFirmwareReleaseInfo = {
   webUpdate: string;
   fingerprint: string;
   fingerprintWeb: string;
-  expectedSize?: number;
   version: IVersionArray;
   changelog: {
     [k in ILocale]: string;
@@ -137,14 +85,41 @@ export type IBLEFirmwareReleaseInfo = {
 
 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[];
-    /** Pro2 Protocol V2 payload package set */
-    'firmware-v1'?: IFirmwareReleaseInfo[];
+    /** Firmware v2 (Touch/Pro specific) */
     '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[];
   };
 };

package/src/utils/capabilitieUtils.ts

@@ -2,7 +2,8 @@ import type { Enum_Capability } from '@onekeyfe/hd-transport';
 import type { Features } from '../types/device';
 
 export const existCapability = (features?: Features, capability?: Enum_Capability) =>
-  capability !== undefined && features?.capabilities?.includes(capability);
+  // @ts-expect-error
+  features?.capabilities?.includes(capability);
 
 export const requireCapability = (features: Features, capability: Enum_Capability) => {
   if (!existCapability(features, capability)) {