53 lines
1.5 KiB
Markdown
53 lines
1.5 KiB
Markdown
ethers.js
|
|
=========
|
|
|
|
[](https://badge.fury.io/js/ethers)
|
|
|
|
Complete Ethereum wallet implementation and utilities in JavaScript.
|
|
|
|
**Features:**
|
|
|
|
- Keep your private keys in your client, **safe** and sound
|
|
- Import and export **JSON wallets** (Geth and crowdsale) and brain wallets
|
|
- Import and export BIP 39 **mnemonic phrases** (12 word backup phrases) and **HD Wallets**
|
|
- Meta-classes create JavaScript objects from any contract ABI
|
|
- Connect to Ethereum nodes over [JSON-RPC](https://github.com/ethereum/wiki/wiki/JSON-RPC), [INFURA](https://infura.io) or [Etherscan](https://etherscan.io)
|
|
- **Tiny** (~77kb compressed; 227kb uncompressed)
|
|
- **Complete** functionality for all your Ethereum needs
|
|
- Extensive [documentation](https://docs.ethers.io/ethers.js/)
|
|
- **MIT License** (including ALL dependencies); completely open source to do with as you please
|
|
|
|
|
|
|
|
Installing
|
|
----------
|
|
|
|
To use in a browser:
|
|
|
|
```html
|
|
<script type="text/javascript" src="https://cdn.ethers.io/scripts/ethers-2.0.min.js">
|
|
</script>
|
|
```
|
|
|
|
To use in [node.js](https://nodejs.org/):
|
|
|
|
```
|
|
/Users/ethers/my-app> npm install --save ethers
|
|
```
|
|
|
|
|
|
|
|
Documentation
|
|
-------------
|
|
|
|
Browse the [API Documentation](https://docs.ethers.io/ethers.js/index.html) online.
|
|
|
|
Documentation is generated using [Sphinx](http://www.sphinx-doc.org) and can be browsed locally from the /docs/build/html directory.
|
|
|
|
|
|
|
|
License
|
|
-------
|
|
|
|
Completely MIT Licensed. Including ALL dependencies.
|