Add erc-20-token-periodic permission type (#106)

* Add erc-20-token-periodic permission type

* Update test expecting registered permission types

Author: jeffsmale90

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

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

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

@@ -2,6 +2,7 @@ import type { PermissionRequest } from '@metamask/7715-permissions-shared/types'
 import { extractPermissionName } from '@metamask/7715-permissions-shared/utils';
 
 import type { AccountController } from '../accountController';
+import { erc20TokenPeriodicPermissionDefinition } from '../permissions/erc20TokenPeriodic';
 import { erc20TokenStreamPermissionDefinition } from '../permissions/erc20TokenStream';
 import { nativeTokenPeriodicPermissionDefinition } from '../permissions/nativeTokenPeriodic';
 import { nativeTokenStreamPermissionDefinition } from '../permissions/nativeTokenStream';
@@ -104,6 +105,11 @@ export class PermissionHandlerFactory {
       case 'erc20-token-stream':
         handler = createPermissionHandler(erc20TokenStreamPermissionDefinition);
         break;
+      case 'erc20-token-periodic':
+        handler = createPermissionHandler(
+          erc20TokenPeriodicPermissionDefinition,
+        );
+        break;
       default:
         throw new Error(`Unsupported permission type: ${type}`);
     }

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

@@ -0,0 +1,33 @@
+import type { CoreCaveatBuilder } from '@metamask/delegation-toolkit';
+
+import type { PopulatedErc20TokenPeriodicPermission } from './types';
+
+/**
+ * Appends permission-specific caveats to the caveat builder.
+ * @param options0 - The options object containing the permission and caveat builder.
+ * @param options0.permission - The complete ERC20 token periodic permission containing periodic parameters.
+ * @param options0.caveatBuilder - The core caveat builder to append caveats to.
+ * @returns The modified caveat builder with appended ERC20 token periodic caveats.
+ */
+export async function appendCaveats({
+  permission,
+  caveatBuilder,
+}: {
+  permission: PopulatedErc20TokenPeriodicPermission;
+  caveatBuilder: CoreCaveatBuilder;
+}): Promise<CoreCaveatBuilder> {
+  const { periodAmount, periodDuration, startTime, tokenAddress } =
+    permission.data;
+
+  caveatBuilder
+    .addCaveat(
+      'erc20PeriodTransfer',
+      tokenAddress,
+      BigInt(periodAmount),
+      periodDuration,
+      startTime,
+    )
+    .addCaveat('valueLte', 0n);
+
+  return caveatBuilder;
+}

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

@@ -0,0 +1,109 @@
+import type { GenericSnapElement } from '@metamask/snaps-sdk/jsx';
+import { Box, Section } from '@metamask/snaps-sdk/jsx';
+
+import { getChainName } from '../../../../shared/src/utils/common';
+import { JUSTIFICATION_SHOW_MORE_BUTTON_NAME } from '../../core/permissionHandler';
+import { renderRules } from '../../core/rules';
+import { AccountDetails } from '../../ui/components/AccountDetails';
+import type { ItemDetails } from '../../ui/components/RequestDetails';
+import { RequestDetails } from '../../ui/components/RequestDetails';
+import {
+  periodAmountRule,
+  periodTypeRule,
+  periodDurationRule,
+  startTimeRule,
+  expiryRule,
+} from './rules';
+import type {
+  Erc20TokenPeriodicContext,
+  Erc20TokenPeriodicMetadata,
+} from './types';
+
+/**
+ * Creates UI content for an ERC20 token periodic permission confirmation.
+ *
+ * @param args - The configuration for the confirmation content.
+ * @param args.context - The context containing permission details.
+ * @param args.metadata - Metadata including derived values and validation errors.
+ * @param args.isJustificationCollapsed - Whether the justification section is collapsed.
+ * @param args.origin - The origin requesting the permission.
+ * @param args.chainId - The chain ID for the permission.
+ * @returns A Promise that resolves to the UI element for the confirmation dialog.
+ */
+export async function createConfirmationContent({
+  context,
+  metadata,
+  isJustificationCollapsed,
+  origin,
+  chainId,
+}: {
+  context: Erc20TokenPeriodicContext;
+  metadata: Erc20TokenPeriodicMetadata;
+  isJustificationCollapsed: boolean;
+  origin: string;
+  chainId: number;
+}): Promise<GenericSnapElement> {
+  const networkName = getChainName(chainId);
+
+  const itemDetails: ItemDetails[] = [
+    {
+      label: 'Recipient',
+      text: origin,
+      tooltipText: 'The site requesting the permission',
+    },
+    {
+      label: 'Network',
+      text: networkName,
+      tooltipText: 'The network on which the permission is being requested',
+    },
+    {
+      label: 'Token',
+      text: context.tokenMetadata.symbol,
+      iconData: context.tokenMetadata.iconDataBase64
+        ? {
+            iconDataBase64: context.tokenMetadata.iconDataBase64,
+            altText: context.tokenMetadata.symbol,
+          }
+        : undefined,
+    },
+  ];
+
+  return (
+    <Box>
+      <Box direction="vertical">
+        <RequestDetails
+          itemDetails={itemDetails}
+          justification={context.justification}
+          isJustificationShowMoreCollapsed={isJustificationCollapsed}
+          justificationShowMoreElementName={JUSTIFICATION_SHOW_MORE_BUTTON_NAME}
+        />
+        <AccountDetails
+          account={context.accountDetails}
+          tokenMetadata={context.tokenMetadata}
+          title="Transfer from"
+          tooltip="The account that the token transfers come from."
+        />
+        <Section>
+          {renderRules({
+            rules: [
+              startTimeRule,
+              periodAmountRule,
+              periodTypeRule,
+              periodDurationRule,
+            ],
+            context,
+            metadata,
+          })}
+        </Section>
+
+        <Section>
+          {renderRules({
+            rules: [expiryRule],
+            context,
+            metadata,
+          })}
+        </Section>
+      </Box>
+    </Box>
+  );
+}