Metamask Plugin

Development

npm install

Developing with Gulp

We're using an experimental version of gulp-cli, so if you have the old version of gulp, you'll need to uninstall it, npm uninstall -g gulp, and install this one instead:

npm install gulpjs/gulp-cli#4.0 -g

After that, you can just:

gulp dev

In Chrome

Open Settings > Extensions.

Check "Developer mode".

At the top, click Load Unpacked Extension.

Navigate to your metamask-plugin/dist folder.

Click Select.

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

Developing the UI

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

Clone the dependency locally.
npm install in its folder.
Run npm link in its folder.
Run npm link $DEP_NAME in this project folder.
Next time you gulp dev it will watch the dependency for changes as well!

Running Tests

Currently the tests are split between two suites (we recently merged the UI into the main plugin repository). There are two different test suites to be concerned with:

Plugin tests, npm test. UI tests, npm run testUi.

You can also run both of these with continuously watching processes, via npm run watch and npm run watchUi.

UI Testing Particulars

Requires mocha installed. Run npm install -g mocha.

You can either run the test suite once with npm testUi, or you can reload on file changes, by running mocha watch ui/test/**/**.

Deploying the UI

You must be authorized already on the Metamask plugin.

Update the version in app/manifest.json and the Changelog in CHANGELOG.md.
Visit the chrome developer dashboard.
Zip the dist folder in this repository.
Upload that zip file as the updated package.

1.9 KiB Raw Blame History