Merge branch 'master' into dm-docs-2

4 files changed, 52 insertions, 17 deletions

diff --git a/app/scripts/lib/config-manager.js b/app/scripts/lib/config-manager.js
index 63d27c40e..c10ff2f4e 100644
--- a/app/scripts/lib/config-manager.js
+++ b/app/scripts/lib/config-manager.js
@@ -1,12 +1,11 @@
 const ethUtil = require('ethereumjs-util')
 const normalize = require('eth-sig-util').normalize
-const MetamaskConfig = require('../config.js')
-
-
-const MAINNET_RPC = MetamaskConfig.network.mainnet
-const ROPSTEN_RPC = MetamaskConfig.network.ropsten
-const KOVAN_RPC = MetamaskConfig.network.kovan
-const RINKEBY_RPC = MetamaskConfig.network.rinkeby
+const {
+  MAINNET_RPC_URL,
+  ROPSTEN_RPC_URL,
+  KOVAN_RPC_URL,
+  RINKEBY_RPC_URL,
+} = require('../controllers/network/enums')
 
 /* The config-manager is a convenience object
  * wrapping a pojo-migrator.
@@ -174,19 +173,19 @@ ConfigManager.prototype.getCurrentRpcAddress = function () {
   switch (provider.type) {
 
     case 'mainnet':
-      return MAINNET_RPC
+      return MAINNET_RPC_URL
 
     case 'ropsten':
-      return ROPSTEN_RPC
+      return ROPSTEN_RPC_URL
 
     case 'kovan':
-      return KOVAN_RPC
+      return KOVAN_RPC_URL
 
     case 'rinkeby':
-      return RINKEBY_RPC
+      return RINKEBY_RPC_URL
 
     default:
-      return provider && provider.rpcTarget ? provider.rpcTarget : RINKEBY_RPC
+      return provider && provider.rpcTarget ? provider.rpcTarget : RINKEBY_RPC_URL
   }
 }
 
diff --git a/app/scripts/lib/createProviderMiddleware.js b/app/scripts/lib/createProviderMiddleware.js
index 4e667bac2..8a939ba4e 100644
--- a/app/scripts/lib/createProviderMiddleware.js
+++ b/app/scripts/lib/createProviderMiddleware.js
@@ -1,6 +1,10 @@
 module.exports = createProviderMiddleware
 
-// forward requests to provider
+/**
+ * Forwards an HTTP request to the current Web3 provider
+ *
+ * @param {{ provider: Object }} config Configuration containing current Web3 provider
+ */
 function createProviderMiddleware ({ provider }) {
   return (req, res, next, end) => {
     provider.sendAsync(req, (err, _res) => {
diff --git a/app/scripts/lib/port-stream.js b/app/scripts/lib/port-stream.js
index a9716fb00..5c4224fd9 100644
--- a/app/scripts/lib/port-stream.js
+++ b/app/scripts/lib/port-stream.js
@@ -6,6 +6,13 @@ module.exports = PortDuplexStream
 
 inherits(PortDuplexStream, Duplex)
 
+/**
+ * Creates a stream that's both readable and writable.
+ * The stream supports arbitrary objects.
+ *
+ * @class
+ * @param {Object} port Remote Port object
+ */
 function PortDuplexStream (port) {
   Duplex.call(this, {
     objectMode: true,
@@ -15,8 +22,13 @@ function PortDuplexStream (port) {
   port.onDisconnect.addListener(this._onDisconnect.bind(this))
 }
 
-// private
-
+/**
+ * Callback triggered when a message is received from
+ * the remote Port associated with this Stream.
+ *
+ * @private
+ * @param {Object} msg - Payload from the onMessage listener of Port
+ */
 PortDuplexStream.prototype._onMessage = function (msg) {
   if (Buffer.isBuffer(msg)) {
     delete msg._isBuffer
@@ -27,14 +39,31 @@ PortDuplexStream.prototype._onMessage = function (msg) {
   }
 }
 
+/**
+ * Callback triggered when the remote Port
+ * associated with this Stream disconnects.
+ *
+ * @private
+ */
 PortDuplexStream.prototype._onDisconnect = function () {
   this.destroy()
 }
 
-// stream plumbing
-
+/**
+ * Explicitly sets read operations to a no-op
+ */
 PortDuplexStream.prototype._read = noop
 
+
+/**
+ * Called internally when data should be written to
+ * this writable stream.
+ * 
+ * @private
+ * @param {*} msg Arbitrary object to write
+ * @param {string} encoding Encoding to use when writing payload
+ * @param {Function} cb Called when writing is complete or an error occurs
+ */
 PortDuplexStream.prototype._write = function (msg, encoding, cb) {
   try {
     if (Buffer.isBuffer(msg)) {
diff --git a/app/scripts/lib/setupMetamaskMeshMetrics.js b/app/scripts/lib/setupMetamaskMeshMetrics.js
index 40343f017..02690a948 100644
--- a/app/scripts/lib/setupMetamaskMeshMetrics.js
+++ b/app/scripts/lib/setupMetamaskMeshMetrics.js
@@ -1,6 +1,9 @@
 
 module.exports = setupMetamaskMeshMetrics
 
+/**
+ * Injects an iframe into the current document for testing
+ */
 function setupMetamaskMeshMetrics() {
   const testingContainer = document.createElement('iframe')
   testingContainer.src = 'https://metamask.github.io/mesh-testing/'