@onekeyfe/hd-shared 1.2.0-alpha.19 → 1.2.0-alpha.20

package/dist/HardwareError.d.ts

@@ -117,6 +117,7 @@ export declare const HardwareErrorCode: {
     readonly PinMismatch: 828;
     readonly DeviceLocked: 829;
     readonly KaspaPrevTxIdMismatch: 830;
+    readonly WalletSessionInvalid: 831;
     readonly LowlevelTrasnportConnectError: 900;
     readonly WebDeviceNotFoundOrNeedsPermission: 901;
     readonly WebDevicePromptAccessError: 902;

package/dist/HardwareError.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"HardwareError.d.ts","sourceRoot":"","sources":["../src/HardwareError.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAE/C,MAAM,WAAW,cAAc;IAC7B,SAAS,EAAE,OAAO,CAAC,OAAO,iBAAiB,CAAC,CAAC;IAC7C,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,GAAG,CAAC;CACd;AAED,KAAK,OAAO,CAAC,CAAC,SAAS,MAAM,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;AAE5C,KAAK,+BAA+B,GAAG;KAAG,CAAC,IAAI,OAAO,CAAC,OAAO,iBAAiB,CAAC,GAAG,MAAM;CAAE,CAAC;AAE5F,KAAK,cAAc,GAAG,OAAO,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAsCxD,qBAAa,aAAc,SAAQ,KAAK;IACtC,SAAS,EAAE,cAAc,CAAkC;IAE3D,OAAO,SAAM;IAEb,MAAM,EAAE,GAAG,CAAM;gBAEL,aAAa,EAAE,cAAc,GAAG,MAAM;CAmBnD;AAED,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAibpB,CAAC;AAEX,eAAO,MAAM,wBAAwB,EAAE,+BAkJ7B,CAAC;AAEX,eAAO,MAAM,UAAU,kBACN,cAAc,GAAG,MAAM,YAC5B,MAAM,WACP,GAAG,kBAMb,CAAC;AAEF,eAAO,MAAM,cAAc,YAAa,GAAG,QAe1C,CAAC;AAEF,eAAO,MAAM,oBAAoB,YAAa,MAAM,KAAG,aAOtD,CAAC;AAGF,eAAO,MAAM,gCAAgC,QAAS,MAAM,KAAG,aAQ9D,CAAC;AAEF,QAAA,MAAM,uCAAuC;oBAM3B,MAAM;oBACN,MAAM;;;mBAcvB,CAAC;AAEF,QAAA,MAAM,sCAAsC;oBAM1B,MAAM;oBACN,MAAM;;;mBAcvB,CAAC;AAEF,QAAA,MAAM,yCAAyC,cAClC,MAAM,GAAG,SAAS,YACnB,MAAM,GAAG,SAAS,iBACb,CAAC,UAAU,GAAG,KAAK,CAAC,EAAE,oBACnB;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,GAAG,CAAC,EAAE,MAAM,CAAC;CACd,kBAsBF,CAAC;AAEF,QAAA,MAAM,6BAA6B,mBACjB,MAAM,qBACH,MAAM,eACZ,MAAM,kBAQpB,CAAC;AAEF,QAAA,MAAM,4BAA4B,aACtB,MAAM,aACL,MAAM,cACL,MAAM,cACN,MAAM,aACP,MAAM,kBAWlB,CAAC;AAEF,QAAA,MAAM,iCAAiC,eAAgB,MAAM,gBAAgB,aAAa,kBAItF,CAAC;AAEL,OAAO,EACL,uCAAuC,EACvC,sCAAsC,EACtC,yCAAyC,EACzC,6BAA6B,EAC7B,4BAA4B,EAC5B,iCAAiC,GAClC,CAAC"}
+{"version":3,"file":"HardwareError.d.ts","sourceRoot":"","sources":["../src/HardwareError.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAE/C,MAAM,WAAW,cAAc;IAC7B,SAAS,EAAE,OAAO,CAAC,OAAO,iBAAiB,CAAC,CAAC;IAC7C,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,GAAG,CAAC;CACd;AAED,KAAK,OAAO,CAAC,CAAC,SAAS,MAAM,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;AAE5C,KAAK,+BAA+B,GAAG;KAAG,CAAC,IAAI,OAAO,CAAC,OAAO,iBAAiB,CAAC,GAAG,MAAM;CAAE,CAAC;AAE5F,KAAK,cAAc,GAAG,OAAO,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAsCxD,qBAAa,aAAc,SAAQ,KAAK;IACtC,SAAS,EAAE,cAAc,CAAkC;IAE3D,OAAO,SAAM;IAEb,MAAM,EAAE,GAAG,CAAM;gBAEL,aAAa,EAAE,cAAc,GAAG,MAAM;CAmBnD;AAED,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAubpB,CAAC;AAEX,eAAO,MAAM,wBAAwB,EAAE,+BAmJ7B,CAAC;AAEX,eAAO,MAAM,UAAU,kBACN,cAAc,GAAG,MAAM,YAC5B,MAAM,WACP,GAAG,kBAMb,CAAC;AAEF,eAAO,MAAM,cAAc,YAAa,GAAG,QAe1C,CAAC;AAEF,eAAO,MAAM,oBAAoB,YAAa,MAAM,KAAG,aAOtD,CAAC;AAGF,eAAO,MAAM,gCAAgC,QAAS,MAAM,KAAG,aAQ9D,CAAC;AAEF,QAAA,MAAM,uCAAuC;oBAM3B,MAAM;oBACN,MAAM;;;mBAcvB,CAAC;AAEF,QAAA,MAAM,sCAAsC;oBAM1B,MAAM;oBACN,MAAM;;;mBAcvB,CAAC;AAEF,QAAA,MAAM,yCAAyC,cAClC,MAAM,GAAG,SAAS,YACnB,MAAM,GAAG,SAAS,iBACb,CAAC,UAAU,GAAG,KAAK,CAAC,EAAE,oBACnB;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,GAAG,CAAC,EAAE,MAAM,CAAC;CACd,kBAsBF,CAAC;AAEF,QAAA,MAAM,6BAA6B,mBACjB,MAAM,qBACH,MAAM,eACZ,MAAM,kBAQpB,CAAC;AAEF,QAAA,MAAM,4BAA4B,aACtB,MAAM,aACL,MAAM,cACL,MAAM,cACN,MAAM,aACP,MAAM,kBAWlB,CAAC;AAEF,QAAA,MAAM,iCAAiC,eAAgB,MAAM,gBAAgB,aAAa,kBAItF,CAAC;AAEL,OAAO,EACL,uCAAuC,EACvC,sCAAsC,EACtC,yCAAyC,EACzC,6BAA6B,EAC7B,4BAA4B,EAC5B,iCAAiC,GAClC,CAAC"}

package/dist/index.d.ts

@@ -13,7 +13,15 @@ type WebUsbIdentityDescriptor = {
     manufacturerName?: string | null;
 };
 declare const isKnownTrezorWebUsbDevice: (descriptor: WebUsbIdentityDescriptor) => boolean;
+/**
+ * Error codes that require device release after occurrence
+ * These errors indicate the device is in an invalid state and needs to be released
+ */
 declare const ERROR_CODES_REQUIRE_RELEASE: readonly [106, 107, 109, 112, 805, 801, 802, 812];
+/**
+ * Error codes that require device disconnect before release
+ * These errors indicate a communication failure that requires full reconnection
+ */
 declare const ERROR_CODES_REQUIRE_DISCONNECT: readonly [106, 805];
 declare enum EOneKeyBleMessageKeys {
     BLE_SELECT = "$onekey-ble-select",
@@ -76,53 +84,201 @@ declare class HardwareError extends Error {
     constructor(hardwareError: IHardwareError | string);
 }
 declare const HardwareErrorCode: {
+    /**
+     * This error can be thrown when unexpected error occurred and in most cases it is related to implementation bug.
+     * Original message is available in message property.
+     */
     readonly UnknownError: 0;
+    /**
+     * Firmware version mismatch
+     */
     readonly DeviceFwException: 101;
+    /**
+     * Device unexpected mode
+     */
     readonly DeviceUnexpectedMode: 102;
+    /**
+     * Device list is not initialized
+     */
     readonly DeviceListNotInitialized: 103;
+    /**
+     * Please select the connected device
+     */
     readonly SelectDevice: 104;
+    /**
+     * Device not found
+     */
     readonly DeviceNotFound: 105;
+    /**
+     * Device is not initialized
+     */
     readonly DeviceInitializeFailed: 106;
+    /**
+     * Device interrupted from another operation
+     */
     readonly DeviceInterruptedFromOutside: 107;
+    /**
+     * Device should be in bootloader mode
+     */
     readonly RequiredButInBootloaderMode: 108;
+    /**
+     * Device interrupted from user
+     */
     readonly DeviceInterruptedFromUser: 109;
+    /**
+     * Check device id is same
+     */
     readonly DeviceCheckDeviceIdError: 110;
+    /**
+     * Do not support passphrase
+     * @params: { require: string }
+     */
     readonly DeviceNotSupportPassphrase: 111;
     readonly DeviceCheckPassphraseStateError: 112;
+    /**
+     * use passphrase, but passphrase is not opened
+     */
     readonly DeviceNotOpenedPassphrase: 113;
+    /**
+     * not use passphrase, but passphrase is opened
+     */
     readonly DeviceOpenedPassphrase: 114;
+    /**
+     *  Detect hardware that is in bootloader mode and return an error.
+     */
     readonly DeviceDetectInBootloaderMode: 115;
+    /**
+     * Device not allow in bootloader mode
+     */
     readonly NotAllowInBootloaderMode: 116;
+    /**
+     * Device is busy
+     */
     readonly DeviceBusy: 117;
+    /**
+     * Device check unlock type not match error
+     */
     readonly DeviceCheckUnlockTypeError: 118;
+    /**
+     * Not initialized
+     */
     readonly NotInitialized: 200;
+    /**
+     * Iframe not initialized
+     */
     readonly IFrameNotInitialized: 300;
+    /**
+     * iframe repeat initialization
+     */
     readonly IFrameAleradyInitialized: 301;
+    /**
+     * iframe load failure
+     */
     readonly IFrameLoadFail: 302;
+    /**
+     * init iframe time out
+     */
     readonly IframeTimeout: 303;
+    /**
+     * iframe blocked
+     */
     readonly IframeBlocked: 304;
+    /**
+     * iframe host not trust
+     */
     readonly IframeDistrust: 305;
+    /**
+     * Runtime errors during method execution
+     */
     readonly CallMethodError: 400;
+    /**
+     * Method does not responding
+     */
     readonly CallMethodNotResponse: 404;
+    /**
+     * Call method invalid parameter
+     */
     readonly CallMethodInvalidParameter: 405;
+    /**
+     * firmware update download failed
+     */
     readonly FirmwareUpdateDownloadFailed: 406;
+    /**
+     * Call method not supported, need update firmware
+     * @params: { current: string, require: string }
+     */
     readonly CallMethodNeedUpgradeFirmware: 407;
+    /**
+     * Call method not supported, is deprecated
+     * @params: { current: string, deprecated: string }
+     */
     readonly CallMethodDeprecated: 408;
+    /**
+     * Only one device can be connected during firmware upgrade
+     */
     readonly FirmwareUpdateLimitOneDevice: 409;
+    /**
+     * You need to manually enter boot
+     */
     readonly FirmwareUpdateManuallyEnterBoot: 410;
+    /**
+     * Manual entry fails. You must manually enter the boot
+     */
     readonly FirmwareUpdateAutoEnterBootFailure: 411;
+    /**
+     * The new firmware has not been released yet
+     */
     readonly NewFirmwareUnRelease: 412;
+    /**
+     * use OneKey desktop client to update the firmware
+     * because need copy resource file to Touch
+     */
     readonly UseDesktopToUpdateFirmware: 413;
+    /**
+     * Mandatory firmware update
+     * @params:{ connectId: string? , deviceId: string? }
+     */
     readonly NewFirmwareForceUpdate: 414;
+    /**
+     * Device not support this method
+     */
     readonly DeviceNotSupportMethod: 415;
+    /**
+     * Forbidden key path
+     */
     readonly ForbiddenKeyPath: 416;
+    /**
+     * Repeat unlocking
+     * all network get address by loop need repeat unlocking
+     */
     readonly RepeatUnlocking: 417;
+    /**
+     * Defective firmware detected
+     */
     readonly DefectiveFirmware: 418;
+    /**
+     * Netword request error
+     */
     readonly NetworkError: 500;
+    /**
+     * Transport not configured
+     */
     readonly TransportNotConfigured: 600;
+    /**
+     * Transport call in progress
+     */
     readonly TransportCallInProgress: 601;
+    /**
+     * Transport not found
+     */
     readonly TransportNotFound: 602;
+    /**
+     * Transport invalid protobuf
+     */
     readonly TransportInvalidProtobuf: 603;
+    /**
+     * Bluetooth error code
+     */
     readonly BleScanError: 700;
     readonly BlePermissionError: 701;
     readonly BleLocationError: 702;
@@ -146,39 +302,143 @@ declare const HardwareErrorCode: {
     readonly BleDeviceDisconnected: 720;
     readonly BlePoweredOff: 721;
     readonly BleUnsupported: 722;
+    /**
+     * Hardware runtiome errors
+     */
     readonly RuntimeError: 800;
+    /**
+     * invalid pin
+     */
     readonly PinInvalid: 801;
+    /**
+     * pin cancelled by user
+     */
     readonly PinCancelled: 802;
+    /**
+     * Action cancelled by user
+     */
     readonly ActionCancelled: 803;
+    /**
+     * Firmware installation failed
+     */
     readonly FirmwareError: 804;
+    /**
+     * transport response unexpect error
+     */
     readonly ResponseUnexpectTypeError: 805;
+    /**
+     * bridge network error
+     */
     readonly BridgeNetworkError: 806;
+    /**
+     * Bridge network timeout
+     */
     readonly BridgeTimeoutError: 807;
+    /**
+     * Bridge not installed
+     */
     readonly BridgeNotInstalled: 808;
+    /**
+     * ensure connect timeout
+     */
     readonly PollingTimeout: 809;
+    /**
+     * ensure connect stop polling
+     */
     readonly PollingStop: 810;
+    /**
+     * Device does not open blid sign
+     */
     readonly BlindSignDisabled: 811;
     readonly UnexpectPassphrase: 812;
+    /**
+     * NFT file already exists
+     */
     readonly FileAlreadyExists: 813;
+    /**
+     * check file length error
+     */
     readonly CheckDownloadFileError: 814;
+    /**
+     * not in signing mode
+     */
     readonly NotInSigningMode: 815;
+    /**
+     * not in signing mode
+     */
     readonly DataOverload: 816;
+    /**
+     * device disconnected during action
+     */
     readonly BridgeDeviceDisconnected: 817;
+    /**
+     * BTC PSBT too many utxos
+     * @params:{ count: number }
+     */
     readonly BTCPsbtTooManyUtxos: 818;
+    /**
+     * EMMC file write firmware error
+     */
     readonly EmmcFileWriteFirmwareError: 819;
+    /**
+     * Firmware verification failed (e.g., bootloader file verify failed)
+     */
     readonly FirmwareVerificationFailed: 820;
+    /**
+     * Web bridge coonect needs permission
+     */
     readonly BridgeNeedsPermission: 821;
     readonly CallQueueActionCancelled: 822;
+    /**
+     * Firmware downgrade not allowed
+     */
     readonly FirmwareDowngradeNotAllowed: 823;
+    /**
+     * Cosmos invalid JSON message, Only support Amino msgs.
+     */
     readonly CosmosInvalidJsonMessage: 824;
+    /**
+     * No setting provided
+     */
     readonly DeviceSettingsNotProvided: 825;
+    /**
+     * Language not supported
+     */
     readonly DeviceSettingsLanguageNotSupport: 826;
+    /**
+     * Too many inputs
+     * @params: { count?: string }
+     */
     readonly TooManyInputs: 827;
+    /**
+     * The two PIN entries did not match while setting/changing PIN on device
+     */
     readonly PinMismatch: 828;
+    /**
+     * Protocol V2 device must be unlocked before the requested operation.
+     * @params: { failureCode?: string; subcode?: number; firmwareMessage?: string }
+     */
     readonly DeviceLocked: 829;
+    /**
+     * Device refused to sign: refTxs don't match the spent input's outpoint
+     */
     readonly KaspaPrevTxIdMismatch: 830;
+    /**
+     * The cached wallet session is invalid or has expired.
+     * @params: { failureCode?: string; subcode?: number; firmwareMessage?: string }
+     */
+    readonly WalletSessionInvalid: 831;
+    /**
+     * Lowlevel transport connect error
+     */
     readonly LowlevelTrasnportConnectError: 900;
+    /**
+     * Web USB or Web Bluetooth device not found or needs permission
+     */
     readonly WebDeviceNotFoundOrNeedsPermission: 901;
+    /**
+     * Web USB or Web Bluetooth device prompt access error
+     */
     readonly WebDevicePromptAccessError: 902;
 };
 declare const HardwareErrorCodeMessage: HardwareErrorCodeMessageMapping;

package/dist/index.js

@@ -166,6 +166,7 @@ const HardwareErrorCode = {
     PinMismatch: 828,
     DeviceLocked: 829,
     KaspaPrevTxIdMismatch: 830,
+    WalletSessionInvalid: 831,
     LowlevelTrasnportConnectError: 900,
     WebDeviceNotFoundOrNeedsPermission: 901,
     WebDevicePromptAccessError: 902,
@@ -272,6 +273,7 @@ const HardwareErrorCodeMessage = {
     [HardwareErrorCode.PinMismatch]: 'PIN mismatch',
     [HardwareErrorCode.DeviceLocked]: 'Device locked',
     [HardwareErrorCode.KaspaPrevTxIdMismatch]: 'Kaspa previous transaction id mismatch',
+    [HardwareErrorCode.WalletSessionInvalid]: 'Wallet session is invalid or expired',
     [HardwareErrorCode.LowlevelTrasnportConnectError]: 'Lowlevel transport connect error',
     [HardwareErrorCode.WebDeviceNotFoundOrNeedsPermission]: 'Web-USB or Web-Bluetooth device not found or needs permission',
     [HardwareErrorCode.WebDevicePromptAccessError]: 'Web-USB or Web-Bluetooth device prompt access error',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@onekeyfe/hd-shared",
-  "version": "1.2.0-alpha.19",
+  "version": "1.2.0-alpha.20",
   "description": "Hardware SDK's shared tool library",
   "keywords": [
     "Hardware-SDK",
@@ -25,5 +25,5 @@
     "lint": "eslint .",
     "lint:fix": "eslint . --fix"
   },
-  "gitHead": "4e79f6a400463f342285b9a761b6b84523f1d6b9"
+  "gitHead": "5fbc1ada90fd3cfda7e5ef08be368cb452018733"
 }

package/src/HardwareError.ts

@@ -495,6 +495,12 @@ export const HardwareErrorCode = {
    */
   KaspaPrevTxIdMismatch: 830,
 
+  /**
+   * The cached wallet session is invalid or has expired.
+   * @params: { failureCode?: string; subcode?: number; firmwareMessage?: string }
+   */
+  WalletSessionInvalid: 831,
+
   /**
    * Lowlevel transport connect error
    */
@@ -648,6 +654,7 @@ export const HardwareErrorCodeMessage: HardwareErrorCodeMessageMapping = {
   [HardwareErrorCode.PinMismatch]: 'PIN mismatch',
   [HardwareErrorCode.DeviceLocked]: 'Device locked',
   [HardwareErrorCode.KaspaPrevTxIdMismatch]: 'Kaspa previous transaction id mismatch',
+  [HardwareErrorCode.WalletSessionInvalid]: 'Wallet session is invalid or expired',
 
   /**
    * Lowlevel transport

package/src/constants.ts

@@ -10,10 +10,10 @@ export type HardwareConnectProtocol =
 
 export const ONEKEY_WEBUSB_FILTER = [
   { vendorId: 0x1209, productId: 0x53c0 }, // Classic Boot、Classic1s Boot、Mini Boot
-  { vendorId: 0x1209, productId: 0x53c1 }, // Classic Firmware、Classic1s Firmware、Mini Firmware、Pro Firmware、Touch Firmware、Pro2（旧固件，勿删：存量设备仍以此 PID 枚举）
-  { vendorId: 0x1209, productId: 0x4f4a }, // Pro Boot、Touch Boot、Pro2
-  { vendorId: 0x1209, productId: 0x4f4b }, // Pro Firmware、Touch Firmware（Not implemented Trezor）、Pro2
-  { vendorId: 0x1209, productId: 0x4f4c }, // Pro Board、Pro2（新固件 PID）
+  { vendorId: 0x1209, productId: 0x53c1 }, // Classic/Classic1s/Mini/Pro/Touch firmware and legacy Pro2; keep for existing devices
+  { vendorId: 0x1209, productId: 0x4f4a }, // Pro bootloader, Touch bootloader, Pro2
+  { vendorId: 0x1209, productId: 0x4f4b }, // Pro/Touch firmware (Trezor not implemented), Pro2
+  { vendorId: 0x1209, productId: 0x4f4c }, // Pro board and Pro2 with the new firmware PID
   // { vendorId: 0x1209, productId: 0x4f50 }, // Touch Board
 ];