fix(bridge-status-controller): use KeyringClient to force use of KeyringRequest.origin

packages/bridge-status-controller/CHANGELOG.md

@@ -7,6 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Fixed
+
+- Now forward `KeyringRequest.origin` when submitting transactions ([#5918](https://github.com/MetaMask/core/pull/5918))
+  - This is a new requirement when using the Snap platform version `7.0.0` and the keyring API version `18.0.0`.
+
 ## [29.1.0]
 
 ### Added

packages/bridge-status-controller/package.json

@@ -50,7 +50,10 @@
     "@metamask/base-controller": "^8.0.1",
     "@metamask/controller-utils": "^11.9.0",
     "@metamask/keyring-api": "^18.0.0",
+    "@metamask/keyring-snap-client": "^5.0.0",
     "@metamask/polling-controller": "^13.0.0",
+    "@metamask/snaps-sdk": "^7.1.0",
+    "@metamask/snaps-utils": "^9.4.0",
     "@metamask/superstruct": "^3.1.0",
     "@metamask/user-operation-controller": "^36.0.0",
     "@metamask/utils": "^11.2.0",

packages/bridge-status-controller/src/__snapshots__/bridge-status-controller.test.ts.snap

@@ -2866,6 +2866,7 @@ Array [
         "params": Object {
           "account": undefined,
           "id": "test-uuid-1234",
+          "origin": "metamask",
           "request": Object {
             "method": "signAndSendTransaction",
             "params": Object {

packages/bridge-status-controller/src/bridge-status-controller.test.ts

@@ -52,8 +52,16 @@ import { flushPromises } from '../../../tests/helpers';
 import { CHAIN_IDS } from '../../bridge-controller/src/constants/chains';
 import type { MultichainTransactionsControllerEvents } from '../../multichain-transactions-controller/src/MultichainTransactionsController';
 
+const mockUuidV4 = 'test-uuid-1234';
+
 jest.mock('uuid', () => ({
-  v4: () => 'test-uuid-1234',
+  v4: () => mockUuidV4,
+}));
+
+// FIXME: For now, the accounts packages do use a different major version of `uuid`, so we need to mock
+// explicitly this version for now!
+jest.mock('@metamask/keyring-snap-client/node_modules/uuid', () => ({
+  v4: () => mockUuidV4,
 }));
 
 const mockIsEthUsdt = jest.fn();
@@ -1431,7 +1439,14 @@ describe('BridgeStatusController', () => {
 
     it('should successfully submit a Solana transaction', async () => {
       mockMessengerCall.mockReturnValueOnce(mockSolanaAccount);
-      mockMessengerCall.mockResolvedValueOnce('signature');
+      mockMessengerCall.mockResolvedValueOnce({
+        // We now use a `KeyringClient` to dispatch keyring requests, thus
+        // the return type has to follow this shape:
+        pending: false,
+        result: {
+          signature: 'signature',
+        },
+      });
 
       mockMessengerCall.mockReturnValueOnce(mockSolanaAccount);
       mockMessengerCall.mockReturnValueOnce(mockSolanaAccount);

packages/bridge-status-controller/src/bridge-status-controller.ts

@@ -19,7 +19,10 @@ import {
 import type { TraceCallback } from '@metamask/controller-utils';
 import { toHex } from '@metamask/controller-utils';
 import { EthAccountType } from '@metamask/keyring-api';
+import { KeyringClient } from '@metamask/keyring-snap-client';
 import { StaticIntervalPollingController } from '@metamask/polling-controller';
+import type { SnapId } from '@metamask/snaps-sdk';
+import { HandlerType } from '@metamask/snaps-utils';
 import type {
   TransactionController,
   TransactionParams,
@@ -30,6 +33,7 @@ import {
   type TransactionMeta,
 } from '@metamask/transaction-controller';
 import type { UserOperationController } from '@metamask/user-operation-controller';
+import type { Json, JsonRpcRequest } from '@metamask/utils';
 import { numberToHex, type Hex } from '@metamask/utils';
 import { BigNumber } from 'bignumber.js';
 
@@ -536,6 +540,24 @@ export class BridgeStatusController extends StaticIntervalPollingController<Brid
    *******************************************************
    */
 
+  /**
+   * Gets a keyring client for a given Snap ID.
+   *
+   * @param snapId - The Snap ID.
+   * @returns The keyring client.
+   */
+  #getKeyringClient(snapId: SnapId): KeyringClient {
+    return new KeyringClient({
+      send: async (request: JsonRpcRequest) =>
+        (await this.messagingSystem.call('SnapController:handleRequest', {
+          snapId,
+          origin: 'metamask',
+          handler: HandlerType.OnKeyringRequest,
+          request,
+        })) as Promise<Json>,
+    });
+  }
+
   /**
    * Submits the transaction to the snap using the keyring rpc method
    * This adds an approval tx to the ApprovalsController in the background
@@ -559,9 +581,12 @@ export class BridgeStatusController extends StaticIntervalPollingController<Brid
         'Failed to submit cross-chain swap transaction: undefined snap id',
       );
     }
+
+    const keyringClient = this.#getKeyringClient(
+      selectedAccount.metadata.snap.id as SnapId,
+    );
     const keyringRequest = getKeyringRequest(quoteResponse, selectedAccount);
-    const keyringResponse = (await this.messagingSystem.call(
-      'SnapController:handleRequest',
+    const keyringResponse = (await keyringClient.submitRequest(
       keyringRequest,
     )) as string | { result: Record<string, string> };
 

packages/bridge-status-controller/src/utils/transaction.ts

@@ -7,6 +7,7 @@ import {
   type QuoteMetadata,
   type QuoteResponse,
 } from '@metamask/bridge-controller';
+import type { KeyringRequest } from '@metamask/keyring-api';
 import { SolScope } from '@metamask/keyring-api';
 import {
   TransactionStatus,
@@ -126,31 +127,23 @@ export const handleLineaDelay = async (
 export const getKeyringRequest = (
   quoteResponse: Omit<QuoteResponse<string>, 'approval'> & QuoteMetadata,
   selectedAccount: AccountsControllerState['internalAccounts']['accounts'][string],
-) => {
+): KeyringRequest => {
   const keyringReqId = uuid();
-  const snapRequestId = uuid();
 
   return {
+    // An origin is now required on the inner-request. We use `'metamask'` here since
+    // those requests will be dispatched by MetaMask itself (internal use only).
     origin: 'metamask',
-    snapId: selectedAccount.metadata.snap?.id as never,
-    handler: 'onKeyringRequest' as never,
     request: {
-      id: keyringReqId,
-      jsonrpc: '2.0',
-      method: 'keyring_submitRequest',
       params: {
-        request: {
-          params: {
-            account: { address: selectedAccount.address },
-            transaction: quoteResponse.trade,
-            scope: SolScope.Mainnet,
-          },
-          method: 'signAndSendTransaction',
-        },
-        id: snapRequestId,
-        account: selectedAccount.id,
+        account: { address: selectedAccount.address },
+        transaction: quoteResponse.trade,
         scope: SolScope.Mainnet,
       },
+      method: 'signAndSendTransaction',
     },
+    id: keyringReqId,
+    account: selectedAccount.id,
+    scope: SolScope.Mainnet,
   };
 };

yarn.lock

@@ -2777,10 +2777,13 @@ __metadata:
     "@metamask/controller-utils": "npm:^11.9.0"
     "@metamask/gas-fee-controller": "npm:^23.0.0"
     "@metamask/keyring-api": "npm:^18.0.0"
+    "@metamask/keyring-snap-client": "npm:^5.0.0"
     "@metamask/multichain-transactions-controller": "npm:^2.0.0"
     "@metamask/network-controller": "npm:^23.5.1"
     "@metamask/polling-controller": "npm:^13.0.0"
     "@metamask/snaps-controllers": "npm:^12.3.1"
+    "@metamask/snaps-sdk": "npm:^7.1.0"
+    "@metamask/snaps-utils": "npm:^9.4.0"
     "@metamask/superstruct": "npm:^3.1.0"
     "@metamask/transaction-controller": "npm:^57.0.0"
     "@metamask/user-operation-controller": "npm:^36.0.0"