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

package/src/types/api/checkAllFirmwareRelease.ts

@@ -1,8 +1,17 @@
-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';
 
 export type FirmwareRelease = {
   shouldUpdate?: boolean;
@@ -11,16 +20,49 @@ 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;
 };
 
 export type CheckAllFirmwareReleaseParams = {

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/export.ts

@@ -29,8 +29,14 @@ export type {
   FirmwareUpdateBinaryParams,
   FirmwareUpdateV3Params,
   FirmwareUpdateV4Params,
+  FirmwareUpdateV4Target,
 } from './firmwareUpdate';
 export type { AllFirmwareRelease } from './checkAllFirmwareRelease';
+export type {
+  ProtocolV2FirmwareComponentRelease,
+  ProtocolV2FirmwareComponentReleaseStatus,
+  ProtocolV2FirmwareReleaseStatus,
+} from './checkAllFirmwareRelease';
 
 export type { AllNetworkAddressParams, AllNetworkGetAddressParams } from './allNetworkGetAddress';
 
@@ -161,6 +167,8 @@ export type {
   KaspaSignTransactionParams,
   KaspaSignInputParams,
   KaspaSignOutputParams,
+  KaspaStreamingSignInputParams,
+  KaspaStreamingSignOutputParams,
 } from './kaspaSignTransaction';
 
 export type { NexaAddress, NexaGetAddressParams } from './nexaGetAddress';

package/src/types/api/firmwareUpdate.ts

@@ -58,15 +58,27 @@ export interface FirmwareUpdateV3Params {
 }
 
 /**
- * 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 {
   platform: IPlatform;
   chunkSize?: number;
   firmwareType?: EFirmwareType;
+  targetsToUpdate?: FirmwareUpdateV4Target[];
 
-  /** 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,9 +93,15 @@ export interface FirmwareUpdateV4Params {
   se02Binary?: ArrayBuffer;
   se03Binary?: ArrayBuffer;
   se04Binary?: ArrayBuffer;
-  /** 资源包通过 FW_MGMT_TARGET_CRATE = 1 安装；每个元素是一个独立 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;
+  }>;
 }
 
 export declare function firmwareUpdateV3(

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>;

package/src/types/api/index.ts

@@ -1,29 +1,10 @@
 import type {
-  deviceFirmwareUpdate,
-  deviceFactoryInfoGet,
-  deviceFactoryInfoSet,
-  deviceInfoGet,
-  deviceGetFirmwareUpdateStatus,
+  deviceGetOnboardingStatus,
   deviceReboot,
-  dirList,
-  dirMake,
-  dirRemove,
-  fileDelete,
-  fileRead,
-  fileWrite,
-  filesystemDirList,
-  filesystemDirMake,
-  filesystemDirRemove,
-  filesystemDiskControl,
-  filesystemFileDelete,
-  filesystemFileRead,
-  filesystemFileWrite,
-  filesystemPermissionFix,
-  filesystemFormat,
-  filesystemPathInfoQuery,
-  pathInfo,
-  ping,
-  protocolInfoRequest,
+  deviceUploadNft,
+  deviceUploadWallpaper,
+  testProtocolV2Ping,
+  uploadPortfolio,
 } from './protocolV2';
 import type { off, on, removeAllListeners } from './event';
 import type { uiResponse } from './uiResponse';
@@ -31,6 +12,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';
@@ -38,9 +20,10 @@ 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 { getDeviceState } from './getDeviceState';
 import type { getOnekeyFeatures } from './getOnekeyFeatures';
 import type { getPassphraseState } from './getPassphraseState';
+import type { openWalletSession } from './openWalletSession';
 import type { checkFirmwareRelease } from './checkFirmwareRelease';
 import type { checkBLEFirmwareRelease } from './checkBLEFirmwareRelease';
 import type {
@@ -164,19 +147,16 @@ import type { neoSignTransaction } from './neoSignTransaction';
 import type { ConnectSettings } from '../settings';
 
 export * from './export';
+export type { DeviceStateScope, GetDeviceStateParams } from './getDeviceState';
+export type { GetPassphraseStateParams } from './getPassphraseState';
+export { OpenWalletSessionMode } from './openWalletSession';
 export type {
-  DeviceInfoMode,
-  DeviceInfoProtocol,
-  DeviceInfoScope,
-  DeviceInfoSource,
-  DeviceInfoStatus,
-  DeviceProfile,
-  GetDeviceInfoParams,
-  DeviceProfileRaw,
-  DeviceProfileVerify,
-  DeviceProfileVersions,
-} from './getDeviceInfo';
-export type { GetPassphraseStateParams, GetPassphraseStatePayload } from './getPassphraseState';
+  OpenWalletSessionModeValue,
+  OpenWalletSessionParams,
+  OpenWalletSessionPayload,
+} from './openWalletSession';
+export type { ClearSessionCacheParams, ClearSessionCachePayload } from './sessionCache';
+export type { TestProtocolV2PingParams } from './protocolV2';
 
 export type CoreApi = {
   /**
@@ -187,18 +167,20 @@ export type CoreApi = {
   off: typeof off;
   emit: (event: string, ...args: any[]) => void;
   removeAllListeners: typeof removeAllListeners;
-  dispose: () => void;
+  dispose: () => void | Promise<void>;
   call: (params: any) => Promise<any>;
   uiResponse: typeof uiResponse;
   cancel: (connectId?: string) => void;
   updateSettings: typeof updateSettings;
   switchTransport: (env: ConnectSettings['env']) => Promise<{ success: boolean }>;
   getLogs: typeof getLogs;
+  clearSessionCache: typeof clearSessionCache;
 
   /**
    * Test function
    */
   testInitializeDeviceDuration: typeof testInitializeDeviceDuration;
+  testProtocolV2Ping: typeof testProtocolV2Ping;
   preInitialize: typeof preInitialize;
 
   /**
@@ -216,9 +198,10 @@ export type CoreApi = {
   searchDevices: typeof searchDevices;
   promptWebDeviceAccess: typeof promptWebDeviceAccess;
   getFeatures: typeof getFeatures;
-  getDeviceInfo: typeof getDeviceInfo;
+  getDeviceState: typeof getDeviceState;
   getOnekeyFeatures: typeof getOnekeyFeatures;
   getPassphraseState: typeof getPassphraseState;
+  openWalletSession: typeof openWalletSession;
   deviceBackup: typeof deviceBackup;
   deviceChangePin: typeof deviceChangePin;
   deviceFlags: typeof deviceFlags;
@@ -248,33 +231,13 @@ export type CoreApi = {
   cipherKeyValue: typeof cipherKeyValue;
 
   /**
-   * File system & device control API (Protocol V2 only)
+   * Pro2 business API
    */
-  protocolInfoRequest: typeof protocolInfoRequest;
-  ping: typeof ping;
   deviceReboot: typeof deviceReboot;
-  deviceInfoGet: typeof deviceInfoGet;
-  deviceFirmwareUpdate: typeof deviceFirmwareUpdate;
-  deviceGetFirmwareUpdateStatus: typeof deviceGetFirmwareUpdateStatus;
-  deviceFactoryInfoSet: typeof deviceFactoryInfoSet;
-  deviceFactoryInfoGet: typeof deviceFactoryInfoGet;
-  filesystemPermissionFix: typeof filesystemPermissionFix;
-  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;
+  deviceGetOnboardingStatus: typeof deviceGetOnboardingStatus;
+  deviceUploadNft: typeof deviceUploadNft;
+  deviceUploadWallpaper: typeof deviceUploadWallpaper;
+  uploadPortfolio: typeof uploadPortfolio;
 
   /**
    * All network function

package/src/types/api/kaspaSignTransaction.ts

@@ -13,25 +13,81 @@ export type KaspaSignInputParams = {
   sequenceNumber: number | string;
   output: {
     satoshis: number | string;
-    script: string;
+    // Required by the legacy host-prehash flow; unused by the streaming protocol.
+    script?: string;
   };
   sigOpCount?: number;
 };
 
 export type KaspaSignOutputParams = {
   satoshis: number | string;
+  // Streaming protocol describes outputs by address; the device builds the script itself.
+  // `address` for an external output, `addressN` (BIP-32 path) for a change output.
+  address?: string;
+  addressN?: string | number[];
+  // Legacy host-prehash fields, unused by the streaming protocol but kept for compatibility.
+  script?: string;
+  scriptVersion?: number;
+};
+
+export type KaspaStreamingSignInputParams = Omit<KaspaSignInputParams, 'output'> & {
+  output: {
+    satoshis: number | string;
+    script?: string;
+  };
+};
+
+export type KaspaStreamingSignOutputParams = {
+  satoshis: number | string;
+  // Streaming protocol describes outputs by address; the device builds the script itself.
+  // `address` for an external output, `addressN` (BIP-32 path) for a change output.
+  address?: string;
+  addressN?: string | number[];
+  // Legacy host-prehash fields, unused by the streaming protocol but kept for compatibility.
+  script?: string;
+  scriptVersion?: number;
+};
+
+// Referenced (previous) transactions for the streaming protocol's input
+// verification: the device may ask for the transactions the inputs spend from
+// (selected by prev_tx_id) to verify input amounts on-device.
+export type KaspaRefTransactionInput = {
+  prevTxId: string;
+  outputIndex: number;
+  sequenceNumber: number | string;
+};
+
+export type KaspaRefTransactionOutput = {
+  satoshis: number | string;
+  scriptVersion?: number;
   script: string;
-  scriptVersion: number;
+};
+
+export type KaspaRefTransaction = {
+  txId: string;
+  version: number;
+  inputs: KaspaRefTransactionInput[];
+  outputs: KaspaRefTransactionOutput[];
+  lockTime?: number | string;
+  subNetworkID?: string;
+  gas?: number | string;
+  payload?: string;
 };
 
 export type KaspaSignTransactionParams = {
   version: number;
-  inputs: KaspaSignInputParams[];
-  outputs: KaspaSignOutputParams[];
+  inputs: Array<KaspaSignInputParams | KaspaStreamingSignInputParams>;
+  outputs: Array<KaspaSignOutputParams | KaspaStreamingSignOutputParams>;
   lockTime: number | string;
   sigHashType?: SignatureType;
   sigOpCount?: number;
   subNetworkID?: string;
+  // Optional transaction payload (hex), streamed to the device in chunks.
+  payload?: string;
+  gas?: number | string;
+  // Previous transactions referenced by the inputs, required only when the
+  // device requests them for on-device input-amount verification.
+  refTxs?: KaspaRefTransaction[];
   scheme?: string;
   prefix?: string;
   useTweak?: boolean; // default is true

package/src/types/api/openWalletSession.ts

@@ -0,0 +1,54 @@
+import type { CommonParams, Response } from '../params';
+
+export const OpenWalletSessionMode = {
+  Standard: 'standard',
+  SelectHidden: 'select-hidden',
+  ResumeHidden: 'resume-hidden',
+} as const;
+
+export type OpenWalletSessionModeValue =
+  (typeof OpenWalletSessionMode)[keyof typeof OpenWalletSessionMode];
+
+export type OpenWalletSessionParams =
+  | {
+      mode: typeof OpenWalletSessionMode.Standard;
+      deviceId?: never;
+      passphraseState?: never;
+    }
+  | {
+      mode: typeof OpenWalletSessionMode.SelectHidden;
+      deviceId?: never;
+      passphraseState?: never;
+    }
+  | {
+      mode: typeof OpenWalletSessionMode.ResumeHidden;
+      deviceId: string;
+      passphraseState: string;
+    };
+
+type OpenWalletSessionPayloadBase = {
+  protocol: 'V1' | 'V2';
+  deviceId: string;
+  resumed: boolean;
+};
+
+export type OpenWalletSessionPayload = OpenWalletSessionPayloadBase &
+  (
+    | {
+        walletType: 'standard';
+        passphraseState: null;
+      }
+    | {
+        walletType: 'hidden';
+        passphraseState: string;
+      }
+  );
+
+/**
+ * Opens the standard, hidden, or Attach-to-PIN wallet flow through a unified
+ * Protocol V1/V2 API.
+ */
+export declare function openWalletSession(
+  connectId: string,
+  params: CommonParams & OpenWalletSessionParams
+): Response<OpenWalletSessionPayload>;