This repository was archived by the owner on Mar 5, 2025. It is now read-only.

web3/web3.jsPublic archive

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

You must be signed in to change notification settings

Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 4,082 Commits
.github		.github
.husky		.husky
assets/logo		assets/logo
config		config
docs		docs
fixtures		fixtures
packages		packages
scripts		scripts
templates		templates
tools		tools
.editorconfig		.editorconfig
.eslintrc.js		.eslintrc.js
.eslintrc.test.js		.eslintrc.test.js
.gitignore		.gitignore
.lintstagedrc.json		.lintstagedrc.json
.npmrc		.npmrc
.prettierignore		.prettierignore
.prettierrc.json		.prettierrc.json
CHANGELOG.md		CHANGELOG.md
FUNDING.json		FUNDING.json
LICENSE		LICENSE
README.md		README.md
RELEASE.md		RELEASE.md
REVIEW.md		REVIEW.md
SECURITY.md		SECURITY.md
codecov.yml		codecov.yml
hardhat.config.js		hardhat.config.js
jest.config.js		jest.config.js
lerna.json		lerna.json
package.json		package.json
tsconfig.base.json		tsconfig.base.json
tsdoc.json		tsdoc.json
verdaccio.yml		verdaccio.yml
webpack.base.config.js		webpack.base.config.js
yarn.lock		yarn.lock

Repository files navigation

Web3.js is a TypeScript implementation of theEthereum JSON RPC API and related tooling maintained byChainSafe Systems.

You can install the package either usingNPM or usingYarn

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

npm install web3

yarn add web3

Migration Guide from Web3.js 1.x to 4.xBreaking 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 inDiscord, and in case of any bug or new feature requestopen issue or create a pull request forcontributions.

Package	Version	License	Docs	Description
web3				🚨 Entire Web3.js offering (includes all packages)
web3-core				Core functions for web3.js packages
web3-errors				Errors Objects
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 package contained inweb3-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-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-rpc-methods				RPC Methods
web3-types				Shared useable types
web3-utils				Useful utility functions for Dapp developers
web3-validator				Utilities for validating objects

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