@metamask-previews/keyring-controller 19.0.7-preview-862b5dac → 19.1.0-preview-cb58d7d1

package/CHANGELOG.md

@@ -7,6 +7,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [19.1.0]
+
+### Added
+
+- Add new keyring type for OneKey ([#5216](https://github.com/MetaMask/core/pull/5216))
+
+### Changed
+
+- A specific error message is thrown when any operation is attempted while the controller is locked ([#5172](https://github.com/MetaMask/core/pull/5172))
+
 ## [19.0.7]
 
 ### Changed
@@ -660,7 +670,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.7...HEAD
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/keyring-controller@19.1.0...HEAD
+[19.1.0]: https://github.com/MetaMask/core/compare/@metamask/keyring-controller@19.0.7...@metamask/keyring-controller@19.1.0
 [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

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_assertIsUnlocked, _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_keyringsMetadata, _KeyringController_password, _KeyringController_qrKeyringStateListener, _KeyringController_registerMessageHandlers, _KeyringController_getKeyringByIdOrDefault, _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");
@@ -48,6 +48,8 @@ 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 name = 'KeyringController';
 /**
@@ -59,6 +61,7 @@ var KeyringTypes;
     KeyringTypes["hd"] = "HD Key Tree";
     KeyringTypes["qr"] = "QR Hardware Wallet Device";
     KeyringTypes["trezor"] = "Trezor Hardware";
+    KeyringTypes["oneKey"] = "OneKey Hardware";
     KeyringTypes["ledger"] = "Ledger Hardware";
     KeyringTypes["lattice"] = "Lattice Hardware";
     KeyringTypes["snap"] = "Snap Keyring";
@@ -115,6 +118,7 @@ const getDefaultKeyringState = () => {
     return {
         isUnlocked: false,
         keyrings: [],
+        keyringsMetadata: [],
     };
 };
 exports.getDefaultKeyringState = getDefaultKeyringState;
@@ -246,6 +250,7 @@ class KeyringController extends base_controller_1.BaseController {
                 vault: { persist: true, anonymous: false },
                 isUnlocked: { persist: false, anonymous: true },
                 keyrings: { persist: false, anonymous: false },
+                keyringsMetadata: { persist: true, anonymous: false },
                 encryptionKey: { persist: false, anonymous: false },
                 encryptionSalt: { persist: false, anonymous: false },
             },
@@ -263,6 +268,7 @@ class KeyringController extends base_controller_1.BaseController {
         _KeyringController_encryptor.set(this, void 0);
         _KeyringController_cacheEncryptionKey.set(this, void 0);
         _KeyringController_keyrings.set(this, void 0);
+        _KeyringController_keyringsMetadata.set(this, void 0);
         _KeyringController_password.set(this, void 0);
         _KeyringController_qrKeyringStateListener.set(this, void 0);
         __classPrivateFieldSet(this, _KeyringController_keyringBuilders, keyringBuilders
@@ -270,6 +276,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
@@ -418,13 +425,18 @@ class KeyringController extends base_controller_1.BaseController {
      * Gets the seed phrase of the HD keyring.
      *
      * @param password - Password of the keyring.
+     * @param keyringId - The id of the keyring.
      * @returns Promise resolving to the seed phrase.
      */
-    async exportSeedPhrase(password) {
+    async exportSeedPhrase(password, keyringId) {
         __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;
+        const selectedKeyring = __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_getKeyringByIdOrDefault).call(this, keyringId);
+        if (!selectedKeyring) {
+            throw new Error('Keyring not found');
+        }
+        assertHasUint8ArrayMnemonic(selectedKeyring);
+        return selectedKeyring.mnemonic;
     }
     /**
      * Gets the private key from the keyring controlling an address.
@@ -609,6 +621,13 @@ class KeyringController extends base_controller_1.BaseController {
         __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));
+            const keyringIndex = this.state.keyrings.findIndex((kr) => kr.accounts.includes(address));
+            const isPrimaryKeyring = keyringIndex === 0;
+            const shouldRemoveKeyring = (await keyring.getAccounts()).length === 1;
+            // Primary keyring should never be removed, so we need to keep at least one account in it
+            if (isPrimaryKeyring && shouldRemoveKeyring) {
+                throw new Error(constants_1.KeyringControllerError.LastAccountInPrimaryKeyring);
+            }
             // Not all the keyrings support this, so we have to check
             if (!keyring.removeAccount) {
                 throw new Error(constants_1.KeyringControllerError.UnsupportedRemoveAccount);
@@ -619,9 +638,7 @@ class KeyringController extends base_controller_1.BaseController {
             // because `Keyring<State>.removeAccount` requires address to be `Hex`. Those
             // type would need to be updated for a full non-EVM support.
             keyring.removeAccount(address);
-            const accounts = await keyring.getAccounts();
-            // Check if this was the last/only account
-            if (accounts.length === 0) {
+            if (shouldRemoveKeyring) {
                 await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_removeEmptyKeyrings).call(this);
             }
         });
@@ -838,11 +855,12 @@ class KeyringController extends base_controller_1.BaseController {
     /**
      * Verifies the that the seed phrase restores the current keychain's accounts.
      *
+     * @param keyringId - The id of the keyring to verify.
      * @returns Promise resolving to the seed phrase as Uint8Array.
      */
-    async verifySeedPhrase() {
+    async verifySeedPhrase(keyringId) {
         __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));
+        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 = {
         createIfMissing: false,
@@ -853,12 +871,16 @@ class KeyringController extends base_controller_1.BaseController {
             if ('address' in selector) {
                 keyring = (await this.getKeyringForAccount(selector.address));
             }
-            else {
+            else if ('type' in selector) {
                 keyring = this.getKeyringsByType(selector.type)[selector.index || 0];
                 if (!keyring && options.createIfMissing) {
                     keyring = (await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_newKeyring).call(this, selector.type, options.createWithData));
                 }
             }
+            else if ('id' in selector) {
+                const index = this.state.keyringsMetadata.findIndex((metadata) => metadata.id === selector.id);
+                keyring = __classPrivateFieldGet(this, _KeyringController_keyrings, "f")[index];
+            }
             if (!keyring) {
                 throw new Error(constants_1.KeyringControllerError.KeyringNotFound);
             }
@@ -1072,7 +1094,7 @@ class KeyringController extends base_controller_1.BaseController {
     }
 }
 exports.KeyringController = KeyringController;
-_KeyringController_controllerOperationMutex = new WeakMap(), _KeyringController_vaultOperationMutex = new WeakMap(), _KeyringController_keyringBuilders = new WeakMap(), _KeyringController_unsupportedKeyrings = new WeakMap(), _KeyringController_encryptor = new WeakMap(), _KeyringController_cacheEncryptionKey = new WeakMap(), _KeyringController_keyrings = new WeakMap(), _KeyringController_password = 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_unsupportedKeyrings = new WeakMap(), _KeyringController_encryptor = new WeakMap(), _KeyringController_cacheEncryptionKey = new WeakMap(), _KeyringController_keyrings = new WeakMap(), _KeyringController_keyringsMetadata = new WeakMap(), _KeyringController_password = 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));
@@ -1086,6 +1108,12 @@ _KeyringController_controllerOperationMutex = new WeakMap(), _KeyringController_
     this.messagingSystem.registerActionHandler(`${name}:patchUserOperation`, this.patchUserOperation.bind(this));
     this.messagingSystem.registerActionHandler(`${name}:signUserOperation`, this.signUserOperation.bind(this));
     this.messagingSystem.registerActionHandler(`${name}:addNewAccount`, this.addNewAccount.bind(this));
+}, _KeyringController_getKeyringByIdOrDefault = function _KeyringController_getKeyringByIdOrDefault(keyringId) {
+    if (!keyringId) {
+        return __classPrivateFieldGet(this, _KeyringController_keyrings, "f")[0];
+    }
+    const index = this.state.keyringsMetadata.findIndex((metadata) => metadata.id === keyringId);
+    return __classPrivateFieldGet(this, _KeyringController_keyrings, "f")[index];
 }, _KeyringController_getKeyringBuilderForType = function _KeyringController_getKeyringBuilderForType(type) {
     return __classPrivateFieldGet(this, _KeyringController_keyringBuilders, "f").find((keyringBuilder) => keyringBuilder.type === type);
 }, _KeyringController_addQRKeyring = 
@@ -1138,23 +1166,29 @@ async function _KeyringController_createNewVaultWithKeyring(password, keyring) {
     });
     __classPrivateFieldSet(this, _KeyringController_password, password, "f");
     await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_clearKeyrings).call(this);
+    __classPrivateFieldSet(this, _KeyringController_keyringsMetadata, [], "f");
     await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_createKeyringWithFirstAccount).call(this, keyring.type, keyring.opts);
     __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_setUnlocked).call(this);
 }, _KeyringController_verifySeedPhrase = 
 /**
  * Internal non-exclusive method to verify the seed phrase.
  *
+ * @param keyringId - The id of the keyring to verify the seed phrase for.
  * @returns A promise resolving to the seed phrase as Uint8Array.
  */
-async function _KeyringController_verifySeedPhrase() {
+async function _KeyringController_verifySeedPhrase(keyringId) {
     __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertControllerMutexIsLocked).call(this);
-    const primaryKeyring = this.getKeyringsByType(KeyringTypes.hd)[0];
-    if (!primaryKeyring) {
-        throw new Error('No HD keyring found.');
+    const keyring = __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_getKeyringByIdOrDefault).call(this, keyringId);
+    if (!keyring) {
+        throw new Error(constants_1.KeyringControllerError.KeyringNotFound);
+    }
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-enum-comparison
+    if (keyring.type !== KeyringTypes.hd) {
+        throw new Error(constants_1.KeyringControllerError.UnsupportedVerifySeedPhrase);
     }
-    assertHasUint8ArrayMnemonic(primaryKeyring);
-    const seedWords = primaryKeyring.mnemonic;
-    const accounts = await primaryKeyring.getAccounts();
+    assertHasUint8ArrayMnemonic(keyring);
+    const seedWords = keyring.mnemonic;
+    const accounts = await keyring.getAccounts();
     /* istanbul ignore if */
     if (accounts.length === 0) {
         throw new Error('Cannot verify an empty keyring.');
@@ -1334,9 +1368,13 @@ async function _KeyringController_unlockKeyrings(password, encryptionKey, encryp
             throw new Error(constants_1.KeyringControllerError.MissingVaultData);
         }
         const updatedKeyrings = await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_getUpdatedKeyrings).call(this);
+        if (updatedKeyrings.length !== __classPrivateFieldGet(this, _KeyringController_keyringsMetadata, "f").length) {
+            throw new Error(constants_1.KeyringControllerError.KeyringMetadataLengthMismatch);
+        }
         this.update((state) => {
             state.vault = updatedState.vault;
             state.keyrings = updatedKeyrings;
+            state.keyringsMetadata = __classPrivateFieldGet(this, _KeyringController_keyringsMetadata, "f").slice();
             if (updatedState.encryptionKey) {
                 state.encryptionKey = updatedState.encryptionKey;
                 state.encryptionSalt = JSON.parse(updatedState.vault).salt;
@@ -1376,13 +1414,13 @@ async function _KeyringController_createKeyringWithFirstAccount(type, opts) {
     if (!firstAccount) {
         throw new Error(constants_1.KeyringControllerError.NoFirstAccount);
     }
+    return firstAccount;
 }, _KeyringController_newKeyring = 
 /**
  * Instantiate, initialize and return a new keyring of the given `type`,
  * 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.
  * @returns The new keyring.
@@ -1390,6 +1428,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: (0, ulid_1.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}`);
@@ -1417,6 +1459,9 @@ async function _KeyringController_newKeyring(type, data) {
         __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_subscribeToQRKeyringEvents).call(this, keyring);
     }
     __classPrivateFieldGet(this, _KeyringController_keyrings, "f").push(keyring);
+    if (__classPrivateFieldGet(this, _KeyringController_keyringsMetadata, "f").length < __classPrivateFieldGet(this, _KeyringController_keyrings, "f").length) {
+        __classPrivateFieldGet(this, _KeyringController_keyringsMetadata, "f").push(newKeyringMetadata);
+    }
     return keyring;
 }, _KeyringController_clearKeyrings = 
 /**
@@ -1469,19 +1514,22 @@ 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)
-    await Promise.all(__classPrivateFieldGet(this, _KeyringController_keyrings, "f").map(async (keyring) => {
+    await Promise.all(__classPrivateFieldGet(this, _KeyringController_keyrings, "f").map(async (keyring, index) => {
         const accounts = await keyring.getAccounts();
         if (accounts.length > 0) {
             validKeyrings.push(keyring);
+            validKeyringMetadata.push(__classPrivateFieldGet(this, _KeyringController_keyringsMetadata, "f")[index]);
         }
         else {
             await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_destroyKeyring).call(this, keyring);
         }
     }));
     __classPrivateFieldSet(this, _KeyringController_keyrings, validKeyrings, "f");
+    __classPrivateFieldSet(this, _KeyringController_keyringsMetadata, validKeyringMetadata, "f");
 }, _KeyringController_checkForDuplicate = 
 /**
  * Checks for duplicate keypairs, using the the first account in the given
@@ -1547,6 +1595,7 @@ async function _KeyringController_withRollback(callback) {
     return __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_withControllerLock).call(this, async ({ releaseLock }) => {
         const currentSerializedKeyrings = await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_getSerializedKeyrings).call(this);
         const currentPassword = __classPrivateFieldGet(this, _KeyringController_password, "f");
+        const currentKeyringsMetadata = __classPrivateFieldGet(this, _KeyringController_keyringsMetadata, "f").slice();
         try {
             return await callback({ releaseLock });
         }
@@ -1554,6 +1603,7 @@ async function _KeyringController_withRollback(callback) {
             // Keyrings and password are restored to their previous state
             await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_restoreSerializedKeyrings).call(this, currentSerializedKeyrings);
             __classPrivateFieldSet(this, _KeyringController_password, currentPassword, "f");
+            __classPrivateFieldSet(this, _KeyringController_keyringsMetadata, currentKeyringsMetadata, "f");
             throw e;
         }
     });