npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@theqrl/web3

v0.2.1

Published

Zond JavaScript API

Downloads

13

Readme

web3.js

ES Version Node Version NPM Package Downloads

This is the main package of web3.js.

web3 contains the ideal setup for a Web3.js package.

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

| Script | Description | | ---------------- | -------------------------------------------------- | | clean | Uses rimraf to remove dist/ | | build | Uses tsc to build package and dependent packages | | lint | Uses eslint to lint package | | lint:fix | Uses eslint to check and fix any warnings | | format | Uses prettier to format the code | | test | Uses jest to run unit tests | | test:integration | Uses jest to run tests under /test/integration | | test:unit | Uses 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.

| Package | Version | License | Docs | Description | | ------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | | web3 | npm | License: LGPL v3 | documentation | :rotating_light: 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 |