@onekeyfe/hd-transport 1.2.8 → 1.2.10-alpha.2

package/src/serialization/protobuf/legacy-protocol-info.json

@@ -0,0 +1,16 @@
+{
+  "nested": {
+    "LegacyProtocolInfo": {
+      "fields": {
+        "version": { "rule": "required", "type": "uint32", "id": 1 },
+        "supported_messages": {
+          "rule": "repeated",
+          "type": "uint32",
+          "id": 2,
+          "options": { "packed": false }
+        },
+        "protobuf_definition": { "type": "string", "id": 3 }
+      }
+    }
+  }
+}

package/src/serialization/protobuf/messages.ts

@@ -1,11 +1,17 @@
 import * as protobuf from 'protobufjs/light';
+import Long from 'long';
 
-export function parseConfigure(data: protobuf.INamespace) {
-  // @ts-ignore [compatiblity]: connect is sending stringified json
-  if (typeof data === 'string') {
-    return protobuf.Root.fromJSON(JSON.parse(data));
-  }
-  return protobuf.Root.fromJSON(data);
+import { installStaticCodecs } from './generated/codecs';
+
+// protobufjs optional dependency discovery uses Function, which CSP can disable.
+protobuf.util.Long = Long;
+protobuf.configure();
+
+export function parseConfigure(data: protobuf.INamespace | string) {
+  const root = protobuf.Root.fromJSON(typeof data === 'string' ? JSON.parse(data) : data);
+  // Unrecognized custom schemas retain the existing reflection-based API.
+  installStaticCodecs(root);
+  return root;
 }
 
 export const createMessageFromName = (messages: protobuf.Root, name: string) => {

package/src/types/messages.ts

@@ -4554,6 +4554,28 @@ export enum CommandFlags {
   Factory_Only = 1,
 }
 
+export enum Enum_CanonicalBitcoinNetwork {
+  BITCOIN_MAINNET = 0,
+  BITCOIN_TESTNET = 1,
+  BITCOIN_SIGNET = 2,
+  BITCOIN_REGTEST = 3,
+}
+export type CanonicalBitcoinNetwork = keyof typeof Enum_CanonicalBitcoinNetwork;
+
+// BabylonDeriveContextHash
+export type BabylonDeriveContextHash = {
+  address_n: number[];
+  script_type: InputScriptType;
+  app_name: string;
+  context: string;
+  network: CanonicalBitcoinNetwork;
+};
+
+// BabylonDerivedContextHash
+export type BabylonDerivedContextHash = {
+  secret: string;
+};
+
 export type TextMemo = {
   text: string;
 };
@@ -4658,6 +4680,70 @@ export type UiAnimationRequest = {
   type?: UiAnimationType;
 };
 
+export enum ZcashAddressType {
+  UNIFIED_ORCHARD_P2PKH = 0,
+  TRANSPARENT_P2PKH = 1,
+  UNIFIED_ORCHARD = 2,
+}
+
+export enum ZcashAddressScope {
+  EXTERNAL = 0,
+  INTERNAL = 1,
+}
+
+// ZcashGetAddress
+export type ZcashGetAddress = {
+  address_n: number[];
+  show_display?: boolean;
+  include_seed_fingerprint?: boolean;
+  diversifier_index?: number;
+  address_type?: ZcashAddressType;
+  scope?: ZcashAddressScope;
+};
+
+// ZcashAddress
+export type ZcashAddress = {
+  address: string;
+  seed_fingerprint?: string;
+};
+
+// ZcashGetFullViewingKey
+export type ZcashGetFullViewingKey = {
+  address_n: number[];
+};
+
+// ZcashFullViewingKey
+export type ZcashFullViewingKey = {
+  ufvk: string;
+};
+
+// ZcashSignPczt
+export type ZcashSignPczt = {
+  pczt_length: number;
+  pczt_initial_chunk: string;
+};
+
+// ZcashPcztChunkRequest
+export type ZcashPcztChunkRequest = {
+  chunk_length: number;
+};
+
+// ZcashPcztChunkAck
+export type ZcashPcztChunkAck = {
+  data_chunk: string;
+};
+
+// ZcashSignedPczt
+export type ZcashSignedPczt = {
+  pczt_length: number;
+  pczt_initial_chunk: string;
+};
+
+// ZcashSignedPcztChunkRequest
+export type ZcashSignedPcztChunkRequest = {
+  chunk_length: number;
+};
+
 // experimental_message
 export type experimental_message = {};
 
@@ -5949,6 +6035,8 @@ export type MessageType = {
   TronSignMessage: TronSignMessage;
   TronMessageSignature: TronMessageSignature;
   facotry: facotry;
+  BabylonDeriveContextHash: BabylonDeriveContextHash;
+  BabylonDerivedContextHash: BabylonDerivedContextHash;
   TextMemo: TextMemo;
   RefundMemo: RefundMemo;
   CoinPurchaseMemo: CoinPurchaseMemo;
@@ -5964,6 +6052,15 @@ export type MessageType = {
   UnlockPath: UnlockPath;
   UnlockedPathRequest: UnlockedPathRequest;
   UiAnimationRequest: UiAnimationRequest;
+  ZcashGetAddress: ZcashGetAddress;
+  ZcashAddress: ZcashAddress;
+  ZcashGetFullViewingKey: ZcashGetFullViewingKey;
+  ZcashFullViewingKey: ZcashFullViewingKey;
+  ZcashSignPczt: ZcashSignPczt;
+  ZcashPcztChunkRequest: ZcashPcztChunkRequest;
+  ZcashPcztChunkAck: ZcashPcztChunkAck;
+  ZcashSignedPczt: ZcashSignedPczt;
+  ZcashSignedPcztChunkRequest: ZcashSignedPcztChunkRequest;
   experimental_message: experimental_message;
   experimental_field: experimental_field;
   ProtocolInfoRequest: ProtocolInfoRequest;

package/src/types/transport.ts

@@ -34,6 +34,12 @@ export type OneKeyDeviceInfoWithSession = OneKeyUsbDeviceInfo & {
 export type OneKeyMobileDeviceInfo = {
   id: string;
   name: string | null;
+  /**
+   * Color letter of the serial number ('A'-'Z') from the Pro2 / Neo BLE advertisement,
+   * possibly seen in an earlier scan. Set by the React Native and Electron BLE
+   * transports; absent when unknown.
+   */
+  bleColorCode?: string;
 };
 
 export type OneKeyDeviceInfoBase = {
@@ -70,6 +76,19 @@ export type TransportWriteMetrics = {
   frameBytes: number;
 };
 
+/**
+ * Supplies the remaining chunks of one file for an ordered FilesystemFileWrite pipeline.
+ * The call's request data is the first chunk; `next` returns the following chunk in offset
+ * order, or undefined to stop. The call then resolves with the last confirmation (or the
+ * device Failure), so the caller must check `processed_byte` for completeness. Callbacks
+ * should not throw: an error escapes with chunks still in flight and invalidates the link.
+ */
+export type ProtocolV2FileWritePipeline = {
+  next: () => Promise<Record<string, unknown> | undefined>;
+  /** Called for each chunk after the device confirms it, in offset order. */
+  onResponse: (response: MessageFromOneKey) => void;
+};
+
 export type TransportCallOptions = {
   timeoutMs?: number;
   expectedTypes?: string[];
@@ -83,6 +102,12 @@ export type TransportCallOptions = {
   onResponseAfterWrite?: (response: MessageFromOneKey) => void;
   /** Prefer acknowledged BLE characteristic writes for this call when supported. */
   writeWithResponse?: boolean;
+  /**
+   * Protocol V2 only: keep up to PROTOCOL_V2_FILE_WRITE_PIPELINE_WINDOW ordered
+   * FilesystemFileWrite frames of one file in flight within this call. `timeoutMs`
+   * bounds each frame write and each response instead of the whole file.
+   */
+  fileWritePipeline?: ProtocolV2FileWritePipeline;
 };
 
 type ITransportInitFn = (

package/src/utils/transportLog.ts

@@ -4,28 +4,39 @@ const REDACTED = '[REDACTED]';
 
 const SENSITIVE_LOG_KEYS = new Set([
   'accesstoken',
+  'additionaltxpubkeys',
   'address',
   'apikey',
   'connectid',
+  'datachunk',
   'devicestate',
   'deviceid',
+  'enckey',
   'entropy',
   'expectedpassphrasestate',
   'mnemonic',
+  'outkey',
   'passphrase',
   'passphrasestate',
   'password',
+  'pczt',
   'pin',
   'privatekey',
   'publickey',
   'seed',
+  'secret',
+  'seedfingerprint',
   'serialnumber',
   'session',
   'sessionid',
   'signature',
+  'signedpczt',
   'token',
+  'txpubkey',
+  'ufvk',
   'uuid',
   'walletsessionid',
+  'watchkey',
   'xprv',
   'xpub',
 ]);
@@ -44,7 +55,11 @@ const isSensitiveLogKey = (key: string) => {
 };
 
 const isSigningMessage = (messageName?: string) =>
-  Boolean(messageName && /(?:sign|txack|transaction)/i.test(messageName));
+  Boolean(messageName && /(?:sign|txack|transaction|pczt)/i.test(messageName));
+
+// Key image and tx key exchanges carry per-output secrets under generic field names (iv, blob, salt).
+const isMoneroSecretMessage = (messageName?: string) =>
+  Boolean(messageName && /^Monero(?:KeyImage|GetTxKey|LiveRefresh)/.test(messageName));
 
 const redactLogValue = (value: unknown, seen: WeakSet<object>): unknown => {
   if (ArrayBuffer.isView(value)) {
@@ -77,7 +92,7 @@ const redactLogValue = (value: unknown, seen: WeakSet<object>): unknown => {
 };
 
 export function getSafeTransportLogPayload(value: unknown, messageName?: string): unknown {
-  if (isSigningMessage(messageName)) {
+  if (isSigningMessage(messageName) || isMoneroSecretMessage(messageName)) {
     return REDACTED;
   }
   return redactLogValue(value, new WeakSet());