web3-errors - npm Package Compare versions

Comparing version 1.0.2 to 1.0.3-dev.51bc03d.0

lib/commonjs/error_codes.js

@@ -117,2 +117,3 @@ "use strict";
 exports.GENESIS_BLOCK_NUMBER = '0x0';
+// RPC error codes (EIP-1193)
 // https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1193.md#provider-errors
@@ -148,3 +149,4 @@ exports.JSONRPC_ERR_REJECTED_REQUEST = 4001;
 exports.ERR_CORE_CHAIN_MISMATCH = 1102;
-// rpc error codes EIP-1474
+// RPC error codes (EIP-1474)
+// https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1474.md
 exports.ERR_RPC_INVALID_JSON = -32700;
@@ -151,0 +153,0 @@ exports.ERR_RPC_INVALID_REQUEST = -32600;

lib/commonjs/errors/rpc_errors.d.ts

@@ -19,2 +19,7 @@ import { JsonRpcResponseWithError, JsonRpcId, JsonRpcError } from 'web3-types';
 }
+export declare class EIP1193ProviderRpcError extends BaseWeb3Error {
+    code: number;
+    data?: unknown;
+    constructor(code: number, data?: unknown);
+}
 export declare class ParseError extends RpcError {
@@ -21,0 +26,0 @@ code: number;

lib/commonjs/errors/rpc_errors.js

@@ -19,8 +19,9 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.rpcErrorsMap = exports.LimitExceededError = exports.TransactionRejectedError = exports.VersionNotSupportedError = exports.ResourcesNotFoundError = exports.ResourceUnavailableError = exports.MethodNotSupported = exports.InvalidInputError = exports.InternalError = exports.InvalidParamsError = exports.MethodNotFoundError = exports.InvalidRequestError = exports.ParseError = exports.RpcError = void 0;
+exports.rpcErrorsMap = exports.LimitExceededError = exports.TransactionRejectedError = exports.VersionNotSupportedError = exports.ResourcesNotFoundError = exports.ResourceUnavailableError = exports.MethodNotSupported = exports.InvalidInputError = exports.InternalError = exports.InvalidParamsError = exports.MethodNotFoundError = exports.InvalidRequestError = exports.ParseError = exports.EIP1193ProviderRpcError = exports.RpcError = void 0;
 const web3_error_base_js_1 = require("../web3_error_base.js");
 const error_codes_js_1 = require("../error_codes.js");
+const rpc_error_messages_js_1 = require("./rpc_error_messages.js");
 class RpcError extends web3_error_base_js_1.BaseWeb3Error {
     constructor(rpcError, message) {
-        super(message !== null && message !== void 0 ? message : `An Rpc error has occured with a code of ${rpcError.error.code}`);
+        super(message !== null && message !== void 0 ? message : rpc_error_messages_js_1.genericRpcErrorMessageTemplate.replace('*code*', rpcError.error.code.toString()));
         this.code = rpcError.error.code;
@@ -36,5 +37,27 @@ this.id = rpcError.id;
 exports.RpcError = RpcError;
+class EIP1193ProviderRpcError extends web3_error_base_js_1.BaseWeb3Error {
+    constructor(code, data) {
+        var _a, _b, _c, _d;
+        if (!code) {
+            // this case should ideally not happen
+            super();
+        }
+        else if ((_a = rpc_error_messages_js_1.RpcErrorMessages[code]) === null || _a === void 0 ? void 0 : _a.message) {
+            super(rpc_error_messages_js_1.RpcErrorMessages[code].message);
+        }
+        else {
+            // Retrieve the status code object for the given code from the table, by searching through the appropriate range
+            const statusCodeRange = Object.keys(rpc_error_messages_js_1.RpcErrorMessages).find(statusCode => typeof statusCode === 'string' &&
+                code >= parseInt(statusCode.split('-')[0], 10) &&
+                code <= parseInt(statusCode.split('-')[1], 10));
+            super((_c = (_b = rpc_error_messages_js_1.RpcErrorMessages[statusCodeRange !== null && statusCodeRange !== void 0 ? statusCodeRange : '']) === null || _b === void 0 ? void 0 : _b.message) !== null && _c !== void 0 ? _c : rpc_error_messages_js_1.genericRpcErrorMessageTemplate.replace('*code*', (_d = code === null || code === void 0 ? void 0 : code.toString()) !== null && _d !== void 0 ? _d : '""'));
+        }
+        this.code = code;
+        this.data = data;
+    }
+}
+exports.EIP1193ProviderRpcError = EIP1193ProviderRpcError;
 class ParseError extends RpcError {
     constructor(rpcError) {
-        super(rpcError, 'Parse error');
+        super(rpcError, rpc_error_messages_js_1.RpcErrorMessages[error_codes_js_1.ERR_RPC_INVALID_JSON].message);
         this.code = error_codes_js_1.ERR_RPC_INVALID_JSON;
@@ -46,3 +69,3 @@ }
     constructor(rpcError) {
-        super(rpcError, 'Invalid request');
+        super(rpcError, rpc_error_messages_js_1.RpcErrorMessages[error_codes_js_1.ERR_RPC_INVALID_REQUEST].message);
         this.code = error_codes_js_1.ERR_RPC_INVALID_REQUEST;
@@ -54,3 +77,3 @@ }
     constructor(rpcError) {
-        super(rpcError, 'Method not found');
+        super(rpcError, rpc_error_messages_js_1.RpcErrorMessages[error_codes_js_1.ERR_RPC_INVALID_METHOD].message);
         this.code = error_codes_js_1.ERR_RPC_INVALID_METHOD;
@@ -62,3 +85,3 @@ }
     constructor(rpcError) {
-        super(rpcError, 'Invalid request');
+        super(rpcError, rpc_error_messages_js_1.RpcErrorMessages[error_codes_js_1.ERR_RPC_INVALID_PARAMS].message);
         this.code = error_codes_js_1.ERR_RPC_INVALID_PARAMS;
@@ -70,3 +93,3 @@ }
     constructor(rpcError) {
-        super(rpcError, 'Internal error');
+        super(rpcError, rpc_error_messages_js_1.RpcErrorMessages[error_codes_js_1.ERR_RPC_INTERNAL_ERROR].message);
         this.code = error_codes_js_1.ERR_RPC_INTERNAL_ERROR;
@@ -78,3 +101,3 @@ }
     constructor(rpcError) {
-        super(rpcError, 'Invalid input');
+        super(rpcError, rpc_error_messages_js_1.RpcErrorMessages[error_codes_js_1.ERR_RPC_INVALID_INPUT].message);
         this.code = error_codes_js_1.ERR_RPC_INVALID_INPUT;
@@ -86,3 +109,3 @@ }
     constructor(rpcError) {
-        super(rpcError, 'Method not supported');
+        super(rpcError, rpc_error_messages_js_1.RpcErrorMessages[error_codes_js_1.ERR_RPC_UNSUPPORTED_METHOD].message);
         this.code = error_codes_js_1.ERR_RPC_UNSUPPORTED_METHOD;
@@ -94,3 +117,3 @@ }
     constructor(rpcError) {
-        super(rpcError, 'Resource unavailable');
+        super(rpcError, rpc_error_messages_js_1.RpcErrorMessages[error_codes_js_1.ERR_RPC_UNAVAILABLE_RESOURCE].message);
         this.code = error_codes_js_1.ERR_RPC_UNAVAILABLE_RESOURCE;
@@ -102,3 +125,3 @@ }
     constructor(rpcError) {
-        super(rpcError, 'Resource not found');
+        super(rpcError, rpc_error_messages_js_1.RpcErrorMessages[error_codes_js_1.ERR_RPC_MISSING_RESOURCE].message);
         this.code = error_codes_js_1.ERR_RPC_MISSING_RESOURCE;
@@ -110,3 +133,3 @@ }
     constructor(rpcError) {
-        super(rpcError, 'JSON-RPC version not supported');
+        super(rpcError, rpc_error_messages_js_1.RpcErrorMessages[error_codes_js_1.ERR_RPC_NOT_SUPPORTED].message);
         this.code = error_codes_js_1.ERR_RPC_NOT_SUPPORTED;
@@ -118,3 +141,3 @@ }
     constructor(rpcError) {
-        super(rpcError, 'Transaction rejected');
+        super(rpcError, rpc_error_messages_js_1.RpcErrorMessages[error_codes_js_1.ERR_RPC_TRANSACTION_REJECTED].message);
         this.code = error_codes_js_1.ERR_RPC_TRANSACTION_REJECTED;
@@ -126,3 +149,3 @@ }
     constructor(rpcError) {
-        super(rpcError, 'Limit exceeded');
+        super(rpcError, rpc_error_messages_js_1.RpcErrorMessages[error_codes_js_1.ERR_RPC_LIMIT_EXCEEDED].message);
         this.code = error_codes_js_1.ERR_RPC_LIMIT_EXCEEDED;
@@ -129,0 +152,0 @@ }

lib/commonjs/index.d.ts

@@ -15,1 +15,2 @@ export * from './error_codes.js';
 export * from './errors/rpc_errors.js';
+export * from './errors/rpc_error_messages.js';

lib/commonjs/index.js

@@ -47,2 +47,3 @@ "use strict";
 __exportStar(require("./errors/rpc_errors.js"), exports);
+__exportStar(require("./errors/rpc_error_messages.js"), exports);
 //# sourceMappingURL=index.js.map

lib/esm/error_codes.js

@@ -112,2 +112,3 @@ /*
 export const GENESIS_BLOCK_NUMBER = '0x0';
+// RPC error codes (EIP-1193)
 // https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1193.md#provider-errors
@@ -143,3 +144,4 @@ export const JSONRPC_ERR_REJECTED_REQUEST = 4001;
 export const ERR_CORE_CHAIN_MISMATCH = 1102;
-// rpc error codes EIP-1474
+// RPC error codes (EIP-1474)
+// https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1474.md
 export const ERR_RPC_INVALID_JSON = -32700;
@@ -146,0 +148,0 @@ export const ERR_RPC_INVALID_REQUEST = -32600;

lib/esm/errors/rpc_errors.js

@@ -19,5 +19,6 @@ /*
 import { ERR_RPC_INTERNAL_ERROR, ERR_RPC_INVALID_INPUT, ERR_RPC_INVALID_JSON, ERR_RPC_INVALID_METHOD, ERR_RPC_INVALID_PARAMS, ERR_RPC_INVALID_REQUEST, ERR_RPC_LIMIT_EXCEEDED, ERR_RPC_MISSING_RESOURCE, ERR_RPC_NOT_SUPPORTED, ERR_RPC_TRANSACTION_REJECTED, ERR_RPC_UNAVAILABLE_RESOURCE, ERR_RPC_UNSUPPORTED_METHOD, } from '../error_codes.js';
+import { RpcErrorMessages, genericRpcErrorMessageTemplate } from './rpc_error_messages.js';
 export class RpcError extends BaseWeb3Error {
     constructor(rpcError, message) {
-        super(message !== null && message !== void 0 ? message : `An Rpc error has occured with a code of ${rpcError.error.code}`);
+        super(message !== null && message !== void 0 ? message : genericRpcErrorMessageTemplate.replace('*code*', rpcError.error.code.toString()));
         this.code = rpcError.error.code;
@@ -32,5 +33,26 @@ this.id = rpcError.id;
 }
+export class EIP1193ProviderRpcError extends BaseWeb3Error {
+    constructor(code, data) {
+        var _a, _b, _c, _d;
+        if (!code) {
+            // this case should ideally not happen
+            super();
+        }
+        else if ((_a = RpcErrorMessages[code]) === null || _a === void 0 ? void 0 : _a.message) {
+            super(RpcErrorMessages[code].message);
+        }
+        else {
+            // Retrieve the status code object for the given code from the table, by searching through the appropriate range
+            const statusCodeRange = Object.keys(RpcErrorMessages).find(statusCode => typeof statusCode === 'string' &&
+                code >= parseInt(statusCode.split('-')[0], 10) &&
+                code <= parseInt(statusCode.split('-')[1], 10));
+            super((_c = (_b = RpcErrorMessages[statusCodeRange !== null && statusCodeRange !== void 0 ? statusCodeRange : '']) === null || _b === void 0 ? void 0 : _b.message) !== null && _c !== void 0 ? _c : genericRpcErrorMessageTemplate.replace('*code*', (_d = code === null || code === void 0 ? void 0 : code.toString()) !== null && _d !== void 0 ? _d : '""'));
+        }
+        this.code = code;
+        this.data = data;
+    }
+}
 export class ParseError extends RpcError {
     constructor(rpcError) {
-        super(rpcError, 'Parse error');
+        super(rpcError, RpcErrorMessages[ERR_RPC_INVALID_JSON].message);
         this.code = ERR_RPC_INVALID_JSON;
@@ -41,3 +63,3 @@ }
     constructor(rpcError) {
-        super(rpcError, 'Invalid request');
+        super(rpcError, RpcErrorMessages[ERR_RPC_INVALID_REQUEST].message);
         this.code = ERR_RPC_INVALID_REQUEST;
@@ -48,3 +70,3 @@ }
     constructor(rpcError) {
-        super(rpcError, 'Method not found');
+        super(rpcError, RpcErrorMessages[ERR_RPC_INVALID_METHOD].message);
         this.code = ERR_RPC_INVALID_METHOD;
@@ -55,3 +77,3 @@ }
     constructor(rpcError) {
-        super(rpcError, 'Invalid request');
+        super(rpcError, RpcErrorMessages[ERR_RPC_INVALID_PARAMS].message);
         this.code = ERR_RPC_INVALID_PARAMS;
@@ -62,3 +84,3 @@ }
     constructor(rpcError) {
-        super(rpcError, 'Internal error');
+        super(rpcError, RpcErrorMessages[ERR_RPC_INTERNAL_ERROR].message);
         this.code = ERR_RPC_INTERNAL_ERROR;
@@ -69,3 +91,3 @@ }
     constructor(rpcError) {
-        super(rpcError, 'Invalid input');
+        super(rpcError, RpcErrorMessages[ERR_RPC_INVALID_INPUT].message);
         this.code = ERR_RPC_INVALID_INPUT;
@@ -76,3 +98,3 @@ }
     constructor(rpcError) {
-        super(rpcError, 'Method not supported');
+        super(rpcError, RpcErrorMessages[ERR_RPC_UNSUPPORTED_METHOD].message);
         this.code = ERR_RPC_UNSUPPORTED_METHOD;
@@ -83,3 +105,3 @@ }
     constructor(rpcError) {
-        super(rpcError, 'Resource unavailable');
+        super(rpcError, RpcErrorMessages[ERR_RPC_UNAVAILABLE_RESOURCE].message);
         this.code = ERR_RPC_UNAVAILABLE_RESOURCE;
@@ -90,3 +112,3 @@ }
     constructor(rpcError) {
-        super(rpcError, 'Resource not found');
+        super(rpcError, RpcErrorMessages[ERR_RPC_MISSING_RESOURCE].message);
         this.code = ERR_RPC_MISSING_RESOURCE;
@@ -97,3 +119,3 @@ }
     constructor(rpcError) {
-        super(rpcError, 'JSON-RPC version not supported');
+        super(rpcError, RpcErrorMessages[ERR_RPC_NOT_SUPPORTED].message);
         this.code = ERR_RPC_NOT_SUPPORTED;
@@ -104,3 +126,3 @@ }
     constructor(rpcError) {
-        super(rpcError, 'Transaction rejected');
+        super(rpcError, RpcErrorMessages[ERR_RPC_TRANSACTION_REJECTED].message);
         this.code = ERR_RPC_TRANSACTION_REJECTED;
@@ -111,3 +133,3 @@ }
     constructor(rpcError) {
-        super(rpcError, 'Limit exceeded');
+        super(rpcError, RpcErrorMessages[ERR_RPC_LIMIT_EXCEEDED].message);
         this.code = ERR_RPC_LIMIT_EXCEEDED;
@@ -114,0 +136,0 @@ }

lib/esm/index.js

@@ -31,2 +31,3 @@ /*
 export * from './errors/rpc_errors.js';
+export * from './errors/rpc_error_messages.js';
 //# sourceMappingURL=index.js.map

lib/types/errors/rpc_errors.d.ts

@@ -19,2 +19,7 @@ import { JsonRpcResponseWithError, JsonRpcId, JsonRpcError } from 'web3-types';
 }
+export declare class EIP1193ProviderRpcError extends BaseWeb3Error {
+    code: number;
+    data?: unknown;
+    constructor(code: number, data?: unknown);
+}
 export declare class ParseError extends RpcError {
@@ -21,0 +26,0 @@ code: number;

lib/types/index.d.ts

@@ -15,2 +15,3 @@ export * from './error_codes.js';
 export * from './errors/rpc_errors.js';
+export * from './errors/rpc_error_messages.js';
 //# sourceMappingURL=index.d.ts.map

package.json

 {
 	"name": "web3-errors",
-	"version": "1.0.2",
+	"version": "1.0.3-dev.51bc03d.0+51bc03d",
 	"description": "This package has web3 error classes",
@@ -44,3 +44,3 @@ "main": "./lib/commonjs/index.js",
 	"dependencies": {
-		"web3-types": "^1.0.2"
+		"web3-types": "1.0.3-dev.51bc03d.0+51bc03d"
 	},
@@ -61,3 +61,3 @@ "devDependencies": {
 	},
-	"gitHead": "bce9a8b87a24ac3ced0c3e79da04aa30b9fe0086"
+	"gitHead": "51bc03dd15dbb9619e77b81c474ab251f9afcfec"
 }

src/error_codes.ts

@@ -127,2 +127,3 @@ /*
 
+// RPC error codes (EIP-1193)
 // https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1193.md#provider-errors
@@ -163,3 +164,4 @@ export const JSONRPC_ERR_REJECTED_REQUEST = 4001;
 
-// rpc error codes EIP-1474
+// RPC error codes (EIP-1474)
+// https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1474.md
 export const ERR_RPC_INVALID_JSON = -32700;
@@ -166,0 +168,0 @@ export const ERR_RPC_INVALID_REQUEST = -32600;

src/errors/rpc_errors.ts

@@ -36,2 +36,3 @@ /*
 } from '../error_codes.js';
+import { RpcErrorMessages, genericRpcErrorMessageTemplate } from './rpc_error_messages.js';
 
@@ -44,3 +45,6 @@ export class RpcError extends BaseWeb3Error {
 	public constructor(rpcError: JsonRpcResponseWithError, message?: string) {
-		super(message ?? `An Rpc error has occured with a code of ${rpcError.error.code}`);
+		super(
+			message ??
+				genericRpcErrorMessageTemplate.replace('*code*', rpcError.error.code.toString()),
+		);
 		this.code = rpcError.error.code;
@@ -57,6 +61,34 @@ this.id = rpcError.id;
 
+export class EIP1193ProviderRpcError extends BaseWeb3Error {
+	public code: number;
+	public data?: unknown;
+
+	public constructor(code: number, data?: unknown) {
+		if (!code) {
+			// this case should ideally not happen
+			super();
+		} else if (RpcErrorMessages[code]?.message) {
+			super(RpcErrorMessages[code].message);
+		} else {
+			// Retrieve the status code object for the given code from the table, by searching through the appropriate range
+			const statusCodeRange = Object.keys(RpcErrorMessages).find(
+				statusCode =>
+					typeof statusCode === 'string' &&
+					code >= parseInt(statusCode.split('-')[0], 10) &&
+					code <= parseInt(statusCode.split('-')[1], 10),
+			);
+			super(
+				RpcErrorMessages[statusCodeRange ?? '']?.message ??
+					genericRpcErrorMessageTemplate.replace('*code*', code?.toString() ?? '""'),
+			);
+		}
+		this.code = code;
+		this.data = data;
+	}
+}
+
 export class ParseError extends RpcError {
 	public code = ERR_RPC_INVALID_JSON;
 	public constructor(rpcError: JsonRpcResponseWithError) {
-		super(rpcError, 'Parse error');
+		super(rpcError, RpcErrorMessages[ERR_RPC_INVALID_JSON].message);
 	}
@@ -68,3 +100,3 @@ }
 	public constructor(rpcError: JsonRpcResponseWithError) {
-		super(rpcError, 'Invalid request');
+		super(rpcError, RpcErrorMessages[ERR_RPC_INVALID_REQUEST].message);
 	}
@@ -76,3 +108,3 @@ }
 	public constructor(rpcError: JsonRpcResponseWithError) {
-		super(rpcError, 'Method not found');
+		super(rpcError, RpcErrorMessages[ERR_RPC_INVALID_METHOD].message);
 	}
@@ -84,3 +116,3 @@ }
 	public constructor(rpcError: JsonRpcResponseWithError) {
-		super(rpcError, 'Invalid request');
+		super(rpcError, RpcErrorMessages[ERR_RPC_INVALID_PARAMS].message);
 	}
@@ -92,3 +124,3 @@ }
 	public constructor(rpcError: JsonRpcResponseWithError) {
-		super(rpcError, 'Internal error');
+		super(rpcError, RpcErrorMessages[ERR_RPC_INTERNAL_ERROR].message);
 	}
@@ -100,3 +132,3 @@ }
 	public constructor(rpcError: JsonRpcResponseWithError) {
-		super(rpcError, 'Invalid input');
+		super(rpcError, RpcErrorMessages[ERR_RPC_INVALID_INPUT].message);
 	}
@@ -108,3 +140,3 @@ }
 	public constructor(rpcError: JsonRpcResponseWithError) {
-		super(rpcError, 'Method not supported');
+		super(rpcError, RpcErrorMessages[ERR_RPC_UNSUPPORTED_METHOD].message);
 	}
@@ -116,3 +148,3 @@ }
 	public constructor(rpcError: JsonRpcResponseWithError) {
-		super(rpcError, 'Resource unavailable');
+		super(rpcError, RpcErrorMessages[ERR_RPC_UNAVAILABLE_RESOURCE].message);
 	}
@@ -124,3 +156,3 @@ }
 	public constructor(rpcError: JsonRpcResponseWithError) {
-		super(rpcError, 'Resource not found');
+		super(rpcError, RpcErrorMessages[ERR_RPC_MISSING_RESOURCE].message);
 	}
@@ -132,3 +164,3 @@ }
 	public constructor(rpcError: JsonRpcResponseWithError) {
-		super(rpcError, 'JSON-RPC version not supported');
+		super(rpcError, RpcErrorMessages[ERR_RPC_NOT_SUPPORTED].message);
 	}
@@ -140,3 +172,3 @@ }
 	public constructor(rpcError: JsonRpcResponseWithError) {
-		super(rpcError, 'Transaction rejected');
+		super(rpcError, RpcErrorMessages[ERR_RPC_TRANSACTION_REJECTED].message);
 	}
@@ -148,3 +180,3 @@ }
 	public constructor(rpcError: JsonRpcResponseWithError) {
-		super(rpcError, 'Limit exceeded');
+		super(rpcError, RpcErrorMessages[ERR_RPC_LIMIT_EXCEEDED].message);
 	}
@@ -151,0 +183,0 @@ }

src/index.ts

@@ -32,1 +32,2 @@ /*
 export * from './errors/rpc_errors.js';
+export * from './errors/rpc_error_messages.js';

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Manifest confusion

Supply chain risk

This package has inconsistent metadata. This could be malicious or caused by an error when publishing the package.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

392228

increased by11.48%

Number of package files

133

increased by6.4%

Lines of code

6974

increased by11.05%

Worsened metrics

Number of low quality alerts

2

increased by100%

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• - Removedweb3-types@1.8.0(transitive)

• Updatedweb3-types@1.0.3-dev.51bc03d.0+51bc03d