@metamask-previews/keyring-controller 19.0.3-preview-183f0b5a → 19.0.3-preview-4c4eb52a

package/dist/KeyringController.cjs

@@ -36,7 +36,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
-var _KeyringController_instances, _KeyringController_controllerOperationMutex, _KeyringController_vaultOperationMutex, _KeyringController_keyringBuilders, _KeyringController_keyrings, _KeyringController_unsupportedKeyrings, _KeyringController_password, _KeyringController_encryptor, _KeyringController_cacheEncryptionKey, _KeyringController_qrKeyringStateListener, _KeyringController_registerMessageHandlers, _KeyringController_getKeyringById, _KeyringController_getKeyringBuilderForType, _KeyringController_addQRKeyring, _KeyringController_subscribeToQRKeyringEvents, _KeyringController_unsubscribeFromQRKeyringsEvents, _KeyringController_createNewVaultWithKeyring, _KeyringController_verifySeedPhrase, _KeyringController_getUpdatedKeyrings, _KeyringController_getSerializedKeyrings, _KeyringController_restoreSerializedKeyrings, _KeyringController_unlockKeyrings, _KeyringController_updateVault, _KeyringController_getAccountsFromKeyrings, _KeyringController_createKeyringWithFirstAccount, _KeyringController_newKeyring, _KeyringController_clearKeyrings, _KeyringController_restoreKeyring, _KeyringController_destroyKeyring, _KeyringController_removeEmptyKeyrings, _KeyringController_checkForDuplicate, _KeyringController_setUnlocked, _KeyringController_persistOrRollback, _KeyringController_withRollback, _KeyringController_assertControllerMutexIsLocked, _KeyringController_withControllerLock, _KeyringController_withVaultLock;
+var _KeyringController_instances, _KeyringController_controllerOperationMutex, _KeyringController_vaultOperationMutex, _KeyringController_keyringBuilders, _KeyringController_keyrings, _KeyringController_keyringsMetadata, _KeyringController_unsupportedKeyrings, _KeyringController_password, _KeyringController_encryptor, _KeyringController_cacheEncryptionKey, _KeyringController_qrKeyringStateListener, _KeyringController_registerMessageHandlers, _KeyringController_getKeyringById, _KeyringController_getKeyringBuilderForType, _KeyringController_addQRKeyring, _KeyringController_subscribeToQRKeyringEvents, _KeyringController_unsubscribeFromQRKeyringsEvents, _KeyringController_createNewVaultWithKeyring, _KeyringController_verifySeedPhrase, _KeyringController_getUpdatedKeyrings, _KeyringController_getSerializedKeyrings, _KeyringController_restoreSerializedKeyrings, _KeyringController_unlockKeyrings, _KeyringController_updateVault, _KeyringController_getAccountsFromKeyrings, _KeyringController_createKeyringWithFirstAccount, _KeyringController_newKeyring, _KeyringController_clearKeyrings, _KeyringController_restoreKeyring, _KeyringController_destroyKeyring, _KeyringController_removeEmptyKeyrings, _KeyringController_checkForDuplicate, _KeyringController_setUnlocked, _KeyringController_persistOrRollback, _KeyringController_withRollback, _KeyringController_assertControllerMutexIsLocked, _KeyringController_withControllerLock, _KeyringController_withVaultLock;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.KeyringController = exports.getDefaultKeyringState = exports.keyringBuilderFactory = exports.SignTypedDataVersion = exports.AccountImportStrategy = exports.isCustodyKeyring = exports.KeyringTypes = void 0;
 const util_1 = require("@ethereumjs/util");
@@ -48,11 +48,10 @@ 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"));
-const constants_1 = require("./constants.cjs");
 // 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 ulid_1 = require("ulid");
+const constants_1 = require("./constants.cjs");
+const ulid = (0, ulid_1.monotonicFactory)();
 const name = 'KeyringController';
 /**
  * Available keyring types
@@ -283,6 +282,7 @@ class KeyringController extends base_controller_1.BaseController {
         _KeyringController_vaultOperationMutex.set(this, new async_mutex_1.Mutex());
         _KeyringController_keyringBuilders.set(this, void 0);
         _KeyringController_keyrings.set(this, void 0);
+        _KeyringController_keyringsMetadata.set(this, void 0);
         _KeyringController_unsupportedKeyrings.set(this, void 0);
         _KeyringController_password.set(this, void 0);
         _KeyringController_encryptor.set(this, void 0);
@@ -293,6 +293,7 @@ class KeyringController extends base_controller_1.BaseController {
             : defaultKeyringBuilders, "f");
         __classPrivateFieldSet(this, _KeyringController_encryptor, encryptor, "f");
         __classPrivateFieldSet(this, _KeyringController_keyrings, [], "f");
+        __classPrivateFieldSet(this, _KeyringController_keyringsMetadata, state?.keyringsMetadata ?? [], "f");
         __classPrivateFieldSet(this, _KeyringController_unsupportedKeyrings, [], "f");
         // This option allows the controller to cache an exported key
         // for use in decrypting and encrypting data without password
@@ -312,6 +313,9 @@ class KeyringController extends base_controller_1.BaseController {
     async addNewAccount(accountCount) {
         return __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_persistOrRollback).call(this, async () => {
             const selectedKeyring = this.getKeyringsByType('HD Key Tree')[0];
+            if (!selectedKeyring) {
+                throw new Error('No HD keyring found');
+            }
             const oldAccounts = await selectedKeyring.getAccounts();
             if (accountCount && oldAccounts.length !== accountCount) {
                 if (accountCount > oldAccounts.length) {
@@ -853,10 +857,18 @@ 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);
+        let keyring;
+        if (!keyringId) {
+            keyring = __classPrivateFieldGet(this, _KeyringController_keyrings, "f")[0];
+        }
+        else {
+            keyring = __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_getKeyringById).call(this, keyringId);
+            if (keyring.type !== KeyringTypes.hd) {
+                throw new Error(constants_1.KeyringControllerError.UnsupportedVerifySeedPhrase);
+            }
+        }
+        if (!keyring) {
+            throw new Error(constants_1.KeyringControllerError.NoHdKeyring);
         }
         return __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_withControllerLock).call(this, async () => __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_verifySeedPhrase).call(this, keyringId));
     }
@@ -1076,7 +1088,7 @@ class KeyringController extends base_controller_1.BaseController {
     }
 }
 exports.KeyringController = KeyringController;
-_KeyringController_controllerOperationMutex = new WeakMap(), _KeyringController_vaultOperationMutex = new WeakMap(), _KeyringController_keyringBuilders = new WeakMap(), _KeyringController_keyrings = new WeakMap(), _KeyringController_unsupportedKeyrings = new WeakMap(), _KeyringController_password = new WeakMap(), _KeyringController_encryptor = new WeakMap(), _KeyringController_cacheEncryptionKey = new WeakMap(), _KeyringController_qrKeyringStateListener = new WeakMap(), _KeyringController_instances = new WeakSet(), _KeyringController_registerMessageHandlers = function _KeyringController_registerMessageHandlers() {
+_KeyringController_controllerOperationMutex = new WeakMap(), _KeyringController_vaultOperationMutex = new WeakMap(), _KeyringController_keyringBuilders = new WeakMap(), _KeyringController_keyrings = new WeakMap(), _KeyringController_keyringsMetadata = new WeakMap(), _KeyringController_unsupportedKeyrings = new WeakMap(), _KeyringController_password = new WeakMap(), _KeyringController_encryptor = new WeakMap(), _KeyringController_cacheEncryptionKey = new WeakMap(), _KeyringController_qrKeyringStateListener = new WeakMap(), _KeyringController_instances = new WeakSet(), _KeyringController_registerMessageHandlers = function _KeyringController_registerMessageHandlers() {
     this.messagingSystem.registerActionHandler(`${name}:signMessage`, this.signMessage.bind(this));
     this.messagingSystem.registerActionHandler(`${name}:signPersonalMessage`, this.signPersonalMessage.bind(this));
     this.messagingSystem.registerActionHandler(`${name}:signTypedMessage`, this.signTypedMessage.bind(this));
@@ -1162,9 +1174,6 @@ 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();
@@ -1237,11 +1246,8 @@ async function _KeyringController_restoreSerializedKeyrings(serializedKeyrings)
     for (const serializedKeyring of serializedKeyrings) {
         await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_restoreKeyring).call(this, serializedKeyring);
     }
-    if (this.state.keyringsMetadata.length > __classPrivateFieldGet(this, _KeyringController_keyrings, "f").length) {
-        this.update((state) => {
-            // remove metadata from the end of the array to have the same length as the keyrings array
-            state.keyringsMetadata = state.keyringsMetadata.slice(0, -1 * (state.keyringsMetadata.length - __classPrivateFieldGet(this, _KeyringController_keyrings, "f").length));
-        });
+    if (__classPrivateFieldGet(this, _KeyringController_keyringsMetadata, "f").length > __classPrivateFieldGet(this, _KeyringController_keyrings, "f").length) {
+        throw new Error(constants_1.KeyringControllerError.KeyringMetadataLengthMismatch);
     }
 }, _KeyringController_unlockKeyrings = 
 /**
@@ -1356,12 +1362,13 @@ async function _KeyringController_unlockKeyrings(password, encryptionKey, encryp
         this.update((state) => {
             state.vault = updatedState.vault;
             state.keyrings = updatedKeyrings;
+            state.keyringsMetadata = __classPrivateFieldGet(this, _KeyringController_keyringsMetadata, "f");
             if (updatedState.encryptionKey) {
                 state.encryptionKey = updatedState.encryptionKey;
                 state.encryptionSalt = JSON.parse(updatedState.vault).salt;
             }
-            if (updatedKeyrings.length < state.keyringsMetadata.length) {
-                state.keyringsMetadata = state.keyringsMetadata.slice(0, -1 * (state.keyringsMetadata.length - updatedKeyrings.length));
+            if (updatedKeyrings.length < __classPrivateFieldGet(this, _KeyringController_keyringsMetadata, "f").length) {
+                throw new Error(constants_1.KeyringControllerError.KeyringMetadataLengthMismatch);
             }
         });
         return true;
@@ -1412,7 +1419,10 @@ async function _KeyringController_createKeyringWithFirstAccount(type, opts) {
  */
 async function _KeyringController_newKeyring(type, data) {
     __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertControllerMutexIsLocked).call(this);
-    const newKeyringMetadata = { id: ulid(), name: '' };
+    const newKeyringMetadata = {
+        id: ulid().toString(),
+        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}`);
@@ -1444,13 +1454,8 @@ async function _KeyringController_newKeyring(type, data) {
     }
     __classPrivateFieldGet(this, _KeyringController_keyrings, "f").push(keyring);
     if (newKeyringMetadata &&
-        this.state.keyringsMetadata.length < __classPrivateFieldGet(this, _KeyringController_keyrings, "f").length) {
-        this.update((state) => {
-            state.keyringsMetadata = [
-                ...state.keyringsMetadata,
-                newKeyringMetadata,
-            ];
-        });
+        __classPrivateFieldGet(this, _KeyringController_keyringsMetadata, "f").length < __classPrivateFieldGet(this, _KeyringController_keyrings, "f").length) {
+        __classPrivateFieldSet(this, _KeyringController_keyringsMetadata, [...__classPrivateFieldGet(this, _KeyringController_keyringsMetadata, "f"), newKeyringMetadata], "f");
     }
     return keyring;
 }, _KeyringController_clearKeyrings = 
@@ -1464,9 +1469,10 @@ 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 = [];
-    });
+    __classPrivateFieldSet(this, _KeyringController_keyringsMetadata, [], "f");
+    // this.update((state) => {
+    //   state.keyringsMetadata = [];
+    // });
 }, _KeyringController_restoreKeyring = 
 /**
  * Restore a Keyring from a provided serialized payload.
@@ -1522,9 +1528,7 @@ async function _KeyringController_removeEmptyKeyrings() {
         }
     }));
     __classPrivateFieldSet(this, _KeyringController_keyrings, validKeyrings, "f");
-    this.update((state) => {
-        state.keyringsMetadata = validKeyringMetadata;
-    });
+    __classPrivateFieldSet(this, _KeyringController_keyringsMetadata, validKeyringMetadata, "f");
 }, _KeyringController_checkForDuplicate = 
 /**
  * Checks for duplicate keypairs, using the the first account in the given