🌐 πŸ”Œ metamask chrome extension
JavaScript CSS HTML
Latest commit 247f7aa Jan 20, 2017 @kumavis kumavis committed on GitHub Merge pull request #1042 from MetaMask/upToDate
keep dev Up to date
Permalink
Failed to load latest commit information.
app Merge branch 'master' into upToDate Jan 20, 2017
development Allow importing of private key strings Jan 18, 2017
docs Add to doc Oct 11, 2016
library First pass at revision requests Dec 21, 2016
test Fix test to log out despite number of menu items Jan 18, 2017
ui Merge branch 'dev' into i715-AddJsonImport Jan 19, 2017
.babelrc Added basic es6 mocha test suite Mar 25, 2016
.editorconfig init commit Aug 1, 2015
.eslintignore Convert conversion util to pure json. Nov 19, 2016
.eslintrc Merge branch 'i328-MultiVault-v1' into i715-AddImportMenu Jan 17, 2017
.gitattributes Fix gitattributes Jun 30, 2016
.gitignore gulp - add disc bundle analysis task Jan 10, 2017
.jshintrc init commit Aug 1, 2015
.nvmrc Add platform specific builds and zip tasks (#486) Jul 26, 2016
.travis.yml Remove extraneous build target Apr 14, 2016
.yo-rc.json init commit Aug 1, 2015
CHANGELOG.md Merge branch 'master' into upToDate Jan 20, 2017
CONTRIBUTING.md Add contributing.md file Jun 15, 2016
LICENSE license Jul 14, 2016
README.md meta - readme - add gource instructions Jan 2, 2017
USER_AGREEMENT.md Remove version from terms of service. Oct 11, 2016
circle.yml Remove npm i again because apparently that worked Sep 8, 2016
fonts Improved Ui Dev Mode Jul 1, 2016
gulpfile.js gulp - fix brfs instrumentation Jan 10, 2017
images Improved Ui Dev Mode Jul 1, 2016
mock-dev.js First pass at revision requests Dec 21, 2016
package.json Implement naieve JSON file importing Jan 19, 2017
testem.yml Merge in crypto. Oct 19, 2016
ui-dev.js Fix integration test suite Nov 7, 2016

README.md

MetaMask Plugin Build Status

Developing Compatible Dapps

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

Building locally

  • Install Node.js version 6.3.1 or later.
  • Install local dependencies with 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.

Installing Local Builds on Chrome

To install your locally built extension on Chrome, follow this guide.

The built extension is stored in ./dist/chrome/.

Architecture

Architecture Diagram

Development

npm install
npm start

Build for Publishing

npm run dist

In Chrome

Open Settings > Extensions.

Check "Developer mode".

At the top, click Load Unpacked Extension.

Navigate to your metamask-plugin/dist/chrome folder.

Click Select.

You now have the plugin, and can click 'inspect views: background plugin' to view its dev console.

In Firefox

Go to the url about:debugging.

Click the button Load Temporary Add-On.

Select the file dist/firefox/manifest.json.

You can optionally enable debugging, and click Debug, for a console window that logs all of Metamask's processes to a single console.

If you have problems debugging, try connecting to the IRC channel #webextensions on irc.mozilla.org.

For longer questions, use the StackOverfow tag firefox-addons.

Developing on UI Only

You can run npm run ui, and your browser should open a live-reloading demo version of the plugin UI.

Some actions will crash the app, so this is only for tuning aesthetics, but it allows live-reloading styles, which is a much faster feedback loop than reloading the full extension.

Developing on UI with Mocked Background Process

You can run npm run mock and your browser should open a live-reloading demo version of the plugin UI, just like the npm run ui, except that it tries to actually perform all normal operations.

It does not yet connect to a real blockchain (this could be a good test feature later, connecting to a test blockchain), so only local operations work.

You can reset the mock ui at any time with the Reset button at the top of the screen.

Developing on Dependencies

To enjoy the live-reloading that gulp dev offers while working on the web3-provider-engine or other dependencies:

  1. Clone the dependency locally.
  2. npm install in its folder.
  3. Run npm link in its folder.
  4. Run npm link $DEP_NAME in this project folder.
  5. Next time you npm start it will watch the dependency for changes as well!

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.

Writing Browser Tests

To write tests that will be run in the browser using QUnit, add your test files to test/integration/lib.

Deploying the UI

You must be authorized already on the MetaMask plugin.

  1. Update the version in app/manifest.json and the Changelog in CHANGELOG.md.
  2. Visit the chrome developer dashboard.
  3. Run gulp dist (or gulp zip if you've already built)
  4. Upload the latest zip file from builds/metamask-$PLATFORM-$VERSION.zip as the updated package.

Generate Development Visualization

This will generate a video of the repo commit history.

Install preqs:

brew install gource
brew install ffmpeg

From the repo dir, pipe gource into ffmpeg:

gource \
  --seconds-per-day .1 \
  --user-scale 1.5 \
  --default-user-image "./images/icon-512.png" \
  --viewport 1280x720 \
  --auto-skip-seconds .1 \
  --multi-sampling \
  --stop-at-end \
  --highlight-users \
  --hide mouse,progress \
  --file-idle-time 0 \
  --max-files 0  \
  --background-colour 000000 \
  --font-size 18 \
  --date-format "%b %d, %Y" \
  --highlight-dirs \
  --user-friction 0.1 \
  --title "MetaMask Development History" \
  --output-ppm-stream - \
  --output-framerate 30 \
  | ffmpeg -y -r 30 -f image2pipe -vcodec ppm -i - -b 65536K metamask-dev-history.mp4