feat: add @metamask/foundryup package

.github/CODEOWNERS

@@ -82,6 +82,7 @@
 /packages/permission-log-controller    @MetaMask/wallet-api-platform-engineers @MetaMask/wallet-framework-engineers
 /packages/profile-sync-controller      @MetaMask/identity
 /packages/remote-feature-flag-controller @MetaMask/extension-platform @MetaMask/mobile-platform
+/packages/foundryup                    @MetaMask/mobile-platform @MetaMask/extension-platform
 
 ## Package Release related
 /packages/accounts-controller/package.json        @MetaMask/accounts-engineers @MetaMask/wallet-framework-engineers
@@ -148,3 +149,5 @@
 /packages/bridge-status-controller/CHANGELOG.md         @MetaMask/swaps-engineers @MetaMask/wallet-framework-engineers
 /packages/app-metadata-controller/package.json        @MetaMask/mobile-platform @MetaMask/wallet-framework-engineers
 /packages/app-metadata-controller/CHANGELOG.md        @MetaMask/mobile-platform @MetaMask/wallet-framework-engineers
+/packages/foundryup/package.json @MetaMask/mobile-platform @MetaMask/extension-platform @MetaMask/wallet-framework-engineers
+/packages/foundryup/CHANGELOG.md @MetaMask/mobile-platform @MetaMask/extension-platform @MetaMask/wallet-framework-engineers

.gitignore

@@ -34,4 +34,7 @@ scripts/coverage
 !.yarn/versions
 
 # typescript
-packages/*/*.tsbuildinfo
+packages/*/*.tsbuildinfo
+
+# foundry cache
+.metamask/cache

README.md

@@ -39,6 +39,7 @@ Each package in this repository has its own README where you can find installati
 - [`@metamask/ens-controller`](packages/ens-controller)
 - [`@metamask/error-reporting-service`](packages/error-reporting-service)
 - [`@metamask/eth-json-rpc-provider`](packages/eth-json-rpc-provider)
+- [`@metamask/foundryup`](packages/foundryup)
 - [`@metamask/gas-fee-controller`](packages/gas-fee-controller)
 - [`@metamask/json-rpc-engine`](packages/json-rpc-engine)
 - [`@metamask/json-rpc-middleware-stream`](packages/json-rpc-middleware-stream)
@@ -95,6 +96,7 @@ linkStyle default opacity:0.5
   ens_controller(["@metamask/ens-controller"]);
   error_reporting_service(["@metamask/error-reporting-service"]);
   eth_json_rpc_provider(["@metamask/eth-json-rpc-provider"]);
+  foundryup(["@metamask/foundryup"]);
   gas_fee_controller(["@metamask/gas-fee-controller"]);
   json_rpc_engine(["@metamask/json-rpc-engine"]);
   json_rpc_middleware_stream(["@metamask/json-rpc-middleware-stream"]);

eslint.config.mjs

@@ -24,6 +24,11 @@ const config = createConfig([
       // e.g. `txreceipt_status`, `signTypedData_v4`, `token_id`
       camelcase: 'off',
       'id-length': 'off',
+      'import-x/no-nodejs-modules': 'off',
+      'n/no-unsupported-features/node-builtins': 'off',
+      'n/no-missing-import': 'off',
+      'n/no-restricted-import': 'off',
+      'n/no-deprecated-api': 'off',
 
       // TODO: re-enble most of these rules
       'function-paren-newline': 'off',
@@ -73,6 +78,8 @@ const config = createConfig([
       // TODO: These rules created more errors after the upgrade to ESLint 9.
       // Re-enable these rules and address any lint violations.
       'n/no-unsupported-features/node-builtins': 'warn',
+      'n/no-missing-import': 'off',
+      'n/no-restricted-import': 'off', // Allow Node.js built-in module imports
     },
   },
   {

packages/foundryup/.gitignore

@@ -0,0 +1 @@
+.metamask

packages/foundryup/.yarnrc.yml

@@ -0,0 +1 @@
+enableGlobalCache: false

packages/foundryup/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+[Unreleased]: https://github.com/MetaMask/core/

packages/foundryup/LICENSE

@@ -0,0 +1,20 @@
+MIT License
+
+Copyright (c) 2025 MetaMask
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

packages/foundryup/README.md

@@ -0,0 +1,43 @@
+# `@metamask/foundryup`
+
+foundryup
+
+## Installation
+
+`yarn add @metamask/foundryup`
+
+or
+
+`npm install @metamask/foundryup`
+
+## Usage
+
+Once installed into a package you can do `yarn bin mm-foundryup`.
+
+This will install the latest version of Foundry things by default.
+
+Try `yarn bin mm-foundryup --help` for more options.
+
+Once you have the binaries installed, you have to figure out how to get to them.
+
+Probably best to just add each as a `package.json` script:
+
+```json
+"scripts": {
+  "anvil": "node_modules/.bin/anvil",
+}
+```
+
+Kind of weird, but it seems to work okay. You can probably use `npx anvil` in place of `node_modules/.bin/anvil`, but
+getting it to work in all scenarios (cross platform and in CI) wasn't straightforward. `yarn bin anvil` doesn't work
+in yarn v4 because it isn't a bin of `@metamask/foundryup`, so yarn pretends it doesn't exist.
+
+This all needs to work.
+
+---
+
+You can try it here in the monorepo by running `yarn workspace @metamask/foundryup anvil`.
+
+## Contributing
+
+This package is part of a monorepo. Instructions for contributing can be found in the [monorepo README](https://github.com/MetaMask/core#readme).

packages/foundryup/jest.config.js

@@ -0,0 +1,26 @@
+/*
+ * For a detailed explanation regarding each configuration property and type check, visit:
+ * https://jestjs.io/docs/configuration
+ */
+
+const merge = require('deepmerge');
+const path = require('path');
+
+const baseConfig = require('../../jest.config.packages');
+
+const displayName = path.basename(__dirname);
+
+module.exports = merge(baseConfig, {
+  // The display name when running multiple projects
+  displayName,
+
+  // An object that configures minimum threshold enforcement for coverage results
+  coverageThreshold: {
+    global: {
+      branches: 50,
+      functions: 50,
+      lines: 50,
+      statements: 50,
+    },
+  },
+});

packages/foundryup/package.json

@@ -0,0 +1,82 @@
+{
+  "name": "@metamask/foundryup",
+  "version": "0.0.0",
+  "description": "foundryup",
+  "keywords": [
+    "MetaMask",
+    "Ethereum"
+  ],
+  "homepage": "https://github.com/MetaMask/core/tree/main/packages/foundryup#readme",
+  "bugs": {
+    "url": "https://github.com/MetaMask/core/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/MetaMask/core.git"
+  },
+  "license": "MIT",
+  "sideEffects": false,
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    }
+  },
+  "bin": {
+    "mm-foundryup": "./dist/cli.mjs"
+  },
+  "files": [
+    "dist/"
+  ],
+  "scripts": {
+    "anvil": "node_modules/.bin/anvil",
+    "build": "ts-bridge --project tsconfig.build.json --verbose --clean --no-references",
+    "build:docs": "typedoc",
+    "changelog:update": "../../scripts/update-changelog.sh @metamask/foundryup",
+    "changelog:validate": "../../scripts/validate-changelog.sh @metamask/foundryup",
+    "publish:preview": "yarn npm publish --tag preview",
+    "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter",
+    "test:clean": "NODE_OPTIONS=--experimental-vm-modules jest --clearCache",
+    "test:verbose": "NODE_OPTIONS=--experimental-vm-modules jest --verbose",
+    "test:watch": "NODE_OPTIONS=--experimental-vm-modules jest --watch",
+    "since-latest-release": "../../scripts/since-latest-release.sh"
+  },
+  "devDependencies": {
+    "@metamask/auto-changelog": "^3.4.4",
+    "@types/jest": "^27.4.1",
+    "@types/unzipper": "^0.10.10",
+    "@types/yargs": "^17.0.32",
+    "@types/yargs-parser": "^21.0.3",
+    "deepmerge": "^4.2.2",
+    "jest": "^27.5.1",
+    "nock": "^13.3.1",
+    "ts-jest": "^27.1.4",
+    "typedoc": "^0.24.8",
+    "typedoc-plugin-missing-exports": "^2.0.0",
+    "typescript": "~5.2.2",
+    "yaml": "^2.3.4"
+  },
+  "engines": {
+    "node": "^18.18 || >=20"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "dependencies": {
+    "minipass": "^7.1.2",
+    "tar": "^7.4.3",
+    "unzipper": "^0.12.3",
+    "yargs": "^17.7.2",
+    "yargs-parser": "^21.1.1"
+  },
+  "main": "./dist/index.cjs",
+  "types": "./dist/index.d.cts"
+}

packages/foundryup/src/cli.ts

@@ -0,0 +1,22 @@
+#!/usr/bin/env node
+
+/**
+ * CLI entry point for Foundryup.
+ *
+ * This script downloads and installs Foundry binaries.
+ * If an error occurs, it logs the error and exits with code 1.
+ */
+import { downloadAndInstallFoundryBinaries } from '.';
+
+/**
+ * Run the main installation process and handle errors.
+ */
+downloadAndInstallFoundryBinaries().catch((error) => {
+  /**
+   * Log any error that occurs during installation and exit with code 1.
+   *
+   * @param error - The error thrown during installation.
+   */
+  console.error('Error:', error);
+  process.exit(1);
+});

packages/foundryup/src/download.ts

@@ -0,0 +1,90 @@
+import { request as httpRequest, type IncomingMessage } from 'node:http';
+import { request as httpsRequest } from 'node:https';
+import { Stream } from 'node:stream';
+import { pipeline } from 'node:stream/promises';
+
+import type { DownloadOptions } from './types';
+
+/**
+ * A PassThrough stream that emits a 'response' event when the HTTP(S) response is available.
+ */
+class DownloadStream extends Stream.PassThrough {
+  /**
+   * Returns a promise that resolves with the HTTP(S) IncomingMessage response.
+   *
+   * @returns The HTTP(S) response stream.
+   */
+  async response(): Promise<IncomingMessage> {
+    return new Promise((resolve, reject) => {
+      this.once('response', resolve);
+      this.once('error', reject);
+    });
+  }
+}
+
+/**
+ * Starts a download from the given URL.
+ *
+ * @param url - The URL to download from
+ * @param options - The download options
+ * @param redirects - The number of redirects that have occurred
+ * @returns A stream of the download
+ */
+export function startDownload(
+  url: URL,
+  options: DownloadOptions = {},
+  redirects: number = 0,
+) {
+  const MAX_REDIRECTS = options.maxRedirects ?? 5;
+  const request = url.protocol === 'http:' ? httpRequest : httpsRequest;
+  const stream = new DownloadStream();
+  request(url, options, (response) => {
+    stream.once('close', () => {
+      response.destroy();
+    });
+
+    const { statusCode, statusMessage, headers } = response;
+    // handle redirects
+    if (
+      statusCode &&
+      statusCode >= 300 &&
+      statusCode < 400 &&
+      headers.location
+    ) {
+      if (redirects >= MAX_REDIRECTS) {
+        stream.emit('error', new Error('Too many redirects'));
+        response.destroy();
+      } else {
+        // note: we don't emit a response until we're done redirecting, because
+        // handlers only expect it to be emitted once.
+        pipeline(
+          startDownload(new URL(headers.location, url), options, redirects + 1)
+            // emit the response event to the stream
+            .once('response', stream.emit.bind(stream, 'response')),
+          stream,
+        ).catch(stream.emit.bind(stream, 'error'));
+        response.destroy();
+      }
+    }
+
+    // check for HTTP errors
+    else if (!statusCode || statusCode < 200 || statusCode >= 300) {
+      stream.emit(
+        'error',
+        new Error(
+          `Request to ${url} failed. Status Code: ${statusCode} - ${statusMessage}`,
+        ),
+      );
+      response.destroy();
+    } else {
+      // resolve with response stream
+      stream.emit('response', response);
+
+      response.once('error', stream.emit.bind(stream, 'error'));
+      pipeline(response, stream).catch(stream.emit.bind(stream, 'error'));
+    }
+  })
+    .once('error', stream.emit.bind(stream, 'error'))
+    .end();
+  return stream;
+}