fix: Keyring.signTypedData accepts types for V1

Author: mikesposito

packages/keyring-eth-ledger-bridge/src/ledger-keyring.ts

@@ -484,12 +484,16 @@ export class LedgerKeyring implements Keyring {
     return hdPath;
   }
 
-  async signTypedData<T extends MessageTypes>(
+  async signTypedData<
+    Version extends SignTypedDataVersion.V4,
+    Types extends MessageTypes,
+    Options extends { version?: Version },
+  >(
     withAccount: Hex,
-    data: TypedMessage<T>,
-    options: { version?: string } = {},
+    data: TypedMessage<Types>,
+    options: Options,
   ): Promise<string> {
-    const isV4 = options.version === 'V4';
+    const isV4 = options?.version === 'V4';
     if (!isV4) {
       throw new Error(
         'Ledger: Only version 4 of typed data signing is supported',

packages/keyring-eth-simple/src/simple-keyring.ts

@@ -10,6 +10,9 @@ import {
   toBuffer,
 } from '@ethereumjs/util';
 import {
+  type TypedDataV1,
+  type MessageTypes,
+  type TypedMessage,
   concatSig,
   decrypt,
   EIP7702Authorization,
@@ -147,17 +150,23 @@ export default class SimpleKeyring implements Keyring {
     return decrypt({ privateKey, encryptedData });
   }
 
-  // personal_signTypedData, signs data along with the schema
-  async signTypedData(
+  async signTypedData<
+    Version extends SignTypedDataVersion,
+    Types extends MessageTypes,
+    Options extends { version: Version } & KeyringOpt,
+  >(
     address: Hex,
-    typedData: any,
-    opts: KeyringOpt = { version: SignTypedDataVersion.V1 },
+    typedData: Version extends SignTypedDataVersion.V1
+      ? TypedDataV1
+      : TypedMessage<Types>,
+    opts?: Options,
   ): Promise<string> {
+    const options = opts ?? { version: SignTypedDataVersion.V1 };
     // Treat invalid versions as "V1"
     let version = SignTypedDataVersion.V1;
 
-    if (opts.version && isSignTypedDataVersion(opts.version)) {
-      version = SignTypedDataVersion[opts.version];
+    if (options.version && isSignTypedDataVersion(options.version)) {
+      version = SignTypedDataVersion[options.version];
     }
 
     const privateKey = this.#getPrivateKeyFor(address, opts);

packages/keyring-eth-trezor/src/trezor-keyring.ts

@@ -453,10 +453,14 @@ export class TrezorKeyring implements Keyring {
   }
 
   // EIP-712 Sign Typed Data
-  async signTypedData<T extends MessageTypes>(
+  async signTypedData<
+    Version extends SignTypedDataVersion.V3 | SignTypedDataVersion.V4,
+    Types extends MessageTypes,
+    Options extends { version?: Version },
+  >(
     address: Hex,
-    data: TypedMessage<T>,
-    { version }: { version: SignTypedDataVersion },
+    data: TypedMessage<Types>,
+    { version }: Options,
   ): Promise<string> {
     const dataWithHashes = transformTypedData(
       data,

packages/keyring-utils/src/keyring.ts

@@ -229,7 +229,7 @@ export type Keyring = {
    */
   signTypedData?(
     address: Hex,
-    typedData: Record<string, unknown>,
+    typedData: unknown[] | Record<string, unknown>,
     options?: Record<string, unknown>,
   ): Promise<string>;