Implemented hardware wallet claim message signing

Author: ikem-legend

app/src/ipc.js

@@ -8,6 +8,7 @@ const { contextBridge, ipcRenderer } = require('electron');
 const REQUEST = 'REQUEST';
 const RESPONSE = 'RESPONSE';
 const GET_SIGNED_MESSAGE = 'GET_SIGNED_MESSAGE';
+const GET_SIGNED_RAW_MESSAGE = 'GET_SIGNED_RAW_MESSAGE';
 const GET_SIGNED_TRANSACTION = 'GET_SIGNED_TRANSACTION';
 const GET_PUB_KEY = 'GET_PUB_KEY';
 const GET_MULTIPLE_ADDRESSES = 'GET_MULTIPLE_ADDRESSES';
@@ -61,6 +62,9 @@ contextBridge.exposeInMainWorld('ipc', {
   [`${GET_SIGNED_MESSAGE}.${REQUEST}`]: (title) => {
     ipcRenderer.send(`${GET_SIGNED_MESSAGE}.${REQUEST}`, title);
   },
+  [`${GET_SIGNED_RAW_MESSAGE}.${REQUEST}`]: (title) => {
+    ipcRenderer.send(`${GET_SIGNED_RAW_MESSAGE}.${REQUEST}`, title);
+  },
   [`${GET_CONNECTED_DEVICES}.${RESPONSE}`]: (func) => {
     ipcRenderer.once(`${GET_CONNECTED_DEVICES}.${RESPONSE}`, (event, ...args) => {
       func(event, ...args);
@@ -91,6 +95,11 @@ contextBridge.exposeInMainWorld('ipc', {
       func(event, ...args);
     });
   },
+  [`${GET_SIGNED_RAW_MESSAGE}.${RESPONSE}`]: (func) => {
+    ipcRenderer.once(`${GET_SIGNED_RAW_MESSAGE}.${RESPONSE}`, (event, ...args) => {
+      func(event, ...args);
+    });
+  },
   [LEDGER_HW_HID_EVENT]: (func) => {
     ipcRenderer.on(LEDGER_HW_HID_EVENT, (event, ...args) => {
       func(event, ...args);

libs/hardwareWallet/ledger/constants.js

@@ -3,6 +3,7 @@ export const REQUEST = 'REQUEST';
 export const LEDGER_HW_HID_EVENT = 'LEDGER_HW_HID_EVENT';
 export const LEDGER_HW_IPC_CHANNELS = {
   GET_SIGNED_MESSAGE: 'GET_SIGNED_MESSAGE',
+  GET_SIGNED_RAW_MESSAGE: 'GET_SIGNED_RAW_MESSAGE',
   GET_SIGNED_TRANSACTION: 'GET_SIGNED_TRANSACTION',
   GET_PUB_KEY: 'GET_PUB_KEY',
   GET_MULTIPLE_ADDRESSES: 'GET_MULTIPLE_ADDRESSES',

libs/hardwareWallet/ledger/ledgerLiskAppIPCChannel/clientLedgerHWCommunication/index.js

@@ -8,6 +8,7 @@ const {
   GET_PUB_KEY,
   GET_MULTIPLE_ADDRESSES,
   GET_SIGNED_MESSAGE,
+  GET_SIGNED_RAW_MESSAGE,
 } = LEDGER_HW_IPC_CHANNELS;
 
 function sleep(ms) {
@@ -34,6 +35,16 @@ export const getSignedMessage = async (devicePath, accountIndex, unsignedMessage
   return signedMessage;
 };
 
+export const getSignedRawMessage = async (devicePath, accountIndex, unsignedMessage) => {
+  const signedRawMessage = await executeIPCCommand(GET_SIGNED_RAW_MESSAGE, {
+    devicePath,
+    accountIndex,
+    unsignedMessage,
+  });
+
+  return signedRawMessage;
+};
+
 export const getPubKey = async (devicePath, accountIndex, showOnDevice) => {
   const pubKey = await executeIPCCommand(GET_PUB_KEY, {
     devicePath,

libs/hardwareWallet/ledger/ledgerLiskAppIPCChannel/index.js

@@ -15,6 +15,7 @@ import {
 const {
   GET_CONNECTED_DEVICES,
   GET_SIGNED_MESSAGE,
+  GET_SIGNED_RAW_MESSAGE,
   GET_PUB_KEY,
   GET_MULTIPLE_ADDRESSES,
   GET_SIGNED_TRANSACTION,
@@ -36,6 +37,12 @@ export const ledgerLiskAppIPCChannel = () => {
     return result;
   });
 
+  createIpcMainChannel(GET_SIGNED_RAW_MESSAGE, async (data) => {
+    const id = `${GET_SIGNED_RAW_MESSAGE}-${Date.now()}`;
+    const result = await getSequentiallyQueuedData(myq, id, () => getSignedMessage(data));
+    return result;
+  });
+
   createIpcMainChannel(GET_PUB_KEY, async (data) => {
     const id = `${GET_PUB_KEY}-${Date.now()}`;
     const result = await getSequentiallyQueuedData(myq, id, () => getPubKey(data));

src/modules/message/store/action.js

@@ -1,6 +1,6 @@
 import { to } from 'await-to-js';
 import { cryptography } from '@liskhq/lisk-client';
-import { signMessageUsingHW } from '@wallet/utils/signMessage';
+import { signMessageUsingHW, signClaimMessageUsingHW } from '@wallet/utils/signMessage';
 import {
   signMessageWithPrivateKey,
   signClaimMessageWithPrivateKey,
@@ -46,6 +46,28 @@ export const signMessage =
 export const signClaimMessage =
   ({ nextStep, portalMessage, privateKey, currentAccount }) =>
   async () => {
+    if (currentAccount?.hw) {
+      const [error, signature] = await to(
+        signClaimMessageUsingHW({
+          account: currentAccount,
+          message: getUnsignedNonProtocolMessage(portalMessage),
+        })
+      );
+
+      if (error) {
+        return nextStep({ error, portalMessage });
+      }
+
+      const portalSignature = {
+        data: {
+          pubKey: currentAccount.metadata.pubkey,
+          r: `0x${signature.substring(0, 64)}`,
+          s: `0x${signature.substring(64)}`,
+        },
+      };
+
+      return nextStep({ signature: portalSignature, portalMessage });
+    }
     const signature = signClaimMessageWithPrivateKey({
       message: portalMessage,
       privateKey,

src/modules/wallet/utils/signMessage.js

@@ -1,5 +1,8 @@
 import i18next from 'i18next';
-import { getSignedMessage } from '@libs/hardwareWallet/ledger/ledgerLiskAppIPCChannel/clientLedgerHWCommunication';
+import {
+  getSignedMessage,
+  getSignedRawMessage,
+} from '@libs/hardwareWallet/ledger/ledgerLiskAppIPCChannel/clientLedgerHWCommunication';
 import { IPCLedgerError } from '@libs/hardwareWallet/ledger/ledgerLiskAppIPCChannel/clientLedgerHWCommunication/utils';
 import { txStatusTypes } from '@transaction/configuration/txStatus';
 
@@ -30,3 +33,31 @@ export const signMessageUsingHW = async ({ account, message }) => {
     throw new IPCLedgerError(error);
   }
 };
+
+export const signClaimMessageUsingHW = async ({ account, message }) => {
+  try {
+    const signedMessage = await getSignedRawMessage(
+      account.hw.path,
+      account.metadata.accountIndex,
+      message
+    );
+    let signature = signedMessage?.signature;
+
+    if (!signature) {
+      throw new IPCLedgerError({
+        message: i18next.t('The message signature has been canceled on your {{model}}', {
+          model: account.hw.product,
+        }),
+        hwTxStatusType: txStatusTypes.hwRejected,
+      });
+    }
+
+    if (signature instanceof Uint8Array) {
+      signature = Buffer.from(signature);
+    }
+
+    return signature.toString('hex');
+  } catch (error) {
+    throw new IPCLedgerError(error);
+  }
+};