Merge branch 'master' into dm-docs-2

8 files changed, 219 insertions, 136 deletions

diff --git a/app/scripts/controllers/currency.js b/app/scripts/controllers/currency.js
index c23c7f616..480c08b1c 100644
--- a/app/scripts/controllers/currency.js
+++ b/app/scripts/controllers/currency.js
@@ -1,17 +1,18 @@
   const ObservableStore = require('obs-store')
 const extend = require('xtend')
+const log = require('loglevel')
 
 // every ten minutes
 const POLLING_INTERVAL = 600000
 
 class CurrencyController {
 
-	/**
-	 * Controller responsible for managing data associated with the currently selected currency.
-	 *
+  /**
+   * Controller responsible for managing data associated with the currently selected currency.
+   *
    * @typedef {Object} CurrencyController
-	 * @param {object} opts Overrides the defaults for the initial state of this.store
-	 * @property {array} opts.initState  initializes the the state of the CurrencyController. Can contain an
+   * @param {object} opts Overrides the defaults for the initial state of this.store
+   * @property {array} opts.initState  initializes the the state of the CurrencyController. Can contain an
    * currentCurrency, conversionRate and conversionDate properties
    * @property {string} currentCurrency A 2-4 character shorthand that describes a specific currency, currently
    * selected by the user
@@ -20,8 +21,8 @@ class CurrencyController {
    * since midnight of January 1, 1970 
    * @property {number} conversionInterval The id of the interval created by the scheduleConversionInterval method.
    * Used to clear an existing interval on subsequent calls of that method.
-	 *
-	 */
+   *
+   */
   constructor (opts = {}) {
     const initState = extend({
       currentCurrency: 'usd',
@@ -35,22 +36,22 @@ class CurrencyController {
   // PUBLIC METHODS
   //
 
-	/**
-	 * A getter for the currentCurrency property
-	 *
-	 * @returns {string} A 2-4 character shorthand that describes a specific currency, currently selected by the user
-	 *
-	 */
+  /**
+   * A getter for the currentCurrency property
+   *
+   * @returns {string} A 2-4 character shorthand that describes a specific currency, currently selected by the user
+   *
+   */
   getCurrentCurrency () {
     return this.store.getState().currentCurrency
   }
 
-	/**
-	 * A setter for the currentCurrency property
-	 *
-	 * @param {string} currentCurrency The new currency to set as the currentCurrency in the store
-	 *
-	 */
+  /**
+   * A setter for the currentCurrency property
+   *
+   * @param {string} currentCurrency The new currency to set as the currentCurrency in the store
+   *
+   */
   setCurrentCurrency (currentCurrency) {
     this.store.updateState({ currentCurrency })
   }
@@ -117,12 +118,12 @@ class CurrencyController {
     }
   }
 
-	/**
-	 * Creates a new poll, using setInterval, to periodically call updateConversionRate. The id of the interval is
+  /**
+   * Creates a new poll, using setInterval, to periodically call updateConversionRate. The id of the interval is
    * stored at the controller's conversionInterval property. If it is called and such an id already exists, the
    * previous interval is clear and a new one is created.
-	 *
-	 */
+   *
+   */
   scheduleConversionInterval () {
     if (this.conversionInterval) {
       clearInterval(this.conversionInterval)
diff --git a/app/scripts/controllers/infura.js b/app/scripts/controllers/infura.js
index c6b4c9de2..8f6dd837e 100644
--- a/app/scripts/controllers/infura.js
+++ b/app/scripts/controllers/infura.js
@@ -1,5 +1,6 @@
 const ObservableStore = require('obs-store')
 const extend = require('xtend')
+const log = require('loglevel')
 
 // every ten minutes
 const POLLING_INTERVAL = 10 * 60 * 1000
diff --git a/app/scripts/controllers/network.js b/app/scripts/controllers/network.js
index 617456cd7..45574e673 100644
--- a/app/scripts/controllers/network.js
+++ b/app/scripts/controllers/network.js
@@ -9,6 +9,7 @@ const extend = require('xtend')
 const EthQuery = require('eth-query')
 const createEventEmitterProxy = require('../lib/events-proxy.js')
 const networkConfig = require('../config.js')
+const log = require('loglevel')
 const { OLD_UI_NETWORK_TYPE, DEFAULT_RPC } = networkConfig.enums
 const INFURA_PROVIDER_TYPES = ['ropsten', 'rinkeby', 'kovan', 'mainnet']
 
diff --git a/app/scripts/controllers/preferences.js b/app/scripts/controllers/preferences.js
index d54efb889..bdedde2fb 100644
--- a/app/scripts/controllers/preferences.js
+++ b/app/scripts/controllers/preferences.js
@@ -4,8 +4,8 @@ const extend = require('xtend')
 
 class PreferencesController {
 
-	/**
-	 *
+  /**
+   *
    * @typedef {Object} PreferencesController
 	 * @param {object} opts Overrides the defaults for the initial state of this.store
    * @property {object} store The stored object containing a users preferences, stored in local storage
@@ -18,7 +18,7 @@ class PreferencesController {
    * @property {string} store.currentLocale The preferred language locale key
    * @property {string} store.selectedAddress A hex string that matches the currently selected address in the app
    *
-	 */
+   */
   constructor (opts = {}) {
     const initState = extend({
       frequentRpcList: [],
@@ -32,43 +32,43 @@ class PreferencesController {
   }
 // PUBLIC METHODS
 
-	/**
-	 * Setter for the `useBlockie` property
-	 *
-	 * @param {boolean} val Whether or not the user prefers blockie indicators
-	 *
-	 */
+  /**
+   * Setter for the `useBlockie` property
+   *
+   * @param {boolean} val Whether or not the user prefers blockie indicators
+   *
+   */
   setUseBlockie (val) {
     this.store.updateState({ useBlockie: val })
   }
 
-	/**
-	 * Getter for the `useBlockie` property
-	 *
-	 * @returns {boolean} this.store.useBlockie
-	 *
-	 */
+  /**
+   * Getter for the `useBlockie` property
+   *
+   * @returns {boolean} this.store.useBlockie
+   *
+   */
   getUseBlockie () {
     return this.store.getState().useBlockie
   }
 
-	/**
-	 * Setter for the `currentLocale` property
+  /**
+   * Setter for the `currentLocale` property
    *
    * @param {string} key he preferred language locale key
-	 *
-	 */
+   *
+   */
   setCurrentLocale (key) {
     this.store.updateState({ currentLocale: key })
   }
 
-	/**
-	 * Setter for the `selectedAddress` property
-	 *
-	 * @param {string} _address A new hex address for an account
-	 * @returns {Promise<void>} Promise resolves with undefined
-	 *
-	 */
+  /**
+   * Setter for the `selectedAddress` property
+   *
+   * @param {string} _address A new hex address for an account
+   * @returns {Promise<void>} Promise resolves with undefined
+   *
+   */
   setSelectedAddress (_address) {
     return new Promise((resolve, reject) => {
       const address = normalizeAddress(_address)
@@ -129,13 +129,13 @@ class PreferencesController {
     return Promise.resolve(tokens)
   }
 
-	/**
-	 * Removes a specified token from the tokens array.
-	 *
-	 * @param {string} rawAddress Hex address of the token contract to remove.
-	 * @returns {Promise<array> The new array of AddedToken objects
-	 *
-	 */
+  /**
+   * Removes a specified token from the tokens array.
+   *
+   * @param {string} rawAddress Hex address of the token contract to remove.
+   * @returns {Promise<array>} The new array of AddedToken objects
+   *
+   */
   removeToken (rawAddress) {
     const tokens = this.store.getState().tokens
 
@@ -145,23 +145,23 @@ class PreferencesController {
     return Promise.resolve(updatedTokens)
   }
 
-	/**
-	 * A getter for the `tokens` property
-	 *
-	 * @returns {array} The current array of AddedToken objects
-	 *
-	 */
+  /**
+   * A getter for the `tokens` property
+   *
+   * @returns {array} The current array of AddedToken objects
+   *
+   */
   getTokens () {
     return this.store.getState().tokens
   }
 
-	/**
-	 * Gets an updated rpc list from this.addToFrequentRpcList() and sets the `frequentRpcList` to this update list.
-	 *
-	 * @param {string} _url The the new rpc url to add to the updated list
-	 * @returns {Promise<void>} Promise resolves with undefined
-	 *
-	 */
+  /**
+   * Gets an updated rpc list from this.addToFrequentRpcList() and sets the `frequentRpcList` to this update list.
+   *
+   * @param {string} _url The the new rpc url to add to the updated list
+   * @returns {Promise<void>} Promise resolves with undefined
+   *
+   */
   updateFrequentRpcList (_url) {
     return this.addToFrequentRpcList(_url)
       .then((rpcList) => {
@@ -170,13 +170,13 @@ class PreferencesController {
       })
   }
 
-	/**
-	 * Setter for the `currentAccountTab` property 
-	 *
-	 * @param {string} currentAccountTab Specifies the new tab to be marked as current
-	 * @returns {Promise<void>} Promise resolves with undefined
-	 *
-	 */
+  /**
+   * Setter for the `currentAccountTab` property 
+   *
+   * @param {string} currentAccountTab Specifies the new tab to be marked as current
+   * @returns {Promise<void>} Promise resolves with undefined
+   *
+   */
   setCurrentAccountTab (currentAccountTab) {
     return new Promise((resolve, reject) => {
       this.store.updateState({ currentAccountTab })
@@ -184,15 +184,15 @@ class PreferencesController {
     })
   }
 
-	/**
-	 * Returns an updated rpcList based on the passed url and the current list.
+  /**
+   * Returns an updated rpcList based on the passed url and the current list.
    * The returned list will have a max length of 2. If the _url currently exists it the list, it will be moved to the
    * end of the list. The current list is modified and returned as a promise.
-	 *
-	 * @param {string} _url The rpc url to add to the frequentRpcList.
-	 * @returns {Promise<array>} The updated frequentRpcList. 
-	 *
-	 */
+   *
+   * @param {string} _url The rpc url to add to the frequentRpcList.
+   * @returns {Promise<array>} The updated frequentRpcList. 
+   *
+   */
   addToFrequentRpcList (_url) {
     const rpcList = this.getFrequentRpcList()
     const index = rpcList.findIndex((element) => { return element === _url })
@@ -208,24 +208,24 @@ class PreferencesController {
     return Promise.resolve(rpcList)
   }
 
-	/**
-	 * Getter for the `frequentRpcList` property.
-	 *
-	 * @returns {array<string>} An array of one or two rpc urls.
-	 *
-	 */
+  /**
+   * Getter for the `frequentRpcList` property.
+   *
+   * @returns {array<string>} An array of one or two rpc urls.
+   *
+   */
   getFrequentRpcList () {
     return this.store.getState().frequentRpcList
   }
 
-	/**
-	 * Updates the `featureFlags` property, which is an object. One property within that object will be set to a boolean.
-	 *
-	 * @param {string} feature A key that corresponds to a UI feature.
+  /**
+   * Updates the `featureFlags` property, which is an object. One property within that object will be set to a boolean.
+   *
+   * @param {string} feature A key that corresponds to a UI feature.
    * @param {boolean} activated Indicates whether or not the UI feature should be displayed
-	 * @returns {Promise<object>} Promises a new object; the updated featureFlags object.
-	 *
-	 */
+   * @returns {Promise<object>} Promises a new object; the updated featureFlags object.
+   *
+   */
   setFeatureFlag (feature, activated) {
     const currentFeatureFlags = this.store.getState().featureFlags
     const updatedFeatureFlags = {
@@ -238,13 +238,13 @@ class PreferencesController {
     return Promise.resolve(updatedFeatureFlags)
   }
 
-	/**
-	 * A getter for the `featureFlags` property
-	 *
-	 * @returns {object} A key-boolean map, where keys refer to features and booleans to whether the
+  /**
+   * A getter for the `featureFlags` property
+   *
+   * @returns {object} A key-boolean map, where keys refer to features and booleans to whether the
    * user wishes to see that feature
-	 *
-	 */
+   *
+   */
   getFeatureFlags () {
     return this.store.getState().featureFlags
   }
diff --git a/app/scripts/controllers/recent-blocks.js b/app/scripts/controllers/recent-blocks.js
index ddcaa7220..1377c1ba9 100644
--- a/app/scripts/controllers/recent-blocks.js
+++ b/app/scripts/controllers/recent-blocks.js
@@ -2,6 +2,7 @@ const ObservableStore = require('obs-store')
 const extend = require('xtend')
 const BN = require('ethereumjs-util').BN
 const EthQuery = require('eth-query')
+const log = require('loglevel')
 
 class RecentBlocksController {
 
diff --git a/app/scripts/controllers/shapeshift.js b/app/scripts/controllers/shapeshift.js
index 17994d2db..b2a1462c2 100644
--- a/app/scripts/controllers/shapeshift.js
+++ b/app/scripts/controllers/shapeshift.js
@@ -1,5 +1,6 @@
 const ObservableStore = require('obs-store')
 const extend = require('xtend')
+const log = require('loglevel')
 
 // every three seconds when an incomplete tx is waiting
 const POLLING_INTERVAL = 3000
@@ -31,7 +32,7 @@ class ShapeshiftController {
    * @property {string} depositAddress - An address at which to send a crypto deposit, so that eth can be sent to the
    * user's Metamask account
    * @property {string} depositType - An abbreviation of the type of crypto currency to be deposited.
-   * @constant {string} key - The 'shapeshift' key differentiates this from other types of txs in Metamask
+   * @property {string} key - The 'shapeshift' key differentiates this from other types of txs in Metamask
    * @property {number} time - The time at which the tx was created
    * @property {object} response - Initiated as an empty object, which will be replaced by a Response object. @see {@link
    * https://developer.mozilla.org/en-US/docs/Web/API/Response}
@@ -41,38 +42,38 @@ class ShapeshiftController {
   // PUBLIC METHODS
   //
 
-	/**
-	 * A getter for the shapeShiftTxList property
-	 *
-	 * @returns {array<ShapeShiftTx>}
-	 *
-	 */
+  /**
+   * A getter for the shapeShiftTxList property
+   *
+   * @returns {array<ShapeShiftTx>}
+   *
+   */
   getShapeShiftTxList () {
     const shapeShiftTxList = this.store.getState().shapeShiftTxList
     return shapeShiftTxList
   }
 
-	/**
-	 * A getter for all ShapeShiftTx in the shapeShiftTxList that have not successfully completed a deposit.
-	 *
-	 * @returns {array<ShapeShiftTx>} Only includes ShapeShiftTx which has a response property with a status !== complete
-	 *
-	 */
+  /**
+   * A getter for all ShapeShiftTx in the shapeShiftTxList that have not successfully completed a deposit.
+   *
+   * @returns {array<ShapeShiftTx>} Only includes ShapeShiftTx which has a response property with a status !== complete
+   *
+   */
   getPendingTxs () {
     const txs = this.getShapeShiftTxList()
     const pending = txs.filter(tx => tx.response && tx.response.status !== 'complete')
     return pending
   }
 
-	/**
-	 * A poll that exists as long as there are pending transactions. Each call attempts to update the data of any
+  /**
+   * A poll that exists as long as there are pending transactions. Each call attempts to update the data of any
    * pendingTxs, and then calls itself again. If there are no pending txs, the recursive call is not made and
    * the polling stops.
    *
    * this.updateTx is used to attempt the update to the pendingTxs in the ShapeShiftTxList, and that updated data
    * is saved with saveTx.
-	 *
-	 */
+   *
+   */
   pollForUpdates () {
     const pendingTxs = this.getPendingTxs()
 
@@ -113,13 +114,13 @@ class ShapeshiftController {
     }
   }
 
-	/**
-	 * Saves an updated to a ShapeShiftTx in the shapeShiftTxList. If the passed ShapeShiftTx is not in the
+  /**
+   * Saves an updated to a ShapeShiftTx in the shapeShiftTxList. If the passed ShapeShiftTx is not in the
    * shapeShiftTxList, nothing happens.
-	 *
-	 * @param {ShapeShiftTx} tx The updated tx to save, if it exists in the current shapeShiftTxList
-	 *
-	 */
+   *
+   * @param {ShapeShiftTx} tx The updated tx to save, if it exists in the current shapeShiftTxList
+   *
+   */
   saveTx (tx) {
     const { shapeShiftTxList } = this.store.getState()
     const index = shapeShiftTxList.indexOf(tx)
@@ -129,12 +130,12 @@ class ShapeshiftController {
     }
   }
 
-	/**
-	 * Removes a ShapeShiftTx from the shapeShiftTxList
-	 *
-	 * @param {ShapeShiftTx} tx The tx to remove
-	 *
-	 */
+  /**
+   * Removes a ShapeShiftTx from the shapeShiftTxList
+   *
+   * @param {ShapeShiftTx} tx The tx to remove
+   *
+   */
   removeShapeShiftTx (tx) {
     const { shapeShiftTxList } = this.store.getState()
     const index = shapeShiftTxList.indexOf(index)
@@ -144,14 +145,14 @@ class ShapeshiftController {
     this.updateState({ shapeShiftTxList })
   }
 
-	/**
-	 * Creates a new ShapeShiftTx, adds it to the shapeShiftTxList, and initiates a new poll for updates of pending txs
-	 *
+  /**
+   * Creates a new ShapeShiftTx, adds it to the shapeShiftTxList, and initiates a new poll for updates of pending txs
+   *
    * @param {string} depositAddress - An address at which to send a crypto deposit, so that eth can be sent to the
    * user's Metamask account
    * @param {string} depositType - An abbreviation of the type of crypto currency to be deposited.
-	 *
-	 */
+   *
+   */
   createShapeShiftTx (depositAddress, depositType) {
     const state = this.store.getState()
     let { shapeShiftTxList } = state
diff --git a/app/scripts/controllers/token-rates.js b/app/scripts/controllers/token-rates.js
new file mode 100644
index 000000000..22e3e8154
--- /dev/null
+++ b/app/scripts/controllers/token-rates.js
@@ -0,0 +1,77 @@
+const ObservableStore = require('obs-store')
+
+// By default, poll every 3 minutes
+const DEFAULT_INTERVAL = 180 * 1000
+
+/**
+ * A controller that polls for token exchange
+ * rates based on a user's current token list
+ */
+class TokenRatesController {
+  /**
+   * Creates a TokenRatesController
+   *
+   * @param {Object} [config] - Options to configure controller
+   */
+  constructor ({ interval = DEFAULT_INTERVAL, preferences } = {}) {
+    this.store = new ObservableStore()
+    this.preferences = preferences
+    this.interval = interval
+  }
+
+  /**
+   * Updates exchange rates for all tokens
+   */
+  async updateExchangeRates () {
+    if (!this.isActive) { return }
+    const contractExchangeRates = {}
+    for (const i in this._tokens) {
+      const address = this._tokens[i].address
+      contractExchangeRates[address] = await this.fetchExchangeRate(address)
+    }
+    this.store.putState({ contractExchangeRates })
+  }
+
+  /**
+   * Fetches a token exchange rate by address
+   *
+   * @param {String} address - Token contract address
+   */
+  async fetchExchangeRate (address) {
+    try {
+      const response = await fetch(`https://exchanges.balanc3.net/prices?from=${address}&to=ETH&autoConversion=false&summaryOnly=true`)
+      const json = await response.json()
+      return json && json.length ? json[0].averagePrice : 0
+    } catch (error) { }
+  }
+
+  /**
+   * @type {Number} - Interval used to poll for exchange rates
+   */
+  set interval (interval) {
+    this._handle && clearInterval(this._handle)
+    if (!interval) { return }
+    this._handle = setInterval(() => { this.updateExchangeRates() }, interval)
+  }
+
+  /**
+   * @type {Object} - Preferences controller instance
+   */
+  set preferences (preferences) {
+    this._preferences && this._preferences.unsubscribe()
+    if (!preferences) { return }
+    this._preferences = preferences
+    this.tokens = preferences.getState().tokens
+    preferences.subscribe(({ tokens = [] }) => { this.tokens = tokens })
+  }
+
+  /**
+   * @type {Array} - Array of token objects with contract addresses
+   */
+  set tokens (tokens) {
+    this._tokens = tokens
+    this.updateExchangeRates()
+  }
+}
+
+module.exports = TokenRatesController
diff --git a/app/scripts/controllers/transactions.js b/app/scripts/controllers/transactions.js
index 336b0d8f7..c8211ebd7 100644
--- a/app/scripts/controllers/transactions.js
+++ b/app/scripts/controllers/transactions.js
@@ -7,6 +7,7 @@ const TransactionStateManager = require('../lib/tx-state-manager')
 const TxGasUtil = require('../lib/tx-gas-utils')
 const PendingTransactionTracker = require('../lib/pending-tx-tracker')
 const NonceTracker = require('../lib/nonce-tracker')
+const log = require('loglevel')
 
 /*
   Transaction Controller is an aggregate of sub-controllers and trackers