Merge branch '4.x' into feat/docs/external-provider

Dan Forbes · web-flow · commit 1f8cb476ac9a · 2024-08-21T06:18:13.000-07:00
diff --git a/packages/web3-errors/CHANGELOG.md b/packages/web3-errors/CHANGELOG.md
@@ -178,4 +178,8 @@ Documentation:
 
 - Fixed the undefined data in `Eip838ExecutionError` constructor (#6905)
 
-## [Unreleased]
+## [Unreleased]
+
+### Added
+
+- Added optional `statusCode` property of response in ResponseError.
diff --git a/packages/web3-errors/src/errors/response_errors.ts b/packages/web3-errors/src/errors/response_errors.ts
@@ -45,11 +45,13 @@ export class ResponseError<ErrorType = unknown, RequestType = unknown> extends B
 	public code = ERR_RESPONSE;
 	public data?: ErrorType | ErrorType[];
 	public request?: JsonRpcPayload<RequestType>;
+	public statusCode?: number;
 
 	public constructor(
 		response: JsonRpcResponse<unknown, ErrorType>,
 		message?: string,
 		request?: JsonRpcPayload<RequestType>,
+		statusCode?: number
 	) {
 		super(
 			message ??
@@ -66,6 +68,7 @@ export class ResponseError<ErrorType = unknown, RequestType = unknown> extends B
 				: response?.error?.data;
 		}
 
+		this.statusCode = statusCode;
 		this.request = request;
 		let errorOrErrors: JsonRpcError | JsonRpcError[] | undefined;
 		if (`error` in response) {
@@ -82,7 +85,7 @@ export class ResponseError<ErrorType = unknown, RequestType = unknown> extends B
 	}
 
 	public toJSON() {
-		return { ...super.toJSON(), data: this.data, request: this.request };
+		return { ...super.toJSON(), data: this.data, request: this.request, statusCode: this.statusCode };
 	}
 }
 
diff --git a/packages/web3-errors/test/unit/__snapshots__/errors.test.ts.snap b/packages/web3-errors/test/unit/__snapshots__/errors.test.ts.snap
@@ -239,6 +239,7 @@ exports[`errors InvalidResponseError should have valid json structure 1`] = `
   "message": "Returned error: error message",
   "name": "InvalidResponseError",
   "request": undefined,
+  "statusCode": undefined,
 }
 `;
 
@@ -316,6 +317,7 @@ exports[`errors ResponseError should have valid json structure with data 1`] = `
   "message": "Returned error: error message",
   "name": "ResponseError",
   "request": undefined,
+  "statusCode": undefined,
 }
 `;
 
@@ -336,6 +338,7 @@ exports[`errors ResponseError should have valid json structure without data 1`]
   "message": "Returned error: error message",
   "name": "ResponseError",
   "request": undefined,
+  "statusCode": undefined,
 }
 `;
 
@@ -357,6 +360,7 @@ exports[`errors ResponseError should include the array of inner errors 1`] = `
   "message": "Returned error: error message,error message",
   "name": "ResponseError",
   "request": undefined,
+  "statusCode": undefined,
 }
 `;
 
diff --git a/packages/web3-providers-http/CHANGELOG.md b/packages/web3-providers-http/CHANGELOG.md
@@ -129,4 +129,8 @@ Documentation:
 
 -   Fix issue lquixada/cross-fetch#78, enabling to run web3.js in service worker (#6463)
 
-## [Unreleased]
+## [Unreleased]
+
+### Added
+
+- Added `statusCode` of response in ResponseError, `statusCode` is optional property in ResponseError.
diff --git a/packages/web3-providers-http/src/index.ts b/packages/web3-providers-http/src/index.ts
@@ -80,7 +80,7 @@ export default class HttpProvider<
 		});
 		if (!response.ok) { 
 			// eslint-disable-next-line @typescript-eslint/no-unsafe-argument
-			throw new ResponseError(await response.json())
+			throw new ResponseError(await response.json(), undefined, undefined, response.status);
 		};
 
 		return (await response.json()) as JsonRpcResponseWithResult<ResultType>;
diff --git a/packages/web3-rpc-providers/CHANGELOG.md b/packages/web3-rpc-providers/CHANGELOG.md
@@ -43,12 +43,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [1.0.0.rc.1]
 
- ### Added
+### Added
 
  - When error is returned with code 429, throw rate limit error (#7102)
 
- ### Changed
+### Changed
 
  - Change request return type `Promise<ResultType>` to `Promise<JsonRpcResponseWithResult<ResultType>>` (#7102)
 
-## [Unreleased]
+## [Unreleased]
+
+### Added
+
+-   Updated rate limit error of QuickNode provider for HTTP transport
+-   Added optional `HttpProviderOptions | SocketOptions` in `Web3ExternalProvider` and `QuickNodeProvider` for provider configs
diff --git a/packages/web3-rpc-providers/package.json b/packages/web3-rpc-providers/package.json
@@ -49,6 +49,7 @@
 		"eslint-config-base-web3": "0.1.0",
 		"eslint-config-prettier": "^8.5.0",
 		"eslint-plugin-import": "^2.26.0",
+		"isomorphic-ws": "^5.0.0",
 		"jest": "^29.7.0",
 		"jest-extended": "^3.0.1",
 		"prettier": "^2.7.1",
diff --git a/packages/web3-rpc-providers/src/errors.ts b/packages/web3-rpc-providers/src/errors.ts
@@ -15,14 +15,25 @@ You should have received a copy of the GNU Lesser General Public License
 along with web3.js.  If not, see <http://www.gnu.org/licenses/>.
 */
 
+/* eslint-disable max-classes-per-file */
+
 import { BaseWeb3Error } from 'web3-errors';
-import {  } from 'web3-types';
 
 const ERR_QUICK_NODE_RATE_LIMIT = 1300;
 export class QuickNodeRateLimitError extends BaseWeb3Error {
 	public code = ERR_QUICK_NODE_RATE_LIMIT;
 
-	public constructor() {
-		super(`Too many requests, Quicknode has reached its rate limit.`);
+	public constructor(error?: Error) {
+		super(`You've reach the rate limit of free RPC calls from our Partner Quick Nodes. There are two options you can either create a paid Quick Nodes account and get 20% off for 2 months using WEB3JS referral code, or use Free public RPC endpoint.`, error);
+	}
+}
+
+const ERR_PROVIDER_CONFIG_OPTIONS = 1301;
+export class ProviderConfigOptionsError extends BaseWeb3Error {
+	public code = ERR_PROVIDER_CONFIG_OPTIONS;
+
+	public constructor(msg: string) {
+		super(`Invalid provider config options given for ${msg}`);
 	}
-}
+}
+/* eslint-enable max-classes-per-file */
diff --git a/packages/web3-rpc-providers/src/index.ts b/packages/web3-rpc-providers/src/index.ts
@@ -20,6 +20,7 @@ import { QuickNodeProvider } from './web3_provider_quicknode.js';
 export * from './types.js';
 export * from './web3_provider_quicknode.js';
 export * from './web3_provider.js';
+export * from './errors.js';
 
 // default providers
 export const mainnet = new QuickNodeProvider(); 
diff --git a/packages/web3-rpc-providers/src/types.ts b/packages/web3-rpc-providers/src/types.ts
@@ -15,6 +15,9 @@ You should have received a copy of the GNU Lesser General Public License
 along with web3.js.  If not, see <http://www.gnu.org/licenses/>.
 */
 
+import {ClientOptions, ClientRequestArgs} from "web3-providers-ws";
+import { ReconnectOptions } from 'web3-utils';
+
 export enum Transport {
     HTTPS = "https",
     WebSocket = "wss"
@@ -41,4 +44,10 @@ export enum Network {
 
     BNB_MAINNET = "bnb_mainnet",
     BNB_TESTNET = "bnb_testnet"
+};
+
+// Combining the ws types
+export type SocketOptions = {
+    socketOptions?: ClientOptions | ClientRequestArgs;
+    reconnectOptions?: Partial<ReconnectOptions>;
 };
diff --git a/packages/web3-rpc-providers/src/web3_provider.ts b/packages/web3-rpc-providers/src/web3_provider.ts
@@ -15,9 +15,8 @@ You should have received a copy of the GNU Lesser General Public License
 along with web3.js.  If not, see <http://www.gnu.org/licenses/>.
 */
 
-import HttpProvider from "web3-providers-http";
+import HttpProvider, { HttpProviderOptions } from "web3-providers-http";
 import WebSocketProvider from "web3-providers-ws";
-import { isNullish } from "web3-validator";
 import {
     EthExecutionAPI, JsonRpcResult, ProviderConnectInfo, ProviderMessage,
     ProviderRpcError, Web3APIMethod, Web3APIPayload, Web3APIReturnType, Web3APISpec, Web3BaseProvider,
@@ -28,8 +27,8 @@ import {
     JsonRpcResponseWithResult,
 } from "web3-types";
 import { Eip1193Provider } from "web3-utils";
-import { Transport, Network } from "./types.js";
-import { QuickNodeRateLimitError } from './errors.js';
+import { Transport, Network, SocketOptions } from "./types.js";
+import { ProviderConfigOptionsError } from "./errors.js";
 
 /* 
 This class can be used to create new providers only when there is custom logic required in each Request method like
@@ -39,29 +38,49 @@ Another simpler approach can be a function simply returning URL strings instead
 no additional logic implementation is required in the provider.
 */
 
-export abstract class Web3ExternalProvider <
-API extends Web3APISpec = EthExecutionAPI,
+export abstract class Web3ExternalProvider<
+    API extends Web3APISpec = EthExecutionAPI,
 > extends Eip1193Provider {
 
     public provider!: Web3BaseProvider;
     public readonly transport: Transport;
 
-    public abstract getRPCURL(network: Network,transport: Transport,token: string, host: string): string;
+    public abstract getRPCURL(network: Network, transport: Transport, token: string, host: string): string;
 
     public constructor(
         network: Network,
         transport: Transport,
         token: string,
-        host: string) {
-            
+        host: string,
+        providerConfigOptions?: HttpProviderOptions | SocketOptions) {
+
         super();
 
+        if(providerConfigOptions!== undefined && 
+            transport === Transport.HTTPS && 
+            !('providerOptions' in providerConfigOptions)){
+
+            throw new ProviderConfigOptionsError("HTTP Provider");
+        } 
+        else if(providerConfigOptions!== undefined &&
+             transport === Transport.WebSocket && 
+             !( 'socketOptions' in providerConfigOptions ||
+                'reconnectOptions' in providerConfigOptions 
+        )){
+            throw new ProviderConfigOptionsError("Websocket Provider");
+        }
+
         this.transport = transport;
         if (transport === Transport.HTTPS) {
-            this.provider = new HttpProvider(this.getRPCURL(network, transport, token, host));
+            this.provider = new HttpProvider(
+                this.getRPCURL(network, transport, token, host), 
+                providerConfigOptions as HttpProviderOptions);
         }
         else if (transport === Transport.WebSocket) {
-            this.provider = new WebSocketProvider(this.getRPCURL(network, transport, token, host));
+            this.provider = new WebSocketProvider(
+                this.getRPCURL(network, transport, token, host), 
+                (providerConfigOptions as SocketOptions)?.socketOptions, 
+                (providerConfigOptions as SocketOptions)?.reconnectOptions);
         }
     }
 
@@ -74,18 +93,11 @@ API extends Web3APISpec = EthExecutionAPI,
     ): Promise<JsonRpcResponseWithResult<ResultType>> {
 
         if (this.transport === Transport.HTTPS) {
-                const res = await ( (this.provider as HttpProvider).request(payload, requestOptions)) as unknown as JsonRpcResponseWithResult<ResultType>;
-                
-                if (typeof res === 'object' && !isNullish(res) && 'error' in res && !isNullish(res.error) && 'code' in res.error && (res.error as { code: number }).code === 429){
-                    // rate limiting error by quicknode;
-                    throw new QuickNodeRateLimitError();
-                    
-                }
-                return res;
-            }
-        
+            return await ((this.provider as HttpProvider).request(payload, requestOptions)) as unknown as JsonRpcResponseWithResult<ResultType>;
+        }
+
         return (this.provider as WebSocketProvider).request(payload);
-        
+
     }
 
     public getStatus(): Web3ProviderStatus {
@@ -142,4 +154,5 @@ API extends Web3APISpec = EthExecutionAPI,
             // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
             this.provider.removeListener(_type as any, _listener as any);
     }
-}
+}
+
diff --git a/packages/web3-rpc-providers/src/web3_provider_quicknode.ts b/packages/web3-rpc-providers/src/web3_provider_quicknode.ts
@@ -15,23 +15,44 @@ You should have received a copy of the GNU Lesser General Public License
 along with web3.js.  If not, see <http://www.gnu.org/licenses/>.
 */
 
-import { Transport, Network } from "./types.js";
+import { EthExecutionAPI, JsonRpcResponseWithResult, Web3APIMethod, Web3APIPayload, Web3APIReturnType, Web3APISpec } from "web3-types";
+import { ResponseError } from "web3-errors";
+import { HttpProviderOptions } from "web3-providers-http";
+import { Transport, Network, SocketOptions } from "./types.js";
 import { Web3ExternalProvider } from "./web3_provider.js";
+import { QuickNodeRateLimitError } from "./errors.js";
 
 const isValid = (str: string) => str !== undefined && str.trim().length > 0;
 
-export class QuickNodeProvider extends Web3ExternalProvider {
+export class QuickNodeProvider<
+API extends Web3APISpec = EthExecutionAPI,
+> extends Web3ExternalProvider {
 
-    public constructor(
-        network: Network = Network.ETH_MAINNET,
-        transport: Transport = Transport.HTTPS,
-        token = "", 
-        host = "") {
+    // eslint-disable-next-line default-param-last
+    public constructor( network: Network = Network.ETH_MAINNET, transport: Transport = Transport.HTTPS, token = "", host = "", providerConfigOptions?: HttpProviderOptions | SocketOptions) {
 
-        super(network, transport, token, host);
+        super(network, transport, token, host, providerConfigOptions);
 
     }
 
+    public async request<
+        Method extends Web3APIMethod<API>,
+        ResultType = Web3APIReturnType<API, Method>,
+    >(
+        payload: Web3APIPayload<EthExecutionAPI, Method>,
+        requestOptions?: RequestInit,
+    ): Promise<JsonRpcResponseWithResult<ResultType>> {
+
+        try {
+            return await super.request(payload, requestOptions);
+        } catch (error) {
+            if (error instanceof ResponseError && error.statusCode === 429){
+                throw new QuickNodeRateLimitError(error);
+            }
+            throw error;
+        }
+    }
+
     // eslint-disable-next-line class-methods-use-this
     public getRPCURL(network: Network,
         transport: Transport,
diff --git a/packages/web3-rpc-providers/test/unit/constructor.test.ts b/packages/web3-rpc-providers/test/unit/constructor.test.ts
diff --git a/packages/web3-rpc-providers/test/unit/request.test.ts b/packages/web3-rpc-providers/test/unit/request.test.ts
diff --git a/yarn.lock b/yarn.lock
