@onekeyfe/hd-transport 1.2.0-alpha.2 → 1.2.0-alpha.21

package/src/protocols/index.ts

@@ -6,10 +6,9 @@ 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';
 
 export const PROTOCOL_V2_SYS_MESSAGE_THRESHOLD = 60000;
 
@@ -23,9 +22,6 @@ type ProtocolV2FrameOptions = {
   router?: number;
   /** Sequence number (1-255). Managed per-session by ProtocolV2Session. */
   seq?: number;
-  logger?: ProtocolV2DebugLogger;
-  logPrefix?: string;
-  context?: string;
 };
 
 const resolveProtocolV2EncodeSchema = (name: string, schemas: ProtocolV2Schemas) => {
@@ -38,6 +34,7 @@ const resolveProtocolV2EncodeSchema = (name: string, schemas: ProtocolV2Schemas)
 };
 
 const PROTOCOL_V2_LEGACY_DECODE_ALLOWLIST = new Set([
+  'Failure',
   'ButtonRequest',
   'EntropyRequest',
   'PinMatrixRequest',
@@ -73,6 +70,20 @@ export const ProtocolV1 = {
 };
 
 export const ProtocolV2 = {
+  isAckFrame,
+
+  inspectFrame(schemas: ProtocolV2Schemas, frame: Uint8Array) {
+    const { messageTypeId, pbPayload, seq } = decodeV2Frame(frame);
+    const { messageName } = createProtocolV2MessageFromType(messageTypeId, schemas);
+    return {
+      messageName,
+      messageTypeId,
+      pbPayload,
+      seq,
+      type: messageName,
+    };
+  },
+
   encodeFrame(
     schemas: ProtocolV2Schemas,
     name: string,
@@ -86,51 +97,31 @@ export const ProtocolV2 = {
     const rawPbBuffer = pbBuffer.toBuffer() as unknown as ArrayBuffer;
     const pbBytes = new Uint8Array(rawPbBuffer);
 
-    options.logger?.debug?.(`[${options.logPrefix ?? 'ProtocolV2'}] encode protobuf`, {
-      context: options.context ?? `encode:${name}`,
-      messageName: name,
-      messageTypeId,
-      pbPayloadLength: pbBytes.length,
-      packetSrc: options.packetSrc ?? 0,
-      router: options.router ?? 0,
-    });
-
     return encodeProtobufFrame(
       messageTypeId,
       pbBytes,
       options.packetSrc,
       options.router,
-      {
-        logger: options.logger,
-        logPrefix: options.logPrefix,
-        context: options.context ?? `encode:${name}`,
-        messageName: name,
-      },
       options.seq
     );
   },
 
-  decodeFrame(
-    schemas: ProtocolV2Schemas,
-    frame: Uint8Array,
-    options: Pick<ProtocolV2FrameOptions, 'logger' | 'logPrefix' | 'context'> = {}
-  ) {
-    const { messageTypeId, pbPayload, seq } = decodeV2Frame(frame, {
-      logger: options.logger,
-      logPrefix: options.logPrefix,
-      context: options.context ?? 'decode',
-    });
-    const { Message, messageName } = createProtocolV2MessageFromType(messageTypeId, schemas);
+  decodeFrame(schemas: ProtocolV2Schemas, frame: Uint8Array) {
+    const { messageTypeId, pbPayload, seq, messageName } = this.inspectFrame(schemas, frame);
+    const { Message } = createProtocolV2MessageFromType(messageTypeId, schemas);
     const rxByteBuffer = ByteBuffer.wrap(Buffer.from(pbPayload) as unknown as ArrayBuffer);
-    const message = decodeProtobuf(Message, rxByteBuffer);
-
-    options.logger?.debug?.(`[${options.logPrefix ?? 'ProtocolV2'}] decode protobuf`, {
-      context: options.context ?? `decode:${messageName}`,
-      messageName,
-      messageTypeId,
-      pbPayloadLength: pbPayload.length,
-      seq,
-    });
+    let message: ReturnType<typeof decodeProtobuf>;
+    try {
+      message = decodeProtobuf(Message, rxByteBuffer);
+    } catch (cause) {
+      const error = new Error(
+        `Protocol V2 protobuf decode failed for "${messageName}" ` +
+          `(${messageTypeId}, ${pbPayload.length}-byte payload); ` +
+          'the payload is malformed or incompatible with the active SDK schema.'
+      );
+      (error as Error & { cause?: unknown }).cause = cause;
+      throw error;
+    }
 
     return {
       message,

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/crc8.ts

@@ -22,7 +22,7 @@ export const CRC8_TABLE = new Uint8Array([
 ]);
 
 /**
- * 计算 data 前 len 个字节的 CRC-8，使用与固件侧一致的初始值。
+ * Compute CRC-8 over the first len bytes using the firmware-compatible initial value.
  */
 export function crc8(data: Uint8Array, len: number): number {
   let crc = CRC8_INIT;

package/src/protocols/v2/decode.ts

@@ -1,8 +1,5 @@
-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';
-
-import type { ProtocolV2FrameDebugOptions } from './debug';
 
 export interface ProtoV2Frame {
   /** Little-endian message type ID */
@@ -13,20 +10,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 +27,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 +36,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 +45,35 @@ 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): ProtoV2Frame {
+  const frameLen = validateFrame(data);
+
   const seq = data[6];
   // Payload spans bytes 7 to frameLen-2 (inclusive), excluding final CRC byte
   const payloadData = data.slice(7, frameLen - 1);
@@ -74,19 +85,5 @@ export function decodeFrame(
   const messageTypeId = payloadData[0] + payloadData[1] * 256;
   const pbPayload = payloadData.slice(2);
 
-  logProtocolV2Debug(debugOptions, 'decode raw frame', {
-    frameLen,
-    dataLength: data.length,
-    router: data[4],
-    attr: data[5],
-    seq,
-    headerCrc: data[3],
-    expectedHeaderCrc,
-    frameCrc: data[frameLen - 1],
-    expectedFrameCrc,
-    messageTypeId,
-    pbPayloadLength: pbPayload.length,
-  });
-
   return { messageTypeId, pbPayload, seq };
 }

package/src/protocols/v2/encode.ts

@@ -1,10 +1,7 @@
 import { PROTO_DATA_TYPE_PACKET, PROTO_HEAD_CRC_SIZE, PROTO_HEAD_SOF } from './constants';
 import { crc8 } from './crc8';
-import { logProtocolV2Debug } from './debug';
 import { PROTOCOL_V2_FRAME_MAX_BYTES } from '../../constants';
 
-import type { ProtocolV2FrameDebugOptions } from './debug';
-
 // Default sequence number when callers do not manage one themselves.
 // Stateful per-session sequencing lives in ProtocolV2Session (session.ts),
 // which advances the counter via nextProtoSeq() and passes it in explicitly.
@@ -35,7 +32,6 @@ export function encodeFrame(
   payload: Uint8Array | null,
   packetSrc?: number,
   router?: number,
-  debugOptions?: ProtocolV2FrameDebugOptions,
   seq?: number
 ): Uint8Array {
   const resolvedPacketSrc = packetSrc ?? 0;
@@ -47,7 +43,7 @@ export function encodeFrame(
   const payloadLen = payload ? payload.length : 0;
   const frameLen = payloadLen + PROTO_HEAD_CRC_SIZE;
   if (frameLen > PROTOCOL_V2_FRAME_MAX_BYTES) {
-    throw new Error(`Protocol V2 frame too large: ${frameLen}`);
+    throw new Error(`Protocol V2 frame too large: ${frameLen} > ${PROTOCOL_V2_FRAME_MAX_BYTES}`);
   }
   const frame = new Uint8Array(frameLen);
 
@@ -69,17 +65,6 @@ export function encodeFrame(
   // CRC8 over entire frame except last byte
   frame[frameLen - 1] = crc8(frame, frameLen - 1);
 
-  logProtocolV2Debug(debugOptions, 'encode raw frame', {
-    frameLen,
-    payloadLen,
-    packetSrc: resolvedPacketSrc,
-    router: frame[4],
-    attr: frame[5],
-    seq: frame[6],
-    headerCrc: frame[3],
-    frameCrc: frame[frameLen - 1],
-  });
-
   return frame;
 }
 
@@ -95,22 +80,11 @@ export function encodeProtobufFrame(
   pbPayload: Uint8Array,
   packetSrc?: number,
   router?: number,
-  debugOptions?: ProtocolV2FrameDebugOptions,
   seq?: number
 ): Uint8Array {
   const payload = new Uint8Array(2 + pbPayload.length);
   payload[0] = messageTypeId % 256;
   payload[1] = Math.floor(messageTypeId / 256) % 256;
   payload.set(pbPayload, 2);
-  return encodeFrame(
-    payload,
-    packetSrc,
-    router,
-    {
-      ...debugOptions,
-      messageTypeId,
-      pbPayloadLength: pbPayload.length,
-    },
-    seq
-  );
+  return encodeFrame(payload, packetSrc, router, seq);
 }

package/src/protocols/v2/index.ts

@@ -1,6 +1,5 @@
 export * from './constants';
 export * from './crc8';
-export * from './debug';
 export * from './encode';
 export * from './decode';
 export * from './frame-assembler';

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