@onekeyfe/hd-core 1.1.27-alpha.4 → 1.1.27-alpha.41

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;
   }
 }

package/src/device/Device.ts

@@ -41,6 +41,7 @@ import { DataManager } from '../data-manager';
 import TransportManager from '../data-manager/TransportManager';
 import { toHardened } from '../api/helpers/pathUtils';
 import { existCapability } from '../utils/capabilitieUtils';
+import { getProtocolV2Features } from '../protocols/protocol-v2';
 
 import type { PROTO } from '../constants';
 import type {
@@ -49,7 +50,7 @@ import type {
   PassphraseRequestPayload,
 } from '../events';
 import type { PassphrasePromptResponse } from './DeviceCommands';
-import type { Deferred } from '@onekeyfe/hd-shared';
+import type { Deferred, HardwareConnectProtocol } from '@onekeyfe/hd-shared';
 import type { OneKeyDeviceInfo as DeviceDescriptor } from '@onekeyfe/hd-transport';
 import type DeviceConnector from './DeviceConnector';
 
@@ -58,11 +59,11 @@ export type InitOptions = {
   deviceId?: string;
   passphraseState?: string;
   deriveCardano?: boolean;
+  connectProtocol?: HardwareConnectProtocol;
 };
 
 export type RunOptions = {
   keepSession?: boolean;
-  skipInitialize?: boolean;
 } & InitOptions;
 
 const parseRunOptions = (options?: RunOptions): RunOptions => {
@@ -197,17 +198,6 @@ export class Device extends EventEmitter {
 
   pendingCallbackPromise?: Deferred<void>;
 
-  /** Pre-initialize timestamp (ms) */
-  private preInitializedAt?: number;
-
-  /** Pre-initialize context, used to verify state consistency before skipping */
-  private preInitializeMeta?: {
-    passphraseState?: string;
-  };
-
-  /** Last Initialize duration (ms), reported as "saved" when a skip happens */
-  private lastInitializeDurationMs?: number;
-
   constructor(descriptor: DeviceDescriptor, sdkInstanceId?: string) {
     super();
     this.originalDescriptor = descriptor;
@@ -264,13 +254,13 @@ export class Device extends EventEmitter {
    * Device connect
    * @returns {Promise<boolean>}
    */
-  connect() {
+  connect(connectProtocol?: HardwareConnectProtocol) {
     const env = DataManager.getSettings('env');
     // eslint-disable-next-line no-async-promise-executor
     return new Promise<boolean>(async (resolve, reject) => {
       if (DataManager.isBleConnect(env)) {
         try {
-          await this.acquire();
+          await this.acquire(connectProtocol);
           resolve(true);
         } catch (error) {
           reject(error);
@@ -280,7 +270,7 @@ export class Device extends EventEmitter {
       // 不存在 Session ID 或存在 Session ID 但设备在别处使用，都需要 acquire 获取最新 sessionID
       if (!this.mainId || (!this.isUsedHere() && this.originalDescriptor)) {
         try {
-          await this.acquire();
+          await this.acquire(connectProtocol);
           resolve(true);
         } catch (error) {
           reject(error);
@@ -295,23 +285,44 @@ export class Device extends EventEmitter {
     });
   }
 
-  async acquire() {
+  async acquire(connectProtocol?: HardwareConnectProtocol) {
     const env = DataManager.getSettings('env');
     const mainIdKey = DataManager.isBleConnect(env) ? 'id' : 'session';
+    const expectedProtocol = connectProtocol ?? this.originalDescriptor.protocolType;
     try {
+      let acquireResult: unknown;
       if (DataManager.isBleConnect(env)) {
-        const res = await this.deviceConnector?.acquire(this.originalDescriptor.id);
-        this.mainId = (res as unknown as any).uuid ?? '';
+        acquireResult = await this.deviceConnector?.acquire(
+          this.originalDescriptor.id,
+          undefined,
+          true,
+          expectedProtocol
+        );
+        this.mainId = (acquireResult as any)?.uuid ?? '';
         Log.debug('Expected uuid:', this.mainId);
       } else {
-        this.mainId = await this.deviceConnector?.acquire(
+        acquireResult = await this.deviceConnector?.acquire(
           this.originalDescriptor.path,
-          this.originalDescriptor.session
+          this.originalDescriptor.session,
+          undefined,
+          expectedProtocol
         );
+        this.mainId = acquireResult as string | undefined;
         Log.debug('Expected session id:', this.mainId);
       }
       this.deviceAcquired = true;
       this.updateDescriptor({ [mainIdKey]: this.mainId } as unknown as DeviceDescriptor);
+
+      // Propagate protocol version detected during acquire.
+      const detectedProtocol =
+        (acquireResult as { protocolType?: HardwareConnectProtocol } | undefined)?.protocolType ??
+        TransportManager.transport?.getProtocolType?.(
+          DataManager.isBleConnect(env) ? this.originalDescriptor.id : this.originalDescriptor.path
+        );
+      if (detectedProtocol) {
+        this.originalDescriptor.protocolType = detectedProtocol;
+      }
+
       if (this.commands) {
         await this.commands.dispose(false);
       }
@@ -367,54 +378,6 @@ export class Device extends EventEmitter {
     this.deviceAcquired = false;
   }
 
-  /**
-   * Pre-initialize: connect + Initialize ahead of the sign. Only runs the
-   * fallback init when features are missing (gate on `!this.features`, not
-   * isUsedHere which is always false on BLE); otherwise just records the mark.
-   */
-  async preInitialize(initOptions?: InitOptions) {
-    if (!this.features) {
-      await this.acquire();
-      await this.initialize(initOptions);
-    }
-    this.markPreInitialized({
-      passphraseState: initOptions?.passphraseState,
-    });
-  }
-
-  markPreInitialized(meta?: { passphraseState?: string }) {
-    this.preInitializedAt = Date.now();
-    this.preInitializeMeta = meta
-      ? {
-          passphraseState: meta.passphraseState === '' ? undefined : meta.passphraseState,
-        }
-      : undefined;
-  }
-
-  clearPreInitialized() {
-    this.preInitializedAt = undefined;
-    this.preInitializeMeta = undefined;
-  }
-
-  isPreInitializeMetaMatch(payload?: { passphraseState?: string }) {
-    if (!this.preInitializeMeta) return true;
-    const passphraseState = payload?.passphraseState === '' ? undefined : payload?.passphraseState;
-    return this.preInitializeMeta.passphraseState === passphraseState;
-  }
-
-  isPreInitializedValid(ttlMs: number) {
-    if (!this.preInitializedAt) return false;
-    return Date.now() - this.preInitializedAt <= ttlMs;
-  }
-
-  setLastInitializeDuration(durationMs: number) {
-    this.lastInitializeDurationMs = durationMs;
-  }
-
-  getLastInitializeDuration() {
-    return this.lastInitializeDurationMs;
-  }
-
   getCommands() {
     return this.commands;
   }
@@ -522,6 +485,17 @@ export class Device extends EventEmitter {
   }
 
   async initialize(options?: InitOptions) {
+    // Protocol V2 不支持传统 Initialize，直接使用协议专用初始化流程。
+    if (this.originalDescriptor.protocolType === 'V2') {
+      this.passphraseState = options?.passphraseState;
+      if (this.features && !this.featuresNeedsReload && !options?.initSession) {
+        Log.debug('Skip Protocol V2 feature adapter; cached features are available');
+        return;
+      }
+      await this._initializeProtocolV2();
+      return;
+    }
+
     // Log.debug('initialize param:', options);
 
     this.passphraseState = options?.passphraseState;
@@ -542,7 +516,13 @@ export class Device extends EventEmitter {
     payload.passphrase_state = options?.passphraseState;
     payload.is_contains_attach = true;
 
-    const initStartAt = Date.now();
+    Log.debug('Initialize device begin:', {
+      deviceId: options?.deviceId,
+      passphraseState: options?.passphraseState,
+      initSession: options?.initSession,
+      InitializePayload: payload,
+    });
+
     try {
       // @ts-expect-error
       const { message } = await Promise.race([
@@ -555,8 +535,7 @@ export class Device extends EventEmitter {
         }),
       ]);
 
-      const initCostMs = Date.now() - initStartAt;
-      this.setLastInitializeDuration(initCostMs);
+      Log.debug('Initialize device end: ', message);
       this._updateFeatures(message, options?.initSession);
       await TransportManager.reconfigure(this.features);
     } catch (error) {
@@ -565,6 +544,36 @@ export class Device extends EventEmitter {
     }
   }
 
+  /**
+   * Device initialization over Protocol V2.
+   *
+   * Protocol V2 不走传统 Initialize/GetFeatures，直接用轻量 DeviceGetDeviceInfo
+   * 归一成 legacy-style Features 视图。
+   */
+  private async _initializeProtocolV2() {
+    Log.debug('Initialize device via Protocol V2 feature adapter');
+
+    try {
+      const features = await Promise.race([
+        getProtocolV2Features({
+          commands: this.commands,
+          descriptor: this.originalDescriptor,
+          timeoutMs: 10 * 1000,
+        }),
+        new Promise<never>((_, reject) => {
+          setTimeout(() => {
+            reject(ERRORS.TypedError(HardwareErrorCode.DeviceInitializeFailed));
+          }, 10 * 1000);
+        }),
+      ]);
+      Log.debug('Protocol V2 normalized features:', features);
+      this._updateFeatures(features);
+    } catch (error) {
+      Log.error('Protocol V2 initialization failed:', error);
+      throw error;
+    }
+  }
+
   async getFeatures() {
     const { message } = await this.commands.typedCall('GetFeatures', 'Features', {});
     this._updateFeatures(message);
@@ -635,7 +644,7 @@ export class Device extends EventEmitter {
       const env = DataManager.getSettings('env');
       if (env !== 'react-native') {
         try {
-          await this.acquire();
+          await this.acquire(options.connectProtocol);
         } catch (error) {
           this.runPromise = null;
           return Promise.reject(error);
@@ -643,9 +652,7 @@ export class Device extends EventEmitter {
 
         try {
           if (fn) {
-            if (!options?.skipInitialize) {
-              await this.initialize(options);
-            }
+            await this.initialize(options);
           }
         } catch (error) {
           this.runPromise = null;
@@ -879,9 +886,13 @@ export class Device extends EventEmitter {
       this.features,
       Enum_Capability.Capability_AttachToPin
     );
+    const isPro2 = getDeviceType(this.features) === EDeviceType.Pro2;
 
     const supportUnlock =
-      supportAttachPinCapability || (versionRange && semver.gte(firmwareVersion, versionRange.min));
+      supportAttachPinCapability ||
+      // Pro2 V2 暂未从 features 暴露 capabilities，先直连该方法用于固件联调。
+      isPro2 ||
+      (versionRange && semver.gte(firmwareVersion, versionRange.min));
 
     if (supportUnlock) {
       const res = await this.commands.typedCall('UnLockDevice', 'UnLockDeviceResponse');
@@ -929,14 +940,11 @@ export class Device extends EventEmitter {
         onlyMainPin: useEmptyPassphrase,
       });
 
-    if (skipPassphraseCheck) {
-      return true;
-    }
-
     // Main wallet and unlock Attach Pin, throw safe error
     const mainWalletUseAttachPin = unlockedAttachPin && useEmptyPassphrase;
     const useErrorAttachPin =
       unlockedAttachPin && passphraseState && passphraseState !== newPassphraseState;
+    const passphraseStateMismatch = !!passphraseState && passphraseState !== newPassphraseState;
 
     Log.debug('Check passphrase state safety: ', {
       passphraseState,
@@ -945,6 +953,14 @@ export class Device extends EventEmitter {
       useEmptyPassphrase,
     });
 
+    if (skipPassphraseCheck) {
+      if (passphraseStateMismatch) {
+        this.clearInternalState();
+        return false;
+      }
+      return true;
+    }
+
     if (mainWalletUseAttachPin || useErrorAttachPin) {
       try {
         await this.lockDevice();
@@ -956,7 +972,7 @@ export class Device extends EventEmitter {
     }
 
     // When exists passphraseState, check passphraseState
-    if (passphraseState && passphraseState !== newPassphraseState) {
+    if (passphraseStateMismatch) {
       this.clearInternalState();
       return false;
     }