feat: implement personalSign method in wallet adapters

- Added `personalSign` method to `WalletAdapterFilsnap`, `WalletAdapterHd`, `WalletAdapterLedger`, and `WalletAdapterRaw` for signing messages with the new PERSONAL_MESSAGE signature type.
- Updated the `WalletAdapter` interface in `types.ts` to include `personalSign`, marking the old `sign` method as deprecated.
- Enhanced error handling in `personalSign` methods to ensure proper connection checks and error emissions.

This update improves the signing capabilities across wallet adapters, aligning with the latest FRC-102 standards and enhancing user experience for message signing.

Author: hugomrdias

packages/iso-filecoin-wallets/src/filsnap.js

@@ -239,6 +239,24 @@ export class WalletAdapterFilsnap extends TypedEventTarget {
     return r.result
   }
 
+  /**
+   * @type {WalletAdapter['personalSign']}
+   * @inheritdoc
+   */
+  async personalSign(data) {
+    if (!this.filsnap) {
+      throw new Error('Adapter is not connected')
+    }
+    const r = await this.filsnap.personalSign(data)
+    if (r.error) {
+      const err = new Error(r.error.message, { cause: r.error.data })
+      this.emit('error', err)
+      throw err
+    }
+
+    return r.result
+  }
+
   /**
    *
    * @param {MessageObj} message - Filecoin message to sign

packages/iso-filecoin-wallets/src/hd.js

@@ -1,7 +1,9 @@
+/** biome-ignore-all lint/suspicious/useAwait: sync version */
 import { pathFromNetwork } from 'iso-filecoin/utils'
 import {
   accountFromSeed,
   mnemonicToSeed,
+  personalSign,
   sign,
   signMessage,
 } from 'iso-filecoin/wallet'
@@ -102,7 +104,6 @@ export class WalletAdapterHd extends TypedEventTarget {
     return this.#support
   }
 
-  // biome-ignore lint/suspicious/useAwait: <explanation>
   async checkSupport() {
     this.#support = WalletSupport.Detected
   }
@@ -120,7 +121,6 @@ export class WalletAdapterHd extends TypedEventTarget {
   /**
    * @param {{ network?: Network }} [params]
    */
-  // biome-ignore lint/suspicious/useAwait: <explanation>
   async connect(params = {}) {
     if (!this.#seed) {
       throw new Error('No seed found')
@@ -149,7 +149,6 @@ export class WalletAdapterHd extends TypedEventTarget {
     }
   }
 
-  // biome-ignore lint/suspicious/useAwait: <explanation>
   async disconnect() {
     this.account = undefined
     this.emit('disconnect')
@@ -158,8 +157,6 @@ export class WalletAdapterHd extends TypedEventTarget {
   /**
    * @param {Network} network
    */
-
-  // biome-ignore lint/suspicious/useAwait: <explanation>
   async changeNetwork(network) {
     if (!this.connected || !this.account || !this.#seed) {
       throw new Error('Adapter is not connected')
@@ -187,7 +184,6 @@ export class WalletAdapterHd extends TypedEventTarget {
   /**
    * @param {number } index
    */
-  // biome-ignore lint/suspicious/useAwait: <explanation>
   async deriveAccount(index) {
     if (!this.connected || !this.account || !this.#seed) {
       throw new Error('Adapter is not connected')
@@ -208,7 +204,6 @@ export class WalletAdapterHd extends TypedEventTarget {
    *
    * @param {Uint8Array} data - Data to sign
    */
-  // biome-ignore lint/suspicious/useAwait: <explanation>
   async sign(data) {
     if (!this.account) {
       throw new Error('Client is not connected')
@@ -220,11 +215,25 @@ export class WalletAdapterHd extends TypedEventTarget {
     return sign(this.account.privateKey, this.signatureType, data)
   }
 
+  /**
+   * @type {WalletAdapter['personalSign']}
+   * @inheritdoc
+   */
+  async personalSign(data) {
+    if (!this.account) {
+      throw new Error('Client is not connected')
+    }
+
+    if (!this.account.privateKey) {
+      throw new Error('Private key not found')
+    }
+    return personalSign(this.account.privateKey, this.signatureType, data)
+  }
+
   /**
    *
    * @param {MessageObj} message - Filecoin message to sign
    */
-  // biome-ignore lint/suspicious/useAwait: <explanation>
   async signMessage(message) {
     if (!this.account) {
       throw new Error('Client is not connected')

packages/iso-filecoin-wallets/src/ledger.js

@@ -120,6 +120,11 @@ export class WalletAdapterLedger extends TypedEventTarget {
 
       transport = await this.#transport.create()
       this.#app = new LedgerFilecoin(transport)
+      const version = await this.#app.getVersion()
+      const vNum = version.split('.').join('')
+      if (Number(vNum) < 221) {
+        throw new Error('Ledger app version is too old')
+      }
       this.account = await this.#createAccount(this.#app)
 
       this.emit('connect', { account: this.account, network: this.network })
@@ -222,6 +227,33 @@ export class WalletAdapterLedger extends TypedEventTarget {
     }
   }
 
+  /**
+   * @type {WalletAdapter['personalSign']}
+   * @inheritdoc
+   */
+  async personalSign(data) {
+    try {
+      if (!this.account || !this.#app) {
+        throw new Error('Adapter is not connected')
+      }
+
+      if (!this.account.path) {
+        throw new Error('Derivation path not found')
+      }
+
+      const raw = await this.#app.personalSign(this.account.path, data)
+      return new Signature({
+        type: this.signatureType,
+        data: raw,
+      })
+    } catch (error) {
+      const err = /** @type {Error} */ (error)
+
+      this.emit('error', err)
+      throw error
+    }
+  }
+
   /**
    * @param {MessageObj} message
    */

packages/iso-filecoin-wallets/src/local.js

@@ -1,4 +1,11 @@
-import { create, getPublicKey, sign, signMessage } from 'iso-filecoin/wallet'
+/** biome-ignore-all lint/suspicious/useAwait: sync version */
+import {
+  create,
+  getPublicKey,
+  personalSign,
+  sign,
+  signMessage,
+} from 'iso-filecoin/wallet'
 import { TypedEventTarget } from 'iso-web/event-target'
 import { nanoid } from 'nanoid'
 import { WalletSupport } from './common.js'
@@ -89,7 +96,6 @@ export class WalletAdapterRaw extends TypedEventTarget {
    * @param {{ network?: Network }} [params]
    */
 
-  // biome-ignore lint/suspicious/useAwait: <explanation>
   async connect(params = {}) {
     if (this.#isConnecting || this.connected) {
       if (!this.account) throw new Error('No account found')
@@ -125,12 +131,10 @@ export class WalletAdapterRaw extends TypedEventTarget {
     return this.#support
   }
 
-  // biome-ignore lint/suspicious/useAwait: <explanation>
   async checkSupport() {
     this.#support = WalletSupport.Detected
   }
 
-  // biome-ignore lint/suspicious/useAwait: <explanation>
   async disconnect() {
     this.account = undefined
     this.emit('disconnect')
@@ -140,7 +144,6 @@ export class WalletAdapterRaw extends TypedEventTarget {
    * @param {Network} network
    */
 
-  // biome-ignore lint/suspicious/useAwait: <explanation>
   async changeNetwork(network) {
     if (!this.connected || !this.account) {
       throw new Error('Adapter is not connected')
@@ -163,30 +166,37 @@ export class WalletAdapterRaw extends TypedEventTarget {
    * @param {number } _index
    * @returns {Promise<IAccount>}
    */
-  // biome-ignore lint/suspicious/useAwait: <explanation>
   async deriveAccount(_index) {
     const err = new Error('Local wallet is not a HD wallet')
     this.emit('error', err)
     throw err
   }
 
   /**
-   *
-   * @param {Uint8Array} data - Data to sign
+   * @type {WalletAdapter['sign']}
    */
-  // biome-ignore lint/suspicious/useAwait: <explanation>
   async sign(data) {
     if (!this.account) {
       throw new Error('Client is not connected')
     }
     return sign(this.privateKey, this.signatureType, data)
   }
 
+  /**
+   * @type {WalletAdapter['personalSign']}
+   * @inheritdoc
+   */
+  async personalSign(data) {
+    if (!this.account) {
+      throw new Error('Client is not connected')
+    }
+    return personalSign(this.privateKey, this.signatureType, data)
+  }
+
   /**
    *
    * @param {MessageObj} message - Filecoin message to sign
    */
-  // biome-ignore lint/suspicious/useAwait: <explanation>
   async signMessage(message) {
     if (!this.connected) {
       throw new Error('Client is not connected')

packages/iso-filecoin-wallets/src/types.ts

@@ -148,10 +148,19 @@ export interface WalletAdapter extends TypedEventTarget<WalletEvents> {
   /**
    * Sign raw bytes
    *
+   * @deprecated Use {@link personalSign} instead
    * @param data - raw bytes to sign
    */
   sign(data: Uint8Array): Promise<Signature>
 
+  /**
+   * Sign FRC-102 message
+   *
+   * @see https://github.com/filecoin-project/FIPs/blob/master/FRCs/frc-0102.md
+   * @param data - raw bytes to sign
+   */
+  personalSign: (data: Uint8Array) => Promise<Signature>
+
   /**
    * Sign filecoin message
    *

packages/iso-filecoin-wallets/test/adapters/base.js

@@ -232,19 +232,23 @@ export function connectorTests({
     })
 
     it('should sign', async function () {
-      this.timeout(10_000)
+      this.timeout(15_000)
       await wallet.connect({ network })
       assert.strictEqual(wallet.connected, true)
       if (sim) {
-        await sim.toggleExpertMode()
+        await sim.toggleBlindSigning()
       }
 
       const sigPromise = wallet.sign(utf8.decode('hello world'))
       if (sim) {
         await sim.waitUntilScreenIsNot(sim.getMainMenuSnapshot())
         await sim.compareSnapshotsAndApprove(
           './test',
-          `adapter_sign_raw-${walletName}`
+          `adapter_sign_raw-${walletName}`,
+          true,
+          0,
+          1500,
+          true
         )
       }
       const sig = await sigPromise
@@ -253,7 +257,7 @@ export function connectorTests({
         fixtures[wallet.id][`${wallet.network}`].sig
       )
       if (sim) {
-        await sim.toggleExpertMode()
+        await sim.toggleBlindSigning()
       }
     })
     it('should sign message', async function () {

packages/iso-filecoin-wallets/test/setup.js

@@ -18,16 +18,14 @@ export const SEED =
 export const PATH = "m/44'/461'/0/0/0"
 export const PATH_TESTNET = "m/44'/1'/0/0/0"
 
-const APP_PATH_S = path.join(__dirname, 'output/app_s.elf')
-const APP_PATH_X = path.join(__dirname, 'output/app_x.elf')
-const APP_PATH_SP = path.join(__dirname, 'output/app_s2.elf')
-const APP_PATH_ST = path.join(__dirname, 'output/app_stax.elf')
-const APP_PATH_FL = path.join(__dirname, 'output/app_flex.elf')
+const APP_PATH_X = path.join(__dirname, '../../../ledger-app/app_x.elf')
+const APP_PATH_SP = path.join(__dirname, '../../../ledger-app/app_s2.elf')
+const APP_PATH_ST = path.join(__dirname, '../../../ledger-app/app_stax.elf')
+const APP_PATH_FL = path.join(__dirname, '../../../ledger-app/app_flex.elf')
 /**
  * @type {import('@zondax/zemu').IDeviceModel[]}
  */
 export const models = [
-  { name: 'nanos', prefix: 'S', path: APP_PATH_S },
   { name: 'nanox', prefix: 'X', path: APP_PATH_X },
   { name: 'nanosp', prefix: 'SP', path: APP_PATH_SP },
   { name: 'stax', prefix: 'ST', path: APP_PATH_ST },