@onekeyfe/hd-transport 1.2.0-alpha.16 → 1.2.0-alpha.18

package/messages-protocol-v2.json

@@ -482,7 +482,7 @@
         "MessageType_DeviceStatus": 60603,
         "MessageType_DevGetOnboardingStatus": 60604,
         "MessageType_DevOnboardingStatus": 60605,
-        "MessageType_DeviceSessionGet": 60606,
+        "MessageType_DeviceSessionOpen": 60606,
         "MessageType_DeviceSession": 60607,
         "MessageType_DeviceSessionAskPin": 60608,
         "MessageType_FilesystemPermissionFix": 60800,
@@ -12418,14 +12418,68 @@
         }
       }
     },
-    "DeviceSessionGet": {
+    "DeviceSessionResume": {
       "fields": {
         "session_id": {
+          "rule": "required",
           "type": "bytes",
           "id": 1
         }
       }
     },
+    "DeviceHostPassphrase": {
+      "fields": {
+        "passphrase": {
+          "rule": "required",
+          "type": "string",
+          "id": 1
+        }
+      }
+    },
+    "DevicePassphraseOnDevice": {
+      "fields": {}
+    },
+    "DeviceAttachPinOnDevice": {
+      "fields": {}
+    },
+    "DeviceWalletSelect": {
+      "oneofs": {
+        "access": {
+          "oneof": ["host_passphrase", "passphrase_on_device", "attach_pin_on_device"]
+        }
+      },
+      "fields": {
+        "host_passphrase": {
+          "type": "DeviceHostPassphrase",
+          "id": 1
+        },
+        "passphrase_on_device": {
+          "type": "DevicePassphraseOnDevice",
+          "id": 2
+        },
+        "attach_pin_on_device": {
+          "type": "DeviceAttachPinOnDevice",
+          "id": 3
+        }
+      }
+    },
+    "DeviceSessionOpen": {
+      "oneofs": {
+        "mode": {
+          "oneof": ["resume", "select"]
+        }
+      },
+      "fields": {
+        "resume": {
+          "type": "DeviceSessionResume",
+          "id": 1
+        },
+        "select": {
+          "type": "DeviceWalletSelect",
+          "id": 2
+        }
+      }
+    },
     "DeviceSession": {
       "fields": {
         "session_id": {
@@ -12481,21 +12535,59 @@
     "DeviceStatusGet": {
       "fields": {}
     },
-    "DevOnboardingStage": {
+    "DevOnboardingStep": {
+      "values": {
+        "DEV_ONBOARDING_STEP_UNKNOWN": 0,
+        "DEV_ONBOARDING_STEP_CHECKING": 1,
+        "DEV_ONBOARDING_STEP_PERSONALIZATION": 2,
+        "DEV_ONBOARDING_STEP_PIN": 3,
+        "DEV_ONBOARDING_STEP_SETUP": 4,
+        "DEV_ONBOARDING_STEP_DONE": 5
+      }
+    },
+    "DevOnboardingPhase": {
+      "values": {
+        "DEV_ONBOARDING_PHASE_UNKNOWN": 0,
+        "DEV_ONBOARDING_PHASE_SAFETY_CHECK": 1,
+        "DEV_ONBOARDING_PHASE_PIN_SETUP": 2,
+        "DEV_ONBOARDING_PHASE_FINGERPRINT_SETUP": 3,
+        "DEV_ONBOARDING_PHASE_SETUP_CHOICE": 4,
+        "DEV_ONBOARDING_PHASE_WALLET_CREATE_START": 5,
+        "DEV_ONBOARDING_PHASE_RECOVERY_PHRASE_VIEW": 6,
+        "DEV_ONBOARDING_PHASE_RECOVERY_PHRASE_CONFIRM": 7,
+        "DEV_ONBOARDING_PHASE_RESTORE_METHOD_CHOICE": 8,
+        "DEV_ONBOARDING_PHASE_RECOVERY_PHRASE_RESTORE": 9,
+        "DEV_ONBOARDING_PHASE_SEEDCARD_RESTORE": 10,
+        "DEV_ONBOARDING_PHASE_WALLET_READY": 11,
+        "DEV_ONBOARDING_PHASE_SEEDCARD_BACKUP_PROMPT": 12,
+        "DEV_ONBOARDING_PHASE_SEEDCARD_BACKUP": 13
+      }
+    },
+    "DevOnboardingSetupKind": {
       "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
+        "DEV_ONBOARDING_SETUP_KIND_UNKNOWN": 0,
+        "DEV_ONBOARDING_SETUP_KIND_CHOICE": 1,
+        "DEV_ONBOARDING_SETUP_KIND_CREATE": 2,
+        "DEV_ONBOARDING_SETUP_KIND_RESTORE": 3
+      }
+    },
+    "DevOnboardingSetupMethod": {
+      "values": {
+        "DEV_ONBOARDING_SETUP_METHOD_UNKNOWN": 0,
+        "DEV_ONBOARDING_SETUP_METHOD_RECOVERY_PHRASE": 1,
+        "DEV_ONBOARDING_SETUP_METHOD_SEEDCARD": 2
+      }
+    },
+    "DevOnboardingSetupStatus": {
+      "fields": {
+        "kind": {
+          "type": "DevOnboardingSetupKind",
+          "id": 1
+        },
+        "method": {
+          "type": "DevOnboardingSetupMethod",
+          "id": 2
+        }
       }
     },
     "DevGetOnboardingStatus": {
@@ -12503,18 +12595,25 @@
     },
     "DevOnboardingStatus": {
       "fields": {
-        "stage": {
-          "rule": "required",
-          "type": "DevOnboardingStage",
+        "step": {
+          "type": "DevOnboardingStep",
           "id": 1
         },
-        "status_code": {
-          "type": "uint32",
+        "phase": {
+          "type": "DevOnboardingPhase",
           "id": 2
         },
-        "detail_code": {
-          "type": "uint32",
+        "setup": {
+          "type": "DevOnboardingSetupStatus",
           "id": 3
+        },
+        "pin_set": {
+          "type": "bool",
+          "id": 4
+        },
+        "wallet_initialized": {
+          "type": "bool",
+          "id": 5
         }
       }
     },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@onekeyfe/hd-transport",
-  "version": "1.2.0-alpha.16",
+  "version": "1.2.0-alpha.18",
   "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": "2356d951f63a39a46bc995c2090348a383966175"
+  "gitHead": "bdbc5bf74e48ca90f5c56f3079b2b974e61f7aa4"
 }

package/scripts/protobuf-build.sh

@@ -2,57 +2,137 @@
 
 set -euxo pipefail
 
-echo $#
-
-PARENT_PATH=$( cd "$(dirname "${BASH_SOURCE[0]}")" ; pwd -P )
+PARENT_PATH=$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd -P)
+PACKAGE_ROOT="$PARENT_PATH/.."
+REPO_ROOT="$PARENT_PATH/../../.."
+CORE_MESSAGES_DIR="$REPO_ROOT/packages/core/src/data/messages"
 
 SRC="../../submodules/firmware/common/protob"
 DIST="."
 LANG="typescript"
 
-if [[ $# -ne 0 && $# -ne 3 ]]
-    then
-        echo "must provide either 3 or 0 arguments. $# provided"
-        exit 1
+if [[ $# -ne 0 && $# -ne 3 ]]; then
+    echo "must provide either 3 or 0 arguments. $# provided"
+    exit 1
+fi
+
+if [[ $# -eq 3 ]]; then
+    SRC=$1
+    DIST=$2
+    LANG=$3
+fi
+
+if [[ "$LANG" != "typescript" && "$LANG" != "flow" ]]; then
+    echo "either typescript or flow must be specified as the third argument"
+    exit 1
 fi
 
-if [[ $# -eq 3 ]]
-    then
-        SRC=$1
-        DIST=$2
-        LANG=$3
+if [[ "$SRC" = /* ]]; then
+    SRC_PATH="$SRC"
+else
+    SRC_PATH="$PACKAGE_ROOT/$SRC"
 fi
 
-if [[ "$LANG" != "typescript" && "$LANG" != "flow" ]];
-    then
-        echo "either typescript or flow must be specified as the third argument"
-        exit 1
+if [[ "$DIST" = /* ]]; then
+    DIST_PATH="$DIST"
+else
+    DIST_PATH="$PACKAGE_ROOT/$DIST"
 fi
 
+V1_TMP_PROTO="$DIST_PATH/messages-tmp.proto"
+V2_TMP_PROTO="$PARENT_PATH/messages-protocol-v2-tmp.proto"
+trap 'rm -f "$V1_TMP_PROTO" "$V2_TMP_PROTO"' EXIT
 
-# 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 \
+echo "=== Building Protocol V1 messages ==="
+echo 'syntax = "proto2";' > "$V1_TMP_PROTO"
+echo 'import "google/protobuf/descriptor.proto";' >> "$V1_TMP_PROTO"
+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 '>> $DIST/messages.proto
+| grep -v '    reserved ' >> "$V1_TMP_PROTO"
 
-# BUILD messages.json from message.proto
-npx pbjs -t json -p $DIST -o $DIST/messages.json --keep-case messages.proto
-rm $DIST/messages.proto
+npx pbjs -t json -p "$DIST_PATH" -o "$DIST_PATH/messages.json" --keep-case "$V1_TMP_PROTO"
+cp "$DIST_PATH/messages.json" "$CORE_MESSAGES_DIR/messages.json"
 
-echo "generating type definitions for: $LANG"
+echo "=== Building Protocol V2 messages ==="
+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"
 
-cd "$PARENT_PATH"
+if [[ ! -d "$SRC_PRO2_LEGACY" || ! -d "$SRC_PRO2_LATEST" ]]; then
+    echo "firmware-pro2 protobuf schema is missing"
+    exit 1
+fi
+
+{
+    echo 'syntax = "proto2";'
+    echo 'import "google/protobuf/descriptor.proto";'
+    echo ''
+    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 '
+} > "$V2_TMP_PROTO"
 
-node ./protobuf-types.js $LANG
+# Protocol V2 latest schema defines common request names that also exist in
+# legacy chain messages. Keep the legacy definitions and remove the duplicate
+# top-level latest declarations before protobufjs parses the flattened schema.
+node - "$V2_TMP_PROTO" <<'NODE'
+const fs = require('fs');
+
+const protoPath = process.argv[2];
+let proto = fs.readFileSync(protoPath, 'utf8');
+
+function removeLastTopLevelMessage(source, name) {
+  const pattern = new RegExp(`(^|\\n)message\\s+${name}\\s*\\{`, 'gm');
+  const matches = Array.from(source.matchAll(pattern));
+  if (matches.length < 2) return source;
+  const match = matches[matches.length - 1];
+  const start = match.index + (match[1] ? match[1].length : 0);
+  let depth = 0;
+  for (let index = start; index < source.length; index += 1) {
+    if (source[index] === '{') depth += 1;
+    if (source[index] === '}') {
+      depth -= 1;
+      if (depth === 0) {
+        let end = index + 1;
+        while (end < source.length && /\\s/.test(source[end])) end += 1;
+        return `${source.slice(0, start)}${source.slice(end)}`;
+      }
+    }
+  }
+  throw new Error(`Unterminated message block: ${name}`);
+}
+
+['Initialize', 'GetFeatures', 'OnekeyGetFeatures', 'Features'].forEach(name => {
+  proto = removeLastTopLevelMessage(proto, name);
+});
+
+fs.writeFileSync(protoPath, proto);
+NODE
+
+npx pbjs -t json -p "$PARENT_PATH" -o "$PACKAGE_ROOT/messages-protocol-v2.json" --keep-case "$V2_TMP_PROTO"
+cp "$PACKAGE_ROOT/messages-protocol-v2.json" "$CORE_MESSAGES_DIR/messages-protocol-v2.json"
+
+echo "generating type definitions for: $LANG"
+cd "$PARENT_PATH"
+node ./protobuf-types.js "$LANG"
 
-yarn prettier --write messages.json
-yarn prettier --write **/messages.ts
+yarn --cwd "$PACKAGE_ROOT" prettier --write "$DIST_PATH/messages.json"
+yarn --cwd "$PACKAGE_ROOT" prettier --write "$CORE_MESSAGES_DIR/messages.json"
+yarn --cwd "$PACKAGE_ROOT" prettier --write "$PACKAGE_ROOT/messages-protocol-v2.json"
+yarn --cwd "$PACKAGE_ROOT" prettier --write "$CORE_MESSAGES_DIR/messages-protocol-v2.json"
+yarn --cwd "$PACKAGE_ROOT" prettier --write "$PACKAGE_ROOT/src/types/messages.ts"

package/scripts/protobuf-patches/index.js

@@ -210,6 +210,7 @@ const TYPE_PATCH = {
   'TonSignMessage.ext_ton_amount': UINT_TYPE,
   'TonSignData.timestamp': UINT_TYPE,
   'TonSignProof.expire_at': UINT_TYPE,
+  'TonSignData.timestamp': UINT_TYPE,
 };
 
 const DEFINITION_PATCH = {

package/scripts/protobuf-types.js

@@ -57,6 +57,9 @@ const ENUM_KEYS = [
   'InputScriptType',
   'OutputScriptType',
   'RequestType',
+  'KaspaInputScriptType',
+  'KaspaOutputScriptType',
+  'KaspaRequestType',
   'BackupType',
   'Capability',
   'SafetyCheckLevel',

package/src/protocols/v2/session.ts

@@ -201,14 +201,10 @@ export class ProtocolV2Session {
       router,
       seq: protoSeq,
     });
+    // 暂停输出 Protocol V2 TX 帧日志，避免传输层产生大量调试信息。
+    /*
     const txMetadata = ProtocolV2.inspectFrame(schemas, frame);
 
-    if (maxFrameBytes !== undefined && frame.length > maxFrameBytes) {
-      throw new Error(
-        `Protocol V2 frame too large for transport: ${frame.length} > ${maxFrameBytes}`
-      );
-    }
-
     if (!shouldReduceDebug) {
       logger?.debug?.(`[${logPrefix}] TX`, {
         method: name,
@@ -218,6 +214,13 @@ export class ProtocolV2Session {
         bytes: frame.length,
       });
     }
+    */
+
+    if (maxFrameBytes !== undefined && frame.length > maxFrameBytes) {
+      throw new Error(
+        `Protocol V2 frame too large for transport: ${frame.length} > ${maxFrameBytes}`
+      );
+    }
 
     // Lenient watchdog on the write phase only — see
     // PROTOCOL_V2_WRITE_WATCHDOG_TIMEOUT_MS for the rationale.
@@ -248,6 +251,8 @@ export class ProtocolV2Session {
         }
         const isAck = ProtocolV2.isAckFrame(rxFrame);
         if (!isAck) {
+          // 暂停输出 Protocol V2 RX 帧日志，避免传输层产生大量调试信息。
+          /*
           const rxMetadata = ProtocolV2.inspectFrame(schemas, rxFrame);
 
           if (!shouldReduceDebug) {
@@ -259,6 +264,7 @@ export class ProtocolV2Session {
               bytes: rxFrame.length,
             });
           }
+          */
 
           const decoded = ProtocolV2.decodeFrame(schemas, rxFrame);
 

package/src/serialization/protobuf/decode.ts

@@ -70,7 +70,10 @@ function messageToJSON(Message: Message<Record<string, unknown>>, fields: Type['
     }
     // message type
     else if (field.resolvedType!.fields) {
-      res[key] = messageToJSON(value, field.resolvedType!.fields);
+      // [compatibility]: absent optional sub-messages are not own properties
+      // of the decoded instance, so value is undefined here; decode them to
+      // null, matching the optional primitive-field convention above.
+      res[key] = value == null ? null : messageToJSON(value, (field.resolvedType as Type).fields);
     } else {
       throw new Error(`case not handled: ${key}`);
     }