@onekeyfe/hd-transport 1.1.28 → 1.2.0-alpha.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@onekeyfe/hd-transport",
-  "version": "1.1.28",
+  "version": "1.2.0-alpha.1",
   "description": "Transport layer abstractions and utilities for OneKey hardware SDK.",
   "author": "OneKey",
   "homepage": "https://github.com/OneKeyHQ/hardware-js-sdk#readme",
@@ -16,7 +16,7 @@
     "test": "jest",
     "lint": "eslint .",
     "lint:fix": "eslint . --fix",
-    "update:protobuf": "./scripts/protobuf-build.sh"
+    "update-protobuf": "./scripts/protobuf-build.sh"
   },
   "devDependencies": {
     "@types/bytebuffer": "^5.0.42",
@@ -28,5 +28,5 @@
     "long": "^4.0.0",
     "protobufjs": "^6.11.2"
   },
-  "gitHead": "9cfd4f7f00a2b7317325161d666a7b0173345995"
+  "gitHead": "4f4aae3a47be7bd54b4db4a10c400056784e01bd"
 }

package/scripts/protobuf-build.sh

@@ -5,10 +5,14 @@ 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
@@ -29,30 +33,320 @@ 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 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
 
-# BUILD messages.json from message.proto
-npx pbjs -t json -p $DIST -o $DIST/messages.json --keep-case messages.proto
-rm $DIST/messages.proto
+# ============================================================
+# 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"
+
+    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
 
-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"
 
-node ./protobuf-types.js $LANG
+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 '
+
+        if ! grep -q '^message TonSignData ' "$SRC_PRO2_LEGACY"/messages*.proto; then
+            echo ''
+            echo '// --- TON signData (kept until firmware-pro2 legacy proto exports it) ---'
+            echo 'message TonSignData {'
+            echo '    repeated uint32 address_n = 1;'
+            echo '    required TonSignDataType type = 2;'
+            echo '    required bytes payload = 3;'
+            echo '    optional string schema = 4;'
+            echo '    required string appdomain = 5;'
+            echo '    required uint64 timestamp = 6;'
+            echo '    optional string from_address = 7;'
+            echo '    optional TonWalletVersion wallet_version = 8 [default=V4R2];'
+            echo '    optional uint32 wallet_id = 9 [default=698983191];'
+            echo '    optional TonWorkChain workchain = 10 [default=BASECHAIN];'
+            echo '    optional bool is_bounceable = 11 [default=false];'
+            echo '    optional bool is_testnet_only = 12 [default=false];'
+            echo ''
+            echo '    enum TonSignDataType {'
+            echo '        TEXT = 0;'
+            echo '        BINARY = 1;'
+            echo '        CELL = 2;'
+            echo '    }'
+            echo '}'
+            echo ''
+            echo 'message TonSignedData {'
+            echo '    optional bytes signature = 1;'
+            echo '    optional bytes digest = 2;'
+            echo '}'
+        fi
+
+        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 '
+
+        if ! grep -q '^message GetOnboardingStatus ' "$SRC_PRO2_LATEST"/messages*.proto; then
+            echo ''
+            echo '// --- Onboarding status (kept until firmware-pro2 latest proto exports it) ---'
+            echo 'enum OnboardingStep {'
+            echo '    ONBOARDING_STEP_UNKNOWN = 0;'
+            echo '    ONBOARDING_STEP_DEVICE_VERIFICATION = 1;'
+            echo '    ONBOARDING_STEP_PERSONALIZATION = 2;'
+            echo '    ONBOARDING_STEP_SETUP = 3;'
+            echo '    ONBOARDING_STEP_FIRMWARE = 4;'
+            echo '}'
+            echo ''
+            echo 'message GetOnboardingStatus {'
+            echo '}'
+            echo ''
+            echo 'message OnboardingStatus {'
+            echo '    message Setup {'
+            echo '        message NewDevice {'
+            echo '            optional bool seedcard_backup = 1;'
+            echo '        }'
+            echo '        message Restore {'
+            echo '            optional bool mnemonic = 1;'
+            echo '            optional bool seedcard = 2;'
+            echo '        }'
+            echo '        optional NewDevice new_device = 1;'
+            echo '        optional Restore restore = 2;'
+            echo '    }'
+            echo '    required OnboardingStep step = 1;'
+            echo '    optional Setup setup = 2;'
+            echo '    optional uint32 detail_code = 3;'
+            echo '    optional string detail_str = 4;'
+            echo '}'
+        fi
+    } > "$TMP_PROTO"
+
+    if ! grep -q 'MessageType_TonSignData' "$TMP_PROTO"; then
+        node - "$TMP_PROTO" <<'NODE'
+const fs = require('fs');
+
+const protoPath = process.argv[2];
+const proto = fs.readFileSync(protoPath, 'utf8');
+const updated = proto.replace(
+  /(    MessageType_TonTxAck\s*=\s*11907[^\n]*;\n)/,
+  `$1    MessageType_TonSignData = 11908 [(wire_in) = true];\n    MessageType_TonSignedData = 11909 [(wire_out) = true];\n`
+);
 
-yarn prettier --write messages.json
-yarn prettier --write **/messages.ts
+if (updated === proto) {
+  throw new Error('Unable to insert TON signData MessageType entries into Pro2 schema');
+}
+
+fs.writeFileSync(protoPath, updated);
+NODE
+    fi
+
+    if ! grep -q 'MessageType_GetOnboardingStatus' "$TMP_PROTO"; then
+        node - "$TMP_PROTO" <<'NODE'
+const fs = require('fs');
+
+const protoPath = process.argv[2];
+const proto = fs.readFileSync(protoPath, 'utf8');
+const updated = proto.replace(
+  /(    MessageType_DeviceInfo\s*=\s*60601[^\n]*;\n)/,
+  `$1    MessageType_GetOnboardingStatus = 60602;\n    MessageType_OnboardingStatus = 60603;\n`
+);
+
+if (updated === proto) {
+  throw new Error('Unable to insert onboarding MessageType entries into Pro2 schema');
+}
+
+fs.writeFileSync(protoPath, updated);
+NODE
+    fi
+
+    node - "$TMP_PROTO" <<'NODE'
+const fs = require('fs');
+
+const protoPath = process.argv[2];
+const proto = fs.readFileSync(protoPath, 'utf8');
+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 = [
+  'Ping',
+  'Success',
+  'Failure',
+  'DevReboot',
+  'DevGetDeviceInfo',
+  'DeviceInfo',
+  'DevFirmwareUpdate',
+  'DevFirmwareInstallProgress',
+  'DevGetFirmwareUpdateStatus',
+  'DevFirmwareUpdateStatus',
+  'FilesystemFixPermission',
+  'FilesystemPathInfo',
+  'FilesystemPathInfoQuery',
+  'FilesystemFile',
+  'FilesystemFileRead',
+  'FilesystemFileWrite',
+  'FilesystemFileDelete',
+  'FilesystemDir',
+  'FilesystemDirList',
+  'FilesystemDirMake',
+  'FilesystemDirRemove',
+  'FilesystemFormat',
+  'TonSignData',
+  'TonSignedData',
+  'GetOnboardingStatus',
+  'OnboardingStatus',
+];
+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_romloader_split ` +
+      '(origin/dev_romloader_split), which contains the Filesystem*/DevFirmwareUpdate/DevReboot messages.'
+  );
+}
+
+// Provisional wire IDs injected by this script for messages the firmware proto does
+// not export yet (pending firmware confirmation, see
+// docs/protocol-v2-deviceinfo-field-gaps.md). If the firmware submodule starts
+// exporting these MessageType entries itself, the injection above is skipped and the
+// firmware-assigned IDs flow into TMP_PROTO — assert they still match the IDs the SDK
+// was built against, and fail loudly on any drift.
+const expectedInjectedIds = {
+  TonSignData: 11908,
+  TonSignedData: 11909,
+  GetOnboardingStatus: 60602,
+  OnboardingStatus: 60603,
+};
+const actualIds = {};
+for (const match of proto.matchAll(/^\s*MessageType_([A-Za-z_][A-Za-z0-9_]*)\s*=\s*(\d+)/gm)) {
+  actualIds[match[1]] = Number(match[2]);
+}
+const idMismatches = Object.entries(expectedInjectedIds)
+  .filter(([name, id]) => name in actualIds && actualIds[name] !== id)
+  .map(([name, id]) => `${name}: expected ${id}, firmware proto has ${actualIds[name]}`);
+
+if (idMismatches.length > 0) {
+  throw new Error(
+    `Protocol V2 injected MessageType wire IDs conflict with the firmware proto: ${idMismatches.join(
+      '; '
+    )}. Update the injected IDs in protobuf-build.sh and the registry section in ` +
+      'docs/protocol-v2-deviceinfo-field-gaps.md.'
+  );
+}
+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_romloader_split."
+    echo "Run: git submodule update --init submodules/firmware-pro2"
+    echo "Then: git -C submodules/firmware-pro2 fetch origin dev_romloader_split && git -C submodules/firmware-pro2 checkout origin/dev_romloader_split"
+    exit 1
+fi

package/scripts/protobuf-patches/TxInputType.js

@@ -29,6 +29,7 @@ type CommonTxInputType = {|
     witness?: string, // used by EXTERNAL, depending on script_pubkey
     ownership_proof?: string, // used by EXTERNAL, depending on script_pubkey
     commitment_data?: string, // used by EXTERNAL, depending on ownership_proof
+    coinjoin_flags?: number, // Protocol V2 only (CoinJoin)
 |};
 
 export type TxInputType =

package/scripts/protobuf-patches/index.js

@@ -116,6 +116,7 @@ const TYPE_PATCH = {
   'Features.onekey_se03_state': 'string | null',
   'Features.onekey_se04_state': 'string | null',
   'HDNodePathType.node': 'HDNodeType | string',
+  'FilesystemFile.data': 'Buffer | ArrayBuffer | Uint8Array | string',
   'FirmwareUpload.payload': 'Buffer | ArrayBuffer',
   'EthereumGetAddress.encoded_network': 'ArrayBuffer',
   'EthereumDefinitions.encoded_network': 'ArrayBuffer',
@@ -207,6 +208,7 @@ const TYPE_PATCH = {
   'TonSignMessage.fwd_fee': UINT_TYPE,
   'TonSignMessage.expire_at': UINT_TYPE,
   'TonSignMessage.ext_ton_amount': UINT_TYPE,
+  'TonSignData.timestamp': UINT_TYPE,
   'TonSignProof.expire_at': UINT_TYPE,
 };