History

Richard Moore 184c459fab Updating docs.		2019-12-13 22:05:10 -05:00
..
api	Updating docs.	2019-12-13 22:05:10 -05:00
concepts	Updating docs.	2019-12-13 22:05:10 -05:00
contributing	Updating docs.	2019-12-13 22:05:10 -05:00
cookbook	Updating docs.	2019-12-13 22:05:10 -05:00
documentation	Updating docs.	2019-12-13 22:05:10 -05:00
getting-started	Updating docs.	2019-12-13 22:05:10 -05:00
hacking	Updating docs.	2019-12-13 22:05:10 -05:00
license	Updating docs.	2019-12-13 22:05:10 -05:00
migration	Updating docs.	2019-12-13 22:05:10 -05:00
static	Updating docs.	2019-12-13 22:05:10 -05:00
testing	Updating docs.	2019-12-13 22:05:10 -05:00
index.html	Updating docs.	2019-12-13 22:05:10 -05:00
README.md	Updating docs.	2019-12-13 22:05:10 -05:00

README.md

Documentation: html

What is ethers?

The ethers.js library aims to be a complete and compact library for interacting 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, Traditional 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, Nodesmith, Alchemy, or MetaMask.
ENS names are first-class citizens; they can be used anywhere an Ethereum addresses can be used
Tiny (~88kb compressed; 284kb uncompressed)
Complete functionality for all your Ethereum needs
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

Developer Documentation

Legacy Documentation

This section will be kept up to date, linking to documentation of older versions of the library.

Content Hash: f1da4df3feeb06a567657ae41d8498ea3315f68d05dc2f9e86c2858b5d2b2f89