Define getState action, stateChange event for PPOMController

MetaMask · Jul 26, 2024 · 244a10a · 244a10a
1 parent 857d4cb
commit 244a10a
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 5 deletions.
diff --git a/src/index.ts b/src/index.ts
@@ -3,6 +3,9 @@ export type {
   PPOMState,
   UsePPOM,
   PPOMControllerActions,
+  PPOMControllerEvents,
+  PPOMControllerGetStateAction,
+  PPOMControllerStateChangeEvent,
   PPOMControllerMessenger,
 } from './ppom-controller';
 export { NETWORK_CACHE_DURATION, PPOMController } from './ppom-controller';

diff --git a/src/ppom-controller.ts b/src/ppom-controller.ts
@@ -1,4 +1,4 @@
-import type { RestrictedControllerMessenger } from '@metamask/base-controller';
+import type { ControllerGetStateAction, ControllerStateChangeEvent, RestrictedControllerMessenger } from '@metamask/base-controller';
 import { BaseController } from '@metamask/base-controller';
 import { safelyExecute, timeoutFetch } from '@metamask/controller-utils';
 import type {
@@ -127,7 +127,13 @@ export type UsePPOM = {
   handler: (callback: (ppom: PPOM) => Promise<unknown>) => Promise<unknown>;
 };
 
-export type PPOMControllerActions = UsePPOM;
+export type PPOMControllerGetStateAction = ControllerGetStateAction<typeof controllerName, PPOMState>;
+
+export type PPOMControllerActions = PPOMControllerGetStateAction | UsePPOM;
+
+export type PPOMControllerStateChangeEvent = ControllerStateChangeEvent<typeof controllerName, PPOMState>;
+
+export type PPOMControllerEvents = PPOMControllerStateChangeEvent;
 
 export type AllowedEvents = NetworkControllerNetworkDidChangeEvent;
 
@@ -136,7 +142,7 @@ export type AllowedActions = NetworkControllerGetNetworkClientByIdAction;
 export type PPOMControllerMessenger = RestrictedControllerMessenger<
   typeof controllerName,
   PPOMControllerActions | AllowedActions,
-  AllowedEvents,
+  PPOMControllerEvents | AllowedEvents,
   AllowedActions['type'],
   AllowedEvents['type']
 >;

diff --git a/test/test-utils.ts b/test/test-utils.ts
@@ -10,7 +10,7 @@ import type {
   AllowedEvents,
   PPOMControllerActions,
 } from '../src/ppom-controller';
-import { PPOMController } from '../src/ppom-controller';
+import { PPOMController, PPOMControllerEvents } from '../src/ppom-controller';
 import type { StorageKey } from '../src/ppom-storage';
 import { SUPPORTED_NETWORK_CHAINIDS } from '../src/util';
 
@@ -181,7 +181,7 @@ export class PPOMClass {
 export const buildPPOMController = (options?: any) => {
   const controllerMessenger: ControllerMessenger<
     PPOMControllerActions | AllowedActions,
-    AllowedEvents
+    PPOMControllerEvents | AllowedEvents
   > = new ControllerMessenger();
   const messenger = controllerMessenger.getRestricted({
     name: 'PPOMController',