@onekeyfe/hd-core 1.2.0-alpha.4 → 1.2.0-alpha.40

package/__tests__/pro2Nft.test.ts

@@ -0,0 +1,108 @@
+import { blake2s } from '@noble/hashes/blake2s';
+import { bytesToHex } from '@noble/hashes/utils';
+
+import {
+  PRO2_NFT_IMAGE_HEIGHT,
+  PRO2_NFT_IMAGE_WIDTH,
+  PRO2_NFT_THUMBNAIL_HEIGHT,
+  PRO2_NFT_THUMBNAIL_WIDTH,
+  buildPro2NftBundle,
+} from '../src/utils/pro2Nft';
+
+const rgba = (width: number, height: number, alpha = 0xff) => {
+  const data = new Uint8Array(width * height * 4);
+  for (let index = 3; index < data.length; index += 4) data[index] = alpha;
+  return data;
+};
+
+describe('buildPro2NftBundle', () => {
+  test('builds the exact Pro2 RGB565 triplet and basename', () => {
+    const bundle = buildPro2NftBundle({
+      image: {
+        width: PRO2_NFT_IMAGE_WIDTH,
+        height: PRO2_NFT_IMAGE_HEIGHT,
+        rgba: rgba(PRO2_NFT_IMAGE_WIDTH, PRO2_NFT_IMAGE_HEIGHT),
+      },
+      thumbnail: {
+        width: PRO2_NFT_THUMBNAIL_WIDTH,
+        height: PRO2_NFT_THUMBNAIL_HEIGHT,
+        rgba: rgba(PRO2_NFT_THUMBNAIL_WIDTH, PRO2_NFT_THUMBNAIL_HEIGHT),
+      },
+      title: 'CryptoPunk #3100',
+      subtitle: 'CryptoPunks',
+      timestampMs: 1_760_000_000_000,
+    });
+
+    expect(bundle.image.byteLength).toBe(583_212);
+    expect(bundle.thumbnail.byteLength).toBe(138_876);
+    expect(Array.from(bundle.image.slice(0, 12))).toEqual([
+      0x19, 0x12, 0, 0, 28, 2, 28, 2, 56, 4, 0, 0,
+    ]);
+    expect(Array.from(bundle.thumbnail.slice(0, 12))).toEqual([
+      0x19, 0x12, 0, 0, 7, 1, 7, 1, 16, 2, 0, 0,
+    ]);
+    expect(new TextDecoder().decode(bundle.metadata)).toBe(
+      '{"title":"CryptoPunk #3100","subtitle":"CryptoPunks"}'
+    );
+    expect(bytesToHex(blake2s(bundle.image))).toBe(
+      'af4b5f8fe216cfd0ef4a9162a42b5c66a73466f2491066f66f756c4e28cc869e'
+    );
+    expect(bytesToHex(blake2s(bundle.thumbnail))).toBe(
+      '44591afae1163cc14651d77644501c6a110f96506889b825cab0351ff4de857d'
+    );
+    expect(bytesToHex(blake2s(bundle.metadata))).toBe(
+      'e30d4dc2cddd441c9f1438c783e05a623ccf76f2f6219d4281769dda1b3635b5'
+    );
+    expect(bundle.basename).toBe('nft-af4b5f8f-1760000000000');
+  });
+
+  test('composites transparent pixels onto black without an alpha plane', () => {
+    const image = rgba(PRO2_NFT_IMAGE_WIDTH, PRO2_NFT_IMAGE_HEIGHT);
+    image.set([255, 255, 255, 0], 0);
+    const bundle = buildPro2NftBundle({
+      image: { width: PRO2_NFT_IMAGE_WIDTH, height: PRO2_NFT_IMAGE_HEIGHT, rgba: image },
+      thumbnail: {
+        width: PRO2_NFT_THUMBNAIL_WIDTH,
+        height: PRO2_NFT_THUMBNAIL_HEIGHT,
+        rgba: rgba(PRO2_NFT_THUMBNAIL_WIDTH, PRO2_NFT_THUMBNAIL_HEIGHT, 0),
+      },
+      title: 'NFT',
+      subtitle: '',
+      timestampMs: 1,
+    });
+
+    expect(bundle.image[1]).toBe(0x12);
+    expect(Array.from(bundle.image.slice(12, 14))).toEqual([0, 0]);
+    expect(bundle.thumbnail.byteLength).toBe(138_876);
+  });
+
+  test('rejects invalid dimensions and metadata byte lengths', () => {
+    const validThumbnail = {
+      width: PRO2_NFT_THUMBNAIL_WIDTH,
+      height: PRO2_NFT_THUMBNAIL_HEIGHT,
+      rgba: rgba(PRO2_NFT_THUMBNAIL_WIDTH, PRO2_NFT_THUMBNAIL_HEIGHT),
+    };
+    expect(() =>
+      buildPro2NftBundle({
+        image: { width: 1, height: 1, rgba: new Uint8Array(4) },
+        thumbnail: validThumbnail,
+        title: 'NFT',
+        subtitle: '',
+        timestampMs: 1,
+      })
+    ).toThrow('540x540');
+    expect(() =>
+      buildPro2NftBundle({
+        image: {
+          width: PRO2_NFT_IMAGE_WIDTH,
+          height: PRO2_NFT_IMAGE_HEIGHT,
+          rgba: rgba(PRO2_NFT_IMAGE_WIDTH, PRO2_NFT_IMAGE_HEIGHT),
+        },
+        thumbnail: validThumbnail,
+        title: 'a'.repeat(64),
+        subtitle: '',
+        timestampMs: 1,
+      })
+    ).toThrow('1 to 63');
+  });
+});

package/__tests__/pro2Wallpaper.test.ts

@@ -0,0 +1,39 @@
+import { encodePro2Wallpaper } from '../src/utils/pro2Wallpaper';
+
+describe('encodePro2Wallpaper', () => {
+  test('encodes opaque pixels as aligned LVGL v9 RGB565 data', () => {
+    const result = encodePro2Wallpaper({
+      width: 2,
+      height: 1,
+      rgba: new Uint8Array([255, 0, 0, 255, 0, 255, 0, 255]),
+    });
+
+    expect(result.colorFormat).toBe('RGB565');
+    expect(Array.from(result.data.slice(0, 12))).toEqual([
+      0x19, 0x12, 0, 0, 2, 0, 1, 0, 4, 0, 0, 0,
+    ]);
+    expect(Array.from(result.data.slice(12))).toEqual([0x00, 0xf8, 0xe0, 0x07]);
+  });
+
+  test('encodes transparent pixels as RGB565A8 with alpha plane after RGB data', () => {
+    const result = encodePro2Wallpaper({
+      width: 2,
+      height: 1,
+      rgba: new Uint8Array([0, 0, 255, 128, 255, 255, 255, 255]),
+    });
+
+    expect(result.colorFormat).toBe('RGB565A8');
+    expect(result.data[1]).toBe(0x14);
+    expect(Array.from(result.data.slice(8, 10))).toEqual([4, 0]);
+    expect(Array.from(result.data.slice(12))).toEqual([0x1f, 0x00, 0xff, 0xff, 128, 255]);
+  });
+
+  test('rejects invalid dimensions and RGBA byte length', () => {
+    expect(() => encodePro2Wallpaper({ width: 0, height: 1, rgba: new Uint8Array() })).toThrow(
+      'width'
+    );
+    expect(() => encodePro2Wallpaper({ width: 2, height: 1, rgba: new Uint8Array(4) })).toThrow(
+      '8'
+    );
+  });
+});

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

@@ -0,0 +1,37 @@
+import { Device } from '../src/device/Device';
+import { UI_REQUEST } from '../src/events/ui-request';
+
+jest.mock('../src/data/config', () => ({
+  getSDKVersion: jest.fn(() => '1.0.0'),
+  DEFAULT_DOMAIN: 'https://jssdk.onekey.so/1.0.0/',
+}));
+
+const createBootloaderDevice = (protocolType: 'V1' | 'V2') => {
+  const device = Device.fromDescriptor({
+    id: `${protocolType.toLowerCase()}-bootloader`,
+    path: `${protocolType.toLowerCase()}-bootloader`,
+    protocolType,
+  } as any);
+
+  (device as any).features = {
+    bootloaderMode: true,
+    initialized: true,
+    noBackup: false,
+  };
+
+  return device;
+};
+
+describe('Pro2 bootloader mode', () => {
+  test('does not block Protocol V2 methods in bootloader mode', () => {
+    const device = createBootloaderDevice('V2');
+
+    expect(device.hasUnexpectedMode([], [])).toBeNull();
+  });
+
+  test('keeps the Protocol V1 bootloader restriction', () => {
+    const device = createBootloaderDevice('V1');
+
+    expect(device.hasUnexpectedMode([], [])).toBe(UI_REQUEST.BOOTLOADER);
+  });
+});

package/__tests__/protocol-v2-firmware-targets.test.ts

@@ -0,0 +1,37 @@
+import { ProtocolV2FirmwareTargetType } from '../src/protocols/protocol-v2/firmware';
+import { isProtocolV2FirmwareFingerprintValid } from '../src/api/FirmwareUpdateV4';
+
+jest.mock('../src/data/config', () => ({
+  DEFAULT_DOMAIN: 'https://example.com/',
+  getSDKVersion: () => '0.0.0-test',
+}));
+
+describe('Protocol V2 firmware target contract', () => {
+  test('matches the current firmware-pro2 target ids', () => {
+    expect(ProtocolV2FirmwareTargetType).toEqual({
+      FW_MGMT_TARGET_INVALID: 0,
+      FW_MGMT_TARGET_CRATE: 1,
+      FW_MGMT_TARGET_ROMLOADER: 2,
+      FW_MGMT_TARGET_BOOTLOADER: 3,
+      FW_MGMT_TARGET_APPLICATION_P1: 4,
+      FW_MGMT_TARGET_APPLICATION_P2: 5,
+      FW_MGMT_TARGET_COPROCESSOR: 6,
+      FW_MGMT_TARGET_SE01: 7,
+      FW_MGMT_TARGET_SE02: 8,
+      FW_MGMT_TARGET_SE03: 9,
+      FW_MGMT_TARGET_SE04: 10,
+    });
+  });
+
+  test('validates the full package SHA-256 fingerprint from config', () => {
+    const binary = Uint8Array.from([1, 2, 3]);
+
+    expect(
+      isProtocolV2FirmwareFingerprintValid(
+        binary,
+        '039058c6f2c0cb492c533b0a4d14ef77cc0f78abccced5287d84a1a2011cfb81'
+      )
+    ).toBe(true);
+    expect(isProtocolV2FirmwareFingerprintValid(binary, '00'.repeat(32))).toBe(false);
+  });
+});

package/__tests__/protocol-v2-ping.test.ts

@@ -0,0 +1,28 @@
+import { validateProtocolV2PingMessage } from '../src/api/protocol-v2/Ping';
+
+jest.mock('../src/data/config', () => ({
+  DEFAULT_DOMAIN: 'https://example.com/',
+  getSDKVersion: () => '0.0.0-test',
+}));
+
+describe('Protocol V2 diagnostic Ping validation', () => {
+  test('accepts messages up to the firmware UTF-8 byte limit', () => {
+    expect(validateProtocolV2PingMessage('x'.repeat(63))).toBe('x'.repeat(63));
+    expect(validateProtocolV2PingMessage('测'.repeat(21))).toBe('测'.repeat(21));
+  });
+
+  test('rejects messages larger than the firmware UTF-8 byte limit', () => {
+    expect(() => validateProtocolV2PingMessage('x'.repeat(64))).toThrow(
+      'Protocol V2 Ping message must not exceed 63 UTF-8 bytes.'
+    );
+    expect(() => validateProtocolV2PingMessage('测'.repeat(22))).toThrow(
+      'Protocol V2 Ping message must not exceed 63 UTF-8 bytes.'
+    );
+  });
+
+  test('rejects non-string messages at the runtime API boundary', () => {
+    expect(() => validateProtocolV2PingMessage(64)).toThrow(
+      'Protocol V2 Ping message must be a string.'
+    );
+  });
+});

package/__tests__/protocol-v2-ui-lifecycle.test.ts

@@ -0,0 +1,56 @@
+import { DeviceSessionPinType } from '@onekeyfe/hd-transport';
+
+import { DEVICE } from '../src/events';
+import { Device } from '../src/device/Device';
+
+jest.mock('../src/data/config', () => ({
+  getSDKVersion: jest.fn(() => '1.0.0-test'),
+  DEFAULT_DOMAIN: 'https://example.com/',
+}));
+
+describe('Protocol V2 UI interaction lifecycle', () => {
+  test('emits a matching PIN phase completion after DeviceSessionAskPin succeeds', async () => {
+    const device = new Device({ id: 'connect-1' } as any);
+    device.isProtocolV2 = jest.fn(() => true);
+    device.updateProtocolV2Status = jest.fn(() => undefined as any);
+    device.commands = {
+      typedCall: jest.fn().mockResolvedValue({
+        message: { unlocked: true },
+      }),
+    } as any;
+    device.beginProtocolV2UiInteraction();
+
+    const starts: unknown[] = [];
+    const completions: unknown[] = [];
+    device.on(DEVICE.PIN_ON_DEVICE, (...args) => starts.push(args));
+    device.on(DEVICE.PIN_ON_DEVICE_COMPLETE, (...args) => completions.push(args));
+
+    await device.unlockDevice(DeviceSessionPinType.Main, {
+      source: 'unlock-coordinator',
+      reason: 'device-locked',
+      deviceOnly: true,
+    });
+
+    const startMetadata = (starts[0] as unknown[])[2] as Record<string, unknown>;
+    const completionMetadata = (completions[0] as unknown[])[1] as Record<string, unknown>;
+    expect(startMetadata.interaction).toMatchObject({
+      phase: 'pin',
+      transition: 'start',
+      protocol: 'V2',
+    });
+    expect(completionMetadata).toMatchObject({
+      interactionId: (startMetadata.interaction as { interactionId: string }).interactionId,
+      phaseId: (startMetadata.interaction as { phaseId: string }).phaseId,
+      phase: 'pin',
+      transition: 'complete',
+      outcome: 'succeeded',
+      protocol: 'V2',
+    });
+    expect(completionMetadata.sequence).toBeGreaterThan(
+      (startMetadata.interaction as { sequence: number }).sequence
+    );
+    expect(completionMetadata.phaseId).toBe(
+      (startMetadata.interaction as { phaseId: string }).phaseId
+    );
+  });
+});

package/__tests__/protocol-v2-unlock-policy.test.ts

@@ -0,0 +1,96 @@
+import ConfluxSignMessageCIP23 from '../src/api/conflux/ConfluxSignMessageCIP23';
+import DeviceLock from '../src/api/device/DeviceLock';
+import { runMethodWithUnlockPolicy } from '../src/protocols/protocol-v2/unlockPolicyRunner';
+
+jest.mock('../src/data/config', () => ({
+  DEFAULT_DOMAIN: 'https://example.com/',
+  getSDKVersion: () => '0.0.0-test',
+}));
+
+describe('Protocol V2 unlock semantics', () => {
+  test('wallet business methods inherit the wallet-session unlock requirement', () => {
+    const method = new ConfluxSignMessageCIP23({
+      id: 1,
+      payload: { method: 'confluxSignMessageCIP23' },
+    });
+
+    expect(method.useDevicePassphraseState).toBe(true);
+    expect(method.unlockPolicy).toBe('none');
+    expect(method.getSupportedProtocols()).toContain('V2');
+  });
+
+  test('lock-free Protocol V2 controls explicitly opt out of wallet-session handling', () => {
+    const method = new DeviceLock({
+      id: 1,
+      payload: { method: 'deviceLock' },
+    });
+
+    method.init();
+
+    expect(method.useDevicePassphraseState).toBe(false);
+    expect(method.unlockPolicy).toBe('none');
+  });
+
+  test('pre-unlocks an unregistered wallet business method', async () => {
+    const features = { unlocked: false };
+    const method = {
+      name: 'newWalletBusinessMethod',
+      unlockPolicy: 'none',
+      useDevicePassphraseState: true,
+      run: jest.fn().mockResolvedValue({ message: 'ok' }),
+    };
+    const device = {
+      features,
+      commands: {
+        typedCall: jest.fn().mockResolvedValue({ message: { unlocked: false } }),
+      },
+      isProtocolV2: () => true,
+      isBootloader: () => false,
+      isRomloader: () => false,
+      updateProtocolV2Status: jest.fn(() => features),
+      unlockDevice: jest.fn().mockImplementation(() => {
+        features.unlocked = true;
+        return Promise.resolve(features);
+      }),
+    };
+
+    await expect(runMethodWithUnlockPolicy(method as any, device as any)).resolves.toEqual({
+      message: 'ok',
+    });
+    expect(device.unlockDevice).toHaveBeenCalledTimes(1);
+    expect(method.run).toHaveBeenCalledTimes(1);
+  });
+
+  test('runs fresh-status validation before starting unlock', async () => {
+    const identityError = new Error('Unexpected device');
+    const method = {
+      name: 'walletBusinessMethod',
+      unlockPolicy: 'none',
+      useDevicePassphraseState: true,
+      run: jest.fn(),
+    };
+    const features = { unlocked: false };
+    const device = {
+      features,
+      commands: {
+        typedCall: jest.fn().mockResolvedValue({ message: { unlocked: false } }),
+      },
+      isProtocolV2: () => true,
+      isBootloader: () => false,
+      isRomloader: () => false,
+      updateProtocolV2Status: jest.fn(() => features),
+      unlockDevice: jest.fn(),
+    };
+
+    await expect(
+      runMethodWithUnlockPolicy(method as any, device as any, {
+        afterStatusBeforeUnlock: () => {
+          throw identityError;
+        },
+      })
+    ).rejects.toBe(identityError);
+
+    expect(device.unlockDevice).not.toHaveBeenCalled();
+    expect(method.run).not.toHaveBeenCalled();
+  });
+});