@onekeyfe/hd-core 1.2.0-alpha.30 → 1.2.0-alpha.32

package/src/api/CheckAllFirmwareRelease.ts

@@ -1,34 +1,295 @@
-import { HardwareError } from '@onekeyfe/hd-shared';
+import { EFirmwareType, ERRORS, HardwareErrorCode } from '@onekeyfe/hd-shared';
+import semver from 'semver';
 
-import { BaseMethod } from './BaseMethod';
 import { UI_REQUEST } from '../constants/ui-request';
+import { DataManager } from '../data-manager';
 import {
   getBleFirmwareReleaseInfo,
   getBootloaderReleaseInfo,
   getFirmwareReleaseInfo,
 } from './firmware/releaseHelper';
-import {
-  buildFirmwareUpdatePlan,
-  validateFirmwareUpdatePlanForceTargets,
-} from './firmware/FirmwareUpdatePlan';
 import { getBridgeReleaseInfo } from '../utils/bridgeUpdate';
-import {
-  LoggerNames,
-  getDeviceFirmwareVersion,
-  getDeviceType,
-  getFirmwareType,
-  getLogger,
-} from '../utils';
+import { getDeviceFirmwareVersion, getDeviceType, getFirmwareType } from '../utils';
+import { httpRequest } from '../utils/networkUtils';
+import { BaseMethod } from './BaseMethod';
 
 import type {
   AllFirmwareRelease,
   CheckAllFirmwareReleaseParams,
+  ProtocolV2FirmwareComponentRelease,
+  ProtocolV2FirmwareReleaseStatus,
 } from '../types/api/checkAllFirmwareRelease';
-import type { FirmwareUpdatePlan } from '../types/api/firmwareUpdatePlan';
+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',
+};
+
+const PROTOCOL_V2_PACKAGE_METADATA_END = 0x27f;
+const PROTOCOL_V2_PACKAGE_PAYLOAD_HASH_OFFSET = 0x200;
+const PROTOCOL_V2_PACKAGE_PAYLOAD_HASH_SIZE = 64;
+
+function bytesToHex(bytes: Uint8Array): string {
+  return Array.from(bytes)
+    .map(byte => byte.toString(16).padStart(2, '0'))
+    .join('');
+}
+
+function normalizeHex(value: string | undefined): string | undefined {
+  const normalized = value?.replace(/^0x/i, '').toLowerCase();
+  return normalized && /^[0-9a-f]+$/.test(normalized) ? normalized : undefined;
+}
+
+async function getRemoteComponentPayloadHash(url: string): Promise<string | null> {
+  try {
+    const binary = await httpRequest<ArrayBuffer>(url, 'binary', {
+      headers: { Range: `bytes=0-${PROTOCOL_V2_PACKAGE_METADATA_END}` },
+      connectTimeoutMs: 5000,
+      readTimeoutMs: 5000,
+      overallTimeoutMs: 10000,
+      maxRetries: 1,
+      retryDelayMs: 250,
+    });
+    const bytes = new Uint8Array(binary);
+    if (
+      bytes.byteLength <= PROTOCOL_V2_PACKAGE_METADATA_END ||
+      String.fromCharCode(...bytes.slice(0, 4)) !== 'OKPP'
+    ) {
+      return null;
+    }
+    return bytesToHex(
+      bytes.slice(
+        PROTOCOL_V2_PACKAGE_PAYLOAD_HASH_OFFSET,
+        PROTOCOL_V2_PACKAGE_PAYLOAD_HASH_OFFSET + PROTOCOL_V2_PACKAGE_PAYLOAD_HASH_SIZE
+      )
+    );
+  } catch {
+    return null;
+  }
+}
+
+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 if (remotePayloadHash !== undefined) {
+      const currentHashKey = CURRENT_HASH_BY_COMPONENT_TARGET[componentTarget];
+      const currentHash = normalizeHex(
+        currentHashKey ? currentVerification[currentHashKey] : undefined
+      );
+      const expectedHash = normalizeHex(remotePayloadHash ?? undefined);
+      if (currentHash && expectedHash) {
+        status = expectedHash.startsWith(currentHash) ? 'valid' : 'outdated';
+      } else {
+        status = 'unknown';
+      }
+    } else {
+      status = 'valid';
+    }
+  }
+
+  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,
+    };
+  }
 
-const Log = getLogger(LoggerNames.Method);
+  let components = getOrderedComponentEntries(release).map(([configKey, component]) =>
+    buildComponentRelease({
+      configKey,
+      component,
+      currentVersions,
+      currentVerification,
+      remotePayloadHash: Object.prototype.hasOwnProperty.call(remotePayloadHashes, configKey)
+        ? remotePayloadHashes[configKey]
+        : undefined,
+      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;
@@ -36,14 +297,13 @@ export default class CheckAllFirmwareRelease extends BaseMethod {
   }
 
   async run() {
+    if (this.device.isProtocolV2()) {
+      return this.runProtocolV2();
+    }
+
     const { features } = this.device;
-    const {
-      checkBridgeRelease,
-      firmwareType: firmwareTypeParams,
-      platform,
-      forceUpdateTargets,
-    } = this.payload as CheckAllFirmwareReleaseParams;
-    const validatedForceUpdateTargets = validateFirmwareUpdatePlanForceTargets(forceUpdateTargets);
+    const { checkBridgeRelease, firmwareType: firmwareTypeParams } = this
+      .payload as CheckAllFirmwareReleaseParams;
 
     if (!features) {
       return Promise.resolve(null);
@@ -74,32 +334,6 @@ export default class CheckAllFirmwareRelease extends BaseMethod {
       firmwareType,
     });
     const bleFirmwareReleaseInfo = getBleFirmwareReleaseInfo(features);
-    let firmwareUpdatePlan: FirmwareUpdatePlan | undefined;
-    try {
-      firmwareUpdatePlan = buildFirmwareUpdatePlan({
-        features,
-        firmwareType,
-        platform: platform ?? 'web',
-        firmware: firmwareRelease,
-        ble: bleFirmwareReleaseInfo,
-        bootloader: bootloaderRelease,
-        forceUpdateTargets: validatedForceUpdateTargets,
-      });
-    } catch (error) {
-      if (
-        validatedForceUpdateTargets.length > 0 ||
-        !(error instanceof HardwareError) ||
-        error.params?.firmwareUpdateCode !== 'FirmwarePlanInvalid'
-      ) {
-        throw error;
-      }
-      // A Plan is an optional external-host capability. Release checks remain
-      // available for legacy and recovery flows when a Plan cannot be built.
-      Log.warn(
-        '[CheckAllFirmwareRelease] Optional firmware Plan is unavailable; using the legacy release result'
-      );
-      firmwareUpdatePlan = undefined;
-    }
 
     return {
       firmware: firmwareRelease,
@@ -114,7 +348,91 @@ export default class CheckAllFirmwareRelease extends BaseMethod {
           }
         : undefined,
       features,
-      firmwareUpdatePlan,
-    } as unknown as AllFirmwareRelease;
+    } 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 remotePayloadHashes: Record<string, string | null> = {};
+    if (release) {
+      await Promise.all(
+        getOrderedComponentEntries(release).map(async ([configKey, component]) => {
+          const componentTarget =
+            component.target.toUpperCase() as IProtocolV2FirmwareComponentTarget;
+          if (!CURRENT_HASH_BY_COMPONENT_TARGET[componentTarget]) return;
+          const currentVersionKey = CURRENT_VERSION_BY_COMPONENT_TARGET[componentTarget];
+          const currentVersion = currentVersionKey
+            ? state.versions[currentVersionKey] ??
+              (componentTarget === 'APPLICATION_P1' ? state.versions.firmware : null)
+            : null;
+          const targetVersion = toVersionString(component.version);
+          if (
+            currentVersion &&
+            targetVersion &&
+            semver.valid(currentVersion) &&
+            semver.valid(targetVersion) &&
+            semver.eq(currentVersion, targetVersion)
+          ) {
+            const configuredPayloadHash = normalizeHex(component.payloadHash);
+            if (configuredPayloadHash) {
+              remotePayloadHashes[configKey] = configuredPayloadHash;
+            } else if (component.fingerprint && component.url) {
+              remotePayloadHashes[configKey] = await getRemoteComponentPayloadHash(component.url);
+            }
+          }
+        })
+      );
+    }
+    const plan = buildProtocolV2FirmwareRelease({
+      currentVersions: state.versions,
+      currentVerification: state.verification,
+      remotePayloadHashes,
+      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,
+    };
   }
 }