@onekeyfe/hd-core 1.1.27 → 1.2.0-alpha.0

package/src/data-manager/DataManager.ts

@@ -4,6 +4,7 @@ import { EDeviceType, EFirmwareType } from '@onekeyfe/hd-shared';
 
 import MessagesJSON from '../data/messages/messages.json';
 import MessagesLegacyV1JSON from '../data/messages/messages_legacy_v1.json';
+import MessagesProtocolV2JSON from '../data/messages/messages-protocol-v2.json';
 import {
   LoggerNames,
   getDeviceBLEFirmwareVersion,
@@ -40,7 +41,8 @@ export const FIRMWARE_FIELDS = [
 
 export type IFirmwareField = (typeof FIRMWARE_FIELDS)[number];
 
-export type MessageVersion = 'latest' | 'v1';
+export type ProtocolV1MessageSchema = 'v1CurrentSchema' | 'v1LegacySchema';
+export type ProtobufMessageSchema = ProtocolV1MessageSchema | 'v2Schema';
 
 const FIRMWARE_FIELD_TYPE_MAP: Readonly<Record<IFirmwareField, EFirmwareType>> = {
   firmware: EFirmwareType.Universal,
@@ -62,7 +64,9 @@ function getFirmwareTypeFromField(firmwareField: IFirmwareField): EFirmwareType
 }
 
 export default class DataManager {
-  static deviceMap: DeviceTypeMap = {
+  static deviceMap: DeviceTypeMap & {
+    [k: string]: DeviceTypeMap[keyof DeviceTypeMap] | undefined;
+  } = {
     [EDeviceType.Classic]: {
       firmware: [],
       ble: [],
@@ -93,9 +97,10 @@ export default class DataManager {
 
   static settings: ConnectSettings;
 
-  static messages: { [version in MessageVersion]: JSON } = {
-    latest: MessagesJSON as unknown as JSON,
-    v1: MessagesLegacyV1JSON as unknown as JSON,
+  static messages: { [schema in ProtobufMessageSchema]: JSON } = {
+    v1CurrentSchema: MessagesJSON as unknown as JSON,
+    v1LegacySchema: MessagesLegacyV1JSON as unknown as JSON,
+    v2Schema: MessagesProtocolV2JSON as unknown as JSON,
   };
 
   static lastCheckTimestamp = 0;
@@ -472,8 +477,8 @@ export default class DataManager {
     }
   }
 
-  static getProtobufMessages(messageVersion: MessageVersion = 'latest'): JSON {
-    return this.messages[messageVersion];
+  static getProtobufMessages(schema: ProtobufMessageSchema = 'v1CurrentSchema'): JSON {
+    return this.messages[schema];
   }
 
   static getSettings(key?: undefined): ConnectSettings;

package/src/data-manager/MessagesConfig.ts

@@ -1,28 +1,28 @@
 import type { IDeviceModel, IDeviceType } from '../types';
-import type { MessageVersion } from './DataManager';
+import type { ProtocolV1MessageSchema } from './DataManager';
 
 type DeviceVersionConfig = {
   [deviceType in IDeviceType | IDeviceModel]?: {
     minVersion: string;
-    messageVersion: MessageVersion;
+    protocolV1MessageSchema: ProtocolV1MessageSchema;
   }[];
 };
 
 export const PROTOBUF_MESSAGE_CONFIG: DeviceVersionConfig = {
   model_mini: [
-    // Classic1s starts from 3.5.0, so use latest by default
-    // Only use v1 for specific old versions (< 3.3.0)
-    { minVersion: '3.3.0', messageVersion: 'latest' },
-    { minVersion: '0.0.1', messageVersion: 'v1' },
-    // Fallback to latest for unknown versions (0.0.0) to prevent device type detection issues
-    { minVersion: '0.0.0', messageVersion: 'latest' },
+    // Classic1s starts from 3.5.0, so use the current Protocol V1 schema by default.
+    // Only use the legacy Protocol V1 schema for specific old versions (< 3.3.0).
+    { minVersion: '3.3.0', protocolV1MessageSchema: 'v1CurrentSchema' },
+    { minVersion: '0.0.1', protocolV1MessageSchema: 'v1LegacySchema' },
+    // Fallback to current Protocol V1 schema for unknown versions (0.0.0).
+    { minVersion: '0.0.0', protocolV1MessageSchema: 'v1CurrentSchema' },
   ],
   model_touch: [
-    // Use latest by default for Touch/Pro
-    // Only use v1 for specific old versions (< 4.5.0)
-    { minVersion: '4.5.0', messageVersion: 'latest' },
-    { minVersion: '0.0.1', messageVersion: 'v1' },
-    // Fallback to latest for unknown versions (0.0.0)
-    { minVersion: '0.0.0', messageVersion: 'latest' },
+    // Use the current Protocol V1 schema by default for Touch/Pro.
+    // Only use the legacy Protocol V1 schema for specific old versions (< 4.5.0).
+    { minVersion: '4.5.0', protocolV1MessageSchema: 'v1CurrentSchema' },
+    { minVersion: '0.0.1', protocolV1MessageSchema: 'v1LegacySchema' },
+    // Fallback to current Protocol V1 schema for unknown versions (0.0.0).
+    { minVersion: '0.0.0', protocolV1MessageSchema: 'v1CurrentSchema' },
   ],
 };

package/src/data-manager/TransportManager.ts

@@ -4,9 +4,9 @@ import DataManager from './DataManager';
 import { LoggerNames, getLogger } from '../utils';
 // eslint-disable-next-line import/no-cycle
 import { DevicePool } from '../device/DevicePool';
-import { getSupportMessageVersion } from '../utils/deviceFeaturesUtils';
+import { getSupportProtocolV1MessageSchema } from '../utils/deviceFeaturesUtils';
 
-import type { MessageVersion } from './DataManager';
+import type { ProtocolV1MessageSchema } from './DataManager';
 import type { LowlevelTransportSharedPlugin, Transport } from '@onekeyfe/hd-transport';
 import type { Features } from '../types';
 
@@ -17,6 +17,7 @@ const LowLevelLogger = getLogger(LoggerNames.HdTransportLowLevel);
 const NodeUsbLogger = getLogger(LoggerNames.HdTransportNodeUsb);
 const WebBleLogger = getLogger(LoggerNames.HdWebBleTransport);
 const WebUsbLogger = getLogger(LoggerNames.HdTransportWebUsb);
+const REACT_NATIVE_BLE_SCAN_TIMEOUT_MS = 8000;
 
 /**
  * transport 在同一个环境中只会存在一个
@@ -32,7 +33,7 @@ export default class TransportManager {
 
   static reactNativeInit = false;
 
-  static messageVersion: MessageVersion = 'latest';
+  static protocolV1MessageSchema: ProtocolV1MessageSchema = 'v1CurrentSchema';
 
   static plugin: LowlevelTransportSharedPlugin | null = null;
 
@@ -40,7 +41,7 @@ export default class TransportManager {
     Log.debug('transport manager load');
     this.defaultMessages = DataManager.getProtobufMessages();
     this.currentMessages = this.defaultMessages;
-    this.messageVersion = 'latest';
+    this.protocolV1MessageSchema = 'v1CurrentSchema';
   }
 
   static async configure() {
@@ -74,6 +75,9 @@ export default class TransportManager {
       }
       Log.debug('Configuring transports');
       await this.transport.configure(JSON.stringify(this.defaultMessages));
+      this.currentMessages = this.defaultMessages;
+      this.protocolV1MessageSchema = 'v1CurrentSchema';
+      await this.configureProtocolV2Messages();
       Log.debug('Configuring transports done');
     } catch (error) {
       Log.debug('Initializing transports error: ', error);
@@ -83,20 +87,31 @@ export default class TransportManager {
     }
   }
 
-  static async reconfigure(features?: Features | undefined) {
-    Log.debug(`Begin reconfiguring transports`);
-    const { messageVersion, messages } = getSupportMessageVersion(features);
+  /**
+   * Re-load the transport's main protobuf schema based on a device's reported features.
+   *
+   * This handles protobuf schema compatibility within Protocol V1 (e.g. Touch's legacy
+   * vs current Protocol V1 schema). It is NOT used to switch between Protocol V1 and Protocol V2 —
+   * the transport already holds both schemas after initial configure(), and routes per
+   * device by `getProtocolType()`.
+   */
+  static async reconfigure(features?: Features) {
+    if (!features) {
+      return;
+    }
+
+    const { protocolV1MessageSchema, messages } = getSupportProtocolV1MessageSchema(features);
 
     if (this.currentMessages === messages || !messages) {
       return;
     }
 
-    Log.debug(`Reconfiguring transports version:${messageVersion}`);
+    Log.debug(`Reconfiguring transports Protocol V1 schema:${protocolV1MessageSchema}`);
 
     try {
       await this.transport.configure(JSON.stringify(messages));
       this.currentMessages = messages;
-      this.messageVersion = messageVersion;
+      this.protocolV1MessageSchema = protocolV1MessageSchema;
     } catch (error) {
       throw ERRORS.TypedError(
         HardwareErrorCode.TransportInvalidProtobuf,
@@ -109,7 +124,9 @@ export default class TransportManager {
     const env = DataManager.getSettings('env');
     if (env === 'react-native') {
       /** Actually initializes the ReactNativeTransport */
-      this.transport = new TransportConstructor({ scanTimeout: 3000 }) as unknown as Transport;
+      this.transport = new TransportConstructor({
+        scanTimeout: REACT_NATIVE_BLE_SCAN_TIMEOUT_MS,
+      }) as unknown as Transport;
     } else {
       /** Actually initializes the HttpTransport */
       this.transport = new TransportConstructor() as unknown as Transport;
@@ -130,6 +147,15 @@ export default class TransportManager {
     return this.transport;
   }
 
+  private static async configureProtocolV2Messages() {
+    const protocolV2Messages = DataManager.getProtobufMessages('v2Schema');
+    const { configureProtocolV2 } = this.transport;
+    if (protocolV2Messages && typeof configureProtocolV2 === 'function') {
+      await configureProtocolV2.call(this.transport, JSON.stringify(protocolV2Messages));
+      Log.debug('Protocol V2 messages configured');
+    }
+  }
+
   static getDefaultMessages() {
     return this.defaultMessages;
   }
@@ -138,7 +164,7 @@ export default class TransportManager {
     return this.currentMessages;
   }
 
-  static getMessageVersion() {
-    return this.messageVersion;
+  static getProtocolV1MessageSchema() {
+    return this.protocolV1MessageSchema;
   }
 }