feat: add KeyringController:withLocked action

Author: mikesposito

packages/keyring-controller/jest.config.js

@@ -17,10 +17,10 @@ module.exports = merge(baseConfig, {
   // An object that configures minimum threshold enforcement for coverage results
   coverageThreshold: {
     global: {
-      branches: 94.55,
+      branches: 94.8,
       functions: 100,
-      lines: 98.85,
-      statements: 98.86,
+      lines: 98.89,
+      statements: 98.9,
     },
   },
 

packages/keyring-controller/src/KeyringController.test.ts

@@ -2256,6 +2256,18 @@ describe('KeyringController', () => {
           expect(await controller.withKeyring(selector, fn)).toBe('hello');
         });
       });
+
+      it('should throw an error if the keyring is not found', async () => {
+        await withController(async ({ controller }) => {
+          const selector = { type: 'foo' };
+          const fn = jest.fn();
+
+          await expect(controller.withKeyring(selector, fn)).rejects.toThrow(
+            KeyringControllerError.KeyringNotFound,
+          );
+          expect(fn).not.toHaveBeenCalled();
+        });
+      });
     });
 
     describe('when the keyring is selected by address', () => {
@@ -2283,6 +2295,20 @@ describe('KeyringController', () => {
           expect(await controller.withKeyring(selector, fn)).toBe('hello');
         });
       });
+
+      it('should throw an error if the keyring is not found', async () => {
+        await withController(async ({ controller }) => {
+          const selector = {
+            address: '0x4584d2B4905087A100420AFfCe1b2d73fC69B8E4' as Hex,
+          };
+          const fn = jest.fn();
+
+          await expect(controller.withKeyring(selector, fn)).rejects.toThrow(
+            'KeyringController - No keyring found. Error info: There are keyrings, but none match the address',
+          );
+          expect(fn).not.toHaveBeenCalled();
+        });
+      });
     });
   });
 
@@ -2947,6 +2973,9 @@ describe('KeyringController', () => {
       jest
         .spyOn(KeyringController.prototype, 'signUserOperation')
         .mockResolvedValue('0x1234');
+      jest
+        .spyOn(KeyringController.prototype, 'withKeyring')
+        .mockResolvedValue(jest.fn());
     });
 
     describe('signMessage', () => {
@@ -3059,6 +3088,19 @@ describe('KeyringController', () => {
       });
     });
 
+    describe('withKeyring', () => {
+      it('should call withKeyring', async () => {
+        await withController(async ({ controller, messenger }) => {
+          const selector = { type: KeyringTypes.hd };
+          const fn = async () => 'foo';
+
+          await messenger.call('KeyringController:withKeyring', selector, fn);
+
+          expect(controller.withKeyring).toHaveBeenCalledWith(selector, fn);
+        });
+      });
+    });
+
     describe('prepareUserOperation', () => {
       const chainId = '0x1';
       const executionContext = {

packages/keyring-controller/src/KeyringController.ts

@@ -124,11 +124,21 @@ export type KeyringControllerGetEncryptionPublicKeyAction = {
   handler: KeyringController['getEncryptionPublicKey'];
 };
 
+/**
+ * @deprecated Use of this method is discouraged as actions executed directly on
+ * keyrings are not being reflected in the KeyringController state and not
+ * persisted in the vault. Use `KeyringController:withKeyring` instead.
+ */
 export type KeyringControllerGetKeyringsByTypeAction = {
   type: `${typeof name}:getKeyringsByType`;
   handler: KeyringController['getKeyringsByType'];
 };
 
+/**
+ * @deprecated Use of this method is discouraged as actions executed directly on
+ * keyrings are not being reflected in the KeyringController state and not
+ * persisted in the vault. Use `KeyringController:withKeyring` instead.
+ */
 export type KeyringControllerGetKeyringForAccountAction = {
   type: `${typeof name}:getKeyringForAccount`;
   handler: KeyringController['getKeyringForAccount'];
@@ -139,6 +149,10 @@ export type KeyringControllerGetAccountsAction = {
   handler: KeyringController['getAccounts'];
 };
 
+/**
+ * @deprecated This action is being phased out in favor of
+ * `KeyringController:withKeyring`.
+ */
 export type KeyringControllerPersistAllKeyringsAction = {
   type: `${typeof name}:persistAllKeyrings`;
   handler: KeyringController['persistAllKeyrings'];
@@ -159,6 +173,11 @@ export type KeyringControllerSignUserOperationAction = {
   handler: KeyringController['signUserOperation'];
 };
 
+export type KeyringControllerWithKeyringAction = {
+  type: `${typeof name}:withKeyring`;
+  handler: KeyringController['withKeyring'];
+};
+
 export type KeyringControllerStateChangeEvent = {
   type: `${typeof name}:stateChange`;
   payload: [KeyringControllerState, Patch[]];
@@ -192,6 +211,7 @@ export type KeyringControllerActions =
   | KeyringControllerDecryptMessageAction
   | KeyringControllerGetEncryptionPublicKeyAction
   | KeyringControllerGetAccountsAction
+  | KeyringControllerWithKeyringAction
   | KeyringControllerGetKeyringsByTypeAction
   | KeyringControllerGetKeyringForAccountAction
   | KeyringControllerPersistAllKeyringsAction
@@ -1380,10 +1400,10 @@ export class KeyringController extends BaseController<
       }
 
       if (!keyring) {
-        throw new Error(KeyringControllerError.NoKeyring);
+        throw new Error(KeyringControllerError.KeyringNotFound);
       }
 
-      return fn(keyring as EthKeyring<Json>);
+      return fn(keyring);
     });
   }
 
@@ -1590,6 +1610,11 @@ export class KeyringController extends BaseController<
       `${name}:signUserOperation`,
       this.signUserOperation.bind(this),
     );
+
+    this.messagingSystem.registerActionHandler(
+      `${name}:withKeyring`,
+      this.withKeyring.bind(this),
+    );
   }
 
   /**

packages/keyring-controller/src/constants.ts

@@ -1,5 +1,6 @@
 export enum KeyringControllerError {
   NoKeyring = 'KeyringController - No keyring found',
+  KeyringNotFound = 'KeyringController - Keyring not found.',
   WrongPasswordType = 'KeyringController - Password must be of type string.',
   NoFirstAccount = 'KeyringController - First Account not found.',
   DuplicatedAccount = 'KeyringController - The account you are trying to import is a duplicate',