ethers.js/docs/README.md

Documentation: html

What is ethers?

The ethers.js library aims to be a complete and compact library for interacting with the Ethereum Blockchain and its ecosystem. It was originally designed for use with ethers.io and has since expanded into a much more general-purpose library.

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

Developer Documentation

• Getting Started
  • Installing
  • Importing
• Concepts
  • Events
  • Gas
    • Gas Price
    • Gas Limit
• Application Programming Interface
  • Contracts
    • Buckets
  • Signers
    • Signer
    • Wallet inherits Signer
  • Providers
    • Provider
      • Accounts Methods
      • Blocks Methods
      • Ethereum Naming Service (ENS) Methods
      • Logs Methods
      • Network Status Methods
      • Transactions Methods
      • Event Emitter Methods
      • Inspection Methods
    • JSON-RPC Provider
      • JsonRpcProvider
      • JsonRpcSigner
      • JsonRpcUncheckedSigner
    • API Providers
      • EtherscanProvider
      • InfuraProvider
      • NodesmithProvider
      • AlchemyProvider
    • Other Providers
      • FallbackProvider
      • IpcProvider
    • Types
      • Blocks
      • Events and Logs
      • Transactions
  • Utilities
    • Addresses
    • BigNumber
      • Types
      • Creating Instances
      • Methods
      • Notes
    • Byte Manipulation
      • Types
      • Inspection
      • Converting between Arrays and Hexstrings
      • Array Manipulation
      • Hexstring Manipulation
      • Signature Conversion
    • Constants
      • Bytes
      • Strings
      • BigNumber
    • Display Logic and Input
      • Units
      • Functions
    • FixedNumber
      • Types
      • Creating Instances
      • Properties
      • Methods
    • Hashing Algorithms
      • Cryptographic Hashing
      • Common Hashing Helpers
      • Solidity Hashing Algorithms
    • Strings
      • Bytes32String
      • UTF-8 Strings
• Cookbook
• Migration Guide
  • From Web3
  • From ethers v4
• Testing
• Contributing and Hacking
  • Building
• Flatworm Docs
  • Fragments
  • Markdown
• License and Copyright

Legacy Documentation

This section will be kept up to date, linking to documentation of older versions of the library.

• version 4.0
• version 3.0

---

Content Hash: 6abeb4fa3f15b3443d89a26a6b0320f602a12368bc5ebbfb14a6cce682836167