@metamask-previews/keyring-controller 14.0.1-preview-f04be62f → 15.0.0-preview-11ae513

package/dist/{chunk-6HZWCYLD.mjs → chunk-SFPZOKV2.mjs}

@@ -3,7 +3,7 @@ import {
   __privateGet,
   __privateMethod,
   __privateSet
-} from "./chunk-NAAWD7HX.mjs";
+} from "./chunk-XPARO3LL.mjs";
 
 // src/KeyringController.ts
 import { isValidPrivate, toBuffer, getBinarySize } from "@ethereumjs/util";
@@ -86,7 +86,7 @@ async function displayForKeyring(keyring) {
     accounts: accounts.map(normalize)
   };
 }
-var _keyringBuilders, _keyrings, _unsupportedKeyrings, _password, _encryptor, _cacheEncryptionKey, _qrKeyringStateListener, _registerMessageHandlers, registerMessageHandlers_fn, _getKeyringBuilderForType, getKeyringBuilderForType_fn, _addQRKeyring, addQRKeyring_fn, _subscribeToQRKeyringEvents, subscribeToQRKeyringEvents_fn, _unsubscribeFromQRKeyringsEvents, unsubscribeFromQRKeyringsEvents_fn, _createNewVaultWithKeyring, createNewVaultWithKeyring_fn, _updateKeyringsInState, updateKeyringsInState_fn, _unlockKeyrings, unlockKeyrings_fn, _createKeyringWithFirstAccount, createKeyringWithFirstAccount_fn, _newKeyring, newKeyring_fn, _clearKeyrings, clearKeyrings_fn, _restoreKeyring, restoreKeyring_fn, _destroyKeyring, destroyKeyring_fn, _removeEmptyKeyrings, removeEmptyKeyrings_fn, _checkForDuplicate, checkForDuplicate_fn, _setUnlocked, setUnlocked_fn, _getMemState, getMemState_fn;
+var _initVaultMutex, _vaultOperationMutex, _keyringBuilders, _keyrings, _unsupportedKeyrings, _password, _encryptor, _cacheEncryptionKey, _qrKeyringStateListener, _registerMessageHandlers, registerMessageHandlers_fn, _getKeyringBuilderForType, getKeyringBuilderForType_fn, _addQRKeyring, addQRKeyring_fn, _subscribeToQRKeyringEvents, subscribeToQRKeyringEvents_fn, _unsubscribeFromQRKeyringsEvents, unsubscribeFromQRKeyringsEvents_fn, _createNewVaultWithKeyring, createNewVaultWithKeyring_fn, _getUpdatedKeyrings, getUpdatedKeyrings_fn, _unlockKeyrings, unlockKeyrings_fn, _createKeyringWithFirstAccount, createKeyringWithFirstAccount_fn, _newKeyring, newKeyring_fn, _clearKeyrings, clearKeyrings_fn, _restoreKeyring, restoreKeyring_fn, _destroyKeyring, destroyKeyring_fn, _removeEmptyKeyrings, removeEmptyKeyrings_fn, _checkForDuplicate, checkForDuplicate_fn, _setUnlocked, setUnlocked_fn, _getMemState, getMemState_fn, _withVaultLock, withVaultLock_fn;
 var KeyringController = class extends BaseController {
   /**
    * Creates a KeyringController instance.
@@ -164,9 +164,12 @@ var KeyringController = class extends BaseController {
      */
     __privateAdd(this, _createNewVaultWithKeyring);
     /**
-     * Update the controller state with its current keyrings.
+     * Get the updated array of each keyring's type and
+     * accounts list.
+     *
+     * @returns A promise resolving to the updated keyrings array.
      */
-    __privateAdd(this, _updateKeyringsInState);
+    __privateAdd(this, _getUpdatedKeyrings);
     /**
      * Unlock Keyrings, decrypting the vault and deserializing all
      * keyrings contained in it, using a password or an encryption key with salt.
@@ -199,6 +202,9 @@ var KeyringController = class extends BaseController {
     /**
      * Remove all managed keyrings, destroying all their
      * instances in memory.
+     *
+     * @param options - Operations options.
+     * @param options.skipStateUpdate - Whether to skip updating the controller state.
      */
     __privateAdd(this, _clearKeyrings);
     /**
@@ -245,7 +251,20 @@ var KeyringController = class extends BaseController {
      */
     __privateAdd(this, _setUnlocked);
     __privateAdd(this, _getMemState);
-    this.mutex = new Mutex();
+    /**
+     * Lock the vault mutex before executing the given function,
+     * and release it after the function is resolved or after an
+     * error is thrown.
+     *
+     * This ensures that each operation that interacts with the vault
+     * is executed in a mutually exclusive way.
+     *
+     * @param fn - The function to execute while the vault mutex is locked.
+     * @returns The result of the function.
+     */
+    __privateAdd(this, _withVaultLock);
+    __privateAdd(this, _initVaultMutex, new Mutex());
+    __privateAdd(this, _vaultOperationMutex, new Mutex());
     __privateAdd(this, _keyringBuilders, void 0);
     __privateAdd(this, _keyrings, void 0);
     __privateAdd(this, _unsupportedKeyrings, void 0);
@@ -276,15 +295,18 @@ var KeyringController = class extends BaseController {
     if (!primaryKeyring) {
       throw new Error("No HD keyring found");
     }
-    const oldAccounts = await this.getAccounts();
+    const oldAccounts = await primaryKeyring.getAccounts();
     if (accountCount && oldAccounts.length !== accountCount) {
       if (accountCount > oldAccounts.length) {
         throw new Error("Account out of sequence");
       }
-      const primaryKeyringAccounts = await primaryKeyring.getAccounts();
+      const existingAccount = oldAccounts[accountCount];
+      if (!existingAccount) {
+        throw new Error(`Can't find account at index ${accountCount}`);
+      }
       return {
         keyringState: __privateMethod(this, _getMemState, getMemState_fn).call(this),
-        addedAccountAddress: primaryKeyringAccounts[accountCount]
+        addedAccountAddress: existingAccount
       };
     }
     const addedAccountAddress = await this.addNewAccountForKeyring(
@@ -346,7 +368,7 @@ var KeyringController = class extends BaseController {
    * @returns Promise resolving to the restored keychain object.
    */
   async createNewVaultAndRestore(password, seed) {
-    const releaseLock = await this.mutex.acquire();
+    const releaseLock = await __privateGet(this, _initVaultMutex).acquire();
     if (!password || !password.length) {
       throw new Error("Invalid password");
     }
@@ -370,7 +392,7 @@ var KeyringController = class extends BaseController {
    * @returns Newly-created keychain object.
    */
   async createNewVaultAndKeychain(password) {
-    const releaseLock = await this.mutex.acquire();
+    const releaseLock = await __privateGet(this, _initVaultMutex).acquire();
     try {
       const accounts = await this.getAccounts();
       if (!accounts.length) {
@@ -460,7 +482,7 @@ var KeyringController = class extends BaseController {
     return await keyring.exportAccount(normalize(address));
   }
   /**
-   * Returns the public addresses of all accounts for the current keyring.
+   * Returns the public addresses of all accounts from every keyring.
    *
    * @returns A promise resolving to an array of addresses.
    */
@@ -565,60 +587,66 @@ var KeyringController = class extends BaseController {
    * operation completes.
    */
   async persistAllKeyrings() {
-    const { encryptionKey, encryptionSalt } = this.state;
-    if (!__privateGet(this, _password) && !encryptionKey) {
-      throw new Error("KeyringController - Cannot persist vault without password and encryption key" /* MissingCredentials */);
-    }
-    const serializedKeyrings = await Promise.all(
-      __privateGet(this, _keyrings).map(async (keyring) => {
-        const [type, data] = await Promise.all([
-          keyring.type,
-          keyring.serialize()
-        ]);
-        return { type, data };
-      })
-    );
-    serializedKeyrings.push(...__privateGet(this, _unsupportedKeyrings));
-    let vault;
-    let newEncryptionKey;
-    if (__privateGet(this, _cacheEncryptionKey)) {
-      assertIsExportableKeyEncryptor(__privateGet(this, _encryptor));
-      if (encryptionKey) {
-        const key = await __privateGet(this, _encryptor).importKey(encryptionKey);
-        const vaultJSON = await __privateGet(this, _encryptor).encryptWithKey(
-          key,
-          serializedKeyrings
-        );
-        vaultJSON.salt = encryptionSalt;
-        vault = JSON.stringify(vaultJSON);
-      } else if (__privateGet(this, _password)) {
-        const { vault: newVault, exportedKeyString } = await __privateGet(this, _encryptor).encryptWithDetail(
+    return __privateMethod(this, _withVaultLock, withVaultLock_fn).call(this, async () => {
+      const { encryptionKey, encryptionSalt } = this.state;
+      if (!__privateGet(this, _password) && !encryptionKey) {
+        throw new Error("KeyringController - Cannot persist vault without password and encryption key" /* MissingCredentials */);
+      }
+      const serializedKeyrings = await Promise.all(
+        __privateGet(this, _keyrings).map(async (keyring) => {
+          const [type, data] = await Promise.all([
+            keyring.type,
+            keyring.serialize()
+          ]);
+          return { type, data };
+        })
+      );
+      serializedKeyrings.push(...__privateGet(this, _unsupportedKeyrings));
+      if (!serializedKeyrings.some((keyring) => keyring.type === "HD Key Tree" /* hd */)) {
+        throw new Error("KeyringController - No HD Keyring found" /* NoHdKeyring */);
+      }
+      const updatedState = {};
+      if (__privateGet(this, _cacheEncryptionKey)) {
+        assertIsExportableKeyEncryptor(__privateGet(this, _encryptor));
+        if (encryptionKey) {
+          const key = await __privateGet(this, _encryptor).importKey(encryptionKey);
+          const vaultJSON = await __privateGet(this, _encryptor).encryptWithKey(
+            key,
+            serializedKeyrings
+          );
+          vaultJSON.salt = encryptionSalt;
+          updatedState.vault = JSON.stringify(vaultJSON);
+        } else if (__privateGet(this, _password)) {
+          const { vault: newVault, exportedKeyString } = await __privateGet(this, _encryptor).encryptWithDetail(
+            __privateGet(this, _password),
+            serializedKeyrings
+          );
+          updatedState.vault = newVault;
+          updatedState.encryptionKey = exportedKeyString;
+        }
+      } else {
+        if (typeof __privateGet(this, _password) !== "string") {
+          throw new TypeError("KeyringController - Password must be of type string." /* WrongPasswordType */);
+        }
+        updatedState.vault = await __privateGet(this, _encryptor).encrypt(
           __privateGet(this, _password),
           serializedKeyrings
         );
-        vault = newVault;
-        newEncryptionKey = exportedKeyString;
       }
-    } else {
-      if (typeof __privateGet(this, _password) !== "string") {
-        throw new TypeError("KeyringController - Password must be of type string." /* WrongPasswordType */);
+      if (!updatedState.vault) {
+        throw new Error("KeyringController - Cannot persist vault without vault information" /* MissingVaultData */);
       }
-      vault = await __privateGet(this, _encryptor).encrypt(__privateGet(this, _password), serializedKeyrings);
-    }
-    if (!vault) {
-      throw new Error("KeyringController - Cannot persist vault without vault information" /* MissingVaultData */);
-    }
-    this.update((state) => {
-      state.vault = vault;
-    });
-    await __privateMethod(this, _updateKeyringsInState, updateKeyringsInState_fn).call(this);
-    if (newEncryptionKey) {
+      const updatedKeyrings = await __privateMethod(this, _getUpdatedKeyrings, getUpdatedKeyrings_fn).call(this);
       this.update((state) => {
-        state.encryptionKey = newEncryptionKey;
-        state.encryptionSalt = JSON.parse(vault).salt;
+        state.vault = updatedState.vault;
+        state.keyrings = updatedKeyrings;
+        if (updatedState.encryptionKey) {
+          state.encryptionKey = updatedState.encryptionKey;
+          state.encryptionSalt = JSON.parse(updatedState.vault).salt;
+        }
       });
-    }
-    return true;
+      return true;
+    });
   }
   /**
    * Imports an account with the specified import strategy.
@@ -803,9 +831,10 @@ var KeyringController = class extends BaseController {
    *
    * @param from - Address of the sender.
    * @param transactions - Base transactions to include in the UserOperation.
+   * @param executionContext - The execution context to use for the UserOperation.
    * @returns A pseudo-UserOperation that can be used to construct a real.
    */
-  async prepareUserOperation(from, transactions) {
+  async prepareUserOperation(from, transactions, executionContext) {
     const address = normalize(from);
     const keyring = await this.getKeyringForAccount(
       address
@@ -813,7 +842,11 @@ var KeyringController = class extends BaseController {
     if (!keyring.prepareUserOperation) {
       throw new Error("KeyringController - The keyring for the current address does not support the method prepareUserOperation." /* UnsupportedPrepareUserOperation */);
     }
-    return await keyring.prepareUserOperation(address, transactions);
+    return await keyring.prepareUserOperation(
+      address,
+      transactions,
+      executionContext
+    );
   }
   /**
    * Patches properties of a UserOperation. Currently, only the
@@ -821,9 +854,10 @@ var KeyringController = class extends BaseController {
    *
    * @param from - Address of the sender.
    * @param userOp - UserOperation to patch.
+   * @param executionContext - The execution context to use for the UserOperation.
    * @returns A patch to apply to the UserOperation.
    */
-  async patchUserOperation(from, userOp) {
+  async patchUserOperation(from, userOp, executionContext) {
     const address = normalize(from);
     const keyring = await this.getKeyringForAccount(
       address
@@ -831,16 +865,17 @@ var KeyringController = class extends BaseController {
     if (!keyring.patchUserOperation) {
       throw new Error("KeyringController - The keyring for the current address does not support the method patchUserOperation." /* UnsupportedPatchUserOperation */);
     }
-    return await keyring.patchUserOperation(address, userOp);
+    return await keyring.patchUserOperation(address, userOp, executionContext);
   }
   /**
    * Signs an UserOperation.
    *
    * @param from - Address of the sender.
    * @param userOp - UserOperation to sign.
+   * @param executionContext - The execution context to use for the UserOperation.
    * @returns The signature of the UserOperation.
    */
-  async signUserOperation(from, userOp) {
+  async signUserOperation(from, userOp, executionContext) {
     const address = normalize(from);
     const keyring = await this.getKeyringForAccount(
       address
@@ -848,7 +883,7 @@ var KeyringController = class extends BaseController {
     if (!keyring.signUserOperation) {
       throw new Error("KeyringController - The keyring for the current address does not support the method signUserOperation." /* UnsupportedSignUserOperation */);
     }
-    return await keyring.signUserOperation(address, userOp);
+    return await keyring.signUserOperation(address, userOp, executionContext);
   }
   /**
    * Attempts to decrypt the current vault and load its keyrings,
@@ -1011,6 +1046,8 @@ var KeyringController = class extends BaseController {
     return { removedAccounts, remainingAccounts };
   }
 };
+_initVaultMutex = new WeakMap();
+_vaultOperationMutex = new WeakMap();
 _keyringBuilders = new WeakMap();
 _keyrings = new WeakMap();
 _unsupportedKeyrings = new WeakMap();
@@ -1116,65 +1153,72 @@ createNewVaultWithKeyring_fn = async function(password, keyring) {
   __privateMethod(this, _setUnlocked, setUnlocked_fn).call(this);
   return __privateMethod(this, _getMemState, getMemState_fn).call(this);
 };
-_updateKeyringsInState = new WeakSet();
-updateKeyringsInState_fn = async function() {
-  const keyrings = await Promise.all(__privateGet(this, _keyrings).map(displayForKeyring));
-  this.update((state) => {
-    state.keyrings = keyrings;
-  });
+_getUpdatedKeyrings = new WeakSet();
+getUpdatedKeyrings_fn = async function() {
+  return Promise.all(__privateGet(this, _keyrings).map(displayForKeyring));
 };
 _unlockKeyrings = new WeakSet();
 unlockKeyrings_fn = async function(password, encryptionKey, encryptionSalt) {
-  const encryptedVault = this.state.vault;
-  if (!encryptedVault) {
-    throw new Error("KeyringController - Cannot unlock without a previous vault." /* VaultError */);
-  }
-  await __privateMethod(this, _clearKeyrings, clearKeyrings_fn).call(this);
-  let vault;
-  if (__privateGet(this, _cacheEncryptionKey)) {
-    assertIsExportableKeyEncryptor(__privateGet(this, _encryptor));
-    if (password) {
-      const result = await __privateGet(this, _encryptor).decryptWithDetail(
-        password,
-        encryptedVault
-      );
-      vault = result.vault;
-      __privateSet(this, _password, password);
-      this.update((state) => {
-        state.encryptionKey = result.exportedKeyString;
-        state.encryptionSalt = result.salt;
-      });
-    } else {
-      const parsedEncryptedVault = JSON.parse(encryptedVault);
-      if (encryptionSalt !== parsedEncryptedVault.salt) {
-        throw new Error("KeyringController - Encryption key and salt provided are expired" /* ExpiredCredentials */);
+  return __privateMethod(this, _withVaultLock, withVaultLock_fn).call(this, async ({ releaseLock }) => {
+    const encryptedVault = this.state.vault;
+    if (!encryptedVault) {
+      throw new Error("KeyringController - Cannot unlock without a previous vault." /* VaultError */);
+    }
+    await __privateMethod(this, _clearKeyrings, clearKeyrings_fn).call(this, { skipStateUpdate: true });
+    let vault;
+    const updatedState = {};
+    if (__privateGet(this, _cacheEncryptionKey)) {
+      assertIsExportableKeyEncryptor(__privateGet(this, _encryptor));
+      if (password) {
+        const result = await __privateGet(this, _encryptor).decryptWithDetail(
+          password,
+          encryptedVault
+        );
+        vault = result.vault;
+        __privateSet(this, _password, password);
+        updatedState.encryptionKey = result.exportedKeyString;
+        updatedState.encryptionSalt = result.salt;
+      } else {
+        const parsedEncryptedVault = JSON.parse(encryptedVault);
+        if (encryptionSalt !== parsedEncryptedVault.salt) {
+          throw new Error("KeyringController - Encryption key and salt provided are expired" /* ExpiredCredentials */);
+        }
+        if (typeof encryptionKey !== "string") {
+          throw new TypeError("KeyringController - Password must be of type string." /* WrongPasswordType */);
+        }
+        const key = await __privateGet(this, _encryptor).importKey(encryptionKey);
+        vault = await __privateGet(this, _encryptor).decryptWithKey(
+          key,
+          parsedEncryptedVault
+        );
+        updatedState.encryptionKey = encryptionKey;
+        updatedState.encryptionSalt = encryptionSalt;
       }
-      if (typeof encryptionKey !== "string") {
+    } else {
+      if (typeof password !== "string") {
         throw new TypeError("KeyringController - Password must be of type string." /* WrongPasswordType */);
       }
-      const key = await __privateGet(this, _encryptor).importKey(encryptionKey);
-      vault = await __privateGet(this, _encryptor).decryptWithKey(key, parsedEncryptedVault);
-      this.update((state) => {
-        state.encryptionKey = encryptionKey;
-        state.encryptionSalt = encryptionSalt;
-      });
+      vault = await __privateGet(this, _encryptor).decrypt(password, encryptedVault);
+      __privateSet(this, _password, password);
     }
-  } else {
-    if (typeof password !== "string") {
-      throw new TypeError("KeyringController - Password must be of type string." /* WrongPasswordType */);
+    if (!isSerializedKeyringsArray(vault)) {
+      throw new Error("KeyringController - The decrypted vault has an unexpected shape." /* VaultDataError */);
     }
-    vault = await __privateGet(this, _encryptor).decrypt(password, encryptedVault);
-    __privateSet(this, _password, password);
-  }
-  if (!isSerializedKeyringsArray(vault)) {
-    throw new Error("KeyringController - The decrypted vault has an unexpected shape." /* VaultDataError */);
-  }
-  await Promise.all(vault.map(__privateMethod(this, _restoreKeyring, restoreKeyring_fn).bind(this)));
-  await __privateMethod(this, _updateKeyringsInState, updateKeyringsInState_fn).call(this);
-  if (__privateGet(this, _password) && (!__privateGet(this, _cacheEncryptionKey) || !encryptionKey) && __privateGet(this, _encryptor).isVaultUpdated && !__privateGet(this, _encryptor).isVaultUpdated(encryptedVault)) {
-    await this.persistAllKeyrings();
-  }
-  return __privateGet(this, _keyrings);
+    await Promise.all(vault.map(__privateMethod(this, _restoreKeyring, restoreKeyring_fn).bind(this)));
+    const updatedKeyrings = await __privateMethod(this, _getUpdatedKeyrings, getUpdatedKeyrings_fn).call(this);
+    this.update((state) => {
+      state.keyrings = updatedKeyrings;
+      if (updatedState.encryptionKey || updatedState.encryptionSalt) {
+        state.encryptionKey = updatedState.encryptionKey;
+        state.encryptionSalt = updatedState.encryptionSalt;
+      }
+    });
+    if (__privateGet(this, _password) && (!__privateGet(this, _cacheEncryptionKey) || !encryptionKey) && __privateGet(this, _encryptor).isVaultUpdated && !__privateGet(this, _encryptor).isVaultUpdated(encryptedVault)) {
+      releaseLock();
+      await this.persistAllKeyrings();
+    }
+    return __privateGet(this, _keyrings);
+  });
 };
 _createKeyringWithFirstAccount = new WeakSet();
 createKeyringWithFirstAccount_fn = async function(type, opts) {
@@ -1200,14 +1244,16 @@ newKeyring_fn = async function(type, data) {
   return keyring;
 };
 _clearKeyrings = new WeakSet();
-clearKeyrings_fn = async function() {
+clearKeyrings_fn = async function(options = { skipStateUpdate: false }) {
   for (const keyring of __privateGet(this, _keyrings)) {
     await __privateMethod(this, _destroyKeyring, destroyKeyring_fn).call(this, keyring);
   }
   __privateSet(this, _keyrings, []);
-  this.update((state) => {
-    state.keyrings = [];
-  });
+  if (!options.skipStateUpdate) {
+    this.update((state) => {
+      state.keyrings = [];
+    });
+  }
 };
 _restoreKeyring = new WeakSet();
 restoreKeyring_fn = async function(serialized) {
@@ -1275,6 +1321,15 @@ getMemState_fn = function() {
     keyrings: this.state.keyrings
   };
 };
+_withVaultLock = new WeakSet();
+withVaultLock_fn = async function(fn) {
+  const releaseLock = await __privateGet(this, _vaultOperationMutex).acquire();
+  try {
+    return await fn({ releaseLock });
+  } finally {
+    releaseLock();
+  }
+};
 var KeyringController_default = KeyringController;
 
 export {
@@ -1287,4 +1342,4 @@ export {
   KeyringController,
   KeyringController_default
 };
-//# sourceMappingURL=chunk-6HZWCYLD.mjs.map
+//# sourceMappingURL=chunk-SFPZOKV2.mjs.map