@onetokenfe/hd-core 1.1.23

package/src/core/index.ts

@@ -0,0 +1,1320 @@
+import semver from 'semver';
+import EventEmitter from 'events';
+import {
+  ERRORS,
+  ERROR_CODES_REQUIRE_RELEASE,
+  HardwareError,
+  HardwareErrorCode,
+  createDefectiveFirmwareError,
+  createDeferred,
+  createDeprecatedHardwareError,
+  createDeviceNotSupportMethodError,
+  createNeedUpgradeFirmwareHardwareError,
+  createNewFirmwareForceUpdateHardwareError,
+  createNewFirmwareUnReleaseHardwareError,
+} from '@onetokenfe/hd-shared';
+
+import {
+  LoggerNames,
+  enableLog,
+  getDeviceBLEFirmwareVersion,
+  getDeviceFirmwareVersion,
+  getFirmwareType,
+  getLogger,
+  getMethodVersionRange,
+  setLoggerPostMessage,
+  wait,
+} from '../utils';
+import {
+  findDefectiveBatchDevice,
+  getDefectiveDeviceInfo,
+} from '../utils/findDefectiveBatchDevice';
+import { supportNewPassphrase } from '../utils/deviceFeaturesUtils';
+import {
+  cleanupSdkInstance,
+  completeRequestContext,
+  createRequestContext,
+  createSdkTracingContext,
+  formatRequestContext,
+  getActiveRequestsByDeviceInstance,
+  updateRequestContext,
+} from '../utils/tracing';
+import { Device } from '../device/Device';
+import { DeviceList } from '../device/DeviceList';
+import { DevicePool } from '../device/DevicePool';
+import { findMethod } from '../api/utils';
+import { DataManager } from '../data-manager';
+import { UI_REQUEST as UI_REQUEST_CONST } from '../constants/ui-request';
+import {
+  CORE_EVENT,
+  DEVICE,
+  IFRAME,
+  UI_REQUEST,
+  UI_RESPONSE,
+  createDeviceMessage,
+  createResponseMessage,
+  createUiMessage,
+} from '../events';
+import TransportManager from '../data-manager/TransportManager';
+import DeviceConnector from '../device/DeviceConnector';
+import RequestQueue from './RequestQueue';
+import { getSynchronize } from '../utils/getSynchronize';
+
+import type { ConnectSettings, KnownDevice } from '../types';
+import type { CoreMessage, IFrameCallMessage, UiPromise, UiPromiseResponse } from '../events';
+import type { DeviceEvents, InitOptions, RunOptions } from '../device/Device';
+import type { SdkTracingContext } from '../utils/tracing';
+import type { Deferred } from '@onetokenfe/hd-shared';
+import type {
+  Features,
+  LowlevelTransportSharedPlugin,
+  OneTokenDeviceInfo,
+} from '@onetokenfe/hd-transport';
+import type { BaseMethod } from '../api/BaseMethod';
+
+const Log = getLogger(LoggerNames.Core);
+
+export type CoreContext = ReturnType<Core['getCoreContext']>;
+
+function hasDeriveCardano(method: BaseMethod): boolean {
+  if (
+    method.name.startsWith('allNetworkGetAddress') &&
+    method.payload &&
+    method.payload.bundle &&
+    // @ts-expect-error
+    method.payload.bundle.some(net => net && net.network === 'ada')
+  ) {
+    return true;
+  }
+
+  return method.name.startsWith('cardano') || method.payload?.deriveCardano;
+}
+
+const parseInitOptions = (method?: BaseMethod): InitOptions => ({
+  initSession: method?.payload.initSession,
+  passphraseState: method?.payload.passphraseState,
+  deviceId: method?.payload.deviceId,
+  deriveCardano: method && hasDeriveCardano(method),
+});
+
+let _core: Core;
+let _deviceList: DeviceList | undefined;
+let _connector: DeviceConnector | undefined;
+let _uiPromises: UiPromise<UiPromiseResponse['type']>[] = []; // Waiting for ui response
+
+const deviceCacheMap = new Map<string, Device>();
+let pollingId = 1;
+const pollingState: Record<number, boolean> = {};
+
+let preConnectCache: {
+  passphraseState: string | undefined;
+} = {
+  passphraseState: undefined,
+};
+
+const toError = (error: unknown): Error | undefined => {
+  if (error instanceof Error) return error;
+  if (error == null) return undefined;
+  if (typeof error === 'string') return new Error(error);
+  try {
+    return new Error(JSON.stringify(error));
+  } catch {
+    return new Error(String(error));
+  }
+};
+
+const updateMethodRequestContext = (method: BaseMethod, updates: any) => {
+  if (method.requestContext) {
+    updateRequestContext(method.requestContext.responseID, updates);
+  }
+};
+
+const completeMethodRequestContext = (method: BaseMethod, error?: unknown) => {
+  if (!method.requestContext) {
+    return;
+  }
+  completeRequestContext(method.requestContext.responseID, toError(error));
+};
+
+export const callAPI = async (context: CoreContext, message: CoreMessage) => {
+  if (!message.id || !message.payload || message.type !== IFRAME.CALL) {
+    return Promise.reject(ERRORS.TypedError('on call: message.id or message.payload is missing'));
+  }
+
+  // find api method
+  let method: BaseMethod;
+  try {
+    method = findMethod(message as IFrameCallMessage);
+    method.connector = _connector;
+    method.postMessage = postMessage;
+    method.setContext?.(context);
+
+    method.requestContext = createRequestContext(method.responseID, method.name, {
+      sdkInstanceId: context.sdkInstanceId,
+      connectId: method.connectId,
+    });
+
+    Log.debug(`[${context.sdkInstanceId}] callAPI: ${formatRequestContext(method.requestContext)}`);
+
+    method.init();
+  } catch (error) {
+    return Promise.reject(error);
+  }
+
+  DevicePool.emitter.on(DEVICE.CONNECT, onDeviceConnectHandler);
+
+  if (!method.useDevice) {
+    updateMethodRequestContext(method, { status: 'running' });
+    try {
+      const response = await method.run();
+      completeMethodRequestContext(method);
+      return createResponseMessage(method.responseID, true, response);
+    } catch (error) {
+      completeMethodRequestContext(method, error);
+      return createResponseMessage(method.responseID, false, { error });
+    }
+  }
+  // push method to queue
+  // callApiQueue.push(method);
+
+  // if (callApiQueue.length > 1) {
+  //   Log.debug(
+  //     'should cancel the previous method execution: ',
+  //     callApiQueue.map(m => m.name)
+  //   );
+  // }
+
+  const { requestQueue, methodSynchronize } = context;
+  const error = await methodSynchronize(() => {
+    for (const requestId of requestQueue.getRequestTasksId()) {
+      const task = requestQueue.getTask(requestId);
+      Log.debug(
+        'pre request task: ',
+        `task?.id: ${task?.id},
+      task?.method.connectId: ${task?.method.connectId},
+      task?.method.deviceId: ${task?.method.deviceId},
+      task?.method.name: ${task?.method.name}`
+      );
+      // if (task) {
+      //   return Promise.reject(ERRORS.TypedError(HardwareErrorCode.DeviceBusy));
+      // }
+    }
+    return null;
+  });
+
+  if (error) {
+    return createResponseMessage(method.responseID, false, { error });
+  }
+
+  return onCallDevice(context, message, method);
+};
+
+const waitWithTimeout = async (promise: Promise<any>, timeout: number) => {
+  const timeoutPromise = new Promise((_, reject) => {
+    setTimeout(() => reject(new Error('Request timeout')), timeout);
+  });
+  return Promise.race([promise, timeoutPromise]);
+};
+
+const waitForPendingPromise = async (
+  getPrePendingCallPromise: () => Promise<void> | undefined,
+  removePrePendingCallPromise?: (promise: Promise<void> | undefined) => void
+) => {
+  const pendingPromise = getPrePendingCallPromise();
+  if (pendingPromise) {
+    Log.debug('pre pending call promise before call method, wait for it');
+    try {
+      await waitWithTimeout(pendingPromise, 5 * 1000);
+    } catch (error) {
+      // ignore timeout error
+    }
+    removePrePendingCallPromise?.(pendingPromise);
+    Log.debug('pre pending call promise before call method done');
+  }
+};
+
+const onCallDevice = async (
+  context: CoreContext,
+  message: CoreMessage,
+  method: BaseMethod
+): Promise<any> => {
+  let messageResponse: any;
+
+  const { requestQueue, getPrePendingCallPromise, setPrePendingCallPromise } = context;
+
+  updateMethodRequestContext(method, { status: 'running' });
+
+  const connectStateChange = preConnectCache.passphraseState !== method.payload.passphraseState;
+
+  preConnectCache = {
+    passphraseState: method.payload.passphraseState,
+  };
+
+  if (connectStateChange || method.payload.initSession) {
+    Log.debug('passphrase state change, clear device cache');
+    DevicePool.clearDeviceCache(method.payload.connectId);
+  }
+
+  // wait for previous callback tasks to complete (ensure device does not call concurrently)
+  if (method.connectId) {
+    await context.waitForCallbackTasks(method.connectId);
+  }
+
+  await waitForPendingPromise(getPrePendingCallPromise, setPrePendingCallPromise);
+
+  const task = requestQueue.createTask(method);
+
+  let device: Device;
+  try {
+    /**
+     * Polling to ensure successful connection
+     */
+    if (pollingState[pollingId]) {
+      pollingState[pollingId] = false;
+    }
+    pollingId += 1;
+
+    device = await ensureConnected(context, method, pollingId, task.abortController?.signal);
+  } catch (e) {
+    console.log('ensureConnected error: ', e);
+
+    completeMethodRequestContext(method, e);
+
+    if (e.name === 'AbortError' || e.message === 'Request aborted') {
+      requestQueue.releaseTask(method.responseID);
+      return createResponseMessage(method.responseID, false, {
+        error: ERRORS.TypedError(HardwareErrorCode.ActionCancelled, 'Request cancelled by user'),
+      });
+    }
+    requestQueue.releaseTask(method.responseID);
+    return createResponseMessage(method.responseID, false, { error: e });
+  }
+
+  if (method.payload?.onlyConnectBleDevice) {
+    Log.debug('Call API - only connect ble device: ', device?.mainId);
+    return createResponseMessage(method.responseID, true, null);
+  }
+
+  Log.debug('Call API - setDevice: ', device.mainId);
+  method.setDevice?.(device);
+  method.context = context;
+
+  updateMethodRequestContext(method, {
+    deviceInstanceId: device.instanceId,
+    commandsInstanceId: device.commands?.instanceId,
+  });
+
+  const activeRequests = getActiveRequestsByDeviceInstance(device.instanceId);
+  if (activeRequests.length > 0) {
+    Log.warn(
+      `[${method.instanceId}] Device ${device.instanceId} has ${activeRequests.length} active requests:`,
+      activeRequests.map(formatRequestContext)
+    );
+  }
+
+  device.on(DEVICE.PIN, onDevicePinHandler);
+  device.on(DEVICE.BUTTON, onDeviceButtonHandler);
+  device.on(
+    DEVICE.PASSPHRASE,
+    message.payload.useEmptyPassphrase ? onEmptyPassphraseHandler : onDevicePassphraseHandler
+  );
+  device.on(DEVICE.PASSPHRASE_ON_DEVICE, onEnterPassphraseOnDeviceHandler);
+  device.on(DEVICE.FEATURES, onDeviceFeaturesHandler);
+  device.on(
+    DEVICE.SELECT_DEVICE_IN_BOOTLOADER_FOR_WEB_DEVICE,
+    onSelectDeviceInBootloaderForWebDeviceHandler
+  );
+  device.on(
+    DEVICE.SELECT_DEVICE_FOR_SWITCH_FIRMWARE_WEB_DEVICE,
+    onSelectDeviceForSwitchFirmwareWebDeviceHandler
+  );
+
+  try {
+    if (method.connectId) {
+      await context.waitForCallbackTasks(method.connectId);
+    }
+
+    await waitForPendingPromise(getPrePendingCallPromise, setPrePendingCallPromise);
+
+    const inner = async (): Promise<void> => {
+      // check firmware version
+      const versionRange = getMethodVersionRange(
+        device.features,
+        type => method.getVersionRange()[type]
+      );
+
+      if (device.features) {
+        await DataManager.checkAndReloadData();
+
+        // 检测故障固件设备
+        if (findDefectiveBatchDevice(device.features)) {
+          const defectiveInfo = getDefectiveDeviceInfo(device.features);
+          if (defectiveInfo) {
+            throw createDefectiveFirmwareError(
+              defectiveInfo.serialNo,
+              defectiveInfo.seVersion || 'Unknown',
+              defectiveInfo.deviceType,
+              method.connectId,
+              method.deviceId
+            );
+          }
+        }
+
+        const deviceFirmwareType = getFirmwareType(device.features);
+        const newVersionStatus = DataManager.getFirmwareStatus(device.features, deviceFirmwareType);
+        const bleVersionStatus = DataManager.getBLEFirmwareStatus(device.features);
+
+        const currentFirmwareVersion = getDeviceFirmwareVersion(device.features).join('.');
+        const currentBleVersion = getDeviceBLEFirmwareVersion(device.features).join('.');
+        if (
+          (newVersionStatus === 'required' || bleVersionStatus === 'required') &&
+          method.skipForceUpdateCheck === false
+        ) {
+          // Get current version information for error reporting
+          const currentVersions = {
+            firmware: currentFirmwareVersion,
+            ble: currentBleVersion,
+          };
+
+          // Provide more specific error message based on which version check failed
+          const requiredUpdates: ('firmware' | 'ble')[] = [];
+          if (newVersionStatus === 'required') {
+            requiredUpdates.push('firmware');
+          }
+          if (bleVersionStatus === 'required') {
+            requiredUpdates.push('ble');
+          }
+          throw createNewFirmwareForceUpdateHardwareError(
+            method.connectId,
+            method.deviceId,
+            requiredUpdates,
+            currentVersions
+          );
+        }
+
+        if (versionRange) {
+          if (
+            semver.valid(versionRange.min) &&
+            semver.lt(currentFirmwareVersion, versionRange.min)
+          ) {
+            if (newVersionStatus === 'none' || newVersionStatus === 'valid') {
+              throw createNewFirmwareUnReleaseHardwareError({
+                currentVersion: currentFirmwareVersion,
+                requireVersion: versionRange.min,
+                methodName: method.name,
+                firmwareType: getFirmwareType(device.features),
+              });
+            }
+
+            return Promise.reject(
+              createNeedUpgradeFirmwareHardwareError({
+                currentVersion: currentFirmwareVersion,
+                requireVersion: versionRange.min,
+                methodName: method.name,
+                firmwareType: getFirmwareType(device.features),
+              })
+            );
+          }
+          if (
+            versionRange.max &&
+            semver.valid(versionRange.max) &&
+            semver.gte(currentFirmwareVersion, versionRange.max)
+          ) {
+            return Promise.reject(
+              createDeprecatedHardwareError(currentFirmwareVersion, versionRange.max, method.name)
+            );
+          }
+        } else if (method.strictCheckDeviceSupport) {
+          throw createDeviceNotSupportMethodError(method.name, getFirmwareType(device.features));
+        }
+      }
+
+      // check call method mode
+      const unexpectedMode = device.hasUnexpectedMode(
+        method.allowDeviceMode,
+        method.requireDeviceMode
+      );
+      if (unexpectedMode) {
+        if (unexpectedMode === UI_REQUEST_CONST.NOT_IN_BOOTLOADER) {
+          return Promise.reject(ERRORS.TypedError(HardwareErrorCode.RequiredButInBootloaderMode));
+        }
+        if (unexpectedMode === UI_REQUEST_CONST.BOOTLOADER) {
+          return Promise.reject(ERRORS.TypedError(HardwareErrorCode.NotAllowInBootloaderMode));
+        }
+        return Promise.reject(
+          ERRORS.TypedError(HardwareErrorCode.DeviceUnexpectedMode, unexpectedMode)
+        );
+      }
+
+      if (method.deviceId && method.checkDeviceId) {
+        const isSameDeviceID = device.checkDeviceId(method.deviceId);
+        if (!isSameDeviceID) {
+          return Promise.reject(ERRORS.TypedError(HardwareErrorCode.DeviceCheckDeviceIdError));
+        }
+      }
+
+      /**
+       * check firmware release info
+       */
+      method.checkFirmwareRelease();
+
+      /**
+       * check additional supported feature
+       */
+      method.checkDeviceSupportFeature();
+
+      // reconfigure messages
+      if (_deviceList) {
+        await TransportManager.reconfigure(device.features);
+      }
+
+      // Check to see if it is safe to use Passphrase
+      checkPassphraseEnableState(method, device.features);
+
+      if (device.hasUsePassphrase() && method.useDevicePassphraseState) {
+        // check version
+        const support = supportNewPassphrase(device.features);
+        if (!support.support) {
+          return Promise.reject(
+            ERRORS.TypedError(
+              HardwareErrorCode.DeviceNotSupportPassphrase,
+              `Device not support passphrase, please update to ${support.require}`,
+              {
+                require: support.require,
+              }
+            )
+          );
+        }
+
+        // Check Device passphrase State
+        const passphraseStateSafety = await device.checkPassphraseStateSafety(
+          method.payload?.passphraseState,
+          method.payload?.useEmptyPassphrase,
+          method.payload?.skipPassphraseCheck
+        );
+
+        // Double check, handles the special case of Touch/Pro
+        checkPassphraseEnableState(method, device.features);
+
+        if (!passphraseStateSafety) {
+          DevicePool.clearDeviceCache(method.payload.connectId);
+          return Promise.reject(
+            ERRORS.TypedError(HardwareErrorCode.DeviceCheckPassphraseStateError)
+          );
+        }
+
+        // close pin popup window
+        postMessage(createUiMessage(UI_REQUEST.CLOSE_UI_PIN_WINDOW));
+      }
+
+      // Automatic check safety_check level for Kovan, Ropsten, Rinkeby, Goerli test networks.
+      try {
+        await method.checkSafetyLevelOnTestNet();
+      } catch (e) {
+        const error =
+          e instanceof HardwareError
+            ? e
+            : ERRORS.TypedError(HardwareErrorCode.RuntimeError, 'open safety check failed.');
+        // messageResponse = createResponseMessage(method.responseID, false, { error });
+        // requestQueue.resolveRequest(method.responseID, messageResponse);
+        // return;
+        throw error;
+      }
+
+      method.device?.commands?.checkDisposed();
+
+      try {
+        const response: object = await method.run();
+        Log.debug('Call API - Inner Method Run: ');
+        messageResponse = createResponseMessage(method.responseID, true, response);
+        requestQueue.resolveRequest(method.responseID, messageResponse);
+        completeMethodRequestContext(method);
+      } catch (error) {
+        Log.debug(`Call API - Inner Method Run Error`, error);
+        messageResponse = createResponseMessage(method.responseID, false, { error });
+        requestQueue.resolveRequest(method.responseID, messageResponse);
+        completeMethodRequestContext(method, error);
+
+        // Re-throw errors that need to trigger device release/disconnect in Device._runInner
+        if (
+          error instanceof HardwareError &&
+          ERROR_CODES_REQUIRE_RELEASE.includes(error.errorCode as any)
+        ) {
+          throw error;
+        }
+      }
+    };
+    Log.debug('Call API - Device Run: ', device.mainId);
+
+    const runOptions: RunOptions = {
+      keepSession: method.payload.keepSession,
+      ...parseInitOptions(method),
+    };
+    const deviceRun = () => device.run(inner, runOptions);
+    task.callPromise = createDeferred<any>(deviceRun);
+
+    try {
+      return await task.callPromise.promise;
+    } catch (e) {
+      Log.debug('Device Run Error: ', e);
+      completeMethodRequestContext(method, e);
+      return createResponseMessage(method.responseID, false, { error: e });
+    }
+  } catch (error) {
+    messageResponse = createResponseMessage(method.responseID, false, { error });
+    requestQueue.rejectRequest(
+      method.responseID,
+      ERRORS.TypedError(HardwareErrorCode.CallMethodError, error.message)
+    );
+    Log.debug('Call API - Run Error: ', error);
+    completeMethodRequestContext(method, error);
+  } finally {
+    const response = messageResponse;
+
+    if (response) {
+      if (method) {
+        method.dispose();
+      }
+    }
+
+    // remove method from queue
+    // const index = method.responseID
+    //   ? callApiQueue.findIndex(m => m.responseID === method.responseID)
+    //   : -1;
+    // if (index > -1) {
+    //   callApiQueue.splice(index, 1);
+    //   Log.debug(
+    //     'Remove the finished method from the queue： ',
+    //     callApiQueue.map(m => m.name)
+    //   );
+    // }
+
+    requestQueue.releaseTask(method.responseID);
+
+    closePopup();
+
+    cleanup();
+
+    if (device) {
+      const stillActive = getActiveRequestsByDeviceInstance(device.instanceId);
+      if (stillActive.length > 1) {
+        Log.warn(
+          `[${method.instanceId}] Removing listeners while ${stillActive.length} requests are active!`,
+          {
+            deviceInstanceId: device.instanceId,
+            activeRequests: stillActive.map(formatRequestContext),
+            pinListeners: device.listenerCount(DEVICE.PIN),
+          }
+        );
+      } else {
+        removeDeviceListener(device);
+      }
+    }
+  }
+};
+
+async function initDeviceList(method: BaseMethod) {
+  const env = DataManager.getSettings('env');
+  if (DataManager.isBleConnect(env) && method.connectId) {
+    await TransportManager.configure();
+    return;
+  }
+
+  if (!_deviceList) {
+    _deviceList = new DeviceList();
+    await TransportManager.configure();
+    _deviceList.connector = _connector;
+  }
+
+  await _deviceList.getDeviceLists(method.connectId, parseInitOptions(method));
+}
+
+function initDevice(method: BaseMethod) {
+  if (!_deviceList) {
+    throw ERRORS.TypedError(HardwareErrorCode.DeviceListNotInitialized);
+  }
+
+  let device: Device | typeof undefined;
+  const allDevices = _deviceList.allDevices();
+
+  if (method.payload?.detectBootloaderDevice && allDevices.some(d => d.features?.bootloader_mode)) {
+    throw ERRORS.TypedError(HardwareErrorCode.DeviceDetectInBootloaderMode);
+  }
+
+  if (method.connectId) {
+    device = _deviceList.getDevice(method.connectId);
+  } else if (allDevices.length === 1) {
+    [device] = allDevices;
+  } else if (allDevices.length > 1) {
+    throw ERRORS.TypedError(
+      [
+        'firmwareUpdateV3',
+        'firmwareUpdateV2',
+        'checkFirmwareRelease',
+        'checkBootloaderRelease',
+        'checkBLEFirmwareRelease',
+      ].includes(method.name)
+        ? HardwareErrorCode.FirmwareUpdateLimitOneDevice
+        : HardwareErrorCode.SelectDevice
+    );
+  }
+
+  if (!device) {
+    const env = DataManager.getSettings('env');
+    // Browser WebUSB needs permission prompt, desktop WebUSB doesn't
+    if (DataManager.isBrowserWebUsb(env)) {
+      throw ERRORS.TypedError(HardwareErrorCode.WebDeviceNotFoundOrNeedsPermission);
+    }
+    throw ERRORS.TypedError(HardwareErrorCode.DeviceNotFound);
+  }
+
+  // inject properties
+  device.deviceConnector = _connector;
+
+  return device;
+}
+
+function initDeviceForBle(method: BaseMethod) {
+  if (!method.connectId && !_deviceList) {
+    throw ERRORS.TypedError(HardwareErrorCode.DeviceListNotInitialized);
+  }
+
+  if (!method.connectId) {
+    return initDevice(method);
+  }
+
+  let device: Device;
+  if (deviceCacheMap.has(method.connectId)) {
+    device = deviceCacheMap.get(method.connectId) as Device;
+  } else {
+    device = Device.fromDescriptor(
+      { id: method.connectId } as OneTokenDeviceInfo,
+      method.sdkInstanceId
+    );
+    deviceCacheMap.set(method.connectId, device);
+  }
+  device.deviceConnector = _connector;
+  return device;
+}
+
+/**
+ * If the Bluetooth connection times out, retry 6 times
+ */
+let bleTimeoutRetry = 0;
+
+async function connectDeviceForBle(method: BaseMethod, device: Device) {
+  try {
+    await device.acquire();
+    if (method.payload?.onlyConnectBleDevice) {
+      return;
+    }
+    await device.initialize(parseInitOptions(method));
+  } catch (err) {
+    if (err.errorCode === HardwareErrorCode.BleTimeoutError && bleTimeoutRetry <= 5) {
+      bleTimeoutRetry += 1;
+      Log.debug(`Bletooth connect timeout and will retry, retry count: ${bleTimeoutRetry}`);
+      await wait(3000);
+      await connectDeviceForBle(method, device);
+    } else {
+      throw err;
+    }
+  }
+}
+
+type IPollFn<T> = (time?: number) => T;
+// eslint-disable-next-line @typescript-eslint/require-await
+const ensureConnected = async (
+  _context: CoreContext,
+  method: BaseMethod,
+  pollingId: number,
+  abortSignal?: AbortSignal
+) => {
+  let tryCount = 0;
+  const MAX_RETRY_COUNT =
+    method.payload && typeof method.payload.retryCount === 'number' ? method.payload.retryCount : 5;
+  const POLL_INTERVAL_TIME = (method.payload && method.payload.pollIntervalTime) || 1000;
+  const TIME_OUT = (method.payload && method.payload.timeout) || 10000;
+  let timer: ReturnType<typeof setTimeout> | null = null;
+  Log.debug(
+    `EnsureConnected function start, MAX_RETRY_COUNT=${MAX_RETRY_COUNT}, POLL_INTERVAL_TIME=${POLL_INTERVAL_TIME}  `
+  );
+
+  const poll: IPollFn<Promise<Device>> = async (time = POLL_INTERVAL_TIME) =>
+    // eslint-disable-next-line no-async-promise-executor
+    new Promise(async (resolve, reject) => {
+      const abort = () => {
+        if (abortSignal && abortSignal.aborted) {
+          if (timer) {
+            clearTimeout(timer);
+          }
+          reject(ERRORS.TypedError(HardwareErrorCode.CallQueueActionCancelled));
+          return true;
+        }
+        return false;
+      };
+
+      if (abort()) {
+        return;
+      }
+
+      if (!pollingState[pollingId]) {
+        Log.debug('EnsureConnected function stop, polling id: ', pollingId);
+        reject(ERRORS.TypedError(HardwareErrorCode.PollingStop));
+        return;
+      }
+
+      // 单次连接确保不超时
+      if (timer) {
+        clearTimeout(timer);
+      }
+      timer = setTimeout(() => {
+        reject(ERRORS.TypedError(HardwareErrorCode.PollingTimeout));
+      }, TIME_OUT);
+
+      tryCount += 1;
+      Log.debug('EnsureConnected function try count: ', tryCount, ' poll interval time: ', time);
+      try {
+        await initDeviceList(method);
+      } catch (error) {
+        Log.debug('device list error: ', error);
+        if (
+          [
+            HardwareErrorCode.BridgeNotInstalled,
+            HardwareErrorCode.BridgeTimeoutError,
+            HardwareErrorCode.BridgeNeedsPermission,
+          ].includes(error.errorCode)
+        ) {
+          _deviceList = undefined;
+          reject(error);
+          return;
+        }
+        if (error.errorCode === HardwareErrorCode.TransportNotConfigured) {
+          await TransportManager.configure();
+        }
+      }
+
+      if (abort()) {
+        return;
+      }
+
+      const env = DataManager.getSettings('env');
+      let device: Device;
+      try {
+        if (DataManager.isBleConnect(env)) {
+          device = initDeviceForBle(method);
+        } else {
+          device = initDevice(method);
+        }
+
+        if (device) {
+          if (timer) {
+            clearTimeout(timer);
+          }
+
+          /**
+           * Bluetooth should call initialize here
+           */
+          if (DataManager.isBleConnect(env)) {
+            bleTimeoutRetry = 0;
+
+            if (abort()) {
+              return;
+            }
+            await connectDeviceForBle(method, device);
+          }
+          resolve(device);
+          return;
+        }
+      } catch (error) {
+        Log.debug('device error: ', error);
+        if ([HardwareErrorCode.BleCharacteristicNotifyChangeFailure].includes(error.errorCode)) {
+          postMessage(createUiMessage(UI_REQUEST.BLUETOOTH_CHARACTERISTIC_NOTIFY_CHANGE_FAILURE));
+        }
+        if (
+          [
+            HardwareErrorCode.BlePoweredOff,
+            HardwareErrorCode.BleUnsupported,
+            HardwareErrorCode.BlePermissionError,
+            HardwareErrorCode.BleLocationError,
+            HardwareErrorCode.BleLocationServicesDisabled,
+            HardwareErrorCode.BleDeviceNotBonded,
+            HardwareErrorCode.BleDeviceBondError,
+            HardwareErrorCode.BleDeviceBondedCanceled,
+            HardwareErrorCode.BleCharacteristicNotifyError,
+            HardwareErrorCode.BleTimeoutError,
+            HardwareErrorCode.BleWriteCharacteristicError,
+            HardwareErrorCode.BleAlreadyConnected,
+            HardwareErrorCode.FirmwareUpdateLimitOneDevice,
+            HardwareErrorCode.SelectDevice,
+            HardwareErrorCode.DeviceDetectInBootloaderMode,
+            HardwareErrorCode.BleCharacteristicNotifyChangeFailure,
+            HardwareErrorCode.BridgeNeedsPermission,
+          ].includes(error.errorCode)
+        ) {
+          reject(error);
+          return;
+        }
+      }
+
+      if (tryCount > MAX_RETRY_COUNT) {
+        if (timer) {
+          clearTimeout(timer);
+        }
+        Log.debug('EnsureConnected get to max try count, will return: ', tryCount);
+        // Browser WebUSB needs permission prompt, desktop WebUSB doesn't
+        // skipWebDevicePrompt can override this behavior for special cases
+        if (DataManager.isBrowserWebUsb(env) && !method.payload?.skipWebDevicePrompt) {
+          postMessage(createUiMessage(UI_REQUEST.WEB_DEVICE_PROMPT_ACCESS_PERMISSION));
+          reject(ERRORS.TypedError(HardwareErrorCode.WebDeviceNotFoundOrNeedsPermission));
+        } else {
+          reject(ERRORS.TypedError(HardwareErrorCode.DeviceNotFound));
+        }
+        return;
+      }
+
+      if (abort()) {
+        return;
+      }
+
+      // eslint-disable-next-line no-promise-executor-return
+      return setTimeout(() => resolve(poll(time * 1.5)), time);
+    });
+  pollingState[pollingId] = true;
+  return poll();
+};
+
+export const cancel = (context: CoreContext, connectId?: string) => {
+  const { requestQueue, setPrePendingCallPromise } = context;
+  if (connectId) {
+    try {
+      // let device;
+      // if (DataManager.isBleConnect(env)) {
+      //   device = initDeviceForBle({ connectId } as BaseMethod);
+      // } else {
+      //   device = initDevice({ connectId } as BaseMethod);
+      // }
+      // setPrePendingCallPromise(device?.interruptionFromUser());
+      // requestQueue.abortRequestsByConnectId(connectId);
+
+      // cancel callback tasks
+      requestQueue.cancelCallbackTasks(connectId);
+
+      const requestIds = requestQueue.getRequestTasksId();
+      Log.debug(
+        `Cancel Api connect requestQueues: length:${requestIds.length} requestIds:${requestIds.join(
+          ','
+        )}`
+      );
+      const canceledDevices: Device[] = [];
+      for (const requestId of requestIds) {
+        const task = requestQueue.getTask(requestId);
+        Log.debug('Cancel Api connect task: ', task);
+        if (task && task.method?.device) {
+          if (!canceledDevices.includes(task.method.device)) {
+            const { device } = task.method;
+            setPrePendingCallPromise(device?.interruptionFromUser());
+            canceledDevices.push(device);
+          }
+          requestQueue.rejectRequest(
+            requestId,
+            ERRORS.TypedError(HardwareErrorCode.CallQueueActionCancelled)
+          );
+        }
+      }
+      requestQueue.abortRequestsByConnectId(connectId);
+    } catch (e) {
+      Log.error('Cancel API Error: ', e);
+    }
+  } else {
+    const env = DataManager.getSettings('env');
+    if (DataManager.isBleConnect(env)) {
+      Log.debug('Cancel Api all _deviceList: ');
+      const canceledDevices: Device[] = [];
+      for (const requestId of requestQueue.getRequestTasksId()) {
+        const task = requestQueue.getTask(requestId);
+        Log.debug('Cancel Api connect task: ', task);
+        if (task && task.method?.device) {
+          if (!canceledDevices.includes(task.method.device)) {
+            const { device } = task.method;
+            device?.interruptionFromUser();
+            canceledDevices.push(device);
+          }
+
+          requestQueue.rejectRequest(
+            requestId,
+            ERRORS.TypedError(HardwareErrorCode.CallQueueActionCancelled)
+          );
+        }
+      }
+    } else {
+      _deviceList?.allDevices().forEach(device => {
+        Log.debug('device: ', device, ' device.hasDeviceAcquire: ', device.hasDeviceAcquire());
+        if (device.hasDeviceAcquire()) {
+          device?.interruptionFromUser();
+        }
+      });
+
+      requestQueue.getRequestTasksId().forEach(requestId => {
+        requestQueue.rejectRequest(
+          requestId,
+          ERRORS.TypedError(HardwareErrorCode.CallQueueActionCancelled)
+        );
+      });
+    }
+  }
+
+  cleanup();
+  closePopup();
+};
+
+const checkPassphraseEnableState = (method: BaseMethod, features?: Features) => {
+  if (!method.useDevicePassphraseState) return;
+
+  if (features?.passphrase_protection === true) {
+    const hasNoPassphraseState =
+      method.payload.passphraseState == null || method.payload.passphraseState === '';
+    const shouldRequirePassphrase =
+      !method.payload.useEmptyPassphrase && !method.payload.skipPassphraseCheck;
+
+    if (hasNoPassphraseState && shouldRequirePassphrase) {
+      DevicePool.clearDeviceCache(method.payload.connectId);
+      throw ERRORS.TypedError(HardwareErrorCode.DeviceOpenedPassphrase);
+    }
+  }
+
+  if (features?.passphrase_protection === false && method.payload.passphraseState) {
+    DevicePool.clearDeviceCache(method.payload.connectId);
+    throw ERRORS.TypedError(HardwareErrorCode.DeviceNotOpenedPassphrase);
+  }
+};
+
+const cleanup = () => {
+  _uiPromises = [];
+  Log.debug('Cleanup...');
+};
+
+const removeDeviceListener = (device: Device) => {
+  device.removeAllListeners();
+  DevicePool.emitter.removeAllListeners(DEVICE.CONNECT);
+  // DevicePool.emitter.removeListener(DEVICE.DISCONNECT, onDeviceDisconnectHandler);
+};
+
+/**
+ * Force close popup
+ */
+const closePopup = () => {
+  postMessage(createUiMessage(UI_REQUEST.CLOSE_UI_WINDOW));
+};
+
+const onDeviceConnectHandler = (device: Device) => {
+  const env = DataManager.getSettings('env');
+  const deviceObject = DataManager.isBleConnect(env) ? device : device.toMessageObject();
+  postMessage(createDeviceMessage(DEVICE.CONNECT, { device: deviceObject as KnownDevice }));
+};
+
+const onDeviceDisconnectHandler = (device: Device) => {
+  const env = DataManager.getSettings('env');
+  const deviceObject = DataManager.isBleConnect(env) ? device : device.toMessageObject();
+  postMessage(createDeviceMessage(DEVICE.DISCONNECT, { device: deviceObject as KnownDevice }));
+};
+
+const onDevicePinHandler = async (...[device, type, callback]: DeviceEvents['pin']) => {
+  Log.log('request Input PIN');
+  // create ui promise
+  const uiPromise = createUiPromise(UI_RESPONSE.RECEIVE_PIN, device);
+  // request pin view
+  postMessage(
+    createUiMessage(UI_REQUEST.REQUEST_PIN, {
+      device: device.toMessageObject() as unknown as KnownDevice,
+      type,
+    })
+  );
+  // wait for pin
+  const uiResp = await uiPromise.promise;
+  // callback.apply(null, [null, pin]);
+  callback(null, uiResp.payload);
+};
+
+export const onDeviceButtonHandler = (...[device, request]: [...DeviceEvents['button']]) => {
+  postMessage(createDeviceMessage(DEVICE.BUTTON, { ...request, device: device.toMessageObject() }));
+
+  if (request.code === 'ButtonRequest_PinEntry' || request.code === 'ButtonRequest_AttachPin') {
+    Log.log('request Confirm Input PIN or Attach PIN');
+    postMessage(
+      createUiMessage(UI_REQUEST.REQUEST_PIN, {
+        device: device.toMessageObject() as KnownDevice,
+        type: request.code,
+      })
+    );
+  } else {
+    Log.log('request Confirm Button');
+    postMessage(createUiMessage(UI_REQUEST.REQUEST_BUTTON, { device: device.toMessageObject() }));
+  }
+};
+
+const onDeviceFeaturesHandler = (...[_, features]: [...DeviceEvents['features']]) => {
+  postMessage(createDeviceMessage(DEVICE.FEATURES, { ...features }));
+};
+
+const onDevicePassphraseHandler = async (
+  ...[device, requestPayload, callback]: DeviceEvents['passphrase']
+) => {
+  Log.debug('onDevicePassphraseHandler');
+  const uiPromise = createUiPromise(UI_RESPONSE.RECEIVE_PASSPHRASE, device);
+  postMessage(
+    createUiMessage(UI_REQUEST.REQUEST_PASSPHRASE, {
+      device: device.toMessageObject() as KnownDevice,
+      passphraseState: device.passphraseState,
+      existsAttachPinUser: requestPayload.existsAttachPinUser,
+    })
+  );
+  // wait for passphrase
+  const uiResp = await uiPromise.promise;
+  const { value, passphraseOnDevice, save, attachPinOnDevice } = uiResp.payload;
+  // send as PassphrasePromptResponse
+  callback({
+    passphrase: value.normalize('NFKD'),
+    passphraseOnDevice,
+    attachPinOnDevice,
+    cache: save,
+  });
+};
+
+const onEmptyPassphraseHandler = (...[_, , callback]: DeviceEvents['passphrase']) => {
+  Log.debug('onEmptyPassphraseHandler');
+  // send as PassphrasePromptResponse
+  callback({ passphrase: '' });
+};
+
+const onEnterPassphraseOnDeviceHandler = (
+  ...[device]: [...DeviceEvents['passphrase_on_device']]
+) => {
+  postMessage(
+    createUiMessage(UI_REQUEST.REQUEST_PASSPHRASE_ON_DEVICE, {
+      device: device.toMessageObject() as KnownDevice,
+      passphraseState: device.passphraseState,
+    })
+  );
+};
+
+const onSelectDeviceInBootloaderForWebDeviceHandler = async (
+  ...[device, callback]: [...DeviceEvents['select_device_in_bootloader_for_web_device']]
+) => {
+  Log.debug('onSelectDeviceInBootloaderForWebDeviceHandler');
+  const uiPromise = createUiPromise(UI_RESPONSE.SELECT_DEVICE_IN_BOOTLOADER_FOR_WEB_DEVICE, device);
+  postMessage(
+    createUiMessage(UI_REQUEST.REQUEST_DEVICE_IN_BOOTLOADER_FOR_WEB_DEVICE, {
+      device: device.toMessageObject() as KnownDevice,
+    })
+  );
+  const uiResp = await uiPromise.promise;
+  callback(null, uiResp.payload.deviceId);
+};
+
+const onSelectDeviceForSwitchFirmwareWebDeviceHandler = async (
+  ...[device, callback]: [...DeviceEvents['select_device_for_switch_firmware_web_device']]
+) => {
+  Log.debug('onSelectDeviceForSwitchFirmwareWebDeviceHandler');
+  const uiPromise = createUiPromise(
+    UI_RESPONSE.SELECT_DEVICE_FOR_SWITCH_FIRMWARE_WEB_DEVICE,
+    device
+  );
+  postMessage(
+    createUiMessage(UI_REQUEST.REQUEST_DEVICE_FOR_SWITCH_FIRMWARE_WEB_DEVICE, {
+      device: device.toMessageObject() as KnownDevice,
+    })
+  );
+  const uiResp = await uiPromise.promise;
+  callback(null, uiResp.payload.deviceId);
+};
+
+/**
+ * Emit message to listener (parent).
+ * Clear method reference from _callMethods
+ * @param {CoreMessage} message
+ * @returns {void}
+ * @memberof Core
+ */
+const postMessage = (message: CoreMessage) => {
+  if (!_core) {
+    return;
+  }
+  _core.emit(CORE_EVENT, message);
+};
+
+const createUiPromise = <T extends UiPromiseResponse['type']>(promiseEvent: T, device?: Device) => {
+  const uiPromise: UiPromise<T> = createDeferred(promiseEvent, device);
+  _uiPromises.push(uiPromise as any);
+
+  return uiPromise;
+};
+
+const findUiPromise = <T extends UiPromiseResponse['type']>(promiseEvent: T) =>
+  _uiPromises.find(p => p.id === promiseEvent);
+
+const removeUiPromise = (promise: Deferred<any>) => {
+  _uiPromises = _uiPromises.filter(p => p !== promise);
+};
+
+export default class Core extends EventEmitter {
+  private tracingContext: SdkTracingContext;
+
+  public readonly sdkInstanceId: string;
+
+  private requestQueue = new RequestQueue();
+
+  // background task
+  private prePendingCallPromise: Promise<void> | undefined;
+
+  private methodSynchronize = getSynchronize();
+
+  constructor() {
+    super();
+    this.tracingContext = createSdkTracingContext();
+    this.sdkInstanceId = this.tracingContext.sdkInstanceId;
+    Log.debug(`[Core] Created SDK instance: ${this.sdkInstanceId}`);
+  }
+
+  private getCoreContext() {
+    return {
+      sdkInstanceId: this.sdkInstanceId,
+      tracingContext: this.tracingContext,
+      requestQueue: this.requestQueue,
+      methodSynchronize: this.methodSynchronize,
+      getPrePendingCallPromise: () => this.prePendingCallPromise,
+      setPrePendingCallPromise: (promise: Promise<void> | undefined) => {
+        this.prePendingCallPromise = promise;
+      },
+      // callback 任务管理
+      registerCallbackTask: (connectId: string, callbackPromise: Deferred<any>) => {
+        this.requestQueue.registerPendingCallbackTask(connectId, callbackPromise);
+      },
+      waitForCallbackTasks: (connectId: string) =>
+        this.requestQueue.waitForPendingCallbackTasks(connectId),
+      cancelCallbackTasks: (connectId: string) => this.requestQueue.cancelCallbackTasks(connectId),
+    };
+  }
+
+  async handleMessage(message: CoreMessage) {
+    switch (message.type) {
+      case UI_RESPONSE.RECEIVE_PIN:
+      case UI_RESPONSE.RECEIVE_PASSPHRASE:
+      case UI_RESPONSE.SELECT_DEVICE_IN_BOOTLOADER_FOR_WEB_DEVICE:
+      case UI_RESPONSE.SELECT_DEVICE_FOR_SWITCH_FIRMWARE_WEB_DEVICE: {
+        const uiPromise = findUiPromise(message.type);
+        if (uiPromise) {
+          Log.log('receive UI Response: ', message.type);
+          uiPromise.resolve(message);
+          removeUiPromise(uiPromise);
+        }
+        break;
+      }
+
+      case UI_REQUEST.BLUETOOTH_UNSUPPORTED:
+      case UI_REQUEST.BLUETOOTH_POWERED_OFF:
+      case UI_REQUEST.BLUETOOTH_PERMISSION:
+      case UI_REQUEST.BLUETOOTH_CHARACTERISTIC_NOTIFY_CHANGE_FAILURE:
+      case UI_REQUEST.LOCATION_PERMISSION:
+      case UI_REQUEST.LOCATION_SERVICE_PERMISSION: {
+        postMessage(message);
+        break;
+      }
+
+      case IFRAME.CALL: {
+        Log.log('call API: ', message);
+        const response = await callAPI(this.getCoreContext(), message);
+        const { success, payload } = response;
+        Log.log('call API Response: ', response);
+        if (success) {
+          return response;
+        }
+
+        return {
+          ...response,
+          payload: {
+            ...payload,
+            connectId: message.payload?.connectId ?? '',
+            deviceId: message.payload?.deviceId ?? '',
+          },
+        };
+      }
+      case IFRAME.CANCEL: {
+        Log.log('cancel API: ', message);
+        cancel(this.getCoreContext(), message.payload.connectId);
+        break;
+      }
+      case IFRAME.CALLBACK: {
+        Log.log('callback message: ', message);
+        postMessage(message);
+        break;
+      }
+      default:
+        break;
+    }
+    return Promise.resolve(message);
+  }
+
+  dispose() {
+    _deviceList = undefined;
+    _connector = undefined;
+    Log.debug(`[Core] Disposing SDK instance: ${this.sdkInstanceId}`);
+    cleanupSdkInstance(this.sdkInstanceId);
+  }
+}
+
+export const initCore = () => {
+  _core = new Core();
+  return _core;
+};
+
+export const initConnector = () => {
+  _connector = new DeviceConnector();
+  DevicePool.emitter.on(DEVICE.DISCONNECT, onDeviceDisconnectHandler);
+  return _connector;
+};
+
+const initTransport = (Transport: any, plugin?: LowlevelTransportSharedPlugin) => {
+  TransportManager.setTransport(Transport, plugin);
+};
+
+export const init = async (
+  settings: ConnectSettings,
+  Transport: any,
+  plugin?: LowlevelTransportSharedPlugin
+) => {
+  try {
+    try {
+      await DataManager.load(settings);
+      initTransport(Transport, plugin);
+    } catch {
+      Log.error('DataManager.load error');
+    }
+    enableLog(DataManager.getSettings('debug'));
+    if (DataManager.getSettings('env') !== 'react-native') {
+      setLoggerPostMessage(postMessage);
+    }
+    initCore();
+    initConnector();
+
+    return _core;
+  } catch (error) {
+    Log.error('core init', error);
+  }
+};
+
+export const switchTransport = ({
+  env,
+  Transport,
+  plugin,
+}: {
+  env: ConnectSettings['env'];
+  Transport: any;
+  plugin?: LowlevelTransportSharedPlugin;
+}) => {
+  DataManager.updateEnv(env);
+  TransportManager.setTransport(Transport, plugin);
+  _deviceList = undefined;
+  DevicePool.resetState();
+  _connector = undefined;
+  initConnector();
+};