Adds async init method to keyrings

Author: bergarces

index.js

@@ -237,11 +237,11 @@ class KeyringController extends EventEmitter {
    * @returns {Promise<Keyring>} The new keyring.
    */
   async addNewKeyring(type, opts) {
-    const Keyring = this.getKeyringClassForType(type);
-    const keyring = new Keyring(opts);
+    const keyring = await this._newKeyring(type, opts);
+
     if ((!opts || !opts.mnemonic) && type === KEYRINGS_TYPE_MAP.HD_KEYRING) {
       keyring.generateRandomMnemonic();
-      keyring.addAccounts();
+      await keyring.addAccounts();
     }
 
     const accounts = await keyring.getAccounts();
@@ -700,12 +700,12 @@ class KeyringController extends EventEmitter {
   async _restoreKeyring(serialized) {
     const { type, data } = serialized;
 
-    const Keyring = this.getKeyringClassForType(type);
-    if (!Keyring) {
+    const keyring = await this._newKeyring(type);
+    if (!keyring) {
       this._unsupportedKeyrings.push(serialized);
       return undefined;
     }
-    const keyring = new Keyring();
+
     await keyring.deserialize(data);
     // getAccounts also validates the accounts for some keyrings
     await keyring.getAccounts();
@@ -873,6 +873,22 @@ class KeyringController extends EventEmitter {
       );
     }
   }
+
+  async _newKeyring(type, data) {
+    const Keyring = this.getKeyringClassForType(type);
+
+    if (!Keyring) {
+      return undefined;
+    }
+
+    const keyring = new Keyring(data);
+
+    if (keyring.init) {
+      await keyring.init();
+    }
+
+    return keyring;
+  }
 }
 
 module.exports = KeyringController;

test/index.js

@@ -6,6 +6,7 @@ const sinon = require('sinon');
 const Wallet = require('ethereumjs-wallet').default;
 
 const KeyringController = require('..');
+const { KeyringMockWithInit } = require('./lib/mock-keyring');
 const mockEncryptor = require('./lib/mock-encryptor');
 
 const password = 'password123';
@@ -33,6 +34,7 @@ describe('KeyringController', function () {
   beforeEach(async function () {
     keyringController = new KeyringController({
       encryptor: mockEncryptor,
+      keyringTypes: [KeyringMockWithInit],
     });
 
     await keyringController.createNewVaultAndKeychain(password);
@@ -240,6 +242,23 @@ describe('KeyringController', function () {
       const allAccounts = await keyringController.getAccounts();
       expect(allAccounts).toHaveLength(3);
     });
+
+    it('should call init method if available', async function () {
+      const Keyring = keyringController.getKeyringClassForType(
+        'Keyring Mock With Init',
+      );
+
+      const initSpy = sinon.spy(Keyring.prototype, 'init');
+
+      const keyring = await keyringController.addNewKeyring(
+        'Keyring Mock With Init',
+      );
+
+      const keyringAccounts = await keyring.getAccounts();
+      expect(keyringAccounts).toHaveLength(0);
+
+      expect(initSpy.calledOnce).toBe(true);
+    });
   });
 
   describe('restoreKeyring', function () {

test/lib/mock-keyring.js

@@ -0,0 +1,19 @@
+class KeyringMockWithInit {
+  init() {
+    return Promise.resolve();
+  }
+
+  getAccounts() {
+    return [];
+  }
+
+  serialize() {
+    return Promise.resolve({});
+  }
+}
+
+KeyringMockWithInit.type = 'Keyring Mock With Init';
+
+module.exports = {
+  KeyringMockWithInit,
+};