@onekeyfe/hd-core 1.2.0-alpha.1 → 1.2.0-alpha.11

package/src/data/messages/messages.json

@@ -7784,6 +7784,14 @@
         "passphrase_state": {
           "type": "string",
           "id": 1
+        },
+        "_only_main_pin": {
+          "type": "bool",
+          "id": 2
+        },
+        "allow_create_attach_pin": {
+          "type": "bool",
+          "id": 3
         }
       }
     },

package/src/data-manager/DataManager.ts

@@ -34,6 +34,7 @@ const Log = getLogger(LoggerNames.Core);
 
 export const FIRMWARE_FIELDS = [
   'firmware',
+  'firmware-v1',
   'firmware-v2',
   'firmware-v8',
   'firmware-btc-v8',
@@ -46,6 +47,7 @@ export type ProtobufMessageSchema = ProtocolV1MessageSchema | 'v2Schema';
 
 const FIRMWARE_FIELD_TYPE_MAP: Readonly<Record<IFirmwareField, EFirmwareType>> = {
   firmware: EFirmwareType.Universal,
+  'firmware-v1': EFirmwareType.Universal,
   'firmware-v2': EFirmwareType.Universal,
   'firmware-v8': EFirmwareType.Universal,
   'firmware-btc-v8': EFirmwareType.BitcoinOnly,
@@ -87,6 +89,10 @@ export default class DataManager {
       firmware: [],
       ble: [],
     },
+    [EDeviceType.Pro2]: {
+      firmware: [],
+      ble: [],
+    },
     [EDeviceType.ClassicPure]: {
       firmware: [],
       ble: [],
@@ -447,6 +453,7 @@ export default class DataManager {
         [EDeviceType.Mini]: this.enrichFirmwareReleaseInfo(data.mini),
         [EDeviceType.Touch]: this.enrichFirmwareReleaseInfo(data.touch),
         [EDeviceType.Pro]: this.enrichFirmwareReleaseInfo(data.pro),
+        [EDeviceType.Pro2]: this.enrichFirmwareReleaseInfo(data.pro2),
       };
       this.assets = {
         bridge: data.bridge,

package/src/data-manager/connectSettings.ts

@@ -27,8 +27,6 @@ const initialSettings: ConnectSettings = {
   env: 'web',
   lazyLoad: false,
   timestamp: new Date().getTime(),
-  // 临时开关：仅用于本地/测试固件兼容；正式链路默认调用真实 DevGetDeviceInfo。
-  protocolV2DeviceInfoMockEnabled: false,
 };
 
 export const getEnv = () => {
@@ -117,8 +115,8 @@ export const parseConnectSettings = (input: Partial<ConnectSettings> = {}) => {
     settings.fetchConfig = input.fetchConfig;
   }
 
-  if (typeof input.protocolV2DeviceInfoMockEnabled === 'boolean') {
-    settings.protocolV2DeviceInfoMockEnabled = input.protocolV2DeviceInfoMockEnabled;
+  if (input.configFetcher) {
+    settings.configFetcher = input.configFetcher;
   }
 
   return settings;

package/src/device/Device.ts

@@ -9,6 +9,7 @@ import {
   HardwareError,
   HardwareErrorCode,
   createDeferred,
+  createDeviceNotSupportMethodError,
 } from '@onekeyfe/hd-shared';
 
 import {
@@ -31,6 +32,7 @@ import {
 import { generateInstanceId } from '../utils/tracing';
 // eslint-disable-next-line import/no-cycle
 import { DeviceCommands } from './DeviceCommands';
+import { deviceWalletSessionStore } from './DeviceWalletSessionStore';
 import {
   type DeviceFirmwareRange,
   DeviceModelToTypes,
@@ -65,6 +67,8 @@ import type { PassphrasePromptResponse } from './DeviceCommands';
 import type { Deferred, HardwareConnectProtocol } from '@onekeyfe/hd-shared';
 import type {
   OneKeyDeviceInfo as DeviceDescriptor,
+  DeviceSessionPinResult,
+  DeviceStatus,
   ProtocolV2DeviceInfo,
   Success,
 } from '@onekeyfe/hd-transport';
@@ -76,6 +80,7 @@ export type InitOptions = {
   passphraseState?: string;
   deriveCardano?: boolean;
   connectProtocol?: HardwareConnectProtocol;
+  protocolV2DeviceInfoTimeoutMs?: number;
 };
 
 export type RunOptions = {
@@ -118,8 +123,6 @@ export interface Device {
   emit<K extends keyof DeviceEvents>(type: K, ...args: DeviceEvents[K]): boolean;
 }
 
-const deviceSessionCache: Record<string, string> = {};
-
 /**
  * Pre-populate the device session cache with a known session ID.
  *
@@ -137,8 +140,7 @@ export function preloadSessionCache(
   passphraseState: string,
   sessionId: string
 ): void {
-  const key = `${deviceId}@${passphraseState}`;
-  deviceSessionCache[key] = sessionId;
+  deviceWalletSessionStore.set(deviceId, passphraseState, sessionId);
 }
 
 export class Device extends EventEmitter {
@@ -187,7 +189,7 @@ export class Device extends EventEmitter {
   /**
    * 唯一设备状态缓存。
    *
-   * V1 直接保存原生 Features；V2 保存由 DevGetDeviceInfo 映射出的
+   * V1 直接保存原生 Features；V2 保存由 DeviceInfoGet 映射出的
    * Features 视图。Device 不再保存 profile，结构化 DeviceProfile 只作为
    * getDeviceInfo() 的 API 返回值存在。
    */
@@ -197,7 +199,7 @@ export class Device extends EventEmitter {
    * 是否需要更新设备信息。
    *
    * 历史名称保留用于兼容现有调用语义；对 V2 表示 features 需要由
-   * DevGetDeviceInfo 刷新。
+   * DeviceInfoGet 刷新。
    */
   featuresNeedsReload = false;
 
@@ -264,7 +266,7 @@ export class Device extends EventEmitter {
     const connectId = this.getConnectId();
     const deviceId = this.getCurrentDeviceId() || null;
 
-    const features = this.features;
+    const { features } = this;
 
     return {
       /** Android uses Mac address, iOS uses uuid, USB uses uuid  */
@@ -326,7 +328,10 @@ export class Device extends EventEmitter {
     });
   }
 
-  async acquire(connectProtocol?: HardwareConnectProtocol) {
+  async acquire(
+    connectProtocol?: HardwareConnectProtocol,
+    options?: { throwOnRunPromiseError?: boolean }
+  ) {
     const env = DataManager.getSettings('env');
     const mainIdKey = DataManager.isBleConnect(env) ? 'id' : 'session';
     const expectedProtocol = connectProtocol ?? this.originalDescriptor.protocolType;
@@ -375,6 +380,9 @@ export class Device extends EventEmitter {
 
       this.commands = new DeviceCommands(this, this.mainId ?? '');
     } catch (error) {
+      if (options?.throwOnRunPromiseError) {
+        throw error;
+      }
       if (this.runPromise) {
         this.runPromise.reject(error);
       } else {
@@ -477,7 +485,7 @@ export class Device extends EventEmitter {
   /**
    * 唯一协议判别器。
    *
-   * descriptor.protocolType 是协议探测后的结果；V2 features 由 DevGetDeviceInfo
+   * descriptor.protocolType 是协议探测后的结果；V2 features 由 DeviceInfoGet
    * 映射产生。
    * 全 SDK 的协议分支都必须走这里，不要直接读 originalDescriptor.protocolType
    * 或从 features 反推。
@@ -506,9 +514,8 @@ export class Device extends EventEmitter {
     const serialNo = this.getCurrentSerialNo();
     if (serialNo) return serialNo;
 
-    // connectId 是 SDK 内部连接路由 key；Protocol V2 早期固件/mock
-    // 可能还没有 serial_no，此时用 transport descriptor 兜底，不改变
-    // features.serialNo / deviceId 的业务语义。
+    // connectId 是 SDK 内部连接路由 key。这里兜底到 transport descriptor，
+    // 不改变 features.serialNo / deviceId 的业务语义。
     return this.originalDescriptor.path || this.originalDescriptor.id || '';
   }
 
@@ -622,13 +629,6 @@ export class Device extends EventEmitter {
     };
   }
 
-  private generateStateKey(deviceId: string, passphraseState?: string) {
-    if (passphraseState) {
-      return `${deviceId}@${passphraseState}`;
-    }
-    return deviceId;
-  }
-
   private getSessionCacheDeviceKey(_deviceId?: string) {
     const deviceId = _deviceId || this.getCurrentDeviceId();
     if (deviceId) return deviceId;
@@ -639,7 +639,6 @@ export class Device extends EventEmitter {
   }
 
   getInternalState(_deviceId?: string) {
-    Log.debug('getInternalState session cache: ', deviceSessionCache);
     Log.debug(
       'getInternalState session param: ',
       `device_id: ${_deviceId}`,
@@ -657,8 +656,7 @@ export class Device extends EventEmitter {
     // downstream call carries it and hits the primary lookup below.
     if (!this.passphraseState) return undefined;
 
-    const usePassKey = this.generateStateKey(deviceId, this.passphraseState);
-    return deviceSessionCache[usePassKey];
+    return deviceWalletSessionStore.get(deviceId, this.passphraseState);
   }
 
   // attach to pin to fix internal state
@@ -674,36 +672,26 @@ export class Device extends EventEmitter {
       `device_id: ${deviceId}`,
       `enablePassphrase: ${enablePassphrase}`,
       `passphraseState: ${passphraseState}`,
-      `sessionId: ${sessionId}`,
-      `featuresSessionId: ${featuresSessionId}`
+      `hasSessionId: ${Boolean(sessionId)}`,
+      `hasFeaturesSessionId: ${Boolean(featuresSessionId)}`
     );
 
     const cacheDeviceKey = this.getSessionCacheDeviceKey(deviceId);
     if (!cacheDeviceKey) return;
 
     if (enablePassphrase) {
-      // update the sessionId
-      if (sessionId) {
-        deviceSessionCache[this.generateStateKey(cacheDeviceKey, passphraseState)] = sessionId;
-      } else if (featuresSessionId) {
-        deviceSessionCache[this.generateStateKey(cacheDeviceKey, passphraseState)] =
-          featuresSessionId;
-      }
-    }
-
-    // delete the old sessionId
-    const oldKey = `${cacheDeviceKey}`;
-    if (deviceSessionCache[oldKey]) {
-      delete deviceSessionCache[oldKey];
+      const walletSessionId =
+        sessionId || featuresSessionId || deviceWalletSessionStore.getPending(cacheDeviceKey);
+      deviceWalletSessionStore.set(cacheDeviceKey, passphraseState, walletSessionId ?? undefined);
     }
 
-    Log.debug('updateInternalState session cache: ', deviceSessionCache);
+    deviceWalletSessionStore.deletePending(cacheDeviceKey);
   }
 
   private setInternalState(state: string, initSession?: boolean) {
     Log.debug(
       'setInternalState session param: ',
-      `state: ${state}`,
+      `hasState: ${Boolean(state)}`,
       `initSession: ${initSession}`,
       `deviceId: ${this.features?.deviceId}`,
       `passphraseState: ${this.passphraseState}`
@@ -714,12 +702,11 @@ export class Device extends EventEmitter {
     const deviceId = this.getSessionCacheDeviceKey();
     if (!deviceId) return;
 
-    const key = this.generateStateKey(deviceId, this.passphraseState);
-
-    if (state) {
-      deviceSessionCache[key] = state;
+    if (this.passphraseState) {
+      deviceWalletSessionStore.set(deviceId, this.passphraseState, state);
+    } else if (initSession) {
+      deviceWalletSessionStore.setPending(deviceId, state);
     }
-    Log.debug('setInternalState done session cache: ', deviceSessionCache);
   }
 
   clearInternalState(_deviceId?: string) {
@@ -727,12 +714,10 @@ export class Device extends EventEmitter {
 
     const deviceId = this.getSessionCacheDeviceKey(_deviceId);
     if (!deviceId) return;
-    const key = `${deviceId}`;
-    delete deviceSessionCache[key];
+    deviceWalletSessionStore.deletePending(deviceId);
 
     if (this.passphraseState) {
-      const usePassKey = this.generateStateKey(deviceId, this.passphraseState);
-      delete deviceSessionCache[usePassKey];
+      deviceWalletSessionStore.delete(deviceId, this.passphraseState);
     }
   }
 
@@ -741,13 +726,16 @@ export class Device extends EventEmitter {
     if (this.isProtocolV2()) {
       this.passphraseState = options?.passphraseState;
       if (this.features && !this.featuresNeedsReload && !options?.initSession) {
+        if (this.features.bootloaderMode) {
+          return;
+        }
         // 不能直接信任缓存 features：设备端 wipe / 完成初始化 / 改 label 后
         // features 会永久陈旧。每次 run 做一次轻量 status 刷新（不含 fw/SE），
         // 用字段级合并保留已有版本和 SE 信息。
-        await this._refreshProtocolV2Status();
+        await this._refreshProtocolV2Status(options);
         return;
       }
-      await this._initializeProtocolV2();
+      await this._initializeProtocolV2(options);
       return;
     }
 
@@ -797,10 +785,10 @@ export class Device extends EventEmitter {
   /**
    * Device initialization over Protocol V2.
    *
-   * Protocol V2 不走传统 Initialize/GetFeatures；直接用 DevGetDeviceInfo
+   * Protocol V2 不走传统 Initialize/GetFeatures；直接用 DeviceInfoGet
    * 生成唯一的 features 状态。
    */
-  private async _initializeProtocolV2() {
+  private async _initializeProtocolV2(options?: InitOptions) {
     Log.debug('Initialize device via Protocol V2 features adapter');
 
     try {
@@ -809,6 +797,7 @@ export class Device extends EventEmitter {
       // 且 reject 后底层调用仍会残留。
       const deviceInfo = await requestProtocolV2DeviceInfo({
         commands: this.commands,
+        timeoutMs: options?.protocolV2DeviceInfoTimeoutMs,
       });
       // 默认请求不含 SE/hash 数据，scope 如实标注为 basic；
       // 完整数据由 getDeviceInfo(scope:'verify'|'full') 获取。
@@ -824,15 +813,16 @@ export class Device extends EventEmitter {
   /**
    * Protocol V2 的轻量状态刷新（每次 run 前调用）。
    *
-   * 请求 hw + bt + status（不含 fw/SE target）：status 提供 init_states / label /
-   * passphrase_protection 等会在设备端变化的字段；hw/bt 提供 serialNo / bleName。
+   * 请求 hw + coprocessor + status（不含 fw/SE target）：status 提供 init_states / label /
+   * passphrase_enabled 等会在设备端变化的字段；hw/coprocessor 提供 serialNo / bleName。
    * versions 为空时按字段级合并保留旧值，verify 数据不会被降级。
    */
-  private async _refreshProtocolV2Status() {
+  private async _refreshProtocolV2Status(options?: InitOptions) {
     try {
       const deviceInfo = await requestProtocolV2DeviceInfo({
         commands: this.commands,
         request: PROTOCOL_V2_STATUS_DEVICE_INFO_REQUEST,
+        timeoutMs: options?.protocolV2DeviceInfoTimeoutMs,
       });
       const features = this.updateProtocolV2Features(deviceInfo);
       Log.debug('Protocol V2 features (status refresh):', features);
@@ -856,6 +846,7 @@ export class Device extends EventEmitter {
   }
 
   _updateFeatures(protoFeatures: PROTO.Features | Features, initSession?: boolean) {
+    const previousCacheDeviceKey = this.getSessionCacheDeviceKey();
     let feat =
       'protocol' in protoFeatures
         ? protoFeatures
@@ -865,28 +856,50 @@ export class Device extends EventEmitter {
     if (this.features?.sessionId && !feat.sessionId) {
       feat.sessionId = this.features.sessionId;
     }
-    if (this.getCurrentDeviceId() && feat.sessionId) {
-      this.setInternalState(feat.sessionId, initSession);
-    }
     feat.unlocked = feat.unlocked ?? true;
 
     feat = fixFeaturesFirmwareVersion(feat);
 
     this.features = feat;
+    const nextCacheDeviceKey = this.getSessionCacheDeviceKey();
+    if (previousCacheDeviceKey && nextCacheDeviceKey) {
+      deviceWalletSessionStore.migrateDeviceKey(previousCacheDeviceKey, nextCacheDeviceKey);
+    }
+    if (feat.deviceId && feat.sessionId) {
+      this.setInternalState(feat.sessionId, initSession);
+    }
     this.featuresNeedsReload = false;
     this.emit(DEVICE.FEATURES, this, feat);
   }
 
   updateProtocolV2Features(deviceInfo?: ProtocolV2DeviceInfo) {
+    const previousCacheDeviceKey = this.getSessionCacheDeviceKey();
     const features = fixFeaturesFirmwareVersion(
       buildProtocolV2FeaturesPayload(deviceInfo, this.features)
     );
     this.features = features;
+    const nextCacheDeviceKey = this.getSessionCacheDeviceKey();
+    if (previousCacheDeviceKey && nextCacheDeviceKey) {
+      deviceWalletSessionStore.migrateDeviceKey(previousCacheDeviceKey, nextCacheDeviceKey);
+    }
     this.featuresNeedsReload = false;
     this.emit(DEVICE.FEATURES, this, features);
     return features;
   }
 
+  updateProtocolV2Status(status: DeviceStatus) {
+    const previousDeviceInfo = this.features?.raw?.protocolV2DeviceInfo;
+    const previousStatus = previousDeviceInfo?.status;
+    return this.updateProtocolV2Features({
+      ...(previousDeviceInfo ?? {}),
+      protocol_version: previousDeviceInfo?.protocol_version ?? this.features?.protocolVersion ?? 2,
+      status: {
+        ...previousStatus,
+        ...status,
+      },
+    });
+  }
+
   /**
    * 暂时只在 acquire 后更新 Session ID
    * 后续看是否有需要依据 listen 返回结果更新
@@ -1167,8 +1180,7 @@ export class Device extends EventEmitter {
   }
 
   supportUnlockVersionRange(): DeviceFirmwareRange {
-    // 仅适用于 Protocol V1 的 Pro 系列；Pro2 走独立版本线，
-    // 且 Protocol V2 固件从首个版本即支持 UnLockDevice（见 unlockDevice 的 isProtocolV2 短路）。
+    // 仅适用于 Protocol V1 的 Pro 系列；Pro2 走独立的 Protocol V2 解锁流程。
     return {
       pro: {
         min: '4.15.0',
@@ -1177,6 +1189,37 @@ export class Device extends EventEmitter {
   }
 
   async unlockDevice() {
+    if (this.isProtocolV2()) {
+      let pinResult: DeviceSessionPinResult;
+      try {
+        ({ message: pinResult } = await this.commands.typedCall(
+          'DeviceSessionAskPin',
+          'DeviceSessionPinResult'
+        ));
+      } catch (error) {
+        const errorText =
+          error instanceof Error
+            ? `${error.name} ${error.message}`
+            : String((error as { message?: unknown } | null)?.message ?? error ?? '');
+        if (errorText.includes('Failure_UnexpectedMessage')) {
+          throw createDeviceNotSupportMethodError('deviceUnlock', this.getCurrentFirmwareType());
+        }
+        throw error;
+      }
+
+      const status: DeviceStatus = {};
+      if (pinResult.unlocked != null) {
+        status.unlocked = pinResult.unlocked;
+      }
+      if (pinResult.unlocked_attach_pin != null) {
+        status.unlocked_by_attach_to_pin = pinResult.unlocked_attach_pin;
+      }
+      if (pinResult.passphrase_protection != null) {
+        status.passphrase_enabled = pinResult.passphrase_protection;
+      }
+      return this.updateProtocolV2Status(status);
+    }
+
     const firmwareVersion = this.getCurrentFirmwareVersionString() ?? '0.0.0';
     const versionRange = this.getCurrentMethodVersionRange(
       type => this.supportUnlockVersionRange()[type]
@@ -1186,9 +1229,7 @@ export class Device extends EventEmitter {
       this.features,
       Enum_Capability.Capability_AttachToPin
     );
-    // Pro2 (Protocol V2) 版本线独立于 Pro 系列，固件从首个版本即支持 UnLockDevice
     const supportUnlock =
-      this.isProtocolV2() ||
       supportAttachPinCapability ||
       (versionRange &&
         semver.valid(firmwareVersion) &&
@@ -1210,14 +1251,6 @@ export class Device extends EventEmitter {
       return Promise.resolve(features);
     }
 
-    // legacy 解锁探测仅适用于 Protocol V1 老固件；V2 固件必然支持 UnLockDevice
-    if (this.isProtocolV2()) {
-      throw ERRORS.TypedError(
-        HardwareErrorCode.RuntimeError,
-        'unlock device error: device firmware does not support UnLockDevice'
-      );
-    }
-
     const { type } = await this.commands.typedCall('GetAddress', 'Address', {
       address_n: [toHardened(44), toHardened(1), toHardened(0), 0, 0],
       coin_name: 'Testnet',

package/src/device/DeviceCommands.ts

@@ -532,8 +532,9 @@ export class DeviceCommands {
 
     this.device.clearCancelableAction();
     if (res.type === 'Failure') {
-      const { code, message } = res.message as {
+      const { code, subcode, message } = res.message as {
         code?: string | FailureType;
+        subcode?: number;
         message?: string;
       };
       let error: HardwareError | null = null;
@@ -577,8 +578,13 @@ export class DeviceCommands {
       }
 
       if (code === 'Failure_ProcessError') {
-        // Handle firmware verification failures
-        if (
+        if (subcode === 9) {
+          error = ERRORS.TypedError(HardwareErrorCode.DeviceLocked, message, {
+            failureCode: code,
+            subcode,
+            firmwareMessage: message,
+          });
+        } else if (
           message?.includes('Bootloader file verify failed') ||
           message?.includes('verify failed')
         ) {

package/src/device/DeviceWalletSessionStore.ts

@@ -0,0 +1,78 @@
+export class DeviceWalletSessionStore {
+  private readonly walletSessions = new Map<string, Map<string, string>>();
+
+  private readonly pendingSessions = new Map<string, string>();
+
+  get(deviceKey: string, passphraseState?: string) {
+    if (!deviceKey || !passphraseState) return undefined;
+    return this.walletSessions.get(deviceKey)?.get(passphraseState);
+  }
+
+  set(deviceKey: string, passphraseState?: string, sessionId?: string) {
+    if (!deviceKey || !passphraseState || !sessionId) return;
+    let deviceSessions = this.walletSessions.get(deviceKey);
+    if (!deviceSessions) {
+      deviceSessions = new Map<string, string>();
+      this.walletSessions.set(deviceKey, deviceSessions);
+    }
+    deviceSessions.set(passphraseState, sessionId);
+  }
+
+  setPending(deviceKey: string, sessionId?: string) {
+    if (!deviceKey || !sessionId) return;
+    this.pendingSessions.set(deviceKey, sessionId);
+  }
+
+  getPending(deviceKey: string) {
+    if (!deviceKey) return undefined;
+    return this.pendingSessions.get(deviceKey);
+  }
+
+  delete(deviceKey: string, passphraseState?: string) {
+    if (!deviceKey || !passphraseState) return;
+    const deviceSessions = this.walletSessions.get(deviceKey);
+    if (!deviceSessions) return;
+    deviceSessions.delete(passphraseState);
+    if (deviceSessions.size === 0) {
+      this.walletSessions.delete(deviceKey);
+    }
+  }
+
+  deletePending(deviceKey: string) {
+    if (!deviceKey) return;
+    this.pendingSessions.delete(deviceKey);
+  }
+
+  deleteDevice(deviceKey: string) {
+    if (!deviceKey) return;
+    this.walletSessions.delete(deviceKey);
+    this.pendingSessions.delete(deviceKey);
+  }
+
+  migrateDeviceKey(from: string, to: string) {
+    if (!from || !to || from === to) return;
+
+    const sourceSessions = this.walletSessions.get(from);
+    if (sourceSessions) {
+      const targetSessions = this.walletSessions.get(to) ?? new Map<string, string>();
+      this.walletSessions.set(to, targetSessions);
+      sourceSessions.forEach((sessionId, passphraseState) => {
+        targetSessions.set(passphraseState, sessionId);
+      });
+      this.walletSessions.delete(from);
+    }
+
+    const pendingSession = this.pendingSessions.get(from);
+    if (pendingSession) {
+      this.pendingSessions.set(to, pendingSession);
+      this.pendingSessions.delete(from);
+    }
+  }
+
+  clear() {
+    this.walletSessions.clear();
+    this.pendingSessions.clear();
+  }
+}
+
+export const deviceWalletSessionStore = new DeviceWalletSessionStore();