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

package/src/api/CheckAllFirmwareRelease.ts

@@ -1,5 +1,8 @@
-import { BaseMethod } from './BaseMethod';
+import { EFirmwareType, ERRORS, HardwareErrorCode } from '@onekeyfe/hd-shared';
+import semver from 'semver';
+
 import { UI_REQUEST } from '../constants/ui-request';
+import { DataManager } from '../data-manager';
 import {
   getBleFirmwareReleaseInfo,
   getBootloaderReleaseInfo,
@@ -7,13 +10,247 @@ import {
 } from './firmware/releaseHelper';
 import { getBridgeReleaseInfo } from '../utils/bridgeUpdate';
 import { getDeviceFirmwareVersion, getDeviceType, getFirmwareType } from '../utils';
+import { BaseMethod } from './BaseMethod';
 
 import type {
   AllFirmwareRelease,
   CheckAllFirmwareReleaseParams,
+  ProtocolV2FirmwareComponentRelease,
+  ProtocolV2FirmwareReleaseStatus,
 } from '../types/api/checkAllFirmwareRelease';
+import type { FirmwareUpdateV4Target } from '../types/api/firmwareUpdate';
+import type {
+  DeviceFeaturesVerify,
+  DeviceStateVersions,
+  IFirmwareReleaseInfo,
+  IProtocolV2FirmwareComponent,
+  IProtocolV2FirmwareComponentTarget,
+} from '../types';
+
+const UPDATE_TARGET_BY_COMPONENT_TARGET: Readonly<
+  Partial<Record<IProtocolV2FirmwareComponentTarget, FirmwareUpdateV4Target>>
+> = {
+  BOOTLOADER: 'boot',
+  APPLICATION_P1: 'app_v1',
+  APPLICATION_P2: 'app_v2',
+  COPROCESSOR: 'coprocessor',
+  SE01: 'se01',
+  SE02: 'se02',
+  SE03: 'se03',
+  SE04: 'se04',
+};
+
+const CURRENT_VERSION_BY_COMPONENT_TARGET: Readonly<
+  Record<IProtocolV2FirmwareComponentTarget, keyof DeviceStateVersions | null>
+> = {
+  ROMLOADER: 'board',
+  BOOTLOADER: 'bootloader',
+  APPLICATION_P1: 'applicationP1',
+  APPLICATION_P2: 'applicationP2',
+  COPROCESSOR: 'ble',
+  SE01: 'se01',
+  SE02: 'se02',
+  SE03: 'se03',
+  SE04: 'se04',
+};
+
+const CURRENT_HASH_BY_COMPONENT_TARGET: Readonly<
+  Partial<Record<IProtocolV2FirmwareComponentTarget, keyof DeviceFeaturesVerify>>
+> = {
+  BOOTLOADER: 'bootloaderHash',
+  APPLICATION_P1: 'applicationP1Hash',
+  APPLICATION_P2: 'applicationP2Hash',
+};
+
+function normalizeHex(value: string | undefined): string | undefined {
+  const normalized = value?.replace(/^0x/i, '').toLowerCase();
+  return normalized && /^[0-9a-f]+$/.test(normalized) ? normalized : undefined;
+}
+
+function toVersionString(version: number[] | undefined): string | null {
+  return version?.length ? version.join('.') : null;
+}
+
+function getOrderedComponentEntries(release: IFirmwareReleaseInfo) {
+  const components = release.components ?? {};
+  const orderedKeys = [
+    ...(release.installOrder ?? []),
+    ...Object.keys(components).filter(key => !release.installOrder?.includes(key)),
+  ];
+  return orderedKeys
+    .map(key => {
+      const component = components[key];
+      return component ? ([key, component] as const) : undefined;
+    })
+    .filter((entry): entry is readonly [string, IProtocolV2FirmwareComponent] => !!entry);
+}
+
+function buildComponentRelease({
+  configKey,
+  component,
+  currentVersions,
+  currentVerification,
+  remotePayloadHash,
+  releaseRequired,
+}: {
+  configKey: string;
+  component: IProtocolV2FirmwareComponent;
+  currentVersions: DeviceStateVersions;
+  currentVerification: Partial<DeviceFeaturesVerify>;
+  remotePayloadHash: string | null | undefined;
+  releaseRequired: boolean;
+}): ProtocolV2FirmwareComponentRelease {
+  const componentTarget = component.target.toUpperCase() as IProtocolV2FirmwareComponentTarget;
+  const updateTarget = UPDATE_TARGET_BY_COMPONENT_TARGET[componentTarget] ?? null;
+  const currentVersionKey = CURRENT_VERSION_BY_COMPONENT_TARGET[componentTarget];
+  const currentVersion = currentVersionKey
+    ? currentVersions[currentVersionKey] ??
+      (componentTarget === 'APPLICATION_P1' ? currentVersions.firmware : null) ??
+      null
+    : null;
+  const targetVersion = toVersionString(component.version);
+
+  let status: ProtocolV2FirmwareComponentRelease['status'] = 'unknown';
+  if (!updateTarget) {
+    status = 'unsupported';
+  } else if (
+    currentVersion &&
+    targetVersion &&
+    semver.valid(currentVersion) &&
+    semver.valid(targetVersion)
+  ) {
+    if (semver.lt(currentVersion, targetVersion)) {
+      status = 'outdated';
+    } else if (semver.gt(currentVersion, targetVersion)) {
+      status = 'valid';
+    } else {
+      const currentHashKey = CURRENT_HASH_BY_COMPONENT_TARGET[componentTarget];
+      if (!currentHashKey) {
+        status = 'valid';
+      } else {
+        const currentHash = normalizeHex(currentVerification[currentHashKey]);
+        const expectedHash = normalizeHex(remotePayloadHash ?? undefined);
+        if (currentHash && expectedHash) {
+          status = expectedHash.startsWith(currentHash) ? 'valid' : 'outdated';
+        } else {
+          status = 'unknown';
+        }
+      }
+    }
+  }
+
+  return {
+    configKey,
+    componentTarget,
+    updateTarget,
+    currentVersion,
+    targetVersion,
+    status,
+    required: releaseRequired && status === 'outdated',
+  };
+}
+
+type ProtocolV2FirmwareReleasePlan = {
+  firmwareType: EFirmwareType;
+  status: ProtocolV2FirmwareReleaseStatus;
+  hasUpgrade: boolean;
+  required: boolean;
+  currentVersions: DeviceStateVersions;
+  components: ProtocolV2FirmwareComponentRelease[];
+  targetsToUpdate: FirmwareUpdateV4Target[];
+  release: IFirmwareReleaseInfo | undefined;
+};
+
+export function buildProtocolV2FirmwareRelease({
+  currentVersions,
+  currentVerification = {},
+  remotePayloadHashes = {},
+  firmwareType,
+  release,
+}: {
+  currentVersions: DeviceStateVersions;
+  currentVerification?: Partial<DeviceFeaturesVerify>;
+  remotePayloadHashes?: Readonly<Record<string, string | null>>;
+  firmwareType: EFirmwareType;
+  release: IFirmwareReleaseInfo | undefined;
+}): ProtocolV2FirmwareReleasePlan {
+  if (!release) {
+    return {
+      firmwareType,
+      status: 'unavailable' as const,
+      hasUpgrade: false,
+      required: false,
+      currentVersions,
+      components: [],
+      targetsToUpdate: [],
+      release: undefined,
+    };
+  }
+
+  let components = getOrderedComponentEntries(release).map(([configKey, component]) =>
+    buildComponentRelease({
+      configKey,
+      component,
+      currentVersions,
+      currentVerification,
+      remotePayloadHash: Object.prototype.hasOwnProperty.call(remotePayloadHashes, configKey)
+        ? remotePayloadHashes[configKey]
+        : normalizeHex(component.payloadHash),
+      releaseRequired: release.required,
+    })
+  );
+  if (!currentVersions.applicationP2) {
+    const applicationP1 = components.find(
+      component => component.componentTarget === 'APPLICATION_P1'
+    );
+    if (applicationP1) {
+      components = components.map(component =>
+        component.componentTarget === 'APPLICATION_P2' && component.status === 'unknown'
+          ? {
+              ...component,
+              currentVersion: currentVersions.applicationP1 ?? currentVersions.firmware,
+              status: applicationP1.status,
+              required: applicationP1.required,
+            }
+          : component
+      );
+    }
+  }
+  const targetsToUpdate = components.flatMap(component =>
+    component.status === 'outdated' && component.updateTarget ? [component.updateTarget] : []
+  );
+  if (targetsToUpdate.length > 0 && release.resourceBundles?.length) {
+    targetsToUpdate.push('resource');
+  }
+  const uniqueTargetsToUpdate = Array.from(new Set(targetsToUpdate));
+  const hasUpgrade = uniqueTargetsToUpdate.length > 0;
+  const required = release.required && hasUpgrade;
+  let status: ProtocolV2FirmwareReleaseStatus = 'valid';
+  if (required) {
+    status = 'required';
+  } else if (hasUpgrade) {
+    status = 'outdated';
+  } else if (components.some(component => component.status === 'unknown')) {
+    status = 'unknown';
+  }
+
+  return {
+    firmwareType,
+    status,
+    hasUpgrade,
+    required,
+    currentVersions,
+    components,
+    targetsToUpdate: uniqueTargetsToUpdate,
+    release,
+  };
+}
 
 export default class CheckAllFirmwareRelease extends BaseMethod {
+  getSupportedProtocols() {
+    return ['V1', 'V2'] as const;
+  }
+
   init() {
     this.allowDeviceMode = [...this.allowDeviceMode, UI_REQUEST.BOOTLOADER];
     this.useDevicePassphraseState = false;
@@ -21,6 +258,10 @@ export default class CheckAllFirmwareRelease extends BaseMethod {
   }
 
   async run() {
+    if (this.device.isProtocolV2()) {
+      return this.runProtocolV2();
+    }
+
     const { features } = this.device;
     const { checkBridgeRelease, firmwareType: firmwareTypeParams } = this
       .payload as CheckAllFirmwareReleaseParams;
@@ -70,4 +311,58 @@ export default class CheckAllFirmwareRelease extends BaseMethod {
       features,
     } as AllFirmwareRelease;
   }
+
+  private async runProtocolV2(): Promise<AllFirmwareRelease> {
+    const state = await this.device.getDeviceState({
+      refreshSections: ['identity', 'versions', 'verification'],
+    });
+    if (state.identity.deviceType !== 'pro2') {
+      throw ERRORS.TypedError(
+        HardwareErrorCode.DeviceNotSupportMethod,
+        'checkAllFirmwareRelease requires a Pro2 device for Protocol V2'
+      );
+    }
+
+    const { features } = this.device;
+    if (!features) {
+      throw ERRORS.TypedError(
+        HardwareErrorCode.RuntimeError,
+        'checkAllFirmwareRelease requires initialized device features'
+      );
+    }
+
+    const { firmwareType: firmwareTypeParam } = this.payload as CheckAllFirmwareReleaseParams;
+    const firmwareType =
+      firmwareTypeParam ?? state.identity.firmwareType ?? EFirmwareType.Universal;
+    const release = DataManager.getFirmwareLatestRelease(features, firmwareType);
+    const plan = buildProtocolV2FirmwareRelease({
+      currentVersions: state.versions,
+      currentVerification: state.verification,
+      firmwareType,
+      release,
+    });
+    const firmwareStatus = plan.status === 'unavailable' ? 'unknown' : plan.status;
+    const emptyRelease = 'none' as const;
+
+    return {
+      firmware: {
+        status: firmwareStatus,
+        changelog: release ? [release.changelog] : [],
+        release: release ?? emptyRelease,
+        bootloaderMode: state.status.mode === 'bootloader' || state.status.mode === 'romloader',
+      },
+      ble: {
+        status: 'valid',
+        release: emptyRelease,
+      },
+      bootloader: {
+        status: 'valid',
+        release: emptyRelease,
+      },
+      features,
+      protocol: 'V2',
+      deviceType: 'pro2',
+      ...plan,
+    };
+  }
 }

package/src/api/CheckBootloaderRelease.ts

@@ -1,7 +1,6 @@
 import { BaseMethod } from './BaseMethod';
 import { UI_REQUEST } from '../constants/ui-request';
 import { getBootloaderReleaseInfo } from './firmware/releaseHelper';
-import { getFirmwareType } from '../utils';
 
 import type { CheckBootloaderReleaseParams } from '../types/api/checkBootloaderRelease';
 
@@ -19,7 +18,7 @@ export default class CheckBootloaderRelease extends BaseMethod {
     const { features } = this.device;
     const payload = this.payload as CheckBootloaderReleaseParams;
 
-    const deviceFirmwareType = getFirmwareType(features);
+    const deviceFirmwareType = this.device.getCurrentFirmwareType();
     const firmwareType = payload.firmwareType ?? deviceFirmwareType;
 
     const releaseInfo = getBootloaderReleaseInfo({

package/src/api/CheckFirmwareRelease.ts

@@ -1,7 +1,6 @@
 import { BaseMethod } from './BaseMethod';
 import { UI_REQUEST } from '../constants/ui-request';
 import { getFirmwareReleaseInfo } from './firmware/releaseHelper';
-import { getFirmwareType } from '../utils';
 
 import type { CheckFirmwareReleaseParams } from '../types/api/checkFirmwareRelease';
 
@@ -20,7 +19,7 @@ export default class CheckFirmwareRelease extends BaseMethod {
     const payload = this.payload as CheckFirmwareReleaseParams;
 
     if (this.device.features) {
-      const deviceFirmwareType = getFirmwareType(this.device.features);
+      const deviceFirmwareType = this.device.getCurrentFirmwareType();
       const firmwareType = payload.firmwareType ?? deviceFirmwareType;
 
       const releaseInfo = getFirmwareReleaseInfo(this.device.features, firmwareType);

package/src/api/CipherKeyValue.ts

@@ -8,6 +8,10 @@ import type { CipheredKeyValue, CipheredKeyValueParams } from '../types';
 import type { CipherKeyValue as HardwareCipherKeyValue } from '@onekeyfe/hd-transport';
 
 export default class CipherKeyValue extends BaseMethod<HardwareCipherKeyValue[]> {
+  getSupportedProtocols() {
+    return ['V1', 'V2'] as const;
+  }
+
   hasBundle = false;
 
   init() {

package/src/api/ClearSessionCache.ts

@@ -0,0 +1,32 @@
+import { BaseMethod } from './BaseMethod';
+import { invalidParameter } from './helpers/paramsValidator';
+import { deviceWalletSessionStore } from '../device/DeviceWalletSessionStore';
+
+import type { ClearSessionCacheParams } from '../types/api/sessionCache';
+
+export default class ClearSessionCache extends BaseMethod<ClearSessionCacheParams> {
+  init() {
+    if (this.payload.passphraseState !== undefined && !this.payload.deviceId) {
+      throw invalidParameter('Parameter [deviceId] is required with [passphraseState].');
+    }
+    this.useDevice = false;
+    this.useDevicePassphraseState = false;
+    this.skipForceUpdateCheck = true;
+    this.params = {
+      deviceId: this.payload.deviceId,
+      passphraseState: this.payload.passphraseState,
+    };
+  }
+
+  run() {
+    const { deviceId, passphraseState } = this.params;
+    if (!deviceId) {
+      deviceWalletSessionStore.clear();
+    } else if (!passphraseState) {
+      deviceWalletSessionStore.deleteDevice(deviceId);
+    } else {
+      deviceWalletSessionStore.delete(deviceId, passphraseState);
+    }
+    return Promise.resolve({ cleared: true as const });
+  }
+}

package/src/api/DirList.ts

@@ -1,7 +1,7 @@
 import { BaseMethod } from './BaseMethod';
 import {
-  validateNonEmptyString,
   validateOptionalNonNegativeInteger,
+  validateProtocolV2FilesystemPath,
 } from './helpers/filesystemValidation';
 
 export type DirListParams = {
@@ -10,13 +10,18 @@ export type DirListParams = {
 };
 
 export default class DirList extends BaseMethod<DirListParams> {
+  getSupportedProtocols() {
+    return ['V2'] as const;
+  }
+
   init() {
-    // Protocol V2 (Pro2) 专属方法，core 调度层统一做非 V2 设备守卫
-    this.requireProtocolV2 = true;
+    // Protocol V2 (Pro2) only; Core rejects non-V2 devices.
     this.skipForceUpdateCheck = true;
     this.useDevicePassphraseState = false;
     this.params = {
-      path: validateNonEmptyString(this.payload.path, 'path'),
+      path: validateProtocolV2FilesystemPath(this.payload.path, 'path', {
+        allowVolumeRoot: true,
+      }),
       depth: validateOptionalNonNegativeInteger(this.payload.depth, 'depth'),
     };
   }

package/src/api/DirMake.ts

@@ -1,17 +1,20 @@
 import { BaseMethod } from './BaseMethod';
-import { validateNonEmptyString } from './helpers/filesystemValidation';
+import { validateProtocolV2FilesystemPath } from './helpers/filesystemValidation';
 
 export type DirMakeParams = {
   path: string;
 };
 
 export default class DirMake extends BaseMethod<DirMakeParams> {
+  getSupportedProtocols() {
+    return ['V2'] as const;
+  }
+
   init() {
-    // Protocol V2 (Pro2) 专属方法，core 调度层统一做非 V2 设备守卫
-    this.requireProtocolV2 = true;
+    // Protocol V2 (Pro2) only; Core rejects non-V2 devices.
     this.skipForceUpdateCheck = true;
     this.useDevicePassphraseState = false;
-    this.params = { path: validateNonEmptyString(this.payload.path, 'path') };
+    this.params = { path: validateProtocolV2FilesystemPath(this.payload.path, 'path') };
   }
 
   async run() {

package/src/api/DirRemove.ts

@@ -1,17 +1,20 @@
 import { BaseMethod } from './BaseMethod';
-import { validateNonEmptyString } from './helpers/filesystemValidation';
+import { validateProtocolV2FilesystemPath } from './helpers/filesystemValidation';
 
 export type DirRemoveParams = {
   path: string;
 };
 
 export default class DirRemove extends BaseMethod<DirRemoveParams> {
+  getSupportedProtocols() {
+    return ['V2'] as const;
+  }
+
   init() {
-    // Protocol V2 (Pro2) 专属方法，core 调度层统一做非 V2 设备守卫
-    this.requireProtocolV2 = true;
+    // Protocol V2 (Pro2) only; Core rejects non-V2 devices.
     this.skipForceUpdateCheck = true;
     this.useDevicePassphraseState = false;
-    this.params = { path: validateNonEmptyString(this.payload.path, 'path') };
+    this.params = { path: validateProtocolV2FilesystemPath(this.payload.path, 'path') };
   }
 
   async run() {

package/src/api/FileDelete.ts

@@ -1,17 +1,20 @@
 import { BaseMethod } from './BaseMethod';
-import { validateNonEmptyString } from './helpers/filesystemValidation';
+import { validateProtocolV2FilesystemPath } from './helpers/filesystemValidation';
 
 export type FileDeleteParams = {
   path: string;
 };
 
 export default class FileDelete extends BaseMethod<FileDeleteParams> {
+  getSupportedProtocols() {
+    return ['V2'] as const;
+  }
+
   init() {
-    // Protocol V2 (Pro2) 专属方法，core 调度层统一做非 V2 设备守卫
-    this.requireProtocolV2 = true;
+    // Protocol V2 (Pro2) only; Core rejects non-V2 devices.
     this.skipForceUpdateCheck = true;
     this.useDevicePassphraseState = false;
-    this.params = { path: validateNonEmptyString(this.payload.path, 'path') };
+    this.params = { path: validateProtocolV2FilesystemPath(this.payload.path, 'path') };
   }
 
   async run() {

package/src/api/FileRead.ts

@@ -1,15 +1,15 @@
 import {
-  PROTOCOL_V2_BLE_FILE_CHUNK_SIZE,
+  PROTOCOL_V2_BLE_FILE_READ_CHUNK_SIZE,
   PROTOCOL_V2_WEBUSB_FILE_CHUNK_SIZE,
 } from '@onekeyfe/hd-transport';
 import { ERRORS, HardwareErrorCode } from '@onekeyfe/hd-shared';
 
 import { BaseMethod } from './BaseMethod';
 import {
-  validateNonEmptyString,
   validateNonNegativeInteger,
   validateOptionalNonNegativeInteger,
   validateOptionalPercentage,
+  validateProtocolV2FilesystemPath,
 } from './helpers/filesystemValidation';
 import { hexToBytes, isHexString, stripHexPrefix } from './helpers/hexUtils';
 import { DataManager } from '../data-manager';
@@ -27,7 +27,7 @@ const MIN_FILE_READ_CHUNK_SIZE = 64;
 function getProtocolV2FileReadChunkLimit() {
   const env = DataManager.getSettings('env');
   if (env && DataManager.isBleConnect(env)) {
-    return PROTOCOL_V2_BLE_FILE_CHUNK_SIZE;
+    return PROTOCOL_V2_BLE_FILE_READ_CHUNK_SIZE;
   }
   return PROTOCOL_V2_WEBUSB_FILE_CHUNK_SIZE;
 }
@@ -69,7 +69,11 @@ function toUint8Array(value: unknown): Uint8Array {
   return new Uint8Array(0);
 }
 
-function getDeviceTransferProgress(bytesBeforeChunk: number, bytesAfterChunk: number, totalBytes: number) {
+function getDeviceTransferProgress(
+  bytesBeforeChunk: number,
+  bytesAfterChunk: number,
+  totalBytes: number
+) {
   if (!Number.isFinite(totalBytes) || totalBytes <= 0) {
     return 100;
   }
@@ -83,12 +87,15 @@ function getDeviceTransferProgress(bytesBeforeChunk: number, bytesAfterChunk: nu
 }
 
 export default class FileRead extends BaseMethod<FileReadParams> {
+  getSupportedProtocols() {
+    return ['V2'] as const;
+  }
+
   init() {
-    // Protocol V2 (Pro2) 专属方法，core 调度层统一做非 V2 设备守卫
-    this.requireProtocolV2 = true;
+    // Protocol V2 (Pro2) only; Core rejects non-V2 devices.
     this.skipForceUpdateCheck = true;
     this.useDevicePassphraseState = false;
-    const path = validateNonEmptyString(this.payload.path, 'path');
+    const path = validateProtocolV2FilesystemPath(this.payload.path, 'path');
     this.params = {
       path,
       offset: validateNonNegativeInteger(this.payload.offset, 'offset', 0),
@@ -136,8 +143,7 @@ export default class FileRead extends BaseMethod<FileReadParams> {
       const readLen = Math.min(chunkSize, totalLength - read);
       const offset = startOffset + read;
       const progress =
-        this.params.uiPercentage ??
-        getDeviceTransferProgress(read, read + readLen, totalLength);
+        this.params.uiPercentage ?? getDeviceTransferProgress(read, read + readLen, totalLength);
       const res = await this.device.commands.typedCall('FilesystemFileRead', 'FilesystemFile', {
         file: {
           path: this.params.path,