ethers.js/README.md
2017-04-05 16:56:41 -04:00

1.5 KiB

ethers.js

npm version

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, INFURA or Etherscan
  • Tiny (~77kb compressed; 227kb uncompressed)
  • Complete functionality for all your Ethereum needs
  • Extensive documentation
  • MIT License (including ALL dependencies); completely open source to do with as you please

Installing

To use in a browser:

<script type="text/javascript" src="https://cdn.ethers.io/scripts/ethers-2.0.min.js">
</script>

To use in node.js:

/Users/ethers/my-app> npm install --save ethers

Documentation

Browse the API Documentation online.

Documentation is generated using Sphinx and can be browsed locally from the /docs/build/html directory.

License

Completely MIT Licensed. Including ALL dependencies.