@onekeyfe/hd-core 0.3.16 → 0.3.19

package/src/data/messages-config/index.ts

@@ -0,0 +1,20 @@
+import { IDeviceModel, IDeviceType } from '../../types';
+import { MessageVersion } from '../../data-manager/DataManager';
+
+type DeviceVersionConfig = {
+  [deviceType in IDeviceType | IDeviceModel]?: {
+    minVersion: string;
+    messageVersion: MessageVersion;
+  }[];
+};
+
+export const PROTOBUF_MESSAGE_CONFIG: DeviceVersionConfig = {
+  model_mini: [
+    { minVersion: '3.2.0', messageVersion: 'latest' },
+    { minVersion: '0.0.0', messageVersion: 'v1' },
+  ],
+  model_touch: [
+    { minVersion: '4.4.0', messageVersion: 'latest' },
+    { minVersion: '0.0.0', messageVersion: 'v1' },
+  ],
+};

package/src/data-manager/DataManager.ts

@@ -1,28 +1,31 @@
 import axios from 'axios';
 import semver from 'semver';
 import MessagesJSON from '../data/messages/messages.json';
+import MessagesLegacyV1JSON from '../data/messages/messages_legacy_v1.json';
 import { getTimeStamp } from '../utils';
 import {
-  getDeviceType,
-  getDeviceFirmwareVersion,
   getDeviceBLEFirmwareVersion,
+  getDeviceFirmwareVersion,
+  getDeviceType,
   getFirmwareUpdateField,
 } from '../utils/deviceFeaturesUtils';
 
 import type {
+  AssetsMap,
   ConnectSettings,
   DeviceTypeMap,
-  AssetsMap,
-  RemoteConfigResponse,
   Features,
-  IDeviceFirmwareStatus,
   IDeviceBLEFirmwareStatus,
+  IDeviceFirmwareStatus,
   ITransportStatus,
   IVersionArray,
+  RemoteConfigResponse,
 } from '../types';
-import { getReleaseChangelog, getReleaseStatus, findLatestRelease } from '../utils/release';
+import { findLatestRelease, getReleaseChangelog, getReleaseStatus } from '../utils/release';
+
+type FirmwareField = 'firmware' | 'firmware-v2' | 'firmware-v3' | 'firmware-v4';
 
-type FirmwareField = 'firmware' | 'firmware-v2' | 'firmware-v3';
+export type MessageVersion = 'latest' | 'v1';
 
 export default class DataManager {
   static deviceMap: DeviceTypeMap = {
@@ -48,8 +51,9 @@ export default class DataManager {
 
   static settings: ConnectSettings;
 
-  static messages: { default: JSON } = {
-    default: MessagesJSON as unknown as JSON,
+  static messages: { [version in MessageVersion]: JSON } = {
+    latest: MessagesJSON as unknown as JSON,
+    v1: MessagesLegacyV1JSON as unknown as JSON,
   };
 
   static lastCheckTimestamp = 0;
@@ -254,8 +258,8 @@ export default class DataManager {
     }
   }
 
-  static getProtobufMessages() {
-    return this.messages.default;
+  static getProtobufMessages(messageVersion: MessageVersion = 'latest'): JSON {
+    return this.messages[messageVersion];
   }
 
   static getSettings(key?: undefined): ConnectSettings;

package/src/data-manager/TransportManager.ts

@@ -1,13 +1,16 @@
 import { Transport } from '@onekeyfe/hd-transport';
 import { ERRORS, HardwareErrorCode } from '@onekeyfe/hd-shared';
-import DataManager from './DataManager';
+import DataManager, { MessageVersion } from './DataManager';
 import { getLogger, LoggerNames } from '../utils';
 // eslint-disable-next-line import/no-cycle
 import { DevicePool } from '../device/DevicePool';
+import { getSupportMessageVersion } from '../utils/deviceFeaturesUtils';
+import { Features } from '../types';
 
 const Log = getLogger(LoggerNames.Transport);
 const BleLogger = getLogger(LoggerNames.HdBleTransport);
 const HttpLogger = getLogger(LoggerNames.HdTransportHttp);
+
 /**
  * transport 在同一个环境中只会存在一个
  * 这里设计成单例获取
@@ -22,10 +25,13 @@ export default class TransportManager {
 
   static reactNativeInit = false;
 
+  static messageVersion: MessageVersion = 'latest';
+
   static load() {
     Log.debug('transport manager load');
     this.defaultMessages = DataManager.getProtobufMessages();
     this.currentMessages = this.defaultMessages;
+    this.messageVersion = 'latest';
   }
 
   static async configure() {
@@ -53,16 +59,20 @@ export default class TransportManager {
     }
   }
 
-  static async reconfigure(messages?: JSON | number[] | null) {
-    if (Array.isArray(messages)) {
-      messages = DataManager.getProtobufMessages();
-    }
+  static async reconfigure(features?: Features | undefined) {
+    Log.debug(`Begin reconfiguring transports`);
+    const { messageVersion, messages } = getSupportMessageVersion(features);
+
     if (this.currentMessages === messages || !messages) {
       return;
     }
+
+    Log.debug(`Reconfiguring transports version:${messageVersion}`);
+
     try {
       await this.transport.configure(JSON.stringify(messages));
       this.currentMessages = messages;
+      this.messageVersion = messageVersion;
     } catch (error) {
       throw ERRORS.TypedError(
         HardwareErrorCode.TransportInvalidProtobuf,
@@ -94,4 +104,8 @@ export default class TransportManager {
   static getCurrentMessages() {
     return this.currentMessages;
   }
+
+  static getMessageVersion() {
+    return this.messageVersion;
+  }
 }

package/src/device/Device.ts

@@ -3,17 +3,17 @@ import { OneKeyDeviceInfo as DeviceDescriptor } from '@onekeyfe/hd-transport';
 import {
   createDeferred,
   Deferred,
-  HardwareErrorCode,
   ERRORS,
   HardwareError,
+  HardwareErrorCode,
 } from '@onekeyfe/hd-shared';
 import {
+  getDeviceBLEFirmwareVersion,
   getDeviceFirmwareVersion,
   getDeviceLabel,
   getDeviceType,
-  getDeviceUUID,
-  getDeviceBLEFirmwareVersion,
   getDeviceTypeOnBootloader,
+  getDeviceUUID,
   getPassphraseState,
 } from '../utils/deviceFeaturesUtils';
 
@@ -21,12 +21,13 @@ import type DeviceConnector from './DeviceConnector';
 // eslint-disable-next-line import/no-cycle
 import { DeviceCommands, PassphrasePromptResponse } from './DeviceCommands';
 
-import type { Features, Device as DeviceTyped, UnavailableCapabilities } from '../types';
+import type { Device as DeviceTyped, Features, UnavailableCapabilities } from '../types';
 import { DEVICE, DeviceButtonRequestPayload, DeviceFeaturesPayload } from '../events';
 import { UI_REQUEST } from '../constants/ui-request';
 import { PROTO } from '../constants';
 import { getLogger, LoggerNames } from '../utils';
 import { DataManager } from '../data-manager';
+import TransportManager from '../data-manager/TransportManager';
 
 export type InitOptions = {
   initSession?: boolean;
@@ -355,6 +356,8 @@ export class Device extends EventEmitter {
 
     const { message } = await this.commands.typedCall('Initialize', 'Features', payload);
     this._updateFeatures(message, options?.initSession);
+
+    await TransportManager.reconfigure(message);
   }
 
   async getFeatures() {
@@ -370,7 +373,7 @@ export class Device extends EventEmitter {
     if (this.features && this.features.device_id && feat.session_id) {
       this.setInternalState(feat.session_id, initSession);
     }
-    feat.unlocked = feat.unlocked || true;
+    feat.unlocked = feat.unlocked ?? true;
 
     this.features = feat;
     this.featuresNeedsReload = false;

package/src/types/api/nexaGetAddress.ts

@@ -1,9 +1,10 @@
-import { NexaAddress as HardwareNexaAddress } from '@onekeyfe/hd-transport';
 import type { CommonParams, Response } from '../params';
 
 export type NexaAddress = {
   path: string;
-} & HardwareNexaAddress;
+  pub: string;
+  address: string;
+};
 
 export type NexaGetAddressParams = {
   path: string | number[];

package/src/types/device.ts

@@ -77,6 +77,18 @@ export type IDeviceType = 'classic' | 'mini' | 'touch' | 'pro';
 // model_touch: 'touch' | 'pro'
 export type IDeviceModel = 'model_mini' | 'model_touch';
 
+export const DeviceModelToTypes: { [deviceModel in IDeviceModel]: IDeviceType[] } = {
+  model_mini: ['classic', 'mini'],
+  model_touch: ['touch', 'pro'],
+};
+
+export const DeviceTypeToModels: { [deviceType in IDeviceType]: IDeviceModel[] } = {
+  classic: ['model_mini'],
+  mini: ['model_mini'],
+  touch: ['model_touch'],
+  pro: ['model_touch'],
+};
+
 export type IDeviceFirmwareStatus = 'valid' | 'outdated' | 'required' | 'unknown' | 'none';
 
 export type IDeviceBLEFirmwareStatus = 'valid' | 'outdated' | 'required' | 'unknown' | 'none';

package/src/types/settings.ts

@@ -66,6 +66,7 @@ export type DeviceTypeMap = {
     firmware: IFirmwareReleaseInfo[];
     'firmware-v2'?: IFirmwareReleaseInfo[];
     'firmware-v3'?: IFirmwareReleaseInfo[];
+    'firmware-v4'?: IFirmwareReleaseInfo[];
     ble: IBLEFirmwareReleaseInfo[];
   };
 };

package/src/utils/deviceFeaturesUtils.ts

@@ -4,11 +4,14 @@ import { toHardened } from '../api/helpers/pathUtils';
 import { DeviceCommands } from '../device/DeviceCommands';
 import type {
   Features,
-  IVersionArray,
-  IDeviceType,
   IDeviceModel,
+  IDeviceType,
+  IVersionArray,
   SupportFeatureType,
 } from '../types';
+import { DeviceTypeToModels } from '../types';
+import DataManager, { MessageVersion } from '../data-manager/DataManager';
+import { PROTOBUF_MESSAGE_CONFIG } from '../data/messages-config';
 
 export const getDeviceModel = (features?: Features): IDeviceModel => {
   if (!features || typeof features !== 'object') {
@@ -113,6 +116,43 @@ export const getDeviceBootloaderVersion = (features: Features): IVersionArray =>
   return [0, 0, 0];
 };
 
+export const getSupportMessageVersion = (
+  features: Features | undefined
+): { messages: JSON; messageVersion: MessageVersion } => {
+  if (!features)
+    return {
+      messages: DataManager.messages.latest,
+      messageVersion: 'latest',
+    };
+
+  const currentDeviceVersion = getDeviceFirmwareVersion(features).join('.');
+  const deviceType = getDeviceType(features);
+
+  const deviceVersionConfigs =
+    PROTOBUF_MESSAGE_CONFIG[deviceType] ||
+    (DeviceTypeToModels[deviceType] &&
+      DeviceTypeToModels[deviceType]
+        .map(model => PROTOBUF_MESSAGE_CONFIG[model])
+        .find(range => range !== undefined));
+
+  const sortedDeviceVersionConfigs =
+    deviceVersionConfigs?.sort((a, b) => semver.compare(b.minVersion, a.minVersion)) ?? [];
+
+  for (const { minVersion, messageVersion } of sortedDeviceVersionConfigs) {
+    if (semver.gte(currentDeviceVersion, minVersion)) {
+      return {
+        messages: DataManager.messages[messageVersion],
+        messageVersion,
+      };
+    }
+  }
+
+  return {
+    messages: DataManager.messages.latest,
+    messageVersion: 'latest',
+  };
+};
+
 export const supportInputPinOnSoftware = (features: Features): SupportFeatureType => {
   if (!features) return { support: false };
 
@@ -185,7 +225,7 @@ export const supportModifyHomescreen = (features?: Features): SupportFeatureType
 export const getFirmwareUpdateField = (
   features: Features,
   updateType: 'firmware' | 'ble'
-): 'firmware' | 'ble' | 'firmware-v3' | 'firmware-v2' => {
+): 'firmware' | 'ble' | 'firmware-v4' => {
   const deviceType = getDeviceType(features);
   const deviceFirmwareVersion = getDeviceFirmwareVersion(features);
   if (updateType === 'ble') {
@@ -193,12 +233,12 @@ export const getFirmwareUpdateField = (
   }
 
   if (deviceType === 'classic' || deviceType === 'mini') {
-    return 'firmware-v3';
+    return 'firmware-v4';
   }
 
   if (deviceType === 'touch') {
     if (semver.lt(deviceFirmwareVersion.join('.'), '3.4.0')) return 'firmware';
-    return 'firmware-v3';
+    return 'firmware-v4';
   }
   return 'firmware';
 };