refactor: rename LegacyKeyringRequest to KeyringRequestWithoutOrigin

Author: ccharly

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

@@ -1 +1 @@
-export * from './legacy';
+export * from './keyring-request';

…nal-api/src/compatibility/legacy.test.ts …rc/compatibility/keyring-request.test.tspackages/keyring-internal-api/src/compatibility/legacy.test.ts renamed to packages/keyring-internal-api/src/compatibility/keyring-request.test.ts packages/keyring-internal-api/src/compatibility/legacy.test.ts renamed to packages/keyring-internal-api/src/compatibility/keyring-request.test.ts

@@ -1,9 +1,9 @@
 import { EthMethod, EthScope } from '@metamask/keyring-api';
 
-import { toLegacyKeyringRequest } from './legacy';
+import { toKeyringRequestWithoutOrigin } from './keyring-request';
 
 describe('v1', () => {
-  describe('toLegacyKeyringRequest', () => {
+  describe('toKeyringRequestWithoutOrigin', () => {
     const request = {
       id: 'mock-request-id',
       scope: EthScope.Mainnet,
@@ -17,7 +17,7 @@ describe('v1', () => {
     const { origin, ...requestV1 } = request;
 
     it('converts a keyring request to a keyring request v1', () => {
-      expect(toLegacyKeyringRequest(request)).toStrictEqual(requestV1);
+      expect(toKeyringRequestWithoutOrigin(request)).toStrictEqual(requestV1);
     });
   });
 });

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

@@ -0,0 +1,42 @@
+import type { KeyringRequest } from '@metamask/keyring-api';
+import {
+  KeyringRequestStruct,
+  KeyringResponseStruct,
+} from '@metamask/keyring-api';
+import { omit, type Infer } from '@metamask/superstruct';
+
+/**
+ * Keyring request without `origin` support.
+ */
+export const KeyringRequestWithoutOriginStruct = omit(KeyringRequestStruct, [
+  'origin',
+]);
+
+export type KeyringRequestWithoutOrigin = Infer<
+  typeof KeyringRequestWithoutOriginStruct
+>;
+
+/**
+ * Response to a call to `submitRequest` (v1).
+ */
+export const KeyringResponseWithoutOriginStruct = KeyringResponseStruct;
+
+export type KeyringResponseWithoutOrigin = Infer<
+  typeof KeyringResponseWithoutOriginStruct
+>;
+
+export const SubmitRequestResponseV1Struct = KeyringResponseWithoutOriginStruct;
+
+/**
+ * Converts a keyring request to a keyring request v1.
+ *
+ * @param request - A keyring request.
+ * @returns A keyring request v1.
+ */
+export function toKeyringRequestWithoutOrigin(
+  request: KeyringRequest,
+): KeyringRequestWithoutOrigin {
+  const { origin, ...requestV1 } = request;
+
+  return requestV1;
+}

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

@@ -3,7 +3,7 @@ import {
   EthScope,
   type KeyringAccount,
 } from '@metamask/keyring-api';
-import type { LegacyKeyringRequest } from '@metamask/keyring-internal-api';
+import type { KeyringRequestWithoutOrigin } from '@metamask/keyring-internal-api';
 import type { SnapId } from '@metamask/snaps-sdk';
 
 import {
@@ -87,8 +87,8 @@ describe('KeyringInternalSnapClient', () => {
     });
   });
 
-  describe('submitLegacyRequest', () => {
-    const keyringRequest: LegacyKeyringRequest = {
+  describe('submitRequestWithoutOrigin', () => {
+    const keyringRequest: KeyringRequestWithoutOrigin = {
       id: 'mock-request-id',
       scope: EthScope.Mainnet,
       account: MOCK_ACCOUNT.id,
@@ -109,7 +109,7 @@ describe('KeyringInternalSnapClient', () => {
       },
     };
 
-    it('calls the submitLegacyRequest method', async () => {
+    it('calls the submitRequestWithoutOrigin method', async () => {
       const client = new KeyringInternalSnapClient({
         messenger: messenger as unknown as KeyringInternalSnapClientMessenger,
         snapId,
@@ -119,7 +119,7 @@ describe('KeyringInternalSnapClient', () => {
         pending: false,
         result: null,
       });
-      await client.submitLegacyRequest(keyringRequest);
+      await client.submitRequestWithoutOrigin(keyringRequest);
       expect(messenger.call).toHaveBeenCalledWith(
         'SnapController:handleRequest',
         request,

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

@@ -1,7 +1,7 @@
 import { KeyringRpcMethod } from '@metamask/keyring-api';
 import type {
-  LegacyKeyringRequest,
-  LegacyKeyringResponse,
+  KeyringRequestWithoutOrigin,
+  KeyringResponseWithoutOrigin,
 } from '@metamask/keyring-internal-api';
 import { SubmitRequestResponseV1Struct } from '@metamask/keyring-internal-api';
 import { KeyringClient, type Sender } from '@metamask/keyring-snap-client';
@@ -131,9 +131,9 @@ export class KeyringInternalSnapClient extends KeyringClient {
    * @param request - Keyring request.
    * @returns Keyring request's response.
    */
-  async submitLegacyRequest(
-    request: LegacyKeyringRequest,
-  ): Promise<LegacyKeyringResponse> {
+  async submitRequestWithoutOrigin(
+    request: KeyringRequestWithoutOrigin,
+  ): Promise<KeyringResponseWithoutOrigin> {
     return strictMask(
       await this.send({
         method: KeyringRpcMethod.SubmitRequest,

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

@@ -28,7 +28,7 @@ import {
   AnyAccountType,
 } from '@metamask/keyring-api';
 import type { InternalAccount } from '@metamask/keyring-internal-api';
-import { toLegacyKeyringRequest } from '@metamask/keyring-internal-api';
+import { toKeyringRequestWithoutOrigin } from '@metamask/keyring-internal-api';
 import { KeyringInternalSnapClient } from '@metamask/keyring-internal-snap-client';
 import {
   type GetSelectedAccountsResponse,
@@ -1091,8 +1091,8 @@ export class SnapKeyring {
         response = await client.submitRequest(request);
       } else {
         // Legacy keyring request did not support the `origin` field.
-        response = await client.submitLegacyRequest(
-          toLegacyKeyringRequest(request),
+        response = await client.submitRequestWithoutOrigin(
+          toKeyringRequestWithoutOrigin(request),
         );
       }