chore: refactor and unify low return warning #29918

bfullam · 2025-01-27T10:52:49Z

Description

Users are experiencing issues with receiving significantly lower amounts of destination tokens than expected during swaps. This is due to excessive price differentials between the estimated swap amount and the actual return. Currently, the logic for triggering a low return warning differs between swaps and bridges, leading to inconsistencies and user confusion.

This PR brings swap to parity with bridge by adding a warning when a swap results in a return below 80% of the value of the source tokens.

Related issues

Fixes:

Manual testing steps

Go to swaps
Select tokens and input amount to force warning (eg. 0.01 ETH to ENA)
See warning

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-27T10:53:04Z

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-27T11:28:36Z

Builds ready [ca439f6]

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, 13
- ui: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13
- content-script: 0
- offscreen: 0

Page Load Metrics (1786 ± 110 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	295	2393	1628	445	214
		domContentLoaded	1422	2382	1760	230	111
		load	1429	2396	1786	230	110
		domInteractive	18	131	46	29	14
		backgroundConnect	8	92	32	25	12
		firstReactRender	16	73	37	23	11
		getState	5	40	11	8	4
		initialActions	0	1	0	0	0
		loadScripts	1013	1875	1294	208	100
		setupStore	6	84	19	23	11
		uiStartup	1624	2633	2030	253	121

Bundle size diffs [🚨 Warning! Bundle size has increased!]

background: 0 Bytes (0.00%)
ui: 42 Bytes (0.00%)
common: 20 Bytes (0.00%)

…ce value

…k fees

metamaskbot · 2025-01-27T17:29:13Z

Builds ready [6c2cc08]

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, 13
- ui: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13
- content-script: 0
- offscreen: 0

Page Load Metrics (1805 ± 76 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	1545	2150	1812	162	78
		domContentLoaded	1537	2136	1776	152	73
		load	1546	2153	1805	159	76
		domInteractive	23	99	44	20	10
		backgroundConnect	9	80	35	26	12
		firstReactRender	16	88	37	23	11
		getState	5	74	27	23	11
		initialActions	0	1	0	0	0
		loadScripts	1082	1570	1303	117	56
		setupStore	9	60	20	19	9
		uiStartup	1702	2467	2091	195	94

Bundle size diffs [🚨 Warning! Bundle size has increased!]

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

ghgoodreau · 2025-01-27T21:39:25Z

ui/pages/swaps/prepare-swap-page/review-quote.js

+          ),
+        )
+      : false;
+  setIsEstimatedReturnLow(isEstimatedReturnLow);


nit: maybe better to import this logic from a util file?

ghgoodreau

approved with nit

metamaskbot · 2025-01-28T13:15:06Z

Builds ready [bcdc0de]

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, 13
- ui: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13
- content-script: 0
- offscreen: 0

Page Load Metrics (1873 ± 125 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	304	2166	1581	551	265
		domContentLoaded	1510	2568	1847	259	125
		load	1520	2583	1873	260	125
		domInteractive	25	131	47	28	14
		backgroundConnect	9	78	34	22	11
		firstReactRender	15	96	44	27	13
		getState	5	94	22	23	11
		initialActions	0	1	0	0	0
		loadScripts	1058	1870	1347	207	100
		setupStore	9	60	25	21	10
		uiStartup	1756	2923	2203	338	162

Bundle size diffs [🚨 Warning! Bundle size has increased!]

background: 0 Bytes (0.00%)
ui: -1.34 KiB (-0.02%)
common: 3.04 KiB (0.03%)

metamaskbot · 2025-01-28T15:47:48Z

Builds ready [f77e3a4]

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, 13
- ui: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13
- content-script: 0
- offscreen: 0

Page Load Metrics (1993 ± 81 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	402	2270	1822	498	239
		domContentLoaded	1705	2256	1956	170	82
		load	1716	2279	1993	169	81
		domInteractive	27	107	46	23	11
		backgroundConnect	10	92	37	27	13
		firstReactRender	18	102	50	31	15
		getState	7	65	26	23	11
		initialActions	0	1	0	0	0
		loadScripts	1223	1737	1452	146	70
		setupStore	8	90	23	23	11
		uiStartup	2008	3014	2348	248	119

Bundle size diffs [🚨 Warning! Bundle size has increased!]

background: 0 Bytes (0.00%)
ui: -1.34 KiB (-0.02%)
common: 3.04 KiB (0.03%)

shared/constants/bridge.ts

metamaskbot · 2025-01-29T11:55:11Z

Builds ready [44c1587]

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, 13
- ui: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13
- content-script: 0
- offscreen: 0

Page Load Metrics (2011 ± 131 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	275	2467	1742	651	313
		domContentLoaded	1422	2417	1985	264	127
		load	1432	2464	2011	272	131
		domInteractive	24	108	45	18	9
		backgroundConnect	9	77	29	21	10
		firstReactRender	16	101	49	28	13
		getState	4	64	27	21	10
		initialActions	0	1	0	0	0
		loadScripts	1023	1772	1460	220	106
		setupStore	8	99	23	23	11
		uiStartup	1646	3287	2353	349	167

Bundle size diffs [🚨 Warning! Bundle size has increased!]

background: 0 Bytes (0.00%)
ui: -1.34 KiB (-0.02%)
common: 3.05 KiB (0.03%)

metamaskbot · 2025-01-29T12:51:14Z

Builds ready [981a5e3]

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, 13
- ui: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13
- content-script: 0
- offscreen: 0

Page Load Metrics (1641 ± 71 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	553	1860	1574	265	127
		domContentLoaded	1424	1990	1614	149	72
		load	1452	1996	1641	147	71
		domInteractive	25	101	43	23	11
		backgroundConnect	10	66	27	19	9
		firstReactRender	16	70	33	22	11
		getState	5	64	17	19	9
		initialActions	0	1	0	0	0
		loadScripts	1014	1458	1178	121	58
		setupStore	8	96	22	27	13
		uiStartup	1646	2493	1920	217	104

Bundle size diffs [🚨 Warning! Bundle size has increased!]

background: 0 Bytes (0.00%)
ui: -1.34 KiB (-0.02%)
common: 3.05 KiB (0.03%)

bfullam added 4 commits January 24, 2025 16:34

chore: update bridge "low return" threshold

77447b6

feat: add param to allow useTokenFiatAmount to return raw float

e54eec1

chore: return rawNetworkFees from getFeeForSmartTransaction

4397ee6

chore: request rawNetworkFees from updated functions

ca439f6

metamaskbot added the team-swaps label Jan 27, 2025

bfullam added 5 commits January 27, 2025 14:36

feat: show warning banner when swap returns less than 80% of the sour…

ca81003

…ce value

test: add test

26b4ae6

Merge branch 'main' into MMS-1851-refactor-and-unify-low-return-warning

7dfb992

chore: add check for defined destination token fiat amount and networ…

d4737b2

…k fees

chore: lint

6c2cc08

ghgoodreau reviewed Jan 27, 2025

View reviewed changes

ghgoodreau previously approved these changes Jan 27, 2025

View reviewed changes

chore: move isEstimatedReturnLow logic to util file

bcdc0de

bfullam dismissed ghgoodreau’s stale review via bcdc0de January 28, 2025 12:41

chore: lint

f77e3a4

micaelae reviewed Jan 28, 2025

View reviewed changes

shared/constants/bridge.ts Outdated Show resolved Hide resolved

chore: update max return difference

44c1587

test: update unit tests

981a5e3

bfullam marked this pull request as ready for review January 29, 2025 15:37

bfullam requested a review from a team as a code owner January 29, 2025 15:37

bfullam enabled auto-merge January 29, 2025 15:37

micaelae approved these changes Jan 29, 2025

View reviewed changes

ghgoodreau approved these changes Jan 30, 2025

View reviewed changes

bfullam added this pull request to the merge queue Jan 30, 2025

Merged via the queue into main with commit 5f76d25 Jan 30, 2025
72 checks passed

bfullam deleted the MMS-1851-refactor-and-unify-low-return-warning branch January 30, 2025 16:48

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

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: refactor and unify low return warning #29918

chore: refactor and unify low return warning #29918

bfullam commented Jan 27, 2025 •

edited

Loading

github-actions bot commented Jan 27, 2025

metamaskbot commented Jan 27, 2025

metamaskbot commented Jan 27, 2025

ghgoodreau Jan 27, 2025

ghgoodreau left a comment

metamaskbot commented Jan 28, 2025

metamaskbot commented Jan 28, 2025

metamaskbot commented Jan 29, 2025

metamaskbot commented Jan 29, 2025

chore: refactor and unify low return warning #29918

chore: refactor and unify low return warning #29918

Conversation

bfullam commented Jan 27, 2025 • edited Loading

Description

Related issues

Manual testing steps

Screenshots/Recordings

Before

After

Pre-merge author checklist

Pre-merge reviewer checklist

github-actions bot commented Jan 27, 2025

metamaskbot commented Jan 27, 2025

metamaskbot commented Jan 27, 2025

ghgoodreau Jan 27, 2025

Choose a reason for hiding this comment

ghgoodreau left a comment

Choose a reason for hiding this comment

metamaskbot commented Jan 28, 2025

metamaskbot commented Jan 28, 2025

metamaskbot commented Jan 29, 2025

metamaskbot commented Jan 29, 2025

bfullam commented Jan 27, 2025 •

edited

Loading