12e055a37c
* Add background environment type The `getEnvironmentType` method now checks for the background environment as well, instead of returning 'notification' for that case. Instead of adding another regex for the background path, the regexes for each environment have been replaced with the URL constructor[0]. This is the standard method of parsing URLs, and is available in all supported browsers. [0]: https://developer.mozilla.org/en-US/docs/Web/API/URL * Add note regarding a missing manifest permission The `url` parameter to `tabs.query(...)` requires the `tabs` permission, and will be ignored otherwise. We are missing this permission, so that call does not work. * Close window after opening full screen The browser behaviour when opening a new tab differs between Chrome and Firefox. In the case of a popup, Chrome will close the popup whereas Firefox will leave it open. In the case of the notification window, Chrome will move the new tab to the foreground, whereas Firefox will leave the notification window in the foreground when opening a new tab. We always want to close the current UI (popup or notification) when switching to a full-screen view. The only exception to this is when the switch is triggered from the background, which has no UI. Closes #6513, #6685 |
||
---|---|---|
.circleci | ||
.github | ||
.storybook | ||
app | ||
development | ||
docs | ||
test | ||
ui | ||
.dockerignore | ||
.editorconfig | ||
.eslintignore | ||
.eslintrc | ||
.gitattributes | ||
.gitignore | ||
.nvmrc | ||
.stylelintignore | ||
.stylelintrc | ||
babel.config.js | ||
CHANGELOG.md | ||
CONTRIBUTING.md | ||
fonts | ||
gentests.js | ||
gulpfile.js | ||
images | ||
ISSUE_TEMPLATE | ||
LICENSE | ||
MISSION.md | ||
package.json | ||
README.md | ||
USER_AGREEMENT.md | ||
yarn.lock |
MetaMask Browser Extension
You can find the latest version of MetaMask on our official website. For help using MetaMask, visit our User Support Site.
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 10
- If you are using nvm (recommended) running
nvm use
will automatically choose the right node version for you.
- If you are using nvm (recommended) running
- Install Yarn
- Install dependencies:
yarn
- Build the project to the
./dist/
folder withyarn dist
. - Optionally, to start a development build (e.g. with logging and file watching) run
yarn start
instead.- To start the React DevTools and Redux DevTools Extension
alongside the app, use
yarn start:dev
.- React DevTools will open in a separate window; no browser extension is required
- Redux DevTools will need to be installed as a browser extension. Open the Redux Remote Devtools to access Redux state logs. This can be done by either right clicking within the web browser to bring up the context menu, expanding the Redux DevTools panel and clicking Open Remote DevTools OR clicking the Redux DevTools extension icon and clicking Open Remote DevTools.
- You will also need to check the "Use custom (local) server" checkbox in the Remote DevTools Settings, using the default server configuration (host
localhost
, port8000
, secure connection checkbox unchecked)
- You will also need to check the "Use custom (local) server" checkbox in the Remote DevTools Settings, using the default server configuration (host
- To start the React DevTools and Redux DevTools Extension
alongside the app, use
Uncompressed builds can be found in /dist
, compressed builds can be found in /builds
once they're built.
Contributing
You can read our internal docs here.
You can re-generate the docs locally by running yarn doc
, and contributors can update the hosted docs by running yarn publish-docs
.
Running Tests
Run tests with yarn test
.
You can also test with a continuously watching process, via yarn watch
.
You can run the linter by itself with yarn lint
.
Architecture
Development
yarn
yarn start
Build for Publishing
yarn dist
Writing Browser Tests
To write tests that will be run in the browser using QUnit, add your test files to test/integration/lib
.
Other Docs
- How to add custom build to Chrome
- How to add custom build to Firefox
- How to add a new translation to MetaMask
- Publishing Guide
- The MetaMask Team
- How to live reload on local dependency changes
- How to add new networks to the Provider Menu
- How to port MetaMask to a new platform
- How to use the TREZOR emulator
- How to generate a visualization of this repository's development