Merge branch 'master' into mascara-deploy

10 files changed, 238 insertions, 0 deletions

diff --git a/docs/add-to-chrome.md b/docs/add-to-chrome.md
new file mode 100644
index 000000000..ea5213182
--- /dev/null
+++ b/docs/add-to-chrome.md
@@ -0,0 +1,14 @@
+## Add Custom Build to 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.
+
diff --git a/docs/add-to-firefox.md b/docs/add-to-firefox.md
new file mode 100644
index 000000000..593d06170
--- /dev/null
+++ b/docs/add-to-firefox.md
@@ -0,0 +1,14 @@
+# Add Custom Build to 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`.
+
diff --git a/docs/adding-new-networks.md b/docs/adding-new-networks.md
new file mode 100644
index 000000000..ea1453c21
--- /dev/null
+++ b/docs/adding-new-networks.md
@@ -0,0 +1,25 @@
+## Adding Custom Networks
+
+To add another network to our dropdown menu, make sure the following files are adjusted properly:
+
+```
+app/scripts/config.js
+app/scripts/lib/buy-eth-url.js
+app/scripts/lib/config-manager.js
+ui/app/app.js
+ui/app/components/buy-button-subview.js
+ui/app/components/drop-menu-item.js
+ui/app/components/network.js
+ui/app/components/transaction-list-item.js
+ui/app/config.js
+ui/app/css/lib.css
+ui/lib/account-link.js
+ui/lib/explorer-link.js
+```
+
+You will need:
++ The network ID
++ An RPC Endpoint url
++ An explorer link
++ CSS for the display icon
+
diff --git a/docs/developing-on-deps.md b/docs/developing-on-deps.md
new file mode 100644
index 000000000..7de3f67a8
--- /dev/null
+++ b/docs/developing-on-deps.md
@@ -0,0 +1,10 @@
+### 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!
+
diff --git a/docs/development-visualization.md b/docs/development-visualization.md
new file mode 100644
index 000000000..95847300d
--- /dev/null
+++ b/docs/development-visualization.md
@@ -0,0 +1,35 @@
+### 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
+```
+
diff --git a/docs/notices.md b/docs/notices.md
new file mode 100644
index 000000000..826e6e84e
--- /dev/null
+++ b/docs/notices.md
@@ -0,0 +1,15 @@
+## Generating Notices
+
+To add a notice:
+```
+npm run generateNotice
+```
+Enter the body of your notice into the text editor that pops up, without including the body. Be sure to save the file before closing the window!
+Afterwards, enter the title of the notice in the command line and press enter. Afterwards, add and commit the new changes made.
+
+To delete a notice:
+```
+npm run deleteNotice
+```
+A list of active notices will pop up. Enter the corresponding id in the command line prompt and add and commit the new changes afterwards.
+
diff --git a/docs/porting_to_new_environment.md b/docs/porting_to_new_environment.md
new file mode 100644
index 000000000..729a28e5d
--- /dev/null
+++ b/docs/porting_to_new_environment.md
@@ -0,0 +1,92 @@
+# Guide to Porting MetaMask to a New Environment
+
+MetaMask has been under continuous development for nearly two years now, and we’ve gradually discovered some very useful abstractions, that have allowed us to grow more easily. A couple of those layers together allow MetaMask to be ported to new environments and contexts increasingly easily.
+
+### The MetaMask Controller
+
+The core functionality of MetaMask all lives in what we call [The MetaMask Controller](https://github.com/MetaMask/metamask-extension/blob/master/app/scripts/metamask-controller.js). Our goal for this file is for it to eventually be its own javascript module that can be imported into any JS-compatible context, allowing it to fully manage an app's relationship to Ethereum.
+
+#### Constructor
+
+When calling `new MetaMask(opts)`, many platform-specific options are configured. The keys on `opts` are as follows:
+
+- initState: The last emitted state, used for restoring persistent state between sessions.
+- platform: The `platform` object defines a variety of platform-specific functions, including opening the confirmation view, and opening web sites.
+- encryptor - An object that provides access to the desired encryption methods.
+
+##### Encryptor
+
+An object that provides two simple methods, which can encrypt in any format you prefer. This parameter is optional, and will default to the browser-native WebCrypto API.
+
+- encrypt(password, object) - returns a Promise of a string that is ready for storage.
+- decrypt(password, encryptedString) - Accepts the encrypted output of `encrypt` and returns a Promise of a restored `object` as it was encrypted.
+
+
+##### Platform Options
+
+The `platform` object has a variety of options:
+
+- reload (function) - Will be called when MetaMask would like to reload its own context.
+- openWindow ({ url }) - Will be called when MetaMask would like to open a web page. It will be passed a single `options` object with a `url` key, with a string value.
+- getVersion() - Should return the current MetaMask version, as described in the current `CHANGELOG.md` or `app/manifest.json`.
+
+#### [metamask.getState()](https://github.com/MetaMask/metamask-extension/blob/master/app/scripts/metamask-controller.js#L241)
+
+This method returns a javascript object representing the current MetaMask state. This includes things like known accounts, sent transactions, current exchange rates, and more! The controller is also an event emitter, so you can subscribe to state updates via `metamask.on('update', handleStateUpdate)`. State examples available [here](https://github.com/MetaMask/metamask-extension/tree/master/development/states) under the `metamask` key. (Warning: some are outdated)
+
+#### [metamask.getApi()](https://github.com/MetaMask/metamask-extension/blob/master/app/scripts/metamask-controller.js#L274-L335)
+
+Returns a JavaScript object filled with callback functions representing every operation our user interface ever performs. Everything from creating new accounts, changing the current network, to sending a transaction, is provided via these API methods. We export this external API on an object because it allows us to easily expose this API over a port using [dnode](https://www.npmjs.com/package/dnode), which is how our WebExtension's UI works!
+
+### The UI
+
+The MetaMask UI is essentially just a website that can be configured by passing it the API and state subscriptions from above. Anyone could make a UI that consumes these, effectively reskinning MetaMask.
+
+You can see this in action in our file [ui/index.js](https://github.com/MetaMask/metamask-extension/blob/master/ui/index.js). There you can see an argument being passed in named `accountManager`, which is essentially a MetaMask controller (forgive its really outdated parameter name!). With access to that object, the UI is able to initialize a whole React/Redux app that relies on this API for its account/blockchain-related/persistent states.
+
+## Putting it Together
+
+As an example, a WebExtension is always defined by a `manifest.json` file. [In ours](https://github.com/MetaMask/metamask-extension/blob/master/app/manifest.json#L31), you can see that [background.js](https://github.com/MetaMask/metamask-extension/blob/master/app/scripts/background.js) is defined as a script to run in the background, and this is the file that we use to initialize the MetaMask controller.
+
+In that file, there's a lot going on, so it's maybe worth focusing on our MetaMask controller constructor to start. It looks something like this:
+
+```javascript
+const controller = new MetamaskController({
+    // User confirmation callbacks:
+    showUnconfirmedMessage: triggerUi,
+    unlockAccountMessage: triggerUi,
+    showUnapprovedTx: triggerUi,
+    // initial state
+    initState,
+    // platform specific api
+    platform,
+})
+```
+Since `background.js` is essentially the Extension setup file, we can see it doing all the things specific to the extension platform:
+- Defining how to open the UI for new messages, transactions, and even requests to unlock (reveal to the site) their account.
+- Provide the instance's initial state, leaving MetaMask persistence to the platform.
+- Providing a `platform` object. This is becoming our catch-all adapter for platforms to define a few other platform-variant features we require, like opening a web link. (Soon we will be moving encryption out here too, since our browser-encryption isn't portable enough!)
+
+## Ports, streams, and Web3!
+
+Everything so far has been enough to create a MetaMask wallet on virtually any platform that runs JS, but MetaMask's most unique feature isn't being a wallet, it's providing an Ethereum-enabled JavaScript context to websites.
+
+MetaMask has two kinds of [duplex stream APIs](https://github.com/substack/stream-handbook#duplex) that it exposes:
+- [metamask.setupTrustedCommunication(connectionStream, originDomain)](https://github.com/MetaMask/metamask-extension/blob/master/app/scripts/metamask-controller.js#L352) - This stream is used to connect the user interface over a remote port, and may not be necessary for contexts where the interface and the metamask-controller share a process.
+- [metamask.setupUntrustedCommunication(connectionStream, originDomain)](https://github.com/MetaMask/metamask-extension/blob/master/app/scripts/metamask-controller.js#L337) - This method is used to connect a new web site's web3 API to MetaMask's blockchain connection. Additionally, the `originDomain` is used to block detected phishing sites.
+
+### Web3 as a Stream
+
+If you are making a MetaMask-powered browser for a new platform, one of the trickiest tasks will be injecting the Web3 API into websites that are visited. On WebExtensions, we actually have to pipe data through a total of three JS contexts just to let sites talk to our background process (site -> contentscript -> background).
+
+To make this as easy as possible, we use one of our favorite internal tools, [web3-provider-engine](https://www.npmjs.com/package/web3-provider-engine) to construct a custom web3 provider object whose source of truth is a stream that we connect to remotely.
+
+To see how we do that, you can refer to the [inpage script](https://github.com/MetaMask/metamask-extension/blob/master/app/scripts/inpage.js) that we inject into every website. There you can see it creates a multiplex stream to the background, and uses it to initialize what we call the [inpage-provider](https://github.com/MetaMask/metamask-extension/blob/master/app/scripts/lib/inpage-provider.js), which you can see stubs a few methods out, but mostly just passes calls to `sendAsync` through the stream it's passed! That's really all the magic that's needed to create a web3-like API in a remote context, once you have a stream to MetaMask available.
+
+In `inpage.js` you can see we create a `PortStream`, that's just a class we use to wrap WebExtension ports as streams, so we can reuse our favorite stream abstraction over the more irregular API surface of the WebExtension. In a new platform, you will probably need to construct this stream differently. The key is that you need to construct a stream that talks from the site context to the background. Once you have that set up, it works like magic!
+
+If streams seem new and confusing to you, that's ok, they can seem strange at first. To help learn them, we highly recommend reading Substack's [Stream Handbook](https://github.com/substack/stream-handbook), or going through NodeSchool's interactive command-line class [Stream Adventure](https://github.com/workshopper/stream-adventure), also maintained by Substack.
+
+## Conclusion
+
+I hope this has been helpful to you! If you have any other questionsm, or points you think need clarification in this guide, please [open an issue on our GitHub](https://github.com/MetaMask/metamask-plugin/issues/new)!
diff --git a/docs/publishing.md b/docs/publishing.md
new file mode 100644
index 000000000..00369acf9
--- /dev/null
+++ b/docs/publishing.md
@@ -0,0 +1,19 @@
+# Publishing Guide
+
+When publishing a new version of MetaMask, we follow this procedure:
+
+## Incrementing Version & Changelog
+
+ 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](https://chrome.google.com/webstore/developer/dashboard?authuser=2).
+
+## Publishing
+
+1. `npm run dist` to generate the latest build.
+2. Publish to chrome store.
+3. Publish to firefox addon marketplace.
+4. Post on Github releases page.
+5. `npm run announce`, post that announcement in our public places.
+
diff --git a/docs/ui-dev-mode.md b/docs/ui-dev-mode.md
new file mode 100644
index 000000000..df49d8b04
--- /dev/null
+++ b/docs/ui-dev-mode.md
@@ -0,0 +1,6 @@
+# Running UI Dev Mode
+
+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.
+
diff --git a/docs/ui-mock-mode.md b/docs/ui-mock-mode.md
new file mode 100644
index 000000000..bb54dc471
--- /dev/null
+++ b/docs/ui-mock-mode.md
@@ -0,0 +1,8 @@
+### 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.
+