Release/4.1.0

[jdevcs]

Added

web3

• Added minimum support of web3.extend function

web3-core

• Added minimum support of web3.extend function

web3-errors

• RpcErrorMessages that contains mapping for standard RPC Errors and their messages. (Fix: 'disconnect' in Eip1193 provider must emit ProviderRpcError #6230)
• created TransactionGasMismatchInnerError for clarity on the error in TransactionGasMismatchError (maxFeePerGas requirement in 4.x #6215)
• created MissingGasInnerError for clarity on the error in MissingGasError (maxFeePerGas requirement in 4.x #6215)

web3-eth

• A rpc_method_wrapper (signTypedData) for the rpc calls eth_signTypedData and eth_signTypedData_v4 (Implement EIP712 RPC Wrapper Methods and getEncodedEip712Data Util #6286)
• A signTypedData method to the Web3Eth class (Implement EIP712 RPC Wrapper Methods and getEncodedEip712Data Util #6286)

web3-eth-abi

• A getEncodedEip712Data method that takes an EIP-712 typed data object and returns the encoded data with the option to also keccak256 hash it (Implement EIP712 RPC Wrapper Methods and getEncodedEip712Data Util #6286)

web3-rpc-methods

• A signTypedData method to eth_rpc_methods for the rpc calls eth_signTypedData and eth_signTypedData_v4 (Implement EIP712 RPC Wrapper Methods and getEncodedEip712Data Util #6286)

web3-types

• eth_signTypedData and eth_signTypedData_v4 to web3_eth_execution_api (Implement EIP712 RPC Wrapper Methods and getEncodedEip712Data Util #6286)
• Eip712TypeDetails and Eip712TypedData to eth_types (Implement EIP712 RPC Wrapper Methods and getEncodedEip712Data Util #6286)

web3-validator

• Added json-schema as a main json schema type (6156 find replacement for is my json valid #6264)

Fixed

web3-core

• Fixed the issue: "Version 4.x does not fire connected event for subscriptions. Version 4.x does not fire connected event for subscriptions. #6252". (Enable Custom Event Subscription #6262)

web3-errors

• Fixed: "'disconnect' in Eip1193 provider must emit ProviderRpcError 'disconnect' in Eip1193 provider must emit ProviderRpcError #6003".(Fix: 'disconnect' in Eip1193 provider must emit ProviderRpcError #6230)

web3-eth

• sendTransaction will have gas filled by default using method estimateGas unless transaction builder options.fillGas is false. (Migration from 1.8v to 4v caused Insufficient funds error #6249)
• Missing blockHeaderSchema properties causing some properties to not appear in response of newHeads subscription (Add missing blockHeaderSchema properties #6243)
• Missing blockHeaderSchema properties causing some properties to not appear in response of newHeads subscription (Add missing blockHeaderSchema properties #6243)

web3-providers-ws

• Ensure a fixed version for "@types/ws": "8.5.3" (Ensure a fixed version for "@types/ws": "8.5.3" #6309)

Changed

web3-core

• No need to pass CommonSubscriptionEvents & at every child class of Web3Subscription (Enable Custom Event Subscription #6262)
• Implementation of _processSubscriptionResult and _processSubscriptionError has been written in the base class Web3Subscription and maid public. (Enable Custom Event Subscription #6262)
• A new optional protected method formatSubscriptionResult could be used to customize data formatting instead of re-implementing _processSubscriptionResult. (Enable Custom Event Subscription #6262)
• No more needed to pass CommonSubscriptionEvents & for the first generic parameter of Web3Subscription when inheriting from it. (Enable Custom Event Subscription #6262)

web3-eth

• MissingGasError error message changed for clarity (maxFeePerGas requirement in 4.x #6215)
• input and data are no longer auto populated for transaction objects if they are not present. Instead, whichever property is provided by the user is formatted and sent to the RPC provider. Transaction objects returned from RPC responses are still formatted to contain both input and data properties (Transaction input and data refactors #6294)

web3-eth-accounts

• Dependencies updated

web3-eth-contract

• Dependencies updated

web3-eth-ens

• Dependencies updated

web3-eth-iban

• Dependencies updated

web3-eth-personal

• Dependencies updated

web3-net

• Dependencies updated

web3-providers-http

• Dependencies updated

web3-providers-ipc

• Dependencies updated

web3-types

• input and data are now optional properties on PopulatedUnsignedBaseTransaction (previously input was a required property, and data was not available) (Transaction input and data refactors #6294)

web3-utils

• Dependencies updated

web3-validator

• Replace is-my-json-valid with zod dependency. Related code was changed (6156 find replacement for is my json valid #6264)
• Types ValidationError and JsonSchema were changed (6156 find replacement for is my json valid #6264)

Removed

web3-eth

• Missing blockHeaderSchema properties causing some properties to not appear in response of newHeads subscription (Add missing blockHeaderSchema properties #6243)
• Type RawValidationError was removed (6156 find replacement for is my json valid #6264)

web3-validator

• Type RawValidationError was removed (6156 find replacement for is my json valid #6264)

[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	653 KB	653 KB	0	0.00%

View detailed bundle breakdown

Added

No assets were added

Removed

No assets were removed

Bigger

No assets were bigger

Smaller

No assets were smaller

Unchanged

Asset	Old size	New size	Diff	Diff %
web3.min.js	635 KB	635 KB	0	0.00%
../lib/commonjs/index.d.ts	8.56 KB	8.56 KB	0	0.00%
../lib/commonjs/accounts.d.ts	3.67 KB	3.67 KB	0	0.00%
../lib/commonjs/types.d.ts	2.45 KB	2.45 KB	0	0.00%
../lib/commonjs/web3.d.ts	1.14 KB	1.14 KB	0	0.00%
../lib/commonjs/abi.d.ts	1000 bytes	1000 bytes	0	0.00%
../lib/commonjs/eth.exports.d.ts	280 bytes	280 bytes	0	0.00%
../lib/commonjs/providers.exports.d.ts	148 bytes	148 bytes	0	0.00%
../lib/commonjs/version.d.ts	60 bytes	60 bytes	0	0.00%

[cloudflare-workers-and-pages]

Deploying with    Cloudflare Pages

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

View logs

[codecov]

Codecov Report

Merging #6342 (af3bad1) into 4.x (51d087e) will not change coverage.
The diff coverage is 100.00%.

Additional details and impacted files

@@           Coverage Diff           @@
##              4.x    #6342   +/-   ##
=======================================
  Coverage   88.88%   88.88%           
=======================================
  Files         199      199           
  Lines        7717     7717           
  Branches     2124     2124           
=======================================
  Hits         6859     6859           
  Misses        858      858           

Flag	Coverage Δ
UnitTests	88.88% <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	∅ <ø> (∅)

[jdevcs]

Geth http tests are fixed in #6354 , and will be merged in to 4.x after release.