feat: enable STX by default with migration and notification #28854

httpJunkie · 2024-12-02T22:39:23Z

Description

This PR enables Smart Transactions (STX) by default through migration number 135 for users who have either opted out or haven't interacted with the STX toggle, provided they have no recorded STX activity.

How it works:

Upon Migration 135, alert displays on transaction confirmations:
Legacy transaction flow
New transaction flow (experimental)
Swaps confirmation flow
Contract deployment
Contract interactions (minting, etc.)

In the case a user migrates from a previous version of the extension and the migration runs and sets STX toggle "ON" in Settings > Advanced > Smart Transactions, they will receive an STX Banner Alert on transaction confirmation screens until dismissed through a close button, or by clicking on the "Higher success rates" link within the alert that goes to: What is 'Smart Transactions'? for more information.

Edge Cases:

If a user is new and setting up a wallet for the first time, they will not receive the Banner Alert. If a user imports a new wallet during a fresh install of the extension on a new browser or recovers a wallet, it's possible they may not see the alert if STX was on in a previous install. The STX Banner Alert is dismissed and will not show again if a user is in the state to get shown the banner and toggles STX off independently even if they do not physically dismiss the STX Banner Alert.

Migration Logic:

If smartTransactionsOptInStatus is null (new/never interacted)

Sets status to true
Enables notification flag

If status is false (previously opted out):

With no Ethereum Mainnet STX activity: Sets to true with notification
With existing Mainnet STX activity: Preserves user preference

If status is true: No changes needed

UI Components:

Implements SmartTransactionsBannerAlert component for user notification

The notification system bridges the migration changes with the UI, ensuring users are informed of the STX enablement while maintaining their ability to opt out through settings.

Target release: TBD
Affected user base: ~5.7M users who previously opted out of STX but have no STX activity.

Related issues

Fixes: N/A

Running Unit Tests

Migration Test:

yarn jest app/scripts/migrations/135.test.ts --verbose

Smart Transaction Banner Component Test:

yarn jest ui/pages/confirmations/components/smart-transactions-banner-alert/smart-transactions-banner-alert.test.ts --coverage=false

Confirm Transaction base Test:

yarn jest ui/pages/confirmations/confirm-transaction-base/confirm-transaction-base.test.js --coverage=false

Preferences Controller Test:

yarn jest app/scripts/controllers/preferences-controller.test.ts --coverage=false

Transaction Alerts Component Test:

yarn jest ui/pages/confirmations/components/transaction-alerts/transaction-alerts.test.js --coverage=false

Manual testing steps

Test Migration (using a wallet/account with no STX Transactions)

Switch branch: git checkout tags/v12.5.0 and run:

yarn
yarn webpack

Generate a dist/chrome directory

In Chrome Extension Manager, "Load Unpacked" from this directory
Import or setup a wallet without STX transactions, launch the wallet and choose "No Thanks" on the "Enhanced Transaction Protection" popup.
Check that toggle is OFF in: Settings > Advanced > Smart Transactions
Close MetaMask Extension and toggle the Extension "OFF" in the Extension Manager
Switch to branch from this PR git checkout feat/enable-stx-migration

yarn
yarn webpack

Open MetaMask Extension and Check that toggle is ON in: Settings > Advanced > Smart Transactions

Test STX Banner Alert that it shows on Transaction Confirmations and not Sign Confirmations)
(using new confirmations flow)

Check that Improved transaction requests is ON in Settings > Experimental
Open the E2E TestDapp, try several Signs (ETH Sign, Personal Sign, Sign Typed Data, etc..) and ensure the STX Banner Alert does not show on those confirmations screens.
Create a Send transaction to your own wallet for 0.0001 ETH
Ensure that Smart Transactions Banner Alert IS showing
Start a Swaps transaction on Ethereum Mainnet
Ensure that Smart Transactions Banner Alert IS showing

Test STX Banner Alert that it shows on Transaction Confirmations and not Sign Confirmations)
(using old confirmations flow)

Check that Improved transaction requests is OFF in Settings > Experimental
Open the E2E TestDapp, try several Signs (ETH Sign, Personal Sign, Sign Typed Data, etc..) and ensure the STX Banner Alert does not show on those confirmations screens.
Create a Send transaction to your own wallet for 0.0001 ETH
Ensure that Smart Transactions Banner Alert IS showing
Start a Swaps transaction on Ethereum Mainnet
Ensure that Smart Transactions Banner Alert IS showing
Without clicking on Check that "Higher success rates" link (inspect) goes to: What is 'Smart Transactions'?
Dismiss the Smart Transactions Banner Alert and set Improved transaction requests back to ON in Settings > Experimental
Create a Send transaction to your own wallet for 0.0001 ETH
Ensure that Smart Transactions Banner Alert IS NOT showing

Congrats, you have manually tested the happy path, now we just need to test the edge cases:

Remove the extensions from Extension Manager and Repeat steps 1 to 10 above to run migration again
Create a Send transaction to your own wallet for 0.0001 ETH
Ensure that Smart Transactions Banner Alert IS showing

DO NOT DISMISS THE ALERT. Instead

Open MetaMask Extension and Check that toggle is ON in: Settings > Advanced > Smart Transactions
Turn it off
Create a Send transaction to your own wallet for 0.0001 ETH
Ensure that Smart Transactions Banner Alert IS NOT showing
Perform any other Signing and/or Transaction Confirmations and ensure there are no modals that show errors and that the Banner Alert does not show anymore.

Test edge case that after STX migration runs and Banner is being shown that clicking on "Higher success rates" link:

Remove the extensions from Extension Manager and Repeat steps 1 to 10 above to run migration again
Create a Send transaction to your own wallet for 0.0001 ETH
Ensure that Smart Transactions Banner Alert IS showing

DO NOT DISMISS THE ALERT WITH CLOSE BUTTON... INSTEAD

Click on "Higher success rates" link and ensure that it goes to: What is 'Smart Transactions'?
Open MetaMask Extension and Check that toggle is ON in: Settings > Advanced > Smart Transactions
Turn it off
Create a Send transaction to your own wallet for 0.0001 ETH
Ensure that Smart Transactions Banner Alert IS NOT showing
Perform any other Signing and/or Transaction Confirmations and ensure there are no modals that show errors and that the Banner Alert does not show anymore.

Because the NEW confirmation flow does not support alerts using hooks that are dismissible, we have used the old style Banner Alert, and it is normal for their to be some variation on where the alert shows up and it's surroundings. But overall they should look similar.

Screenshots/Recordings

Before

After

Pre-merge author checklist

Pre-merge reviewer checklist

I've manually tested the PR (e.g. pulled and built the branch, ran the app, and tested the changes described above).
I confirm that this PR addresses all acceptance criteria described in the ticket and includes the necessary testing evidence (e.g., recordings, screenshots, or detailed descriptions).

…es-controller with `smartTransactionsOptInStatus` in `controllerMetadata`

…ler and migration's state transformation.

github-actions · 2024-12-02T22:39:34Z

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.

…transaction flows that occur when experimental/Improved transaction requests is not toggled on.

httpJunkie · 2024-12-04T09:20:21Z

I have read the CLA Document and I hereby sign the CLA

app/_locales/en/messages.json

app/scripts/controllers/preferences-controller.ts

app/scripts/migrations/135.test.ts

app/scripts/migrations/135.ts

shared/constants/alerts.ts

ui/pages/confirmations/components/stx-banner-alert/stx-banner-alert.js

ui/ducks/alerts/stx-migration.js

ui/pages/confirmations/components/transaction-alerts/transaction-alerts.js

…passing, update console.logs to debug in migration code for testing manually

…ended

… alert dismissal issue.

…he user has seen our message and has dismissed.

Update stx-migration ducks test.

…or without complex store mocking.

…ing message. When a user dismisses the alert (via close or "Learn more"), their preference is stored and persists across transaction sessions. The dismissal is handled through the alerts state system and uses the existing setAlertEnabledness functionality. Remove comments.

…sts for the STXBannerAlert and TransactionAlerts tests.

…ion flow. Does not let me close alert or show link.

metamaskbot · 2024-12-19T12:56:32Z

Builds ready [fd00aa9]

builds: chrome, firefox
builds (beta): chrome
builds (flask): chrome, firefox
builds (MMI): chrome, firefox
builds (test): chrome, firefox
builds (test-flask): chrome, firefox
build viz: Build System
mv3: Background Module Init Stats
mv3: UI Init Stats
mv3: Module Load Stats
mv3: Bundle Size Stats
mv2: E2e Actions Stats
code coverage: Report
storybook: Storybook
typescript migration: Dashboard
all artifacts
bundle viz:
- background: 0, 1, 2, 3, 4, 5, 6
- 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 (1776 ± 108 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	330	2246	1597	452	217
		domContentLoaded	1477	2188	1743	218	105
		load	1504	2240	1776	224	108
		domInteractive	23	106	49	24	12
		backgroundConnect	10	69	34	19	9
		firstReactRender	16	78	36	21	10
		getState	5	62	17	17	8
		initialActions	0	0	0	0	0
		loadScripts	1066	1685	1306	176	85
		setupStore	7	54	13	13	6
		uiStartup	1753	2528	2009	244	117

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

background: 1.98 KiB (0.04%)
ui: 5.97 KiB (0.08%)
common: 309 Bytes (0.00%)

…have already removed in `preference-controller` and I forgot to remove from the migration. Removed unneeded comments.

…ptInStatus` from root level of PreferencesController. Also, cleaned up migration test for readability.

…ask-extension into feat/enable-stx-migration

metamaskbot · 2024-12-19T17:42:16Z

Builds ready [20cca27]

builds: chrome, firefox
builds (beta): chrome
builds (flask): chrome, firefox
builds (MMI): chrome, firefox
builds (test): chrome, firefox
builds (test-flask): chrome, firefox
build viz: Build System
mv3: Background Module Init Stats
mv3: UI Init Stats
mv3: Module Load Stats
mv3: Bundle Size Stats
mv2: E2e Actions Stats
code coverage: Report
storybook: Storybook
typescript migration: Dashboard
all artifacts
bundle viz:
- background: 0, 1, 2, 3, 4, 5, 6
- 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 (1787 ± 100 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	330	2218	1707	370	178
		domContentLoaded	1472	2145	1758	211	101
		load	1523	2179	1787	209	100
		domInteractive	24	122	52	31	15
		backgroundConnect	10	62	27	16	8
		firstReactRender	17	107	48	29	14
		getState	7	77	29	26	12
		initialActions	0	1	0	0	0
		loadScripts	1095	1655	1332	170	82
		setupStore	7	61	16	17	8
		uiStartup	1747	2589	2095	268	129

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

background: 1.84 KiB (0.03%)
ui: 5.97 KiB (0.08%)
common: 309 Bytes (0.00%)

…ore or without migration) as conditions are already tested individually.

- Replace inline Redux selector with `getSmartTransactionsOptInStatusInternal` - Add `getSmartTransactionsMigrationAppliedInternal` for consistent state handling - Centralize banner visibility logic in `alertConditions` for clarity - Consolidate alert dismissal logic in `dismissAlert` and remove redundant `dispatch` - Simplify state typing and remove unused types - Merge duplicate dismissal tests for shared functionality Alert state is now managed via AlertController's `setAlertEnabledness`. Selectors are reusable, logic is more maintainable, and tests better reflect component behavior.

…-transactions-alert-banner.test.tsx

metamaskbot · 2024-12-19T22:29:29Z

Builds ready [dcf814c]

builds: chrome, firefox
builds (beta): chrome
builds (flask): chrome, firefox
builds (MMI): chrome, firefox
builds (test): chrome, firefox
builds (test-flask): chrome, firefox
build viz: Build System
mv3: Background Module Init Stats
mv3: UI Init Stats
mv3: Module Load Stats
mv3: Bundle Size Stats
mv2: E2e Actions Stats
code coverage: Report
storybook: Storybook
typescript migration: Dashboard
all artifacts
bundle viz:
- background: 0, 1, 2, 3, 4, 5, 6
- 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 (1664 ± 86 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	1382	2106	1668	172	82
		domContentLoaded	1373	2094	1644	169	81
		load	1382	2158	1664	179	86
		domInteractive	23	169	54	40	19
		backgroundConnect	8	65	23	16	8
		firstReactRender	16	78	44	27	13
		getState	5	57	17	17	8
		initialActions	0	1	0	0	0
		loadScripts	973	1436	1194	128	62
		setupStore	6	55	13	14	7
		uiStartup	1576	2383	1891	188	90

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

background: 1.9 KiB (0.03%)
ui: 5.76 KiB (0.07%)
common: 504 Bytes (0.01%)

… migration test

metamaskbot · 2024-12-20T21:06:08Z

Builds ready [8385fce]

builds: chrome, firefox
builds (beta): chrome
builds (flask): chrome, firefox
builds (MMI): chrome, firefox
builds (test): chrome, firefox
builds (test-flask): chrome, firefox
build viz: Build System
mv3: Background Module Init Stats
mv3: UI Init Stats
mv3: Module Load Stats
mv3: Bundle Size Stats
mv2: E2e Actions Stats
code coverage: Report
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 (1655 ± 77 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	1472	2107	1651	155	75
		domContentLoaded	1465	2062	1625	153	74
		load	1472	2117	1655	161	77
		domInteractive	20	169	43	33	16
		backgroundConnect	7	134	29	31	15
		firstReactRender	15	104	50	32	15
		getState	4	74	20	22	11
		initialActions	0	1	0	0	0
		loadScripts	1039	1384	1185	94	45
		setupStore	6	55	10	10	5
		uiStartup	1670	2350	1944	200	96

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

background: 1.9 KiB (0.03%)
ui: 5.76 KiB (0.07%)
common: 504 Bytes (0.01%)

metamaskbot · 2024-12-21T16:57:03Z

Builds ready [f4b14dc]

builds: chrome, firefox
builds (beta): chrome
builds (flask): chrome, firefox
builds (MMI): chrome, firefox
builds (test): chrome, firefox
builds (test-flask): chrome, firefox
build viz: Build System
mv3: Bundle Size Stats
mv2: E2e Actions Stats
code coverage: Report
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 (1906 ± 78 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	234	2261	1617	663	318
		domContentLoaded	1653	2247	1875	159	76
		load	1660	2260	1906	163	78
		domInteractive	25	179	53	36	17
		backgroundConnect	11	96	38	27	13
		firstReactRender	22	111	50	24	11
		getState	6	82	29	20	10
		initialActions	0	1	0	0	0
		loadScripts	1256	1734	1422	132	63
		setupStore	7	49	14	11	5
		uiStartup	1863	2918	2247	297	142

metamaskbot · 2024-12-30T20:24:34Z

Builds ready [dac3904]

builds: chrome, firefox
builds (beta): chrome
builds (flask): chrome, firefox
builds (MMI): chrome, firefox
builds (test): chrome, firefox
builds (test-flask): chrome, firefox
build viz: Build System
mv3: Bundle Size Stats
mv2: E2e Actions Stats
code coverage: Report
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 (1843 ± 70 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	288	2136	1765	368	177
		domContentLoaded	1522	2033	1811	135	65
		load	1533	2097	1843	147	70
		domInteractive	25	105	41	23	11
		backgroundConnect	7	79	30	24	12
		firstReactRender	17	86	47	25	12
		getState	6	61	19	19	9
		initialActions	0	1	0	0	0
		loadScripts	1072	1568	1337	119	57
		setupStore	7	57	15	15	7
		uiStartup	1899	2428	2126	143	69

httpJunkie added 4 commits December 2, 2024 15:00

Add migration and tests for enabling STX by default, update preferenc…

dba315a

…es-controller with `smartTransactionsOptInStatus` in `controllerMetadata`

add logging to trace state and metadata change in preferences control…

59b94a5

…ler and migration's state transformation.

add logging in setPreference in preferences controller and actions.ts

606f293

update VersionedData in the migration to have preferences:

629b2a2

httpJunkie requested a review from a team as a code owner December 2, 2024 22:39

Merge branch 'main' into feat/enable-stx-migration

dac7203

httpJunkie requested a review from a team as a code owner December 3, 2024 15:46

Add UI for legacy transaction flow, creation of STX Banner Alert for …

3010831

…transaction flows that occur when experimental/Improved transaction requests is not toggled on.

httpJunkie requested a review from a team as a code owner December 4, 2024 06:17

Merge branch 'main' into feat/enable-stx-migration

0987ad2

httpJunkie self-assigned this Dec 4, 2024

dan437 reviewed Dec 4, 2024

View reviewed changes

httpJunkie added 10 commits December 4, 2024 15:21

update stx-migration.js to include extraReducers, added test and …

f89ab51

…passing, update console.logs to debug in migration code for testing manually

Add logs and alet to ensure component is mounting and state is as int…

73a0f19

…ended

remove alert and update logs

a3daae9

registering our stxMigration reducer in ducks index

85073df

Remove logs from migration script; update stx-migration logs to debug…

9b906cd

… alert dismissal issue.

update stx-migration in ducks to dismissAndDIsable alert state once t…

cf23f7b

…he user has seen our message and has dismissed.

revert changes to wrong file

a24e963

update stx-migration ducks file to consider dismiss and disable alert.

89fde17

Update stx-migration ducks test.

update path to store in test file and directly tests the thunk behavi…

3a6e424

…or without complex store mocking.

add logs to check extraReducer logic and state.

3af6e58

This comment was marked as outdated.

Sign in to view

httpJunkie added 5 commits December 5, 2024 17:00

With changes to permanent alert dismissal, we needed to update our te…

724d3e6

…sts for the STXBannerAlert and TransactionAlerts tests.

Merge branch 'main' into feat/enable-stx-migration

24c1d6c

First stab at trying to implement alert for new confirmation/transact…

1df568e

…ion flow. Does not let me close alert or show link.

added an action to dismiss

a6fa239

dan437 added 2 commits December 19, 2024 12:17

Update a Jest snapshot

4377a1b

Update an E2E test

fd00aa9

httpJunkie added 8 commits December 19, 2024 09:43

fix: remove root level duplicated smartTransactionsOptInStatus (we …

b7ed2d1

…have already removed in `preference-controller` and I forgot to remove from the migration. Removed unneeded comments.

Merge branch 'main' into feat/enable-stx-migration

49ab97d

fix: cleaned up test for migration after removing `smartTransactionsO…

b445df7

…ptInStatus` from root level of PreferencesController. Also, cleaned up migration test for readability.

Merge branch 'main' into feat/enable-stx-migration

d9f06a1

fix: remove root level smartTransactionsOptInStatus from snapshots.

9a51557

Merge branch 'feat/enable-stx-migration' of github.com:MetaMask/metam…

7123914

…ask-extension into feat/enable-stx-migration

Merge branch 'main' into feat/enable-stx-migration

3cda0ac

Merge branch 'main' into feat/enable-stx-migration

20cca27

httpJunkie added 4 commits December 19, 2024 13:08

fix: Remove redundant test for an impossible state (alert enabled bef…

ab5c1d7

…ore or without migration) as conditions are already tested individually.

refactor: simplify logic in migration 135 and fix formatting in smart…

f520d7c

…-transactions-alert-banner.test.tsx

Merge branch 'main' into feat/enable-stx-migration

dcf814c

httpJunkie added 2 commits December 19, 2024 17:39

fix: remove skipped tests

28d135a

fix: close SmartTransactionsMigrationNotification on swap-eth.spec.ts

b58381f

matthewwalsh0 previously approved these changes Dec 20, 2024

View reviewed changes

fix: Scroll "View all quotes" button into view before clicking in STX…

e92d4dd

… migration test

httpJunkie dismissed matthewwalsh0’s stale review via e92d4dd December 20, 2024 20:28

Merge branch 'main' into feat/enable-stx-migration

8385fce

Merge branch 'main' into feat/enable-stx-migration

f4b14dc

httpJunkie requested review from dan437 and matthewwalsh0 December 21, 2024 16:21

Merge branch 'main' into feat/enable-stx-migration

dac3904

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: enable STX by default with migration and notification #28854

feat: enable STX by default with migration and notification #28854

httpJunkie commented Dec 2, 2024 •

edited

Loading

github-actions bot commented Dec 2, 2024 •

edited

Loading

httpJunkie commented Dec 4, 2024

This comment was marked as outdated.

metamaskbot commented Dec 19, 2024

metamaskbot commented Dec 19, 2024

metamaskbot commented Dec 19, 2024

metamaskbot commented Dec 20, 2024

metamaskbot commented Dec 21, 2024

metamaskbot commented Dec 30, 2024

feat: enable STX by default with migration and notification #28854

Are you sure you want to change the base?

feat: enable STX by default with migration and notification #28854

Conversation

httpJunkie commented Dec 2, 2024 • edited Loading

Description

Related issues

Running Unit Tests

Manual testing steps

Screenshots/Recordings

Before

After

Pre-merge author checklist

Pre-merge reviewer checklist

github-actions bot commented Dec 2, 2024 • edited Loading

httpJunkie commented Dec 4, 2024

This comment was marked as outdated.

metamaskbot commented Dec 19, 2024

metamaskbot commented Dec 19, 2024

metamaskbot commented Dec 19, 2024

metamaskbot commented Dec 20, 2024

metamaskbot commented Dec 21, 2024

metamaskbot commented Dec 30, 2024

httpJunkie commented Dec 2, 2024 •

edited

Loading

github-actions bot commented Dec 2, 2024 •

edited

Loading