feat: Add option to hide return modal

0xEdouardEth · 0xEdouardEth · commit 72edc58f7777 · 2025-09-29T15:45:14.000+02:00
diff --git a/packages/sdk/src/PostMessageStream/RemoteCommunicationPostMessageStream.test.ts b/packages/sdk/src/PostMessageStream/RemoteCommunicationPostMessageStream.test.ts
@@ -36,6 +36,22 @@ describe('RemoteCommunicationPostMessageStream', () => {
     );
   });
 
+  it('should initialize with hideReturnToAppModal option', () => {
+    const instanceWithOption = new RemoteCommunicationPostMessageStream({
+      name: ProviderConstants.PROVIDER,
+      remote: mockRemoteCommunication,
+      deeplinkProtocol: false,
+      platformManager: mockPlatformManager,
+      hideReturnToAppModal: true,
+    });
+
+    expect(instanceWithOption.state.hideReturnToAppModal).toBe(true);
+  });
+
+  it('should have hideReturnToAppModal as false by default', () => {
+    expect(instance.state.hideReturnToAppModal).toBe(false);
+  });
+
   it('should call _write properly', async () => {
     const chunk = 'someData';
     const encoding = 'utf8';
diff --git a/packages/sdk/src/PostMessageStream/RemoteCommunicationPostMessageStream.ts b/packages/sdk/src/PostMessageStream/RemoteCommunicationPostMessageStream.ts
@@ -14,6 +14,7 @@ interface RemoteCommunicationPostMessageStreamState {
   _name: any;
   remote: RemoteCommunication | null;
   deeplinkProtocol: boolean;
+  hideReturnToAppModal?: boolean;
   platformManager: PlatformManager | null;
 }
 
@@ -25,17 +26,20 @@ export class RemoteCommunicationPostMessageStream
     _name: null,
     remote: null,
     deeplinkProtocol: false,
+    hideReturnToAppModal: false,
     platformManager: null,
   };
 
   constructor({
     name,
     remote,
     deeplinkProtocol,
+    hideReturnToAppModal,
     platformManager,
   }: {
     name: ProviderConstants;
     deeplinkProtocol: boolean;
+    hideReturnToAppModal?: boolean;
     remote: RemoteCommunication;
     platformManager: PlatformManager;
   }) {
@@ -45,6 +49,8 @@ export class RemoteCommunicationPostMessageStream
     this.state._name = name;
     this.state.remote = remote;
     this.state.deeplinkProtocol = deeplinkProtocol;
+    this.state.hideReturnToAppModal =
+      hideReturnToAppModal ?? this.state.hideReturnToAppModal;
     this.state.platformManager = platformManager;
 
     this._onMessage = this._onMessage.bind(this);
diff --git a/packages/sdk/src/PostMessageStream/getPostMessageStream.test.ts b/packages/sdk/src/PostMessageStream/getPostMessageStream.test.ts
@@ -59,4 +59,38 @@ describe('getPostMessageStream', () => {
       platformManager: fakePlatformManager,
     });
   });
+
+  it('should pass hideReturnToAppModal from remoteConnection state', () => {
+    const fakeConnector = {};
+    const fakePlatformManager = {};
+    const hideReturnToAppModal = true;
+    mockRemoteConnection.mockImplementation(
+      () =>
+        ({
+          getConnector: jest.fn().mockReturnValue(fakeConnector),
+          getPlatformManager: jest.fn().mockReturnValue(fakePlatformManager),
+          state: {
+            deeplinkProtocol: false,
+            hideReturnToAppModal,
+          },
+        } as any),
+    );
+
+    const result = getPostMessageStream({
+      name: ProviderConstants.CONTENT_SCRIPT,
+      remoteConnection: new RemoteConnection({
+        getConnector: jest.fn().mockReturnValue(fakeConnector),
+      } as any),
+      debug: false,
+    } as any);
+
+    expect(result).toBeInstanceOf(RemoteCommunicationPostMessageStream);
+    expect(mockPostMessageStream).toHaveBeenCalledWith({
+      name: ProviderConstants.CONTENT_SCRIPT,
+      remote: fakeConnector,
+      deeplinkProtocol: false,
+      platformManager: fakePlatformManager,
+      hideReturnToAppModal,
+    });
+  });
 });
diff --git a/packages/sdk/src/PostMessageStream/getPostMessageStream.ts b/packages/sdk/src/PostMessageStream/getPostMessageStream.ts
@@ -25,6 +25,7 @@ export const getPostMessageStream = ({
     name,
     remote: remoteConnection?.getConnector(),
     deeplinkProtocol: remoteConnection?.state.deeplinkProtocol,
+    hideReturnToAppModal: remoteConnection?.state.hideReturnToAppModal,
     platformManager: remoteConnection?.getPlatformManager(),
   });
 };
diff --git a/packages/sdk/src/sdk.test.ts b/packages/sdk/src/sdk.test.ts
@@ -199,6 +199,33 @@ describe('MetaMaskSDK', () => {
       expect(sdk.options).toMatchObject(options);
     });
 
+    it('should initialize with hideReturnToAppModal option', () => {
+      const options: MetaMaskSDKOptions = {
+        hideReturnToAppModal: true,
+        dappMetadata: {
+          name: 'Test DApp',
+          url: 'http://test-dapp.com',
+        },
+      };
+
+      sdk = new MetaMaskSDK(options);
+
+      expect(sdk.options.hideReturnToAppModal).toBe(true);
+    });
+
+    it('should have hideReturnToAppModal as undefined by default', () => {
+      const options: MetaMaskSDKOptions = {
+        dappMetadata: {
+          name: 'Test DApp',
+          url: 'http://test-dapp.com',
+        },
+      };
+
+      sdk = new MetaMaskSDK(options);
+
+      expect(sdk.options.hideReturnToAppModal).toBeUndefined();
+    });
+
     it('should set max listeners', () => {
       expect(sdk.getMaxListeners()).toBe(50);
     });
diff --git a/packages/sdk/src/sdk.ts b/packages/sdk/src/sdk.ts
@@ -91,6 +91,12 @@ export interface MetaMaskSDKOptions {
    */
   useDeeplink?: boolean;
 
+  /**
+   * If true, MetaMask Mobile will hide the modal that invites the user to return to the app after performing an action on MetaMask Mobile.
+   * This should be used when the app is loaded in an iframe inside the MetaMask Mobile browser.
+   */
+  hideReturnToAppModal?: boolean;
+
   /**
    * If true, the SDK will shim the window.web3 object with the provider returned by the SDK (useful for compatibility with older browser).
    */
@@ -220,6 +226,7 @@ export class MetaMaskSDK extends EventEmitter2 {
       enableAnalytics: true,
       shouldShimWeb3: true,
       useDeeplink: true,
+      hideReturnToAppModal: false,
       extensionOnly: true,
       headless: false,
       dappMetadata: {
diff --git a/packages/sdk/src/services/MetaMaskSDK/InitializerManager/performSDKInitialization.test.ts b/packages/sdk/src/services/MetaMaskSDK/InitializerManager/performSDKInitialization.test.ts
@@ -57,6 +57,7 @@ describe('performSDKInitialization', () => {
       injectProvider: true,
       shouldShimWeb3: true,
       useDeeplink: true,
+      hideReturnToAppModal: false,
       storage: {
         enabled: true,
       },
diff --git a/packages/sdk/src/services/MetaMaskSDK/InitializerManager/performSDKInitialization.ts b/packages/sdk/src/services/MetaMaskSDK/InitializerManager/performSDKInitialization.ts
@@ -57,6 +57,7 @@ export async function performSDKInitialization(instance: MetaMaskSDK) {
   options.shouldShimWeb3 = options.shouldShimWeb3 ?? true;
   options.extensionOnly = options.extensionOnly ?? true;
   options.useDeeplink = options.useDeeplink ?? true;
+  options.hideReturnToAppModal = options.hideReturnToAppModal ?? false;
   options.storage = options.storage ?? {
     enabled: true,
   };
diff --git a/packages/sdk/src/services/RemoteCommunicationPostMessageStream/write.test.ts b/packages/sdk/src/services/RemoteCommunicationPostMessageStream/write.test.ts
@@ -317,4 +317,83 @@ describe('write function', () => {
       expect(mockSendMessage).toHaveBeenCalled();
     });
   });
+
+  describe('hideReturnToAppModal URL parameter', () => {
+    beforeEach(() => {
+      mockIsReady.mockReturnValue(true);
+      mockIsConnected.mockReturnValue(true);
+      mockIsAuthorized.mockReturnValue(true);
+      mockIsMobileWeb.mockReturnValue(false);
+      mockIsSecure.mockReturnValue(true);
+      mockGetChannelId.mockReturnValue('some_channel_id');
+      mockIsMetaMaskInstalled.mockReturnValue(true);
+      mockGetKeyInfo.mockReturnValue({ ecies: { public: 'test_public_key' } });
+      mockHasDeeplinkProtocol.mockReturnValue(false);
+      mockExtractMethod.mockReturnValue({
+        method: Object.keys(METHODS_TO_REDIRECT)[0],
+        data: {
+          data: {
+            jsonrpc: '2.0',
+            method: Object.keys(METHODS_TO_REDIRECT)[0],
+            params: [],
+          },
+        },
+        triggeredInstaller: false,
+      });
+    });
+
+    it('should include hr=1 in URL when hideReturnToAppModal is true', async () => {
+      mockRemoteCommunicationPostMessageStream.state.hideReturnToAppModal =
+        true;
+
+      await write(
+        mockRemoteCommunicationPostMessageStream,
+        { jsonrpc: '2.0', method: Object.keys(METHODS_TO_REDIRECT)[0] },
+        'utf8',
+        callback,
+      );
+
+      expect(mockOpenDeeplink).toHaveBeenCalledWith(
+        expect.stringContaining('hr=1'),
+        expect.stringContaining('hr=1'),
+        '_self',
+      );
+    });
+
+    it('should include hr=0 in URL when hideReturnToAppModal is false', async () => {
+      mockRemoteCommunicationPostMessageStream.state.hideReturnToAppModal =
+        false;
+
+      await write(
+        mockRemoteCommunicationPostMessageStream,
+        { jsonrpc: '2.0', method: Object.keys(METHODS_TO_REDIRECT)[0] },
+        'utf8',
+        callback,
+      );
+
+      expect(mockOpenDeeplink).toHaveBeenCalledWith(
+        expect.stringContaining('hr=0'),
+        expect.stringContaining('hr=0'),
+        '_self',
+      );
+    });
+
+    it('should include hr=0 in URL when hideReturnToAppModal is undefined', async () => {
+      mockRemoteCommunicationPostMessageStream.state.hideReturnToAppModal =
+        undefined;
+
+      await write(
+        mockRemoteCommunicationPostMessageStream,
+        { jsonrpc: '2.0', method: Object.keys(METHODS_TO_REDIRECT)[0] },
+        'utf8',
+        callback,
+      );
+
+      expect(mockOpenDeeplink).toHaveBeenCalledWith(
+        expect.stringContaining('hr=0'),
+        expect.stringContaining('hr=0'),
+        '_self',
+      );
+    });
+  });
 });
diff --git a/packages/sdk/src/services/RemoteCommunicationPostMessageStream/write.ts b/packages/sdk/src/services/RemoteCommunicationPostMessageStream/write.ts
@@ -100,7 +100,9 @@ export async function write(
 
     const pubKey = instance.state.remote?.getKeyInfo()?.ecies.public ?? '';
     let urlParams = encodeURI(
-      `channelId=${channelId}&pubkey=${pubKey}&comm=socket&t=d&v=2`,
+      `channelId=${channelId}&pubkey=${pubKey}&comm=socket&t=d&v=2&hr=${
+        instance.state.hideReturnToAppModal ? 1 : 0
+      }`,
     );
 
     if (activeDeeplinkProtocol) {
diff --git a/packages/sdk/src/services/RemoteConnection/ConnectionManager/startConnection.test.ts b/packages/sdk/src/services/RemoteConnection/ConnectionManager/startConnection.test.ts
@@ -223,4 +223,55 @@ describe('startConnection', () => {
       );
     });
   });
+
+  describe('hideReturnToAppModal URL parameter', () => {
+    beforeEach(() => {
+      mockIsSecure.mockReturnValue(true);
+    });
+
+    it('should pass hr=1 when hideReturnToAppModal is true', async () => {
+      state.hideReturnToAppModal = true;
+
+      await startConnection(state, options);
+
+      // Vérifier que le QR code link contient hr=1
+      expect(state.qrcodeLink).toContain('hr=1');
+    });
+
+    it('should pass hr=0 when hideReturnToAppModal is false', async () => {
+      state.hideReturnToAppModal = false;
+
+      await startConnection(state, options);
+
+      // Vérifier que le QR code link contient hr=0
+      expect(state.qrcodeLink).toContain('hr=0');
+    });
+
+    it('should pass hr=0 when hideReturnToAppModal is undefined', async () => {
+      state.hideReturnToAppModal = undefined;
+
+      await startConnection(state, options);
+
+      // Vérifier que le QR code link contient hr=0
+      expect(state.qrcodeLink).toContain('hr=0');
+    });
+
+    it('should include hr parameter in connectWith scenarios', async () => {
+      mockIsSecure.mockReturnValue(false);
+      state.hideReturnToAppModal = true;
+      const connectWith = {
+        method: 'eth_sign',
+        params: ['0x123456', '0xabcdef'],
+        id: '123',
+      };
+
+      await startConnection(state, options, { connectWith });
+
+      expect(mockConnectWithModalInstaller).toHaveBeenCalledWith(
+        state,
+        options,
+        expect.stringContaining('hr=1'),
+      );
+    });
+  });
 });
diff --git a/packages/sdk/src/services/RemoteConnection/ConnectionManager/startConnection.ts b/packages/sdk/src/services/RemoteConnection/ConnectionManager/startConnection.ts
@@ -148,7 +148,9 @@ export async function startConnection(
 
     let linkParams = `channelId=${channelId}&v=2&comm=${
       state.communicationLayerPreference ?? ''
-    }&pubkey=${pubKey}${qrCodeOrigin}&originatorInfo=${base64OriginatorInfo}`;
+    }&pubkey=${pubKey}${qrCodeOrigin}&originatorInfo=${base64OriginatorInfo}&hr=${
+      state.hideReturnToAppModal ? 1 : 0
+    }`;
 
     if (connectWith) {
       const base64Rpc = base64Encode(JSON.stringify(connectWith));
diff --git a/packages/sdk/src/services/RemoteConnection/RemoteConnection.ts b/packages/sdk/src/services/RemoteConnection/RemoteConnection.ts
@@ -93,6 +93,7 @@ export interface RemoteConnectionState {
   connector?: RemoteCommunication;
   qrcodeLink?: string;
   useDeeplink?: boolean;
+  hideReturnToAppModal?: boolean;
   developerMode: boolean;
   analytics?: Analytics;
   authorized: boolean;
@@ -146,6 +147,7 @@ export class RemoteConnection {
     this.state.analytics = options.analytics;
     this.state.preferDesktop = options.preferDesktop ?? false;
     this.state.useDeeplink = options.sdk.options.useDeeplink;
+    this.state.hideReturnToAppModal = options.sdk.options.hideReturnToAppModal;
     this.state.communicationLayerPreference =
       options.communicationLayerPreference;
     this.state.platformManager = options.platformManager;
