✨ Make the web3 constructor parameters optional

packages/web3-core/src/utils.ts

@@ -41,7 +41,7 @@ export const isLegacySendAsyncProvider = <API extends Web3APISpec>(
 
 export const isSupportedProvider = <API extends Web3APISpec>(
 	provider: SupportedProviders<API>,
-): boolean =>
+): provider is SupportedProviders<API> =>
 	Web3BaseProvider.isWeb3Provider(provider) ||
 	isLegacyRequestProvider(provider) ||
 	isLegacySendAsyncProvider(provider) ||

packages/web3-core/src/web3_context.ts

@@ -21,7 +21,7 @@ import {
 	Web3BaseWalletAccount,
 	Web3AccountProvider,
 } from 'web3-common';
-import { HexString } from 'web3-utils';
+import { HexString, isNullish } from 'web3-utils';
 import { SupportedProviders } from './types';
 import { isSupportedProvider } from './utils';
 // eslint-disable-next-line import/no-cycle
@@ -41,7 +41,7 @@ export type Web3ContextObject<
 	} = any,
 > = {
 	config: Web3ConfigOptions;
-	provider: SupportedProviders<API>;
+	provider?: SupportedProviders<API> | string;
 	requestManager: Web3RequestManager<API>;
 	subscriptionManager?: Web3SubscriptionManager<API, RegisteredSubs> | undefined;
 	registeredSubscriptions?: RegisteredSubs;
@@ -59,7 +59,7 @@ export type Web3ContextInitOptions<
 	} = any,
 > = {
 	config?: Partial<Web3ConfigOptions>;
-	provider: SupportedProviders<API> | string;
+	provider?: SupportedProviders<API> | string;
 	requestManager?: Web3RequestManager<API>;
 	subscriptionManager?: Web3SubscriptionManager<API, RegisteredSubs> | undefined;
 	registeredSubscriptions?: RegisteredSubs;
@@ -99,17 +99,24 @@ export class Web3Context<
 
 	public constructor(
 		providerOrContext?:
+			| string
 			| SupportedProviders<API>
-			| Web3ContextInitOptions<API, RegisteredSubs>
-			| string,
+			| Web3ContextInitOptions<API, RegisteredSubs>,
 	) {
 		super();
+
+		// If "providerOrContext" is provided as "string" or an objects matching "SupportedProviders" interface
 		if (
-			typeof providerOrContext === 'string' ||
+			isNullish(providerOrContext) ||
+			(typeof providerOrContext === 'string' && providerOrContext.trim() !== '') ||
 			isSupportedProvider(providerOrContext as SupportedProviders<API>)
 		) {
 			this._requestManager = new Web3RequestManager<API>(
-				providerOrContext as SupportedProviders<API>,
+				providerOrContext as undefined | string | SupportedProviders<API>,
+			);
+			this._subscriptionManager = new Web3SubscriptionManager(
+				this._requestManager,
+				{} as RegisteredSubs,
 			);
 
 			return;
@@ -123,7 +130,7 @@ export class Web3Context<
 			registeredSubscriptions,
 			accountProvider,
 			wallet,
-		} = providerOrContext as Partial<Web3ContextObject<API, RegisteredSubs>>;
+		} = providerOrContext as Web3ContextInitOptions<API, RegisteredSubs>;
 
 		this.setConfig(config ?? {});
 
@@ -229,19 +236,19 @@ export class Web3Context<
 		});
 	}
 
-	public get provider(): SupportedProviders<API> {
+	public get provider(): SupportedProviders<API> | string | undefined {
 		return this.requestManager.provider;
 	}
 
-	public set provider(provider: SupportedProviders<API> | string) {
+	public set provider(provider: SupportedProviders<API> | string | undefined) {
 		this.requestManager.setProvider(provider);
 	}
 
-	public get currentProvider(): SupportedProviders<API> {
+	public get currentProvider(): SupportedProviders<API> | string | undefined {
 		return this.requestManager.provider;
 	}
 
-	public set currentProvider(provider: SupportedProviders<API> | string) {
+	public set currentProvider(provider: SupportedProviders<API> | string | undefined) {
 		this.requestManager.setProvider(provider);
 	}
 
@@ -250,7 +257,7 @@ export class Web3Context<
 		return Web3Context.givenProvider;
 	}
 
-	public setProvider(provider: SupportedProviders<API>) {
+	public setProvider(provider?: SupportedProviders<API> | string) {
 		this.provider = provider;
 	}
 

packages/web3-core/src/web3_request_manager.ts

@@ -31,7 +31,6 @@ import {
 	Web3APIRequest,
 	Web3APIReturnType,
 	Web3APISpec,
-	Web3BaseProvider,
 	Web3EventEmitter,
 } from 'web3-common';
 import HttpProvider from 'web3-providers-http';
@@ -60,14 +59,14 @@ const availableProviders = {
 export class Web3RequestManager<
 	API extends Web3APISpec = EthExecutionAPI,
 > extends Web3EventEmitter<{
-	[key in Web3RequestManagerEvent]: SupportedProviders<API>;
+	[key in Web3RequestManagerEvent]: SupportedProviders<API> | undefined;
 }> {
-	private _provider!: SupportedProviders<API>;
+	private _provider?: SupportedProviders<API>;
 
 	public constructor(provider?: SupportedProviders<API> | string, net?: Socket) {
 		super();
 
-		if (provider) {
+		if (!isNullish(provider)) {
 			this.setProvider(provider, net);
 		}
 	}
@@ -77,10 +76,6 @@ export class Web3RequestManager<
 	}
 
 	public get provider() {
-		if (!this._provider) {
-			throw new ProviderError('Provider not available');
-		}
-
 		return this._provider;
 	}
 
@@ -89,8 +84,8 @@ export class Web3RequestManager<
 		return availableProviders;
 	}
 
-	public setProvider(provider: SupportedProviders<API> | string, net?: Socket) {
-		let newProvider!: Web3BaseProvider<API>;
+	public setProvider(provider?: SupportedProviders<API> | string, net?: Socket) {
+		let newProvider: SupportedProviders<API> | undefined;
 
 		// autodetect provider
 		if (provider && typeof provider === 'string' && this.providers) {
@@ -106,12 +101,17 @@ export class Web3RequestManager<
 			} else if (typeof net === 'object' && typeof net.connect === 'function') {
 				newProvider = new this.providers.IpcProvider<API>(provider, net);
 			} else {
-				throw new ProviderError(`Can't autodetect provider for "${provider}'"`);
+				throw new ProviderError(`Can't autodetect provider for "${provider}"`);
 			}
+		} else if (isNullish(provider)) {
+			// In case want to unset the provider
+			newProvider = undefined;
+		} else {
+			newProvider = provider as SupportedProviders<API>;
 		}
 
 		this.emit(Web3RequestManagerEvent.BEFORE_PROVIDER_CHANGE, this._provider);
-		this._provider = newProvider ?? provider;
+		this._provider = newProvider;
 		this.emit(Web3RequestManagerEvent.PROVIDER_CHANGED, this._provider);
 	}
 
@@ -142,6 +142,12 @@ export class Web3RequestManager<
 	): Promise<JsonRpcResponse<ResponseType>> {
 		const { provider } = this;
 
+		if (isNullish(provider)) {
+			throw new ProviderError(
+				'Provider not available. Use `.setProvider` or `.provider=` to initialize the provider.',
+			);
+		}
+
 		const payload = jsonRpc.isBatchRequest(request)
 			? jsonRpc.toBatchPayload(request)
 			: jsonRpc.toPayload(request);

packages/web3-core/src/web3_subscription_manager.ts

@@ -126,6 +126,8 @@ export class Web3SubscriptionManager<
 	}
 
 	public supportsSubscriptions(): boolean {
-		return isSupportSubscriptions(this.requestManager.provider);
+		return isNullish(this.requestManager.provider)
+			? false
+			: isSupportSubscriptions(this.requestManager.provider);
 	}
 }

packages/web3-core/test/unit/__snapshots__/web3_context.test.ts.snap

@@ -33,11 +33,14 @@ Object {
     "IpcProvider": [Function],
     "WebsocketProvider": [Function],
   },
-  "registeredSubscriptions": undefined,
+  "registeredSubscriptions": Object {},
   "requestManager": Web3RequestManager {
     "_emitter": EventEmitter {
-      "_events": Object {},
-      "_eventsCount": 0,
+      "_events": Object {
+        "BEFORE_PROVIDER_CHANGE": [Function],
+        "PROVIDER_CHANGED": [Function],
+      },
+      "_eventsCount": 2,
       "_maxListeners": undefined,
       Symbol(kCapture): false,
     },
@@ -46,7 +49,25 @@ Object {
       "httpProviderOptions": undefined,
     },
   },
-  "subscriptionManager": undefined,
+  "subscriptionManager": Web3SubscriptionManager {
+    "_subscriptions": Map {},
+    "registeredSubscriptions": Object {},
+    "requestManager": Web3RequestManager {
+      "_emitter": EventEmitter {
+        "_events": Object {
+          "BEFORE_PROVIDER_CHANGE": [Function],
+          "PROVIDER_CHANGED": [Function],
+        },
+        "_eventsCount": 2,
+        "_maxListeners": undefined,
+        Symbol(kCapture): false,
+      },
+      "_provider": HttpProvider {
+        "clientUrl": "http://test/abc",
+        "httpProviderOptions": undefined,
+      },
+    },
+  },
   "wallet": undefined,
 }
 `;

packages/web3-core/test/unit/web3_request_manager.test.ts

@@ -233,7 +233,7 @@ describe('Web3RequestManager', () => {
 			const manager = new Web3RequestManager();
 
 			expect(() => manager.setProvider(providerString)).toThrow(
-				`Can't autodetect provider for "pc://mydomain.com'"`,
+				`Can't autodetect provider for "pc://mydomain.com"`,
 			);
 		});
 	});

packages/web3-eth-contract/src/contract.ts

@@ -175,7 +175,7 @@ export class Contract<Abi extends ContractAbi>
 		super({
 			...context,
 			// Pass an empty string to avoid type issue. Error will be thrown from underlying validation
-			provider: options?.provider ?? context?.provider ?? Contract.givenProvider ?? '',
+			provider: options?.provider ?? context?.provider ?? Contract.givenProvider,
 			registeredSubscriptions: {
 				logs: LogsSubscription,
 				newHeads: NewHeadsSubscription,

packages/web3-eth-contract/src/types.ts

@@ -61,7 +61,7 @@ export interface ContractInitOptions {
 	readonly from?: Address;
 	readonly data?: Bytes;
 	readonly gasLimit?: Uint;
-	readonly provider: SupportedProviders<EthExecutionAPI> | string;
+	readonly provider?: SupportedProviders<EthExecutionAPI> | string;
 }
 
 export type TransactionReceipt = ReceiptInfo;

packages/web3-eth/src/web3_eth.ts

@@ -18,7 +18,12 @@ along with web3.js.  If not, see <http://www.gnu.org/licenses/>.
 // Disabling because returnTypes must be last param to match 1.x params
 /* eslint-disable default-param-last */
 import { DataFormat, DEFAULT_RETURN_FORMAT } from 'web3-common';
-import { SupportedProviders, Web3Context, Web3ContextInitOptions } from 'web3-core';
+import {
+	isSupportedProvider,
+	SupportedProviders,
+	Web3Context,
+	Web3ContextInitOptions,
+} from 'web3-core';
 import {
 	Address,
 	Bytes,
@@ -53,28 +58,40 @@ type RegisteredSubscription = {
 	syncing: typeof SyncingSubscription;
 };
 
+const registeredSubscriptions = {
+	logs: LogsSubscription,
+	newPendingTransactions: NewPendingTransactionsSubscription,
+	newHeads: NewHeadsSubscription,
+	syncing: SyncingSubscription,
+	pendingTransactions: NewPendingTransactionsSubscription, // the same as newPendingTransactions. just for support API like in version 1.x
+	newBlockHeaders: NewHeadsSubscription, // the same as newHeads. just for support API like in version 1.x
+};
+
 export class Web3Eth extends Web3Context<Web3EthExecutionAPI, RegisteredSubscription> {
 	public constructor(
-		// eslint-disable-next-line @typescript-eslint/no-explicit-any
-		providerOrContext: SupportedProviders<any> | Web3ContextInitOptions | string,
+		providerOrContext?: SupportedProviders<any> | Web3ContextInitOptions | string,
 	) {
-		super(
-			typeof providerOrContext === 'object' &&
-				(providerOrContext as Web3ContextInitOptions).provider
-				? providerOrContext
-				: {
-						// eslint-disable-next-line @typescript-eslint/no-explicit-any
-						provider: providerOrContext as SupportedProviders<any>,
-						registeredSubscriptions: {
-							logs: LogsSubscription,
-							newPendingTransactions: NewPendingTransactionsSubscription,
-							newHeads: NewHeadsSubscription,
-							syncing: SyncingSubscription,
-							pendingTransactions: NewPendingTransactionsSubscription, // the same as newPendingTransactions. just for support API like in version 1.x
-							newBlockHeaders: NewHeadsSubscription, // the same as newHeads. just for support API like in version 1.x
-						},
-				  },
-		);
+		if (
+			typeof providerOrContext === 'string' ||
+			isSupportedProvider(providerOrContext as SupportedProviders<any>)
+		) {
+			super({
+				provider: providerOrContext as SupportedProviders<any>,
+				registeredSubscriptions,
+			});
+
+			return;
+		}
+
+		if ((providerOrContext as Web3ContextInitOptions).registeredSubscriptions) {
+			super(providerOrContext as Web3ContextInitOptions);
+			return;
+		}
+
+		super({
+			...(providerOrContext as Web3ContextInitOptions),
+			registeredSubscriptions,
+		});
 	}
 	public async getProtocolVersion() {
 		return rpcMethods.getProtocolVersion(this.requestManager);

packages/web3-validator/src/validation/numbers.ts

@@ -38,6 +38,7 @@ export const isUInt = (
 	) {
 		return false;
 	}
+
 	let size!: number;
 
 	if (options?.abiType) {

packages/web3/src/web3.ts

@@ -61,10 +61,11 @@ export class Web3 extends Web3Context<EthExecutionAPI> {
 		Personal,
 	};
 
+	public utils: typeof utils;
+
 	public eth: Web3Eth & {
 		Iban: typeof Iban;
 		ens: ENS;
-		utils: typeof utils;
 		net: Net;
 		personal: Personal;
 		Contract: typeof Contract & {
@@ -93,7 +94,7 @@ export class Web3 extends Web3Context<EthExecutionAPI> {
 		};
 	};
 
-	public constructor(provider: SupportedProviders<EthExecutionAPI> | string) {
+	public constructor(provider?: SupportedProviders<EthExecutionAPI> | string) {
 		const accountProvider = {
 			create,
 			privateKeyToAccount,
@@ -108,6 +109,8 @@ export class Web3 extends Web3Context<EthExecutionAPI> {
 
 		super({ provider, wallet, accountProvider });
 
+		this.utils = utils;
+
 		// Have to use local alias to initiate contract context
 		// eslint-disable-next-line @typescript-eslint/no-this-alias
 		const self = this;
@@ -146,8 +149,6 @@ export class Web3 extends Web3Context<EthExecutionAPI> {
 			net: self.use(Net),
 			personal: self.use(Personal),
 
-			utils,
-
 			// Contract helper and module
 			Contract: ContractBuilder,