feat: Attach metadata when submitting a revocation to the permission provider snap

packages/gator-permissions-controller/CHANGELOG.md

@@ -7,6 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- **BREAKING:** Extends the `GatorPermissionsController` to enable attaching metadata(transaction hash) when submitting a permission revocation. ([#7503](https://github.com/MetaMask/core/pull/7503))
+  - `submitRevocation` revocationParams object now requires a `revocationMetadata` property.
+
 ### Changed
 
 - Bump `@metamask/transaction-controller` from `^62.9.1` to `^62.9.2` ([#7642](https://github.com/MetaMask/core/pull/7642))

packages/gator-permissions-controller/src/GatorPermissionsController.test.ts

@@ -841,6 +841,7 @@ describe('GatorPermissionsController', () => {
 
       const revocationParams: RevocationParams = {
         permissionContext: '0x1234567890abcdef1234567890abcdef12345678',
+        revocationMetadata: {},
       };
 
       await controller.submitRevocation(revocationParams);
@@ -869,6 +870,7 @@ describe('GatorPermissionsController', () => {
 
       const revocationParams: RevocationParams = {
         permissionContext: '0x1234567890abcdef1234567890abcdef12345678',
+        revocationMetadata: {},
       };
 
       await expect(
@@ -897,6 +899,7 @@ describe('GatorPermissionsController', () => {
 
       const revocationParams: RevocationParams = {
         permissionContext: '0x1234567890abcdef1234567890abcdef12345678',
+        revocationMetadata: {},
       };
 
       await expect(
@@ -941,6 +944,7 @@ describe('GatorPermissionsController', () => {
 
       const revocationParams: RevocationParams = {
         permissionContext: '0x1234567890abcdef1234567890abcdef12345678',
+        revocationMetadata: {},
       };
 
       // Should throw GatorPermissionsFetchError (not GatorPermissionsProviderError)
@@ -981,6 +985,7 @@ describe('GatorPermissionsController', () => {
 
       const revocationParams: RevocationParams = {
         permissionContext: '0x1234567890abcdef1234567890abcdef12345678',
+        revocationMetadata: {},
       };
 
       await controller.submitDirectRevocation(revocationParams);
@@ -1022,6 +1027,7 @@ describe('GatorPermissionsController', () => {
         '0x1234567890abcdef1234567890abcdef12345678' as Hex;
       const revocationParams: RevocationParams = {
         permissionContext,
+        revocationMetadata: {},
       };
 
       // Spy on submitRevocation to check pending state before it's called
@@ -1046,6 +1052,7 @@ describe('GatorPermissionsController', () => {
 
       const revocationParams: RevocationParams = {
         permissionContext: '0x1234567890abcdef1234567890abcdef12345678',
+        revocationMetadata: {},
       };
 
       await expect(
@@ -1076,6 +1083,7 @@ describe('GatorPermissionsController', () => {
         '0x1234567890abcdef1234567890abcdef12345678' as Hex;
       const revocationParams: RevocationParams = {
         permissionContext,
+        revocationMetadata: {},
       };
 
       await expect(
@@ -1212,7 +1220,75 @@ describe('GatorPermissionsController', () => {
         request: {
           jsonrpc: '2.0',
           method: 'permissionsProvider_submitRevocation',
-          params: { permissionContext },
+          params: {
+            permissionContext,
+            revocationMetadata: { txHash: undefined },
+          },
+        },
+      });
+
+      // Verify that permissions are refreshed after revocation (getGrantedPermissions is called)
+      expect(mockHandleRequestHandler).toHaveBeenCalledWith({
+        snapId: MOCK_GATOR_PERMISSIONS_PROVIDER_SNAP_ID,
+        origin: 'metamask',
+        handler: 'onRpcRequest',
+        request: {
+          jsonrpc: '2.0',
+          method: 'permissionsProvider_getGrantedPermissions',
+          params: { isRevoked: false },
+        },
+      });
+    });
+
+    it('should submit revocation metadata when transaction is confirmed', async () => {
+      const mockHandleRequestHandler = jest.fn().mockResolvedValue(undefined);
+      const rootMessenger = getRootMessenger({
+        snapControllerHandleRequestActionHandler: mockHandleRequestHandler,
+      });
+      const messenger = getMessenger(rootMessenger);
+
+      const controller = new GatorPermissionsController({
+        messenger,
+        state: {
+          isGatorPermissionsEnabled: true,
+          gatorPermissionsProviderSnapId:
+            MOCK_GATOR_PERMISSIONS_PROVIDER_SNAP_ID,
+        },
+      });
+
+      const txId = 'test-tx-id';
+      const permissionContext = '0x1234567890abcdef1234567890abcdef12345678';
+      const hash = '0x-mock-hash';
+
+      await controller.addPendingRevocation({ txId, permissionContext });
+
+      // Emit transaction approved event (user confirms)
+      rootMessenger.publish('TransactionController:transactionApproved', {
+        transactionMeta: { id: txId } as TransactionMeta,
+      });
+
+      // Emit transaction confirmed event
+      rootMessenger.publish('TransactionController:transactionConfirmed', {
+        id: txId,
+        hash,
+      } as TransactionMeta);
+
+      await flushPromises();
+
+      // Verify submitRevocation was called
+      expect(mockHandleRequestHandler).toHaveBeenCalledWith({
+        snapId: MOCK_GATOR_PERMISSIONS_PROVIDER_SNAP_ID,
+        origin: 'metamask',
+        handler: 'onRpcRequest',
+        request: {
+          jsonrpc: '2.0',
+          method: 'permissionsProvider_submitRevocation',
+          params: {
+            permissionContext,
+            revocationMetadata: {
+              txHash: hash,
+            },
+          },
         },
       });
 

packages/gator-permissions-controller/src/GatorPermissionsController.ts

@@ -34,7 +34,10 @@ import {
 } from './errors';
 import { controllerLog } from './logger';
 import { GatorPermissionsSnapRpcMethod } from './types';
-import type { StoredGatorPermissionSanitized } from './types';
+import type {
+  RevocationMetadata,
+  StoredGatorPermissionSanitized,
+} from './types';
 import type {
   GatorPermissionsMap,
   PermissionTypesWithCustom,
@@ -944,9 +947,28 @@ export default class GatorPermissionsController extends BaseController<
         controllerLog('Transaction confirmed, submitting revocation', {
           txId,
           permissionContext,
+          txHash: transactionMeta.hash,
         });
 
-        this.submitRevocation({ permissionContext })
+        // Attach metadata by parsing the confirmed transactionMeta
+        const { hash } = transactionMeta;
+        const revocationMetadata: RevocationMetadata = {
+          txHash: hash as Hex | undefined,
+        };
+        if (hash === undefined) {
+          controllerLog(
+            'Failed to attach transaction hash after revocation transaction confirmed',
+            {
+              txId,
+              permissionContext,
+              error: new Error(
+                'Confirmed transaction is missing transaction hash',
+              ),
+            },
+          );
+        }
+
+        this.submitRevocation({ permissionContext, revocationMetadata })
           .catch((error) => {
             controllerLog(
               'Failed to submit revocation after transaction confirmed',

packages/gator-permissions-controller/src/index.ts

@@ -37,6 +37,7 @@ export type {
   GatorPermissionsListByPermissionTypeAndChainId,
   DelegationDetails,
   RevocationParams,
+  RevocationMetadata,
 } from './types';
 
 export type {

packages/gator-permissions-controller/src/types.ts

@@ -217,6 +217,13 @@ export type DelegationDetails = Pick<
   'caveats' | 'delegator' | 'delegate' | 'authority'
 >;
 
+/**
+ * Represents the metadata for confirmed transaction revocation.
+ */
+export type RevocationMetadata = {
+  txHash?: Hex | undefined;
+};
+
 /**
  * Represents the parameters for submitting a revocation.
  */
@@ -225,6 +232,11 @@ export type RevocationParams = {
    * The permission context as a hex string that identifies the permission to revoke.
    */
   permissionContext: Hex;
+
+  /**
+   * The metadata associated with the permission revocation transaction.
+   */
+  revocationMetadata: RevocationMetadata;
 };
 
 /**