feat: integrating signature decoding api

packages/signature-controller/package.json

@@ -58,6 +58,7 @@
   "devDependencies": {
     "@metamask/approval-controller": "^7.1.1",
     "@metamask/auto-changelog": "^3.4.4",
+    "@metamask/keyring-api": "^8.1.3",
     "@metamask/keyring-controller": "^17.3.1",
     "@metamask/logging-controller": "^6.0.1",
     "@metamask/network-controller": "^22.0.1",

packages/signature-controller/src/SignatureController.test.ts

@@ -18,6 +18,7 @@ import type {
   SignatureRequest,
 } from './types';
 import { SignatureRequestStatus, SignatureRequestType } from './types';
+import * as DecodingDataUtils from './utils/decoding-api';
 import {
   normalizePersonalMessageParams,
   normalizeTypedMessageParams,
@@ -52,6 +53,7 @@ const PARAMS_MOCK = {
 
 const REQUEST_MOCK = {
   networkClientId: NETWORK_CLIENT_ID_MOCK,
+  params: [],
 };
 
 const SIGNATURE_REQUEST_MOCK: SignatureRequest = {
@@ -64,6 +66,27 @@ const SIGNATURE_REQUEST_MOCK: SignatureRequest = {
   type: SignatureRequestType.PersonalSign,
 };
 
+const PERMIT_PARAMS_MOCK = {
+  data: '{"types":{"EIP712Domain":[{"name":"name","type":"string"},{"name":"version","type":"string"},{"name":"chainId","type":"uint256"},{"name":"verifyingContract","type":"address"}],"Permit":[{"name":"owner","type":"address"},{"name":"spender","type":"address"},{"name":"value","type":"uint256"},{"name":"nonce","type":"uint256"},{"name":"deadline","type":"uint256"}]},"primaryType":"Permit","domain":{"name":"MyToken","version":"1","verifyingContract":"0xCcCCccccCCCCcCCCCCCcCcCccCcCCCcCcccccccC","chainId":1},"message":{"owner":"0x975e73efb9ff52e23bac7f7e043a1ecd06d05477","spender":"0x5B38Da6a701c568545dCfcB03FcB875f56beddC4","value":3000,"nonce":0,"deadline":50000000000}}',
+  from: '0x975e73efb9ff52e23bac7f7e043a1ecd06d05477',
+  version: 'V4',
+  signatureMethod: 'eth_signTypedData_v4',
+};
+
+const PERMIT_REQUEST_MOCK = {
+  method: 'eth_signTypedData_v4',
+  params: [
+    '0x975e73efb9ff52e23bac7f7e043a1ecd06d05477',
+    '{"types":{"EIP712Domain":[{"name":"name","type":"string"},{"name":"version","type":"string"},{"name":"chainId","type":"uint256"},{"name":"verifyingContract","type":"address"}],"Permit":[{"name":"owner","type":"address"},{"name":"spender","type":"address"},{"name":"value","type":"uint256"},{"name":"nonce","type":"uint256"},{"name":"deadline","type":"uint256"}]},"primaryType":"Permit","domain":{"name":"MyToken","version":"1","verifyingContract":"0xCcCCccccCCCCcCCCCCCcCcCccCcCCCcCcccccccC","chainId":1},"message":{"owner":"0x975e73efb9ff52e23bac7f7e043a1ecd06d05477","spender":"0x5B38Da6a701c568545dCfcB03FcB875f56beddC4","value":3000,"nonce":0,"deadline":50000000000}}',
+  ],
+  jsonrpc: '2.0',
+  id: 1680528590,
+  origin: 'https://metamask.github.io',
+  networkClientId: 'mainnet',
+  tabId: 1048807181,
+  traceContext: null,
+};
+
 /**
  * Create a mock messenger instance.
  * @returns The mock messenger instance plus individual mock functions for each action.
@@ -890,6 +913,90 @@ describe('SignatureController', () => {
         ).version,
       ).toBe(SignTypedDataVersion.V3);
     });
+
+    describe('decodeSignature', () => {
+      it('invoke decodeSignature to get decoding data', async () => {
+        const MOCK_STATE_CHANGES = {
+          stateChanges: [
+            {
+              assetType: 'ERC20',
+              changeType: 'APPROVE',
+              address: '0x3fc91a3afd70395cd496c647d5a6cc9d4b2b7fad',
+              amount: '1461501637330902918203684832716283019655932542975',
+              contractAddress: '0x6b175474e89094c44da98b954eedeac495271d0f',
+            },
+          ],
+        };
+        const { controller } = createController();
+
+        jest
+          .spyOn(DecodingDataUtils, 'decodeSignature')
+          .mockResolvedValue(MOCK_STATE_CHANGES);
+
+        await controller.newUnsignedTypedMessage(
+          PERMIT_PARAMS_MOCK,
+          PERMIT_REQUEST_MOCK,
+          SignTypedDataVersion.V4,
+          { parseJsonData: false },
+        );
+
+        expect(
+          controller.state.signatureRequests[ID_MOCK].decodingLoading,
+        ).toBe(false);
+        expect(
+          controller.state.signatureRequests[ID_MOCK].decodingData,
+        ).toStrictEqual(MOCK_STATE_CHANGES);
+      });
+
+      it('correctly set decoding data if decodeSignature fails', async () => {
+        const { controller } = createController();
+
+        jest
+          .spyOn(DecodingDataUtils, 'decodeSignature')
+          .mockRejectedValue(new Error('some error'));
+
+        await controller.newUnsignedTypedMessage(
+          PERMIT_PARAMS_MOCK,
+          PERMIT_REQUEST_MOCK,
+          SignTypedDataVersion.V4,
+          { parseJsonData: false },
+        );
+
+        expect(
+          controller.state.signatureRequests[ID_MOCK].decodingLoading,
+        ).toBe(false);
+        expect(
+          controller.state.signatureRequests[ID_MOCK].decodingData?.error?.type,
+        ).toStrictEqual(
+          DecodingDataUtils.DECODING_API_ERRORS.DECODING_FAILED_WITH_ERROR,
+        );
+      });
+
+      it('set decodingLoading to true while api request is in progress', async () => {
+        const { controller } = createController();
+
+        jest
+          .spyOn(DecodingDataUtils, 'decodeSignature')
+          .mockImplementation(() => {
+            return new Promise((resolve) => {
+              setTimeout(() => {
+                resolve({});
+              }, 300);
+            });
+          });
+
+        await controller.newUnsignedTypedMessage(
+          PERMIT_PARAMS_MOCK,
+          PERMIT_REQUEST_MOCK,
+          SignTypedDataVersion.V4,
+          { parseJsonData: false },
+        );
+
+        expect(
+          controller.state.signatureRequests[ID_MOCK].decodingLoading,
+        ).toBe(true);
+      });
+    });
   });
 
   describe('setDeferredSignSuccess', () => {
@@ -920,6 +1027,8 @@ describe('SignatureController', () => {
       const { controller } = createController();
       let resolved = false;
 
+      jest.spyOn(DecodingDataUtils, 'decodeSignature').mockResolvedValue({});
+
       const signaturePromise = controller
         .newUnsignedPersonalMessage(
           {
@@ -998,6 +1107,8 @@ describe('SignatureController', () => {
       const { controller } = createController();
       let rejectedError;
 
+      jest.spyOn(DecodingDataUtils, 'decodeSignature').mockResolvedValue({});
+
       controller
         .newUnsignedPersonalMessage(
           {

packages/signature-controller/src/SignatureController.ts

@@ -44,6 +44,7 @@ import type {
   LegacyStateMessage,
   StateSIWEMessage,
 } from './types';
+import { DECODING_API_ERRORS, decodeSignature } from './utils/decoding-api';
 import {
   normalizePersonalMessageParams,
   normalizeTypedMessageParams,
@@ -155,6 +156,11 @@ export type SignatureControllerOptions = {
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
   ) => Promise<any>;
 
+  /**
+   * URL of API to retrieve decoding data for typed requests.
+   */
+  decodingApiUrl?: string;
+
   /**
    * Initial state of the controller.
    */
@@ -176,6 +182,8 @@ export class SignatureController extends BaseController<
 > {
   hub: EventEmitter;
 
+  #decodingApiUrl?: string;
+
   #trace: TraceCallback;
 
   /**
@@ -185,8 +193,14 @@ export class SignatureController extends BaseController<
    * @param options.messenger - The restricted controller messenger for the sign controller.
    * @param options.state - Initial state to set on this controller.
    * @param options.trace - Callback to generate trace information.
+   * @param options.decodingApiUrl - Api used to get decoded data for permits.
    */
-  constructor({ messenger, state, trace }: SignatureControllerOptions) {
+  constructor({
+    decodingApiUrl,
+    messenger,
+    state,
+    trace,
+  }: SignatureControllerOptions) {
     super({
       name: controllerName,
       metadata: stateMetadata,
@@ -199,6 +213,7 @@ export class SignatureController extends BaseController<
 
     this.hub = new EventEmitter();
     this.#trace = trace ?? (((_request, fn) => fn?.()) as TraceCallback);
+    this.#decodingApiUrl = decodingApiUrl;
   }
 
   /**
@@ -462,6 +477,7 @@ export class SignatureController extends BaseController<
     let approveOrSignError: unknown;
 
     const finalMetadataPromise = this.#waitForFinished(metadata.id);
+    this.#decodePermitSignatureRequest(metadata.id, request, chainId);
 
     try {
       resultCallbacks = await this.#processApproval({
@@ -880,4 +896,33 @@ export class SignatureController extends BaseController<
 
     return networkClient.configuration.chainId;
   }
+
+  #decodePermitSignatureRequest(
+    signatureRequestId: string,
+    request: OriginalRequest,
+    chainId: string,
+  ) {
+    this.#updateMetadata(signatureRequestId, (draftMetadata) => {
+      draftMetadata.decodingLoading = true;
+    });
+    decodeSignature(request, chainId, this.#decodingApiUrl)
+      .then((decodingData) =>
+        this.#updateMetadata(signatureRequestId, (draftMetadata) => {
+          draftMetadata.decodingData = decodingData;
+          draftMetadata.decodingLoading = false;
+        }),
+      )
+      .catch((error) =>
+        this.#updateMetadata(signatureRequestId, (draftMetadata) => {
+          draftMetadata.decodingData = {
+            stateChanges: null,
+            error: {
+              message: (error as unknown as Error).message,
+              type: DECODING_API_ERRORS.DECODING_FAILED_WITH_ERROR,
+            },
+          };
+          draftMetadata.decodingLoading = false;
+        }),
+      );
+  }
 }

packages/signature-controller/src/constants.ts

@@ -0,0 +1,8 @@
+export const EthMethod = {
+  PersonalSign: 'personal_sign',
+  Sign: 'eth_sign',
+  SignTransaction: 'eth_signTransaction',
+  SignTypedDataV1: 'eth_signTypedData_v1',
+  SignTypedDataV3: 'eth_signTypedData_v3',
+  SignTypedDataV4: 'eth_signTypedData_v4',
+};

packages/signature-controller/src/types.ts

@@ -7,12 +7,18 @@ export type OriginalRequest = {
   /** Unique ID to identify the client request. */
   id?: number;
 
+  /** Method of signature request */
+  method?: string;
+
   /** ID of the network client associated with the request. */
   networkClientId?: string;
 
   /** Source of the client request. */
   origin?: string;
 
+  /** Parameters in signature request */
+  params: string[];
+
   /** Response following a security scan of the request. */
   securityAlertResponse?: Record<string, Json>;
 };
@@ -71,15 +77,54 @@ export type MessageParamsTyped = MessageParams & {
         primaryType: string;
         message: Json;
       };
-
   /** Version of the signTypedData request. */
   version?: string;
 };
 
+/** Different decoding data state change types */
+export type DecodingDataChangeType =
+  | 'RECEIVE'
+  | 'TRANSFER'
+  | 'APPROVE'
+  | 'REVOKE_APPROVE'
+  | 'BIDDING'
+  | 'LISTING';
+
+/** Information about a single state change returned by decoding api. */
+export type DecodingDataStateChange = {
+  assetType: string;
+  changeType: DecodingDataChangeType;
+  address: string;
+  amount: string;
+  contractAddress: string;
+  tokenID?: string;
+};
+
+/** Array of the various state changes returned by decoding api. */
+export type DecodingDataStateChanges = DecodingDataStateChange[];
+
+/** Error details for unfulfilled the decoding request. */
+export type DecodingDataError = {
+  message: string;
+  type: string;
+};
+
+/** Decoding data about typed sign V4 signature request. */
+export type DecodingData = {
+  stateChanges: DecodingDataStateChanges | null;
+  error?: DecodingDataError;
+};
+
 type SignatureRequestBase = {
   /** ID of the associated chain. */
   chainId: Hex;
 
+  /** Response from message decoding api. */
+  decodingData?: DecodingData;
+
+  /** Whether decoding is in progress. */
+  decodingLoading?: boolean;
+
   /** Error message that occurred during the signing. */
   error?: string;