# web3.js   [![NPM Package][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] This is the main package of [web3.js](repo), it contains a collection of comprehensive [TypeScript](https://www.typescriptlang.org/) libraries for Interaction with the [Ethereum JSON RPC API](https://ethereum.org/developers/docs/apis/json-rpc) and utility functions. ## Features - **Web3.js Plugins](https://docs.web3js.org/guides/web3_plugin_guide/)**: Enhance or add any functionality by creating scalable web3 plugins for any project. - **Abstractions over the [JSON-RPC API](https://ethereum.org/en/developers/docs/apis/json-rpc)**: Simplifying interaction for your Developer Experience. - **Language aligned to the official [Ethereum terminology](https://ethereum.org/en/glossary** - **Tree-shaking focus**: Include only what you need during bundling for optimized performance. - **Dynamic contract types and full API in TypeScript**: Enforced with strict types for enhanced security and safety. - **Complete utilities and functionalities for all your Ethereum needs** - **More efficient ABI Encoder & Decoder** - **Extensive [documentation](https://docs.web3js.org/) with guides and APIs** - **Large collection of test cases** - **First-class APIs for interacting with [Smart Contracts](https://ethereum.org/en/glossary#smart-contract** - **ESM and CJS module builds**: Support for both ECMAScript module and CommonJS module builds for flexible integration with various project setups. - **Contracts dynamic types](https://docs.web3js.org/guides/smart_contracts/infer_contract_types/) & full API in TypeScript** - **Using native BigInt instead of large BigNumber libraries**: Use native BigInt for improved efficiency compared to using large external BigNumber libraries. - **Custom Output formatters**: Format any returned value to be a string, number, BigInt, etc., providing flexibility in handling output data. ## Installation You can install the package either using [NPM](https://www.npmjs.com/package/web3) or using [Yarn](https://yarnpkg.com/package/web3) ### Using NPM ```bash npm install web3 ``` ### Using Yarn ```bash yarn add web3 ``` ## Getting Started - :writing_hand: If you have questions [submit an issue](https://github.com/ChainSafe/web3.js/issues/new) or join us on [Discord](https://discord.gg/yjyvFRP)  ## Prerequisites - :gear: [NodeJS](https://nodejs.org/) (LTS/Fermium) - :toolbox: [Yarn](https://yarnpkg.com/)/[Lerna](https://lerna.js.org/) ## Migration Guide - [Migration Guide from Web3.js 1.x to 4.x](https://docs.web3js.org/docs/guides/web3_migration_guide) Breaking changes are listed in migration guide and its first step for migrating from Web3.js 1.x to 4.x. If there is any question or discussion feel free to ask in discord, and in case of any bug or new feature request [open issue](https://github.com/web3/web3.js/issues/new) or create a pull request for [contributions](https://github.com/web3/web3.js/blob/4.x/CONTRIBUTIONS.md). ## Package.json Scripts | Script | Description | | ---------------- | -------------------------------------------------- | | clean | Uses `rimraf` to remove `dist/` | | build | Uses `tsc` to build package and dependent packages | | lint | Uses `eslint` to lint package | | lint:fix | Uses `eslint` to check and fix any warnings | | format | Uses `prettier` to format the code | | test | Uses `jest` to run unit tests | | test:integration | Uses `jest` to run tests under `/test/integration` | | test:unit | Uses `jest` to run tests under `/test/unit` | ## Web3.js Packages We encourage users to use only required individual packages listed in following table, for making lightweight application instead of importing main web3 package, and if you don't need functions from most of the packages that are implicitly included with main web3 package. | Package | Version | License | Docs | Description | | ------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | | [web3](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3) | [](https://www.npmjs.com/package/web3) | [](https://www.gnu.org/licenses/lgpl-3.0) | [](https://docs.web3js.org/api/web3) | :rotating_light: Entire Web3.js offering (includes all packages) | | [web3-core](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-core) | [](https://www.npmjs.com/package/web3-core) | [](https://www.gnu.org/licenses/lgpl-3.0) | [](https://docs.web3js.org/api/web3-core) | Core functions for web3.js packages | | [web3-errors](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-errors) | [](https://www.npmjs.com/package/web3-core) | [](https://www.gnu.org/licenses/lgpl-3.0) | [](https://docs.web3js.org/api/web3-errors) | Errors Objects | | [web3-eth](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-eth) | [](https://www.npmjs.com/package/web3-eth) | [](https://www.gnu.org/licenses/lgpl-3.0) | [](https://docs.web3js.org/api/web3-eth) | Modules to interact with the Ethereum blockchain and smart contracts | | [web3-eth-abi](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-eth-abi) | [](https://www.npmjs.com/package/web3-eth-abi) | [](https://www.gnu.org/licenses/lgpl-3.0) | [](https://docs.web3js.org/api/web3-eth-abi) | Functions for encoding and decoding EVM in/output | | [web3-eth-accounts](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-eth-accounts) | [](https://www.npmjs.com/package/web3-eth-accounts) | [](https://www.gnu.org/licenses/lgpl-3.0) | [](https://docs.web3js.org/api/web3-eth-accounts) | Functions for managing Ethereum accounts and signing | | [web3-eth-contract](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-eth-contract) | [](https://www.npmjs.com/package/web3-eth-contract) | [](https://www.gnu.org/licenses/lgpl-3.0) | [](https://docs.web3js.org/api/web3-eth-contract) | The contract package contained in [web3-eth](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-eth) | | [web3-eth-ens](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-eth-ens) | [](https://www.npmjs.com/package/web3-eth-ens) | [](https://www.gnu.org/licenses/lgpl-3.0) | [](https://docs.web3js.org/api/web3-eth-ens) | Functions for interacting with the Ethereum Name Service | | [web3-eth-iban](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-eth-iban) | [](https://www.npmjs.com/package/web3-eth-iban) | [](https://www.gnu.org/licenses/lgpl-3.0) | [](https://docs.web3js.org/api/web3-eth-iban) | Functionality for converting Ethereum addressed to IBAN addressed and vice versa | | [web3-eth-personal](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-eth-personal) | [](https://www.npmjs.com/package/web3-eth-personal) | [](https://www.gnu.org/licenses/lgpl-3.0) | [](https://docs.web3js.org/api/web3-eth-personal) | Module to interact with the Ethereum blockchain accounts stored in the node | | [web3-net](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-net) | [](https://www.npmjs.com/package/web3-net) | [](https://www.gnu.org/licenses/lgpl-3.0) | [](https://docs.web3js.org/api/web3-net) | Functions to interact with an Ethereum node's network properties | | [web3-providers-http](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-providers-http) | [](https://www.npmjs.com/package/web3-providers-http) | [](https://www.gnu.org/licenses/lgpl-3.0) | [](https://docs.web3js.org/api/web3-providers-http) | Web3.js provider for the HTTP protocol | | [web3-providers-ipc](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-providers-ipc) | [](https://www.npmjs.com/package/web3-providers-ipc) | [](https://www.gnu.org/licenses/lgpl-3.0) | [](https://docs.web3js.org/api/web3-providers-ipc) | Web3.js provider for IPC | | [web3-providers-ws](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-providers-ws) | [](https://www.npmjs.com/package/web3-providers-ws) | [](https://www.gnu.org/licenses/lgpl-3.0) | [](https://docs.web3js.org/api/web3-providers-ws) | Web3.js provider for the Websocket protocol | | [web3-rpc-methods](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-rpc-methods) | [](https://www.npmjs.com/package/web3-types) | [](https://www.gnu.org/licenses/lgpl-3.0) | [](https://docs.web3js.org/api/) | RPC Methods | | [web3-types](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-types) | [](https://www.npmjs.com/package/web3-types) | [](https://www.gnu.org/licenses/lgpl-3.0) | [](https://docs.web3js.org/api/web3-types) | Shared useable types | | [web3-utils](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-utils) | [](https://www.npmjs.com/package/web3-utils) | [](https://www.gnu.org/licenses/lgpl-3.0) | [](https://docs.web3js.org/api/web3-utils) | Useful utility functions for Dapp developers | | [web3-validator](https://github.com/ChainSafe/web3.js/tree/4.x/packages/web3-validator) | [](https://www.npmjs.com/package/web3-validator) | [](https://www.gnu.org/licenses/lgpl-3.0) | [](https://docs.web3js.org/api/web3-validator) | Utilities for validating objects | [docs]: https://docs.web3js.org/ [repo]: https://github.com/web3/web3.js/tree/4.x/packages/web3 [npm-image]: https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3%2Fpackage.json [npm-url]: https://npmjs.org/package/web3 [downloads-image]: https://img.shields.io/npm/dm/web3?label=npm%20downloads