Multi srp mvp

app/scripts/controllers/preferences-controller.test.ts

@@ -141,6 +141,12 @@ describe('preferences controller', () => {
               accounts: [firstAddress, secondAddress],
             },
           ],
+          keyringsMetadata: [
+            {
+              id: 'ULID01234567890ABCDEFGHIJKLMN',
+              name: '',
+            },
+          ],
         },
         [],
       );
@@ -186,6 +192,12 @@ describe('preferences controller', () => {
               accounts: [firstAddress, secondAddress],
             },
           ],
+          keyringsMetadata: [
+            {
+              id: 'ULID01234567890ABCDEFGHIJKLMN',
+              name: '',
+            },
+          ],
         },
         [],
       );
@@ -237,6 +249,12 @@ describe('preferences controller', () => {
               accounts: [firstAddress, secondAddress],
             },
           ],
+          keyringsMetadata: [
+            {
+              id: 'ULID01234567890ABCDEFGHIJKLMN',
+              name: '',
+            },
+          ],
         },
         [],
       );
@@ -272,6 +290,12 @@ describe('preferences controller', () => {
               accounts: [firstAddress, secondAddress],
             },
           ],
+          keyringsMetadata: [
+            {
+              id: 'ULID01234567890ABCDEFGHIJKLMN',
+              name: '',
+            },
+          ],
         },
         [],
       );
@@ -524,6 +548,12 @@ describe('preferences controller', () => {
               accounts: [firstAddress, secondAddress],
             },
           ],
+          keyringsMetadata: [
+            {
+              id: 'ULID01234567890ABCDEFGHIJKLMN',
+              name: '',
+            },
+          ],
         },
         [],
       );

app/scripts/metamask-controller.js

@@ -22,6 +22,9 @@ import { providerAsMiddleware } from '@metamask/eth-json-rpc-middleware';
 import { debounce, throttle, memoize, wrap } from 'lodash';
 import {
   KeyringController,
+  ///: BEGIN:ONLY_INCLUDE_IF(multi-srp)
+  KeyringTypes,
+  ///: END:ONLY_INCLUDE_IF
   keyringBuilderFactory,
 } from '@metamask/keyring-controller';
 import createFilterMiddleware from '@metamask/eth-json-rpc-filters';
@@ -3858,6 +3861,11 @@ export default class MetamaskController extends EventEmitter {
       setLocked: this.setLocked.bind(this),
       createNewVaultAndKeychain: this.createNewVaultAndKeychain.bind(this),
       createNewVaultAndRestore: this.createNewVaultAndRestore.bind(this),
+      ///: BEGIN:ONLY_INCLUDE_IF(multi-srp)
+      generateNewMnemonicAndAddToVault:
+        this.generateNewMnemonicAndAddToVault.bind(this),
+      addNewMnemonicToVault: this.addNewMnemonicToVault.bind(this),
+      ///: END:ONLY_INCLUDE_IF
       exportAccount: this.exportAccount.bind(this),
 
       // txController
@@ -4605,6 +4613,57 @@ export default class MetamaskController extends EventEmitter {
     }
   }
 
+  /**
+   * Adds a new mnemonic to the vault.
+   *
+   * @param {string} mnemonic
+   * @returns {object} new account address
+   */
+  ///: BEGIN:ONLY_INCLUDE_IF(multi-srp)
+  async addNewMnemonicToVault(mnemonic) {
+    const releaseLock = await this.createVaultMutex.acquire();
+    try {
+      const newKeyring = await this.keyringController.addNewKeyring(
+        KeyringTypes.hd,
+        {
+          mnemonic,
+          numberOfAccounts: 1,
+        },
+      );
+      const newAccountAddress = (await newKeyring.getAccounts())[0];
+      const account =
+        this.accountsController.getAccountByAddress(newAccountAddress);
+      this.accountsController.setSelectedAccount(account.id);
+
+      const keyringId =
+        this.keyringController.state.keyringsMetadata[
+          this.keyringController.state.keyrings.length - 1
+        ].id;
+      await this._addAccountsWithBalance(keyringId);
+
+      return newAccountAddress;
+    } finally {
+      releaseLock();
+    }
+  }
+
+  async generateNewMnemonicAndAddToVault() {
+    const releaseLock = await this.createVaultMutex.acquire();
+    try {
+      const newHdkeyring = await this.keyringController.addNewKeyring(
+        KeyringTypes.hd,
+      );
+      const newAccount = (await newHdkeyring.getAccounts())[0];
+      const account = this.accountsController.getAccountByAddress(newAccount);
+      this.accountsController.setSelectedAccount(account.id);
+
+      return newAccount;
+    } finally {
+      releaseLock();
+    }
+  }
+  ///: END:ONLY_INCLUDE_IF
+
   /**
    * Create a new Vault and restore an existent keyring.
    *
@@ -4654,11 +4713,11 @@ export default class MetamaskController extends EventEmitter {
     }
   }
 
-  async _addAccountsWithBalance() {
+  async _addAccountsWithBalance(keyringId) {
     try {
       // Scan accounts until we find an empty one
       const chainId = this.#getGlobalChainId();
-      const accounts = await this.keyringController.getAccounts();
+      const accounts = await this.keyringController.getAccounts(keyringId);
       let address = accounts[accounts.length - 1];
 
       for (let count = accounts.length; ; count++) {
@@ -4689,7 +4748,7 @@ export default class MetamaskController extends EventEmitter {
         }
 
         // This account has assets, so check the next one
-        address = await this.keyringController.addNewAccount(count);
+        address = await this.keyringController.addNewAccount(count, keyringId);
       }
     } catch (e) {
       log.warn(`Failed to add accounts with balance. Error: ${e}`);
@@ -5141,14 +5200,18 @@ export default class MetamaskController extends EventEmitter {
   /**
    * Adds a new account to the default (first) HD seed phrase Keyring.
    *
-   * @param accountCount
+   * @param {number} accountCount
+   * @param {string} keyringId
    * @returns {Promise<string>} The address of the newly-created account.
    */
-  async addNewAccount(accountCount) {
+  async addNewAccount(accountCount, keyringId) {
     const oldAccounts = await this.keyringController.getAccounts();
 
     const addedAccountAddress = await this.keyringController.addNewAccount(
       accountCount,
+      ///: BEGIN:ONLY_INCLUDE_IF(multi-srp)
+      keyringId,
+      ///: END:ONLY_INCLUDE_IF
     );
 
     if (!oldAccounts.includes(addedAccountAddress)) {
@@ -5166,12 +5229,13 @@ export default class MetamaskController extends EventEmitter {
    * Called when the first account is created and on unlocking the vault.
    *
    * @param password
+   * @param keyringId - This is the identifier for the hd keyring.
    * @returns {Promise<number[]>} The seed phrase to be confirmed by the user,
    * encoded as an array of UTF-8 bytes.
    */
-  async getSeedPhrase(password) {
+  async getSeedPhrase(password, keyringId) {
     return this._convertEnglishWordlistIndicesToCodepoints(
-      await this.keyringController.exportSeedPhrase(password),
+      await this.keyringController.exportSeedPhrase(password, keyringId),
     );
   }
 

app/scripts/metamask-controller.test.js

@@ -958,6 +958,8 @@ describe('MetaMaskController', () => {
 
       describe('forgetDevice', () => {
         it('should throw if it receives an unknown device name', async () => {
+          // mock keyringController.update
+          jest.spyOn(metamaskController.keyringController, 'update');
           const result = metamaskController.forgetDevice(
             'Some random device name',
           );

builds.yml

@@ -65,6 +65,7 @@ buildTypes:
       - build-flask
       - keyring-snaps
       - solana
+      - multi-srp
     env:
       - INFURA_FLASK_PROJECT_ID
       - SEGMENT_FLASK_WRITE_KEY
@@ -139,6 +140,9 @@ features:
   solana:
     assets:
       - ./{app,shared,ui}/**/solana/**
+  multi-srp:
+    assets:
+      - ./{app,shared,ui}/**/multi-srp/**
 
 # Env variables that are required for all types of builds
 #

package.json

@@ -314,7 +314,7 @@
     "@metamask/json-rpc-engine": "^10.0.0",
     "@metamask/json-rpc-middleware-stream": "^8.0.4",
     "@metamask/keyring-api": "^12.0.0",
-    "@metamask/keyring-controller": "^19.0.2",
+    "@metamask/keyring-controller": "npm:@metamask-previews/keyring-controller@19.0.3-preview-83c8a21",
     "@metamask/keyring-internal-api": "^1.0.0",
     "@metamask/keyring-snap-client": "^1.0.0",
     "@metamask/logging-controller": "^6.0.0",

test/data/mock-send-state.json

@@ -269,6 +269,20 @@
         "accounts": ["0xeb9e64b93097bc15f01f13eae97015c57ab64823"]
       }
     ],
+    "keyringsMetadata": [
+      {
+        "id": "ULID01234567890ABCDEFGHIJKLMN",
+        "name": ""
+      },
+      {
+        "id": "ULID01234567890ABCDEFGHIJKLMN",
+        "name": ""
+      },
+      {
+        "id": "ULID01234567890ABCDEFGHIJKLMN",
+        "name": ""
+      }
+    ],
     "identities": {
       "0x0dcd5d886577d5081b0c52e242ef29e70be3e7bc": {
         "address": "0x0dcd5d886577d5081b0c52e242ef29e70be3e7bc",

test/data/mock-state.json

@@ -619,6 +619,28 @@
         "accounts": ["0xca8f1F0245530118D0cf14a06b01Daf8f76Cf281"]
       }
     ],
+    "keyringsMetadata": [
+      {
+        "id": "ULID01234567890ABCDEFGHIJKLMN",
+        "name": ""
+      },
+      {
+        "id": "ULID01234567890ABCDEFGHIJKLMN",
+        "name": ""
+      },
+      {
+        "id": "ULID01234567890ABCDEFGHIJKLMN",
+        "name": ""
+      },
+      {
+        "id": "ULID01234567890ABCDEFGHIJKLMN",
+        "name": ""
+      },
+      {
+        "id": "ULID01234567890ABCDEFGHIJKLMN",
+        "name": ""
+      }
+    ],
     "identities": {
       "0x0dcd5d886577d5081b0c52e242ef29e70be3e7bc": {
         "address": "0x0dcd5d886577d5081b0c52e242ef29e70be3e7bc",

test/jest/mock-store.js

@@ -365,6 +365,16 @@ export const createSwapsMockStore = () => {
           accounts: ['0xd85a4b6a394794842887b8284293d69163007bbb'],
         },
       ],
+      keyringsMetadata: [
+        {
+          id: 'ULID01234567890ABCDEFGHIJKLMN',
+          name: '',
+        },
+        {
+          id: 'ULID01234567890ABCDEFGHIJKLMN',
+          name: '',
+        },
+      ],
       ...mockNetworkState({
         chainId: CHAIN_IDS.MAINNET,
         ticker: CURRENCY_SYMBOLS.ETH,