Add verifyContract address normalization

package.json

@@ -34,6 +34,8 @@
     "@metamask/json-rpc-engine": "^8.0.2",
     "@metamask/rpc-errors": "^6.0.0",
     "@metamask/utils": "^8.1.0",
+    "@types/bn.js": "^5.1.5",
+    "bn.js": "^5.2.1",
     "klona": "^2.0.6",
     "pify": "^5.0.0",
     "safe-stable-stringify": "^2.4.3"

src/utils/normalize.test.ts

@@ -0,0 +1,124 @@
+import { normalizeTypedMessage } from './normalize';
+
+const MESSAGE_DATA_MOCK = {
+  types: {
+    Permit: [
+      {
+        name: 'owner',
+        type: 'address',
+      },
+      {
+        name: 'spender',
+        type: 'address',
+      },
+      {
+        name: 'value',
+        type: 'uint256',
+      },
+      {
+        name: 'nonce',
+        type: 'uint256',
+      },
+      {
+        name: 'deadline',
+        type: 'uint256',
+      },
+    ],
+    EIP712Domain: [
+      {
+        name: 'name',
+        type: 'string',
+      },
+      {
+        name: 'version',
+        type: 'string',
+      },
+      {
+        name: 'chainId',
+        type: 'uint256',
+      },
+      {
+        name: 'verifyingContract',
+        type: 'address',
+      },
+    ],
+  },
+  domain: {
+    name: 'Liquid staked Ether 2.0',
+    version: '2',
+    chainId: '0x1',
+    verifyingContract: '996101235222674412020337938588541139382869425796',
+  },
+  primaryType: 'Permit',
+  message: {
+    owner: '0x6d404afe1a6a07aa3cbcbf9fd027671df628ebfc',
+    spender: '0x63605E53D422C4F1ac0e01390AC59aAf84C44A51',
+    value:
+      '115792089237316195423570985008687907853269984665640564039457584007913129639935',
+    nonce: '0',
+    deadline: '4482689033',
+  },
+};
+
+describe('normalizeTypedMessage', () => {
+  function parseNormalizerResult(data: Record<string, unknown>) {
+    return JSON.parse(normalizeTypedMessage(JSON.stringify(data)));
+  }
+
+  it('should normalize verifyingContract address in domain', () => {
+    const normalizedData = parseNormalizerResult(MESSAGE_DATA_MOCK);
+    expect(normalizedData.domain.verifyingContract).toBe(
+      '0xae7ab96520de3a18e5e111b5eaab095312d7fe84',
+    );
+  });
+
+  it('should handle octal verifyingContract address by normalizing it', () => {
+    const expectedNormalizedOctalAddress = '0x53';
+    const messageDataWithOctalAddress = {
+      ...MESSAGE_DATA_MOCK,
+      domain: {
+        ...MESSAGE_DATA_MOCK.domain,
+        verifyingContract: '0o123',
+      },
+    };
+
+    const normalizedData = parseNormalizerResult(messageDataWithOctalAddress);
+
+    expect(normalizedData.domain.verifyingContract).toBe(
+      expectedNormalizedOctalAddress,
+    );
+  });
+
+  it('should not modify if verifyingContract is already hexadecimal', () => {
+    const expectedVerifyingContract =
+      '0xae7ab96520de3a18e5e111b5eaab095312d7fe84';
+    const messageDataWithHexAddress = {
+      ...MESSAGE_DATA_MOCK,
+      domain: {
+        ...MESSAGE_DATA_MOCK.domain,
+        verifyingContract: expectedVerifyingContract,
+      },
+    };
+
+    const normalizedData = parseNormalizerResult(messageDataWithHexAddress);
+
+    expect(normalizedData.domain.verifyingContract).toBe(
+      expectedVerifyingContract,
+    );
+  });
+
+  it('should not modify other parts of the message data', () => {
+    const normalizedData = parseNormalizerResult(MESSAGE_DATA_MOCK);
+    expect(normalizedData.message).toStrictEqual(MESSAGE_DATA_MOCK.message);
+    expect(normalizedData.types).toStrictEqual(MESSAGE_DATA_MOCK.types);
+    expect(normalizedData.primaryType).toStrictEqual(
+      MESSAGE_DATA_MOCK.primaryType,
+    );
+  });
+
+  it('should return data as is if not parsable', () => {
+    expect(normalizeTypedMessage('Not parsable data')).toBe(
+      'Not parsable data',
+    );
+  });
+});

src/utils/normalize.ts

@@ -0,0 +1,94 @@
+import { add0x, isValidHexAddress } from '@metamask/utils';
+import type { Hex } from '@metamask/utils';
+import BN from 'bn.js';
+
+type EIP712Domain = {
+  verifyingContract: string;
+};
+
+type SignTypedMessageDataV3V4 = {
+  types: Record<string, unknown>;
+  domain: EIP712Domain;
+  primaryType: string;
+  message: unknown;
+};
+
+/**
+ * Normalizes the messageData for the eth_signTypedData
+ *
+ * @param messageData - The messageData to normalize.
+ * @returns The normalized messageData.
+ */
+export function normalizeTypedMessage(messageData: string) {
+  let data;
+  try {
+    data = parseTypedMessage(
+      messageData,
+    ) as unknown as SignTypedMessageDataV3V4;
+  } catch (e) {
+    // Ignore normalization errors and pass the message as is
+    return messageData;
+  }
+
+  const { verifyingContract } = data.domain ?? {};
+
+  if (!verifyingContract) {
+    return messageData;
+  }
+
+  data.domain.verifyingContract = normalizeContractAddress(verifyingContract);
+
+  return JSON.stringify(data);
+}
+
+/**
+ * Parses the messageData to obtain the data object for EIP712 normalization
+ *
+ * @param data - The messageData to parse.
+ * @returns The data object for EIP712 normalization.
+ */
+function parseTypedMessage(data: string) {
+  if (typeof data !== 'string') {
+    return data;
+  }
+
+  try {
+    return JSON.parse(data);
+  } catch (e) {
+    throw new Error(`Invalid message data for normalization. data: ${data}`);
+  }
+}
+
+/**
+ * Normalizes the address to a hexadecimal format
+ *
+ * @param address - The address to normalize.
+ * @returns The normalized address.
+ */
+function normalizeContractAddress(address: string): Hex {
+  const addressHex = address as Hex;
+  if (isValidHexAddress(addressHex)) {
+    return addressHex;
+  }
+
+  // Check if the address is in octal format, convert to hexadecimal
+  if (addressHex.startsWith('0o')) {
+    // If octal, convert to hexadecimal
+    return octalToHex(addressHex as string);
+  }
+
+  // Check if the address is in decimal format, convert to hexadecimal
+  const parsedAddress = parseInt(addressHex, 10);
+  if (!isNaN(parsedAddress)) {
+    const hexString = new BN(addressHex.toString(), 10).toString(16);
+    return add0x(hexString);
+  }
+
+  // Returning the original address without normalization
+  return addressHex;
+}
+
+function octalToHex(octalAddress: string): Hex {
+  const decimalAddress = parseInt(octalAddress.slice(2), 8).toString(16);
+  return add0x(decimalAddress);
+}

src/wallet.test.ts

@@ -5,6 +5,10 @@ import pify from 'pify';
 import type { TransactionParams, MessageParams, TypedMessageV1Params } from '.';
 import { createWalletMiddleware } from '.';
 
+jest.mock('./utils/normalize', () => ({
+  normalizeTypedMessage: jest.fn().mockImplementation((data) => data),
+}));
+
 const testAddresses = [
   '0xbe93f9bacbcffc8ee6663f2647917ed7a20a57bb',
   '0x1234362ef32bcd26d3dd18ca749378213625ba0b',

src/wallet.ts

@@ -12,6 +12,7 @@
 } from '@metamask/utils';
 
 import type { Block } from './types';
+import { normalizeTypedMessage } from './utils/normalize';
 
 /*
 export type TransactionParams = {
@@ -276,7 +277,7 @@
     const params = req.params as [string, string];
 
     const address = await validateAndNormalizeKeyholder(params[0], req);
-    const message = params[1];
+    const message = normalizeTypedMessage(params[1]);
     const version = 'V3';
     const msgParams: TypedMessageParams = {
       data: message,
@@ -306,7 +307,12 @@
     const params = req.params as [string, string];
 
     const address = await validateAndNormalizeKeyholder(params[0], req);
-    const message = params[1];
+    let message = params[1];
+    try {
+      message = normalizeTypedMessage(message);
+    } catch (e) {
+      // Ignore normalization errors and pass the message as is
+    }
     const version = 'V4';
     const msgParams: TypedMessageParams = {
       data: message,
@@ -458,7 +464,7 @@
    *
    * @param address - The address to validate and normalize.
    * @param req - The request object.
    * @returns {string} - The normalized address, if valid. Otherwise, throws
    * an error
    */
   async function validateAndNormalizeKeyholder(

yarn.lock

@@ -958,12 +958,14 @@ __metadata:
     "@metamask/json-rpc-engine": ^8.0.2
     "@metamask/rpc-errors": ^6.0.0
     "@metamask/utils": ^8.1.0
+    "@types/bn.js": ^5.1.5
     "@types/btoa": ^1.2.3
     "@types/jest": ^27.4.1
     "@types/node": ^17.0.23
     "@types/pify": ^5.0.2
     "@typescript-eslint/eslint-plugin": ^5.42.1
     "@typescript-eslint/parser": ^5.42.1
+    bn.js: ^5.2.1
     eslint: ^8.44.0
     eslint-config-prettier: ^8.1.0
     eslint-plugin-import: ^2.27.5
@@ -1299,6 +1301,15 @@ __metadata:
   languageName: node
   linkType: hard
 
+"@types/bn.js@npm:^5.1.5":
+  version: 5.1.5
+  resolution: "@types/bn.js@npm:5.1.5"
+  dependencies:
+    "@types/node": "*"
+  checksum: c87b28c4af74545624f8a3dae5294b16aa190c222626e8d4b2e327b33b1a3f1eeb43e7a24d914a9774bca43d8cd6e1cb0325c1f4b3a244af6693a024e1d918e6
+  languageName: node
+  linkType: hard
+
 "@types/btoa@npm:^1.2.3":
   version: 1.2.3
   resolution: "@types/btoa@npm:1.2.3"
@@ -1982,6 +1993,13 @@ __metadata:
   languageName: node
   linkType: hard
 
+"bn.js@npm:^5.2.1":
+  version: 5.2.1
+  resolution: "bn.js@npm:5.2.1"
+  checksum: 3dd8c8d38055fedfa95c1d5fc3c99f8dd547b36287b37768db0abab3c239711f88ff58d18d155dd8ad902b0b0cee973747b7ae20ea12a09473272b0201c9edd3
+  languageName: node
+  linkType: hard
+
 "brace-expansion@npm:^1.1.7":
   version: 1.1.11
   resolution: "brace-expansion@npm:1.1.11"