A Metamask fork with Infura removed and default networks editable
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
David Walsh 6a06374784 Dark Mode: Implement Metrics (#14455) 3 years ago
.circleci unblock ci: update vuln deps + fix npm registry for snaps firefox (#14437) 3 years ago
.github Update pull request template (#13908) 3 years ago
.storybook unbreak storybook (#14059) 3 years ago
app Dark Mode: Implement Metrics (#14455) 3 years ago
development Merge remote-tracking branch 'origin/master' into Version-v10.13.0 3 years ago
docs Update manual build instructions in documentation (#13508) 3 years ago
lavamoat Merge remote-tracking branch 'origin/master' into Version-v10.13.0 3 years ago
patches Merge remote-tracking branch 'origin/master' into Version-v10.13.0 3 years ago
shared Dark Mode: Implement Metrics (#14455) 3 years ago
test Remove duplicate gas simulation error messages (#14409) 3 years ago
ui Dark Mode: Implement Metrics (#14455) 3 years ago
.depcheckrc.yml Add TypeScript to the linting process (#13495) 3 years ago
.editorconfig Clean EditorConfig file 6 years ago
.eslintrc.babel.js Refactor ESLint config (#13482) 3 years ago
.eslintrc.base.js Refactor ESLint config (#13482) 3 years ago
.eslintrc.js Add TypeScript to the linting process (#13495) 3 years ago
.eslintrc.jsdoc.js Refactor ESLint config (#13482) 3 years ago
.eslintrc.node.js Refactor ESLint config (#13482) 3 years ago
.eslintrc.typescript-compat.js Add TypeScript to the linting process (#13495) 3 years ago
.gitattributes Suppress diffs for translation files by default (#13537) 3 years ago
.gitignore Add TypeScript to the linting process (#13495) 3 years ago
.metamaskrc.dist Move Token Detection toggle to Advanced tab. (#13977) 3 years ago
.mocharc.js Add Snaps via Flask (#13462) 3 years ago
.nvmrc Update to Node v14 (#9514) 4 years ago
.prettierignore Refactor ESLint config (#13482) 3 years ago
.prettierrc.yml @metamask/eslint config@5.0.0 (#10358) 4 years ago
.yarnrc Add .yarnrc to disable scripts (#10354) 4 years ago
CHANGELOG.md Update Flask changelog entries (#14405) 3 years ago
LICENSE Up year in License (#13330) 3 years ago
README.md Update Redux DevTools README instructions (#13038) 3 years ago
babel.config.js Add TypeScript to the build system (#13489) 3 years ago
crowdin.yml Add crowdin configuration and github action (#12552) 3 years ago
jest.config.js Add Snaps via Flask (#13462) 3 years ago
jest.stories.config.js Update Jest coverage reporters (#12845) 3 years ago
nyc.config.js @metamask/eslint config@5.0.0 (#10358) 4 years ago
package.json stx-controller-v1.10.0 (#14352) 3 years ago
stylelint.config.js Update ESLint config to v8 (#12886) 3 years ago
tsconfig.json Add TypeScript to the linting process (#13495) 3 years ago
yarn.lock unblock ci: update vuln deps + fix npm registry for snaps firefox (#14437) 3 years ago

README.md

MetaMask Browser Extension

You can find the latest version of MetaMask on our official website. For help using MetaMask, visit our User Support Site.

For general questions, feature requests, or developer questions, visit our Community Forum.

MetaMask supports Firefox, Google Chrome, and Chromium-based browsers. We recommend using the latest available browser version.

For up to the minute news, follow our Twitter or Medium pages.

To learn how to develop MetaMask-compatible applications, visit our Developer Docs.

To learn how to contribute to the MetaMask project itself, visit our Internal Docs.

Building locally

  • Install Node.js version 14
    • If you are using nvm (recommended) running nvm use will automatically choose the right node version for you.
  • Install Yarn
  • Install dependencies: yarn setup (not the usual install command)
  • Copy the .metamaskrc.dist file to .metamaskrc
    • Replace the INFURA_PROJECT_ID value with your own personal Infura Project ID.
    • If debugging MetaMetrics, you'll need to add a value for SEGMENT_WRITE_KEY Segment write key.
  • Build the project to the ./dist/ folder with yarn dist.

Uncompressed builds can be found in /dist, compressed builds can be found in /builds once they're built.

See the build system readme for build system usage information.

Contributing

Development builds

To start a development build (e.g. with logging and file watching) run yarn start.

React and Redux DevTools

To start the React DevTools, run yarn devtools:react with a development build installed in a browser. This will open in a separate window; no browser extension is required.

To start the Redux DevTools Extension:

  • Install the package remotedev-server globally (e.g. yarn global add remotedev-server)
  • Install the Redux Devtools extension.
  • Open the Redux DevTools extension and check the "Use custom (local) server" checkbox in the Remote DevTools Settings, using the default server configuration (host localhost, port 8000, secure connection checkbox unchecked).

Then run the command yarn devtools:redux with a development build installed in a browser. This will enable you to use the Redux DevTools extension to inspect MetaMask.

To create a development build and run both of these tools simultaneously, run yarn start:dev.

Test Dapp

This test site can be used to execute different user flows.

Running Unit Tests and Linting

Run unit tests and the linter with yarn test. To run just unit tests, run yarn test:unit.

You can run the linter by itself with yarn lint, and you can automatically fix some lint problems with yarn lint:fix. You can also run these two commands just on your local changes to save time with yarn lint:changed and yarn lint:changed:fix respectively.

Running E2E Tests

Our e2e test suite can be run on either Firefox or Chrome. In either case, start by creating a test build by running yarn build:test.

Firefox e2e tests can be run with yarn test:e2e:firefox.

Chrome e2e tests can be run with yarn test:e2e:chrome, but they will only work if you have Chrome v79 installed. Update the chromedriver package to a version matching your local Chrome installation to run e2e tests on newer Chrome versions.

Changing dependencies

Whenever you change dependencies (adding, removing, or updating, either in package.json or yarn.lock), there are various files that must be kept up-to-date.

  • yarn.lock:
    • Run yarn setup again after your changes to ensure yarn.lock has been properly updated.
    • Run yarn yarn-deduplicate to remove duplicate dependencies from the lockfile.
  • The allow-scripts configuration in package.json
    • Run yarn allow-scripts auto to update the allow-scripts configuration automatically. This config determines whether the package's install/postinstall scripts are allowed to run. Review each new package to determine whether the install script needs to run or not, testing if necessary.
    • Unfortunately, yarn allow-scripts auto will behave inconsistently on different platforms. macOS and Windows users may see extraneous changes relating to optional dependencies.
  • The LavaMoat policy files. The tl;dr is to run yarn lavamoat:auto to update these files, but there can be devils in the details. Continue reading for more information.
    • There are two sets of LavaMoat policy files:
      • The production LavaMoat policy files (lavamoat/browserify/*/policy.json), which are re-generated using yarn lavamoat:background:auto.
        • These should be regenerated whenever the production dependencies for the background change.
      • The build system LavaMoat policy file (lavamoat/build-system/policy.json), which is re-generated using yarn lavamoat:build:auto.
        • This should be regenerated whenever the dependencies used by the build system itself change.
    • Whenever you regenerate a policy file, review the changes to determine whether the access granted to each package seems appropriate.
    • Unfortunately, yarn lavamoat:auto will behave inconsistently on different platforms. macOS and Windows users may see extraneous changes relating to optional dependencies.
    • Keep in mind that any kind of dynamic import or dynamic use of globals may elude LavaMoat's static analysis. Refer to the LavaMoat documentation or ask for help if you run into any issues.

Architecture

Architecture Diagram

Other Docs