@onekeyfe/hd-core 1.2.8-alpha.2 → 1.2.8-alpha.20

package/README.md

@@ -29,4 +29,31 @@ import Core from '@onekeyfe/hd-core';
 Documentation is available [Hardware SDK Getting Started](https://developer.onekey.so/en/hardware-sdk/getting-started)
 
 ## Examples
+
+### Babylon context hash
+
+`btcDeriveContextHash(connectId, deviceId, params)` requires Classic 1s firmware
+3.21.0 or later and Protocol V1. It uses the existing wallet session and device
+confirmation flow. Other device families and Protocol V2 are not supported.
+
+```typescript
+const result = await HardwareSDK.btcDeriveContextHash(connectId, deviceId, {
+  path: "m/84'/0'/0'/0/0", // The currently selected Bitcoin key, not the IKM path.
+  appName: 'babylon-btc-vault',
+  context: 'deadbeef',
+  network: 'bitcoin-mainnet',
+});
+// result.payload.secret is a 32-byte value encoded as 64 lowercase hex characters.
+```
+
+`appName` must contain 1–64 ASCII lowercase letters, digits or hyphens. `context`
+must be lowercase hex without `0x`, containing 1–1024 decoded bytes. `network` is
+required: `bitcoin-mainnet`, `bitcoin-testnet` (testnet3/testnet4), `bitcoin-signet`,
+or `bitcoin-regtest`. The SDK infers the Bitcoin input script type from `path` and
+encodes `appName` as ASCII bytes; the device performs the derivation internally.
+Device rejection and unsupported firmware errors propagate through the normal
+SDK response. Treat the returned secret as sensitive and do not log or persist it.
+
+See the [Babylon specification](https://github.com/babylonlabs-io/babylon-toolkit/blob/main/docs/specs/derive-context-hash.md).
+
 // TODO: add example url

package/__tests__/btc-derive-context-hash.test.ts

@@ -0,0 +1,200 @@
+import { EDeviceType, EFirmwareType, HardwareErrorCode } from '@onekeyfe/hd-shared';
+
+import BTCDeriveContextHash from '../src/api/btc/BTCDeriveContextHash';
+import { findMethod } from '../src/api/utils';
+import { getLogBlockLabel, getSafeLogPayload } from '../src/events/logBlockEvent';
+import { createCoreApi } from '../src/inject';
+import { Device } from '../src/device/Device';
+
+import type { DeviceFirmwareRange } from '../src/types';
+
+jest.mock('../src/data/config', () => ({
+  getSDKVersion: jest.fn(() => '1.0.0'),
+  DEFAULT_DOMAIN: 'https://jssdk.onekey.so/1.0.0/',
+}));
+
+const createMethod = (overrides: Record<string, unknown> = {}) =>
+  new BTCDeriveContextHash({
+    id: 1,
+    payload: {
+      method: 'btcDeriveContextHash',
+      path: "m/84'/0'/0'/0/0",
+      appName: 'test-app',
+      context: 'deadbeef',
+      network: 'bitcoin-mainnet',
+      ...overrides,
+    },
+  });
+
+describe('btcDeriveContextHash', () => {
+  test('forwards the public API call through the existing dispatcher', async () => {
+    const call = jest
+      .fn()
+      .mockResolvedValue({ success: true, payload: { secret: '00'.repeat(32) } });
+    const api = createCoreApi(call);
+    const params = {
+      path: "m/84'/0'/0'/0/0",
+      appName: 'test-app',
+      context: 'deadbeef',
+      network: 'bitcoin-mainnet' as const,
+    };
+    await api.btcDeriveContextHash('connect-id', 'device-id', params);
+    expect(call).toHaveBeenCalledWith({
+      ...params,
+      connectId: 'connect-id',
+      deviceId: 'device-id',
+      method: 'btcDeriveContextHash',
+    });
+  });
+
+  test.each([
+    ['bitcoin-mainnet', 'BITCOIN_MAINNET'],
+    ['bitcoin-testnet', 'BITCOIN_TESTNET'],
+    ['bitcoin-signet', 'BITCOIN_SIGNET'],
+    ['bitcoin-regtest', 'BITCOIN_REGTEST'],
+  ])('maps %s and returns the device result', async (network, wireNetwork) => {
+    const method = createMethod({ network });
+    method.init();
+    const response = { secret: '00'.repeat(32) };
+    const typedCall = jest.fn().mockResolvedValue({ message: response });
+    method.device = { commands: { typedCall } } as unknown as Device;
+
+    await expect(method.run()).resolves.toBe(response);
+    expect(typedCall).toHaveBeenCalledWith(
+      'BabylonDeriveContextHash',
+      'BabylonDerivedContextHash',
+      {
+        address_n: [2147483732, 2147483648, 2147483648, 0, 0],
+        script_type: 'SPENDWITNESS',
+        app_name: '746573742d617070',
+        context: 'deadbeef',
+        network: wireNetwork,
+      }
+    );
+  });
+
+  test.each([
+    ["m/44'/0'/0'/0/0", 'SPENDADDRESS'],
+    ["m/49'/0'/0'/0/0", 'SPENDP2SHWITNESS'],
+    [[2147483734, 2147483648, 2147483648, 0, 0], 'SPENDTAPROOT'],
+  ])('uses the selected path script type for %s', (path, scriptType) => {
+    const method = createMethod({ path });
+    method.init();
+    expect(method.params.script_type).toBe(scriptType);
+  });
+
+  test('accepts the maximum app name and context sizes', () => {
+    const method = createMethod({ appName: 'a'.repeat(64), context: 'ab'.repeat(1024) });
+    expect(() => method.init()).not.toThrow();
+    expect(method.params.context).toHaveLength(2048);
+  });
+
+  test.each([
+    { appName: '' },
+    { appName: 'a'.repeat(65) },
+    { appName: 'Test-App' },
+    { appName: 'test_app' },
+    { appName: '你好' },
+    { appName: null },
+    { context: '' },
+    { context: 'abc' },
+    { context: 'DEADBEEF' },
+    { context: '0xdeadbeef' },
+    { context: 'gg' },
+    { context: 'ab'.repeat(1025) },
+    { context: null },
+    { network: '' },
+    { network: 'litecoin' },
+    { network: 'toString' },
+    { network: 1 },
+    { path: 'm' },
+    { path: "m/84x'/0'/0'/0/0" },
+    { path: "m/2147483648'/0'/0'/0/0" },
+    { path: [2147483732, 2147483648, 2147483648, 0, 0.5] },
+    { path: [2147483732, 2147483648, 2147483648, 0, 4294967296] },
+  ])('rejects invalid inputs before a device call: %j', overrides => {
+    expect(() => createMethod(overrides).init()).toThrow(
+      expect.objectContaining({ errorCode: HardwareErrorCode.CallMethodInvalidParameter })
+    );
+  });
+
+  test('rejects sparse numeric paths before a device call', () => {
+    const sparsePath = [2147483732, 2147483648, 2147483648, 0, 5];
+    delete sparsePath[3];
+
+    [Array<number>(3), sparsePath].forEach(path => {
+      expect(() => createMethod({ path }).init()).toThrow(
+        expect.objectContaining({ errorCode: HardwareErrorCode.CallMethodInvalidParameter })
+      );
+    });
+  });
+
+  test('registers the public method and restricts it to supported firmware and protocol', () => {
+    const method = findMethod({ id: 1, payload: { ...createMethod().payload } });
+    method.init();
+    expect(method).toBeInstanceOf(BTCDeriveContextHash);
+    expect(method.strictCheckDeviceSupport).toBe(true);
+    expect(() => method.assertProtocolSupported('V2', EFirmwareType.Universal)).toThrow(
+      expect.objectContaining({ errorCode: HardwareErrorCode.DeviceNotSupportMethod })
+    );
+  });
+
+  test.each([EDeviceType.Classic1s, EDeviceType.ClassicPure])(
+    'resolves the firmware requirement for %s through the device support check',
+    deviceType => {
+      const method = createMethod();
+      const device = Object.create(Device.prototype) as Device;
+      device.getCurrentDeviceType = jest.fn(() => deviceType);
+      const range: DeviceFirmwareRange = method.getVersionRange();
+
+      expect(device.getCurrentMethodVersionRange(type => range[type])).toEqual({ min: '3.21.0' });
+      expect(() => method.assertProtocolSupported('V1', EFirmwareType.Universal)).not.toThrow();
+    }
+  );
+
+  test.each([EDeviceType.Classic, EDeviceType.Mini, EDeviceType.Touch, EDeviceType.Pro])(
+    'keeps %s outside the supported firmware range',
+    deviceType => {
+      const method = createMethod();
+      const device = Object.create(Device.prototype) as Device;
+      device.getCurrentDeviceType = jest.fn(() => deviceType);
+      const range: DeviceFirmwareRange = method.getVersionRange();
+
+      expect(device.getCurrentMethodVersionRange(type => range[type])).toBeUndefined();
+    }
+  );
+
+  test('propagates device rejection without returning a secret', async () => {
+    const method = createMethod();
+    method.init();
+    const error = new Error('User rejected');
+    method.device = {
+      commands: { typedCall: jest.fn().mockRejectedValue(error) },
+    } as unknown as Device;
+    await expect(method.run()).rejects.toBe(error);
+  });
+
+  test.each([undefined, '00', '00'.repeat(33)])(
+    'rejects malformed device responses',
+    async secret => {
+      const method = createMethod();
+      method.init();
+      method.device = {
+        commands: { typedCall: jest.fn().mockResolvedValue({ message: { secret } }) },
+      } as unknown as Device;
+      await expect(method.run()).rejects.toMatchObject({
+        errorCode: HardwareErrorCode.CallMethodError,
+      });
+    }
+  );
+
+  test('blocks API request and response payloads in logs', () => {
+    const request = { payload: { method: 'btcDeriveContextHash' } };
+    const label = getLogBlockLabel(request);
+    expect(label).toBe('btcDeriveContextHash');
+    expect(getSafeLogPayload({ payload: { secret: '00'.repeat(32) } }, label)).toEqual({
+      method: 'btcDeriveContextHash',
+      payload: '[REDACTED]',
+    });
+  });
+});

package/__tests__/device-lifecycle-events.test.ts

@@ -363,11 +363,11 @@ describe('public device lifecycle events', () => {
 
   test('clears the cleanup barrier when its deadline expires', async () => {
     const realSetTimeout = setTimeout;
-    jest
-      .spyOn(global, 'setTimeout')
-      .mockImplementation((callback, delay, ...args) =>
-        realSetTimeout(callback, delay === 5_000 ? 0 : delay, ...args)
-      );
+    const cleanupDeadline = createDeferred<() => void>();
+    jest.spyOn(global, 'setTimeout').mockImplementation((callback, delay, ...args) => {
+      if (delay === 5_000) cleanupDeadline.resolve(() => callback(...args));
+      return realSetTimeout(callback, delay, ...args);
+    });
     {
       jest.spyOn(DataManager, 'getSettings').mockReturnValue('react-native' as never);
       const acquire = jest.spyOn(Device.prototype, 'acquire').mockResolvedValue(undefined);
@@ -381,13 +381,15 @@ describe('public device lifecycle events', () => {
         type: IFRAME.CALL,
         payload: { method: 'getDeviceState', connectId: 'draining-device', connectProtocol: 'V2' },
       } as CoreMessage);
-      setImmediate(() => cancel(context, 'draining-device'));
+      const expireCleanupDeadline = await cleanupDeadline.promise;
+      cancel(context, 'draining-device');
+      expireCleanupDeadline();
       await expect(result).resolves.toBeDefined();
-      gate.resolve();
       await new Promise(resolve => {
         setImmediate(resolve);
       });
       expect(context.getPrePendingCallPromise('draining-device')).toBeUndefined();
+      gate.resolve();
     }
   });
 
@@ -712,6 +714,48 @@ describe('public device lifecycle events', () => {
     expect(() => JSON.stringify(disconnectMessage?.payload.device)).not.toThrow();
   });
 
+  test.each(['V1', 'V2'] as const)(
+    'preserves the %s connection identity for a transport disconnect after wipe',
+    protocol => {
+      jest.spyOn(DataManager, 'getSettings').mockReturnValue('webusb' as never);
+      core = initCore();
+      initConnector();
+      const messages: CoreMessage[] = [];
+      core.on(CORE_EVENT, message => messages.push(message));
+      const device = createInitializedDevice(protocol);
+      const connectId = device.getConnectId();
+      DevicePool.devicesCache[connectId] = device;
+
+      device.invalidateAfterWipe();
+      expect(device.toMessageObject()).toBeNull();
+      DevicePool.emitter.emit(DEVICE.CONNECT, device);
+      expect(messages.some(message => message.type === DEVICE.CONNECT)).toBe(false);
+      DevicePool.emitter.emit(TRANSPORT_EVENT.DEVICE_DISCONNECT, { connectId });
+
+      const disconnects = messages.filter(message => message.type === DEVICE.DISCONNECT);
+      expect(disconnects).toHaveLength(1);
+      expect(disconnects[0].payload.device).toMatchObject({
+        connectId,
+        serialNo: 'SERIAL-001',
+        deviceId: 'wallet-device-id',
+      });
+      expect(() => JSON.stringify(disconnects[0].payload.device)).not.toThrow();
+
+      device.features = {
+        ...createInitializedDevice(protocol).features,
+        deviceId: 'new-device-id',
+        initialized: false,
+        mode: 'notInitialized',
+      } as never;
+      DevicePool.emitter.emit(TRANSPORT_EVENT.DEVICE_DISCONNECT, { connectId });
+      const nextDisconnects = messages.filter(message => message.type === DEVICE.DISCONNECT);
+      expect(nextDisconnects[1].payload.device).toMatchObject({
+        deviceId: 'new-device-id',
+        mode: 'notInitialized',
+      });
+    }
+  );
+
   test('treats an acquired BLE device as reusable until the transport disconnects', async () => {
     jest.spyOn(DataManager, 'getSettings').mockReturnValue('desktop-web-ble' as never);
     const device = createInitializedDevice('V2');

package/__tests__/device-pool-state.test.ts

@@ -85,6 +85,56 @@ describe('DevicePool state lifecycle', () => {
     expect(result.deviceList).toEqual([device]);
   });
 
+  test.each([
+    ['V1', undefined],
+    ['V1', 'wipe-path'],
+    ['V2', undefined],
+    ['V2', 'wipe-path'],
+  ] as const)('rediscovers a wiped %s device with connect id %s', async (protocol, connectId) => {
+    const descriptor = { path: 'wipe-path', protocolType: protocol } as never;
+    const device = Device.fromDescriptor(descriptor);
+    device.features = {
+      protocol,
+      deviceType: protocol === 'V2' ? 'pro2' : 'classic',
+      deviceId: 'old-device-id',
+      serialNo: 'wipe-path',
+      initialized: true,
+      mode: 'normal',
+    } as never;
+    DevicePool.devicesCache = { 'wipe-path': device };
+    device.invalidateAfterWipe();
+    expect(device.toMessageObject()).toBeNull();
+    const connect = jest.spyOn(device, 'connect').mockResolvedValue(true);
+    const initialize = jest.spyOn(device, 'initialize').mockImplementation(() => {
+      device.features = {
+        protocol,
+        deviceType: protocol === 'V2' ? 'pro2' : 'classic',
+        deviceId: 'new-device-id',
+        serialNo: 'wipe-path',
+        initialized: false,
+        mode: 'notInitialized',
+      } as never;
+      return Promise.resolve();
+    });
+    const release = jest.spyOn(device, 'release').mockResolvedValue(undefined);
+
+    try {
+      const result = await DevicePool.getDevices([descriptor], connectId);
+      expect(initialize).toHaveBeenCalledTimes(1);
+      expect(connect).toHaveBeenCalledTimes(1);
+      expect(release).toHaveBeenCalledTimes(1);
+      expect(result.deviceList[0].toMessageObject()).toMatchObject({
+        deviceId: 'new-device-id',
+        mode: 'notInitialized',
+        features: { initialized: false },
+      });
+      await DevicePool.getDevices([descriptor], connectId);
+      expect(initialize).toHaveBeenCalledTimes(1);
+    } finally {
+      jest.restoreAllMocks();
+    }
+  });
+
   test('keeps a discovered device when its Protocol V2 label cannot be read', async () => {
     const labelError = new Error('settings unavailable');
     const getDeviceState = jest

package/__tests__/protocol-v2-bootloader-mode.test.ts

@@ -1,5 +1,6 @@
 import { EDeviceType } from '@onekeyfe/hd-shared';
 
+import DeviceReboot from '../src/api/protocol-v2/DeviceReboot';
 import { Device } from '../src/device/Device';
 import { UI_REQUEST } from '../src/events/ui-request';
 
@@ -25,6 +26,17 @@ const createBootloaderDevice = (protocolType: 'V1' | 'V2') => {
 };
 
 describe('Pro2 bootloader mode', () => {
+  test('allows deviceReboot to return a Protocol V2 bootloader to normal mode', () => {
+    const device = createBootloaderDevice('V2');
+    const method = new DeviceReboot({
+      id: 1,
+      payload: { method: 'deviceReboot', rebootType: 'normal' },
+    });
+    method.init();
+
+    expect(device.hasUnexpectedMode(method.allowDeviceMode, method.requireDeviceMode)).toBeNull();
+  });
+
   test('blocks Protocol V2 methods that are not allowed in bootloader mode', () => {
     const device = createBootloaderDevice('V2');