ethers.js/docs

Documentation: html

Documentation

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, Alchemy, Cloudflare 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
    • Solidity Topics
  • Gas
    • Gas Price
    • Gas Limit
• Application Programming Interface
  • Contract Interaction
    • Contract
      • Properties
      • Methods
      • Events
      • Meta-Class
    • Example: ERC-20 Contract
      • Connecting to a Contract
      • Properties ^^//(inheritted from [[contract]])//^^
      • Methods ^^//(inheritted from [[contract]])//^^
      • Events ^^//(inheritted from Contract)//^^
      • Meta-Class Methods ^^//(added at Runtime)//^^
      • Meta-Class Filters ^^//(added at Runtime)//^^
  • Signers
    • Signer
    • Wallet
    • VoidSigner
    • ExternallyOwnedAccount
  • Providers
    • Provider
      • Accounts Methods
      • Blocks Methods
      • Ethereum Naming Service (ENS) Methods
      • Logs Methods
      • Network Status Methods
      • Transactions Methods
      • Event Emitter Methods
      • Inspection Methods
    • JsonRpcProvider
      • JsonRpcSigner
      • JsonRpcUncheckedSigner
    • API Providers
      • EtherscanProvider
      • InfuraProvider
      • AlchemyProvider
      • CloudfrontProvider
    • Other Providers
      • FallbackProvider
      • IpcProvider
      • UrlJsonRpcProvider
      • Web3Provider
    • Types
      • BlockTag
      • Network
      • Block
      • Events and Logs
      • Transactions
  • Utilities
    • Application Binary Interface
      • Interface
        • Creating Instances
        • Properties
        • Formatting
        • Fragment Access
        • Signature and Topic Hashes
        • Encoding Data
        • Decoding Data
        • Parsing
        • Types
        • Specifying Fragments
      • Fragments
        • Formats
        • Fragment
        • ConstructorFragment
        • EventFragment
        • FunctionFragment
        • ParamType
    • Addresses
      • Address Formats
      • Functions
    • BigNumber
      • Types
      • Creating Instances
      • Methods
      • Notes
    • Byte Manipulation
      • Types
      • Inspection
      • Converting between Arrays and Hexstrings
      • Array Manipulation
      • Hexstring Manipulation
      • Signature Conversion
      • Random Bytes
    • Constants
      • Bytes
      • Strings
      • BigNumber
    • Display Logic and Input
      • Units
      • Functions
    • Encoding Utilities
      • Base58
      • Base64
      • Recursive-Length Prefix
    • FixedNumber
      • Creating Instances
      • Properties
      • Methods
      • FixedFormat
    • Hashing Algorithms
      • Cryptographic Hashing
      • Common Hashing Helpers
      • Solidity Hashing Algorithms
    • HD Wallet
      • Types
      • HDNode
      • Other Functions
    • Logging
      • Logger
      • Errors
      • Log Levels
    • Property Utilities
    • Signing Key
      • Other Functions
    • Strings
      • Bytes32String
      • UTF-8 Strings
      • UnicodeNormalizationForm
      • Custom UTF-8 Error Handling
    • Transactions
      • Types
      • Functions
    • Web Utilities
    • Wordlists
      • Wordlist
      • Languages
  • Other Libraries
    • Assembly
      • Ethers ASM Dialect
        • Opcodes
        • Labels
        • Literals
        • Comments
        • Scopes
        • Data Segment
        • Links
        • Stack Placeholders
        • Evaluation and Excution
      • Utilities
        • Assembler
        • Disassembler
        • Opcode
      • Abstract Syntax Tree
        • Types
        • Nodes
    • Hardware Wallets
      • LedgerSigner
• Command Line Interfaces
  • Sandbox Utility
    • Help
    • Examples
  • Assembler
    • Help
    • Example Input Files
    • Assembler Examples
    • Disassembler Examples
  • Ethereum Naming Service
    • Help
    • Examples
  • TypeScript
    • Help
    • Examples
  • Making Your Own
    • CLI
    • Plugin
    • ArgParser
• Cookbook
• Migration Guide
  • Migration: From Web3.js
    • Contracts
    • Providers
    • Numbers
    • Utilities
  • Migration: From Ethers v4
    • BigNumber
    • Contracts
    • Errors
    • Interface
    • Utilities
    • Wallet
• Testing
• Contributing and Hacking
  • Building
• Flatworm Docs
  • Fragments
  • Markdown
  • Configuration
  • Extended Directive Functions
• 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: 1ccc27c4ba6e59efa2be69cc0fb345ea9c397f1f4444d08ec13780d0d1a46b60