@onekeyfe/hd-core 1.2.0-alpha.6 → 1.2.0-alpha.62

package/src/topLevelInject.ts

@@ -1,6 +1,7 @@
 import EventEmitter from 'events';
 
 import { createCoreApi } from './inject';
+import { unregisterFirmwareUpdateHostBinding } from './api/firmware/FirmwareHostBinding';
 
 import type { ConnectSettings } from './types/settings';
 import type { CoreApi } from './types/api';
@@ -46,7 +47,10 @@ export const topLevelInject = () => {
       lowLevelApi?.removeAllListeners(type);
     },
 
-    dispose: () => lowLevelApi?.dispose(),
+    dispose: async () => {
+      unregisterFirmwareUpdateHostBinding();
+      await lowLevelApi?.dispose();
+    },
 
     uiResponse: response => lowLevelApi?.uiResponse(response),
 

package/src/types/api/checkAllFirmwareRelease.ts

@@ -1,8 +1,18 @@
-import type { IBLEFirmwareReleaseInfo } from '../settings';
 import type { EFirmwareType } from '@onekeyfe/hd-shared';
-import type { Features } from '@onekeyfe/hd-transport';
 import type { CommonParams, Response } from '../params';
-import type { IDeviceBLEFirmwareStatus, IDeviceFirmwareStatus } from '../device';
+import type {
+  DeviceStateVersions,
+  Features,
+  IDeviceBLEFirmwareStatus,
+  IDeviceFirmwareStatus,
+} from '../device';
+import type {
+  IBLEFirmwareReleaseInfo,
+  IFirmwareReleaseInfo,
+  IProtocolV2FirmwareComponentTarget,
+} from '../settings';
+import type { FirmwareUpdateV4Target } from './firmwareUpdate';
+import type { FirmwareUpdatePlan, FirmwareUpdatePlanForceTarget } from './firmwareUpdatePlan';
 
 export type FirmwareRelease = {
   shouldUpdate?: boolean;
@@ -11,21 +21,57 @@ export type FirmwareRelease = {
     'zh-CN': string;
     'en-US': string;
   }[];
-  release: IDeviceBLEFirmwareStatus | IBLEFirmwareReleaseInfo;
+  release: IDeviceBLEFirmwareStatus | IBLEFirmwareReleaseInfo | IFirmwareReleaseInfo;
   bootloaderMode?: boolean;
 };
 
+export type ProtocolV2FirmwareComponentReleaseStatus =
+  | 'valid'
+  | 'outdated'
+  | 'unknown'
+  | 'unsupported';
+
+export type ProtocolV2FirmwareReleaseStatus =
+  | 'unavailable'
+  | 'valid'
+  | 'unknown'
+  | 'outdated'
+  | 'required';
+
+export type ProtocolV2FirmwareComponentRelease = {
+  configKey: string;
+  componentTarget: IProtocolV2FirmwareComponentTarget;
+  updateTarget: FirmwareUpdateV4Target | null;
+  currentVersion: string | null;
+  targetVersion: string | null;
+  status: ProtocolV2FirmwareComponentReleaseStatus;
+  required: boolean;
+};
+
 export type AllFirmwareRelease = {
   firmware: FirmwareRelease;
   ble: FirmwareRelease;
   bootloader?: FirmwareRelease;
   bridge?: FirmwareRelease;
   features?: Features;
+  protocol?: 'V1' | 'V2';
+  deviceType?: 'pro2';
+  firmwareType?: EFirmwareType;
+  status?: ProtocolV2FirmwareReleaseStatus;
+  hasUpgrade?: boolean;
+  required?: boolean;
+  currentVersions?: DeviceStateVersions;
+  components?: ProtocolV2FirmwareComponentRelease[];
+  targetsToUpdate?: FirmwareUpdateV4Target[];
+  release?: IFirmwareReleaseInfo;
+  firmwareUpdatePlan?: FirmwareUpdatePlan;
 };
 
 export type CheckAllFirmwareReleaseParams = {
   checkBridgeRelease?: boolean;
   firmwareType?: EFirmwareType;
+  platform?: 'native' | 'desktop' | 'ext' | 'web' | 'web-embed';
+  forceUpdateTargets?: FirmwareUpdatePlanForceTarget[];
 };
 
 export declare function checkAllFirmwareRelease(

package/src/types/api/deviceSettings.ts

@@ -1,20 +1,44 @@
-import type { SafetyCheckLevel, Success } from '@onekeyfe/hd-transport';
+import type { Enum_SafetyCheckLevel, Success } from '@onekeyfe/hd-transport';
 import type { CommonParams, Response } from '../params';
 
 export type DeviceSettingsParams = {
   language?: string;
   label?: string;
   usePassphrase?: boolean;
+  /** Protocol V1 only. */
   homescreen?: string;
+  /** Protocol V1 only. */
   passphraseSource?: number;
   autoLockDelayMs?: number;
+  /** Protocol V1 only. */
   displayRotation?: number;
+  /** Protocol V1 only. */
   passphraseAlwaysOnDevice?: boolean;
-  safetyChecks?: SafetyCheckLevel;
+  /** Protocol V1 only. Uses Enum_SafetyCheckLevel numeric values. */
+  safetyChecks?: Enum_SafetyCheckLevel;
+  /** Protocol V1 only; the current Protocol V2 schema has no matching field. */
   experimentalFeatures?: boolean;
   autoShutdownDelayMs?: number;
+  /** Protocol V1 only; opens the legacy device-side brightness flow. */
   changeBrightness?: boolean;
+  /** Protocol V2 only. */
+  brightness?: number;
   hapticFeedback?: boolean;
+  bluetoothEnabled?: boolean;
+  /** Protocol V2 only; changed through an on-device confirmation page. */
+  airgapMode?: boolean;
+  /** Protocol V2 only. */
+  animationEnabled?: boolean;
+  /** Protocol V2 only. */
+  tapToWake?: boolean;
+  /** Protocol V2 only. */
+  deviceNameDisplayEnabled?: boolean;
+  /** Protocol V2 only. */
+  fidoEnabled?: boolean;
+  /** Protocol V2 only. */
+  usbLockEnabled?: boolean;
+  /** Protocol V2 only. */
+  randomKeypad?: boolean;
 };
 
 export declare function deviceSettings(

package/src/types/api/deviceUnlock.ts

@@ -1,4 +1,4 @@
-import type { Features } from '@onekeyfe/hd-transport';
+import type { Features } from '../device';
 import type { CommonParams, Response } from '../params';
 
 export declare function deviceUnlock(connectId: string, params?: CommonParams): Response<Features>;

package/src/types/api/deviceUpdateBootloader.ts

@@ -1,9 +1,15 @@
 import type { Success } from '@onekeyfe/hd-transport';
 import type { EFirmwareType } from '@onekeyfe/hd-shared';
+import type { FirmwareArtifactReader, FirmwareArtifactReference } from './firmwareUpdate';
+import type { FirmwareUpdatePreparedPlan } from './firmwareUpdatePreparedPlan';
 import type { Response } from '../params';
 
 export type DeviceUpdateBootloaderParams = {
+  preparedPlan?: FirmwareUpdatePreparedPlan;
+  hostBindingGeneration?: number;
   binary?: ArrayBuffer;
+  artifact?: FirmwareArtifactReference;
+  artifactReader?: FirmwareArtifactReader;
   firmwareType?: EFirmwareType;
 };
 

package/src/types/api/export.ts

@@ -25,12 +25,36 @@ export type {
   DeviceUploadResourceResponse,
 } from './deviceUploadResource';
 export type {
+  FirmwareArtifactReader,
+  FirmwareArtifactReference,
+  FirmwareUpdateHostBinding,
+  FirmwareUpdateArtifactParams,
   FirmwareUpdateParams,
   FirmwareUpdateBinaryParams,
   FirmwareUpdateV3Params,
   FirmwareUpdateV4Params,
+  FirmwareUpdateV4Target,
 } from './firmwareUpdate';
+export type {
+  FirmwareUpdatePlan,
+  FirmwareUpdatePlanArtifact,
+  FirmwareUpdatePlanArtifactRole,
+  FirmwareUpdatePlanForceTarget,
+  FirmwareUpdatePlanTarget,
+} from './firmwareUpdatePlan';
+export type {
+  FirmwareUpdatePreparedArtifact,
+  FirmwareUpdatePreparedArtifactInput,
+  FirmwareUpdatePreparedEntry,
+  FirmwareUpdatePreparedPlan,
+} from './firmwareUpdatePreparedPlan';
+export type { FirmwareUpdateCapabilities } from './firmwareUpdateCapabilities';
 export type { AllFirmwareRelease } from './checkAllFirmwareRelease';
+export type {
+  ProtocolV2FirmwareComponentRelease,
+  ProtocolV2FirmwareComponentReleaseStatus,
+  ProtocolV2FirmwareReleaseStatus,
+} from './checkAllFirmwareRelease';
 
 export type { AllNetworkAddressParams, AllNetworkGetAddressParams } from './allNetworkGetAddress';
 
@@ -161,6 +185,8 @@ export type {
   KaspaSignTransactionParams,
   KaspaSignInputParams,
   KaspaSignOutputParams,
+  KaspaStreamingSignInputParams,
+  KaspaStreamingSignOutputParams,
 } from './kaspaSignTransaction';
 
 export type { NexaAddress, NexaGetAddressParams } from './nexaGetAddress';

package/src/types/api/firmwareUpdate.ts

@@ -1,14 +1,53 @@
 import type { EFirmwareType } from '@onekeyfe/hd-shared';
 import type { PROTO } from '../../constants';
 import type { Params, Response } from '../params';
+import type { FirmwareUpdatePreparedPlan } from './firmwareUpdatePreparedPlan';
 
 type IUpdateType = 'firmware' | 'ble';
 
+export interface FirmwareArtifactReference {
+  artifactRef: string;
+  size: number;
+  sha256: string;
+}
+
+export interface FirmwareArtifactReader {
+  open(input: { artifactRef: string }): Promise<{
+    readerId: string;
+    size: number;
+  }>;
+  read(input: { readerId: string; offset: number; length: number }): Promise<{
+    data: ArrayBuffer;
+    bytesRead: number;
+    eof: boolean;
+  }>;
+  close(input: { readerId: string }): Promise<void>;
+}
+
+export interface FirmwareUpdateHostBinding {
+  artifactReader: FirmwareArtifactReader;
+}
+
 export interface FirmwareUpdateBinaryParams {
   binary: ArrayBuffer;
   updateType: IUpdateType;
 }
 
+export interface FirmwareUpdateArtifactParams {
+  preparedPlan: FirmwareUpdatePreparedPlan;
+  hostBindingGeneration: number;
+  artifact: FirmwareArtifactReference;
+  resourceArtifact?: FirmwareArtifactReference;
+  resourceEntries?: Array<{
+    entryName: string;
+    artifact: FirmwareArtifactReference;
+  }>;
+  updateType: IUpdateType;
+  forcedUpdateRes?: boolean;
+  isUpdateBootloader?: boolean;
+  firmwareType?: EFirmwareType;
+}
+
 export interface FirmwareUpdateParams {
   version?: number[];
   updateType: IUpdateType;
@@ -37,8 +76,14 @@ export declare function firmwareUpdateV2(
   connectId: string | undefined,
   params: Params<FirmwareUpdateBinaryParams & Platform>
 ): Response<PROTO.Success>;
+export declare function firmwareUpdateV2(
+  connectId: string | undefined,
+  params: Params<FirmwareUpdateArtifactParams & Platform>
+): Response<PROTO.Success>;
 
 export interface FirmwareUpdateV3Params {
+  preparedPlan?: FirmwareUpdatePreparedPlan;
+  hostBindingGeneration?: number;
   bleVersion?: number[];
   bleBinary?: ArrayBuffer;
   chunkSize?: number;
@@ -55,18 +100,45 @@ export interface FirmwareUpdateV3Params {
   firmwareType?: EFirmwareType;
 
   platform: IPlatform;
+
+  artifactReader?: FirmwareArtifactReader;
+  artifacts?: {
+    ble?: FirmwareArtifactReference;
+    firmware?: FirmwareArtifactReference;
+    bootloader?: FirmwareArtifactReference;
+    resourceEntries?: Array<{
+      entryName: string;
+      artifact: FirmwareArtifactReference;
+    }>;
+  };
 }
 
 /**
- * firmwareUpdateV4（Protocol V2）按 DeviceFirmwareTargetType 拆分的目标二进制。
- * 除 romloader 外，每个字段对应一个 bootloader 可接受的固件升级 target。
+ * firmwareUpdateV4 target binaries grouped by DeviceFirmwareTargetType.
+ * Except for romloader, each field maps to a target accepted by bootloader.
  */
+export type FirmwareUpdateV4Target =
+  | 'boot'
+  | 'app_v1'
+  | 'app_v2'
+  | 'coprocessor'
+  | 'resource'
+  | 'se01'
+  | 'se02'
+  | 'se03'
+  | 'se04';
+
 export interface FirmwareUpdateV4Params {
+  preparedPlan?: FirmwareUpdatePreparedPlan;
+  hostBindingGeneration?: number;
   platform: IPlatform;
+  expectedDeviceId?: string;
   chunkSize?: number;
   firmwareType?: EFirmwareType;
+  targetsToUpdate?: FirmwareUpdateV4Target[];
+  expectedTargetVersions?: Partial<Record<FirmwareUpdateV4Target, string>>;
 
-  /** FW_MGMT_TARGET_ROMLOADER = 2；当前 Pro2 bootloader 不接受通过 firmwareUpdateV4 安装 */
+  /** FW_MGMT_TARGET_ROMLOADER = 2; Pro2 cannot install it through firmwareUpdateV4. */
   romloaderBinary?: ArrayBuffer;
   /** FW_MGMT_TARGET_BOOTLOADER = 3 */
   bootloaderBinary?: ArrayBuffer;
@@ -81,11 +153,33 @@ export interface FirmwareUpdateV4Params {
   se02Binary?: ArrayBuffer;
   se03Binary?: ArrayBuffer;
   se04Binary?: ArrayBuffer;
-  /** 资源包通过 FW_MGMT_TARGET_CRATE = 1 安装；Pro2 正常升级推荐传入单个合并 CRATE，多个元素仅用于调试/兼容 */
-  resourceBinaries?: ArrayBuffer[];
   forcedUpdateRes?: boolean;
+  /**
+   * RESC bundle okpkg files written directly to devicePath through FilesystemFileWrite.
+   * Manual mode installs them without version comparison.
+   */
+  resourceBundleFiles?: Array<{
+    binary: ArrayBuffer;
+    devicePath: string;
+  }>;
+  artifactReader?: FirmwareArtifactReader;
+  componentArtifacts?: Partial<
+    Record<Exclude<FirmwareUpdateV4Target, 'resource'>, FirmwareArtifactReference>
+  >;
+  resourceBundleArtifacts?: Array<{
+    name: string;
+    artifact: FirmwareArtifactReference;
+  }>;
 }
 
+export declare function registerFirmwareUpdateHostBinding(
+  binding: FirmwareUpdateHostBinding
+): number;
+
+export declare function unregisterFirmwareUpdateHostBinding(generation?: number): boolean;
+
+export declare function getFirmwareUpdateHostBindingGeneration(): number;
+
 export declare function firmwareUpdateV3(
   connectId: string | undefined,
   params: Params<FirmwareUpdateV3Params>

package/src/types/api/firmwareUpdateCapabilities.ts

@@ -0,0 +1,9 @@
+export interface FirmwareUpdateCapabilities {
+  planSchemaVersion: 2;
+  preparedPlanSchemaVersion: 2;
+  hostBindingProtocolVersion: 2;
+  manifestModes: Array<'external-only' | 'sdk-managed'>;
+  supportsArtifactReader: true;
+}
+
+export declare function getFirmwareUpdateCapabilities(): FirmwareUpdateCapabilities;

package/src/types/api/firmwareUpdatePlan.ts

@@ -0,0 +1,38 @@
+import type { FirmwareUpdateV4Target } from './firmwareUpdate';
+import type { EFirmwareType } from '@onekeyfe/hd-shared';
+
+export type FirmwareUpdatePlanArtifactRole =
+  | 'firmware'
+  | 'ble'
+  | 'bootloader'
+  | 'resource'
+  | 'component'
+  | 'resourceBundle';
+
+export type FirmwareUpdatePlanTarget = 'firmware' | 'ble' | 'bootloader' | FirmwareUpdateV4Target;
+
+export type FirmwareUpdatePlanForceTarget = 'firmware' | 'ble' | 'bootloader' | 'resource';
+
+export interface FirmwareUpdatePlanArtifact {
+  artifactId: string;
+  role: FirmwareUpdatePlanArtifactRole;
+  target: FirmwareUpdatePlanTarget;
+  url: string;
+  container: 'raw' | 'zip';
+  logicalName?: string;
+  expectedSize?: number;
+  expectedSha256?: string;
+  targetVersion?: string;
+}
+
+export interface FirmwareUpdatePlan {
+  schemaVersion: 2;
+  planDigest: string;
+  executor: 'v2' | 'v3' | 'v4';
+  deviceIdentity: string;
+  deviceModel: string;
+  firmwareType: EFirmwareType;
+  platform: 'native' | 'desktop' | 'ext' | 'web' | 'web-embed';
+  artifacts: FirmwareUpdatePlanArtifact[];
+  targetsToUpdate: FirmwareUpdatePlanTarget[];
+}

package/src/types/api/firmwareUpdatePreparedPlan.ts

@@ -0,0 +1,53 @@
+import type { FirmwareArtifactReference } from './firmwareUpdate';
+import type {
+  FirmwareUpdatePlan,
+  FirmwareUpdatePlanArtifactRole,
+  FirmwareUpdatePlanTarget,
+} from './firmwareUpdatePlan';
+
+export interface FirmwareUpdatePreparedEntry {
+  entryName: string;
+  artifact: FirmwareArtifactReference;
+}
+
+export interface FirmwareUpdatePreparedArtifactInput {
+  artifactId: string;
+  artifact: FirmwareArtifactReference;
+  materializedEntries?: FirmwareUpdatePreparedEntry[];
+}
+
+export interface FirmwareUpdatePreparedArtifact {
+  artifactId: string;
+  role: FirmwareUpdatePlanArtifactRole;
+  target: FirmwareUpdatePlanTarget;
+  container: 'raw' | 'zip';
+  logicalName?: string;
+  targetVersion?: string;
+  artifact: FirmwareArtifactReference;
+  materializedEntries?: FirmwareUpdatePreparedEntry[];
+}
+
+export interface FirmwareUpdatePreparedPlan {
+  schemaVersion: 2;
+  preparedPlanDigest: string;
+  planDigest: string;
+  networkPolicy: 'forbid';
+  executor: FirmwareUpdatePlan['executor'];
+  deviceIdentity: string;
+  deviceModel: string;
+  firmwareType: FirmwareUpdatePlan['firmwareType'];
+  platform: FirmwareUpdatePlan['platform'];
+  leaseRef: string;
+  artifacts: FirmwareUpdatePreparedArtifact[];
+  targetsToUpdate: FirmwareUpdatePlanTarget[];
+}
+
+export declare function prepareFirmwareUpdatePlan(input: {
+  plan: FirmwareUpdatePlan;
+  leaseRef: string;
+  artifacts: FirmwareUpdatePreparedArtifactInput[];
+}): FirmwareUpdatePreparedPlan;
+
+export declare function validateFirmwareUpdatePreparedPlan(
+  value: unknown
+): FirmwareUpdatePreparedPlan;

package/src/types/api/getDeviceState.ts

@@ -0,0 +1,19 @@
+import type { DeviceState, DeviceStateSection } from '../device';
+import type { CommonParams, Response } from '../params';
+
+export type DeviceStateScope = 'runtime' | 'settings' | 'firmware';
+
+export type GetDeviceStateParams = CommonParams & {
+  scope?: DeviceStateScope;
+};
+
+/** Internal state-read options, not part of the public CoreApi. */
+export type DeviceStateReadOptions = {
+  refreshSections?: DeviceStateSection[];
+  includeRaw?: boolean;
+};
+
+export declare function getDeviceState(
+  connectId?: string,
+  params?: GetDeviceStateParams
+): Response<DeviceState>;

package/src/types/api/getFeatures.ts

@@ -1,4 +1,7 @@
 import type { CommonParams, Response } from '../params';
 import type { Features } from '../device';
 
+/**
+ * @deprecated Use `getDeviceState` for both Protocol V1 and Protocol V2 devices.
+ */
 export declare function getFeatures(connectId?: string, params?: CommonParams): Response<Features>;

package/src/types/api/getOnekeyFeatures.ts

@@ -1,6 +1,9 @@
 import type { CommonParams, Response } from '../params';
 import type { OnekeyFeatures } from '../device';
 
+/**
+ * @deprecated Use `getDeviceState(connectId, { scope: 'firmware' })`.
+ */
 export declare function getOnekeyFeatures(
   connectId?: string,
   params?: CommonParams

package/src/types/api/getPassphraseState.ts

@@ -1,17 +1,15 @@
 import type { CommonParams, Response } from '../params';
 
-export type GetPassphraseStatePayload = {
-  passphraseState?: string;
-  sessionId?: string;
-  unlockedAttachPin?: boolean;
-  passphraseProtection?: boolean | null;
-};
-
-export type GetPassphraseStateParams = CommonParams & {
-  allowCreateAttachPin?: boolean;
-};
+export type GetPassphraseStateParams = CommonParams;
 
+/**
+ * Compatibility wallet-state API for existing App integrations.
+ *
+ * Protocol V1 keeps its parameterless firmware flow. Protocol V2 maps the existing
+ * `useEmptyPassphrase` and `initSession` intent to the device-only wallet-session flow.
+ * New integrations should prefer `openWalletSession` for explicit wallet intent.
+ */
 export declare function getPassphraseState(
   connectId?: string,
   params?: GetPassphraseStateParams
-): Response<GetPassphraseStatePayload>;
+): Response<string | undefined>;