2020-06-12 10:38:55 +03:00
|
|
|
_section: Documentation @<documentation>
|
2019-08-21 08:53:47 +03:00
|
|
|
|
2020-06-12 10:38:55 +03:00
|
|
|
_subsection: What is Ethers? @<preamble>
|
2019-08-21 08:53:47 +03:00
|
|
|
|
|
|
|
|
The ethers.js library aims to be a complete and compact library for
|
|
|
|
|
interacting with the Ethereum Blockchain and its ecosystem. It was
|
2020-02-02 15:58:29 +03:00
|
|
|
originally designed for use with [ethers.io](link-ethersio) and
|
2019-08-21 08:53:47 +03:00
|
|
|
has since expanded into a much more general-purpose library.
|
|
|
|
|
|
2020-06-12 10:38:55 +03:00
|
|
|
_subsection: Features @<features>
|
2019-08-21 08:53:47 +03:00
|
|
|
|
|
|
|
|
- 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
|
2020-02-02 15:58:29 +03:00
|
|
|
[JSON-RPC](link-jsonrpc), [INFURA](link-infura),
|
|
|
|
|
[Etherscan](link-etherscan), [Alchemy](link-alchemy),
|
|
|
|
|
[Cloudflare](link-cloudflare) or [MetaMask](link-metamask).
|
2019-08-21 08:53:47 +03:00
|
|
|
- **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
|
2020-02-02 15:58:29 +03:00
|
|
|
- Extensive [documentation](link-ethers-docs)
|
2019-08-21 08:53:47 +03:00
|
|
|
- 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
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
_subsection: Developer Documentation
|
|
|
|
|
|
|
|
|
|
_toc:
|
|
|
|
|
|
|
|
|
|
getting-started
|
|
|
|
|
concepts
|
|
|
|
|
api
|
2020-01-10 09:01:00 +03:00
|
|
|
cli
|
2019-08-21 08:53:47 +03:00
|
|
|
cookbook
|
|
|
|
|
migration
|
|
|
|
|
testing
|
|
|
|
|
contributing
|
|
|
|
|
documentation
|
|
|
|
|
license
|
2020-04-17 05:25:05 +03:00
|
|
|
|
2019-08-21 08:53:47 +03:00
|
|
|
|
2020-06-12 10:38:55 +03:00
|
|
|
_subsection: Legacy Documentation @<documentation--legacy>
|
2019-08-21 08:53:47 +03:00
|
|
|
|
|
|
|
|
This section will be kept up to date, linking to documentation of
|
|
|
|
|
older versions of the library.
|
|
|
|
|
|
2020-02-02 15:58:29 +03:00
|
|
|
- [version 4.0](link-legacy-docs4)
|
|
|
|
|
- [version 3.0](link-legacy-docs3)
|
