What is this?
A collection of TypeScript libraries for talking to the Ethereum blockchain through its JSON RPC API, plus utility functions for Dapp developers. It was maintained by ChainSafe Systems.
A collection of TypeScript libraries for talking to the Ethereum blockchain through its JSON RPC API, plus utility functions for Dapp developers. It was maintained by ChainSafe Systems.Is it one big library or a set of separate packages?A monorepo of about 17 packages: the umbrella 'web3' package bundles everything, while focused ones like web3-eth, web3-eth-contract and web3-utils can be used alone. HTTP, IPC and WebSocket connection providers are separate packages too.
A monorepo of about 17 packages: the umbrella 'web3' package bundles everything, while focused ones like web3-eth, web3-eth-contract and web3-utils can be used alone. HTTP, IPC and WebSocket connection providers are separate packages too.How do I add it to a project?Run 'npm install web3' or the Yarn equivalent; to pick up the latest fixes use 'npm install web3@dev'.
Run 'npm install web3' or the Yarn equivalent; to pick up the latest fixes use 'npm install web3@dev'.What do I need installed before I can use it?Node.js is required — the code targets Node >= 14, and the README suggests an LTS release such as Fermium. Yarn and Lerna are listed as prerequisites too, but only matter if you build the monorepo yourself.
Node.js is required — the code targets Node >= 14, and the README suggests an LTS release such as Fermium. Yarn and Lerna are listed as prerequisites too, but only matter if you build the monorepo yourself.Is Web3.js still actively developed?No — the libraries are being sunset on March 4th, 2025 and the GitHub repository is archived, so expect no further updates. The ChainSafe blog has the announcement and migration guides.
No — the libraries are being sunset on March 4th, 2025 and the GitHub repository is archived, so expect no further updates. The ChainSafe blog has the announcement and migration guides.I learned from old tutorials that use the 1.x API — will that code still work?Not unchanged: the 4.x release introduced breaking changes, and the repo ships a migration guide that walks through them as a first step. For questions the README points to the project's Discord.
Not unchanged: the 4.x release introduced breaking changes, and the repo ships a migration guide that walks through them as a first step. For questions the README points to the project's Discord.What can I do with it besides sending transactions?The packages cover the full Dapp surface: ABI encoding and decoding of EVM inputs and outputs, account management and signing, smart contract interaction, Ethereum Name Service lookups, Ethereum-to-IBAN address conversion, plus validation and utility helpers.
The packages cover the full Dapp surface: ABI encoding and decoding of EVM inputs and outputs, account management and signing, smart contract interaction, Ethereum Name Service lookups, Ethereum-to-IBAN address conversion, plus validation and utility helpers.How does my app connect to an Ethereum node with it?Through pluggable providers shipped as separate packages: HTTP, IPC and WebSocket. The repo even has a manual test suite for keeping a long-lived WebSocket connection open.
Through pluggable providers shipped as separate packages: HTTP, IPC and WebSocket. The repo even has a manual test suite for keeping a long-lived WebSocket connection open.Can I use it in a browser app like React?Yes — the README links a React App Example and a tree-shaking guide so you only bundle the parts you import, and the build pipeline produces a dedicated web build.
Yes — the README links a React App Example and a tree-shaking guide so you only bundle the parts you import, and the build pipeline produces a dedicated web build.What are similar projects?sphere-sdk-connect-example, shardeum, ethereumbook, go-ethereum, multicoin-address-validator, robinhood-lp-bot, ethereum-sdk, truffle
sphere-sdk-connect-example, shardeum, ethereumbook, go-ethereum, multicoin-address-validator, robinhood-lp-bot, ethereum-sdk, truffleWhich topics is it in?rpc, ethereum, cryptocurrency, web3, blockchain, monorepo, websocket, deprecated, sdk, npm, api, nodejs
rpc, ethereum, cryptocurrency, web3, blockchain, monorepo, websocket, deprecated, sdk, npm, api, nodejs