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

package/src/protocols/protocol-v2/walletSession.ts

@@ -1,202 +0,0 @@
-import { ERRORS, HardwareErrorCode } from '@onekeyfe/hd-shared';
-
-import { DEVICE, type PassphraseRequestPayload } from '../../events';
-import { assertCompleteDeviceSession } from './deviceSession';
-import { isDeviceLockedError } from './lockedError';
-
-import type { DeviceSessionOpen } from '@onekeyfe/hd-transport';
-import type { Device } from '../../device/Device';
-import type { PassphrasePromptResponse } from '../../device/DeviceCommands';
-
-export const isProtocolV2InvalidSessionError = (error: unknown) =>
-  error !== null &&
-  typeof error === 'object' &&
-  'errorCode' in error &&
-  error.errorCode === HardwareErrorCode.WalletSessionInvalid;
-
-const normalizeHostPassphrase = (passphrase: string | undefined) => {
-  const normalized = (passphrase ?? '').normalize('NFKD');
-  if (!normalized || normalized.includes('\0') || normalized.length > 50) {
-    throw ERRORS.TypedError(
-      HardwareErrorCode.CallMethodInvalidParameter,
-      'Invalid hidden wallet passphrase.'
-    );
-  }
-  return normalized;
-};
-
-export async function requestProtocolV2DeviceStatus(device: Device) {
-  const { message } = await device.commands.typedCall('DeviceStatusGet', 'DeviceStatus', {});
-  return message;
-}
-
-export async function refreshProtocolV2DeviceStatus(device: Device) {
-  const status = await requestProtocolV2DeviceStatus(device);
-  return device.updateProtocolV2Status(status);
-}
-
-const openDeviceSession = async (device: Device, request: DeviceSessionOpen) => {
-  try {
-    return await device.commands.typedCall('DeviceSessionOpen', 'DeviceSession', request);
-  } catch (error) {
-    if (!isDeviceLockedError(error)) {
-      throw error;
-    }
-    await device.unlockDevice();
-    return device.commands.typedCall('DeviceSessionOpen', 'DeviceSession', request);
-  }
-};
-
-const createHiddenWalletRequest = (
-  response: PassphrasePromptResponse
-): {
-  request: DeviceSessionOpen;
-  deviceEvent?: typeof DEVICE.PASSPHRASE_ON_DEVICE | typeof DEVICE.ATTACH_PIN_ON_DEVICE;
-} => {
-  if (response.attachPinOnDevice) {
-    return {
-      request: {
-        select: {
-          attach_pin_on_device: {},
-        },
-      },
-      deviceEvent: DEVICE.ATTACH_PIN_ON_DEVICE,
-    };
-  }
-
-  if (response.passphraseOnDevice) {
-    return {
-      request: {
-        select: {
-          passphrase_on_device: {},
-        },
-      },
-      deviceEvent: DEVICE.PASSPHRASE_ON_DEVICE,
-    };
-  }
-
-  return {
-    request: {
-      select: {
-        host_passphrase: { passphrase: normalizeHostPassphrase(response.passphrase) },
-      },
-    },
-  };
-};
-
-const openSelectedHiddenWallet = async (
-  device: Device,
-  promptPayload: PassphraseRequestPayload
-) => {
-  const response = await device.commands.promptPassphrase(promptPayload, {
-    cancelDeviceOnReject: false,
-  });
-  const { request, deviceEvent } = createHiddenWalletRequest(response);
-
-  if (deviceEvent) {
-    device.emit(deviceEvent, device, promptPayload);
-  }
-
-  return openDeviceSession(device, request);
-};
-
-export async function getProtocolV2WalletSession(
-  device: Device,
-  options?: {
-    initSession?: boolean;
-    expectedPassphraseState?: string;
-    onlyMainPin?: boolean;
-    recoverInvalidSession?: boolean;
-  }
-) {
-  if (options?.initSession) {
-    device.clearInternalState();
-  }
-
-  const expectedPassphraseState = options?.expectedPassphraseState ?? device.passphraseState;
-
-  try {
-    // Unlock with PIN first. The unlock flow refreshes DeviceStatus so wallet
-    // selection uses confirmed passphrase and attach-to-PIN state.
-    if (device.features?.unlocked === false) {
-      await device.unlockDevice();
-    }
-
-    // A standard wallet needs no DeviceSession. After unlock confirms passphrase is
-    // disabled, do not create or forward a hidden-wallet passphraseState.
-    if (options?.onlyMainPin || device.getCurrentPassphraseProtection() === false) {
-      return {
-        passphraseState: undefined,
-        newSession: undefined,
-        unlockedAttachPin: device.features?.unlockedAttachPin ?? false,
-        resumed: false,
-      };
-    }
-
-    const cachedSessionId =
-      typeof device.getInternalState === 'function' ? device.getInternalState() : undefined;
-    let response;
-    let recoveryFailed = false;
-    let resumed = false;
-
-    if (cachedSessionId && expectedPassphraseState) {
-      try {
-        response = await openDeviceSession(device, {
-          resume: { session_id: cachedSessionId },
-        });
-        resumed = true;
-      } catch (error) {
-        if (!isProtocolV2InvalidSessionError(error)) {
-          throw error;
-        }
-        device.clearInternalState();
-        if (options?.recoverInvalidSession === false) {
-          throw error;
-        }
-        recoveryFailed = true;
-      }
-    }
-
-    if (!response) {
-      const promptPayload: PassphraseRequestPayload = {
-        source: 'wallet-session-coordinator',
-        reason: recoveryFailed ? 'session-recovery' : 'open-wallet',
-        expectedPassphraseState,
-        existsAttachPinUser: device.features?.attachToPinEnabled === true,
-      };
-      response = await openSelectedHiddenWallet(device, promptPayload);
-    }
-
-    const { message } = response;
-    try {
-      assertCompleteDeviceSession(message);
-    } catch (error) {
-      device.clearInternalState();
-      throw error;
-    }
-    if (expectedPassphraseState && expectedPassphraseState !== message.btc_test_address) {
-      device.clearInternalState();
-      throw ERRORS.TypedError(HardwareErrorCode.DeviceCheckPassphraseStateError);
-    }
-
-    device.updateInternalState(
-      true,
-      message.btc_test_address,
-      device.getCurrentDeviceId(),
-      message.session_id,
-      options?.initSession ? null : device.features?.sessionId ?? null
-    );
-
-    return {
-      passphraseState: message.btc_test_address,
-      newSession: message.session_id,
-      unlockedAttachPin: device.features?.unlockedAttachPin ?? undefined,
-      resumed,
-    };
-  } catch (error) {
-    if (isProtocolV2InvalidSessionError(error)) {
-      device.clearInternalState();
-    }
-    throw error;
-  }
-}

package/src/types/api/firmwareUpdateCapabilities.ts

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

package/src/types/api/firmwareUpdatePlan.ts

@@ -1,52 +0,0 @@
-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 interface FirmwareUpdatePlanArtifact {
-  artifactId: string;
-  role: FirmwareUpdatePlanArtifactRole;
-  target: FirmwareUpdatePlanTarget;
-  url: string;
-  container: 'raw' | 'zip';
-  logicalName?: string;
-  expectedSize?: number;
-  expectedSha256?: string;
-  targetVersion?: string;
-}
-
-export type FirmwareUpdatePlanEpochKind =
-  | 'legacy-update'
-  | 'resource-sync'
-  | 'bootloader-install'
-  | 'bootloader-verify'
-  | 'component-install'
-  | 'final-verify';
-
-export interface FirmwareUpdatePlanEpoch {
-  epoch: number;
-  kind: FirmwareUpdatePlanEpochKind;
-  artifactIds: string[];
-  targets: FirmwareUpdatePlanTarget[];
-}
-
-export interface FirmwareUpdatePlan {
-  schemaVersion: 1;
-  planDigest: string;
-  executor: 'v2' | 'v3' | 'v4';
-  deviceIdentity: string;
-  deviceModel: string;
-  firmwareType: EFirmwareType;
-  platform: 'native' | 'desktop' | 'ext' | 'web' | 'web-embed';
-  artifacts: FirmwareUpdatePlanArtifact[];
-  epochs: FirmwareUpdatePlanEpoch[];
-  targetsToUpdate: FirmwareUpdatePlanTarget[];
-}

package/src/types/api/firmwareUpdatePreparedPlan.ts

@@ -1,55 +0,0 @@
-import type { FirmwareArtifactReference } from './firmwareUpdate';
-import type {
-  FirmwareUpdatePlan,
-  FirmwareUpdatePlanArtifactRole,
-  FirmwareUpdatePlanEpoch,
-  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: 1;
-  preparedPlanDigest: string;
-  planDigest: string;
-  networkPolicy: 'forbid';
-  executor: FirmwareUpdatePlan['executor'];
-  deviceIdentity: string;
-  deviceModel: string;
-  firmwareType: FirmwareUpdatePlan['firmwareType'];
-  platform: FirmwareUpdatePlan['platform'];
-  leaseRef: string;
-  artifacts: FirmwareUpdatePreparedArtifact[];
-  epochs: FirmwareUpdatePlanEpoch[];
-  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

@@ -1,19 +0,0 @@
-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/openWalletSession.ts

@@ -1,54 +0,0 @@
-import type { CommonParams, Response } from '../params';
-
-export type OpenWalletSessionParams =
-  | {
-      mode: 'standard';
-      deviceId?: never;
-      passphraseState?: never;
-      useEmptyPassphrase?: never;
-      initSession?: never;
-    }
-  | {
-      mode: 'select-hidden';
-      deviceId?: never;
-      passphraseState?: never;
-      useEmptyPassphrase?: never;
-      initSession?: never;
-    }
-  | {
-      mode: 'resume-hidden';
-      deviceId: string;
-      passphraseState: string;
-      useEmptyPassphrase?: never;
-      initSession?: never;
-    }
-  | {
-      /**
-       * Compatibility form. `useEmptyPassphrase: true` opens the standard wallet;
-       * otherwise `initSession: true` starts a fresh hidden-wallet selection, a
-       * complete wallet binding resumes a hidden wallet, and no binding starts the
-       * hidden-wallet selection flow.
-       */
-      mode?: undefined;
-      useEmptyPassphrase?: boolean;
-      initSession?: boolean;
-      deviceId?: string;
-      passphraseState?: string;
-    };
-
-export type OpenWalletSessionPayload = {
-  protocol: 'V1' | 'V2';
-  walletType: 'standard' | 'hidden';
-  deviceId: string;
-  passphraseState: string | null;
-  resumed: boolean;
-};
-
-/**
- * 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,244 +0,0 @@
-import type { CommonParams, Response } from '../params';
-import type {
-  DevOnboardingStatus,
-  DeviceFactoryInfo,
-  DeviceFirmwareUpdateStatus,
-  DeviceSettings,
-  DeviceStatus,
-  ProtocolInfo,
-  ProtocolV2DeviceInfo,
-  Success,
-} from '@onekeyfe/hd-transport';
-import type {
-  DeviceFactoryInfoSetParams,
-  DeviceFirmwareUpdateParams,
-  DeviceFirmwareUpdateStatusGetParams,
-  DeviceRebootParams,
-} from '../../api/protocol-v2/helpers';
-import type { DeviceSessionOpenParams } from '../../api/protocol-v2/DeviceSessionOpen';
-import type { DeviceInfoGetParams } from '../../api/protocol-v2/DeviceInfoGet';
-import type { DeviceSettingsSetParams } from '../../api/protocol-v2/DeviceSettingsSet';
-import type { DeviceSettingsPageShowParams } from '../../api/protocol-v2/DeviceSettingsPageShow';
-import type {
-  DeviceUploadWallpaperParams,
-  DeviceUploadWallpaperResponse,
-} from '../../api/protocol-v2/DeviceUploadWallpaper';
-
-// Re-export implementation parameter types as the single source of truth.
-export type {
-  DeviceFirmwareTargetInput,
-  DeviceFirmwareUpdateParams,
-  DeviceFirmwareUpdateStatusGetParams,
-  DeviceRebootParams,
-  DeviceFactoryInfoSetParams,
-  RebootTypeInput,
-} from '../../api/protocol-v2/helpers';
-export type { DeviceSessionOpenParams } from '../../api/protocol-v2/DeviceSessionOpen';
-export type {
-  DeviceInfoGetParams,
-  DeviceInfoGetTargets,
-  DeviceInfoGetTypes,
-} from '../../api/protocol-v2/DeviceInfoGet';
-export type { DeviceSettingsSetParams } from '../../api/protocol-v2/DeviceSettingsSet';
-export type {
-  DeviceSettingsPageShowParams,
-  SupportedDeviceSettingsPage,
-} from '../../api/protocol-v2/DeviceSettingsPageShow';
-export type {
-  DeviceUploadWallpaperParams,
-  DeviceUploadWallpaperResponse,
-} from '../../api/protocol-v2/DeviceUploadWallpaper';
-
-// ── Shared response shapes (Protocol V2 file system) ────────────────────
-
-export type FileOpSuccess = { message?: string };
-
-export type FileInfo = {
-  path: string;
-  offset: number;
-  total_size: number;
-  data?: Uint8Array;
-  data_hash?: number;
-  processed_byte?: number;
-  chunks?: number;
-};
-
-export type DirInfo = {
-  path: string;
-  child_dirs?: string;
-  child_files?: string;
-};
-
-// All FilesystemPathInfo proto fields are required; keep this type aligned.
-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;
-};
-
-export type DeviceSessionOpenResponse = {
-  session_id: string;
-  btc_test_address: string;
-};
-
-// ── Method signatures ─────────────────────────────────────────────────────
-
-/** @deprecated Development-only raw Protocol V2 command. Use `getDeviceState`. */
-export declare function deviceInfoGet(
-  connectId: string,
-  params?: CommonParams & DeviceInfoGetParams
-): Response<ProtocolV2DeviceInfo>;
-
-/** @deprecated Development-only raw Protocol V2 command. Use `getDeviceState`. */
-export declare function deviceStatusGet(
-  connectId: string,
-  params?: CommonParams
-): Response<DeviceStatus>;
-
-/** @deprecated Development-only raw Protocol V2 command. Use `getDeviceState`. */
-export declare function deviceSettingsGet(
-  connectId: string,
-  params?: CommonParams
-): Response<DeviceSettings>;
-
-/** @deprecated Development-only raw Protocol V2 command. */
-export declare function protocolInfoRequest(
-  connectId: string,
-  params?: CommonParams
-): Response<ProtocolInfo>;
-
-export declare function ping(
-  connectId: string,
-  params?: CommonParams & { message?: string }
-): Response<Success>;
-
-export declare function deviceReboot(
-  connectId: string,
-  params: CommonParams & DeviceRebootParams
-): Response<Success>;
-
-export declare function deviceGetOnboardingStatus(
-  connectId: string,
-  params?: CommonParams
-): Response<DevOnboardingStatus>;
-
-/**
- * @deprecated Use `openWalletSession` instead of the raw Protocol V2 command.
- */
-export declare function deviceSessionOpen(
-  connectId: string,
-  params: CommonParams & DeviceSessionOpenParams
-): Response<DeviceSessionOpenResponse>;
-
-export declare function deviceFirmwareUpdate(
-  connectId: string,
-  params: CommonParams & DeviceFirmwareUpdateParams
-): Response<Success | DeviceFirmwareUpdateStatus>;
-
-export declare function deviceGetFirmwareUpdateStatus(
-  connectId: string,
-  params?: CommonParams & DeviceFirmwareUpdateStatusGetParams
-): Response<DeviceFirmwareUpdateStatus>;
-
-export declare function deviceFactoryInfoSet(
-  connectId: string,
-  params: CommonParams & DeviceFactoryInfoSetParams
-): Response<Success>;
-
-export declare function deviceFactoryInfoGet(
-  connectId: string,
-  params?: CommonParams
-): Response<DeviceFactoryInfo>;
-
-export declare function deviceSettingsSet(
-  connectId: string,
-  params: CommonParams & DeviceSettingsSetParams
-): Response<Success>;
-
-export declare function deviceSettingsPageShow(
-  connectId: string,
-  params: CommonParams & DeviceSettingsPageShowParams
-): Response<Success>;
-
-export declare function deviceUploadWallpaper(
-  connectId: string,
-  params: CommonParams & DeviceUploadWallpaperParams
-): Response<DeviceUploadWallpaperResponse>;
-
-export declare function filesystemPermissionFix(
-  connectId: string,
-  params?: CommonParams
-): 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(
-  connectId: string,
-  params: {
-    path: string;
-    offset?: number;
-    totalSize?: number;
-    chunkSize?: number;
-    chunkLen?: number;
-    data: ArrayBuffer | Uint8Array | Blob | string;
-    overwrite?: boolean;
-    append?: boolean;
-    uiPercentage?: number;
-    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 function uploadPortfolio(
-  connectId: string,
-  params: {
-    operationId?: string;
-    packageBytes: ArrayBuffer | Uint8Array | Blob;
-    timeoutMs?: number | string;
-  }
-): Response<FileInfo & { portfolioUpdated: true }>;
-
-export declare function filesystemFormat(connectId: string): Response<Success>;

package/src/types/api/sessionCache.ts

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