@onekeyfe/hd-shared 1.2.0-alpha.18 → 1.2.0-alpha.180

package/src/constants.ts

@@ -10,13 +10,16 @@ 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 }, // Pro2 / Neo current firmware, all modes
   // { vendorId: 0x1209, productId: 0x4f50 }, // Touch Board
 ];
 
+/** USB IDs whose first probe should be Protocol V2. Shared Pro/Touch PIDs stay unhinted. */
+export const ONEKEY_PROTOCOL_V2_USB_IDS = [{ vendorId: 0x1209, productId: 0x4f4c }] as const;
+
 type WebUsbIdentityDescriptor = {
   vendorId?: number;
   productId?: number;
@@ -86,14 +89,33 @@ export enum EOneKeyBleMessageKeys {
   NOBLE_BLE_STOP_SCAN = '$onekey-noble-ble-stop-scan',
   NOBLE_BLE_GET_DEVICE = '$onekey-noble-ble-get-device',
   NOBLE_BLE_CONNECT = '$onekey-noble-ble-connect',
+  // Logical end-of-operation from the renderer (keep-alive): the physical link
+  // stays up but the main process starts its idle-disconnect countdown.
+  NOBLE_BLE_RELEASE = '$onekey-noble-ble-release',
   NOBLE_BLE_DISCONNECT = '$onekey-noble-ble-disconnect',
   NOBLE_BLE_WRITE = '$onekey-noble-ble-write',
   NOBLE_BLE_SUBSCRIBE = '$onekey-noble-ble-subscribe',
   NOBLE_BLE_UNSUBSCRIBE = '$onekey-noble-ble-unsubscribe',
   NOBLE_BLE_NOTIFICATION = '$onekey-noble-ble-notification',
+  NOBLE_BLE_MTU_CHANGED = '$onekey-noble-ble-mtu-changed',
   NOBLE_BLE_CANCEL_PAIRING = '$onekey-noble-ble-cancel-pairing',
 }
 
+/**
+ * Why a BLE link went down, carried on BLE_DEVICE_DISCONNECTED.
+ *
+ * The main process frees an idle link on its own keep-alive timer, which is an
+ * internal optimisation the device knows nothing about — consumers must not
+ * treat it as "the device is gone". Only DeviceDisconnected means the
+ * peripheral actually dropped.
+ */
+export enum EBleDisconnectReason {
+  /** Unsolicited peripheral drop: powered off, out of range, cable/BLE lost. */
+  DeviceDisconnected = 'device-disconnected',
+  /** Main-process keep-alive timer released an idle link; device still present. */
+  IdleKeepAlive = 'idle-keep-alive',
+}
+
 export const ONEKEY_SERVICE_UUID = '00000001-0000-1000-8000-00805f9b34fb';
 export const ONEKEY_WRITE_CHARACTERISTIC_UUID = '00000002-0000-1000-8000-00805f9b34fb';
 export const ONEKEY_NOTIFY_CHARACTERISTIC_UUID = '00000003-0000-1000-8000-00805f9b34fb';
@@ -148,9 +170,224 @@ export const isOnekeyDevice = (name: string | null, id?: string): boolean => {
   if (
     normalizedName.startsWith('touch ') ||
     normalizedName.startsWith('pro ') ||
-    normalizedName.startsWith('pro2 ')
+    normalizedName.startsWith('pro2') ||
+    normalizedName.startsWith('neo')
   ) {
     return true;
   }
+  const compactName = compactBleName(normalizedName);
+  if (PRO2_COMPACT_NAME_PATTERN.test(compactName) || NEO_COMPACT_NAME_PATTERN.test(compactName)) {
+    return true;
+  }
   return isOneKeyShortName(normalizedName);
 };
+
+export const inferProtocolHintFromUsbId = (vendorId?: number | null, productId?: number | null) =>
+  ONEKEY_PROTOCOL_V2_USB_IDS.some(id => id.vendorId === vendorId && id.productId === productId)
+    ? ('V2' as const)
+    : undefined;
+
+type UsbDevicePathInput = {
+  serialNumber?: string | null;
+  vendorId?: number;
+  productId?: number;
+  productName?: string | null;
+};
+
+export const resolveOneKeyUsbDevicePath = (device: UsbDevicePathInput): string | undefined => {
+  const serial = device.serialNumber?.trim();
+  if (serial) return serial;
+  if (device.vendorId == null && device.productId == null && !device.productName) {
+    return undefined;
+  }
+
+  const vendorId = (device.vendorId ?? 0).toString(16).padStart(4, '0');
+  const productId = (device.productId ?? 0).toString(16).padStart(4, '0');
+  const product = (device.productName ?? 'onekey')
+    .trim()
+    .toLowerCase()
+    .replace(/\s+/g, '-')
+    .replace(/[^a-z0-9-]/g, '');
+  return `usb-${vendorId}-${productId}-${product || 'onekey'}`;
+};
+
+type BluetoothDeviceIdentity = {
+  id?: string;
+  name?: string | null;
+  localName?: string | null;
+  serviceUuids?: Array<string | null | undefined> | null;
+};
+
+const BLUETOOTH_BASE_UUID_SUFFIX = '00001000800000805f9b34fb';
+
+export const normalizeBleUuid = (uuid?: string | null) =>
+  (uuid ?? '').replace(/-/g, '').toLowerCase();
+
+export const createKnownBleUuidAliases = (uuid: string): ReadonlySet<string> => {
+  const normalized = normalizeBleUuid(uuid);
+  const aliases = new Set([normalized]);
+
+  if (normalized.length !== 32 || !normalized.endsWith(BLUETOOTH_BASE_UUID_SUFFIX)) {
+    return aliases;
+  }
+
+  const assignedNumber = normalized.slice(0, 8);
+  aliases.add(assignedNumber);
+  if (assignedNumber.startsWith('0000')) {
+    aliases.add(assignedNumber.slice(4));
+  }
+  return aliases;
+};
+
+export const matchesKnownBleUuid = (
+  actualUuid: string | null | undefined,
+  aliases: ReadonlySet<string>
+) => aliases.has(normalizeBleUuid(actualUuid));
+
+const ONEKEY_COMMUNICATION_SERVICE_ALIASES = createKnownBleUuidAliases(ONEKEY_SERVICE_UUID);
+const FIDO_SERVICE_ALIASES = createKnownBleUuidAliases('0000fffd-0000-1000-8000-00805f9b34fb');
+const PRO2_COMPACT_NAME_PATTERN = /^(?:onekey)?pro2[a-f0-9]{4}$/i;
+const NEO_COMPACT_NAME_PATTERN = /^(?:onekey)?neo[a-f0-9]{4}$/i;
+const FIND_MY_COMPACT_SUFFIXES = [
+  'findemy',
+  'findem',
+  'finde',
+  'findmy',
+  'findm',
+  'find',
+  'fin',
+] as const;
+const COMPLETE_FIND_MY_COMPACT_SUFFIXES = ['findemy', 'findmy'] as const;
+
+const compactBleName = (value: string) =>
+  Array.from(value)
+    .filter(character => character !== '-' && character.trim() !== '')
+    .join('')
+    .toLowerCase();
+
+const getFindMyCompactSuffix = (compactName: string) =>
+  FIND_MY_COMPACT_SUFFIXES.find(candidate => compactName.endsWith(candidate));
+
+const getPro2FindMyBaseLength = (value: string) => {
+  const compactName = compactBleName(value);
+  const suffix = getFindMyCompactSuffix(compactName);
+  if (!suffix) return undefined;
+
+  const compactBaseName = compactName.slice(0, -suffix.length);
+  return PRO2_COMPACT_NAME_PATTERN.test(compactBaseName) ? compactBaseName.length : undefined;
+};
+
+export const isPro2FindMyAdvertisementName = (value?: string | null) => {
+  if (!value) return false;
+  if (getPro2FindMyBaseLength(value) !== undefined) return true;
+
+  const compactName = compactBleName(value);
+  const suffix = COMPLETE_FIND_MY_COMPACT_SUFFIXES.find(candidate =>
+    compactName.endsWith(candidate)
+  );
+  if (!suffix) return false;
+
+  return compactName.slice(0, -suffix.length).includes('pro2');
+};
+
+export const normalizePro2FindMyAdvertisementName = (value: string) => {
+  const baseLength = getPro2FindMyBaseLength(value);
+  if (baseLength === undefined) return value;
+
+  let compactLength = 0;
+  for (let index = 0; index < value.length; index += 1) {
+    const character = value[index];
+    if (character !== '-' && character.trim() !== '') {
+      compactLength += 1;
+      if (compactLength === baseLength) {
+        return value.slice(0, index + 1).trimEnd();
+      }
+    }
+  }
+  return value;
+};
+
+/**
+ * Current Pro2 advertisements use "Pro 2 XXXX". Older firmware used "Pro2 XXXX".
+ * Discovery and DeviceInfo both go through this helper so the public BLE name
+ * stays on the spaced form without changing OneKey Pro / Neo names.
+ *
+ * Match the compact Pro2 form first. A leading "Pro 2" regex would also eat the
+ * first digit of a OneKey Pro suffix such as "Pro 22D8" or "Pro 2D8F".
+ */
+export const canonicalizePro2BleAdvertisementName = (value: string) => {
+  const withoutFindMy = normalizePro2FindMyAdvertisementName(value);
+  const compact = compactBleName(withoutFindMy);
+  if (!PRO2_COMPACT_NAME_PATTERN.test(compact)) return withoutFindMy;
+
+  const match = withoutFindMy.match(/^(onekey\s*)?pro\s*2\s*/i);
+  if (!match) return withoutFindMy;
+
+  const rest = withoutFindMy.slice(match[0].length);
+  const prefix = match[1] ? 'OneKey Pro 2' : 'Pro 2';
+  return rest ? `${prefix} ${rest}` : prefix;
+};
+
+export const isSameOnekeyBleName = (left?: string | null, right?: string | null) => {
+  if (!left || !right) return false;
+  if (left === right) return true;
+  return (
+    compactBleName(canonicalizePro2BleAdvertisementName(left)) ===
+    compactBleName(canonicalizePro2BleAdvertisementName(right))
+  );
+};
+
+export const hasOnekeyCommunicationService = (
+  serviceUuids: Array<string | null | undefined> | null | undefined
+) =>
+  (serviceUuids ?? []).some(uuid =>
+    matchesKnownBleUuid(uuid, ONEKEY_COMMUNICATION_SERVICE_ALIASES)
+  );
+
+/**
+ * Protocol V2 family (Pro2 / Neo) by advertised BLE name. Callers use it to
+ * pick a connection strategy: this family also advertises under Find My names
+ * that carry no OneKey service UUID, so a scan cannot always see it.
+ */
+export const isPro2FamilyBleName = (value?: string | null): boolean => {
+  if (!value) {
+    return false;
+  }
+  const normalized = value.trim().toLowerCase();
+  if (!normalized) {
+    return false;
+  }
+  if (normalized.startsWith('pro2') || normalized.startsWith('neo')) {
+    return true;
+  }
+  const compact = compactBleName(normalized);
+  return (
+    PRO2_COMPACT_NAME_PATTERN.test(compact) ||
+    NEO_COMPACT_NAME_PATTERN.test(compact) ||
+    isPro2FindMyAdvertisementName(value)
+  );
+};
+
+export const isOnekeyBluetoothDevice = ({
+  id,
+  name,
+  localName,
+  serviceUuids,
+}: BluetoothDeviceIdentity): boolean => {
+  const advertisedServiceUuids = serviceUuids ?? [];
+  if (hasOnekeyCommunicationService(advertisedServiceUuids)) {
+    return true;
+  }
+
+  // Android can return a connected Find My peripheral without its advertised
+  // services. Do not let the Pro2-looking name fall through to name discovery.
+  if (isPro2FindMyAdvertisementName(name) || isPro2FindMyAdvertisementName(localName)) {
+    return false;
+  }
+
+  if (advertisedServiceUuids.some(uuid => matchesKnownBleUuid(uuid, FIDO_SERVICE_ALIASES))) {
+    return false;
+  }
+
+  return isOnekeyDevice(name ?? null, id) || isOnekeyDevice(localName ?? null, id);
+};

package/src/deviceType.ts

@@ -7,4 +7,5 @@ export enum EDeviceType {
   Touch = 'touch',
   Pro = 'pro',
   Pro2 = 'pro2',
+  Neo = 'neo',
 }