@onekeyfe/hd-core 1.2.0-alpha.22 → 1.2.0-alpha.24

package/src/api/firmware/uploadFirmware.ts

@@ -10,7 +10,6 @@ import { bytesToHex } from '../helpers/hexUtils';
 import { DataManager } from '../../data-manager';
 import { DevicePool } from '../../device/DevicePool';
 import { buildProtocolV1FeaturesPayload } from '../../deviceProfile';
-import { openFirmwareByteSource, readFirmwareByteSourceFully } from './FirmwareArtifactSource';
 
 import type { KnownDevice } from '../../types';
 import type { TypedCall, TypedResponseMessage } from '../../device/DeviceCommands';
@@ -18,7 +17,6 @@ import type { PROTO } from '../../constants';
 import type { CoreMessage, IFirmwareUpdateProgressType } from '../../events';
 import type { Success } from '@onekeyfe/hd-transport';
 import type { Device } from '../../device/Device';
-import type { FirmwareByteSource } from './FirmwareArtifactSource';
 
 const NEW_BOOT_UPRATE_FIRMWARE_VERSION = '2.4.5';
 const SESSION_ERROR = 'session not found';
@@ -90,20 +88,17 @@ export const waitBleInstall = async (updateType: string) => {
   }
 };
 
-const toArrayBuffer = (payload: ArrayBuffer | Buffer): ArrayBuffer => {
-  if (payload instanceof ArrayBuffer) {
-    return payload;
-  }
-  return new Uint8Array(payload.buffer, payload.byteOffset, payload.byteLength).slice().buffer;
-};
-
-export const uploadFirmwareFromSource = async (
+export const uploadFirmware = async (
   updateType: 'firmware' | 'ble',
   typedCall: TypedCall,
   postMessage: (message: CoreMessage) => void,
   device: Device,
-  source: FirmwareByteSource,
-  rebootOnSuccess?: boolean,
+  {
+    payload,
+    rebootOnSuccess,
+  }: PROTO.FirmwareUpload & {
+    rebootOnSuccess?: boolean;
+  },
   isUpdateBootloader?: boolean
 ) => {
   const deviceType = device.getCurrentDeviceType();
@@ -124,20 +119,20 @@ export const uploadFirmwareFromSource = async (
       if (supportUpgradeFileHeader) {
         // Extract and validate firmware header (first 1KB)
         const HEADER_SIZE = 1024;
-        if (source.size < HEADER_SIZE) {
+        if (payload.byteLength < HEADER_SIZE) {
           throw ERRORS.TypedError(
             HardwareErrorCode.RuntimeError,
-            `firmware payload too small: ${source.size} bytes, expected at least ${HEADER_SIZE} bytes`
+            `firmware payload too small: ${payload.byteLength} bytes, expected at least ${HEADER_SIZE} bytes`
           );
         }
 
         Log.debug('Uploading firmware header:', {
           size: HEADER_SIZE,
-          totalSize: source.size,
+          totalSize: payload.byteLength,
         });
         postProgressTip(device, 'UploadingFirmwareHeader', postMessage);
 
-        const header = new Uint8Array(await source.readAt(0, HEADER_SIZE));
+        const header = new Uint8Array(payload.slice(0, HEADER_SIZE));
 
         try {
           const headerRes = await typedCall('UpgradeFileHeader', 'Success', {
@@ -174,9 +169,6 @@ export const uploadFirmwareFromSource = async (
     postProgressMessage(device, 0, 'installingFirmware', postMessage);
     let updateResponse: TypedResponseMessage<'Success'>;
     try {
-      // Classic/Mini bootloaders accept one protobuf payload and do not expose
-      // a request-range protocol. Other device families remain fully streamed.
-      const payload = await readFirmwareByteSourceFully(source);
       updateResponse = await typedCall('FirmwareUpload', 'Success', {
         payload,
       });
@@ -208,7 +200,9 @@ export const uploadFirmwareFromSource = async (
           updateType,
           postMessage,
           device,
-          source,
+          {
+            payload,
+          },
           rebootOnSuccess
         );
         return response.message;
@@ -217,7 +211,7 @@ export const uploadFirmwareFromSource = async (
 
     postConfirmationMessage(device);
     postProgressTip(device, 'ConfirmOnDevice', postMessage);
-    const length = source.size;
+    const length = payload.byteLength;
 
     let response = await typedCall('FirmwareErase', ['FirmwareRequest', 'Success'], { length });
     postProgressTip(device, 'FirmwareEraseSuccess', postMessage);
@@ -226,7 +220,7 @@ export const uploadFirmwareFromSource = async (
       const start = response.message.offset!;
       // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
       const end = response.message.offset! + response.message.length!;
-      const chunk = await source.readAt(start, end - start);
+      const chunk = payload.slice(start, end);
 
       if (start > 0) {
         postProgressMessage(
@@ -255,45 +249,11 @@ export const uploadFirmwareFromSource = async (
   throw ERRORS.TypedError(HardwareErrorCode.RuntimeError, 'uploadFirmware: unknown device model');
 };
 
-export const uploadFirmware = async (
-  updateType: 'firmware' | 'ble',
-  typedCall: TypedCall,
-  postMessage: (message: CoreMessage) => void,
-  device: Device,
-  {
-    payload,
-    rebootOnSuccess,
-  }: PROTO.FirmwareUpload & {
-    rebootOnSuccess?: boolean;
-  },
-  isUpdateBootloader?: boolean
-) => {
-  const source = await openFirmwareByteSource({
-    binary: toArrayBuffer(payload),
-  });
-  if (!source) {
-    throw ERRORS.TypedError(HardwareErrorCode.RuntimeError, 'firmware payload is empty');
-  }
-  try {
-    return await uploadFirmwareFromSource(
-      updateType,
-      typedCall,
-      postMessage,
-      device,
-      source,
-      rebootOnSuccess,
-      isUpdateBootloader
-    );
-  } finally {
-    await source.close();
-  }
-};
-
 const newTouchUpdateProcess = async (
   updateType: 'firmware' | 'ble',
   postMessage: (message: CoreMessage) => void,
   device: Device,
-  source: FirmwareByteSource,
+  { payload }: PROTO.FirmwareUpload,
   rebootOnSuccess = true
 ) => {
   let typedCall = device.getCommands().typedCall.bind(device.getCommands());
@@ -303,13 +263,13 @@ const newTouchUpdateProcess = async (
   const env = DataManager.getSettings('env');
   const perPackageSize = DataManager.isBleConnect(env) ? 16 : 128;
   const chunkSize = 1024 * perPackageSize;
-  const totalChunks = Math.ceil(source.size / chunkSize);
+  const totalChunks = Math.ceil(payload.byteLength / chunkSize);
   let offset = 0;
   for (let i = 0; i < totalChunks; i++) {
     const chunkStart = i * chunkSize;
-    const chunkEnd = Math.min(chunkStart + chunkSize, source.size);
+    const chunkEnd = Math.min(chunkStart + chunkSize, payload.byteLength);
     const chunkLength = chunkEnd - chunkStart;
-    const chunk = await source.readAt(chunkStart, chunkLength);
+    const chunk = payload.slice(chunkStart, chunkEnd);
     const overwrite = i === 0;
     const progress = Math.round(((i + 1) / totalChunks) * 100);
     const writeRes = await emmcFileWriteWithRetry(
@@ -530,67 +490,6 @@ export const updateResource = async (
   return processResourceRequest(typedCall, res, data);
 };
 
-export const updateResourceFromSource = async (
-  typedCall: TypedCall,
-  fileName: string,
-  source: FirmwareByteSource,
-  onConfirmAfter?: () => void
-) => {
-  const initialLength = Math.min(INIT_DATA_CHUNK_SIZE, source.size);
-  const initialChunk = new Uint8Array(await source.readAt(0, initialLength));
-  let response = await typedCall('ResourceUpdate', ['ResourceRequest', 'Success'], {
-    file_name: fileName,
-    data_length: source.size,
-    initial_data_chunk: bytesToHex(initialChunk),
-    hash: bytesToHex(blake2s(initialChunk)),
-  });
-  onConfirmAfter?.();
-
-  while (response.type !== 'Success') {
-    const { offset, data_length: dataLength } = response.message;
-    if (
-      !Number.isSafeInteger(offset) ||
-      offset === undefined ||
-      offset < 0 ||
-      !Number.isSafeInteger(dataLength) ||
-      dataLength === undefined ||
-      dataLength <= 0 ||
-      offset + dataLength > source.size
-    ) {
-      throw ERRORS.TypedError(
-        HardwareErrorCode.RuntimeError,
-        'Device requested an invalid firmware resource range'
-      );
-    }
-    const chunk = new Uint8Array(await source.readAt(offset, dataLength));
-    response = await typedCall('ResourceAck', ['ResourceRequest', 'Success'], {
-      data_chunk: bytesToHex(chunk),
-      hash: bytesToHex(blake2s(chunk)),
-    });
-  }
-  return response.message;
-};
-
-export const updateResourcesFromSources = async (
-  typedCall: TypedCall,
-  postMessage: (message: CoreMessage) => void,
-  device: Device,
-  entries: ReadonlyArray<{ entryName: string; source: FirmwareByteSource }>
-) => {
-  postProgressTip(device, 'UpdateSysResource', postMessage);
-  for (const [index, entry] of entries.entries()) {
-    await updateResourceFromSource(typedCall, entry.entryName, entry.source);
-    postProgressMessage(
-      device,
-      Math.floor(((index + 1) / entries.length) * 100),
-      'installingFirmware',
-      postMessage
-    );
-  }
-  postProgressTip(device, 'UpdateSysResourceSuccess', postMessage);
-  return true;
-};
-
 export const updateResources = async (
   typedCall: TypedCall,
   postMessage: (message: CoreMessage) => void,
@@ -625,28 +524,11 @@ export const updateBootloader = async (
   typedCall: TypedCall,
   postMessage: (message: CoreMessage) => void,
   device: Device,
-  data: ArrayBuffer
-) => {
-  const source = await openFirmwareByteSource({ binary: data });
-  if (!source) {
-    throw ERRORS.TypedError(HardwareErrorCode.RuntimeError, 'bootloader payload is empty');
-  }
-  try {
-    return await updateBootloaderFromSource(typedCall, postMessage, device, source);
-  } finally {
-    await source.close();
-  }
-};
-
-export const updateBootloaderFromSource = async (
-  typedCall: TypedCall,
-  postMessage: (message: CoreMessage) => void,
-  device: Device,
-  source: FirmwareByteSource
+  source: ArrayBuffer
 ) => {
   postProgressTip(device, 'UpdateBootloader', postMessage);
   postProgressMessage(device, Math.floor(0), 'installingFirmware', postMessage);
-  await updateResourceFromSource(typedCall, 'bootloader.bin', source, () => {
+  await updateResource(typedCall, 'bootloader.bin', source, () => {
     postProcessingMessage('resource', postMessage);
   });
   postProgressMessage(device, Math.floor(100), 'installingFirmware', postMessage);

package/src/api/index.ts

@@ -1,4 +1,5 @@
 export { default as testInitializeDeviceDuration } from './test/TestInitializeDeviceDuration';
+export { default as testProtocolV2Ping } from './protocol-v2/Ping';
 export { default as preInitialize } from './device/PreInitialize';
 
 export { default as searchDevices } from './SearchDevices';

package/src/api/protocol-v2/Ping.ts

@@ -1,12 +1,43 @@
+import { ERRORS, HardwareErrorCode } from '@onekeyfe/hd-shared';
+
 import { BaseMethod } from '../BaseMethod';
 
+// nanopb max_size:64 includes the terminating NUL for string fields.
+export const PROTOCOL_V2_PING_MAX_MESSAGE_BYTES = 63;
+
+const getUtf8ByteLength = (value: string) =>
+  Array.from(value).reduce((length, character) => {
+    const codePoint = character.codePointAt(0) ?? 0;
+    if (codePoint <= 0x7f) return length + 1;
+    if (codePoint <= 0x7ff) return length + 2;
+    if (codePoint <= 0xffff) return length + 3;
+    return length + 4;
+  }, 0);
+
+export function validateProtocolV2PingMessage(value: unknown): string {
+  if (value !== undefined && typeof value !== 'string') {
+    throw ERRORS.TypedError(
+      HardwareErrorCode.CallMethodInvalidParameter,
+      'Protocol V2 Ping message must be a string.'
+    );
+  }
+  const message = value ?? '';
+  if (getUtf8ByteLength(message) > PROTOCOL_V2_PING_MAX_MESSAGE_BYTES) {
+    throw ERRORS.TypedError(
+      HardwareErrorCode.CallMethodInvalidParameter,
+      `Protocol V2 Ping message must not exceed ${PROTOCOL_V2_PING_MAX_MESSAGE_BYTES} UTF-8 bytes.`
+    );
+  }
+  return message;
+}
+
 export default class Ping extends BaseMethod<{ message?: string }> {
   init() {
     // Protocol V2 (Pro2) only; Core rejects non-V2 devices.
     this.requireProtocolV2 = true;
     this.skipForceUpdateCheck = true;
     this.useDevicePassphraseState = false;
-    this.params = { message: this.payload.message };
+    this.params = { message: validateProtocolV2PingMessage(this.payload.message) };
   }
 
   async run() {

package/src/core/index.ts

@@ -1,5 +1,6 @@
 import semver from 'semver';
 import EventEmitter from 'events';
+import { TRANSPORT_EVENT } from '@onekeyfe/hd-transport';
 import {
   ERRORS,
   ERROR_CODES_REQUIRE_RELEASE,
@@ -70,7 +71,11 @@ import type { CoreMessage, IFrameCallMessage, UiPromise, UiPromiseResponse } fro
 import type { DeviceEvents, InitOptions, RunOptions } from '../device/Device';
 import type { SdkTracingContext } from '../utils/tracing';
 import type { Deferred } from '@onekeyfe/hd-shared';
-import type { LowlevelTransportSharedPlugin, OneKeyDeviceInfo } from '@onekeyfe/hd-transport';
+import type {
+  LowlevelTransportSharedPlugin,
+  OneKeyDeviceInfo,
+  TransportDeviceDisconnectEvent,
+} from '@onekeyfe/hd-transport';
 import type { BaseMethod } from '../api/BaseMethod';
 
 const Log = getLogger(LoggerNames.Core);
@@ -173,8 +178,6 @@ export const callAPI = async (context: CoreContext, message: CoreMessage) => {
     return createResponseMessage(method?.responseID ?? message.id, false, { error });
   }
 
-  DevicePool.emitter.on(DEVICE.CONNECT, onDeviceConnectHandler);
-
   if (!method.useDevice) {
     updateMethodRequestContext(method, { status: 'running' });
     try {
@@ -236,7 +239,6 @@ const handlePreWarmSignal = async (
   method: BaseMethod
 ): Promise<any> => {
   const createAckResponse = () => {
-    DevicePool.emitter.removeListener(DEVICE.CONNECT, onDeviceConnectHandler);
     completeMethodRequestContext(method);
     method.dispose();
     return createResponseMessage(method.responseID, true, true);
@@ -874,8 +876,15 @@ function isRetryableBleProtocolV2ProbeError(method: BaseMethod, error: unknown)
  */
 async function connectDeviceForBle(method: BaseMethod, device: Device, retryCount = 0) {
   try {
-    await device.acquire(method.payload.connectProtocol);
+    const shouldAcquire =
+      !device.hasDeviceAcquire() || !device.commands || device.commands.disposed;
+    if (shouldAcquire) {
+      await device.acquire(method.payload.connectProtocol);
+    }
     if (method.payload?.onlyConnectBleDevice) {
+      if (shouldAcquire) {
+        DevicePool.emitter.emit(DEVICE.CONNECT, device);
+      }
       return;
     }
     // Skip initialize if conditions are met
@@ -886,6 +895,9 @@ async function connectDeviceForBle(method: BaseMethod, device: Device, retryCoun
         passphraseState: initOptions.passphraseState,
       });
     }
+    if (shouldAcquire) {
+      DevicePool.emitter.emit(DEVICE.CONNECT, device);
+    }
   } catch (err) {
     if (
       (err.errorCode === HardwareErrorCode.BleTimeoutError ||
@@ -1186,8 +1198,6 @@ const cleanup = () => {
 
 const removeDeviceListener = (device: Device) => {
   device.removeAllListeners();
-  DevicePool.emitter.removeAllListeners(DEVICE.CONNECT);
-  // DevicePool.emitter.removeListener(DEVICE.DISCONNECT, onDeviceDisconnectHandler);
 };
 
 /**
@@ -1210,6 +1220,20 @@ const onDeviceDisconnectHandler = (device: Device) => {
   postMessage(createDeviceMessage(DEVICE.DISCONNECT, { device: deviceObject }));
 };
 
+const onTransportDeviceDisconnectHandler = (event: TransportDeviceDisconnectEvent) => {
+  const device =
+    deviceCacheMap.get(event.connectId) ??
+    DevicePool.devicesCache[event.connectId] ??
+    DevicePool.getDeviceByPath(event.connectId);
+  if (!device) {
+    Log.debug('Ignoring transport disconnect for an unknown device:', event.connectId);
+    return;
+  }
+
+  device.markTransportDisconnected();
+  DevicePool.emitter.emit(DEVICE.DISCONNECT, device);
+};
+
 const onDevicePinHandler = async (...[device, type, callback]: DeviceEvents['pin']) => {
   Log.log('request Input PIN');
   // create ui promise
@@ -1262,6 +1286,7 @@ const onDevicePassphraseHandler = async (
       device: device.toMessageObject() as KnownDevice,
       passphraseState: device.passphraseState,
       existsAttachPinUser: requestPayload.existsAttachPinUser,
+      deviceOnly: requestPayload.deviceOnly,
       source: requestPayload.source,
       reason: requestPayload.reason,
       expectedPassphraseState: requestPayload.expectedPassphraseState,
@@ -1527,7 +1552,15 @@ export const initCore = () => {
 
 export const initConnector = () => {
   _connector = new DeviceConnector();
+  DevicePool.emitter.removeListener(DEVICE.CONNECT, onDeviceConnectHandler);
+  DevicePool.emitter.removeListener(DEVICE.DISCONNECT, onDeviceDisconnectHandler);
+  DevicePool.emitter.removeListener(
+    TRANSPORT_EVENT.DEVICE_DISCONNECT,
+    onTransportDeviceDisconnectHandler
+  );
+  DevicePool.emitter.on(DEVICE.CONNECT, onDeviceConnectHandler);
   DevicePool.emitter.on(DEVICE.DISCONNECT, onDeviceDisconnectHandler);
+  DevicePool.emitter.on(TRANSPORT_EVENT.DEVICE_DISCONNECT, onTransportDeviceDisconnectHandler);
   return _connector;
 };
 

package/src/data/messages/messages-protocol-v2.json

@@ -482,9 +482,10 @@
         "MessageType_DeviceStatus": 60603,
         "MessageType_DevGetOnboardingStatus": 60604,
         "MessageType_DevOnboardingStatus": 60605,
+        "MessageType_DeviceSessionGet": 60606,
         "MessageType_DeviceSession": 60607,
         "MessageType_DeviceSessionAskPin": 60608,
-        "MessageType_DeviceSessionOpen": 60609,
+        "MessageType_DeviceSessionAskPassphrase": 60609,
         "MessageType_FilesystemPermissionFix": 60800,
         "MessageType_FilesystemPathInfo": 60801,
         "MessageType_FilesystemPathInfoQuery": 60802,
@@ -506,8 +507,7 @@
         [90, 92],
         [114, 122],
         [300, 304],
-        [309, 312],
-        [60606, 60606]
+        [309, 312]
       ]
     },
     "AlephiumGetAddress": {
@@ -11506,6 +11506,33 @@
         }
       }
     },
+    "UiAnimationType": {
+      "values": {
+        "Unknown": 0,
+        "Signing": 1
+      }
+    },
+    "UiAnimationCommand": {
+      "values": {
+        "CommandUnknown": 0,
+        "Start": 1,
+        "Stop": 2,
+        "Refresh": 3
+      }
+    },
+    "UiAnimationRequest": {
+      "fields": {
+        "command": {
+          "rule": "required",
+          "type": "UiAnimationCommand",
+          "id": 1
+        },
+        "type": {
+          "type": "UiAnimationType",
+          "id": 2
+        }
+      }
+    },
     "ViewAmount": {
       "fields": {
         "is_unlimited": {
@@ -12446,83 +12473,49 @@
         "DeviceSessionError_Busy": 5
       }
     },
-    "DeviceSessionResume": {
+    "DeviceSessionGet": {
       "fields": {
         "session_id": {
-          "rule": "required",
           "type": "bytes",
           "id": 1
         }
       }
     },
-    "DeviceSessionHostPassphrase": {
-      "fields": {
-        "passphrase": {
-          "rule": "required",
-          "type": "string",
-          "id": 1
-        }
-      }
-    },
-    "DeviceSessionPassphraseOnDevice": {
-      "fields": {}
-    },
-    "DeviceSessionAttachPinOnDevice": {
-      "fields": {}
-    },
-    "DeviceSessionSelect": {
-      "oneofs": {
-        "access": {
-          "oneof": ["host_passphrase", "passphrase_on_device", "attach_pin_on_device"]
-        }
-      },
+    "DeviceSession": {
       "fields": {
-        "host_passphrase": {
-          "type": "DeviceSessionHostPassphrase",
+        "session_id": {
+          "type": "bytes",
           "id": 1
         },
-        "passphrase_on_device": {
-          "type": "DeviceSessionPassphraseOnDevice",
+        "btc_test_address": {
+          "type": "string",
           "id": 2
-        },
-        "attach_pin_on_device": {
-          "type": "DeviceSessionAttachPinOnDevice",
-          "id": 3
         }
       }
     },
-    "DeviceSessionOpen": {
-      "oneofs": {
-        "mode": {
-          "oneof": ["resume", "select"]
-        }
-      },
+    "DeviceSessionPinType": {
+      "values": {
+        "Any": 1,
+        "Main": 2,
+        "AttachToPin": 3
+      }
+    },
+    "DeviceSessionAskPin": {
       "fields": {
-        "resume": {
-          "type": "DeviceSessionResume",
+        "type": {
+          "type": "DeviceSessionPinType",
           "id": 1
-        },
-        "select": {
-          "type": "DeviceSessionSelect",
-          "id": 2
         }
       }
     },
-    "DeviceSession": {
+    "DeviceSessionAskPassphrase": {
       "fields": {
-        "session_id": {
-          "type": "bytes",
-          "id": 1
-        },
-        "btc_test_address": {
+        "passphrase": {
           "type": "string",
-          "id": 2
+          "id": 1
         }
       }
     },
-    "DeviceSessionAskPin": {
-      "fields": {}
-    },
     "DeviceSessionAskPin_FailureSubCodes": {
       "values": {
         "UserCancel": 1