Add new time periods for ERC20 and native token permissions (#190)

* Add new time periods and refactor related logic for ERC20 and native token permissions

* Update tests

* Add tests for getClosestTimePeriod function and related time periods

* Remove debug logs and add comments for time period constants in context and time utility files

* Enhance time period validation and error handling in ERC20 and native token contexts; add tests for edge cases in getClosestTimePeriod function

* Refactor periodDuration type to use zPeriodDuration in ERC20 and native token contexts; add zPeriodDuration definition

* Refactor time period handling to simplify duration conversion; update tests and labels for consistency

* Refactor time period handling in ERC20 and native token contexts to remove getClosestTimePeriod function; simplify duration conversion logic

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

* Refactor periodDuration handling to change type from string to number across ERC20 and native token contexts; update related tests for consistency

Author: mj-kiwi

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

@@ -91,9 +91,12 @@ export type DeepRequired<TParent> = TParent extends (infer U)[]
  * An enum representing the time periods for which the stream rate can be calculated.
  */
 export enum TimePeriod {
+  HOURLY = 'Hourly',
   DAILY = 'Daily',
   WEEKLY = 'Weekly',
+  BIWEEKLY = 'Biweekly',
   MONTHLY = 'Monthly',
+  YEARLY = 'Yearly',
 }
 
 /**

packages/gator-permissions-snap/src/permissions/contextValidation.ts

@@ -157,12 +157,12 @@ export function calculateAmountPerSecond(
  * @param periodDuration - The period duration string to validate.
  * @returns Object containing parsed duration and any validation error.
  */
-export function validatePeriodDuration(periodDuration: string): {
+export function validatePeriodDuration(periodDuration: number): {
   duration: number | undefined;
   error: string | undefined;
 } {
   try {
-    const duration = parseInt(periodDuration, 10);
+    const duration = periodDuration;
     if (isNaN(duration) || duration <= 0) {
       return {
         duration: undefined,

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

@@ -3,7 +3,6 @@ import { Box, Section } from '@metamask/snaps-sdk/jsx';
 
 import {
   periodAmountRule,
-  periodTypeRule,
   periodDurationRule,
   startTimeRule,
   expiryRule,
@@ -32,12 +31,7 @@ export async function createConfirmationContent({
     <Box>
       <Section>
         {renderRules({
-          rules: [
-            startTimeRule,
-            periodAmountRule,
-            periodTypeRule,
-            periodDurationRule,
-          ],
+          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 { 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,
@@ -76,7 +74,7 @@ export async function applyContext({
     periodAmount: bigIntToHex(
       parseUnits({ formatted: permissionDetails.periodAmount, decimals }),
     ),
-    periodDuration: parseInt(permissionDetails.periodDuration, 10),
+    periodDuration: permissionDetails.periodDuration,
     startTime: permissionDetails.startTime,
     justification: originalRequest.permission.data.justification,
     tokenAddress: originalRequest.permission.data.tokenAddress,
@@ -178,19 +176,7 @@ export async function buildContext({
     decimals,
   });
 
-  const periodDuration = data.periodDuration.toString();
-
-  // Determine the period type based on the duration
-  let periodType: TimePeriod | 'Other';
-  if (periodDuration === TIME_PERIOD_TO_SECONDS[TimePeriod.DAILY].toString()) {
-    periodType = TimePeriod.DAILY;
-  } else if (
-    periodDuration === TIME_PERIOD_TO_SECONDS[TimePeriod.WEEKLY].toString()
-  ) {
-    periodType = TimePeriod.WEEKLY;
-  } else {
-    periodType = 'Other';
-  }
+  const { periodDuration } = data;
 
   const startTime = data.startTime ?? Math.floor(Date.now() / 1000);
 
@@ -220,7 +206,6 @@ export async function buildContext({
     },
     permissionDetails: {
       periodAmount,
-      periodType,
       periodDuration,
       startTime,
     },

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

@@ -1,6 +1,8 @@
+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,
@@ -9,7 +11,6 @@ import type {
 
 export const PERIOD_AMOUNT_ELEMENT = 'erc20-token-periodic-period-amount';
 export const PERIOD_TYPE_ELEMENT = 'erc20-token-periodic-period-type';
-export const PERIOD_DURATION_ELEMENT = 'erc20-token-periodic-period-duration';
 export const START_TIME_ELEMENT = 'erc20-token-periodic-start-date';
 export const EXPIRY_ELEMENT = 'erc20-token-periodic-expiry';
 
@@ -37,62 +38,51 @@ export const periodAmountRule: RuleDefinition<
   }),
 };
 
-export const periodTypeRule: RuleDefinition<
+export const periodDurationRule: RuleDefinition<
   Erc20TokenPeriodicContext,
   Erc20TokenPeriodicMetadata
 > = {
   name: PERIOD_TYPE_ELEMENT,
-  label: 'Period duration',
+  label: 'Frequency',
   type: 'dropdown',
   getRuleData: ({ context, metadata }) => ({
     isAdjustmentAllowed: context.isAdjustmentAllowed,
-    value: context.permissionDetails.periodType,
+    value: getClosestTimePeriod(context.permissionDetails.periodDuration),
     isVisible: true,
     tooltip: 'The duration of the period',
-    options: [TimePeriod.DAILY, TimePeriod.WEEKLY, 'Other'],
-    error: metadata.validationErrors.periodTypeError,
+    options: Object.values(TimePeriod),
+    error: metadata.validationErrors.periodDurationError,
   }),
   updateContext: (context: Erc20TokenPeriodicContext, value: string) => {
-    const periodType = value as TimePeriod | 'Other';
-    const periodDuration =
-      periodType === 'Other'
-        ? context.permissionDetails.periodDuration
-        : Number(TIME_PERIOD_TO_SECONDS[periodType]).toString();
+    // Validate that value is a valid TimePeriod
+    if (!Object.values(TimePeriod).includes(value as TimePeriod)) {
+      throw new InvalidInputError(
+        `Invalid period type: "${value}". Valid options are: ${Object.values(TimePeriod).join(', ')}`,
+      );
+    }
+
+    const periodType = value as TimePeriod;
+    const periodSeconds = TIME_PERIOD_TO_SECONDS[periodType];
+
+    // This should never happen if the above check passed, but be defensive
+    if (periodSeconds === undefined) {
+      throw new InvalidInputError(
+        `Period type "${periodType}" is not mapped to a duration. This indicates a system error.`,
+      );
+    }
+
+    const periodDuration = Number(periodSeconds);
 
     return {
       ...context,
       permissionDetails: {
         ...context.permissionDetails,
-        periodType,
         periodDuration,
       },
     };
   },
 };
 
-export const periodDurationRule: RuleDefinition<
-  Erc20TokenPeriodicContext,
-  Erc20TokenPeriodicMetadata
-> = {
-  name: PERIOD_DURATION_ELEMENT,
-  label: 'Duration (seconds)',
-  type: 'number',
-  getRuleData: ({ context, metadata }) => ({
-    value: context.permissionDetails.periodDuration,
-    isAdjustmentAllowed: context.isAdjustmentAllowed,
-    isVisible: context.permissionDetails.periodType === 'Other',
-    tooltip: 'The length of each period in seconds',
-    error: metadata.validationErrors.periodDurationError,
-  }),
-  updateContext: (context: Erc20TokenPeriodicContext, value: string) => ({
-    ...context,
-    permissionDetails: {
-      ...context.permissionDetails,
-      periodDuration: value,
-    },
-  }),
-};
-
 export const startTimeRule: RuleDefinition<
   Erc20TokenPeriodicContext,
   Erc20TokenPeriodicMetadata
@@ -161,7 +151,6 @@ export const expiryRule: RuleDefinition<
 
 export const allRules = [
   periodAmountRule,
-  periodTypeRule,
   periodDurationRule,
   startTimeRule,
   expiryRule,

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

@@ -3,7 +3,6 @@ import {
   zPermission,
   zMetaMaskPermissionData,
   zAddress,
-  zTimestamp,
   zStartTime,
 } from '@metamask/7715-permissions-shared/types';
 import { z } from 'zod';
@@ -12,15 +11,14 @@ import type {
   DeepRequired,
   TypedPermissionRequest,
   BaseContext,
-  TimePeriod,
   BaseMetadata,
 } from '../../core/types';
+import { zPeriodDuration } from '../../utils/time';
 
 export type Erc20TokenPeriodicMetadata = BaseMetadata & {
   validationErrors: {
     periodAmountError?: string;
     periodDurationError?: string;
-    periodTypeError?: string;
     startTimeError?: string;
     expiryError?: string;
   };
@@ -29,8 +27,7 @@ export type Erc20TokenPeriodicMetadata = BaseMetadata & {
 export type Erc20TokenPeriodicContext = BaseContext & {
   permissionDetails: {
     periodAmount: string;
-    periodType: TimePeriod | 'Other';
-    periodDuration: string;
+    periodDuration: number;
     startTime: number;
   };
 };
@@ -41,7 +38,7 @@ export const zErc20TokenPeriodicPermission = zPermission.extend({
     zMetaMaskPermissionData,
     z.object({
       periodAmount: zHexStr,
-      periodDuration: zTimestamp,
+      periodDuration: zPeriodDuration,
       startTime: zStartTime,
       tokenAddress: zAddress,
     }),

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

@@ -3,7 +3,6 @@ import { Box, Section } from '@metamask/snaps-sdk/jsx';
 
 import {
   periodAmountRule,
-  periodTypeRule,
   periodDurationRule,
   startTimeRule,
   expiryRule,
@@ -32,12 +31,7 @@ export async function createConfirmationContent({
     <Box>
       <Section>
         {renderRules({
-          rules: [
-            startTimeRule,
-            periodAmountRule,
-            periodTypeRule,
-            periodDurationRule,
-          ],
+          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 { 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,
@@ -77,7 +75,7 @@ export async function applyContext({
     periodAmount: bigIntToHex(
       parseUnits({ formatted: permissionDetails.periodAmount, decimals }),
     ),
-    periodDuration: parseInt(permissionDetails.periodDuration, 10),
+    periodDuration: permissionDetails.periodDuration,
     startTime: permissionDetails.startTime,
     justification: originalRequest.permission.data.justification,
   };
@@ -178,19 +176,7 @@ export async function buildContext({
     decimals,
   });
 
-  const periodDuration = data.periodDuration.toString();
-
-  // Determine the period type based on the duration
-  let periodType: TimePeriod | 'Other';
-  if (periodDuration === TIME_PERIOD_TO_SECONDS[TimePeriod.DAILY].toString()) {
-    periodType = TimePeriod.DAILY;
-  } else if (
-    periodDuration === TIME_PERIOD_TO_SECONDS[TimePeriod.WEEKLY].toString()
-  ) {
-    periodType = TimePeriod.WEEKLY;
-  } else {
-    periodType = 'Other';
-  }
+  const { periodDuration } = data;
 
   const startTime = data.startTime ?? Math.floor(Date.now() / 1000);
 
@@ -220,7 +206,6 @@ export async function buildContext({
     },
     permissionDetails: {
       periodAmount,
-      periodType,
       periodDuration,
       startTime,
     },