feat: update signature controller and integrate decoding api (#28397)

## **Description** Integrate decoding api. ## **Related issues** Fixes: MetaMask/MetaMask-planning#3623 ## **Manual testing steps** 1. Enable decoding api locally using env variables 2. Submit a permit request 3. Check that decoding api results are present in confirmation object ## **Screenshots/Recordings** NA ## **Pre-merge author checklist** - [X] I've followed [MetaMask Contributor Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask Extension Coding Standards](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/CODING_GUIDELINES.md). - [X] I've completed the PR template to the best of my ability - [X] I’ve included tests if applicable - [X] I’ve documented my code using [JSDoc](https://jsdoc.app/) format if applicable - [X] I’ve applied the right labels on the PR (see [labeling guidelines](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/LABELING_GUIDELINES.md)). Not required for external contributors. ## **Pre-merge reviewer checklist** - [ ] I've manually tested the PR (e.g. pull and build branch, run the app, test code being changed). - [ ] I confirm that this PR addresses all acceptance criteria described in the ticket it closes and includes the necessary testing evidence such as recordings and or screenshots. --------- Co-authored-by: MetaMask Bot <[email protected]> Co-authored-by: Matthew Walsh <[email protected]>
MetaMask · Nov 13, 2024 · e9ffd0a · e9ffd0a
1 parent 8a87315
commit e9ffd0a
Show file tree

Hide file tree

Showing 9 changed files with 29 additions and 8 deletions.
diff --git a/app/scripts/controllers/mmi-controller.ts b/app/scripts/controllers/mmi-controller.ts
@@ -24,9 +24,9 @@ import { NetworkState } from '@metamask/network-controller';
 import {
   MessageParamsPersonal,
   MessageParamsTyped,
+  OriginalRequest,
   SignatureController,
 } from '@metamask/signature-controller';
-import { OriginalRequest } from '@metamask/message-manager';
 import { InternalAccount } from '@metamask/keyring-api';
 import { toHex } from '@metamask/controller-utils';
 import { toChecksumHexAddress } from '../../../shared/modules/hexstring-utils';

diff --git a/app/scripts/metamask-controller.js b/app/scripts/metamask-controller.js
@@ -2001,6 +2001,11 @@ export default class MetamaskController extends EventEmitter {
         ],
       }),
       trace,
+      decodingApiUrl: process.env.DECODING_API_URL,
+      isDecodeSignatureRequestEnabled: () =>
+        this.preferencesController.state.useExternalServices === true &&
+        this.preferencesController.state.useTransactionSimulations &&
+        process.env.ENABLE_SIGNATURE_DECODING === true,
     });
 
     this.signatureController.hub.on(

diff --git a/builds.yml b/builds.yml
@@ -235,6 +235,10 @@ env:
 
   # Used to enable confirmation redesigned pages
   - ENABLE_CONFIRMATION_REDESIGN: ''
+  # Used to enable signature decoding
+  - ENABLE_SIGNATURE_DECODING: ''
+  # URL of the decoding API used to provide additional data from signature requests
+  - DECODING_API_URL: null
   # Determines if feature flagged Settings Page - Developer Options should be used
   - ENABLE_SETTINGS_PAGE_DEV_OPTIONS: false
   # Used for debugging changes to the phishing warning page.

diff --git a/lavamoat/browserify/beta/policy.json b/lavamoat/browserify/beta/policy.json
@@ -2603,6 +2603,9 @@
       }
     },
     "@metamask/signature-controller": {
+      "globals": {
+        "fetch": true
+      },
       "packages": {
         "@metamask/base-controller": true,
         "@metamask/controller-utils": true,

diff --git a/lavamoat/browserify/flask/policy.json b/lavamoat/browserify/flask/policy.json
@@ -2603,6 +2603,9 @@
       }
     },
     "@metamask/signature-controller": {
+      "globals": {
+        "fetch": true
+      },
       "packages": {
         "@metamask/base-controller": true,
         "@metamask/controller-utils": true,

diff --git a/lavamoat/browserify/main/policy.json b/lavamoat/browserify/main/policy.json
@@ -2603,6 +2603,9 @@
       }
     },
     "@metamask/signature-controller": {
+      "globals": {
+        "fetch": true
+      },
       "packages": {
         "@metamask/base-controller": true,
         "@metamask/controller-utils": true,

diff --git a/lavamoat/browserify/mmi/policy.json b/lavamoat/browserify/mmi/policy.json
@@ -2695,6 +2695,9 @@
       }
     },
     "@metamask/signature-controller": {
+      "globals": {
+        "fetch": true
+      },
       "packages": {
         "@metamask/base-controller": true,
         "@metamask/controller-utils": true,

diff --git a/package.json b/package.json
@@ -345,7 +345,7 @@
     "@metamask/safe-event-emitter": "^3.1.1",
     "@metamask/scure-bip39": "^2.0.3",
     "@metamask/selected-network-controller": "^18.0.2",
-    "@metamask/signature-controller": "^21.0.0",
+    "@metamask/signature-controller": "^21.1.0",
     "@metamask/smart-transactions-controller": "^13.0.0",
     "@metamask/snaps-controllers": "^9.12.0",
     "@metamask/snaps-execution-environments": "^6.9.2",

diff --git a/yarn.lock b/yarn.lock
@@ -6312,12 +6312,12 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@metamask/signature-controller@npm:^21.0.0":
-  version: 21.0.0
-  resolution: "@metamask/signature-controller@npm:21.0.0"
+"@metamask/signature-controller@npm:^21.1.0":
+  version: 21.1.0
+  resolution: "@metamask/signature-controller@npm:21.1.0"
   dependencies:
     "@metamask/base-controller": "npm:^7.0.2"
-    "@metamask/controller-utils": "npm:^11.4.1"
+    "@metamask/controller-utils": "npm:^11.4.2"
     "@metamask/eth-sig-util": "npm:^8.0.0"
     "@metamask/utils": "npm:^10.0.0"
     jsonschema: "npm:^1.2.4"
@@ -6328,7 +6328,7 @@ __metadata:
     "@metamask/keyring-controller": ^17.0.0
     "@metamask/logging-controller": ^6.0.0
     "@metamask/network-controller": ^22.0.0
-  checksum: 10/4c1b1cbf909004099adb3f0d2b01c8fe640ae9a13a8e53ffbcf05c7a1a23384f6077b96b845c22c4edf3bceaaff2a705769d4623f37affac7e429ab0dae06912
+  checksum: 10/00d28234d6402632ecf000d7c908a134a0f49cbbdb165a7cfe72895bc91248de82947cd9628dbbe953ffb8b6054f84a0dc1ad824a1aff369d8f2189a78fd56a9
   languageName: node
   linkType: hard
 
@@ -26763,7 +26763,7 @@ __metadata:
     "@metamask/safe-event-emitter": "npm:^3.1.1"
     "@metamask/scure-bip39": "npm:^2.0.3"
     "@metamask/selected-network-controller": "npm:^18.0.2"
-    "@metamask/signature-controller": "npm:^21.0.0"
+    "@metamask/signature-controller": "npm:^21.1.0"
     "@metamask/smart-transactions-controller": "npm:^13.0.0"
     "@metamask/snaps-controllers": "npm:^9.12.0"
     "@metamask/snaps-execution-environments": "npm:^6.9.2"