@onekeyfe/hd-core 1.2.0-alpha.107 → 1.2.0-alpha.109

package/src/api/UploadPortfolio.ts

@@ -1,21 +1,28 @@
 import { createDeviceNotSupportMethodError } from '@onekeyfe/hd-shared';
 
 import { supportsProtocolV2Message } from '../protocols/protocol-v2/features';
+import { decodeCanonicalBase64 } from './helpers/base64Data';
 import FileWrite from './FileWrite';
 
 export type UploadPortfolioParams = {
-  packageBytes: ArrayBuffer | Uint8Array | Blob;
+  packageBase64: string;
   timeoutMs?: number | string;
 };
 
 const PORTFOLIO_PENDING_PATH = 'vol1:/portfolio/portfolio.okpkg.pending';
 const PORTFOLIO_CHUNK_SIZE = 2048;
+const PORTFOLIO_PACKAGE_MAX_BYTES = 128 * 1024;
 const FILESYSTEM_FILE_WRITE_MESSAGE_TYPE = 60805;
 const PORTFOLIO_UPDATE_MESSAGE_TYPE = 61400;
 
 export default class UploadPortfolio extends FileWrite {
   init() {
-    const { packageBytes, timeoutMs } = this.payload as UploadPortfolioParams;
+    const { packageBase64, timeoutMs } = this.payload as UploadPortfolioParams;
+    const packageBytes = decodeCanonicalBase64({
+      value: packageBase64,
+      parameterName: 'packageBase64',
+      maxBytes: PORTFOLIO_PACKAGE_MAX_BYTES,
+    });
     this.payload = {
       ...this.payload,
       path: PORTFOLIO_PENDING_PATH,

package/src/api/helpers/base64Data.ts

@@ -0,0 +1,85 @@
+import { Buffer } from 'buffer';
+import { decode as decodeJpeg } from 'jpeg-js';
+
+import { invalidParameter } from './filesystemValidation';
+
+const BASE64_PATTERN = /^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$/;
+const JPEG_CONTAINER_OVERHEAD_BYTES = 64 * 1024;
+const JPEG_MAX_MEMORY_USAGE_IN_MB = 32;
+const JPEG_MAX_RESOLUTION_IN_MP = 1;
+
+export function decodeCanonicalBase64({
+  value,
+  parameterName,
+  maxBytes,
+}: {
+  value: unknown;
+  parameterName: string;
+  maxBytes: number;
+}): Uint8Array {
+  if (typeof value !== 'string' || value.length === 0) {
+    throw invalidParameter(`Parameter [${parameterName}] must be a non-empty Base64 string.`);
+  }
+  if (value.length > Math.ceil(maxBytes / 3) * 4) {
+    throw invalidParameter(`Parameter [${parameterName}] exceeds the maximum supported size.`);
+  }
+  if (value.length % 4 !== 0 || !BASE64_PATTERN.test(value)) {
+    throw invalidParameter(`Parameter [${parameterName}] must use canonical Base64 encoding.`);
+  }
+
+  const decoded = Buffer.from(value, 'base64');
+  if (decoded.byteLength === 0 || decoded.byteLength > maxBytes) {
+    throw invalidParameter(`Parameter [${parameterName}] exceeds the maximum supported size.`);
+  }
+  if (decoded.toString('base64') !== value) {
+    throw invalidParameter(`Parameter [${parameterName}] must use canonical Base64 encoding.`);
+  }
+  return Uint8Array.from(decoded);
+}
+
+export function decodeJpegBase64ToRgba({
+  jpegBase64,
+  parameterName,
+  expectedWidth,
+  expectedHeight,
+}: {
+  jpegBase64: unknown;
+  parameterName: string;
+  expectedWidth: number;
+  expectedHeight: number;
+}): { width: number; height: number; data: Uint8Array } {
+  const jpegBytes = decodeCanonicalBase64({
+    value: jpegBase64,
+    parameterName,
+    maxBytes: expectedWidth * expectedHeight * 8 + JPEG_CONTAINER_OVERHEAD_BYTES,
+  });
+  if (jpegBytes[0] !== 0xff || jpegBytes[1] !== 0xd8) {
+    throw invalidParameter(`Parameter [${parameterName}] must contain a JPEG image.`);
+  }
+
+  let decoded: { width: number; height: number; data: Uint8Array };
+  try {
+    decoded = decodeJpeg(jpegBytes, {
+      useTArray: true,
+      formatAsRGBA: true,
+      tolerantDecoding: false,
+      maxResolutionInMP: JPEG_MAX_RESOLUTION_IN_MP,
+      maxMemoryUsageInMB: JPEG_MAX_MEMORY_USAGE_IN_MB,
+    });
+  } catch {
+    throw invalidParameter(`Parameter [${parameterName}] must contain a valid JPEG image.`);
+  }
+
+  if (decoded.width !== expectedWidth || decoded.height !== expectedHeight) {
+    throw invalidParameter(
+      `Parameter [${parameterName}] must contain a ${expectedWidth}x${expectedHeight} JPEG image.`
+    );
+  }
+  const expectedLength = expectedWidth * expectedHeight * 4;
+  if (decoded.data.byteLength !== expectedLength) {
+    throw invalidParameter(
+      `Decoded parameter [${parameterName}] must contain ${expectedLength} RGBA bytes.`
+    );
+  }
+  return decoded;
+}

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

@@ -25,7 +25,7 @@ export default class DeviceFactoryInfoSet extends BaseMethod<DeviceFactoryInfoSe
       info: {
         version: this.params.version,
         serial_number: this.params.serial_number,
-        burn_in_completed: this.params.burn_in_completed,
+        factory_burn_in_completed: this.params.burn_in_completed,
         factory_test_completed: this.params.factory_test_completed,
         manufacture_time: this.params.manufacture_time,
       },

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

@@ -5,7 +5,7 @@ import { invalidParameter } from '../helpers/filesystemValidation';
 
 export type DeviceInfoGetTargets = {
   hw?: boolean;
-  fw?: boolean;
+  main_mcu?: boolean;
   coprocessor?: boolean;
   se1?: boolean;
   se2?: boolean;
@@ -27,7 +27,7 @@ export type DeviceInfoGetParams = {
 
 const TARGET_KEYS: (keyof DeviceInfoGetTargets)[] = [
   'hw',
-  'fw',
+  'main_mcu',
   'coprocessor',
   'se1',
   'se2',
@@ -39,7 +39,7 @@ const TYPE_KEYS: (keyof DeviceInfoGetTypes)[] = ['version', 'build_id', 'hash',
 
 const DEFAULT_TARGETS: DeviceInfoGetTargets = {
   hw: true,
-  fw: true,
+  main_mcu: true,
   coprocessor: true,
 };
 

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

@@ -7,21 +7,26 @@ import {
   PRO2_NFT_DEFAULT_PACE_MS,
   PRO2_NFT_DEFAULT_TIMEOUT_MS,
   PRO2_NFT_DIRECTORY,
+  PRO2_NFT_IMAGE_HEIGHT,
+  PRO2_NFT_IMAGE_WIDTH,
   PRO2_NFT_MAX_CHUNK_SIZE,
   PRO2_NFT_MAX_ITEMS,
   PRO2_NFT_MIN_CHUNK_SIZE,
+  PRO2_NFT_THUMBNAIL_HEIGHT,
+  PRO2_NFT_THUMBNAIL_WIDTH,
   type Pro2NftBundle,
-  type Pro2NftImage,
-  buildPro2NftBundle,
+  buildPro2NftBundleFromEncodedImages,
   getCompletePro2NftBasenames,
 } from '../../utils/pro2Nft';
+import { encodePro2Image } from '../../utils/pro2Wallpaper';
 import { BaseMethod } from '../BaseMethod';
+import { decodeJpegBase64ToRgba } from '../helpers/base64Data';
 import { invalidParameter } from '../helpers/filesystemValidation';
 import { writeProtocolV2File } from '../helpers/protocolV2FileWrite';
 
 export type DeviceUploadNftParams = {
-  image: Pro2NftImage;
-  thumbnail: Pro2NftImage;
+  imageJpegBase64: string;
+  thumbnailJpegBase64: string;
   title: string;
   subtitle: string;
   timestampMs?: number;
@@ -54,8 +59,8 @@ export default class DeviceUploadNft extends BaseMethod<DeviceUploadNftParams> {
 
   init() {
     const {
-      image,
-      thumbnail,
+      imageJpegBase64,
+      thumbnailJpegBase64,
       title,
       subtitle,
       timestampMs = Date.now(),
@@ -79,8 +84,51 @@ export default class DeviceUploadNft extends BaseMethod<DeviceUploadNftParams> {
       throw invalidParameter('Parameter [timeoutMs] must be a positive integer.');
     }
 
-    this.bundle = buildPro2NftBundle({ image, thumbnail, title, subtitle, timestampMs });
-    this.params = { image, thumbnail, title, subtitle, timestampMs, chunkSize, paceMs, timeoutMs };
+    const encodedImage = (() => {
+      const decoded = decodeJpegBase64ToRgba({
+        jpegBase64: imageJpegBase64,
+        parameterName: 'imageJpegBase64',
+        expectedWidth: PRO2_NFT_IMAGE_WIDTH,
+        expectedHeight: PRO2_NFT_IMAGE_HEIGHT,
+      });
+      return encodePro2Image({
+        width: PRO2_NFT_IMAGE_WIDTH,
+        height: PRO2_NFT_IMAGE_HEIGHT,
+        rgba: decoded.data,
+        alphaMode: 'black-background',
+      }).data;
+    })();
+    const encodedThumbnail = (() => {
+      const decoded = decodeJpegBase64ToRgba({
+        jpegBase64: thumbnailJpegBase64,
+        parameterName: 'thumbnailJpegBase64',
+        expectedWidth: PRO2_NFT_THUMBNAIL_WIDTH,
+        expectedHeight: PRO2_NFT_THUMBNAIL_HEIGHT,
+      });
+      return encodePro2Image({
+        width: PRO2_NFT_THUMBNAIL_WIDTH,
+        height: PRO2_NFT_THUMBNAIL_HEIGHT,
+        rgba: decoded.data,
+        alphaMode: 'black-background',
+      }).data;
+    })();
+    this.bundle = buildPro2NftBundleFromEncodedImages({
+      image: encodedImage,
+      thumbnail: encodedThumbnail,
+      title,
+      subtitle,
+      timestampMs,
+    });
+    this.params = {
+      imageJpegBase64,
+      thumbnailJpegBase64,
+      title,
+      subtitle,
+      timestampMs,
+      chunkSize,
+      paceMs,
+      timeoutMs,
+    };
     this.unlockPolicy = 'none';
     this.skipForceUpdateCheck = true;
     this.useDevicePassphraseState = false;

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

@@ -1,10 +1,13 @@
 import { blake2s } from '@noble/hashes/blake2s';
 import { bytesToHex } from '@noble/hashes/utils';
+import { createDeviceNotSupportMethodError } from '@onekeyfe/hd-shared';
 
 import { BaseMethod } from '../BaseMethod';
+import { decodeJpegBase64ToRgba } from '../helpers/base64Data';
 import { invalidParameter } from '../helpers/filesystemValidation';
 import { writeProtocolV2File } from '../helpers/protocolV2FileWrite';
 import { UI_REQUEST, createUiMessage } from '../../events/ui-request';
+import { supportsProtocolV2Message } from '../../protocols/protocol-v2/features';
 import {
   PRO2_WALLPAPER_HEIGHT,
   PRO2_WALLPAPER_WIDTH,
@@ -13,9 +16,7 @@ import {
 } from '../../utils/pro2Wallpaper';
 
 export type DeviceUploadWallpaperParams = {
-  width: number;
-  height: number;
-  rgba: Uint8Array | ArrayBuffer;
+  jpegBase64: string;
   fileName?: string;
   chunkSize?: number;
 };
@@ -29,6 +30,9 @@ export type DeviceUploadWallpaperResponse = {
 
 const WALLPAPER_DIRECTORY = 'vol1:/wallpapers';
 const SAFE_FILE_NAME = /^[A-Za-z0-9_-]+(?:\.bin)?$/;
+const DEVICE_SETTINGS_SET_MESSAGE_TYPE = 60412;
+const FILESYSTEM_FILE_WRITE_MESSAGE_TYPE = 60805;
+const FILESYSTEM_DIR_MAKE_MESSAGE_TYPE = 60809;
 
 function normalizeFileName(fileName: string | undefined, data: Uint8Array): string {
   if (fileName !== undefined && (!fileName || !SAFE_FILE_NAME.test(fileName))) {
@@ -54,31 +58,45 @@ export default class DeviceUploadWallpaper extends BaseMethod<DeviceUploadWallpa
   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.');
-    }
+    const { jpegBase64, fileName, chunkSize } = this.payload;
     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 });
+    const decoded = decodeJpegBase64ToRgba({
+      jpegBase64,
+      parameterName: 'jpegBase64',
+      expectedWidth: PRO2_WALLPAPER_WIDTH,
+      expectedHeight: PRO2_WALLPAPER_HEIGHT,
+    });
+    this.encoded = encodePro2Wallpaper({
+      width: PRO2_WALLPAPER_WIDTH,
+      height: PRO2_WALLPAPER_HEIGHT,
+      rgba: decoded.data,
+    });
     this.path = `${WALLPAPER_DIRECTORY}/${normalizeFileName(fileName, this.encoded.data)}`;
-    this.params = { width, height, rgba: rgbaBytes, fileName, chunkSize };
+    this.params = { jpegBase64, fileName, chunkSize };
     this.unlockPolicy = 'none';
     this.skipForceUpdateCheck = true;
     this.useDevicePassphraseState = false;
   }
 
+  private async assertCapabilities() {
+    const protocolInfo = await this.device.ensureProtocolV2RuntimeContext();
+    const requiredMessageTypes = [
+      DEVICE_SETTINGS_SET_MESSAGE_TYPE,
+      FILESYSTEM_FILE_WRITE_MESSAGE_TYPE,
+      FILESYSTEM_DIR_MAKE_MESSAGE_TYPE,
+    ];
+    if (
+      requiredMessageTypes.some(
+        messageType => !supportsProtocolV2Message(protocolInfo, messageType)
+      )
+    ) {
+      throw createDeviceNotSupportMethodError(this.name, this.device.getCurrentFirmwareType());
+    }
+  }
+
   private async ensureDirectory() {
     if (this.directoryReady) return;
     try {
@@ -119,6 +137,7 @@ export default class DeviceUploadWallpaper extends BaseMethod<DeviceUploadWallpa
   async run(): Promise<DeviceUploadWallpaperResponse> {
     const { encoded } = this;
     if (!encoded) throw invalidParameter('Wallpaper data has not been initialized.');
+    await this.assertCapabilities();
     await this.ensureDirectory();
     await this.upload();
     const response = await this.device.commands.typedCall('DeviceSettingsSet', 'Success', {

package/src/api/ton/TonSignMessage.ts

@@ -174,12 +174,14 @@ export default class TonSignMessage extends BaseMethod<HardwareTonSignMessage> {
     if (!request.init_data_length) {
       const deviceType = this.device.getCurrentDeviceType();
       const hasClassic = DeviceModelToTypes.model_classic1s.includes(deviceType);
-      // use signing_message_repr sign, not exists signning_message, skip validate
-      const hasSigningMessageRepr = request.signning_message == null;
+      const signingMessage = request.signning_message;
+      // Blind signing omits the signing message in both protocol schemas.
+      const shouldSkipValidation = signingMessage == null;
 
       return Promise.resolve({
         ...request,
-        skip_validate: hasClassic || hasSigningMessageRepr,
+        signing_message: signingMessage,
+        skip_validate: hasClassic || shouldSkipValidation,
       });
     }
 

package/src/core/index.ts

@@ -136,6 +136,9 @@ const toError = (error: unknown): Error | undefined => {
   }
 };
 
+const isExpectedCompatibilityError = (error: unknown) =>
+  error instanceof HardwareError && error.errorCode === HardwareErrorCode.DeviceNotSupportMethod;
+
 const updateMethodRequestContext = (method: BaseMethod, updates: any) => {
   if (method.requestContext) {
     updateRequestContext(method.requestContext.responseID, updates);
@@ -693,7 +696,9 @@ const onCallDevice = async (
     try {
       return await task.callPromise.promise;
     } catch (e) {
-      Log.debug('Device Run Error: ', e);
+      if (!isExpectedCompatibilityError(e)) {
+        Log.debug('Device Run Error: ', e);
+      }
       completeMethodRequestContext(method, e);
       return createResponseMessage(method.responseID, false, { error: e });
     }
@@ -1248,7 +1253,6 @@ const cleanup = () => {
     pendingUiPromises,
     ERRORS.TypedError(HardwareErrorCode.ActionCancelled, 'UI request was cancelled')
   );
-  Log.debug('Cleanup...');
 };
 
 const removeDeviceListener = (device: Device) => {

package/src/data/messages/messages-protocol-v2.json

@@ -462,9 +462,10 @@
         "MessageType_FilesystemDirMake": 60809,
         "MessageType_FilesystemDirRemove": 60810,
         "MessageType_FilesystemFormat": 60811,
-        "MessageType_DeviceFirmwareUpdateRequest": 61000,
-        "MessageType_DeviceFirmwareUpdateStatusGet": 61001,
-        "MessageType_DeviceFirmwareUpdateStatus": 61002,
+        "MessageType_DeviceFirmwareUpdateStage": 61000,
+        "MessageType_DeviceFirmwareUpdateRequest": 61001,
+        "MessageType_DeviceFirmwareUpdateStatusGet": 61002,
+        "MessageType_DeviceFirmwareUpdateStatus": 61003,
         "MessageType_DeviceSessionGet": 61200,
         "MessageType_DeviceSession": 61201,
         "MessageType_DeviceSessionAskPin": 61202,
@@ -10924,7 +10925,7 @@
           "type": "bytes",
           "id": 1
         },
-        "signing_message": {
+        "signning_message": {
           "type": "bytes",
           "id": 2
         },
@@ -11813,14 +11814,14 @@
           "type": "string",
           "id": 2
         },
-        "burn_in_completed": {
-          "type": "bool",
-          "id": 3
-        },
         "factory_test_completed": {
           "type": "bool",
           "id": 4
         },
+        "factory_burn_in_completed": {
+          "type": "bool",
+          "id": 3
+        },
         "manufacture_time": {
           "type": "DeviceFactoryInfoManufactureTime",
           "id": 5
@@ -11906,7 +11907,7 @@
         }
       }
     },
-    "DeviceFirmwareUpdateRequest": {
+    "DeviceFirmwareUpdateStage": {
       "fields": {
         "targets": {
           "rule": "repeated",
@@ -11915,6 +11916,9 @@
         }
       }
     },
+    "DeviceFirmwareUpdateRequest": {
+      "fields": {}
+    },
     "DeviceFirmwareUpdateRecord": {
       "fields": {
         "target_id": {
@@ -12096,7 +12100,7 @@
           "type": "bool",
           "id": 100
         },
-        "fw": {
+        "main_mcu": {
           "type": "bool",
           "id": 200
         },
@@ -12165,7 +12169,7 @@
           "type": "DeviceHardwareInfo",
           "id": 100
         },
-        "fw": {
+        "main_mcu": {
           "type": "DeviceMainMcuInfo",
           "id": 200
         },
@@ -12703,9 +12707,12 @@
           "id": 1
         },
         "text": {
-          "rule": "required",
           "type": "string",
           "id": 2
+        },
+        "text_id": {
+          "type": "uint32",
+          "id": 3
         }
       }
     },
@@ -12736,7 +12743,6 @@
     "ViewSignPage": {
       "fields": {
         "title": {
-          "rule": "required",
           "type": "string",
           "id": 1
         },
@@ -12770,13 +12776,16 @@
           "options": {
             "default": "LayoutDefault"
           }
+        },
+        "title_id": {
+          "type": "uint32",
+          "id": 8
         }
       }
     },
     "ViewVerifyPage": {
       "fields": {
         "title": {
-          "rule": "required",
           "type": "string",
           "id": 1
         },
@@ -12801,6 +12810,14 @@
         "value_key": {
           "type": "uint32",
           "id": 6
+        },
+        "title_id": {
+          "type": "uint32",
+          "id": 7
+        },
+        "chain_id": {
+          "type": "uint32",
+          "id": 8
         }
       }
     },