40 lines
39 KiB
HTML
40 lines
39 KiB
HTML
|
<!DOCTYPE html>
|
||
|
|
<html class="paged">
|
||
|
|
<head>
|
||
|
|
<title>Documentation</title>
|
||
|
|
<link rel="stylesheet" type="text/css" href="/v5/static/style.css">
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<div class="sidebar">
|
||
|
|
<div class="header">
|
||
|
|
<div class="logo"><a href="/v5/"><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="/v5/getting-started/">Getting Started</a></div><div class="base child show link depth-1"><a href="/v5/concepts/">Ethereum Basics</a></div><div class="hide link depth-2"><a href="/v5/concepts/events/">Events</a></div><div class="hide link depth-2"><a href="/v5/concepts/gas/">Gas</a></div><div class="hide link depth-2"><a href="/v5/concepts/security/">Security</a></div><div class="base child show link depth-1"><a href="/v5/api/">Application Programming Interface</a></div><div class="hide link depth-2"><a href="/v5/api/contract/">Contract Interaction</a></div><div class="hide link depth-3"><a href="/v5/api/contract/contract/">Contract</a></div><div class="hide link depth-3"><a href="/v5/api/contract/contract-factory/">ContractFactory</a></div><div class="hide link depth-3"><a href="/v5/api/contract/example/">Example: ERC-20 Contract</a></div><div class="hide link depth-2"><a href="/v5/api/signer/">Signers</a></div><div class="hide link depth-2"><a href="/v5/api/providers/">Providers</a></div><div class="hide link depth-3"><a href="/v5/api/providers/provider/">Provider</a></div><div class="hide link depth-3"><a href="/v5/api/providers/jsonrpc-provider/">JsonRpcProvider</a></div><div class="hide link depth-3"><a href="/v5/api/providers/api-providers/">API Providers</a></div><div class="hide link depth-3"><a href="/v5/api/providers/other/">Other Providers</a></div><div class="hide link depth-3"><a href="/v5/api/providers/types/">Types</a></div><div class="hide link depth-2"><a href="/v5/api/utils/">Utilities</a></div><div class="hide link depth-3"><a href="/v5/api/utils/abi/">Application Binary Interface</a></div><div class="hide link depth-4"><a href="/v5/api/utils/abi/interface/">Interface</a></div><div class="hide link depth-4"><a href="/v5/api/utils/abi/fragments/">Fragments</a></div><div class="hide link depth-3"><a href="/v5/api/utils/address/">Addresses</a></div><div class="hide link depth-3"><a href="/v5/api/utils/bignumber/">BigNumber</a></div><div class="hide link depth-3"><a href="/v5/api/utils/bytes/">Byte Manipulation</a></div><div class="hide link depth-3"><a href="/v5/api/utils/constants/">Constants</a></div><div class="hide link depth-3"><a href="/v5/api/utils/display-logic/">Display Logic and Input</a></div><div class="hide link depth-3"><a href="/v5/api/utils/encoding/">Encoding Utilities</a></div><div class="hide link depth-3"><a href="/v5/api/utils/fixednumber/">FixedNumber</a></div><div class="hide link depth-3"><a href="/v5/api/utils/hashing/">Hashing Algorithms</a></div><div class="hide link depth-3"><a href="/v5/api/utils/hdnode/">HD Wallet</a></div><div class="hide link depth-3"><a href="/v5/api/utils/logger/">Logging</a></div><div class="hide link depth-3"><a href="/v5/api/utils/properties/">Property Utilities</a></div><div class="hide link depth-3"><a href="/v5/api/utils/signing-key/">Signing Key</a></div><div class="hide link depth-3"><a href="/v5/api/utils/strings/">Strings</a></div><div class="hide link depth-3"><a href="/v5/api/utils/transactions/">Transactions</a></div><div class="hide link depth-3"><a href="/v5/api/utils/web/">Web Utilities</a></div><div class="hide link depth-3"><a href="/v5/api/utils/wordlists/">Wordlists</a></div><div class="hide link depth-2"><a href="/v5/api/other/">Other Libraries</a></div><div class="hide link depth-3"><a href="/v5/api/other/assembly/">Assembly</a></div><div class="hide link depth-4"><a href="/v5/api/other/assembly/dialect/">Ethers ASM Dialect</a></div><div class="hide link depth-4"><a href="/v5/api/other/assembly/api/">Utilities</a></div><div class="hide link depth-4"><a href="/v5/api/other/assembly/ast/">Abstract Syntax Tree</a></div><div class="hide link depth-3"><a href="/v5/api/other/hardware/">Hardware Wallets</a></div><div class="hide link depth-2"><a href="/v5/api/experimental/">Experimental</a></div><div class="base child show link depth-1"><a href="/v5/cli/">Command Line Interfaces</a></div><div class="hide link depth-2"><a hre
|
||
|
|
</div></div>
|
||
|
|
</div>
|
||
|
|
<div class="content">
|
||
|
|
<div class="breadcrumbs"><span class="current">Documentation</span></div>
|
||
|
|
|
||
|
|
<a name="documentation"></a><h1 class="show-anchors"><div>Documentation<div class="anchors"><a class="self" href="/v5/#documentation"></a></div></div></h1>
|
||
|
|
<a name="documentation--what-is-ethers"></a><h2 class="show-anchors"><div>What is Ethers?<div class="anchors"><a class="self" href="/v5/#documentation--what-is-ethers"></a></div></div></h2><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="documentation--features"></a><h2 class="show-anchors"><div>Features<div class="anchors"><a class="self" href="/v5/#documentation--features"></a></div></div></h2><p><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://alchemyapi.io">Alchemy</a>, <a href="https://developers.cloudflare.com/distributed-web/ethereum-gateway/">Cloudflare</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></p>
|
||
|
|
|
||
|
|
<a name="documentation--developer-documentation"></a><h2 class="show-anchors"><div>Developer Documentation<div class="anchors"><a class="self" href="/v5/#documentation--developer-documentation"></a></div></div></h2>
|
||
|
|
<div class="toc"><div style="padding-left: 0px"><span class="bullet">•</span><a href="/v5/getting-started/">Getting Started</a></div><div style="padding-left: 28px"><span class="bullet">•</span><a href="/v5/getting-started/#getting-started--installing">Installing</a></div><div style="padding-left: 28px"><span class="bullet">•</span><a href="/v5/getting-started/#getting-started--importing">Importing</a></div><div style="padding-left: 28px"><span class="bullet">•</span><a href="/v5/getting-started/#getting-started--common-terminology">Common Terminology</a></div><div style="padding-left: 28px"><span class="bullet">•</span><a href="/v5/getting-started/#getting-started--connecting-to-ethereum-metamask">Connecting to Ethereum: Metamask</a></div><div style="padding-left: 28px"><span class="bullet">•</span><a href="/v5/getting-started/#getting-started--contracts">Contracts</a></div><div style="padding-left: 28px"><span class="bullet">•</span><a href="/v5/getting-started/#getting-started--signing-messages">Signing Messages</a></div><div style="padding-left: 0px"><span class="bullet">•</span><a href="/v5/concepts/">Ethereum Basics</a></div><div style="padding-left: 28px"><span class="bullet">•</span><a href="/v5/concepts/events/">Events</a></div><div style="padding-left: 56px"><span class="bullet">•</span><a href="/v5/concepts/events/#events--solidity-topics">Solidity Topics</a></div><div style="padding-left: 56px"><span class="bullet">•</span><a href="/v5/concepts/events/#events--logs-and-filtering">Logs and Filtering</a></div><div style="padding-left: 28px"><span class="bullet">•</span><a href="/v5/concepts/gas/">Gas</a></div><div style="padding-left: 56px"><span class="bullet">•</span><a href="/v5/concepts/gas/#gas-price">Gas Price</a></div><div style="padding-left: 56px"><span class="bullet">•</span><a href="/v5/concepts/gas/#gas-limit">Gas Limit</a></div><div style="padding-left: 28px"><span class="bullet">•</span><a href="/v5/concepts/security/">Security</a></div><div style="padding-left: 56px"><span class="bullet">•</span><a href="/v5/concepts/security/#security-pbkdf">Key Derivation Functions</a></div><div style="padding-left: 0px"><span class="bullet">•</span><a href="/v5/api/">Application Programming Interface</a></div><div style="padding-left: 28px"><span class="bullet">•</span><a href="/v5/api/contract/">Contract Interaction</a></div><div style="padding-left: 56px"><span class="bullet">•</span><a href="/v5/api/contract/contract/">Contract</a></div><div style="padding-left: 84px"><span class="bullet">•</span><a href="/v5/api/contract/contract/#contract--creating">Creating Instances</a></div><div style="padding-left: 84px"><span class="bullet">•</span><a href="/v5/api/contract/contract/#contrct--properties">Properties</a></div><div style="padding-left: 84px"><span class="bullet">•</span><a href="/v5/api/contract/contract/#Contract--methods">Methods</a></div><div style="padding-left: 84px"><span class="bullet">•</span><a href="/v5/api/contract/contract/#Contract--events">Events</a></div><div style="padding-left: 84px"><span class="bullet">•</span><a href="/v5/api/contract/contract/#contract--metaclass">Meta-Class</a></div><div style="padding-left: 56px"><span class="bullet">•</span><a href="/v5/api/contract/contract-factory/">ContractFactory</a></div><div style="padding-left: 84px"><span class="bullet">•</span><a href="/v5/api/contract/contract-factory/#ContractFactory--creating">Creating Instances</a></div><div style="padding-left: 84px"><span class="bullet">•</span><a href="/v5/api/contract/contract-factory/#ContractFactory--properties">Properties</a></div><div style="padding-left: 84px"><span class="bullet">•</span><a href="/v5/api/contract/contract-factory/#ContractFactory--methods">Methods</a></div><div style="padding-left: 56px"><span class="bullet">•</span><a href="/v5/api/contract/example/">Example: ERC-20 Contract</a></div><div style="padding-left: 84px"><span class="b
|
||
|
|
|
||
|
|
<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></p>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="footer">
|
||
|
|
<div class="nav previous"><!--PREV_LINK--></div>
|
||
|
|
<div class="nav next"><a href="/v5/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 License</a>. Generated on June 8, 2020, 10:6pm.</div>
|
||
|
|
</div>
|
||
|
|
<script src="/v5/static/script.js" type="text/javascript"></script>
|
||
|
|
</body>
|
||
|
|
</html>
|