All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
Web3EthExecutionAPI
export (#5441)Web3NetAPI
export (#5441)EthPersonalAPI
export (#5441)
Web3APISpec
,Web3APIMethod
, andWeb3APIParams
now supportsunknown
APIs (#5393)
- These types were moved from
web3-eth-accounts
toweb3-types
package: Cipher, CipherOptions, ScryptParams, PBKDF2SHA256Params, KeyStore (#5581 )
- Make the
request
method ofEIP1193Provider
class, compatible with EIP 1193 (#5591)
tsc
compiled files moved tolib/
directory fromdist/
(#5739)- These types were added: ProviderRpcError, EthSubscription, ProviderMessage, ProviderConnectInfo (#5683)
- Add
TransactionWithFromLocalWalletIndex
,TransactionWithToLocalWalletIndex
andTransactionWithFromAndToLocalWalletIndex
types (#5731)
- Added types from
web3-eth-abi
andTypedArray
from (#5771) - Added
TypedArray
fromweb3-utils
andweb3-validator
(it was defined twice) (#5771) - Added
safe
andfinalized
block tags inBlockTags
andBlockTag
types (#5823)
- Added hybrid build (ESM and CJS) of library (#5904)
- Added source files (#5956)
data
property inTransactionOutput
was renamed toinput
(#5915)- The method
signTransaction
insideWeb3BaseWalletAccount
is now utilizing the typeTransaction
for its argument. (#5993) - The types
FMT_NUMBER
,NumberTypes
,FMT_BYTES
,ByteTypes
,DataFormat
,DEFAULT_RETURN_FORMAT
,ETH_DATA_FORMAT
andFormatType
moved fromweb3-utils
. (#5993) - The types
ContractInitOptions
,NonPayableCallOptions
andPayableCallOptions
are moved fromweb3-eth-contract
. (#5993)
- Added
filters
param to theFilter
type (#6010) - Added types
JsonRpcSubscriptionResultOld
,Web3ProviderMessageEventCallback
. Added.on('data')
type support for old providers (#6082) - Export for
HardforksOrdered
enum (#6102) - Export for
Web3ValidationErrorObject
type (#6102)
- Removed chainId, to, data & input properties from NonPayableCallOptions
- Replaced Buffer for Uint8Array (#6004)
- types
FMT_BYTES.BUFFER
,Bytes
andFormatType
and encryption option types forsalt
andiv
has replaced support forBuffer
forUint8Array
(#6004) - Added
internalType
property to theAbiParameter
type.
Release Notes:
Detailed List of change logs are mentioned under previous 1.x alpha and RC releases.
Documentation: Web3.js documentation Web3 API Migration Guide from 1.x
- Added the
SimpleProvider
interface which has onlyrequest(args)
method that is compatible with EIP-1193 (#6210) - Added the
Eip1193EventName
type that contains the possible events names according to EIP-1193 (#6210)
- The
EIP1193Provider
class has now all the events (foron
andremoveListener
) according to EIP-1193 (#6210)
- Fixed bug #6185, now web3.js compiles on typescript v5 (#6195)
- type
Filter
includesblockHash
(#6206)
input
anddata
are now optional properties onPopulatedUnsignedBaseTransaction
(previouslyinput
was a required property, anddata
was not available) (#6294)
eth_signTypedData
andeth_signTypedData_v4
toweb3_eth_execution_api
(#6286)Eip712TypeDetails
andEip712TypedData
toeth_types
(#6286)
- Dependencies updated
- add
asEIP1193Provider
toWeb3BaseProvider
so every inherited class can have the returned value ofrequest
method, fully compatible with EIP-1193. (#6407)
- Interface
EventLog
was added. (#6410)
- Interface
MetaMaskProvider
added and is part ofSupportedProviders
(#6534) gasPrice
was added toTransaction1559UnsignedAPI
type. (#6539)
- Adds missing exported type
AbiItem
from 1.x to v4 for compatabiltiy (#6678)
- Type
FeeData
to be filled byawait web3.eth.calculateFeeData()
to be used with EIP-1559 transactions (#6795)
- Added
signature
to typeAbiFunctionFragment
(#6922) - update type
Withdrawals
,block
andBlockHeaderOutput
to include properties of eip 4844, 4895, 4788 (#6933)
- Added
result
as optionalnever
anderror
as optionalnever in type
JsonRpcNotification` (#7091) - Added
JsonRpcNotfication
as a union type inJsonRpcResponse
(#7091)
- Add COMMITTED to BlockTags (#7124)
- update the type for
baseFeePerGas
atweb3.eth.getFeeHistory
to be a number. (#7291)
FilterParams
type added (#7353)
- Add signature related types. (#7374)