fix(passport): prevent eth_requestAccounts from being called on Magic RPC (#2576)

Co-authored-by: Hayden Fowler <hayden.fowler@gmail.com>

Author: pano-skylakis

packages/passport/sdk/src/magic/magicProviderProxyFactory.test.ts

@@ -107,5 +107,17 @@ describe('MagicProviderProxyFactory', () => {
 
       await expect(proxy.request!(params)).rejects.toThrow('ProviderProxy: Test error');
     });
+
+    it('should convert eth_requestAccounts to eth_accounts to avoid Magic overlay', async () => {
+      const proxy = factory.createProxy(mockMagicClient);
+      const params = { method: 'eth_requestAccounts' };
+      (mockMagicClient.user.isLoggedIn as jest.Mock).mockResolvedValue(true);
+
+      await proxy.request!(params);
+
+      expect(mockMagicClient.user.isLoggedIn).toHaveBeenCalled();
+      expect(mockRpcProvider.request).toHaveBeenCalledWith({ method: 'eth_accounts' });
+      expect(mockRpcProvider.request).not.toHaveBeenCalledWith(params);
+    });
   });
 });

packages/passport/sdk/src/magic/magicProviderProxyFactory.ts

@@ -8,7 +8,15 @@ const shouldCheckMagicSession = (args: any[]): boolean => (
   && typeof args[0] === 'object'
     && 'method' in args[0]
     && typeof args[0].method === 'string'
-    && ['personal_sign', 'eth_accounts'].includes(args[0].method)
+    && ['personal_sign', 'eth_accounts', 'eth_requestAccounts'].includes(args[0].method)
+);
+
+const isEthRequestAccountsCall = (args: any[]): boolean => (
+  args?.length > 0
+  && typeof args[0] === 'object'
+  && 'method' in args[0]
+  && typeof args[0].method === 'string'
+  && args[0].method === 'eth_requestAccounts'
 );
 
 /**
@@ -47,6 +55,12 @@ export class MagicProviderProxyFactory {
                     providerId: this.config.magicProviderId,
                   });
                 }
+
+                if (isEthRequestAccountsCall(args)) {
+                  // @ts-ignore - Calling eth_requestAccounts on the Magic RPC provider displays an overlay, so this
+                  // should be avoided - call eth_accounts instead.
+                  return target.request!({ method: 'eth_accounts' });
+                }
               }
 
               // @ts-ignore - Invoke the request method with the provided arguments