Add wallet_switchEthereumChain support to snaps-jest

Author: Mrtenz

packages/examples/packages/ethereum-provider/snap.manifest.json

@@ -7,7 +7,7 @@
     "url": "https://github.com/MetaMask/snaps.git"
   },
   "source": {
-    "shasum": "2R9rtwpmidSKcYsKHxk/o9JPKqB6RMNHbWHJEpEjN9U=",
+    "shasum": "FvNPBDpxgcjSkTlVJ73Xi15wnD1MvkaJyIJqFK6eW3I=",
     "location": {
       "npm": {
         "filePath": "dist/bundle.js",

packages/examples/packages/ethereum-provider/src/index.ts

@@ -223,7 +223,7 @@ async function signTypedData(message: string, from: string) {
  * @see https://docs.metamask.io/snaps/reference/rpc-api/#wallet_invokesnap
  */
 export const onRpcRequest: OnRpcRequestHandler = async ({ request }) => {
-  const { chainId = '0x1' } = request.params as BaseParams;
+  const { chainId = '0x1' } = (request.params as BaseParams) ?? {};
   await switchChain(chainId);
 
   switch (request.method) {

packages/snaps-controllers/coverage.json

@@ -1,6 +1,6 @@
 {
-  "branches": 93.28,
+  "branches": 93.29,
   "functions": 96.8,
-  "lines": 98.15,
-  "statements": 97.88
+  "lines": 98.16,
+  "statements": 97.89
 }

packages/snaps-controllers/src/snaps/SnapController.test.tsx

@@ -5330,7 +5330,7 @@ describe('SnapController', () => {
       snapController.destroy();
     });
 
-    it('grants the `endowment:permitted-chains` permission to a Snap with `endowment:ethereum-provider`', async () => {
+    it('grants the `endowment:caip25` permission to a Snap with `endowment:ethereum-provider`', async () => {
       const rootMessenger = getControllerMessenger();
       const messenger = getSnapControllerMessenger(rootMessenger);
 
@@ -5375,21 +5375,42 @@ describe('SnapController', () => {
       });
 
       const approvedPermissions = {
-        'endowment:ethereum-provider': {
-          caveats: [],
+        'endowment:page-home': {
+          caveats: null,
+        },
+        'endowment:ethereum-provider': {},
+        'endowment:caip25': {
+          caveats: [
+            {
+              type: 'authorizedScopes',
+              value: {
+                requiredScopes: {},
+                optionalScopes: {
+                  'eip155:1': {
+                    accounts: [],
+                  },
+                },
+                sessionProperties: {},
+                isMultichainOrigin: false,
+              },
+            },
+          ],
         },
-        permittedChains: {},
       };
 
       expect(messenger.call).toHaveBeenCalledWith(
         'PermissionController:grantPermissions',
-        { approvedPermissions, subject: { origin: MOCK_SNAP_ID } },
+        {
+          approvedPermissions,
+          subject: { origin: MOCK_SNAP_ID },
+          requestData: expect.any(Object),
+        },
       );
 
       snapController.destroy();
     });
 
-    it('overrides the `endowment:permitted-chains` permission if the Snap specifies it in its manifest', async () => {
+    it('overrides the `endowment:caip25` permission if the Snap specifies it in its manifest', async () => {
       const rootMessenger = getControllerMessenger();
       const messenger = getSnapControllerMessenger(rootMessenger);
 
@@ -5418,11 +5439,20 @@ describe('SnapController', () => {
           initialPermissions: {
             'endowment:page-home': {},
             'endowment:ethereum-provider': {},
-            [PERMITTED_CHAINS_ENDOWMENT]: {
+            'endowment:caip25': {
               caveats: [
                 {
-                  type: 'restrictNetworkSwitching',
-                  value: ['0x5'],
+                  type: 'authorizedScopes',
+                  value: {
+                    requiredScopes: {},
+                    optionalScopes: {
+                      'eip155:2': {
+                        accounts: [],
+                      },
+                    },
+                    sessionProperties: {},
+                    isMultichainOrigin: false,
+                  },
                 },
               ],
             },
@@ -5446,11 +5476,20 @@ describe('SnapController', () => {
           caveats: null,
         },
         'endowment:ethereum-provider': {},
-        [PERMITTED_CHAINS_ENDOWMENT]: {
+        'endowment:caip25': {
           caveats: [
             {
-              type: 'restrictNetworkSwitching',
-              value: ['0x1'],
+              type: 'authorizedScopes',
+              value: {
+                requiredScopes: {},
+                optionalScopes: {
+                  'eip155:1': {
+                    accounts: [],
+                  },
+                },
+                sessionProperties: {},
+                isMultichainOrigin: false,
+              },
             },
           ],
         },
@@ -5468,7 +5507,7 @@ describe('SnapController', () => {
       snapController.destroy();
     });
 
-    it('does not grant the `endowment:permitted-chains` permission if the Snap does not have the `endowment:ethereum-provider` permission', async () => {
+    it('does not grant the `endowment:caip25` permission if the Snap does not have the `endowment:ethereum-provider` permission', async () => {
       const rootMessenger = getControllerMessenger();
       const messenger = getSnapControllerMessenger(rootMessenger);
 

packages/snaps-simulation/src/middleware/internal-methods/middleware.ts

@@ -6,6 +6,7 @@ import { getAccountsHandler } from './accounts';
 import { getChainIdHandler } from './chain-id';
 import { getNetworkVersionHandler } from './net-version';
 import { getProviderStateHandler } from './provider-state';
+import { getSwitchEthereumChainHandler } from './switch-ethereum-chain';
 
 export type InternalMethodsMiddlewareHooks = {
   /**
@@ -23,6 +24,7 @@ const methodHandlers = {
   eth_accounts: getAccountsHandler,
   eth_chainId: getChainIdHandler,
   net_version: getNetworkVersionHandler,
+  wallet_switchEthereumChain: getSwitchEthereumChainHandler,
   /* eslint-enable @typescript-eslint/naming-convention */
 };
 

packages/snaps-simulation/src/middleware/internal-methods/switch-ethereum-chain.test.ts

@@ -0,0 +1,28 @@
+import type { Json, PendingJsonRpcResponse } from '@metamask/utils';
+
+import { getSwitchEthereumChainHandler } from './switch-ethereum-chain';
+
+describe('getSwitchEthereumChainHandler', () => {
+  it('returns `null`', async () => {
+    const end = jest.fn();
+    const result: PendingJsonRpcResponse<Json> = {
+      jsonrpc: '2.0' as const,
+      id: 1,
+    };
+
+    await getSwitchEthereumChainHandler(
+      {
+        jsonrpc: '2.0',
+        id: 1,
+        method: 'wallet_switchEthereumChain',
+        params: [],
+      },
+      result,
+      jest.fn(),
+      end,
+    );
+
+    expect(end).toHaveBeenCalled();
+    expect(result.result).toBeNull();
+  });
+});

packages/snaps-simulation/src/middleware/internal-methods/switch-ethereum-chain.ts

@@ -0,0 +1,32 @@
+import type {
+  JsonRpcEngineEndCallback,
+  JsonRpcEngineNextCallback,
+} from '@metamask/json-rpc-engine';
+import type {
+  Json,
+  JsonRpcRequest,
+  PendingJsonRpcResponse,
+} from '@metamask/utils';
+
+/**
+ * A mock handler for the `wallet_switchEthereumChain` method that always
+ * returns `null`.
+ *
+ * @param _request - Incoming JSON-RPC request. This is ignored for this
+ * specific handler.
+ * @param response - The outgoing JSON-RPC response, modified to return the
+ * result.
+ * @param _next - The `json-rpc-engine` middleware next handler.
+ * @param end - The `json-rpc-engine` middleware end handler.
+ * @returns The response.
+ */
+export async function getSwitchEthereumChainHandler(
+  _request: JsonRpcRequest,
+  response: PendingJsonRpcResponse<Json>,
+  _next: JsonRpcEngineNextCallback,
+  end: JsonRpcEngineEndCallback,
+  // hooks: GetAccountsHandlerHooks,
+) {
+  response.result = null;
+  return end();
+}