Add getState action to BaseControllerV2 (#457)

This allows getting the state of the controller via the controller messenger.
MetaMask · Oct 11, 2023 · 9ca7299 · 9ca7299
1 parent fabd56c
commit 9ca7299
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 0 deletions.
diff --git a/src/BaseControllerV2.test.ts b/src/BaseControllerV2.test.ts
@@ -87,6 +87,23 @@ describe('BaseController', () => {
     expect(controller.state).toStrictEqual({ count: 0 });
   });
 
+  it('should allow getting state via the getState action', () => {
+    const controllerMessenger = new ControllerMessenger<
+      CountControllerAction,
+      CountControllerEvent
+    >();
+    new CountController({
+      messenger: getCountMessenger(controllerMessenger),
+      name: countControllerName,
+      state: { count: 0 },
+      metadata: countControllerStateMetadata,
+    });
+
+    expect(controllerMessenger.call('CountController:getState')).toStrictEqual({
+      count: 0,
+    });
+  });
+
   it('should set initial schema', () => {
     const controller = new CountController({
       messenger: getCountMessenger(),

diff --git a/src/BaseControllerV2.ts b/src/BaseControllerV2.ts
@@ -156,6 +156,11 @@ export class BaseController<
     this.name = name;
     this.internalState = state;
     this.metadata = metadata;
+
+    this.messagingSystem.registerActionHandler(
+      `${name}:getState`,
+      () => this.state,
+    );
   }
 
   /**