chore: clean-up Multichain API errors

packages/chain-agnostic-permission/CHANGELOG.md

@@ -7,8 +7,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Add `unknownErrorOrNoScopesAuthorized` and `invalidSessionPropertiesError` to `Caip25Errors` ([#6109](https://github.com/MetaMask/core/pull/6109))
+
 ### Changed
 
+- Update `requestedChainsNotSupportedError` message from "Requested chains are not supported" to "Requested networks are not supported" ([#6109](https://github.com/MetaMask/core/pull/6109))
+
 - Bump `@metamask/controller-utils` from `^11.10.0` to `^11.11.0` ([#6069](https://github.com/MetaMask/core/pull/6069))
 - Bump `@metamask/utils` from `^11.2.0` to `^11.4.2` ([#6054](https://github.com/MetaMask/core/pull/6054))
 

packages/chain-agnostic-permission/src/scope/errors.test.ts

@@ -1,9 +1,16 @@
 import { Caip25Errors } from './errors';
 
 describe('Caip25Errors', () => {
+  it('unknownErrorOrNoScopesAuthorized', () => {
+    expect(Caip25Errors.unknownErrorOrNoScopesAuthorized().message).toBe(
+      'Unknown error with request',
+    );
+    expect(Caip25Errors.unknownErrorOrNoScopesAuthorized().code).toBe(5000);
+  });
+
   it('requestedChainsNotSupportedError', () => {
     expect(Caip25Errors.requestedChainsNotSupportedError().message).toBe(
-      'Requested chains are not supported',
+      'Requested networks are not supported',
     );
     expect(Caip25Errors.requestedChainsNotSupportedError().code).toBe(5100);
   });
@@ -37,4 +44,11 @@ describe('Caip25Errors', () => {
     );
     expect(Caip25Errors.unknownNotificationsRequestedError().code).toBe(5202);
   });
+
+  it('invalidSessionPropertiesError', () => {
+    expect(Caip25Errors.invalidSessionPropertiesError().message).toBe(
+      'Invalid sessionProperties requested',
+    );
+    expect(Caip25Errors.invalidSessionPropertiesError().code).toBe(5302);
+  });
 });

packages/chain-agnostic-permission/src/scope/errors.ts

@@ -4,14 +4,22 @@ import { JsonRpcError } from '@metamask/rpc-errors';
  * CAIP25 Errors.
  */
 export const Caip25Errors = {
+  /**
+   * Thrown when an unknown error occurs or no scopes were authorized in a CAIP-25 request.
+   *
+   * @returns A new JsonRpcError instance.
+   */
+  unknownErrorOrNoScopesAuthorized: () =>
+    new JsonRpcError(5000, 'Unknown error with request'),
+
   /**
    * Thrown when chains requested in a CAIP-25 `wallet_createSession` call are not supported by the wallet.
    * Defined in [CAIP-25 error codes section](https://github.com/ChainAgnostic/CAIPs/blob/main/CAIPs/caip-25.md#trusted-failure-codes).
    *
    * @returns A new JsonRpcError instance.
    */
   requestedChainsNotSupportedError: () =>
-    new JsonRpcError(5100, 'Requested chains are not supported'),
+    new JsonRpcError(5100, 'Requested networks are not supported'),
 
   /**
    * Thrown when methods requested in a CAIP-25 `wallet_createSession` call are not supported by the wallet.
@@ -50,4 +58,13 @@ export const Caip25Errors = {
    */
   unknownNotificationsRequestedError: () =>
     new JsonRpcError(5202, 'Unknown notification(s) requested'),
+
+  /**
+   * Thrown when sessionProperties requested in a CAIP-25 `wallet_createSession` call are not supported by the wallet.
+   * Defined in [CAIP-25 error codes section](https://github.com/ChainAgnostic/CAIPs/blob/main/CAIPs/caip-25.md#trust-agnostic-malformed-request-failure-codes)
+   *
+   * @returns A new JsonRpcError instance.
+   */
+  invalidSessionPropertiesError: () =>
+    new JsonRpcError(5302, 'Invalid sessionProperties requested'),
 };

packages/multichain-api-middleware/CHANGELOG.md

@@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
+- Update `wallet_createSession` and `wallet_revokeSession` handlers to use `Caip25Errors` instead of creating `JsonRpcError` directly ([#6109](https://github.com/MetaMask/core/pull/6109))
 - Bump `@metamask/controller-utils` from `^11.10.0` to `^11.11.0` ([#6069](https://github.com/MetaMask/core/pull/6069))
 - Bump `@metamask/utils` from `^11.2.0` to `^11.4.2` ([#6054](https://github.com/MetaMask/core/pull/6054))
 

packages/multichain-api-middleware/src/handlers/wallet-createSession.test.ts

@@ -4,11 +4,12 @@ import {
   type Caip25Authorization,
   type NormalizedScopesObject,
   KnownSessionProperties,
+  Caip25Errors,
 } from '@metamask/chain-agnostic-permission';
 import * as ChainAgnosticPermission from '@metamask/chain-agnostic-permission';
 import { MultichainNetwork } from '@metamask/multichain-transactions-controller';
 import { invalidParams } from '@metamask/permission-controller';
-import { JsonRpcError, rpcErrors } from '@metamask/rpc-errors';
+
 import type {
   Hex,
   Json,
@@ -18,14 +19,6 @@ import type {
 
 import { walletCreateSession } from './wallet-createSession';
 
-jest.mock('@metamask/rpc-errors', () => ({
-  ...jest.requireActual('@metamask/rpc-errors'),
-  rpcErrors: {
-    invalidParams: jest.fn(),
-    internal: jest.fn(),
-  },
-}));
-
 jest.mock('@metamask/chain-agnostic-permission', () => ({
   ...jest.requireActual('@metamask/chain-agnostic-permission'),
   validateAndNormalizeScopes: jest.fn(),
@@ -179,7 +172,7 @@ describe('wallet_createSession', () => {
       },
     });
     expect(end).toHaveBeenCalledWith(
-      new JsonRpcError(5302, 'Invalid sessionProperties requested'),
+      Caip25Errors.invalidSessionPropertiesError(),
     );
   });
 
@@ -567,7 +560,7 @@ describe('wallet_createSession', () => {
       });
     await handler(baseRequest);
     expect(end).toHaveBeenCalledWith(
-      new JsonRpcError(5100, 'Requested scopes are not supported'),
+      Caip25Errors.requestedChainsNotSupportedError(),
     );
   });
 
@@ -888,7 +881,7 @@ describe('wallet_createSession', () => {
     });
   });
 
-  it('calls internal RPC error if approved CAIP-25 permission has no CAIP-25 caveat value', async () => {
+  it('throws error if approved CAIP-25 permission has no CAIP-25 caveat value', async () => {
     const { handler, requestPermissionsForOrigin } = createMockedHandler();
     requestPermissionsForOrigin.mockReturnValue([
       {
@@ -903,14 +896,14 @@ describe('wallet_createSession', () => {
       },
     ]);
 
-    await handler({
-      ...baseRequest,
-      params: {
-        ...baseRequest.params,
-      },
-    });
-
-    expect(rpcErrors.internal).toHaveBeenCalled();
+    await expect(
+      handler({
+        ...baseRequest,
+        params: {
+          ...baseRequest.params,
+        },
+      }),
+    ).rejects.toThrow(Caip25Errors.unknownErrorOrNoScopesAuthorized());
   });
 
   describe('address case sensitivity', () => {
@@ -1290,7 +1283,7 @@ describe('wallet_createSession', () => {
       await handler(requestWithNoValidScopes);
 
       expect(end).toHaveBeenCalledWith(
-        new JsonRpcError(5100, 'Requested scopes are not supported'),
+        Caip25Errors.requestedChainsNotSupportedError(),
       );
     });
   });

packages/multichain-api-middleware/src/handlers/wallet-createSession.ts

@@ -14,6 +14,7 @@ import {
   getAllScopesFromScopesObjects,
   setNonSCACaipAccountIdsInCaip25CaveatValue,
   isNamespaceInScopesObject,
+  Caip25Errors,
 } from '@metamask/chain-agnostic-permission';
 import { isEqualCaseInsensitive } from '@metamask/controller-utils';
 import type {
@@ -25,7 +26,6 @@ import {
   invalidParams,
   type RequestedPermissions,
 } from '@metamask/permission-controller';
-import { JsonRpcError, rpcErrors } from '@metamask/rpc-errors';
 import {
   type CaipAccountId,
   type CaipChainId,
@@ -96,7 +96,7 @@ async function walletCreateSessionHandler(
   const { requiredScopes, optionalScopes, sessionProperties } = req.params;
 
   if (sessionProperties && Object.keys(sessionProperties).length === 0) {
-    return end(new JsonRpcError(5302, 'Invalid sessionProperties requested'));
+    return end(Caip25Errors.invalidSessionPropertiesError());
   }
 
   const filteredSessionProperties = Object.fromEntries(
@@ -228,9 +228,7 @@ async function walletCreateSessionHandler(
         };
       } else {
         // if solana is not requested and there are no supported scopes, we return an error
-        return end(
-          new JsonRpcError(5100, 'Requested scopes are not supported'),
-        );
+        return end(Caip25Errors.requestedChainsNotSupportedError());
       }
     }
 
@@ -256,7 +254,7 @@ async function walletCreateSessionHandler(
       (caveat) => caveat.type === Caip25CaveatType,
     )?.value as Caip25CaveatValue;
     if (!approvedCaip25CaveatValue) {
-      throw rpcErrors.internal();
+      throw Caip25Errors.unknownErrorOrNoScopesAuthorized();
     }
 
     const sessionScopes = getSessionScopes(approvedCaip25CaveatValue, {

packages/multichain-api-middleware/src/handlers/wallet-revokeSession.test.ts

@@ -1,9 +1,11 @@
-import { Caip25EndowmentPermissionName } from '@metamask/chain-agnostic-permission';
+import {
+  Caip25EndowmentPermissionName,
+  Caip25Errors,
+} from '@metamask/chain-agnostic-permission';
 import {
   PermissionDoesNotExistError,
   UnrecognizedSubjectError,
 } from '@metamask/permission-controller';
-import { rpcErrors } from '@metamask/rpc-errors';
 import type { JsonRpcRequest } from '@metamask/utils';
 
 import { walletRevokeSession } from './wallet-revokeSession';
@@ -81,7 +83,9 @@ describe('wallet_revokeSession', () => {
     });
 
     await handler(baseRequest);
-    expect(end).toHaveBeenCalledWith(rpcErrors.internal());
+    expect(end).toHaveBeenCalledWith(
+      Caip25Errors.unknownErrorOrNoScopesAuthorized(),
+    );
   });
 
   it('returns true if the permission was revoked', async () => {

packages/multichain-api-middleware/src/handlers/wallet-revokeSession.ts

@@ -1,4 +1,7 @@
-import { Caip25EndowmentPermissionName } from '@metamask/chain-agnostic-permission';
+import {
+  Caip25EndowmentPermissionName,
+  Caip25Errors,
+} from '@metamask/chain-agnostic-permission';
 import type {
   JsonRpcEngineNextCallback,
   JsonRpcEngineEndCallback,
@@ -7,7 +10,6 @@ import {
   PermissionDoesNotExistError,
   UnrecognizedSubjectError,
 } from '@metamask/permission-controller';
-import { rpcErrors } from '@metamask/rpc-errors';
 import type { JsonRpcSuccess, JsonRpcRequest } from '@metamask/utils';
 
 /**
@@ -42,7 +44,7 @@ async function walletRevokeSessionHandler(
       !(err instanceof PermissionDoesNotExistError)
     ) {
       console.error(err);
-      return end(rpcErrors.internal());
+      return end(Caip25Errors.unknownErrorOrNoScopesAuthorized());
     }
   }