10 lines
22 KiB
HTML
10 lines
22 KiB
HTML
<html><head><title>Documentation</title><link rel="stylesheet" type="text/css" href="/static/style.css"></head><body><div class="sidebar"><div class="header"><div class="logo"><a href="/"><div class="image"></div><div class="name">ethers</div><div class="version">v5.0-beta</div></a></div></div><div class="toc"><div><div class="link title"><a href="/">Documentation</a></div><div class="base child show link depth-1"><a href="/getting-started/">Getting Started</a></div><div class="hide link depth-2"><a href="/getting-started/#installing">Installing</a></div><div class="hide link depth-2"><a href="/getting-started/#importing">Importing</a></div><div class="base child show link depth-1"><a href="/concepts/">Concepts</a></div><div class="hide link depth-2"><a href="/concepts/events/">Events</a></div><div class="hide link depth-2"><a href="/concepts/gas/">Gas</a></div><div class="hide link depth-3"><a href="/concepts/gas/#gas-price">Gas Price</a></div><div class="hide link depth-3"><a href="/concepts/gas/#gas-limit">Gas Limit</a></div><div class="base child show link depth-1"><a href="/api/">Application Programming Interface</a></div><div class="hide link depth-2"><a href="/api/contract/">Contracts</a></div><div class="hide link depth-3"><a href="/api/contract/#buckets">Buckets</a></div><div class="hide link depth-2"><a href="/api/signer/">Signers</a></div><div class="hide link depth-3"><a href="/api/signer/#signer">Signer</a></div><div class="hide link depth-3"><a href="/api/signer/#wallet-inherits-signer">Wallet inherits Signer</a></div><div class="hide link depth-2"><a href="/api/providers/">Providers</a></div><div class="hide link depth-3"><a href="/api/providers/provider/">Provider</a></div><div class="hide link depth-4"><a href="/api/providers/provider/#accounts-methods">Accounts Methods</a></div><div class="hide link depth-4"><a href="/api/providers/provider/#blocks-methods">Blocks Methods</a></div><div class="hide link depth-4"><a href="/api/providers/provider/#ethereum-naming-service-(ens)-methods">Ethereum Naming Service (ENS) Methods</a></div><div class="hide link depth-4"><a href="/api/providers/provider/#logs-methods">Logs Methods</a></div><div class="hide link depth-4"><a href="/api/providers/provider/#network-status-methods">Network Status Methods</a></div><div class="hide link depth-4"><a href="/api/providers/provider/#transactions-methods">Transactions Methods</a></div><div class="hide link depth-4"><a href="/api/providers/provider/#event-emitter-methods">Event Emitter Methods</a></div><div class="hide link depth-4"><a href="/api/providers/provider/#inspection-methods">Inspection Methods</a></div><div class="hide link depth-3"><a href="/api/providers/jsonrpc-provider/">JSON-RPC Provider</a></div><div class="hide link depth-4"><a href="/api/providers/jsonrpc-provider/#jsonrpcprovider">JsonRpcProvider</a></div><div class="hide link depth-4"><a href="/api/providers/jsonrpc-provider/#jsonrpcsigner">JsonRpcSigner</a></div><div class="hide link depth-4"><a href="/api/providers/jsonrpc-provider/#jsonrpcuncheckedsigner">JsonRpcUncheckedSigner</a></div><div class="hide link depth-3"><a href="/api/providers/api-providers/">API Providers</a></div><div class="hide link depth-4"><a href="/api/providers/api-providers/#etherscanprovider">EtherscanProvider</a></div><div class="hide link depth-4"><a href="/api/providers/api-providers/#infuraprovider">InfuraProvider</a></div><div class="hide link depth-4"><a href="/api/providers/api-providers/#nodesmithprovider">NodesmithProvider</a></div><div class="hide link depth-4"><a href="/api/providers/api-providers/#alchemyprovider">AlchemyProvider</a></div><div class="hide link depth-3"><a href="/api/providers/other/">Other Providers</a></div><div class="hide link depth-4"><a href="/api/providers/other/#fallbackprovider">FallbackProvider</a></div><div class="hide link depth-4"><a href="/api/providers/other/#ipcprovider">IpcProvider</a></div><div class="hide link depth-3"><a href="/api/providers/types/">Types</a></div><div class="hide link depth-4"><a href="/api/providers/types/#blocks">Blocks</a></div><div class="hide link depth-4"><a href="/api/providers/types/#events-and-logs">Events and Logs</a></div><div class="hide link depth-4"><a href="/api/providers/types/#transactions">Transactions</a></div><div class="hide link depth-2"><a href="/api/utils/">Utilities</a></div><div class="hide link depth-3"><a href="/api/utils/address/">Addresses</a></div><div class="hide link depth-3"><a href="/api/utils/bignumber/">BigNumber</a></div><div class="hide link depth-4"><a href="/api/utils/bignumber/#types">Types</a></div><div class="hide link depth-4"><a href="/api/utils/bignumber/#creating-instances">Creating Instances</a></div><div class="hide link depth-4"><a href="/api/utils/bignumber/#methods">Methods</a></div><div class="hide link depth-4"><a href="/api/utils/bignumber/#notes">Notes</a></div><div class="hide link depth-3"><a href="/api/utils/bytes/">Byte Manipulation</a></div><div class="hide link depth-4"><a href="/api/utils/bytes/#types">Types</a></div><div class="hide link depth-4"><a href="/api/utils/bytes/#inspection">Inspection</a></div><div class="hide link depth-4"><a href="/api/utils/bytes/#converting-between-arrays-and-hexstrings">Converting between Arrays and Hexstrings</a></div><div class="hide link depth-4"><a href="/api/utils/bytes/#array-manipulation">Array Manipulation</a></div><div class="hide link depth-4"><a href="/api/utils/bytes/#hexstring-manipulation">Hexstring Manipulation</a></div><div class="hide link depth-4"><a href="/api/utils/bytes/#signature-conversion">Signature Conversion</a></div><div class="hide link depth-3"><a href="/api/utils/constants/">Constants</a></div><div class="hide link depth-4"><a href="/api/utils/constants/#bytes">Bytes</a></div><div class="hide link depth-4"><a href="/api/utils/constants/#strings">Strings</a></div><div class="hide link depth-4"><a href="/api/utils/constants/#bignumber">BigNumber</a></div><div class="hide link depth-3"><a href="/api/utils/display-logic/">Display Logic and Input</a></div><div class="hide link depth-4"><a href="/api/utils/display-logic/#units">Units</a></div><div class="hide link depth-4"><a href="/api/utils/display-logic/#functions">Functions</a></div><div class="hide link depth-3"><a href="/api/utils/fixednumber/">FixedNumber</a></div><div class="hide link depth-4"><a href="/api/utils/fixednumber/#types">Types</a></div><div class="hide link depth-4"><a href="/api/utils/fixednumber/#creating-instances">Creating Instances</a></div><div class="hide link depth-4"><a href="/api/utils/fixednumber/#properties">Properties</a></div><div class="hide link depth-4"><a href="/api/utils/fixednumber/#methods">Methods</a></div><div class="hide link depth-3"><a href="/api/utils/hashing/">Hashing Algorithms</a></div><div class="hide link depth-4"><a href="/api/utils/hashing/#cryptographic-hashing">Cryptographic Hashing</a></div><div class="hide link depth-4"><a href="/api/utils/hashing/#common-hashing-helpers">Common Hashing Helpers</a></div><div class="hide link depth-4"><a href="/api/utils/hashing/#solidity-hashing-algorithms">Solidity Hashing Algorithms</a></div><div class="hide link depth-3"><a href="/api/utils/strings/">Strings</a></div><div class="hide link depth-4"><a href="/api/utils/strings/#bytes32string">Bytes32String</a></div><div class="hide link depth-4"><a href="/api/utils/strings/#utf-8-strings">UTF-8 Strings</a></div><div class="base child show link depth-1"><a href="/cookbook/">Cookbook</a></div><div class="base child show link depth-1"><a href="/migration/">Migration Guide</a></div><div class="hide link depth-2"><a href="/migration/#from-web3">From Web3</a></div><div class="hide link depth-2"><a href="/migration/#from-ethers-v4">From ethers v4</a></div><div class="base child show link depth-1"><a href="/testing/">Testing</a></div><div class="base child show link depth-1"><a href="/contributing/">Contributing and Hacking</a></div><div class="hide link depth-2"><a href="/contributing/#building">Building</a></div><div class="base child show link depth-1"><a href="/documentation/">Flatworm Docs</a></div><div class="hide link depth-2"><a href="/documentation/#fragments">Fragments</a></div><div class="hide link depth-2"><a href="/documentation/#markdown">Markdown</a></div><div class="base child show link depth-1"><a href="/license/">License and Copyright</a></div></div></div></div><div class="content"><div class="breadcrumbs"><span class="current">Documentation</span></div>
|
|
<a name="what-is-ethers?"></a><h1>What is ethers?</h1>
|
|
<p>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 <a href="https://ethers.io/">ethers.io</a> and has since expanded into a much more general-purpose library.</p>
|
|
<a name="features"></a><h2>Features</h2>
|
|
<ul><li>Keep your private keys in your client, <b>safe</b> and sound</li><li>Import and export <b>JSON wallets</b> (Geth, Parity and crowdsale)</li><li>Import and export BIP 39 <b>mnemonic phrases</b> (12 word backup phrases) and HD Wallets (English, Italian, Japanese, Korean, Simplified Chinese, Traditional Chinese; more coming soon)</li><li>Meta-classes create JavaScript objects from any contract ABI, including <b>ABIv2</b> and <b>Human-Readable ABI</b></li><li>Connect to Ethereum nodes over <a href="https://github.com/ethereum/wiki/wiki/JSON-RPC">JSON-RPC</a>, <a href="https://infura.io/">INFURA</a>, <a href="https://etherscan.io/">Etherscan</a>, <a href="https://nodesmith.io">Nodesmith</a>, <a href="https://alchemyapi.io">Alchemy</a>, or <a href="https://metamask.io/">MetaMask</a>.</li><li><b>ENS names</b> are first-class citizens; they can be used anywhere an Ethereum addresses can be used</li><li><b>Tiny</b> (~88kb compressed; 284kb uncompressed)</li><li><b>Complete</b> functionality for all your Ethereum needs</li><li>Extensive <a href="https://docs.ethers.io/">documentation</a></li><li>Large collection of <b>test cases</b> which are maintained and added to</li><li>Fully <b>TypeScript</b> ready, with definition files and full TypeScript source</li><li><b>MIT License</b> (including <i>ALL</i> dependencies); completely open source to do with as you please</li></ul>
|
|
<a name="developer-documentation"></a><h2>Developer Documentation</h2>
|
|
|
|
<div class="toc"><div style="padding-left: 0px"><span class="bullet">•</span><a href="/getting-started/">Getting Started</a></div><div style="padding-left: 28px"><span class="bullet">•</span><a href="/getting-started/#installing">Installing</a></div><div style="padding-left: 28px"><span class="bullet">•</span><a href="/getting-started/#importing">Importing</a></div><div style="padding-left: 0px"><span class="bullet">•</span><a href="/concepts/">Concepts</a></div><div style="padding-left: 28px"><span class="bullet">•</span><a href="/concepts/events/">Events</a></div><div style="padding-left: 28px"><span class="bullet">•</span><a href="/concepts/gas/">Gas</a></div><div style="padding-left: 56px"><span class="bullet">•</span><a href="/concepts/gas/#gas-price">Gas Price</a></div><div style="padding-left: 56px"><span class="bullet">•</span><a href="/concepts/gas/#gas-limit">Gas Limit</a></div><div style="padding-left: 0px"><span class="bullet">•</span><a href="/api/">Application Programming Interface</a></div><div style="padding-left: 28px"><span class="bullet">•</span><a href="/api/contract/">Contracts</a></div><div style="padding-left: 56px"><span class="bullet">•</span><a href="/api/contract/#buckets">Buckets</a></div><div style="padding-left: 28px"><span class="bullet">•</span><a href="/api/signer/">Signers</a></div><div style="padding-left: 56px"><span class="bullet">•</span><a href="/api/signer/#signer">Signer</a></div><div style="padding-left: 56px"><span class="bullet">•</span><a href="/api/signer/#wallet-inherits-signer">Wallet inherits Signer</a></div><div style="padding-left: 28px"><span class="bullet">•</span><a href="/api/providers/">Providers</a></div><div style="padding-left: 56px"><span class="bullet">•</span><a href="/api/providers/provider/">Provider</a></div><div style="padding-left: 84px"><span class="bullet">•</span><a href="/api/providers/provider/#accounts-methods">Accounts Methods</a></div><div style="padding-left: 84px"><span class="bullet">•</span><a href="/api/providers/provider/#blocks-methods">Blocks Methods</a></div><div style="padding-left: 84px"><span class="bullet">•</span><a href="/api/providers/provider/#ethereum-naming-service-(ens)-methods">Ethereum Naming Service (ENS) Methods</a></div><div style="padding-left: 84px"><span class="bullet">•</span><a href="/api/providers/provider/#logs-methods">Logs Methods</a></div><div style="padding-left: 84px"><span class="bullet">•</span><a href="/api/providers/provider/#network-status-methods">Network Status Methods</a></div><div style="padding-left: 84px"><span class="bullet">•</span><a href="/api/providers/provider/#transactions-methods">Transactions Methods</a></div><div style="padding-left: 84px"><span class="bullet">•</span><a href="/api/providers/provider/#event-emitter-methods">Event Emitter Methods</a></div><div style="padding-left: 84px"><span class="bullet">•</span><a href="/api/providers/provider/#inspection-methods">Inspection Methods</a></div><div style="padding-left: 56px"><span class="bullet">•</span><a href="/api/providers/jsonrpc-provider/">JSON-RPC Provider</a></div><div style="padding-left: 84px"><span class="bullet">•</span><a href="/api/providers/jsonrpc-provider/#jsonrpcprovider">JsonRpcProvider</a></div><div style="padding-left: 84px"><span class="bullet">•</span><a href="/api/providers/jsonrpc-provider/#jsonrpcsigner">JsonRpcSigner</a></div><div style="padding-left: 84px"><span class="bullet">•</span><a href="/api/providers/jsonrpc-provider/#jsonrpcuncheckedsigner">JsonRpcUncheckedSigner</a></div><div style="padding-left: 56px"><span class="bullet">•</span><a href="/api/providers/api-providers/">API Providers</a></div><div style="padding-left: 84px"><span class="bullet">•</span><a href="/api/providers/api-providers/#etherscanprovider">EtherscanProvider</a></div><div style="padding-left: 84px"><span class="bullet">•</span><a href="/api/providers/api-providers/#infuraprovider">InfuraProvider</a></div><div style="padding-left: 84px"><span class="bullet">•</span><a href="/api/providers/api-providers/#nodesmithprovider">NodesmithProvider</a></div><div style="padding-left: 84px"><span class="bullet">•</span><a href="/api/providers/api-providers/#alchemyprovider">AlchemyProvider</a></div><div style="padding-left: 56px"><span class="bullet">•</span><a href="/api/providers/other/">Other Providers</a></div><div style="padding-left: 84px"><span class="bullet">•</span><a href="/api/providers/other/#fallbackprovider">FallbackProvider</a></div><div style="padding-left: 84px"><span class="bullet">•</span><a href="/api/providers/other/#ipcprovider">IpcProvider</a></div><div style="padding-left: 56px"><span class="bullet">•</span><a href="/api/providers/types/">Types</a></div><div style="padding-left: 84px"><span class="bullet">•</span><a href="/api/providers/types/#blocks">Blocks</a></div><div style="padding-left: 84px"><span class="bullet">•</span><a href="/api/providers/types/#events-and-logs">Events and Logs</a></div><div style="padding-left: 84px"><span class="bullet">•</span><a href="/api/providers/types/#transactions">Transactions</a></div><div style="padding-left: 28px"><span class="bullet">•</span><a href="/api/utils/">Utilities</a></div><div style="padding-left: 56px"><span class="bullet">•</span><a href="/api/utils/address/">Addresses</a></div><div style="padding-left: 56px"><span class="bullet">•</span><a href="/api/utils/bignumber/">BigNumber</a></div><div style="padding-left: 84px"><span class="bullet">•</span><a href="/api/utils/bignumber/#types">Types</a></div><div style="padding-left: 84px"><span class="bullet">•</span><a href="/api/utils/bignumber/#creating-instances">Creating Instances</a></div><div style="padding-left: 84px"><span class="bullet">•</span><a href="/api/utils/bignumber/#methods">Methods</a></div><div style="padding-left: 84px"><span class="bullet">•</span><a href="/api/utils/bignumber/#notes">Notes</a></div><div style="padding-left: 56px"><span class="bullet">•</span><a href="/api/utils/bytes/">Byte Manipulation</a></div><div style="padding-left: 84px"><span class="bullet">•</span><a href="/api/utils/bytes/#types">Types</a></div><div style="padding-left: 84px"><span class="bullet">•</span><a href="/api/utils/bytes/#inspection">Inspection</a></div><div style="padding-left: 84px"><span class="bullet">•</span><a href="/api/utils/bytes/#converting-between-arrays-and-hexstrings">Converting between Arrays and Hexstrings</a></div><div style="padding-left: 84px"><span class="bullet">•</span><a href="/api/utils/bytes/#array-manipulation">Array Manipulation</a></div><div style="padding-left: 84px"><span class="bullet">•</span><a href="/api/utils/bytes/#hexstring-manipulation">Hexstring Manipulation</a></div><div style="padding-left: 84px"><span class="bullet">•</span><a href="/api/utils/bytes/#signature-conversion">Signature Conversion</a></div><div style="padding-left: 56px"><span class="bullet">•</span><a href="/api/utils/constants/">Constants</a></div><div style="padding-left: 84px"><span class="bullet">•</span><a href="/api/utils/constants/#bytes">Bytes</a></div><div style="padding-left: 84px"><span class="bullet">•</span><a href="/api/utils/constants/#strings">Strings</a></div><div style="padding-left: 84px"><span class="bullet">•</span><a href="/api/utils/constants/#bignumber">BigNumber</a></div><div style="padding-left: 56px"><span class="bullet">•</span><a href="/api/utils/display-logic/">Display Logic and Input</a></div><div style="padding-left: 84px"><span class="bullet">•</span><a href="/api/utils/display-logic/#units">Units</a></div><div style="padding-left: 84px"><span class="bullet">•</span><a href="/api/utils/display-logic/#functions">Functions</a></div><div style="padding-left: 56px"><span class="bullet">•</span><a href="/api/utils/fixednumber/">FixedNumber</a></div><div style="padding-left: 84px"><span class="bullet">•</span><a href="/api/utils/fixednumber/#types">Types</a></div><div style="padding-left: 84px"><span class="bullet">•</span><a href="/api/utils/fixednumber/#creating-instances">Creating Instances</a></div><div style="padding-left: 84px"><span class="bullet">•</span><a href="/api/utils/fixednumber/#properties">Properties</a></div><div style="padding-left: 84px"><span class="bullet">•</span><a href="/api/utils/fixednumber/#methods">Methods</a></div><div style="padding-left: 56px"><span class="bullet">•</span><a href="/api/utils/hashing/">Hashing Algorithms</a></div><div style="padding-left: 84px"><span class="bullet">•</span><a href="/api/utils/hashing/#cryptographic-hashing">Cryptographic Hashing</a></div><div style="padding-left: 84px"><span class="bullet">•</span><a href="/api/utils/hashing/#common-hashing-helpers">Common Hashing Helpers</a></div><div style="padding-left: 84px"><span class="bullet">•</span><a href="/api/utils/hashing/#solidity-hashing-algorithms">Solidity Hashing Algorithms</a></div><div style="padding-left: 56px"><span class="bullet">•</span><a href="/api/utils/strings/">Strings</a></div><div style="padding-left: 84px"><span class="bullet">•</span><a href="/api/utils/strings/#bytes32string">Bytes32String</a></div><div style="padding-left: 84px"><span class="bullet">•</span><a href="/api/utils/strings/#utf-8-strings">UTF-8 Strings</a></div><div style="padding-left: 0px"><span class="bullet">•</span><a href="/cookbook/">Cookbook</a></div><div style="padding-left: 0px"><span class="bullet">•</span><a href="/migration/">Migration Guide</a></div><div style="padding-left: 28px"><span class="bullet">•</span><a href="/migration/#from-web3">From Web3</a></div><div style="padding-left: 28px"><span class="bullet">•</span><a href="/migration/#from-ethers-v4">From ethers v4</a></div><div style="padding-left: 0px"><span class="bullet">•</span><a href="/testing/">Testing</a></div><div style="padding-left: 0px"><span class="bullet">•</span><a href="/contributing/">Contributing and Hacking</a></div><div style="padding-left: 28px"><span class="bullet">•</span><a href="/contributing/#building">Building</a></div><div style="padding-left: 0px"><span class="bullet">•</span><a href="/documentation/">Flatworm Docs</a></div><div style="padding-left: 28px"><span class="bullet">•</span><a href="/documentation/#fragments">Fragments</a></div><div style="padding-left: 28px"><span class="bullet">•</span><a href="/documentation/#markdown">Markdown</a></div><div style="padding-left: 0px"><span class="bullet">•</span><a href="/license/">License and Copyright</a></div></div>
|
|
<a name="legacy-documentation"></a><h2>Legacy Documentation</h2>
|
|
<p>This section will be kept up to date, linking to documentation of older versions of the library.</p><ul><li><a href="https://docs.ethers.io/ethers.js">version 4.0</a></li><li><a href="https://docs.ethers.io/ethers.js/v3.0/html/">version 3.0</a></li></ul><div class="footer"> <div class="nav next"><a href="/getting-started/">Getting Started<span class="arrow">→</span></a></div></div><div class="copyright">The content of this site is licensed under the <a href="https://choosealicense.com/licenses/cc-by-4.0/">Creative Commons Attribution 4.0 International License</a>.</div></div><script src="/script.js" type="text/javascript"></script></body></html><!-- ContentHash:3ffb5d3179ddad1ca0a5c47daa64823b0340dbd820cfe4eaaebfbfe8da749431 --> |