Release/4.0.1 alpha.1

[jdevcs]

[4.0.1-alpha.1]

Added

web3-core

• If the response error was execution reverted, raise ContractExecutionError and pass the response error to it in order to be set as innerError (this innerError will be decoded at web3-eth-contract if its ABI was provided according to EIP-838). (Decoding EIP-838 error codes #5434)
• Added a new configuration variable enableExperimentalFeatures. (Use subscription at rejectIfBlockTimeout when the provider supports subscription #5481)
• registerPlugin method to Web3Context (Example Plugin Implementation  #5393)
• Web3PluginBase exported abstract class (Example Plugin Implementation  #5393)
• Web3EthPluginBase exported abstract class (Example Plugin Implementation  #5393)

web3-error

• Add optional innerError property to the abstract class Web3Error. This innerError could be Error, Error[] or undefined. (Use BigInt when decoding functions' and events' parameters returned from Smart Contracts calls and events #5435) (Decoding EIP-838 error codes #5434)
• The class Web3ContractError is moved to this package from web3-eth-contract. (Decoding EIP-838 error codes #5434)
• Added the error code ERR_TX_SIGNING and used it inside TransactionSigningError (Add ERR_TX_SIGNING and ERR_TX_GAS_MISMATCH and refactor and relocate some errors' classes  #5462)
• Added the error code ERR_TX_GAS_MISMATCH and used it inside TransactionGasMismatchError (Add ERR_TX_SIGNING and ERR_TX_GAS_MISMATCH and refactor and relocate some errors' classes  #5462)
• Added SignatureError to web3-errors/src/errors/signature_errors.ts (moved from web3-eth/src/errors.ts) (Add ERR_TX_SIGNING and ERR_TX_GAS_MISMATCH and refactor and relocate some errors' classes  #5462)
• Added the errors' classes to web3-errors/src/errors/transaction_errors.ts from web3-eth/src/errors.ts (Add ERR_TX_SIGNING and ERR_TX_GAS_MISMATCH and refactor and relocate some errors' classes  #5462)
• Added TransactionBlockTimeoutError class and its error code ERR_TX_BLOCK_TIMEOUT (Stop waiting after transactionBlockTimeout #5294)
• ExistingPluginNamespaceError class and it's error code ERR_EXISTING_PLUGIN_NAMESPACE (Example Plugin Implementation  #5393)

web3-eth

• web3-rpc-methods dependency (Init web3-rpc-methods package #5441)
• Added chain and hardfork validation for transaction and transaction.common object in validateTransactionForSigning

web3-eth-abi

• If an error happens when decoding a value, preserve that exception at innerError inside the error class AbiError. (Use BigInt when decoding functions' and events' parameters returned from Smart Contracts calls and events #5435)
• Add basic functionality that is used, by web3-eth-contract, when decoding error data according to EIP-838. (Decoding EIP-838 error codes #5434)

web3-eth-contract

• Decoding error data, using Error ABI if available, according to EIP-838. (Decoding EIP-838 error codes #5434)
• The class Web3ContractError is moved from this package to web3-error. (Decoding EIP-838 error codes #5434)

web3-plugin-example

• Example plugin for wrapping contract methods to provide custom functionality (Example Plugin Implementation  #5393)
• Example plugin for custom RPC methods using the requestManager (Example Plugin Implementation  #5393)

web3-utils

• Added and exported three reusable utility functions: pollTillDefined, rejectIfTimeout and rejectIfConditionAtInterval which are useful when dealing with promises that involves polling, rejecting after timeout or rejecting if a condition was met when calling repeatably at every time intervals.

web3-eth-personal

• web3-rpc-methods dependency (Init web3-rpc-methods package #5441)

web3-eth-net

• web3-rpc-methods dependency (Init web3-rpc-methods package #5441)

web3-providers-ipc

• Show error message and return dummy promise if socket is not writable (Stop waiting after transactionBlockTimeout #5294)

web3-rpc-methods

• web3-rpc-methods package added

web3-types

• Web3EthExecutionAPI export (Init web3-rpc-methods package #5441)
• Web3NetAPI export (Init web3-rpc-methods package #5441)
• EthPersonalAPI export (Init web3-rpc-methods package #5441)

Changed

web3-core

• Default value for API generic for Web3ContextObject from any to unknown (Example Plugin Implementation  #5393)
• Default value for API generic for Web3ContextInitOptions from any to unknown (Example Plugin Implementation  #5393)
• Added validation when defaultHardfork and defaultCommon.hardfork are different in web3config
• Added validation when defaultChain and defaultCommon.basechain are different in web3config
• Added a new configuration variable enableExperimentalFeatures. (Use subscription at rejectIfBlockTimeout when the provider supports subscription #5481)

web3-error

• Moved SignerError from web3-errors/src/errors/signature_errors.ts to web3-errors/src/errors/transaction_errors.ts, and renamed it to TransactionSigningError (Add ERR_TX_SIGNING and ERR_TX_GAS_MISMATCH and refactor and relocate some errors' classes  #5462)
• Corrected the error code for JSONRPC_ERR_UNAUTHORIZED to be 4100 (Add ERR_TX_SIGNING and ERR_TX_GAS_MISMATCH and refactor and relocate some errors' classes  #5462)

web3-eth

• Web3EthExecutionAPI is now imported via web3-types instead of web3_eth_execution_api.ts (Init web3-rpc-methods package #5441)
• Replace the imported methods from rpc_methods.ts with ethRpcMethods imports from web3-rpc-methods (Init web3-rpc-methods package #5441)
• Web3NetAPI is now imported from web3-types instead of web3-net (Init web3-rpc-methods package #5441)
• Moved rpc_methods tests to web3-rpc-methods (Init web3-rpc-methods package #5441)
• Implemented the logic for transactionBlockTimeout (Stop waiting after transactionBlockTimeout #5294)
• Use subscription at rejectIfBlockTimeout when the provider supports subscription. Implement this as an experimental feature (if useSubscriptionWhenCheckingBlockTimeout at enableExperimentalFeatures is true). (Use subscription at rejectIfBlockTimeout when the provider supports subscription #5481)
• At some test cases, optimized some codes. (Use subscription at rejectIfBlockTimeout when the provider supports subscription #5481)

web3-eth-accounts

• signTransaction and privateKeyToAccount will throw TransactionSigningError instead of SignerError now (Add ERR_TX_SIGNING and ERR_TX_GAS_MISMATCH and refactor and relocate some errors' classes  #5462)

web3-eth-ens

• Web3NetAPI is now imported from web3-types instead of web3-net (Init web3-rpc-methods package #5441)

web3-eth-personal

• Import EthPersonalAPI from web3-types instead of local import (Init web3-rpc-methods package #5441)
• Replace the imported methods from rcp_methods.ts with personalRpcMethods imports from web3-rpc-methods (Init web3-rpc-methods package #5441)
• Replace use of EthPersonalAPIManager with Web3RequestManager<EthPersonalAPI> (Init web3-rpc-methods package #5441)

web3-eth-net

• Web3NetAPI is now imported from web3-types instead of web3_net_api.ts (Init web3-rpc-methods package #5441)
• Replace the imported methods from rpc_methods.ts with netRpcMethods imports from web3-rpc-methods (Init web3-rpc-methods package #5441)

web3-types

• Web3APISpec, Web3APIMethod, and Web3APIParams now supports unknown APIs (Example Plugin Implementation  #5393)

Fixed

web3-error

• Corrected the error code for JSONRPC_ERR_UNAUTHORIZED to be 4100 (Add ERR_TX_SIGNING and ERR_TX_GAS_MISMATCH and refactor and relocate some errors' classes  #5462)

web3-eth

• Fix getBlock returning empty transactions object on hydrated true (eth.getBlock with hydrated = true returning empty transaction objects #5556)
• setimmediate package to polyfill setImmediate for browsers (setImmediate Not Defined in Browsers Fix #5450)

web3-eth-contract

• According to the latest change in web3-eth-abi, the decoded values of the large numbers, returned from function calls or events, are now available as BigInt. (Use BigInt when decoding functions' and events' parameters returned from Smart Contracts calls and events #5435)

web3-eth-abi

• Return BigInt instead of string when decoding function parameters for large numbers, such as uint256. (Use BigInt when decoding functions' and events' parameters returned from Smart Contracts calls and events #5435)

web3-types

• Web3APISpec, Web3APIMethod, and Web3APIParams now supports unknown APIs (Example Plugin Implementation  #5393)

Removed

web3-eth

• Moved the errors' classes from web3-eth/src/errors.ts to web3-errors/src/errors/transaction_errors.ts (Add ERR_TX_SIGNING and ERR_TX_GAS_MISMATCH and refactor and relocate some errors' classes  #5462)

web3-eth-personal

• Exported type EthPersonalAPIManager, EthPersonalAPI is not exported via web3-types (Init web3-rpc-methods package #5441)

web3-eth-net

• rpcMethods export, these methods are now exported via web3-rpc-methods as netRpcMethods (Init web3-rpc-methods package #5441)
• Web3NetAPI export, now exported via web3-types as Web3NetAPI (Init web3-rpc-methods package #5441)

web3-validator

• Removed direct function toJSON() in Web3ValidatorError class as its available via base class (Use BigInt when decoding functions' and events' parameters returned from Smart Contracts calls and events #5435)

[mpetrunic]

• setImmediate fix is under added instead of fixed

• if I fix Update 1.x Critical Vulnerabilities #5547 tomorrow, can we include it in a release as its blocking usage of 4.x in a consulting project?

[jdevcs]

• setImmediate fix is under added instead of fixed
  updated.

• if I fix Update 1.x Critical Vulnerabilities #5547 tomorrow, can we include it in a release as its blocking usage of 4.x in a consulting project?

yes sure, but just want to confirm PR, #5547 is for 1.x, and current release PR is for 4.x.

[mpetrunic]

• setImmediate fix is under added instead of fixed
  updated.

• if I fix Update 1.x Critical Vulnerabilities #5547 tomorrow, can we include it in a release as its blocking usage of 4.x in a consulting project?

yes sure, but just want to confirm PR, #5547 is for 1.x, and current release PR is for 4.x.

Typo , i meant #5574

[jdevcs]

Pushed fix for bigint issue in blackbox tests . #5583

[Muhammad-Altabba]

Thanks for the tremendous fixes and enhancements to the CHANGELOG.md files.