MetaMask Browser Extension

You can find the latest adaptation of MetaMask on our official web site. For help using MetaMask, visit our User Support Site .
For general questions, feature of speech requests, or developer questions, visit our Community Forum .
MetaMask supports Firefox, Google Chrome, and Chromium-based browsers. We recommend using the latest available browser interpretation .
For up to the minute newsworthiness, follow our chirrup or medium pages.

To learn how to develop MetaMask-compatible applications, visit our Developer Docs .
To learn how to contribute to the MetaMask visualize 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, see Developing on MetaMask.
  • 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 physique system readme for build system custom data .

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 physique installed in a browser. This will open in a break 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 growth construct installed in a browser. This will enable you to use the Redux DevTools elongation to inspect MetaMask .
To create a development build and run both of these tools simultaneously, run yarn start:dev .

Test Dapp

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

Running Unit Tests and Linting

Run unit tests and the linter with yarn test. To run barely unit of measurement tests, run yarn test:unit.

You can run the linter by itself with yarn lint, and you can mechanically fix some lint problems with yarn lint:fix. You can besides run these two commands equitable on your local changes to save clock 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 casing, 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. The chromedriver package major version must match the major translation of your local Chrome facility. If they do n’t match, update whichever is behind before running Chrome e2e tests .
  • Single e2e tests can be run with yarn test:e2e:single test/e2e/tests/TEST_NAME.spec.js along with the options below .
 -- browser Set the browser used ; either 'chrome ' or 'firefox ' .

 -- leave-running Leaves the browser running after a test fails, along with anything else
 that the test used ( ganache, the test dapp, etc. ) .

 -- retries Set how many times the test should be retried upon failure. Default is 0. 

An case for running account-details testcase with chrome and leaving the browser capable would be : yarn test:e2e:single test/e2e/tests/account-details.spec.js --browser=chrome --leave-running

Changing dependencies

Whenever you change dependencies ( adding, removing, or updating, either in package.json or yarn.lock ), there are assorted 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

Leave a Reply

Your email address will not be published.