Fix MultichainRouter types and tests

Author: Mrtenz

packages/snaps-controllers/src/multichain/MultichainRouter.test.ts

@@ -5,6 +5,7 @@ import {
 } from '@metamask/snaps-utils/test-utils';
 
 import { MultichainRouter } from './MultichainRouter';
+import { METAMASK_ORIGIN } from '../snaps/constants';
 import {
   getRootMultichainRouterMessenger,
   getRestrictedMultichainRouterMessenger,
@@ -51,9 +52,12 @@ describe('MultichainRouter', () => {
       );
 
       const result = await messenger.call('MultichainRouter:handleRequest', {
+        origin: METAMASK_ORIGIN,
         connectedAddresses: BTC_CONNECTED_ACCOUNTS,
         scope: BTC_CAIP2,
         request: {
+          jsonrpc: '2.0',
+          id: 1,
           method: 'sendBitcoin',
           params: {
             message: 'foo',
@@ -102,9 +106,12 @@ describe('MultichainRouter', () => {
       );
 
       const result = await messenger.call('MultichainRouter:handleRequest', {
+        origin: METAMASK_ORIGIN,
         connectedAddresses: SOLANA_CONNECTED_ACCOUNTS,
         scope: SOLANA_CAIP2,
         request: {
+          jsonrpc: '2.0',
+          id: 1,
           method: 'signAndSendTransaction',
           params: {
             message: 'foo',
@@ -149,10 +156,12 @@ describe('MultichainRouter', () => {
       );
 
       const result = await messenger.call('MultichainRouter:handleRequest', {
+        origin: METAMASK_ORIGIN,
         connectedAddresses: [],
         scope: SOLANA_CAIP2,
-        origin: 'metamask',
         request: {
+          jsonrpc: '2.0',
+          id: 1,
           method: 'getVersion',
         },
       });
@@ -162,7 +171,7 @@ describe('MultichainRouter', () => {
         'solana-core': '1.16.7',
       });
 
-      expect(rootMessenger.call).toHaveBeenNthCalledWith(
+      expect(messenger.call).toHaveBeenNthCalledWith(
         5,
         'SnapController:handleRequest',
         {
@@ -173,7 +182,7 @@ describe('MultichainRouter', () => {
             method: '',
             params: {
               request: {
-                id: expect.any(String),
+                id: 1,
                 jsonrpc: '2.0',
                 method: 'getVersion',
               },
@@ -206,9 +215,12 @@ describe('MultichainRouter', () => {
 
       await expect(
         messenger.call('MultichainRouter:handleRequest', {
+          origin: METAMASK_ORIGIN,
           connectedAddresses: [],
           scope: SOLANA_CAIP2,
           request: {
+            jsonrpc: '2.0',
+            id: 1,
             method: 'getVersion',
           },
         }),
@@ -241,9 +253,12 @@ describe('MultichainRouter', () => {
 
       await expect(
         messenger.call('MultichainRouter:handleRequest', {
+          origin: METAMASK_ORIGIN,
           connectedAddresses: SOLANA_CONNECTED_ACCOUNTS,
           scope: SOLANA_CAIP2,
           request: {
+            jsonrpc: '2.0',
+            id: 1,
             method: 'signAndSendTransaction',
             params: {
               message: 'foo',
@@ -282,9 +297,12 @@ describe('MultichainRouter', () => {
 
       await expect(
         messenger.call('MultichainRouter:handleRequest', {
+          origin: METAMASK_ORIGIN,
           connectedAddresses: SOLANA_CONNECTED_ACCOUNTS,
           scope: SOLANA_CAIP2,
           request: {
+            jsonrpc: '2.0',
+            id: 1,
             method: 'signAndSendTransaction',
             params: {
               message: 'foo',
@@ -322,9 +340,12 @@ describe('MultichainRouter', () => {
 
       await expect(
         messenger.call('MultichainRouter:handleRequest', {
+          origin: METAMASK_ORIGIN,
           connectedAddresses: SOLANA_CONNECTED_ACCOUNTS,
           scope: SOLANA_CAIP2,
           request: {
+            jsonrpc: '2.0',
+            id: 1,
             method: 'signAndSendTransaction',
             params: {
               message: 'foo',

packages/snaps-controllers/src/multichain/MultichainRouter.ts

@@ -60,7 +60,7 @@ type SnapKeyring = {
 };
 
 // Expecting a bound function that calls KeyringController.withKeyring selecting the Snap keyring
-type WithSnapKeyringFunction = <ReturnType>(
+export type WithSnapKeyringFunction = <ReturnType>(
   operation: ({ keyring }: { keyring: SnapKeyring }) => Promise<ReturnType>,
 ) => Promise<ReturnType>;
 

packages/snaps-controllers/src/test-utils/controller.tsx

@@ -919,7 +919,7 @@ export const getRestrictedMultichainRouterMessenger = (
 ) => {
   const controllerMessenger = new Messenger<
     'MultichainRouter',
-    MultichainRouterAllowedActions,
+    MultichainRouterActions | MultichainRouterAllowedActions,
     never,
     any
   >({ namespace: 'MultichainRouter', parent: messenger });
@@ -934,6 +934,8 @@ export const getRestrictedMultichainRouterMessenger = (
     messenger: controllerMessenger,
   });
 
+  jest.spyOn(controllerMessenger, 'call');
+
   return controllerMessenger;
 };
 

packages/snaps-controllers/src/test-utils/multichain.ts

@@ -4,6 +4,8 @@ import { SnapCaveatType } from '@metamask/snaps-utils';
 import { MOCK_SNAP_ID } from '@metamask/snaps-utils/test-utils';
 import type { CaipAccountId, CaipChainId, Json } from '@metamask/utils';
 
+import type { WithSnapKeyringFunction } from '@metamask/snaps-controllers';
+
 export const BTC_CAIP2 =
   'bip122:000000000019d6689c085ae165831e93' as CaipChainId;
 export const BTC_CONNECTED_ACCOUNTS = [
@@ -28,6 +30,7 @@ export const MOCK_BTC_ACCOUNTS = [
     methods: ['sendBitcoin'],
     options: { index: 0, scope: BTC_CAIP2 },
     type: 'bip122:p2wpkh',
+    scopes: [],
   },
 ];
 
@@ -55,6 +58,7 @@ export const MOCK_SOLANA_ACCOUNTS = [
     methods: ['signAndSendTransaction'],
     options: { index: 0, scope: SOLANA_CAIP2 },
     type: 'solana:data-account',
+    scopes: [],
   },
 ];
 
@@ -99,14 +103,14 @@ type MockOperationCallback = ({
   keyring,
 }: {
   keyring: MockSnapKeyring;
-}) => Promise<Json>;
+}) => Promise<any>;
 
 export const getMockWithSnapKeyring = (
   { submitRequest = jest.fn(), resolveAccountAddress = jest.fn() } = {
     submitRequest: jest.fn(),
     resolveAccountAddress: jest.fn(),
   },
-) => {
+): WithSnapKeyringFunction => {
   return async (callback: MockOperationCallback) =>
     callback({
       keyring: {