feat!: add KeyringRequest.origin

README.md

@@ -53,6 +53,7 @@ linkStyle default opacity:0.5
   keyring_internal_api --> keyring_api;
   keyring_internal_api --> keyring_utils;
   keyring_internal_snap_client --> keyring_api;
+  keyring_internal_snap_client --> keyring_internal_api;
   keyring_internal_snap_client --> keyring_snap_client;
   keyring_internal_snap_client --> keyring_utils;
   eth_snap_keyring --> keyring_api;

package.json

@@ -34,6 +34,7 @@
     "test:types": "yarn foreach test:types"
   },
   "resolutions": {
+    "@metamask/snaps-sdk@^6.24.0": "npm:@metamask/snaps-sdk@^7.0.0",
     "@types/node": "^20.12.12",
     "@types/web": "^0.0.69",
     "@typescript/lib-dom": "npm:@types/web@^0.0.69",

packages/keyring-api/src/api/request.test.ts

@@ -10,6 +10,7 @@ describe('KeyringRequest', () => {
         id: '47d782ac-15c8-4c81-8bfe-759ae1be4a3e',
         scope: 'eip155:1',
         account: 'd6311e3c-a4ec-43fa-b341-592ffefd9797',
+        origin: 'metamask',
         request: {
           method: 'eth_personalSign',
           params: {
@@ -24,6 +25,7 @@ describe('KeyringRequest', () => {
         id: '47d782ac-15c8-4c81-8bfe-759ae1be4a3e',
         scope: 'eip155:1',
         account: 'd6311e3c-a4ec-43fa-b341-592ffefd9797',
+        origin: 'metamask',
         request: {
           method: 'eth_somethingElseWithNoParameters',
         },
@@ -36,6 +38,7 @@ describe('KeyringRequest', () => {
       request: {
         scope: 'eip155:1',
         account: 'd6311e3c-a4ec-43fa-b341-592ffefd9797',
+        origin: 'metamask',
         request: {
           method: 'eth_personalSign',
           params: {
@@ -50,6 +53,7 @@ describe('KeyringRequest', () => {
       request: {
         id: '47d782ac-15c8-4c81-8bfe-759ae1be4a3e',
         account: 'd6311e3c-a4ec-43fa-b341-592ffefd9797',
+        origin: 'metamask',
         request: {
           method: 'eth_personalSign',
           params: {
@@ -64,6 +68,22 @@ describe('KeyringRequest', () => {
       request: {
         id: '47d782ac-15c8-4c81-8bfe-759ae1be4a3e',
         scope: 'eip155:1',
+        origin: 'metamask',
+        request: {
+          method: 'eth_personalSign',
+          params: {
+            data: '0x00...',
+          },
+        },
+      },
+      expected: false,
+    },
+    // Missing origin
+    {
+      request: {
+        id: '47d782ac-15c8-4c81-8bfe-759ae1be4a3e',
+        scope: 'eip155:1',
+        account: 'd6311e3c-a4ec-43fa-b341-592ffefd9797',
         request: {
           method: 'eth_personalSign',
           params: {
@@ -79,6 +99,7 @@ describe('KeyringRequest', () => {
         id: '47d782ac-15c8-4c81-8bfe-759ae1be4a3e',
         scope: 'eip155:1',
         account: 'd6311e3c-a4ec-43fa-b341-592ffefd9797',
+        origin: 'metamask',
       },
       expected: false,
     },

packages/keyring-api/src/api/request.ts

@@ -19,6 +19,11 @@ export const KeyringRequestStruct = object({
    */
   account: UuidStruct,
 
+  /**
+   * Origin of the sender.
+   */
+  origin: string(),
+
   /**
    * Inner request sent by the client application.
    */

packages/keyring-internal-api/src/compatibility/index.ts

@@ -0,0 +1 @@
+export * from './v1';

packages/keyring-internal-api/src/compatibility/v1.test.ts

@@ -0,0 +1,23 @@
+import { EthMethod, EthScope } from '@metamask/keyring-api';
+
+import { toKeyringRequestV1 } from './v1';
+
+describe('v1', () => {
+  describe('toKeyringRequestV1', () => {
+    const request = {
+      id: 'mock-request-id',
+      scope: EthScope.Mainnet,
+      account: '55583f38-d81b-48f8-8494-fc543c2b5c95',
+      origin: 'test',
+      request: {
+        method: EthMethod.PersonalSign,
+        params: {},
+      },
+    };
+    const { origin, ...requestV1 } = request;
+
+    it('converts a keyring request to a keyring request v1', () => {
+      expect(toKeyringRequestV1(request)).toStrictEqual(requestV1);
+    });
+  });
+});

packages/keyring-internal-api/src/compatibility/v1.ts

@@ -0,0 +1,34 @@
+import type { KeyringRequest } from '@metamask/keyring-api';
+import {
+  KeyringRequestStruct,
+  KeyringResponseStruct,
+} from '@metamask/keyring-api';
+import { omit, type Infer } from '@metamask/superstruct';
+
+/**
+ * Keyring request (v1).
+ */
+export const KeyringRequestV1Struct = omit(KeyringRequestStruct, ['origin']);
+
+export type KeyringRequestV1 = Infer<typeof KeyringRequestV1Struct>;
+
+/**
+ * Response to a call to `submitRequest` (v1).
+ */
+export const KeyringResponseV1Struct = KeyringResponseStruct;
+
+export type KeyringResponseV1 = Infer<typeof KeyringResponseV1Struct>;
+
+export const SubmitRequestResponseV1Struct = KeyringResponseV1Struct;
+
+/**
+ * Converts a keyring request to a keyring request v1.
+ *
+ * @param request - A keyring request.
+ * @returns A keyring request v1.
+ */
+export function toKeyringRequestV1(request: KeyringRequest): KeyringRequestV1 {
+  const { origin, ...requestV1 } = request;
+
+  return requestV1;
+}

packages/keyring-internal-api/src/index.ts

@@ -1,2 +1,4 @@
+export * from './compatibility';
 export type * from './eth';
 export * from './types';
+export * from './versions';

packages/keyring-internal-api/src/versions.ts

@@ -0,0 +1,12 @@
+export enum KeyringVersion {
+  /** Default. */
+  V1 = 'v1',
+
+  /**
+   * Introduction of `KeyringRequest.origin`.
+   *
+   * Snap will now receive the `origin` as part of a `KeyringRequest` when `submitRequest` is invoked.
+   * We also expect Snaps to display this `origin` in their confirmation screens (if any).
+   */
+  V2 = 'v2',
+}

packages/keyring-internal-snap-client/package.json

@@ -47,16 +47,17 @@
   "dependencies": {
     "@metamask/base-controller": "^7.1.1",
     "@metamask/keyring-api": "workspace:^",
+    "@metamask/keyring-internal-api": "workspace:^",
     "@metamask/keyring-snap-client": "workspace:^",
     "@metamask/keyring-utils": "workspace:^"
   },
   "devDependencies": {
     "@lavamoat/allow-scripts": "^3.2.1",
     "@lavamoat/preinstall-always-fail": "^2.1.0",
     "@metamask/auto-changelog": "^3.4.4",
-    "@metamask/snaps-controllers": "^9.18.0",
-    "@metamask/snaps-sdk": "^6.16.0",
-    "@metamask/snaps-utils": "^8.9.1",
+    "@metamask/snaps-controllers": "^12.2.0",
+    "@metamask/snaps-sdk": "^7.0.0",
+    "@metamask/snaps-utils": "^9.3.0",
     "@metamask/utils": "^11.1.0",
     "@ts-bridge/cli": "^0.6.3",
     "@types/jest": "^29.5.12",

packages/keyring-internal-snap-client/src/KeyringInternalSnapClient.test.ts

@@ -1,24 +1,29 @@
-import type { KeyringAccount } from '@metamask/keyring-api';
+import {
+  EthMethod,
+  EthScope,
+  type KeyringAccount,
+} from '@metamask/keyring-api';
+import type { KeyringRequestV1 } from '@metamask/keyring-internal-api';
 import type { SnapId } from '@metamask/snaps-sdk';
 
 import {
   KeyringInternalSnapClient,
   type KeyringInternalSnapClientMessenger,
 } from './KeyringInternalSnapClient';
 
+const MOCK_ACCOUNT: KeyringAccount = {
+  id: '13f94041-6ae6-451f-a0fe-afdd2fda18a7',
+  address: '0xE9A74AACd7df8112911ca93260fC5a046f8a64Ae',
+  options: {},
+  methods: [],
+  scopes: ['eip155:0'],
+  type: 'eip155:eoa',
+};
+
 describe('KeyringInternalSnapClient', () => {
   const snapId = 'local:localhost:3000' as SnapId;
 
-  const accountsList: KeyringAccount[] = [
-    {
-      id: '13f94041-6ae6-451f-a0fe-afdd2fda18a7',
-      address: '0xE9A74AACd7df8112911ca93260fC5a046f8a64Ae',
-      options: {},
-      methods: [],
-      scopes: ['eip155:0'],
-      type: 'eip155:eoa',
-    },
-  ];
+  const accountsList: KeyringAccount[] = [MOCK_ACCOUNT];
 
   const messenger = {
     call: jest.fn(),
@@ -81,4 +86,44 @@ describe('KeyringInternalSnapClient', () => {
       );
     });
   });
+
+  describe('submitRequestV1', () => {
+    const keyringRequest: KeyringRequestV1 = {
+      id: 'mock-request-id',
+      scope: EthScope.Mainnet,
+      account: MOCK_ACCOUNT.id,
+      request: {
+        method: EthMethod.PersonalSign,
+        params: {},
+      },
+    };
+    const request = {
+      snapId,
+      origin: 'metamask',
+      handler: 'onKeyringRequest',
+      request: {
+        id: expect.any(String),
+        jsonrpc: '2.0',
+        method: 'keyring_submitRequest',
+        params: keyringRequest,
+      },
+    };
+
+    it('calls the submitRequestV1 method', async () => {
+      const client = new KeyringInternalSnapClient({
+        messenger: messenger as unknown as KeyringInternalSnapClientMessenger,
+        snapId,
+      });
+
+      messenger.call.mockResolvedValue({
+        pending: false,
+        result: null,
+      });
+      await client.submitRequestV1(keyringRequest);
+      expect(messenger.call).toHaveBeenCalledWith(
+        'SnapController:handleRequest',
+        request,
+      );
+    });
+  });
 });

packages/keyring-internal-snap-client/src/KeyringInternalSnapClient.ts

@@ -1,6 +1,12 @@
 import type { RestrictedMessenger } from '@metamask/base-controller';
+import { KeyringRpcMethod } from '@metamask/keyring-api';
+import type {
+  KeyringRequestV1,
+  KeyringResponseV1,
+} from '@metamask/keyring-internal-api';
+import { SubmitRequestResponseV1Struct } from '@metamask/keyring-internal-api';
 import { KeyringClient, type Sender } from '@metamask/keyring-snap-client';
-import type { JsonRpcRequest } from '@metamask/keyring-utils';
+import { strictMask, type JsonRpcRequest } from '@metamask/keyring-utils';
 import type { HandleSnapRequest } from '@metamask/snaps-controllers';
 import type { SnapId } from '@metamask/snaps-sdk';
 import type { HandlerType } from '@metamask/snaps-utils';
@@ -121,4 +127,20 @@ export class KeyringInternalSnapClient extends KeyringClient {
       snapId,
     });
   }
+
+  /**
+   * Submit a keyring request v1 (with no `origin`).
+   *
+   * @param request - Keyring request.
+   * @returns Keyring request's response.
+   */
+  async submitRequestV1(request: KeyringRequestV1): Promise<KeyringResponseV1> {
+    return strictMask(
+      await this.send({
+        method: KeyringRpcMethod.SubmitRequest,
+        params: request,
+      }),
+      SubmitRequestResponseV1Struct,
+    );
+  }
 }

packages/keyring-internal-snap-client/tsconfig.build.json

@@ -12,6 +12,9 @@
     {
       "path": "../keyring-api/tsconfig.build.json"
     },
+    {
+      "path": "../keyring-internal-api/tsconfig.build.json"
+    },
     {
       "path": "../keyring-snap-client/tsconfig.build.json"
     }

packages/keyring-snap-bridge/package.json

@@ -53,9 +53,9 @@
     "@lavamoat/allow-scripts": "^3.2.1",
     "@lavamoat/preinstall-always-fail": "^2.1.0",
     "@metamask/auto-changelog": "^3.4.4",
-    "@metamask/snaps-controllers": "^9.18.0",
-    "@metamask/snaps-sdk": "^6.16.0",
-    "@metamask/snaps-utils": "^8.9.1",
+    "@metamask/snaps-controllers": "^12.2.0",
+    "@metamask/snaps-sdk": "^7.0.0",
+    "@metamask/snaps-utils": "^9.3.0",
     "@ts-bridge/cli": "^0.6.3",
     "@types/jest": "^29.5.12",
     "@types/node": "^20.12.12",