Web3.js: Ethereum JavaScript API

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


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

npm install web3

Using Yarn

yarn add web3

Getting Started


Migration Guide

Useful links

Architecture Overview

web3npmLicense: LGPL v3documentation:rotating_light: Entire Web3.js offering (includes all packages)
web3-corenpmLicense: LGPL v3documentationCore functions for web3.js packages
web3-errorsnpmLicense: LGPL v3documentationErrors Objects
web3-ethnpmLicense: LGPL v3documentationModules to interact with the Ethereum blockchain and smart contracts
web3-eth-abinpmLicense: LGPL v3documentationFunctions for encoding and decoding EVM in/output
web3-eth-accountsnpmLicense: LGPL v3documentationFunctions for managing Ethereum accounts and signing
web3-eth-contractnpmLicense: LGPL v3documentationThe contract package contained in web3-eth
web3-eth-ensnpmLicense: LGPL v3documentationFunctions for interacting with the Ethereum Name Service
web3-eth-ibannpmLicense: LGPL v3documentationFunctionality for converting Ethereum addressed to IBAN addressed and vice versa
web3-eth-personalnpmLicense: LGPL v3documentationModule to interact with the Ethereum blockchain accounts stored in the node
web3-netnpmLicense: LGPL v3documentationFunctions to interact with an Ethereum node's network properties
web3-providers-httpnpmLicense: LGPL v3documentationWeb3.js provider for the HTTP protocol
web3-providers-ipcnpmLicense: LGPL v3documentationWeb3.js provider for IPC
web3-providers-wsnpmLicense: LGPL v3documentationWeb3.js provider for the Websocket protocol
web3-rpc-methodsnpmLicense: LGPL v3documentationRPC Methods
web3-typesnpmLicense: LGPL v3documentationShared useable types
web3-utilsnpmLicense: LGPL v3documentationUseful utility functions for Dapp developers
web3-validatornpmLicense: LGPL v3documentationUtilities for validating objects

Package.json Scripts

cleanUses rimraf to remove dist/
buildUses tsc to build all packages
lintUses eslint to lint all packages
lint:fixUses eslint to check and fix any warnings
formatUses prettier to format the code
testUses jest to run unit tests in each package
test:integrationUses jest to run tests under /test/integration in each package
test:unitUses jest to run tests under /test/unit in each package

View on GitHub: https://github.com/web3/web3.js 

#solidity #smartcontract #blockchain #web3  #ethereum 

1 Likes1.05 GEEK