1
0
mirror of https://github.com/kremalicious/metamask-extension.git synced 2024-12-23 01:39:44 +01:00
🦊 Minimalized version of MetaMask for my own personal use.
Go to file
Kevin Serrano bc6312e9e3
Promisify persistence of keyrings before returning key
Change single letter variables (shame)
2016-11-18 15:58:49 -08:00
app Promisify persistence of keyrings before returning key 2016-11-18 15:58:49 -08:00
development Re-enable disclaimer screen. Rename variables to reflect role more clearly. 2016-11-14 16:49:16 -08:00
docs Add to doc 2016-10-11 15:06:09 -07:00
library mascara - remove global transpile 2016-10-26 15:29:13 -07:00
test Create failing test to check submitPassword in keyringController. 2016-11-18 15:40:12 -08:00
ui Revert one cb to previous state. 2016-11-15 17:13:33 -08:00
.babelrc Added basic es6 mocha test suite 2016-03-24 17:51:46 -07:00
.editorconfig init commit 2015-07-31 18:38:02 -07:00
.eslintignore linting and ignoring. 2016-08-16 10:48:31 -07:00
.eslintrc Fix lint rules for ternary operator placement. 2016-11-11 15:37:22 -08:00
.gitattributes Fix gitattributes 2016-06-29 17:28:49 -07:00
.gitignore Remove and untrack npm debug files 2016-11-01 14:59:57 -07:00
.jshintrc init commit 2015-07-31 18:38:02 -07:00
.nvmrc Add platform specific builds and zip tasks (#486) 2016-07-26 15:15:40 -07:00
.travis.yml Remove extraneous build target 2016-04-14 14:55:41 -07:00
.yo-rc.json init commit 2015-07-31 18:38:02 -07:00
CHANGELOG.md Increment tx ids to avoid collisions 2016-11-17 14:05:12 -08:00
circle.yml Remove npm i again because apparently that worked 2016-09-08 12:47:11 -07:00
CONTRIBUTING.md Add contributing.md file 2016-06-15 10:35:23 -07:00
fonts Improved Ui Dev Mode 2016-07-01 14:23:37 -07:00
gulpfile.js Move tos hash logic to build phase. Create dynamic global variables based on build. 2016-10-11 14:32:03 -07:00
images Improved Ui Dev Mode 2016-07-01 14:23:37 -07:00
LICENSE license 2016-07-14 14:37:40 -07:00
mock-dev.js Fix integration test suite 2016-11-07 14:11:01 -08:00
package.json Hard coding jazzicon at working version 2016-11-08 08:54:30 -08:00
README.md Began adding browser-native encryptor module 2016-10-12 20:07:46 -07:00
testem.yml Got encrypting working, not yet decrypting 2016-10-14 13:21:00 -07:00
ui-dev.js Fix integration test suite 2016-11-07 14:11:01 -08:00
USER_AGREEMENT.md Remove version from terms of service. 2016-10-11 14:33:05 -07:00

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.

Architecture

Architecture Diagram

Development

npm install

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 gulp dev 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.