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

package/src/api/protocol-v2/DeviceSettingsPageShow.ts

@@ -1,70 +0,0 @@
-import { DeviceSettingsPage } from '@onekeyfe/hd-transport';
-
-import { BaseMethod } from '../BaseMethod';
-import { invalidParameter } from '../helpers/filesystemValidation';
-import { getProtocolV2SettingsBehavior } from '../../protocols/protocol-v2/settingsUnlockPolicy';
-
-export type SupportedDeviceSettingsPage = DeviceSettingsPage;
-
-export type DeviceSettingsPageShowParams = {
-  page?:
-    | SupportedDeviceSettingsPage
-    | 'DeviceReset'
-    | 'DevicePinChange'
-    | 'DevicePassphrase'
-    | 'DeviceAirgap';
-  fieldName?: string;
-  field_name?: string;
-};
-
-const SUPPORTED_PAGES = new Set<number>([
-  DeviceSettingsPage.DeviceReset,
-  DeviceSettingsPage.DevicePinChange,
-  DeviceSettingsPage.DevicePassphrase,
-  DeviceSettingsPage.DeviceAirgap,
-]);
-
-function normalizePage(value: DeviceSettingsPageShowParams['page']): SupportedDeviceSettingsPage {
-  const page = typeof value === 'string' ? DeviceSettingsPage[value] : value;
-  if (page !== undefined && SUPPORTED_PAGES.has(page)) {
-    return page;
-  }
-  throw invalidParameter(
-    'Parameter [page] must be DeviceReset, DevicePinChange, DevicePassphrase, or DeviceAirgap.'
-  );
-}
-
-export default class DeviceSettingsPageShow extends BaseMethod<{
-  page: SupportedDeviceSettingsPage;
-  field_name?: string;
-}> {
-  init() {
-    this.requireProtocolV2 = true;
-    this.skipForceUpdateCheck = true;
-    this.useDevicePassphraseState = false;
-    this.params = {
-      page: normalizePage(this.payload.page),
-      field_name: this.payload.field_name ?? this.payload.fieldName,
-    };
-    const behavior = getProtocolV2SettingsBehavior({
-      kind: 'page',
-      page: this.params.page,
-    });
-    this.unlockPolicy = behavior.unlockPolicy;
-    this.protocolV2UiInteraction = behavior.uiInteraction;
-  }
-
-  async run() {
-    const res = await this.device.commands.typedCall(
-      'DeviceSettingsPageShow',
-      'Success',
-      this.params
-    );
-    if (this.params.page === DeviceSettingsPage.DevicePassphrase) {
-      await this.device.getDeviceState({ refreshSections: ['status'] });
-    } else if (this.params.page === DeviceSettingsPage.DeviceAirgap) {
-      await this.device.getDeviceState({ refreshSections: ['settings'] });
-    }
-    return Promise.resolve(res.message);
-  }
-}

package/src/api/protocol-v2/DeviceSettingsSet.ts

@@ -1,44 +0,0 @@
-import { BaseMethod } from '../BaseMethod';
-import { mapDeviceSettingsToState } from '../../device/DeviceStateMapper';
-import { getProtocolV2SettingsBehavior } from '../../protocols/protocol-v2/settingsUnlockPolicy';
-import { invalidParameter } from '../helpers/filesystemValidation';
-
-import type { DeviceSettings } from '@onekeyfe/hd-transport';
-
-export type DeviceSettingsSetParams = {
-  settings?: Omit<DeviceSettings, 'passphrase_enable' | 'airgap_mode'>;
-};
-
-export default class DeviceSettingsSet extends BaseMethod<{
-  settings: Omit<DeviceSettings, 'passphrase_enable' | 'airgap_mode'>;
-}> {
-  init() {
-    const { settings } = this.payload;
-    if (!settings || typeof settings !== 'object' || Array.isArray(settings)) {
-      throw invalidParameter('Parameter [settings] must be an object.');
-    }
-
-    const {
-      passphrase_enable: _passphraseEnable,
-      airgap_mode: _airgapMode,
-      ...supported
-    } = settings as DeviceSettings;
-    if (Object.keys(supported).length === 0) {
-      throw invalidParameter('Parameter [settings] must contain at least one supported setting.');
-    }
-
-    this.requireProtocolV2 = true;
-    const behavior = getProtocolV2SettingsBehavior({ kind: 'direct', settings: supported });
-    this.unlockPolicy = behavior.unlockPolicy;
-    this.skipForceUpdateCheck = true;
-    this.useDevicePassphraseState = false;
-    this.params = { settings: supported };
-    this.protocolV2UiInteraction = behavior.uiInteraction;
-  }
-
-  async run() {
-    const res = await this.device.commands.typedCall('DeviceSettingsSet', 'Success', this.params);
-    this.device.updateState(mapDeviceSettingsToState(this.params.settings), 'apply-settings');
-    return Promise.resolve(res.message);
-  }
-}

package/src/api/protocol-v2/DeviceStatusGet.ts

@@ -1,16 +0,0 @@
-import { BaseMethod } from '../BaseMethod';
-
-export default class DeviceStatusGet extends BaseMethod {
-  init() {
-    this.requireProtocolV2 = true;
-    this.unlockPolicy = 'none';
-    this.useDevicePassphraseState = false;
-    this.skipForceUpdateCheck = true;
-  }
-
-  async run() {
-    const { message } = await this.device.commands.typedCall('DeviceStatusGet', 'DeviceStatus', {});
-    this.device.updateProtocolV2Status(message);
-    return message;
-  }
-}

package/src/api/protocol-v2/DeviceUploadWallpaper.ts

@@ -1,131 +0,0 @@
-import { blake2s } from '@noble/hashes/blake2s';
-import { bytesToHex } from '@noble/hashes/utils';
-
-import { BaseMethod } from '../BaseMethod';
-import { invalidParameter } from '../helpers/filesystemValidation';
-import { writeProtocolV2File } from '../helpers/protocolV2FileWrite';
-import { UI_REQUEST, createUiMessage } from '../../events/ui-request';
-import {
-  PRO2_WALLPAPER_HEIGHT,
-  PRO2_WALLPAPER_WIDTH,
-  type Pro2WallpaperColorFormat,
-  encodePro2Wallpaper,
-} from '../../utils/pro2Wallpaper';
-
-export type DeviceUploadWallpaperParams = {
-  width: number;
-  height: number;
-  rgba: Uint8Array | ArrayBuffer;
-  fileName?: string;
-  chunkSize?: number;
-};
-
-export type DeviceUploadWallpaperResponse = {
-  path: string;
-  size: number;
-  colorFormat: Pro2WallpaperColorFormat;
-  message?: string;
-};
-
-const WALLPAPER_DIRECTORY = 'vol1:/wallpapers';
-const SAFE_FILE_NAME = /^[A-Za-z0-9_-]+(?:\.bin)?$/;
-
-function normalizeFileName(fileName: string | undefined, data: Uint8Array): string {
-  if (fileName !== undefined && (!fileName || !SAFE_FILE_NAME.test(fileName))) {
-    throw invalidParameter(
-      'Parameter [fileName] may only contain letters, numbers, underscores, hyphens and an optional .bin suffix.'
-    );
-  }
-  const baseName = fileName ?? `wallpaper-${bytesToHex(blake2s(data)).slice(0, 12)}`;
-  return baseName.endsWith('.bin') ? baseName : `${baseName}.bin`;
-}
-
-export default class DeviceUploadWallpaper extends BaseMethod<DeviceUploadWallpaperParams> {
-  private encoded?: { data: Uint8Array; colorFormat: Pro2WallpaperColorFormat };
-
-  private directoryReady = false;
-
-  private uploaded = false;
-
-  private path = '';
-
-  init() {
-    const { width, height, rgba, fileName, chunkSize } = this.payload;
-    if (width !== PRO2_WALLPAPER_WIDTH || height !== PRO2_WALLPAPER_HEIGHT) {
-      throw invalidParameter(
-        `Pro2 wallpaper dimensions must be ${PRO2_WALLPAPER_WIDTH}x${PRO2_WALLPAPER_HEIGHT}.`
-      );
-    }
-    if (!(rgba instanceof ArrayBuffer) && !ArrayBuffer.isView(rgba)) {
-      throw invalidParameter('Parameter [rgba] must be an ArrayBuffer or Uint8Array.');
-    }
-    if (chunkSize !== undefined && (!Number.isInteger(chunkSize) || chunkSize <= 0)) {
-      throw invalidParameter('Parameter [chunkSize] must be a positive integer.');
-    }
-
-    const rgbaBytes =
-      rgba instanceof ArrayBuffer
-        ? rgba
-        : new Uint8Array(rgba.buffer, rgba.byteOffset, rgba.byteLength);
-    this.encoded = encodePro2Wallpaper({ width, height, rgba: rgbaBytes });
-    this.path = `${WALLPAPER_DIRECTORY}/${normalizeFileName(fileName, this.encoded.data)}`;
-    this.params = { width, height, rgba: rgbaBytes, fileName, chunkSize };
-    this.requireProtocolV2 = true;
-    this.unlockPolicy = 'retry-on-locked';
-    this.skipForceUpdateCheck = true;
-    this.useDevicePassphraseState = false;
-  }
-
-  private async ensureDirectory() {
-    if (this.directoryReady) return;
-    try {
-      await this.device.commands.typedCall('FilesystemDirMake', 'Success', {
-        path: WALLPAPER_DIRECTORY,
-      });
-    } catch (error) {
-      const message = error instanceof Error ? error.message : String(error);
-      if (!/exist/i.test(message)) throw error;
-    }
-    this.directoryReady = true;
-  }
-
-  private async upload() {
-    if (this.uploaded) return;
-    const { encoded } = this;
-    if (!encoded) throw invalidParameter('Wallpaper data has not been initialized.');
-
-    await writeProtocolV2File({
-      commands: this.device.commands,
-      path: this.path,
-      data: encoded.data,
-      totalSize: encoded.data.byteLength,
-      chunkSize: this.params.chunkSize,
-      maxChunkRetries: 3,
-      overwrite: true,
-      append: false,
-      throwIfAborted: () => this.throwIfAborted(),
-      onProgress: payload => {
-        if (typeof this.postMessage === 'function') {
-          this.postMessage(createUiMessage(UI_REQUEST.DEVICE_PROGRESS, payload));
-        }
-      },
-    });
-    this.uploaded = true;
-  }
-
-  async run(): Promise<DeviceUploadWallpaperResponse> {
-    const { encoded } = this;
-    if (!encoded) throw invalidParameter('Wallpaper data has not been initialized.');
-    await this.ensureDirectory();
-    await this.upload();
-    const response = await this.device.commands.typedCall('DeviceSettingsSet', 'Success', {
-      settings: { wallpaper_path: this.path },
-    });
-    return {
-      path: this.path,
-      size: encoded.data.byteLength,
-      colorFormat: encoded.colorFormat,
-      message: response.message?.message,
-    };
-  }
-}

package/src/api/protocol-v2/FilesystemFormat.ts

@@ -1,19 +0,0 @@
-import { BaseMethod } from '../BaseMethod';
-
-export default class FilesystemFormat extends BaseMethod {
-  init() {
-    // Protocol V2 (Pro2) only; Core rejects non-V2 devices.
-    this.requireProtocolV2 = true;
-    this.skipForceUpdateCheck = true;
-    this.useDevicePassphraseState = false;
-    this.params = undefined;
-  }
-
-  async run() {
-    const res = await this.device.commands.typedCall('FilesystemFormat', 'Success', {
-      data: true,
-      user: true,
-    });
-    return Promise.resolve(res.message);
-  }
-}

package/src/api/protocol-v2/FilesystemPermissionFix.ts

@@ -1,16 +0,0 @@
-import { BaseMethod } from '../BaseMethod';
-
-export default class FilesystemPermissionFix extends BaseMethod {
-  init() {
-    // Protocol V2 (Pro2) only; Core rejects non-V2 devices.
-    this.requireProtocolV2 = true;
-    this.skipForceUpdateCheck = true;
-    this.useDevicePassphraseState = false;
-    this.params = undefined;
-  }
-
-  async run() {
-    const res = await this.device.commands.typedCall('FilesystemPermissionFix', 'Success', {});
-    return Promise.resolve(res.message);
-  }
-}

package/src/api/protocol-v2/Ping.ts

@@ -1,18 +0,0 @@
-import { BaseMethod } from '../BaseMethod';
-
-export default class Ping extends BaseMethod<{ message?: string }> {
-  init() {
-    // Protocol V2 (Pro2) only; Core rejects non-V2 devices.
-    this.requireProtocolV2 = true;
-    this.skipForceUpdateCheck = true;
-    this.useDevicePassphraseState = false;
-    this.params = { message: this.payload.message };
-  }
-
-  async run() {
-    const res = await this.device.commands.typedCall('Ping', 'Success', {
-      message: this.params.message ?? '',
-    });
-    return Promise.resolve(res.message);
-  }
-}

package/src/api/protocol-v2/ProtocolInfoRequest.ts

@@ -1,16 +0,0 @@
-import { BaseMethod } from '../BaseMethod';
-
-export default class ProtocolInfoRequest extends BaseMethod {
-  init() {
-    // Protocol V2 (Pro2) only; Core rejects non-V2 devices.
-    this.requireProtocolV2 = true;
-    this.skipForceUpdateCheck = true;
-    this.useDevicePassphraseState = false;
-    this.params = undefined;
-  }
-
-  async run() {
-    const res = await this.device.commands.typedCall('ProtocolInfoRequest', 'ProtocolInfo', {});
-    return Promise.resolve(res.message);
-  }
-}

package/src/api/protocol-v2/helpers.ts

@@ -1,203 +0,0 @@
-import { DeviceRebootType } from '@onekeyfe/hd-transport';
-
-import { invalidParameter, validateNonEmptyString } from '../helpers/filesystemValidation';
-import { ProtocolV2FirmwareTargetType } from '../../protocols/protocol-v2/firmware';
-
-import type {
-  DeviceFirmwareTarget,
-  DeviceFirmwareTargetType,
-  DeviceFirmwareUpdateRecordFields,
-  TransportCallOptions,
-} from '@onekeyfe/hd-transport';
-
-export type RebootTypeInput = DeviceRebootType | keyof typeof DeviceRebootType | string | number;
-
-export type DeviceRebootParams = {
-  rebootType?: RebootTypeInput;
-  reboot_type?: RebootTypeInput;
-};
-
-export type DeviceFirmwareTargetInput =
-  | DeviceFirmwareTarget
-  | {
-      targetId?: DeviceFirmwareTargetType | string | number;
-      target_id?: DeviceFirmwareTargetType | string | number;
-      path: string;
-    };
-
-export type DeviceFirmwareUpdateParams = {
-  targets?: DeviceFirmwareTargetInput[];
-  targetId?: DeviceFirmwareTargetType | string | number;
-  target_id?: DeviceFirmwareTargetType | string | number;
-  path?: string;
-};
-
-export type DeviceFirmwareUpdateStatusGetParams = {
-  fields?: DeviceFirmwareUpdateRecordFields;
-};
-
-export type DeviceFactoryInfoSetParams = {
-  version?: number;
-  serial_number?: string;
-  burn_in_completed?: boolean;
-  factory_test_completed?: boolean;
-  manufacture_time?: {
-    year: number;
-    month: number;
-    day: number;
-    hour: number;
-    minute: number;
-    second: number;
-  };
-};
-
-const DEVICE_REBOOT_TYPES: Record<string, DeviceRebootType> = {
-  Normal: DeviceRebootType.Normal,
-  normal: DeviceRebootType.Normal,
-  Romloader: DeviceRebootType.Romloader,
-  romloader: DeviceRebootType.Romloader,
-  Boardloader: DeviceRebootType.Romloader,
-  boardloader: DeviceRebootType.Romloader,
-  Bootloader: DeviceRebootType.Bootloader,
-  bootloader: DeviceRebootType.Bootloader,
-};
-
-export const PROTOCOL_V2_FIRMWARE_UPDATE_OPTIONS: TransportCallOptions = {
-  intermediateTypes: ['DeviceFirmwareUpdateStatus'],
-};
-
-export const PROTOCOL_V2_FIRMWARE_UPDATE_RESPONSE_TYPES: (
-  | 'Success'
-  | 'DeviceFirmwareUpdateStatus'
-)[] = ['Success', 'DeviceFirmwareUpdateStatus'];
-
-export const getProtocolV2UnknownErrorText = (error: unknown) => {
-  if (!error) {
-    return '';
-  }
-  if (typeof error === 'string') {
-    return error;
-  }
-
-  const parts: string[] = [];
-  if (error instanceof Error) {
-    parts.push(error.name, error.message);
-  }
-
-  if (typeof error === 'object') {
-    const record = error as Record<string, unknown>;
-    for (const field of ['name', 'message', 'reason', 'code', 'errorCode', 'nativeErrorCode']) {
-      const value = record[field];
-      if (value !== undefined && value !== null) {
-        parts.push(String(value));
-      }
-    }
-  }
-
-  const stringified = String(error);
-  if (stringified && stringified !== '[object Object]') {
-    parts.push(stringified);
-  }
-
-  return parts.filter(Boolean).join(' ');
-};
-
-export const isProtocolV2DeviceDisconnectedError = (error: unknown) => {
-  const message = getProtocolV2UnknownErrorText(error).toLowerCase();
-  const compactMessage = message.replace(/\s+/g, '');
-  return (
-    message.includes('notfounderror') ||
-    (message.includes("failed to execute 'open'") && message.includes('usbdevice')) ||
-    message.includes('device was disconnected') ||
-    message.includes('device disconnected') ||
-    message.includes('device disconnect') ||
-    message.includes('was disconnected') ||
-    message.includes('bledevicedisconnected') ||
-    message.includes('bleconnectederror') ||
-    message.includes('connected error is always runtime error') ||
-    message.includes('connection has timed out unexpectedly') ||
-    message.includes('connection error has occured') ||
-    message.includes('connection error has occurred') ||
-    message.includes('multiplatformbleadapter') ||
-    message.includes('multipalformebleadapter') ||
-    compactMessage.includes('rxerrorerror6') ||
-    message.includes('rxerror error 6')
-  );
-};
-
-export function normalizeRebootType(value: RebootTypeInput | undefined): DeviceRebootType {
-  if (typeof value === 'number') return value;
-  if (typeof value === 'string') {
-    const numeric = Number(value);
-    if (Number.isFinite(numeric)) return numeric;
-    if (value in DEVICE_REBOOT_TYPES) return DEVICE_REBOOT_TYPES[value];
-  }
-  return DeviceRebootType.Normal;
-}
-
-// 与 firmware-pro2 的 proto_target_to_firmware_target 安装白名单保持一致。
-const INSTALLABLE_FIRMWARE_TARGET_IDS = new Set<number>([
-  ProtocolV2FirmwareTargetType.FW_MGMT_TARGET_CRATE,
-  ProtocolV2FirmwareTargetType.FW_MGMT_TARGET_BOOTLOADER,
-  ProtocolV2FirmwareTargetType.FW_MGMT_TARGET_APPLICATION_P1,
-  ProtocolV2FirmwareTargetType.FW_MGMT_TARGET_APPLICATION_P2,
-  ProtocolV2FirmwareTargetType.FW_MGMT_TARGET_COPROCESSOR,
-  ProtocolV2FirmwareTargetType.FW_MGMT_TARGET_SE01,
-  ProtocolV2FirmwareTargetType.FW_MGMT_TARGET_SE02,
-  ProtocolV2FirmwareTargetType.FW_MGMT_TARGET_SE03,
-  ProtocolV2FirmwareTargetType.FW_MGMT_TARGET_SE04,
-]);
-const FIRMWARE_TARGET_ID_BY_NAME = new Map<string, DeviceFirmwareTargetType>(
-  Object.entries(ProtocolV2FirmwareTargetType).flatMap(([key, value]) =>
-    INSTALLABLE_FIRMWARE_TARGET_IDS.has(value) ? [[key, value as DeviceFirmwareTargetType]] : []
-  )
-);
-
-function normalizeTargetId(
-  value: DeviceFirmwareTargetType | string | number | undefined,
-  name: string
-): DeviceFirmwareTargetType {
-  if (value === undefined || value === null) {
-    throw invalidParameter(`Missing required parameter: ${name}`);
-  }
-  const named = typeof value === 'string' ? FIRMWARE_TARGET_ID_BY_NAME.get(value) : undefined;
-  const numeric = named ?? (typeof value === 'number' ? value : Number(value));
-  if (Number.isSafeInteger(numeric) && INSTALLABLE_FIRMWARE_TARGET_IDS.has(numeric)) {
-    return numeric as DeviceFirmwareTargetType;
-  }
-  throw invalidParameter(
-    `Parameter [${name}] must be an installable firmware target id (one of ${[
-      ...INSTALLABLE_FIRMWARE_TARGET_IDS,
-    ].join(', ')}).`
-  );
-}
-
-export function normalizeFirmwareTargets(
-  params: DeviceFirmwareUpdateParams
-): DeviceFirmwareTarget[] {
-  const targets =
-    params.targets ??
-    (params.path
-      ? [
-          {
-            target_id: params.target_id ?? params.targetId ?? 0,
-            path: params.path,
-          },
-        ]
-      : []);
-
-  if (!Array.isArray(targets) || targets.length === 0) {
-    throw invalidParameter('Parameter [targets] must contain at least one firmware target.');
-  }
-
-  return targets.map((target, index) => {
-    if (!target || typeof target !== 'object') {
-      throw invalidParameter(`Parameter [targets.${index}] must be an object.`);
-    }
-    const targetId = target.target_id ?? target.targetId;
-    return {
-      target_id: normalizeTargetId(targetId, `targets.${index}.target_id`),
-      path: validateNonEmptyString(target.path, `targets.${index}.path`),
-    };
-  });
-}

package/src/core/deviceEventRegistration.ts

@@ -1,23 +0,0 @@
-import { DEVICE } from '../events';
-
-import type { Device, DeviceEvents } from '../device/Device';
-
-export type HardwareUiEventHandlers = {
-  pin: (...event: DeviceEvents[typeof DEVICE.PIN]) => void;
-  button: (...event: DeviceEvents[typeof DEVICE.BUTTON]) => void;
-  passphrase: (...event: DeviceEvents[typeof DEVICE.PASSPHRASE]) => void;
-  passphraseOnDevice: (...event: DeviceEvents[typeof DEVICE.PASSPHRASE_ON_DEVICE]) => void;
-  attachPinOnDevice: (...event: DeviceEvents[typeof DEVICE.ATTACH_PIN_ON_DEVICE]) => void;
-};
-
-export function registerHardwareUiEventListeners(
-  device: Pick<Device, 'on'>,
-  handlers: HardwareUiEventHandlers
-) {
-  device.on(DEVICE.PIN, handlers.pin);
-  device.on(DEVICE.BUTTON, handlers.button);
-  device.on(DEVICE.PASSPHRASE, handlers.passphrase);
-  device.on(DEVICE.PASSPHRASE_ON_DEVICE, handlers.passphraseOnDevice);
-  device.on(DEVICE.ATTACH_PIN_ON_DEVICE, handlers.attachPinOnDevice);
-  return true;
-}