chore: ganache migration base setup #27246

seaona · 2024-09-18T11:53:39Z

Description

Ganache Migration Phase:

This PR covers:
- Anvil installation
- Anvil class and clients with default options matching Ganache default options
- Anvil contract seeder
- 3 specs run in Anvil
Future work:
- https://github.com/MetaMask/MetaMask-planning/issues/3322
- https://github.com/MetaMask/MetaMask-planning/issues/3323
- Migrate the rest of specs (possibly in several PRs)
- Remove all ganache references
- Optimism clients and L2 support

Related issues

Fixes: https://github.com/MetaMask/MetaMask-planning/issues/3321

Manual testing steps

Go to this page...

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 · 2024-09-18T11:53:55Z

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.

socket-security · 2024-09-18T11:54:49Z

New and removed dependencies detected. Learn more about Socket for GitHub ↗︎

Package	New capabilities	Transitives	Size	Publisher
npm/@adraffy/[email protected]	None	`0`	441 kB	adraffy
npm/@noble/[email protected]	None	`0`	837 kB	paulmillr
npm/@scure/[email protected]	None	`0`	132 kB	paulmillr
npm/@viem/[email protected]	network	`0`	215 kB	jmoxey
npm/[email protected]	None	`0`	1.17 MB	awkweb
npm/[email protected]	None	`0`	38 kB	lpinca
npm/[email protected]	None	`0`	11.1 kB	sindresorhus
npm/[email protected]	None	`0`	10.2 kB	jmoxey
npm/[email protected]	None	`0`	12.7 MB	awkweb, jmoxey
npm/[email protected]	None	`0`	187 kB	jmoxey
npm/[email protected]	environment, network	`0`	147 kB	lpinca

🚮 Removed packages: npm/@noble/[email protected], npm/@scure/[email protected], npm/[email protected], npm/[email protected], npm/[email protected]

View full report↗︎

socket-security · 2024-09-18T11:54:51Z

🚨 Potential security issues detected. Learn more about Socket for GitHub ↗︎

To accept the risk, merge this PR and you will not be notified again.

Alert	Package	Note	Source	CI
Network access	npm/@viem/[email protected]	Module: http-proxy Location: Package overview	`package.json` `yarn.lock`	🚫
Network access	npm/@viem/[email protected]	Module: globalThis["fetch"] Location: Package overview	`package.json` `yarn.lock`	🚫

View full report↗︎

Next steps

What is network access?

This module accesses the network.

Packages should remove all network access that is functionally unnecessary. Consumers should audit network access to ensure legitimate use.

Take a deeper look at the dependency

Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at support [AT] socket [DOT] dev.

Remove the package

If you happen to install a dependency that Socket reports as Known Malware you should immediately remove it and select a different dependency. For other alert types, you may may wish to investigate alternative packages or consider if there are other ways to mitigate the specific risk posed by the dependency.

Mark a package as acceptable risk

To ignore an alert, reply with a comment starting with @SocketSecurity ignore followed by a space separated list of ecosystem/package-name@version specifiers. e.g. @SocketSecurity ignore npm/[email protected] or ignore all packages with @SocketSecurity ignore-all

@SocketSecurity ignore npm/@viem/[email protected]

sonarcloud · 2024-09-18T14:32:30Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

codecov · 2024-09-18T14:52:31Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 70.02%. Comparing base (3e5c0a8) to head (38b4b80).
Report is 17 commits behind head on develop.

Additional details and impacted files

@@             Coverage Diff             @@
##           develop   #27246      +/-   ##
===========================================
+ Coverage    70.00%   70.02%   +0.02%     
===========================================
  Files         1445     1443       -2     
  Lines        50195    50165      -30     
  Branches     14041    14041              
===========================================
- Hits         35139    35127      -12     
+ Misses       15056    15038      -18

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

metamaskbot · 2024-09-18T15:03:43Z

Builds ready [38b4b80]

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

Page Load Metrics (1636 ± 45 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	1501	1849	1636	95	45
		domContentLoaded	1491	1796	1615	90	43
		load	1501	1847	1636	94	45
		domInteractive	19	68	34	15	7

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

background: 5.26 KiB (0.15%)
ui: 0 Bytes (0.00%)
common: 56.95 KiB (0.71%)

seaona · 2024-09-20T09:55:40Z

test/e2e/accounts/snap-account-contract-interaction.spec.ts

@@ -1,4 +1,4 @@
-import GanacheContractAddressRegistry from '../seeder/ganache-contract-address-registry';
+import ContractAddressRegistry from '../seeder/contract-address-registry';


just a rename, as now it's used both with ganache and anvil - no functionality change

seaona · 2024-09-20T09:56:26Z

test/e2e/seeder/contract-address-registry.js

 */
-class GanacheContractAddressRegistry {
+class ContractAddressRegistry {


just a rename, as now it's used both with ganache and anvil - no functionality change

seaona · 2024-09-20T09:56:35Z

test/e2e/seeder/ganache-seeder.js

@@ -3,14 +3,14 @@ const { ContractFactory, Contract } = require('@ethersproject/contracts');

 const { ENTRYPOINT, GANACHE_ACCOUNT } = require('../constants');
 const { SMART_CONTRACTS, contractConfiguration } = require('./smart-contracts');
-const GanacheContractAddressRegistry = require('./ganache-contract-address-registry');
+const ContractAddressRegistry = require('./contract-address-registry');


just a rename, as now it's used both with ganache and anvil - no functionality change

seaona · 2024-09-20T09:58:01Z

test/e2e/tests/transaction/send-eth.spec.js

@@ -18,11 +17,10 @@ describe('Send ETH', function () {
      await withFixtures(
        {
          fixtures: new FixtureBuilder().build(),
-          ganacheOptions: defaultGanacheOptions,
          title: this.test.fullTitle(),


this spec is using anvil.
All tests that use defaultGanacheOptions, once migrated to anvil, won't need to pass defaultXYZOptions, since those will be already default in the anvil config, so we can remove this.

seaona · 2024-09-20T09:59:43Z

test/e2e/tests/transaction/send-eth.spec.js

@@ -154,18 +150,17 @@ describe('Send ETH', function () {
      await withFixtures(
        {
          fixtures: new FixtureBuilder().build(),
-          ganacheOptions: {
-            ...defaultGanacheOptions,
+          networkOptions: {


this spec is using anvil! When we need to pass custom network options, we can pass them and we can omit the default.
I've name the options with a generic name networkOptions

seaona · 2024-09-20T10:00:00Z

test/e2e/tests/transaction/send-eth.spec.js

@@ -321,8 +313,7 @@ describe('Send ETH', function () {
            fixtures: new FixtureBuilder()
              .withPermissionControllerConnectedToTestDapp()
              .build(),
-            ganacheOptions: {
-              ...defaultGanacheOptions,
+            networkOptions: {


same. This spec is using anvil

seaona · 2024-09-20T10:00:19Z

test/e2e/tests/transaction/simple-send.spec.ts

@@ -11,7 +11,6 @@ describe('Simple send eth', function (this: Suite) {
    await withFixtures(
      {
        fixtures: new FixtureBuilder().build(),
-        ganacheOptions: defaultGanacheOptions,
        title: this.test?.fullTitle(),


this spec is using anvil

seaona · 2024-09-20T10:04:36Z

test/e2e/seeder/anvil-clients.ts

+
+  return { publicClient, testClient, walletClient };
+}
+


This file will be expanded in the future, for when we want to add Optimism clients for L2 network support. See:

https://www.opviem.sh/

seaona · 2024-09-20T10:06:55Z

test/e2e/seeder/anvil-seeder.js

@@ -0,0 +1,149 @@
+const { DEFAULT_FIXTURE_ACCOUNT, ENTRYPOINT } = require('../constants');


this file supports the same functionality as ganache seeder, but adapted to anvil (meaning using publicClient/walletClient/testClient for the different actions)

seaona · 2024-09-20T10:08:52Z

test/e2e/seeder/anvil.ts

+  mnemonic:
+    'spread raise short crane omit tent fringe mandate neglect detail suspect cradle',
+  port: 8545,
+};


This are the default network options. Since we have them defined here, there's no need for defaultAnvilOptions, so we don't need to pass anything in the spec files, when we want the default options (see spec files above).

Likewise, we have ganache options defined in the ganache file, we wouldn't need the defaultGanacheOptions (but it's implemented like this)

seaona · 2024-09-20T10:09:23Z

test/e2e/seeder/anvil.ts

+      await this.#server.stop();
+    } catch (e) {
+      console.log('Caught error while closing Anvil network:', e);
+    }


these are the same methods that we support on ganache, so functionality is preserved

seaona · 2024-09-20T10:37:47Z

test/e2e/helpers.js

-      );
-      contractRegistry = ganacheSeeder.getContractRegistry();
+    if (smartContract) {
+      if (ganacheServer) {


once we have migrated all tests, we'll be able to remove this code block and use the below one with the AnvilSeeder

sonarcloud · 2024-09-20T12:04:51Z

Quality Gate failed

Failed conditions
0.0% Coverage on New Code (required ≥ 80%)

See analysis details on SonarCloud

metamaskbot · 2024-09-20T12:37:31Z

Builds ready [a33e7ae]

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

Page Load Metrics (2019 ± 99 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	1710	2531	2010	208	100
		domContentLoaded	1702	2464	1976	192	92
		load	1712	2535	2019	206	99
		domInteractive	14	146	43	31	15

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

background: 5.26 KiB (0.13%)
ui: 0 Bytes (0.00%)
common: 56.95 KiB (0.70%)

seaona added 5 commits September 18, 2024 12:30

base setup and simple send spec

ecb2e16

config tweak

3945591

add require

104372e

fix identation

39dcb0e

fix

1c0b0ed

github-actions bot added the team-extension-platform label Sep 18, 2024

seaona added 6 commits September 18, 2024 14:15

add installation steps

04eec2b

add to path

9576c51

fix?

aae945a

dedupe

7d988ac

lavamoat auto

4b2dcb1

run foundry install in all test jobs

38b4b80

seaona self-assigned this Sep 18, 2024

seaona added 2 commits September 20, 2024 11:53

anvil seeder setup

189fdc5

rename

b9a66c1

seaona commented Sep 20, 2024

View reviewed changes

seaona added 3 commits September 20, 2024 12:29

Merge branch 'develop' into ganache-migration-anvil

e70354a

fix benchmark

a126370

yarn dedupe

eeac3a8

seaona commented Sep 20, 2024

View reviewed changes

seaona added 2 commits September 20, 2024 12:56

fix lint

b5d5315

fix remaining tests

a33e7ae

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: ganache migration base setup #27246

chore: ganache migration base setup #27246

seaona commented Sep 18, 2024 •

edited

Loading

github-actions bot commented Sep 18, 2024

socket-security bot commented Sep 18, 2024 •

edited

Loading

socket-security bot commented Sep 18, 2024 •

edited

Loading

sonarcloud bot commented Sep 18, 2024

codecov bot commented Sep 18, 2024 •

edited

Loading

metamaskbot commented Sep 18, 2024

seaona Sep 20, 2024 •

edited

Loading

seaona Sep 20, 2024

seaona Sep 20, 2024

seaona Sep 20, 2024 •

edited

Loading

seaona Sep 20, 2024

seaona Sep 20, 2024

seaona Sep 20, 2024

seaona Sep 20, 2024

seaona Sep 20, 2024

seaona Sep 20, 2024

seaona Sep 20, 2024

seaona Sep 20, 2024

sonarcloud bot commented Sep 20, 2024

metamaskbot commented Sep 20, 2024

		@@ -1,4 +1,4 @@
		import GanacheContractAddressRegistry from '../seeder/ganache-contract-address-registry';
		import ContractAddressRegistry from '../seeder/contract-address-registry';

		@@ -0,0 +1,149 @@
		const { DEFAULT_FIXTURE_ACCOUNT, ENTRYPOINT } = require('../constants');

chore: ganache migration base setup #27246

Are you sure you want to change the base?

chore: ganache migration base setup #27246

Conversation

seaona commented Sep 18, 2024 • edited Loading

Description

Ganache Migration Phase:

Related issues

Manual testing steps

Screenshots/Recordings

Before

After

Pre-merge author checklist

Pre-merge reviewer checklist

github-actions bot commented Sep 18, 2024

socket-security bot commented Sep 18, 2024 • edited Loading

socket-security bot commented Sep 18, 2024 • edited Loading

Next steps

sonarcloud bot commented Sep 18, 2024

Quality Gate passed

codecov bot commented Sep 18, 2024 • edited Loading

Codecov Report

metamaskbot commented Sep 18, 2024

seaona Sep 20, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

seaona Sep 20, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sonarcloud bot commented Sep 20, 2024

Quality Gate failed

metamaskbot commented Sep 20, 2024

seaona commented Sep 18, 2024 •

edited

Loading

socket-security bot commented Sep 18, 2024 •

edited

Loading

socket-security bot commented Sep 18, 2024 •

edited

Loading

codecov bot commented Sep 18, 2024 •

edited

Loading

seaona Sep 20, 2024 •

edited

Loading

seaona Sep 20, 2024 •

edited

Loading