Socket
Socket
Sign inDemoInstall

web3

Package Overview
Dependencies
70
Maintainers
4
Versions
456
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    web3

Ethereum JavaScript API


Version published
Maintainers
4
Install size
16.4 MB
Created

Changelog

Source

[4.7.0]

added

web3-eth-contract
  • Types ContractDeploySend, ContractMethodSend, Web3PromiEvent was exported (#6883)
web3-eth-ens
  • Added function getText and getName in ENS and resolver classes (#6914)

fixed

web3-validator
  • Multi-dimensional arrays(with a fix length) are now handled properly when parsing ABIs (#6798)
web3-utils
  • fixed erroneous parsing of big numbers in the toNumber(...) function (#6880)

Readme

Source

web3.js

web3.js

ES Version Node Version NPM Package Downloads

This is the main package of web3.js, it contains a collection of comprehensive TypeScript libraries for Interaction with the Ethereum JSON RPC API and utility functions.

Features

  • Web3.js Plugins](https://docs.web3js.org/guides/web3_plugin_guide/): Enhance or add any functionality by creating scalable web3 plugins for any project.
  • Abstractions over the JSON-RPC API: Simplifying interaction for your Developer Experience.
  • Language aligned to the official [Ethereum terminology](https://ethereum.org/en/glossary
  • Tree-shaking focus: Include only what you need during bundling for optimized performance.
  • Dynamic contract types and full API in TypeScript: Enforced with strict types for enhanced security and safety.
  • Complete utilities and functionalities for all your Ethereum needs
  • More efficient ABI Encoder & Decoder
  • Extensive documentation with guides and APIs
  • Large collection of test cases
  • First-class APIs for interacting with [Smart Contracts](https://ethereum.org/en/glossary#smart-contract
  • ESM and CJS module builds: Support for both ECMAScript module and CommonJS module builds for flexible integration with various project setups.
  • Contracts dynamic types](https://docs.web3js.org/guides/smart_contracts/infer_contract_types/) & full API in TypeScript
  • Using native BigInt instead of large BigNumber libraries: Use native BigInt for improved efficiency compared to using large external BigNumber libraries.
  • Custom Output formatters: Format any returned value to be a string, number, BigInt, etc., providing flexibility in handling output data.

Installation

You can install the package either using NPM or using Yarn

Using NPM

npm install web3

Using Yarn

yarn add web3

Getting Started

Prerequisites

Migration Guide

  • Migration Guide from Web3.js 1.x to 4.x Breaking 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 in discord, and in case of any bug or new feature request open issue or create a pull request for contributions.

Package.json Scripts

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

Web3.js Packages

We encourage users to use only required individual packages listed in following table, for making lightweight application instead of importing main web3 package, and if you don't need functions from most of the packages that are implicitly included with main web3 package.

PackageVersionLicenseDocsDescription
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

Keywords

FAQs

Last updated on 26 Mar 2024

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc