@ukeyfe/hardware-core 1.1.13

package/src/api/filecoin/FilecoinSignTransaction.ts

@@ -0,0 +1,56 @@
+import { FilecoinSignTx as HardwareFilecoinSignTx } from '@ukeyfe/hardware-transport';
+import { serializedPath, validatePath } from '../helpers/pathUtils';
+import { BaseMethod } from '../BaseMethod';
+import { validateParams } from '../helpers/paramsValidator';
+import { FilecoinSignTransactionParams } from '../../types';
+import { formatAnyHex } from '../helpers/hexUtils';
+
+export default class FilecoinSignTransaction extends BaseMethod<HardwareFilecoinSignTx> {
+  hasBundle = false;
+
+  init() {
+    this.checkDeviceId = true;
+    this.allowDeviceMode = [...this.allowDeviceMode];
+
+    // check payload
+    validateParams(this.payload, [
+      { name: 'path', required: true },
+      { name: 'rawTx', type: 'hexString', required: true },
+      { name: 'isTestnet', type: 'boolean' },
+    ]);
+
+    // init params
+    const { path, rawTx, isTestnet } = this.payload as FilecoinSignTransactionParams;
+    const addressN = validatePath(path, 3);
+
+    this.params = {
+      address_n: addressN,
+      raw_tx: formatAnyHex(rawTx),
+      testnet: isTestnet,
+    };
+  }
+
+  getVersionRange() {
+    return {
+      model_mini: {
+        min: '2.10.0',
+      },
+      model_touch: {
+        min: '3.5.0',
+      },
+    };
+  }
+
+  async run() {
+    const res = await this.device.commands.typedCall('FilecoinSignTx', 'FilecoinSignedTx', {
+      ...this.params,
+    });
+
+    const { signature } = res.message;
+
+    return {
+      path: serializedPath(this.params.address_n),
+      signature,
+    };
+  }
+}

package/src/api/firmware/FirmwareUpdateBaseMethod.ts

@@ -0,0 +1,417 @@
+import {
+  createDeferred,
+  Deferred,
+  EDeviceType,
+  ERRORS,
+  HardwareError,
+  HardwareErrorCode,
+} from '@ukeyfe/hardware-shared';
+import { RebootType } from '@ukeyfe/hardware-transport';
+import type { KnownDevice } from '../../types';
+
+import {
+  UI_REQUEST,
+  createUiMessage,
+  FirmwareUpdateTipMessage,
+  IFirmwareUpdateTipMessage,
+  IFirmwareUpdateProgressType,
+} from '../../events/ui-request';
+import { DevicePool } from '../../device/DevicePool';
+import { getDeviceType, wait, getLogger, LoggerNames, getDeviceUUID } from '../../utils';
+import { DeviceModelToTypes } from '../../types';
+import { DataManager } from '../../data-manager';
+
+import { BaseMethod } from '../BaseMethod';
+import { DEVICE } from '../../events';
+import { PROTO } from '../../constants';
+
+const Log = getLogger(LoggerNames.Method);
+const SESSION_ERROR = 'session not found';
+
+export class FirmwareUpdateBaseMethod<Params> extends BaseMethod<Params> {
+  checkPromise: Deferred<any> | null = null;
+
+  init(): void {}
+
+  run(): Promise<any> {
+    return Promise.resolve();
+  }
+
+  isBleReconnect(): boolean {
+    const env = DataManager.getSettings('env');
+    return this.payload.connectId && DataManager.isBleConnect(env);
+  }
+
+  /**
+   * @description Post the tip message
+   * @param message The message to be posted, defined in IFirmwareUpdateTipMessage
+   */
+  postTipMessage = (message: IFirmwareUpdateTipMessage) => {
+    this.postMessage(
+      createUiMessage(UI_REQUEST.FIRMWARE_TIP, {
+        device: this.device.toMessageObject() as KnownDevice,
+        data: {
+          message,
+        },
+      })
+    );
+  };
+
+  /**
+   * @description Post the processing message
+   * @param type
+   */
+  postProcessingMessage = (type: 'firmware' | 'ble' | 'bootloader' | 'resource') => {
+    this.postMessage(
+      createUiMessage(UI_REQUEST.FIRMWARE_PROCESSING, {
+        type,
+      })
+    );
+  };
+
+  /**
+   * @description Post the progress message
+   * @param progress Post the percentage of the progress
+   */
+  postProgressMessage = (progress: number, progressType: IFirmwareUpdateProgressType) => {
+    this.postMessage(
+      createUiMessage(UI_REQUEST.FIRMWARE_PROGRESS, {
+        device: this.device.toMessageObject() as KnownDevice,
+        progress,
+        progressType,
+      })
+    );
+  };
+
+  private async _promptDeviceInBootloaderForWebDevice() {
+    return new Promise((resolve, reject) => {
+      if (this.device.listenerCount(DEVICE.SELECT_DEVICE_IN_BOOTLOADER_FOR_WEB_DEVICE) > 0) {
+        this.device.emit(
+          DEVICE.SELECT_DEVICE_IN_BOOTLOADER_FOR_WEB_DEVICE,
+          this.device,
+          (err, deviceId) => {
+            if (err) {
+              reject(err);
+            } else {
+              resolve(deviceId);
+            }
+          }
+        );
+      }
+    });
+  }
+
+  checkDeviceToBootloader(connectId: string | undefined) {
+    this.checkPromise = createDeferred();
+    const env = DataManager.getSettings('env');
+    const isBleReconnect = connectId && DataManager.isBleConnect(env);
+
+    Log.log('FirmwareUpdateBaseMethod [checkDeviceToBootloader] isBleReconnect: ', isBleReconnect);
+
+    // check device goto bootloader mode
+    let isFirstCheck = true;
+    let checkCount = 0;
+    // eslint-disable-next-line prefer-const
+    let timeoutTimer: ReturnType<typeof setTimeout> | undefined;
+
+    const isTouchOrProDevice =
+      getDeviceType(this?.device?.features) === EDeviceType.Touch ||
+      getDeviceType(this?.device?.features) === EDeviceType.Pro;
+
+    const intervalTimer: ReturnType<typeof setInterval> | undefined = setInterval(
+      async () => {
+        checkCount += 1;
+        Log.log('FirmwareUpdateBaseMethod [checkDeviceToBootloader] isFirstCheck: ', isFirstCheck);
+        if (isTouchOrProDevice && isFirstCheck) {
+          isFirstCheck = false;
+          Log.log('FirmwareUpdateBaseMethod [checkDeviceToBootloader] wait 3000ms');
+          await wait(3000);
+        }
+
+        if (checkCount > 4 && DataManager.isWebUsbConnect(DataManager.getSettings('env'))) {
+          clearInterval(intervalTimer);
+          clearTimeout(timeoutTimer);
+
+          try {
+            this.postTipMessage(FirmwareUpdateTipMessage.SelectDeviceInBootloaderForWebDevice);
+            const confirmed = await this._promptDeviceInBootloaderForWebDevice();
+            if (confirmed) {
+              await this._checkDeviceInBootloaderMode(connectId, intervalTimer, timeoutTimer);
+            }
+          } catch (e) {
+            Log.log(
+              'FirmwareUpdateBaseMethod [checkDeviceToBootloader] promptDeviceInBootloaderForWebDevice failed: ',
+              e
+            );
+            this.checkPromise?.reject(e);
+          }
+          return;
+        }
+
+        if (isBleReconnect) {
+          try {
+            await this.device.deviceConnector?.acquire(
+              this.device.originalDescriptor.id,
+              null,
+              true
+            );
+            await this.device.initialize();
+            if (this.device.features?.bootloader_mode) {
+              clearInterval(intervalTimer);
+              this.checkPromise?.resolve(true);
+            }
+          } catch (e) {
+            // ignore error because of device is not connected
+            Log.log('catch Bluetooth error when device is restarting: ', e);
+          }
+        } else {
+          await this._checkDeviceInBootloaderMode(connectId, intervalTimer, timeoutTimer);
+        }
+      },
+      isBleReconnect ? 3000 : 2000
+    );
+
+    // check goto bootloader mode timeout and throw error
+    timeoutTimer = setTimeout(() => {
+      if (this.checkPromise) {
+        clearInterval(intervalTimer);
+        this.checkPromise.reject(new Error());
+      }
+    }, 30000);
+  }
+
+  private async _checkDeviceInBootloaderMode(
+    connectId: string | undefined,
+    intervalTimer?: ReturnType<typeof setInterval>,
+    timeoutTimer?: ReturnType<typeof setTimeout>
+  ) {
+    const deviceDiff = await this.device.deviceConnector?.enumerate();
+    const devicesDescriptor = deviceDiff?.descriptors ?? [];
+    const { deviceList } = await DevicePool.getDevices(devicesDescriptor, connectId);
+
+    if (deviceList.length === 1 && deviceList[0]?.features?.bootloader_mode) {
+      // should update current device from cache
+      // because device was reboot and had some new requests
+      this.device.updateFromCache(deviceList[0]);
+      this.device.commands.disposed = false;
+
+      if (intervalTimer) clearInterval(intervalTimer);
+      if (timeoutTimer) clearTimeout(timeoutTimer);
+      this.checkPromise?.resolve(true);
+      return true;
+    }
+    return false;
+  }
+
+  async enterBootloaderMode() {
+    const typedCall = this.device.getCommands().typedCall.bind(this.device.getCommands());
+    if (this.device.features && !this.device.features.bootloader_mode) {
+      const uuid = getDeviceUUID(this.device.features);
+      const deviceType = getDeviceType(this.device.features);
+      // auto go to bootloader mode
+      try {
+        this.postTipMessage(FirmwareUpdateTipMessage.AutoRebootToBootloader);
+        const bootRes = await typedCall('DeviceBackToBoot', 'Success');
+        // @ts-expect-error
+        if (bootRes.type === 'CallMethodError') {
+          throw ERRORS.TypedError(HardwareErrorCode.FirmwareUpdateAutoEnterBootFailure);
+        }
+        this.postTipMessage(FirmwareUpdateTipMessage.GoToBootloaderSuccess);
+        this.checkDeviceToBootloader(this.payload.connectId);
+
+        // force clean classic device cache so that the device can initialize again
+        if (DeviceModelToTypes.model_classic.includes(deviceType)) {
+          DevicePool.clearDeviceCache(uuid);
+        }
+        delete DevicePool.devicesCache[''];
+        await this.checkPromise?.promise;
+        this.checkPromise = null;
+        /**
+         * Touch 1 with bootloader v2.5.0 issue: BLE chip need more time for looking up name, here change the delay time to 3000ms after rebooting.
+         */
+        const isTouch = DeviceModelToTypes.model_touch.includes(deviceType);
+        await wait(isTouch ? 3000 : 1500);
+        await this.device.acquire();
+        return true;
+      } catch (e) {
+        if (e instanceof HardwareError) {
+          return Promise.reject(e);
+        }
+        console.log('auto go to bootloader mode failed: ', e);
+        return Promise.reject(
+          ERRORS.TypedError(HardwareErrorCode.FirmwareUpdateAutoEnterBootFailure)
+        );
+      }
+    }
+  }
+
+  /**
+   * @description The instruction that triggers the update process
+   * @param path The path of the file to be updated
+   */
+  async startEmmcFirmwareUpdate({ path }: { path: string }) {
+    const typedCall = this.device.getCommands().typedCall.bind(this.device.getCommands());
+    const updaeteResponse = await typedCall('FirmwareUpdateEmmc', 'Success', {
+      path,
+      reboot_on_success: true,
+    });
+    if (updaeteResponse.type !== 'Success') {
+      throw ERRORS.TypedError(HardwareErrorCode.FirmwareError, 'firmware update error');
+    }
+    this.postTipMessage(FirmwareUpdateTipMessage.FirmwareUpdating);
+  }
+
+  /**
+   * @description Create the updates folder if it does not exist
+   * @param path The path of the folder to be created
+   */
+  async createUpdatesFolderIfNotExists(path: string) {
+    const typedCall = this.device.getCommands().typedCall.bind(this.device.getCommands());
+    await typedCall('EmmcDirMake', 'Success', {
+      path,
+    });
+  }
+
+  /**
+   * @param payload The payload of the file to be updated
+   * @param filePath The path of the file to be updated
+   */
+  async emmcCommonUpdateProcess({
+    payload,
+    filePath,
+    processedSize,
+    totalSize,
+  }: PROTO.FirmwareUpload & {
+    filePath: string;
+    processedSize?: number;
+    totalSize?: number;
+  }) {
+    if (!filePath.startsWith('0:')) {
+      throw new Error('filePath must start with 0:');
+    }
+    const env = DataManager.getSettings('env');
+    const perPackageSize = DataManager.isBleConnect(env) ? 16 : 128;
+    const chunkSize = 1024 * perPackageSize;
+    const totalChunks = Math.ceil(payload.byteLength / chunkSize);
+    let offset = 0;
+    let currentFileProcessed = 0;
+
+    for (let i = 0; i < totalChunks; i++) {
+      const chunkStart = i * chunkSize;
+      const chunkEnd = Math.min(chunkStart + chunkSize, payload.byteLength);
+      const chunkLength = chunkEnd - chunkStart;
+      const chunk = payload.slice(chunkStart, chunkEnd);
+      const overwrite = i === 0;
+
+      // Calculate progress based on whether we're tracking overall progress or single file progress
+      let progress: number;
+      if (totalSize !== undefined && processedSize !== undefined) {
+        currentFileProcessed = processedSize + chunkEnd;
+        progress = Math.min(Math.ceil((currentFileProcessed / totalSize) * 100), 99);
+      } else {
+        progress = Math.min(Math.ceil(((i + 1) / totalChunks) * 100), 99);
+      }
+
+      const writeRes = await this.emmcFileWriteWithRetry(
+        filePath,
+        chunkLength,
+        offset,
+        chunk,
+        overwrite,
+        progress
+      );
+      // @ts-expect-error
+      offset += writeRes.message.processed_byte;
+      this.postProgressMessage(progress, 'transferData');
+    }
+
+    // Return processed size only if we're tracking overall progress
+    return totalSize !== undefined ? (processedSize ?? 0) + payload.byteLength : 0;
+  }
+
+  async emmcFileWriteWithRetry(
+    filePath: string,
+    chunkLength: number,
+    offset: number,
+    chunk: ArrayBuffer | Buffer,
+    overwrite: boolean,
+    progress: number | null
+  ) {
+    const writeFunc = async () => {
+      const typedCall = this.device.getCommands().typedCall.bind(this.device.getCommands());
+      // @ts-expect-error
+      const writeRes = await typedCall('EmmcFileWrite', 'EmmcFile', {
+        file: {
+          path: filePath,
+          len: chunkLength,
+          offset,
+          data: chunk,
+        },
+        overwrite,
+        append: offset !== 0,
+        ui_percentage: progress,
+      });
+      if (writeRes.type !== 'EmmcFile') {
+        // @ts-expect-error
+        if (writeRes.type === 'CallMethodError') {
+          if (((writeRes as any).message.error ?? '').indexOf(SESSION_ERROR) > -1) {
+            throw ERRORS.TypedError(HardwareErrorCode.RuntimeError, SESSION_ERROR);
+          }
+        }
+        throw ERRORS.TypedError(
+          HardwareErrorCode.EmmcFileWriteFirmwareError,
+          'transfer data error'
+        );
+      }
+      return writeRes;
+    };
+
+    let retryCount = 10;
+    while (retryCount > 0) {
+      try {
+        const result = await writeFunc();
+        return result;
+      } catch (error) {
+        Log.error(`emmcWrite error: `, error);
+        retryCount--;
+        if (retryCount === 0) {
+          throw ERRORS.TypedError(
+            HardwareErrorCode.EmmcFileWriteFirmwareError,
+            'transfer data error'
+          );
+        }
+        const env = DataManager.getSettings('env');
+        if (DataManager.isBleConnect(env)) {
+          await wait(3000);
+          await this.device.deviceConnector?.acquire(this.device.originalDescriptor.id, null, true);
+          await this.device.initialize();
+        } else if (
+          error?.message?.indexOf(SESSION_ERROR) > -1 ||
+          error?.response?.data?.indexOf(SESSION_ERROR) > -1
+        ) {
+          const deviceDiff = await this.device.deviceConnector?.enumerate();
+          const devicesDescriptor = deviceDiff?.descriptors ?? [];
+          const { deviceList } = await DevicePool.getDevices(devicesDescriptor, undefined);
+          if (deviceList.length === 1 && deviceList[0]?.features?.bootloader_mode) {
+            this.device.updateFromCache(deviceList[0]);
+            await this.device.acquire();
+            this.device.getCommands().mainId = this.device.mainId ?? '';
+          }
+        }
+        await wait(2000);
+      }
+    }
+  }
+
+  /**
+   * @description 设备重启（Bootloader 侧可用）
+   * @param rebootType 重启类型，参考 RebootType 枚举
+   */
+  async reboot(rebootType: RebootType) {
+    const typedCall = this.device.getCommands().typedCall.bind(this.device.getCommands());
+    const res = await typedCall('Reboot', 'Success', {
+      reboot_type: rebootType,
+    });
+    return res.message;
+  }
+}

package/src/api/firmware/bootloaderHelper.ts

@@ -0,0 +1,44 @@
+import semver from 'semver';
+import { EDeviceType } from '@ukeyfe/hardware-shared';
+import { Features, IVersionArray } from '../../types';
+import { getDeviceType } from '../../utils';
+
+export function shouldUpdateBootloaderForClassicAndMini({
+  currentVersion,
+  bootloaderVersion,
+  willUpdateFirmware,
+  targetBootloaderVersion,
+  bootloaderRelatedFirmwareVersion,
+}: {
+  currentVersion: string;
+  bootloaderVersion: string;
+  willUpdateFirmware: string;
+  targetBootloaderVersion?: IVersionArray;
+  bootloaderRelatedFirmwareVersion: IVersionArray;
+}) {
+  // If the current bootloader version is greater than or equal to the version that needs to be upgraded, then no upgrade is required
+  if (targetBootloaderVersion && semver.gte(bootloaderVersion, targetBootloaderVersion.join('.'))) {
+    return false;
+  }
+
+  if (semver.gte(willUpdateFirmware, bootloaderRelatedFirmwareVersion.join('.'))) {
+    return true;
+  }
+
+  // The current version is greater than the relatedVersion and the bootloader version is lower than the target bootloader version
+  if (semver.gte(currentVersion, bootloaderRelatedFirmwareVersion.join('.'))) {
+    return true;
+  }
+
+  return false;
+}
+
+export function isEnteredManuallyBoot(features: Features, updateType: string) {
+  const deviceType = getDeviceType(features);
+  const isMini = deviceType === EDeviceType.Mini;
+  const isBoot183ClassicUpBle =
+    updateType === 'firmware' &&
+    deviceType === EDeviceType.Classic &&
+    features.bootloader_version === '1.8.3';
+  return isMini || isBoot183ClassicUpBle;
+}

package/src/api/firmware/getBinary.ts

@@ -0,0 +1,88 @@
+import semver from 'semver';
+import { ERRORS, HardwareErrorCode } from '@ukeyfe/hardware-shared';
+import { Features } from '../../types';
+import { getDeviceType, httpRequest } from '../../utils';
+import { DataManager } from '../../data-manager';
+import { findLatestRelease } from '../../utils/release';
+import { getFirmwareUpdateField } from '../../utils/deviceFeaturesUtils';
+import { IFirmwareField } from '../../data-manager/DataManager';
+
+export interface GetInfoProps {
+  features: Features;
+  updateType: 'firmware' | 'ble';
+  isUpdateBootloader?: boolean;
+  targetVersion?: string;
+}
+
+interface GetBinaryProps extends GetInfoProps {
+  version?: number[];
+}
+
+export const getBinary = async ({
+  features,
+  updateType,
+  version,
+  isUpdateBootloader,
+}: GetBinaryProps) => {
+  const releaseInfo = getInfo({ features, updateType, targetVersion: version?.join('.') });
+
+  if (!releaseInfo) {
+    throw ERRORS.TypedError(HardwareErrorCode.RuntimeError, 'no firmware found for this device');
+  }
+
+  if (version && !semver.eq(releaseInfo.version.join('.'), version.join('.'))) {
+    const touchWithoutVersion = getDeviceType(features) === 'touch' && !features.ukey_version;
+    if (!touchWithoutVersion) {
+      throw ERRORS.TypedError(HardwareErrorCode.RuntimeError, 'firmware version mismatch');
+    }
+  }
+
+  const url =
+    // eslint-disable-next-line no-nested-ternary
+    updateType === 'ble'
+      ? // @ts-expect-error
+        releaseInfo.webUpdate
+      : isUpdateBootloader
+      ? releaseInfo.bootloaderResource
+      : releaseInfo.url;
+  let fw;
+  try {
+    fw = await httpRequest(url, 'binary');
+  } catch {
+    throw ERRORS.TypedError(HardwareErrorCode.RuntimeError, 'Method_FirmwareUpdate_DownloadFailed');
+  }
+
+  return {
+    ...releaseInfo,
+    binary: fw,
+  };
+};
+
+export const getSysResourceBinary = async (url: string) => {
+  let fw;
+  try {
+    fw = await httpRequest(url, 'binary');
+  } catch {
+    throw ERRORS.TypedError(HardwareErrorCode.RuntimeError, 'Method_FirmwareUpdate_DownloadFailed');
+  }
+
+  return {
+    binary: fw,
+  };
+};
+
+export const getInfo = ({ features, updateType, targetVersion }: GetInfoProps) => {
+  const deviceType = getDeviceType(features);
+  if (deviceType === 'unknown') {
+    return null;
+  }
+  const { deviceMap } = DataManager;
+
+  const firmwareUpdateField: 'ble' | IFirmwareField = getFirmwareUpdateField({
+    features,
+    updateType,
+    targetVersion,
+  });
+  const releaseInfo = deviceMap?.[deviceType]?.[firmwareUpdateField] ?? [];
+  return findLatestRelease(releaseInfo);
+};

package/src/api/firmware/releaseHelper.ts

@@ -0,0 +1,67 @@
+import { DataManager } from '../../data-manager';
+import { DeviceModelToTypes, type Features } from '../../types';
+import {
+  checkNeedUpdateBootForClassicAndMini,
+  checkNeedUpdateBootForTouch,
+  getDeviceType,
+} from '../../utils';
+
+export const getFirmwareReleaseInfo = (features: Features) => {
+  const firmwareStatus = DataManager.getFirmwareStatus(features);
+  const changelog = DataManager.getFirmwareChangelog(features);
+  const release = DataManager.getFirmwareLatestRelease(features);
+  const bootloaderMode = !!features.bootloader_mode;
+  return {
+    status: firmwareStatus,
+    changelog,
+    release,
+    bootloaderMode,
+  };
+};
+
+export const getBleFirmwareReleaseInfo = (features: Features) => {
+  const firmwareStatus = DataManager.getBLEFirmwareStatus(features);
+  const changelog = DataManager.getBleFirmwareChangelog(features);
+  const release = DataManager.getBleFirmwareLatestRelease(features);
+  const bootloaderMode = !!features.bootloader_mode;
+  return {
+    status: firmwareStatus,
+    changelog,
+    release,
+    bootloaderMode,
+  };
+};
+
+export const getBootloaderReleaseInfo = (
+  features: Features,
+  willUpdateFirmwareVersion?: string
+) => {
+  const release = DataManager.getFirmwareLatestRelease(features);
+  const changelog = [release?.bootloaderChangelog].filter(
+    item =>
+      item != null &&
+      typeof item === 'object' &&
+      Object.prototype.hasOwnProperty.call(item, 'zh-CN') &&
+      Object.prototype.hasOwnProperty.call(item, 'en-US')
+  );
+
+  const bootloaderMode = !!features.bootloader_mode;
+
+  let shouldUpdate = false;
+
+  const deviceType = getDeviceType(features);
+  // classic mini classic1s
+  if (DeviceModelToTypes.model_mini.includes(deviceType)) {
+    shouldUpdate = !!checkNeedUpdateBootForClassicAndMini(features, willUpdateFirmwareVersion);
+  } else if (DeviceModelToTypes.model_touch.includes(deviceType)) {
+    shouldUpdate = checkNeedUpdateBootForTouch(features);
+  }
+
+  return {
+    status: shouldUpdate ? 'outdated' : 'valid',
+    changelog,
+    release,
+    bootloaderMode,
+    shouldUpdate,
+  };
+};