Skip to content
Complete Ethereum wallet implementation and library in JavaScript.
Branch: master
Clone or download
Latest commit 055694a Jun 10, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
dist Updated dist files. Jun 10, 2019
providers Updated dist files. May 24, 2019
shims Updated dist files. Sep 24, 2018
src.ts Updated dist files. Jun 10, 2019
tests Added goerli to InfuraProvider (#421). Mar 8, 2019
utils Updatd dist files. Jun 10, 2019
wordlists Updated dist files. Nov 9, 2018
.eslintrc.js Added eslint for promises. (#189) Jul 3, 2018
.gitignore Major re-factor of the library layout for TypeScript; still up for di… Jul 30, 2018
.npmignore Major re-factor of the library layout for TypeScript; still up for di… Jul 30, 2018
.travis.yml Adding node 8 back into tests. Jul 31, 2018
CODE_OF_CONDUCT.md Adding default code of conduct Nov 4, 2017
LICENSE Creating license file in GitHub UI Nov 3, 2017
README.md Updated BIP39 list in readme. Feb 12, 2019
_version.d.ts Updated dist files. Jun 10, 2019
_version.js Updated dist files. Jun 10, 2019
abstract-signer.d.ts Updated dist files. Sep 24, 2018
abstract-signer.js Updated dist files. Sep 24, 2018
constants.d.ts Updated dist files. Sep 24, 2018
constants.js Updated dist files. Sep 24, 2018
contract.d.ts Updated dist files. Feb 12, 2019
contract.js Updated dist files. Feb 12, 2019
errors.d.ts Updated dist files. Dec 27, 2018
errors.js Updated dist files. Dec 27, 2018
ethers.d.ts Updated dist files. Oct 5, 2018
ethers.js Updated dist files. Nov 21, 2018
gulpfile.js Support for xpub and xpriv derivation and generating extended keys; n… Feb 1, 2019
index.d.ts Major re-factor of the library layout for TypeScript; still up for di… Jul 30, 2018
index.js Fixed type definitions using absolute path. Jul 16, 2018
package-lock.json Fixed security recommendations (development deps only; not a problem,… May 14, 2019
package.json Updated dist files. Jun 10, 2019
thirdparty.d.ts Support for xpub and xpriv derivation and generating extended keys; n… Feb 1, 2019
tsconfig.json Major re-factor of the library layout for TypeScript; still up for di… Jul 30, 2018
wallet.d.ts Updated dist files. Oct 7, 2018
wallet.js Updated dist files. Jan 17, 2019

README.md

ethers.js

npm version

Complete Ethereum wallet implementation and utilities in JavaScript (and TypeScript).

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, French, Italian, Japanese, Korean, Simplified Chinese, Spanish, Traditional Chinese)
  • Meta-classes create JavaScript objects from any contract ABI, including ABIv2 and Human-Readable ABI
  • Connect to Ethereum nodes over JSON-RPC, INFURA, Etherscan, or MetaMask
  • ENS names are first-class citizens; they can be used anywhere an Ethereum addresses can be used
  • Tiny (~84kb compressed; 270kb 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

Keep Updated

For the latest news and advisories, please follow @ethersproject on Twitter as well as this GitHub project.

Installing

To use in a browser:

<script charset="utf-8"
        src="https://cdn.ethers.io/scripts/ethers-v4.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.

To fork and submit pull requests to the documentation, please see the documentation repository.

Related Libraries

  • Command Line Interface - Command Line Tools for ethers
  • CryptoKitties - CryptoKitties utility libraries
  • ENS - ENS utility libraries for managing names
  • LedgerSigner - Use a Ledger Hardware Wallet as an ethers Signer (supports HID (node.js) and U2F (browser); or specify your own transport)
  • Web3 Bridge - Use ethers as the backend for a Web3 front-end

Hacking and Contributing

The JavaScript code is now generated from TypeScript, so make sure you modify the TypeScript and compile it, rather than modifying the JavaScript directly. To start auto-compiling the TypeScript code, you may use:

/home/ethers> npm run auto-build

A very important part of ethers is its exhaustive test cases, so before making any bug fix, please add a test case that fails prior to the fix, and succeeds after the fix. All regression tests must pass.

Pull requests are always welcome, but please keep a few points in mind:

  • Compatibility-breaking changes will not be accepted; they may be considered for the next major version
  • Security is important; adding dependencies require fairly convincing arguments
  • The library aims to be lean, so keep an eye on the dist/ethers.min.js file size before and after your changes
  • Add test cases for both expected and unexpected input
  • Any new features need to be supported by us (issues, documentation, testing), so anything that is overly complicated or specific may not be accepted

In general, please start an issue before beginning a pull request, so we can have a public discussion. :)

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.

You can’t perform that action at this time.