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

package/src/api/zcash/ZcashGetAddress.ts

@@ -1,121 +0,0 @@
-import { ZcashAddressScope, ZcashAddressType } from '@onekeyfe/hd-transport';
-
-import { BaseMethod } from '../BaseMethod';
-import { serializedPath, toHardened, validatePath } from '../helpers/pathUtils';
-import { invalidParameter, validateParams, validateResult } from '../helpers/paramsValidator';
-import { UI_REQUEST } from '../../constants/ui-request';
-
-import type { ZcashGetAddress as HardwareZcashGetAddress } from '@onekeyfe/hd-transport';
-import type { ZcashGetAddressParams, ZcashAddress } from '../../types/api/zcashGetAddress';
-import type { DeviceFirmwareRange } from '../../types';
-
-export default class ZcashGetAddress extends BaseMethod<HardwareZcashGetAddress[]> {
-  hasBundle = false;
-
-  getSupportedProtocols() {
-    return ['V2'] as const;
-  }
-
-  init() {
-    this.checkDeviceId = true;
-    this.allowDeviceMode = [...this.allowDeviceMode, UI_REQUEST.NOT_INITIALIZE];
-    this.strictCheckDeviceSupport = true;
-
-    this.hasBundle = !!this.payload?.bundle;
-    const payload = this.hasBundle ? this.payload : { bundle: [this.payload] };
-
-    validateParams(payload, [{ name: 'bundle', type: 'array' }]);
-
-    this.params = [];
-    payload.bundle.forEach((batch: ZcashGetAddressParams) => {
-      // ZIP-32 account path: m/32'/133'/account'
-      const addressN = validatePath(batch.path, 3);
-      if (
-        addressN.length !== 3 ||
-        addressN[0] !== toHardened(32) ||
-        addressN[1] !== toHardened(133) ||
-        addressN[2] < toHardened(0) ||
-        addressN[2] > 0xffffffff
-      ) {
-        throw invalidParameter("Zcash requires a ZIP-32 account path m/32'/133'/account'");
-      }
-      const addressType = batch.addressType ?? ZcashAddressType.UNIFIED_ORCHARD_P2PKH;
-      const scope = batch.scope ?? ZcashAddressScope.EXTERNAL;
-      const diversifierIndex = batch.diversifierIndex ?? 0;
-      if (
-        ![
-          ZcashAddressType.UNIFIED_ORCHARD_P2PKH,
-          ZcashAddressType.TRANSPARENT_P2PKH,
-          ZcashAddressType.UNIFIED_ORCHARD,
-        ].includes(addressType) ||
-        ![ZcashAddressScope.EXTERNAL, ZcashAddressScope.INTERNAL].includes(scope)
-      ) {
-        throw invalidParameter('Invalid Zcash address type or scope');
-      }
-      const maxIndex = addressType === ZcashAddressType.UNIFIED_ORCHARD ? 0xffffffff : 0x7fffffff;
-      if (
-        !Number.isSafeInteger(diversifierIndex) ||
-        diversifierIndex < 0 ||
-        diversifierIndex > maxIndex
-      ) {
-        throw invalidParameter('Invalid Zcash diversifier index');
-      }
-
-      validateParams(batch, [
-        { name: 'path', required: true },
-        { name: 'showOnOneKey', type: 'boolean' },
-        { name: 'includeUfvk', type: 'boolean' },
-        { name: 'includeSeedFingerprint', type: 'boolean' },
-      ]);
-
-      this.params.push({
-        address_n: addressN,
-        address_type: addressType,
-        scope,
-        diversifier_index: diversifierIndex,
-        show_display: batch.showOnOneKey ?? true,
-        include_ufvk: batch.includeUfvk ?? false,
-        include_seed_fingerprint: batch.includeSeedFingerprint ?? false,
-      });
-    });
-  }
-
-  getVersionRange(): DeviceFirmwareRange {
-    return {
-      model_pro2: {
-        min: '0.0.0',
-      },
-    };
-  }
-
-  async run() {
-    const responses: ZcashAddress[] = [];
-
-    for (let i = 0; i < this.params.length; i++) {
-      const param = this.params[i];
-
-      const res = await this.device.commands.typedCall('ZcashGetAddress', 'ZcashAddress', {
-        ...param,
-      });
-
-      const path = serializedPath(param.address_n);
-      responses.push({
-        path,
-        address: res.message.address,
-        ufvk: res.message.ufvk,
-        seedFingerprint: res.message.seed_fingerprint,
-      });
-
-      this.postPreviousAddressMessage({
-        address: res.message.address,
-        path,
-      });
-    }
-
-    validateResult(responses, ['address'], {
-      expectedLength: this.params.length,
-    });
-
-    return Promise.resolve(this.hasBundle ? responses : responses[0]);
-  }
-}

package/src/api/zcash/ZcashSignPczt.ts

@@ -1,155 +0,0 @@
-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/types/api/zcashGetAddress.ts

@@ -1,36 +0,0 @@
-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

@@ -1,18 +0,0 @@
-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>;