@onekeyfe/hd-transport 1.2.0-alpha.11 → 1.2.0-alpha.13

package/scripts/protobuf-build.sh

@@ -5,14 +5,10 @@ set -euxo pipefail
 echo $#
 
 PARENT_PATH=$( cd "$(dirname "${BASH_SOURCE[0]}")" ; pwd -P )
-PACKAGE_ROOT="$PARENT_PATH/.."
 
 SRC="../../submodules/firmware/common/protob"
 DIST="."
 LANG="typescript"
-# Absolute paths — resolved relative to this script's directory
-REPO_ROOT="$PARENT_PATH/../../.."
-CORE_MESSAGES_DIR="$REPO_ROOT/packages/core/src/data/messages"
 
 if [[ $# -ne 0 && $# -ne 3 ]]
     then
@@ -33,238 +29,30 @@ if [[ "$LANG" != "typescript" && "$LANG" != "flow" ]];
         exit 1
 fi
 
-if [[ "$SRC" = /* ]]; then
-    SRC_PATH="$SRC"
-else
-    SRC_PATH="$PACKAGE_ROOT/$SRC"
-fi
-
-if [[ "$DIST" = /* ]]; then
-    DIST_PATH="$DIST"
-else
-    DIST_PATH="$PACKAGE_ROOT/$DIST"
-fi
-
-# Remove temp proto files on any exit, including failure paths
-trap 'rm -f "$DIST_PATH/messages-tmp.proto" "$PARENT_PATH/messages-protocol-v2-tmp.proto"' EXIT
-
-
-# ============================================================
-# BUILD Pro1 messages.json  (requires firmware submodule)
-# ============================================================
-# Combines all messages*.proto files from firmware submodule into
-# messages.json, then copies to core package.
-if [ -d "$SRC_PATH" ] && ls "$SRC_PATH"/messages*.proto 1>/dev/null 2>&1; then
-    echo "=== Building Pro1 (legacy) protobuf messages ==="
-    TMP_PROTO="$DIST_PATH/messages-tmp.proto"
-    echo 'syntax = "proto2";' > "$TMP_PROTO"
-    echo 'import "google/protobuf/descriptor.proto";' >> "$TMP_PROTO"
-    echo "Build proto file from $SRC_PATH"
-    grep -hv -e '^import ' -e '^syntax' -e '^package' -e 'option java_' "$SRC_PATH"/messages*.proto \
-    | sed 's/ hw\.trezor\.messages\.common\./ /' \
-    | sed 's/ common\./ /' \
-    | sed 's/ ethereum_definitions\./ /' \
-    | sed 's/ management\./ /' \
-    | sed 's/^option /\/\/ option /' \
-    | grep -v '    reserved '>> "$TMP_PROTO"
-
-    npx pbjs -t json -p "$DIST_PATH" -o "$DIST_PATH/messages.json" --keep-case "$TMP_PROTO"
-    rm "$TMP_PROTO"
 
-    # Copy to core package
-    cp "$DIST_PATH/messages.json" "$CORE_MESSAGES_DIR/messages.json"
-    echo "Pro1 messages.json copied to core"
+# BUILD combined messages.proto file from protobuf files
+# this code was copied from ./submodules/firmware/protob Makekile
+# clear protobuf syntax and remove unknown values to be able to work with proto2js
+echo 'syntax = "proto2";' > $DIST/messages.proto
+echo 'import "google/protobuf/descriptor.proto";' >> $DIST/messages.proto
+echo "Build proto file from $SRC"
+grep -hv -e '^import ' -e '^syntax' -e '^package' -e 'option java_' $SRC/messages*.proto \
+| sed 's/ hw\.trezor\.messages\.common\./ /' \
+| sed 's/ common\./ /' \
+| sed 's/ ethereum_definitions\./ /' \
+| sed 's/ management\./ /' \
+| sed 's/^option /\/\/ option /' \
+| grep -v '    reserved '>> $DIST/messages.proto
 
-    yarn --cwd "$PACKAGE_ROOT" prettier --write "$DIST_PATH/messages.json"
-    yarn --cwd "$PACKAGE_ROOT" prettier --write "$CORE_MESSAGES_DIR/messages.json"
-    # Type generation (protobuf-types.js) runs once at the end of the Protocol V2
-    # section below, after both schemas are available.
-else
-    # Intentional asymmetry with the Protocol V2 section below: the legacy firmware
-    # submodule is optional (the committed messages.json stays in use when it is
-    # absent), while firmware-pro2 is the only source of the Protocol V2 schema,
-    # so its absence is a hard error (exit 1).
-    echo "⚠️  firmware submodule not found at $SRC_PATH"
-    echo "    Skipping Pro1 protobuf build. To enable:"
-    echo "    git submodule update --init submodules/firmware"
-fi
+# BUILD messages.json from message.proto
+npx pbjs -t json -p $DIST -o $DIST/messages.json --keep-case messages.proto
+rm $DIST/messages.proto
 
+echo "generating type definitions for: $LANG"
 
-# ============================================================
-# BUILD Protocol V2 messages-protocol-v2.json
-# ============================================================
-# Source of truth: submodules/firmware-pro2/sys/protobuf/onekey_protocol/.
-# Protocol V2 keeps chain/app protocols under legacy/ and system protocols under latest/.
-# The SDK flattens them into one protobuf schema for transport runtime, but it must keep
-# firmware message names and enum values intact. SDK-facing aliases belong in core/API code,
-# not in the protobuf schema.
-# ============================================================
 cd "$PARENT_PATH"
 
-SRC_PRO2_LEGACY="$REPO_ROOT/submodules/firmware-pro2/sys/protobuf/onekey_protocol/legacy"
-SRC_PRO2_LATEST="$REPO_ROOT/submodules/firmware-pro2/sys/protobuf/onekey_protocol/latest"
-
-if [ -d "$SRC_PRO2_LATEST" ] && ls "$SRC_PRO2_LATEST"/messages*.proto 1>/dev/null 2>&1; then
-    echo "=== Building Protocol V2 messages from firmware-pro2 legacy + latest protobuf schema ==="
-    TMP_PROTO="$PARENT_PATH/messages-protocol-v2-tmp.proto"
-
-    {
-        echo 'syntax = "proto2";'
-        echo 'import "google/protobuf/descriptor.proto";'
-        echo ''
-
-        # Pro2 firmware keeps chain/app protocols under legacy/, and Protocol V2
-        # device/filesystem/firmware protocols under latest/. Build one flat
-        # schema so Protocol V2 framing can also encode legacy public-chain calls.
-        grep -hv \
-            -e '^import ' -e '^syntax' -e '^package' -e 'option java_' \
-            "$SRC_PRO2_LEGACY"/messages*.proto \
-            | sed 's/ hw\.onekey\.messages\.[a-zA-Z_]*\./ /g' \
-            | sed 's/ crypto\./ /g' \
-            | sed 's/ ethereum_definitions\./ /g' \
-            | sed 's/ management\./ /g' \
-            | sed 's/^option /\/\/ option /' \
-            | grep -v '    reserved '
-
-        echo ''
-        echo '// --- Protocol V2 system messages ---'
-        grep -hv \
-            -e '^import ' -e '^syntax' -e '^package' -e 'option java_' \
-            -e '^option ' \
-            "$SRC_PRO2_LATEST"/messages*.proto \
-            | grep -v '    reserved '
-
-    } > "$TMP_PROTO"
-
-    node - "$TMP_PROTO" <<'NODE'
-const fs = require('fs');
+node ./protobuf-types.js $LANG
 
-const protoPath = process.argv[2];
-let proto = fs.readFileSync(protoPath, 'utf8');
-
-const removeTopLevelMessage = (source, name) => {
-  const pattern = new RegExp(`(^|\\n)message\\s+${name}\\s*\\{`, 'm');
-  const match = pattern.exec(source);
-  if (!match) return source;
-
-  const start = match.index + (match[1] ? match[1].length : 0);
-  let index = start;
-  let depth = 0;
-  while (index < source.length) {
-    const char = source[index];
-    if (char === '{') {
-      depth += 1;
-    } else if (char === '}') {
-      depth -= 1;
-      if (depth === 0) {
-        index += 1;
-        while (index < source.length && /\s/.test(source[index])) index += 1;
-        return `${source.slice(0, start)}${source.slice(index)}`;
-      }
-    }
-    index += 1;
-  }
-  throw new Error(`Unterminated message block: ${name}`);
-};
-
-[
-  'Initialize',
-  'GetFeatures',
-  'OnekeyGetFeatures',
-  'Features',
-].forEach(name => {
-  proto = removeTopLevelMessage(proto, name);
-});
-
-fs.writeFileSync(protoPath, proto);
-
-const messageNames = new Set(
-  Array.from(proto.matchAll(/^\s*message\s+([A-Za-z_][A-Za-z0-9_]*)\s*\{/gm)).map(
-    match => match[1]
-  )
-);
-const messageTypeNames = new Set(
-  Array.from(proto.matchAll(/^\s*MessageType_([A-Za-z_][A-Za-z0-9_]*)\s*=/gm)).map(
-    match => match[1]
-  )
-);
-const requiredMessages = [
-  'DeviceFactoryInfoSet',
-  'DeviceFactoryInfoGet',
-  'DeviceFactoryInfo',
-  'ProtocolInfoRequest',
-  'ProtocolInfo',
-  'Ping',
-  'Success',
-  'Failure',
-  'DeviceReboot',
-  'DeviceInfoGet',
-  'DeviceInfo',
-  'DeviceStatusGet',
-  'DeviceStatus',
-  'DevGetOnboardingStatus',
-  'DevOnboardingStatus',
-  'DeviceSessionGet',
-  'DeviceSession',
-  'DeviceSessionAskPin',
-  'DeviceSessionPinResult',
-  'DeviceFirmwareUpdateRequest',
-  'DeviceFirmwareUpdateStatusGet',
-  'DeviceFirmwareUpdateStatus',
-  'FilesystemPermissionFix',
-  'FilesystemPathInfo',
-  'FilesystemPathInfoQuery',
-  'FilesystemFile',
-  'FilesystemFileRead',
-  'FilesystemFileWrite',
-  'FilesystemFileDelete',
-  'FilesystemDir',
-  'FilesystemDirList',
-  'FilesystemDirMake',
-  'FilesystemDirRemove',
-  'FilesystemFormat',
-  'PortfolioUpdate',
-];
-const missingMessages = requiredMessages.filter(name => !messageNames.has(name));
-const missingMessageTypes = requiredMessages.filter(name => !messageTypeNames.has(name));
-
-if (missingMessages.length > 0 || missingMessageTypes.length > 0) {
-  throw new Error(
-    `Protocol V2 schema missing required entries: messages=[${missingMessages.join(
-      ', '
-    )}], messageTypes=[${missingMessageTypes.join(
-      ', '
-    )}]. Make sure submodules/firmware-pro2 is checked out on branch dev ` +
-      '(origin/dev), which contains the latest Protocol V2 Device*/Filesystem* messages.'
-  );
-}
-
-NODE
-
-    npx pbjs -t json \
-        -p "$PARENT_PATH" \
-        -o "$PARENT_PATH/../messages-protocol-v2.json" \
-        --keep-case \
-        "$(basename "$TMP_PROTO")"
-
-    rm -f "$TMP_PROTO"
-
-    cp "$PARENT_PATH/../messages-protocol-v2.json" "$CORE_MESSAGES_DIR/messages-protocol-v2.json"
-    echo "Protocol V2 messages-protocol-v2.json generated from firmware-pro2 legacy + latest schema and copied to core"
-
-    yarn --cwd "$PACKAGE_ROOT" prettier --write "$PARENT_PATH/../messages-protocol-v2.json"
-    yarn --cwd "$PACKAGE_ROOT" prettier --write "$CORE_MESSAGES_DIR/messages-protocol-v2.json"
-
-    echo "generating type definitions for: $LANG"
-    node ./protobuf-types.js $LANG
-    yarn --cwd "$PACKAGE_ROOT" prettier --write "$PACKAGE_ROOT/src/types/messages.ts"
-    echo "=== Protocol V2 messages build complete ==="
-else
-    # Unlike the optional Pro1 (legacy) section above, the firmware-pro2 submodule is
-    # the only source of the Protocol V2 schema, so a missing checkout is a hard error.
-    echo "firmware-pro2 latest protobuf schema not found at $SRC_PRO2_LATEST"
-    echo "The Protocol V2 schema requires firmware-pro2 on branch dev."
-    echo "Run: git submodule update --init submodules/firmware-pro2"
-    echo "Then: git -C submodules/firmware-pro2 fetch origin dev && git -C submodules/firmware-pro2 checkout origin/dev"
-    exit 1
-fi
+yarn prettier --write messages.json
+yarn prettier --write **/messages.ts

package/scripts/protobuf-types.js

@@ -19,6 +19,10 @@ const optionalJsonFiles = ['../messages-protocol-v2.json'];
 const OPTIONAL_DUPLICATE_TYPE_ALIASES = {
   DeviceInfo: 'ProtocolV2DeviceInfo',
 };
+const OPTIONAL_NESTED_TYPE_ALIASES = [
+  { parent: 'Failure', name: 'FailureType', alias: 'ProtocolV2FailureType' },
+  { parent: 'Features', name: 'Capability', alias: 'ProtocolV2Capability' },
+];
 const messageTypeAliases = {};
 const skipMessageTypeKeys = new Set(Object.values(OPTIONAL_DUPLICATE_TYPE_ALIASES));
 
@@ -59,6 +63,7 @@ const ENUM_KEYS = [
   'ButtonRequestType',
   'PinMatrixRequestType',
   'WordRequestType',
+  'ProtocolV2Capability',
 ];
 
 const parseEnumTypescript = (itemName, item) => {
@@ -317,6 +322,10 @@ optionalJsonFiles.forEach(jsonFile => {
   const jsonPath = path.join(__dirname, jsonFile);
   if (!fs.existsSync(jsonPath)) return;
   const optionalJson = readJson(jsonPath);
+  OPTIONAL_NESTED_TYPE_ALIASES.forEach(({ parent, name, alias }) => {
+    const definition = optionalJson.nested[parent]?.nested?.[name];
+    if (definition) optionalJson.nested[alias] = definition;
+  });
   optionalJsons.push(optionalJson);
   Object.keys(optionalJson.nested).forEach(e => {
     if (!json.nested[e]) return; // V2-only type, parsed after the V1 pass below

package/src/protocols/index.ts

@@ -9,7 +9,6 @@ import { decode as decodeProtobuf } from '../serialization/protobuf/decode';
 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) => {
@@ -76,6 +72,18 @@ 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,
@@ -89,52 +97,21 @@ 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,
-    });
-
     return {
       message,
       messageName,

package/src/protocols/v2/decode.ts

@@ -1,8 +1,5 @@
 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 */
@@ -74,13 +71,8 @@ export function isAckFrame(data: Uint8Array): boolean {
  *
  * Returns the decoded messageTypeId, raw protobuf payload, and sequence number.
  */
-export function decodeFrame(
-  data: Uint8Array,
-  debugOptions?: ProtocolV2FrameDebugOptions
-): ProtoV2Frame {
+export function decodeFrame(data: Uint8Array): 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
@@ -93,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;
@@ -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';