Docs  » What is ethers.

js

What is ethers.js
The ethers.js library aims to be a complete and compact library for interac ng with the Ethereum
Blockchain and its ecosystem. It was originally designed for use with ethers.io and has since
expanded into a much more general‑purpose library.

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, Italian, Japanese, Korean, Simplified Chinese, Tradi onal Chinese; more coming
soon)
Meta‑classes create JavaScript objects from any contract ABI, including ABIv2 and
Human‑Readable ABI
Connect to Ethereum nodes over JSON‑RPC, INFURA, Etherscan, or MetaMask.
ENS names are first‑class ci zens; they can be used anywhere an Ethereum addresses
can be used
Tiny (~88kb compressed; 284kb uncompressed)
Complete func onality for all your Ethereum needs
Extensive documenta on
Large collec on of test cases which are maintained and added to
Fully TypeScript ready, with defini on files and full TypeScript source
MIT License (including ALL dependencies); completely open source to do with as you
please

Developer Documentation
Ge ng Started
Installing in Node.js
Impor ng
Including in Web Applica ons
Applica on Programming Interface (API)
Wallets and Signers
Wallet
 Signer API
Providers
Connec ng to Ethereum
Proper es
Network
Account
Blockchain Status
Ethereum Naming Service
Contract Execu on
Contract State
Events
Objects and Types
Provider Specific Extra API Calls
Contracts
Deploying a Contract
Connec ng to Exis ng Contracts
Meta‑Class Proper es
Overrides
Event Emi er
Providers vs Signers
Types
Filtering Events
Applica on Binary Interface (ABI)
U li es
Addresses
Arrayish
Big Numbers
Bytes32 Strings
Constants
Cryptographic Func ons
Ether Strings and Wei
Hex Strings
Namehash
Signatures
Transac ons
UTF‑8 Strings
Web
Low‑Level API
ABI Coder
HDNode
Interface
Provider (Sub‑Classing)
 Recursive‑Length Prefixed Encoding (RLP)
Signing Key
Cookbook
Accounts
Dump All JSON Wallet Balances (in current directory)
Sweep an Account into Another
Coalesce Jaxx Wallets
Access Funds in a Mnemonic Phrase Wallet
Random Mnemonic
Get Transac on History
Contracts
Return a Value from a State‑Changing Method
Economic Incen ves and Economic Value
Providers
MetaMask
TestRPC / Ganache
Custom Provider
Signing Messages
Signing a String Message
Signing a Digest Hash
Tes ng
Contract Events
Using Mul ple Accounts
React Na ve
Shims
Wordlists
Other Notes
Migra on Guides
Migra ng from Web3 to ethers v4
Migra ng from ethers v3 to ethers v4
Constants
Deploying Contracts
Encrypted Wallets
Events
Fetching JSON
Interfaces
Networks
Parsing Transac ons
Custom Signer
Default Provider
Big Number
JsonRpcProvider
 Verifying Messages
Wai ng for Transac ons
Notes
Why can’t I just use numbers?
Promises
Checksum Address
ICAP Address
Supported Pla orms
Contribu ng
Security
The GitHub and NPM Package
Memory Hard Brute‑Force Encrpy ng
Responsible Disclosure
Tes ng

Legacy Documentation
For documenta on of older versions, we will keep a list here.

version 3.0