Refactor period handling to replace periodType with periodDuration in ERC20 and native token contexts; update related tests for consistency

Author: mj-kiwi

packages/gator-permissions-snap/src/permissions/erc20TokenPeriodic/content.tsx

@@ -3,7 +3,7 @@ import { Box, Section } from '@metamask/snaps-sdk/jsx';
 
 import {
   periodAmountRule,
-  periodTypeRule,
+  periodDurationRule,
   startTimeRule,
   expiryRule,
 } from './rules';
@@ -31,7 +31,7 @@ export async function createConfirmationContent({
     <Box>
       <Section>
         {renderRules({
-          rules: [startTimeRule, periodAmountRule, periodTypeRule],
+          rules: [startTimeRule, periodAmountRule, periodDurationRule],
           context,
           metadata,
         })}

packages/gator-permissions-snap/src/permissions/erc20TokenPeriodic/context.ts

@@ -8,9 +8,7 @@ import {
   type Hex,
 } from '@metamask/utils';
 
-import type { TimePeriod } from '../../core/types';
 import type { TokenMetadataService } from '../../services/tokenMetadataService';
-import { TIME_PERIOD_TO_SECONDS } from '../../utils/time';
 import { parseUnits, formatUnitsFromHex } from '../../utils/value';
 import {
   validateAndParseAmount,
@@ -178,10 +176,6 @@ export async function buildContext({
     decimals,
   });
 
-  const periodType = (Object.keys(TIME_PERIOD_TO_SECONDS) as TimePeriod[]).find(
-    (key: TimePeriod) =>
-      Number(TIME_PERIOD_TO_SECONDS[key]) === data.periodDuration,
-  );
   const periodDuration = data.periodDuration.toString();
 
   const startTime = data.startTime ?? Math.floor(Date.now() / 1000);
@@ -212,7 +206,6 @@ export async function buildContext({
     },
     permissionDetails: {
       periodAmount,
-      periodType,
       periodDuration,
       startTime,
     },

packages/gator-permissions-snap/src/permissions/erc20TokenPeriodic/rules.ts

@@ -2,7 +2,7 @@ import { InvalidInputError } from '@metamask/snaps-sdk';
 
 import { TimePeriod } from '../../core/types';
 import type { RuleDefinition } from '../../core/types';
-import { TIME_PERIOD_TO_SECONDS } from '../../utils/time';
+import { getClosestTimePeriod, TIME_PERIOD_TO_SECONDS } from '../../utils/time';
 import { getIconData } from '../iconUtil';
 import type {
   Erc20TokenPeriodicContext,
@@ -38,7 +38,7 @@ export const periodAmountRule: RuleDefinition<
   }),
 };
 
-export const periodTypeRule: RuleDefinition<
+export const periodDurationRule: RuleDefinition<
   Erc20TokenPeriodicContext,
   Erc20TokenPeriodicMetadata
 > = {
@@ -47,18 +47,13 @@ export const periodTypeRule: RuleDefinition<
   type: 'dropdown',
   getRuleData: ({ context, metadata }) => ({
     isAdjustmentAllowed: context.isAdjustmentAllowed,
-    value: context.permissionDetails.periodType,
+    value: getClosestTimePeriod(
+      parseInt(context.permissionDetails.periodDuration, 10),
+    ),
     isVisible: true,
     tooltip: 'The duration of the period',
-    options: [
-      TimePeriod.HOURLY,
-      TimePeriod.DAILY,
-      TimePeriod.WEEKLY,
-      TimePeriod.BIWEEKLY,
-      TimePeriod.MONTHLY,
-      TimePeriod.YEARLY,
-    ],
-    error: metadata.validationErrors.periodTypeError,
+    options: Object.values(TimePeriod),
+    error: metadata.validationErrors.periodDurationError,
   }),
   updateContext: (context: Erc20TokenPeriodicContext, value: string) => {
     // Validate that value is a valid TimePeriod
@@ -84,7 +79,6 @@ export const periodTypeRule: RuleDefinition<
       ...context,
       permissionDetails: {
         ...context.permissionDetails,
-        periodType,
         periodDuration,
       },
     };
@@ -159,7 +153,7 @@ export const expiryRule: RuleDefinition<
 
 export const allRules = [
   periodAmountRule,
-  periodTypeRule,
+  periodDurationRule,
   startTimeRule,
   expiryRule,
 ];

packages/gator-permissions-snap/src/permissions/erc20TokenPeriodic/types.ts

@@ -11,7 +11,6 @@ import type {
   DeepRequired,
   TypedPermissionRequest,
   BaseContext,
-  TimePeriod,
   BaseMetadata,
 } from '../../core/types';
 import { zPeriodDuration } from '../../utils/time';
@@ -20,7 +19,6 @@ export type Erc20TokenPeriodicMetadata = BaseMetadata & {
   validationErrors: {
     periodAmountError?: string;
     periodDurationError?: string;
-    periodTypeError?: string;
     startTimeError?: string;
     expiryError?: string;
   };
@@ -29,7 +27,6 @@ export type Erc20TokenPeriodicMetadata = BaseMetadata & {
 export type Erc20TokenPeriodicContext = BaseContext & {
   permissionDetails: {
     periodAmount: string;
-    periodType: TimePeriod;
     periodDuration: string;
     startTime: number;
   };

packages/gator-permissions-snap/src/permissions/nativeTokenPeriodic/content.tsx

@@ -3,7 +3,7 @@ import { Box, Section } from '@metamask/snaps-sdk/jsx';
 
 import {
   periodAmountRule,
-  periodTypeRule,
+  periodDurationRule,
   startTimeRule,
   expiryRule,
 } from './rules';
@@ -31,7 +31,7 @@ export async function createConfirmationContent({
     <Box>
       <Section>
         {renderRules({
-          rules: [startTimeRule, periodAmountRule, periodTypeRule],
+          rules: [startTimeRule, periodAmountRule, periodDurationRule],
           context,
           metadata,
         })}

packages/gator-permissions-snap/src/permissions/nativeTokenPeriodic/context.ts

@@ -8,9 +8,7 @@ import {
   type Hex,
 } from '@metamask/utils';
 
-import type { TimePeriod } from '../../core/types';
 import type { TokenMetadataService } from '../../services/tokenMetadataService';
-import { TIME_PERIOD_TO_SECONDS } from '../../utils/time';
 import { parseUnits, formatUnitsFromHex } from '../../utils/value';
 import {
   validateAndParseAmount,
@@ -178,10 +176,6 @@ export async function buildContext({
     decimals,
   });
 
-  const periodType = (Object.keys(TIME_PERIOD_TO_SECONDS) as TimePeriod[]).find(
-    (key: TimePeriod) =>
-      Number(TIME_PERIOD_TO_SECONDS[key]) === data.periodDuration,
-  );
   const periodDuration = data.periodDuration.toString();
 
   const startTime = data.startTime ?? Math.floor(Date.now() / 1000);
@@ -212,7 +206,6 @@ export async function buildContext({
     },
     permissionDetails: {
       periodAmount,
-      periodType,
       periodDuration,
       startTime,
     },

packages/gator-permissions-snap/src/permissions/nativeTokenPeriodic/rules.ts

@@ -2,7 +2,7 @@ import { InvalidInputError } from '@metamask/snaps-sdk';
 
 import { TimePeriod } from '../../core/types';
 import type { RuleDefinition } from '../../core/types';
-import { TIME_PERIOD_TO_SECONDS } from '../../utils/time';
+import { getClosestTimePeriod, TIME_PERIOD_TO_SECONDS } from '../../utils/time';
 import { getIconData } from '../iconUtil';
 import type {
   NativeTokenPeriodicContext,
@@ -38,7 +38,7 @@ export const periodAmountRule: RuleDefinition<
   }),
 };
 
-export const periodTypeRule: RuleDefinition<
+export const periodDurationRule: RuleDefinition<
   NativeTokenPeriodicContext,
   NativeTokenPeriodicMetadata
 > = {
@@ -47,18 +47,13 @@ export const periodTypeRule: RuleDefinition<
   type: 'dropdown',
   getRuleData: ({ context, metadata }) => ({
     isAdjustmentAllowed: context.isAdjustmentAllowed,
-    value: context.permissionDetails.periodType,
+    value: getClosestTimePeriod(
+      parseInt(context.permissionDetails.periodDuration, 10),
+    ),
     isVisible: true,
     tooltip: 'The duration of the period',
-    options: [
-      TimePeriod.HOURLY,
-      TimePeriod.DAILY,
-      TimePeriod.WEEKLY,
-      TimePeriod.BIWEEKLY,
-      TimePeriod.MONTHLY,
-      TimePeriod.YEARLY,
-    ],
-    error: metadata.validationErrors.periodTypeError,
+    options: Object.values(TimePeriod),
+    error: metadata.validationErrors.periodDurationError,
   }),
   updateContext: (context: NativeTokenPeriodicContext, value: string) => {
     // Validate that value is a valid TimePeriod
@@ -84,7 +79,6 @@ export const periodTypeRule: RuleDefinition<
       ...context,
       permissionDetails: {
         ...context.permissionDetails,
-        periodType,
         periodDuration,
       },
     };
@@ -159,7 +153,7 @@ export const expiryRule: RuleDefinition<
 
 export const allRules = [
   periodAmountRule,
-  periodTypeRule,
+  periodDurationRule,
   startTimeRule,
   expiryRule,
 ];

packages/gator-permissions-snap/src/permissions/nativeTokenPeriodic/types.ts

@@ -10,7 +10,6 @@ import type {
   DeepRequired,
   TypedPermissionRequest,
   BaseContext,
-  TimePeriod,
   BaseMetadata,
 } from '../../core/types';
 import { zPeriodDuration } from '../../utils/time';
@@ -19,7 +18,6 @@ export type NativeTokenPeriodicMetadata = BaseMetadata & {
   validationErrors: {
     periodAmountError?: string;
     periodDurationError?: string;
-    periodTypeError?: string;
     startTimeError?: string;
     expiryError?: string;
   };
@@ -28,7 +26,6 @@ export type NativeTokenPeriodicMetadata = BaseMetadata & {
 export type NativeTokenPeriodicContext = BaseContext & {
   permissionDetails: {
     periodAmount: string;
-    periodType: TimePeriod;
     periodDuration: string;
     startTime: number;
   };

packages/gator-permissions-snap/test/permissions/erc20TokenPeriodic/content.test.ts

@@ -27,7 +27,6 @@ const mockContext: Erc20TokenPeriodicContext = {
   },
   permissionDetails: {
     periodAmount: '100',
-    periodType: TimePeriod.DAILY,
     periodDuration: Number(TIME_PERIOD_TO_SECONDS[TimePeriod.DAILY]).toString(),
     startTime: 499161600, // 10/26/1985
   },
@@ -1115,7 +1114,6 @@ describe('erc20TokenPeriodic:content', () => {
         ...mockContext,
         permissionDetails: {
           ...mockContext.permissionDetails,
-          periodType: TimePeriod.WEEKLY,
           periodDuration: Number(
             TIME_PERIOD_TO_SECONDS[TimePeriod.WEEKLY],
           ).toString(),
@@ -3086,6 +3084,7 @@ describe('erc20TokenPeriodic:content', () => {
                         },
                         "type": "Dropdown",
                       },
+                      "error": "Invalid period duration",
                     },
                     "type": "Field",
                   },

packages/gator-permissions-snap/test/permissions/erc20TokenPeriodic/context.test.ts

@@ -89,7 +89,6 @@ const alreadyPopulatedContext: Erc20TokenPeriodicContext = {
   },
   permissionDetails: {
     periodAmount: '100',
-    periodType: TimePeriod.DAILY,
     periodDuration: Number(TIME_PERIOD_TO_SECONDS[TimePeriod.DAILY]).toString(),
     startTime: 1729900800,
   },
@@ -220,7 +219,7 @@ describe('erc20TokenPeriodic:context', () => {
     it('throws an error if the permission request has no rules', async () => {
       const permissionRequest = {
         ...alreadyPopulatedPermissionRequest,
-        rules: undefined,
+        rules: [],
       };
 
       await expect(