README

Web3.js

 Web3.js libraries are being sunset on March 4th, 2025. For migration guides and more details please refer to Chainsafe blog

[![Dependency Status][downloads-image]][npm-url] !Unit Test Coverage
!Commit Activity
!Contributors

!ES Version
!Node Version

Web3.js is a TypeScript implementation of the Ethereum JSON RPC API and related tooling maintained by ChainSafe Systems.

 Installation

You can install the package either using NPM or using Yarn

 If you wanna checkout latest bugfix or feature, use npm install web3@dev

 Using NPM

bash
npm install web3


 Using Yarn

bash
yarn add web3


 Getting Started

-   :writing_hand: If you have questions submit an issue or join us on Discord
    !Discord

 Prerequisites

-   :gear: NodeJS (LTS/Fermium)
-   :toolbox: Yarn/Lerna

 Migration Guide

-   Migration Guide from Web3.js 1.x to 4.x
    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 or create a pull request for contributions.

 Useful links

-   Web3 tree shaking support guide
-   React App Example

 Architecture Overview

| Package                                                                                           | Version                                                                                                                                                                           | License                                                                                                               | Docs                                                                                                           | Description                                                                                                   |
| ------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
| web3                               |                                |  |                 | :rotating_light: Entire Web3.js offering (includes all packages)                                              |
| web3-core                     |                      |  |            | Core functions for web3.js packages                                                                           |
| web3-errors                 |                    |  |          | Errors Objects