Collection of comprehensive TypeScript libraries for Interaction with the Ethereum JSON RPC API and utility functions.
getPastLogs accept blockHash as a parameter https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getlogs (#6181)Filter includes blockHash (#6206)numberToHex (#6206)r and s returned by signTransaction to does not always consist of 64 characters #6207" (#6216)Web3Context, Web3PluginBase, Web3EthPluginBase from 'web3-core', and Web3Validator from 'web3-validator' (#6165)SimpleProvider interface which has only request(args) method that is compatible with EIP-1193 (#6210)Eip1193EventName type that contains the possible events names according to EIP-1193 (#6210)EIP1193Provider class has now all the events (for on and removeListener) according to EIP-1193 (#6210)Web3.js 4.0.1 is written in TypeScript and has many exciting features such as:
Documentation:
Detailed List of changes are mentioned under:
If there are any bugs, improvements, optimizations or any new feature proposal feel free to create github issue, or post a pull request for contributions.
InvalidPropertiesForTransactionTypeError with error code 429 (#6102)getPastEvents method to filter allEvents and specific event (#6010)maxPriorityFeePerGas and maxFeePerGas in ContractOptions type and updated function using it in utils (#6118)filters param to the Filter type (#6010)JsonRpcSubscriptionResultOld, Web3ProviderMessageEventCallback. Added .on('data') type support for old providers (#6082)HardforksOrdered enum (#6102)Web3ValidationErrorObject type (#6102)hexstrict parameter added to numberToHex (#6004)ignoreGasPricing bug with wallet in context (#6071)Eip838ExecutionError constructor and the nested error is set at innerError (#6045)formatTransaction no longer throws a TransactionDataAndInputError if it's passed a transaction object with both data and input properties set (as long as they are the same value) (#6064)rpc_method_wrappers to point to the previously duplicated documentation found under the Web3Eth class documentation (#6054)defaultTransactionTypeParser to return correct EIP-2718 types, prior implementation was prioritizing transaction.hardfork and ignoring the use of transaction.gasLimit. defaultTransactionTypeParser will now throw InvalidPropertiesForTransactionTypeErrors for properties are used that are incompatible with transaction.type (#6102)prepareTransactionForSigning and defaultTransactionBuilder now accepts optional fillGasPrice flag and by default will not fill gas(#6071)Buffer for Uint8Array (#6004)recover, encrypt, privateKeyToAddress does not support type Buffer but supports type Uint8Array (#6004)parseAndValidatePrivateKey returns a type Uint8Array instead of type Buffer (#6004)FMT_BYTES.BUFFER, Bytes and FormatType and encryption option types for salt and iv has replaced support for Buffer for Uint8Array (#6004)internalType property to the AbiParameter type.hexToBytes, randomBytes does not return type Buffer but type Uint8Array (#6004)sha3 and keccak256Wrapper does not accept type Buffer but type Uint8Array (#6004)bytesToBuffer has been removed for the usage of bytesToUint8Array (#6004)Web3ValidationErrorObject type is now exported from web3-types package (#6102)web3-providers-http package to effectively propagate useful error infomation about failed HTTP connections (#5955)web.eth.handleRevert = true (#6000)transaction.type is now formatted to a hex string before being send to provider (#5979)transaction.type === '0x1' && transaction.accessList === undefined, then transaction.accessList is set to [] (#5979)chainId parameter from toChecksumAddress() function types (#5888)getPastEvents method to filter allEvents and specific event (#6015)web3-providers-http package to effectively propagate useful error infomation about failed HTTP connections (#5955)web.eth.handleRevert = true (#6000)transaction.type is now formatted to a hex string before being send to provider (#5979)transaction.type === '0x1' && transaction.accessList === undefined, then transaction.accessList is set to [] (#5979)chainId parameter from toChecksumAddress() function types (#5888)getPastEvents method to filter allEvents and specific event (#6015)net and fs modules (#5978)web3-providers-ipc and instantiate provider yourself (#5978)data property is passed to txInputOptionsFormatter, it will now be replaced with input (#5915)TransactionTypeParser and TransactionBuilder are now utilizing the type Transaction for the transaction object. (#5993)net and fs modules (#5978)web3-providers-ipc and instantiate provider yourself (#5978)gasLimit is no longer accepted as a parameter for MissingGasError and `TransactionGasMismatchError, and is also no longer included in error message (#5915)signTransaction will now return gas instead of gasLimit for returned transaction object regardless of what property name the provider uses (#5915)formatTransaction will now replace data transaction property with input (#5915)isTransactionCall will now check if value.input isHexStrict if provided (#5915)defaultTransactionBuilder and transactionBuilder are now utilizing the type Transaction for the transaction object. (#5993)signTransaction returned by privateKeyToAccount is now accepting the type Transaction for its argument. (#5993)getSendTxParams will now return input instead of data in returned transaction parameters object (#5915)Contract constructor will now thrown new ContractTransactionDataAndInputError if both data and input are passed in ContractInitOptions for Contract constructor (#5915)ContractInitOptions, NonPayableCallOptions and PayableCallOptions are moved to web3-types. (#5993)data property in TransactionOutput was renamed to input (#5915)signTransaction inside Web3BaseWalletAccount is now utilizing the type Transaction for its argument. (#5993)FMT_NUMBER, NumberTypes, FMT_BYTES, ByteTypes, DataFormat, DEFAULT_RETURN_FORMAT, ETH_DATA_FORMAT and FormatType moved from web3-utils. (#5993)ContractInitOptions, NonPayableCallOptions and PayableCallOptions are moved from web3-eth-contract. (#5993)FMT_NUMBER, NumberTypes, FMT_BYTES, ByteTypes, DataFormat, DEFAULT_RETURN_FORMAT, ETH_DATA_FORMAT and FormatType moved to web3-types. (#5993)input is now an acceptable property for ContractInitOptions in place of data (either can be used, but input is used withing the Contract class) (#5915)isHexString, isHexPrefixed, validateNoLeadingZeroes (#5963)getConfig method from Web3Config class, config is now public and accessible using Web3Config.config (#5950)formatDecodedObject function (#5934)data was removed as a property of ContractOptions type (#5915)checkNetwork in ENS (#5988)hexFormat param to getTransaction and getBlock that accepts the value 'hex' (#5845)utils.toNumber and utils.hexToNumber can now return the large unsafe numbers as BigInt, if true was passed to a new optional parameter called bigIntOnOverflow (#5845)registeredSubscriptions was added by default in web3 constructor (#5792)web3-types, web3-errors and web3. (#5771)new Web3().eth.contract (#5824)useRpcCallSpecification at enableExperimentalFeatures is true) (#5525)safe and finalized block tags (#5823)InvalidMethodParamsError and error code ERR_INVALID_METHOD_PARAMS = 207 (#5824)request property to ResponseError (#5854)data property to TransactionRevertInstructionError (#5854)TransactionRevertWithCustomError was added to handle custom solidity errors (#5854)createAccessList functionality ( #5780 )safe and finalized block tags (#5823)contractAbi option to SendTransactionOptions and SendSignedTransactionOptions to added the ability to parse custom solidity errors (#5854)decodeErrorData from web3-eth-contract is now exported from this package and was renamed to decodeContractErrorData (#5844)createAccessList for contracts ( #5780 )Contract will subscribeToContextEvents upon instantiation if syncWithContext is set to true and the constructor is passed an instance of Web3Context (#5833)safe and finalized block tags (#5823)HttpProvider (#5771)IpcProvider (#5771)_socketOptions from IpcProvider constructor to the underlying Socket (#5891)SocketConnection in IpcProvider (inherited from SocketProvider) returns net.Socket (#5891)WebSocketProvider (#5771)SocketConnection in WebSocketProvider (inherited from SocketProvider) returns isomorphic WebSocket (#5891)createAccessList functionality ( #5780 )safe and finalized block tags (#5823)web3-eth-abi and TypedArray from (#5771)TypedArray from web3-utils and web3-validator (it was defined twice) (#5771)safe and finalized block tags in BlockTags and BlockTag types (#5823)safe and finalized block tags (#5823)safe and finalized block tags in isBlockTag method (#5823)require('web3') will now return all web3 exported-objects organized in namespaces . (#5771)Web3Error is renamed to BaseWeb3Error (#5771)MaxAttemptsReachedOnReconnectingError with the same message for 1.x but also adding the maxAttempts (#5894)sendTransaction and sendSignedTransaction now errors with (and error event emits) the following possible errors: TransactionRevertedWithoutReasonError, TransactionRevertInstructionError, TransactionRevertWithCustomError, InvalidResponseError, or ContractExecutionError (#5854)compareBlockNumbers function now only supports comparison of both blocktags params ( except earliest vs number) or both block number params (#5842)SocketProvider abstract class now resolves JSON RPC response errors instead of rejecting them (#5844)SocketConnection in SocketProvider (#5891)_contracts:Contract[] and static setProvider function was removed (#5792)getRevertReason is no longer exported (#5844)web3-types (#5771)decodeErrorData is no longer exported (method was moved to web3-eth-abi and renamed decodeContractErrorData) (#5844)TypedArray to web3-types (was also duplicated at web3-validator) (#5771)genesis tag in compareBlockNumbers function (#5823)TypedArray to web3-types (was also duplicated at web3-utils) (#5771)hexFormat param to getTransaction and getBlock that accepts the value 'hex' (#5845)utils.toNumber and utils.hexToNumber can now return the large unsafe numbers as BigInt, if true was passed to a new optional parameter called bigIntOnOverflow (#5845)