@onekeyfe/hd-core 1.2.8-alpha.1 → 1.2.8-alpha.100

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/data/messages/messages.json

@@ -12485,6 +12485,8 @@
         "(has_bitcoin_only_values)": true
       },
       "values": {
+        "MessageType_BabylonDeriveContextHash": 10054,
+        "MessageType_BabylonDerivedContextHash": 10055,
         "MessageType_Initialize": 0,
         "MessageType_Ping": 1,
         "MessageType_Success": 2,
@@ -12949,6 +12951,55 @@
         "MessageType_UpgradeFileHeader": 10050
       }
     },
+    "CanonicalBitcoinNetwork": {
+      "values": {
+        "BITCOIN_MAINNET": 0,
+        "BITCOIN_TESTNET": 1,
+        "BITCOIN_SIGNET": 2,
+        "BITCOIN_REGTEST": 3
+      }
+    },
+    "BabylonDeriveContextHash": {
+      "fields": {
+        "address_n": {
+          "rule": "repeated",
+          "type": "uint32",
+          "id": 1,
+          "options": {
+            "packed": false
+          }
+        },
+        "script_type": {
+          "rule": "required",
+          "type": "InputScriptType",
+          "id": 2
+        },
+        "app_name": {
+          "rule": "required",
+          "type": "bytes",
+          "id": 3
+        },
+        "context": {
+          "rule": "required",
+          "type": "bytes",
+          "id": 4
+        },
+        "network": {
+          "rule": "required",
+          "type": "CanonicalBitcoinNetwork",
+          "id": 5
+        }
+      }
+    },
+    "BabylonDerivedContextHash": {
+      "fields": {
+        "secret": {
+          "rule": "required",
+          "type": "bytes",
+          "id": 1
+        }
+      }
+    },
     "google": {
       "nested": {
         "protobuf": {

package/src/device/Device.ts

@@ -248,6 +248,9 @@ export class Device extends EventEmitter {
   /** Canonical device-state cache; legacy Features is a compatibility projection. */
   private stateStore = new DeviceStateStore();
 
+  /** Retain the old public identity only for disconnect notifications after wipe. */
+  private deviceBeforeWipe: DeviceTyped | null = null;
+
   /** Force the next initialization to reload DeviceInfo after reconnect or reboot. */
   private protocolV2StateNeedsReload = false;
 
@@ -351,6 +354,8 @@ export class Device extends EventEmitter {
   toMessageObject(): DeviceTyped | null {
     if (this.isUnacquired() || !this.features) return null;
 
+    this.deviceBeforeWipe = null;
+
     const env = DataManager.getSettings('env');
     const deviceType = this.getCurrentDeviceType();
 
@@ -395,6 +400,10 @@ export class Device extends EventEmitter {
     };
   }
 
+  toDisconnectMessageObject(): DeviceTyped | null {
+    return this.toMessageObject() ?? this.deviceBeforeWipe;
+  }
+
   /**
    * Device connect
    * @returns {Promise<boolean>}
@@ -1364,6 +1373,7 @@ export class Device extends EventEmitter {
   }
 
   invalidateAfterWipe() {
+    this.deviceBeforeWipe = this.toMessageObject() ?? this.deviceBeforeWipe;
     const deviceId = this.getCurrentDeviceId();
     if (deviceId) {
       deviceWalletSessionStore.deleteDevice(deviceId);
@@ -1801,7 +1811,7 @@ export class Device extends EventEmitter {
     // both allow and require cases might generate single unexpected mode
     if (!this.isUnacquired()) {
       // allow cases
-      if (this.isBootloader() && !this.isProtocolV2() && !allow.includes(UI_REQUEST.BOOTLOADER)) {
+      if ((this.isBootloader() || this.isRomloader()) && !allow.includes(UI_REQUEST.BOOTLOADER)) {
         return UI_REQUEST.BOOTLOADER;
       }
       if (!this.isInitialized() && !allow.includes(UI_REQUEST.NOT_INITIALIZE)) {

package/src/device/DeviceCommands.ts

@@ -549,6 +549,16 @@ export class DeviceCommands {
           this.device.isProtocolV2() &&
           DEVICE_CONTROL_CALLS.has(callType) &&
           subcode === DeviceErrorCode.DeviceError_Busy;
+        const isProtocolV2PinCancelledBusyFailure =
+          this.device.isProtocolV2() &&
+          !DEVICE_SESSION_CALLS.has(callType) &&
+          subcode === DeviceSessionErrorCode.DeviceSessionError_UserCancelled &&
+          /^pin cancelled$/i.test(normalizedMessage);
+        const isProtocolV2FirmwareUpdateBusyFailure =
+          this.device.isProtocolV2() &&
+          /^requested command not allowed while a firmware update is in progress$/i.test(
+            normalizedMessage
+          );
         const isLegacyProtocolV2LockedFailure =
           this.device.isProtocolV2() && /^device (?:is )?locked$/i.test(normalizedMessage);
         if (
@@ -606,7 +616,11 @@ export class DeviceCommands {
             subcode,
             firmwareMessage: message,
           });
-        } else if (isProtocolV2DeviceBusyFailure) {
+        } else if (
+          isProtocolV2DeviceBusyFailure ||
+          isProtocolV2PinCancelledBusyFailure ||
+          isProtocolV2FirmwareUpdateBusyFailure
+        ) {
           error = ERRORS.TypedError(HardwareErrorCode.DeviceBusy, message, {
             failureCode: code,
             subcode,

package/src/device/DevicePool.ts

@@ -114,7 +114,11 @@ export class DevicePool extends EventEmitter {
         const exist = canPathIdentifyDevice(cachedPath)
           ? descriptorList.find(d => d.path === cachedPath)
           : undefined;
-        if (exist && !initOptions?.forceProtocolDetection) {
+        if (
+          exist &&
+          !initOptions?.forceProtocolDetection &&
+          !(device.needReloadDevice && device.isUnacquired())
+        ) {
           // Log.debug('find existed Device: ', connectId);
           device.updateDescriptor(exist, true);
           await this._refreshRuntimeState(device, initOptions);
@@ -170,7 +174,13 @@ export class DevicePool extends EventEmitter {
     const forceProtocolDetection = initOptions?.forceProtocolDetection === true;
     const isNewDevice = !cachedDevice;
     const device = cachedDevice ?? Device.fromDescriptor(descriptor);
-    if (isNewDevice || forceProtocolDetection) {
+    if (
+      isNewDevice ||
+      forceProtocolDetection ||
+      (device.needReloadDevice && device.isUnacquired())
+    ) {
+      // Wipe invalidates state while the same USB path can remain discoverable.
+      if (cachedDevice) device.updateDescriptor(descriptor, true);
       device.deviceConnector = this.connector;
       // Search/discovery acquires outside Device.run(). Start a new attempt so
       // a previous user cancel does not hide this device from later searches.

package/src/events/core.ts

@@ -54,9 +54,9 @@ export const parseMessage = (messageData: any): CoreMessage => {
 };
 
 export const createErrorMessage = (error: Error & { code?: string | number }): Unsuccessful => {
-  let payload = { error: error.message, code: error.code };
+  let payload: Unsuccessful['payload'] = { error: error.message, code: error.code };
   if (error instanceof HardwareError) {
-    payload = { error: error.message, code: error.errorCode };
+    payload = { error: error.message, code: error.errorCode, params: error.params };
   }
   return {
     success: false,

package/src/events/logBlockEvent.ts

@@ -8,14 +8,18 @@ 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',
   'deviceUploadWallpaper',
   'uploadPortfolio',
   'fileWrite',
   'fileRead',
+  'zcashGetAddress',
+  'zcashGetUnifiedAddress',
+  'zcashSignPczt',
 ]);
 
 export function getLogBlockLabel(message: unknown): string | undefined {

package/src/inject.ts

@@ -309,6 +309,8 @@ export const createCoreApi = (
     call({ ...params, connectId, deviceId, method: 'btcGetAddress' }),
   btcGetPublicKey: (connectId, deviceId, params) =>
     call({ ...params, connectId, deviceId, method: 'btcGetPublicKey' }),
+  btcDeriveContextHash: (connectId, deviceId, params) =>
+    call({ ...params, connectId, deviceId, method: 'btcDeriveContextHash' }),
   btcSignMessage: (connectId, deviceId, params) =>
     call({ ...params, connectId, deviceId, method: 'btcSignMessage' }),
   btcSignPsbt: (connectId, deviceId, params) =>
@@ -502,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/btcDeriveContextHash.ts

@@ -0,0 +1,15 @@
+import type { BabylonDerivedContextHash } from '@onekeyfe/hd-transport';
+import type { CommonParams, Response } from '../params';
+
+export type BTCDeriveContextHashParams = {
+  path: string | number[];
+  appName: string;
+  context: string;
+  network: 'bitcoin-mainnet' | 'bitcoin-testnet' | 'bitcoin-signet' | 'bitcoin-regtest';
+};
+
+export declare function btcDeriveContextHash(
+  connectId: string,
+  deviceId: string,
+  params: CommonParams & BTCDeriveContextHashParams
+): Response<BabylonDerivedContextHash>;

package/src/types/api/export.ts

@@ -1,5 +1,6 @@
 export type { BTCAddress, BTCGetAddressParams } from './btcGetAddress';
 export type { BTCPublicKey, BTCGetPublicKeyParams } from './btcGetPublicKey';
+export type { BTCDeriveContextHashParams } from './btcDeriveContextHash';
 export type { BTCSignMessageParams } from './btcSignMessage';
 export type { BTCVerifyMessageParams } from './btcVerifyMessage';
 export type {
@@ -226,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

@@ -73,6 +73,7 @@ import type { evmSignTypedData } from './evmSignTypedData';
 import type { evmVerifyMessage } from './evmVerifyMessage';
 import type { btcGetAddress } from './btcGetAddress';
 import type { btcGetPublicKey } from './btcGetPublicKey';
+import type { btcDeriveContextHash } from './btcDeriveContextHash';
 import type { btcSignMessage } from './btcSignMessage';
 import type { btcSignPsbt } from './btcSignPsbt';
 import type { btcSignTransaction } from './btcSignTransaction';
@@ -153,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';
 
@@ -286,6 +289,7 @@ export type CoreApi = {
    */
   btcGetAddress: typeof btcGetAddress;
   btcGetPublicKey: typeof btcGetPublicKey;
+  btcDeriveContextHash: typeof btcDeriveContextHash;
   btcSignMessage: typeof btcSignMessage;
   btcSignPsbt: typeof btcSignPsbt;
   btcSignTransaction: typeof btcSignTransaction;
@@ -470,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/params.ts

@@ -83,7 +83,7 @@ export type Params<T> = CommonParams & T & { bundle?: undefined };
 
 export interface Unsuccessful {
   success: false;
-  payload: { error: string; code?: string | number };
+  payload: { error: string; code?: string | number; params?: Record<string, unknown> };
 }
 
 export interface Success<T> {