Merge pull request #89 from MetaMask/feat/native-token-periodic

Add `native-token-periodic` permission

Author: jeffsmale90

packages/gator-permissions-snap/snap.manifest.json

@@ -7,7 +7,7 @@
     "url": "https://github.com/MetaMask/snap-7715-permissions.git"
   },
   "source": {
-    "shasum": "v1B05D89zwDAj6nm4a1UG2nA1s5h/k6sFLYGUPJliGc=",
+    "shasum": "D1xZgkqOmv2yug3z6/YsbDkUWAzgxWujvWgz+W5bWH8=",
     "location": {
       "npm": {
         "filePath": "dist/bundle.js",

packages/gator-permissions-snap/src/core/permissionHandler.ts

@@ -1,6 +1,5 @@
 import type { PermissionRequest } from '@metamask/7715-permissions-shared/types';
 import { UserInputEventType } from '@metamask/snaps-sdk';
-import { type GenericSnapElement } from '@metamask/snaps-sdk/jsx';
 
 import type { AccountController } from '../accountController';
 import type { TokenPricesService } from '../services/tokenPricesService';
@@ -19,68 +18,12 @@ import type {
   PermissionRequestResult,
   RuleDefinition,
   PermissionHandlerType,
+  PermissionHandlerDependencies,
+  PermissionHandlerParams,
 } from './types';
 
 export const JUSTIFICATION_SHOW_MORE_BUTTON_NAME = 'show-more-justification';
 
-export type PermissionHandlerDependencies<
-  TRequest extends PermissionRequest,
-  TContext extends BaseContext,
-  TMetadata extends object,
-  TPermission extends TRequest['permission'],
-  TPopulatedPermission extends DeepRequired<TPermission>,
-> = {
-  validateRequest: (permissionRequest: TRequest) => TRequest;
-  buildContext: (args: {
-    permissionRequest: TRequest;
-    tokenPricesService: any;
-    accountController: AccountController;
-  }) => Promise<TContext>;
-  deriveMetadata: (args: { context: TContext }) => Promise<TMetadata>;
-  createConfirmationContent: (args: {
-    context: TContext;
-    metadata: TMetadata;
-    origin: string;
-    chainId: number;
-    isJustificationCollapsed: boolean;
-    showAddMoreRulesButton: boolean;
-  }) => Promise<GenericSnapElement>;
-  applyContext: (args: {
-    context: TContext;
-    originalRequest: TRequest;
-  }) => Promise<TRequest>;
-  populatePermission: (args: {
-    permission: TPermission;
-  }) => Promise<TPopulatedPermission>;
-  appendCaveats: (args: {
-    permission: TPopulatedPermission;
-    caveatBuilder: any;
-  }) => Promise<any>;
-};
-
-export type PermissionHandlerParams<
-  TRequest extends PermissionRequest,
-  TContext extends BaseContext,
-  TMetadata extends object,
-  TPermission extends TRequest['permission'],
-  TPopulatedPermission extends DeepRequired<TPermission>,
-> = {
-  accountController: AccountController;
-  userEventDispatcher: UserEventDispatcher;
-  orchestrator: PermissionRequestLifecycleOrchestrator;
-  permissionRequest: TRequest;
-  dependencies: PermissionHandlerDependencies<
-    TRequest,
-    TContext,
-    TMetadata,
-    TPermission,
-    TPopulatedPermission
-  >;
-  tokenPricesService: any;
-  rules: RuleDefinition<TContext, TMetadata>[];
-  title: string;
-};
-
 /**
  * Handler for permission requests.
  * Coordinates the permission-specific validation, UI, and caveat logic.
@@ -99,7 +42,7 @@ export class PermissionHandler<
 
   readonly #orchestrator: PermissionRequestLifecycleOrchestrator;
 
-  readonly #permissionRequest: TRequest;
+  readonly #permissionRequest: PermissionRequest;
 
   readonly #dependencies: PermissionHandlerDependencies<
     TRequest,
@@ -290,15 +233,15 @@ export class PermissionHandler<
     };
 
     const {
-      validateRequest,
+      parseAndValidatePermission,
       applyContext,
       populatePermission,
       appendCaveats,
       deriveMetadata,
     } = this.#dependencies;
 
     return {
-      validateRequest,
+      parseAndValidatePermission,
       applyContext,
       populatePermission,
       appendCaveats,

packages/gator-permissions-snap/src/core/permissionHandlerFactory.ts

@@ -2,13 +2,18 @@ import type { PermissionRequest } from '@metamask/7715-permissions-shared/types'
 import { extractPermissionName } from '@metamask/7715-permissions-shared/utils';
 
 import type { AccountController } from '../accountController';
-import { createNativeTokenStreamHandler } from '../permissions/nativeTokenStream/createHandler';
-import type { NativeTokenStreamPermissionRequest } from '../permissions/nativeTokenStream/types';
+import { nativeTokenPeriodicPermissionDefinition } from '../permissions/nativeTokenPeriodic';
+import { nativeTokenStreamPermissionDefinition } from '../permissions/nativeTokenStream';
 import type { TokenPricesService } from '../services/tokenPricesService';
 import type { UserEventDispatcher } from '../userEventDispatcher';
-import type { ConfirmationDialogFactory } from './confirmationFactory';
+import { PermissionHandler } from './permissionHandler';
 import type { PermissionRequestLifecycleOrchestrator } from './permissionRequestLifecycleOrchestrator';
-import type { PermissionHandlerType } from './types';
+import type {
+  BaseContext,
+  DeepRequired,
+  PermissionDefinition,
+  PermissionHandlerType,
+} from './types';
 
 /**
  * Factory for creating permission-specific orchestrators.
@@ -19,28 +24,23 @@ export class PermissionHandlerFactory {
 
   readonly #tokenPricesService: TokenPricesService;
 
-  readonly #confirmationDialogFactory: ConfirmationDialogFactory;
-
   readonly #userEventDispatcher: UserEventDispatcher;
 
   readonly #orchestrator: PermissionRequestLifecycleOrchestrator;
 
   constructor({
     accountController,
     tokenPricesService,
-    confirmationDialogFactory,
     userEventDispatcher,
     orchestrator,
   }: {
     accountController: AccountController;
     tokenPricesService: TokenPricesService;
-    confirmationDialogFactory: ConfirmationDialogFactory;
     userEventDispatcher: UserEventDispatcher;
     orchestrator: PermissionRequestLifecycleOrchestrator;
   }) {
     this.#accountController = accountController;
     this.#tokenPricesService = tokenPricesService;
-    this.#confirmationDialogFactory = confirmationDialogFactory;
     this.#userEventDispatcher = userEventDispatcher;
     this.#orchestrator = orchestrator;
   }
@@ -56,23 +56,47 @@ export class PermissionHandlerFactory {
   ): PermissionHandlerType {
     const type = extractPermissionName(permissionRequest.permission.type);
 
-    const baseDependencies = {
-      permissionRequest:
-        permissionRequest as NativeTokenStreamPermissionRequest,
-      accountController: this.#accountController,
-      confirmationDialogFactory: this.#confirmationDialogFactory,
-      userEventDispatcher: this.#userEventDispatcher,
-      orchestrator: this.#orchestrator,
+    const createPermissionHandler = <
+      TRequest extends PermissionRequest,
+      TContext extends BaseContext,
+      TMetadata extends object,
+      TPermission extends TRequest['permission'],
+      TPopulatedPermission extends DeepRequired<TPermission>,
+    >(
+      permissionDefinition: PermissionDefinition<
+        TRequest,
+        TContext,
+        TMetadata,
+        TPermission,
+        TPopulatedPermission
+      >,
+    ): PermissionHandlerType => {
+      return new PermissionHandler({
+        ...permissionDefinition,
+        accountController: this.#accountController,
+        userEventDispatcher: this.#userEventDispatcher,
+        orchestrator: this.#orchestrator,
+        permissionRequest,
+        tokenPricesService: this.#tokenPricesService,
+      });
     };
+    let handler: PermissionHandlerType;
 
     switch (type) {
       case 'native-token-stream':
-        return createNativeTokenStreamHandler({
-          ...baseDependencies,
-          tokenPricesService: this.#tokenPricesService,
-        });
+        handler = createPermissionHandler(
+          nativeTokenStreamPermissionDefinition,
+        );
+        break;
+      case 'native-token-periodic':
+        handler = createPermissionHandler(
+          nativeTokenPeriodicPermissionDefinition,
+        );
+        break;
       default:
         throw new Error(`Unsupported permission type: ${type}`);
     }
+
+    return handler;
   }
 }

packages/gator-permissions-snap/src/core/permissionRequestLifecycleOrchestrator.ts

@@ -54,7 +54,7 @@ export class PermissionRequestLifecycleOrchestrator {
     TPopulatedPermission extends DeepRequired<TPermission>,
   >(
     origin: string,
-    permissionRequest: TRequest,
+    permissionRequest: PermissionRequest,
     lifecycleHandlers: LifecycleOrchestrationHandlers<
       TRequest,
       TContext,
@@ -66,7 +66,7 @@ export class PermissionRequestLifecycleOrchestrator {
     const isAdjustmentAllowed = permissionRequest.isAdjustmentAllowed ?? true;
 
     const validatedPermissionRequest =
-      lifecycleHandlers.validateRequest(permissionRequest);
+      lifecycleHandlers.parseAndValidatePermission(permissionRequest);
 
     const chainId = parseInt(permissionRequest.chainId, 16);
 

packages/gator-permissions-snap/src/core/ruleModalManager.tsx

@@ -84,7 +84,7 @@ export class RuleModalManager<
   }
 
   hasRulesToAdd(args: { context: TContext }) {
-    return this.#getRulesToAdd(args).length > 0;
+    return this.#getRulesToAdd({ context: args.context }).length > 0;
   }
 
   async renderModal() {

packages/gator-permissions-snap/src/core/rules.tsx

@@ -32,7 +32,9 @@ export function renderRule<
 }): GenericSnapElement | null {
   const value = rule.value(context);
 
-  if (value === undefined) {
+  const isVisible = rule.isVisible?.(context) ?? true;
+
+  if (value === undefined || !isVisible) {
     // If the value is not set, don't render the rule
     return null;
   }