@onekeyfe/hd-core 1.2.0-alpha.4 → 1.2.0-alpha.40

package/src/types/api/protocolV2.ts

@@ -1,36 +1,28 @@
 import type { CommonParams, Response } from '../params';
+import type { OnboardingStatus, Success } from '@onekeyfe/hd-transport';
+import type { DeviceRebootParams } from '../../api/protocol-v2/helpers';
 import type {
-  DeviceFirmwareUpdateStatus,
-  DeviceFactoryInfo,
-  ProtocolInfo,
-  ProtocolV2DeviceInfo,
-  Success,
-} from '@onekeyfe/hd-transport';
+  DeviceUploadWallpaperParams,
+  DeviceUploadWallpaperResponse,
+} from '../../api/protocol-v2/DeviceUploadWallpaper';
 import type {
-  DeviceFirmwareUpdateParams,
-  DeviceRebootParams,
-  DeviceFactoryInfoSetParams,
-} from '../../api/protocol-v2/helpers';
-import type { DeviceInfoGetParams } from '../../api/protocol-v2/DeviceInfoGet';
+  DeviceUploadNftParams,
+  DeviceUploadNftResponse,
+} from '../../api/protocol-v2/DeviceUploadNft';
 
-// 参数类型单源：以 api/protocol-v2 的实现为准（type-only re-export，无运行时依赖）
+// Re-export implementation parameter types as the single source of truth.
+export type { DeviceRebootParams, RebootTypeInput } from '../../api/protocol-v2/helpers';
 export type {
-  DeviceFirmwareTargetInput,
-  DeviceFirmwareUpdateParams,
-  DeviceRebootParams,
-  DeviceFactoryInfoSetParams,
-  RebootTypeInput,
-} from '../../api/protocol-v2/helpers';
+  DeviceUploadWallpaperParams,
+  DeviceUploadWallpaperResponse,
+} from '../../api/protocol-v2/DeviceUploadWallpaper';
 export type {
-  DeviceInfoGetParams,
-  DeviceInfoGetTargets,
-  DeviceInfoGetTypes,
-} from '../../api/protocol-v2/DeviceInfoGet';
+  DeviceUploadNftParams,
+  DeviceUploadNftResponse,
+} from '../../api/protocol-v2/DeviceUploadNft';
 
 // ── Shared response shapes (Protocol V2 file system) ────────────────────
 
-export type FileOpSuccess = { message?: string };
-
 export type FileInfo = {
   path: string;
   offset: number;
@@ -41,39 +33,16 @@ export type FileInfo = {
   chunks?: number;
 };
 
-export type DirInfo = {
-  path: string;
-  child_dirs?: string;
-  child_files?: string;
-};
-
-// proto 中 FilesystemPathInfo 的全部字段均为 required，类型与之保持一致
-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;
-};
-
 // ── Method signatures ─────────────────────────────────────────────────────
 
-export declare function protocolInfoRequest(
-  connectId: string,
-  params?: CommonParams
-): Response<ProtocolInfo>;
+export type TestProtocolV2PingParams = CommonParams & {
+  /** Firmware diagnostic echo payload, limited to 63 UTF-8 bytes. */
+  message?: string;
+};
 
-export declare function ping(
+export declare function testProtocolV2Ping(
   connectId: string,
-  params?: CommonParams & { message?: string }
+  params?: TestProtocolV2PingParams
 ): Response<Success>;
 
 export declare function deviceReboot(
@@ -81,100 +50,25 @@ export declare function deviceReboot(
   params: CommonParams & DeviceRebootParams
 ): Response<Success>;
 
-export declare function deviceInfoGet(
-  connectId: string,
-  params?: CommonParams & DeviceInfoGetParams
-): Response<ProtocolV2DeviceInfo>;
-
-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 deviceFactoryInfoSet(
-  connectId: string,
-  params: CommonParams & DeviceFactoryInfoSetParams
-): Response<Success>;
-
-export declare function deviceFactoryInfoGet(
+export declare function deviceGetOnboardingStatus(
   connectId: string,
   params?: CommonParams
-): Response<DeviceFactoryInfo>;
+): Response<OnboardingStatus>;
 
-export declare function filesystemPermissionFix(
+export declare function deviceUploadWallpaper(
   connectId: string,
-  params?: CommonParams
-): Response<Success>;
+  params: CommonParams & DeviceUploadWallpaperParams
+): Response<DeviceUploadWallpaperResponse>;
 
-export declare function fileRead(
+export declare function deviceUploadNft(
   connectId: string,
-  params: {
-    path: string;
-    offset?: number;
-    totalSize?: number;
-    chunkLen?: number;
-    uiPercentage?: number;
-  }
-): Response<FileInfo>;
+  params: CommonParams & DeviceUploadNftParams
+): Response<DeviceUploadNftResponse>;
 
-export declare function fileWrite(
+export declare function uploadPortfolio(
   connectId: string,
   params: {
-    path: string;
-    offset?: number;
-    totalSize?: number;
-    chunkSize?: number;
-    chunkLen?: number;
-    data: ArrayBuffer | Uint8Array | Blob | string;
-    overwrite?: boolean;
-    append?: boolean;
-    uiPercentage?: number;
+    packageBytes: ArrayBuffer | Uint8Array | Blob;
     timeoutMs?: number | string;
   }
-): 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; timeoutMs?: number | string }
-): Response<PathInfoResult>;
-
-export declare const filesystemFileRead: typeof fileRead;
-export declare const filesystemFileWrite: typeof fileWrite;
-export declare const filesystemFileDelete: typeof fileDelete;
-export declare const filesystemDirList: typeof dirList;
-export declare const filesystemDirMake: typeof dirMake;
-export declare const filesystemDirRemove: typeof dirRemove;
-export declare const filesystemPathInfoQuery: typeof pathInfo;
-
-export declare function filesystemFormat(connectId: string): Response<Success>;
-
-export declare function filesystemDiskControl(
-  connectId: string,
-  // enable 收紧为 boolean | 0 | 1（兼容历史的 '0' / '1' 字符串输入，内部归一化为 0/1）
-  params: CommonParams & { enable: boolean | 0 | 1; timeoutMs?: number | string }
-): Response<Success>;
+): Response<FileInfo & { portfolioUpdated: true }>;

package/src/types/api/sessionCache.ts

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

package/src/types/device.ts

@@ -1,8 +1,14 @@
-import { EDeviceType, type EFirmwareType } from '@onekeyfe/hd-shared';
+import { EDeviceType, type EFirmwareType, type HardwareConnectProtocol } from '@onekeyfe/hd-shared';
 
 import type { IVersionArray } from './settings';
 import type { PROTO } from '../constants';
-import type { OneKeyDeviceCommType, ProtocolV2DeviceInfo } from '@onekeyfe/hd-transport';
+import type {
+  Enum_SafetyCheckLevel,
+  OneKeyDeviceCommType,
+  ProtocolV2DeviceInfo,
+  DeviceStatus as ProtocolV2DeviceStatus,
+  ProtocolInfo as ProtocolV2ProtocolInfo,
+} from '@onekeyfe/hd-transport';
 
 export type DeviceStatus = 'available' | 'occupied' | 'used';
 
@@ -23,6 +29,14 @@ export type UnavailableCapabilities = { [key: string]: UnavailableCapability };
 
 export type KnownDevice = {
   connectId: string | null;
+  /** Protocol family confirmed by the transport's active probe. */
+  connectProtocol?: HardwareConnectProtocol;
+  /**
+   * 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;
@@ -32,9 +46,12 @@ export type KnownDevice = {
   bleName: string | null;
   name: string;
   error?: typeof undefined;
+  /** Current SDK/transport usage state for connection indicators. */
+  status?: DeviceStatus;
   mode: EOneKeyDeviceMode;
-  features?: Features;
-  sessionId?: string | null;
+  features: Features;
+  /** Unified SDK device-state snapshot; features remains a legacy projection. */
+  state?: DeviceState;
   unavailableCapabilities: UnavailableCapabilities;
   bleFirmwareVersion: IVersionArray | null;
   firmwareVersion: IVersionArray | null;
@@ -47,6 +64,19 @@ export type KnownDevice = {
 
 export type SearchDevice = {
   connectId: string | null;
+  /** Protocol family confirmed by the transport's active probe. */
+  connectProtocol?: HardwareConnectProtocol;
+  /**
+   * 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;
@@ -91,6 +121,7 @@ export type DeviceFeaturesProtocol = 'V1' | 'V2' | 'unknown';
 export type DeviceFeaturesMode =
   | 'normal'
   | 'bootloader'
+  | 'romloader'
   | 'notInitialized'
   | 'backupMode'
   | 'unknown';
@@ -98,6 +129,10 @@ export type DeviceFeaturesMode =
 export type DeviceFeaturesVerify = {
   firmwareBuildId?: string;
   firmwareHash?: string;
+  applicationP1BuildId?: string;
+  applicationP1Hash?: string;
+  applicationP2BuildId?: string;
+  applicationP2Hash?: string;
   bootloaderBuildId?: string;
   bootloaderHash?: string;
   boardBuildId?: string;
@@ -125,10 +160,139 @@ export type DeviceFeaturesVerify = {
 export type DeviceFeaturesRaw = {
   protocolV1Features?: PROTO.Features;
   protocolV1OneKeyFeatures?: OnekeyFeatures;
+  protocolV2ProtocolInfo?: ProtocolV2ProtocolInfo;
   protocolV2DeviceInfo?: ProtocolV2DeviceInfo;
+  protocolV2DeviceStatus?: ProtocolV2DeviceStatus;
 };
 
-export type Features = {
+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'
+  | 'settings-read'
+  | 'settings-write'
+  | '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: Enum_SafetyCheckLevel | 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;
+  applicationP1?: string | null;
+  applicationP2?: 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;
@@ -158,10 +322,21 @@ export type Features = {
   wipeCodeProtection: boolean | null;
   passphraseAlwaysOnDevice: boolean | null;
   attachToPinEnabled?: boolean | null;
-  safetyChecks: string | null;
+  safetyChecks: Enum_SafetyCheckLevel | 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;
@@ -182,6 +357,10 @@ export type Features = {
   raw?: DeviceFeaturesRaw;
 };
 
+export type Features = NormalizedFeatures &
+  Partial<Omit<PROTO.Features, keyof NormalizedFeatures>> &
+  Partial<Omit<PROTO.OnekeyFeatures, keyof NormalizedFeatures | keyof PROTO.Features>>;
+
 export type OnekeyFeatures = PROTO.OnekeyFeatures;
 
 export type IDeviceType =
@@ -233,7 +412,6 @@ export type ITransportStatus = 'valid' | 'outdated';
 export type IVersionRange = {
   min: string;
   max?: string;
-  unsupported?: boolean;
 };
 
 export type DeviceFirmwareRange = {

package/src/types/params.ts

@@ -15,7 +15,7 @@ export interface CommonParams {
    */
   timeout?: number;
   /**
-   * Protocol V2 初始化阶段 DeviceInfoGet 超时时间
+   * DeviceInfoGet timeout during Protocol V2 initialization.
    */
   protocolV2DeviceInfoTimeoutMs?: number;
   /**
@@ -60,7 +60,8 @@ export interface CommonParams {
   usePreInitialize?: boolean;
 
   /**
-   * Expected transport protocol. If omitted, SDK probes Protocol V1 then Protocol V2.
+   * Strictly expected transport protocol. The SDK actively verifies this value and
+   * rejects a mismatch. If omitted, a cached protocol only influences probe order.
    */
   connectProtocol?: HardwareConnectProtocol;
 }

package/src/types/settings.ts

@@ -49,34 +49,34 @@ export type IProtocolV2FirmwareComponentTarget =
   | 'SE01'
   | 'SE02'
   | 'SE03'
-  | 'SE04'
-  | 'CRATE';
+  | 'SE04';
 
 export type IProtocolV2FirmwareComponent = {
   target: IProtocolV2FirmwareComponentTarget;
   url: string;
+  /** SHA-256 of the complete okpkg, used after downloading the package. */
   fingerprint?: string;
+  /** OKPP payload hash, used to detect same-version package changes. */
+  payloadHash?: string;
   version?: IVersionArray;
-  resourceManifest?: IProtocolV2ResourceManifest;
 };
 
-export type IProtocolV2ResourceManifestPackage = {
-  name?: string;
-  path: string;
-  type?: string;
+/** 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;
+  /** Device target path, such as vol0:/bundles/images/images.okpkg. */
+  devicePath: string;
+  /** okpkg payload_version used to skip matching content after FileRead. */
   version?: IVersionArray;
-  sha256?: string;
+  /** okpkg payload_hash used for SHA3-512 comparison after FileRead. */
   payloadHash?: string;
+  /** okpkg header_hash used for SHA3-512 comparison after FileRead. */
   headerHash?: string;
 };
 
-export type IProtocolV2ResourceManifest = {
-  format?: 'okpkg-crate' | string;
-  target?: 'CRATE' | string;
-  version?: IVersionArray;
-  packages: IProtocolV2ResourceManifestPackage[];
-};
-
 /** STM32 firmware config */
 export type IFirmwareReleaseInfo = {
   required: boolean;
@@ -98,7 +98,8 @@ export type IFirmwareReleaseInfo = {
   upgradeType?: 'payload-package-set' | string;
   components?: Record<string, IProtocolV2FirmwareComponent>;
   installOrder?: string[];
-  resourceManifest?: IProtocolV2ResourceManifest;
+  /** Pro2 RESC bundles for incremental direct FileWrite synchronization. */
+  resourceBundles?: IProtocolV2ResourceBundle[];
   bootloaderChangelog?: {
     [k in ILocale]: string;
   };

package/src/utils/assets.ts

@@ -1,5 +1,8 @@
 import { httpRequest as browserHttpRequest } from './networkUtils';
 
-export const httpRequest = (url: string, type: string): any => browserHttpRequest(url, type);
+import type { HttpRequestOptions } from './networkUtils';
+
+export const httpRequest = (url: string, type: string, options?: HttpRequestOptions): any =>
+  browserHttpRequest(url, type, options);
 
 export const getTimeStamp = () => new Date().getTime();