MetaMask Browser Extension

Support

If you're a user seeking support, here is our support site.

Introduction

Mission Statement

Internal documentation

Developing Compatible Dapps

If you're a web dapp developer, we've got two types of guides for you:

New Dapp Developers

• We recommend this Learning Solidity tutorial series by Karl Floersch.
• We wrote a (slightly outdated now) gentle introduction on Developing Dapps with Truffle and MetaMask.

Current Dapp Developers

• If you have a Dapp, and you want to ensure compatibility, here is our guide on building MetaMask-compatible Dapps

Building locally

• Install Node.js version 8 and the latest available npm@6
  • If you are using nvm (recommended) running nvm use will automatically choose the right node version for you.
  • If you install Node.js manually, ensure you're using npm@6
    • Install npm@6 using npm install -g npm@6
• Install dependencies: npm install
• Install gulp globally with npm install -g gulp-cli.
• Build the project to the ./dist/ folder with gulp build.
• Optionally, to rebuild on file changes, run gulp dev.
• To package .zip files for distribution, run gulp zip, or run the full build & zip with gulp dist.

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 npm run doc, and contributors can update the hosted docs by running npm run publish-docs.

Running Tests

Requires mocha installed. Run npm install -g mocha.

Then just run npm test.

You can also test with a continuously watching process, via npm run watch.

You can run the linter by itself with gulp lint.

Architecture

Development

npm install
npm start

Build for Publishing

npm run 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 develop a live-reloading UI
• How to add a new translation to MetaMask
• Publishing Guide
• The MetaMask Team
• How to develop an in-browser mocked UI
• How to live reload on local dependency changes
• How to add new networks to the Provider Menu
• How to manage notices that appear when the app starts up
• How to port MetaMask to a new platform
• How to use the TREZOR emulator
• How to generate a visualization of this repository's development