Complete Ethereum library and wallet implementation in JavaScript.
Installations
npm install @ethersproject/webReleases
ethers/v6.13.4 (2024-10-10 18:01)
Published on 12 Oct 2024
ethers/v6.13.3 (2024-09-30 22:08)
Published on 01 Oct 2024
ethers/v6.13.2 (2024-07-25 18:20)
Published on 25 Jul 2024
ethers/v6.13.1 (2024-06-18 02:37)
Published on 18 Jun 2024
ethers/v6.13.0 (2024-06-04 01:38)
Published on 04 Jun 2024
ethers/v6.12.2 (2024-05-30 17:24)
Published on 02 Jun 2024
Developer
Developer Guide
Module System
CommonJS, UMD
Min. Node Version
Typescript Support
Yes
Node Version
18.7.0
NPM Version
ethers-dist@0.0.1
Statistics
7,995 Stars
685 Commits
1,863 Forks
102 Watching
22 Branches
3 Contributors
Updated on 27 Nov 2024
Bundle Size
16.05 kB
Minified
5.89 kB
Minified + Gzipped
Languages
TypeScript (65.73%)
JavaScript (34.21%)
HTML (0.05%)
Total Downloads
Cumulative downloads
Total Downloads
141,889,229
Last day
-8.3%
178,560
Compared to previous day
Last week
6.9%
1,110,306
Compared to previous week
Last month
12.6%
4,331,744
Compared to previous month
Last year
-12.8%
42,641,506
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
The Ethers Project
A complete, compact and simple library for Ethereum and ilk, written in TypeScript.
Features
- Keep your private keys in your client, safe and sound
- Import and export JSON wallets (Geth, Parity and crowdsale)
- Import and export BIP 39 mnemonic phrases (12 word backup phrases) and HD Wallets (English as well as Czech, French, Italian, Japanese, Korean, Simplified Chinese, Spanish, Traditional Chinese)
- Meta-classes create JavaScript objects from any contract ABI, including ABIv2 and Human-Readable ABI
- Connect to Ethereum nodes over JSON-RPC, INFURA, Etherscan, Alchemy, Ankr or MetaMask
- ENS names are first-class citizens; they can be used anywhere an Ethereum addresses can be used
- Small (~144kb compressed; 460kb uncompressed)
- Tree-shaking focused; include only what you need during bundling
- Complete functionality for all your Ethereum desires
- Extensive documentation
- Large collection of test cases which are maintained and added to
- Fully written in TypeScript, with strict types for security and safety
- MIT License (including ALL dependencies); completely open source to do with as you please
Keep Updated
For advisories and important notices, follow @ethersproject on Twitter (low-traffic, non-marketing, important information only) as well as watch this GitHub project.
For more general news, discussions, and feedback, follow or DM me, @ricmoo on Twitter or on the Ethers Discord.
For the latest changes, see the CHANGELOG.
Summaries
- August 2023
- September 2022
- June 2022
- March 2022
- December 2021
- September 2021
- May 2021
- March 2021
- December 2020
Installing
NodeJS
/home/ricmoo/some_project> npm install ethers
Browser (ESM)
The bundled library is available in the ./dist/ folder in this repo.
<script type="module">
import { ethers } from "./dist/ethers.min.js";
</script>
Documentation
Browse the documentation online:
Providers
Ethers works closely with an ever-growing list of third-party providers to ensure getting started is quick and easy, by providing default keys to each service.
These built-in keys mean you can use ethers.getDefaultProvider() and
start developing right away.
However, the API keys provided to ethers are also shared and are intentionally throttled to encourage developers to eventually get their own keys, which unlock many other features, such as faster responses, more capacity, analytics and other features like archival data.
When you are ready to sign up and start using for your own keys, please check out the Provider API Keys in the documentation.
A special thanks to these services for providing community resources:
Extension Packages
The ethers package only includes the most common and most core
functionality to interact with Ethereum. There are many other
packages designed to further enhance the functionality and experience.
- MulticallProvider - A Provider which bundles multiple call requests into a single
callto reduce latency and backend request capacity - MulticoinPlugin - A Provider plugin to expand the support of ENS coin types
- GanaceProvider - A Provider for in-memory node instances, for fast debugging, testing and simulating blockchain operations
- Optimism Utilities - A collection of Optimism utilities
- LedgerSigner - A Signer to interact directly with Ledger Hardware Wallets
License
MIT License (including all dependencies).
No vulnerabilities found.
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
7 commit(s) and 7 issue activity found in the last 90 days -- score normalized to 10
Reason
license file detected
Details
- Info: project has a license file: LICENSE.md:0
- Info: FSF or OSI recognized license: MIT License: LICENSE.md:0
Reason
no binaries found in the repo
Reason
1 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
Reason
dependency not pinned by hash detected -- score normalized to 2
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/generate-docs.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/ethers-io/ethers.js/generate-docs.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/generate-docs.yml:27: update your workflow using https://app.stepsecurity.io/secureworkflow/ethers-io/ethers.js/generate-docs.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/generate-docs.yml:41: update your workflow using https://app.stepsecurity.io/secureworkflow/ethers-io/ethers.js/generate-docs.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test-browser.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/ethers-io/ethers.js/test-browser.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/test-browser.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/ethers-io/ethers.js/test-browser.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test-browser.yml:37: update your workflow using https://app.stepsecurity.io/secureworkflow/ethers-io/ethers.js/test-browser.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test-ci.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/ethers-io/ethers.js/test-ci.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/test-ci.yml:38: update your workflow using https://app.stepsecurity.io/secureworkflow/ethers-io/ethers.js/test-ci.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test-ci.yml:41: update your workflow using https://app.stepsecurity.io/secureworkflow/ethers-io/ethers.js/test-ci.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test-ci.yml:67: update your workflow using https://app.stepsecurity.io/secureworkflow/ethers-io/ethers.js/test-ci.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/test-ci.yml:72: update your workflow using https://app.stepsecurity.io/secureworkflow/ethers-io/ethers.js/test-ci.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test-ci.yml:75: update your workflow using https://app.stepsecurity.io/secureworkflow/ethers-io/ethers.js/test-ci.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test-ci.yml:87: update your workflow using https://app.stepsecurity.io/secureworkflow/ethers-io/ethers.js/test-ci.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test-ci.yml:96: update your workflow using https://app.stepsecurity.io/secureworkflow/ethers-io/ethers.js/test-ci.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/test-ci.yml:102: update your workflow using https://app.stepsecurity.io/secureworkflow/ethers-io/ethers.js/test-ci.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test-env.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/ethers-io/ethers.js/test-env.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test-env.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/ethers-io/ethers.js/test-env.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/test-env.yml:45: update your workflow using https://app.stepsecurity.io/secureworkflow/ethers-io/ethers.js/test-env.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test-env.yml:66: update your workflow using https://app.stepsecurity.io/secureworkflow/ethers-io/ethers.js/test-env.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test-env.yml:71: update your workflow using https://app.stepsecurity.io/secureworkflow/ethers-io/ethers.js/test-env.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/test-env.yml:79: update your workflow using https://app.stepsecurity.io/secureworkflow/ethers-io/ethers.js/test-env.yml/main?enable=pin
- Warn: npmCommand not pinned by hash: .github/workflows/generate-docs.yml:36
- Warn: npmCommand not pinned by hash: .github/workflows/test-env.yml:83
- Warn: npmCommand not pinned by hash: .github/workflows/test-env.yml:49
- Info: 0 out of 14 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 7 third-party GitHubAction dependencies pinned
- Info: 4 out of 7 npmCommand dependencies pinned
Reason
Found 0/30 approved changesets -- score normalized to 0
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/generate-docs.yml:1
- Warn: no topLevel permission defined: .github/workflows/test-browser.yml:1
- Warn: no topLevel permission defined: .github/workflows/test-ci.yml:1
- Warn: no topLevel permission defined: .github/workflows/test-env.yml:1
- Info: no jobLevel write permissions found
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
no SAST tool detected
Details
- Warn: no pull requests merged into dev branch
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'main'
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Score
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