Repository files navigation

A complete, compact and simple library for Ethereum and ilk, writteninTypeScript.

Features

• Keep your private keys in your client,safe and sound
• Import and exportJSON wallets (Geth, Parity and crowdsale)
• Import and export BIP 39mnemonic phrases (12 word backup phrases) andHD Wallets (English as well as Czech, French, Italian, Japanese, Korean, Simplified Chinese, Spanish, Traditional Chinese)
• Meta-classes create JavaScript objects from any contract ABI, includingABIv2 andHuman-Readable ABI
• Connect to Ethereum nodes overJSON-RPC,INFURA,Etherscan,Alchemy,Ankr orMetaMask
• 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
• Extensivedocumentation
• Large collection oftest cases which are maintained and added to
• Fully written inTypeScript, with strict types for security and safety
• MIT License (including ALL dependencies); completely open source to do with as you please

For advisories and important notices, follow@ethersprojecton 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 theEthers Discord.

For the latest changes, see theCHANGELOG.

Summaries

• August 2023
• September 2022
• June 2022
• March 2022
• December 2021
• September 2021
• May 2021
• March 2021
• December 2020

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>

Browse thedocumentation online:

• Getting Started
• Full API Documentation
• Various Ethereum Articles

Ethers works closely with an ever-growing list of third-party providersto ensure getting started is quick and easy, by providing default keysto each service.

These built-in keys mean you can useethers.getDefaultProvider() andstart developing right away.

However, the API keys provided to ethers are also shared and areintentionally throttled to encourage developers to eventually gettheir own keys, which unlock many other features, such as fasterresponses, more capacity, analytics and other features like archivaldata.

When you are ready to sign up and start using for your own keys, pleasecheck out theProvider API Keys inthe documentation.

A special thanks to these services for providing community resources:

• Ankr
• QuickNode
• Etherscan
• INFURA
• Alchemy

Theethers package only includes the most common and most corefunctionality to interact with Ethereum. There are many otherpackages designed to further enhance the functionality and experience.

• MulticallProvider - A Provider which bundles multiple call requests into a singlecall to 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

MIT License (includingall dependencies).