Optional ALL THE DataWithOptionalCause

Author: legobeat

src/classes.ts

@@ -5,10 +5,7 @@ import type {
 import { isPlainObject } from '@metamask/utils';
 import safeStringify from 'fast-safe-stringify';
 
-import type {
-  DataWithOptionalCause,
-  OptionalDataWithOptionalCause,
-} from './utils';
+import type { OptionalDataWithOptionalCause } from './utils';
 import { serializeCause } from './utils';
 
 export type { SerializedJsonRpcError };
@@ -87,7 +84,7 @@ export class JsonRpcError<
  * Permits integer error codes in the [ 1000 <= 4999 ] range.
  */
 export class EthereumProviderError<
-  Data extends DataWithOptionalCause,
+  Data extends OptionalDataWithOptionalCause,
 > extends JsonRpcError<Data> {
   /**
    * Create an Ethereum Provider JSON-RPC error.

src/errors.ts

@@ -1,21 +1,18 @@
 import { JsonRpcError, EthereumProviderError } from './classes';
 import { errorCodes } from './error-constants';
-import type {
-  DataWithOptionalCause,
-  OptionalDataWithOptionalCause,
-} from './utils';
+import type { OptionalDataWithOptionalCause } from './utils';
 import { getMessageFromCode } from './utils';
 
 type EthereumErrorOptions<Data extends OptionalDataWithOptionalCause> = {
   message?: string;
   data?: Data;
 };
 
-type ServerErrorOptions<Data extends DataWithOptionalCause> = {
+type ServerErrorOptions<Data extends OptionalDataWithOptionalCause> = {
   code: number;
 } & EthereumErrorOptions<Data>;
 
-type CustomErrorArg<Data extends DataWithOptionalCause> =
+type CustomErrorArg<Data extends OptionalDataWithOptionalCause> =
   ServerErrorOptions<Data>;
 
 type JsonRpcErrorsArg<Data extends OptionalDataWithOptionalCause> =
@@ -29,16 +26,17 @@ export const rpcErrors = {
    * @param arg - The error message or options bag.
    * @returns An instance of the {@link JsonRpcError} class.
    */
-  parse: <Data extends DataWithOptionalCause>(arg?: JsonRpcErrorsArg<Data>) =>
-    getJsonRpcError(errorCodes.rpc.parse, arg),
+  parse: <Data extends OptionalDataWithOptionalCause>(
+    arg?: JsonRpcErrorsArg<Data>,
+  ) => getJsonRpcError(errorCodes.rpc.parse, arg),
 
   /**
    * Get a JSON RPC 2.0 Invalid Request (-32600) error.
    *
    * @param arg - The error message or options bag.
    * @returns An instance of the {@link JsonRpcError} class.
    */
-  invalidRequest: <Data extends DataWithOptionalCause>(
+  invalidRequest: <Data extends OptionalDataWithOptionalCause>(
     arg?: JsonRpcErrorsArg<Data>,
   ) => getJsonRpcError(errorCodes.rpc.invalidRequest, arg),
 
@@ -48,7 +46,7 @@ export const rpcErrors = {
    * @param arg - The error message or options bag.
    * @returns An instance of the {@link JsonRpcError} class.
    */
-  invalidParams: <Data extends DataWithOptionalCause>(
+  invalidParams: <Data extends OptionalDataWithOptionalCause>(
     arg?: JsonRpcErrorsArg<Data>,
   ) => getJsonRpcError(errorCodes.rpc.invalidParams, arg),
 
@@ -58,7 +56,7 @@ export const rpcErrors = {
    * @param arg - The error message or options bag.
    * @returns An instance of the {@link JsonRpcError} class.
    */
-  methodNotFound: <Data extends DataWithOptionalCause>(
+  methodNotFound: <Data extends OptionalDataWithOptionalCause>(
     arg?: JsonRpcErrorsArg<Data>,
   ) => getJsonRpcError(errorCodes.rpc.methodNotFound, arg),
 
@@ -80,7 +78,7 @@ export const rpcErrors = {
    * @param opts - The error options bag.
    * @returns An instance of the {@link JsonRpcError} class.
    */
-  server: <Data extends DataWithOptionalCause>(
+  server: <Data extends OptionalDataWithOptionalCause>(
     opts: ServerErrorOptions<Data>,
   ) => {
     if (!opts || typeof opts !== 'object' || Array.isArray(opts)) {
@@ -103,7 +101,7 @@ export const rpcErrors = {
    * @param arg - The error message or options bag.
    * @returns An instance of the {@link JsonRpcError} class.
    */
-  invalidInput: <Data extends DataWithOptionalCause>(
+  invalidInput: <Data extends OptionalDataWithOptionalCause>(
     arg?: JsonRpcErrorsArg<Data>,
   ) => getJsonRpcError(errorCodes.rpc.invalidInput, arg),
 
@@ -113,7 +111,7 @@ export const rpcErrors = {
    * @param arg - The error message or options bag.
    * @returns An instance of the {@link JsonRpcError} class.
    */
-  resourceNotFound: <Data extends DataWithOptionalCause>(
+  resourceNotFound: <Data extends OptionalDataWithOptionalCause>(
     arg?: JsonRpcErrorsArg<Data>,
   ) => getJsonRpcError(errorCodes.rpc.resourceNotFound, arg),
 
@@ -123,7 +121,7 @@ export const rpcErrors = {
    * @param arg - The error message or options bag.
    * @returns An instance of the {@link JsonRpcError} class.
    */
-  resourceUnavailable: <Data extends DataWithOptionalCause>(
+  resourceUnavailable: <Data extends OptionalDataWithOptionalCause>(
     arg?: JsonRpcErrorsArg<Data>,
   ) => getJsonRpcError(errorCodes.rpc.resourceUnavailable, arg),
 
@@ -133,7 +131,7 @@ export const rpcErrors = {
    * @param arg - The error message or options bag.
    * @returns An instance of the {@link JsonRpcError} class.
    */
-  transactionRejected: <Data extends DataWithOptionalCause>(
+  transactionRejected: <Data extends OptionalDataWithOptionalCause>(
     arg?: JsonRpcErrorsArg<Data>,
   ) => getJsonRpcError(errorCodes.rpc.transactionRejected, arg),
 
@@ -143,7 +141,7 @@ export const rpcErrors = {
    * @param arg - The error message or options bag.
    * @returns An instance of the {@link JsonRpcError} class.
    */
-  methodNotSupported: <Data extends DataWithOptionalCause>(
+  methodNotSupported: <Data extends OptionalDataWithOptionalCause>(
     arg?: JsonRpcErrorsArg<Data>,
   ) => getJsonRpcError(errorCodes.rpc.methodNotSupported, arg),
 
@@ -153,7 +151,7 @@ export const rpcErrors = {
    * @param arg - The error message or options bag.
    * @returns An instance of the {@link JsonRpcError} class.
    */
-  limitExceeded: <Data extends DataWithOptionalCause>(
+  limitExceeded: <Data extends OptionalDataWithOptionalCause>(
     arg?: JsonRpcErrorsArg<Data>,
   ) => getJsonRpcError(errorCodes.rpc.limitExceeded, arg),
 };
@@ -165,7 +163,7 @@ export const providerErrors = {
    * @param arg - The error message or options bag.
    * @returns An instance of the {@link EthereumProviderError} class.
    */
-  userRejectedRequest: <Data extends DataWithOptionalCause>(
+  userRejectedRequest: <Data extends OptionalDataWithOptionalCause>(
     arg?: JsonRpcErrorsArg<Data>,
   ) => {
     return getEthProviderError(errorCodes.provider.userRejectedRequest, arg);
@@ -177,7 +175,7 @@ export const providerErrors = {
    * @param arg - The error message or options bag.
    * @returns An instance of the {@link EthereumProviderError} class.
    */
-  unauthorized: <Data extends DataWithOptionalCause>(
+  unauthorized: <Data extends OptionalDataWithOptionalCause>(
     arg?: JsonRpcErrorsArg<Data>,
   ) => {
     return getEthProviderError(errorCodes.provider.unauthorized, arg);
@@ -189,7 +187,7 @@ export const providerErrors = {
    * @param arg - The error message or options bag.
    * @returns An instance of the {@link EthereumProviderError} class.
    */
-  unsupportedMethod: <Data extends DataWithOptionalCause>(
+  unsupportedMethod: <Data extends OptionalDataWithOptionalCause>(
     arg?: JsonRpcErrorsArg<Data>,
   ) => {
     return getEthProviderError(errorCodes.provider.unsupportedMethod, arg);
@@ -201,7 +199,7 @@ export const providerErrors = {
    * @param arg - The error message or options bag.
    * @returns An instance of the {@link EthereumProviderError} class.
    */
-  disconnected: <Data extends DataWithOptionalCause>(
+  disconnected: <Data extends OptionalDataWithOptionalCause>(
     arg?: JsonRpcErrorsArg<Data>,
   ) => {
     return getEthProviderError(errorCodes.provider.disconnected, arg);
@@ -213,7 +211,7 @@ export const providerErrors = {
    * @param arg - The error message or options bag.
    * @returns An instance of the {@link EthereumProviderError} class.
    */
-  chainDisconnected: <Data extends DataWithOptionalCause>(
+  chainDisconnected: <Data extends OptionalDataWithOptionalCause>(
     arg?: JsonRpcErrorsArg<Data>,
   ) => {
     return getEthProviderError(errorCodes.provider.chainDisconnected, arg);
@@ -225,7 +223,9 @@ export const providerErrors = {
    * @param opts - The error options bag.
    * @returns An instance of the {@link EthereumProviderError} class.
    */
-  custom: <Data extends DataWithOptionalCause>(opts: CustomErrorArg<Data>) => {
+  custom: <Data extends OptionalDataWithOptionalCause>(
+    opts: CustomErrorArg<Data>,
+  ) => {
     if (!opts || typeof opts !== 'object' || Array.isArray(opts)) {
       throw new Error(
         'Ethereum Provider custom errors must provide single object argument.',
@@ -263,7 +263,7 @@ function getJsonRpcError<Data extends OptionalDataWithOptionalCause>(
  * @param arg - The error message or options bag.
  * @returns An instance of the {@link EthereumProviderError} class.
  */
-function getEthProviderError<Data extends DataWithOptionalCause>(
+function getEthProviderError<Data extends OptionalDataWithOptionalCause>(
   code: number,
   arg?: JsonRpcErrorsArg<Data>,
 ): EthereumProviderError<Data> {