Improve Keyring organization

Separated public & private methods. (Fixes #845)
Made class method `type()` into a simple property. (Fixes #846)

app/scripts/keyring-controller.js

@@ -67,7 +67,7 @@ module.exports = class KeyringController extends EventEmitter {
       currentFiat: this.configManager.getCurrentFiat(),
       conversionRate: this.configManager.getConversionRate(),
       conversionDate: this.configManager.getConversionDate(),
-      keyringTypes: this.keyringTypes.map((krt) => krt.type()),
+      keyringTypes: this.keyringTypes.map(krt => krt.type),
       identities: this.identities,
     }
   }
@@ -312,7 +312,7 @@ module.exports = class KeyringController extends EventEmitter {
 
   getKeyringClassForType (type) {
     const Keyring = this.keyringTypes.reduce((res, kr) => {
-      if (kr.type() === type) {
+      if (kr.type === type) {
         return kr
       } else {
         return res

app/scripts/keyrings/hd.js

@@ -2,17 +2,17 @@ const EventEmitter = require('events').EventEmitter
 const hdkey = require('ethereumjs-wallet/hdkey')
 const bip39 = require('bip39')
 const ethUtil = require('ethereumjs-util')
+
+// *Internal Deps
 const sigUtil = require('../lib/sig-util')
 
+// Options:
+const hdPathString = `m/44'/60'/0'/0`
 const type = 'HD Key Tree'
 
-const hdPathString = `m/44'/60'/0'/0`
+class HdKeyring extends EventEmitter {
 
-module.exports = class HdKeyring extends EventEmitter {
-
-  static type () {
-    return type
-  }
+  /* PUBLIC METHODS */
 
   constructor (opts = {}) {
     super()
@@ -20,28 +20,6 @@ module.exports = class HdKeyring extends EventEmitter {
     this.deserialize(opts)
   }
 
-  deserialize (opts = {}) {
-    this.opts = opts || {}
-    this.wallets = []
-    this.mnemonic = null
-    this.root = null
-
-    if ('mnemonic' in opts) {
-      this.initFromMnemonic(opts.mnemonic)
-    }
-
-    if ('numberOfAccounts' in opts) {
-      this.addAccounts(opts.numberOfAccounts)
-    }
-  }
-
-  initFromMnemonic (mnemonic) {
-    this.mnemonic = mnemonic
-    const seed = bip39.mnemonicToSeed(mnemonic)
-    this.hdWallet = hdkey.fromMasterSeed(seed)
-    this.root = this.hdWallet.derivePath(hdPathString)
-  }
-
   serialize () {
     return {
       mnemonic: this.mnemonic,
@@ -49,14 +27,24 @@ module.exports = class HdKeyring extends EventEmitter {
     }
   }
 
-  exportAccount (address) {
-    const wallet = this.getWalletForAccount(address)
-    return wallet.getPrivateKey().toString('hex')
+  deserialize (opts = {}) {
+    this.opts = opts || {}
+    this.wallets = []
+    this.mnemonic = null
+    this.root = null
+
+    if ('mnemonic' in opts) {
+      this._initFromMnemonic(opts.mnemonic)
+    }
+
+    if ('numberOfAccounts' in opts) {
+      this.addAccounts(opts.numberOfAccounts)
+    }
   }
 
   addAccounts (numberOfAccounts = 1) {
     if (!this.root) {
-      this.initFromMnemonic(bip39.generateMnemonic())
+      this._initFromMnemonic(bip39.generateMnemonic())
     }
 
     const oldLen = this.wallets.length
@@ -76,7 +64,7 @@ module.exports = class HdKeyring extends EventEmitter {
 
   // tx is an instance of the ethereumjs-transaction class.
   signTransaction (address, tx) {
-    const wallet = this.getWalletForAccount(address)
+    const wallet = this._getWalletForAccount(address)
     var privKey = wallet.getPrivateKey()
     tx.sign(privKey)
     return tx
@@ -84,7 +72,7 @@ module.exports = class HdKeyring extends EventEmitter {
 
   // For eth_sign, we need to sign transactions:
   signMessage (withAccount, data) {
-    const wallet = this.getWalletForAccount(withAccount)
+    const wallet = this._getWalletForAccount(withAccount)
     const message = ethUtil.removeHexPrefix(data)
     var privKey = wallet.getPrivateKey()
     var msgSig = ethUtil.ecsign(new Buffer(message, 'hex'), privKey)
@@ -92,10 +80,29 @@ module.exports = class HdKeyring extends EventEmitter {
     return rawMsgSig
   }
 
-  getWalletForAccount (account) {
+  exportAccount (address) {
+    const wallet = this._getWalletForAccount(address)
+    return wallet.getPrivateKey().toString('hex')
+  }
+
+
+  /* PRIVATE METHODS */
+
+  _initFromMnemonic (mnemonic) {
+    this.mnemonic = mnemonic
+    const seed = bip39.mnemonicToSeed(mnemonic)
+    this.hdWallet = hdkey.fromMasterSeed(seed)
+    this.root = this.hdWallet.derivePath(hdPathString)
+  }
+
+
+  _getWalletForAccount (account) {
     return this.wallets.find((w) => {
       const address = w.getAddress().toString('hex')
       return ((address === account) || (sigUtil.normalize(address) === account))
     })
   }
 }
+
+HdKeyring.type = type
+module.exports = HdKeyring

app/scripts/keyrings/simple.js

@@ -4,7 +4,9 @@ const ethUtil = require('ethereumjs-util')
 const type = 'Simple Key Pair'
 const sigUtil = require('../lib/sig-util')
 
-module.exports = class SimpleKeyring extends EventEmitter {
+class SimpleKeyring extends EventEmitter {
+
+  /* PUBLIC METHODS */
 
   static type () {
     return type
@@ -44,7 +46,7 @@ module.exports = class SimpleKeyring extends EventEmitter {
 
   // tx is an instance of the ethereumjs-transaction class.
   signTransaction (address, tx) {
-    const wallet = this.getWalletForAccount(address)
+    const wallet = this._getWalletForAccount(address)
     var privKey = wallet.getPrivateKey()
     tx.sign(privKey)
     return tx
@@ -52,7 +54,7 @@ module.exports = class SimpleKeyring extends EventEmitter {
 
   // For eth_sign, we need to sign transactions:
   signMessage (withAccount, data) {
-    const wallet = this.getWalletForAccount(withAccount)
+    const wallet = this._getWalletForAccount(withAccount)
     const message = ethUtil.removeHexPrefix(data)
     var privKey = wallet.getPrivateKey()
     var msgSig = ethUtil.ecsign(new Buffer(message, 'hex'), privKey)
@@ -60,8 +62,19 @@ module.exports = class SimpleKeyring extends EventEmitter {
     return rawMsgSig
   }
 
-  getWalletForAccount (account) {
+  exportAccount (address) {
+    const wallet = this._getWalletForAccount(address)
+    return wallet.getPrivateKey().toString('hex')
+  }
+
+
+  /* PRIVATE METHODS */
+
+  _getWalletForAccount (account) {
     return this.wallets.find(w => w.getAddress().toString('hex') === account)
   }
 
 }
+
+SimpleKeyring.type = type
+module.exports = SimpleKeyring

test/unit/keyrings/hd-test.js

@@ -27,9 +27,9 @@ describe('hd-keyring', function() {
     assert.equal(accounts[1], secondAcct)
   })
 
-  describe('Keyring.type()', function() {
-    it('is a class method that returns the type string.', function() {
-      const type = HdKeyring.type()
+  describe('Keyring.type', function() {
+    it('is a class property that returns the type string.', function() {
+      const type = HdKeyring.type
       assert.equal(typeof type, 'string')
     })
   })

test/unit/keyrings/simple-test.js

@@ -13,9 +13,9 @@ describe('simple-keyring', function() {
     keyring = new SimpleKeyring()
   })
 
-  describe('Keyring.type()', function() {
-    it('is a class method that returns the type string.', function() {
-      const type = SimpleKeyring.type()
+  describe('Keyring.type', function() {
+    it('is a class property that returns the type string.', function() {
+      const type = SimpleKeyring.type
       assert.equal(type, TYPE_STR)
     })
   })