fix: better submitRequest validation

packages/keyring-api/src/eth/rpc/params.ts

@@ -126,6 +126,13 @@ export type EthEip7702Authorization = Infer<
   typeof EthEip7702AuthorizationStruct
 >;
 
+/**
+ * A struct for getEncryptionPublicKey options.
+ */
+export const EthGetEncryptionPublicKeyOptionsStruct = optional(
+  record(string(), unknown()),
+);
+
 // ============================================================================
 // RPC Method Parameter Structs
 // ============================================================================
@@ -214,3 +221,11 @@ export const EthSignEip7702AuthorizationParamsStruct = tuple([
 export type EthSignEip7702AuthorizationParams = Infer<
   typeof EthSignEip7702AuthorizationParamsStruct
 >;
+
+/**
+ * Parameters for `eth_getEncryptionPublicKey`.
+ */
+export const EthGetEncryptionPublicKeyParamsStruct = tuple([
+  EthAddressStruct, // address
+  EthGetEncryptionPublicKeyOptionsStruct, // options
+]);

packages/keyring-api/src/eth/types.ts

@@ -1,7 +1,7 @@
 import { object } from '@metamask/keyring-utils';
 import type { Infer } from '@metamask/superstruct';
 import { nonempty, array, enums, literal } from '@metamask/superstruct';
-import { definePattern } from '@metamask/utils';
+import { definePattern, type Hex } from '@metamask/utils';
 
 import { EthScope } from '.';
 import {
@@ -12,7 +12,7 @@ import {
 
 export const EthBytesStruct = definePattern('EthBytes', /^0x[0-9a-f]*$/iu);
 
-export const EthAddressStruct = definePattern(
+export const EthAddressStruct = definePattern<Hex>(
   'EthAddress',
   /^0x[0-9a-f]{40}$/iu,
 );

packages/keyring-api/src/eth/v2/eth-keyring-wrapper.test.ts

@@ -419,10 +419,16 @@ describe('EthKeyringWrapper', () => {
         );
 
         const result = await wrapper.submitRequest(
-          createMockRequest(EthKeyringMethod.GetEncryptionPublicKey, []),
+          createMockRequest(EthKeyringMethod.GetEncryptionPublicKey, [
+            MOCK_ADDRESS,
+            {}, // options
+          ]),
         );
 
-        expect(mockGetEncryptionPublicKey).toHaveBeenCalledWith(MOCK_ADDRESS);
+        expect(mockGetEncryptionPublicKey).toHaveBeenCalledWith(
+          MOCK_ADDRESS,
+          {},
+        );
         expect(result).toBe('pubkey');
       });
 
@@ -435,28 +441,6 @@ describe('EthKeyringWrapper', () => {
           ),
         ).rejects.toThrow('Keyring does not support getEncryptionPublicKey');
       });
-
-      it('handles request with undefined params', async () => {
-        const mockGetEncryptionPublicKey = jest
-          .fn()
-          .mockResolvedValue('pubkey');
-        const wrapper = new TestEthKeyringWrapper(
-          createMockKeyring({
-            getEncryptionPublicKey: mockGetEncryptionPublicKey,
-          }),
-        );
-
-        const request: KeyringRequest = {
-          id: '00000000-0000-0000-0000-000000000000',
-          scope: EthScope.Eoa,
-          account: MOCK_ACCOUNT_ID,
-          origin: 'https://example.com',
-          request: { method: EthKeyringMethod.GetEncryptionPublicKey },
-        };
-
-        const result = await wrapper.submitRequest(request);
-        expect(result).toBe('pubkey');
-      });
     });
 
     describe('eth_getAppKeyAddress', () => {

packages/keyring-api/src/eth/v2/eth-keyring-wrapper.ts

@@ -14,6 +14,7 @@ import {
 import {
   EthDecryptParamsStruct,
   EthGetAppKeyAddressParamsStruct,
+  EthGetEncryptionPublicKeyParamsStruct,
   EthPersonalSignParamsStruct,
   EthSignEip7702AuthorizationParamsStruct,
   EthSignParamsStruct,
@@ -79,7 +80,7 @@ export abstract class EthKeyringWrapper<
    * @returns The result of the signing operation.
    */
   async submitRequest(request: KeyringRequest): Promise<Json> {
-    const { method, params = [] } = request.request;
+    const { method, params } = request.request;
 
     const { address, methods } = await this.getAccount(request.account);
     const hexAddress = this.toHexAddress(address);
@@ -182,7 +183,9 @@ export abstract class EthKeyringWrapper<
         if (!this.inner.getEncryptionPublicKey) {
           throw new Error('Keyring does not support getEncryptionPublicKey');
         }
-        return this.inner.getEncryptionPublicKey(hexAddress);
+        assert(params, EthGetEncryptionPublicKeyParamsStruct);
+        const [, options] = params;
+        return this.inner.getEncryptionPublicKey(hexAddress, options);
       }
 
       case `${EthKeyringMethod.GetAppKeyAddress}`: {
@@ -200,10 +203,7 @@ export abstract class EthKeyringWrapper<
         }
         assert(params, EthSignEip7702AuthorizationParamsStruct);
         const [authorization] = params;
-        return this.inner.signEip7702Authorization(
-          hexAddress,
-          authorization as [number, Hex, number],
-        );
+        return this.inner.signEip7702Authorization(hexAddress, authorization);
       }
 
       default:

packages/keyring-eth-hd/src/hd-keyring-v2.test.ts

@@ -906,7 +906,7 @@ describe('HdKeyringV2', () => {
         const request = createMockRequest(
           accountId,
           'eth_getEncryptionPublicKey',
-          [],
+          ['0x0000000000000000000000000000000000000000'],
         );
 
         const result = await wrapper.submitRequest(request);
@@ -920,7 +920,7 @@ describe('HdKeyringV2', () => {
         const pubKeyRequest = createMockRequest(
           accountId,
           'eth_getEncryptionPublicKey',
-          [],
+          ['0x0000000000000000000000000000000000000000', {}],
         );
 
         const pubKey = await wrapper.submitRequest(pubKeyRequest);