feat: Add new metadata to core controllers

eslint-warning-thresholds.json

@@ -286,9 +286,6 @@
   "packages/permission-controller/src/PermissionController.test.ts": {
     "jest/no-conditional-in-test": 4
   },
-  "packages/permission-controller/src/PermissionController.ts": {
-    "prettier/prettier": 12
-  },
   "packages/permission-controller/src/rpc-methods/getPermissions.test.ts": {
     "import-x/order": 1
   },

packages/composable-controller/CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Add two new controller state metadata properties: `includeInStateLogs` and `usedInUi` ([#6525](https://github.com/MetaMask/core/pull/6525))
+
 ### Changed
 
 - Bump `@metamask/base-controller` from `^8.0.0` to `^8.3.0` ([#5722](https://github.com/MetaMask/core/pull/5722), [#6284](https://github.com/MetaMask/core/pull/6284), [#6355](https://github.com/MetaMask/core/pull/6355), [#6465](https://github.com/MetaMask/core/pull/6465))

packages/composable-controller/src/ComposableController.test.ts

@@ -1,5 +1,9 @@
 import type { RestrictedMessenger } from '@metamask/base-controller';
-import { BaseController, Messenger } from '@metamask/base-controller';
+import {
+  BaseController,
+  Messenger,
+  deriveStateFromMetadata,
+} from '@metamask/base-controller';
 import { JsonRpcEngine } from '@metamask/json-rpc-engine';
 import type { Patch } from 'immer';
 import * as sinon from 'sinon';
@@ -436,4 +440,190 @@ describe('ComposableController', () => {
         }),
     ).not.toThrow();
   });
+
+  describe('metadata', () => {
+    it('includes expected state in debug snapshots', () => {
+      type ComposableControllerState = {
+        FooController: FooControllerState;
+      };
+      const messenger = new Messenger<
+        never,
+        | ComposableControllerEvents<ComposableControllerState>
+        | FooControllerEvent
+      >();
+      const fooMessenger = messenger.getRestricted<
+        'FooController',
+        never,
+        never
+      >({
+        name: 'FooController',
+        allowedActions: [],
+        allowedEvents: [],
+      });
+      const fooController = new FooController(fooMessenger);
+      const composableControllerMessenger = messenger.getRestricted({
+        name: 'ComposableController',
+        allowedActions: [],
+        allowedEvents: ['FooController:stateChange'],
+      });
+      const controller = new ComposableController<
+        ComposableControllerState,
+        Pick<ControllersMap, keyof ComposableControllerState>
+      >({
+        controllers: {
+          FooController: fooController,
+        },
+        messenger: composableControllerMessenger,
+      });
+
+      expect(
+        deriveStateFromMetadata(
+          controller.state,
+          controller.metadata,
+          'anonymous',
+        ),
+      ).toMatchInlineSnapshot(`
+        Object {
+          "FooController": Object {
+            "foo": "foo",
+          },
+        }
+      `);
+    });
+
+    it('includes expected state in state logs', () => {
+      type ComposableControllerState = {
+        FooController: FooControllerState;
+      };
+      const messenger = new Messenger<
+        never,
+        | ComposableControllerEvents<ComposableControllerState>
+        | FooControllerEvent
+      >();
+      const fooMessenger = messenger.getRestricted<
+        'FooController',
+        never,
+        never
+      >({
+        name: 'FooController',
+        allowedActions: [],
+        allowedEvents: [],
+      });
+      const fooController = new FooController(fooMessenger);
+      const composableControllerMessenger = messenger.getRestricted({
+        name: 'ComposableController',
+        allowedActions: [],
+        allowedEvents: ['FooController:stateChange'],
+      });
+      const controller = new ComposableController<
+        ComposableControllerState,
+        Pick<ControllersMap, keyof ComposableControllerState>
+      >({
+        controllers: {
+          FooController: fooController,
+        },
+        messenger: composableControllerMessenger,
+      });
+
+      expect(
+        deriveStateFromMetadata(
+          controller.state,
+          controller.metadata,
+          'includeInStateLogs',
+        ),
+      ).toMatchInlineSnapshot(`Object {}`);
+    });
+
+    it('persists expected state', () => {
+      type ComposableControllerState = {
+        FooController: FooControllerState;
+      };
+      const messenger = new Messenger<
+        never,
+        | ComposableControllerEvents<ComposableControllerState>
+        | FooControllerEvent
+      >();
+      const fooMessenger = messenger.getRestricted<
+        'FooController',
+        never,
+        never
+      >({
+        name: 'FooController',
+        allowedActions: [],
+        allowedEvents: [],
+      });
+      const fooController = new FooController(fooMessenger);
+      const composableControllerMessenger = messenger.getRestricted({
+        name: 'ComposableController',
+        allowedActions: [],
+        allowedEvents: ['FooController:stateChange'],
+      });
+      const controller = new ComposableController<
+        ComposableControllerState,
+        Pick<ControllersMap, keyof ComposableControllerState>
+      >({
+        controllers: {
+          FooController: fooController,
+        },
+        messenger: composableControllerMessenger,
+      });
+
+      expect(
+        deriveStateFromMetadata(
+          controller.state,
+          controller.metadata,
+          'persist',
+        ),
+      ).toMatchInlineSnapshot(`
+        Object {
+          "FooController": Object {
+            "foo": "foo",
+          },
+        }
+      `);
+    });
+
+    it('exposes expected state to UI', () => {
+      type ComposableControllerState = {
+        FooController: FooControllerState;
+      };
+      const messenger = new Messenger<
+        never,
+        | ComposableControllerEvents<ComposableControllerState>
+        | FooControllerEvent
+      >();
+      const fooMessenger = messenger.getRestricted<
+        'FooController',
+        never,
+        never
+      >({
+        name: 'FooController',
+        allowedActions: [],
+        allowedEvents: [],
+      });
+      const fooController = new FooController(fooMessenger);
+      const composableControllerMessenger = messenger.getRestricted({
+        name: 'ComposableController',
+        allowedActions: [],
+        allowedEvents: ['FooController:stateChange'],
+      });
+      const controller = new ComposableController<
+        ComposableControllerState,
+        Pick<ControllersMap, keyof ComposableControllerState>
+      >({
+        controllers: {
+          FooController: fooController,
+        },
+        messenger: composableControllerMessenger,
+      });
+
+      expect(
+        deriveStateFromMetadata(
+          controller.state,
+          controller.metadata,
+          'usedInUi',
+        ),
+      ).toMatchInlineSnapshot(`Object {}`);
+    });
+  });
 });

packages/composable-controller/src/ComposableController.ts

@@ -126,8 +126,10 @@ export class ComposableController<
         StateMetadata<ComposableControllerState>
       >((metadata, name) => {
         (metadata as StateMetadataConstraint)[name] = {
+          includeInStateLogs: false,
           persist: true,
           anonymous: true,
+          usedInUi: false,
         };
         return metadata;
       }, {} as never),

packages/keyring-controller/CHANGELOG.md

@@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 
 - Add `KeyringController:addNewKeyring` action ([#6439](https://github.com/MetaMask/core/pull/6439))
+- Add two new controller state metadata properties: `includeInStateLogs` and `usedInUi` ([#6525](https://github.com/MetaMask/core/pull/6525))
 
 ### Changed
 

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

@@ -1,7 +1,7 @@
 import { Chain, Common, Hardfork } from '@ethereumjs/common';
 import type { TypedTxData } from '@ethereumjs/tx';
 import { TransactionFactory } from '@ethereumjs/tx';
-import { Messenger } from '@metamask/base-controller';
+import { Messenger, deriveStateFromMetadata } from '@metamask/base-controller';
 import { HdKeyring } from '@metamask/eth-hd-keyring';
 import {
   normalize,
@@ -4264,6 +4264,90 @@ describe('KeyringController', () => {
       });
     });
   });
+
+  describe('metadata', () => {
+    it('includes expected state in debug snapshots', async () => {
+      await withController(
+        // Skip vault creation and use static vault to get deterministic state snapshot
+        { skipVaultCreation: true, state: { vault: freshVault } },
+        ({ controller }) => {
+          expect(
+            deriveStateFromMetadata(
+              controller.state,
+              controller.metadata,
+              'anonymous',
+            ),
+          ).toMatchInlineSnapshot(`
+            Object {
+              "isUnlocked": false,
+            }
+          `);
+        },
+      );
+    });
+
+    it('includes expected state in state logs', async () => {
+      await withController(
+        // Skip vault creation and use static vault to get deterministic state snapshot
+        { skipVaultCreation: true, state: { vault: freshVault } },
+        ({ controller }) => {
+          expect(
+            deriveStateFromMetadata(
+              controller.state,
+              controller.metadata,
+              'includeInStateLogs',
+            ),
+          ).toMatchInlineSnapshot(`
+            Object {
+              "isUnlocked": false,
+              "keyrings": Array [],
+            }
+          `);
+        },
+      );
+    });
+
+    it('persists expected state', async () => {
+      await withController(
+        // Skip vault creation and use static vault to get deterministic state snapshot
+        { skipVaultCreation: true, state: { vault: freshVault } },
+        ({ controller }) => {
+          expect(
+            deriveStateFromMetadata(
+              controller.state,
+              controller.metadata,
+              'persist',
+            ),
+          ).toMatchInlineSnapshot(`
+            Object {
+              "vault": "{\\"data\\":\\"{\\\\\\"tag\\\\\\":{\\\\\\"key\\\\\\":{\\\\\\"password\\\\\\":\\\\\\"password123\\\\\\",\\\\\\"salt\\\\\\":\\\\\\"salt\\\\\\"},\\\\\\"iv\\\\\\":\\\\\\"iv\\\\\\"},\\\\\\"value\\\\\\":[{\\\\\\"type\\\\\\":\\\\\\"HD Key Tree\\\\\\",\\\\\\"data\\\\\\":{\\\\\\"mnemonic\\\\\\":[119,97,114,114,105,111,114,32,108,97,110,103,117,97,103,101,32,106,111,107,101,32,98,111,110,117,115,32,117,110,102,97,105,114,32,97,114,116,105,115,116,32,107,97,110,103,97,114,111,111,32,99,105,114,99,108,101,32,101,120,112,97,110,100,32,104,111,112,101,32,109,105,100,100,108,101,32,103,97,117,103,101],\\\\\\"numberOfAccounts\\\\\\":1,\\\\\\"hdPath\\\\\\":\\\\\\"m/44'/60'/0'/0\\\\\\"},\\\\\\"metadata\\\\\\":{\\\\\\"id\\\\\\":\\\\\\"01JXEFM7DAX2VJ0YFR4ESNY3GQ\\\\\\",\\\\\\"name\\\\\\":\\\\\\"\\\\\\"}}]}\\",\\"iv\\":\\"iv\\",\\"salt\\":\\"salt\\"}",
+            }
+          `);
+        },
+      );
+    });
+
+    it('exposes expected state to UI', async () => {
+      await withController(
+        // Skip vault creation and use static vault to get deterministic state snapshot
+        { skipVaultCreation: true, state: { vault: freshVault } },
+        ({ controller }) => {
+          expect(
+            deriveStateFromMetadata(
+              controller.state,
+              controller.metadata,
+              'usedInUi',
+            ),
+          ).toMatchInlineSnapshot(`
+            Object {
+              "isUnlocked": false,
+              "keyrings": Array [],
+            }
+          `);
+        },
+      );
+    });
+  });
 });
 
 type WithControllerCallback<ReturnValue> = ({

packages/keyring-controller/src/KeyringController.ts

@@ -680,11 +680,36 @@ export class KeyringController extends BaseController<
     super({
       name,
       metadata: {
-        vault: { persist: true, anonymous: false },
-        isUnlocked: { persist: false, anonymous: true },
-        keyrings: { persist: false, anonymous: false },
-        encryptionKey: { persist: false, anonymous: false },
-        encryptionSalt: { persist: false, anonymous: false },
+        vault: {
+          includeInStateLogs: false,
+          persist: true,
+          anonymous: false,
+          usedInUi: false,
+        },
+        isUnlocked: {
+          includeInStateLogs: true,
+          persist: false,
+          anonymous: true,
+          usedInUi: true,
+        },
+        keyrings: {
+          includeInStateLogs: true,
+          persist: false,
+          anonymous: false,
+          usedInUi: true,
+        },
+        encryptionKey: {
+          includeInStateLogs: false,
+          persist: false,
+          anonymous: false,
+          usedInUi: false,
+        },
+        encryptionSalt: {
+          includeInStateLogs: false,
+          persist: false,
+          anonymous: false,
+          usedInUi: false,
+        },
       },
       messenger,
       state: {

packages/multichain-network-controller/CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Add two new controller state metadata properties: `includeInStateLogs` and `usedInUi` ([#6525](https://github.com/MetaMask/core/pull/6525))
+
 ### Changed
 
 - Bump `@metamask/base-controller` from `^8.1.0` to `^8.3.0` ([#6355](https://github.com/MetaMask/core/pull/6355), [#6465](https://github.com/MetaMask/core/pull/6465))