ethers.js/README.md

1.8 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
  • ENS names are first-class citizens; they can almost always used instead of Ethereum addresses
  • Tiny (~77kb compressed; 227kb uncompressed)
  • Complete functionality for all your Ethereum needs
  • Extensive documentation
  • Large collection of test cases which are maintained and added to
  • MIT License (including ALL dependencies); completely open source to do with as you please

Installing

To use in a browser:

<script charset="utf-8"
        src="https://cdn.ethers.io/scripts/ethers-v2.min.js"
        type="text/javascript">
</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.

Donations

I do this because I love it, but if you want to buy me a coffee, I won't say no. :o)

Ethereum: 0xEA517D5a070e6705Cc5467858681Ed953d285Eb9

License

Completely MIT Licensed. Including ALL dependencies.