Collection of comprehensive TypeScript libraries for Interaction with the Ethereum JSON RPC API and utility functions.
Installations
npm install web3-utilsDeveloper
Developer Guide
BETA
Module System
CommonJS, ESM
Min. Node Version
>=14
Typescript Support
Yes
Node Version
18.18.2
NPM Version
lerna/6.6.2/node@v18.18.2+x64 (darwin)
Statistics
19,382 Stars
4,073 Commits
4,973 Forks
461 Watching
202 Branches
297 Contributors
Updated on 28 Nov 2024
Languages
TypeScript (96.11%)
JavaScript (3.26%)
Shell (0.38%)
Solidity (0.16%)
HTML (0.07%)
Total Downloads
Cumulative downloads
Total Downloads
172,974,465
Last day
-6.5%
191,927
Compared to previous day
Last week
4.7%
1,185,624
Compared to previous week
Last month
4%
4,758,290
Compared to previous month
Last year
-4%
47,572,292
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Versions
Web3.js
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
1npm install web3
Using Yarn
1yarn add web3
Getting Started
- :writing_hand: If you have questions submit an issue or join us on Discord
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.
Useful links
Architecture Overview
| Package | Version | License | Docs | Description |
|---|---|---|---|---|
| web3 |  |  |  | :rotating_light: 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 in web3-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 |
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 |
Stable Version
The latest stable version of the package.
Stable Version
4.3.2
HIGH
2
HIGH
7.5/10
Summary
web3-utils Prototype Pollution vulnerability
Affected Versions
>= 4.0.1, < 4.2.1
Patched Versions
4.2.1
HIGH
7.5/10
Summary
Duplicate Advisory: web3-utils Prototype Pollution vulnerability
Affected Versions
< 4.2.1
Patched Versions
4.2.1
Reason
30 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 10
Reason
all changesets reviewed
Reason
no dangerous workflow patterns detected
Reason
security policy file detected
Details
- Info: security policy file detected: SECURITY.md:1
- Info: Found linked content: SECURITY.md:1
- Info: Found disclosure, vulnerability, and/or timelines in security policy: SECURITY.md:1
- Info: Found text in security policy: SECURITY.md:1
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Warn: project license file does not contain an FSF or OSI license.
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: jobLevel 'deployments' permission set to 'write': .github/workflows/build.yml:231
- Info: jobLevel 'contents' permission set to 'read': .github/workflows/build.yml:230
- Info: jobLevel 'contents' permission set to 'read': .github/workflows/deploy-docs.yaml:13
- Warn: jobLevel 'deployments' permission set to 'write': .github/workflows/deploy-docs.yaml:14
- Warn: no topLevel permission defined: .github/workflows/black_box_tests.yml:1
- Warn: no topLevel permission defined: .github/workflows/build.yml:1
- Warn: no topLevel permission defined: .github/workflows/canary_release.yml:1
- Warn: no topLevel permission defined: .github/workflows/deploy-docs.yaml:1
- Warn: no topLevel permission defined: .github/workflows/e2e_network_tests.yml:1
- Warn: no topLevel permission defined: .github/workflows/stale.yml:1
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/black_box_tests.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/web3/web3.js/black_box_tests.yml/4.x?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/black_box_tests.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/web3/web3.js/black_box_tests.yml/4.x?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/black_box_tests.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/web3/web3.js/black_box_tests.yml/4.x?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/black_box_tests.yml:43: update your workflow using https://app.stepsecurity.io/secureworkflow/web3/web3.js/black_box_tests.yml/4.x?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/black_box_tests.yml:46: update your workflow using https://app.stepsecurity.io/secureworkflow/web3/web3.js/black_box_tests.yml/4.x?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:103: update your workflow using https://app.stepsecurity.io/secureworkflow/web3/web3.js/build.yml/4.x?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:106: update your workflow using https://app.stepsecurity.io/secureworkflow/web3/web3.js/build.yml/4.x?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:112: update your workflow using https://app.stepsecurity.io/secureworkflow/web3/web3.js/build.yml/4.x?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:120: update your workflow using https://app.stepsecurity.io/secureworkflow/web3/web3.js/build.yml/4.x?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:127: update your workflow using https://app.stepsecurity.io/secureworkflow/web3/web3.js/build.yml/4.x?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:188: update your workflow using https://app.stepsecurity.io/secureworkflow/web3/web3.js/build.yml/4.x?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:191: update your workflow using https://app.stepsecurity.io/secureworkflow/web3/web3.js/build.yml/4.x?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:207: update your workflow using https://app.stepsecurity.io/secureworkflow/web3/web3.js/build.yml/4.x?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/build.yml:210: update your workflow using https://app.stepsecurity.io/secureworkflow/web3/web3.js/build.yml/4.x?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:212: update your workflow using https://app.stepsecurity.io/secureworkflow/web3/web3.js/build.yml/4.x?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/build.yml:219: update your workflow using https://app.stepsecurity.io/secureworkflow/web3/web3.js/build.yml/4.x?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:141: update your workflow using https://app.stepsecurity.io/secureworkflow/web3/web3.js/build.yml/4.x?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:145: update your workflow using https://app.stepsecurity.io/secureworkflow/web3/web3.js/build.yml/4.x?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/build.yml:152: update your workflow using https://app.stepsecurity.io/secureworkflow/web3/web3.js/build.yml/4.x?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:165: update your workflow using https://app.stepsecurity.io/secureworkflow/web3/web3.js/build.yml/4.x?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:168: update your workflow using https://app.stepsecurity.io/secureworkflow/web3/web3.js/build.yml/4.x?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:233: update your workflow using https://app.stepsecurity.io/secureworkflow/web3/web3.js/build.yml/4.x?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:234: update your workflow using https://app.stepsecurity.io/secureworkflow/web3/web3.js/build.yml/4.x?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:238: update your workflow using https://app.stepsecurity.io/secureworkflow/web3/web3.js/build.yml/4.x?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/build.yml:246: update your workflow using https://app.stepsecurity.io/secureworkflow/web3/web3.js/build.yml/4.x?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:259: update your workflow using https://app.stepsecurity.io/secureworkflow/web3/web3.js/build.yml/4.x?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:262: update your workflow using https://app.stepsecurity.io/secureworkflow/web3/web3.js/build.yml/4.x?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:269: update your workflow using https://app.stepsecurity.io/secureworkflow/web3/web3.js/build.yml/4.x?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/build.yml:275: update your workflow using https://app.stepsecurity.io/secureworkflow/web3/web3.js/build.yml/4.x?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/build.yml:293: update your workflow using https://app.stepsecurity.io/secureworkflow/web3/web3.js/build.yml/4.x?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:318: update your workflow using https://app.stepsecurity.io/secureworkflow/web3/web3.js/build.yml/4.x?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/web3/web3.js/build.yml/4.x?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/web3/web3.js/build.yml/4.x?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:29: update your workflow using https://app.stepsecurity.io/secureworkflow/web3/web3.js/build.yml/4.x?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:39: update your workflow using https://app.stepsecurity.io/secureworkflow/web3/web3.js/build.yml/4.x?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:42: update your workflow using https://app.stepsecurity.io/secureworkflow/web3/web3.js/build.yml/4.x?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:53: update your workflow using https://app.stepsecurity.io/secureworkflow/web3/web3.js/build.yml/4.x?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:56: update your workflow using https://app.stepsecurity.io/secureworkflow/web3/web3.js/build.yml/4.x?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:67: update your workflow using https://app.stepsecurity.io/secureworkflow/web3/web3.js/build.yml/4.x?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:70: update your workflow using https://app.stepsecurity.io/secureworkflow/web3/web3.js/build.yml/4.x?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:75: update your workflow using https://app.stepsecurity.io/secureworkflow/web3/web3.js/build.yml/4.x?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/canary_release.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/web3/web3.js/canary_release.yml/4.x?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/canary_release.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/web3/web3.js/canary_release.yml/4.x?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/deploy-docs.yaml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/web3/web3.js/deploy-docs.yaml/4.x?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/deploy-docs.yaml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/web3/web3.js/deploy-docs.yaml/4.x?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/deploy-docs.yaml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/web3/web3.js/deploy-docs.yaml/4.x?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/e2e_network_tests.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/web3/web3.js/e2e_network_tests.yml/4.x?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/e2e_network_tests.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/web3/web3.js/e2e_network_tests.yml/4.x?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/e2e_network_tests.yml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/web3/web3.js/e2e_network_tests.yml/4.x?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/e2e_network_tests.yml:46: update your workflow using https://app.stepsecurity.io/secureworkflow/web3/web3.js/e2e_network_tests.yml/4.x?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/e2e_network_tests.yml:49: update your workflow using https://app.stepsecurity.io/secureworkflow/web3/web3.js/e2e_network_tests.yml/4.x?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/stale.yml:10: update your workflow using https://app.stepsecurity.io/secureworkflow/web3/web3.js/stale.yml/4.x?enable=pin
- Warn: npmCommand not pinned by hash: .github/workflows/build.yml:268
- Warn: npmCommand not pinned by hash: .github/workflows/build.yml:218
- Info: 0 out of 45 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 7 third-party GitHubAction dependencies pinned
- Info: 0 out of 2 npmCommand dependencies pinned
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 30 are checked with a SAST tool
Reason
27 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j
- Warn: Project is vulnerable to: GHSA-4vvj-4cpr-p986
- Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
- Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-434g-2637-qmqr
- Warn: Project is vulnerable to: GHSA-49q7-c7j4-3p7m
- Warn: Project is vulnerable to: GHSA-977x-g7h5-7qgw
- Warn: Project is vulnerable to: GHSA-f7q4-pwc6-w24p
- Warn: Project is vulnerable to: GHSA-fc9h-whq2-v747
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-584q-6j8j-r5pm
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
- Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x
- Warn: Project is vulnerable to: GHSA-c7qv-q95q-8v27
- Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22
- Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp
- Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
- Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg
- Warn: Project is vulnerable to: GHSA-vx3p-948g-6vhq
- Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
- Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
- Warn: Project is vulnerable to: GHSA-3787-6prv-h9w3
- Warn: Project is vulnerable to: GHSA-9qxr-qj54-h672
- Warn: Project is vulnerable to: GHSA-m4v8-wqvr-p9f7
Score
5.5
/10
Last Scanned on 2024-11-25
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More