Release/4.0.1 rc.0

[jdevcs]

[4.0.1-rc.0]

Added

web3

• registeredSubscriptions was added by default in web3 constructor (5704 memory leak in web3.eth.contract #5792)
• Add named exports for all objects which are the default-exported-object in their packages (Enable the user to use only web3 as dependency #5771)
• Export all packages' objects organized by namespaces (Enable the user to use only web3 as dependency #5771)
• Add Additional flat exports for all types and constants from web3-types, web3-errors and web3. (Enable the user to use only web3 as dependency #5771)
• Fix few issues with new Web3().eth.contract (Fix few issues with new Web3().eth.contract #5824)

web3-core

• Added rpc exception codes following eip-1474 as an experimental feature (if useRpcCallSpecification at enableExperimentalFeatures is true) (Nikos/5430/validator unit test coverage #5525)
• Added support of safe and finalized block tags (5811 merge block tags #5823)

web3-errors

• Added error class InvalidMethodParamsError and error code ERR_INVALID_METHOD_PARAMS = 207 (Fix few issues with new Web3().eth.contract #5824)
• request property to ResponseError (sendTransaction and sendSignedTransaction Error Refactors #5854)
• data property to TransactionRevertInstructionError (sendTransaction and sendSignedTransaction Error Refactors #5854)
• TransactionRevertWithCustomError was added to handle custom solidity errors (sendTransaction and sendSignedTransaction Error Refactors #5854)

web3-eth

• Added createAccessList functionality ( 5488 create access list #5780 )
• Added support of safe and finalized block tags (5811 merge block tags #5823)
• contractAbi option to SendTransactionOptions and SendSignedTransactionOptions to added the ability to parse custom solidity errors (sendTransaction and sendSignedTransaction Error Refactors #5854)

web3-eth-abi

• decodeErrorData from web3-eth-contract is now exported from this package and was renamed to decodeContractErrorData (Refactor getRevertReason and add tests #5844)

web3-eth-contract

• Added functionality of createAccessList for contracts ( 5488 create access list #5780 )
• An instance of Contract will subscribeToContextEvents upon instantiation if syncWithContext is set to true and the constructor is passed an instance of Web3Context (Subscribe to context events if contractContext instanceof Web3Context #5833)
• Added support of safe and finalized block tags (5811 merge block tags #5823)

web3-providers-http

• Added named export for HttpProvider (Enable the user to use only web3 as dependency #5771)

web3-providers-ipc

• Added named export for IpcProvider (Enable the user to use only web3 as dependency #5771)
• Pass _socketOptions from IpcProvider constructor to the underlying Socket (A fix at IpcProvider and few changes at SocketProvider and its descendants #5891)
• The getter of SocketConnection in IpcProvider (inherited from SocketProvider) returns net.Socket (A fix at IpcProvider and few changes at SocketProvider and its descendants #5891)

web3-providers-ws

• Added named export for WebSocketProvider (Enable the user to use only web3 as dependency #5771)
• The getter of SocketConnection in WebSocketProvider (inherited from SocketProvider) returns isomorphic WebSocket (A fix at IpcProvider and few changes at SocketProvider and its descendants #5891)

web3-rpc-methods

• Added createAccessList functionality ( 5488 create access list #5780 )
• Added support of safe and finalized block tags (5811 merge block tags #5823)

web3-types

• Added types from web3-eth-abi and TypedArray from (Enable the user to use only web3 as dependency #5771)
• Added TypedArray from web3-utils and web3-validator (it was defined twice) (Enable the user to use only web3 as dependency #5771)
• Added safe and finalized block tags in BlockTags and BlockTag types (5811 merge block tags #5823)

web3-utils

• Added support of safe and finalized block tags (5811 merge block tags #5823)

web3-validator

• Added support of safe and finalized block tags in isBlockTag method (5811 merge block tags #5823)

Changed

web3

• require('web3') will now return all web3 exported-objects organized in namespaces . (Enable the user to use only web3 as dependency #5771)

web3-errors

• The abstract class Web3Error is renamed to BaseWeb3Error (Enable the user to use only web3 as dependency #5771)
• Renamed TransactionRevertError to TransactionRevertInstructionError to remain consistent with 1.x
• Using MaxAttemptsReachedOnReconnectingError with the same message for 1.x but also adding the maxAttempts (Use MaxAttemptsReachedOnReconnectingError similar to v1.x #5894)

web3-eth

• Update imports statements for objects that was moved between web3 packages (Enable the user to use only web3 as dependency #5771)
• sendTransaction and sendSignedTransaction now errors with (and error event emits) the following possible errors: TransactionRevertedWithoutReasonError, TransactionRevertInstructionError, TransactionRevertWithCustomError, InvalidResponseError, or ContractExecutionError (sendTransaction and sendSignedTransaction Error Refactors #5854)

web3-eth-accounts

• Updated dependencies

web3-eth-contract

• Update imports statements for objects that was moved between web3 packages (Enable the user to use only web3 as dependency #5771)

web3-eth-ens

• Updated dependencies

web3-eth-iban

• Updated dependencies

web3-eth-personal

• Updated dependencies

web3-net

• Updated dependencies

web3-utils

• compareBlockNumbers function now only supports comparison of both blocktags params ( except earliest vs number) or both block number params (5836compare blocks #5842)
• SocketProvider abstract class now resolves JSON RPC response errors instead of rejecting them (Refactor getRevertReason and add tests #5844)
• Exposes the getter of SocketConnection in SocketProvider (A fix at IpcProvider and few changes at SocketProvider and its descendants #5891)

Removed

web3

• Private static _contracts:Contract[] and static setProvider function was removed (5704 memory leak in web3.eth.contract #5792)

web3-eth

• getRevertReason is no longer exported (Refactor getRevertReason and add tests #5844)

web3-eth-abi

• Moved all types and interfaces to web3-types (Enable the user to use only web3 as dependency #5771)

web3-eth-contract

• decodeErrorData is no longer exported (method was moved to web3-eth-abi and renamed decodeContractErrorData) (Refactor getRevertReason and add tests #5844)

web3-utils

• Moved TypedArray to web3-types (was also duplicated at web3-validator) (Enable the user to use only web3 as dependency #5771)
• Removed support of genesis tag in compareBlockNumbers function (5811 merge block tags #5823)

web3-validator

• Moved TypedArray to web3-types (was also duplicated at web3-utils) (Enable the user to use only web3 as dependency #5771)

Fixed

web3-eth-contract

• Fix contract defaults (Nikos/5603/some default properties cannot set from contract class #5756)
• Fixed getPastEventsError (5788 - 4.x getPastEvents error #5819)

[github-actions]

Bundle Stats

Hey there, this message comes from a github action that helps you and reviewers to understand how these changes affect the size of this project's bundle.

As this PR is updated, I'll keep you updated on how the bundle size is impacted.

Total

Asset	Old size	New size	Diff	Diff %
Total	1.18 MB	1.06 MB	-116 KB	-9.61%

View detailed bundle breakdown

Added

Asset	Old size	New size	Diff	Diff %
../lib/eth.exports.d.ts.map	0	358 bytes	358 bytes	-
../lib/eth.exports.d.ts	0	321 bytes	321 bytes	-
../lib/providers.exports.d.ts.map	0	292 bytes	292 bytes	-
../lib/providers.exports.d.ts	0	238 bytes	238 bytes	-

Removed

No assets were removed

Bigger

Asset	Old size	New size	Diff	Diff %
../lib/index.d.ts	77 bytes	899 bytes	822 bytes	1067.53%
../lib/index.d.ts.map	155 bytes	919 bytes	764 bytes	492.90%

Smaller

Asset	Old size	New size	Diff	Diff %
web3.min.js	1.17 MB	1.05 MB	-118 KB	-9.88%
../lib/types.d.ts	1.92 KB	1.68 KB	-253 bytes	-12.84%
../lib/types.d.ts.map	1.75 KB	1.51 KB	-241 bytes	-13.46%

Unchanged

Asset	Old size	New size	Diff	Diff %
../lib/accounts.d.ts	3.42 KB	3.42 KB	0	0.00%
../lib/abi.d.ts	1020 bytes	999 bytes	-18 bytes	-1.77%
../lib/web3.d.ts	842 bytes	842 bytes	0	0.00%
../lib/web3.d.ts.map	693 bytes	694 bytes	1 bytes	0.14%
../lib/accounts.d.ts.map	528 bytes	528 bytes	0	0.00%
../lib/version.d.ts.map	140 bytes	140 bytes	0	0.00%
../lib/abi.d.ts.map	124 bytes	124 bytes	0	0.00%
../lib/version.d.ts	97 bytes	97 bytes	0	0.00%

[cloudflare-workers-and-pages]

Deploying with    Cloudflare Pages

Latest commit:	e7d290c
Status:	✅  Deploy successful!
Preview URL:	https://b3966e7f.web3-js-docs.pages.dev
Branch Preview URL:	https://release-4-0-1-rc-0.web3-js-docs.pages.dev

View logs

[codecov]

Codecov Report

Merging #5912 (e7d290c) into 4.x (f758099) will not change coverage.
The diff coverage is 100.00%.

Additional details and impacted files

@@           Coverage Diff           @@
##              4.x    #5912   +/-   ##
=======================================
  Coverage   81.00%   81.00%           
=======================================
  Files         137      137           
  Lines        5981     5981           
  Branches     1573     1573           
=======================================
  Hits         4845     4845           
  Misses       1136     1136           

Flag	Coverage Δ
UnitTests	81.00% <100.00%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Components	Coverage Δ
web3	∅ <ø> (∅)
web3-core	∅ <ø> (∅)
web3-errors	∅ <ø> (∅)
web3-eth	∅ <ø> (∅)
web3-eth-abi	∅ <ø> (∅)
web3-eth-accounts	∅ <ø> (∅)
web3-eth-contract	∅ <ø> (∅)
web3-eth-ens	∅ <ø> (∅)
web3-eth-iban	∅ <ø> (∅)
web3-eth-personal	∅ <ø> (∅)
web3-net	∅ <ø> (∅)
web3-providers-http	∅ <ø> (∅)
web3-providers-ipc	∅ <ø> (∅)
web3-providers-ws	∅ <ø> (∅)
web3-rpc-methods	∅ <ø> (∅)
web3-utils	∅ <ø> (∅)
web3-validator	∅ <ø> (∅)