@onekeyfe/hd-transport 1.2.0-alpha.7 → 1.2.0-alpha.9

package/messages-protocol-v2.json

@@ -107,8 +107,6 @@
         "MessageType_FirmwareHash": 89,
         "MessageType_UnlockPath": 93,
         "MessageType_UnlockedPathRequest": 94,
-        "MessageType_UnLockDevice": 10030,
-        "MessageType_UnLockDeviceResponse": 10031,
         "MessageType_SetU2FCounter": 63,
         "MessageType_GetNextU2FCounter": 80,
         "MessageType_NextU2FCounter": 81,
@@ -197,6 +195,7 @@
         "MessageType_EthereumGnosisSafeTxAck": 20118,
         "MessageType_EthereumGnosisSafeTxRequest": 20119,
         "MessageType_EthereumSignTxEIP7702OneKey": 20120,
+        "MessageType_EthereumSignTypedDataQR": 20121,
         "MessageType_NEMGetAddress": 67,
         "MessageType_NEMAddress": 68,
         "MessageType_NEMSignTx": 69,
@@ -454,6 +453,8 @@
         "MessageType_UiviewConfirmTxRequest": 30202,
         "MessageType_UiviewConfirmSignMessageRequest": 30203,
         "MessageType_UiviewResponse": 30204,
+        "MessageType_UnLockDevice": 10030,
+        "MessageType_UnLockDeviceResponse": 10031,
         "MessageType_DeviceFactoryInfoSet": 60000,
         "MessageType_DeviceFactoryInfoGet": 60001,
         "MessageType_DeviceFactoryInfo": 60002,
@@ -478,6 +479,12 @@
         "MessageType_Wallpaper": 60432,
         "MessageType_DeviceInfoGet": 60600,
         "MessageType_DeviceInfo": 60601,
+        "MessageType_DeviceStatusGet": 60602,
+        "MessageType_DeviceStatus": 60603,
+        "MessageType_DevGetOnboardingStatus": 60604,
+        "MessageType_DevOnboardingStatus": 60605,
+        "MessageType_DeviceSessionGet": 60606,
+        "MessageType_DeviceSession": 60607,
         "MessageType_FilesystemPermissionFix": 60800,
         "MessageType_FilesystemPathInfo": 60801,
         "MessageType_FilesystemPathInfoQuery": 60802,
@@ -492,7 +499,8 @@
         "MessageType_FilesystemFormat": 60811,
         "MessageType_DeviceFirmwareUpdateRequest": 61000,
         "MessageType_DeviceFirmwareUpdateStatusGet": 61001,
-        "MessageType_DeviceFirmwareUpdateStatus": 61002
+        "MessageType_DeviceFirmwareUpdateStatus": 61002,
+        "MessageType_PortfolioUpdate": 61200
       },
       "reserved": [
         [90, 92],
@@ -5395,6 +5403,37 @@
         }
       }
     },
+    "EthereumSignTypedDataQR": {
+      "fields": {
+        "address_n": {
+          "rule": "repeated",
+          "type": "uint32",
+          "id": 1,
+          "options": {
+            "packed": false
+          }
+        },
+        "json_data": {
+          "type": "bytes",
+          "id": 2
+        },
+        "chain_id": {
+          "type": "uint64",
+          "id": 3
+        },
+        "metamask_v4_compat": {
+          "type": "bool",
+          "id": 4,
+          "options": {
+            "default": true
+          }
+        },
+        "request_id": {
+          "type": "bytes",
+          "id": 5
+        }
+      }
+    },
     "EthereumGetPublicKeyOneKey": {
       "fields": {
         "address_n": {
@@ -11120,6 +11159,26 @@
         }
       }
     },
+    "ViewRawData": {
+      "fields": {
+        "initial_data": {
+          "rule": "required",
+          "type": "string",
+          "id": 1
+        },
+        "placeholder": {
+          "rule": "required",
+          "type": "uint32",
+          "id": 2
+        }
+      }
+    },
+    "ViewSignLayout": {
+      "values": {
+        "LayoutDefault": 0,
+        "LayoutSafeTxCreate": 1
+      }
+    },
     "ViewSignPage": {
       "fields": {
         "title": {
@@ -11139,6 +11198,24 @@
         "tip": {
           "type": "ViewTip",
           "id": 4
+        },
+        "raw_data": {
+          "type": "ViewRawData",
+          "id": 5
+        },
+        "slide_to_confirm": {
+          "type": "bool",
+          "id": 6,
+          "options": {
+            "default": true
+          }
+        },
+        "layout": {
+          "type": "ViewSignLayout",
+          "id": 7,
+          "options": {
+            "default": "LayoutDefault"
+          }
         }
       }
     },
@@ -11892,6 +11969,46 @@
         }
       }
     },
+    "DeviceStatusGet": {
+      "fields": {}
+    },
+    "DevOnboardingStage": {
+      "values": {
+        "DEV_ONBOARDING_STAGE_UNKNOWN": 0,
+        "DEV_ONBOARDING_STAGE_SAFETY_CHECK": 1,
+        "DEV_ONBOARDING_STAGE_PERSONALIZATION": 2,
+        "DEV_ONBOARDING_STAGE_SELECT_SETUP_METHOD": 3,
+        "DEV_ONBOARDING_STAGE_NEW_DEVICE": 4,
+        "DEV_ONBOARDING_STAGE_SELECT_RESTORE_METHOD": 5,
+        "DEV_ONBOARDING_STAGE_RESTORE_MNEMONIC": 6,
+        "DEV_ONBOARDING_STAGE_RESTORE_SEEDCARD": 7,
+        "DEV_ONBOARDING_STAGE_WALLET_READY": 8,
+        "DEV_ONBOARDING_STAGE_SEEDCARD_BACKUP_PROMPT": 9,
+        "DEV_ONBOARDING_STAGE_SELECT_SEEDCARD_BACKUP_METHOD": 10,
+        "DEV_ONBOARDING_STAGE_SEEDCARD_BACKUP": 11,
+        "DEV_ONBOARDING_STAGE_DONE": 12
+      }
+    },
+    "DevGetOnboardingStatus": {
+      "fields": {}
+    },
+    "DevOnboardingStatus": {
+      "fields": {
+        "stage": {
+          "rule": "required",
+          "type": "DevOnboardingStage",
+          "id": 1
+        },
+        "status_code": {
+          "type": "uint32",
+          "id": 2
+        },
+        "detail_code": {
+          "type": "uint32",
+          "id": 3
+        }
+      }
+    },
     "FilesystemPermissionFix": {
       "fields": {}
     },
@@ -12105,6 +12222,20 @@
       }
     },
     "FilesystemFormat": {
+      "fields": {
+        "data": {
+          "rule": "required",
+          "type": "bool",
+          "id": 1
+        },
+        "user": {
+          "rule": "required",
+          "type": "bool",
+          "id": 2
+        }
+      }
+    },
+    "PortfolioUpdate": {
       "fields": {}
     },
     "google": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@onekeyfe/hd-transport",
-  "version": "1.2.0-alpha.7",
+  "version": "1.2.0-alpha.9",
   "description": "Transport layer abstractions and utilities for OneKey hardware SDK.",
   "author": "OneKey",
   "homepage": "https://github.com/OneKeyHQ/hardware-js-sdk#readme",
@@ -28,5 +28,5 @@
     "long": "^4.0.0",
     "protobufjs": "^6.11.2"
   },
-  "gitHead": "001372047f518aaeed5fcbe87b990b8b619a9a65"
+  "gitHead": "f90ef9921b742f68cce9f4e7a0425e45e8ae7ec9"
 }

package/scripts/protobuf-build.sh

@@ -167,6 +167,37 @@ const removeTopLevelMessage = (source, name) => {
   throw new Error(`Unterminated message block: ${name}`);
 };
 
+const restoreTemporaryMessageType = (name, id) => {
+  const activePattern = new RegExp(
+    `^\\s*MessageType_${name}\\s*=\\s*(\\d+)\\b[^;]*;`,
+    'gm'
+  );
+  const activeMatches = Array.from(proto.matchAll(activePattern));
+  if (activeMatches.length > 1) {
+    throw new Error(`Protocol V2 schema defines MessageType_${name} more than once`);
+  }
+  if (activeMatches.length === 1) {
+    if (Number(activeMatches[0][1]) !== id) {
+      throw new Error(
+        `Protocol V2 schema defines MessageType_${name} with id ${activeMatches[0][1]}, expected ${id}`
+      );
+    }
+    return;
+  }
+
+  const commentedPattern = new RegExp(
+    `^(\\s*)//\\s*(MessageType_${name}\\s*=\\s*${id}\\b[^;]*;)`,
+    'gm'
+  );
+  const commentedMatches = Array.from(proto.matchAll(commentedPattern));
+  if (commentedMatches.length !== 1) {
+    throw new Error(
+      `Protocol V2 schema must contain exactly one commented MessageType_${name} = ${id}`
+    );
+  }
+  proto = proto.replace(commentedPattern, '$1$2');
+};
+
 [
   'Initialize',
   'GetFeatures',
@@ -175,6 +206,12 @@ const removeTopLevelMessage = (source, name) => {
 ].forEach(name => {
   proto = removeTopLevelMessage(proto, name);
 });
+
+// firmware-pro2 暂时注释了旧的解锁入口，但 SDK/app 仍需使用原协议 ID。
+// 只恢复 UnLockDevice，不恢复已由 DeviceSessionGet 取代的 passphrase 消息 ID。
+restoreTemporaryMessageType('UnLockDevice', 10030);
+restoreTemporaryMessageType('UnLockDeviceResponse', 10031);
+
 fs.writeFileSync(protoPath, proto);
 
 const messageNames = new Set(
@@ -199,6 +236,14 @@ const requiredMessages = [
   'DeviceReboot',
   'DeviceInfoGet',
   'DeviceInfo',
+  'DeviceStatusGet',
+  'DeviceStatus',
+  'DevGetOnboardingStatus',
+  'DevOnboardingStatus',
+  'DeviceSessionGet',
+  'DeviceSession',
+  'UnLockDevice',
+  'UnLockDeviceResponse',
   'DeviceFirmwareUpdateRequest',
   'DeviceFirmwareUpdateStatusGet',
   'DeviceFirmwareUpdateStatus',
@@ -214,6 +259,7 @@ const requiredMessages = [
   'FilesystemDirMake',
   'FilesystemDirRemove',
   'FilesystemFormat',
+  'PortfolioUpdate',
 ];
 const missingMessages = requiredMessages.filter(name => !messageNames.has(name));
 const missingMessageTypes = requiredMessages.filter(name => !messageTypeNames.has(name));

package/src/constants.ts

@@ -29,6 +29,12 @@ export const PROTOCOL_V2_WEBUSB_FILE_CHUNK_SIZE = 4000;
 /** BLE 下 FilesystemFileWrite 的文件数据分块大小。 */
 export const PROTOCOL_V2_BLE_FILE_CHUNK_SIZE = 1800;
 
+/** BLE 下 FilesystemFileRead 的文件数据分块大小，受 Pro2 UART 1024B TX 缓冲限制。 */
+export const PROTOCOL_V2_BLE_FILE_READ_CHUNK_SIZE = 900;
+
+/** Pro2 BLE/UART 接收 FIFO 必须容纳完整 Proto Link 帧。 */
+export const PROTOCOL_V2_BLE_FRAME_MAX_BYTES = 2048;
+
 /** @deprecated 使用按传输区分的 PROTOCOL_V2_WEBUSB_FILE_CHUNK_SIZE / PROTOCOL_V2_BLE_FILE_CHUNK_SIZE。 */
 export const PROTOCOL_V2_FILE_CHUNK_SIZE = PROTOCOL_V2_WEBUSB_FILE_CHUNK_SIZE;
 

package/src/index.ts

@@ -10,8 +10,11 @@ import {
 } from './serialization';
 import { PROTOCOL_V2_SYS_MESSAGE_THRESHOLD, ProtocolV1, ProtocolV2 } from './protocols';
 import * as protocolV2Codec from './protocols/v2';
+import { ProtocolV2LinkManager } from './protocols/v2/link-manager';
+import { ProtocolV2UsbTransportBase } from './protocols/v2/usb-transport-base';
 import {
   ProtocolV2FrameAssembler,
+  ProtocolV2SequenceCursor,
   ProtocolV2Session,
   bytesToHex,
   concatUint8Arrays,
@@ -49,6 +52,8 @@ export * from './protocols';
 export * as protocolV1 from './protocols/v1';
 export * as protocolV2 from './protocols/v2';
 export * from './protocols/v2/session';
+export * from './protocols/v2/link-manager';
+export * from './protocols/v2/usb-transport-base';
 
 export default {
   check,
@@ -58,7 +63,10 @@ export default {
   ProtocolV2,
   PROTOCOL_V2_SYS_MESSAGE_THRESHOLD,
   ProtocolV2FrameAssembler,
+  ProtocolV2LinkManager,
+  ProtocolV2SequenceCursor,
   ProtocolV2Session,
+  ProtocolV2UsbTransportBase,
   bytesToHex,
   concatUint8Arrays,
   createMessageFromName,

package/src/protocols/index.ts

@@ -6,7 +6,7 @@ import { decodeMessage as decodeV1Message } from './v1/receive';
 import { createMessageFromName, createMessageFromType } from '../serialization/protobuf/messages';
 import { encode as encodeProtobuf } from '../serialization/protobuf/encode';
 import { decode as decodeProtobuf } from '../serialization/protobuf/decode';
-import { decodeFrame as decodeV2Frame, encodeProtobufFrame } from './v2';
+import { decodeFrame as decodeV2Frame, encodeProtobufFrame, isAckFrame } from './v2';
 
 import type { Root } from 'protobufjs/light';
 import type { ProtocolV2DebugLogger } from './v2';
@@ -74,6 +74,8 @@ export const ProtocolV1 = {
 };
 
 export const ProtocolV2 = {
+  isAckFrame,
+
   encodeFrame(
     schemas: ProtocolV2Schemas,
     name: string,

package/src/protocols/v2/constants.ts

@@ -4,3 +4,4 @@ export const PROTO_HEAD_CRC_SIZE = 8;
 export const CRC8_INIT = 0x30;
 export const PACKET_SIZE = 4096;
 export const PROTO_DATA_TYPE_PACKET = 0;
+export const PROTO_DATA_TYPE_ACK = 1;

package/src/protocols/v2/decode.ts

@@ -1,4 +1,4 @@
-import { PROTO_HEAD_CRC_SIZE, PROTO_HEAD_SOF } from './constants';
+import { PROTO_DATA_TYPE_ACK, PROTO_HEAD_CRC_SIZE, PROTO_HEAD_SOF } from './constants';
 import { crc8 } from './crc8';
 import { logProtocolV2Debug } from './debug';
 
@@ -13,20 +13,7 @@ export interface ProtoV2Frame {
   seq: number;
 }
 
-/**
- * Parse and validate a Protocol V2 response frame.
- *
- * Validates:
- *   - SOF byte (0x5A)
- *   - Header CRC (bytes 0-2)
- *   - Frame CRC (full frame except last byte)
- *
- * Returns the decoded messageTypeId, raw protobuf payload, and sequence number.
- */
-export function decodeFrame(
-  data: Uint8Array,
-  debugOptions?: ProtocolV2FrameDebugOptions
-): ProtoV2Frame {
+function validateFrame(data: Uint8Array): number {
   if (data.length < PROTO_HEAD_CRC_SIZE) {
     throw new Error(`Protocol V2 frame too short: ${data.length} bytes`);
   }
@@ -43,7 +30,6 @@ export function decodeFrame(
     throw new Error(`Frame truncated: expected ${frameLen} bytes, got ${data.length}`);
   }
 
-  // Verify pre-header CRC (bytes 0-2)
   const expectedHeaderCrc = crc8(data, 3);
   if (data[3] !== expectedHeaderCrc) {
     throw new Error(
@@ -53,7 +39,6 @@ export function decodeFrame(
     );
   }
 
-  // Verify frame CRC (all bytes except last)
   const expectedFrameCrc = crc8(data, frameLen - 1);
   if (data[frameLen - 1] !== expectedFrameCrc) {
     throw new Error(
@@ -63,6 +48,40 @@ export function decodeFrame(
     );
   }
 
+  return frameLen;
+}
+
+export function isAckFrame(data: Uint8Array): boolean {
+  // eslint-disable-next-line no-bitwise
+  if (data.length < 6 || (data[5] & 0x03) !== PROTO_DATA_TYPE_ACK) {
+    return false;
+  }
+
+  const frameLen = validateFrame(data);
+  if (frameLen !== PROTO_HEAD_CRC_SIZE) {
+    throw new Error(`Invalid Protocol V2 ACK frame length: ${frameLen}`);
+  }
+  return true;
+}
+
+/**
+ * Parse and validate a Protocol V2 response frame.
+ *
+ * Validates:
+ *   - SOF byte (0x5A)
+ *   - Header CRC (bytes 0-2)
+ *   - Frame CRC (full frame except last byte)
+ *
+ * Returns the decoded messageTypeId, raw protobuf payload, and sequence number.
+ */
+export function decodeFrame(
+  data: Uint8Array,
+  debugOptions?: ProtocolV2FrameDebugOptions
+): ProtoV2Frame {
+  const frameLen = validateFrame(data);
+  const expectedHeaderCrc = data[3];
+  const expectedFrameCrc = data[frameLen - 1];
+
   const seq = data[6];
   // Payload spans bytes 7 to frameLen-2 (inclusive), excluding final CRC byte
   const payloadData = data.slice(7, frameLen - 1);

package/src/protocols/v2/link-manager.ts

@@ -0,0 +1,160 @@
+import { ProtocolV2SequenceCursor } from './sequence-cursor';
+import { ProtocolV2Session, getErrorMessage } from './session';
+
+import type { MessageFromOneKey, TransportCallOptions } from '../../types';
+import type { ProtocolV2CallContext, ProtocolV2Schemas, ProtocolV2SessionOptions } from './session';
+
+export type ProtocolV2LinkErrorClassification = 'link-fatal' | 'recoverable';
+
+export interface ProtocolV2LinkAdapter {
+  router: number;
+  maxFrameBytes?: number;
+  generation: number;
+  prepareCall(context: ProtocolV2CallContext): Promise<void> | void;
+  writeFrame(frame: Uint8Array, context: ProtocolV2CallContext): Promise<void>;
+  readFrame(context: ProtocolV2CallContext): Promise<Uint8Array>;
+  reset(reason: string): Promise<void> | void;
+  logger?: ProtocolV2SessionOptions['logger'];
+  logPrefix?: string;
+  createTimeoutError?: ProtocolV2SessionOptions['createTimeoutError'];
+}
+
+export type ProtocolV2LinkManagerOptions<Key> = {
+  getSchemas: () => ProtocolV2Schemas;
+  classifyError: (error: unknown) => ProtocolV2LinkErrorClassification;
+  onLinkInvalidated?: (key: Key, reason: string) => Promise<void> | void;
+};
+
+type ProtocolV2Link = {
+  adapter: ProtocolV2LinkAdapter;
+  session: ProtocolV2Session;
+  state: {
+    invalidatedReason?: string;
+  };
+};
+
+export class ProtocolV2LinkManager<Key> {
+  private readonly links = new Map<Key, ProtocolV2Link>();
+
+  private readonly sequences = new Map<Key, ProtocolV2SequenceCursor>();
+
+  private readonly callQueues = new Map<Key, Promise<unknown>>();
+
+  private readonly options: ProtocolV2LinkManagerOptions<Key>;
+
+  constructor(options: ProtocolV2LinkManagerOptions<Key>) {
+    this.options = options;
+  }
+
+  call(
+    key: Key,
+    createAdapter: () => ProtocolV2LinkAdapter,
+    name: string,
+    data: Record<string, unknown>,
+    options?: TransportCallOptions
+  ): Promise<MessageFromOneKey> {
+    const run = () => this.executeCall(key, createAdapter, name, data, options);
+    const previous = this.callQueues.get(key) ?? Promise.resolve();
+    const result = previous.then(run, run);
+    const queue = result.catch(() => undefined);
+    this.callQueues.set(key, queue);
+    result
+      .then(
+        () => this.clearSettledCallQueue(key, queue),
+        () => this.clearSettledCallQueue(key, queue)
+      )
+      .catch(() => undefined);
+    return result;
+  }
+
+  async invalidateLink(key: Key, reason: string): Promise<void> {
+    const link = this.links.get(key);
+    if (!link) return;
+
+    this.links.delete(key);
+    link.state.invalidatedReason = reason;
+    await link.adapter.reset(reason);
+    await this.options.onLinkInvalidated?.(key, reason);
+  }
+
+  async invalidateAllLinks(reason: string): Promise<void> {
+    await Promise.all(Array.from(this.links.keys(), key => this.invalidateLink(key, reason)));
+  }
+
+  async dispose(reason: string): Promise<void> {
+    await this.invalidateAllLinks(reason);
+    this.sequences.clear();
+    this.callQueues.clear();
+  }
+
+  private getOrCreateLink(key: Key, createAdapter: () => ProtocolV2LinkAdapter): ProtocolV2Link {
+    const existing = this.links.get(key);
+    if (existing) return existing;
+
+    const adapter = createAdapter();
+    const state: ProtocolV2Link['state'] = {};
+    const assertLinkActive = () => {
+      if (state.invalidatedReason) {
+        throw new Error(state.invalidatedReason);
+      }
+    };
+    let sequenceCursor = this.sequences.get(key);
+    if (!sequenceCursor) {
+      sequenceCursor = new ProtocolV2SequenceCursor();
+      this.sequences.set(key, sequenceCursor);
+    }
+    const session = new ProtocolV2Session({
+      schemas: this.options.getSchemas(),
+      router: adapter.router,
+      maxFrameBytes: adapter.maxFrameBytes,
+      generation: adapter.generation,
+      sequenceCursor,
+      prepareCall: async context => {
+        assertLinkActive();
+        await adapter.prepareCall(context);
+        assertLinkActive();
+      },
+      writeFrame: async (frame, context) => {
+        assertLinkActive();
+        await adapter.writeFrame(frame, context);
+        assertLinkActive();
+      },
+      readFrame: async context => {
+        assertLinkActive();
+        const frame = await adapter.readFrame(context);
+        assertLinkActive();
+        return frame;
+      },
+      logger: adapter.logger,
+      logPrefix: adapter.logPrefix,
+      createTimeoutError: adapter.createTimeoutError,
+    });
+    const link = { adapter, session, state };
+    this.links.set(key, link);
+    return link;
+  }
+
+  private async executeCall(
+    key: Key,
+    createAdapter: () => ProtocolV2LinkAdapter,
+    name: string,
+    data: Record<string, unknown>,
+    options?: TransportCallOptions
+  ): Promise<MessageFromOneKey> {
+    try {
+      return await this.getOrCreateLink(key, createAdapter).session.call(name, data, options);
+    } catch (error) {
+      if (this.options.classifyError(error) === 'link-fatal') {
+        const errorMessage = getErrorMessage(error) || 'unknown error';
+        await this.invalidateLink(key, `Protocol V2 link-fatal error: ${errorMessage}`);
+      }
+      throw error;
+    }
+  }
+
+  private clearSettledCallQueue(key: Key, queue: Promise<unknown>) {
+    if (this.callQueues.get(key) === queue) {
+      this.callQueues.delete(key);
+    }
+  }
+}

package/src/protocols/v2/sequence-cursor.ts

@@ -0,0 +1,10 @@
+import { nextProtoSeq } from './encode';
+
+export class ProtocolV2SequenceCursor {
+  private current = 0;
+
+  next(): number {
+    this.current = nextProtoSeq(this.current);
+    return this.current;
+  }
+}