The Ethers Project

A complete Ethereum wallet implementation and utilities in JavaScript (and 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
• Tiny (~104kb compressed; 322kb uncompressed)
• Modular packages; include only what you need
• Complete functionality for all your Ethereum desires
• Extensive documentation
• Large collection of test cases which are maintained and added to
• Fully TypeScript ready, with definition files and full TypeScript source
• MIT License (including ALL dependencies); completely open source to do with as you please

Keep Updated

For the latest news and advisories, please follow the @ethersproject on Twitter (low-traffic, non-marketing, important information only) as well as watch this GitHub project.

For the latest changes, see the CHANGELOG.

Installing

node.js

/home/ricmoo/some_project> npm install --save ethers

browser (UMD)

<script src="https://cdn.ethers.io/lib/ethers-5.6.umd.min.js" type="text/javascript">
</script>

browser (ESM)

<script type="module">
    import { ethers } from "https://cdn.ethers.io/lib/ethers-5.6.esm.min.js";
</script>

Documentation

Browse the documentation online:

• Getting Started
• Full API Documentation
• Various Ethereum Articles

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:

• Ankr
• Etherscan
• INFURA
• Alchemy
• Pocket

Ancillary Packages

These are a number of packages not included in the umbrella ethers npm package, and additional packages are always being added. Often these packages are for specific use-cases, so rather than adding them to the umbrella package, they are added as ancillary packages, which can be included by those who need them, while not bloating everyone else with packages they do not need.

We will keep a list of useful packages here.

• @ethersproject/experimental (documentation)
• @ethersproject/cli (documentation)
• @ethersproject/hardware-wallets (documentation)

License

MIT License (including all dependencies).