feat: add `@metamask/foundryup` package #5810

davidmurdoch · 2025-05-14T22:16:39Z

Explanation

This PR introduces a JavaScript-based foundryup installer that simplifies the installation of Foundry toolchain binaries—Anvil, Cast, Forge, and Chisel. The installer is designed to be cross-platform and work across macOS, Linux, and Windows, supporting both ARM and AMD architectures.

It's been used in the MetaMask Extension for a few months now: MetaMask/metamask-extension#28393

References

Changelog

Checklist

I've updated the test suite for new or updated code as appropriate
I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate
I've communicated my changes to consumers by updating changelogs for packages I've changed, highlighting breaking changes as necessary
I've prepared draft pull requests for clients and consumer packages to resolve any breaking changes

socket-security · 2025-05-14T22:23:29Z

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Diff	Package	Supply Chain Security	Vulnerability	Quality	Maintenance	License
	@types/unzipper@0.10.11
	unzipper@0.12.3
	yaml@2.5.0 ⏵ 2.8.0	⁺¹

View full report

… read, default to local cache.

…acked

…guideline

cortisiko · 2025-05-20T00:23:14Z

@metamaskbot publish-preview

github-actions · 2025-05-20T00:31:02Z

Preview builds have been published. See these instructions for more information about preview builds.

Expand for full list of packages and versions.

{
  "@metamask-previews/accounts-controller": "29.0.0-preview-c1fef6e5",
  "@metamask-previews/address-book-controller": "6.0.3-preview-c1fef6e5",
  "@metamask-previews/announcement-controller": "7.0.3-preview-c1fef6e5",
  "@metamask-previews/app-metadata-controller": "1.0.0-preview-c1fef6e5",
  "@metamask-previews/approval-controller": "7.1.3-preview-c1fef6e5",
  "@metamask-previews/assets-controllers": "63.0.0-preview-c1fef6e5",
  "@metamask-previews/base-controller": "8.0.1-preview-c1fef6e5",
  "@metamask-previews/bridge-controller": "25.0.0-preview-c1fef6e5",
  "@metamask-previews/bridge-status-controller": "21.0.0-preview-c1fef6e5",
  "@metamask-previews/build-utils": "3.0.3-preview-c1fef6e5",
  "@metamask-previews/chain-agnostic-permission": "0.6.0-preview-c1fef6e5",
  "@metamask-previews/composable-controller": "11.0.0-preview-c1fef6e5",
  "@metamask-previews/controller-utils": "11.8.0-preview-c1fef6e5",
  "@metamask-previews/delegation-controller": "0.3.0-preview-c1fef6e5",
  "@metamask-previews/earn-controller": "0.14.0-preview-c1fef6e5",
  "@metamask-previews/eip1193-permission-middleware": "0.1.0-preview-c1fef6e5",
  "@metamask-previews/ens-controller": "16.0.0-preview-c1fef6e5",
  "@metamask-previews/eth-json-rpc-provider": "4.1.8-preview-c1fef6e5",
  "@metamask-previews/foundryup": "0.0.0-preview-c1fef6e5",
  "@metamask-previews/gas-fee-controller": "23.0.0-preview-c1fef6e5",
  "@metamask-previews/json-rpc-engine": "10.0.3-preview-c1fef6e5",
  "@metamask-previews/json-rpc-middleware-stream": "8.0.7-preview-c1fef6e5",
  "@metamask-previews/keyring-controller": "22.0.0-preview-c1fef6e5",
  "@metamask-previews/logging-controller": "6.0.4-preview-c1fef6e5",
  "@metamask-previews/message-manager": "12.0.1-preview-c1fef6e5",
  "@metamask-previews/multichain": "4.0.0-preview-c1fef6e5",
  "@metamask-previews/multichain-api-middleware": "0.2.0-preview-c1fef6e5",
  "@metamask-previews/multichain-network-controller": "0.7.0-preview-c1fef6e5",
  "@metamask-previews/multichain-transactions-controller": "0.11.0-preview-c1fef6e5",
  "@metamask-previews/name-controller": "8.0.3-preview-c1fef6e5",
  "@metamask-previews/network-controller": "23.4.0-preview-c1fef6e5",
  "@metamask-previews/notification-services-controller": "8.0.0-preview-c1fef6e5",
  "@metamask-previews/permission-controller": "11.0.6-preview-c1fef6e5",
  "@metamask-previews/permission-log-controller": "3.0.3-preview-c1fef6e5",
  "@metamask-previews/phishing-controller": "12.5.0-preview-c1fef6e5",
  "@metamask-previews/polling-controller": "13.0.0-preview-c1fef6e5",
  "@metamask-previews/preferences-controller": "18.0.0-preview-c1fef6e5",
  "@metamask-previews/profile-sync-controller": "15.0.0-preview-c1fef6e5",
  "@metamask-previews/queued-request-controller": "10.0.0-preview-c1fef6e5",
  "@metamask-previews/rate-limit-controller": "6.0.3-preview-c1fef6e5",
  "@metamask-previews/remote-feature-flag-controller": "1.6.0-preview-c1fef6e5",
  "@metamask-previews/sample-controllers": "0.1.0-preview-c1fef6e5",
  "@metamask-previews/selected-network-controller": "22.0.0-preview-c1fef6e5",
  "@metamask-previews/signature-controller": "29.0.0-preview-c1fef6e5",
  "@metamask-previews/token-search-discovery-controller": "3.1.0-preview-c1fef6e5",
  "@metamask-previews/transaction-controller": "56.0.0-preview-c1fef6e5",
  "@metamask-previews/user-operation-controller": "35.0.0-preview-c1fef6e5"
}

cortisiko · 2025-05-23T21:33:37Z

Update on the changes I made to this PR:

I successfully ran this package as an executable in the mobile repository. The e2e tests ran with Anvil and passed: https://app.bitrise.io/build/f2b009b6-5e12-407f-ac77-484240cb064e
The default unit test coverage is 100%. I added a few more tests, which put our coverage around 55%. We can continue to strive for 100% coverage. In the meantime, I adjusted the test coverage threshold to 50%.
I added jsdocs for the files that were missing them.

The challenge i am facing now is this linting error Do not import Node.js builtin module "node:process"

I am unsure on how to handle it. I will post a message in the wallet framework channel to get some guidance.

This reverts commit 59227bf.

This reverts commit a91cd2d.

cortisiko · 2025-05-28T14:03:00Z

@metamaskbot publish-preview

github-actions · 2025-05-28T14:08:23Z

Preview builds have been published. See these instructions for more information about preview builds.

Expand for full list of packages and versions.

{
  "@metamask-previews/accounts-controller": "29.0.0-preview-de21a3fe",
  "@metamask-previews/address-book-controller": "6.0.3-preview-de21a3fe",
  "@metamask-previews/announcement-controller": "7.0.3-preview-de21a3fe",
  "@metamask-previews/app-metadata-controller": "1.0.0-preview-de21a3fe",
  "@metamask-previews/approval-controller": "7.1.3-preview-de21a3fe",
  "@metamask-previews/assets-controllers": "65.0.0-preview-de21a3fe",
  "@metamask-previews/base-controller": "8.0.1-preview-de21a3fe",
  "@metamask-previews/bridge-controller": "28.0.0-preview-de21a3fe",
  "@metamask-previews/bridge-status-controller": "25.0.0-preview-de21a3fe",
  "@metamask-previews/build-utils": "3.0.3-preview-de21a3fe",
  "@metamask-previews/chain-agnostic-permission": "0.7.0-preview-de21a3fe",
  "@metamask-previews/composable-controller": "11.0.0-preview-de21a3fe",
  "@metamask-previews/controller-utils": "11.9.0-preview-de21a3fe",
  "@metamask-previews/delegation-controller": "0.3.0-preview-de21a3fe",
  "@metamask-previews/earn-controller": "0.14.0-preview-de21a3fe",
  "@metamask-previews/eip1193-permission-middleware": "0.1.0-preview-de21a3fe",
  "@metamask-previews/ens-controller": "16.0.0-preview-de21a3fe",
  "@metamask-previews/error-reporting-service": "0.0.0-preview-de21a3fe",
  "@metamask-previews/eth-json-rpc-provider": "4.1.8-preview-de21a3fe",
  "@metamask-previews/foundryup": "0.0.0-preview-de21a3fe",
  "@metamask-previews/gas-fee-controller": "23.0.0-preview-de21a3fe",
  "@metamask-previews/json-rpc-engine": "10.0.3-preview-de21a3fe",
  "@metamask-previews/json-rpc-middleware-stream": "8.0.7-preview-de21a3fe",
  "@metamask-previews/keyring-controller": "22.0.0-preview-de21a3fe",
  "@metamask-previews/logging-controller": "6.0.4-preview-de21a3fe",
  "@metamask-previews/message-manager": "12.0.1-preview-de21a3fe",
  "@metamask-previews/multichain": "4.1.0-preview-de21a3fe",
  "@metamask-previews/multichain-api-middleware": "0.4.0-preview-de21a3fe",
  "@metamask-previews/multichain-network-controller": "0.7.0-preview-de21a3fe",
  "@metamask-previews/multichain-transactions-controller": "1.0.0-preview-de21a3fe",
  "@metamask-previews/name-controller": "8.0.3-preview-de21a3fe",
  "@metamask-previews/network-controller": "23.5.0-preview-de21a3fe",
  "@metamask-previews/notification-services-controller": "8.0.0-preview-de21a3fe",
  "@metamask-previews/permission-controller": "11.0.6-preview-de21a3fe",
  "@metamask-previews/permission-log-controller": "3.0.3-preview-de21a3fe",
  "@metamask-previews/phishing-controller": "12.5.0-preview-de21a3fe",
  "@metamask-previews/polling-controller": "13.0.0-preview-de21a3fe",
  "@metamask-previews/preferences-controller": "18.0.0-preview-de21a3fe",
  "@metamask-previews/profile-sync-controller": "15.0.0-preview-de21a3fe",
  "@metamask-previews/queued-request-controller": "10.0.0-preview-de21a3fe",
  "@metamask-previews/rate-limit-controller": "6.0.3-preview-de21a3fe",
  "@metamask-previews/remote-feature-flag-controller": "1.6.0-preview-de21a3fe",
  "@metamask-previews/sample-controllers": "0.1.0-preview-de21a3fe",
  "@metamask-previews/selected-network-controller": "22.1.0-preview-de21a3fe",
  "@metamask-previews/signature-controller": "29.0.0-preview-de21a3fe",
  "@metamask-previews/token-search-discovery-controller": "3.2.0-preview-de21a3fe",
  "@metamask-previews/transaction-controller": "56.2.0-preview-de21a3fe",
  "@metamask-previews/user-operation-controller": "35.0.0-preview-de21a3fe"
}

mcmire

Hey thanks for the PR, just had questions about some things. I realize that some of the comments I left may require some followup. I will do that soon but thought I'd jot down my thoughts in the meantime.

eslint.config.mjs

packages/foundryup/.yarnrc.yml

packages/foundryup/.gitignore

packages/foundryup/README.md

packages/foundryup/jest.config.js

packages/foundryup/types/node:fs.d.ts

packages/foundryup/types/unzipper.d.ts

scripts/run-eslint.ts

packages/foundryup/src/cli.ts

packages/foundryup/tsconfig.build.json

Co-authored-by: Elliot Winkler <[email protected]>

eslint.config.mjs

scripts/run-eslint.ts

mcmire

One more thing :)

eslint.config.mjs

mcmire

LGTM now!

cortisiko · 2025-06-03T17:02:11Z

Note to self @cortisiko : Create task to Increase test coverage.

davidmurdoch assigned cortisiko May 14, 2025

davidmurdoch mentioned this pull request May 14, 2025

test: throw on foundryup installation issues MetaMask/metamask-extension#32641

Closed

7 tasks

davidmurdoch added 4 commits May 15, 2025 10:30

feat: add @metamask/foundryup package

9c6da58

make it more flexible

0826ab0

some fixes

1593955

some tips

30fb702

davidmurdoch force-pushed the add-foundryup branch from c638121 to 30fb702 Compare May 15, 2025 14:31

cortisiko added 5 commits May 19, 2025 14:40

adding shebang to cli script.

6ac55b2

add conditional to check if the yarnrc file doesn't exist or can't be…

2c366b2

… read, default to local cache.

ignore cache so that the foundry binaries cache directory won't be tr…

a8ed967

…acked

attempt to fix unit tests + make test follow unit test best practice …

a187b22

…guideline

remove nock from package json

c1fef6e

cortisiko added 9 commits May 21, 2025 19:44

add more tests

54f6380

fix lint issues within tests

9a7c16e

increase test coverage and reduce coverage threshold to 50%

e2f4380

attempting to fix lint error: 'TSError: ⨯ Unable to compile TypeScript:'

362d8ba

add jsdocs for cli.ts file

23b6f64

add js docs to download.ts

e303de9

add jsdocs for index.ts

e8cc2e9

fix lint issues with extract.ts

f9f190b

fix linting issue with test file

7b1ee0d

cortisiko added 5 commits May 23, 2025 17:35

Merge branch 'main' into add-foundryup

e249f64

fix more linting in: index/options/types

59227bf

fix linting on utils file

a91cd2d

Revert "fix more linting in: index/options/types"

cb02fdf

This reverts commit 59227bf.

Revert "fix linting on utils file"

55badf4

This reverts commit a91cd2d.

cortisiko marked this pull request as ready for review May 28, 2025 01:29

Merge branch 'main' into add-foundryup

58beb89

cortisiko removed the no-changelog label May 28, 2025

add code owners

560f21f

cortisiko requested a review from a team as a code owner May 28, 2025 01:52

cortisiko added the no-changelog label May 28, 2025

cortisiko added 5 commits May 27, 2025 21:57

auto changelog script

4ff51b7

fix typo

8eba3af

fix code owners

9fb5bed

fix codeowners

8ef7b12

fix dependencies

de21a3f

dedupe

7d2ed49

mcmire reviewed May 28, 2025

View reviewed changes

cortisiko and others added 5 commits May 28, 2025 16:09

Update packages/foundryup/src/cli.ts

839d43f

Co-authored-by: Elliot Winkler <[email protected]>

Merge branch 'main' into add-foundryup

f1b1135

clean up package json

a52970a

undo root gitignore change

3a27cfa

add eslint rule to allow the foundryup package to use Node.js modules.

596758c

mcmire reviewed Jun 3, 2025

View reviewed changes

eslint.config.mjs Outdated Show resolved Hide resolved

eslint.config.mjs Outdated Show resolved Hide resolved

scripts/run-eslint.ts Show resolved Hide resolved

set lint rules specificially for the foundrup package

e104de1

mcmire reviewed Jun 3, 2025

View reviewed changes

eslint.config.mjs Outdated Show resolved Hide resolved

clean up lint rules

1c7f8e1

mcmire approved these changes Jun 3, 2025

View reviewed changes

cortisiko enabled auto-merge (squash) June 3, 2025 16:56

Merge branch 'main' into add-foundryup

fa487fd

cortisiko merged commit dc95d93 into main Jun 3, 2025
214 checks passed

cortisiko deleted the add-foundryup branch June 3, 2025 17:02

Uh oh!

feat: add @metamask/foundryup package #5810

feat: add @metamask/foundryup package #5810

Uh oh!

Conversation

davidmurdoch commented May 14, 2025 • edited by cortisiko Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Explanation

References

Changelog

Checklist

Uh oh!

socket-security bot commented May 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

cortisiko commented May 20, 2025

Uh oh!

github-actions bot commented May 20, 2025

Uh oh!

cortisiko commented May 23, 2025

Uh oh!

cortisiko commented May 28, 2025

Uh oh!

github-actions bot commented May 28, 2025

Uh oh!

mcmire left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mcmire left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mcmire left a comment

Choose a reason for hiding this comment

Uh oh!

cortisiko commented Jun 3, 2025

Uh oh!

Uh oh!

Uh oh!

feat: add `@metamask/foundryup` package #5810

feat: add `@metamask/foundryup` package #5810

davidmurdoch commented May 14, 2025 •

edited by cortisiko

Loading

socket-security bot commented May 14, 2025 •

edited

Loading