chore(Error): add error wrapper for wallet rpc error code (#374)

* chore: add error wrapper

* fix: update estimate fee error test

* chore: packages/starknet-snap/src/index.ts

Co-authored-by: khanti42 <[email protected]>

* chore: update var name

---------

Co-authored-by: khanti42 <[email protected]>

packages/starknet-snap/src/index.ts

@@ -4,12 +4,7 @@ import type {
   OnInstallHandler,
   OnUpdateHandler,
 } from '@metamask/snaps-sdk';
-import {
-  panel,
-  text,
-  SnapError,
-  MethodNotFoundError,
-} from '@metamask/snaps-sdk';
+import { panel, text, MethodNotFoundError } from '@metamask/snaps-sdk';
 
 import { addErc20Token } from './addErc20Token';
 import { addNetwork } from './addNetwork';
@@ -67,6 +62,7 @@ import {
   STARKNET_SEPOLIA_TESTNET_NETWORK,
   STARKNET_TESTNET_NETWORK,
 } from './utils/constants';
+import { UnknownError } from './utils/exceptions';
 import { getAddressKeyDeriver } from './utils/keyPair';
 import { acquireLock } from './utils/lock';
 import { logger } from './utils/logger';
@@ -287,7 +283,8 @@ export const onRpcRequest: OnRpcRequestHandler = async ({ request }) => {
     let snapError = error;
 
     if (!isSnapRpcError(error)) {
-      snapError = new SnapError('Unable to execute the rpc request');
+      // To ensure the error meets both the SnapError format and WalletRpc format.
+      snapError = new UnknownError('Unable to execute the rpc request');
     }
     logger.error(
       `onRpcRequest error: ${JSON.stringify(snapError.toJSON(), null, 2)}`,

packages/starknet-snap/src/rpcs/displayPrivateKey.test.ts

@@ -1,11 +1,11 @@
-import {
-  InvalidParamsError,
-  UserRejectedRequestError,
-} from '@metamask/snaps-sdk';
 import { constants } from 'starknet';
 
 import type { SnapState } from '../types/snapState';
 import { STARKNET_SEPOLIA_TESTNET_NETWORK } from '../utils/constants';
+import {
+  UserRejectedOpError,
+  InvalidRequestParamsError,
+} from '../utils/exceptions';
 import {
   mockAccount,
   prepareAlertDialog,
@@ -77,7 +77,7 @@ describe('displayPrivateKey', () => {
     ]);
   });
 
-  it('throws `UserRejectedRequestError` if user denies the operation', async () => {
+  it('throws `UserRejectedOpError` if user denies the operation', async () => {
     const chainId = constants.StarknetChainId.SN_SEPOLIA;
     const account = await mockAccount(chainId);
     prepareMockAccount(account, state);
@@ -89,7 +89,7 @@ describe('displayPrivateKey', () => {
     const request = createRequestParam(chainId, account.address);
 
     await expect(displayPrivateKey.execute(request)).rejects.toThrow(
-      UserRejectedRequestError,
+      UserRejectedOpError,
     );
   });
 
@@ -108,11 +108,11 @@ describe('displayPrivateKey', () => {
       },
     },
   ])(
-    'throws `InvalidParamsError` when $case',
+    'throws `InvalidRequestParamsError` when $case',
     async ({ request }: { request: unknown }) => {
       await expect(
         displayPrivateKey.execute(request as DisplayPrivateKeyParams),
-      ).rejects.toThrow(InvalidParamsError);
+      ).rejects.toThrow(InvalidRequestParamsError);
     },
   );
 });

packages/starknet-snap/src/rpcs/displayPrivateKey.ts

@@ -1,4 +1,4 @@
-import { copyable, text, UserRejectedRequestError } from '@metamask/snaps-sdk';
+import { copyable, text } from '@metamask/snaps-sdk';
 import { type Infer, object, literal, assign } from 'superstruct';
 
 import {
@@ -8,6 +8,7 @@ import {
   alertDialog,
   BaseRequestStruct,
 } from '../utils';
+import { UserRejectedOpError } from '../utils/exceptions';
 
 export const DisplayPrivateKeyRequestStruct = assign(
   object({
@@ -58,7 +59,7 @@ export class DisplayPrivateKeyRpc extends AccountRpcController<
     const confirmComponents = [text('Do you want to export your private key?')];
 
     if (!(await confirmDialog(confirmComponents))) {
-      throw new UserRejectedRequestError() as unknown as Error;
+      throw new UserRejectedOpError() as unknown as Error;
     }
 
     const alertComponents = [

packages/starknet-snap/src/rpcs/estimateFee.test.ts

@@ -1,11 +1,11 @@
-import { InvalidParamsError } from '@metamask/snaps-sdk';
 import type { Invocations } from 'starknet';
 import { constants, TransactionType } from 'starknet';
 import type { Infer } from 'superstruct';
 
 import { getEstimateFees } from '../__tests__/helper';
 import { FeeTokenUnit } from '../types/snapApi';
 import { STARKNET_SEPOLIA_TESTNET_NETWORK } from '../utils/constants';
+import { InvalidRequestParamsError } from '../utils/exceptions';
 import * as starknetUtils from '../utils/starknetUtils';
 import type { TxVersionStruct } from '../utils/superstruct';
 import { mockAccount, prepareMockAccount } from './__tests__/helper';
@@ -101,9 +101,9 @@ describe('estimateFee', () => {
     });
   });
 
-  it('throws `InvalidParamsError` when request parameter is not correct', async () => {
+  it('throws `InvalidRequestParamsError` when request parameter is not correct', async () => {
     await expect(
       estimateFee.execute({} as unknown as EstimateFeeParams),
-    ).rejects.toThrow(InvalidParamsError);
+    ).rejects.toThrow(InvalidRequestParamsError);
   });
 });

packages/starknet-snap/src/rpcs/executeTxn.test.ts

@@ -1,14 +1,14 @@
-import {
-  InvalidParamsError,
-  UserRejectedRequestError,
-} from '@metamask/snaps-sdk';
 import type { UniversalDetails, Call, InvokeFunctionResponse } from 'starknet';
 import { constants } from 'starknet';
 
 import callsExamples from '../__tests__/fixture/callsExamples.json'; // Assuming you have a similar fixture
 import { getEstimateFees } from '../__tests__/helper';
 import type { FeeTokenUnit } from '../types/snapApi';
 import { STARKNET_SEPOLIA_TESTNET_NETWORK } from '../utils/constants';
+import {
+  UserRejectedOpError,
+  InvalidRequestParamsError,
+} from '../utils/exceptions';
 import * as starknetUtils from '../utils/starknetUtils';
 import { executeTxn as executeTxnUtil } from '../utils/starknetUtils';
 import {
@@ -179,7 +179,7 @@ describe('ExecuteTxn', () => {
     },
   );
 
-  it('throws UserRejectedRequestError if user cancels execution', async () => {
+  it('throws UserRejectedOpError if user cancels execution', async () => {
     callsExample = callsExamples[1];
     const { request, confirmDialogSpy } = await prepareMockExecuteTxn(
       callsExample.hash,
@@ -190,7 +190,7 @@ describe('ExecuteTxn', () => {
     confirmDialogSpy.mockResolvedValue(false);
 
     await expect(executeTxn.execute(request)).rejects.toThrow(
-      UserRejectedRequestError,
+      UserRejectedOpError,
     );
   });
 
@@ -209,9 +209,9 @@ describe('ExecuteTxn', () => {
     await expect(executeTxn.execute(request)).rejects.toThrow(Error);
   });
 
-  it('throws `InvalidParamsError` when request parameter is not correct', async () => {
+  it('throws `InvalidRequestParamsError` when request parameter is not correct', async () => {
     await expect(
       executeTxn.execute({} as unknown as ExecuteTxnParams),
-    ).rejects.toThrow(InvalidParamsError);
+    ).rejects.toThrow(InvalidRequestParamsError);
   });
 });

packages/starknet-snap/src/rpcs/executeTxn.ts

@@ -1,11 +1,5 @@
 import type { Component, Json } from '@metamask/snaps-sdk';
-import {
-  heading,
-  row,
-  UserRejectedRequestError,
-  text,
-  divider,
-} from '@metamask/snaps-sdk';
+import { heading, row, text, divider } from '@metamask/snaps-sdk';
 import convert from 'ethereum-unit-converter';
 import type { Call, Calldata } from 'starknet';
 import { constants, TransactionStatus, TransactionType } from 'starknet';
@@ -27,6 +21,7 @@ import {
   CallsStruct,
   mapDeprecatedParams,
 } from '../utils';
+import { UserRejectedOpError } from '../utils/exceptions';
 import { logger } from '../utils/logger';
 import {
   createAccount,
@@ -140,7 +135,7 @@ export class ExecuteTxnRpc extends AccountRpcController<
         version,
       ))
     ) {
-      throw new UserRejectedRequestError() as unknown as Error;
+      throw new UserRejectedOpError() as unknown as Error;
     }
 
     if (!accountDeployed) {

packages/starknet-snap/src/rpcs/sign-declare-transaction.test.ts

@@ -1,13 +1,13 @@
-import {
-  InvalidParamsError,
-  UserRejectedRequestError,
-} from '@metamask/snaps-sdk';
 import type { DeclareSignerDetails } from 'starknet';
 import { constants } from 'starknet';
 
 import type { SnapState } from '../types/snapState';
 import { toJson } from '../utils';
 import { STARKNET_SEPOLIA_TESTNET_NETWORK } from '../utils/constants';
+import {
+  UserRejectedOpError,
+  InvalidRequestParamsError,
+} from '../utils/exceptions';
 import * as starknetUtils from '../utils/starknetUtils';
 import {
   mockAccount,
@@ -108,7 +108,7 @@ describe('signDeclareTransaction', () => {
     ]);
   });
 
-  it('throws `UserRejectedRequestError` if user denied the operation', async () => {
+  it('throws `UserRejectedOpError` if user denied the operation', async () => {
     const chainId = constants.StarknetChainId.SN_SEPOLIA;
     const account = await mockAccount(chainId);
 
@@ -120,15 +120,15 @@ describe('signDeclareTransaction', () => {
     const request = createRequest(chainId, account.address);
 
     await expect(signDeclareTransaction.execute(request)).rejects.toThrow(
-      UserRejectedRequestError,
+      UserRejectedOpError,
     );
   });
 
-  it('throws `InvalidParamsError` when request parameter is not correct', async () => {
+  it('throws `InvalidRequestParamsError` when request parameter is not correct', async () => {
     await expect(
       signDeclareTransaction.execute(
         {} as unknown as SignDeclareTransactionParams,
       ),
-    ).rejects.toThrow(InvalidParamsError);
+    ).rejects.toThrow(InvalidRequestParamsError);
   });
 });

packages/starknet-snap/src/rpcs/sign-declare-transaction.ts

@@ -1,10 +1,5 @@
 import type { Component } from '@metamask/snaps-sdk';
-import {
-  heading,
-  row,
-  text,
-  UserRejectedRequestError,
-} from '@metamask/snaps-sdk';
+import { heading, row, text } from '@metamask/snaps-sdk';
 import type { DeclareSignerDetails } from 'starknet';
 import type { Infer } from 'superstruct';
 import { array, object, string, assign } from 'superstruct';
@@ -18,6 +13,7 @@ import {
   DeclareSignDetailsStruct,
   mapDeprecatedParams,
 } from '../utils';
+import { UserRejectedOpError } from '../utils/exceptions';
 import { signDeclareTransaction as signDeclareTransactionUtil } from '../utils/starknetUtils';
 
 export const SignDeclareTransactionRequestStruct = assign(
@@ -87,7 +83,7 @@ export class SignDeclareTransactionRpc extends AccountRpcController<
   ): Promise<SignDeclareTransactionResponse> {
     const { details } = params;
     if (!(await this.getSignDeclareTransactionConsensus(details))) {
-      throw new UserRejectedRequestError() as unknown as Error;
+      throw new UserRejectedOpError() as unknown as Error;
     }
 
     return (await signDeclareTransactionUtil(

packages/starknet-snap/src/rpcs/signMessage.test.ts

@@ -1,13 +1,13 @@
-import {
-  InvalidParamsError,
-  UserRejectedRequestError,
-} from '@metamask/snaps-sdk';
 import { constants } from 'starknet';
 
 import typedDataExample from '../__tests__/fixture/typedDataExample.json';
 import type { SnapState } from '../types/snapState';
 import { toJson } from '../utils';
 import { STARKNET_SEPOLIA_TESTNET_NETWORK } from '../utils/constants';
+import {
+  UserRejectedOpError,
+  InvalidRequestParamsError,
+} from '../utils/exceptions';
 import * as starknetUtils from '../utils/starknetUtils';
 import {
   mockAccount,
@@ -89,7 +89,7 @@ describe('signMessage', () => {
     ]);
   });
 
-  it('throws `UserRejectedRequestError` if user denied the operation', async () => {
+  it('throws `UserRejectedOpError` if user denied the operation', async () => {
     const account = await mockAccount(constants.StarknetChainId.SN_SEPOLIA);
 
     prepareMockAccount(account, state);
@@ -105,13 +105,13 @@ describe('signMessage', () => {
     };
 
     await expect(signMessage.execute(request)).rejects.toThrow(
-      UserRejectedRequestError,
+      UserRejectedOpError,
     );
   });
 
-  it('throws `InvalidParamsError` when request parameter is not correct', async () => {
+  it('throws `InvalidRequestParamsError` when request parameter is not correct', async () => {
     await expect(
       signMessage.execute({} as unknown as SignMessageParams),
-    ).rejects.toThrow(InvalidParamsError);
+    ).rejects.toThrow(InvalidRequestParamsError);
   });
 });

packages/starknet-snap/src/rpcs/signMessage.ts

@@ -1,10 +1,5 @@
 import type { Component } from '@metamask/snaps-sdk';
-import {
-  heading,
-  row,
-  text,
-  UserRejectedRequestError,
-} from '@metamask/snaps-sdk';
+import { heading, row, text } from '@metamask/snaps-sdk';
 import type { Infer } from 'superstruct';
 import { array, object, string, assign } from 'superstruct';
 
@@ -18,6 +13,7 @@ import {
   AccountRpcController,
   mapDeprecatedParams,
 } from '../utils';
+import { UserRejectedOpError } from '../utils/exceptions';
 import { signMessage as signMessageUtil } from '../utils/starknetUtils';
 
 export const SignMessageRequestStruct = assign(
@@ -84,7 +80,7 @@ export class SignMessageRpc extends AccountRpcController<
       enableAuthorize &&
       !(await this.getSignMessageConsensus(typedDataMessage, address))
     ) {
-      throw new UserRejectedRequestError() as unknown as Error;
+      throw new UserRejectedOpError() as unknown as Error;
     }
 
     return await signMessageUtil(

packages/starknet-snap/src/rpcs/signTransaction.test.ts

@@ -1,14 +1,14 @@
-import {
-  InvalidParamsError,
-  UserRejectedRequestError,
-} from '@metamask/snaps-sdk';
 import type { InvocationsSignerDetails } from 'starknet';
 import { constants } from 'starknet';
 
 import transactionExample from '../__tests__/fixture/transactionExample.json'; // Assuming you have a similar fixture
 import type { SnapState } from '../types/snapState';
 import { toJson } from '../utils';
 import { STARKNET_SEPOLIA_TESTNET_NETWORK } from '../utils/constants';
+import {
+  UserRejectedOpError,
+  InvalidRequestParamsError,
+} from '../utils/exceptions';
 import * as starknetUtils from '../utils/starknetUtils';
 import {
   mockAccount,
@@ -118,7 +118,7 @@ describe('signTransaction', () => {
     expect(confirmDialogSpy).not.toHaveBeenCalled();
   });
 
-  it('throws `UserRejectedRequestError` if user denied the operation', async () => {
+  it('throws `UserRejectedOpError` if user denied the operation', async () => {
     const chainId = constants.StarknetChainId.SN_SEPOLIA;
     const account = await mockAccount(chainId);
     prepareMockAccount(account, state);
@@ -127,13 +127,13 @@ describe('signTransaction', () => {
     const request = createRequestParam(chainId, account.address, true);
 
     await expect(signTransaction.execute(request)).rejects.toThrow(
-      UserRejectedRequestError,
+      UserRejectedOpError,
     );
   });
 
-  it('throws `InvalidParamsError` when request parameter is not correct', async () => {
+  it('throws `InvalidRequestParamsError` when request parameter is not correct', async () => {
     await expect(
       signTransaction.execute({} as unknown as SignTransactionParams),
-    ).rejects.toThrow(InvalidParamsError);
+    ).rejects.toThrow(InvalidRequestParamsError);
   });
 });