refactor: connection Flow to use CAIP25 Permission format

app/scripts/controllers/permissions/background-api.js

@@ -12,8 +12,6 @@ import {
   setPermittedEthChainIds,
 } from '@metamask/multichain';
 import { isSnapId } from '@metamask/snaps-utils';
-import { RestrictedMethods } from '../../../../shared/constants/permissions';
-import { PermissionNames } from './specifications';
 
 export function getPermissionBackgroundApiMethods({
   permissionController,
@@ -102,14 +100,17 @@ export function getPermissionBackgroundApiMethods({
   };
 
   const requestAccountsAndChainPermissions = async (origin, id) => {
-    // Note that we are purposely requesting an approval from the ApprovalController
-    // and then manually forming the permission that is then granted via the
-    // PermissionController rather than calling the PermissionController.requestPermissions()
-    // directly because the Approval UI is still dependent on the notion of there
-    // being separate "eth_accounts" and "endowment:permitted-chains" permissions.
-    // After that depedency is refactored, we can move to requesting "endowment:caip25"
-    // directly from the PermissionController instead.
-    const legacyApproval = await approvalController.addAndShowApprovalRequest({
+    /**
+     * Note that we are purposely requesting an approval from the ApprovalController
+     * and then manually forming the permission that is then granted via the
+     * PermissionController rather than calling the PermissionController.requestPermissions()
+     * directly because the CAIP-25 permission is missing the factory method implementation.
+     * After the factory method is added, we can move to requesting "endowment:caip25"
+     * directly from the PermissionController instead.
+     */
+    const {
+      approvedSessionScopes: { permissions },
+    } = await approvalController.addAndShowApprovalRequest({
       id,
       origin,
       requestData: {
@@ -118,41 +119,26 @@ export function getPermissionBackgroundApiMethods({
           origin,
         },
         permissions: {
-          [RestrictedMethods.eth_accounts]: {},
-          [PermissionNames.permittedChains]: {},
+          [Caip25EndowmentPermissionName]: {
+            caveats: [
+              {
+                type: Caip25CaveatType,
+                value: {
+                  requiredScopes: {},
+                  optionalScopes: {},
+                  isMultichainOrigin: false,
+                },
+              },
+            ],
+          },
         },
       },
       type: MethodNames.RequestPermissions,
     });
 
-    const newCaveatValue = {
-      requiredScopes: {},
-      optionalScopes: {},
-      isMultichainOrigin: false,
-    };
-
-    const caveatValueWithChains = setPermittedEthChainIds(
-      newCaveatValue,
-      legacyApproval.approvedChainIds,
-    );
-
-    const caveatValueWithAccounts = setEthAccounts(
-      caveatValueWithChains,
-      legacyApproval.approvedAccounts,
-    );
-
     permissionController.grantPermissions({
       subject: { origin },
-      approvedPermissions: {
-        [Caip25EndowmentPermissionName]: {
-          caveats: [
-            {
-              type: Caip25CaveatType,
-              value: caveatValueWithAccounts,
-            },
-          ],
-        },
-      },
+      approvedPermissions: permissions,
     });
   };
 

app/scripts/controllers/permissions/background-api.test.js

@@ -6,10 +6,8 @@ import {
   Caip25CaveatType,
   Caip25EndowmentPermissionName,
 } from '@metamask/multichain';
-import { RestrictedMethods } from '../../../../shared/constants/permissions';
 import { flushPromises } from '../../../../test/lib/timer-helpers';
 import { getPermissionBackgroundApiMethods } from './background-api';
-import { PermissionNames } from './specifications';
 
 describe('permission background API methods', () => {
   afterEach(() => {
@@ -466,13 +464,37 @@ describe('permission background API methods', () => {
   });
 
   describe('requestAccountsAndChainPermissionsWithId', () => {
+    const approvedPermissions = {
+      [Caip25EndowmentPermissionName]: {
+        caveats: [
+          {
+            type: Caip25CaveatType,
+            value: {
+              requiredScopes: {},
+              optionalScopes: {
+                'eip155:1': {
+                  accounts: ['eip155:1:0xdeadbeef'],
+                },
+                'eip155:5': {
+                  accounts: ['eip155:5:0xdeadbeef'],
+                },
+              },
+              isMultichainOrigin: false,
+            },
+          },
+        ],
+      },
+    };
+
     it('requests eth_accounts and permittedChains approval and returns the request id', async () => {
       const approvalController = {
         addAndShowApprovalRequest: jest.fn().mockResolvedValue({
-          approvedChainIds: ['0x1', '0x5'],
-          approvedAccounts: ['0xdeadbeef'],
+          approvedSessionScopes: {
+            permissions: approvedPermissions,
+          },
         }),
       };
+
       const permissionController = {
         grantPermissions: jest.fn(),
       };
@@ -496,8 +518,18 @@ describe('permission background API methods', () => {
               origin: 'foo.com',
             },
             permissions: {
-              [RestrictedMethods.eth_accounts]: {},
-              [PermissionNames.permittedChains]: {},
+              [Caip25EndowmentPermissionName]: {
+                caveats: [
+                  {
+                    type: Caip25CaveatType,
+                    value: {
+                      requiredScopes: {},
+                      optionalScopes: {},
+                      isMultichainOrigin: false,
+                    },
+                  },
+                ],
+              },
             },
           },
           type: MethodNames.RequestPermissions,
@@ -508,10 +540,12 @@ describe('permission background API methods', () => {
     it('grants a legacy CAIP-25 permission (isMultichainOrigin: false) with the approved eip155 chainIds and accounts', async () => {
       const approvalController = {
         addAndShowApprovalRequest: jest.fn().mockResolvedValue({
-          approvedChainIds: ['0x1', '0x5'],
-          approvedAccounts: ['0xdeadbeef'],
+          approvedSessionScopes: {
+            permissions: approvedPermissions,
+          },
         }),
       };
+
       const permissionController = {
         grantPermissions: jest.fn(),
       };
@@ -527,27 +561,7 @@ describe('permission background API methods', () => {
         subject: {
           origin: 'foo.com',
         },
-        approvedPermissions: {
-          [Caip25EndowmentPermissionName]: {
-            caveats: [
-              {
-                type: Caip25CaveatType,
-                value: {
-                  requiredScopes: {},
-                  optionalScopes: {
-                    'eip155:1': {
-                      accounts: ['eip155:1:0xdeadbeef'],
-                    },
-                    'eip155:5': {
-                      accounts: ['eip155:5:0xdeadbeef'],
-                    },
-                  },
-                  isMultichainOrigin: false,
-                },
-              },
-            ],
-          },
-        },
+        approvedPermissions,
       });
     });
   });

app/scripts/metamask-controller.js

@@ -5416,6 +5416,15 @@ export default class MetamaskController extends EventEmitter {
    * @param {Hex} chainId - The chainId to add incrementally.
    */
   async requestApprovalPermittedChainsPermission(origin, chainId) {
+    const caveatValueWithChains = setPermittedEthChainIds(
+      {
+        requiredScopes: {},
+        optionalScopes: {},
+        isMultichainOrigin: false,
+      },
+      [chainId],
+    );
+
     const id = nanoid();
     await this.approvalController.addAndShowApprovalRequest({
       id,
@@ -5426,11 +5435,11 @@ export default class MetamaskController extends EventEmitter {
           origin,
         },
         permissions: {
-          [PermissionNames.permittedChains]: {
+          [Caip25EndowmentPermissionName]: {
             caveats: [
               {
-                type: CaveatTypes.restrictNetworkSwitching,
-                value: [chainId],
+                type: Caip25CaveatType,
+                value: caveatValueWithChains,
               },
             ],
           },
@@ -5566,20 +5575,15 @@ export default class MetamaskController extends EventEmitter {
       delete permissions[PermissionNames.permittedChains];
     }
 
-    const id = nanoid();
-    const legacyApproval =
-      await this.approvalController.addAndShowApprovalRequest({
-        id,
-        origin,
-        requestData: {
-          metadata: {
-            id,
-            origin,
-          },
-          permissions,
-        },
-        type: MethodNames.RequestPermissions,
-      });
+    const requestedChains =
+      permissions[PermissionNames.permittedChains]?.caveats?.find(
+        (caveat) => caveat.type === CaveatTypes.restrictNetworkSwitching,
+      )?.value ?? [];
+
+    const requestedAccounts =
+      permissions[PermissionNames.eth_accounts]?.caveats?.find(
+        (caveat) => caveat.type === CaveatTypes.restrictReturnedAccounts,
+      )?.value ?? [];
 
     const newCaveatValue = {
       requiredScopes: {},
@@ -5593,26 +5597,41 @@ export default class MetamaskController extends EventEmitter {
 
     const caveatValueWithChains = setPermittedEthChainIds(
       newCaveatValue,
-      isSnapId(origin) ? [] : legacyApproval.approvedChainIds,
+      isSnapId(origin) ? [] : requestedChains,
     );
 
     const caveatValueWithAccounts = setEthAccounts(
       caveatValueWithChains,
-      legacyApproval.approvedAccounts,
+      requestedAccounts,
     );
 
-    return {
-      [Caip25EndowmentPermissionName]: {
-        caveats: [
-          {
-            type: Caip25CaveatType,
-            value: caveatValueWithAccounts,
+    const id = nanoid();
+
+    const { approvedSessionScopes } =
+      await this.approvalController.addAndShowApprovalRequest({
+        id,
+        origin,
+        requestData: {
+          metadata: {
+            id,
+            origin,
           },
-        ],
-      },
-    };
-  }
+          permissions: {
+            [Caip25EndowmentPermissionName]: {
+              caveats: [
+                {
+                  type: Caip25CaveatType,
+                  value: caveatValueWithAccounts,
+                },
+              ],
+            },
+          },
+        },
+        type: MethodNames.RequestPermissions,
+      });
 
+    return approvedSessionScopes.permissions;
+  }
   // ---------------------------------------------------------------------------
   // Identity Management (signature operations)