@metamask-previews/keyring-controller 24.0.0-preview-2e88eaea → 24.0.0-preview-b289ac1c

package/dist/KeyringController.cjs

@@ -850,7 +850,7 @@ class KeyringController extends base_controller_1.BaseController {
         return __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_persistOrRollback).call(this, async () => {
             assertIsValidPassword(password);
             await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_deriveEncryptionKey).call(this, password, {
-                useVaultKeyMetadata: false,
+                ignoreExistingVault: false,
             });
         });
     }
@@ -922,7 +922,7 @@ class KeyringController extends base_controller_1.BaseController {
                         // If the vault is being upgraded, we want to ignore the metadata
                         // that is already in the vault, so we can effectively
                         // re-encrypt the vault with the new encryption config.
-                        useVaultKeyMetadata: false,
+                        ignoreExistingVault: false,
                     });
                     await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_updateVault).call(this);
                 }
@@ -1045,7 +1045,9 @@ async function _KeyringController_createNewVaultWithKeyring(password, keyring) {
         delete state.encryptionKey;
         delete state.encryptionSalt;
     });
-    await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_deriveEncryptionKey).call(this, password);
+    await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_deriveEncryptionKey).call(this, password, {
+        ignoreExistingVault: false,
+    });
     await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_clearKeyrings).call(this);
     await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_createKeyringWithFirstAccount).call(this, keyring.type, keyring.opts);
     __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_setUnlocked).call(this);
@@ -1059,12 +1061,16 @@ async function _KeyringController_createNewVaultWithKeyring(password, keyring) {
  * using the salt from the vault. If the vault is empty, a new salt
  * is generated and used to derive the key.
  *
+ * If `options.ignoreExistingVault` is set to `false`, the existing
+ * vault is completely ignored: the new key won't be able to decrypt
+ * the existing vault, and should be used to re-encrypt it.
+ *
  * @param password - The password to use for decryption or derivation.
  * @param options - Options for the key derivation.
- * @param options.useVaultKeyMetadata - Whether to use the vault key metadata
+ * @param options.ignoreExistingVault - Whether to use the existing vault salt and key metadata
  */
 async function _KeyringController_deriveEncryptionKey(password, options = {
-    useVaultKeyMetadata: true,
+    ignoreExistingVault: true,
 }) {
     __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertControllerMutexIsLocked).call(this);
     const { vault } = this.state;
@@ -1072,7 +1078,7 @@ async function _KeyringController_deriveEncryptionKey(password, options = {
         throw new TypeError(constants_1.KeyringControllerError.WrongPasswordType);
     }
     let serializedEncryptionKey, salt;
-    if (vault && options.useVaultKeyMetadata) {
+    if (vault && options.ignoreExistingVault) {
         // The `decryptWithDetail` method is being used here instead of
         // `keyFromPassword` + `exportKey` to let the encryptor handle
         // any legacy encryption formats and metadata that might be