@onekeyfe/hd-core 1.1.26 → 1.1.27-alpha.30

package/src/api/FileRead.ts

@@ -0,0 +1,158 @@
+import {
+  PROTOCOL_V2_BLE_FILE_CHUNK_SIZE,
+  PROTOCOL_V2_WEBUSB_FILE_CHUNK_SIZE,
+} from '@onekeyfe/hd-transport';
+import { ERRORS, HardwareErrorCode } from '@onekeyfe/hd-shared';
+
+import { BaseMethod } from './BaseMethod';
+import { hexToBytes, isHexString, stripHexPrefix } from './helpers/hexUtils';
+import { DataManager } from '../data-manager';
+
+export type FileReadParams = {
+  path: string;
+  offset?: number;
+  totalSize?: number;
+  chunkLen?: number;
+  uiPercentage?: number;
+};
+
+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_WEBUSB_FILE_CHUNK_SIZE;
+}
+
+function normalizeChunkSize(value: unknown, maxChunkSize: number): number {
+  const numeric = Number(value);
+  if (!Number.isFinite(numeric) || numeric <= 0) return maxChunkSize;
+  return Math.min(Math.max(Math.floor(numeric), MIN_FILE_READ_CHUNK_SIZE), maxChunkSize);
+}
+
+function toFiniteNumber(value: unknown): number | undefined {
+  if (typeof value === 'number' && Number.isFinite(value)) return value;
+  if (typeof value === 'string') {
+    const numeric = Number(value);
+    return Number.isFinite(numeric) ? numeric : undefined;
+  }
+  if (value && typeof value === 'object') {
+    const longLike = value as { toNumber?: () => number };
+    if (typeof longLike.toNumber === 'function') {
+      const numeric = longLike.toNumber();
+      return Number.isFinite(numeric) ? numeric : undefined;
+    }
+  }
+  return undefined;
+}
+
+function toUint8Array(value: unknown): Uint8Array {
+  if (value instanceof Uint8Array) return value;
+  if (value instanceof ArrayBuffer) return new Uint8Array(value);
+  if (ArrayBuffer.isView(value)) {
+    return new Uint8Array(value.buffer, value.byteOffset, value.byteLength);
+  }
+  if (typeof value === 'string') {
+    const hex = stripHexPrefix(value);
+    if (!hex) return new Uint8Array(0);
+    if (!isHexString(hex) || hex.length % 2 !== 0) return new Uint8Array(0);
+    return hexToBytes(hex);
+  }
+  return new Uint8Array(0);
+}
+
+export default class FileRead extends BaseMethod<FileReadParams> {
+  init() {
+    this.skipForceUpdateCheck = true;
+    this.useDevicePassphraseState = false;
+    this.params = {
+      path: this.payload.path,
+      offset: this.payload.offset ?? 0,
+      totalSize: this.payload.totalSize ?? 0,
+      chunkLen: this.payload.chunkLen,
+      uiPercentage: this.payload.uiPercentage,
+    };
+  }
+
+  async run() {
+    const startOffset = this.params.offset ?? 0;
+    const requestedLength = Number(this.params.totalSize);
+    const chunkSize = normalizeChunkSize(this.params.chunkLen, getProtocolV2FileReadChunkLimit());
+    let totalLength = Number.isFinite(requestedLength) && requestedLength > 0 ? requestedLength : 0;
+
+    if (totalLength === 0) {
+      const pathInfoRes = await this.device.commands.typedCall(
+        'FilesystemPathInfoQuery',
+        'FilesystemPathInfo',
+        {
+          path: this.params.path,
+        }
+      );
+      const fileSize = toFiniteNumber(pathInfoRes.message?.size);
+      if (!pathInfoRes.message?.exist || pathInfoRes.message?.directory) {
+        throw ERRORS.TypedError(
+          HardwareErrorCode.RuntimeError,
+          `FilesystemFileRead path is not a file: ${this.params.path}`
+        );
+      }
+      if (fileSize === undefined || fileSize < startOffset) {
+        throw ERRORS.TypedError(
+          HardwareErrorCode.RuntimeError,
+          `FilesystemFileRead invalid offset ${startOffset} for ${this.params.path}`
+        );
+      }
+      totalLength = fileSize - startOffset;
+    }
+
+    const chunks: Uint8Array[] = [];
+    let read = 0;
+    let lastMessage: Record<string, unknown> | undefined;
+
+    while (read < totalLength) {
+      const readLen = Math.min(chunkSize, totalLength - read);
+      const offset = startOffset + read;
+      const progress =
+        this.params.uiPercentage ??
+        Math.min(Math.ceil(((read + readLen) / Math.max(totalLength, 1)) * 100), 99);
+      const res = await this.device.commands.typedCall('FilesystemFileRead', 'FilesystemFile', {
+        file: {
+          path: this.params.path,
+          offset,
+          total_size: 0,
+        },
+        chunk_len: readLen,
+        ui_percentage: progress,
+      });
+      const data = toUint8Array(res.message?.data);
+      lastMessage = res.message;
+
+      if (data.byteLength === 0) {
+        throw ERRORS.TypedError(
+          HardwareErrorCode.RuntimeError,
+          `FilesystemFileRead received empty data at offset ${offset}`
+        );
+      }
+
+      chunks.push(data);
+      read += data.byteLength;
+    }
+
+    const combined = new Uint8Array(read);
+    let cursor = 0;
+    chunks.forEach(chunk => {
+      combined.set(chunk, cursor);
+      cursor += chunk.byteLength;
+    });
+
+    return Promise.resolve({
+      ...lastMessage,
+      path: this.params.path,
+      offset: startOffset,
+      total_size: totalLength,
+      data: combined,
+      chunks: chunks.length,
+    });
+  }
+}

package/src/api/FileWrite.ts

@@ -0,0 +1,191 @@
+import {
+  PROTOCOL_V2_BLE_FILE_CHUNK_SIZE,
+  PROTOCOL_V2_WEBUSB_FILE_CHUNK_SIZE,
+} from '@onekeyfe/hd-transport';
+import { ERRORS, HardwareErrorCode } from '@onekeyfe/hd-shared';
+
+import { BaseMethod } from './BaseMethod';
+import { UI_REQUEST, createUiMessage } from '../events/ui-request';
+import { DataManager } from '../data-manager';
+
+export type FileWriteParams = {
+  path: string;
+  offset?: number;
+  totalSize?: number;
+  data: ArrayBuffer | Uint8Array | Blob | string;
+  chunkSize?: number;
+  chunkLen?: number;
+  overwrite?: boolean;
+  append?: boolean;
+  uiPercentage?: number;
+};
+
+const MIN_FILE_CHUNK_SIZE = 64;
+
+function getProtocolV2FileChunkLimit() {
+  const env = DataManager.getSettings('env');
+  if (env && DataManager.isBleConnect(env)) {
+    return PROTOCOL_V2_BLE_FILE_CHUNK_SIZE;
+  }
+  return PROTOCOL_V2_WEBUSB_FILE_CHUNK_SIZE;
+}
+
+async function dataToUint8Array(data: FileWriteParams['data'] | Blob): Promise<Uint8Array> {
+  if (typeof data === 'string') {
+    return new TextEncoder().encode(data);
+  }
+
+  if (data instanceof ArrayBuffer) {
+    return new Uint8Array(data);
+  }
+
+  if (ArrayBuffer.isView(data)) {
+    return new Uint8Array(data.buffer, data.byteOffset, data.byteLength);
+  }
+
+  if (typeof Blob !== 'undefined' && data instanceof Blob) {
+    return new Uint8Array(await data.arrayBuffer());
+  }
+
+  throw ERRORS.TypedError(HardwareErrorCode.RuntimeError, 'Unsupported FilesystemFileWrite data');
+}
+
+function normalizeChunkSize(value: unknown, maxChunkSize: number): number {
+  const numeric = Number(value);
+  if (!Number.isFinite(numeric) || numeric <= 0) return maxChunkSize;
+  return Math.min(Math.max(Math.floor(numeric), MIN_FILE_CHUNK_SIZE), maxChunkSize);
+}
+
+function getConfirmedProgress(
+  processedByte: number,
+  totalSize: number,
+  written: number,
+  dataLength: number
+) {
+  if (Number.isFinite(processedByte) && Number.isFinite(totalSize) && totalSize > 0) {
+    if (processedByte >= totalSize) return 100;
+    return Math.min(Math.max(Math.floor((processedByte / totalSize) * 100), 0), 99);
+  }
+  if (dataLength > 0) {
+    if (written >= dataLength) return 100;
+    return Math.min(Math.max(Math.floor((written / dataLength) * 100), 0), 99);
+  }
+  return 100;
+}
+
+export default class FileWrite extends BaseMethod<FileWriteParams> {
+  init() {
+    this.skipForceUpdateCheck = true;
+    this.useDevicePassphraseState = false;
+    const offset = this.payload.offset ?? 0;
+    this.params = {
+      path: this.payload.path,
+      offset,
+      totalSize: this.payload.totalSize ?? 0,
+      data: this.payload.data,
+      chunkSize: this.payload.chunkSize,
+      chunkLen: this.payload.chunkLen,
+      overwrite: this.payload.overwrite ?? offset === 0,
+      append: this.payload.append ?? false,
+      uiPercentage: this.payload.uiPercentage,
+    };
+  }
+
+  async run() {
+    const data = await dataToUint8Array(this.params.data);
+    const dataLength = data.byteLength;
+    const offsetValue = Number(this.params.offset ?? 0);
+    const startOffset = Number.isFinite(offsetValue) && offsetValue > 0 ? offsetValue : 0;
+    const payloadTotalSize = Number(this.params.totalSize);
+    const totalSize =
+      Number.isFinite(payloadTotalSize) && payloadTotalSize > 0
+        ? payloadTotalSize
+        : startOffset + dataLength;
+
+    if (totalSize < startOffset + dataLength) {
+      throw ERRORS.TypedError(
+        HardwareErrorCode.RuntimeError,
+        `FilesystemFileWrite totalSize ${totalSize} is smaller than offset + data length ${
+          startOffset + dataLength
+        }`
+      );
+    }
+
+    const chunkSize = normalizeChunkSize(
+      this.params.chunkSize ?? this.params.chunkLen,
+      getProtocolV2FileChunkLimit()
+    );
+    const overwrite = this.params.overwrite ?? false;
+    const append = this.params.append ?? false;
+    let written = 0;
+    let chunkIndex = 0;
+    let lastMessage: Record<string, unknown> | undefined;
+    const startTime = Date.now();
+
+    while (written < dataLength) {
+      const chunkEnd = Math.min(written + chunkSize, dataLength);
+      const chunk = data.slice(written, chunkEnd);
+      const offset = startOffset + written;
+      const isFirstChunk = chunkIndex === 0;
+      const progress =
+        this.params.uiPercentage ??
+        Math.min(Math.ceil(((written + chunk.byteLength) / dataLength) * 100), 99);
+
+      const res = await this.device.commands.typedCall('FilesystemFileWrite', 'FilesystemFile', {
+        file: {
+          path: this.params.path,
+          offset,
+          total_size: totalSize,
+          data: chunk,
+        },
+        overwrite: isFirstChunk ? overwrite : false,
+        append,
+        ui_percentage: progress,
+      });
+
+      lastMessage = res.message;
+      const processedByte = Number(res.message?.processed_byte);
+      if (Number.isFinite(processedByte) && processedByte > offset) {
+        written = processedByte - startOffset;
+      } else {
+        written += chunk.byteLength;
+      }
+
+      if (written > dataLength) {
+        throw ERRORS.TypedError(
+          HardwareErrorCode.RuntimeError,
+          `FilesystemFileWrite invalid processed_byte ${processedByte}`
+        );
+      }
+
+      const confirmedProcessedByte =
+        Number.isFinite(processedByte) && processedByte > offset
+          ? processedByte
+          : startOffset + written;
+      if (typeof this.postMessage === 'function') {
+        const elapsedMs = Date.now() - startTime;
+        const transferredBytes = Math.min(written, dataLength);
+        this.postMessage(
+          createUiMessage(UI_REQUEST.DEVICE_PROGRESS, {
+            progress: getConfirmedProgress(confirmedProcessedByte, totalSize, written, dataLength),
+            transferredBytes,
+            totalBytes: dataLength,
+            rateBytesPerSecond:
+              elapsedMs > 0 ? Math.round((transferredBytes / elapsedMs) * 1000) : undefined,
+            elapsedMs,
+          })
+        );
+      }
+      chunkIndex += 1;
+    }
+
+    return Promise.resolve({
+      ...lastMessage,
+      path: this.params.path,
+      offset: startOffset,
+      total_size: totalSize,
+      processed_byte: startOffset + written,
+      chunks: chunkIndex,
+    });
+  }
+}

package/src/api/FirmwareUpdateV3.ts

@@ -79,6 +79,20 @@ export default class FirmwareUpdateV3 extends FirmwareUpdateBaseMethod<FirmwareU
   }
 
   async run() {
+    if (this.device.originalDescriptor?.protocolType === 'V2') {
+      throw ERRORS.TypedError(
+        HardwareErrorCode.RuntimeError,
+        'Protocol V2 firmware update must use firmwareUpdateV4'
+      );
+    }
+    Log.debug('FirmwareUpdateV3 strategy: Protocol V1');
+    return this.runProtocolV1();
+  }
+
+  /**
+   * Protocol V1 firmware update strategy for existing Pro devices.
+   */
+  private async runProtocolV1() {
     const { device } = this;
     const { features } = device;
 
@@ -251,6 +265,8 @@ export default class FirmwareUpdateV3 extends FirmwareUpdateBaseMethod<FirmwareU
     }
 
     this.postTipMessage(FirmwareUpdateTipMessage.StartTransferData);
+    const transferStartTime = Date.now();
+
     // Process resource zip contents
     if (resourceBinary) {
       const file = await JSZip.loadAsync(resourceBinary);
@@ -264,6 +280,7 @@ export default class FirmwareUpdateV3 extends FirmwareUpdateBaseMethod<FirmwareU
             filePath: `0:res/${name}`,
             processedSize,
             totalSize,
+            transferStartTime,
           });
         }
       }
@@ -275,6 +292,7 @@ export default class FirmwareUpdateV3 extends FirmwareUpdateBaseMethod<FirmwareU
         filePath: `0:boot/bootloader.bin`,
         processedSize,
         totalSize,
+        transferStartTime,
       });
     }
 
@@ -287,16 +305,15 @@ export default class FirmwareUpdateV3 extends FirmwareUpdateBaseMethod<FirmwareU
           filePath: `0:updates/${fwbinary.fileName}`,
           processedSize,
           totalSize,
+          transferStartTime,
         });
       }
     }
 
-    // trigger firmware update, support folder updates
+    // trigger firmware update
     try {
       this.postTipMessage(FirmwareUpdateTipMessage.ConfirmOnDevice);
-      await this.startEmmcFirmwareUpdate({
-        path: '0:updates',
-      });
+      await this.startEmmcFirmwareUpdate({ path: '0:updates' });
     } catch (error) {
       Log.error('triggerFirmwareUpdateEmmc error: ', error);
       // Re-throw errors with specific error codes that should not be ignored