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

package/src/types/api/index.ts

@@ -1,34 +1,10 @@
 import type {
-  deviceFirmwareUpdate,
-  deviceGetDeviceInfo,
-  deviceGetFirmwareUpdateStatus,
   deviceGetOnboardingStatus,
   deviceReboot,
-  devFirmwareUpdate,
-  devGetDeviceInfo,
-  devGetFirmwareUpdateStatus,
-  devReboot,
-  dirList,
-  dirMake,
-  dirRemove,
-  factoryDeviceInfoSettings,
-  factoryGetDeviceInfo,
-  fileDelete,
-  fileRead,
-  fileWrite,
-  filesystemDirList,
-  filesystemDirMake,
-  filesystemDirRemove,
-  filesystemDiskControl,
-  filesystemFileDelete,
-  filesystemFileRead,
-  filesystemFileWrite,
-  filesystemFixPermission,
-  filesystemFormat,
-  filesystemPathInfoQuery,
-  getProtoVersion,
-  pathInfo,
-  ping,
+  deviceUploadNft,
+  deviceUploadWallpaper,
+  testProtocolV2Ping,
+  uploadPortfolio,
 } from './protocolV2';
 import type { off, on, removeAllListeners } from './event';
 import type { uiResponse } from './uiResponse';
@@ -36,16 +12,19 @@ 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';
 import type { checkAllFirmwareRelease } from './checkAllFirmwareRelease';
 import type { checkFirmwareTypeAvailable } from './checkFirmwareTypeAvailable';
 import type { searchDevices } from './searchDevices';
+import type { detectDeviceConnectProtocol } from './detectDeviceConnectProtocol';
 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 {
@@ -53,7 +32,15 @@ import type {
   firmwareUpdateV2,
   firmwareUpdateV3,
   firmwareUpdateV4,
+  getFirmwareUpdateHostBindingGeneration,
+  registerFirmwareUpdateHostBinding,
+  unregisterFirmwareUpdateHostBinding,
 } from './firmwareUpdate';
+import type { getFirmwareUpdateCapabilities } from './firmwareUpdateCapabilities';
+import type {
+  prepareFirmwareUpdatePlan,
+  validateFirmwareUpdatePreparedPlan,
+} from './firmwareUpdatePreparedPlan';
 import type { promptWebDeviceAccess } from './promptWebDeviceAccess';
 import type { deviceReset } from './deviceReset';
 import type { deviceRecovery } from './deviceRecovery';
@@ -167,21 +154,19 @@ import type { benfenSignMessage } from './benfenSignMessage';
 import type { neoGetAddress } from './neoGetAddress';
 import type { neoSignTransaction } from './neoSignTransaction';
 import type { ConnectSettings } from '../settings';
+import type { HardwareConnectProtocol } from '@onekeyfe/hd-shared';
 
 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 = {
   /**
@@ -192,18 +177,28 @@ 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>;
+  /**
+   * Bind a protocol that has already been verified for one transport endpoint.
+   * Every later SDK call for the same connectId uses it as a strict expectation.
+   */
+  setDeviceConnectProtocol: (
+    connectId: string,
+    connectProtocol: HardwareConnectProtocol | undefined
+  ) => void;
   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;
 
   /**
@@ -219,11 +214,13 @@ export type CoreApi = {
    * Device function
    */
   searchDevices: typeof searchDevices;
+  detectDeviceConnectProtocol: typeof detectDeviceConnectProtocol;
   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;
@@ -250,41 +247,22 @@ export type CoreApi = {
   firmwareUpdateV2: typeof firmwareUpdateV2;
   firmwareUpdateV3: typeof firmwareUpdateV3;
   firmwareUpdateV4: typeof firmwareUpdateV4;
+  registerFirmwareUpdateHostBinding: typeof registerFirmwareUpdateHostBinding;
+  unregisterFirmwareUpdateHostBinding: typeof unregisterFirmwareUpdateHostBinding;
+  getFirmwareUpdateHostBindingGeneration: typeof getFirmwareUpdateHostBindingGeneration;
+  getFirmwareUpdateCapabilities: typeof getFirmwareUpdateCapabilities;
+  prepareFirmwareUpdatePlan: typeof prepareFirmwareUpdatePlan;
+  validateFirmwareUpdatePreparedPlan: typeof validateFirmwareUpdatePreparedPlan;
   cipherKeyValue: typeof cipherKeyValue;
 
   /**
-   * File system & device control API (Protocol V2 only)
+   * Pro2 business API
    */
-  getProtoVersion: typeof getProtoVersion;
-  ping: typeof ping;
   deviceReboot: typeof deviceReboot;
-  deviceGetDeviceInfo: typeof deviceGetDeviceInfo;
   deviceGetOnboardingStatus: typeof deviceGetOnboardingStatus;
-  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;
-  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;
+  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>;

package/src/types/api/protocolV2.ts

@@ -1,37 +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 {
-  DevFirmwareUpdateStatus,
-  FactoryDeviceInfo,
-  OnboardingStatus,
-  ProtoVersion,
-  ProtocolV2DeviceInfo,
-  Success,
-} from '@onekeyfe/hd-transport';
+  DeviceUploadWallpaperParams,
+  DeviceUploadWallpaperResponse,
+} from '../../api/protocol-v2/DeviceUploadWallpaper';
 import type {
-  DeviceFirmwareUpdateParams,
-  DeviceRebootParams,
-  FactoryDeviceInfoSettingsParams,
-} from '../../api/protocol-v2/helpers';
-import type { DeviceGetDeviceInfoParams } from '../../api/protocol-v2/DeviceGetDeviceInfo';
+  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,
-  FactoryDeviceInfoSettingsParams,
-  RebootTypeInput,
-} from '../../api/protocol-v2/helpers';
+  DeviceUploadWallpaperParams,
+  DeviceUploadWallpaperResponse,
+} from '../../api/protocol-v2/DeviceUploadWallpaper';
 export type {
-  DeviceGetDeviceInfoParams,
-  DeviceGetDeviceInfoTargets,
-  DeviceGetDeviceInfoTypes,
-} from '../../api/protocol-v2/DeviceGetDeviceInfo';
+  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;
@@ -42,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 getProtoVersion(
-  connectId: string,
-  params?: CommonParams
-): Response<ProtoVersion>;
+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(
@@ -82,119 +50,25 @@ export declare function deviceReboot(
   params: CommonParams & DeviceRebootParams
 ): Response<Success>;
 
-export declare function deviceGetDeviceInfo(
-  connectId: string,
-  params?: CommonParams & DeviceGetDeviceInfoParams
-): Response<ProtocolV2DeviceInfo>;
-
 export declare function deviceGetOnboardingStatus(
   connectId: string,
   params?: CommonParams
 ): Response<OnboardingStatus>;
 
-export declare function deviceFirmwareUpdate(
-  connectId: string,
-  params: CommonParams & DeviceFirmwareUpdateParams
-): Response<Success | DevFirmwareUpdateStatus>;
-
-export declare function deviceGetFirmwareUpdateStatus(
-  connectId: string,
-  params?: CommonParams
-): Response<DevFirmwareUpdateStatus>;
-
-export declare function devReboot(
-  connectId: string,
-  params: CommonParams & DeviceRebootParams
-): Response<Success>;
-
-export declare function devGetDeviceInfo(
-  connectId: string,
-  params?: CommonParams & DeviceGetDeviceInfoParams
-): Response<ProtocolV2DeviceInfo>;
-
-export declare function devFirmwareUpdate(
+export declare function deviceUploadWallpaper(
   connectId: string,
-  params: CommonParams & DeviceFirmwareUpdateParams
-): Response<Success | DevFirmwareUpdateStatus>;
+  params: CommonParams & DeviceUploadWallpaperParams
+): Response<DeviceUploadWallpaperResponse>;
 
-export declare function devGetFirmwareUpdateStatus(
+export declare function deviceUploadNft(
   connectId: string,
-  params?: CommonParams
-): Response<DevFirmwareUpdateStatus>;
+  params: CommonParams & DeviceUploadNftParams
+): Response<DeviceUploadNftResponse>;
 
-export declare function factoryDeviceInfoSettings(
-  connectId: string,
-  params: FactoryDeviceInfoSettingsParams
-): 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: {
-    path: string;
-    offset?: number;
-    totalSize?: number;
-    chunkLen?: number;
-    uiPercentage?: number;
-  }
-): Response<FileInfo>;
-
-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>;