@onekeyfe/hd-core 1.2.8-alpha.110 → 1.2.8-alpha.111

package/src/api/zcash/ZcashSignPczt.ts

@@ -0,0 +1,155 @@
+import { bytesToHex } from '@noble/hashes/utils';
+import { ERRORS, HardwareErrorCode } from '@onekeyfe/hd-shared';
+
+import { BaseMethod } from '../BaseMethod';
+import { invalidParameter, validateParams } from '../helpers/paramsValidator';
+import { stripHexPrefix } from '../helpers/hexUtils';
+import { UI_REQUEST } from '../../constants/ui-request';
+
+import type { ZcashSignPczt as HardwareZcashSignPczt } from '@onekeyfe/hd-transport';
+import type { TypedCall, TypedResponseMessage } from '../../device/DeviceCommands';
+import type { ZcashSignedPczt } from '../../types/api/zcashSignPczt';
+import type { DeviceFirmwareRange } from '../../types';
+
+const CHUNK_BYTE_SIZE = 1024;
+// Host memory sanity bound on the device-announced length, not a device limit.
+const SIGNED_PCZT_SANITY_MAX_BYTES = 16 * 1024 * 1024;
+
+export default class ZcashSignPczt extends BaseMethod<HardwareZcashSignPczt> {
+  pczt: Buffer = Buffer.alloc(0);
+
+  getSupportedProtocols() {
+    return ['V2'] as const;
+  }
+
+  init() {
+    this.checkDeviceId = true;
+    this.allowDeviceMode = [...this.allowDeviceMode, UI_REQUEST.NOT_INITIALIZE];
+    this.strictCheckDeviceSupport = true;
+
+    validateParams(this.payload, [{ name: 'pczt', type: 'hexString', required: true }]);
+
+    // Reject odd-length hex instead of left-padding it, which would shift every nibble.
+    const pcztHex = stripHexPrefix(this.payload.pczt);
+    if (pcztHex.length % 2 !== 0) {
+      throw invalidParameter('pczt hex must have an even length');
+    }
+    this.pczt = Buffer.from(pcztHex, 'hex');
+    if (this.pczt.length === 0) {
+      throw invalidParameter('pczt is empty');
+    }
+
+    this.params = {
+      pczt_length: this.pczt.length,
+      pczt_initial_chunk: bytesToHex(this.pczt.subarray(0, CHUNK_BYTE_SIZE)),
+    };
+  }
+
+  getVersionRange(): DeviceFirmwareRange {
+    return {
+      model_pro2: {
+        min: '0.0.0',
+      },
+    };
+  }
+
+  // Upload: the device decides every chunk length via ZcashPcztChunkRequest and
+  // the host must answer with exactly that many bytes.
+  uploadPczt = async (
+    typedCall: TypedCall,
+    res: TypedResponseMessage<'ZcashSignedPczt'> | TypedResponseMessage<'ZcashPcztChunkRequest'>,
+    offset: number
+  ): Promise<TypedResponseMessage<'ZcashSignedPczt'>> => {
+    if (res.type === 'ZcashSignedPczt') {
+      if (offset !== this.pczt.length) {
+        throw ERRORS.TypedError(
+          HardwareErrorCode.ResponseUnexpectTypeError,
+          'device completed signing before receiving the whole pczt'
+        );
+      }
+      return res;
+    }
+
+    const { chunk_length: chunkLength } = res.message;
+    if (
+      !Number.isSafeInteger(chunkLength) ||
+      chunkLength <= 0 ||
+      offset + chunkLength > this.pczt.length
+    ) {
+      throw ERRORS.TypedError(
+        HardwareErrorCode.ResponseUnexpectTypeError,
+        `device requested ${chunkLength} bytes at offset ${offset} of ${this.pczt.length}`
+      );
+    }
+
+    const chunk = this.pczt.subarray(offset, offset + chunkLength);
+    const next = await typedCall(
+      'ZcashPcztChunkAck',
+      ['ZcashSignedPczt', 'ZcashPcztChunkRequest'],
+      {
+        data_chunk: bytesToHex(chunk),
+      }
+    );
+
+    return this.uploadPczt(typedCall, next, offset + chunkLength);
+  };
+
+  // Download: the host decides chunk lengths via ZcashSignedPcztChunkRequest
+  // until the announced pczt_length has been received.
+  downloadSignedPczt = async (
+    typedCall: TypedCall,
+    res: TypedResponseMessage<'ZcashSignedPczt'>
+  ): Promise<Buffer> => {
+    const { pczt_length: total, pczt_initial_chunk: initial } = res.message;
+    if (!Number.isSafeInteger(total) || total <= 0 || total > SIGNED_PCZT_SANITY_MAX_BYTES) {
+      throw ERRORS.TypedError(
+        HardwareErrorCode.ResponseUnexpectTypeError,
+        `device announced invalid signed pczt length ${total}`
+      );
+    }
+
+    const parts: Buffer[] = [Buffer.from(initial ?? '', 'hex')];
+    let received = parts[0].length;
+    if (received > total) {
+      throw ERRORS.TypedError(
+        HardwareErrorCode.ResponseUnexpectTypeError,
+        'device returned more initial pczt bytes than announced'
+      );
+    }
+
+    while (received < total) {
+      const chunkLength = Math.min(CHUNK_BYTE_SIZE, total - received);
+      const ack = await typedCall('ZcashSignedPcztChunkRequest', 'ZcashPcztChunkAck', {
+        chunk_length: chunkLength,
+      });
+      const chunk = Buffer.from(ack.message.data_chunk ?? '', 'hex');
+      if (chunk.length !== chunkLength) {
+        throw ERRORS.TypedError(
+          HardwareErrorCode.ResponseUnexpectTypeError,
+          `device returned ${chunk.length} of ${chunkLength} requested bytes at offset ${received} of ${total}`
+        );
+      }
+      parts.push(chunk);
+      received += chunk.length;
+    }
+
+    return Buffer.concat(parts);
+  };
+
+  async run(): Promise<ZcashSignedPczt> {
+    const typedCall = this.device.getCommands().typedCall.bind(this.device.getCommands());
+
+    const first = await typedCall('ZcashSignPczt', ['ZcashSignedPczt', 'ZcashPcztChunkRequest'], {
+      ...this.params,
+    });
+
+    const signed = await this.uploadPczt(
+      typedCall,
+      first,
+      Math.min(CHUNK_BYTE_SIZE, this.pczt.length)
+    );
+    const pczt = await this.downloadSignedPczt(typedCall, signed);
+
+    return { pczt: bytesToHex(pczt) };
+  }
+}

package/src/data/messages/messages-protocol-v2.json

@@ -11034,6 +11034,61 @@
         }
       }
     },
+    "ZcashSignPczt": {
+      "fields": {
+        "pczt_length": {
+          "rule": "required",
+          "type": "uint32",
+          "id": 1
+        },
+        "pczt_initial_chunk": {
+          "rule": "required",
+          "type": "bytes",
+          "id": 2
+        }
+      }
+    },
+    "ZcashPcztChunkRequest": {
+      "fields": {
+        "chunk_length": {
+          "rule": "required",
+          "type": "uint32",
+          "id": 1
+        }
+      }
+    },
+    "ZcashPcztChunkAck": {
+      "fields": {
+        "data_chunk": {
+          "rule": "required",
+          "type": "bytes",
+          "id": 1
+        }
+      }
+    },
+    "ZcashSignedPczt": {
+      "fields": {
+        "pczt_length": {
+          "rule": "required",
+          "type": "uint32",
+          "id": 1
+        },
+        "pczt_initial_chunk": {
+          "rule": "required",
+          "type": "bytes",
+          "id": 2
+        }
+      }
+    },
+    "ZcashSignedPcztChunkRequest": {
+      "fields": {
+        "chunk_length": {
+          "rule": "required",
+          "type": "uint32",
+          "id": 1
+        }
+      }
+    },
     "wire_in": {
       "type": "bool",
       "id": 50002,
@@ -11459,6 +11514,11 @@
         "MessageType_NeoAddress": 12302,
         "MessageType_NeoSignTx": 12303,
         "MessageType_NeoSignedTx": 12304,
+        "MessageType_ZcashSignPczt": 12402,
+        "MessageType_ZcashSignedPczt": 12403,
+        "MessageType_ZcashPcztChunkRequest": 12404,
+        "MessageType_ZcashPcztChunkAck": 12405,
+        "MessageType_ZcashSignedPcztChunkRequest": 12406,
         "MessageType_DeviceFactoryInfoSet": 60000,
         "MessageType_DeviceFactoryInfoGet": 60001,
         "MessageType_DeviceFactoryInfo": 60002,
@@ -11511,7 +11571,9 @@
         "MessageType_PortfolioUpdate": 61400,
         "MessageType_NftUpdate": 61500,
         "MessageType_OnboardingStatusGet": 61600,
-        "MessageType_OnboardingStatus": 61601
+        "MessageType_OnboardingStatus": 61601,
+        "MessageType_ZcashGetAddress": 12400,
+        "MessageType_ZcashAddress": 12401
       },
       "reserved": [
         [90, 92],
@@ -13730,6 +13792,81 @@
           }
         }
       }
+    },
+    "ZcashAddressType": {
+      "values": {
+        "UNIFIED_ORCHARD_P2PKH": 0,
+        "TRANSPARENT_P2PKH": 1,
+        "UNIFIED_ORCHARD": 2
+      }
+    },
+    "ZcashAddressScope": {
+      "values": {
+        "EXTERNAL": 0,
+        "INTERNAL": 1
+      }
+    },
+    "ZcashGetAddress": {
+      "fields": {
+        "address_n": {
+          "rule": "repeated",
+          "type": "uint32",
+          "id": 1,
+          "options": {
+            "packed": false
+          }
+        },
+        "show_display": {
+          "type": "bool",
+          "id": 2
+        },
+        "include_seed_fingerprint": {
+          "type": "bool",
+          "id": 3
+        },
+        "include_ufvk": {
+          "type": "bool",
+          "id": 4
+        },
+        "diversifier_index": {
+          "type": "uint32",
+          "id": 5,
+          "options": {
+            "default": 0
+          }
+        },
+        "address_type": {
+          "type": "ZcashAddressType",
+          "id": 6,
+          "options": {
+            "default": "UNIFIED_ORCHARD_P2PKH"
+          }
+        },
+        "scope": {
+          "type": "ZcashAddressScope",
+          "id": 7,
+          "options": {
+            "default": "EXTERNAL"
+          }
+        }
+      }
+    },
+    "ZcashAddress": {
+      "fields": {
+        "address": {
+          "rule": "required",
+          "type": "string",
+          "id": 1
+        },
+        "ufvk": {
+          "type": "string",
+          "id": 2
+        },
+        "seed_fingerprint": {
+          "type": "bytes",
+          "id": 3
+        }
+      }
     }
   }
 }

package/src/events/logBlockEvent.ts

@@ -8,8 +8,8 @@ export const LogBlockEvent: Set<string> = new Set([
   UI_RESPONSE.RECEIVE_PASSPHRASE,
 ]);
 
-// These resource/file APIs did not exist in 1.1.32. Skip the payload so
-// the log layer does not copy huge Base64 or binary data.
+// Drop sensitive wallet payloads and large resource data before logger caches
+// or log events can retain them, regardless of whether debug output is enabled.
 const LogPayloadBlockMethod: Set<string> = new Set([
   'btcDeriveContextHash',
   'deviceUploadNft',
@@ -17,6 +17,8 @@ const LogPayloadBlockMethod: Set<string> = new Set([
   'uploadPortfolio',
   'fileWrite',
   'fileRead',
+  'zcashGetAddress',
+  'zcashSignPczt',
 ]);
 
 export function getLogBlockLabel(message: unknown): string | undefined {

package/src/inject.ts

@@ -504,4 +504,8 @@ export const createCoreApi = (
     call({ ...params, connectId, deviceId, method: 'neoGetAddress' }),
   neoSignTransaction: (connectId, deviceId, params) =>
     call({ ...params, connectId, deviceId, method: 'neoSignTransaction' }),
+  zcashGetAddress: (connectId, deviceId, params) =>
+    call({ ...params, connectId, deviceId, method: 'zcashGetAddress' }),
+  zcashSignPczt: (connectId, deviceId, params) =>
+    call({ ...params, connectId, deviceId, method: 'zcashSignPczt' }),
 });

package/src/types/api/export.ts

@@ -227,3 +227,5 @@ export type { BenfenAddress, BenfenGetAddressParams } from './benfenGetAddress';
 export type { BenfenPublicKey, BenfenGetPublicKeyParams } from './benfenGetPublicKey';
 export type { BenfenSignMessageParams } from './benfenSignMessage';
 export type { BenfenSignedTx, BenfenSignTransactionParams } from './benfenSignTransaction';
+export type { ZcashAddress, ZcashGetAddressParams } from './zcashGetAddress';
+export type { ZcashSignedPczt, ZcashSignPcztParams } from './zcashSignPczt';

package/src/types/api/index.ts

@@ -154,6 +154,8 @@ import type { benfenSignTransaction } from './benfenSignTransaction';
 import type { benfenSignMessage } from './benfenSignMessage';
 import type { neoGetAddress } from './neoGetAddress';
 import type { neoSignTransaction } from './neoSignTransaction';
+import type { zcashGetAddress } from './zcashGetAddress';
+import type { zcashSignPczt } from './zcashSignPczt';
 import type { ConnectSettings } from '../settings';
 import type { HardwareConnectProtocol } from '@onekeyfe/hd-shared';
 
@@ -472,4 +474,10 @@ export type CoreApi = {
    */
   neoGetAddress: typeof neoGetAddress;
   neoSignTransaction: typeof neoSignTransaction;
+
+  /**
+   * Zcash
+   */
+  zcashGetAddress: typeof zcashGetAddress;
+  zcashSignPczt: typeof zcashSignPczt;
 };

package/src/types/api/zcashGetAddress.ts

@@ -0,0 +1,36 @@
+import type { ZcashAddressScope, ZcashAddressType } from '@onekeyfe/hd-transport';
+
+import type { CommonParams, Response } from '../params';
+
+export type ZcashAddress = {
+  path: string;
+  // ZIP-316 unified address or transparent P2PKH address
+  address: string;
+  // ZIP-316 unified full viewing key, present when includeUfvk was requested
+  ufvk?: string;
+  // ZIP-32 seed fingerprint (hex), present when includeSeedFingerprint was requested
+  seedFingerprint?: string;
+};
+
+export type ZcashGetAddressParams = {
+  // ZIP-32 account path, m/32'/133'/account'
+  path: string | number[];
+  showOnOneKey?: boolean;
+  diversifierIndex?: number;
+  addressType?: ZcashAddressType;
+  scope?: ZcashAddressScope;
+  includeUfvk?: boolean;
+  includeSeedFingerprint?: boolean;
+};
+
+export declare function zcashGetAddress(
+  connectId: string,
+  deviceId: string,
+  params: CommonParams & ZcashGetAddressParams
+): Response<ZcashAddress>;
+
+export declare function zcashGetAddress(
+  connectId: string,
+  deviceId: string,
+  params: CommonParams & { bundle?: ZcashGetAddressParams[] }
+): Response<Array<ZcashAddress>>;

package/src/types/api/zcashSignPczt.ts

@@ -0,0 +1,18 @@
+import type { CommonParams, Response } from '../params';
+
+export type ZcashSignPcztParams = {
+  // Unproved PCZT (v2, tx v6) as hex; the device signs it and returns a
+  // redacted copy with signatures filled in.
+  pczt: string;
+};
+
+export type ZcashSignedPczt = {
+  // Signed, redacted PCZT as hex
+  pczt: string;
+};
+
+export declare function zcashSignPczt(
+  connectId: string,
+  deviceId: string,
+  params: CommonParams & ZcashSignPcztParams
+): Response<ZcashSignedPczt>;

package/src/types/device.ts

@@ -83,12 +83,6 @@ export type SearchDevice = {
   deviceType: IDeviceType;
   name: string;
   commType: OneKeyDeviceCommType;
-  /**
-   * React Native and Electron BLE discovery only. Serial-number color letter ('A'-'Z')
-   * advertised by Pro2 / Neo, possibly remembered from an earlier advertisement in this
-   * process. Absent when unknown; the letter's meaning depends on deviceType.
-   */
-  bleColorCode?: string;
 };
 
 /** Identity confirmed over USB. The descriptor path is only a transport address. */