Skip to content
forked from web3/web3.js

Collection of comprehensive TypeScript libraries for Interaction with the Ethereum JSON RPC API and utility functions.

License

Notifications You must be signed in to change notification settings

18211308/web3.js

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

web3.js

Web3.js

Dependency Status 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

npm install web3

Using Yarn

yarn add web3

Getting Started

Prerequisites

Migration Guide

Useful links

Architecture Overview

Package Version License Docs Description
web3 npm License: LGPL v3 documentation 🚨 Entire Web3.js offering (includes all packages)
web3-core npm License: LGPL v3 documentation Core functions for web3.js packages
web3-errors npm License: LGPL v3 documentation Errors Objects
web3-eth npm License: LGPL v3 documentation Modules to interact with the Ethereum blockchain and smart contracts
web3-eth-abi npm License: LGPL v3 documentation Functions for encoding and decoding EVM in/output
web3-eth-accounts npm License: LGPL v3 documentation Functions for managing Ethereum accounts and signing
web3-eth-contract npm License: LGPL v3 documentation The contract package contained in web3-eth
web3-eth-ens npm License: LGPL v3 documentation Functions for interacting with the Ethereum Name Service
web3-eth-iban npm License: LGPL v3 documentation Functionality for converting Ethereum addressed to IBAN addressed and vice versa
web3-eth-personal npm License: LGPL v3 documentation Module to interact with the Ethereum blockchain accounts stored in the node
web3-net npm License: LGPL v3 documentation Functions to interact with an Ethereum node's network properties
web3-providers-http npm License: LGPL v3 documentation Web3.js provider for the HTTP protocol
web3-providers-ipc npm License: LGPL v3 documentation Web3.js provider for IPC
web3-providers-ws npm License: LGPL v3 documentation Web3.js provider for the Websocket protocol
web3-rpc-methods npm License: LGPL v3 documentation RPC Methods
web3-types npm License: LGPL v3 documentation Shared useable types
web3-utils npm License: LGPL v3 documentation Useful utility functions for Dapp developers
web3-validator npm License: LGPL v3 documentation 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
test:manual:long-connection-ws Runs manual tests for keeping a long WebSocket connection
test:manual Runs manual tests under test/manual in the web3 package

About

Collection of comprehensive TypeScript libraries for Interaction with the Ethereum JSON RPC API and utility functions.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 96.5%
  • JavaScript 2.9%
  • Other 0.6%