update allowed actions in controller-utils and document example snap …

…params types
MetaMask · Dec 17, 2024 · e68ce95 · e68ce95
1 parent 68214c6
commit e68ce95
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/packages/examples/packages/cronjobs/src/types.ts b/packages/examples/packages/cronjobs/src/types.ts
@@ -1,7 +1,17 @@
+/**
+ * The parameters for calling the `scheduleNotification` JSON-RPC method.
+ *
+ * @property date - The ISO 8601 date of when the notification should be scheduled.
+ */
 export type ScheduleNotificationParams = {
   date: string;
 };
 
+/**
+ * The parameters for calling the `cancelNotification` JSON-RPC method.
+ *
+ * @property id - The id of the notification event to cancel.
+ */
 export type CancelNotificationParams = {
   id: string;
 };
diff --git a/packages/snaps-controllers/src/test-utils/controller.ts b/packages/snaps-controllers/src/test-utils/controller.ts
@@ -677,6 +677,7 @@ export const getRestrictedCronjobControllerMessenger = (
       'SnapController:handleRequest',
       'CronjobController:scheduleBackgroundEvent',
       'CronjobController:cancelBackgroundEvent',
+      'CronjobController:getBackgroundEvents',
     ],
   });