@onekeyfe/hd-core 1.0.33-alpha.5 → 1.0.33-alpha.6

package/src/api/starcoin/StarcoinGetPublicKey.ts

@@ -13,7 +13,7 @@ export default class StarcoinGetPublicKey extends BaseMethod<HardwareStarcoinGet
 
   init() {
     this.checkDeviceId = true;
-    this.notAllowDeviceMode = [...this.notAllowDeviceMode, UI_REQUEST.INITIALIZE];
+    this.allowDeviceMode = [...this.allowDeviceMode, UI_REQUEST.NOT_INITIALIZE];
 
     this.hasBundle = !!this.payload?.bundle;
     const payload = this.hasBundle ? this.payload : { bundle: [this.payload] };

package/src/api/starcoin/StarcoinSignMessage.ts

@@ -8,7 +8,7 @@ import { formatAnyHex } from '../helpers/hexUtils';
 export default class StarcoinSignMessage extends BaseMethod<HardwareStarcoinSignMessage> {
   init() {
     this.checkDeviceId = true;
-    this.notAllowDeviceMode = [...this.notAllowDeviceMode, UI_REQUEST.INITIALIZE];
+    this.allowDeviceMode = [...this.allowDeviceMode, UI_REQUEST.NOT_INITIALIZE];
 
     // check payload
     validateParams(this.payload, [

package/src/api/starcoin/StarcoinSignTransaction.ts

@@ -8,7 +8,7 @@ import { formatAnyHex } from '../helpers/hexUtils';
 export default class StarcoinSignTransaction extends BaseMethod<StarcoinSignTx> {
   init() {
     this.checkDeviceId = true;
-    this.notAllowDeviceMode = [...this.notAllowDeviceMode, UI_REQUEST.INITIALIZE];
+    this.allowDeviceMode = [...this.allowDeviceMode, UI_REQUEST.NOT_INITIALIZE];
 
     // check payload
     validateParams(this.payload, [

package/src/api/starcoin/StarcoinVerifyMessage.ts

@@ -7,7 +7,7 @@ import { formatAnyHex } from '../helpers/hexUtils';
 export default class EVMSignMessage extends BaseMethod<HardwareStarcoinVerifyMessage> {
   init() {
     this.checkDeviceId = true;
-    this.notAllowDeviceMode = [...this.notAllowDeviceMode, UI_REQUEST.INITIALIZE];
+    this.allowDeviceMode = [...this.allowDeviceMode, UI_REQUEST.NOT_INITIALIZE];
 
     validateParams(this.payload, [
       { name: 'publicKey', type: 'string', required: true },

package/src/api/stellar/StellarGetAddress.ts

@@ -10,7 +10,7 @@ export default class StellarGetAddress extends BaseMethod<HardwareStellarGetAddr
 
   init() {
     this.checkDeviceId = true;
-    this.notAllowDeviceMode = [...this.notAllowDeviceMode, UI_REQUEST.INITIALIZE];
+    this.allowDeviceMode = [...this.allowDeviceMode, UI_REQUEST.NOT_INITIALIZE];
 
     this.hasBundle = !!this.payload?.bundle;
     const payload = this.hasBundle ? this.payload : { bundle: [this.payload] };

package/src/api/stellar/StellarSignTransaction.ts

@@ -149,7 +149,7 @@ export default class StellarSignTransaction extends BaseMethod<HardwareStellarSi
 
   init() {
     this.checkDeviceId = true;
-    this.notAllowDeviceMode = [...this.notAllowDeviceMode, UI_REQUEST.INITIALIZE];
+    this.allowDeviceMode = [...this.allowDeviceMode, UI_REQUEST.NOT_INITIALIZE];
 
     // check payload
     validateParams(this.payload, [

package/src/api/sui/SuiGetAddress.ts

@@ -16,7 +16,7 @@ export default class SuiGetAddress extends BaseMethod<HardwareSuiGetAddress[]> {
 
   init() {
     this.checkDeviceId = true;
-    this.notAllowDeviceMode = [...this.notAllowDeviceMode, UI_REQUEST.INITIALIZE];
+    this.allowDeviceMode = [...this.allowDeviceMode, UI_REQUEST.NOT_INITIALIZE];
 
     this.hasBundle = !!this.payload?.bundle;
     const payload = this.hasBundle ? this.payload : { bundle: [this.payload] };

package/src/api/sui/SuiGetPublicKey.ts

@@ -10,7 +10,7 @@ export default class SuiGetPublicKey extends BaseMethod<any> {
 
   init() {
     this.checkDeviceId = true;
-    this.notAllowDeviceMode = [...this.notAllowDeviceMode, UI_REQUEST.INITIALIZE];
+    this.allowDeviceMode = [...this.allowDeviceMode, UI_REQUEST.NOT_INITIALIZE];
 
     this.hasBundle = !!this.payload?.bundle;
     const payload = this.hasBundle ? this.payload : { bundle: [this.payload] };

package/src/api/sui/SuiSignMessage.ts

@@ -8,7 +8,7 @@ import { stripHexPrefix } from '../helpers/hexUtils';
 export default class SuiSignMessage extends BaseMethod<HardwareSuiSignMessage> {
   init() {
     this.checkDeviceId = true;
-    this.notAllowDeviceMode = [...this.notAllowDeviceMode, UI_REQUEST.INITIALIZE];
+    this.allowDeviceMode = [...this.allowDeviceMode, UI_REQUEST.NOT_INITIALIZE];
 
     // check payload
     validateParams(this.payload, [

package/src/api/sui/SuiSignTransaction.ts

@@ -15,7 +15,7 @@ type SuiSignTx = Omit<HardwareSuiSignTx, 'data_initial_chunk' | 'data_length'> &
 export default class SuiSignTransaction extends BaseMethod<SuiSignTx> {
   init() {
     this.checkDeviceId = true;
-    this.notAllowDeviceMode = [...this.notAllowDeviceMode, UI_REQUEST.INITIALIZE];
+    this.allowDeviceMode = [...this.allowDeviceMode, UI_REQUEST.NOT_INITIALIZE];
 
     // check payload
     validateParams(this.payload, [

package/src/api/test/TestInitializeDeviceDuration.ts

@@ -3,9 +3,9 @@ import { BaseMethod } from '../BaseMethod';
 
 export default class TestInitializeDeviceDuration extends BaseMethod {
   init() {
-    this.notAllowDeviceMode = [
-      ...this.notAllowDeviceMode,
-      UI_REQUEST.INITIALIZE,
+    this.allowDeviceMode = [
+      ...this.allowDeviceMode,
+      UI_REQUEST.NOT_INITIALIZE,
       UI_REQUEST.BOOTLOADER,
     ];
     this.useDevicePassphraseState = false;

package/src/api/ton/TonGetAddress.ts

@@ -14,7 +14,7 @@ export default class TonGetAddress extends BaseMethod<HardwareTonGetAddress[]> {
   init() {
     this.strictCheckDeviceSupport = true;
     this.checkDeviceId = true;
-    this.notAllowDeviceMode = [...this.notAllowDeviceMode, UI_REQUEST.INITIALIZE];
+    this.allowDeviceMode = [...this.allowDeviceMode, UI_REQUEST.NOT_INITIALIZE];
 
     this.hasBundle = !!this.payload?.bundle;
     const payload = this.hasBundle ? this.payload : { bundle: [this.payload] };

package/src/api/ton/TonSignMessage.ts

@@ -22,7 +22,7 @@ export default class TonSignMessage extends BaseMethod<HardwareTonSignMessage> {
   init() {
     this.strictCheckDeviceSupport = true;
     this.checkDeviceId = true;
-    this.notAllowDeviceMode = [...this.notAllowDeviceMode, UI_REQUEST.INITIALIZE];
+    this.allowDeviceMode = [...this.allowDeviceMode, UI_REQUEST.NOT_INITIALIZE];
 
     // init params
     validateParams(this.payload, [

package/src/api/ton/TonSignProof.ts

@@ -10,7 +10,7 @@ export default class TonSignProof extends BaseMethod<HardwareTonSignProof> {
   init() {
     this.strictCheckDeviceSupport = true;
     this.checkDeviceId = true;
-    this.notAllowDeviceMode = [...this.notAllowDeviceMode, UI_REQUEST.INITIALIZE];
+    this.allowDeviceMode = [...this.allowDeviceMode, UI_REQUEST.NOT_INITIALIZE];
 
     // init params
     validateParams(this.payload, [

package/src/api/tron/TronGetAddress.ts

@@ -10,7 +10,7 @@ export default class TronGetAddress extends BaseMethod<HardwareTronGetAddress[]>
 
   init() {
     this.checkDeviceId = true;
-    this.notAllowDeviceMode = [...this.notAllowDeviceMode, UI_REQUEST.INITIALIZE];
+    this.allowDeviceMode = [...this.allowDeviceMode, UI_REQUEST.NOT_INITIALIZE];
 
     this.hasBundle = !!this.payload?.bundle;
     const payload = this.hasBundle ? this.payload : { bundle: [this.payload] };

package/src/api/tron/TronSignMessage.ts

@@ -8,7 +8,7 @@ import { stripHexPrefix } from '../helpers/hexUtils';
 export default class TronSignMessage extends BaseMethod<HardwareTronSignMessage> {
   init() {
     this.checkDeviceId = true;
-    this.notAllowDeviceMode = [...this.notAllowDeviceMode, UI_REQUEST.INITIALIZE];
+    this.allowDeviceMode = [...this.allowDeviceMode, UI_REQUEST.NOT_INITIALIZE];
 
     // check payload
     validateParams(this.payload, [

package/src/api/tron/TronSignTransaction.ts

@@ -119,7 +119,7 @@ export default class TronSignTransaction extends BaseMethod<TronSignTx> {
 
   init() {
     this.checkDeviceId = true;
-    this.notAllowDeviceMode = [...this.notAllowDeviceMode, UI_REQUEST.INITIALIZE];
+    this.allowDeviceMode = [...this.allowDeviceMode, UI_REQUEST.NOT_INITIALIZE];
 
     // check payload
     validateParams(this.payload, [

package/src/api/xrp/XrpGetAddress.ts

@@ -19,7 +19,7 @@ export default class XrpGetAddress extends BaseMethod<
 
   init() {
     this.checkDeviceId = true;
-    this.notAllowDeviceMode = [...this.notAllowDeviceMode, UI_REQUEST.INITIALIZE];
+    this.allowDeviceMode = [...this.allowDeviceMode, UI_REQUEST.NOT_INITIALIZE];
 
     this.hasBundle = !!this.payload?.bundle;
     const payload = this.hasBundle ? this.payload : { bundle: [this.payload] };

package/src/api/xrp/XrpSignTransaction.ts

@@ -9,7 +9,7 @@ export default class XrpGetAddress extends BaseMethod<XrpSignTransactionParams>
 
   init() {
     this.checkDeviceId = true;
-    this.notAllowDeviceMode = [...this.notAllowDeviceMode, UI_REQUEST.INITIALIZE];
+    this.allowDeviceMode = [...this.allowDeviceMode, UI_REQUEST.NOT_INITIALIZE];
 
     const { payload } = this;
     validateParams(payload, [

package/src/core/index.ts

@@ -285,7 +285,7 @@ const onCallDevice = async (
 
       // check call method mode
       const unexpectedMode = device.hasUnexpectedMode(
-        method.notAllowDeviceMode,
+        method.allowDeviceMode,
         method.requireDeviceMode
       );
       if (unexpectedMode) {
@@ -837,12 +837,12 @@ const onDevicePinHandler = async (...[device, type, callback]: DeviceEvents['pin
 const onDeviceButtonHandler = (...[device, request]: [...DeviceEvents['button']]) => {
   postMessage(createDeviceMessage(DEVICE.BUTTON, { ...request, device: device.toMessageObject() }));
 
-  if (request.code === 'ButtonRequest_PinEntry') {
-    Log.log('request Confirm Input PIN');
+  if (request.code === 'ButtonRequest_PinEntry' || request.code === 'ButtonRequest_AttachPin') {
+    Log.log('request Confirm Input PIN or Attach PIN');
     postMessage(
       createUiMessage(UI_REQUEST.REQUEST_PIN, {
         device: device.toMessageObject() as KnownDevice,
-        type: 'ButtonRequest_PinEntry',
+        type: request.code,
       })
     );
   } else {
@@ -855,27 +855,31 @@ const onDeviceFeaturesHandler = (...[_, features]: [...DeviceEvents['features']]
   postMessage(createDeviceMessage(DEVICE.FEATURES, { ...features }));
 };
 
-const onDevicePassphraseHandler = async (...[device, callback]: DeviceEvents['passphrase']) => {
+const onDevicePassphraseHandler = async (
+  ...[device, requestPayload, callback]: DeviceEvents['passphrase']
+) => {
   Log.debug('onDevicePassphraseHandler');
   const uiPromise = createUiPromise(UI_RESPONSE.RECEIVE_PASSPHRASE, device);
   postMessage(
     createUiMessage(UI_REQUEST.REQUEST_PASSPHRASE, {
       device: device.toMessageObject() as KnownDevice,
       passphraseState: device.passphraseState,
+      existsAttachPinUser: requestPayload.existsAttachPinUser,
     })
   );
   // wait for passphrase
   const uiResp = await uiPromise.promise;
-  const { value, passphraseOnDevice, save } = uiResp.payload;
+  const { value, passphraseOnDevice, save, attachPinOnDevice } = uiResp.payload;
   // send as PassphrasePromptResponse
   callback({
     passphrase: value.normalize('NFKD'),
     passphraseOnDevice,
+    attachPinOnDevice,
     cache: save,
   });
 };
 
-const onEmptyPassphraseHandler = (...[_, callback]: DeviceEvents['passphrase']) => {
+const onEmptyPassphraseHandler = (...[_, , callback]: DeviceEvents['passphrase']) => {
   Log.debug('onEmptyPassphraseHandler');
   // send as PassphrasePromptResponse
   callback({ passphrase: '' });

package/src/data/messages/messages.json

@@ -3021,7 +3021,8 @@
             "ButtonRequest_Success": 17,
             "ButtonRequest_Warning": 18,
             "ButtonRequest_PassphraseEntry": 19,
-            "ButtonRequest_PinEntry": 20
+            "ButtonRequest_PinEntry": 20,
+            "ButtonRequest_AttachPin": 8000
           }
         }
       }
@@ -3071,6 +3072,10 @@
           "options": {
             "deprecated": true
           }
+        },
+        "exists_attach_pin_user": {
+          "type": "bool",
+          "id": 8000
         }
       }
     },
@@ -3090,6 +3095,10 @@
         "on_device": {
           "type": "bool",
           "id": 3
+        },
+        "on_device_attach_pin": {
+          "type": "bool",
+          "id": 8000
         }
       }
     },
@@ -3146,38 +3155,6 @@
     "BixinPinInputOnDevice": {
       "fields": {}
     },
-    "GetPassphraseState": {
-      "fields": {
-        "btc_test": {
-          "type": "string",
-          "id": 1
-        },
-        "only_main_pin": {
-          "type": "bool",
-          "id": 2
-        },
-        "session_id": {
-          "type": "bytes",
-          "id": 3
-        }
-      }
-    },
-    "PassphraseState": {
-      "fields": {
-        "btc_test": {
-          "type": "string",
-          "id": 1
-        },
-        "session_id": {
-          "type": "bytes",
-          "id": 2
-        },
-        "attach_to_pin_user": {
-          "type": "bool",
-          "id": 3
-        }
-      }
-    },
     "ConfluxGetAddress": {
       "fields": {
         "address_n": {
@@ -6086,7 +6063,7 @@
         },
         "btc_test": {
           "type": "string",
-          "id": 4
+          "id": 8000
         }
       }
     },
@@ -6465,10 +6442,6 @@
         "onekey_se04_state": {
           "type": "OneKeySEState",
           "id": 624
-        },
-        "attach_to_pin_user": {
-          "type": "bool",
-          "id": 625
         }
       },
       "nested": {
@@ -7573,6 +7546,38 @@
         }
       }
     },
+    "GetPassphraseState": {
+      "fields": {
+        "passphrase_state": {
+          "type": "string",
+          "id": 1
+        },
+        "_only_main_pin": {
+          "type": "bool",
+          "id": 2
+        },
+        "allow_create_attach_pin": {
+          "type": "bool",
+          "id": 3
+        }
+      }
+    },
+    "PassphraseState": {
+      "fields": {
+        "passphrase_state": {
+          "type": "string",
+          "id": 1
+        },
+        "session_id": {
+          "type": "bytes",
+          "id": 2
+        },
+        "unlocked_attach_pin": {
+          "type": "bool",
+          "id": 3
+        }
+      }
+    },
     "MoneroTransactionSourceEntry": {
       "fields": {
         "outputs": {

package/src/device/Device.ts

@@ -33,7 +33,13 @@ import {
   type Features,
   type UnavailableCapabilities,
 } from '../types';
-import { DEVICE, DeviceButtonRequestPayload, DeviceFeaturesPayload, UI_REQUEST } from '../events';
+import {
+  DEVICE,
+  DeviceButtonRequestPayload,
+  DeviceFeaturesPayload,
+  PassphraseRequestPayload,
+  UI_REQUEST,
+} from '../events';
 import { PROTO } from '../constants';
 import { DataManager } from '../data-manager';
 import TransportManager from '../data-manager/TransportManager';
@@ -61,7 +67,11 @@ export interface DeviceEvents {
   [DEVICE.PASSPHRASE_ON_DEVICE]: [Device, ((response: any) => void)?];
   [DEVICE.BUTTON]: [Device, DeviceButtonRequestPayload];
   [DEVICE.FEATURES]: [Device, DeviceFeaturesPayload];
-  [DEVICE.PASSPHRASE]: [Device, (response: PassphrasePromptResponse, error?: Error) => void];
+  [DEVICE.PASSPHRASE]: [
+    Device,
+    PassphraseRequestPayload,
+    (response: PassphrasePromptResponse, error?: Error) => void
+  ];
   [DEVICE.SELECT_DEVICE_IN_BOOTLOADER_FOR_WEB_DEVICE]: [
     Device,
     (err: any, deviceId: string) => void
@@ -398,7 +408,7 @@ export class Device extends EventEmitter {
     if (options?.deriveCardano) {
       payload.derive_cardano = true;
     }
-    payload.btc_test = options?.passphraseState;
+    payload.passphrase_state = options?.passphraseState;
 
     // Log.debug('initialize payload:', payload);
     console.log('=====>>>>>> initialize device begin: ', payload, {
@@ -689,8 +699,8 @@ export class Device extends EventEmitter {
       if (this.isBootloader() && !allow.includes(UI_REQUEST.BOOTLOADER)) {
         return UI_REQUEST.BOOTLOADER;
       }
-      if (!this.isInitialized() && !allow.includes(UI_REQUEST.INITIALIZE)) {
-        return UI_REQUEST.INITIALIZE;
+      if (!this.isInitialized() && !allow.includes(UI_REQUEST.NOT_INITIALIZE)) {
+        return UI_REQUEST.NOT_INITIALIZE;
       }
       if (this.isSeedless() && !allow.includes(UI_REQUEST.SEEDLESS)) {
         return UI_REQUEST.SEEDLESS;
@@ -722,13 +732,17 @@ export class Device extends EventEmitter {
 
   async checkPassphraseStateSafety(passphraseState?: string, useEmptyPassphraseState?: boolean) {
     if (!this.features) return false;
-    const { passphraseState: newPassphraseState } = await getPassphraseStateWithRefreshDeviceInfo(
-      this,
-      {
+    const { passphraseState: newPassphraseState, unlockedAttachPin } =
+      await getPassphraseStateWithRefreshDeviceInfo(this, {
         expectPassphraseState: passphraseState,
         onlyMainPin: useEmptyPassphraseState,
-      }
-    );
+      });
+
+    // Main wallet and unlock Attach Pin, throw safe error
+    if (unlockedAttachPin && useEmptyPassphraseState) {
+      this.clearInternalState();
+      return Promise.reject(ERRORS.TypedError(HardwareErrorCode.DeviceCheckUnlockTypeError));
+    }
 
     // When exists passphraseState, check passphraseState
     if (passphraseState && passphraseState !== newPassphraseState) {

package/src/device/DeviceCommands.ts

@@ -4,12 +4,13 @@ import TransportManager from '../data-manager/TransportManager';
 import DataManager from '../data-manager/DataManager';
 import { patchFeatures, getLogger, LoggerNames, getDeviceType } from '../utils';
 import type { Device } from './Device';
-import { DEVICE } from '../events';
+import { DEVICE, type PassphraseRequestPayload } from '../events';
 import { DeviceModelToTypes } from '../types';
 
 export type PassphrasePromptResponse = {
   passphrase?: string;
   passphraseOnDevice?: boolean;
+  attachPinOnDevice?: boolean;
   cache?: boolean;
 };
 
@@ -438,8 +439,17 @@ export class DeviceCommands {
     }
 
     if (res.type === 'PassphraseRequest') {
-      return this._promptPassphrase().then(response => {
-        const { passphrase, passphraseOnDevice } = response;
+      const existsAttachPinUser = res.message.exists_attach_pin_user;
+      return this._promptPassphrase({
+        existsAttachPinUser,
+      }).then(response => {
+        const { passphrase, passphraseOnDevice, attachPinOnDevice } = response;
+
+        // Attach PIN on device
+        if (attachPinOnDevice && existsAttachPinUser) {
+          return this._commonCall('PassphraseAck', { on_device_attach_pin: true });
+        }
+
         return !passphraseOnDevice
           ? this._commonCall('PassphraseAck', { passphrase })
           : this._commonCall('PassphraseAck', { on_device: true });
@@ -501,7 +511,7 @@ export class DeviceCommands {
     });
   }
 
-  _promptPassphrase() {
+  _promptPassphrase(options: PassphraseRequestPayload) {
     return new Promise<PassphrasePromptResponse>((resolve, reject) => {
       const cancelAndReject = (_error?: Error) =>
         cancelDeviceInPrompt(this.device, false)
@@ -527,6 +537,7 @@ export class DeviceCommands {
         this.device.emit(
           DEVICE.PASSPHRASE,
           this.device,
+          options,
           (response: PassphrasePromptResponse, error?: Error) => {
             this.device.clearCancelableAction();
             if (error) {

package/src/events/device.ts

@@ -44,6 +44,10 @@ export interface DeviceButtonRequestPayload extends Omit<PROTO.ButtonRequest, 'c
   code?: PROTO.ButtonRequest['code'] | 'ButtonRequest_FirmwareUpdate';
 }
 
+export type PassphraseRequestPayload = {
+  existsAttachPinUser?: boolean;
+};
+
 export interface DeviceButtonRequest {
   type: typeof DEVICE.BUTTON;
   payload: DeviceButtonRequestPayload & { device: Device | null };

package/src/events/ui-request.ts

@@ -34,7 +34,7 @@ export const UI_REQUEST = {
   BOOTLOADER: 'ui-device_bootloader_mode',
   NOT_IN_BOOTLOADER: 'ui-device_not_in_bootloader_mode',
   REQUIRE_MODE: 'ui-device_require_mode',
-  INITIALIZE: 'ui-device_not_initialized',
+  NOT_INITIALIZE: 'ui-device_not_initialized',
   SEEDLESS: 'ui-device_seedless',
   FIRMWARE_OLD: 'ui-device_firmware_old',
   FIRMWARE_NOT_SUPPORTED: 'ui-device_firmware_unsupported',
@@ -66,7 +66,7 @@ export type UiRequestDeviceAction = {
   type: typeof UI_REQUEST.REQUEST_PIN;
   payload: {
     device: Device;
-    type?: PROTO.PinMatrixRequestType | 'ButtonRequest_PinEntry';
+    type?: PROTO.PinMatrixRequestType | 'ButtonRequest_PinEntry' | 'ButtonRequest_AttachPin';
   };
 };
 
@@ -80,6 +80,7 @@ export interface UiRequestPassphrase {
   payload: {
     device: Device;
     passphraseState?: string;
+    existsAttachPinUser?: boolean;
   };
 }
 

package/src/events/ui-response.ts

@@ -18,6 +18,7 @@ export interface UiResponsePassphrase {
   payload: {
     value: string;
     passphraseOnDevice?: boolean;
+    attachPinOnDevice?: boolean;
     save?: boolean;
   };
 }