Web3.js

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

Get it from the NPM Registry:

yarn add web3

Getting Started

• ✍️ If you have questions submit an issue or join us on Discord

Prerequisites

• ⚙️ NodeJS (LTS/Fermium)
• 🧰 Yarn/Lerna

Architecture Overview

Package	Version	License	Docs	Description
web3				🚨 Entire Web3.js offering (includes all packages)
web3-common				Common data structures and interfaces
web3-core				Core functions for web3.js packages
web3-eth				Modules to interact with the Ethereum blockchain and smart contracts
web3-eth-abi				Functions for encoding and decoding EVM in/output
web3-eth-accounts				Functions for managing Ethereum accounts and signing
web3-eth-contract				The contract pacakge contained in web3-eth
web3-eth-ens				Functions for interacting with the Ethereum Name Service
web3-eth-iban				Functionality for converting Ethereum addressed to IBAN addressed and vice versa
web3-eth-personal				Module to interact with the Ethereum blockchain accounts stored in the node
web3-eth-tx				@ethereumjs/tx wrapper class
web3-net				Functions to interact with an Ethereum node's network properties
web3-providers-http				Web3.js provider for the HTTP protocol
web3-providers-ipc				Web3.js provider for IPC
web3-providers-ws				Web3.js provider for the Websocket protocol
web3-utils				Useful utility functions for Dapp developers
web3-validator				Utilities for validating objects

Package.json Scripts

Script	Description
clean	Uses rimraf to remove dist/
build	Uses tsc to build all packages
lint	Uses eslint to lint all packages
lint:fix	Uses eslint to check and fix any warnings
format	Uses prettier to format the code
test	Uses jest to run unit tests in each package
test:integration	Uses jest to run tests under /test/integration in each package
test:unit	Uses jest to run tests under /test/unit in each package