feat: integrating signature decoding api

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

@@ -966,7 +966,7 @@ describe('SignatureController', () => {
           controller.state.signatureRequests[ID_MOCK].decodingLoading,
         ).toBe(false);
         expect(
-          controller.state.signatureRequests[ID_MOCK].decodingData?.error.type,
+          controller.state.signatureRequests[ID_MOCK].decodingData?.error?.type,
         ).toStrictEqual(
           DecodingDataUtils.DECODING_API_ERRORS.DECODING_FAILED_WITH_ERROR,
         );

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

@@ -81,34 +81,38 @@ export type MessageParamsTyped = MessageParams & {
   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. */
-type DecodingDataStateChange = {
+export type DecodingDataStateChange = {
   assetType: string;
-  changeType:
-    | 'RECEIVE'
-    | 'TRANSFER'
-    | 'APPROVE'
-    | 'REVOKE_APPROVE'
-    | 'BIDDING'
-    | 'LISTING';
+  changeType: DecodingDataChangeType;
   address: string;
   amount: string;
   contractAddress: string;
+  tokenID?: string;
 };
 
 /** Array of the various state changes returned by decoding api. */
-type DecodingDataStateChanges = DecodingDataStateChange[];
+export type DecodingDataStateChanges = DecodingDataStateChange[];
 
 /** Error details for unfulfilled the decoding request. */
-type DecodingDataError = {
+export type DecodingDataError = {
   message: string;
   type: string;
 };
 
 /** Decoding data about typed sign V4 signature request. */
 export type DecodingData = {
   stateChanges: DecodingDataStateChanges | null;
-  error: DecodingDataError;
+  error?: DecodingDataError;
 };
 
 type SignatureRequestBase = {

packages/signature-controller/src/utils/decoding-api.test.ts

@@ -1,8 +1,9 @@
+import { EthMethod } from '../constants';
 import type { OriginalRequest } from '../types';
 import { decodeSignature } from './decoding-api';
 
 const PERMIT_REQUEST_MOCK = {
-  method: 'eth_signTypedData_v4',
+  method: EthMethod.SignTypedDataV4,
   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}}',

packages/signature-controller/src/utils/decoding-api.ts

@@ -1,5 +1,4 @@
-import { EthMethod } from '@metamask/keyring-api';
-
+import { EthMethod } from '../constants';
 import type { OriginalRequest } from '../types';
 import { convertNumericValuesToQuotedString } from './normalize';