2017-12-16 00:06:06 +01:00
# MetaMask Browser Extension
2020-01-20 02:15:49 +01:00
2019-02-20 18:41:03 +01:00
You can find the latest version of MetaMask on [our official website ](https://metamask.io/ ). For help using MetaMask, visit our [User Support Site ](https://metamask.zendesk.com/hc/en-us ).
2017-08-04 00:05:32 +02:00
2021-06-15 18:23:43 +02:00
For [general questions ](https://community.metamask.io/c/learn/26 ), [feature requests ](https://community.metamask.io/c/feature-requests-ideas/13 ), or [developer questions ](https://community.metamask.io/c/developer-questions/11 ), visit our [Community Forum ](https://community.metamask.io/ ).
2021-01-06 23:31:15 +01:00
2019-08-02 14:59:18 +02:00
MetaMask supports Firefox, Google Chrome, and Chromium-based browsers. We recommend using the latest available browser version.
2021-02-23 18:05:38 +01:00
For up to the minute news, follow our [Twitter ](https://twitter.com/metamask ) or [Medium ](https://medium.com/metamask ) pages.
2017-07-19 00:41:33 +02:00
2018-12-13 01:18:18 +01:00
To learn how to develop MetaMask-compatible applications, visit our [Developer Docs ](https://metamask.github.io/metamask-docs/ ).
2018-05-29 18:27:02 +02:00
2018-12-13 01:18:18 +01:00
To learn how to contribute to the MetaMask project itself, visit our [Internal Docs ](https://github.com/MetaMask/metamask-extension/tree/develop/docs ).
2016-09-10 05:01:27 +02:00
2016-07-16 03:04:52 +02:00
## Building locally
2022-07-19 02:24:23 +02:00
- Install [Node.js ](https://nodejs.org ) version 16
2022-11-10 15:25:37 +01:00
- If you are using [nvm ](https://github.com/nvm-sh/nvm#installing-and-updating ) (recommended) running `nvm use` will automatically choose the right node version for you.
Switch from `npm` to `yarn` (#6843)
As a solution to the constant lockfile churn issues we've had with
`npm`, the project now uses `yarn` to manage dependencies.
The `package-lock.json` file has been replaced with `yarn.lock`, which
was created using `yarn import`. It should approximate the contents of
`package-lock.json` fairly well, though there may be some changes due to
deduplication. The codeowners file has been updated to reference this
new lockfile.
All documentation and npm scripts have been updated to reference `yarn`
rather than `npm`. Note that running scripts using `npm run` still works
fine, but it seemed better to switch those to `yarn` as well to avoid
confusion.
The `npm-audit` Bash script has been replaced with `yarn-audit`. The
output of `yarn audit` is a bit different than `npm audit` in that it
returns a bitmask to describe which severity issues were found. This
made it simpler to check the results directly from the Bash script, so
the associated `npm-audit-check.js` script was no longer required. The
output should be exactly the same, and the information is still sourced
from the same place (the npm registry).
The new `yarn-audit` script does have an external dependency: `jq`.
However, `jq` is already assumed to be present by another CI script, and
is present on all CI images we use. `jq` was not added to `package.json`
as a dependency because there is no official package on the npm
registry, just wrapper scripts. We don't need it anywhere exept on CI
anyway.
The section in `CONTRIBUTING` about how to develop inside the
`node_modules` folder was removed, as the advice was a bit dated, and
wasn't specific to this project anyway.
2019-07-30 20:36:23 +02:00
- Install [Yarn ](https://yarnpkg.com/en/docs/install )
2021-02-05 16:41:45 +01:00
- Install dependencies: `yarn setup` (not the usual install command)
2020-09-10 18:16:00 +02:00
- Copy the `.metamaskrc.dist` file to `.metamaskrc`
2020-09-10 19:29:32 +02:00
- Replace the `INFURA_PROJECT_ID` value with your own personal [Infura Project ID ](https://infura.io/docs ).
2022-06-15 22:48:40 +02:00
- If debugging MetaMetrics, you'll need to add a value for `SEGMENT_WRITE_KEY` [Segment write key ](https://segment.com/docs/connections/find-writekey/ ), see [Developing on MetaMask - Segment ](./development/README.md#segment ).
- If debugging unhandled exceptions, you'll need to add a value for `SENTRY_DSN` [Sentry Dsn ](https://docs.sentry.io/product/sentry-basics/dsn-explainer/ ), see [Developing on MetaMask - Sentry ](./development/README.md#sentry ).
2022-06-22 22:48:11 +02:00
- Optionally, replace the `PASSWORD` value with your development wallet password to avoid entering it each time you open the app.
Switch from `npm` to `yarn` (#6843)
As a solution to the constant lockfile churn issues we've had with
`npm`, the project now uses `yarn` to manage dependencies.
The `package-lock.json` file has been replaced with `yarn.lock`, which
was created using `yarn import`. It should approximate the contents of
`package-lock.json` fairly well, though there may be some changes due to
deduplication. The codeowners file has been updated to reference this
new lockfile.
All documentation and npm scripts have been updated to reference `yarn`
rather than `npm`. Note that running scripts using `npm run` still works
fine, but it seemed better to switch those to `yarn` as well to avoid
confusion.
The `npm-audit` Bash script has been replaced with `yarn-audit`. The
output of `yarn audit` is a bit different than `npm audit` in that it
returns a bitmask to describe which severity issues were found. This
made it simpler to check the results directly from the Bash script, so
the associated `npm-audit-check.js` script was no longer required. The
output should be exactly the same, and the information is still sourced
from the same place (the npm registry).
The new `yarn-audit` script does have an external dependency: `jq`.
However, `jq` is already assumed to be present by another CI script, and
is present on all CI images we use. `jq` was not added to `package.json`
as a dependency because there is no official package on the npm
registry, just wrapper scripts. We don't need it anywhere exept on CI
anyway.
The section in `CONTRIBUTING` about how to develop inside the
`node_modules` folder was removed, as the advice was a bit dated, and
wasn't specific to this project anyway.
2019-07-30 20:36:23 +02:00
- Build the project to the `./dist/` folder with `yarn dist` .
2022-06-10 03:56:08 +02:00
- Optionally, you may run `yarn start` to run dev mode.
2016-07-16 03:04:52 +02:00
2019-06-24 15:03:35 +02:00
Uncompressed builds can be found in `/dist` , compressed builds can be found in `/builds` once they're built.
2016-07-27 00:35:08 +02:00
Rationalize build system arguments (#12047)
This rationalizes how arguments are passed to and parsed by the build system. To accomplish this, everything that isn't an environment variable from `.metamaskrc` or our CI environment is now passed as an argument on the command line.
Of such arguments, the `entryTask` is still expected as a positional argument in the first position (i.e. `process.argv[2]`), but everything else must be passed as a named argument. We use `minimist` to parse the arguments, and set defaults to preserve existing behavior.
Arguments are parsed in a new function, `parseArgv`, in `development/build/index.js`. They are assigned to environment variables where convenient, and otherwise returned from `parseArgv` to be passed to other functions invoked in the same file.
This change is motivated by our previous inconsistent handling of arguments to the build system, which will grow increasingly problematic as the build system grows in complexity. (Which it will very shortly, as we introduce Flask builds.)
Miscellaneous changes:
- Adds a build system readme at `development/build/README.md`
- Removes the `beta` package script. Now, we can instead call: `yarn dist --build-type beta`
- Fixes the casing of some log messages and reorders some parameters in the build system
2021-09-09 21:44:57 +02:00
See the [build system readme ](./development/build/README.md ) for build system usage information.
2018-09-12 23:10:06 +02:00
## Contributing
2021-02-24 16:52:42 +01:00
### Development builds
2016-11-22 03:16:45 +01:00
2021-02-24 16:52:42 +01:00
To start a development build (e.g. with logging and file watching) run `yarn start` .
2017-06-05 22:55:48 +02:00
2021-12-10 18:53:37 +01:00
#### React and Redux DevTools
2017-06-05 22:55:48 +02:00
2021-12-10 18:53:37 +01:00
To start the [React DevTools ](https://github.com/facebook/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 ](https://github.com/reduxjs/redux-devtools/tree/main/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 ](https://metamask.github.io/test-dapp/ ) can be used to execute different user flows.
2021-09-21 19:57:24 +02:00
2021-02-24 16:52:42 +01:00
### Running Unit Tests and Linting
2021-10-12 14:40:33 +02:00
Run unit tests and the linter with `yarn test` . To run just unit tests, run `yarn test:unit` .
2021-02-24 16:52:42 +01:00
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
2022-11-07 19:22:47 +01:00
Our e2e test suite can be run on either Firefox or Chrome.
2021-02-24 16:52:42 +01:00
2022-11-07 19:22:47 +01:00
1. **required** `yarn build:test` to create a test build.
2. run tests, targetting the browser:
* 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 version of your local Chrome installation. If they don't match, update whichever is behind before running Chrome e2e tests.
2021-02-24 16:52:42 +01:00
2022-11-07 19:22:47 +01:00
#### Running a single e2e test
2022-04-20 13:12:07 +02:00
2022-11-07 19:22:47 +01:00
Single e2e tests can be run with `yarn test:e2e:single test/e2e/tests/TEST_NAME.spec.js` along with the options below.
2022-04-20 13:12:07 +02:00
```console
--browser Set the browser used; either 'chrome' or 'firefox'.
2022-08-24 21:11:49 +02:00
--leave-running Leaves the browser running after a test fails, along with anything else
2022-04-20 13:12:07 +02:00
that the test used (ganache, the test dapp, etc.).
2022-08-24 21:11:49 +02:00
2022-04-20 13:12:07 +02:00
--retries Set how many times the test should be retried upon failure. Default is 0.
```
An example for running `account-details` testcase with chrome and leaving the browser open would be:
`yarn test:e2e:single test/e2e/tests/account-details.spec.js --browser=chrome --leave-running`
2021-02-24 16:52:42 +01:00
### 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.
2021-12-07 18:31:55 +01:00
* Run `yarn yarn-deduplicate` to remove duplicate dependencies from the lockfile.
2021-02-24 16:52:42 +01:00
* 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.
2022-08-19 01:09:26 +02:00
* 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:
2021-11-15 23:23:46 +01:00
* There are two sets of LavaMoat policy files:
2022-08-19 01:09:26 +02:00
* The production LavaMoat policy files (`lavamoat/browserify/*/policy.json`), which are re-generated using `yarn lavamoat:background:auto` . Add `--help` for usage.
2021-11-15 23:23:46 +01:00
* 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.
2022-08-19 01:09:26 +02:00
* If you keep getting policy failures even after regenerating the policy files, try regenerating the policies after a clean install by doing:
* `rm -rf node_modules/ && yarn setup && yarn lavamoat:auto`
2021-11-15 23:23:46 +01:00
* 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.
2016-11-22 03:16:45 +01:00
2016-06-14 01:53:21 +02:00
## Architecture
2022-09-23 16:17:42 +02:00
- [Visual of the controller hierarchy and dependencies as of summer 2022. ](https://gist.github.com/rekmarks/8dba6306695dcd44967cce4b6a94ae33 )
2022-08-16 18:39:38 +02:00
- [Visual of the entire codebase. ](https://mango-dune-07a8b7110.1.azurestaticapps.net/?repo=metamask%2Fmetamask-extension )
2016-06-14 01:53:21 +02:00
[][1]
2017-06-05 22:55:48 +02:00
## Other Docs
2016-03-22 18:43:56 +01:00
2017-06-05 22:55:48 +02:00
- [How to add custom build to Chrome ](./docs/add-to-chrome.md )
- [How to add custom build to Firefox ](./docs/add-to-firefox.md )
2018-03-09 20:18:43 +01:00
- [How to add a new translation to MetaMask ](./docs/translating-guide.md )
2017-06-05 22:55:48 +02:00
- [Publishing Guide ](./docs/publishing.md )
2018-07-20 00:47:22 +02:00
- [How to use the TREZOR emulator ](./docs/trezor-emulator.md )
2022-08-24 21:11:49 +02:00
- [Developing on MetaMask ](./development/README.md )
2019-11-20 15:42:36 +01:00
- [How to generate a visualization of this repository's development ](./development/gource-viz.sh )
2016-06-14 01:53:21 +02:00
2022-08-16 18:39:38 +02:00
## Dapp Developer Resources
- [Extend MetaMask's features w/ MetaMask Snaps. ](https://docs.metamask.io/guide/snaps.html )
- [Prompt your users to add and switch to a new network. ](https://medium.com/metamask/connect-users-to-layer-2-networks-with-the-metamask-custom-networks-api-d0873fac51e5 )
- [Change the logo that appears when your dapp connects to MetaMask. ](https://docs.metamask.io/guide/defining-your-icon.html )
2019-07-10 21:01:48 +02:00
[1]: http://www.nomnoml.com/#view/%5B%3Cactor%3Euser%5D%0A%0A%5Bmetamask-ui%7C%0A%20%20%20%5Btools%7C%0A%20%20%20%20%20react%0A%20%20%20%20%20redux%0A%20%20%20%20%20thunk%0A%20%20%20%20%20ethUtils%0A%20%20%20%20%20jazzicon%0A%20%20%20%5D%0A%20%20%20%5Bcomponents%7C%0A%20%20%20%20%20app%0A%20%20%20%20%20account-detail%0A%20%20%20%20%20accounts%0A%20%20%20%20%20locked-screen%0A%20%20%20%20%20restore-vault%0A%20%20%20%20%20identicon%0A%20%20%20%20%20config%0A%20%20%20%20%20info%0A%20%20%20%5D%0A%20%20%20%5Breducers%7C%0A%20%20%20%20%20app%0A%20%20%20%20%20metamask%0A%20%20%20%20%20identities%0A%20%20%20%5D%0A%20%20%20%5Bactions%7C%0A%20%20%20%20%20%5BbackgroundConnection%5D%0A%20%20%20%5D%0A%20%20%20%5Bcomponents%5D%3A-%3E%5Bactions%5D%0A%20%20%20%5Bactions%5D%3A-%3E%5Breducers%5D%0A%20%20%20%5Breducers%5D%3A-%3E%5Bcomponents%5D%0A%5D%0A%0A%5Bweb%20dapp%7C%0A%20%20%5Bui%20code%5D%0A%20%20%5Bweb3%5D%0A%20%20%5Bmetamask-inpage%5D%0A%20%20%0A%20%20%5B%3Cactor%3Eui%20developer%5D%0A%20%20%5Bui%20developer%5D-%3E%5Bui%20code%5D%0A%20%20%5Bui%20code%5D%3C-%3E%5Bweb3%5D%0A%20%20%5Bweb3%5D%3C-%3E%5Bmetamask-inpage%5D%0A%5D%0A%0A%5Bmetamask-background%7C%0A%20%20%5Bprovider-engine%5D%0A%20%20%5Bhooked%20wallet%20subprovider%5D%0A%20%20%5Bid%20store%5D%0A%20%20%0A%20%20%5Bprovider-engine%5D%3C-%3E%5Bhooked%20wallet%20subprovider%5D%0A%20%20%5Bhooked%20wallet%20subprovider%5D%3C-%3E%5Bid%20store%5D%0A%20%20%5Bconfig%20manager%7C%0A%20%20%20%20%5Brpc%20configuration%5D%0A%20%20%20%20%5Bencrypted%20keys%5D%0A%20%20%20%20%5Bwallet%20nicknames%5D%0A%20%20%5D%0A%20%20%0A%20%20%5Bprovider-engine%5D%3C-%5Bconfig%20manager%5D%0A%20%20%5Bid%20store%5D%3C-%3E%5Bconfig%20manager%5D%0A%5D%0A%0A%5Buser%5D%3C-%3E%5Bmetamask-ui%5D%0A%0A%5Buser%5D%3C%3A--%3A%3E%5Bweb%20dapp%5D%0A%0A%5Bmetamask-contentscript%7C%0A%20%20%5Bplugin%20restart%20detector%5D%0A%20%20%5Brpc%20passthrough%5D%0A%5D%0A%0A%5Brpc%20%7C%0A%20%20%5Bethereum%20blockchain%20%7C%0A%20%20%20%20%5Bcontracts%5D%0A%20%20%20%20%5Baccounts%5D%0A%20%20%5D%0A%5D%0A%0A%5Bweb%20dapp%5D%3C%3A--%3A%3E%5Bmetamask-contentscript%5D%0A%5Bmetamask-contentscript%5D%3C-%3E%5Bmetamask-background%5D%0A%5Bmetamask-background%5D%3C-%3E%5Bmetamask-ui%5D%0A%5Bmetamask-background%5D%3C-%3E%5Brpc%5D%0A
