feat: render known facilitator redeemers by name (#354)

* feat: add MetaMask facilitator addresses and update rendering logic in permission handler

* Update facilitator tooltip and refine RedeemerField rendering logic

* Remove facilitator tooltip and update RedeemerField rendering logic

Author: mj-kiwi

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

@@ -76,6 +76,9 @@
     "redeemerTooltip": {
       "message": "Only these addresses may redeem this permission."
     },
+    "facilitatorValue": {
+      "message": "MetaMask facilitator"
+    },
     "payeeLabel": {
       "message": "Payees"
     },

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

@@ -0,0 +1,26 @@
+export const METAMASK_FACILITATOR_ADDRESSES = [
+  '0xB01caEa8c6C47bbf4F4b4c5080Ca642043359C2E',
+  '0xC066ac5D385419B1A8c43A0E146fA439837a8B8c',
+  '0xB42F812A44c22cc6b861478900401ee759EbEAD6',
+] as const;
+
+export const METAMASK_FACILITATOR_ADDRESSES_DEV = [
+  '0xb4827A2a066CD2Ef88560EFdf063dD05C6c41cC7',
+] as const;
+
+const METAMASK_FACILITATOR_ADDRESSES_LOWERCASE = new Set<string>(
+  [
+    ...METAMASK_FACILITATOR_ADDRESSES,
+    ...METAMASK_FACILITATOR_ADDRESSES_DEV,
+  ].map((address) => address.toLowerCase()),
+);
+
+/**
+ * Checks whether an address is a known MetaMask facilitator signer.
+ *
+ * @param address - Address to check.
+ * @returns Whether the address is a known MetaMask facilitator signer.
+ */
+export function isMetaMaskFacilitatorAddress(address: string): boolean {
+  return METAMASK_FACILITATOR_ADDRESSES_LOWERCASE.has(address.toLowerCase());
+}

packages/gator-permissions-snap/src/core/permissionHandlerContent.tsx

@@ -15,6 +15,7 @@ import {
 import { parseCaipAssetType } from '@metamask/utils';
 
 import { ConfirmationDialog } from './confirmation';
+import { isMetaMaskFacilitatorAddress } from './facilitatorAddresses';
 import { JUSTIFICATION_SHOW_MORE_BUTTON_NAME } from './permissionHandler';
 import type { BaseContext, IconData } from './types';
 import {
@@ -197,10 +198,14 @@ export const PermissionHandlerContent = ({
     />
   );
 
+  const shouldRenderRedeemersAsFacilitators =
+    context.redeemerAddresses?.every(isMetaMaskFacilitatorAddress) ?? false;
+
   const redeemerField = context.redeemerAddresses?.length ? (
     <RedeemerField
       label={t('redeemerLabel')}
       addresses={context.redeemerAddresses}
+      shouldRenderRedeemersAsFacilitators={shouldRenderRedeemersAsFacilitators}
       tooltip={t('redeemerTooltip')}
     />
   ) : null;

packages/gator-permissions-snap/src/ui/components/RedeemerField.tsx

@@ -1,30 +1,37 @@
-import { Address, Box } from '@metamask/snaps-sdk/jsx';
+import { Address, Box, Text } from '@metamask/snaps-sdk/jsx';
 import type { Hex } from '@metamask/utils';
 
 import { Field } from './Field';
+import { t } from '../../utils/i18n';
 
 export type RedeemerFieldParams = {
   label: string;
   addresses: string[];
   tooltip?: string | undefined;
+  shouldRenderRedeemersAsFacilitators?: boolean;
 };
 
 export const RedeemerField = ({
   label,
   addresses,
   tooltip,
+  shouldRenderRedeemersAsFacilitators = false,
 }: RedeemerFieldParams): JSX.Element | null => {
   if (addresses.length === 0) {
     return null;
   }
 
   return (
     <Field label={label} tooltip={tooltip} variant="display">
-      <Box direction="vertical">
-        {addresses.map((addr) => (
-          <Address key={addr} address={addr as Hex} displayName={true} />
-        ))}
-      </Box>
+      {shouldRenderRedeemersAsFacilitators ? (
+        <Text alignment="end">{t('facilitatorValue')}</Text>
+      ) : (
+        <Box direction="vertical">
+          {addresses.map((addr) => (
+            <Address key={addr} address={addr as Hex} displayName={true} />
+          ))}
+        </Box>
+      )}
     </Field>
   );
 };

packages/gator-permissions-snap/test/core/permissionHandler.test.ts

@@ -6,6 +6,7 @@ import { AddressScanResultType } from '../../src/clients/trustSignalsClient';
 import type { TokenBalanceAndMetadata } from '../../src/clients/types';
 import type { AccountController } from '../../src/core/accountController';
 import { ExistingPermissionsState } from '../../src/core/existingpermissions/existingPermissionsState';
+import { METAMASK_FACILITATOR_ADDRESSES } from '../../src/core/facilitatorAddresses';
 import { PermissionHandler } from '../../src/core/permissionHandler';
 import type { PermissionRequestLifecycleOrchestrator } from '../../src/core/permissionRequestLifecycleOrchestrator';
 import type {
@@ -472,6 +473,89 @@ describe('PermissionHandler', () => {
         const serialized = JSON.stringify(result);
         expect(serialized).toContain('Malicious address');
       });
+
+      it('renders redeemer addresses as redeemers when no payee rule is present', async () => {
+        const { permissionHandler, getLifecycleHandlers } = setupTest();
+
+        await permissionHandler.handlePermissionRequest(mockOrigin);
+
+        const lifecycleHandlers = getLifecycleHandlers();
+
+        const result = await lifecycleHandlers.createConfirmationContent({
+          context: {
+            ...mockContext,
+            redeemerAddresses: ['0x1111111111111111111111111111111111111111'],
+          },
+          metadata: mockMetadata,
+          origin: mockOrigin,
+          chainId: 1,
+          scanDappUrlResult: null,
+          scanAddressResult: null,
+          existingPermissionsStatus: ExistingPermissionsState.None,
+          isGrantDisabled: false,
+        });
+
+        const serialized = JSON.stringify(result);
+        expect(serialized).toContain('Redeemers');
+        expect(serialized).not.toContain('Facilitators');
+      });
+
+      it('renders known MetaMask facilitator redeemer addresses as a MetaMask facilitator redeemer', async () => {
+        const { permissionHandler, getLifecycleHandlers } = setupTest();
+
+        await permissionHandler.handlePermissionRequest(mockOrigin);
+
+        const lifecycleHandlers = getLifecycleHandlers();
+
+        const result = await lifecycleHandlers.createConfirmationContent({
+          context: {
+            ...mockContext,
+            redeemerAddresses: [...METAMASK_FACILITATOR_ADDRESSES],
+          },
+          metadata: mockMetadata,
+          origin: mockOrigin,
+          chainId: 1,
+          scanDappUrlResult: null,
+          scanAddressResult: null,
+          existingPermissionsStatus: ExistingPermissionsState.None,
+          isGrantDisabled: false,
+        });
+
+        const serialized = JSON.stringify(result);
+        expect(serialized).toContain('Redeemers');
+        expect(serialized).toContain('MetaMask facilitator');
+        expect(serialized).toContain(
+          'Only these addresses may redeem this permission.',
+        );
+        expect(serialized).not.toContain('Facilitators');
+      });
+
+      it('does not render arbitrary redeemer addresses as facilitators when a payee rule is present', async () => {
+        const { permissionHandler, getLifecycleHandlers } = setupTest();
+
+        await permissionHandler.handlePermissionRequest(mockOrigin);
+
+        const lifecycleHandlers = getLifecycleHandlers();
+
+        const result = await lifecycleHandlers.createConfirmationContent({
+          context: {
+            ...mockContext,
+            redeemerAddresses: ['0x1111111111111111111111111111111111111111'],
+            payeeAddresses: ['0x2222222222222222222222222222222222222222'],
+          },
+          metadata: mockMetadata,
+          origin: mockOrigin,
+          chainId: 1,
+          scanDappUrlResult: null,
+          scanAddressResult: null,
+          existingPermissionsStatus: ExistingPermissionsState.None,
+          isGrantDisabled: false,
+        });
+
+        const serialized = JSON.stringify(result);
+        expect(serialized).toContain('Redeemers');
+        expect(serialized).not.toContain('Facilitators');
+      });
     });
 
     describe('onConfirmationCreated', () => {