feat: Expose list of pending revocations in state (#7055)

## Explanation

Expose the list of pending revocations in the state to allow MM clients
to create custom selectors that filter on `pendingRevocations` to
determine whether the revoke CTA should show the "pending" status.

- A revocation is added to `pendingRevocations` state on calls to
`addPendingRevocation()`
- A revocation is removed from `pendingRevocations` state given a
`transactionId` when the handler's `cleanup()` function is executed.

## References

Forked from #6713

## Checklist

- [x] I've updated the test suite for new or updated code as appropriate
- [x] I've updated documentation (JSDoc, Markdown, etc.) for new or
updated code as appropriate
- [x] I've communicated my changes to consumers by [updating changelogs
for packages I've
changed](https://github.com/MetaMask/core/tree/main/docs/contributing.md#updating-changelogs),
highlighting breaking changes as necessary
- [x] I've prepared draft pull requests for clients and consumer
packages to resolve any breaking changes



<!-- CURSOR_SUMMARY -->
---

> [!NOTE]
> Adds `pendingRevocations` to controller state with lifecycle
management via `addPendingRevocation` and `submitRevocation`, updating
metadata, tests, and changelog.
> 
> - **GatorPermissionsController**:
> - **State**: Add `pendingRevocations: { txId: string;
permissionContext: Hex }[]` with default `[]` and UI exposure in
metadata.
>   - **API**:
>     - New getter `pendingRevocations`.
> - `addPendingRevocation` now appends to state immediately and cleans
up on confirm/fail/drop/timeout by `txId`.
> - `submitRevocation` submits to Snap and removes entry by
`permissionContext` on success.
> - **Internals**: Add private helpers to add/remove pending
revocations; import `Hex` type.
> - **Tests**: Update snapshots, add coverage for pending revocations
lifecycle and getter.
> - **Docs**: Update `CHANGELOG.md` to note exposed pending revocations
and related actions.
> 
> <sup>Written by [Cursor
Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit
77e676e. This will update automatically
on new commits. Configure
[here](https://cursor.com/dashboard?tab=bugbot).</sup>
<!-- /CURSOR_SUMMARY -->

Author: V00D00-child

packages/gator-permissions-controller/CHANGELOG.md

@@ -7,12 +7,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-## [0.3.0]
-
 ### Added
 
 - Add `submitRevocation` action to submit permission revocations through the gator permissions provider snap
 - Add `addPendingRevocation` action to queue revocations until transaction confirmation
+- Expose list of pending revocations in state
+
+## [0.3.0]
 
 ### Changed
 

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

@@ -115,6 +115,7 @@ describe('GatorPermissionsController', () => {
           other: {},
         }),
         gatorPermissionsProviderSnapId: MOCK_GATOR_PERMISSIONS_PROVIDER_SNAP_ID,
+        pendingRevocations: [],
       };
 
       const controller = new GatorPermissionsController({
@@ -454,6 +455,7 @@ describe('GatorPermissionsController', () => {
           "gatorPermissionsProviderSnapId": "npm:@metamask/gator-permissions-snap",
           "isFetchingGatorPermissions": false,
           "isGatorPermissionsEnabled": false,
+          "pendingRevocations": Array [],
         }
       `);
     });
@@ -491,6 +493,7 @@ describe('GatorPermissionsController', () => {
       ).toMatchInlineSnapshot(`
         Object {
           "gatorPermissionsMapSerialized": "{\\"native-token-stream\\":{},\\"native-token-periodic\\":{},\\"erc20-token-stream\\":{},\\"erc20-token-periodic\\":{},\\"other\\":{}}",
+          "pendingRevocations": Array [],
         }
       `);
     });
@@ -735,6 +738,12 @@ describe('GatorPermissionsController', () => {
           isGatorPermissionsEnabled: true,
           gatorPermissionsProviderSnapId:
             MOCK_GATOR_PERMISSIONS_PROVIDER_SNAP_ID,
+          pendingRevocations: [
+            {
+              txId: 'test-tx-id',
+              permissionContext: '0x1234567890abcdef1234567890abcdef12345678',
+            },
+          ],
         },
       });
 
@@ -754,6 +763,7 @@ describe('GatorPermissionsController', () => {
           params: revocationParams,
         },
       });
+      expect(controller.pendingRevocations).toStrictEqual([]);
     });
 
     it('should throw GatorPermissionsNotEnabledError when gator permissions are disabled', async () => {
@@ -1038,6 +1048,33 @@ describe('GatorPermissionsController', () => {
       ).rejects.toThrow('Gator permissions are not enabled');
     });
   });
+
+  describe('get pendingRevocations', () => {
+    it('should return the pending revocations list', () => {
+      const messenger = getMessenger();
+      const controller = new GatorPermissionsController({
+        messenger,
+        state: {
+          isGatorPermissionsEnabled: true,
+          gatorPermissionsProviderSnapId:
+            MOCK_GATOR_PERMISSIONS_PROVIDER_SNAP_ID,
+          pendingRevocations: [
+            {
+              txId: 'test-tx-id',
+              permissionContext: '0x1234567890abcdef1234567890abcdef12345678',
+            },
+          ],
+        },
+      });
+
+      expect(controller.pendingRevocations).toStrictEqual([
+        {
+          txId: 'test-tx-id',
+          permissionContext: '0x1234567890abcdef1234567890abcdef12345678',
+        },
+      ]);
+    });
+  });
 });
 
 /**

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

@@ -15,7 +15,7 @@ import type {
   TransactionControllerTransactionDroppedEvent,
   TransactionControllerTransactionFailedEvent,
 } from '@metamask/transaction-controller';
-import type { Json } from '@metamask/utils';
+import type { Hex, Json } from '@metamask/utils';
 
 import type { DecodedPermission } from './decodePermission';
 import {
@@ -104,6 +104,14 @@ export type GatorPermissionsControllerState = {
    * Default value is `@metamask/gator-permissions-snap`
    */
   gatorPermissionsProviderSnapId: SnapId;
+
+  /**
+   * List of gator permission pending a revocation transaction
+   */
+  pendingRevocations: {
+    txId: string;
+    permissionContext: Hex;
+  }[];
 };
 
 const gatorPermissionsControllerMetadata: StateMetadata<GatorPermissionsControllerState> =
@@ -132,6 +140,12 @@ const gatorPermissionsControllerMetadata: StateMetadata<GatorPermissionsControll
       includeInDebugSnapshot: false,
       usedInUi: false,
     },
+    pendingRevocations: {
+      includeInStateLogs: true,
+      persist: false,
+      includeInDebugSnapshot: false,
+      usedInUi: true,
+    },
   } satisfies StateMetadata<GatorPermissionsControllerState>;
 
 /**
@@ -150,6 +164,7 @@ export function getDefaultGatorPermissionsControllerState(): GatorPermissionsCon
     ),
     isFetchingGatorPermissions: false,
     gatorPermissionsProviderSnapId: defaultGatorPermissionsProviderSnapId,
+    pendingRevocations: [],
   };
 }
 
@@ -313,6 +328,32 @@ export default class GatorPermissionsController extends BaseController<
     });
   }
 
+  #addPendingRevocationToState(txId: string, permissionContext: Hex) {
+    this.update((state) => {
+      state.pendingRevocations = [
+        ...state.pendingRevocations,
+        { txId, permissionContext },
+      ];
+    });
+  }
+
+  #removePendingRevocationFromStateByTxId(txId: string) {
+    this.update((state) => {
+      state.pendingRevocations = state.pendingRevocations.filter(
+        (pendingRevocations) => pendingRevocations.txId !== txId,
+      );
+    });
+  }
+
+  #removePendingRevocationFromStateByPermissionContext(permissionContext: Hex) {
+    this.update((state) => {
+      state.pendingRevocations = state.pendingRevocations.filter(
+        (pendingRevocations) =>
+          pendingRevocations.permissionContext !== permissionContext,
+      );
+    });
+  }
+
   #registerMessageHandlers(): void {
     this.messenger.registerActionHandler(
       `${controllerName}:fetchAndUpdateGatorPermissions`,
@@ -536,6 +577,15 @@ export default class GatorPermissionsController extends BaseController<
     });
   }
 
+  /**
+   * Gets the pending revocations list.
+   *
+   * @returns The pending revocations list.
+   */
+  get pendingRevocations(): { txId: string; permissionContext: Hex }[] {
+    return this.state.pendingRevocations;
+  }
+
   /**
    * Fetches the gator permissions from profile sync and updates the state.
    *
@@ -689,6 +739,10 @@ export default class GatorPermissionsController extends BaseController<
         snapRequest,
       );
 
+      this.#removePendingRevocationFromStateByPermissionContext(
+        revocationParams.permissionContext,
+      );
+
       controllerLog('Successfully submitted revocation', {
         permissionContext: revocationParams.permissionContext,
         result,
@@ -728,6 +782,7 @@ export default class GatorPermissionsController extends BaseController<
     });
 
     this.#assertGatorPermissionsEnabled();
+    this.#addPendingRevocationToState(txId, permissionContext);
 
     type PendingRevocationHandlers = {
       confirmed?: (
@@ -751,7 +806,7 @@ export default class GatorPermissionsController extends BaseController<
     };
 
     // Cleanup function to unsubscribe from all events and clear timeout
-    const cleanup = () => {
+    const cleanup = (txIdToRemove: string) => {
       if (handlers.confirmed) {
         this.messenger.unsubscribe(
           'TransactionController:transactionConfirmed',
@@ -773,6 +828,9 @@ export default class GatorPermissionsController extends BaseController<
       if (handlers.timeoutId !== undefined) {
         clearTimeout(handlers.timeoutId);
       }
+
+      // Remove the pending revocation from the state
+      this.#removePendingRevocationFromStateByTxId(txIdToRemove);
     };
 
     // Handle confirmed transaction - submit revocation
@@ -783,8 +841,6 @@ export default class GatorPermissionsController extends BaseController<
           permissionContext,
         });
 
-        cleanup();
-
         this.submitRevocation({ permissionContext }).catch((error) => {
           controllerLog(
             'Failed to submit revocation after transaction confirmed',
@@ -795,6 +851,8 @@ export default class GatorPermissionsController extends BaseController<
             },
           );
         });
+
+        cleanup(transactionMeta.id);
       }
     };
 
@@ -807,7 +865,7 @@ export default class GatorPermissionsController extends BaseController<
           error: payload.error,
         });
 
-        cleanup();
+        cleanup(payload.transactionMeta.id);
       }
     };
 
@@ -819,7 +877,7 @@ export default class GatorPermissionsController extends BaseController<
           permissionContext,
         });
 
-        cleanup();
+        cleanup(payload.transactionMeta.id);
       }
     };
 
@@ -843,7 +901,7 @@ export default class GatorPermissionsController extends BaseController<
         txId,
         permissionContext,
       });
-      cleanup();
+      cleanup(txId);
     }, PENDING_REVOCATION_TIMEOUT);
   }
 }