Enable the user to use only web3 as dependency

CHANGELOG.md

@@ -1139,16 +1139,66 @@ should use 4.0.1-alpha.0 for testing.
 
 ### Added
 
+#### web3
+
+-   `registeredSubscriptions` was added by default in web3 constructor (#5792)
+-   Add named exports for all objects which are the default-exported-object in their packages (#5771)
+-   Export all packages' objects organized by namespaces (#5771)
+-   Add Additional flat exports for all types and constants from `web3-types`, `web3-errors` and `web3`. (#5771)
+
 #### web3-core
 
 -   Added rpc exception codes following eip-1474 as an experimental feature (if `useRpcCallSpecification` at `enableExperimentalFeatures` is `true`) (#5525)
 
+#### web3-providers-http
+
+-   Added named export for `HttpProvider` (#5771)
+
+#### web3-providers-ipc
+
+-   Added named export for `IpcProvider` (#5771)
+
+#### web3-providers-ws
+
+-   Added named export for `WebSocketProvider` (#5771)
+
+#### web3-types
+
+-   Added types from `web3-eth-abi` and `TypedArray` from (#5771)
+-   Added `TypedArray` from `web3-utils` and `web3-validator` (it was defined twice) (#5771)
+
+### Changed
+
 #### web3
 
-##### Removed
+-   `require('web3')` will now return all web3 exported-objects organized in namespaces . (#5771)
+
+#### web3-errors
+
+-   The abstract class `Web3Error` is renamed to `BaseWeb3Error` (#5771)
+
+#### web3-eth
+
+-   Update imports statements for objects that was moved between web3 packages (#5771)
+
+#### web3-eth-contract
+
+-   Update imports statements for objects that was moved between web3 packages (#5771)
+
+### Removed
+
+#### web3
 
 -   Private static `_contracts:Contract[]` and static `setProvider` function was removed (#5792)
 
-##### Added
+#### web3-eth-abi
 
--   `registeredSubscriptions` was added by default in web3 constructor (#5792)
+-   Moved all types and interfaces to `web3-types` (#5771)
+
+#### web3-utils
+
+-   Moved `TypedArray` to `web3-types` (was also duplicated at `web3-validator`) (#5771)
+
+#### web3-validator
+
+-   Moved `TypedArray` to `web3-types` (was also duplicated at `web3-utils`) (#5771)

docs/docs/guides/web3_migration_guide/index.md

@@ -9,6 +9,27 @@ This migration guide is for migration from web3.js 1.x to web3.js 4.x.
 
 ## Breaking Changes
 
+### The `web3` package will return all web3.js exported objects
+
+`require('web3')` will now return all web3 exported-objects organized in namespaces (and few are available on top level). So, it is no longer supported to write the following code:
+
+```ts
+// This will return the name space and the line after it will throw an error!
+const Web3 = require('web3');
+
+const web3 = new Web3();
+```
+
+And the correct usage now is:
+
+```ts
+const { Web3 } = require('web3');
+
+const web3 = new Web3();
+```
+
+### Passing Callbacks to functions
+
 Passing callbacks to functions is no longer supported, except for event listeners.
 
 ### Not Implemented or Exported

packages/web3-errors/CHANGELOG.md

@@ -72,3 +72,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 -   web3.js dependencies (#5757)
 
 ## [Unreleased]
+
+### Changed
+
+#### web3-errors
+
+-   The abstract class `Web3Error` is renamed to `BaseWeb3Error` (#5771)

packages/web3-errors/src/errors/account_errors.ts

@@ -28,65 +28,65 @@ import {
 	ERR_IV_LENGTH,
 	ERR_PBKDF2_ITERATIONS,
 } from '../error_codes';
-import { Web3Error } from '../web3_error_base';
+import { BaseWeb3Error } from '../web3_error_base';
 
-export class PrivateKeyLengthError extends Web3Error {
+export class PrivateKeyLengthError extends BaseWeb3Error {
 	public code = ERR_PRIVATE_KEY_LENGTH;
 	public constructor() {
 		super(`Private key must be 32 bytes.`);
 	}
 }
 
-export class InvalidPrivateKeyError extends Web3Error {
+export class InvalidPrivateKeyError extends BaseWeb3Error {
 	public code = ERR_INVALID_PRIVATE_KEY;
 	public constructor() {
 		super(`Invalid Private Key, Not a valid string or buffer`);
 	}
 }
 
-export class InvalidSignatureError extends Web3Error {
+export class InvalidSignatureError extends BaseWeb3Error {
 	public code = ERR_INVALID_SIGNATURE;
 	public constructor(errorDetails: string) {
 		super(`"${errorDetails}"`);
 	}
 }
 
-export class InvalidKdfError extends Web3Error {
+export class InvalidKdfError extends BaseWeb3Error {
 	public code = ERR_UNSUPPORTED_KDF;
 	public constructor() {
 		super(`Invalid key derivation function`);
 	}
 }
 
-export class KeyDerivationError extends Web3Error {
+export class KeyDerivationError extends BaseWeb3Error {
 	public code = ERR_KEY_DERIVATION_FAIL;
 	public constructor() {
 		super(`Key derivation failed - possibly wrong password`);
 	}
 }
 
-export class KeyStoreVersionError extends Web3Error {
+export class KeyStoreVersionError extends BaseWeb3Error {
 	public code = ERR_KEY_VERSION_UNSUPPORTED;
 	public constructor() {
 		super('Unsupported key store version');
 	}
 }
 
-export class InvalidPasswordError extends Web3Error {
+export class InvalidPasswordError extends BaseWeb3Error {
 	public code = ERR_INVALID_PASSWORD;
 	public constructor() {
 		super('Password cannot be empty');
 	}
 }
 
-export class IVLengthError extends Web3Error {
+export class IVLengthError extends BaseWeb3Error {
 	public code = ERR_IV_LENGTH;
 	public constructor() {
 		super('Initialization vector must be 16 bytes');
 	}
 }
 
-export class PBKDF2IterationsError extends Web3Error {
+export class PBKDF2IterationsError extends BaseWeb3Error {
 	public code = ERR_PBKDF2_ITERATIONS;
 	public constructor() {
 		super('c > 1000, pbkdf2 is less secure with less iterations');

packages/web3-errors/src/errors/connection_errors.ts

@@ -28,9 +28,9 @@ import {
 	ERR_CONN_PENDING_REQUESTS,
 	ERR_REQ_ALREADY_SENT,
 } from '../error_codes';
-import { Web3Error } from '../web3_error_base';
+import { BaseWeb3Error } from '../web3_error_base';
 
-export class ConnectionError extends Web3Error {
+export class ConnectionError extends BaseWeb3Error {
 	public code = ERR_CONN;
 	public errorCode?: number;
 	public errorReason?: string;

packages/web3-errors/src/errors/contract_errors.ts

@@ -31,9 +31,9 @@ import {
 	ERR_CONTRACT_RESERVED_EVENT,
 	ERR_CONTRACT_RESOLVER_MISSING,
 } from '../error_codes';
-import { Web3Error } from '../web3_error_base';
+import { BaseWeb3Error } from '../web3_error_base';
 
-export class Web3ContractError extends Web3Error {
+export class Web3ContractError extends BaseWeb3Error {
 	public code = ERR_CONTRACT;
 	public receipt?: TransactionReceipt;
 
@@ -43,7 +43,7 @@ export class Web3ContractError extends Web3Error {
 		this.receipt = receipt;
 	}
 }
-export class ResolverMethodMissingError extends Web3Error {
+export class ResolverMethodMissingError extends BaseWeb3Error {
 	public code = ERR_CONTRACT_RESOLVER_MISSING;
 
 	public constructor(public address: string, public name: string) {
@@ -55,7 +55,7 @@ export class ResolverMethodMissingError extends Web3Error {
 	}
 }
 
-export class ContractMissingABIError extends Web3Error {
+export class ContractMissingABIError extends BaseWeb3Error {
 	public code = ERR_CONTRACT_ABI_MISSING;
 
 	public constructor() {
@@ -65,15 +65,15 @@ export class ContractMissingABIError extends Web3Error {
 	}
 }
 
-export class ContractOnceRequiresCallbackError extends Web3Error {
+export class ContractOnceRequiresCallbackError extends BaseWeb3Error {
 	public code = ERR_CONTRACT_REQUIRED_CALLBACK;
 
 	public constructor() {
 		super('Once requires a callback as the second parameter.');
 	}
 }
 
-export class ContractEventDoesNotExistError extends Web3Error {
+export class ContractEventDoesNotExistError extends BaseWeb3Error {
 	public code = ERR_CONTRACT_EVENT_NOT_EXISTS;
 
 	public constructor(public eventName: string) {
@@ -85,7 +85,7 @@ export class ContractEventDoesNotExistError extends Web3Error {
 	}
 }
 
-export class ContractReservedEventError extends Web3Error {
+export class ContractReservedEventError extends BaseWeb3Error {
 	public code = ERR_CONTRACT_RESERVED_EVENT;
 
 	public constructor(public type: string) {
@@ -97,31 +97,31 @@ export class ContractReservedEventError extends Web3Error {
 	}
 }
 
-export class ContractMissingDeployDataError extends Web3Error {
+export class ContractMissingDeployDataError extends BaseWeb3Error {
 	public code = ERR_CONTRACT_MISSING_DEPLOY_DATA;
 
 	public constructor() {
 		super(`No "data" specified in neither the given options, nor the default options.`);
 	}
 }
 
-export class ContractNoAddressDefinedError extends Web3Error {
+export class ContractNoAddressDefinedError extends BaseWeb3Error {
 	public code = ERR_CONTRACT_MISSING_ADDRESS;
 
 	public constructor() {
 		super("This contract object doesn't have address set yet, please set an address first.");
 	}
 }
 
-export class ContractNoFromAddressDefinedError extends Web3Error {
+export class ContractNoFromAddressDefinedError extends BaseWeb3Error {
 	public code = ERR_CONTRACT_MISSING_FROM_ADDRESS;
 
 	public constructor() {
 		super('No "from" address specified in neither the given options, nor the default options.');
 	}
 }
 
-export class ContractInstantiationError extends Web3Error {
+export class ContractInstantiationError extends BaseWeb3Error {
 	public code = ERR_CONTRACT_INSTANTIATION;
 }
 

packages/web3-errors/src/errors/core_errors.ts

@@ -17,10 +17,10 @@ along with web3.js.  If not, see <http://www.gnu.org/licenses/>.
 
 /* eslint-disable max-classes-per-file */
 
-import { Web3Error } from '../web3_error_base';
+import { BaseWeb3Error } from '../web3_error_base';
 import { ERR_CORE_HARDFORK_MISMATCH } from '../error_codes';
 
-export class ConfigHardforkMismatchError extends Web3Error {
+export class ConfigHardforkMismatchError extends BaseWeb3Error {
 	public code = ERR_CORE_HARDFORK_MISMATCH;
 
 	public constructor(defaultHardfork: string, commonHardFork: string) {
@@ -30,7 +30,7 @@ export class ConfigHardforkMismatchError extends Web3Error {
 	}
 }
 
-export class ConfigChainMismatchError extends Web3Error {
+export class ConfigChainMismatchError extends BaseWeb3Error {
 	public code = ERR_CORE_HARDFORK_MISMATCH;
 
 	public constructor(defaultHardfork: string, commonHardFork: string) {

packages/web3-errors/src/errors/ens_errors.ts

@@ -22,23 +22,23 @@ import {
 	ERR_ENS_NETWORK_NOT_SYNCED,
 	ERR_ENS_UNSUPPORTED_NETWORK,
 } from '../error_codes';
-import { Web3Error } from '../web3_error_base';
+import { BaseWeb3Error } from '../web3_error_base';
 
-export class ENSCheckInterfaceSupportError extends Web3Error {
+export class ENSCheckInterfaceSupportError extends BaseWeb3Error {
 	public code = ERR_ENS_CHECK_INTERFACE_SUPPORT;
 	public constructor(errorDetails: string) {
 		super(`ENS resolver check interface support error. "${errorDetails}"`);
 	}
 }
 
-export class ENSUnsupportedNetworkError extends Web3Error {
+export class ENSUnsupportedNetworkError extends BaseWeb3Error {
 	public code = ERR_ENS_UNSUPPORTED_NETWORK;
 	public constructor(networkType: string) {
 		super(`ENS is not supported on network ${networkType}`);
 	}
 }
 
-export class ENSNetworkNotSyncedError extends Web3Error {
+export class ENSNetworkNotSyncedError extends BaseWeb3Error {
 	public code = ERR_ENS_NETWORK_NOT_SYNCED;
 	public constructor() {
 		super(`Network not synced`);

packages/web3-errors/src/errors/generic_errors.ts

@@ -26,9 +26,9 @@ import {
 	ERR_PARAM,
 	ERR_EXISTING_PLUGIN_NAMESPACE,
 } from '../error_codes';
-import { Web3Error } from '../web3_error_base';
+import { BaseWeb3Error } from '../web3_error_base';
 
-export class InvalidNumberOfParamsError extends Web3Error {
+export class InvalidNumberOfParamsError extends BaseWeb3Error {
 	public code = ERR_PARAM;
 
 	public constructor(public got: number, public expected: number, public method: string) {
@@ -45,31 +45,31 @@ export class InvalidNumberOfParamsError extends Web3Error {
 	}
 }
 
-export class FormatterError extends Web3Error {
+export class FormatterError extends BaseWeb3Error {
 	public code = ERR_FORMATTERS;
 }
 
-export class MethodNotImplementedError extends Web3Error {
+export class MethodNotImplementedError extends BaseWeb3Error {
 	public code = ERR_METHOD_NOT_IMPLEMENTED;
 
 	public constructor() {
 		super("The method you're trying to call is not implemented.");
 	}
 }
 
-export class OperationTimeoutError extends Web3Error {
+export class OperationTimeoutError extends BaseWeb3Error {
 	public code = ERR_OPERATION_TIMEOUT;
 }
 
-export class OperationAbortError extends Web3Error {
+export class OperationAbortError extends BaseWeb3Error {
 	public code = ERR_OPERATION_ABORT;
 }
 
-export class AbiError extends Web3Error {
+export class AbiError extends BaseWeb3Error {
 	public code = ERR_ABI_ENCODING;
 }
 
-export class ExistingPluginNamespaceError extends Web3Error {
+export class ExistingPluginNamespaceError extends BaseWeb3Error {
 	public code = ERR_EXISTING_PLUGIN_NAMESPACE;
 
 	public constructor(pluginNamespace: string) {