@onekeyfe/hd-core 0.1.3 → 0.1.6

package/src/api/utils.ts

@@ -1,11 +1,11 @@
+import { ERRORS, HardwareErrorCode } from '@onekeyfe/hd-shared';
 import * as ApiMethods from './index';
-import { TypedError } from '../constants/errors';
 import { IFrameCallMessage } from '../events';
 
 export function findMethod(message: IFrameCallMessage & { id?: number }) {
   const { method } = message.payload;
   if (typeof method !== 'string') {
-    throw TypedError('Method_InvalidParameter', 'Method is not set');
+    throw ERRORS.TypedError(HardwareErrorCode.CallMethodInvalidParameter, 'Method is not set');
   }
 
   // @ts-expect-error
@@ -14,5 +14,8 @@ export function findMethod(message: IFrameCallMessage & { id?: number }) {
     return new MethodConstructor(message);
   }
 
-  throw TypedError('Method_InvalidParameter', `Method ${method} is not set`);
+  throw ERRORS.TypedError(
+    HardwareErrorCode.CallMethodInvalidParameter,
+    `Method ${method} is not set`
+  );
 }

package/src/constants/errors.ts

@@ -1,49 +1,9 @@
-export const ERROR_CODES = {
-  // methods error
-  Method_InvalidParameter: '',
-  Call_API: '',
-  Call_NotResponse: 'No response data',
-  Method_FirmwareUpdate_DownloadFailed: '',
+import { HardwareError, ERRORS } from '@onekeyfe/hd-shared';
 
-  // device error
-  Transport_InvalidProtobuf: '',
-  Device_FwException: '',
-  Device_UnexpectedMode: '',
-  Device_CallInProgress: '',
-  Device_InitializeFailed: '',
-  Device_Interrupted: 'The device is performing other operations',
-  Not_Use_Onekey_Device: 'Please use onekey device',
-
-  // runtime error
-  Runtime: '',
-
-  // iframe error
-  Init_NotInitialized: 'Init_NotInitialized',
-  Init_IframeBlocked: 'Init_IframeBlocked',
-  Init_IframeTimeout: 'Init_IframeTimeout',
-  Init_AlreadyInitialized: 'Init_AlreadyInitialized',
-  Init_IframeLoadFail: 'Init_IframeLoadFail',
-};
-
-export class OnekeyError extends Error {
-  code: string;
-
-  message: string;
-
-  constructor(code: string, message: string) {
-    super(message);
-    this.code = code;
-    this.message = message;
-  }
-}
-
-export const TypedError = (id: keyof typeof ERROR_CODES, message?: string) =>
-  new OnekeyError(id, message || ERROR_CODES[id]);
-
-// serialize Error/TypeError object into payload error type (Error object/class is converted to string while sent via postMessage)
-export const serializeError = (payload: any) => {
-  if (payload && payload.error instanceof Error) {
-    return { error: payload.error.message, code: payload.error.code };
+export const safeThrowError = (error: any) => {
+  if (error instanceof HardwareError) {
+    throw error;
+  } else {
+    throw ERRORS.TypedError(error);
   }
-  return payload;
 };

package/src/constants/index.ts

@@ -1,2 +1,2 @@
-export * as ERRORS from './errors';
+export { safeThrowError } from './errors';
 export { Messages as PROTO } from '@onekeyfe/hd-transport';

package/src/core/index.ts

@@ -1,13 +1,13 @@
 import semver from 'semver';
 import EventEmitter from 'events';
 import { OneKeyDeviceInfo } from '@onekeyfe/hd-transport';
-import { ERRORS } from '../constants';
+import { createDeferred, Deferred, ERRORS, HardwareErrorCode } from '@onekeyfe/hd-shared';
 import { Device, DeviceEvents } from '../device/Device';
 import { DeviceList } from '../device/DeviceList';
 import { findMethod } from '../api/utils';
 import { DataManager } from '../data-manager';
 import { enableLog } from '../utils/logger';
-import { initLog, create as createDeferred, Deferred } from '../utils';
+import { initLog } from '../utils';
 import {
   CoreMessage,
   createResponseMessage,
@@ -45,12 +45,7 @@ const deviceCacheMap = new Map<string, Device>();
 
 export const callAPI = async (message: CoreMessage) => {
   if (!message.id || !message.payload || message.type !== IFRAME.CALL) {
-    return Promise.reject(
-      ERRORS.TypedError(
-        'Method_InvalidParameter',
-        'onCall: message.id or message.payload is missing'
-      )
-    );
+    return Promise.reject(ERRORS.TypedError('on call: message.id or message.payload is missing'));
   }
 
   // find api method
@@ -70,10 +65,7 @@ export const callAPI = async (message: CoreMessage) => {
       const response = await method.run();
       return createResponseMessage(method.responseID, true, response);
     } catch (error) {
-      return createResponseMessage(method.responseID, false, {
-        code: error.code,
-        error: error.message ?? error,
-      });
+      return createResponseMessage(method.responseID, false, { error });
     }
   }
 
@@ -123,7 +115,7 @@ export const callAPI = async (message: CoreMessage) => {
         if (semver.valid(versionRange.min) && semver.lt(currentVersion, versionRange.min)) {
           return Promise.reject(
             ERRORS.TypedError(
-              'Device_FwException',
+              HardwareErrorCode.DeviceFwException,
               `Device firmware version is too low, please update to ${versionRange.min}`
             )
           );
@@ -135,7 +127,7 @@ export const callAPI = async (message: CoreMessage) => {
         ) {
           return Promise.reject(
             ERRORS.TypedError(
-              'Device_FwException',
+              HardwareErrorCode.DeviceFwException,
               `Device firmware version is too high, this method has been deprecated in ${versionRange.max}`
             )
           );
@@ -148,7 +140,9 @@ export const callAPI = async (message: CoreMessage) => {
         method.requireDeviceMode
       );
       if (unexpectedMode) {
-        return Promise.reject(ERRORS.TypedError('Device_UnexpectedMode', unexpectedMode));
+        return Promise.reject(
+          ERRORS.TypedError(HardwareErrorCode.DeviceUnexpectedMode, unexpectedMode)
+        );
       }
 
       // const deviceTypeException = method.checkDeviceType();
@@ -168,7 +162,7 @@ export const callAPI = async (message: CoreMessage) => {
         _callPromise?.resolve(messageResponse);
       } catch (error) {
         Log.debug('Call API - Inner Method Run Error: ', error);
-        messageResponse = createResponseMessage(method.responseID, false, error.message);
+        messageResponse = createResponseMessage(method.responseID, false, { error });
         _callPromise?.resolve(messageResponse);
       }
     };
@@ -180,11 +174,11 @@ export const callAPI = async (message: CoreMessage) => {
       return await _callPromise.promise;
     } catch (e) {
       console.log('Device Run Error: ', e);
-      return createResponseMessage(method.responseID, false, e.message);
+      return createResponseMessage(method.responseID, false, { error: e });
     }
   } catch (error) {
-    messageResponse = createResponseMessage(method.responseID, false, error);
-    _callPromise?.reject(ERRORS.TypedError('Call_API', error));
+    messageResponse = createResponseMessage(method.responseID, false, { error });
+    _callPromise?.reject(ERRORS.TypedError(HardwareErrorCode.CallMethodError, error.message));
     Log.debug('Call API - Run Error: ', error);
   } finally {
     const response = messageResponse;
@@ -219,7 +213,7 @@ async function initDeviceList(method: BaseMethod) {
 
 function initDevice(method: BaseMethod) {
   if (!_deviceList) {
-    throw ERRORS.TypedError('Call_API', 'DeviceList is not initialized');
+    throw ERRORS.TypedError(HardwareErrorCode.DeviceListNotInitialized);
   }
 
   let device: Device | typeof undefined;
@@ -230,11 +224,11 @@ function initDevice(method: BaseMethod) {
   } else if (allDevices.length === 1) {
     [device] = allDevices;
   } else if (allDevices.length > 1) {
-    throw ERRORS.TypedError('Call_API', '请选择连接设备');
+    throw ERRORS.TypedError(HardwareErrorCode.SelectDevice);
   }
 
   if (!device) {
-    throw ERRORS.TypedError('Call_API', 'Device Not Found');
+    throw ERRORS.TypedError(HardwareErrorCode.DeviceNotFound);
   }
 
   // inject properties
@@ -245,7 +239,7 @@ function initDevice(method: BaseMethod) {
 
 function initDeviceForBle(method: BaseMethod) {
   if (!method.connectId && !_deviceList) {
-    throw ERRORS.TypedError('Call_API', 'DeviceList is not initialized');
+    throw ERRORS.TypedError(HardwareErrorCode.DeviceListNotInitialized);
   }
 
   if (!method.connectId) {

package/src/data-manager/TransportManager.ts

@@ -1,5 +1,5 @@
 import { Transport } from '@onekeyfe/hd-transport';
-import { ERRORS } from '../constants';
+import { ERRORS, HardwareErrorCode } from '@onekeyfe/hd-shared';
 import { initLog } from '../utils';
 import DataManager from './DataManager';
 
@@ -57,7 +57,10 @@ export default class TransportManager {
       await this.transport.configure(JSON.stringify(messages));
       this.currentMessages = messages;
     } catch (error) {
-      throw ERRORS.TypedError('Transport_InvalidProtobuf', error.message);
+      throw ERRORS.TypedError(
+        HardwareErrorCode.TransportInvalidProtobuf,
+        `Transport_InvalidProtobuf:  ${error.message as unknown as string}`
+      );
     }
   }
 

package/src/device/Device.ts

@@ -1,10 +1,11 @@
 import EventEmitter from 'events';
 import { OneKeyDeviceInfo as DeviceDescriptor } from '@onekeyfe/hd-transport';
+import { createDeferred, Deferred, HardwareErrorCode, ERRORS } from '@onekeyfe/hd-shared';
 
 import DeviceConnector from './DeviceConnector';
 import { DeviceCommands } from './DeviceCommands';
 
-import { initLog, Deferred, create as createDeferred } from '../utils';
+import { initLog } from '../utils';
 import {
   getDeviceFirmwareVersion,
   getDeviceLabel,
@@ -15,7 +16,7 @@ import {
 import type { Features, Device as DeviceTyped, UnavailableCapabilities } from '../types';
 import { DEVICE, DeviceButtonRequestPayload } from '../events';
 import { UI_REQUEST } from '../constants/ui-request';
-import { ERRORS, PROTO } from '../constants';
+import { PROTO } from '../constants';
 import { DataManager } from '../data-manager';
 
 type RunOptions = {
@@ -266,7 +267,7 @@ export class Device extends EventEmitter {
    * 后续看是否有需要依据 listen 返回结果更新
    * @param descriptor
    */
-  updateDescriptor(descriptor: DeviceDescriptor) {
+  updateDescriptor(descriptor: DeviceDescriptor, forceUpdate = false) {
     const env = DataManager.getSettings('env');
     if (env === 'react-native') {
       return;
@@ -277,12 +278,16 @@ export class Device extends EventEmitter {
     if (originalSession !== upcomingSession) {
       this.originalDescriptor.session = upcomingSession;
     }
+
+    if (forceUpdate) {
+      this.originalDescriptor = descriptor;
+    }
   }
 
   updateFromCache(device: Device) {
     this.mainId = device.mainId;
     this.commands = device.commands;
-    this.updateDescriptor(device.originalDescriptor);
+    this.updateDescriptor(device.originalDescriptor, true);
     if (device.features) {
       this._updateFeatures(device.features);
     }
@@ -311,7 +316,7 @@ export class Device extends EventEmitter {
         this.runPromise = null;
         return Promise.reject(
           ERRORS.TypedError(
-            'Device_InitializeFailed',
+            HardwareErrorCode.DeviceInitializeFailed,
             `Initialize failed: ${error.message as string}, code: ${error.code as string}`
           )
         );
@@ -347,7 +352,7 @@ export class Device extends EventEmitter {
       this.commands.dispose();
     }
     if (this.runPromise) {
-      this.runPromise.reject(ERRORS.TypedError('Device_Interrupted'));
+      this.runPromise.reject(ERRORS.TypedError(HardwareErrorCode.DeviceInterruptedFromOutside));
     }
   }
 

package/src/device/DeviceCommands.ts

@@ -1,6 +1,6 @@
 import type { Transport, Messages } from '@onekeyfe/hd-transport';
+import { ERRORS, HardwareError, HardwareErrorCode } from '@onekeyfe/hd-shared';
 import TransportManager from '../data-manager/TransportManager';
-import { ERRORS } from '../constants';
 import { initLog } from '../utils';
 import type { Device } from './Device';
 import { DEVICE } from '../events';
@@ -26,7 +26,7 @@ const assertType = (res: DefaultMessageResponse, resType: string | string[]) =>
   const splitResTypes = Array.isArray(resType) ? resType : resType.split('|');
   if (!splitResTypes.includes(res.type)) {
     throw ERRORS.TypedError(
-      'Runtime',
+      HardwareErrorCode.RuntimeError,
       `assertType: Response of unexpected type: ${res.type}. Should be ${resType as string}`
     );
   }
@@ -100,7 +100,10 @@ export class DeviceCommands {
     msg?: DefaultMessageResponse['message']
   ) {
     if (this.disposed) {
-      throw ERRORS.TypedError('Runtime', 'typedCall: DeviceCommands already disposed');
+      throw ERRORS.TypedError(
+        HardwareErrorCode.RuntimeError,
+        'typedCall: DeviceCommands already disposed'
+      );
     }
 
     const response = await this._commonCall(type, msg);
@@ -126,20 +129,34 @@ export class DeviceCommands {
     console.log('_filterCommonTypes: ', res);
     if (res.type === 'Failure') {
       const { code } = res.message;
-      let { message } = res.message;
+      const { message } = res.message;
+      let error: HardwareError | null = null;
       // Model One does not send any message in firmware update
       if (code === 'Failure_FirmwareError' && !message) {
-        message = 'Firmware installation failed';
+        error = ERRORS.TypedError(HardwareErrorCode.FirmwareError);
       }
       // Failure_ActionCancelled message could be also missing
-      if (code === 'Failure_ActionCancelled' && !message) {
-        message = 'Action cancelled by user';
+      if (code === 'Failure_ActionCancelled') {
+        error = ERRORS.TypedError(HardwareErrorCode.ActionCancelled);
+      }
+
+      if (code === 'Failure_PinInvalid') {
+        error = ERRORS.TypedError(HardwareErrorCode.PinInvalid, message);
+      }
+
+      if (code === 'Failure_PinCancelled') {
+        error = ERRORS.TypedError(HardwareErrorCode.PinCancelled);
+      }
+
+      if (error) {
+        return Promise.reject(error);
       }
-      // pass code and message from firmware error
+
       return Promise.reject(
-        new ERRORS.OnekeyError(
-          (code as any) || 'Failure_UnknownCode',
-          message || 'Failure_UnknownMessage'
+        ERRORS.TypedError(
+          HardwareErrorCode.RuntimeError,
+          // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
+          `${(code as any) || 'Failure_UnknownCode'},${message || 'Failure_UnknownMessage'}`
         )
       );
     }
@@ -204,7 +221,12 @@ export class DeviceCommands {
         });
       } else {
         console.warn('[DeviceCommands] [call] PIN callback not configured, cancelling request');
-        reject(ERRORS.TypedError('Runtime', '_promptPin: PIN callback not configured'));
+        reject(
+          ERRORS.TypedError(
+            HardwareErrorCode.RuntimeError,
+            '_promptPin: PIN callback not configured'
+          )
+        );
       }
     });
   }

package/src/device/DeviceConnector.ts

@@ -1,4 +1,5 @@
 import { Transport, OneKeyDeviceInfo as DeviceDescriptor } from '@onekeyfe/hd-transport';
+import { safeThrowError } from '../constants';
 import { DataManager } from '../data-manager';
 import TransportManager from '../data-manager/TransportManager';
 import { initLog } from '../utils';
@@ -98,8 +99,7 @@ export default class DeviceConnector {
       Log.debug('diff result: ', diff);
       return diff;
     } catch (error) {
-      throw new Error(error);
-      // empty
+      safeThrowError(error);
     }
   }
 
@@ -152,7 +152,7 @@ export default class DeviceConnector {
       }
       return res;
     } catch (error) {
-      throw new Error(error);
+      safeThrowError(error);
     }
   }
 
@@ -161,7 +161,7 @@ export default class DeviceConnector {
       const res = await this.transport.release(session, onclose);
       return res;
     } catch (error) {
-      throw new Error(error);
+      safeThrowError(error);
     }
   }
 

package/src/events/call.ts

@@ -1,4 +1,4 @@
-import { serializeError } from '../constants/errors';
+import { serializeError } from '@onekeyfe/hd-shared';
 import { IFRAME } from './iframe';
 import { CommonParams, CoreApi } from '../types';
 

package/src/events/core.ts

@@ -1,3 +1,4 @@
+import { HardwareError } from '@onekeyfe/hd-shared';
 import { Unsuccessful } from '../types/params';
 import { IFrameCallMessage, IFrameCancelMessage } from './call';
 import { DeviceEventMessage } from './device';
@@ -40,10 +41,13 @@ export const parseMessage = (messageData: any): CoreMessage => {
   return message;
 };
 
-export const createErrorMessage = (error: Error & { code?: string }): Unsuccessful => ({
-  success: false,
-  payload: {
-    error: error.message,
-    code: error.code,
-  },
-});
+export const createErrorMessage = (error: Error & { code?: string | number }): Unsuccessful => {
+  let payload = { error: error.message, code: error.code };
+  if (error instanceof HardwareError) {
+    payload = { error: error.message, code: error.errorCode };
+  }
+  return {
+    success: false,
+    payload,
+  };
+};

package/src/events/ui-promise.ts

@@ -1,7 +1,7 @@
+import type { Deferred } from '@onekeyfe/hd-shared';
 import type { DEVICE } from './device';
 import type { Device } from '../device/Device';
 import type { UiResponseEvent } from './ui-response';
-import type { Deferred } from '../utils/deferred';
 
 export type UiPromiseResponse =
   | UiResponseEvent

package/src/types/params.ts

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

package/src/utils/index.ts

@@ -2,7 +2,6 @@ import { initLog, enableLog } from './logger';
 
 export * from './assets';
 export * from './versionUtils';
-export * from './deferred';
 export {
   getDeviceType,
   getDeviceTypeByBleName,

package/dist/utils/deferred.d.ts

@@ -1,9 +0,0 @@
-export declare type Deferred<T, I = any, D = any> = {
-    id?: I;
-    data?: D;
-    promise: Promise<T>;
-    resolve: (t: T) => void;
-    reject: (e: Error) => void;
-};
-export declare function create<T, I = any, D = any>(arg?: I, data?: D): Deferred<T, I, D>;
-//# sourceMappingURL=deferred.d.ts.map

package/dist/utils/deferred.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"deferred.d.ts","sourceRoot":"","sources":["../../src/utils/deferred.ts"],"names":[],"mappings":"AAAA,oBAAY,QAAQ,CAAC,CAAC,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,GAAG,GAAG,IAAI;IAC1C,EAAE,CAAC,EAAE,CAAC,CAAC;IACP,IAAI,CAAC,EAAE,CAAC,CAAC;IACT,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;IACpB,OAAO,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,IAAI,CAAC;IACxB,MAAM,EAAE,CAAC,CAAC,EAAE,KAAK,KAAK,IAAI,CAAC;CAC5B,CAAC;AAEF,wBAAgB,MAAM,CAAC,CAAC,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,GAAG,GAAG,EAAE,GAAG,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CA0BhF"}

package/src/utils/deferred.ts

@@ -1,35 +0,0 @@
-export type Deferred<T, I = any, D = any> = {
-  id?: I;
-  data?: D;
-  promise: Promise<T>;
-  resolve: (t: T) => void;
-  reject: (e: Error) => void;
-};
-
-export function create<T, I = any, D = any>(arg?: I, data?: D): Deferred<T, I, D> {
-  let localResolve: (t: T) => void = (_t: T) => {};
-  let localReject: (e?: Error) => void = (_e?: Error) => {};
-  let id: I | undefined;
-
-  // eslint-disable-next-line no-async-promise-executor
-  const promise: Promise<T> = new Promise(async (resolve, reject) => {
-    localResolve = resolve;
-    localReject = reject;
-    if (typeof arg === 'function') {
-      try {
-        await arg();
-      } catch (error) {
-        reject(error);
-      }
-    }
-    if (typeof arg === 'string') id = arg;
-  });
-
-  return {
-    id,
-    data,
-    resolve: localResolve,
-    reject: localReject,
-    promise,
-  };
-}