fix: Missing "Unlimited" as value for the DAI permit #29597

pedronfigueiredo · 2025-01-09T10:39:40Z

Description

Introduces a new logical path for displaying "Unlimited" in the permit simulation, for when the allowed property in the signature message is set and the permit is for the token DAI. This is as is specified in ERC-2612's "Backwards Compatibility" section:

There are already a couple of permit functions in token contracts implemented in contracts in the wild, most notably the one introduced in the dai.sol.

Its implementation differs slightly from the presentation here in that:

instead of taking a value argument, it takes a bool allowed, setting approval to 0 or uint(-1).

This PR also fixes a bug that prevents boolean values from being displayed in the key value display in the message section of signatures.

Related issues

Fixes: #28964

Manual testing steps

Open the browser console and execute the following code:

async function connectMetaMask() {
  try {
    const accounts = await window.ethereum.request({
      method: 'eth_requestAccounts',
    });
    console.log('Connected account:', accounts[0]);
    return accounts[0];
  } catch (error) {
    console.error('User rejected the request:', error);
    throw error;
  }
}
async function signPermit() {
  try {
    const fromAddress = await connectMetaMask();
    const msgParams = {
      types: {
        EIP712Domain: [
          { name: 'name', type: 'string' },
          { name: 'version', type: 'string' },
          { name: 'chainId', type: 'uint256' },
          { name: 'verifyingContract', type: 'address' },
        ],
        Permit: [
          { name: 'holder', type: 'address' },
          { name: 'spender', type: 'address' },
          { name: 'nonce', type: 'uint256' },
          { name: 'expiry', type: 'uint256' },
          { name: 'allowed', type: 'bool' },
        ],
      },
      domain: {
        name: 'Dai Stablecoin',
        version: '1',
        verifyingContract: '0x6B175474E89094C44Da98b954EedeAC495271d0F',
        chainId: '0x1',
      },
      primaryType: 'Permit',
      message: {
        holder: '0xD2C44F28eC4C7eF686f587FADdb204da3aEFa827',
        spender: '0x68b3465833fb72A70ecDF485E0e4C7bD8665Fc45',
        allowed: true,
        nonce: 0,
        expiry: 1660916504,
      },
    };

    const signature = await window.ethereum.request({
      method: 'eth_signTypedData_v4',
      params: [fromAddress, JSON.stringify(msgParams)],
    });
    console.log('Signature:', signature);
    return signature;
  } catch (error) {
    console.error('Error signing permit:', error);
  }
}
signPermit();

Change "allowed": true to "allowed": false in the aforementioned code and execute it to see the revocation screen.

Screenshots/Recordings

Before

After

Pre-merge author checklist

I've followed MetaMask Contributor Docs and MetaMask Extension Coding Standards.
I've completed the PR template to the best of my ability
I’ve included tests if applicable
I’ve documented my code using JSDoc format if applicable
I’ve applied the right labels on the PR (see labeling guidelines). 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.

github-actions · 2025-01-09T10:39:53Z

CLA Signature Action: All authors have signed the CLA. You may need to manually re-run the blocking PR check if it doesn't pass in a few minutes.

metamaskbot · 2025-01-09T11:14:02Z

Builds ready [715eb4f]

builds: chrome, firefox
builds (flask): chrome, firefox
builds (MMI): chrome
builds (test): chrome, firefox
builds (test-flask): chrome, firefox
build viz: Build System
mv3: Bundle Size Stats
mv2: E2e Actions Stats
storybook: Storybook
typescript migration: Dashboard
all artifacts
bundle viz:
- background: 0, 1, 2, 3, 4, 5, 6, 7
- common: 0, 1, 10, 11, 12, 2, 3, 4, 5, 6, 7, 8, 9
- content-script: 0
- offscreen: 0
- ui: 0, 1, 10, 11, 12, 13, 2, 3, 4, 5, 6, 7, 8, 9

Page Load Metrics (1654 ± 47 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	1441	1864	1655	98	47
		domContentLoaded	1392	1797	1629	101	49
		load	1441	1858	1654	97	47
		domInteractive	22	132	47	32	15
		backgroundConnect	11	83	28	20	10
		firstReactRender	15	95	40	26	13
		getState	5	12	8	2	1
		initialActions	0	1	0	0	0
		loadScripts	1037	1409	1228	92	44
		setupStore	6	84	20	23	11
		uiStartup	1627	2652	1915	212	102

metamaskbot · 2025-01-09T12:00:24Z

Builds ready [6c106c2]

builds: chrome, firefox
builds (flask): chrome, firefox
builds (MMI): chrome
builds (test): chrome, firefox
builds (test-flask): chrome, firefox
build viz: Build System
mv3: Bundle Size Stats
mv2: E2e Actions Stats
storybook: Storybook
typescript migration: Dashboard
all artifacts
bundle viz:
- background: 0, 1, 2, 3, 4, 5, 6, 7
- common: 0, 1, 10, 11, 12, 2, 3, 4, 5, 6, 7, 8, 9
- content-script: 0
- offscreen: 0
- ui: 0, 1, 10, 11, 12, 13, 2, 3, 4, 5, 6, 7, 8, 9

Page Load Metrics (1646 ± 84 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	208	2112	1507	450	216
		domContentLoaded	1489	2076	1627	166	80
		load	1500	2132	1646	174	84
		domInteractive	24	176	56	45	21
		backgroundConnect	7	66	23	19	9
		firstReactRender	15	97	37	30	14
		getState	5	76	15	19	9
		initialActions	0	1	0	0	0
		loadScripts	1050	1618	1207	145	70
		setupStore	6	90	28	29	14
		uiStartup	1652	2493	1994	241	116

metamaskbot · 2025-01-09T14:09:56Z

Builds ready [c2b7ffb]

builds: chrome, firefox
builds (flask): chrome, firefox
builds (MMI): chrome
builds (test): chrome, firefox
builds (test-flask): chrome, firefox
build viz: Build System
mv3: Bundle Size Stats
mv2: E2e Actions Stats
storybook: Storybook
typescript migration: Dashboard
all artifacts
bundle viz:
- background: 0, 1, 2, 3, 4, 5, 6, 7
- common: 0, 1, 10, 11, 12, 2, 3, 4, 5, 6, 7, 8, 9
- content-script: 0
- offscreen: 0
- ui: 0, 1, 10, 11, 12, 13, 2, 3, 4, 5, 6, 7, 8, 9

Page Load Metrics (1760 ± 77 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	1544	2271	1756	157	75
		domContentLoaded	1528	2259	1714	157	75
		load	1543	2274	1760	161	77
		domInteractive	25	86	47	22	10
		backgroundConnect	9	96	37	28	13
		firstReactRender	17	102	45	30	15
		getState	5	94	23	26	12
		initialActions	0	1	0	0	0
		loadScripts	1150	1794	1281	134	64
		setupStore	6	90	22	26	13
		uiStartup	1823	2765	2114	251	121

metamaskbot · 2025-01-09T18:37:04Z

Builds ready [fb248dc]

builds: chrome, firefox
builds (flask): chrome, firefox
builds (MMI): chrome
builds (test): chrome, firefox
builds (test-flask): chrome, firefox
build viz: Build System
mv3: Bundle Size Stats
mv2: E2e Actions Stats
storybook: Storybook
typescript migration: Dashboard
all artifacts
bundle viz:
- background: 0, 1, 2, 3, 4, 5, 6, 7
- common: 0, 1, 10, 11, 12, 2, 3, 4, 5, 6, 7, 8, 9
- content-script: 0
- offscreen: 0
- ui: 0, 1, 10, 11, 12, 13, 2, 3, 4, 5, 6, 7, 8, 9

Page Load Metrics (1693 ± 36 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	325	1826	1623	306	147
		domContentLoaded	1558	1796	1665	69	33
		load	1572	1827	1693	75	36
		domInteractive	25	94	38	18	9
		backgroundConnect	9	57	26	16	8
		firstReactRender	16	96	39	28	13
		getState	5	71	20	20	9
		initialActions	0	1	0	0	0
		loadScripts	1154	1370	1249	63	30
		setupStore	7	67	17	18	9
		uiStartup	1780	2404	1971	147	71

metamaskbot · 2025-01-10T14:22:44Z

Builds ready [0d72d36]

builds: chrome, firefox
builds (flask): chrome, firefox
builds (MMI): chrome
builds (test): chrome, firefox
builds (test-flask): chrome, firefox
build viz: Build System
mv3: Bundle Size Stats
mv2: E2e Actions Stats
storybook: Storybook
typescript migration: Dashboard
all artifacts
bundle viz:
- background: 0, 1, 2, 3, 4, 5, 6, 7
- common: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12
- ui: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13
- content-script: 0
- offscreen: 0

Page Load Metrics (1620 ± 61 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	435	1841	1556	288	138
		domContentLoaded	1396	1766	1590	123	59
		load	1404	1828	1620	127	61
		domInteractive	24	225	46	45	22
		backgroundConnect	6	64	28	21	10
		firstReactRender	15	91	37	25	12
		getState	5	68	11	13	6
		initialActions	0	1	0	0	0
		loadScripts	991	1327	1163	98	47
		setupStore	6	51	11	12	6
		uiStartup	1597	2149	1858	168	81

Bundle size diffs

background: 0 Bytes (0.00%)
ui: 1.31 KiB (0.02%)
common: 0 Bytes (0.00%)

metamaskbot · 2025-01-10T15:16:47Z

Builds ready [9a68eba]

builds: chrome, firefox
builds (flask): chrome, firefox
builds (MMI): chrome
builds (test): chrome, firefox
builds (test-flask): chrome, firefox
build viz: Build System
mv3: Bundle Size Stats
mv2: E2e Actions Stats
storybook: Storybook
typescript migration: Dashboard
all artifacts
bundle viz:
- background: 0, 1, 2, 3, 4, 5, 6, 7
- common: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12
- ui: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13
- content-script: 0
- offscreen: 0

Page Load Metrics (1660 ± 61 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	1464	1929	1659	128	61
		domContentLoaded	1457	1879	1643	120	57
		load	1465	1928	1660	127	61
		domInteractive	25	166	47	34	16
		backgroundConnect	7	65	16	15	7
		firstReactRender	15	88	46	29	14
		getState	5	55	12	13	6
		initialActions	0	1	0	0	0
		loadScripts	1069	1429	1215	99	47
		setupStore	5	90	21	25	12
		uiStartup	1648	2649	1957	212	102

Bundle size diffs

background: 0 Bytes (0.00%)
ui: 1.31 KiB (0.02%)
common: 0 Bytes (0.00%)

matthewwalsh0 · 2025-01-16T01:07:59Z

...nts/confirm/info/typed-sign/typed-sign-v4-simulation/permit-simulation/permit-simulation.tsx

+  } else if (message.allowed === false) {
+    // revoke permit
+    descriptionKey = 'revokeSimulationDetailsDesc';
+  } else {


Minor, rather than setting the fallback with an else, could we assign it by default when we define descriptionKey?

matthewwalsh0 · 2025-01-16T01:09:25Z

.../components/confirm/info/typed-sign/typed-sign-v4-simulation/value-display/value-display.tsx

@@ -31,6 +31,9 @@ import {
 import { TOKEN_VALUE_UNLIMITED_THRESHOLD } from '../../../shared/constants';
 import { getAmountColors } from '../../../utils';

+export const DAI_CONTRACT_ADDRESS =


Minor, is this better in ui/pages/confirmations/components/confirm/info/shared/constants.ts?

matthewwalsh0 · 2025-01-16T01:12:51Z

ui/pages/confirmations/components/confirm/title/title.tsx

@@ -136,6 +152,20 @@ const getDescription = (
        if (tokenStandard === TokenStandard.ERC721) {
          return t('confirmTitleDescApproveTransaction');
        }
+
+        const msgData = (confirmation as SignatureRequestType)?.msgParams?.data;


Should we add a utility such as isRevokeDAIPermit to avoid the duplication?

metamaskbot · 2025-01-16T11:05:25Z

Builds ready [489e1a8]

builds: chrome, firefox
builds (flask): chrome, firefox
builds (MMI): chrome
builds (test): chrome, firefox
builds (test-flask): chrome, firefox
build viz: Build System
mv3: Bundle Size Stats
mv2: E2e Actions Stats
storybook: Storybook
typescript migration: Dashboard
all artifacts
bundle viz:
- background: 0, 1, 2, 3, 4, 5, 6, 7
- common: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12
- ui: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13
- content-script: 0
- offscreen: 0

Page Load Metrics (1757 ± 53 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	340	2078	1696	335	161
		domContentLoaded	1533	1936	1726	103	49
		load	1566	1992	1757	110	53
		domInteractive	26	142	46	29	14
		backgroundConnect	6	84	33	27	13
		firstReactRender	16	104	52	33	16
		getState	5	64	24	21	10
		initialActions	0	1	0	0	0
		loadScripts	1103	1483	1271	88	42
		setupStore	7	87	22	25	12
		uiStartup	1895	2882	2157	239	115

Bundle size diffs

background: 0 Bytes (0.00%)
ui: 1.15 KiB (0.01%)
common: 0 Bytes (0.00%)

Addressed feedback

pedronfigueiredo added the team-confirmations Push issues to confirmations team label Jan 9, 2025

pedronfigueiredo self-assigned this Jan 9, 2025

pedronfigueiredo requested a review from a team as a code owner January 9, 2025 10:39

pedronfigueiredo requested review from a team as code owners January 9, 2025 11:26

pedronfigueiredo force-pushed the pnf/28964 branch from 6c106c2 to c2b7ffb Compare January 9, 2025 13:35

pedronfigueiredo force-pushed the pnf/28964 branch from c2b7ffb to fb248dc Compare January 9, 2025 18:01

pedronfigueiredo force-pushed the pnf/28964 branch from fb248dc to 5c23171 Compare January 10, 2025 10:44

pedronfigueiredo force-pushed the pnf/28964 branch from 0d72d36 to 9a68eba Compare January 10, 2025 14:39

OGPoyraz previously approved these changes Jan 14, 2025

View reviewed changes

matthewwalsh0 previously requested changes Jan 16, 2025

View reviewed changes

pedronfigueiredo added 11 commits January 16, 2025 10:28

fix: Missaing Unlimited as value for the DAI permit

43f6a4e

fix: Missaing Unlimited as value for the DAI permit

8aa12fb

fix: Missing Unlimited as value for the DAI permit

7d26ce6

fix: Missing Unlimited as value for the DAI permit

70d19ea

wip

0d06c27

wip

9ce6827

wip

9892c8a

wip

8221cd4

wip

5877d42

wip

b4fdfbd

Address PR feedback

489e1a8

pedronfigueiredo dismissed OGPoyraz’s stale review via 489e1a8 January 16, 2025 10:28

pedronfigueiredo force-pushed the pnf/28964 branch from 9a68eba to 489e1a8 Compare January 16, 2025 10:28

OGPoyraz approved these changes Jan 17, 2025

View reviewed changes

vinistevam approved these changes Jan 17, 2025

View reviewed changes

pedronfigueiredo added this pull request to the merge queue Jan 17, 2025

Merged via the queue into main with commit e659f4f Jan 17, 2025
72 checks passed

pedronfigueiredo deleted the pnf/28964 branch January 17, 2025 12:44

github-actions bot locked and limited conversation to collaborators Jan 17, 2025

metamaskbot added the release-12.12.0 Issue or pull request that will be included in release 12.12.0 label Jan 17, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: Missing "Unlimited" as value for the DAI permit #29597

fix: Missing "Unlimited" as value for the DAI permit #29597

pedronfigueiredo commented Jan 9, 2025 •

edited by github-actions bot

Loading

github-actions bot commented Jan 9, 2025

metamaskbot commented Jan 9, 2025

metamaskbot commented Jan 9, 2025

metamaskbot commented Jan 9, 2025

metamaskbot commented Jan 9, 2025

metamaskbot commented Jan 10, 2025

metamaskbot commented Jan 10, 2025

matthewwalsh0 Jan 16, 2025

matthewwalsh0 Jan 16, 2025

matthewwalsh0 Jan 16, 2025

metamaskbot commented Jan 16, 2025

fix: Missing "Unlimited" as value for the DAI permit #29597

fix: Missing "Unlimited" as value for the DAI permit #29597

Conversation

pedronfigueiredo commented Jan 9, 2025 • edited by github-actions bot Loading

Description

Related issues

Manual testing steps

Screenshots/Recordings

Before

After

Pre-merge author checklist

Pre-merge reviewer checklist

github-actions bot commented Jan 9, 2025

metamaskbot commented Jan 9, 2025

metamaskbot commented Jan 9, 2025

metamaskbot commented Jan 9, 2025

metamaskbot commented Jan 9, 2025

metamaskbot commented Jan 10, 2025

metamaskbot commented Jan 10, 2025

matthewwalsh0 Jan 16, 2025

Choose a reason for hiding this comment

matthewwalsh0 Jan 16, 2025

Choose a reason for hiding this comment

matthewwalsh0 Jan 16, 2025

Choose a reason for hiding this comment

metamaskbot commented Jan 16, 2025

pedronfigueiredo commented Jan 9, 2025 •

edited by github-actions bot

Loading