Repository files navigation

A complete Ethereum wallet implementation and utilities in JavaScript (and TypeScript).

Features:

• Keep your private keys in your client,safe and sound
• Import and exportJSON wallets (Geth, Parity and crowdsale)
• Import and export BIP 39mnemonic phrases (12 word backup phrases) andHD Wallets (English as well as Czech, French, Italian, Japanese, Korean, Simplified Chinese, Spanish, Traditional Chinese)
• Meta-classes create JavaScript objects from any contract ABI, includingABIv2 andHuman-Readable ABI
• Connect to Ethereum nodes overJSON-RPC,INFURA,Etherscan,Alchemy orMetaMask
• ENS names are first-class citizens; they can be used anywhere an Ethereum addresses can be used
• Tiny (~104kb compressed; 322kb uncompressed)
• Modular packages; include only what you need
• Complete functionality for all your Ethereum desires
• Extensivedocumentation
• Large collection oftest cases which are maintained and added to
• FullyTypeScript ready, with definition files and full TypeScript source
• MIT License (including ALL dependencies); completely open source to do with as you please

For the latest news and advisories, please follow the@ethersprojecton Twitter (low-traffic, non-marketing, important information only) as well as watch this GitHub project.

For the latest changes, see theCHANGELOG.

node.js

/home/ricmoo/some_project> npm install --save ethers

browser (UMD)

<script src="https://cdn.ethers.io/lib/ethers-5.1.umd.min.js" type="text/javascript"></script>

browser (ESM)

<script type="module">    import { ethers } from "https://cdn.ethers.io/lib/ethers-5.1.esm.min.js";</script>

Browse thedocumentation online:

• Getting Started
• Full API Documentation
• Various Ethereum Articles

Or browse the entire documentation as asingle page to make searching easier.

These are a number of packages not included in the umbrellaethers npm package, andadditional packages are always being added. Often these packages are for specificuse-cases, so rather than adding them to the umbrella package, they are added asancillary packages, which can be included by those who need them, while not bloatingeveryone else with packages they do not need.

We will keep a list of useful packages here.

• @ethersproject/experimental (documentation)
• @ethersproject/cli (documentation)
• @ethersproject/hardware-wallets (documentation)

MIT License (includingall dependencies).