@metamask-previews/keyring-controller 19.0.6-preview-224dff25 → 19.0.7-preview-1a21f764

package/CHANGELOG.md

@@ -7,6 +7,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [19.0.7]
+
+### Changed
+
+- Bump `@metamask/base-controller` from `^7.1.1` to `^8.0.0` ([#5305](https://github.com/MetaMask/core/pull/5305))
+- Bump `@metamask/message-manager` from `^12.0.0` to `^12.0.1` ([#5305](https://github.com/MetaMask/core/pull/5305))
+
 ## [19.0.6]
 
 ### Changed
@@ -653,7 +660,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
     All changes listed after this point were applied to this package following the monorepo conversion.
 
-[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/keyring-controller@19.0.6...HEAD
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/keyring-controller@19.0.7...HEAD
+[19.0.7]: https://github.com/MetaMask/core/compare/@metamask/keyring-controller@19.0.6...@metamask/keyring-controller@19.0.7
 [19.0.6]: https://github.com/MetaMask/core/compare/@metamask/keyring-controller@19.0.5...@metamask/keyring-controller@19.0.6
 [19.0.5]: https://github.com/MetaMask/core/compare/@metamask/keyring-controller@19.0.4...@metamask/keyring-controller@19.0.5
 [19.0.4]: https://github.com/MetaMask/core/compare/@metamask/keyring-controller@19.0.3...@metamask/keyring-controller@19.0.4

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_unsupportedKeyrings, _KeyringController_encryptor, _KeyringController_cacheEncryptionKey, _KeyringController_keyrings, _KeyringController_password, _KeyringController_qrKeyringStateListener, _KeyringController_registerMessageHandlers, _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_unsupportedKeyrings, _KeyringController_encryptor, _KeyringController_cacheEncryptionKey, _KeyringController_keyrings, _KeyringController_password, _KeyringController_qrKeyringStateListener, _KeyringController_registerMessageHandlers, _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_assertIsUnlocked, _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");
@@ -287,6 +287,7 @@ class KeyringController extends base_controller_1.BaseController {
      * @returns Promise resolving to the added account address.
      */
     async addNewAccount(accountCount) {
+        __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertIsUnlocked).call(this);
         return __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_persistOrRollback).call(this, async () => {
             const primaryKeyring = this.getKeyringsByType('HD Key Tree')[0];
             if (!primaryKeyring) {
@@ -321,6 +322,7 @@ class KeyringController extends base_controller_1.BaseController {
         // We still uses `Hex` here, since we are not using this method when creating
         // and account using a "Snap Keyring". This function assume the `keyring` is
         // ethereum compatible, but "Snap Keyring" might not be.
+        __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertIsUnlocked).call(this);
         return __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_persistOrRollback).call(this, async () => {
             const oldAccounts = await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_getAccountsFromKeyrings).call(this);
             if (accountCount && oldAccounts.length !== accountCount) {
@@ -386,6 +388,7 @@ class KeyringController extends base_controller_1.BaseController {
      * @returns Promise resolving to the added keyring.
      */
     async addNewKeyring(type, opts) {
+        __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertIsUnlocked).call(this);
         if (type === KeyringTypes.qr) {
             return this.getOrAddQRKeyring();
         }
@@ -418,6 +421,7 @@ class KeyringController extends base_controller_1.BaseController {
      * @returns Promise resolving to the seed phrase.
      */
     async exportSeedPhrase(password) {
+        __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertIsUnlocked).call(this);
         await this.verifyPassword(password);
         assertHasUint8ArrayMnemonic(__classPrivateFieldGet(this, _KeyringController_keyrings, "f")[0]);
         return __classPrivateFieldGet(this, _KeyringController_keyrings, "f")[0].mnemonic;
@@ -443,6 +447,7 @@ class KeyringController extends base_controller_1.BaseController {
      * @returns A promise resolving to an array of addresses.
      */
     async getAccounts() {
+        __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertIsUnlocked).call(this);
         return this.state.keyrings.reduce((accounts, keyring) => accounts.concat(keyring.accounts), []);
     }
     /**
@@ -454,6 +459,7 @@ class KeyringController extends base_controller_1.BaseController {
      * @returns Promise resolving to encyption public key of the `account` if one exists.
      */
     async getEncryptionPublicKey(account, opts) {
+        __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertIsUnlocked).call(this);
         const address = (0, eth_sig_util_1.normalize)(account);
         const keyring = (await this.getKeyringForAccount(account));
         if (!keyring.getEncryptionPublicKey) {
@@ -470,6 +476,7 @@ class KeyringController extends base_controller_1.BaseController {
      * @returns The raw decryption result.
      */
     async decryptMessage(messageParams) {
+        __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertIsUnlocked).call(this);
         const address = (0, eth_sig_util_1.normalize)(messageParams.from);
         const keyring = (await this.getKeyringForAccount(address));
         if (!keyring.decryptMessage) {
@@ -488,6 +495,7 @@ class KeyringController extends base_controller_1.BaseController {
      * @returns Promise resolving to keyring of the `account` if one exists.
      */
     async getKeyringForAccount(account) {
+        __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertIsUnlocked).call(this);
         const address = normalize(account);
         const candidates = await Promise.all(__classPrivateFieldGet(this, _KeyringController_keyrings, "f").map(async (keyring) => {
             return Promise.all([keyring, keyring.getAccounts()]);
@@ -519,6 +527,7 @@ class KeyringController extends base_controller_1.BaseController {
      * @returns An array of keyrings of the given type.
      */
     getKeyringsByType(type) {
+        __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertIsUnlocked).call(this);
         return __classPrivateFieldGet(this, _KeyringController_keyrings, "f").filter((keyring) => keyring.type === type);
     }
     /**
@@ -529,6 +538,7 @@ class KeyringController extends base_controller_1.BaseController {
      * operation completes.
      */
     async persistAllKeyrings() {
+        __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertIsUnlocked).call(this);
         return __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_persistOrRollback).call(this, async () => true);
     }
     /**
@@ -543,6 +553,7 @@ class KeyringController extends base_controller_1.BaseController {
     // TODO: Replace `any` with type
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     args) {
+        __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertIsUnlocked).call(this);
         return __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_persistOrRollback).call(this, async () => {
             let privateKey;
             switch (strategy) {
@@ -595,6 +606,7 @@ class KeyringController extends base_controller_1.BaseController {
      * @returns Promise resolving when the account is removed.
      */
     async removeAccount(address) {
+        __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertIsUnlocked).call(this);
         await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_persistOrRollback).call(this, async () => {
             const keyring = (await this.getKeyringForAccount(address));
             // Not all the keyrings support this, so we have to check
@@ -621,6 +633,7 @@ class KeyringController extends base_controller_1.BaseController {
      * @returns Promise resolving when the operation completes.
      */
     async setLocked() {
+        __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertIsUnlocked).call(this);
         return __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_withRollback).call(this, async () => {
             __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_unsubscribeFromQRKeyringsEvents).call(this);
             __classPrivateFieldSet(this, _KeyringController_password, undefined, "f");
@@ -641,6 +654,7 @@ class KeyringController extends base_controller_1.BaseController {
      * @returns Promise resolving to a signed message string.
      */
     async signMessage(messageParams) {
+        __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertIsUnlocked).call(this);
         if (!messageParams.data) {
             throw new Error("Can't sign an empty message");
         }
@@ -658,6 +672,7 @@ class KeyringController extends base_controller_1.BaseController {
      * @returns Promise resolving to a signed message string.
      */
     async signPersonalMessage(messageParams) {
+        __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertIsUnlocked).call(this);
         const address = (0, eth_sig_util_1.normalize)(messageParams.from);
         const keyring = (await this.getKeyringForAccount(address));
         if (!keyring.signPersonalMessage) {
@@ -675,6 +690,7 @@ class KeyringController extends base_controller_1.BaseController {
      * @returns Promise resolving to a signed message string or an error if any.
      */
     async signTypedMessage(messageParams, version) {
+        __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertIsUnlocked).call(this);
         try {
             if (![
                 SignTypedDataVersion.V1,
@@ -710,6 +726,7 @@ class KeyringController extends base_controller_1.BaseController {
      * @returns Promise resolving to a signed transaction string.
      */
     async signTransaction(transaction, from, opts) {
+        __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertIsUnlocked).call(this);
         const address = (0, eth_sig_util_1.normalize)(from);
         const keyring = (await this.getKeyringForAccount(address));
         if (!keyring.signTransaction) {
@@ -726,6 +743,7 @@ class KeyringController extends base_controller_1.BaseController {
      * @returns A pseudo-UserOperation that can be used to construct a real.
      */
     async prepareUserOperation(from, transactions, executionContext) {
+        __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertIsUnlocked).call(this);
         const address = (0, eth_sig_util_1.normalize)(from);
         const keyring = (await this.getKeyringForAccount(address));
         if (!keyring.prepareUserOperation) {
@@ -743,6 +761,7 @@ class KeyringController extends base_controller_1.BaseController {
      * @returns A patch to apply to the UserOperation.
      */
     async patchUserOperation(from, userOp, executionContext) {
+        __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertIsUnlocked).call(this);
         const address = (0, eth_sig_util_1.normalize)(from);
         const keyring = (await this.getKeyringForAccount(address));
         if (!keyring.patchUserOperation) {
@@ -759,6 +778,7 @@ class KeyringController extends base_controller_1.BaseController {
      * @returns The signature of the UserOperation.
      */
     async signUserOperation(from, userOp, executionContext) {
+        __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertIsUnlocked).call(this);
         const address = (0, eth_sig_util_1.normalize)(from);
         const keyring = (await this.getKeyringForAccount(address));
         if (!keyring.signUserOperation) {
@@ -773,10 +793,8 @@ class KeyringController extends base_controller_1.BaseController {
      * @returns Promise resolving when the operation completes.
      */
     changePassword(password) {
+        __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertIsUnlocked).call(this);
         return __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_persistOrRollback).call(this, async () => {
-            if (!this.state.isUnlocked) {
-                throw new Error(constants_1.KeyringControllerError.MissingCredentials);
-            }
             assertIsValidPassword(password);
             __classPrivateFieldSet(this, _KeyringController_password, password, "f");
             // We need to clear encryption key and salt from state
@@ -823,11 +841,13 @@ class KeyringController extends base_controller_1.BaseController {
      * @returns Promise resolving to the seed phrase as Uint8Array.
      */
     async verifySeedPhrase() {
+        __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertIsUnlocked).call(this);
         return __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_withControllerLock).call(this, async () => __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_verifySeedPhrase).call(this));
     }
     async withKeyring(selector, operation, options = {
         createIfMissing: false,
     }) {
+        __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertIsUnlocked).call(this);
         return __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_persistOrRollback).call(this, async () => {
             let keyring;
             if ('address' in selector) {
@@ -861,6 +881,7 @@ class KeyringController extends base_controller_1.BaseController {
      * @deprecated Use `withKeyring` instead.
      */
     getQRKeyring() {
+        __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertIsUnlocked).call(this);
         // QRKeyring is not yet compatible with Keyring type from @metamask/utils
         return this.getKeyringsByType(KeyringTypes.qr)[0];
     }
@@ -871,6 +892,7 @@ class KeyringController extends base_controller_1.BaseController {
      * @deprecated Use `addNewKeyring` and `withKeyring` instead.
      */
     async getOrAddQRKeyring() {
+        __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertIsUnlocked).call(this);
         return (this.getQRKeyring() ||
             (await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_persistOrRollback).call(this, async () => __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_addQRKeyring).call(this))));
     }
@@ -884,6 +906,7 @@ class KeyringController extends base_controller_1.BaseController {
     // TODO: Replace `any` with type
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     async restoreQRKeyring(serialized) {
+        __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertIsUnlocked).call(this);
         return __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_persistOrRollback).call(this, async () => {
             const keyring = this.getQRKeyring() || (await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_addQRKeyring).call(this));
             keyring.deserialize(serialized);
@@ -896,6 +919,7 @@ class KeyringController extends base_controller_1.BaseController {
      * @deprecated Use `withKeyring` instead.
      */
     async resetQRKeyringState() {
+        __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertIsUnlocked).call(this);
         (await this.getOrAddQRKeyring()).resetStore();
     }
     /**
@@ -906,6 +930,7 @@ class KeyringController extends base_controller_1.BaseController {
      * instead.
      */
     async getQRKeyringState() {
+        __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertIsUnlocked).call(this);
         return (await this.getOrAddQRKeyring()).getMemStore();
     }
     /**
@@ -916,6 +941,7 @@ class KeyringController extends base_controller_1.BaseController {
      * @deprecated Use `withKeyring` instead.
      */
     async submitQRCryptoHDKey(cryptoHDKey) {
+        __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertIsUnlocked).call(this);
         (await this.getOrAddQRKeyring()).submitCryptoHDKey(cryptoHDKey);
     }
     /**
@@ -926,6 +952,7 @@ class KeyringController extends base_controller_1.BaseController {
      * @deprecated Use `withKeyring` instead.
      */
     async submitQRCryptoAccount(cryptoAccount) {
+        __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertIsUnlocked).call(this);
         (await this.getOrAddQRKeyring()).submitCryptoAccount(cryptoAccount);
     }
     /**
@@ -937,6 +964,7 @@ class KeyringController extends base_controller_1.BaseController {
      * @deprecated Use `withKeyring` instead.
      */
     async submitQRSignature(requestId, ethSignature) {
+        __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertIsUnlocked).call(this);
         (await this.getOrAddQRKeyring()).submitSignature(requestId, ethSignature);
     }
     /**
@@ -946,6 +974,7 @@ class KeyringController extends base_controller_1.BaseController {
      * @deprecated Use `withKeyring` instead.
      */
     async cancelQRSignRequest() {
+        __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertIsUnlocked).call(this);
         (await this.getOrAddQRKeyring()).cancelSignRequest();
     }
     /**
@@ -955,6 +984,7 @@ class KeyringController extends base_controller_1.BaseController {
      * @deprecated Use `withKeyring` instead.
      */
     async cancelQRSynchronization() {
+        __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertIsUnlocked).call(this);
         (await this.getOrAddQRKeyring()).cancelSync();
     }
     /**
@@ -967,6 +997,7 @@ class KeyringController extends base_controller_1.BaseController {
      * `withKeyring` instead.
      */
     async connectQRHardware(page) {
+        __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertIsUnlocked).call(this);
         return __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_persistOrRollback).call(this, async () => {
             try {
                 const keyring = this.getQRKeyring() || (await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_addQRKeyring).call(this));
@@ -1007,6 +1038,7 @@ class KeyringController extends base_controller_1.BaseController {
      * @deprecated Use `withKeyring` instead.
      */
     async unlockQRHardwareWalletAccount(index) {
+        __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertIsUnlocked).call(this);
         return __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_persistOrRollback).call(this, async () => {
             const keyring = this.getQRKeyring() || (await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_addQRKeyring).call(this));
             keyring.setAccountToUnlock(index);
@@ -1014,6 +1046,7 @@ class KeyringController extends base_controller_1.BaseController {
         });
     }
     async getAccountKeyringType(account) {
+        __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertIsUnlocked).call(this);
         const keyring = (await this.getKeyringForAccount(account));
         return keyring.type;
     }
@@ -1024,6 +1057,7 @@ class KeyringController extends base_controller_1.BaseController {
      * @deprecated Use `withKeyring` instead.
      */
     async forgetQRDevice() {
+        __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertIsUnlocked).call(this);
         return __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_persistOrRollback).call(this, async () => {
             const keyring = this.getQRKeyring();
             if (!keyring) {
@@ -1481,6 +1515,10 @@ async function _KeyringController_checkForDuplicate(type, newAccountArray) {
         state.isUnlocked = true;
     });
     this.messagingSystem.publish(`${name}:unlock`);
+}, _KeyringController_assertIsUnlocked = function _KeyringController_assertIsUnlocked() {
+    if (!this.state.isUnlocked) {
+        throw new Error(constants_1.KeyringControllerError.ControllerLocked);
+    }
 }, _KeyringController_persistOrRollback = 
 /**
  * Execute the given function after acquiring the controller lock