@onekeyfe/hd-core 1.2.0-alpha.8 → 1.2.0-alpha.80

package/src/api/cardano/CardanoSignMessage.ts

@@ -7,6 +7,10 @@ import { validatePath } from '../helpers/pathUtils';
 import type { CardanoSignMessageParams } from '../../types/api/cardanoSignMessage';
 
 export default class CardanoSignMessage extends BaseMethod<CardanoSignMessageParams> {
+  getSupportedProtocols() {
+    return ['V1', 'V2'] as const;
+  }
+
   hasBundle?: boolean;
 
   isCheck?: boolean;
@@ -14,7 +18,7 @@ export default class CardanoSignMessage extends BaseMethod<CardanoSignMessagePar
   init() {
     this.checkDeviceId = true;
     this.allowDeviceMode = [...this.allowDeviceMode, UI_REQUEST.NOT_INITIALIZE];
-    this.allowUsePreInitialize = true;
+    this.allowUsePreInitialize = false;
 
     const { payload } = this;
     validateParams(payload, [

package/src/api/cardano/CardanoSignTransaction.ts

@@ -32,6 +32,10 @@ import type {
 } from '../../types/api/cardano';
 
 export default class CardanoSignTransaction extends BaseMethod<any> {
+  getSupportedProtocols() {
+    return ['V1', 'V2'] as const;
+  }
+
   hasBundle?: boolean;
 
   getVersionRange() {
@@ -48,7 +52,7 @@ export default class CardanoSignTransaction extends BaseMethod<any> {
   init() {
     this.checkDeviceId = true;
     this.allowDeviceMode = [...this.allowDeviceMode, UI_REQUEST.NOT_INITIALIZE];
-    this.allowUsePreInitialize = true;
+    this.allowUsePreInitialize = false;
 
     this.hasBundle = !!this.payload?.bundle;
 

package/src/api/conflux/ConfluxGetAddress.ts

@@ -7,6 +7,12 @@ import type { ConfluxGetAddress as HardwareConfluxGetAddress } from '@onekeyfe/h
 import type { ConfluxAddress, ConfluxGetAddressParams } from '../../types/api/confluxGetAddress';
 
 export default class ConfluxGetAddress extends BaseMethod<HardwareConfluxGetAddress[]> {
+  getSupportedProtocols() {
+    return ['V1', 'V2'] as const;
+  }
+
+  checkDeviceId = true;
+
   hasBundle = false;
 
   init() {

package/src/api/conflux/ConfluxSignMessage.ts

@@ -7,6 +7,12 @@ import { formatAnyHex } from '../helpers/hexUtils';
 import type { ConfluxSignMessage as HardwareConfluxSignMessage } from '@onekeyfe/hd-transport';
 
 export default class ConfluxSignMessage extends BaseMethod<HardwareConfluxSignMessage> {
+  getSupportedProtocols() {
+    return ['V1', 'V2'] as const;
+  }
+
+  checkDeviceId = true;
+
   init() {
     this.allowDeviceMode = [...this.allowDeviceMode, UI_REQUEST.NOT_INITIALIZE];
     this.allowUsePreInitialize = true;

package/src/api/conflux/ConfluxSignMessageCIP23.ts

@@ -7,6 +7,12 @@ import { formatAnyHex } from '../helpers/hexUtils';
 import type { ConfluxSignMessageCIP23 as HardwareConfluxSignMessageCIP23 } from '@onekeyfe/hd-transport';
 
 export default class ConfluxSignMessageCIP23 extends BaseMethod<HardwareConfluxSignMessageCIP23> {
+  getSupportedProtocols() {
+    return ['V1', 'V2'] as const;
+  }
+
+  checkDeviceId = true;
+
   init() {
     this.allowDeviceMode = [...this.allowDeviceMode, UI_REQUEST.NOT_INITIALIZE];
     this.allowUsePreInitialize = true;

package/src/api/conflux/ConfluxSignTransaction.ts

@@ -16,6 +16,12 @@ import type {
 import type { ConfluxSignTx, ConfluxTxRequest } from '@onekeyfe/hd-transport';
 
 export default class ConfluxSignTransaction extends BaseMethod {
+  getSupportedProtocols() {
+    return ['V1', 'V2'] as const;
+  }
+
+  checkDeviceId = true;
+
   addressN: number[] = [];
 
   formattedTx: ConfluxTransaction | undefined;
@@ -35,7 +41,7 @@ export default class ConfluxSignTransaction extends BaseMethod {
 
     // check if transaction is valid
     const schema: SchemaParam[] = [
-      { name: 'to', type: 'string', required: true },
+      { name: 'to', type: 'hexString', required: true },
       { name: 'value', type: 'hexString', required: true },
       { name: 'gasLimit', type: 'hexString', required: true },
       { name: 'gasPrice', type: 'hexString', required: true },
@@ -48,10 +54,7 @@ export default class ConfluxSignTransaction extends BaseMethod {
 
     validateParams(tx, schema);
 
-    this.formattedTx = {
-      ...formatAnyHex(tx),
-      to: tx.to,
-    };
+    this.formattedTx = formatAnyHex(tx);
   }
 
   processTxRequest = async (request: ConfluxTxRequest, data: string): Promise<ConfluxSignedTx> => {

package/src/api/cosmos/CosmosGetAddress.ts

@@ -6,6 +6,10 @@ import type { CosmosGetAddress as HardwareCosmosGetAddress } from '@onekeyfe/hd-
 import type { CosmosAddress, CosmosGetAddressParams } from '../../types';
 
 export default class CosmosGetAddress extends BaseMethod<HardwareCosmosGetAddress[]> {
+  getSupportedProtocols() {
+    return ['V1', 'V2'] as const;
+  }
+
   hasBundle = false;
 
   init() {

package/src/api/cosmos/CosmosGetPublicKey.ts

@@ -7,6 +7,10 @@ import { batchGetPublickeys } from '../helpers/batchGetPublickeys';
 import type { CosmosAddress, CosmosGetPublicKeyParams } from '../../types';
 
 export default class CosmosGetPublicKey extends BaseMethod<any> {
+  getSupportedProtocols() {
+    return ['V1', 'V2'] as const;
+  }
+
   hasBundle = false;
 
   init() {

package/src/api/cosmos/CosmosSignTransaction.ts

@@ -9,6 +9,10 @@ import type { CosmosSignTx as HardwareCosmosSignTx } from '@onekeyfe/hd-transpor
 import type { CosmosSignTransactionParams } from '../../types';
 
 export default class CosmosSignTransaction extends BaseMethod<HardwareCosmosSignTx> {
+  getSupportedProtocols() {
+    return ['V1', 'V2'] as const;
+  }
+
   hasBundle = false;
 
   init() {

package/src/api/device/DeviceCancel.ts

@@ -3,8 +3,13 @@ import { BaseMethod } from '../BaseMethod';
 import type { Cancel } from '@onekeyfe/hd-transport';
 
 export default class DeviceCancel extends BaseMethod<Cancel> {
+  getSupportedProtocols() {
+    return ['V1', 'V2'] as const;
+  }
+
   init() {
     this.useDevicePassphraseState = false;
+    this.unlockPolicy = 'none';
   }
 
   async run() {

package/src/api/device/DeviceChangePin.ts

@@ -1,10 +1,18 @@
+import { DeviceSettingsPage } from '@onekeyfe/hd-transport';
+
 import { BaseMethod } from '../BaseMethod';
 import { validateParams } from '../helpers/paramsValidator';
+import { invalidParameter } from '../helpers/filesystemValidation';
 
 import type { ChangePin } from '@onekeyfe/hd-transport';
 
 export default class DeviceChangePin extends BaseMethod<ChangePin> {
+  getSupportedProtocols() {
+    return ['V1', 'V2'] as const;
+  }
+
   init() {
+    this.unlockPolicy = 'unlock-before-run';
     this.useDevicePassphraseState = false;
 
     // check payload
@@ -13,9 +21,29 @@ export default class DeviceChangePin extends BaseMethod<ChangePin> {
     this.params = {
       remove: this.payload.remove,
     };
+    this.protocolV2UiInteraction = {
+      request: 'button',
+      source: 'method-lifecycle',
+      reason: 'change-pin',
+      completion: 'operation-completed',
+      deviceOnly: true,
+      page: DeviceSettingsPage.DevicePinChange,
+    };
   }
 
   async run() {
+    if (this.device.isProtocolV2()) {
+      if (this.params.remove) {
+        throw invalidParameter(
+          'Parameter [remove=true] is not supported by the Pro2 device PIN page.'
+        );
+      }
+      const res = await this.device.commands.typedCall('DeviceSettingsPageShow', 'Success', {
+        page: DeviceSettingsPage.DevicePinChange,
+      });
+      return Promise.resolve(res.message);
+    }
+
     const res = await this.device.commands.typedCall('ChangePin', 'Success', {
       ...this.params,
     });

package/src/api/device/DeviceFullyUploadResource.ts

@@ -5,12 +5,11 @@ import { UI_REQUEST } from '../../constants/ui-request';
 import { BaseMethod } from '../BaseMethod';
 import { getSysResourceBinary } from '../firmware/getBinary';
 import { updateResources } from '../firmware/uploadFirmware';
-import { getDeviceFirmwareVersion, getFirmwareType } from '../../utils';
 import { createUiMessage } from '../../events/ui-request';
 import { DataManager } from '../../data-manager';
 
 import type { Deferred } from '@onekeyfe/hd-shared';
-import type { Features, KnownDevice } from '../../types';
+import type { KnownDevice } from '../../types';
 import type { DeviceFullyUploadResourceParams } from '../../types/api/deviceFullyUploadResource';
 
 export default class DeviceFullyUploadResource extends BaseMethod {
@@ -33,12 +32,12 @@ export default class DeviceFullyUploadResource extends BaseMethod {
     );
   };
 
-  isSupportResourceUpdate(features: Features, updateType: string) {
+  isSupportResourceUpdate(updateType: string) {
     if (updateType !== 'firmware') return false;
 
     const deviceType = this.device.getCurrentDeviceType();
     const isTouchMode = deviceType === EDeviceType.Touch || deviceType === EDeviceType.Pro;
-    const currentVersion = getDeviceFirmwareVersion(features).join('.');
+    const currentVersion = this.device.getCurrentFirmwareVersionString() ?? '0.0.0';
 
     return isTouchMode && semver.gte(currentVersion, '3.4.0');
   }
@@ -49,7 +48,7 @@ export default class DeviceFullyUploadResource extends BaseMethod {
 
     const payload = this.payload as DeviceFullyUploadResourceParams;
 
-    const deviceFirmwareType = getFirmwareType(features);
+    const deviceFirmwareType = device.getCurrentFirmwareType();
     const firmwareType = payload.firmwareType ?? deviceFirmwareType;
 
     if (!device.isBootloader() && features) {

package/src/api/device/DeviceLock.ts

@@ -3,8 +3,13 @@ import { BaseMethod } from '../BaseMethod';
 import type { LockDevice } from '@onekeyfe/hd-transport';
 
 export default class DeviceLock extends BaseMethod<LockDevice> {
+  getSupportedProtocols() {
+    return ['V1', 'V2'] as const;
+  }
+
   init() {
     this.useDevicePassphraseState = false;
+    this.unlockPolicy = 'none';
   }
 
   async run() {

package/src/api/device/DeviceRebootToBoardloader.ts

@@ -6,6 +6,10 @@ import type { RebootToBoardloaderParams } from '../../types/api/deviceRebootToBo
 
 // Reboot BoardLoader
 export default class DeviceRebootToBoardloader extends BaseMethod<RebootToBoardloaderParams> {
+  getSupportedProtocols() {
+    return ['V1', 'V2'] as const;
+  }
+
   init() {
     this.useDevicePassphraseState = false;
     this.skipForceUpdateCheck = true;
@@ -28,6 +32,7 @@ export default class DeviceRebootToBoardloader extends BaseMethod<RebootToBoardl
       const res = await this.device.commands.typedCall('DeviceReboot', 'Success', {
         reboot_type: DeviceRebootType.Romloader,
       });
+      this.device.markProtocolV2Reboot(DeviceRebootType.Romloader);
       return Promise.resolve(res.message);
     }
 

package/src/api/device/DeviceRebootToBootloader.ts

@@ -6,6 +6,10 @@ import type { RebootToBootloader } from '@onekeyfe/hd-transport';
 
 // Reboot BootLoader
 export default class DeviceRebootToBootloader extends BaseMethod<RebootToBootloader> {
+  getSupportedProtocols() {
+    return ['V1', 'V2'] as const;
+  }
+
   init() {
     this.useDevicePassphraseState = false;
     this.skipForceUpdateCheck = true;
@@ -28,6 +32,7 @@ export default class DeviceRebootToBootloader extends BaseMethod<RebootToBootloa
       const res = await this.device.commands.typedCall('DeviceReboot', 'Success', {
         reboot_type: DeviceRebootType.Bootloader,
       });
+      this.device.markProtocolV2Reboot(DeviceRebootType.Bootloader);
       return Promise.resolve(res.message);
     }
 

package/src/api/device/DeviceSettings.ts

@@ -1,12 +1,81 @@
 import { HardwareErrorCode, TypedError } from '@onekeyfe/hd-shared';
+import { DeviceSettingsPage } from '@onekeyfe/hd-transport';
 
 import { BaseMethod } from '../BaseMethod';
+import { invalidParameter } from '../helpers/filesystemValidation';
 import { validateParams } from '../helpers/paramsValidator';
-import { LANGUAGE_LABELS } from '../../utils/deviceSettings';
+import {
+  mapApplySettingsToState,
+  mapCommonSettingsToProtocolV2,
+} from '../../device/DeviceStateMapper';
+import { getProtocolV2SettingsBehavior } from '../../protocols/protocol-v2/settingsUnlockPolicy';
+import {
+  DEVICE_SETTINGS_V1_ONLY_FIELDS,
+  DEVICE_SETTINGS_V2_ONLY_FIELDS,
+  LANGUAGE_LABELS,
+  getDeviceSettingsCapabilities,
+} from '../../utils/deviceSettings';
 
 import type { ApplySettings } from '@onekeyfe/hd-transport';
+import type { DeviceSettingsParams } from '../../types/api/deviceSettings';
+
+const assertSettingsSupported = (
+  payload: DeviceSettingsParams,
+  unsupported: readonly (keyof DeviceSettingsParams)[],
+  protocol: 'Protocol V1' | 'Protocol V2'
+) => {
+  const provided = unsupported.filter(key => payload[key] !== undefined);
+  if (provided.length > 0) {
+    throw invalidParameter(`${protocol} does not support settings: ${provided.join(', ')}.`);
+  }
+};
+
+const assertProtocolV2SettingValues = (
+  payload: DeviceSettingsParams,
+  capabilities: ReturnType<typeof getDeviceSettingsCapabilities>
+) => {
+  const brightnessRange = capabilities.ranges.brightness;
+  if (
+    payload.brightness !== undefined &&
+    brightnessRange &&
+    (payload.brightness < brightnessRange.min || payload.brightness > brightnessRange.max)
+  ) {
+    throw invalidParameter(
+      `Protocol V2 brightness must be between ${brightnessRange.min} and ${brightnessRange.max}.`
+    );
+  }
+
+  const delayFields = [
+    ['autoLockDelayMs', capabilities.autoLockDelayOptions],
+    ['autoShutdownDelayMs', capabilities.autoShutdownDelayOptions],
+  ] as const;
+  delayFields.forEach(([field, options]) => {
+    const value = payload[field];
+    if (value !== undefined && !options.some(option => option.valueMs === value)) {
+      throw invalidParameter(
+        `Protocol V2 ${field} must be one of: ${options.map(option => option.valueMs).join(', ')}.`
+      );
+    }
+  });
+};
+
+const settingsPageForPayload = (
+  payload: DeviceSettingsParams
+): DeviceSettingsPage.DevicePassphrase | DeviceSettingsPage.DeviceAirgap | undefined => {
+  if (payload.usePassphrase !== undefined) {
+    return DeviceSettingsPage.DevicePassphrase;
+  }
+  if (payload.airgapMode !== undefined) {
+    return DeviceSettingsPage.DeviceAirgap;
+  }
+  return undefined;
+};
 
 export default class DeviceSettings extends BaseMethod<ApplySettings> {
+  getSupportedProtocols() {
+    return ['V1', 'V2'] as const;
+  }
+
   init() {
     this.useDevicePassphraseState = false;
 
@@ -24,7 +93,16 @@ export default class DeviceSettings extends BaseMethod<ApplySettings> {
       { name: 'experimentalFeatures', type: 'boolean' },
       { name: 'autoShutdownDelayMs', type: 'number' },
       { name: 'changeBrightness', type: 'boolean' },
+      { name: 'brightness', type: 'number' },
       { name: 'hapticFeedback', type: 'boolean' },
+      { name: 'bluetoothEnabled', type: 'boolean' },
+      { name: 'airgapMode', type: 'boolean' },
+      { name: 'animationEnabled', type: 'boolean' },
+      { name: 'tapToWake', type: 'boolean' },
+      { name: 'deviceNameDisplayEnabled', type: 'boolean' },
+      { name: 'fidoEnabled', type: 'boolean' },
+      { name: 'usbLockEnabled', type: 'boolean' },
+      { name: 'randomKeypad', type: 'boolean' },
     ]);
 
     // init params
@@ -40,11 +118,34 @@ export default class DeviceSettings extends BaseMethod<ApplySettings> {
       safety_checks: this.payload.safetyChecks,
       experimental_features: this.payload.experimentalFeatures,
       auto_shutdown_delay_ms: this.payload.autoShutdownDelayMs,
+      use_ble: this.payload.bluetoothEnabled,
       ...(this.payload.changeBrightness
         ? { change_brightness: this.payload.changeBrightness }
         : undefined),
       haptic_feedback: this.payload.hapticFeedback,
     };
+    const page = settingsPageForPayload(this.payload);
+    const directSettings = mapCommonSettingsToProtocolV2(this.payload);
+    const hasConflictingPages =
+      this.payload.usePassphrase !== undefined && this.payload.airgapMode !== undefined;
+    const combinesPageWithDirectSettings =
+      page !== undefined && Object.keys(directSettings).length > 0;
+    if (hasConflictingPages || combinesPageWithDirectSettings) {
+      // V1 may still accept passphrase plus direct settings. Suppress only the
+      // Protocol V2 pre-run interaction; run() returns the protocol-specific error.
+      this.unlockPolicy = 'none';
+      this.protocolV2UiInteraction = undefined;
+      return;
+    }
+    const behavior =
+      page === undefined
+        ? getProtocolV2SettingsBehavior({
+            kind: 'direct',
+            settings: directSettings,
+          })
+        : getProtocolV2SettingsBehavior({ kind: 'page', page });
+    this.unlockPolicy = behavior.unlockPolicy;
+    this.protocolV2UiInteraction = behavior.uiInteraction;
   }
 
   getVersionRange() {
@@ -60,9 +161,102 @@ export default class DeviceSettings extends BaseMethod<ApplySettings> {
 
   async run() {
     try {
+      if (this.device.isProtocolV2()) {
+        const refreshStatusAndSettings = () =>
+          this.device.getDeviceState({ refreshSections: ['status', 'settings'] });
+        assertSettingsSupported(this.payload, DEVICE_SETTINGS_V1_ONLY_FIELDS, 'Protocol V2');
+        const capabilities = getDeviceSettingsCapabilities(
+          this.device.getCurrentDeviceType(),
+          'V2'
+        );
+        assertProtocolV2SettingValues(this.payload, capabilities);
+        const settings = mapCommonSettingsToProtocolV2(this.payload);
+        const requestedPassphrase = this.payload.usePassphrase;
+        const requestedAirgap = this.payload.airgapMode;
+        const hasPassphrasePage = requestedPassphrase !== undefined;
+        const hasAirgapPage = requestedAirgap !== undefined;
+
+        if (hasPassphrasePage && hasAirgapPage) {
+          throw invalidParameter(
+            'Protocol V2 passphrase and air-gap settings must be changed in separate calls.'
+          );
+        }
+        if ((hasPassphrasePage || hasAirgapPage) && Object.keys(settings).length > 0) {
+          throw invalidParameter(
+            'Protocol V2 on-device settings must not be combined with direct settings.'
+          );
+        }
+        if (requestedPassphrase !== undefined) {
+          const current = await this.device.getDeviceState({ refreshSections: ['status'] });
+          if (current.status.passphraseProtection === requestedPassphrase) {
+            return { message: 'Settings already match requested value.' };
+          }
+
+          const res = await this.device.commands.typedCall('DeviceSettingsPageShow', 'Success', {
+            page: DeviceSettingsPage.DevicePassphrase,
+          });
+          const updated = await refreshStatusAndSettings();
+          const lockedAfterDisabling =
+            requestedPassphrase === false &&
+            current.status.unlocked === true &&
+            updated.status.unlocked === false;
+          if (
+            updated.status.passphraseProtection !== requestedPassphrase &&
+            !lockedAfterDisabling
+          ) {
+            throw TypedError(
+              HardwareErrorCode.RuntimeError,
+              'Protocol V2 passphrase setting did not reach the requested value.'
+            );
+          }
+          return res.message;
+        }
+        if (requestedAirgap !== undefined) {
+          const current = await this.device.getDeviceState({ refreshSections: ['settings'] });
+          if (current.settings.airgapMode === requestedAirgap) {
+            return { message: 'Settings already match requested value.' };
+          }
+
+          const res = await this.device.commands.typedCall('DeviceSettingsPageShow', 'Success', {
+            page: DeviceSettingsPage.DeviceAirgap,
+          });
+          const updated = await refreshStatusAndSettings();
+          if (updated.settings.airgapMode !== requestedAirgap) {
+            throw TypedError(
+              HardwareErrorCode.RuntimeError,
+              'Protocol V2 air-gap setting did not reach the requested value.'
+            );
+          }
+          return res.message;
+        }
+        if (Object.keys(settings).length === 0) {
+          throw invalidParameter('No Protocol V2 compatible setting provided.');
+        }
+
+        const res = await this.device.commands.typedCall('DeviceSettingsSet', 'Success', {
+          settings,
+        });
+        await refreshStatusAndSettings();
+        return res.message;
+      }
+
+      assertSettingsSupported(this.payload, DEVICE_SETTINGS_V2_ONLY_FIELDS, 'Protocol V1');
+      const capabilities = getDeviceSettingsCapabilities(this.device.getCurrentDeviceType(), 'V1');
+      if (
+        this.payload.safetyChecks !== undefined &&
+        !capabilities.safetyCheckOptions.some(option => option.value === this.payload.safetyChecks)
+      ) {
+        throw invalidParameter(
+          `Protocol V1 safetyChecks must be one of: ${capabilities.safetyCheckOptions
+            .map(option => option.value)
+            .join(', ')}.`
+        );
+      }
+
       const res = await this.device.commands.typedCall('ApplySettings', 'Success', {
         ...this.params,
       });
+      this.device.updateState(mapApplySettingsToState(this.params), 'settings-write');
       return res.message;
     } catch (error) {
       if (error.message?.toLowerCase().includes('no setting provided')) {

package/src/api/device/DeviceSupportFeatures.ts

@@ -1,6 +1,10 @@
 import { BaseMethod } from '../BaseMethod';
 
 export default class DeviceSupportFeatures extends BaseMethod {
+  getSupportedProtocols() {
+    return ['V1', 'V2'] as const;
+  }
+
   init() {
     this.useDevicePassphraseState = false;
     this.skipForceUpdateCheck = true;

package/src/api/device/DeviceUnlock.ts

@@ -1,13 +1,31 @@
+import { DeviceSessionPinType } from '@onekeyfe/hd-transport';
+
 import { BaseMethod } from '../BaseMethod';
 
-import type { LockDevice } from '@onekeyfe/hd-transport';
+import type { DeviceUnlockParams } from '../../types/api/deviceUnlock';
+
+export default class DeviceUnlock extends BaseMethod<DeviceUnlockParams> {
+  getSupportedProtocols() {
+    return ['V1', 'V2'] as const;
+  }
 
-export default class DeviceUnlock extends BaseMethod<LockDevice> {
   init() {
+    this.params = {
+      pinType: this.payload.pinType ?? DeviceSessionPinType.Main,
+    };
     this.useDevicePassphraseState = false;
+    this.unlockPolicy = 'none';
+    this.protocolV2UiInteraction = {
+      request: 'pin',
+      source: 'method-lifecycle',
+      reason: 'device-unlock',
+      completion: 'operation-completed',
+      deviceOnly: true,
+      operation: 'unlock-device',
+    };
   }
 
   async run() {
-    return this.device.unlockDevice();
+    return this.device.unlockDevice(this.params.pinType, { emitUiEvent: false });
   }
 }