@metamask-previews/keyring-controller 19.0.3-preview-83c8a21 → 19.0.3-preview-183f0b5a

package/dist/KeyringController.cjs

@@ -48,10 +48,11 @@ const eth_simple_keyring_1 = __importDefault(require("@metamask/eth-simple-keyri
 const utils_1 = require("@metamask/utils");
 const async_mutex_1 = require("async-mutex");
 const ethereumjs_wallet_1 = __importStar(require("ethereumjs-wallet"));
-// When generating a ULID within the same millisecond, monotonicFactory provides some guarantees regarding sort order.
-const ulid_1 = require("ulid");
 const constants_1 = require("./constants.cjs");
-const ulid = (0, ulid_1.monotonicFactory)();
+// When generating a ULID within the same millisecond, monotonicFactory provides some guarantees regarding sort order.
+// eslint-disable-next-line @typescript-eslint/no-require-imports
+const { monotonicFactory } = require("ulidx");
+const ulid = monotonicFactory();
 const name = 'KeyringController';
 /**
  * Available keyring types
@@ -305,19 +306,12 @@ class KeyringController extends base_controller_1.BaseController {
      * Adds a new account to the default (first) HD seed phrase keyring.
      *
      * @param accountCount - Number of accounts before adding a new one, used to
-     * @param keyringId - The id of the keyring to add the account to.
      * make the method idempotent.
      * @returns Promise resolving to the added account address.
      */
-    async addNewAccount(accountCount, keyringId) {
+    async addNewAccount(accountCount) {
         return __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_persistOrRollback).call(this, async () => {
-            let selectedKeyring = this.getKeyringsByType('HD Key Tree')[0];
-            if (keyringId) {
-                selectedKeyring = __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_getKeyringById).call(this, keyringId);
-            }
-            if (!selectedKeyring) {
-                throw new Error('No HD keyring found');
-            }
+            const selectedKeyring = this.getKeyringsByType('HD Key Tree')[0];
             const oldAccounts = await selectedKeyring.getAccounts();
             if (accountCount && oldAccounts.length !== accountCount) {
                 if (accountCount > oldAccounts.length) {
@@ -331,7 +325,7 @@ class KeyringController extends base_controller_1.BaseController {
                 return existingAccount;
             }
             const [addedAccountAddress] = await selectedKeyring.addAccounts(1);
-            await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_verifySeedPhrase).call(this, keyringId);
+            await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_verifySeedPhrase).call(this);
             return addedAccountAddress;
         });
     }
@@ -414,7 +408,7 @@ class KeyringController extends base_controller_1.BaseController {
         if (type === KeyringTypes.qr) {
             return this.getOrAddQRKeyring();
         }
-        return __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_persistOrRollback).call(this, async () => __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_newKeyring).call(this, type, opts, { id: ulid(), name: '' }));
+        return __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_persistOrRollback).call(this, async () => __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_newKeyring).call(this, type, opts));
     }
     /**
      * Method to verify a given password validity. Throws an
@@ -474,18 +468,9 @@ class KeyringController extends base_controller_1.BaseController {
     /**
      * Returns the public addresses of all accounts from every keyring.
      *
-     * @param keyringId - The id of the keyring to get the accounts from.
      * @returns A promise resolving to an array of addresses.
      */
-    async getAccounts(keyringId) {
-        if (keyringId) {
-            const keyringIndex = this.state.keyringsMetadata.findIndex((keyring) => keyring.id === keyringId);
-            const keyring = this.state.keyrings[keyringIndex];
-            if (!keyring) {
-                throw new Error('Keyring not found');
-            }
-            return keyring.accounts;
-        }
+    async getAccounts() {
         return this.state.keyrings.reduce((accounts, keyring) => accounts.concat(keyring.accounts), []);
     }
     /**
@@ -625,7 +610,7 @@ class KeyringController extends base_controller_1.BaseController {
             }
             const newKeyring = (await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_newKeyring).call(this, KeyringTypes.simple, [
                 privateKey,
-            ], { id: ulid(), name: '' }));
+            ]));
             const accounts = await newKeyring.getAccounts();
             return accounts[0];
         });
@@ -868,6 +853,11 @@ class KeyringController extends base_controller_1.BaseController {
      * @returns Promise resolving to the seed phrase as Uint8Array.
      */
     async verifySeedPhrase(keyringId) {
+        const keyringIndex = this.state.keyringsMetadata.findIndex((keyring) => keyring.id === keyringId);
+        const keyring = this.state.keyrings[keyringIndex];
+        if (keyring.type !== KeyringTypes.hd) {
+            throw new Error(constants_1.KeyringControllerError.UnsupportedVerifySeedPhrase);
+        }
         return __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_withControllerLock).call(this, async () => __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_verifySeedPhrase).call(this, keyringId));
     }
     async withKeyring(selector, operation, options = {
@@ -881,8 +871,7 @@ class KeyringController extends base_controller_1.BaseController {
             else if ('type' in selector) {
                 keyring = this.getKeyringsByType(selector.type)[selector.index || 0];
                 if (!keyring && options.createIfMissing) {
-                    const newMetadata = { id: ulid(), name: '' };
-                    keyring = (await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_newKeyring).call(this, selector.type, options.createWithData, newMetadata));
+                    keyring = (await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_newKeyring).call(this, selector.type, options.createWithData));
                 }
             }
             else if ('id' in selector) {
@@ -1117,10 +1106,7 @@ _KeyringController_controllerOperationMutex = new WeakMap(), _KeyringController_
 async function _KeyringController_addQRKeyring() {
     __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertControllerMutexIsLocked).call(this);
     // QRKeyring is not yet compatible with Keyring type from @metamask/utils
-    return (await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_newKeyring).call(this, KeyringTypes.qr, undefined, {
-        id: ulid(),
-        name: '',
-    }));
+    return (await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_newKeyring).call(this, KeyringTypes.qr, undefined));
 }, _KeyringController_subscribeToQRKeyringEvents = function _KeyringController_subscribeToQRKeyringEvents(qrKeyring) {
     __classPrivateFieldSet(this, _KeyringController_qrKeyringStateListener, (state) => {
         this.messagingSystem.publish(`${name}:qrKeyringStateChange`, state);
@@ -1176,6 +1162,9 @@ async function _KeyringController_verifySeedPhrase(keyringId) {
     if (!keyring) {
         throw new Error('No HD keyring found.');
     }
+    if (keyring.type !== KeyringTypes.hd) {
+        throw new Error(constants_1.KeyringControllerError.UnsupportedVerifySeedPhrase);
+    }
     assertHasUint8ArrayMnemonic(keyring);
     const seedWords = keyring.mnemonic;
     const accounts = await keyring.getAccounts();
@@ -1404,10 +1393,7 @@ async function _KeyringController_getAccountsFromKeyrings() {
  */
 async function _KeyringController_createKeyringWithFirstAccount(type, opts) {
     __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertControllerMutexIsLocked).call(this);
-    const keyring = (await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_newKeyring).call(this, type, opts, {
-        id: ulid(),
-        name: '',
-    }));
+    const keyring = (await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_newKeyring).call(this, type, opts));
     const [firstAccount] = await keyring.getAccounts();
     if (!firstAccount) {
         throw new Error(constants_1.KeyringControllerError.NoFirstAccount);
@@ -1419,15 +1405,14 @@ async function _KeyringController_createKeyringWithFirstAccount(type, opts) {
  * using the given `opts`. The keyring is built using the keyring builder
  * registered for the given `type`.
  *
- *
  * @param type - The type of keyring to add.
  * @param data - The data to restore a previously serialized keyring.
- * @param metadata - The metadata to add to the keyring.
  * @returns The new keyring.
  * @throws If the keyring includes duplicated accounts.
  */
-async function _KeyringController_newKeyring(type, data, metadata) {
+async function _KeyringController_newKeyring(type, data) {
     __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertControllerMutexIsLocked).call(this);
+    const newKeyringMetadata = { id: ulid(), name: '' };
     const keyringBuilder = __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_getKeyringBuilderForType).call(this, type);
     if (!keyringBuilder) {
         throw new Error(`${constants_1.KeyringControllerError.NoKeyringBuilder}. Keyring type: ${type}`);
@@ -1458,9 +1443,13 @@ async function _KeyringController_newKeyring(type, data, metadata) {
         __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_subscribeToQRKeyringEvents).call(this, keyring);
     }
     __classPrivateFieldGet(this, _KeyringController_keyrings, "f").push(keyring);
-    if (metadata && this.state.keyringsMetadata.length < __classPrivateFieldGet(this, _KeyringController_keyrings, "f").length) {
+    if (newKeyringMetadata &&
+        this.state.keyringsMetadata.length < __classPrivateFieldGet(this, _KeyringController_keyrings, "f").length) {
         this.update((state) => {
-            state.keyringsMetadata = [...state.keyringsMetadata, metadata];
+            state.keyringsMetadata = [
+                ...state.keyringsMetadata,
+                newKeyringMetadata,
+            ];
         });
     }
     return keyring;
@@ -1475,6 +1464,9 @@ async function _KeyringController_clearKeyrings() {
         await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_destroyKeyring).call(this, keyring);
     }
     __classPrivateFieldSet(this, _KeyringController_keyrings, [], "f");
+    this.update((state) => {
+        state.keyringsMetadata = [];
+    });
 }, _KeyringController_restoreKeyring = 
 /**
  * Restore a Keyring from a provided serialized payload.
@@ -1515,6 +1507,7 @@ async function _KeyringController_destroyKeyring(keyring) {
 async function _KeyringController_removeEmptyKeyrings() {
     __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertControllerMutexIsLocked).call(this);
     const validKeyrings = [];
+    const validKeyringMetadata = [];
     // Since getAccounts returns a Promise
     // We need to wait to hear back form each keyring
     // in order to decide which ones are now valid (accounts.length > 0)
@@ -1522,12 +1515,16 @@ async function _KeyringController_removeEmptyKeyrings() {
         const accounts = await keyring.getAccounts();
         if (accounts.length > 0) {
             validKeyrings.push(keyring);
+            validKeyringMetadata.push(this.state.keyringsMetadata[index]);
         }
         else {
             await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_destroyKeyring).call(this, keyring);
         }
     }));
     __classPrivateFieldSet(this, _KeyringController_keyrings, validKeyrings, "f");
+    this.update((state) => {
+        state.keyringsMetadata = validKeyringMetadata;
+    });
 }, _KeyringController_checkForDuplicate = 
 /**
  * Checks for duplicate keypairs, using the the first account in the given