feat: add token approval revocation functionality (#328)

* feat: implement token approval revocation functionality

- Add tests for token approval revocation context, content, and validation.
- Create a new TokenApprovalRevocationForm component to handle user input for revocation methods.
- Update the RedemptionForm to support various token approval revocation methods.
- Refactor existing ERC20TokenRevocationForm references to the new TokenApprovalRevocationForm.
- Modify the RPC handler and supported rule types to accommodate the new token approval revocation type.
- Remove deprecated ERC20TokenRevocationForm component.

* feat: update token approval revocation mechanisms and labels

* feat: update approval revocation enforcer address in chain metadata

* feat: update dependencies for delegation-core and permission-types

* feat: rename permit2ApproveZero to permit2Approve and update related references

* feat: update token approval revocation terminology and logic

* refactor: remove unnecessary newline in caveats test

* feat: update package dependencies and remove deprecated smart-accounts-kit reference

* feat: update token approval revocation test to reflect terminology change

* feat: refactor token approval revocation types and constants for clarity

Author: mj-kiwi

packages/gator-permissions-snap/locales/en.json

@@ -212,7 +212,7 @@
       "message": "Unknown chain $1"
     },
     "permissionRequestSubtitleRevocation": {
-      "message": "This site wants permissions to revoke your ERC-20 token approvals."
+      "message": "This site wants permissions to revoke your token approvals."
     },
     "introAdvancedPermissionsTitle": {
       "message": "Advanced permissions keep you in control"
@@ -251,7 +251,7 @@
       "message": "Token revocation request"
     },
     "introManageTokenApprovalsDescription": {
-      "message": "Token revocation allows sites to revoke token approvals on your behalf."
+      "message": "Token revocation allows sites to revoke ERC-20, NFT, and Permit2 approvals on your behalf."
     },
     "introAllowanceTitle": {
       "message": "Token allowance request"
@@ -318,6 +318,30 @@
     },
     "revokeTokenApprovalsLabel": {
       "message": "Revoke token approvals"
+    },
+    "approvalRevocationPrimitivesLabel": {
+      "message": "Revocation primitives"
+    },
+    "allApprovalRevocationPrimitivesLabel": {
+      "message": "All primitives"
+    },
+    "erc20ApproveRevocationLabel": {
+      "message": "ERC-20 approve(spender, 0)"
+    },
+    "erc721ApproveRevocationLabel": {
+      "message": "ERC-721 approve(address(0), tokenId)"
+    },
+    "erc721SetApprovalForAllRevocationLabel": {
+      "message": "ERC-721/ERC-1155 setApprovalForAll(false)"
+    },
+    "permit2ApproveRevocationLabel": {
+      "message": "Permit2 approve(token, spender, 0, 0)"
+    },
+    "permit2LockdownRevocationLabel": {
+      "message": "Permit2 lockdown"
+    },
+    "permit2InvalidateNoncesRevocationLabel": {
+      "message": "Permit2 invalidate nonces"
     }
   }
 }

packages/gator-permissions-snap/package.json

@@ -48,7 +48,7 @@
   },
   "dependencies": {
     "@metamask/abi-utils": "3.0.0",
-    "@metamask/delegation-core": "^2.0.0",
+    "@metamask/delegation-core": "^2.2.1",
     "@metamask/profile-sync-controller": "28.1.0",
     "@metamask/snaps-sdk": "11.1.0",
     "@metamask/utils": "11.11.0",

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

@@ -36,7 +36,7 @@ const manifest: SnapManifest = {
     snap_dialog: {},
     snap_getPreferences: {},
   },
-  platformVersion: '10.2.0',
+  platformVersion: '11.1.0',
   manifestVersion: '0.1',
 };
 

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

@@ -20,6 +20,7 @@ export type DelegationContracts = {
   allowedCalldataEnforcer: Hex;
   redeemerEnforcer: Hex;
   allowedTargetsEnforcer: Hex;
+  approvalRevocationEnforcer: Hex;
 };
 
 const contracts: DelegationContracts = {
@@ -38,6 +39,7 @@ const contracts: DelegationContracts = {
   allowedCalldataEnforcer: '0xc2b0d624c1c4319760C96503BA27C347F3260f55',
   redeemerEnforcer: '0xE144b0b2618071B4E56f746313528a669c7E65c5',
   allowedTargetsEnforcer: '0x7F20f61b1f09b08D970938F6fa563634d65c4EeB',
+  approvalRevocationEnforcer: '0xe264F1f09A19505a1ca1a86D5b01E8bFdb64324A',
 };
 
 // derived from https://chainid.network/chains.json

packages/gator-permissions-snap/src/core/existingpermissions/permissionFormatter.ts

@@ -7,6 +7,7 @@ import { hexToNumber } from '@metamask/utils';
 import type { Hex } from '@metamask/utils';
 
 import { DEFAULT_MAX_AMOUNT } from '../../permissions/erc20TokenStream/context';
+import { TOKEN_APPROVAL_REVOCATION_PRIMITIVES } from '../../permissions/tokenApprovalRevocation/types';
 import type { TokenMetadataService } from '../../services/tokenMetadataService';
 import { t } from '../../utils/i18n';
 import { getClosestTimePeriod } from '../../utils/time';
@@ -88,13 +89,22 @@ function extractPermissionDetails(
     }
 
     // For revocation-type permissions
-    if (permissionType === 'erc20-token-revocation') {
+    if (permissionType === 'token-approval-revocation') {
       const revokeLabel = t('revokeTokenApprovalsLabel');
-      const revokeValue = t('allTokens');
-      details.tokenApprovals = {
-        label: revokeLabel,
-        value: revokeValue,
-      };
+      const revocationPrimitives = TOKEN_APPROVAL_REVOCATION_PRIMITIVES.filter(
+        ({ key }) => permissionData[key] === true,
+      ).map(({ labelKey }) => t(labelKey));
+      if (revocationPrimitives.length > 0) {
+        const revokeValue =
+          revocationPrimitives.length ===
+          TOKEN_APPROVAL_REVOCATION_PRIMITIVES.length
+            ? t('allApprovalRevocationPrimitivesLabel')
+            : revocationPrimitives.join(', ');
+        details.tokenApprovals = {
+          label: revokeLabel,
+          value: revokeValue,
+        };
+      }
     }
     // For periodic-type permissions
     else if (

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

@@ -3,24 +3,24 @@ import { extractDescriptorName } from '@metamask/7715-permissions-shared/utils';
 import { InvalidInputError } from '@metamask/snaps-sdk';
 
 import type { AccountController } from './accountController';
+import { PermissionHandler } from './permissionHandler';
+import type { PermissionRequestLifecycleOrchestrator } from './permissionRequestLifecycleOrchestrator';
+import type {
+  BaseContext,
+  DeepRequired,
+  PermissionDefinition,
+  PermissionHandlerType,
+} from './types';
 import { erc20TokenAllowancePermissionDefinition } from '../permissions/erc20TokenAllowance';
 import { erc20TokenPeriodicPermissionDefinition } from '../permissions/erc20TokenPeriodic';
-import { erc20TokenRevocationPermissionDefinition } from '../permissions/erc20TokenRevocation';
 import { erc20TokenStreamPermissionDefinition } from '../permissions/erc20TokenStream';
 import { nativeTokenAllowancePermissionDefinition } from '../permissions/nativeTokenAllowance';
 import { nativeTokenPeriodicPermissionDefinition } from '../permissions/nativeTokenPeriodic';
 import { nativeTokenStreamPermissionDefinition } from '../permissions/nativeTokenStream';
+import { tokenApprovalRevocationPermissionDefinition } from '../permissions/tokenApprovalRevocation';
 import type { TokenMetadataService } from '../services/tokenMetadataService';
 import type { TokenPricesService } from '../services/tokenPricesService';
 import type { UserEventDispatcher } from '../userEventDispatcher';
-import { PermissionHandler } from './permissionHandler';
-import type { PermissionRequestLifecycleOrchestrator } from './permissionRequestLifecycleOrchestrator';
-import type {
-  BaseContext,
-  DeepRequired,
-  PermissionDefinition,
-  PermissionHandlerType,
-} from './types';
 
 /**
  * Factory for creating permission-specific orchestrators.
@@ -121,9 +121,9 @@ export class PermissionHandlerFactory {
           erc20TokenAllowancePermissionDefinition,
         );
         break;
-      case 'erc20-token-revocation':
+      case 'token-approval-revocation':
         handler = createPermissionHandler(
-          erc20TokenRevocationPermissionDefinition,
+          tokenApprovalRevocationPermissionDefinition,
         );
         break;
       case 'erc20-token-stream':

packages/gator-permissions-snap/src/core/permissionIntroduction/permissionIntroductionContent.tsx

@@ -120,7 +120,7 @@ export const permissionIntroductionConfigs: Record<
     page1: allowancePage1Content,
     page2: fixedPage2Content,
   },
-  'erc20-token-revocation': {
+  'token-approval-revocation': {
     page1: revocationPage1Content,
     page2: fixedPage2Content,
   },