ethers 's direct dependencies. Data on all dependencies, including transitive ones, is available via CSV download.| Name | Version | Size | License | Type | Vulnerabilities |
|---|---|---|---|---|---|
| @adraffy/ens-normalize | 1.9.2 | 210.59 kB | MIT | prod | |
| @noble/hashes | 1.1.2 | 47.42 kB | MIT | prod | |
| @noble/secp256k1 | 1.7.1 | 27.33 kB | MIT | prod | |
| @types/node | 18.15.13 | 656.76 kB | MIT | prod | |
| aes-js | 4.0.0-beta.5 | 388.32 kB | MIT | prod | |
| tslib | 2.4.0 | 9.85 kB | 0BSD | prod | |
| ws | 8.5.0 | 30.13 kB | MIT | prod |
Ethers is a comprehensive, compact, and easy-to-use library dedicated for Ethereum. It facilitates secure client-side private key handling and offers several other features. These include the ability to import and export JSON wallets (compatible with Geth, Parity, and crowdsale), import and export BIP 39 mnemonic phrases and HD Wallets, and create JavaScript objects from any contract ABI (including ABIv2 and Human-Readable ABI). Furthermore, Ethers enables connection to Ethereum nodes over various protocols such as JSON-RPC, INFURA, Etherscan, Alchemy, Ankr, or MetaMask. ENS names are treated as first-class citizens, the library is focused on tree-shaking, ensuring only the necessary parts are bundled. Lastly, Ethers offers complete Ethereum functionality, extensive documentation, and an open-source MIT License guaranteeing freedom of use.
Ethers can be easily installed and used in your project. For NodeJS you can install it via npm:
npm install ethers
For the browser (ESM), the bundled library is available in the ./dist/ folder within the GitHub repository. Import the library in your script as shown below:
<script type="module">
import { ethers } from "./dist/ethers.min.js";
</script>
Ethers works closely with third-party providers. You can start development right away using ethers.getDefaultProvider(). For your own keys which unlock many other features, refer to the Provider API Keys section in the official documentation. It's worthy to note that the ethers package only includes the essential functionality to interact with Ethereum. There are other additional packages designed to further enhance its functionality and experience.
The official documentation for Ethers is available online. It provides a comprehensive guide that includes a Getting Started section, Full API Documentation, and various articles on Ethereum. To explore more about the latest changes, you can refer to the CHANGELOG section on the GitHub project page. Lastly, for advisories and important notices, you can follow the Ethers project on Twitter or watch the GitHub project.
