4052 lines
702 KiB
HTML
4052 lines
702 KiB
HTML
<!DOCTYPE html>
|
|
<html class="single-page">
|
|
<head>
|
|
<title>ethers</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</div></a></div>
|
|
</div>
|
|
<div class="toc"><div>
|
|
<div class="link title"><a href="/v5/single-page/">Documentation</a></div><div class="show show link depth-1"><a href="#/v5/getting-started/">Getting Started</a></div><div class="show show link depth-1"><a href="#/v5/concepts/">Ethereum Basics</a></div><div class="show show link depth-2"><a href="#/v5/concepts/events/">Events</a></div><div class="show show link depth-2"><a href="#/v5/concepts/gas/">Gas</a></div><div class="show show link depth-2"><a href="#/v5/concepts/security/">Security</a></div><div class="show show link depth-1"><a href="#/v5/api/">Application Programming Interface</a></div><div class="show show link depth-2"><a href="#/v5/api/contract/">Contract Interaction</a></div><div class="show show link depth-3"><a href="#/v5/api/contract/contract/">Contract</a></div><div class="show show link depth-3"><a href="#/v5/api/contract/contract-factory/">ContractFactory</a></div><div class="show show link depth-3"><a href="#/v5/api/contract/example/">Example: ERC-20 Contract</a></div><div class="show show link depth-2"><a href="#/v5/api/signer/">Signers</a></div><div class="show show link depth-2"><a href="#/v5/api/providers/">Providers</a></div><div class="show show link depth-3"><a href="#/v5/api/providers/provider/">Provider</a></div><div class="show show link depth-3"><a href="#/v5/api/providers/jsonrpc-provider/">JsonRpcProvider</a></div><div class="show show link depth-3"><a href="#/v5/api/providers/api-providers/">API Providers</a></div><div class="show show link depth-3"><a href="#/v5/api/providers/other/">Other Providers</a></div><div class="show show link depth-3"><a href="#/v5/api/providers/types/">Types</a></div><div class="show show link depth-2"><a href="#/v5/api/utils/">Utilities</a></div><div class="show show link depth-3"><a href="#/v5/api/utils/abi/">Application Binary Interface</a></div><div class="show show link depth-4"><a href="#/v5/api/utils/abi/coder/">AbiCoder</a></div><div class="show show link depth-4"><a href="#/v5/api/utils/abi/formats/">ABI Formats</a></div><div class="show show link depth-4"><a href="#/v5/api/utils/abi/fragments/">Fragments</a></div><div class="show show link depth-4"><a href="#/v5/api/utils/abi/interface/">Interface</a></div><div class="show show link depth-3"><a href="#/v5/api/utils/address/">Addresses</a></div><div class="show show link depth-3"><a href="#/v5/api/utils/bignumber/">BigNumber</a></div><div class="show show link depth-3"><a href="#/v5/api/utils/bytes/">Byte Manipulation</a></div><div class="show show link depth-3"><a href="#/v5/api/utils/constants/">Constants</a></div><div class="show show link depth-3"><a href="#/v5/api/utils/display-logic/">Display Logic and Input</a></div><div class="show show link depth-3"><a href="#/v5/api/utils/encoding/">Encoding Utilities</a></div><div class="show show link depth-3"><a href="#/v5/api/utils/fixednumber/">FixedNumber</a></div><div class="show show link depth-3"><a href="#/v5/api/utils/hashing/">Hashing Algorithms</a></div><div class="show show link depth-3"><a href="#/v5/api/utils/hdnode/">HD Wallet</a></div><div class="show show link depth-3"><a href="#/v5/api/utils/logger/">Logging</a></div><div class="show show link depth-3"><a href="#/v5/api/utils/properties/">Property Utilities</a></div><div class="show show link depth-3"><a href="#/v5/api/utils/signing-key/">Signing Key</a></div><div class="show show link depth-3"><a href="#/v5/api/utils/strings/">Strings</a></div><div class="show show link depth-3"><a href="#/v5/api/utils/transactions/">Transactions</a></div><div class="show show link depth-3"><a href="#/v5/api/utils/web/">Web Utilities</a></div><div class="show show link depth-3"><a href="#/v5/api/utils/wordlists/">Wordlists</a></div><div class="show show link depth-2"><a href="#/v5/api/other/">Other Libraries</a></div><div class="show show link depth-3"><a href="#/v5/api/other/assembly/">Assembly</a></div><div class="show show link depth-4"><a href="#/v5/api/other/assembly/dialect/">Ethers ASM Dialect</a></div><div class="show show link depth-4"><a href="#/v5/api/other/assembly/api/">Utilities</a></div><div class="show show link depth-4"><a href="#/v5/api/other/assembly/ast/">Abstract Syntax Tree</a></div><div class="show show link depth-3"><a href="#/v5/api/other/hardware/">Hardware Wallets</a></div><div class="show show link depth-2"><a href="#/v5/api/experimental/">Experimental</a></div><div class="show show link depth-1"><a href="#/v5/cli/">Command Line Interfaces</a></div><div class="show show link depth-2"><a href="#/v5/cli/ethers/">Sandbox Utility</a></div><div class="show show link depth-2"><a href="#/v5/cli/asm/">Assembler</a></div><div class="show show link depth-2"><a href="#/v5/cli/ens/">Ethereum Naming Service</a></div><div class="show show link depth-2"><a href="#/v5/cli/typescript/">TypeScript</a></div><div class="show show link depth-2"><a href="#/v5/cli/plugin/">Making Your Own</a></div><div class="show show link depth-1"><a href="#/v5/cookbook/">Cookbook</a></div><div class="show show link depth-1"><a href="#/v5/migration/">Migration Guide</a></div><div class="show show link depth-2"><a href="#/v5/migration/web3/">Migration: From Web3.js</a></div><div class="show show link depth-2"><a href="#/v5/migration/ethers-v4/">Migration: From Ethers v4</a></div><div class="show show link depth-1"><a href="#/v5/testing/">Testing</a></div><div class="show show link depth-1"><a href="#/v5/contributing/">Contributing and Hacking</a></div><div class="show show link depth-1"><a href="#/v5/documentation/">Flatworm Docs</a></div><div class="show show link depth-1"><a href="#/v5/license/">License and Copyright</a></div>
|
|
</div></div>
|
|
</div>
|
|
<div class="content">
|
|
<div class="breadcrumbs"><!--BREADCRUMBS--></div>
|
|
<a name="/v5/-%23-documentation"></a><a name="/v5/-%23-documentation"></a><a name="/v5/"></a><h1 class="show-anchors"><div>Documentation<div class="anchors"><a class="self" href="#/v5/-%23-documentation"></a></div></div></h1>
|
|
<a name="/v5/-%23-preamble"></a><a name="/v5/-%23-documentation--preamble"></a><a name="/v5/"></a><h2 class="show-anchors"><div>What is Ethers?<div class="anchors"><a class="self" href="#/v5/-%23-preamble"></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="/v5/-%23-features"></a><a name="/v5/-%23-documentation--features"></a><a name="/v5/"></a><h2 class="show-anchors"><div>Features<div class="anchors"><a class="self" href="#/v5/-%23-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="/v5/-%23-documentation--developer-documentation"></a><a name="/v5/"></a><h2 class="show-anchors"><div>Developer Documentation<div class="anchors"><a class="self" href="#/v5/-%23-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: 0px"><span class="bullet">•</span><a href="#/v5/concepts/">Ethereum Basics</a></div><div style="padding-left: 0px"><span class="bullet">•</span><a href="#/v5/api/">Application Programming Interface</a></div><div style="padding-left: 0px"><span class="bullet">•</span><a href="#/v5/cli/">Command Line Interfaces</a></div><div style="padding-left: 0px"><span class="bullet">•</span><a href="#/v5/cookbook/">Cookbook</a></div><div style="padding-left: 0px"><span class="bullet">•</span><a href="#/v5/migration/">Migration Guide</a></div><div style="padding-left: 0px"><span class="bullet">•</span><a href="#/v5/testing/">Testing</a></div><div style="padding-left: 0px"><span class="bullet">•</span><a href="#/v5/contributing/">Contributing and Hacking</a></div><div style="padding-left: 0px"><span class="bullet">•</span><a href="#/v5/documentation/">Flatworm Docs</a></div><div style="padding-left: 0px"><span class="bullet">•</span><a href="#/v5/license/">License and Copyright</a></div></div><a name="/v5/-%23-documentation--legacy"></a><a name="/v5/-%23-documentation--documentation--legacy"></a><a name="/v5/"></a><h2 class="show-anchors"><div>Legacy Documentation<div class="anchors"><a class="self" href="#/v5/-%23-documentation--legacy"></a></div></div></h2><p>This section will be kept up to date, linking to documentation of older versions of the library.</p>
|
|
|
|
<p><ul><li><a href="https://docs.ethers.io/v4/">version 4.0</a> </li><li><a href="https://docs.ethers.io/v3/">version 3.0</a> </li></ul></p>
|
|
|
|
<div class="page-separator"></div><a name="/v5/getting-started/-%23-getting-started"></a><a name="/v5/getting-started/-%23-getting-started"></a><a name="/v5/getting-started/"></a><h1 class="show-anchors"><div>Getting Started<div class="anchors"><a class="self" href="#/v5/getting-started/-%23-getting-started"></a></div></div></h1>
|
|
<a name="/v5/getting-started/-%23-installing"></a><a name="/v5/getting-started/-%23-getting-started--installing"></a><a name="/v5/getting-started/"></a><h2 class="show-anchors"><div>Installing<div class="anchors"><a class="self" href="#/v5/getting-started/-%23-installing"></a></div></div></h2><p>The various Classes and Functions are available to be imported manually from sub-packages under the <a href="https://www.npmjs.com/search?q=%40ethersproject%2F">@ethersproject</a> organization but for most projects, the umbrella package is the easiest way to get started.</p>
|
|
|
|
<div class="code">/home/ricmoo> npm install --save ethers@next</div><a name="/v5/getting-started/-%23-importing"></a><a name="/v5/getting-started/-%23-getting-started--importing"></a><a name="/v5/getting-started/"></a><h2 class="show-anchors"><div>Importing<div class="anchors"><a class="self" href="#/v5/getting-started/-%23-importing"></a></div></div></h2>
|
|
<a name="/v5/getting-started/-%23-getting-started--importing--node-js"></a><a name="/v5/getting-started/"></a><h3 class="show-anchors"><div>Node.js<div class="anchors"><a class="self" href="#/v5/getting-started/-%23-getting-started--importing--node-js"></a></div></div></h3>
|
|
<div class="code-title"><div>node.js require</div></div><div class="code">const { ethers } = require("ethers");
|
|
</div><div class="code-title"><div>ES6 or TypeScript</div></div><div class="code">import { ethers } from "ethers";
|
|
</div><a name="/v5/getting-started/-%23-getting-started--importing--web-browser"></a><a name="/v5/getting-started/"></a><h3 class="show-anchors"><div>Web Browser<div class="anchors"><a class="self" href="#/v5/getting-started/-%23-getting-started--importing--web-browser"></a></div></div></h3><p>It is generally better practice (for security reasons) to copy the <a href="https://cdn.ethers.io/lib/ethers-5.0.esm.min.js">ethers library</a> to your own webserver and serve it yourself.</p>
|
|
|
|
<p>For quick demos or prototyping though, it can be loaded in your Web Applications from our CDN.</p>
|
|
|
|
<div class="code-title"><div>ES6 in the Browser</div></div><div class="code"><script src="https://cdn.ethers.io/lib/ethers-5.0.esm.min.js"
|
|
type="application/javascipt"></script></div><div class="code-title"><div>ES3 (UMD) in the Browser</div></div><div class="code"><script src="https://cdn.ethers.io/lib/ethers-5.0.umd.min.js"
|
|
type="application/javascipt"></script></div><a name="/v5/getting-started/-%23-getting-started--glossary"></a><a name="/v5/getting-started/-%23-getting-started--getting-started--glossary"></a><a name="/v5/getting-started/"></a><h2 class="show-anchors"><div>Common Terminology<div class="anchors"><a class="self" href="#/v5/getting-started/-%23-getting-started--glossary"></a></div></div></h2><p>This section needs work...</p>
|
|
|
|
<table class="table minimal"><tr><td align="left"><b>Provider</b></td><td align="left">A Provider (in ethers) is a class which provides an abstraction for a connection to the Ethereum Network. It provides read-only access to the Blockchain and its status.</td><td class="fix"> </td></tr><tr><td align="left"><b>Signer</b></td><td align="left">A Signer is a class which (usually) in some way directly or indirectly has access to a private key, which can sign messages and transactions to authorize the network to charge your account ether to perform operations.</td><td class="fix"> </td></tr><tr><td align="left"><b>Contract</b></td><td align="left">A Contract is an abstraction which represents a connection to a specific contract on the Ethereum Network, so that it can be used like a normal JavaScipt object.</td><td class="fix"> </td></tr><tr><td class="table-title" colspan="2">Common Terms</td><td class="fix"> </td></tr></table><a name="/v5/getting-started/-%23-getting-started--connecting"></a><a name="/v5/getting-started/-%23-getting-started--getting-started--connecting"></a><a name="/v5/getting-started/"></a><h2 class="show-anchors"><div>Connecting to Ethereum: Metamask<div class="anchors"><a class="self" href="#/v5/getting-started/-%23-getting-started--connecting"></a></div></div></h2><p>The quickest and easiest way to experiment and begin developing on Ethereum is to use <a href="https://metamask.io/">Metamask</a>, which is a browser extension that provides:</p>
|
|
|
|
<p><ul><li>A connection to the Ethereum network (a <a href="#/v5/api/providers/provider/">Provider</a>) </li><li>Holds your private key and can sign things (a <a href="#/v5/api/signer/-%23-Signer">Signer</a>) </li></ul></p>
|
|
|
|
<div class="code-title"><div>Connecting to Metamask</div></div><div class="code"><span class="comment">// A Web3Provider wraps a standard Web3 provider, which is
|
|
</span><span class="comment">// what Metamask injects as window.ethereum into each page
|
|
</span>const provider = new ethers.providers.Web3Provider(window.ethereum)
|
|
|
|
<span class="comment">// The Metamask plugin also allows signing transactions to
|
|
</span><span class="comment">// send ether and pay to change state within the blockchain.
|
|
</span><span class="comment">// For this, we need the account signer...
|
|
</span>const signer = provider.getSigner()
|
|
</div><a name="/v5/getting-started/-%23-getting-started--querying"></a><a name="/v5/getting-started/-%23-getting-started--getting-started--connecting--getting-started--querying"></a><a name="/v5/getting-started/"></a><h3 class="show-anchors"><div>Querying the Blockchain<div class="anchors"><a class="self" href="#/v5/getting-started/-%23-getting-started--querying"></a></div></div></h3><p>Once you have a <a href="#/v5/api/providers/provider/">Provider</a>, you have a read-only connection to the blockchain, which can be used to query the current state, fetch historic logs, look up deployed code and so on.</p>
|
|
|
|
<div class="code-title"><div>Basic Queries</div></div><div class="code"><span class="comment">// Look up the current block number
|
|
</span>provider.getBlockNumber()
|
|
<span class="result ok">// { Promise: 10384649 }
|
|
</span>
|
|
<span class="comment">// Get the balance of an account (by address or ENS name)
|
|
</span>balance = await provider.getBalance("ethers.eth")
|
|
<span class="result ok">// { BigNumber: "2337132817842795605" }
|
|
</span>
|
|
<span class="comment">// Often you will need to format the output for the user
|
|
</span><span class="comment">// which prefer to see values in ether (instead of wei)
|
|
</span>ethers.utils.formatEther(balance)
|
|
<span class="result ok">// '2.337132817842795605'
|
|
</span>
|
|
<span class="comment">// Or if a user enters a string in an input field, you may need
|
|
</span><span class="comment">// to convert it from ether (as a string) to wei (as a BigNumber)
|
|
</span>ethers.utils.parseEther("1.0")
|
|
<span class="result ok">// { BigNumber: "1000000000000000000" }
|
|
</span></div><a name="/v5/getting-started/-%23-getting-started--sending"></a><a name="/v5/getting-started/-%23-getting-started--getting-started--connecting--getting-started--sending"></a><a name="/v5/getting-started/"></a><h3 class="show-anchors"><div>Writing to the Blockchain<div class="anchors"><a class="self" href="#/v5/getting-started/-%23-getting-started--sending"></a></div></div></h3>
|
|
<div class="code-title"><div>Sending Ether</div></div><div class="code"><span class="comment">// Send 1 ether to an ens name.
|
|
</span>const tx = signer.sendTransaction({
|
|
to: "ricmoo.firefly.eth",
|
|
value: ethers.utils.parseEther("1.0")
|
|
});
|
|
</div><a name="/v5/getting-started/-%23-getting-started--contracts"></a><a name="/v5/getting-started/-%23-getting-started--getting-started--contracts"></a><a name="/v5/getting-started/"></a><h2 class="show-anchors"><div>Contracts<div class="anchors"><a class="self" href="#/v5/getting-started/-%23-getting-started--contracts"></a></div></div></h2><p>A Contract is an abstraction of program code which lives on the Ethereum blockchain.</p>
|
|
|
|
<p>The <a href="#/v5/api/contract/contract/">Contract</a> object makes it easier to use an on-chain Contract as a normal JavaScript object, with the method all mapped to encoding and decoding data for you.</p>
|
|
|
|
<p>If you are familiar with Databases, this is similar to ORM.</p>
|
|
|
|
<p>In order to communicate with the Contract on-chain, this class needs to know what methods are available and how to encode and decode the data, which is what the <i>Application Binary Interface</i> (API) provides.</p>
|
|
|
|
<p>This class is a meta-class, which means its methods are constructed at runtime, when you pass in the ABI to the constructor it uses that to determine which methods to add.</p>
|
|
|
|
<p>While a on-chain Contract may have many methods available, you can safely ignore any methods you don't need or use, providing a smaller subset of the ABI to the contract.</p>
|
|
|
|
<p>An ABI often comes from the Solidity or Vyper compiler, but may also be placed in the code easily using the Human-Readable ABI, which the following examples use.</p>
|
|
|
|
<div class="code-title"><div>Connecting to the DAI Contract</div></div><div class="code"><span class="comment">// We can use an ENS name for the contract address
|
|
</span>const daiAddress = "dai.tokens.ethers.eth";
|
|
|
|
<span class="comment">// The ERC-20 Contract ABI, which is a common contract interface
|
|
</span><span class="comment">// for tokens (this is the Human-Readable ABI format)
|
|
</span>const daiAbi = [
|
|
<span class="comment"> // Some simple details about the token
|
|
</span> "function name() view returns (string)",
|
|
"function symbol() view returns (string)",
|
|
|
|
<span class="comment"> // Get the account balance
|
|
</span> "function balanceOf(address) view returns (uint)",
|
|
|
|
<span class="comment"> // Send some of your tokens to someone else
|
|
</span> "function transfer(address to, uint amount)",
|
|
|
|
<span class="comment"> // An event triggered whenever anyone transfers to someone else
|
|
</span> "event Transfer(address indexed from, address indexed to, uint amount)"
|
|
];
|
|
|
|
<span class="comment">// The Contract object
|
|
</span>const daiContract = new ethers.Contract(daiAddress, daiAbi, provider);
|
|
</div><a name="/v5/getting-started/-%23-getting-started--reading"></a><a name="/v5/getting-started/-%23-getting-started--getting-started--contracts--getting-started--reading"></a><a name="/v5/getting-started/"></a><h3 class="show-anchors"><div>Read-Only Methods<div class="anchors"><a class="self" href="#/v5/getting-started/-%23-getting-started--reading"></a></div></div></h3>
|
|
<div class="code-title"><div>Querying the DAI Contract</div></div><div class="code"><span class="comment">// Get the ERC-20 token name
|
|
</span>daiContract.name()
|
|
<span class="result ok">// { Promise: 'Dai Stablecoin' }
|
|
</span>
|
|
<span class="comment">// Get the ERC-20 token synbol (for tickers and UIs)
|
|
</span>daiContract.symbol()
|
|
<span class="result ok">// { Promise: 'DAI' }
|
|
</span>
|
|
<span class="comment">// Get the balance of an address
|
|
</span>balance = await daiContract.balanceOf("ricmoo.firefly.eth")
|
|
<span class="result ok">// { BigNumber: "8814410125722568213383" }
|
|
</span>
|
|
<span class="comment">// Format the DAI for displaying to the user
|
|
</span>ethers.utils.formatUnits(balance, 18)
|
|
<span class="result ok">// '8814.410125722568213383'
|
|
</span></div><a name="/v5/getting-started/-%23-getting-started--writing"></a><a name="/v5/getting-started/-%23-getting-started--getting-started--contracts--getting-started--writing"></a><a name="/v5/getting-started/"></a><h3 class="show-anchors"><div>State Changing Methods<div class="anchors"><a class="self" href="#/v5/getting-started/-%23-getting-started--writing"></a></div></div></h3>
|
|
<div class="code-title"><div>Sending DAI</div></div><div class="code"><span class="comment">// The DAI Contract is currently connected to the Provider,
|
|
</span><span class="comment">// which is read-only. We need to connect to a Signer, so
|
|
</span><span class="comment">// that we can pay to send state-changing transactions.
|
|
</span>const daiWithSigner = contract.connect(signer);
|
|
|
|
<span class="comment">// Each DAI has 18 decimal places
|
|
</span>const dai = ethers.utils.parseUnits("1.0", 18);
|
|
|
|
<span class="comment">// Send 1 DAI to "ricmoo.firefly.eth"
|
|
</span>tx = daiWithSigner.transfer("ricmoo.firefly.eth", dai);
|
|
</div><a name="/v5/getting-started/-%23-getting-started--events"></a><a name="/v5/getting-started/-%23-getting-started--getting-started--contracts--getting-started--events"></a><a name="/v5/getting-started/"></a><h3 class="show-anchors"><div>Listening to Events<div class="anchors"><a class="self" href="#/v5/getting-started/-%23-getting-started--events"></a></div></div></h3>
|
|
<div class="code-title"><div>Listening to Events</div></div><div class="code"><span class="comment">// Receive an event when ANY transfer occurs
|
|
</span>daiContract.on("Transfer", (from, to, amount, event) => {
|
|
console.log(`${ from } sent ${ formatEther(amount) } to ${ to}`);
|
|
<span class="comment"> // The event object contains the verbatim log data, the
|
|
</span><span class="comment"> // EventFragment and functions to fetch the block,
|
|
</span><span class="comment"> // transaction and receipt and event functions
|
|
</span>});
|
|
|
|
<span class="comment">// A filter for when a specific address receives tokens
|
|
</span>myAddress = "0x8ba1f109551bD432803012645Ac136ddd64DBA72";
|
|
filter = daiContract.filters.Transfer(null, myAddress)
|
|
<span class="result ok">// {
|
|
</span><span class="result ok">// address: 'dai.tokens.ethers.eth',
|
|
</span><span class="result ok">// topics: [
|
|
</span><span class="result ok">// '0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef',
|
|
</span><span class="result ok">// null,
|
|
</span><span class="result ok">// '0x0000000000000000000000008ba1f109551bd432803012645ac136ddd64dba72'
|
|
</span><span class="result ok">// ]
|
|
</span><span class="result ok">// }
|
|
</span>
|
|
<span class="comment">// Receive an event when that filter occurs
|
|
</span>daiContract.on(filter, (from, to, amount, event) => {
|
|
<span class="comment"> // The to will always be "address"
|
|
</span> console.log(`I got ${ formatEther(amount) } from ${ from }.`);
|
|
});
|
|
</div><a name="/v5/getting-started/-%23-getting-started--history"></a><a name="/v5/getting-started/-%23-getting-started--getting-started--contracts--getting-started--history"></a><a name="/v5/getting-started/"></a><h3 class="show-anchors"><div>Query Historic Events<div class="anchors"><a class="self" href="#/v5/getting-started/-%23-getting-started--history"></a></div></div></h3>
|
|
<div class="code-title"><div>Filtering Historic Events</div></div><div class="code"><span class="comment">// Get the address of the Signer
|
|
</span>myAddress = await signer.getAddress()
|
|
<span class="result ok">// '0x8ba1f109551bD432803012645Ac136ddd64DBA72'
|
|
</span>
|
|
<span class="comment">// Filter for all token transfers to me
|
|
</span>filterFrom = daiContract.filters.Transfer(myAddress, null);
|
|
<span class="result ok">// {
|
|
</span><span class="result ok">// address: 'dai.tokens.ethers.eth',
|
|
</span><span class="result ok">// topics: [
|
|
</span><span class="result ok">// '0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef',
|
|
</span><span class="result ok">// '0x0000000000000000000000008ba1f109551bd432803012645ac136ddd64dba72'
|
|
</span><span class="result ok">// ]
|
|
</span><span class="result ok">// }
|
|
</span>
|
|
<span class="comment">// Filter for all token transfers from me
|
|
</span>filterTo = daiContract.filters.Transfer(null, myAddress);
|
|
<span class="result ok">// {
|
|
</span><span class="result ok">// address: 'dai.tokens.ethers.eth',
|
|
</span><span class="result ok">// topics: [
|
|
</span><span class="result ok">// '0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef',
|
|
</span><span class="result ok">// null,
|
|
</span><span class="result ok">// '0x0000000000000000000000008ba1f109551bd432803012645ac136ddd64dba72'
|
|
</span><span class="result ok">// ]
|
|
</span><span class="result ok">// }
|
|
</span>
|
|
<span class="comment">// List all transfers sent from me a specific block range
|
|
</span>daiContract.queryFilter(filterFrom, 9843470, 9843480)
|
|
<span class="result ok">// { Promise: [
|
|
</span><span class="result ok">// {
|
|
</span><span class="result ok">// address: '0x6B175474E89094C44Da98b954EedeAC495271d0F',
|
|
</span><span class="result ok">// args: [
|
|
</span><span class="result ok">// '0x8ba1f109551bD432803012645Ac136ddd64DBA72',
|
|
</span><span class="result ok">// '0x8B3765eDA5207fB21690874B722ae276B96260E0',
|
|
</span><span class="result ok">// { BigNumber: "4750000000000000000" }
|
|
</span><span class="result ok">// ],
|
|
</span><span class="result ok">// blockHash: '0x8462eb2fbcef5aa4861266f59ad5f47b9aa6525d767d713920fdbdfb6b0c0b78',
|
|
</span><span class="result ok">// blockNumber: 9843476,
|
|
</span><span class="result ok">// data: '0x00000000000000000000000000000000000000000000000041eb63d55b1b0000',
|
|
</span><span class="result ok">// decode: [Function],
|
|
</span><span class="result ok">// event: 'Transfer',
|
|
</span><span class="result ok">// eventSignature: 'Transfer(address,address,uint256)',
|
|
</span><span class="result ok">// getBlock: [Function],
|
|
</span><span class="result ok">// getTransaction: [Function],
|
|
</span><span class="result ok">// getTransactionReceipt: [Function],
|
|
</span><span class="result ok">// logIndex: 69,
|
|
</span><span class="result ok">// removeListener: [Function],
|
|
</span><span class="result ok">// removed: false,
|
|
</span><span class="result ok">// topics: [
|
|
</span><span class="result ok">// '0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef',
|
|
</span><span class="result ok">// '0x0000000000000000000000008ba1f109551bd432803012645ac136ddd64dba72',
|
|
</span><span class="result ok">// '0x0000000000000000000000008b3765eda5207fb21690874b722ae276b96260e0'
|
|
</span><span class="result ok">// ],
|
|
</span><span class="result ok">// transactionHash: '0x1be23554545030e1ce47391a41098a46ff426382ed740db62d63d7676ff6fcf1',
|
|
</span><span class="result ok">// transactionIndex: 81
|
|
</span><span class="result ok">// },
|
|
</span><span class="result ok">// {
|
|
</span><span class="result ok">// address: '0x6B175474E89094C44Da98b954EedeAC495271d0F',
|
|
</span><span class="result ok">// args: [
|
|
</span><span class="result ok">// '0x8ba1f109551bD432803012645Ac136ddd64DBA72',
|
|
</span><span class="result ok">// '0x00De4B13153673BCAE2616b67bf822500d325Fc3',
|
|
</span><span class="result ok">// { BigNumber: "250000000000000000" }
|
|
</span><span class="result ok">// ],
|
|
</span><span class="result ok">// blockHash: '0x8462eb2fbcef5aa4861266f59ad5f47b9aa6525d767d713920fdbdfb6b0c0b78',
|
|
</span><span class="result ok">// blockNumber: 9843476,
|
|
</span><span class="result ok">// data: '0x00000000000000000000000000000000000000000000000003782dace9d90000',
|
|
</span><span class="result ok">// decode: [Function],
|
|
</span><span class="result ok">// event: 'Transfer',
|
|
</span><span class="result ok">// eventSignature: 'Transfer(address,address,uint256)',
|
|
</span><span class="result ok">// getBlock: [Function],
|
|
</span><span class="result ok">// getTransaction: [Function],
|
|
</span><span class="result ok">// getTransactionReceipt: [Function],
|
|
</span><span class="result ok">// logIndex: 70,
|
|
</span><span class="result ok">// removeListener: [Function],
|
|
</span><span class="result ok">// removed: false,
|
|
</span><span class="result ok">// topics: [
|
|
</span><span class="result ok">// '0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef',
|
|
</span><span class="result ok">// '0x0000000000000000000000008ba1f109551bd432803012645ac136ddd64dba72',
|
|
</span><span class="result ok">// '0x00000000000000000000000000de4b13153673bcae2616b67bf822500d325fc3'
|
|
</span><span class="result ok">// ],
|
|
</span><span class="result ok">// transactionHash: '0x1be23554545030e1ce47391a41098a46ff426382ed740db62d63d7676ff6fcf1',
|
|
</span><span class="result ok">// transactionIndex: 81
|
|
</span><span class="result ok">// }
|
|
</span><span class="result ok">// ] }
|
|
</span>
|
|
//
|
|
<span class="comment">// The following have had the results omitted due to the
|
|
</span><span class="comment">// number of entries; but they provide some useful examples
|
|
</span>//
|
|
|
|
<span class="comment">// List all transfers I sent in the last 10,000 blocks
|
|
</span>daiContract.queryFilter(filterFrom, -10000)
|
|
|
|
<span class="comment">// List all transfers ever sent to me
|
|
</span>daiContract.queryFilter(filterTo)
|
|
</div><a name="/v5/getting-started/-%23-getting-started--signing"></a><a name="/v5/getting-started/-%23-getting-started--getting-started--signing"></a><a name="/v5/getting-started/"></a><h2 class="show-anchors"><div>Signing Messages<div class="anchors"><a class="self" href="#/v5/getting-started/-%23-getting-started--signing"></a></div></div></h2>
|
|
<div class="code-title"><div>Signing Messages</div></div><div class="code"><span class="comment">// To sign a simple string, which can often be used for
|
|
</span><span class="comment">// logging into a service, such as CryptoKitties simply
|
|
</span><span class="comment">// pass the string in.
|
|
</span>signature = await signer.signMessage("Hello World");
|
|
<span class="result ok">// '0x9671c8b89473038593fddda5875debcb517dbfe79bd25119f6b0878bcd6c5e9d497e5d7f08cb7314da5d2a04b49bee0918d0b9e11744ee5a738b94e38986575f1c'
|
|
</span>
|
|
//
|
|
<span class="comment">// A common case is also signing a hash, which is 32
|
|
</span><span class="comment">// bytes. It is important to note, that to sign binary
|
|
</span><span class="comment">// data it MUST be an Array (or TypedArray)
|
|
</span>//
|
|
|
|
<span class="comment">// This string is 66 chacacters long
|
|
</span>message = "0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef"
|
|
|
|
<span class="comment">// This array representation is 32 bytes long
|
|
</span>messageBytes = ethers.utils.arrayify(message);
|
|
<span class="result ok">// Uint8Array [ 221, 242, 82, 173, 27, 226, 200, 155, 105, 194, 176, 104, 252, 55, 141, 170, 149, 43, 167, 241, 99, 196, 161, 22, 40, 245, 90, 77, 245, 35, 179, 239 ]
|
|
</span>
|
|
<span class="comment">// To sign a hash, you most often want to sign the bytes
|
|
</span>signature = await signer.signMessage(messageBytes)
|
|
<span class="result ok">// '0xfff17b9972cf8466bcde13dfc52afe6cbe39b86b1c9028d0fe4de6ab565ce01a48b7eba3663a24588e87798d924e8178f3c7c84d9363f57a9bee519f7cac50b31b'
|
|
</span></div><div class="page-separator"></div><a name="/v5/concepts/-%23-ethereum-basics"></a><a name="/v5/concepts/"></a><h1 class="show-anchors"><div>Ethereum Basics<div class="anchors"><a class="self" href="#/v5/concepts/-%23-ethereum-basics"></a></div></div></h1><p>This is a very breif overview of some aspects of <i>Ethereum</i> and blockchains which developers can make use of or should be aware of.</p>
|
|
|
|
<p>This section is fairly sparse at the moment, but will be expanded as time goes on.</p>
|
|
|
|
<div class="toc"><div style="padding-left: 0px"><span class="bullet">•</span><a href="#/v5/concepts/events/">Events</a></div><div style="padding-left: 0px"><span class="bullet">•</span><a href="#/v5/concepts/gas/">Gas</a></div><div style="padding-left: 0px"><span class="bullet">•</span><a href="#/v5/concepts/security/">Security</a></div></div><div class="page-separator"></div><a name="/v5/concepts/events/-%23-events"></a><a name="/v5/concepts/events/"></a><h1 class="show-anchors"><div>Events<div class="anchors"><a class="self" href="#/v5/concepts/events/-%23-events"></a></div></div></h1><p>Explain how topics and such work</p>
|
|
|
|
<a name="/v5/concepts/events/-%23-events--solidity-topics"></a><a name="/v5/concepts/events/"></a><h2 class="show-anchors"><div>Solidity Topics<div class="anchors"><a class="self" href="#/v5/concepts/events/-%23-events--solidity-topics"></a></div></div></h2><p>How to compute the topic...</p>
|
|
|
|
<a name="/v5/concepts/events/-%23-events--logs-and-filtering"></a><a name="/v5/concepts/events/"></a><h2 class="show-anchors"><div>Logs and Filtering<div class="anchors"><a class="self" href="#/v5/concepts/events/-%23-events--logs-and-filtering"></a></div></div></h2><p>Example hog logs are used.</p>
|
|
|
|
<p>Link to provider.getLogs and contract.on</p>
|
|
|
|
<a name="/v5/concepts/events/-%23-events--logs-and-filtering--filters"></a><a name="/v5/concepts/events/"></a><h3 class="show-anchors"><div>Filters<div class="anchors"><a class="self" href="#/v5/concepts/events/-%23-events--logs-and-filtering--filters"></a></div></div></h3><p>Filter are used as a way to query ... efficient, explain bloom filters lightly</p>
|
|
|
|
<p>A filter may have up to 4 topic-sets, where each topic-set refers to a condition that must match the log topic in that position (i.e. each condition is <code class="inline">AND</code>-ed together).</p>
|
|
|
|
<p>If a topic-set is <code class="inline">null</code>, a log topic in that position is not filtered at all and <b>any value</b> matches.</p>
|
|
|
|
<p>If a topic-set is a single topic, a log topic in that position must match <b>that topic</b>.</p>
|
|
|
|
<p>If a topic-set is an array of topics, a log topic in that position must match any <b>one</b> of the topics (i.e. the topic in this position are <code class="inline">OR</code>-ed).</p>
|
|
|
|
<table class="table full"><tr><td align="center" width="25%"><b>Topic-Sets</b></td><td align="center" colspan="3" width="75%"><b>Matching Logs</b></td><td class="fix"> </td></tr><tr><td align="center" width="25%">[ A ]</td><td align="left" colspan="3" rowspan="2" width="75%">topic[0] = A</td><td class="fix"> </td></tr><tr><td align="center" width="25%">[ A, null ]</td><td class="fix"> </td></tr><tr><td align="center" width="25%">[ null, B ]</td><td align="left" colspan="3" rowspan="3" width="75%">topic[1] = B</td><td class="fix"> </td></tr><tr><td align="center" width="25%">[ null, [ B ] ]</td><td class="fix"> </td></tr><tr><td align="center" width="25%">[ null, [ B ], null ]</td><td class="fix"> </td></tr><tr><td align="center" width="25%">[ A, B ]</td><td align="left" colspan="3" rowspan="3" width="75%">(topic[0] = A) <b>AND</b> (topic[1] = B)</td><td class="fix"> </td></tr><tr><td align="center" width="25%">[ A, [ B ] ]</td><td class="fix"> </td></tr><tr><td align="center" width="25%">[ A, [ B ], null ]</td><td class="fix"> </td></tr><tr><td align="center" width="25%">[ [ A, B ] ]</td><td align="left" colspan="3" rowspan="2" width="75%">(topic[0] = A) <b>OR</b> (topic[0] = B)</td><td class="fix"> </td></tr><tr><td align="center" width="25%">[ [ A, B ], null ]</td><td class="fix"> </td></tr><tr><td align="center" width="25%">[ [ A, B ], [ C, D ] ]</td><td align="left" colspan="3" width="75%"><b>[</b> (topic[0] = A) <b>OR</b> (topic[0] = B) <b>]</b> <b>AND</b> <b>[</b> (topic[1] = C) <b>OR</b> (topic[1] = D) <b>]</b></td><td class="fix"> </td></tr><tr><td class="table-title" colspan="4">Example Log Matching</td><td class="fix"> </td></tr></table><div class="code-title"><div>ERC-20 Transfer Filter Examples</div></div><div class="code"><span class="comment">// Short example of manually creating filters for an ERC-20
|
|
</span><span class="comment">// Transfer event.
|
|
</span>//
|
|
<span class="comment">// Most users should generally use the Contract API to
|
|
</span><span class="comment">// compute filters, as it is much simpler, but this is
|
|
</span><span class="comment">// provided as an illustration for those curious. See
|
|
</span><span class="comment">// below for examples of the equivalent Contract API.
|
|
</span>
|
|
<span class="comment">// ERC-20:
|
|
</span><span class="comment">// Transfer(address indexed src, address indexed dst, uint val)
|
|
</span>//
|
|
<span class="comment">// -------------------^
|
|
</span><span class="comment">// ----------------------------------------^
|
|
</span>//
|
|
<span class="comment">// Notice that only *src* and *dst* are *indexed*, so ONLY they
|
|
</span><span class="comment">// qualify for filtering.
|
|
</span>//
|
|
<span class="comment">// Also, note that in Solidity an Event uses the first topic to
|
|
</span><span class="comment">// identify the Event name; for Transfer this will be:
|
|
</span><span class="comment">// id("Transfer(address,address,uint256)")
|
|
</span>//
|
|
<span class="comment">// Other Notes:
|
|
</span><span class="comment">// - A topic must be 32 bytes; so shorter types must be padded
|
|
</span>
|
|
<span class="comment">// List all token transfers *from* myAddress
|
|
</span>filter = {
|
|
address: tokenAddress,
|
|
topics: [
|
|
id("Transfer(address,address,uint256)"),
|
|
hexZeroPad(myAddress, 32)
|
|
]
|
|
}
|
|
|
|
<span class="comment">// List all token transfers *to* myAddress:
|
|
</span>filter = {
|
|
address: tokenAddress,
|
|
topics: [
|
|
id("Transfer(address,address,uint256)"),
|
|
null,
|
|
hexZeroPad(myAddress, 32)
|
|
]
|
|
}
|
|
|
|
<span class="comment">// List all token transfers *to* myAddress or myOtherAddress:
|
|
</span>filter = {
|
|
address: tokenAddress,
|
|
topics: [
|
|
id("Transfer(address,address,uint256)"),
|
|
null,
|
|
[
|
|
hexZeroPad(myAddress, 32),
|
|
hexZeroPad(myOtherAddress, 32),
|
|
]
|
|
]
|
|
}
|
|
</div><p>To simplify life, ..., explain here, the contract API</p>
|
|
|
|
<div class="code-title"><div>ERC-20 Contract Filter Examples</div></div><div class="code">const abi = [
|
|
"event Transfer(address indexed src, address indexed dst, uint val)"
|
|
];
|
|
|
|
const contract = new Contract(tokenAddress, abi, provider);
|
|
|
|
<span class="comment">// List all token transfers *from* myAddress
|
|
</span>contract.filters.Transfer(myAddress)
|
|
<span class="result ok">// {
|
|
</span><span class="result ok">// address: '0x6B175474E89094C44Da98b954EedeAC495271d0F',
|
|
</span><span class="result ok">// topics: [
|
|
</span><span class="result ok">// '0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef',
|
|
</span><span class="result ok">// '0x0000000000000000000000008ba1f109551bd432803012645ac136ddd64dba72'
|
|
</span><span class="result ok">// ]
|
|
</span><span class="result ok">// }
|
|
</span>
|
|
<span class="comment">// List all token transfers *to* myAddress:
|
|
</span>contract.filters.Transfer(null, myAddress)
|
|
<span class="result ok">// {
|
|
</span><span class="result ok">// address: '0x6B175474E89094C44Da98b954EedeAC495271d0F',
|
|
</span><span class="result ok">// topics: [
|
|
</span><span class="result ok">// '0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef',
|
|
</span><span class="result ok">// null,
|
|
</span><span class="result ok">// '0x0000000000000000000000008ba1f109551bd432803012645ac136ddd64dba72'
|
|
</span><span class="result ok">// ]
|
|
</span><span class="result ok">// }
|
|
</span>
|
|
<span class="comment">// List all token transfers *from* myAddress *to* otherAddress:
|
|
</span>contract.filters.Transfer(myAddress, otherAddress)
|
|
<span class="result ok">// {
|
|
</span><span class="result ok">// address: '0x6B175474E89094C44Da98b954EedeAC495271d0F',
|
|
</span><span class="result ok">// topics: [
|
|
</span><span class="result ok">// '0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef',
|
|
</span><span class="result ok">// '0x0000000000000000000000008ba1f109551bd432803012645ac136ddd64dba72',
|
|
</span><span class="result ok">// '0x000000000000000000000000ea517d5a070e6705cc5467858681ed953d285eb9'
|
|
</span><span class="result ok">// ]
|
|
</span><span class="result ok">// }
|
|
</span>
|
|
<span class="comment">// List all token transfers *to* myAddress OR otherAddress:
|
|
</span>contract.filters.Transfer(null, [ myAddress, otherAddress ])
|
|
<span class="result ok">// {
|
|
</span><span class="result ok">// address: '0x6B175474E89094C44Da98b954EedeAC495271d0F',
|
|
</span><span class="result ok">// topics: [
|
|
</span><span class="result ok">// '0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef',
|
|
</span><span class="result ok">// null,
|
|
</span><span class="result ok">// [
|
|
</span><span class="result ok">// '0x0000000000000000000000008ba1f109551bd432803012645ac136ddd64dba72',
|
|
</span><span class="result ok">// '0x000000000000000000000000ea517d5a070e6705cc5467858681ed953d285eb9'
|
|
</span><span class="result ok">// ]
|
|
</span><span class="result ok">// ]
|
|
</span><span class="result ok">// }
|
|
</span></div><a name="/v5/concepts/events/-%23-events--logs-and-filtering--other-things-todo"></a><a name="/v5/concepts/events/"></a><h3 class="show-anchors"><div>Other Things? TODO<div class="anchors"><a class="self" href="#/v5/concepts/events/-%23-events--logs-and-filtering--other-things-todo"></a></div></div></h3><p>Explain what happens to strings and bytes, how to filter and retain the value</p>
|
|
|
|
<div class="page-separator"></div><a name="/v5/concepts/gas/-%23-gas"></a><a name="/v5/concepts/gas/-%23-gas"></a><a name="/v5/concepts/gas/"></a><h1 class="show-anchors"><div>Gas<div class="anchors"><a class="self" href="#/v5/concepts/gas/-%23-gas"></a></div></div></h1><p>Explain attack vectors</p>
|
|
|
|
<a name="/v5/concepts/gas/-%23-gas-price"></a><a name="/v5/concepts/gas/-%23-gas--gas-price"></a><a name="/v5/concepts/gas/"></a><h2 class="show-anchors"><div>Gas Price<div class="anchors"><a class="self" href="#/v5/concepts/gas/-%23-gas-price"></a></div></div></h2><p>The gas price is used somewhat like a bid, indicating an amount you are willing to pay (per unit of execution) to have your transaction processed.</p>
|
|
|
|
<a name="/v5/concepts/gas/-%23-gas-limit"></a><a name="/v5/concepts/gas/-%23-gas--gas-limit"></a><a name="/v5/concepts/gas/"></a><h2 class="show-anchors"><div>Gas Limit<div class="anchors"><a class="self" href="#/v5/concepts/gas/-%23-gas-limit"></a></div></div></h2>
|
|
<div class="page-separator"></div><a name="/v5/concepts/security/-%23-security"></a><a name="/v5/concepts/security/-%23-security"></a><a name="/v5/concepts/security/"></a><h1 class="show-anchors"><div>Security<div class="anchors"><a class="self" href="#/v5/concepts/security/-%23-security"></a></div></div></h1>
|
|
<a name="/v5/concepts/security/-%23-security--pbkdf"></a><a name="/v5/concepts/security/-%23-security--security--pbkdf"></a><a name="/v5/concepts/security/"></a><h2 class="show-anchors"><div>Key Derivation Functions<div class="anchors"><a class="self" href="#/v5/concepts/security/-%23-security--pbkdf"></a></div></div></h2><p>This is not specific to Ethereum, but is a useful technique to understand and has some implications on User Experience.</p>
|
|
|
|
<p>Many people are concerned that encrypting and decrypting an Ethereum wallet is quite slow and can take quite some time. It is important to understand this is intentional and provides much stronger security.</p>
|
|
|
|
<p>The algorithm usually used for this process is <a href="https://en.wikipedia.org/wiki/Scrypt">scrypt</a>, which is a memory and CPU intensive algorithm which computes a key (fixed-length pseudo-random series of bytes) for a given password.</p>
|
|
|
|
<a name="/v5/concepts/security/-%23-security--security--pbkdf--why-does-it-take-so-long"></a><a name="/v5/concepts/security/"></a><h3 class="show-anchors"><div>Why does it take so long?<div class="anchors"><a class="self" href="#/v5/concepts/security/-%23-security--security--pbkdf--why-does-it-take-so-long"></a></div></div></h3><p>The goal is to use as much CPU and memory as possible during this algorithm, so that a single computer can only compute a very small number of results for some fixed amount of time. To scale up an attack, the attacker requires additional compuers, increasing the cost to <a href="https://en.wikipedia.org/wiki/Brute-force_attack">brute-force attack</a> to guess the password.</p>
|
|
|
|
<p>For example, if a user knows their correct password, this process may take 10 seconds for them to unlock their own wallet and proceed.</p>
|
|
|
|
<p>But since an attacker does not know the password, they must guess; and each guess also requires 10 seconds. So, if they wish to try guessing 1 million passwords, their computer would be completely tied up for 10 million seconds, or around 115 days.</p>
|
|
|
|
<p>Without using an algorithm like this, a user would be able to log in instantly, however, 1 million passwords would only take a few seconds to attempt. Even secure passwords would likely be broken within a short period of time. There is no way the algorithm can be faster for a legitimate user without also being faster for an attacker.</p>
|
|
|
|
<a name="/v5/concepts/security/-%23-security--security--pbkdf--mitigating-the-user-experience"></a><a name="/v5/concepts/security/"></a><h3 class="show-anchors"><div>Mitigating the User Experience<div class="anchors"><a class="self" href="#/v5/concepts/security/-%23-security--security--pbkdf--mitigating-the-user-experience"></a></div></div></h3><p>Rather than reducing the security (see below), a better practice is to make the user feel better about waiting. The Ethers encryption and decryption API allows the developer to incorporate a progress bar, by passing in a progress callback which will be periodically called with a number between 0 and 1 indication percent completion.</p>
|
|
|
|
<p>In general a progress bar makes the experience feel faster, as well as more comfortable since there is a clear indication how much (relative) time is remaining. Additionally, using language like <i>"decrypting..."</i> in a progress bar makes a user feel like there time is not being <i>needlessly</i> wasted.</p>
|
|
|
|
<a name="/v5/concepts/security/-%23-security--security--pbkdf--work-arounds-not-recommended"></a><a name="/v5/concepts/security/"></a><h3 class="show-anchors"><div>Work-Arounds (not recommended)<div class="anchors"><a class="self" href="#/v5/concepts/security/-%23-security--security--pbkdf--work-arounds-not-recommended"></a></div></div></h3><p>There are ways to reduce the time required to decrypt an Ethereum JSON Wallet, but please keep in mind that doing so <b>discards nearly all security</b> on that wallet.</p>
|
|
|
|
<p>The scrypt algorithm is designed to be tuned. The main purpose of this is to increase the difficulty as time goes on and computers get faster, but it can also be tuned down in situations where the security is less important.</p>
|
|
|
|
<div class="code"><span class="comment">// Our wallet object
|
|
</span>const wallet = Wallet.createRandom();
|
|
|
|
<span class="comment">// The password to encrypt with
|
|
</span>const password = "password123";
|
|
|
|
<span class="comment">// WARNING: Doing this substantially reduces the security
|
|
</span><span class="comment">// of the wallet. This is highly NOT recommended.
|
|
</span>
|
|
<span class="comment">// We override the default scrypt.N value, which is used
|
|
</span><span class="comment">// to indicate the difficulty to crack this wallet.
|
|
</span>const json = wallet.encrypt(password, {
|
|
scrypt: {
|
|
<span class="comment"> // The number must be a power of 2 (default: 131072)
|
|
</span> N: 64
|
|
}
|
|
});
|
|
</div><div class="page-separator"></div><a name="/v5/api/-%23-api"></a><a name="/v5/api/-%23-api"></a><a name="/v5/api/"></a><h1 class="show-anchors"><div>Application Programming Interface<div class="anchors"><a class="self" href="#/v5/api/-%23-api"></a></div></div></h1><p>An Application Programming Interface (API) is the formal specification of the library.</p>
|
|
|
|
<div class="toc"><div style="padding-left: 0px"><span class="bullet">•</span><a href="#/v5/api/contract/">Contract Interaction</a></div><div style="padding-left: 0px"><span class="bullet">•</span><a href="#/v5/api/signer/">Signers</a></div><div style="padding-left: 0px"><span class="bullet">•</span><a href="#/v5/api/providers/">Providers</a></div><div style="padding-left: 0px"><span class="bullet">•</span><a href="#/v5/api/utils/">Utilities</a></div><div style="padding-left: 0px"><span class="bullet">•</span><a href="#/v5/api/other/">Other Libraries</a></div><div style="padding-left: 0px"><span class="bullet">•</span><a href="#/v5/api/experimental/">Experimental</a></div></div><div class="page-separator"></div><a name="/v5/api/contract/-%23-contracts"></a><a name="/v5/api/contract/-%23-contracts"></a><a name="/v5/api/contract/"></a><h1 class="show-anchors"><div>Contract Interaction<div class="anchors"><a class="self" href="#/v5/api/contract/-%23-contracts"></a></div></div></h1><p>A <b>Contract</b> object is an abstraction of a contract (EVM bytecode) deployed on the Ethereum network. It allows for a simple way to serialize calls and transactions to an on-chain contract and deserialize their results and emitted logs.</p>
|
|
|
|
<p>A <b>ContractFactory</b> is an abstraction of a contract's <i>bytecode</i> and facilitates deploying a contract.</p>
|
|
|
|
<div class="toc"><div style="padding-left: 0px"><span class="bullet">•</span><a href="#/v5/api/contract/contract/">Contract</a></div><div style="padding-left: 0px"><span class="bullet">•</span><a href="#/v5/api/contract/contract-factory/">ContractFactory</a></div><div style="padding-left: 0px"><span class="bullet">•</span><a href="#/v5/api/contract/example/">Example: ERC-20 Contract</a></div></div><div class="page-separator"></div><a name="/v5/api/contract/contract/-%23-Contract"></a><a name="/v5/api/contract/contract/-%23-Contract"></a><a name="/v5/api/contract/contract/"></a><h1 class="show-anchors"><div>Contract<div class="anchors"><a class="self" href="#/v5/api/contract/contract/-%23-Contract"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/contracts/src.ts/index.ts#L556">source</a></div></div></h1><p>Explain contract here...</p>
|
|
|
|
<a name="/v5/api/contract/contract/-%23-Contract--creating"></a><a name="/v5/api/contract/contract/-%23-Contract--Contract--creating"></a><a name="/v5/api/contract/contract/"></a><h2 class="show-anchors"><div>Creating Instances<div class="anchors"><a class="self" href="#/v5/api/contract/contract/-%23-Contract--creating"></a></div></div></h2>
|
|
<div class="property show-anchors"><div class="signature"><span class="modifier">new </span><span class="path">ethers</span><span class="symbol">.</span><span class="method">Contract</span><span class="symbol">(</span> <span class="param">address</span> <span class="symbol">,</span> <span class="param">abi</span> <span class="symbol">,</span> <span class="param">signerOrProvider</span> <span class="symbol">)</span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/contracts/src.ts/index.ts#L589">source</a></div></div><div class="body">
|
|
</div></div><a name="/v5/api/contract/contract/-%23-Contract-attach"></a><div class="property show-anchors"><div class="signature"><span class="path">contract</span><span class="symbol">.</span><span class="method">attach</span><span class="symbol">(</span> <span class="param">addressOrName</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/contract/contract/">Contract</a></span><div class="anchors"><a class="self" href="#/v5/api/contract/contract/-%23-Contract-attach"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/contracts/src.ts/index.ts#L821">source</a></div></div><div class="body"><p>Returns a new instance of the <b>Contract</b> attached to a new address. This is useful if there are multiple similar or identical copies of a Contract on the network and you wish to interact with each of them.</p>
|
|
|
|
</div></div><a name="/v5/api/contract/contract/-%23-Contract-connect"></a><div class="property show-anchors"><div class="signature"><span class="path">contract</span><span class="symbol">.</span><span class="method">connect</span><span class="symbol">(</span> <span class="param">providerOrSigner</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/contract/contract/">Contract</a></span><div class="anchors"><a class="self" href="#/v5/api/contract/contract/-%23-Contract-connect"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/contracts/src.ts/index.ts#L808">source</a></div></div><div class="body"><p>Returns a new instance of the Contract, but connected to <i>providerOrSigner</i>.</p>
|
|
|
|
<p>By passing in a <a href="#/v5/api/providers/provider/">Provider</a>, this will return a downgraded <b>Contract</b> which only has read-only access (i.e. constant calls).</p>
|
|
|
|
<p>By passing in a <a href="#/v5/api/signer/-%23-Signer">Signer</a>. this will return a <b>Contract</b> which will act on behalf of that signer.</p>
|
|
|
|
</div></div><a name="/v5/api/contract/contract/-%23-Contract--properties"></a><a name="/v5/api/contract/contract/-%23-Contract--Contract--properties"></a><a name="/v5/api/contract/contract/"></a><h2 class="show-anchors"><div>Properties<div class="anchors"><a class="self" href="#/v5/api/contract/contract/-%23-Contract--properties"></a></div></div></h2>
|
|
<div class="property show-anchors"><div class="signature"><span class="path">contract</span><span class="symbol">.</span><span class="method">address</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/address/-%23-address">Address</a> ></span><div class="anchors"></div></div><div class="body"><p>This is the address (or ENS name) the contract was constructed with.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">contract</span><span class="symbol">.</span><span class="method">resolvedAddress</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/address/-%23-address">Address</a> ></span><div class="anchors"></div></div><div class="body"><p>This is a promise that will resolve to the address the <b>Contract</b> object is attached to. If an <a href="#/v5/api/utils/address/-%23-address">Address</a> was provided to the constructor, it will be equal to this; if an ENS name was provided, this will be the resolved address.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">contract</span><span class="symbol">.</span><span class="method">deployTransaction</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/providers/types/-%23-providers-TransactionResponse">TransactionResponse</a></span><div class="anchors"></div></div><div class="body"><p>If the <b>Contract</b> object is the result of a ContractFactory deployment, this is the transaction which was used to deploy the contract.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">contract</span><span class="symbol">.</span><span class="method">interface</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/abi/interface/">Interface</a></span><div class="anchors"></div></div><div class="body"><p>This is the ABI as an <a href="#/v5/api/utils/abi/interface/">Interface</a>.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">contract</span><span class="symbol">.</span><span class="method">provider</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/providers/provider/">Provider</a></span><div class="anchors"></div></div><div class="body"><p>If a provider was provided to the constructor, this is that provider. If a signer was provided that had a <a href="#/v5/api/providers/provider/">Provider</a>, this is that provider.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">contract</span><span class="symbol">.</span><span class="method">signer</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/signer/-%23-Signer">Signer</a></span><div class="anchors"></div></div><div class="body"><p>If a signer was provided to the constructor, this is that signer.</p>
|
|
|
|
</div></div><a name="/v5/api/contract/contract/-%23-Contract--methods"></a><a name="/v5/api/contract/contract/-%23-Contract--Contract--methods"></a><a name="/v5/api/contract/contract/"></a><h2 class="show-anchors"><div>Methods<div class="anchors"><a class="self" href="#/v5/api/contract/contract/-%23-Contract--methods"></a></div></div></h2>
|
|
<a name="/v5/api/contract/contract/-%23-Contract-deployed"></a><div class="property show-anchors"><div class="signature"><span class="path">contract</span><span class="symbol">.</span><span class="method">deployed</span><span class="symbol">(</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Promise< <a href="#/v5/api/contract/contract/">Contract</a> ></span><div class="anchors"><a class="self" href="#/v5/api/contract/contract/-%23-Contract-deployed"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/contracts/src.ts/index.ts#L750">source</a></div></div><div class="body">
|
|
</div></div><a name="/v5/api/contract/contract/-%23-Contract-isIndexed"></a><div class="property show-anchors"><div class="signature"><span class="path">Contract</span><span class="symbol">.</span><span class="method">isIndexed</span><span class="symbol">(</span> <span class="param">value</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">boolean</span><div class="anchors"><a class="self" href="#/v5/api/contract/contract/-%23-Contract-isIndexed"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/contracts/src.ts/index.ts#L825">source</a></div></div><div class="body">
|
|
</div></div><a name="/v5/api/contract/contract/-%23-Contract--events"></a><a name="/v5/api/contract/contract/-%23-Contract--Contract--events"></a><a name="/v5/api/contract/contract/"></a><h2 class="show-anchors"><div>Events<div class="anchors"><a class="self" href="#/v5/api/contract/contract/-%23-Contract--events"></a></div></div></h2>
|
|
<a name="/v5/api/contract/contract/-%23-Contract-queryFilter"></a><div class="property show-anchors"><div class="signature"><span class="path">contract</span><span class="symbol">.</span><span class="method">queryFilter</span><span class="symbol">(</span> <span class="param">event</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">fromBlockOrBlockHash</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">toBlock</span> <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Promise< Array< Event > ></span><div class="anchors"><a class="self" href="#/v5/api/contract/contract/-%23-Contract-queryFilter"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/contracts/src.ts/index.ts#L964">source</a></div></div><div class="body"><p>Return Events that match the <i>event</i>.</p>
|
|
|
|
</div></div><a name="/v5/api/contract/contract/-%23-Contract-listenerCount"></a><div class="property show-anchors"><div class="signature"><span class="path">contract</span><span class="symbol">.</span><span class="method">listenerCount</span><span class="symbol">(</span> <span class="symbol">[</span> <span class="param">event</span> <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">number</span><div class="anchors"><a class="self" href="#/v5/api/contract/contract/-%23-Contract-listenerCount"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/contracts/src.ts/index.ts#L1005">source</a></div></div><div class="body"><p>Return the number of listeners that are subscribed to <i>event</i>. If no event is provided, returns the total count of all events.</p>
|
|
|
|
</div></div><a name="/v5/api/contract/contract/-%23-Contract-listeners"></a><div class="property show-anchors"><div class="signature"><span class="path">contract</span><span class="symbol">.</span><span class="method">listeners</span><span class="symbol">(</span> <span class="param">event</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Array< Listener ></span><div class="anchors"><a class="self" href="#/v5/api/contract/contract/-%23-Contract-listeners"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/contracts/src.ts/index.ts#L1010">source</a></div></div><div class="body"><p>Return a list of listeners that are subscribed to <i>event</i>.</p>
|
|
|
|
</div></div><a name="/v5/api/contract/contract/-%23-Contract-off"></a><div class="property show-anchors"><div class="signature"><span class="path">contract</span><span class="symbol">.</span><span class="method">off</span><span class="symbol">(</span> <span class="param">event</span> <span class="symbol">,</span> <span class="param">listener</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">this</span><div class="anchors"><a class="self" href="#/v5/api/contract/contract/-%23-Contract-off"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/contracts/src.ts/index.ts#L1046">source</a></div></div><div class="body"><p>Unsubscribe <i>listener</i> to <i>event</i>.</p>
|
|
|
|
</div></div><a name="/v5/api/contract/contract/-%23-Contract-on"></a><div class="property show-anchors"><div class="signature"><span class="path">contract</span><span class="symbol">.</span><span class="method">on</span><span class="symbol">(</span> <span class="param">event</span> <span class="symbol">,</span> <span class="param">listener</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">this</span><div class="anchors"><a class="self" href="#/v5/api/contract/contract/-%23-Contract-on"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/contracts/src.ts/index.ts#L983">source</a></div></div><div class="body"><p>Subscribe to <i>event</i> calling <i>listener</i> when the event occurs.</p>
|
|
|
|
</div></div><a name="/v5/api/contract/contract/-%23-Contract-once"></a><div class="property show-anchors"><div class="signature"><span class="path">contract</span><span class="symbol">.</span><span class="method">once</span><span class="symbol">(</span> <span class="param">event</span> <span class="symbol">,</span> <span class="param">listener</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">this</span><div class="anchors"><a class="self" href="#/v5/api/contract/contract/-%23-Contract-once"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/contracts/src.ts/index.ts#L988">source</a></div></div><div class="body"><p>Subscribe once to <i>event</i> calling <i>listener</i> when the event occurs.</p>
|
|
|
|
</div></div><a name="/v5/api/contract/contract/-%23-Contract-removeAllListeners"></a><div class="property show-anchors"><div class="signature"><span class="path">contract</span><span class="symbol">.</span><span class="method">removeAllListeners</span><span class="symbol">(</span> <span class="symbol">[</span> <span class="param">event</span> <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">this</span><div class="anchors"><a class="self" href="#/v5/api/contract/contract/-%23-Contract-removeAllListeners"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/contracts/src.ts/index.ts#L1026">source</a></div></div><div class="body"><p>Unsubscribe all listeners for <i>event</i>. If no event is provided, all events are unsubscribed.</p>
|
|
|
|
</div></div><a name="/v5/api/contract/contract/-%23-Contract--metaclass"></a><a name="/v5/api/contract/contract/-%23-Contract--Contract--metaclass"></a><a name="/v5/api/contract/contract/"></a><h2 class="show-anchors"><div>Meta-Class<div class="anchors"><a class="self" href="#/v5/api/contract/contract/-%23-Contract--metaclass"></a></div></div></h2><p>A Meta-Class is a Class which has any of its properties determined at run-time. The <b>Contract</b> object uses a Contract's ABI to determine what methods are available, so the following sections describe the generic ways to interact with the properties added at run-time during the <b>Contract</b> constructor.</p>
|
|
|
|
<a name="/v5/api/contract/contract/-%23-Contract--readonly"></a><a name="/v5/api/contract/contract/-%23-Contract--Contract--metaclass--Contract--readonly"></a><a name="/v5/api/contract/contract/"></a><h3 class="show-anchors"><div>Read-Only Methods (constant)<div class="anchors"><a class="self" href="#/v5/api/contract/contract/-%23-Contract--readonly"></a></div></div></h3><p>A constant method is read-only and evaluates a small amount of EVM code against the current blockchain state and can be computed by asking a single node, which can return a result. It is therefore free and does not require any ether, but <b>cannot make changes</b> to the blockchain state..</p>
|
|
|
|
<a name="/v5/api/contract/contract/-%23-Contract-functionsCall"></a><div class="property show-anchors"><div class="signature"><span class="path">contract</span><span class="symbol">.</span><span class="method">METHOD_NAME</span><span class="symbol">(</span> ...<span class="param">args</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">overrides</span> <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Promise< any ></span><div class="anchors"><a class="self" href="#/v5/api/contract/contract/-%23-Contract-functionsCall"></a></div></div><div class="body"><p>The type of the result depends on the ABI.</p>
|
|
|
|
<p>For values that have a simple meaning in JavaScript, the types are fairly straight forward; strings and booleans are returned as JavaScript strings and booleans.</p>
|
|
|
|
<p>For numbers, if the <b>type</b> is in the JavaScript safe range (i.e. less than 53 bits, such as an <code class="inline">int24</code> or <code class="inline">uint48</code>) a normal JavaScript number is used. Otherwise a <a href="#/v5/api/utils/bignumber/">BigNumber</a> is returned.</p>
|
|
|
|
<p>For bytes (both fixed length and dynamic), a <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a> is returned.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">contract</span><span class="symbol">.</span><span class="path">functions</span><span class="symbol">.</span><span class="method">METHOD_NAME</span><span class="symbol">(</span> ...<span class="param">args</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">overrides</span> <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Promise< <a href="#/v5/api/utils/abi/interface/-%23-Result">Result</a> ></span><div class="anchors"></div></div><div class="body"><p>The result will always be a <a href="#/v5/api/utils/abi/interface/-%23-Result">Result</a>, even if there is only a single return value type.</p>
|
|
|
|
<p>This simplifies frameworks which wish to use the <a href="#/v5/api/contract/contract/">Contract</a> object, since they do not need to inspect the return types to unwrap simplified functions.</p>
|
|
|
|
<p>Another use for this method is for error recovery. For example, if a function result is an invalid UTF-8 string, the normal call using the above meta-class function will throw an exception. This allows using the Result access error to access the low-level bytes and reason for the error allowing an alternate UTF-8 error strategy to be used.</p>
|
|
|
|
<p>Most developers should not require this.</p>
|
|
|
|
</div></div><a name="/v5/api/contract/contract/-%23-Contract--write"></a><a name="/v5/api/contract/contract/-%23-Contract--Contract--metaclass--Contract--write"></a><a name="/v5/api/contract/contract/"></a><h3 class="show-anchors"><div>Write Methods (non-constant)<div class="anchors"><a class="self" href="#/v5/api/contract/contract/-%23-Contract--write"></a></div></div></h3><p>A non-constant method requires a transaction to be signed and requires payment in the form of a fee to be paid to a miner. This transaction will be verified by every node on the entire network as well by the miner who will compute the new state of the blockchain after executing it against the current state.</p>
|
|
|
|
<p>It cannot return a result. If a result is required, it should be logged using a Solidity event (or EVM log), which can then be queried from the transaction receipt.</p>
|
|
|
|
<a name="/v5/api/contract/contract/-%23-contract-functionsSend"></a><div class="property show-anchors"><div class="signature"><span class="path">contract</span><span class="symbol">.</span><span class="method">METHOD_NAME</span><span class="symbol">(</span> ...<span class="param">args</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">overrides</span> <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Promise< <a href="#/v5/api/providers/types/-%23-providers-TransactionResponse">TransactionResponse</a> ></span><div class="anchors"><a class="self" href="#/v5/api/contract/contract/-%23-contract-functionsSend"></a></div></div><div class="body"><p>Returns a <a href="#/v5/api/providers/types/-%23-providers-TransactionResponse">TransactionResponse</a> for the transaction after it is sent to the network. This requires the <b>Contract</b> has a signer.</p>
|
|
|
|
</div></div><a name="/v5/api/contract/contract/-%23-Contract--check"></a><a name="/v5/api/contract/contract/-%23-Contract--Contract--metaclass--Contract--check"></a><a name="/v5/api/contract/contract/"></a><h3 class="show-anchors"><div>Write Methods Analysis<div class="anchors"><a class="self" href="#/v5/api/contract/contract/-%23-Contract--check"></a></div></div></h3><p>There are several options to analyze properties and results of a write method without actually executing it.</p>
|
|
|
|
<a name="/v5/api/contract/contract/-%23-contract-estimateGas"></a><div class="property show-anchors"><div class="signature"><span class="path">contract</span><span class="symbol">.</span><span class="path">estimateGas</span><span class="symbol">.</span><span class="method">METHOD_NAME</span><span class="symbol">(</span> ...<span class="param">args</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">overrides</span> <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Promise< <a href="#/v5/api/utils/bignumber/">BigNumber</a> ></span><div class="anchors"><a class="self" href="#/v5/api/contract/contract/-%23-contract-estimateGas"></a></div></div><div class="body"><p>Returns the estimate units of gas that would be required to execute the <i>METHOD_NAME</i> with <i>args</i> and <i>overrides</i>.</p>
|
|
|
|
</div></div><a name="/v5/api/contract/contract/-%23-contract-populateTransaction"></a><div class="property show-anchors"><div class="signature"><span class="path">contract</span><span class="symbol">.</span><span class="path">populateTransaction</span><span class="symbol">.</span><span class="method">METHOD_NAME</span><span class="symbol">(</span> ...<span class="param">args</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">overrides</span> <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Promise< <a href="#/v5/api/utils/transactions/-%23-UnsignedTransaction">UnsignedTx</a> ></span><div class="anchors"><a class="self" href="#/v5/api/contract/contract/-%23-contract-populateTransaction"></a></div></div><div class="body"><p>Returns an <a href="#/v5/api/utils/transactions/-%23-UnsignedTransaction">UnsignedTransaction</a> which represents the transaction that would need to be signed and submitted to the network to execute <i>METHOD_NAME</i> with <i>args</i> and <i>overrides</i>.</p>
|
|
|
|
</div></div><a name="/v5/api/contract/contract/-%23-contract-callStatic"></a><div class="property show-anchors"><div class="signature"><span class="path">contract</span><span class="symbol">.</span><span class="path">callStatic</span><span class="symbol">.</span><span class="method">METHOD_NAME</span><span class="symbol">(</span> ...<span class="param">args</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">overrides</span> <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Promise< any ></span><div class="anchors"><a class="self" href="#/v5/api/contract/contract/-%23-contract-callStatic"></a></div></div><div class="body"><p>Rather than executing the state-change of a transaction, it is possible to ask a node to <i>pretend</i> that a call is not state-changing and return the result.</p>
|
|
|
|
<p>This does not actually change any state, but is free. This in some cases can be used to determine if a transaction will fail or succeed.</p>
|
|
|
|
<p>This otherwise functions the same as a <a href="#/v5/api/contract/contract/-%23-Contract--readonly">Read-Only Method</a>.</p>
|
|
|
|
</div></div><a name="/v5/api/contract/contract/-%23-Contract--filters"></a><a name="/v5/api/contract/contract/-%23-Contract--Contract--metaclass--Contract--filters"></a><a name="/v5/api/contract/contract/"></a><h3 class="show-anchors"><div>Event Filters<div class="anchors"><a class="self" href="#/v5/api/contract/contract/-%23-Contract--filters"></a></div></div></h3><p>An event filter is made up of topics, which are values logged in a <a href="https://en.wikipedia.org/wiki/Bloom_filter">Bloom Filter</a>, allowing efficient searching for entries which match a filter.</p>
|
|
|
|
<div class="property show-anchors"><div class="signature"><span class="path">contract</span><span class="symbol">.</span><span class="path">filters</span><span class="symbol">.</span><span class="method">EVENT_NAME</span><span class="symbol">(</span> ...<span class="param">args</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Filter</span><div class="anchors"></div></div><div class="body"><p>Return a filter for <i>EVENT_NAME</i>, optionally filtering by additional constraints.</p>
|
|
|
|
<p>Only <code class="inline">indexed</code> event parameters may be filtered. If a parameter is null (or not provided) then any value in that field matches.</p>
|
|
|
|
</div></div><div class="page-separator"></div><a name="/v5/api/contract/contract-factory/-%23-ContractFactory"></a><a name="/v5/api/contract/contract-factory/-%23-ContractFactory"></a><a name="/v5/api/contract/contract-factory/"></a><h1 class="show-anchors"><div>ContractFactory<div class="anchors"><a class="self" href="#/v5/api/contract/contract-factory/-%23-ContractFactory"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/contracts/src.ts/index.ts#L1060">source</a></div></div></h1><p>@TODO: Fill this in, including @SRC links</p>
|
|
|
|
<a name="/v5/api/contract/contract-factory/-%23-ContractFactory--creating"></a><a name="/v5/api/contract/contract-factory/-%23-ContractFactory--ContractFactory--creating"></a><a name="/v5/api/contract/contract-factory/"></a><h2 class="show-anchors"><div>Creating Instances<div class="anchors"><a class="self" href="#/v5/api/contract/contract-factory/-%23-ContractFactory--creating"></a></div></div></h2>
|
|
<div class="property show-anchors"><div class="signature"><span class="modifier">new </span><span class="path">ethers</span><span class="symbol">.</span><span class="method">ContractFactory</span><span class="symbol">(</span> <span class="param">interface</span> <span class="symbol">,</span> <span class="param">bydecode</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">signer</span> <span class="symbol">]</span> <span class="symbol">)</span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/contracts/src.ts/index.ts#L1066">source</a></div></div><div class="body">
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">ContractFactory</span><span class="symbol">.</span><span class="method">fromSolidity</span><span class="symbol">(</span> <span class="param">compilerOutput</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">signer</span> <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/contract/contract-factory/">ContractFactory</a></span><div class="anchors"></div></div><div class="body">
|
|
</div></div><a name="/v5/api/contract/contract-factory/-%23-ContractFactory-connect"></a><div class="property show-anchors"><div class="signature"><span class="path">contractFactory</span><span class="symbol">.</span><span class="method">connect</span><span class="symbol">(</span> <span class="param">signer</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/contract/contract/">Contract</a></span><div class="anchors"><a class="self" href="#/v5/api/contract/contract-factory/-%23-ContractFactory-connect"></a></div></div><div class="body">
|
|
</div></div><a name="/v5/api/contract/contract-factory/-%23-ContractFactory--properties"></a><a name="/v5/api/contract/contract-factory/-%23-ContractFactory--ContractFactory--properties"></a><a name="/v5/api/contract/contract-factory/"></a><h2 class="show-anchors"><div>Properties<div class="anchors"><a class="self" href="#/v5/api/contract/contract-factory/-%23-ContractFactory--properties"></a></div></div></h2>
|
|
<div class="property show-anchors"><div class="signature"><span class="path">contractFactory</span><span class="symbol">.</span><span class="method">interface</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/abi/interface/">Interface</a></span><div class="anchors"></div></div><div class="body">
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">contractFactory</span><span class="symbol">.</span><span class="method">bytecode</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a> ></span><div class="anchors"></div></div><div class="body">
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">contractFactory</span><span class="symbol">.</span><span class="method">signer</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/signer/-%23-Signer">Signer</a></span><div class="anchors"></div></div><div class="body">
|
|
</div></div><a name="/v5/api/contract/contract-factory/-%23-ContractFactory--methods"></a><a name="/v5/api/contract/contract-factory/-%23-ContractFactory--ContractFactory--methods"></a><a name="/v5/api/contract/contract-factory/"></a><h2 class="show-anchors"><div>Methods<div class="anchors"><a class="self" href="#/v5/api/contract/contract-factory/-%23-ContractFactory--methods"></a></div></div></h2>
|
|
<a name="/v5/api/contract/contract-factory/-%23-ContractFactory-attach"></a><div class="property show-anchors"><div class="signature"><span class="path">contractFactory</span><span class="symbol">.</span><span class="method">attach</span><span class="symbol">(</span> <span class="param">address</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/contract/contract/">Contract</a></span><div class="anchors"><a class="self" href="#/v5/api/contract/contract-factory/-%23-ContractFactory-attach"></a></div></div><div class="body"><p>Return an instance of a <a href="#/v5/api/contract/contract/">Contract</a> attched to <i>address</i>. This is the same as using the <a href="#/v5/api/contract/contract/-%23-Contract--creating">Contract constructor</a> with <i>address</i> and this the the <i>interface</i> and <i>signerOrProvider</i> passed in when creating the ContractFactory.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">contractFactory</span><span class="symbol">.</span><span class="method">getDeployTransaction</span><span class="symbol">(</span> ...<span class="param">args</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/transactions/-%23-UnsignedTransaction">UnsignedTransaction</a></span><div class="anchors"></div></div><div class="body"><p>Returns the unsigned transaction which would deploy this Contract with <i>args</i> passed to the Contract's constructor.</p>
|
|
|
|
</div></div><a name="/v5/api/contract/contract-factory/-%23-ContractFactory-deploy"></a><div class="property show-anchors"><div class="signature"><span class="path">contractFactory</span><span class="symbol">.</span><span class="method">deploy</span><span class="symbol">(</span> ...<span class="param">args</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Promise< <a href="#/v5/api/contract/contract/">Contract</a> ></span><div class="anchors"><a class="self" href="#/v5/api/contract/contract-factory/-%23-ContractFactory-deploy"></a></div></div><div class="body"><p>Uses the signer to deploy the Contract with <i>args</i> passed into the constructor and retruns a Contract which is attached to the address where this contract <b>will</b> be deployed once the transaction is mined.</p>
|
|
|
|
<p>The transaction can be found at <code class="inline">contract.deployTransaction</code>, and no interactions should be made until the transaction is mined.</p>
|
|
|
|
</div></div><div class="code-title"><div>Deploying a Contract</div></div><div class="code">// <hide>
|
|
const signer = ethers.LocalSigner();
|
|
const ContractFactory = ethers.ContractFactory;
|
|
// </hide>
|
|
|
|
// If your contract constructor requires parameters, the ABI
|
|
// must include the constructor
|
|
const abi = [
|
|
"constructor(address owner, uint256 initialValue)"
|
|
];
|
|
|
|
const factory = new ContractFactory(abi, bytecode, signer)
|
|
|
|
const contract = await factory.deploy("ricmoo.eth", 42);
|
|
|
|
// The address is available immediately, but the contract
|
|
// is NOT deployed yet
|
|
contract.address
|
|
//!
|
|
|
|
// The transaction that the signer sent to deploy
|
|
contract.deployTransaction
|
|
//!
|
|
|
|
// Wait until the transaction is mined
|
|
contract.deployTransaction.wait()
|
|
//!
|
|
|
|
// Now the contract is safe to interact with
|
|
contract.value()
|
|
//!</div><div class="page-separator"></div><a name="/v5/api/contract/example/-%23-example-erc-20-contract"></a><a name="/v5/api/contract/example/"></a><h1 class="show-anchors"><div>Example: ERC-20 Contract<div class="anchors"><a class="self" href="#/v5/api/contract/example/-%23-example-erc-20-contract"></a></div></div></h1>
|
|
<a name="/v5/api/contract/example/-%23-example-erc-20-contract--connecting-to-a-contract"></a><a name="/v5/api/contract/example/"></a><h2 class="show-anchors"><div>Connecting to a Contract<div class="anchors"><a class="self" href="#/v5/api/contract/example/-%23-example-erc-20-contract--connecting-to-a-contract"></a></div></div></h2>
|
|
<div class="code-title"><div>A simple ERC-20 contract</div></div><div class="code"><span class="comment">// A Human-Readable ABI; any supported ABI format could be used
|
|
</span>const abi = [
|
|
<span class="comment"> // Read-Only Functions
|
|
</span> "function balanceOf(address owner) view returns (uint256)",
|
|
"function decimals() view returns (uint8)",
|
|
"function symbol() view returns (string)",
|
|
|
|
<span class="comment"> // Authenticated Functions
|
|
</span> "function transfer(address to, uint amount) returns (boolean)",
|
|
|
|
<span class="comment"> // Events
|
|
</span> "event Transfer(address indexed from, address indexed to, uint amount)"
|
|
];
|
|
|
|
<span class="comment">// This can be an address or an ENS name
|
|
</span>const address = "dai.tokens.ethers.eth";
|
|
|
|
<span class="comment">// An example Provider
|
|
</span>const provider = ethers.getDefaultProvider();
|
|
|
|
<span class="comment">// An example Signer
|
|
</span>const signer = ethers.Wallet.createRandom().connect(provider);
|
|
|
|
<span class="comment">// Read-Only; By connecting to a Provider, allows:
|
|
</span><span class="comment">// - Any constant function
|
|
</span><span class="comment">// - Querying Filters
|
|
</span><span class="comment">// - Populating Unsigned Transactions for non-constant methods
|
|
</span><span class="comment">// - Estimating Gas for non-constant (as an anonymous sender)
|
|
</span><span class="comment">// - Static Calling non-constant methods (as anonymous sender)
|
|
</span>const erc20 = new ethers.Contract(address, abi, provider);
|
|
|
|
<span class="comment">// Read-Write; By connecting to a Signer, allows:
|
|
</span><span class="comment">// - Everything from Read-Only (except as Signer, not anonymous)
|
|
</span><span class="comment">// - Sending transactions for non-constant functions
|
|
</span>const erc20_rw = new ethers.Contract(address, abi, signer)
|
|
</div><a name="/v5/api/contract/example/-%23-example-erc-20-contract--connecting-to-a-contract--erc20contract"></a><a name="/v5/api/contract/example/"></a><h3 class="show-anchors"><div>ERC20Contract<span class="inherits"> inherits <a href="#/v5/api/contract/contract/">Contract</a></span><div class="anchors"><a class="self" href="#/v5/api/contract/example/-%23-example-erc-20-contract--connecting-to-a-contract--erc20contract"></a></div></div></h3>
|
|
<div class="property show-anchors"><div class="signature"><span class="modifier">new </span><span class="path">ethers</span><span class="symbol">.</span><span class="method">Contract</span><span class="symbol">(</span> <span class="param">address</span> <span class="symbol">,</span> <span class="param">abi</span> <span class="symbol">,</span> <span class="param">providerOrSigner</span> <span class="symbol">)</span><div class="anchors"></div></div><div class="body"><p>See the above code example for creating an Instance which will (in addition to the Contact methods and properties) automatically add the additional properties defined in <i>abi</i> to a <b>Contract</b> connected to <i>address</i> using the <i>providerOrSigner</i>.</p>
|
|
|
|
</div></div><a name="/v5/api/contract/example/-%23-example-erc-20-contract--properties"></a><a name="/v5/api/contract/example/"></a><h2 class="show-anchors"><div>Properties<span class="inherits">(inheritted from <a href="#/v5/api/contract/contract/">Contract</a>)</span><div class="anchors"><a class="self" href="#/v5/api/contract/example/-%23-example-erc-20-contract--properties"></a></div></div></h2>
|
|
<div class="property show-anchors"><div class="signature"><span class="path">erc20</span><span class="symbol">.</span><span class="method">address</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/address/-%23-address">Address</a> ></span><div class="anchors"></div></div><div class="body"><p>This is the address (or ENS name) the contract was constructed with.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">erc20</span><span class="symbol">.</span><span class="method">resolvedAddress</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/address/-%23-address">Address</a> ></span><div class="anchors"></div></div><div class="body"><p>This is a promise that will resolve to the address the <b>Contract</b> object is attached to. If an <a href="#/v5/api/utils/address/-%23-address">Address</a> was provided to the constructor, it will be equal to this; if an ENS name was provided, this will be the resolved address.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">erc20</span><span class="symbol">.</span><span class="method">deployTransaction</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/providers/types/-%23-providers-TransactionResponse">TransactionResponse</a></span><div class="anchors"></div></div><div class="body"><p>If the <b>Contract</b> object is the result of a ContractFactory deployment, this is the transaction which was used to deploy the contract.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">erc20</span><span class="symbol">.</span><span class="method">interface</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/abi/interface/">Interface</a></span><div class="anchors"></div></div><div class="body"><p>This is the ABI as an <a href="#/v5/api/utils/abi/interface/">Interface</a>.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">erc20</span><span class="symbol">.</span><span class="method">provider</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/providers/provider/">Provider</a></span><div class="anchors"></div></div><div class="body"><p>If a provider was provided to the constructor, this is that provider. If a signer was provided that had a <a href="#/v5/api/providers/provider/">Provider</a>, this is that provider.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">erc20</span><span class="symbol">.</span><span class="method">signer</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/signer/-%23-Signer">Signer</a></span><div class="anchors"></div></div><div class="body"><p>If a signer was provided to the constructor, this is that signer.</p>
|
|
|
|
</div></div><a name="/v5/api/contract/example/-%23-example-erc-20-contract--methods"></a><a name="/v5/api/contract/example/"></a><h2 class="show-anchors"><div>Methods<span class="inherits">(inheritted from <a href="#/v5/api/contract/contract/">Contract</a>)</span><div class="anchors"><a class="self" href="#/v5/api/contract/example/-%23-example-erc-20-contract--methods"></a></div></div></h2>
|
|
<div class="property show-anchors"><div class="signature"><span class="path">erc20</span><span class="symbol">.</span><span class="method">attach</span><span class="symbol">(</span> <span class="param">addressOrName</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/contract/contract/">Contract</a></span><div class="anchors"></div></div><div class="body"><p>Returns a new instance of the <b>Contract</b> attached to a new address. This is useful if there are multiple similar or identical copies of a Contract on the network and you wish to interact with each of them.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">erc20</span><span class="symbol">.</span><span class="method">connect</span><span class="symbol">(</span> <span class="param">providerOrSigner</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/contract/contract/">Contract</a></span><div class="anchors"></div></div><div class="body"><p>Returns a new instance of the Contract, but connected to <i>providerOrSigner</i>.</p>
|
|
|
|
<p>By passing in a <a href="#/v5/api/providers/provider/">Provider</a>, this will return a downgraded <b>Contract</b> which only has read-only access (i.e. constant calls).</p>
|
|
|
|
<p>By passing in a <a href="#/v5/api/signer/-%23-Signer">Signer</a>. this will return a <b>Contract</b> which will act on behalf of that signer.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">erc20</span><span class="symbol">.</span><span class="method">deployed</span><span class="symbol">(</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Promise< Contract ></span><div class="anchors"></div></div><div class="body">
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">Contract</span><span class="symbol">.</span><span class="method">isIndexed</span><span class="symbol">(</span> <span class="param">value</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">boolean</span><div class="anchors"></div></div><div class="body">
|
|
</div></div><a name="/v5/api/contract/example/-%23-erc20-events"></a><a name="/v5/api/contract/example/-%23-example-erc-20-contract--erc20-events"></a><a name="/v5/api/contract/example/"></a><h2 class="show-anchors"><div>Events<span class="inherits">(inheritted from <a href="#/v5/api/contract/contract/">Contract</a>)</span><div class="anchors"><a class="self" href="#/v5/api/contract/example/-%23-erc20-events"></a></div></div></h2>
|
|
<a name="/v5/api/contract/example/-%23-erc20-queryfilter"></a><div class="property show-anchors"><div class="signature"><span class="path">erc20</span><span class="symbol">.</span><span class="method">queryFilter</span><span class="symbol">(</span> <span class="param">event</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">fromBlockOrBlockHash</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">toBlock</span> <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Promise< Array< Event > ></span><div class="anchors"><a class="self" href="#/v5/api/contract/example/-%23-erc20-queryfilter"></a></div></div><div class="body"><p>Return Events that match the <i>event</i>.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">erc20</span><span class="symbol">.</span><span class="method">listenerCount</span><span class="symbol">(</span> <span class="symbol">[</span> <span class="param">event</span> <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">number</span><div class="anchors"></div></div><div class="body"><p>Return the number of listeners that are subscribed to <i>event</i>. If no event is provided, returns the total count of all events.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">erc20</span><span class="symbol">.</span><span class="method">listeners</span><span class="symbol">(</span> <span class="param">event</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Array< Listener ></span><div class="anchors"></div></div><div class="body"><p>Return a list of listeners that are subscribed to <i>event</i>.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">erc20</span><span class="symbol">.</span><span class="method">off</span><span class="symbol">(</span> <span class="param">event</span> <span class="symbol">,</span> <span class="param">listener</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">this</span><div class="anchors"></div></div><div class="body"><p>Unsubscribe <i>listener</i> to <i>event</i>.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">erc20</span><span class="symbol">.</span><span class="method">on</span><span class="symbol">(</span> <span class="param">event</span> <span class="symbol">,</span> <span class="param">listener</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">this</span><div class="anchors"></div></div><div class="body"><p>Subscribe to <i>event</i> calling <i>listener</i> when the event occurs.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">erc20</span><span class="symbol">.</span><span class="method">once</span><span class="symbol">(</span> <span class="param">event</span> <span class="symbol">,</span> <span class="param">listener</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">this</span><div class="anchors"></div></div><div class="body"><p>Subscribe once to <i>event</i> calling <i>listener</i> when the event occurs.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">erc20</span><span class="symbol">.</span><span class="method">removeAllListeners</span><span class="symbol">(</span> <span class="symbol">[</span> <span class="param">event</span> <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">this</span><div class="anchors"></div></div><div class="body"><p>Unsubscribe all listeners for <i>event</i>. If no event is provided, all events are unsubscribed.</p>
|
|
|
|
</div></div><a name="/v5/api/contract/example/-%23-example-erc-20-contract--meta-class-methods"></a><a name="/v5/api/contract/example/"></a><h2 class="show-anchors"><div>Meta-Class Methods<span class="inherits">(added at Runtime)</span><div class="anchors"><a class="self" href="#/v5/api/contract/example/-%23-example-erc-20-contract--meta-class-methods"></a></div></div></h2><p>Since the Contract is a Meta-Class, the methods available here depend on the ABI which was passed into the <b>Contract</b>.</p>
|
|
|
|
<div class="property show-anchors"><div class="signature"><span class="path">erc20</span><span class="symbol">.</span><span class="method">decimals</span><span class="symbol">(</span> <span class="symbol">[</span> <span class="param">overrides</span> <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Promise< number ></span><div class="anchors"></div></div><div class="body"><p>Returns the number of decimal places used by this ERC-20 token. This can be used with <a href="#/v5/api/utils/display-logic/-%23-utils-parseUnits">parseUnits</a> when taking input from the user or [formatUnits](utils-formatunits] when displaying the token amounts in the UI.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">erc20</span><span class="symbol">.</span><span class="method">getBalance</span><span class="symbol">(</span> <span class="param">owner</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">overrides</span> <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Promise< <a href="#/v5/api/utils/bignumber/">BigNumber</a> ></span><div class="anchors"></div></div><div class="body"><p>Returns the balance of <i>owner</i> for this ERC-20 token.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">erc20</span><span class="symbol">.</span><span class="method">symbol</span><span class="symbol">(</span> <span class="symbol">[</span> <span class="param">overrides</span> <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Promise< string ></span><div class="anchors"></div></div><div class="body"><p>Returns the symbol of the token.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">erc20_rw</span><span class="symbol">.</span><span class="method">transfer</span><span class="symbol">(</span> <span class="param">target</span> <span class="symbol">,</span> <span class="param">amount</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">overrides</span> <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Promise< <a href="#/v5/api/providers/types/-%23-providers-TransactionResponse">TransactionResponse</a> ></span><div class="anchors"></div></div><div class="body"><p>Transfers <i>amount</i> tokens to <i>target</i> from the current signer. The return value (a boolean) is inaccessible during a write operation using a transaction. Other techniques (such as events) are required if this value is required. On-chain contracts calling the <code class="inline">transfer</code> function have access to this result, which is why it is possible.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">erc20</span><span class="symbol">.</span><span class="path">callStatic</span><span class="symbol">.</span><span class="method">transfer</span><span class="symbol">(</span> <span class="param">target</span> <span class="symbol">,</span> <span class="param">amount</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">overrides</span> <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Promise< boolean ></span><div class="anchors"></div></div><div class="body"><p>Performs a dry-run of transferring <i>amount</i> tokens to <i>target</i> from the current signer, without actually signing or sending a transaction.</p>
|
|
|
|
<p>This can be used to preflight check that a transaction will be successful.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">erc20</span><span class="symbol">.</span><span class="path">estimateGas</span><span class="symbol">.</span><span class="method">transfer</span><span class="symbol">(</span> <span class="param">target</span> <span class="symbol">,</span> <span class="param">amount</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">overrides</span> <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Promise< <a href="#/v5/api/utils/bignumber/">BigNumber</a> ></span><div class="anchors"></div></div><div class="body"><p>Returns an estimate for how many units of gas would be required to transfer <i>amount</i> tokens to <i>target</i>.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">erc20</span><span class="symbol">.</span><span class="path">populateTransaction</span><span class="symbol">.</span><span class="method">transfer</span><span class="symbol">(</span> <span class="param">target</span> <span class="symbol">,</span> <span class="param">amount</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">overrides</span> <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Promise< <a href="#/v5/api/utils/transactions/-%23-UnsignedTransaction">UnsignedTx</a> ></span><div class="anchors"></div></div><div class="body"><p>Returns an <a href="#/v5/api/utils/transactions/-%23-UnsignedTransaction">UnsignedTransaction</a> which could be signed and submitted to the network to transaction <i>amount</i> tokens to <i>target</i>.</p>
|
|
|
|
</div></div><div class="definition container-box note"><div class="term">Note on Estimating and Static Calling</div><div class="body"><p>When you perform a static call, the current state is taken into account as best as Ethereum can determine. There are many cases where this can provide false positives and false negatives. The eventually consistent model of the blockchain also means there are certain consistency modes that cannot be known until an actual transaction is attempted.</p>
|
|
|
|
</div></div><a name="/v5/api/contract/example/-%23-example-erc-20-contract--meta-class-filters"></a><a name="/v5/api/contract/example/"></a><h2 class="show-anchors"><div>Meta-Class Filters<span class="inherits">(added at Runtime)</span><div class="anchors"><a class="self" href="#/v5/api/contract/example/-%23-example-erc-20-contract--meta-class-filters"></a></div></div></h2><p>Since the Contract is a Meta-Class, the methods available here depend on the ABI which was passed into the <b>Contract</b>.</p>
|
|
|
|
<div class="property show-anchors"><div class="signature"><span class="path">erc20</span><span class="symbol">.</span><span class="path">filters</span><span class="symbol">.</span><span class="method">Transafer</span><span class="symbol">(</span> <span class="symbol">[</span> <span class="param">fromAddress</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">toAddress</span> <span class="symbol">]</span> <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Filter</span><div class="anchors"></div></div><div class="body"><p>Returns a new Filter which can be used to <a href="#/v5/api/contract/example/-%23-erc20-queryfilter">query</a> or to <a href="#/v5/api/contract/example/-%23-erc20-events">subscribe/unsubscribe to events</a>.</p>
|
|
|
|
<p>If <i>fromAddress</i> is null or not provided, then any from address matches. If <i>toAddress</i> is null or not provided, then any to address matches.</p>
|
|
|
|
</div></div><div class="page-separator"></div><a name="/v5/api/signer/-%23-signers"></a><a name="/v5/api/signer/-%23-signers"></a><a name="/v5/api/signer/"></a><h1 class="show-anchors"><div>Signers<div class="anchors"><a class="self" href="#/v5/api/signer/-%23-signers"></a></div></div></h1><p>A <b>Signer</b> in <i>ethers</i> is an abstraction of an Ethereum Account, which can be used to sign messages and transactions and send signed transactions to the Ethereum Network to execute state changing operations.</p>
|
|
|
|
<p>The available operations depends largely on the sub-class used.</p>
|
|
|
|
<p>For example, a Signer from MetaMask can send transactions and sign messages but cannot sign a transaction (without broadcasting it).</p>
|
|
|
|
<p>The most common Signers you will encounter are:</p>
|
|
|
|
<p><ul><li><a href="#/v5/api/signer/-%23-Wallet">Wallet</a>, which is a class which knows its private key and can execute any operations with it </li><li><a href="#/v5/api/providers/jsonrpc-provider/-%23-JsonRpcSigner">JsonRpcSigner</a>, which is connected to a <a href="#/v5/api/providers/jsonrpc-provider/">JsonRpcProvider</a> (or sub-class) and is acquired using <a href="#/v5/api/providers/jsonrpc-provider/-%23-JsonRpcProvider-getSigner">getSigner</a> </li></ul></p>
|
|
|
|
<a name="/v5/api/signer/-%23-Signer"></a><a name="/v5/api/signer/-%23-signers--Signer"></a><a name="/v5/api/signer/"></a><h2 class="show-anchors"><div>Signer<div class="anchors"><a class="self" href="#/v5/api/signer/-%23-Signer"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/abstract-signer/src.ts/index.ts#L30">source</a></div></div></h2><p>The <b>Signer</b> class is abstract and cannot be directly instaniated.</p>
|
|
|
|
<p>Instead use one of the concreate sub-classes, such as the <a href="#/v5/api/signer/-%23-Wallet">Wallet</a>, <a href="#/v5/api/signer/-%23-VoidSigner">VoidSigner</a> or <a href="#/v5/api/providers/jsonrpc-provider/-%23-JsonRpcSigner">JsonRpcSigner</a>.</p>
|
|
|
|
<a name="/v5/api/signer/-%23-Signer-connect"></a><div class="property show-anchors"><div class="signature"><span class="path">signer</span><span class="symbol">.</span><span class="method">connect</span><span class="symbol">(</span> <span class="param">provider</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/signer/-%23-Signer">Signer</a></span><div class="anchors"><a class="self" href="#/v5/api/signer/-%23-Signer-connect"></a></div></div><div class="body"><p>Sub-classes <b>must</b> implement this, however they may simply throw an error if changing providers is not supported.</p>
|
|
|
|
</div></div><a name="/v5/api/signer/-%23-Signer-getaddress"></a><div class="property show-anchors"><div class="signature"><span class="path">signer</span><span class="symbol">.</span><span class="method">getAddress</span><span class="symbol">(</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Promise< string< <a href="#/v5/api/utils/address/-%23-address">Address</a> > ></span><div class="anchors"><a class="self" href="#/v5/api/signer/-%23-Signer-getaddress"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/abstract-signer/src.ts/index.ts#L53">source</a></div></div><div class="body"><p>Returns a Promise that resolves to the account address.</p>
|
|
|
|
<p>This is a Promise so that a <b>Signer</b> can be designed around an asynchronous source, such as hardware wallets.</p>
|
|
|
|
<p>Sub-classes <b>must</b> implement this.</p>
|
|
|
|
</div></div><a name="/v5/api/signer/-%23-Signer-isSigner"></a><div class="property show-anchors"><div class="signature"><span class="path">Signer</span><span class="symbol">.</span><span class="method">isSigner</span><span class="symbol">(</span> <span class="param">object</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">boolean</span><div class="anchors"><a class="self" href="#/v5/api/signer/-%23-Signer-isSigner"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/abstract-signer/src.ts/index.ts#L206">source</a></div></div><div class="body"><p>Returns true if an only if <i>object</i> is a <b>Signer</b>.</p>
|
|
|
|
</div></div><a name="/v5/api/signer/-%23-Signer--blockchain-methods"></a><a name="/v5/api/signer/-%23-signers--Signer--Signer--blockchain-methods"></a><a name="/v5/api/signer/"></a><h3 class="show-anchors"><div>Blockchain Methods<div class="anchors"><a class="self" href="#/v5/api/signer/-%23-Signer--blockchain-methods"></a></div></div></h3>
|
|
<a name="/v5/api/signer/-%23-Signer-getBalance"></a><div class="property show-anchors"><div class="signature"><span class="path">signer</span><span class="symbol">.</span><span class="method">getBalance</span><span class="symbol">(</span> <span class="symbol">[</span> <span class="param">blockTag</span> = "<span class="param">latest</span>" <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Promise< <a href="#/v5/api/utils/bignumber/">BigNumber</a> ></span><div class="anchors"><a class="self" href="#/v5/api/signer/-%23-Signer-getBalance"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/abstract-signer/src.ts/index.ts#L69">source</a></div></div><div class="body"><p>Returns the balance of this wallet at <i>blockTag</i>.</p>
|
|
|
|
</div></div><a name="/v5/api/signer/-%23-Signer-getChainId"></a><div class="property show-anchors"><div class="signature"><span class="path">signer</span><span class="symbol">.</span><span class="method">getChainId</span><span class="symbol">(</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Promise< number ></span><div class="anchors"><a class="self" href="#/v5/api/signer/-%23-Signer-getChainId"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/abstract-signer/src.ts/index.ts#L103">source</a></div></div><div class="body"><p>Returns the chain ID this wallet is connected to.</p>
|
|
|
|
</div></div><a name="/v5/api/signer/-%23-Signer-getGasPrice"></a><div class="property show-anchors"><div class="signature"><span class="path">signer</span><span class="symbol">.</span><span class="method">getGasPrice</span><span class="symbol">(</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Promise< <a href="#/v5/api/utils/bignumber/">BigNumber</a> ></span><div class="anchors"><a class="self" href="#/v5/api/signer/-%23-Signer-getGasPrice"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/abstract-signer/src.ts/index.ts#L109">source</a></div></div><div class="body"><p>Returns the current gas price.</p>
|
|
|
|
</div></div><a name="/v5/api/signer/-%23-Signer-getTransactionCount"></a><div class="property show-anchors"><div class="signature"><span class="path">signer</span><span class="symbol">.</span><span class="method">getTransactionCount</span><span class="symbol">(</span> <span class="symbol">[</span> <span class="param">blockTag</span> = "<span class="param">latest</span>" <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Promise< number ></span><div class="anchors"><a class="self" href="#/v5/api/signer/-%23-Signer-getTransactionCount"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/abstract-signer/src.ts/index.ts#L74">source</a></div></div><div class="body"><p>Returns the number of transactions this account has ever sent. This is the value required to be included in transactions as the <code class="inline">nonce</code>.</p>
|
|
|
|
</div></div><a name="/v5/api/signer/-%23-Signer-call"></a><div class="property show-anchors"><div class="signature"><span class="path">signer</span><span class="symbol">.</span><span class="method">call</span><span class="symbol">(</span> <span class="param">transactionRequest</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Promise< string< <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a> > ></span><div class="anchors"><a class="self" href="#/v5/api/signer/-%23-Signer-call"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/abstract-signer/src.ts/index.ts#L87">source</a></div></div><div class="body"><p>Returns the result of calling using the <i>transactionRequest</i>, with this account address being used as the <code class="inline">from</code> field.</p>
|
|
|
|
</div></div><a name="/v5/api/signer/-%23-Signer-estimateGas"></a><div class="property show-anchors"><div class="signature"><span class="path">signer</span><span class="symbol">.</span><span class="method">estimateGas</span><span class="symbol">(</span> <span class="param">transactionRequest</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Promise< <a href="#/v5/api/utils/bignumber/">BigNumber</a> ></span><div class="anchors"><a class="self" href="#/v5/api/signer/-%23-Signer-estimateGas"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/abstract-signer/src.ts/index.ts#L80">source</a></div></div><div class="body"><p>Returns the result of estimating the cost to send the <i>transactionRequest</i>, with this account address being used as the <code class="inline">from</code> field.</p>
|
|
|
|
</div></div><a name="/v5/api/signer/-%23-Signer-resolveName"></a><div class="property show-anchors"><div class="signature"><span class="path">signer</span><span class="symbol">.</span><span class="method">resolveName</span><span class="symbol">(</span> <span class="param">ensName</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Promise< string< <a href="#/v5/api/utils/address/-%23-address">Address</a> > ></span><div class="anchors"><a class="self" href="#/v5/api/signer/-%23-Signer-resolveName"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/abstract-signer/src.ts/index.ts#L114">source</a></div></div><div class="body"><p>Returns the address associated with the <i>ensName</i>.</p>
|
|
|
|
</div></div><a name="/v5/api/signer/-%23-Signer--signing-methods"></a><a name="/v5/api/signer/-%23-signers--Signer--Signer--signing-methods"></a><a name="/v5/api/signer/"></a><h3 class="show-anchors"><div>Signing<div class="anchors"><a class="self" href="#/v5/api/signer/-%23-Signer--signing-methods"></a></div></div></h3>
|
|
<a name="/v5/api/signer/-%23-Signer-signMessage"></a><div class="property show-anchors"><div class="signature"><span class="path">signer</span><span class="symbol">.</span><span class="method">signMessage</span><span class="symbol">(</span> <span class="param">message</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Promise< string< <a href="#/v5/api/utils/bytes/-%23-signature-raw">RawSignature</a> > ></span><div class="anchors"><a class="self" href="#/v5/api/signer/-%23-Signer-signMessage"></a></div></div><div class="body"><p>This returns a Promise which resolves to the <a href="#/v5/api/utils/bytes/-%23-signature-raw">Raw Signature</a> of <i>message</i>.</p>
|
|
|
|
<p>Sub-classes <b>must</b> implement this, however they may throw if signing a message is not supported, such as in a Contract-based Wallet or Meta-Transaction-based Wallet.</p>
|
|
|
|
</div></div><div class="definition container-box note"><div class="term">Note</div><div class="body"><p>If <i>message</i> is a string, it is <b>treated as a string</b> and converted to its representation in UTF8 bytes.</p>
|
|
|
|
<p><b>If and only if</b> a message is a <a href="#/v5/api/utils/bytes/-%23-Bytes">Bytes</a> will it be treated as binary data.</p>
|
|
|
|
<p>For example, the string <code class="inline">"0x1234"</code> is 6 characters long (and in this case 6 bytes long). This is <b>not</b> equivalent to the array <code class="inline">[ 0x12, 0x34 ]</code>, which is 2 bytes long.</p>
|
|
|
|
<p>A common case is to sign a hash. In this case, if the hash is a string, it <b>must</b> be converted to an array first, using the <a href="#/v5/api/utils/bytes/-%23-utils-arrayify">arrayify</a> utility function.</p>
|
|
|
|
</div></div>
|
|
<a name="/v5/api/signer/-%23-Signer-signTransaction"></a><div class="property show-anchors"><div class="signature"><span class="path">signer</span><span class="symbol">.</span><span class="method">signTransaction</span><span class="symbol">(</span> <span class="param">transactionRequest</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Promise< string< <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a> > ></span><div class="anchors"><a class="self" href="#/v5/api/signer/-%23-Signer-signTransaction"></a></div></div><div class="body"><p>Returns a Promise which resolves to the signed transaction of the <i>transactionRequest</i>. This method does not populate any missing fields.</p>
|
|
|
|
<p>Sub-classes <b>must</b> implement this, however they may throw if signing a transaction is not supported, which is common for security reasons in many clients.</p>
|
|
|
|
</div></div><a name="/v5/api/signer/-%23-Signer-sendTransaction"></a><div class="property show-anchors"><div class="signature"><span class="path">signer</span><span class="symbol">.</span><span class="method">sendTransaction</span><span class="symbol">(</span> <span class="param">transactionRequest</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Promise< <a href="#/v5/api/providers/types/-%23-providers-TransactionResponse">TransactionResponse</a> ></span><div class="anchors"><a class="self" href="#/v5/api/signer/-%23-Signer-sendTransaction"></a></div></div><div class="body"><p>This method populates the transactionRequest with missing fields, using <a href="#/v5/api/signer/-%23-Signer-populateTransaction">populateTransaction</a> and returns a Promise which resolves to the transaction.</p>
|
|
|
|
<p>Sub-classes <b>must</b> implement this, however they may throw if sending a transaction is not supported, such as the <a href="#/v5/api/signer/-%23-VoidSigner">VoidSigner</a> or if the Wallet is offline and not connected to a <a href="#/v5/api/providers/provider/">Provider</a>.</p>
|
|
|
|
</div></div><a name="/v5/api/signer/-%23-Signer--subclassing"></a><a name="/v5/api/signer/-%23-signers--Signer--Signer--subclassing"></a><a name="/v5/api/signer/"></a><h3 class="show-anchors"><div>Sub-Classes<div class="anchors"><a class="self" href="#/v5/api/signer/-%23-Signer--subclassing"></a></div></div></h3><p>It is very important that all important properties of a <b>Signer</b> are <b>immutable</b>. Since Ethereum is very asynchronous and deals with critical data (such as ether and other potentially valuable crypto assets), keeping properties such as the <i>provider</i> and <i>address</i> static throughout the life-cycle of the Signer helps prevent serious issues and many other classes and libraries make this assumption.</p>
|
|
|
|
<p>A sub-class <b>must</b> extend Signer and <b>must</b> call <code class="inline">super()</code>.</p>
|
|
|
|
<a name="/v5/api/signer/-%23-Signer-checkTransaction"></a><div class="property show-anchors"><div class="signature"><span class="path">signer</span><span class="symbol">.</span><span class="method">checkTransaction</span><span class="symbol">(</span> <span class="param">transactionRequest</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/providers/types/-%23-providers-TransactionRequest">TransactionRequest</a></span><div class="anchors"><a class="self" href="#/v5/api/signer/-%23-Signer-checkTransaction"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/abstract-signer/src.ts/index.ts#L131">source</a></div></div><div class="body"><p>This is generally not required to be overridden, but may needed to provide custom behaviour in sub-classes.</p>
|
|
|
|
<p>This should return a <b>copy</b> of the <i>transactionRequest</i>, with any properties needed by <code class="inline">call</code>, <code class="inline">estimateGas</code> and <code class="inline">populateTransaction</code> (which is used by sendTransaction). It should also throw an error if any unknown key is specified.</p>
|
|
|
|
<p>The default implementation checks only valid <a href="#/v5/api/providers/types/-%23-providers-TransactionRequest">TransactionRequest</a> properties exist and adds <code class="inline">from</code> to the transaction if it does not exist.</p>
|
|
|
|
<p>If there is a <code class="inline">from</code> field it <b>must</b> be verified to be equal to the Signer's address.</p>
|
|
|
|
</div></div><a name="/v5/api/signer/-%23-Signer-populateTransaction"></a><div class="property show-anchors"><div class="signature"><span class="path">signer</span><span class="symbol">.</span><span class="method">populateTransaction</span><span class="symbol">(</span> <span class="param">transactionRequest</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Promise< <a href="#/v5/api/providers/types/-%23-providers-TransactionRequest">TransactionRequest</a> ></span><div class="anchors"><a class="self" href="#/v5/api/signer/-%23-Signer-populateTransaction"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/abstract-signer/src.ts/index.ts#L162">source</a></div></div><div class="body"><p>This is generally not required to be overridden, but may needed to provide custom behaviour in sub-classes.</p>
|
|
|
|
<p>This should return a <b>copy</b> of <i>transactionRequest</i>, follow the same procedure as <code class="inline">checkTransaction</code> and fill in any properties required for sending a transaction. The result should have all promises resolved; if needed the <a href="#/v5/api/utils/properties/-%23-utils-resolveproperties">resolveProperties</a> utility function can be used for this.</p>
|
|
|
|
<p>The default implementation calls <code class="inline">checkTransaction</code> and resolves to if it is an ENS name, adds <code class="inline">gasPrice</code>, <code class="inline">nonce</code>, <code class="inline">gasLimit</code> and <code class="inline">chainId</code> based on the related operations on Signer.</p>
|
|
|
|
</div></div><a name="/v5/api/signer/-%23-Wallet"></a><a name="/v5/api/signer/-%23-signers--Wallet"></a><a name="/v5/api/signer/"></a><h2 class="show-anchors"><div>Wallet<span class="inherits"> inherits <a href="#/v5/api/signer/-%23-ExternallyOwnedAccount">ExternallyOwnedAccount</a> and <a href="#/v5/api/signer/-%23-Signer">Signer</a></span><div class="anchors"><a class="self" href="#/v5/api/signer/-%23-Wallet"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/wallet/src.ts/index.ts#L30">source</a></div></div></h2><p>The Wallet class inherits <a href="#/v5/api/signer/-%23-Signer">Signer</a> and can sign transactions and messages using a private key as a standard Externally Owned Account (EOA).</p>
|
|
|
|
<a name="/v5/api/signer/-%23-Wallet-constructor"></a><div class="property show-anchors"><div class="signature"><span class="modifier">new </span><span class="path">ethers</span><span class="symbol">.</span><span class="method">Wallet</span><span class="symbol">(</span> <span class="param">privateKey</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">provider</span> <span class="symbol">]</span> <span class="symbol">)</span><div class="anchors"><a class="self" href="#/v5/api/signer/-%23-Wallet-constructor"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/wallet/src.ts/index.ts#L40">source</a></div></div><div class="body"><p>Create a new Wallet instance for <i>privateKey</i> and optionally connected to the <i>provider</i>.</p>
|
|
|
|
</div></div><a name="/v5/api/signer/-%23-Wallet-createRandom"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">Wallet</span><span class="symbol">.</span><span class="method">createRandom</span><span class="symbol">(</span> <span class="symbol">[</span> <span class="param">options</span> = {} <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/signer/-%23-Wallet">Wallet</a></span><div class="anchors"><a class="self" href="#/v5/api/signer/-%23-Wallet-createRandom"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/wallet/src.ts/index.ts#L143">source</a></div></div><div class="body"><p>Returns a new Wallet with a random private key, generated from cryptographically secure entropy sources. If the current environment does not have a secure entropy source, an error is thrown.</p>
|
|
|
|
<p>Wallets created using this method will have a mnemonic.</p>
|
|
|
|
</div></div><a name="/v5/api/signer/-%23-Wallet-fromEncryptedJson"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">Wallet</span><span class="symbol">.</span><span class="method">fromEncryptedJson</span><span class="symbol">(</span> <span class="param">json</span> <span class="symbol">,</span> <span class="param">password</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">progress</span> <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Promise< <a href="#/v5/api/signer/-%23-Wallet">Wallet</a> ></span><div class="anchors"><a class="self" href="#/v5/api/signer/-%23-Wallet-fromEncryptedJson"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/wallet/src.ts/index.ts#L156">source</a></div></div><div class="body"><p>Create an instance from an encrypted JSON wallet.</p>
|
|
|
|
<p>If <i>progress</i> is provided it will be called during decryption with a value between 0 and 1 indicating the progress towards completion.</p>
|
|
|
|
</div></div><a name="/v5/api/signer/-%23-Wallet-fromEncryptedJsonSync"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">Wallet</span><span class="symbol">.</span><span class="method">fromEncryptedJsonSync</span><span class="symbol">(</span> <span class="param">json</span> <span class="symbol">,</span> <span class="param">password</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/signer/-%23-Wallet">Wallet</a></span><div class="anchors"><a class="self" href="#/v5/api/signer/-%23-Wallet-fromEncryptedJsonSync"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/wallet/src.ts/index.ts#L162">source</a></div></div><div class="body"><p>Create an instance from an encrypted JSON wallet.</p>
|
|
|
|
<p>This operation will operate synchronously which will lock up the user interface, possibly for a non-trivial duration. Most applications should use the asynchronous <code class="inline">fromEncryptedJson</code> instead.</p>
|
|
|
|
</div></div><a name="/v5/api/signer/-%23-Wallet.fromMnemonic"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">Wallet</span><span class="symbol">.</span><span class="method">fromMnemonic</span><span class="symbol">(</span> <span class="param">mnemonic</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">path</span> <span class="symbol">,</span> <span class="symbol">[</span> <span class="param">wordlist</span> <span class="symbol">]</span> <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/signer/-%23-Wallet">Wallet</a></span><div class="anchors"><a class="self" href="#/v5/api/signer/-%23-Wallet.fromMnemonic"></a></div></div><div class="body"><p>Create an instance from a mnemonic phrase.</p>
|
|
|
|
<p>If path is not specified, the Ethereum default path is used (i.e. <code class="inline">m/44'/60'/0'/0/0</code>).</p>
|
|
|
|
<p>If wordlist is not specified, the English Wordlist is used.</p>
|
|
|
|
</div></div><a name="/v5/api/signer/-%23-Wallet--properties"></a><a name="/v5/api/signer/-%23-signers--Wallet--Wallet--properties"></a><a name="/v5/api/signer/"></a><h3 class="show-anchors"><div>Properties<div class="anchors"><a class="self" href="#/v5/api/signer/-%23-Wallet--properties"></a></div></div></h3>
|
|
<div class="property show-anchors"><div class="signature"><span class="path">wallet</span><span class="symbol">.</span><span class="method">address</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/address/-%23-address">Address</a> ></span><div class="anchors"></div></div><div class="body"><p>The address for the account this Wallet represents.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">wallet</span><span class="symbol">.</span><span class="method">provider</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/providers/provider/">Provider</a></span><div class="anchors"></div></div><div class="body"><p>The provider this wallet is connected to, which will ge used for any <a href="#/v5/api/signer/-%23-Signer--blockchain-methods">Blockchain Methods</a> methods. This can be null.</p>
|
|
|
|
</div></div><div class="definition container-box note"><div class="term">Note</div><div class="body"><p>A <b>Wallet</b> instance is immutable, so if you wish to change the Provider, you may use the <a href="#/v5/api/signer/-%23-Signer-connect">connect</a> method to create a new instance connected to the desired provider.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">wallet</span><span class="symbol">.</span><span class="method">publicKey</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a>< 65 > ></span><div class="anchors"></div></div><div class="body"><p>The uncompressed public key for this Wallet represents.</p>
|
|
|
|
</div></div><a name="/v5/api/signer/-%23-Wallet--methods"></a><a name="/v5/api/signer/-%23-signers--Wallet--Wallet--methods"></a><a name="/v5/api/signer/"></a><h3 class="show-anchors"><div>Methods<div class="anchors"><a class="self" href="#/v5/api/signer/-%23-Wallet--methods"></a></div></div></h3>
|
|
<a name="/v5/api/signer/-%23-Wallet-encrypt"></a><div class="property show-anchors"><div class="signature"><span class="path">wallet</span><span class="symbol">.</span><span class="method">encrypt</span><span class="symbol">(</span> <span class="param">password</span> <span class="symbol">,</span> <span class="symbol">[</span> <span class="param">options</span> = {} <span class="symbol">,</span> <span class="symbol">[</span> <span class="param">progress</span> <span class="symbol">]</span> <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Promise< string ></span><div class="anchors"><a class="self" href="#/v5/api/signer/-%23-Wallet-encrypt"></a></div></div><div class="body"><p>Encrypt the wallet using <i>password</i> returning a Promise which resolves to a JSON wallet.</p>
|
|
|
|
<p>If <i>progress</i> is provided it will be called during decryption with a value between 0 and 1 indicating the progress towards completion.</p>
|
|
|
|
</div></div><div class="code-title"><div>Wallet Examples</div></div><div class="code"><span class="comment">// Create a wallet instance from a mnemonic...
|
|
</span>mnemonic = "announce room limb pattern dry unit scale effort smooth jazz weasel alcohol"
|
|
walletMnemonic = Wallet.fromMnemonic(mnemonic)
|
|
|
|
<span class="comment">// ...or from a private key
|
|
</span>walletPrivateKey = new Wallet(walletMnemonic.privateKey)
|
|
|
|
walletMnemonic.address === walletPrivateKey.address
|
|
<span class="result ok">// true
|
|
</span>
|
|
<span class="comment">// The address as a Promise per the Signer API
|
|
</span>walletMnemonic.getAddress()
|
|
<span class="result ok">// { Promise: '0x71CB05EE1b1F506fF321Da3dac38f25c0c9ce6E1' }
|
|
</span>
|
|
<span class="comment">// A Wallet address is also available synchronously
|
|
</span>walletMnemonic.address
|
|
<span class="result ok">// '0x71CB05EE1b1F506fF321Da3dac38f25c0c9ce6E1'
|
|
</span>
|
|
<span class="comment">// The internal cryptographic components
|
|
</span>walletMnemonic.privateKey
|
|
<span class="result ok">// '0x1da6847600b0ee25e9ad9a52abbd786dd2502fa4005dd5af9310b7cc7a3b25db'
|
|
</span>walletMnemonic.publicKey
|
|
<span class="result ok">// '0x04b9e72dfd423bcf95b3801ac93f4392be5ff22143f9980eb78b3a860c4843bfd04829ae61cdba4b3b1978ac5fc64f5cc2f4350e35a108a9c9a92a81200a60cd64'
|
|
</span>
|
|
<span class="comment">// The wallet mnemonic
|
|
</span>walletMnemonic.mnemonic
|
|
<span class="result ok">// {
|
|
</span><span class="result ok">// locale: 'en',
|
|
</span><span class="result ok">// path: 'm/44\'/60\'/0\'/0/0',
|
|
</span><span class="result ok">// phrase: 'announce room limb pattern dry unit scale effort smooth jazz weasel alcohol'
|
|
</span><span class="result ok">// }
|
|
</span>
|
|
<span class="comment">// Note: A wallet created with a private key does not
|
|
</span><span class="comment">// have a mnemonic (the derivation prevents it)
|
|
</span>walletPrivateKey.mnemonic
|
|
<span class="result ok">// null
|
|
</span>
|
|
<span class="comment">// Signing a message
|
|
</span>walletMnemonic.signMessage("Hello World")
|
|
<span class="result ok">// { Promise: '0x14280e5885a19f60e536de50097e96e3738c7acae4e9e62d67272d794b8127d31c03d9cd59781d4ee31fb4e1b893bd9b020ec67dfa65cfb51e2bdadbb1de26d91c' }
|
|
</span>
|
|
tx = {
|
|
to: "0x8ba1f109551bD432803012645Ac136ddd64DBA72",
|
|
value: utils.parseEther("1.0")
|
|
}
|
|
|
|
<span class="comment">// Signing a transaction
|
|
</span>walletMnemonic.signTransaction(tx)
|
|
<span class="result ok">// { Promise: '0xf865808080948ba1f109551bd432803012645ac136ddd64dba72880de0b6b3a7640000801ca0918e294306d177ab7bd664f5e141436563854ebe0a3e523b9690b4922bbb52b8a01181612cec9c431c4257a79b8c9f0c980a2c49bb5a0e6ac52949163eeb565dfc' }
|
|
</span>
|
|
<span class="comment">// The connect method returns a new instance of the
|
|
</span><span class="comment">// Wallet connected to a provider
|
|
</span>wallet = walletMnemonic.connect(provider)
|
|
|
|
<span class="comment">// Querying the network
|
|
</span>wallet.getBalance();
|
|
<span class="result ok">// { Promise: { BigNumber: "42" } }
|
|
</span>wallet.getTransactionCount();
|
|
<span class="result ok">// { Promise: 0 }
|
|
</span>
|
|
<span class="comment">// Sending ether
|
|
</span>wallet.sendTransaction(tx)
|
|
</div><a name="/v5/api/signer/-%23-VoidSigner"></a><a name="/v5/api/signer/-%23-signers--VoidSigner"></a><a name="/v5/api/signer/"></a><h2 class="show-anchors"><div>VoidSigner<span class="inherits"> inherits <a href="#/v5/api/signer/-%23-Signer">Signer</a></span><div class="anchors"><a class="self" href="#/v5/api/signer/-%23-VoidSigner"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/abstract-signer/src.ts/index.ts#L211">source</a></div></div></h2><p>A <b>VoidSigner</b> is a simple Signer which cannot sign.</p>
|
|
|
|
<p>It is useful as a read-only signer, when an API requires a Signer as a parameter, but it is known only read-only operations will be carried.</p>
|
|
|
|
<p>For example, the <code class="inline">call</code> operation will automatically have the provided address passed along during the execution.</p>
|
|
|
|
<div class="property show-anchors"><div class="signature"><span class="modifier">new </span><span class="path">ethers</span><span class="symbol">.</span><span class="method">VoidSigner</span><span class="symbol">(</span> <span class="param">address</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">provider</span> <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/signer/-%23-VoidSigner">VoidSigner</a></span><div class="anchors"></div></div><div class="body"><p>Create a new instance of a <b>VoidSigner</b> for <i>address</i>.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">voidSigner</span><span class="symbol">.</span><span class="method">address</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/address/-%23-address">Address</a> ></span><div class="anchors"></div></div><div class="body"><p>The address of this <b>VoidSigner</b>.</p>
|
|
|
|
</div></div><div class="code-title"><div>VoidSigner Pre-flight Example</div></div><div class="code">address = "0x8ba1f109551bD432803012645Ac136ddd64DBA72"
|
|
signer = new ethers.VoidSigner(address, provider)
|
|
|
|
<span class="comment">// The DAI token contract
|
|
</span>abi = [
|
|
"function balanceOf(address) view returns (uint)",
|
|
"function transfer(address, uint) returns (bool)"
|
|
]
|
|
contract = new ethers.Contract("dai.tokens.ethers.eth", abi, signer)
|
|
|
|
<span class="comment">// Get the number of tokens for this account
|
|
</span>tokens = await contract.balanceOf(signer.getAddress())
|
|
<span class="result ok">// { BigNumber: "8814410125722568213383" }
|
|
</span>
|
|
//
|
|
<span class="comment">// Pre-flight (check for revert) on DAI from the signer
|
|
</span>//
|
|
<span class="comment">// Note: We do not have the private key at this point, this
|
|
</span><span class="comment">// simply allows us to check what would happen if we
|
|
</span><span class="comment">// did. This can be useful to check before prompting
|
|
</span><span class="comment">// a request in the UI
|
|
</span>//
|
|
|
|
<span class="comment">// This will pass since the token balance is available
|
|
</span>contract.callStatic.transfer("donations.ethers.eth", tokens)
|
|
<span class="result ok">// { Promise: true }
|
|
</span>
|
|
<span class="comment">// This will fail since it is greater than the token balance
|
|
</span>contract.callStatic.transfer("donations.ethers.eth", tokens.add(1))
|
|
<span class="result error">// Error: call revert exception (method="transfer(address,uint256)", errorSignature="Error(string)", errorArgs=["Dai/insufficient-balance"], reason="Dai/insufficient-balance", code=CALL_EXCEPTION, version=abi/5.0.1)
|
|
</span></div><a name="/v5/api/signer/-%23-ExternallyOwnedAccount"></a><a name="/v5/api/signer/-%23-signers--ExternallyOwnedAccount"></a><a name="/v5/api/signer/"></a><h2 class="show-anchors"><div>ExternallyOwnedAccount<div class="anchors"><a class="self" href="#/v5/api/signer/-%23-ExternallyOwnedAccount"></a></div></div></h2><p>This is an interface which contains a minimal set of properties required for Externally Owned Accounts which can have certain operations performed, such as encoding as a JSON wallet.</p>
|
|
|
|
<div class="property show-anchors"><div class="signature"><span class="path">eoa</span><span class="symbol">.</span><span class="method">address</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/address/-%23-address">Address</a> ></span><div class="anchors"></div></div><div class="body"><p>The <a href="#/v5/api/utils/address/-%23-address">Address</a> of this EOA.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">eoa</span><span class="symbol">.</span><span class="method">privateKey</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a>< 32 > ></span><div class="anchors"></div></div><div class="body"><p>The privateKey of this EOA</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">eoa</span><span class="symbol">.</span><span class="method">mnemonic</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/hdnode/-%23-Mnemonic">Mnemonic</a></span><div class="anchors"></div></div><div class="body"><p><i>Optional</i>. The account HD mnemonic, if it has one and can be determined. Some sources do not encode the mnemonic, such as an HD extended keys.</p>
|
|
|
|
</div></div><div class="page-separator"></div><a name="/v5/api/providers/-%23-providers"></a><a name="/v5/api/providers/-%23-providers"></a><a name="/v5/api/providers/"></a><h1 class="show-anchors"><div>Providers<div class="anchors"><a class="self" href="#/v5/api/providers/-%23-providers"></a></div></div></h1><p>A <b>Provider</b> is an abstraction of a connection to the Ethereum network, providing a concise, consistent interface to standard Ethereum node functionality.</p>
|
|
|
|
<p>The ethers.js library provides several options which should cover the vast majority of use-cases, but also includes the necessary functions and classes for sub-classing if a more custom configuration is necessary.</p>
|
|
|
|
<p>Most users should be able to simply use the <a href="#/v5/api/providers/-%23-providers-getDefaultProvider">Default Provider</a>.</p>
|
|
|
|
<a name="/v5/api/providers/-%23-providers-getDefaultProvider"></a><a name="/v5/api/providers/-%23-providers--providers-getDefaultProvider"></a><a name="/v5/api/providers/"></a><h2 class="show-anchors"><div>Default Provider<div class="anchors"><a class="self" href="#/v5/api/providers/-%23-providers-getDefaultProvider"></a></div></div></h2><p>The default provider is the safest, easiest way to begin developing on <i>Ethereum</i>, and it is also robust enough for use in production.</p>
|
|
|
|
<p>It creates a <a href="#/v5/api/providers/other/-%23-FallbackProvider">FallbackProvider</a> connected to as many backend services as possible. When a request is made, it is sent to multiple backends simulatenously. As responses from each backend are returned, they are checked that they agree. Once a quorum has been reached (i.e. enough of the backends agree), the response is provided to your application.</p>
|
|
|
|
<p>This ensures that if a backend has become out-of-sync, or if it has been compromised that its responses are dropped in favor of responses that match the majority.</p>
|
|
|
|
<div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="method">getDefaultProvider</span><span class="symbol">(</span> <span class="symbol">[</span> <span class="param">network</span> <span class="symbol">,</span> <span class="symbol">[</span> <span class="param">options</span> <span class="symbol">]</span> <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/providers/provider/">Provider</a></span><div class="anchors"></div></div><div class="body"><p>Returns a new Provider, backed by multiple services, connected to <i>network</i>. Is no <i>network</i> is provided, <b>homestead</b> (i.e. mainnet) is used.</p>
|
|
|
|
<p>The <i>options</i> is an object, with the following properties:</p>
|
|
|
|
</div></div><table class="table minimal"><tr><td align="center"><b>Property</b></td><td align="center"><b>Description</b></td><td class="fix"> </td></tr><tr><td align="center"><i>alchemy</i></td><td align="left"><a href="https://alchemyapi.io">Alchemy</a> API Token</td><td class="fix"> </td></tr><tr><td align="center"><i>etherscan</i></td><td align="left"><a href="https://etherscan.io">Etherscan</a> API Token</td><td class="fix"> </td></tr><tr><td align="center"><i>infura</i></td><td align="left"><a href="https://infura.io">INFURA</a> Project ID or ProjectID and Project Secret</td><td class="fix"> </td></tr><tr><td align="center"><i>quorum</i></td><td align="left">The number of backends that must agree <i>(default: 2 for mainnet, 1 for testnets)</i></td><td class="fix"> </td></tr><tr><td class="table-title" colspan="2">Option Properties</td><td class="fix"> </td></tr></table><div class="definition container-box note"><div class="term">Note: API Keys</div><div class="body"><p>It is highly recommended for production services that to acquire and specify an API Key for each sercice.</p>
|
|
|
|
<p>The default API Keys used by ethers are shared across all users, so services may throttle all services that are using the default API Keys during periods of load without realizing it.</p>
|
|
|
|
<p>Many services also have monitoring and usage metrics, which are only available if an API Key is specified. This allows tracking how many requests are being sent and which methods are being used the most.</p>
|
|
|
|
<p>Some services also provide additional paid features, which are only available when specifying an API Key.</p>
|
|
|
|
</div></div><a name="/v5/api/providers/-%23-providers--provider-documentation"></a><a name="/v5/api/providers/"></a><h2 class="show-anchors"><div>Provider Documentation<div class="anchors"><a class="self" href="#/v5/api/providers/-%23-providers--provider-documentation"></a></div></div></h2>
|
|
<div class="toc"><div style="padding-left: 0px"><span class="bullet">•</span><a href="#/v5/api/providers/provider/">Provider</a></div><div style="padding-left: 0px"><span class="bullet">•</span><a href="#/v5/api/providers/jsonrpc-provider/">JsonRpcProvider</a></div><div style="padding-left: 0px"><span class="bullet">•</span><a href="#/v5/api/providers/api-providers/">API Providers</a></div><div style="padding-left: 0px"><span class="bullet">•</span><a href="#/v5/api/providers/other/">Other Providers</a></div><div style="padding-left: 0px"><span class="bullet">•</span><a href="#/v5/api/providers/types/">Types</a></div></div><div class="page-separator"></div><a name="/v5/api/providers/provider/-%23-Provider"></a><a name="/v5/api/providers/provider/-%23-Provider"></a><a name="/v5/api/providers/provider/"></a><h1 class="show-anchors"><div>Provider<div class="anchors"><a class="self" href="#/v5/api/providers/provider/-%23-Provider"></a></div></div></h1><p>Explain what a provider is...</p>
|
|
|
|
<a name="/v5/api/providers/provider/-%23-Provider--account-methods"></a><a name="/v5/api/providers/provider/-%23-Provider--Provider--account-methods"></a><a name="/v5/api/providers/provider/"></a><h2 class="show-anchors"><div>Accounts Methods<div class="anchors"><a class="self" href="#/v5/api/providers/provider/-%23-Provider--account-methods"></a></div></div></h2>
|
|
<a name="/v5/api/providers/provider/-%23-Provider-getBalance"></a><div class="property show-anchors"><div class="signature"><span class="path">provider</span><span class="symbol">.</span><span class="method">getBalance</span><span class="symbol">(</span> <span class="param">address</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">blockTag</span> = <span class="param">latest</span> <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Promise< <a href="#/v5/api/utils/bignumber/">BigNumber</a> ></span><div class="anchors"><a class="self" href="#/v5/api/providers/provider/-%23-Provider-getBalance"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/providers/src.ts/base-provider.ts#L700">source</a></div></div><div class="body"><p>Returns the balance of <i>address</i> as of the <i>blockTag</i> block height.</p>
|
|
|
|
</div></div><a name="/v5/api/providers/provider/-%23-Provider-getCode"></a><div class="property show-anchors"><div class="signature"><span class="path">provider</span><span class="symbol">.</span><span class="method">getCode</span><span class="symbol">(</span> <span class="param">address</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">blockTag</span> = <span class="param">latest</span> <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Promise< string< <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a> > ></span><div class="anchors"><a class="self" href="#/v5/api/providers/provider/-%23-Provider-getCode"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/providers/src.ts/base-provider.ts#L718">source</a></div></div><div class="body"><p>Returns the contract code of <i>address</i> as of the <i>blockTag</i> block height. If there is no contract currently deployed, the result is <code class="inline">0x</code>.</p>
|
|
|
|
</div></div><a name="/v5/api/providers/provider/-%23-Provider-getStorageAt"></a><div class="property show-anchors"><div class="signature"><span class="path">provider</span><span class="symbol">.</span><span class="method">getStorageAt</span><span class="symbol">(</span> <span class="param">addr</span> <span class="symbol">,</span> <span class="param">pos</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">blockTag</span> = <span class="param">latest</span> <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Promise< string< <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a> > ></span><div class="anchors"><a class="self" href="#/v5/api/providers/provider/-%23-Provider-getStorageAt"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/providers/src.ts/base-provider.ts#L727">source</a></div></div><div class="body"><p>Returns the <code class="inline">Bytes32</code> value of the position <i>pos</i> at address <i>addr</i>, as of the <i>blockTag</i>.</p>
|
|
|
|
</div></div><a name="/v5/api/providers/provider/-%23-Provider-getTransactionCount"></a><div class="property show-anchors"><div class="signature"><span class="path">provider</span><span class="symbol">.</span><span class="method">getTransactionCount</span><span class="symbol">(</span> <span class="param">address</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">blockTag</span> = <span class="param">latest</span> <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Promise< number ></span><div class="anchors"><a class="self" href="#/v5/api/providers/provider/-%23-Provider-getTransactionCount"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/providers/src.ts/base-provider.ts#L709">source</a></div></div><div class="body"><p>Returns the number of transactions <i>address</i> has ever <b>sent</b>, as of <i>blockTag</i>. This value is required to be the nonce for the next transaction from <i>address</i> sent to the network.</p>
|
|
|
|
</div></div><div class="code-title"><div>Account Examples</div></div><div class="code"><span class="comment">// Get the balance for an account...
|
|
</span>provider.getBalance("ricmoo.firefly.eth");
|
|
<span class="result ok">// { Promise: { BigNumber: "1585454034436018765" } }
|
|
</span>
|
|
<span class="comment">// Get the code for a contract...
|
|
</span>provider.getCode("registrar.firefly.eth");
|
|
<span class="result ok">// { Promise: '0x606060405236156100885763ffffffff60e060020a60003504166369fe0e2d81146100fa578063704b6c021461010f57806379502c551461012d578063bed866f614610179578063c37067fa1461019e578063c66485b2146101ab578063d80528ae146101c9578063ddca3f43146101f7578063f2c298be14610219578063f3fef3a314610269575b6100f85b6000808052600760209081527f6d5257204ebe7d88fd91ae87941cb2dd9d8062b64ae5a2bd2d28ec40b9fbf6df80543490810190915560408051918252517fdb7750418f9fa390aaf85d881770065aa4adbe46343bcff4ae573754c829d9af929181900390910190a25b565b005b341561010257fe5b6100f860043561028a565b005b341561011757fe5b6100f8600160a060020a03600435166102ec565b005b341561013557fe5b61013d610558565b60408051600160a060020a0396871681526020810195909552928516848401526060840191909152909216608082015290519081900360a00190f35b341561018157fe5b61018c600435610580565b60408051918252519081900360200190f35b6100f8600435610595565b005b34156101b357fe5b6100f8600160a060020a03600435166105e6565b005b34156101d157fe5b6101d9610676565b60408051938452602084019290925282820152519081900360600190f35b34156101ff57fe5b61018c61068d565b60408051918252519081900360200190f35b6100f8600480803590602001908201803590602001908080601f0160208091040260200160405190810160405280939291908181526020018383808284375094965061069495505050505050565b005b341561027157fe5b6100f8600160a060020a0360043516602435610ab2565b005b60025433600160a060020a039081169116146102a65760006000fd5b600454604080519182526020820183905280517f854231545a00e13c316c82155f2b8610d638e9ff6ebc4930676f84a5af08a49a9281900390910190a160048190555b50565b60025433600160a060020a039081169116146103085760006000fd5b60025460408051600160a060020a039283168152918316602083015280517fbadc9a52979e89f78b7c58309537410c5e51d0f63a0a455efe8d61d2b474e6989281900390910190a16002805473ffffffffffffffffffffffffffffffffffffffff1916600160a060020a038381169190911790915560008054604080516020908101849052815160e060020a6302571be30281527f91d1777781884d03a6757a803996e38de2a42967fb37eeaca72729271025a9e26004820152915192909416936302571be39360248084019492938390030190829087803b15156103e957fe5b60325a03f115156103f657fe5b50505060405180519050600160a060020a0316631e83409a826000604051602001526040518263ffffffff1660e060020a0281526004018082600160a060020a0316600160a060020a03168152602001915050602060405180830381600087803b151561045f57fe5b60325a03f1151561046c57fe5b50506040805160008054600354602093840183905284517f0178b8bf00000000000000000000000000000000000000000000000000000000815260048101919091529351600160a060020a039091169450630178b8bf9360248082019493918390030190829087803b15156104dd57fe5b60325a03f115156104ea57fe5b505060408051805160035460025460e860020a62d5fa2b0284526004840191909152600160a060020a03908116602484015292519216925063d5fa2b0091604480830192600092919082900301818387803b151561054457fe5b60325a03f1151561055157fe5b5050505b50565b600054600354600254600454600154600160a060020a039485169492831692165b9091929394565b6000818152600760205260409020545b919050565b6000818152600760209081526040918290208054349081019091558251908152915183927fdb7750418f9fa390aaf85d881770065aa4adbe46343bcff4ae573754c829d9af92908290030190a25b50565b60025433600160a060020a039081169116146106025760006000fd5b60015460408051600160a060020a039283168152918316602083015280517f279875333405c968e401e3bc4e71d5f8e48728c90f4e8180ce28f74efb5669209281900390910190a16001805473ffffffffffffffffffffffffffffffffffffffff1916600160a060020a0383161790555b50565b600654600554600160a060020a033016315b909192565b6004545b90565b80516001820190600080808060048510806106af5750601485115b156106ba5760006000fd5b600093505b8484101561072a57855160ff16925060618310806106e05750607a8360ff16115b80156106fc575060308360ff1610806106fc575060398360ff16115b5b801561070d57508260ff16602d14155b156107185760006000fd5b6001909501945b6001909301926106bf565b60045434101561073a5760006000fd5b866040518082805190602001908083835b6020831061076a5780518252601f19909201916020918201910161074b565b51815160209384036101000a60001901801990921691161790526040805192909401829003822060035483528282018190528451928390038501832060008054948401819052865160e060020a6302571be3028152600481018390529651929a509098509650600160a060020a0390921694506302571be393602480820194509192919082900301818787803b15156107ff57fe5b60325a03f1151561080c57fe5b505060405151600160a060020a031691909114905061082b5760006000fd5b60008054600354604080517f06ab5923000000000000000000000000000000000000000000000000000000008152600481019290925260248201869052600160a060020a03308116604484015290519216926306ab59239260648084019382900301818387803b151561089a57fe5b60325a03f115156108a757fe5b505060008054600154604080517f1896f70a00000000000000000000000000000000000000000000000000000000815260048101879052600160a060020a0392831660248201529051919092169350631896f70a9260448084019391929182900301818387803b151561091657fe5b60325a03f1151561092357fe5b50506001546040805160e860020a62d5fa2b02815260048101859052600160a060020a033381166024830152915191909216925063d5fa2b009160448082019260009290919082900301818387803b151561097a57fe5b60325a03f1151561098757fe5b505060008054604080517f5b0fc9c300000000000000000000000000000000000000000000000000000000815260048101869052600160a060020a0333811660248301529151919092169350635b0fc9c39260448084019391929182900301818387803b15156109f357fe5b60325a03f11515610a0057fe5b505060058054349081019091556006805460010190556000838152600760209081526040918290208054840190558151600160a060020a03331681529081019290925280518493507f179ef3319e6587f6efd3157b34c8b357141528074bcb03f9903589876168fa149281900390910190a260408051348152905182917fdb7750418f9fa390aaf85d881770065aa4adbe46343bcff4ae573754c829d9af919081900360200190a25b50505050505050565b60025433600160a060020a03908116911614610ace5760006000fd5b604051600160a060020a0383169082156108fc029083906000818181858888f193505050501515610aff5760006000fd5b60408051600160a060020a03841681526020810183905281517fac375770417e1cb46c89436efcf586a74d0298fee9838f66a38d40c65959ffda929181900390910190a15b50505600a165627a7a723058205c3628c01dc80233f51979d91a76cec2a25d84e86c9838d34672734ca2232b640029' }
|
|
</span>
|
|
<span class="comment">// Get the storage value at position 0...
|
|
</span>provider.getStorageAt("registrar.firefly.eth", 0)
|
|
<span class="result ok">// { Promise: '0x000000000000000000000000314159265dd8dbb310642f98f50c066173c1259b' }
|
|
</span>
|
|
<span class="comment">// Get transaction count of an account...
|
|
</span>provider.getTransactionCount("ricmoo.firefly.eth");
|
|
<span class="result ok">// { Promise: 670 }
|
|
</span></div><a name="/v5/api/providers/provider/-%23-Provider--block-methods"></a><a name="/v5/api/providers/provider/-%23-Provider--Provider--block-methods"></a><a name="/v5/api/providers/provider/"></a><h2 class="show-anchors"><div>Blocks Methods<div class="anchors"><a class="self" href="#/v5/api/providers/provider/-%23-Provider--block-methods"></a></div></div></h2>
|
|
<a name="/v5/api/providers/provider/-%23-Provider-getBlock"></a><div class="property show-anchors"><div class="signature"><span class="path">provider</span><span class="symbol">.</span><span class="method">getBlock</span><span class="symbol">(</span> <span class="param">block</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Promise< <a href="#/v5/api/providers/types/-%23-providers-Block">Block</a> ></span><div class="anchors"><a class="self" href="#/v5/api/providers/provider/-%23-Provider-getBlock"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/providers/src.ts/base-provider.ts#L936">source</a></div></div><div class="body"><p>Get the <i>block</i> from the network, where the <code class="inline">result.transactions</code> is a list of transaction hashes.</p>
|
|
|
|
</div></div><a name="/v5/api/providers/provider/-%23-Provider-getBlockWithTransactions"></a><div class="property show-anchors"><div class="signature"><span class="path">provider</span><span class="symbol">.</span><span class="method">getBlockWithTransactions</span><span class="symbol">(</span> <span class="param">block</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Promise< <a href="#/v5/api/providers/types/-%23-providers-BlockWithTransactions">BlockWithTransactions</a> ></span><div class="anchors"><a class="self" href="#/v5/api/providers/provider/-%23-Provider-getBlockWithTransactions"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/providers/src.ts/base-provider.ts#L940">source</a></div></div><div class="body"><p>Get the <i>block</i> from the network, where the <code class="inline">result.transactions</code> is an Array of <a href="#/v5/api/providers/types/-%23-providers-TransactionResponse">TransactionResponse</a> objects.</p>
|
|
|
|
</div></div><div class="code-title"><div>Block Examples</div></div><div class="code">provider.getBlock(100004)
|
|
<span class="result ok">// { Promise: {
|
|
</span><span class="result ok">// difficulty: 3849295379889,
|
|
</span><span class="result ok">// extraData: '0x476574682f76312e302e312d39383130306634372f6c696e75782f676f312e34',
|
|
</span><span class="result ok">// gasLimit: { BigNumber: "3141592" },
|
|
</span><span class="result ok">// gasUsed: { BigNumber: "21000" },
|
|
</span><span class="result ok">// hash: '0xf93283571ae16dcecbe1816adc126954a739350cd1523a1559eabeae155fbb63',
|
|
</span><span class="result ok">// miner: '0x909755D480A27911cB7EeeB5edB918fae50883c0',
|
|
</span><span class="result ok">// nonce: '0x1a455280001cc3f8',
|
|
</span><span class="result ok">// number: 100004,
|
|
</span><span class="result ok">// parentHash: '0x73d88d376f6b4d232d70dc950d9515fad3b5aa241937e362fdbfd74d1c901781',
|
|
</span><span class="result ok">// timestamp: 1439799168,
|
|
</span><span class="result ok">// transactions: [
|
|
</span><span class="result ok">// '0x6f12399cc2cb42bed5b267899b08a847552e8c42a64f5eb128c1bcbd1974fb0c'
|
|
</span><span class="result ok">// ]
|
|
</span><span class="result ok">// } }
|
|
</span>
|
|
provider.getBlockWithTransactions(100004)
|
|
<span class="result ok">// { Promise: {
|
|
</span><span class="result ok">// difficulty: 3849295379889,
|
|
</span><span class="result ok">// extraData: '0x476574682f76312e302e312d39383130306634372f6c696e75782f676f312e34',
|
|
</span><span class="result ok">// gasLimit: { BigNumber: "3141592" },
|
|
</span><span class="result ok">// gasUsed: { BigNumber: "21000" },
|
|
</span><span class="result ok">// hash: '0xf93283571ae16dcecbe1816adc126954a739350cd1523a1559eabeae155fbb63',
|
|
</span><span class="result ok">// miner: '0x909755D480A27911cB7EeeB5edB918fae50883c0',
|
|
</span><span class="result ok">// nonce: '0x1a455280001cc3f8',
|
|
</span><span class="result ok">// number: 100004,
|
|
</span><span class="result ok">// parentHash: '0x73d88d376f6b4d232d70dc950d9515fad3b5aa241937e362fdbfd74d1c901781',
|
|
</span><span class="result ok">// timestamp: 1439799168,
|
|
</span><span class="result ok">// transactions: [
|
|
</span><span class="result ok">// {
|
|
</span><span class="result ok">// blockHash: '0xf93283571ae16dcecbe1816adc126954a739350cd1523a1559eabeae155fbb63',
|
|
</span><span class="result ok">// blockNumber: 100004,
|
|
</span><span class="result ok">// chainId: 0,
|
|
</span><span class="result ok">// confirmations: 10284646,
|
|
</span><span class="result ok">// creates: null,
|
|
</span><span class="result ok">// data: '0x',
|
|
</span><span class="result ok">// from: '0xcf00A85f3826941e7A25BFcF9Aac575d40410852',
|
|
</span><span class="result ok">// gasLimit: { BigNumber: "90000" },
|
|
</span><span class="result ok">// gasPrice: { BigNumber: "54588778004" },
|
|
</span><span class="result ok">// hash: '0x6f12399cc2cb42bed5b267899b08a847552e8c42a64f5eb128c1bcbd1974fb0c',
|
|
</span><span class="result ok">// nonce: 25,
|
|
</span><span class="result ok">// r: '0xb23adc880d3735e4389698dddc953fb02f1fa9b57e84d3510a2a4b3597ac2486',
|
|
</span><span class="result ok">// s: '0x4e856f95c4e2828933246fb4765a5bfd2ca5959840643bef0e80b4e3a243d064',
|
|
</span><span class="result ok">// to: '0xD9666150A9dA92d9108198a4072970805a8B3428',
|
|
</span><span class="result ok">// transactionIndex: 0,
|
|
</span><span class="result ok">// v: 27,
|
|
</span><span class="result ok">// value: { BigNumber: "5000000000000000000" }
|
|
</span><span class="result ok">// }
|
|
</span><span class="result ok">// ]
|
|
</span><span class="result ok">// } }
|
|
</span></div><a name="/v5/api/providers/provider/-%23-Provider--ens-methods"></a><a name="/v5/api/providers/provider/-%23-Provider--Provider--ens-methods"></a><a name="/v5/api/providers/provider/"></a><h2 class="show-anchors"><div>Ethereum Naming Service (ENS) Methods<div class="anchors"><a class="self" href="#/v5/api/providers/provider/-%23-Provider--ens-methods"></a></div></div></h2><p>The <a href="https://ens.domains/">Ethereum Naming Service</a> (ENS) allows a short and easy-to-remember ENS Name to be attached to any set of keys and values.</p>
|
|
|
|
<p>One of the most common uses for this is to use a simple name to refer to an <a href="#/v5/api/utils/address/-%23-address">Ethereum Address</a>.</p>
|
|
|
|
<p>In the ethers API, nearly anywhere that accepts an address, an ENS name may be used instead, which can simplify code and make reading and debugging much simpler.</p>
|
|
|
|
<p>The provider offers some basic operations to help resolve and work with ENS names.</p>
|
|
|
|
<a name="/v5/api/providers/provider/-%23-Provider-lookupAddress"></a><div class="property show-anchors"><div class="signature"><span class="path">provider</span><span class="symbol">.</span><span class="method">lookupAddress</span><span class="symbol">(</span> <span class="param">address</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Promise< string ></span><div class="anchors"><a class="self" href="#/v5/api/providers/provider/-%23-Provider-lookupAddress"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/providers/src.ts/base-provider.ts#L1099">source</a></div></div><div class="body"><p>Performs a reverse lookup of the <i>address</i> in ENS using the <i>Reverse Registrar</i>. If the name does not exist, or the forward lookup does not match, <code class="inline">null</code> is returned.</p>
|
|
|
|
</div></div><a name="/v5/api/providers/provider/-%23-Provider-ResolveName"></a><div class="property show-anchors"><div class="signature"><span class="path">provider</span><span class="symbol">.</span><span class="method">resolveName</span><span class="symbol">(</span> <span class="param">name</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Promise< string< <a href="#/v5/api/utils/address/-%23-address">Address</a> > ></span><div class="anchors"><a class="self" href="#/v5/api/providers/provider/-%23-Provider-ResolveName"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/providers/src.ts/base-provider.ts#L1071">source</a></div></div><div class="body"><p>Looks up the address of <i>name</i>. If the name is not owned, or does not have a <i>Resolver</i> configured, or the <i>Resolver</i> does not have an address configured, <code class="inline">null</code> is returned.</p>
|
|
|
|
</div></div><div class="code-title"><div>ENS Examples</div></div><div class="code"><span class="comment">// Reverse lookup of an ENS by address...
|
|
</span>provider.lookupAddress("0x6fC21092DA55B392b045eD78F4732bff3C580e2c");
|
|
<span class="result ok">// { Promise: 'registrar.firefly.eth' }
|
|
</span>
|
|
<span class="comment">// Lookup an address of an ENS name...
|
|
</span>provider.resolveName("ricmoo.firefly.eth");
|
|
<span class="result ok">// { Promise: '0x8ba1f109551bD432803012645Ac136ddd64DBA72' }
|
|
</span></div><a name="/v5/api/providers/provider/-%23-Provider--log-methods"></a><a name="/v5/api/providers/provider/-%23-Provider--Provider--log-methods"></a><a name="/v5/api/providers/provider/"></a><h2 class="show-anchors"><div>Logs Methods<div class="anchors"><a class="self" href="#/v5/api/providers/provider/-%23-Provider--log-methods"></a></div></div></h2>
|
|
<a name="/v5/api/providers/provider/-%23-Provider-getLogs"></a><div class="property show-anchors"><div class="signature"><span class="path">provider</span><span class="symbol">.</span><span class="method">getLogs</span><span class="symbol">(</span> <span class="param">filter</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Promise< Array< <a href="#/v5/api/providers/types/-%23-providers-Log">Log</a> > ></span><div class="anchors"><a class="self" href="#/v5/api/providers/provider/-%23-Provider-getLogs"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/providers/src.ts/base-provider.ts#L1016">source</a></div></div><div class="body"><p>Returns the Array of <a href="#/v5/api/providers/types/-%23-providers-Log">Log</a> matching the <i>filter</i>.</p>
|
|
|
|
<p>Keep in mind that many backends will discard old events, and that requests which are too broad may get dropped as they require too many resources to execute the query.</p>
|
|
|
|
</div></div><a name="/v5/api/providers/provider/-%23-Provider--network-methods"></a><a name="/v5/api/providers/provider/-%23-Provider--Provider--network-methods"></a><a name="/v5/api/providers/provider/"></a><h2 class="show-anchors"><div>Network Status Methods<div class="anchors"><a class="self" href="#/v5/api/providers/provider/-%23-Provider--network-methods"></a></div></div></h2>
|
|
<a name="/v5/api/providers/provider/-%23-Provider-getNetwork"></a><div class="property show-anchors"><div class="signature"><span class="path">provider</span><span class="symbol">.</span><span class="method">getNetwork</span><span class="symbol">(</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Promise< <a href="#/v5/api/providers/types/-%23-providers-Network">Network</a> ></span><div class="anchors"><a class="self" href="#/v5/api/providers/provider/-%23-Provider-getNetwork"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/providers/src.ts/base-provider.ts#L520">source</a></div></div><div class="body"><p>Returns the <a href="#/v5/api/providers/types/-%23-providers-Network">Network</a> this Provider is connected to.</p>
|
|
|
|
</div></div><a name="/v5/api/providers/provider/-%23-Provider-getBlockNumber"></a><div class="property show-anchors"><div class="signature"><span class="path">provider</span><span class="symbol">.</span><span class="method">getBlockNumber</span><span class="symbol">(</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Promise< number ></span><div class="anchors"><a class="self" href="#/v5/api/providers/provider/-%23-Provider-getBlockNumber"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/providers/src.ts/base-provider.ts#L691">source</a></div></div><div class="body"><p>Returns the block number (or height) of the most recently mined block.</p>
|
|
|
|
</div></div><a name="/v5/api/providers/provider/-%23-Provider-getGasPrice"></a><div class="property show-anchors"><div class="signature"><span class="path">provider</span><span class="symbol">.</span><span class="method">getGasPrice</span><span class="symbol">(</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Promise< <a href="#/v5/api/utils/bignumber/">BigNumber</a> ></span><div class="anchors"><a class="self" href="#/v5/api/providers/provider/-%23-Provider-getGasPrice"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/providers/src.ts/base-provider.ts#L695">source</a></div></div><div class="body"><p>Returns a <i>best guess</i> of the <a href="#/v5/concepts/gas/-%23-gas-price">Gas Price</a> to use in a transaction.</p>
|
|
|
|
</div></div><div class="code-title"><div>Network Status Examples</div></div><div class="code"><span class="comment">// The network information
|
|
</span>provider.getNetwork()
|
|
<span class="result ok">// {
|
|
</span><span class="result ok">// chainId: 1,
|
|
</span><span class="result ok">// ensAddress: '0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e',
|
|
</span><span class="result ok">// name: 'homestead'
|
|
</span><span class="result ok">// }
|
|
</span>
|
|
<span class="comment">// The current block number
|
|
</span>provider.getBlockNumber()
|
|
<span class="result ok">// { Promise: 10384649 }
|
|
</span>
|
|
<span class="comment">// Get the current suggested gas price (in wei)...
|
|
</span>gasPrice = await provider.getGasPrice()
|
|
<span class="result ok">// { BigNumber: "41000000000" }
|
|
</span>
|
|
<span class="comment">// ...often this gas price is easier to understand or
|
|
</span><span class="comment">// display to the user in gwei (giga-wei, or 1e9 wei)
|
|
</span>utils.formatUnits(gasPrice, "gwei")
|
|
<span class="result ok">// '41.0'
|
|
</span></div><a name="/v5/api/providers/provider/-%23-Provider--transaction-methods"></a><a name="/v5/api/providers/provider/-%23-Provider--Provider--transaction-methods"></a><a name="/v5/api/providers/provider/"></a><h2 class="show-anchors"><div>Transactions Methods<div class="anchors"><a class="self" href="#/v5/api/providers/provider/-%23-Provider--transaction-methods"></a></div></div></h2>
|
|
<a name="/v5/api/providers/provider/-%23-Provider-call"></a><div class="property show-anchors"><div class="signature"><span class="path">provider</span><span class="symbol">.</span><span class="method">call</span><span class="symbol">(</span> <span class="param">transaction</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">blockTag</span> = <span class="param">latest</span> <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Promise< string< <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a> > ></span><div class="anchors"><a class="self" href="#/v5/api/providers/provider/-%23-Provider-call"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/providers/src.ts/base-provider.ts#L836">source</a></div></div><div class="body"><p>Returns the result of executing the <i>transaction</i>, using <i>call</i>. A call does not require any ether, but cannot change any state. This is useful for calling gettings on Contracts.</p>
|
|
|
|
</div></div><a name="/v5/api/providers/provider/-%23-Provider-estimateGas"></a><div class="property show-anchors"><div class="signature"><span class="path">provider</span><span class="symbol">.</span><span class="method">estimateGas</span><span class="symbol">(</span> <span class="param">transaction</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Promise< <a href="#/v5/api/utils/bignumber/">BigNumber</a> ></span><div class="anchors"><a class="self" href="#/v5/api/providers/provider/-%23-Provider-estimateGas"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/providers/src.ts/base-provider.ts#L845">source</a></div></div><div class="body"><p>Returns an estimate of the amount of gas that would be required to submit <i>transaction</i> to the network.</p>
|
|
|
|
<p>An estimate may not be accurate since there could be another transaction on the network that was not accounted for, but after being mined affected relevant state.</p>
|
|
|
|
</div></div><a name="/v5/api/providers/provider/-%23-Provider-sendTransaction"></a><div class="property show-anchors"><div class="signature"><span class="path">provider</span><span class="symbol">.</span><span class="method">sendTransaction</span><span class="symbol">(</span> <span class="param">transaction</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Promise< <a href="#/v5/api/providers/types/-%23-providers-TransactionResponse">TransactionResponse</a> ></span><div class="anchors"><a class="self" href="#/v5/api/providers/provider/-%23-Provider-sendTransaction"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/providers/src.ts/base-provider.ts#L777">source</a></div></div><div class="body"><p>Submits <i>transaction</i> to the network to be mined. The <i>transaction</i> <b>must</b> be signed, and be valid (i.e. the nonce is correct and the account has sufficient balance to pay for the transaction).</p>
|
|
|
|
</div></div><a name="/v5/api/providers/provider/-%23-Provider-waitForTransaction"></a><div class="property show-anchors"><div class="signature"><span class="path">provider</span><span class="symbol">.</span><span class="method">waitForTransaction</span><span class="symbol">(</span> <span class="param">hash</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">confirms</span> = <span class="param">1</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">timeout</span> <span class="symbol">]</span> <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Promise< <a href="#/v5/api/providers/types/-%23-providers-TransactionReceipt">TxReceipt</a> ></span><div class="anchors"><a class="self" href="#/v5/api/providers/provider/-%23-Provider-waitForTransaction"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/providers/src.ts/base-provider.ts#L652">source</a></div></div><div class="body"><p>Returns a Promise which will not resolve until <i>transactionHash</i> is mined.</p>
|
|
|
|
</div></div><a name="/v5/api/providers/provider/-%23-Provider--event-methods"></a><a name="/v5/api/providers/provider/-%23-Provider--Provider--event-methods"></a><a name="/v5/api/providers/provider/"></a><h2 class="show-anchors"><div>Event Emitter Methods<div class="anchors"><a class="self" href="#/v5/api/providers/provider/-%23-Provider--event-methods"></a></div></div></h2><p>Explain events here...</p>
|
|
|
|
<a name="/v5/api/providers/provider/-%23-Provider-on"></a><div class="property show-anchors"><div class="signature"><span class="path">provider</span><span class="symbol">.</span><span class="method">on</span><span class="symbol">(</span> <span class="param">eventName</span> <span class="symbol">,</span> <span class="param">listener</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">this</span><div class="anchors"><a class="self" href="#/v5/api/providers/provider/-%23-Provider-on"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/providers/src.ts/base-provider.ts#L1157">source</a></div></div><div class="body"><p>Add a <i>listener</i> to be triggered for each <i>eventName</i>.</p>
|
|
|
|
</div></div><a name="/v5/api/providers/provider/-%23-Provider-once"></a><div class="property show-anchors"><div class="signature"><span class="path">provider</span><span class="symbol">.</span><span class="method">once</span><span class="symbol">(</span> <span class="param">eventName</span> <span class="symbol">,</span> <span class="param">listener</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">this</span><div class="anchors"><a class="self" href="#/v5/api/providers/provider/-%23-Provider-once"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/providers/src.ts/base-provider.ts#L1161">source</a></div></div><div class="body"><p>Add a <i>listener</i> to be triggered for only the next <i>eventName</i>, at which time it be removed.</p>
|
|
|
|
</div></div><a name="/v5/api/providers/provider/-%23-Provider-emit"></a><div class="property show-anchors"><div class="signature"><span class="path">provider</span><span class="symbol">.</span><span class="method">emit</span><span class="symbol">(</span> <span class="param">eventName</span> <span class="symbol">,</span> ...<span class="param">args</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">boolean</span><div class="anchors"><a class="self" href="#/v5/api/providers/provider/-%23-Provider-emit"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/providers/src.ts/base-provider.ts#L1166">source</a></div></div><div class="body"><p>Notify all listeners of <i>eventName</i>, passing <i>args</i> to each listener. This is generally only used internally.</p>
|
|
|
|
</div></div><a name="/v5/api/providers/provider/-%23-Provider-off"></a><div class="property show-anchors"><div class="signature"><span class="path">provider</span><span class="symbol">.</span><span class="method">off</span><span class="symbol">(</span> <span class="param">eventName</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">listener</span> <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">this</span><div class="anchors"><a class="self" href="#/v5/api/providers/provider/-%23-Provider-off"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/providers/src.ts/base-provider.ts#L1214">source</a></div></div><div class="body"><p>Remove a <i>listener</i> for <i>eventName</i>. If no <i>listener</i> is provided, all listeners for <i>eventName</i> are removed.</p>
|
|
|
|
</div></div><a name="/v5/api/providers/provider/-%23-Provider-removeAllListeners"></a><div class="property show-anchors"><div class="signature"><span class="path">provider</span><span class="symbol">.</span><span class="method">removeAllListeners</span><span class="symbol">(</span> <span class="symbol">[</span> <span class="param">eventName</span> <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">this</span><div class="anchors"><a class="self" href="#/v5/api/providers/provider/-%23-Provider-removeAllListeners"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/providers/src.ts/base-provider.ts#L1237">source</a></div></div><div class="body"><p>Remove all the listeners for <i>eventName</i>. If no <i>eventName</i> is provided, <b>all</b> events are removed.</p>
|
|
|
|
</div></div><a name="/v5/api/providers/provider/-%23-Provider-listenerCount"></a><div class="property show-anchors"><div class="signature"><span class="path">provider</span><span class="symbol">.</span><span class="method">listenerCount</span><span class="symbol">(</span> <span class="symbol">[</span> <span class="param">eventName</span> <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">number</span><div class="anchors"><a class="self" href="#/v5/api/providers/provider/-%23-Provider-listenerCount"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/providers/src.ts/base-provider.ts#L1194">source</a></div></div><div class="body"><p>Returns the number of listeners for <i>eventName</i>. If no <i>eventName</i> is provided, the total number of listeners is returned.</p>
|
|
|
|
</div></div><a name="/v5/api/providers/provider/-%23-Provider-listeners"></a><div class="property show-anchors"><div class="signature"><span class="path">provider</span><span class="symbol">.</span><span class="method">listeners</span><span class="symbol">(</span> <span class="param">eventName</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Array< Listener ></span><div class="anchors"><a class="self" href="#/v5/api/providers/provider/-%23-Provider-listeners"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/providers/src.ts/base-provider.ts#L1203">source</a></div></div><div class="body"><p>Returns the list of Listeners for <i>eventName</i>.</p>
|
|
|
|
</div></div><a name="/v5/api/providers/provider/-%23-Provider--events"></a><a name="/v5/api/providers/provider/-%23-Provider--Provider--event-methods--Provider--events"></a><a name="/v5/api/providers/provider/"></a><h3 class="show-anchors"><div>Events<div class="anchors"><a class="self" href="#/v5/api/providers/provider/-%23-Provider--events"></a></div></div></h3><p>Any of the following may be used as the <i>eventName</i> in the above methods.</p>
|
|
|
|
<div class="definition"><div class="term"><b>Log Filter</b></div><div class="body"><p>A filter is an object, representing a contract log Filter, which has the optional properties <code class="inline">address</code> (the source contract) and <code class="inline">topics</code> (a topic-set to match).</p>
|
|
|
|
<p>If <code class="inline">address</code> is unspecified, the filter matches any contract address.</p>
|
|
|
|
<p>See events for more information on how to specify topic-sets.</p>
|
|
|
|
</div></div><div class="definition"><div class="term"><b>Topic-Set Filter</b></div><div class="body"><p>The value of a <b>Topic-Set Filter</b> is a array of Topic-Sets.</p>
|
|
|
|
<p>This event is identical to a <i>Log Filter</i> with the address omitted (i.e. from any contract).</p>
|
|
|
|
</div></div><div class="definition"><div class="term"><b>Transaction Filter</b></div><div class="body"><p>The value of a <b>Transaction Filter</b> is any transaction hash.</p>
|
|
|
|
<p>This event is emitted on every block that is part of a chain that includes the given mined transaction. It is much more common that the <a href="#/v5/api/providers/provider/-%23-Provider-once">once</a> method is used than the <a href="#/v5/api/providers/provider/-%23-Provider-on">on</a> method.</p>
|
|
|
|
</div></div><p>In addition to transaction and filter events, there are several named events.</p>
|
|
|
|
<table class="table full"><tr><td align="center" width="16%"><b>Event Name</b></td><td align="center" colspan="2" width="28%"><b>Arguments</b></td><td align="center" colspan="4" width="56%"><b>Description</b></td><td class="fix"> </td></tr><tr><td align="center" width="16%"><code class="inline">"block"</code></td><td align="center" colspan="2" width="28%"><i>blockNumber</i></td><td align="left" colspan="4" width="56%">emitted when a new block is mined</td><td class="fix"> </td></tr><tr><td align="center" width="16%"><code class="inline">"error"</code></td><td align="center" colspan="2" width="28%"><i>error</i></td><td align="left" colspan="4" width="56%">emitted on any error</td><td class="fix"> </td></tr><tr><td align="center" width="16%"><code class="inline">"pending"</code></td><td align="center" colspan="2" width="28%"><i>pendingTransaction</i></td><td align="left" colspan="4" width="56%">emitted when a new transaction enters the memory pool; only certain providers offer this event and may require running your own node for reliable results</td><td class="fix"> </td></tr><tr><td align="center" width="16%"><code class="inline">"willPoll"</code></td><td align="center" colspan="2" width="28%"><i>pollId</i></td><td align="left" colspan="4" width="56%">emitted prior to a polling loop is about to begin; <i>(very rarely used by most developers)</i></td><td class="fix"> </td></tr><tr><td align="center" width="16%"><code class="inline">"poll"</code></td><td align="center" colspan="2" width="28%"><i>pollId</i>, <i>blockNumber</i></td><td align="left" colspan="4" width="56%">emitted during each poll cycle after `blockNumber` is updated (if changed) and before any other events (if any) are emitted during the poll loop; <i>(very rarely used by most developers)</i></td><td class="fix"> </td></tr><tr><td align="center" width="16%"><code class="inline">"didPoll"</code></td><td align="center" colspan="2" width="28%"><i>pollId</i></td><td align="left" colspan="4" width="56%">emitted after all events from a polling loop are emitted; <i>(very rarely used by most developers)</i></td><td class="fix"> </td></tr><tr><td align="center" width="16%"><code class="inline">"debug"</code></td><td align="center" colspan="2" width="28%">provider dependent</td><td align="left" colspan="4" width="56%">each Provider may use this to emit useful debugging information and the format is up to the developer; <i>(very rarely used by most developers)</i></td><td class="fix"> </td></tr><tr><td class="table-title" colspan="7">Named Provider Events</td><td class="fix"> </td></tr></table><div class="code-title"><div>Events Example</div></div><div class="code">provider.on("block", (blockNumber) => {
|
|
<span class="comment"> // Emitted on every block change
|
|
</span>})
|
|
|
|
|
|
provider.once(txHash, (transaction) => {
|
|
<span class="comment"> // Emitted when the transaction has been mined
|
|
</span>})
|
|
|
|
|
|
<span class="comment">// This filter could also be generated with the Contract or
|
|
</span><span class="comment">// Interface API. If address is not specified, any address
|
|
</span><span class="comment">// matches and if topics is not specified, any log matches
|
|
</span>filter = {
|
|
address: "dai.tokens.ethers.eth",
|
|
topics: [
|
|
utils.id("Transfer(address,address,uint256")
|
|
]
|
|
}
|
|
provider.on(filter, (log, event) => {
|
|
<span class="comment"> // Emitted whenever a DAI token transfer occurs
|
|
</span>})
|
|
|
|
|
|
<span class="comment">// Notice this is an array of topic-sets and is identical to
|
|
</span><span class="comment">// using a filter with no address (i.e. match any address)
|
|
</span>topicSets = [
|
|
utils.id("Transfer(address,address,uint256"),
|
|
null,
|
|
[
|
|
myAddress,
|
|
myOtherAddress
|
|
]
|
|
]
|
|
provider.on(topicSets, (log, event) => {
|
|
<span class="comment"> // Emitted any token is sent TO either address
|
|
</span>})
|
|
|
|
|
|
provider.on("pending", (tx) => {
|
|
<span class="comment"> // Emitted when any new pending transaction is noticed
|
|
</span>});
|
|
|
|
|
|
provider.on("error", (tx) => {
|
|
<span class="comment"> // Emitted when any error occurs
|
|
</span>});
|
|
</div><a name="/v5/api/providers/provider/-%23-Provider--inspection-methods"></a><a name="/v5/api/providers/provider/-%23-Provider--Provider--inspection-methods"></a><a name="/v5/api/providers/provider/"></a><h2 class="show-anchors"><div>Inspection Methods<div class="anchors"><a class="self" href="#/v5/api/providers/provider/-%23-Provider--inspection-methods"></a></div></div></h2>
|
|
<a name="/v5/api/providers/provider/-%23-Provider-isProvider"></a><div class="property show-anchors"><div class="signature"><span class="path">Provider</span><span class="symbol">.</span><span class="method">isProvider</span><span class="symbol">(</span> <span class="param">object</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">boolean</span><div class="anchors"><a class="self" href="#/v5/api/providers/provider/-%23-Provider-isProvider"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/abstract-provider/src.ts/index.ts#L269">source</a></div></div><div class="body"><p>Returns true if and only if <i>object</i> is a Provider.</p>
|
|
|
|
</div></div><div class="page-separator"></div><a name="/v5/api/providers/jsonrpc-provider/-%23-JsonRpcProvider"></a><a name="/v5/api/providers/jsonrpc-provider/-%23-JsonRpcProvider"></a><a name="/v5/api/providers/jsonrpc-provider/"></a><h1 class="show-anchors"><div>JsonRpcProvider<span class="inherits"> inherits <a href="#/v5/api/providers/provider/">Provider</a></span><div class="anchors"><a class="self" href="#/v5/api/providers/jsonrpc-provider/-%23-JsonRpcProvider"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/providers/src.ts/json-rpc-provider.ts#L220">source</a></div></div></h1><p>The <a href="https://github.com/ethereum/wiki/wiki/JSON-RPC">JSON-RPC API</a> is a very popular method for interacting with Ethereum and is available in all major Ethereum node implementations (e.g. <a href="https://geth.ethereum.org">Geth</a> and <a href="https://www.parity.io">Parity</a>) as well as many third-party web services (e.g. <a href="https://infura.io">INFURA</a>)</p>
|
|
|
|
<div class="property show-anchors"><div class="signature"><span class="modifier">new </span><span class="path">ethers</span><span class="symbol">.</span><span class="path">providers</span><span class="symbol">.</span><span class="method">JsonRpcProvider</span><span class="symbol">(</span> <span class="symbol">[</span> <span class="param">url</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">aNetworkish</span> <span class="symbol">]</span> <span class="symbol">]</span> <span class="symbol">)</span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/providers/src.ts/json-rpc-provider.ts#L226">source</a></div></div><div class="body"><p>Connect to a JSON-RPC API located at <i>url</i> using the <i>aNetworkish</i> network. If <i>url</i> is not specified, the default (i.e. <code class="inline">http://localhost:8545</code>) is used and if no network is specified, it will be determined automatically by querying the node.</p>
|
|
|
|
</div></div><div class="definition container-box note"><div class="term">Note: Connecting to a Local Node</div><div class="body"><p>Each node implementation is slightly different and may require specific command-line flags, configuration or settings in their UI to enable JSON-RPC, unlock accounts or expose specific APIs. Please consult their documentation.</p>
|
|
|
|
</div></div><a name="/v5/api/providers/jsonrpc-provider/-%23-JsonRpcProvider-getSigner"></a><div class="property show-anchors"><div class="signature"><span class="path">jsonRpcProvider</span><span class="symbol">.</span><span class="method">getSigner</span><span class="symbol">(</span> <span class="symbol">[</span> <span class="param">addressOrIndex</span> <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/providers/jsonrpc-provider/-%23-JsonRpcSigner">JsonRpcSigner</a></span><div class="anchors"><a class="self" href="#/v5/api/providers/jsonrpc-provider/-%23-JsonRpcProvider-getSigner"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/providers/src.ts/json-rpc-provider.ts#L294">source</a></div></div><div class="body"><p>Returns a <a href="#/v5/api/providers/jsonrpc-provider/-%23-JsonRpcSigner">JsonRpcSigner</a> which is managed by this Ethereum node, at <i>addressOrIndex</i>. If no <i>addressOrIndex</i> is provided, the first account (account #0) is used.</p>
|
|
|
|
</div></div><a name="/v5/api/providers/jsonrpc-provider/-%23-JsonRpcProvider-getUncheckedSigner"></a><div class="property show-anchors"><div class="signature"><span class="path">jsonRpcProvider</span><span class="symbol">.</span><span class="method">getUncheckedSigner</span><span class="symbol">(</span> <span class="symbol">[</span> <span class="param">addressOrIndex</span> <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/providers/jsonrpc-provider/-%23-UncheckedJsonRpcSigner">JsonRpcUncheckedSigner</a></span><div class="anchors"><a class="self" href="#/v5/api/providers/jsonrpc-provider/-%23-JsonRpcProvider-getUncheckedSigner"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/providers/src.ts/json-rpc-provider.ts#L298">source</a></div></div><div class="body">
|
|
</div></div><a name="/v5/api/providers/jsonrpc-provider/-%23-JsonRpcProvider-listAccounts"></a><div class="property show-anchors"><div class="signature"><span class="path">jsonRpcProvider</span><span class="symbol">.</span><span class="method">listAccounts</span><span class="symbol">(</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Array< string ></span><div class="anchors"><a class="self" href="#/v5/api/providers/jsonrpc-provider/-%23-JsonRpcProvider-listAccounts"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/providers/src.ts/json-rpc-provider.ts#L302">source</a></div></div><div class="body"><p>Returns a list of all account addresses managed by this provider.</p>
|
|
|
|
</div></div><a name="/v5/api/providers/jsonrpc-provider/-%23-JsonRpcProvider-send"></a><div class="property show-anchors"><div class="signature"><span class="path">jsonRpcProvider</span><span class="symbol">.</span><span class="method">send</span><span class="symbol">(</span> <span class="param">method</span> <span class="symbol">,</span> <span class="param">params</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Promise< any ></span><div class="anchors"><a class="self" href="#/v5/api/providers/jsonrpc-provider/-%23-JsonRpcProvider-send"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/providers/src.ts/json-rpc-provider.ts#L308">source</a></div></div><div class="body"><p>Allows sending raw messages to the provider.</p>
|
|
|
|
<p>This can be used for backend-specific calls, such as for debugging or specific account management.</p>
|
|
|
|
</div></div><a name="/v5/api/providers/jsonrpc-provider/-%23-JsonRpcSigner"></a><a name="/v5/api/providers/jsonrpc-provider/-%23-JsonRpcProvider--JsonRpcSigner"></a><a name="/v5/api/providers/jsonrpc-provider/"></a><h2 class="show-anchors"><div>JsonRpcSigner<span class="inherits"> inherits <a href="#/v5/api/signer/-%23-Signer">Signer</a></span><div class="anchors"><a class="self" href="#/v5/api/providers/jsonrpc-provider/-%23-JsonRpcSigner"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/providers/src.ts/json-rpc-provider.ts#L46">source</a></div></div></h2><p>A <b>JsonRpcSigner</b> is a simple Signer which is backed by a connected <a href="#/v5/api/providers/jsonrpc-provider/">JsonRpcProvider</a>.</p>
|
|
|
|
<div class="property show-anchors"><div class="signature"><span class="path">signer</span><span class="symbol">.</span><span class="method">provider</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/providers/jsonrpc-provider/">JsonRpcProvider</a></span><div class="anchors"></div></div><div class="body"><p>The provider this signer was established from.</p>
|
|
|
|
</div></div><a name="/v5/api/providers/jsonrpc-provider/-%23-JsonRpcSigner-connectUnchecked"></a><div class="property show-anchors"><div class="signature"><span class="path">signer</span><span class="symbol">.</span><span class="method">connectUnchecked</span><span class="symbol">(</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/providers/jsonrpc-provider/-%23-UncheckedJsonRpcSigner">JsonRpcUncheckedSigner</a></span><div class="anchors"><a class="self" href="#/v5/api/providers/jsonrpc-provider/-%23-JsonRpcSigner-connectUnchecked"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/providers/src.ts/json-rpc-provider.ts#L83">source</a></div></div><div class="body"><p>Returns a new Signer object which does not perform additional checks when sending a transaction. See <a href="#/v5/api/providers/jsonrpc-provider/-%23-JsonRpcProvider-getUncheckedSigner">getUncheckedSigner</a> for more details.</p>
|
|
|
|
</div></div><a name="/v5/api/providers/jsonrpc-provider/-%23-JsonRpcSigner-sendUncheckedTransaction"></a><div class="property show-anchors"><div class="signature"><span class="path">signer</span><span class="symbol">.</span><span class="method">sendUncheckedTransaction</span><span class="symbol">(</span> <span class="param">transaction</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Promise< string< <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a>< 32 > > ></span><div class="anchors"><a class="self" href="#/v5/api/providers/jsonrpc-provider/-%23-JsonRpcSigner-sendUncheckedTransaction"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/providers/src.ts/json-rpc-provider.ts#L102">source</a></div></div><div class="body"><p>Sends the <i>transaction</i> and returns a Promise which resolves to the opaque transaction hash.</p>
|
|
|
|
</div></div><a name="/v5/api/providers/jsonrpc-provider/-%23-JsonRpcSigner-unlock"></a><div class="property show-anchors"><div class="signature"><span class="path">signer</span><span class="symbol">.</span><span class="method">unlock</span><span class="symbol">(</span> <span class="param">password</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Promise< boolean ></span><div class="anchors"><a class="self" href="#/v5/api/providers/jsonrpc-provider/-%23-JsonRpcSigner-unlock"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/providers/src.ts/json-rpc-provider.ts#L188">source</a></div></div><div class="body"><p>Request the node unlock the account (if locked) using <i>password</i>.</p>
|
|
|
|
</div></div><a name="/v5/api/providers/jsonrpc-provider/-%23-UncheckedJsonRpcSigner"></a><a name="/v5/api/providers/jsonrpc-provider/-%23-JsonRpcProvider--UncheckedJsonRpcSigner"></a><a name="/v5/api/providers/jsonrpc-provider/"></a><h2 class="show-anchors"><div>JsonRpcUncheckedSigner<span class="inherits"> inherits <a href="#/v5/api/signer/-%23-Signer">Signer</a></span><div class="anchors"><a class="self" href="#/v5/api/providers/jsonrpc-provider/-%23-UncheckedJsonRpcSigner"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/providers/src.ts/json-rpc-provider.ts#L197">source</a></div></div></h2><p>The JSON-RPC API only provides a transaction hash as the response when a transaction is sent, but the ethers Provider requires populating all details of a transaction before returning it. For example, the gas price and gas limit may be adjusted by the node or the nonce automatically included, in which case the opaque transaction hash has discarded this.</p>
|
|
|
|
<p>To remedy this, the <a href="#/v5/api/providers/jsonrpc-provider/-%23-JsonRpcSigner">JsonRpcSigner</a> immediately queries the provider for the details using the returned transaction hash to populate the <a href="#/v5/api/providers/types/-%23-providers-TransactionResponse">TransactionResponse</a> object.</p>
|
|
|
|
<p>Some backends do not respond immediately and instead defer releasing the details of a transaction it was responsible for signing until it is mined.</p>
|
|
|
|
<p>The <b>UncheckedSigner</b> does not populate any additional information and will immediately return the result as a mock <a href="#/v5/api/providers/types/-%23-providers-TransactionResponse">TransactionResponse</a>-like object, with most of the properties set to null, but allows access to the transaction hash quickly, if that is all that is required.</p>
|
|
|
|
<a name="/v5/api/providers/jsonrpc-provider/-%23-JsonRpcProvider--other"></a><a name="/v5/api/providers/jsonrpc-provider/-%23-JsonRpcProvider--JsonRpcProvider--other"></a><a name="/v5/api/providers/jsonrpc-provider/"></a><h2 class="show-anchors"><div>Node-Specific Methods<div class="anchors"><a class="self" href="#/v5/api/providers/jsonrpc-provider/-%23-JsonRpcProvider--other"></a></div></div></h2><p>Many methods are less common or specific to certain Ethereum Node implementations (e.g. <a href="https://www.parity.io">Parity</a> vs <a href="https://geth.ethereum.org">Geth</a>. These include account and admin management, debugging, deeper block and transaction exploration and other services (such as Swarm and Whisper).</p>
|
|
|
|
<p>The <a href="#/v5/api/providers/jsonrpc-provider/-%23-JsonRpcProvider-send">jsonRpcProvider.send</a> method can be used to access these.</p>
|
|
|
|
<p><ul><li><a href="https://github.com/ethereum/wiki/wiki/JSON-RPC">All JSON-RPC methods</a> (including the less common methods) which most Ethereum Nodes support. </li><li><a href="https://openethereum.github.io/wiki/JSONRPC-trace-module">Parity's Trace Module</a> can be used to trace and debug EVM execution of a transaction (requires custom configuration) </li><li><a href="https://github.com/ethereum/go-ethereum/wiki/Management-APIs#debug">Geth's Debug Module</a> can be used to debug transactions and internal cache state, etc. </li><li><a href="https://github.com/ethereum/go-ethereum/wiki/Management-APIs">Additional Geth Methods</a> </li><li><a href="https://openethereum.github.io/wiki/JSONRPC">Additional Parity Methods</a> </li></ul></p>
|
|
|
|
<div class="page-separator"></div><a name="/v5/api/providers/api-providers/-%23-api-providers"></a><a name="/v5/api/providers/api-providers/-%23-api-providers"></a><a name="/v5/api/providers/api-providers/"></a><h1 class="show-anchors"><div>API Providers<div class="anchors"><a class="self" href="#/v5/api/providers/api-providers/-%23-api-providers"></a></div></div></h1><p>There are many services which offer a web API for accessing the Ethereum Blockchain. These Providers allow connecting to them, which simplifies development, since you do not need to run your own instance or cluster of Ethereum nodes.</p>
|
|
|
|
<p>However, this reliance on third-party services can reduce resiliance, security and increase the amount of required trust. To mitigate these issues, it is recommended you use a <a href="#/v5/api/providers/-%23-providers-getDefaultProvider">Default Provider</a>.</p>
|
|
|
|
<a name="/v5/api/providers/api-providers/-%23-EtherscanProvider"></a><a name="/v5/api/providers/api-providers/-%23-api-providers--EtherscanProvider"></a><a name="/v5/api/providers/api-providers/"></a><h2 class="show-anchors"><div>EtherscanProvider<span class="inherits"> inherits <a href="#/v5/api/providers/provider/">Provider</a></span><div class="anchors"><a class="self" href="#/v5/api/providers/api-providers/-%23-EtherscanProvider"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/providers/src.ts/etherscan-provider.ts#L76">source</a></div></div></h2><p>The <b>EtherscanProvider</b> is backed by a combination of the various <a href="https://etherscan.io/apis">Etherscan APIs</a>.</p>
|
|
|
|
<div class="property show-anchors"><div class="signature"><span class="modifier">new </span><span class="path">ethers</span><span class="symbol">.</span><span class="path">providers</span><span class="symbol">.</span><span class="method">EtherscanProvider</span><span class="symbol">(</span> <span class="symbol">[</span> <span class="param">network</span> = "<span class="param">homestead</span>" <span class="symbol">,</span> <span class="symbol">[</span> <span class="param">apiKey</span> <span class="symbol">]</span> <span class="symbol">]</span> <span class="symbol">)</span><div class="anchors"></div></div><div class="body"><p>Create a new <b>EtherscanProvider</b> connected to <i>network</i> with the optional <i>apiKey</i>.</p>
|
|
|
|
<p>The <i>network</i> may be specified as <b>string</b> for a common network name, a <b>number</b> for a common chain ID or a [Network Object]provider-(network).</p>
|
|
|
|
<p>If no <i>apiKey</i> is provided, a shared API key will be used, which may result in reduced performance and throttled requests. It is highly recommended for production, you register with <a href="https://etherscan.io">Etherscan</a> for your own API key.</p>
|
|
|
|
</div></div><div class="definition container-box note"><div class="term">Note: Default API keys</div><div class="body"><p>If no <i>apiKey</i> is provided, a shared API key will be used, which may result in reduced performance and throttled requests.</p>
|
|
|
|
<p>It is highly recommended for production, you register with <a href="https://etherscan.io">Etherscan</a> for your own API key.</p>
|
|
|
|
</div></div><div class="definition"><div class="term"><b>Supported Networks</b></div><div class="body"><p><ul><li>Homestead (Mainnet) </li><li>Ropsten (proof-of-work testnet) </li><li>Rinkeby (proof-of-authority testnet) </li><li>Görli (clique testnet) </li><li>Kovan (proof-of-authority testnet) </li></ul></p>
|
|
|
|
</div></div><div class="code-title"><div>Etherscan Examples</div></div><div class="code"><span class="comment">// Connect to mainnet (homestead)
|
|
</span>provider = new EtherscanProvider();
|
|
|
|
<span class="comment">// Connect to rinkeby testnet (these are equivalent)
|
|
</span>provider = new EtherscanProvider("rinkeby");
|
|
provider = new EtherscanProvider(4);
|
|
|
|
const network = ethers.providers.getNetwork("rinkeby");
|
|
<span class="result ok">// {
|
|
</span><span class="result ok">// chainId: 4,
|
|
</span><span class="result ok">// ensAddress: '0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e',
|
|
</span><span class="result ok">// name: 'rinkeby'
|
|
</span><span class="result ok">// }
|
|
</span>
|
|
provider = new EtherscanProvider(network);
|
|
|
|
<span class="comment">// Connect to mainnet (homestead) with an API key
|
|
</span>provider = new EtherscanProvider(null, apiKey);
|
|
provider = new EtherscanProvider("homestead", apiKey);
|
|
</div><div class="property show-anchors"><div class="signature"><span class="path">provider</span><span class="symbol">.</span><span class="method">getHistory</span><span class="symbol">(</span> <span class="param">address</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Array< History ></span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/providers/src.ts/etherscan-provider.ts#L306">source</a></div></div><div class="body"><p>@TODO... Explain</p>
|
|
|
|
</div></div><a name="/v5/api/providers/api-providers/-%23-InfuraProvider"></a><a name="/v5/api/providers/api-providers/-%23-api-providers--InfuraProvider"></a><a name="/v5/api/providers/api-providers/"></a><h2 class="show-anchors"><div>InfuraProvider<span class="inherits"> inherits <a href="#/v5/api/providers/other/-%23-UrlJsonRpcProvider">UrlJsonRpcProvider</a></span><div class="anchors"><a class="self" href="#/v5/api/providers/api-providers/-%23-InfuraProvider"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/providers/src.ts/infura-provider.ts#L17">source</a></div></div></h2><p>The <b>InfuraProvider</b> is backed by the popular <a href="https://infura.io">INFURA</a> Ethereum service.</p>
|
|
|
|
<div class="property show-anchors"><div class="signature"><span class="modifier">new </span><span class="path">ethers</span><span class="symbol">.</span><span class="path">providers</span><span class="symbol">.</span><span class="method">InfuraProvider</span><span class="symbol">(</span> <span class="symbol">[</span> <span class="param">network</span> = "<span class="param">homestead</span>" <span class="symbol">,</span> <span class="symbol">[</span> <span class="param">apiKey</span> <span class="symbol">]</span> <span class="symbol">]</span> <span class="symbol">)</span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/providers/src.ts/infura-provider.ts#L17">source</a></div></div><div class="body"><p>Create a new <b>InfuraProvider</b> connected to <i>network</i> with the optional <i>apiKey</i>.</p>
|
|
|
|
<p>The <i>network</i> may be specified as <b>string</b> for a common network name, a <b>number</b> for a common chain ID or a [Network Object]provider-(network).</p>
|
|
|
|
<p>The <i>apiKey</i> can be a <b>string</b> Project ID or an <b>object</b> with the properties <code class="inline">projectId</code> and <code class="inline">projectSecret</code> to specify a <a href="https://infura.io/docs/gettingStarted/authentication">Project Secret</a> which can be used on non-public sources (like on a server) to further secure your API access and quotas.</p>
|
|
|
|
</div></div><a name="/v5/api/providers/api-providers/-%23-InfuraProvider-getWebSocketProvider"></a><div class="property show-anchors"><div class="signature"><span class="path">InfuraProvider</span><span class="symbol">.</span><span class="method">getWebSocketProvider</span><span class="symbol">(</span> <span class="symbol">[</span> <span class="param">network</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">apiKey</span> <span class="symbol">]</span> <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/providers/other/-%23-WebSocketProvider">WebSocketProvider</a></span><div class="anchors"><a class="self" href="#/v5/api/providers/api-providers/-%23-InfuraProvider-getWebSocketProvider"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/providers/src.ts/infura-provider.ts#L21">source</a></div></div><div class="body"><p>Create a new <a href="#/v5/api/providers/other/-%23-WebSocketProvider">WebSocketProvider</a> using the INFURA web-socket endpoint to connect to <i>network</i> with the optional <i>apiKey</i>.</p>
|
|
|
|
<p>The <i>network</i> and <i>apiKey</i> are specified the same as <a href="#/v5/api/providers/api-providers/-%23-InfuraProvider">the constructor</a>.</p>
|
|
|
|
</div></div><div class="definition container-box note"><div class="term">Note: Default API keys</div><div class="body"><p>If no <i>apiKey</i> is provided, a shared API key will be used, which may result in reduced performance and throttled requests.</p>
|
|
|
|
<p>It is highly recommended for production, you register with <a href="https://infura.io">INFURA</a> for your own API key.</p>
|
|
|
|
</div></div><div class="definition"><div class="term"><b>Supported Networks</b></div><div class="body"><p><ul><li>Homestead (Mainnet) </li><li>Ropsten (proof-of-work testnet) </li><li>Rinkeby (proof-of-authority testnet) </li><li>Görli (clique testnet) </li><li>Kovan (proof-of-authority testnet) </li></ul></p>
|
|
|
|
</div></div><div class="code-title"><div>INFURA Examples</div></div><div class="code"><span class="comment">// Connect to mainnet (homestead)
|
|
</span>provider = new InfuraProvider();
|
|
|
|
<span class="comment">// Connect to the ropsten testnet
|
|
</span><span class="comment">// (see EtherscanProvider above for other network examples)
|
|
</span>provider = new InfuraProvider("ropsten");
|
|
|
|
<span class="comment">// Connect to mainnet with a Project ID (these are equivalent)
|
|
</span>provider = new InfuraProvider(null, projectId);
|
|
provider = new InfuraProvider("homestead", projectId);
|
|
|
|
<span class="comment">// Connect to mainnet with a Project ID and Project Secret
|
|
</span>provider = new InfuraProvider("homestead", {
|
|
projectId: projectId,
|
|
projectSecret: projectSecret
|
|
});
|
|
|
|
<span class="comment">// Connect to the INFURA WebSocket endpoints with a WebSocketProvider
|
|
</span>provider = InfuraProvider.getWebSocketProvider()
|
|
</div><a name="/v5/api/providers/api-providers/-%23-AlchemyProvider"></a><a name="/v5/api/providers/api-providers/-%23-api-providers--AlchemyProvider"></a><a name="/v5/api/providers/api-providers/"></a><h2 class="show-anchors"><div>AlchemyProvider<span class="inherits"> inherits <a href="#/v5/api/providers/other/-%23-UrlJsonRpcProvider">UrlJsonRpcProvider</a></span><div class="anchors"><a class="self" href="#/v5/api/providers/api-providers/-%23-AlchemyProvider"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/providers/src.ts/alchemy-provider.ts#L20">source</a></div></div></h2><p>The <b>AlchemyProvider</b> is backed by <a href="https://alchemyapi.io">Alchemy</a>.</p>
|
|
|
|
<div class="property show-anchors"><div class="signature"><span class="modifier">new </span><span class="path">ethers</span><span class="symbol">.</span><span class="path">providers</span><span class="symbol">.</span><span class="method">AlchemyProvider</span><span class="symbol">(</span> <span class="symbol">[</span> <span class="param">network</span> = "<span class="param">homestead</span>" <span class="symbol">,</span> <span class="symbol">[</span> <span class="param">apiKey</span> <span class="symbol">]</span> <span class="symbol">]</span> <span class="symbol">)</span><div class="anchors"></div></div><div class="body"><p>Create a new <b>AlchemyProvider</b> connected to <i>network</i> with the optional <i>apiKey</i>.</p>
|
|
|
|
<p>The <i>network</i> may be specified as <b>string</b> for a common network name, a <b>number</b> for a common chain ID or a <a href="#/v5/api/providers/types/-%23-providers-Network">Network Object</a>.</p>
|
|
|
|
</div></div><div class="definition container-box note"><div class="term">Note: Default API keys</div><div class="body"><p>If no <i>apiKey</i> is provided, a shared API key will be used, which may result in reduced performance and throttled requests.</p>
|
|
|
|
<p>It is highly recommended for production, you register with <a href="https://alchemyapi.io">Alchemy</a> for your own API key.</p>
|
|
|
|
</div></div><div class="definition"><div class="term"><b>Supported Networks</b></div><div class="body"><p><ul><li>Homestead (Mainnet) </li><li>Ropsten (proof-of-work testnet) </li><li>Rinkeby (proof-of-authority testnet) </li><li>Görli (clique testnet) </li><li>Kovan (proof-of-authority testnet) </li></ul></p>
|
|
|
|
</div></div><div class="code-title"><div>Alchemy Examples</div></div><div class="code"><span class="comment">// Connect to mainnet (homestead)
|
|
</span>provider = new AlchemyProvider();
|
|
|
|
<span class="comment">// Connect to the ropsten testnet
|
|
</span><span class="comment">// (see EtherscanProvider above for other network examples)
|
|
</span>provider = new AlchemyProvider("ropsten");
|
|
|
|
<span class="comment">// Connect to mainnet with an API key (these are equivalent)
|
|
</span>provider = new AlchemyProvider(null, apiKey);
|
|
provider = new AlchemyProvider("homestead", apiKey);
|
|
</div><a name="/v5/api/providers/api-providers/-%23-CloudflareProvider"></a><a name="/v5/api/providers/api-providers/-%23-api-providers--CloudflareProvider"></a><a name="/v5/api/providers/api-providers/"></a><h2 class="show-anchors"><div>CloudflareProvider<span class="inherits"> inherits <a href="#/v5/api/providers/other/-%23-UrlJsonRpcProvider">UrlJsonRpcProvider</a></span><div class="anchors"><a class="self" href="#/v5/api/providers/api-providers/-%23-CloudflareProvider"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/providers/src.ts/cloudflare-provider.ts#L10">source</a></div></div></h2><p>The CloudflareProvider is backed by the <a href="https://developers.cloudflare.com/distributed-web/ethereum-gateway/">Cloudflare Ethereum Gateway</a>.</p>
|
|
|
|
<div class="property show-anchors"><div class="signature"><span class="modifier">new </span><span class="path">ethers</span><span class="symbol">.</span><span class="path">providers</span><span class="symbol">.</span><span class="method">CloudflareProvider</span><span class="symbol">(</span> <span class="symbol">)</span><div class="anchors"></div></div><div class="body"><p>Create a new <b>CloudflareProvider</b> connected to mainnet (i.e. "homestead").</p>
|
|
|
|
</div></div><div class="definition"><div class="term"><b>Supported Networks</b></div><div class="body"><p><ul><li>Homestead (Mainnet) </li></ul></p>
|
|
|
|
</div></div><div class="code-title"><div>Cloudflare Examples</div></div><div class="code"><span class="comment">// Connect to mainnet (homestead)
|
|
</span>provider = new CloudflareProvider();
|
|
</div><div class="page-separator"></div><a name="/v5/api/providers/other/-%23-other-providers"></a><a name="/v5/api/providers/other/"></a><h1 class="show-anchors"><div>Other Providers<div class="anchors"><a class="self" href="#/v5/api/providers/other/-%23-other-providers"></a></div></div></h1><p>Others...</p>
|
|
|
|
<a name="/v5/api/providers/other/-%23-FallbackProvider"></a><a name="/v5/api/providers/other/-%23-other-providers--FallbackProvider"></a><a name="/v5/api/providers/other/"></a><h2 class="show-anchors"><div>FallbackProvider<span class="inherits"> inherits <a href="#/v5/api/providers/provider/">Provider</a></span><div class="anchors"><a class="self" href="#/v5/api/providers/other/-%23-FallbackProvider"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/providers/src.ts/fallback-provider.ts#L384">source</a></div></div></h2><p>The <b>FallbackProvider</b> is the most advanced <a href="#/v5/api/providers/provider/">Provider</a> available in ethers.</p>
|
|
|
|
<p>It uses a quorum and connects to multiple <a href="#/v5/api/providers/provider/">Providers</a> as backends, each configured with a <i>priority</i> and a <i>weight</i> .</p>
|
|
|
|
<p>When a request is made, the request is dispatched to multiple backends, randomly choosen (higher prioirty backends are always selected first) and the results from each are compared against the others. Only once the quorum has been reached will that result be accepted and returned to the caller.</p>
|
|
|
|
<p>By default the quorum requires 50% (rounded up) of the backends to agree. The <i>weight</i> can be used to give a backend Provider more influence.</p>
|
|
|
|
<div class="property show-anchors"><div class="signature"><span class="modifier">new </span><span class="path">ethers</span><span class="symbol">.</span><span class="path">providers</span><span class="symbol">.</span><span class="method">FallbackProvider</span><span class="symbol">(</span> <span class="param">providers</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">quorum</span> <span class="symbol">]</span> <span class="symbol">)</span><div class="anchors"></div></div><div class="body"><p>Creates a new instance of a FallbackProvider connected to <i>providers</i>. If quorum is not specified, half of the total sum of the provider weights is used.</p>
|
|
|
|
<p>The <i>providers</i> can be either an array of <a href="#/v5/api/providers/provider/">Provider</a> or <a href="#/v5/api/providers/other/-%23-FallbackProviderConfig">FallbackProviderConfig</a>. If a <a href="#/v5/api/providers/provider/">Provider</a> is provided, the defaults are a priority of 1 and a weight of 1.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">provider</span><span class="symbol">.</span><span class="method">providerConfigs</span> <span class="arrow">⇒</span> <span class="returns">Array< <a href="#/v5/api/providers/other/-%23-FallbackProviderConfig">FallbackProviderConfig</a> ></span><div class="anchors"></div></div><div class="body"><p>The list of Provider Configurations that describe the backends.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">provider</span><span class="symbol">.</span><span class="method">quorum</span> <span class="arrow">⇒</span> <span class="returns">number</span><div class="anchors"></div></div><div class="body"><p>The quorum the backend responses must agree upon before a result will be resolved. By default this is <i>half the sum of the weights</i>.</p>
|
|
|
|
</div></div><a name="/v5/api/providers/other/-%23-FallbackProviderConfig"></a><a name="/v5/api/providers/other/-%23-other-providers--FallbackProvider--FallbackProviderConfig"></a><a name="/v5/api/providers/other/"></a><h3 class="show-anchors"><div>FallbackProviderConfig<div class="anchors"><a class="self" href="#/v5/api/providers/other/-%23-FallbackProviderConfig"></a></div></div></h3>
|
|
<div class="property show-anchors"><div class="signature"><span class="path">fallbackProviderConfig</span><span class="symbol">.</span><span class="method">provider</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/providers/provider/">Provider</a></span><div class="anchors"></div></div><div class="body"><p>The provider for this configuration.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">fallbackProviderConfig</span><span class="symbol">.</span><span class="method">priority</span> <span class="arrow">⇒</span> <span class="returns">number</span><div class="anchors"></div></div><div class="body"><p>The priority used for the provider. Higher priorities are favoured over lower priorities. If multiple providers share the same prioirty, they are choosen at random.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">fallbackProviderConfig</span><span class="symbol">.</span><span class="method">stallTimeout</span> <span class="arrow">⇒</span> <span class="returns">number</span><div class="anchors"></div></div><div class="body"><p>The timeout (in ms) after which another <a href="#/v5/api/providers/provider/">Provider</a> will be attempted. This does not affect the current Provider; if it returns a result it is counted as part of the quorum.</p>
|
|
|
|
<p>Lower values will result in more network traffic, but may reduce the response time of requests.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">fallbackProviderConfig</span><span class="symbol">.</span><span class="method">weight</span> <span class="arrow">⇒</span> <span class="returns">number</span><div class="anchors"></div></div><div class="body"><p>The weight a response from this provider provides. This can be used if a given <a href="#/v5/api/providers/provider/">Provider</a> is more trusted, for example.</p>
|
|
|
|
</div></div><a name="/v5/api/providers/other/-%23-IpcProvider"></a><a name="/v5/api/providers/other/-%23-other-providers--IpcProvider"></a><a name="/v5/api/providers/other/"></a><h2 class="show-anchors"><div>IpcProvider<span class="inherits"> inherits <a href="#/v5/api/providers/jsonrpc-provider/">JsonRpcProvider</a></span><div class="anchors"><a class="self" href="#/v5/api/providers/other/-%23-IpcProvider"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/providers/src.ts/ipc-provider.ts#L15">source</a></div></div></h2><p>The <b>IpcProvider</b> allows the JSON-RPC API to be used over a local filename on the file system, exposed by Geth, Parity and other nodes.</p>
|
|
|
|
<p>This is only available in <i>node.js</i> (as it requires file system access, and may have additional complications due to file permissions. See any related notes on the documentation for the actual node implementation websites.</p>
|
|
|
|
<div class="property show-anchors"><div class="signature"><span class="path">ipcProvider</span><span class="symbol">.</span><span class="method">path</span> <span class="arrow">⇒</span> <span class="returns">string</span><div class="anchors"></div></div><div class="body"><p>The path this <a href="#/v5/api/providers/provider/">Provider</a> is connected to.</p>
|
|
|
|
</div></div><a name="/v5/api/providers/other/-%23-UrlJsonRpcProvider"></a><a name="/v5/api/providers/other/-%23-other-providers--UrlJsonRpcProvider"></a><a name="/v5/api/providers/other/"></a><h2 class="show-anchors"><div>UrlJsonRpcProvider<span class="inherits"> inherits <a href="#/v5/api/providers/jsonrpc-provider/">JsonRpcProvider</a></span><div class="anchors"><a class="self" href="#/v5/api/providers/other/-%23-UrlJsonRpcProvider"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/providers/src.ts/url-json-rpc-provider.ts#L35">source</a></div></div></h2><p>This class is intended to be sub-classed and not used directly. It simplifies creating a <a href="#/v5/api/providers/provider/">Provider</a> where a normal <a href="#/v5/api/providers/jsonrpc-provider/">JsonRpcProvider</a> would suffice, with a little extra effort needed to generate the JSON-RPC URL.</p>
|
|
|
|
<div class="property show-anchors"><div class="signature"><span class="modifier">new </span><span class="path">ethers</span><span class="symbol">.</span><span class="path">providers</span><span class="symbol">.</span><span class="method">UrlJsonRpcProvider</span><span class="symbol">(</span> <span class="symbol">[</span> <span class="param">network</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">apiKey</span> <span class="symbol">]</span> <span class="symbol">]</span> <span class="symbol">)</span><div class="anchors"></div></div><div class="body"><p>Sub-classes do not need to override this. Instead they should override the static method <code class="inline">getUrl</code> and optionally <code class="inline">getApiKey</code>.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">urlJsonRpcProvider</span><span class="symbol">.</span><span class="method">apiKey</span> <span class="arrow">⇒</span> <span class="returns">any</span><div class="anchors"></div></div><div class="body"><p>The value of the apiKey that was returned from <code class="inline">InheritedClass.getApiKey</code>.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">InheritingClass</span><span class="symbol">.</span><span class="method">getApiKey</span><span class="symbol">(</span> <span class="param">apiKey</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">any</span><div class="anchors"></div></div><div class="body"><p>This function should examine the <i>apiKey</i> to ensure it is valid and return a (possible modified) value to use in <code class="inline">getUrl</code>.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">InheritingClass</span><span class="symbol">.</span><span class="method">getUrl</span><span class="symbol">(</span> <span class="param">network</span> <span class="symbol">,</span> <span class="param">apiKey</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">string</span><div class="anchors"></div></div><div class="body"><p>The URL to use for the JsonRpcProvider instance.</p>
|
|
|
|
</div></div><a name="/v5/api/providers/other/-%23-Web3Provider"></a><a name="/v5/api/providers/other/-%23-other-providers--Web3Provider"></a><a name="/v5/api/providers/other/"></a><h2 class="show-anchors"><div>Web3Provider<span class="inherits"> inherits <a href="#/v5/api/providers/jsonrpc-provider/">JsonRpcProvider</a></span><div class="anchors"><a class="self" href="#/v5/api/providers/other/-%23-Web3Provider"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/providers/src.ts/web3-provider.ts#L77">source</a></div></div></h2><p>The Web3Provider is meant to ease moving from a <a href="https://github.com/ethereum/web3.js">web3.js based</a> application to ethers by wraping an existing Web3-compatible (such as a <a href="https://github.com/ethereum/web3.js/tree/1.x/packages/web3-providers-http">Web3HttpProvider</a>, <a href="https://github.com/ethereum/web3.js/tree/1.x/packages/web3-providers-ipc">Web3IpcProvider</a> or <a href="https://github.com/ethereum/web3.js/tree/1.x/packages/web3-providers-ws">Web3WsProvider</a>) and exposing it as an ethers.js <a href="#/v5/api/providers/provider/">Provider</a> which can then be used with the rest of the library.</p>
|
|
|
|
<p>This may also be used to wrap a standard [EIP-1193 Provider](link-eip-1193].</p>
|
|
|
|
<div class="property show-anchors"><div class="signature"><span class="modifier">new </span><span class="path">ethers</span><span class="symbol">.</span><span class="path">providers</span><span class="symbol">.</span><span class="method">Web3Provider</span><span class="symbol">(</span> <span class="param">externalProvider</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">network</span> <span class="symbol">]</span> <span class="symbol">)</span><div class="anchors"></div></div><div class="body"><p>Create a new <b>Web3Provider</b>, which wraps an <a href="https://eips.ethereum.org/EIPS/eip-1193">EIP-1193 Provider</a> or Web3Provider-compatible Provider.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">web3Provider</span><span class="symbol">.</span><span class="method">provider</span> <span class="arrow">⇒</span> <span class="returns">Web3CompatibleProvider</span><div class="anchors"></div></div><div class="body"><p>The provider used to create this instance.</p>
|
|
|
|
</div></div><a name="/v5/api/providers/other/-%23-Web3Provider--ExternalProvider"></a><a name="/v5/api/providers/other/-%23-other-providers--Web3Provider--Web3Provider--ExternalProvider"></a><a name="/v5/api/providers/other/"></a><h3 class="show-anchors"><div>ExternalProvider<div class="anchors"><a class="self" href="#/v5/api/providers/other/-%23-Web3Provider--ExternalProvider"></a></div></div></h3><p>An <b>ExternalProvider</b> can be either one for the above mentioned Web3 Providers (or otherwise compatible) or an <a href="https://eips.ethereum.org/EIPS/eip-1193">EIP-1193</a> provider.</p>
|
|
|
|
<p>An ExternalProvider must offer one of the following signatures, and the first matching is used:</p>
|
|
|
|
<div class="property show-anchors"><div class="signature"><span class="path">externalProvider</span><span class="symbol">.</span><span class="method">request</span><span class="symbol">(</span> <span class="param">request</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Promise< any ></span><div class="anchors"></div></div><div class="body"><p>This follows the <a href="https://eips.ethereum.org/EIPS/eip-1193">EIP-1193</a> API signature.</p>
|
|
|
|
<p>The <i>request</i> should be a standard JSON-RPC payload, which should at a minimum specify the <code class="inline">method</code> and <code class="inline">params</code>.</p>
|
|
|
|
<p>The result should be the actual result, which differs from the Web3.js response, which is a wrapped JSON-RPC response.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">externalProvider</span><span class="symbol">.</span><span class="method">sendAsync</span><span class="symbol">(</span> <span class="param">request</span> <span class="symbol">,</span> <span class="param">callback</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">void</span><div class="anchors"></div></div><div class="body"><p>This follows the <a href="https://github.com/ethereum/web3.js/blob/1.x/packages/web3-providers-http/types/index.d.ts#L57">Web3.js Provider Signature</a>.</p>
|
|
|
|
<p>The <i>request</i> should be a standard JSON-RPC payload, which should at a minimum specify the <code class="inline">method</code> and <code class="inline">params</code>.</p>
|
|
|
|
<p>The <i>callback</i> should use the error-first calling semantics, so <code class="inline">(error, result)</code> where the result is a JSON-RPC wrapped result.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">externalProvider</span><span class="symbol">.</span><span class="method">send</span><span class="symbol">(</span> <span class="param">request</span> <span class="symbol">,</span> <span class="param">callback</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">void</span><div class="anchors"></div></div><div class="body"><p>This is identical to <code class="inline">sendAsync</code>. Historically, this used a synchronous web request, but no current browsers support this, so its use this way was deprecated quite a long time ago</p>
|
|
|
|
</div></div><a name="/v5/api/providers/other/-%23-WebSocketProvider"></a><a name="/v5/api/providers/other/-%23-other-providers--WebSocketProvider"></a><a name="/v5/api/providers/other/"></a><h2 class="show-anchors"><div>WebSocketProvider<span class="inherits"> inherits <a href="#/v5/api/providers/jsonrpc-provider/">JsonRpcProvider</a></span><div class="anchors"><a class="self" href="#/v5/api/providers/other/-%23-WebSocketProvider"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/providers/src.ts/websocket-provider.ts#L47">source</a></div></div></h2><p>The <b>WebSocketProvider</b> connects to a JSON-RPC WebSocket-compatible backend which allows for a persistent connection, multiplexing requests and pub-sub events for a more immediate event dispatching.</p>
|
|
|
|
<p>The WebSocket API is newer, and if running your own infrastructure, note that WebSockets are much more intensive on your server resourses, as they must manage and maintain the state for each client. For this reason, many services may also charge additional fees for using their WebSocket endpoints.</p>
|
|
|
|
<div class="property show-anchors"><div class="signature"><span class="modifier">new </span><span class="path">ethers</span><span class="symbol">.</span><span class="path">provider</span><span class="symbol">.</span><span class="method">WebSockerProvider</span><span class="symbol">(</span> <span class="symbol">[</span> <span class="param">url</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">network</span> <span class="symbol">]</span> <span class="symbol">]</span> <span class="symbol">)</span><div class="anchors"></div></div><div class="body"><p>Returns a new <a href="#/v5/api/providers/other/-%23-WebSocketProvider">WebSocketProvider</a> connected to <i>url</i> as the <i>network</i>.</p>
|
|
|
|
<p>If <i>url</i> is unspecified, the default <code class="inline">"ws://localhost:8546"</code> will be used. If <i>network</i> is unspecified, it will be queried from the network.</p>
|
|
|
|
</div></div><div class="page-separator"></div><a name="/v5/api/providers/types/-%23-types"></a><a name="/v5/api/providers/types/"></a><h1 class="show-anchors"><div>Types<div class="anchors"><a class="self" href="#/v5/api/providers/types/-%23-types"></a></div></div></h1>
|
|
<a name="/v5/api/providers/types/-%23-providers-BlockTag"></a><a name="/v5/api/providers/types/-%23-types--providers-BlockTag"></a><a name="/v5/api/providers/types/"></a><h2 class="show-anchors"><div>BlockTag<div class="anchors"><a class="self" href="#/v5/api/providers/types/-%23-providers-BlockTag"></a></div></div></h2><p>A <b>BlockTag</b> specifies a specific location in the Blockchain.</p>
|
|
|
|
<p><ul><li><b><code class="inline">"latest"</code></b> -- The most recently mined block </li><li><b><code class="inline">"earliest"</code></b> -- Block #0 </li><li><b><code class="inline">"pending"</code></b> -- The block currently being prepared for mining; not all operations and backends support this BlockTag </li><li><b><i>number</i></b> -- The block at this height </li><li><b><i>a negative number</i></b> -- The block this many blocks ago </li></ul></p>
|
|
|
|
<a name="/v5/api/providers/types/-%23-providers-EventType"></a><a name="/v5/api/providers/types/-%23-types--providers-BlockTag--providers-EventType"></a><a name="/v5/api/providers/types/"></a><h3 class="show-anchors"><div>EventType<div class="anchors"><a class="self" href="#/v5/api/providers/types/-%23-providers-EventType"></a></div></div></h3><p>And <b>EventType</b> can be any of the following.</p>
|
|
|
|
<p><ul><li><b><i>string</i></b> -- TODO... </li><li><b><i>Array<string<<a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a><32>> | Array<string<<a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a><32>>>></i></b> -- TODO... </li><li><b><i><a href="#/v5/api/providers/types/-%23-providers-EventFilter">EventFilter</a></i></b> -- TODO... </li></ul></p>
|
|
|
|
<a name="/v5/api/providers/types/-%23-providers-Network"></a><a name="/v5/api/providers/types/-%23-types--providers-Network"></a><a name="/v5/api/providers/types/"></a><h2 class="show-anchors"><div>Network<div class="anchors"><a class="self" href="#/v5/api/providers/types/-%23-providers-Network"></a></div></div></h2><p>A <b>Network</b> represents an Etherem network.</p>
|
|
|
|
<div class="property show-anchors"><div class="signature"><span class="path">network</span><span class="symbol">.</span><span class="method">name</span> <span class="arrow">⇒</span> <span class="returns">string</span><div class="anchors"></div></div><div class="body"><p>The human-readable name of the network, such as <code class="inline">homestead</code>. If the network name is unknown, this will be <code class="inline">"unknown"</code>.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">network</span><span class="symbol">.</span><span class="method">chainId</span> <span class="arrow">⇒</span> <span class="returns">number</span><div class="anchors"></div></div><div class="body"><p>The Chain ID of the network.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">network</span><span class="symbol">.</span><span class="method">ensAddress</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/address/-%23-address">Address</a> ></span><div class="anchors"></div></div><div class="body"><p>The address at which the ENS registry is deployed on this network.</p>
|
|
|
|
</div></div><a name="/v5/api/providers/types/-%23-providers-Block"></a><a name="/v5/api/providers/types/-%23-types--providers-Block"></a><a name="/v5/api/providers/types/"></a><h2 class="show-anchors"><div>Block<div class="anchors"><a class="self" href="#/v5/api/providers/types/-%23-providers-Block"></a></div></div></h2>
|
|
<div class="property show-anchors"><div class="signature"><span class="path">block</span><span class="symbol">.</span><span class="method">hash</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a>< 32 > ></span><div class="anchors"></div></div><div class="body"><p>The hash of this block.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">block</span><span class="symbol">.</span><span class="method">parentHash</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a>< 32 > ></span><div class="anchors"></div></div><div class="body"><p>The hash of the previous block.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">block</span><span class="symbol">.</span><span class="method">number</span> <span class="arrow">⇒</span> <span class="returns">number</span><div class="anchors"></div></div><div class="body"><p>The height (number) of this block.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">block</span><span class="symbol">.</span><span class="method">timestamp</span> <span class="arrow">⇒</span> <span class="returns">number</span><div class="anchors"></div></div><div class="body"><p>The timestamp of this block.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">block</span><span class="symbol">.</span><span class="method">nonce</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a> ></span><div class="anchors"></div></div><div class="body"><p>The nonce used as part of the proof-of-work to mine this block.</p>
|
|
|
|
<p>This property is generally of little interest developers.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">block</span><span class="symbol">.</span><span class="method">difficulty</span> <span class="arrow">⇒</span> <span class="returns">number</span><div class="anchors"></div></div><div class="body"><p>The difficulty target required to be met by the miner of the block.</p>
|
|
|
|
<p>This property is generally of little interest developers.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">block</span><span class="symbol">.</span><span class="method">gasLimit</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/bignumber/">BigNumber</a></span><div class="anchors"></div></div><div class="body"><p>The maximum amount of gas that this block was permitted to use. This is a value that can be voted up or voted down by miners and is used to automatically adjust the bandwidth requirements of the network.</p>
|
|
|
|
<p>This property is generally of little interest developers.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">block</span><span class="symbol">.</span><span class="method">gasUsed</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/bignumber/">BigNumber</a></span><div class="anchors"></div></div><div class="body"><p>The total amount of gas used by all transactions in this block.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">block</span><span class="symbol">.</span><span class="method">miner</span> <span class="arrow">⇒</span> <span class="returns">string</span><div class="anchors"></div></div><div class="body"><p>The coinbase address of this block, which indicates the address the miner that mined this block would like the subsidy reward to go to.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">block</span><span class="symbol">.</span><span class="method">extraData</span> <span class="arrow">⇒</span> <span class="returns">string</span><div class="anchors"></div></div><div class="body"><p>This is extra data a miner may choose to include when mining a block.</p>
|
|
|
|
<p>This property is generally of little interest developers.</p>
|
|
|
|
</div></div><a name="/v5/api/providers/types/-%23-types--providers-Block--block-with-transaction-hashes"></a><a name="/v5/api/providers/types/"></a><h3 class="show-anchors"><div>Block (with transaction hashes)<div class="anchors"><a class="self" href="#/v5/api/providers/types/-%23-types--providers-Block--block-with-transaction-hashes"></a></div></div></h3><p>Often only the hashes of the transactions included in a block are needed, so by default a block only contains this information, as it is substantially less data.</p>
|
|
|
|
<div class="property show-anchors"><div class="signature"><span class="path">block</span><span class="symbol">.</span><span class="method">transactions</span> <span class="arrow">⇒</span> <span class="returns">Array< string< <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a>< 32 > > ></span><div class="anchors"></div></div><div class="body"><p>A list of the transactions hashes for each transaction this block includes.</p>
|
|
|
|
</div></div><a name="/v5/api/providers/types/-%23-providers-BlockWithTransactions"></a><a name="/v5/api/providers/types/-%23-types--providers-Block--providers-BlockWithTransactions"></a><a name="/v5/api/providers/types/"></a><h3 class="show-anchors"><div>BlockWithTransactions<span class="inherits"> inherits <a href="#/v5/api/providers/types/-%23-providers-Block">Block</a></span><div class="anchors"><a class="self" href="#/v5/api/providers/types/-%23-providers-BlockWithTransactions"></a></div></div></h3><p>If all transactions for a block are needed, this object instead includes the full details on each transaction.</p>
|
|
|
|
<div class="property show-anchors"><div class="signature"><span class="path">block</span><span class="symbol">.</span><span class="method">transactions</span> <span class="arrow">⇒</span> <span class="returns">Array< <a href="#/v5/api/providers/types/-%23-providers-TransactionResponse">TransactionResponse</a> ></span><div class="anchors"></div></div><div class="body"><p>A list of the transactions this block includes.</p>
|
|
|
|
</div></div><a name="/v5/api/providers/types/-%23-types--events-and-logs"></a><a name="/v5/api/providers/types/"></a><h2 class="show-anchors"><div>Events and Logs<div class="anchors"><a class="self" href="#/v5/api/providers/types/-%23-types--events-and-logs"></a></div></div></h2>
|
|
<a name="/v5/api/providers/types/-%23-providers-EventFilter"></a><a name="/v5/api/providers/types/-%23-types--events-and-logs--providers-EventFilter"></a><a name="/v5/api/providers/types/"></a><h3 class="show-anchors"><div>EventFilter<div class="anchors"><a class="self" href="#/v5/api/providers/types/-%23-providers-EventFilter"></a></div></div></h3>
|
|
<div class="property show-anchors"><div class="signature"><span class="path">filter</span><span class="symbol">.</span><span class="method">address</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/address/-%23-address">Address</a> ></span><div class="anchors"></div></div><div class="body"><p>The address to filter by, or <code class="inline">null</code> to match any address.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">filter</span><span class="symbol">.</span><span class="method">topics</span> <span class="arrow">⇒</span> <span class="returns">Array< string< <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a>< 32 > > | Array< string< <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a>< 32 > > > ></span><div class="anchors"></div></div><div class="body"><p>The topics to filter by, or <code class="inline">null</code> to match any topics. Each entry represents an <b>AND</b> condition that must match, or may be <code class="inline">null</code> to match anything. If a given entry is an Array, then that entry is treated as an <b>OR</b> for any value in the entry.</p>
|
|
|
|
</div></div><a name="/v5/api/providers/types/-%23-providers-Filter"></a><a name="/v5/api/providers/types/-%23-types--events-and-logs--providers-Filter"></a><a name="/v5/api/providers/types/"></a><h3 class="show-anchors"><div>Filter<span class="inherits"> inherits <a href="#/v5/api/providers/types/-%23-providers-EventFilter">EventFilter</a></span><div class="anchors"><a class="self" href="#/v5/api/providers/types/-%23-providers-Filter"></a></div></div></h3>
|
|
<div class="property show-anchors"><div class="signature"><span class="path">filter</span><span class="symbol">.</span><span class="method">fromBlock</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/providers/types/-%23-providers-BlockTag">BlockTag</a></span><div class="anchors"></div></div><div class="body"><p>The starting block (inclusive) to search for logs matching the filter criteria.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">filter</span><span class="symbol">.</span><span class="method">toBlock</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/providers/types/-%23-providers-BlockTag">BlockTag</a></span><div class="anchors"></div></div><div class="body"><p>The end block (inclusive) to search for logs matching the filter criteria.</p>
|
|
|
|
</div></div><a name="/v5/api/providers/types/-%23-providers-FilterByBlockHash"></a><a name="/v5/api/providers/types/-%23-types--events-and-logs--providers-FilterByBlockHash"></a><a name="/v5/api/providers/types/"></a><h3 class="show-anchors"><div>FilterByBlockHash<span class="inherits"> inherits <a href="#/v5/api/providers/types/-%23-providers-EventFilter">EventFilter</a></span><div class="anchors"><a class="self" href="#/v5/api/providers/types/-%23-providers-FilterByBlockHash"></a></div></div></h3>
|
|
<div class="property show-anchors"><div class="signature"><span class="path">filter</span><span class="symbol">.</span><span class="method">blockHash</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a>< 32 > ></span><div class="anchors"></div></div><div class="body"><p>The specific block (by its block hash) to search for logs matching the filter criteria.</p>
|
|
|
|
</div></div><a name="/v5/api/providers/types/-%23-providers-Log"></a><a name="/v5/api/providers/types/-%23-types--events-and-logs--providers-Log"></a><a name="/v5/api/providers/types/"></a><h3 class="show-anchors"><div>Log<div class="anchors"><a class="self" href="#/v5/api/providers/types/-%23-providers-Log"></a></div></div></h3>
|
|
<div class="property show-anchors"><div class="signature"><span class="path">log</span><span class="symbol">.</span><span class="method">blockNumber</span> <span class="arrow">⇒</span> <span class="returns">number</span><div class="anchors"></div></div><div class="body"><p>The block height (number) of the block including the transaction of this log.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">log</span><span class="symbol">.</span><span class="method">blockHash</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a>< 32 > ></span><div class="anchors"></div></div><div class="body"><p>The block hash of the block including the transaction of this log.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">log</span><span class="symbol">.</span><span class="method">removed</span> <span class="arrow">⇒</span> <span class="returns">boolean</span><div class="anchors"></div></div><div class="body"><p>During a re-org, if a transaction is orphaned, this will be set to true to indicate the Log entry has been removed; it will likely be emitted again in the near future when another block is mined with the transaction that triggered this log, but keep in mind the values may change.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">log</span><span class="symbol">.</span><span class="method">transactionLogIndex</span> <span class="arrow">⇒</span> <span class="returns">number</span><div class="anchors"></div></div><div class="body"><p>The index of this log in the transaction.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">log</span><span class="symbol">.</span><span class="method">address</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/address/-%23-address">Address</a> ></span><div class="anchors"></div></div><div class="body"><p>The address of the contract that generated this log.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">log</span><span class="symbol">.</span><span class="method">data</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a> ></span><div class="anchors"></div></div><div class="body"><p>The data included in this log.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">log</span><span class="symbol">.</span><span class="method">topics</span> <span class="arrow">⇒</span> <span class="returns">Array< string< <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a>< 32 > > ></span><div class="anchors"></div></div><div class="body"><p>The list of topics (indexed properties) for this log.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">log</span><span class="symbol">.</span><span class="method">transactionHash</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a>< 32 > ></span><div class="anchors"></div></div><div class="body"><p>The transaction hash of the transaction of this log.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">log</span><span class="symbol">.</span><span class="method">transactionIndex</span> <span class="arrow">⇒</span> <span class="returns">number</span><div class="anchors"></div></div><div class="body"><p>The index of the transaction in the block of the transaction of this log.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">log</span><span class="symbol">.</span><span class="method">logIndex</span> <span class="arrow">⇒</span> <span class="returns">number</span><div class="anchors"></div></div><div class="body"><p>The index of this log across all logs in the entire <b>block</b>.</p>
|
|
|
|
</div></div><a name="/v5/api/providers/types/-%23-types--transactions"></a><a name="/v5/api/providers/types/"></a><h2 class="show-anchors"><div>Transactions<div class="anchors"><a class="self" href="#/v5/api/providers/types/-%23-types--transactions"></a></div></div></h2>
|
|
<a name="/v5/api/providers/types/-%23-providers-TransactionRequest"></a><a name="/v5/api/providers/types/-%23-types--transactions--providers-TransactionRequest"></a><a name="/v5/api/providers/types/"></a><h3 class="show-anchors"><div>TransactionRequest<div class="anchors"><a class="self" href="#/v5/api/providers/types/-%23-providers-TransactionRequest"></a></div></div></h3><p>A transaction request describes a transaction that is to be sent to the network or otherwise processed.</p>
|
|
|
|
<p>All fields are optional and may be a promise which resolves to the required type.</p>
|
|
|
|
<div class="property show-anchors"><div class="signature"><span class="path">transactionRequest</span><span class="symbol">.</span><span class="method">to</span> <span class="arrow">⇒</span> <span class="returns">string | Promise< string ></span><div class="anchors"></div></div><div class="body"><p>The address (or ENS name) this transaction it to.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">transactionRequest</span><span class="symbol">.</span><span class="method">from</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/address/-%23-address">Address</a> > | Promise< string< <a href="#/v5/api/utils/address/-%23-address">Address</a> > ></span><div class="anchors"></div></div><div class="body"><p>The address this transaction is from.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">transactionRequest</span><span class="symbol">.</span><span class="method">nonce</span> <span class="arrow">⇒</span> <span class="returns">number | Promise< number ></span><div class="anchors"></div></div><div class="body"><p>The nonce for this transaction. This should be set to the number of transactions ever sent <b>from</b> this address.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">transactionRequest</span><span class="symbol">.</span><span class="method">gasLimit</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/bignumber/">BigNumber</a> | Promise< <a href="#/v5/api/utils/bignumber/">BigNumber</a> ></span><div class="anchors"></div></div><div class="body"><p>The maximum amount of gas this transaction is permitted to use.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">transactionRequest</span><span class="symbol">.</span><span class="method">gasPrice</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/bignumber/">BigNumber</a> | Promise< <a href="#/v5/api/utils/bignumber/">BigNumber</a> ></span><div class="anchors"></div></div><div class="body"><p>The price (in wei) per unit of gas this transaction will pay.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">transactionRequest</span><span class="symbol">.</span><span class="method">data</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a> | Promise< <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a> ></span><div class="anchors"></div></div><div class="body"><p>The transaction data.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">transactionRequest</span><span class="symbol">.</span><span class="method">value</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/bignumber/">BigNumber</a> | Promise< <a href="#/v5/api/utils/bignumber/">BigNumber</a> ></span><div class="anchors"></div></div><div class="body"><p>The amount (in wei) this transaction is sending.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">transactionRequest</span><span class="symbol">.</span><span class="method">chainId</span> <span class="arrow">⇒</span> <span class="returns">number | Promise< number ></span><div class="anchors"></div></div><div class="body"><p>The chain ID this transaction is authorized on, as specified by <a href="https://eips.ethereum.org/EIPS/eip-155">EIP-155</a>.</p>
|
|
|
|
<p>If the chain ID is 0 will disable EIP-155 and the transaction will be valid on any network. This can be <b>dangerous</b> and care should be taken, since it allows transactions to be replayed on networks that were possibly not intended.</p>
|
|
|
|
</div></div><a name="/v5/api/providers/types/-%23-providers-TransactionResponse"></a><a name="/v5/api/providers/types/-%23-types--transactions--providers-TransactionResponse"></a><a name="/v5/api/providers/types/"></a><h3 class="show-anchors"><div>TransactionResponse<span class="inherits"> inherits <a href="#/v5/api/utils/transactions/-%23-Transaction">Transaction</a></span><div class="anchors"><a class="self" href="#/v5/api/providers/types/-%23-providers-TransactionResponse"></a></div></div></h3><p>A <b>TransactionResponse</b> includes all properties of a <a href="#/v5/api/utils/transactions/-%23-Transaction">Transaction</a> as well as several properties that are useful once it has been mined.</p>
|
|
|
|
<div class="property show-anchors"><div class="signature"><span class="path">transaction</span><span class="symbol">.</span><span class="method">blockNumber</span> <span class="arrow">⇒</span> <span class="returns">number</span><div class="anchors"></div></div><div class="body"><p>The number ("height") of the block this transaction was mined in. If the block has not been mined, this is <code class="inline">null</code>.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">transaction</span><span class="symbol">.</span><span class="method">blockHash</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a>< 32 > ></span><div class="anchors"></div></div><div class="body"><p>The hash of the block this transaction was mined in. If the block has not been mined, this is <code class="inline">null</code>.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">transaction</span><span class="symbol">.</span><span class="method">timestamp</span> <span class="arrow">⇒</span> <span class="returns">number</span><div class="anchors"></div></div><div class="body"><p>The timestamp of the block this transaction was mined in. If the block has not been mined, this is <code class="inline">null</code>.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">transaction</span><span class="symbol">.</span><span class="method">confirmations</span> <span class="arrow">⇒</span> <span class="returns">number</span><div class="anchors"></div></div><div class="body"><p>The number of blocks that have been mined (including the initial block) since this transaction was mined.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">transaction</span><span class="symbol">.</span><span class="method">raw</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a> ></span><div class="anchors"></div></div><div class="body"><p>The serialized transaction.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">transaction</span><span class="symbol">.</span><span class="method">wait</span><span class="symbol">(</span> <span class="symbol">[</span> <span class="param">confirmations</span> = <span class="param">1</span> <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Promise< <a href="#/v5/api/providers/types/-%23-providers-TransactionReceipt">TransactionReceipt</a> ></span><div class="anchors"></div></div><div class="body"><p>Wait for <i>confirmations</i>. If 0, and the transaction has not been mined, <code class="inline">null</code> is returned.</p>
|
|
|
|
</div></div><a name="/v5/api/providers/types/-%23-providers-TransactionReceipt"></a><a name="/v5/api/providers/types/-%23-types--transactions--providers-TransactionReceipt"></a><a name="/v5/api/providers/types/"></a><h3 class="show-anchors"><div>TransactionReceipt<div class="anchors"><a class="self" href="#/v5/api/providers/types/-%23-providers-TransactionReceipt"></a></div></div></h3>
|
|
<div class="property show-anchors"><div class="signature"><span class="path">receipt</span><span class="symbol">.</span><span class="method">to</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/address/-%23-address">Address</a> ></span><div class="anchors"></div></div><div class="body"><p>The address this transaction is to. This is <code class="inline">null</code> if the the transaction was an <b>init transaction</b>, used to deploy a contract.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">receipt</span><span class="symbol">.</span><span class="method">from</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/address/-%23-address">Address</a> ></span><div class="anchors"></div></div><div class="body"><p>The address this transaction is from.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">receipt</span><span class="symbol">.</span><span class="method">contractAddress</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/address/-%23-address">Address</a> ></span><div class="anchors"></div></div><div class="body"><p>If this transaction has a <code class="inline">null</code> to address, it is an <b>init transaction</b> used to deploy a contract, in which case this is the address created by that contract.</p>
|
|
|
|
<p>To compute a contract address, the <a href="#/v5/api/utils/address/-%23-utils-getContractAddress">getContractAddress</a> utility function can also be used with a <a href="#/v5/api/providers/types/-%23-providers-TransactionResponse">TransactionResponse</a> object, which requires the transaction nonce and the address of the sender.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">receipt</span><span class="symbol">.</span><span class="method">transactionIndex</span> <span class="arrow">⇒</span> <span class="returns">number</span><div class="anchors"></div></div><div class="body"><p>The index of this transaction in the list of transactions included in the block this transaction was mined in.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">receipt</span><span class="symbol">.</span><span class="method">root</span> <span class="arrow">⇒</span> <span class="returns">string</span><div class="anchors"></div></div><div class="body"><p>The intermediate state root of a receipt.</p>
|
|
|
|
<p>Only transactions included in blocks <b>before</b> the <a href="https://eips.ethereum.org/EIPS/eip-609">Byzantium Hard Fork</a> have this property, as it was replaced by the <code class="inline">status</code> property.</p>
|
|
|
|
<p>The property is generally of little use to developers. At the time it could be used to verify a state transition with a fraud-proof only considering the single transaction; without it the full block must be considered.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">receipt</span><span class="symbol">.</span><span class="method">gasUsed</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/bignumber/">BigNumber</a></span><div class="anchors"></div></div><div class="body"><p>The amount of gas actually used by this transaction.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">receipt</span><span class="symbol">.</span><span class="method">logsBloom</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a> ></span><div class="anchors"></div></div><div class="body"><p>A <a href="https://en.wikipedia.org/wiki/Bloom_filter">bloom-filter</a>, which incldues all the addresses and topics included in any log in this transaction.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">receipt</span><span class="symbol">.</span><span class="method">blockHash</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a>< 32 > ></span><div class="anchors"></div></div><div class="body"><p>The block hash of the block that this transaction was included in.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">receipt</span><span class="symbol">.</span><span class="method">transactionHash</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a>< 32 > ></span><div class="anchors"></div></div><div class="body"><p>The transaction hash of this transaction.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">receipt</span><span class="symbol">.</span><span class="method">logs</span> <span class="arrow">⇒</span> <span class="returns">Array< <a href="#/v5/api/providers/types/-%23-providers-Log">Log</a> ></span><div class="anchors"></div></div><div class="body"><p>All the logs emitted by this transaction.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">receipt</span><span class="symbol">.</span><span class="method">blockNumber</span> <span class="arrow">⇒</span> <span class="returns">number</span><div class="anchors"></div></div><div class="body"><p>The block height (number) of the block that this transaction was included in.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">receipt</span><span class="symbol">.</span><span class="method">confirmations</span> <span class="arrow">⇒</span> <span class="returns">number</span><div class="anchors"></div></div><div class="body"><p>The number of blocks that have been mined since this transaction, including the actual block it was mined in.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">receipt</span><span class="symbol">.</span><span class="method">cumulativeGasUsed</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/bignumber/">BigNumber</a></span><div class="anchors"></div></div><div class="body"><p>For the block this transaction was included in, this is the sum of the gas used used by each transaction in the ordered list of transactions up to (and including) this transaction.</p>
|
|
|
|
<p>This is generally of little interest to developers.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">receipt</span><span class="symbol">.</span><span class="method">byzantium</span> <span class="arrow">⇒</span> <span class="returns">boolean</span><div class="anchors"></div></div><div class="body"><p>This is true if the block is in a <a href="https://eips.ethereum.org/EIPS/eip-609">post-Byzantium Hard Fork</a> block.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">receipt</span><span class="symbol">.</span><span class="method">status</span> <span class="arrow">⇒</span> <span class="returns">boolean</span><div class="anchors"></div></div><div class="body"><p>The status of a transaction is 1 is successful or 0 if it was reverted. Only transactions included in blocks <a href="https://eips.ethereum.org/EIPS/eip-609">post-Byzantium Hard Fork</a> have this property.</p>
|
|
|
|
</div></div><div class="page-separator"></div><a name="/v5/api/utils/-%23-utilities"></a><a name="/v5/api/utils/"></a><h1 class="show-anchors"><div>Utilities<div class="anchors"><a class="self" href="#/v5/api/utils/-%23-utilities"></a></div></div></h1><p>These utilities are used extensively within the library, but are also quite useful for application developers.</p>
|
|
|
|
<div class="toc"><div style="padding-left: 0px"><span class="bullet">•</span><a href="#/v5/api/utils/abi/">Application Binary Interface</a></div><div style="padding-left: 0px"><span class="bullet">•</span><a href="#/v5/api/utils/address/">Addresses</a></div><div style="padding-left: 0px"><span class="bullet">•</span><a href="#/v5/api/utils/bignumber/">BigNumber</a></div><div style="padding-left: 0px"><span class="bullet">•</span><a href="#/v5/api/utils/bytes/">Byte Manipulation</a></div><div style="padding-left: 0px"><span class="bullet">•</span><a href="#/v5/api/utils/constants/">Constants</a></div><div style="padding-left: 0px"><span class="bullet">•</span><a href="#/v5/api/utils/display-logic/">Display Logic and Input</a></div><div style="padding-left: 0px"><span class="bullet">•</span><a href="#/v5/api/utils/encoding/">Encoding Utilities</a></div><div style="padding-left: 0px"><span class="bullet">•</span><a href="#/v5/api/utils/fixednumber/">FixedNumber</a></div><div style="padding-left: 0px"><span class="bullet">•</span><a href="#/v5/api/utils/hashing/">Hashing Algorithms</a></div><div style="padding-left: 0px"><span class="bullet">•</span><a href="#/v5/api/utils/hdnode/">HD Wallet</a></div><div style="padding-left: 0px"><span class="bullet">•</span><a href="#/v5/api/utils/logger/">Logging</a></div><div style="padding-left: 0px"><span class="bullet">•</span><a href="#/v5/api/utils/properties/">Property Utilities</a></div><div style="padding-left: 0px"><span class="bullet">•</span><a href="#/v5/api/utils/signing-key/">Signing Key</a></div><div style="padding-left: 0px"><span class="bullet">•</span><a href="#/v5/api/utils/strings/">Strings</a></div><div style="padding-left: 0px"><span class="bullet">•</span><a href="#/v5/api/utils/transactions/">Transactions</a></div><div style="padding-left: 0px"><span class="bullet">•</span><a href="#/v5/api/utils/web/">Web Utilities</a></div><div style="padding-left: 0px"><span class="bullet">•</span><a href="#/v5/api/utils/wordlists/">Wordlists</a></div></div><div class="page-separator"></div><a name="/v5/api/utils/abi/-%23-application-binary-interface"></a><a name="/v5/api/utils/abi/"></a><h1 class="show-anchors"><div>Application Binary Interface<div class="anchors"><a class="self" href="#/v5/api/utils/abi/-%23-application-binary-interface"></a></div></div></h1><p>An <b>Application Binary Interface</b> (ABI) is a collection of <a href="#/v5/api/utils/abi/fragments/-%23-Fragment">Fragments</a> which specify how to interact with various components of a Contract.</p>
|
|
|
|
<p>An <a href="#/v5/api/utils/abi/interface/">Interface</a> helps organize Fragments by type as well as provides the functionality required to encode, decode and work with each component.</p>
|
|
|
|
<p>Most developers will not require this low-level access to encoding and decoding the binary data on the network and will most likely use a <a href="#/v5/api/contract/contract/">Contract</a> which provides a more convenient interface. Some framework, tool developers or developers using advanced techniques may find these classes and utilities useful.</p>
|
|
|
|
<div class="toc"><div style="padding-left: 0px"><span class="bullet">•</span><a href="#/v5/api/utils/abi/coder/">AbiCoder</a></div><div style="padding-left: 0px"><span class="bullet">•</span><a href="#/v5/api/utils/abi/formats/">ABI Formats</a></div><div style="padding-left: 0px"><span class="bullet">•</span><a href="#/v5/api/utils/abi/fragments/">Fragments</a></div><div style="padding-left: 0px"><span class="bullet">•</span><a href="#/v5/api/utils/abi/interface/">Interface</a></div></div><div class="page-separator"></div><a name="/v5/api/utils/abi/coder/-%23-AbiCoder"></a><a name="/v5/api/utils/abi/coder/-%23-AbiCoder"></a><a name="/v5/api/utils/abi/coder/"></a><h1 class="show-anchors"><div>AbiCoder<div class="anchors"><a class="self" href="#/v5/api/utils/abi/coder/-%23-AbiCoder"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/abi/src.ts/abi-coder.ts#L32">source</a></div></div></h1><p>The <b>AbiCoder</b> is a collection of Coders which can be used to encode and decode the binary data formats used to interoperate between the EVM and higher level libraries.</p>
|
|
|
|
<p>Most developers will never need to use this class directly, since the <a href="#/v5/api/utils/abi/interface/">Interface</a> class greatly simplifies these operations.</p>
|
|
|
|
<a name="/v5/api/utils/abi/coder/-%23-AbiCoder--creating"></a><a name="/v5/api/utils/abi/coder/-%23-AbiCoder--AbiCoder--creating"></a><a name="/v5/api/utils/abi/coder/"></a><h2 class="show-anchors"><div>Creating Instance<div class="anchors"><a class="self" href="#/v5/api/utils/abi/coder/-%23-AbiCoder--creating"></a></div></div></h2><p>For the most part, there should never be a need to manually create an instance of an <a href="#/v5/api/utils/abi/coder/">AbiCoder</a>, since one is created with the default coersion function when the library is loaded which can be used universally.</p>
|
|
|
|
<p>This is likely only needed by those with specific needs to override how values are coerced after they are decoded from their binary format.</p>
|
|
|
|
<div class="property show-anchors"><div class="signature"><span class="modifier">new </span><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="method">AbiCoder</span><span class="symbol">(</span> <span class="symbol">[</span> <span class="param">coerceFunc</span> <span class="symbol">]</span> <span class="symbol">)</span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/abi/src.ts/abi-coder.ts#L35">source</a></div></div><div class="body"><p>Create a new AbiCoder instance, which will call the <i>coerceFunc</i> on every decode, where the result of the call will be used in the Result.</p>
|
|
|
|
<p>The function signature is `(type, value)`, where the <i>type</i> is the string describing the type and the <i>value</i> is the processed value from the underlying Coder.</p>
|
|
|
|
<p>If the callback throws, the Result will contain a property that when accessed will throw, allowing for higher level libraries to recover from data errors.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="method">defaultAbiCoder</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/abi/coder/">AbiCoder</a></span><div class="anchors"></div></div><div class="body"><p>An <a href="#/v5/api/utils/abi/coder/">AbiCoder</a> created when the library is imported which is used by the <a href="#/v5/api/utils/abi/interface/">Interface</a>.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/abi/coder/-%23-AbiCoder--methods"></a><a name="/v5/api/utils/abi/coder/-%23-AbiCoder--AbiCoder--methods"></a><a name="/v5/api/utils/abi/coder/"></a><h2 class="show-anchors"><div>Coding Methods<div class="anchors"><a class="self" href="#/v5/api/utils/abi/coder/-%23-AbiCoder--methods"></a></div></div></h2>
|
|
<a name="/v5/api/utils/abi/coder/-%23-AbiCoder-encode"></a><div class="property show-anchors"><div class="signature"><span class="path">abiCoder</span><span class="symbol">.</span><span class="method">encode</span><span class="symbol">(</span> <span class="param">types</span> <span class="symbol">,</span> <span class="param">values</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a> ></span><div class="anchors"><a class="self" href="#/v5/api/utils/abi/coder/-%23-AbiCoder-encode"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/abi/src.ts/abi-coder.ts#L94">source</a></div></div><div class="body"><p>Encode the array <i>values</i> according the array of <i>types</i>, each of which may be a string or a <a href="#/v5/api/utils/abi/fragments/-%23-ParamType">ParamType</a>.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/abi/coder/-%23-AbiCoder-decode"></a><div class="property show-anchors"><div class="signature"><span class="path">abiCoder</span><span class="symbol">.</span><span class="method">decode</span><span class="symbol">(</span> <span class="param">types</span> <span class="symbol">,</span> <span class="param">data</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/abi/interface/-%23-Result">Result</a></span><div class="anchors"><a class="self" href="#/v5/api/utils/abi/coder/-%23-AbiCoder-decode"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/abi/src.ts/abi-coder.ts#L110">source</a></div></div><div class="body"><p>Decode the <i>data</i> according to the array of <i>types</i>, each of which may be a string or <a href="#/v5/api/utils/abi/fragments/-%23-ParamType">ParamType</a>.</p>
|
|
|
|
</div></div><div class="page-separator"></div><a name="/v5/api/utils/abi/formats/-%23-abi-formats"></a><a name="/v5/api/utils/abi/formats/-%23-abi-formats"></a><a name="/v5/api/utils/abi/formats/"></a><h1 class="show-anchors"><div>ABI Formats<div class="anchors"><a class="self" href="#/v5/api/utils/abi/formats/-%23-abi-formats"></a></div></div></h1><p>@TODO: Expand this section</p>
|
|
|
|
<a name="/v5/api/utils/abi/formats/-%23-abi-formats--human-readable-abi"></a><a name="/v5/api/utils/abi/formats/-%23-abi-formats--abi-formats--human-readable-abi"></a><a name="/v5/api/utils/abi/formats/"></a><h2 class="show-anchors"><div>Human-Readable ABI<div class="anchors"><a class="self" href="#/v5/api/utils/abi/formats/-%23-abi-formats--human-readable-abi"></a></div></div></h2><p>See <a href="https://blog.ricmoo.com/human-readable-contract-abis-in-ethers-js-141902f4d917">Human-Readable Abi</a>.</p>
|
|
|
|
<a name="/v5/api/utils/abi/formats/-%23-abi-formats--solidity"></a><a name="/v5/api/utils/abi/formats/-%23-abi-formats--abi-formats--solidity"></a><a name="/v5/api/utils/abi/formats/"></a><h2 class="show-anchors"><div>Solidity JSON ABI<div class="anchors"><a class="self" href="#/v5/api/utils/abi/formats/-%23-abi-formats--solidity"></a></div></div></h2><p>See <a href="https://solidity.readthedocs.io/en/v0.6.0/using-the-compiler.html#output-description">Solidity compiler</a>.</p>
|
|
|
|
<div class="page-separator"></div><a name="/v5/api/utils/abi/fragments/-%23-fragments"></a><a name="/v5/api/utils/abi/fragments/-%23-fragments"></a><a name="/v5/api/utils/abi/fragments/"></a><h1 class="show-anchors"><div>Fragments<div class="anchors"><a class="self" href="#/v5/api/utils/abi/fragments/-%23-fragments"></a></div></div></h1><p>Explain an ABI.</p>
|
|
|
|
<a name="/v5/api/utils/abi/fragments/-%23-fragments--formats"></a><a name="/v5/api/utils/abi/fragments/"></a><h2 class="show-anchors"><div>Formats<div class="anchors"><a class="self" href="#/v5/api/utils/abi/fragments/-%23-fragments--formats"></a></div></div></h2>
|
|
<a name="/v5/api/utils/abi/fragments/-%23-fragments--formats--json-string-abi-solidity-output-json"></a><a name="/v5/api/utils/abi/fragments/"></a><h3 class="show-anchors"><div>JSON String ABI (Solidity Output JSON)<div class="anchors"><a class="self" href="#/v5/api/utils/abi/fragments/-%23-fragments--formats--json-string-abi-solidity-output-json"></a></div></div></h3><p>The <b>JSON ABI Format</b> is the format that is <a href="https://solidity.readthedocs.io/en/v0.6.0/using-the-compiler.html#output-description">output from the Solidity compiler</a>.</p>
|
|
|
|
<p>A JSON serialized object is always a string, which represents an Array of Objects, where each Object has various properties describing the <a href="#/v5/api/utils/abi/fragments/-%23-Fragment">Fragment</a> of the ABI.</p>
|
|
|
|
<p>The deserialized JSON string (which is a normal JavaScript Object) may also be passed into any function which accepts a JSON String ABI.</p>
|
|
|
|
<a name="/v5/api/utils/abi/fragments/-%23-fragments--formats--humanb-readable-abi"></a><a name="/v5/api/utils/abi/fragments/"></a><h3 class="show-anchors"><div>Humanb-Readable ABI<div class="anchors"><a class="self" href="#/v5/api/utils/abi/fragments/-%23-fragments--formats--humanb-readable-abi"></a></div></div></h3><p>The Human-Readable ABI was @TODO</p>
|
|
|
|
<p><a href="https://blog.ricmoo.com/human-readable-contract-abis-in-ethers-js-141902f4d917">article</a></p>
|
|
|
|
<a name="/v5/api/utils/abi/fragments/-%23-fragments--output-formats"></a><a name="/v5/api/utils/abi/fragments/-%23-fragments--formats--fragments--output-formats"></a><a name="/v5/api/utils/abi/fragments/"></a><h3 class="show-anchors"><div>Output Formats<div class="anchors"><a class="self" href="#/v5/api/utils/abi/fragments/-%23-fragments--output-formats"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/abi/src.ts/fragments.ts#L235">source</a></div></div></h3><p>Each <a href="#/v5/api/utils/abi/fragments/-%23-Fragment">Fragment</a> and <a href="#/v5/api/utils/abi/fragments/-%23-ParamType">ParamType</a> may be output using its <code class="inline">format</code> method.</p>
|
|
|
|
<div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="path">FragmentTypes</span><span class="symbol">.</span><span class="method">full</span> <span class="arrow">⇒</span> <span class="returns">string</span><div class="anchors"></div></div><div class="body"><p>This is a full human-readable string, including all parameter names, any optional modifiers (e.g. <code class="inline">indexed</code>, <code class="inline">public</code>, etc) and white-space to aid in human readabiliy.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="path">FragmentTypes</span><span class="symbol">.</span><span class="method">minimal</span> <span class="arrow">⇒</span> <span class="returns">string</span><div class="anchors"></div></div><div class="body"><p>This is similar to <code class="inline">full</code>, except with no unnecessary whitespace or parameter names. This is useful for storing a minimal string which can still fully reconstruct the original Fragment using <a href="#/v5/api/utils/abi/fragments/-%23-Fragment-from">Fragment&thinsp;.&thinsp;from</a>.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="path">FragmentTypes</span><span class="symbol">.</span><span class="method">json</span> <span class="arrow">⇒</span> <span class="returns">string</span><div class="anchors"></div></div><div class="body"><p>This returns a JavaScript Object which is safe to call <code class="inline">JSON.stringify</code> on to create a JSON string.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="path">FragmentTypes</span><span class="symbol">.</span><span class="method">sighash</span> <span class="arrow">⇒</span> <span class="returns">string</span><div class="anchors"></div></div><div class="body"><p>This is a minimal output format, which is used by Solidity when computing a signature hash or an event topic hash.</p>
|
|
|
|
</div></div><div class="definition container-box warning"><div class="term">Note</div><div class="body"><p>The <code class="inline">sighash</code> format is <b>insufficient</b> to re-create the original <a href="#/v5/api/utils/abi/fragments/-%23-Fragment">Fragment</a>, since it discards modifiers such as indexed, anonymous, stateMutability, etc.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/abi/fragments/-%23-Fragment"></a><a name="/v5/api/utils/abi/fragments/-%23-fragments--Fragment"></a><a name="/v5/api/utils/abi/fragments/"></a><h2 class="show-anchors"><div>Fragment<div class="anchors"><a class="self" href="#/v5/api/utils/abi/fragments/-%23-Fragment"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/abi/src.ts/fragments.ts#L405">source</a></div></div></h2><p>An ABI is a collection of <b>Fragments</b>, where each fragment specifies:</p>
|
|
|
|
<p><ul><li>An <a href="#/v5/api/utils/abi/fragments/-%23-EventFragment">Event</a> </li><li>A <a href="#/v5/api/utils/abi/fragments/-%23-FunctionFragment">Function</a> </li><li>A <a href="#/v5/api/utils/abi/fragments/-%23-ConstructorFragment">Constructor</a> </li></ul></p>
|
|
|
|
<a name="/v5/api/utils/abi/fragments/-%23-fragments--Fragment--properties"></a><a name="/v5/api/utils/abi/fragments/"></a><h3 class="show-anchors"><div>Properties<div class="anchors"><a class="self" href="#/v5/api/utils/abi/fragments/-%23-fragments--Fragment--properties"></a></div></div></h3>
|
|
<div class="property show-anchors"><div class="signature"><span class="path">fragment</span><span class="symbol">.</span><span class="method">name</span> <span class="arrow">⇒</span> <span class="returns">string</span><div class="anchors"></div></div><div class="body"><p>This is the name of the Event or Function. This will be null for a <a href="#/v5/api/utils/abi/fragments/-%23-ConstructorFragment">ConstructorFragment</a>.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">fragment</span><span class="symbol">.</span><span class="method">type</span> <span class="arrow">⇒</span> <span class="returns">string</span><div class="anchors"></div></div><div class="body"><p>This is a string which indicates the type of the <a href="#/v5/api/utils/abi/fragments/-%23-Fragment">Fragment</a>. This will be one of:</p>
|
|
|
|
<p><ul><li><code class="inline">constructor</code> </li><li><code class="inline">event</code> </li><li><code class="inline">function</code> </li></ul></p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">fragment</span><span class="symbol">.</span><span class="method">inputs</span> <span class="arrow">⇒</span> <span class="returns">Array< <a href="#/v5/api/utils/abi/fragments/-%23-ParamType">ParamType</a> ></span><div class="anchors"></div></div><div class="body"><p>This is an array of of each <a href="#/v5/api/utils/abi/fragments/-%23-ParamType">ParamType</a> for the input parameters to the Constructor, Event of Function.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/abi/fragments/-%23-fragments--Fragment--methods"></a><a name="/v5/api/utils/abi/fragments/"></a><h3 class="show-anchors"><div>Methods<div class="anchors"><a class="self" href="#/v5/api/utils/abi/fragments/-%23-fragments--Fragment--methods"></a></div></div></h3>
|
|
<a name="/v5/api/utils/abi/fragments/-%23-Fragment-from"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="path">Fragment</span><span class="symbol">.</span><span class="method">from</span><span class="symbol">(</span> <span class="param">objectOrString</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/abi/fragments/-%23-Fragment">Fragment</a></span><div class="anchors"><a class="self" href="#/v5/api/utils/abi/fragments/-%23-Fragment-from"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/abi/src.ts/fragments.ts#L428">source</a></div></div><div class="body"><p>Returns a</p>
|
|
|
|
</div></div><a name="/v5/api/utils/abi/fragments/-%23-Fragment-isFragment"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="path">Fragment</span><span class="symbol">.</span><span class="method">isFragment</span><span class="symbol">(</span> <span class="param">object</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">boolean</span><div class="anchors"><a class="self" href="#/v5/api/utils/abi/fragments/-%23-Fragment-isFragment"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/abi/src.ts/fragments.ts#L474">source</a></div></div><div class="body"><p>Tra lal al</p>
|
|
|
|
</div></div><a name="/v5/api/utils/abi/fragments/-%23-ConstructorFragment"></a><a name="/v5/api/utils/abi/fragments/-%23-fragments--ConstructorFragment"></a><a name="/v5/api/utils/abi/fragments/"></a><h2 class="show-anchors"><div>ConstructorFragment<span class="inherits"> inherits <a href="#/v5/api/utils/abi/fragments/-%23-Fragment">Fragment</a></span><div class="anchors"><a class="self" href="#/v5/api/utils/abi/fragments/-%23-ConstructorFragment"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/abi/src.ts/fragments.ts#L708">source</a></div></div></h2>
|
|
<a name="/v5/api/utils/abi/fragments/-%23-fragments--ConstructorFragment--properties"></a><a name="/v5/api/utils/abi/fragments/"></a><h3 class="show-anchors"><div>Properties<div class="anchors"><a class="self" href="#/v5/api/utils/abi/fragments/-%23-fragments--ConstructorFragment--properties"></a></div></div></h3>
|
|
<div class="property show-anchors"><div class="signature"><span class="path">fragment</span><span class="symbol">.</span><span class="method">gas</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/bignumber/">BigNumber</a></span><div class="anchors"></div></div><div class="body"><p>This is the gas limit that should be used during deployment. It may be null.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">fragment</span><span class="symbol">.</span><span class="method">payable</span> <span class="arrow">⇒</span> <span class="returns">boolean</span><div class="anchors"></div></div><div class="body"><p>This is whether the constructor may receive ether during deployment as an endowment (i.e. msg.value != 0).</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">fragment</span><span class="symbol">.</span><span class="method">stateMutability</span> <span class="arrow">⇒</span> <span class="returns">string</span><div class="anchors"></div></div><div class="body"><p>This is the state mutability of the constructor. It can be any of:</p>
|
|
|
|
<p><ul><li><code class="inline">nonpayable</code> </li><li><code class="inline">payable</code> </li></ul></p>
|
|
|
|
</div></div><a name="/v5/api/utils/abi/fragments/-%23-fragments--ConstructorFragment--methods"></a><a name="/v5/api/utils/abi/fragments/"></a><h3 class="show-anchors"><div>Methods<div class="anchors"><a class="self" href="#/v5/api/utils/abi/fragments/-%23-fragments--ConstructorFragment--methods"></a></div></div></h3>
|
|
<a name="/v5/api/utils/abi/fragments/-%23-ConstructorFragment-from"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="path">ConstructorFragment</span><span class="symbol">.</span><span class="method">from</span><span class="symbol">(</span> <span class="param">objectOrString</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/abi/fragments/-%23-ConstructorFragment">ConstructorFragment</a></span><div class="anchors"><a class="self" href="#/v5/api/utils/abi/fragments/-%23-ConstructorFragment-from"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/abi/src.ts/fragments.ts#L746">source</a></div></div><div class="body"><p>Tra la la...</p>
|
|
|
|
</div></div><a name="/v5/api/utils/abi/fragments/-%23-ConstructorFragment-isConstructorFragment"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="path">ConstructorFragment</span><span class="symbol">.</span><span class="method">isConstructorFragment</span><span class="symbol">(</span> <span class="param">object</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">boolean</span><div class="anchors"><a class="self" href="#/v5/api/utils/abi/fragments/-%23-ConstructorFragment-isConstructorFragment"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/abi/src.ts/fragments.ts#L794">source</a></div></div><div class="body"><p>Tra lal al</p>
|
|
|
|
</div></div><a name="/v5/api/utils/abi/fragments/-%23-EventFragment"></a><a name="/v5/api/utils/abi/fragments/-%23-fragments--EventFragment"></a><a name="/v5/api/utils/abi/fragments/"></a><h2 class="show-anchors"><div>EventFragment<span class="inherits"> inherits <a href="#/v5/api/utils/abi/fragments/-%23-Fragment">Fragment</a></span><div class="anchors"><a class="self" href="#/v5/api/utils/abi/fragments/-%23-EventFragment"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/abi/src.ts/fragments.ts#L483">source</a></div></div></h2>
|
|
<a name="/v5/api/utils/abi/fragments/-%23-fragments--EventFragment--properties"></a><a name="/v5/api/utils/abi/fragments/"></a><h3 class="show-anchors"><div>Properties<div class="anchors"><a class="self" href="#/v5/api/utils/abi/fragments/-%23-fragments--EventFragment--properties"></a></div></div></h3>
|
|
<div class="property show-anchors"><div class="signature"><span class="path">fragment</span><span class="symbol">.</span><span class="method">anonymous</span> <span class="arrow">⇒</span> <span class="returns">boolean</span><div class="anchors"></div></div><div class="body"><p>This is whether the event is anonymous. An anonymous Event does not inject its topic hash as topic0 when creating a log.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/abi/fragments/-%23-fragments--EventFragment--methods"></a><a name="/v5/api/utils/abi/fragments/"></a><h3 class="show-anchors"><div>Methods<div class="anchors"><a class="self" href="#/v5/api/utils/abi/fragments/-%23-fragments--EventFragment--methods"></a></div></div></h3>
|
|
<a name="/v5/api/utils/abi/fragments/-%23-EventFragment-from"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="path">EventFragment</span><span class="symbol">.</span><span class="method">from</span><span class="symbol">(</span> <span class="param">objectOrString</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/abi/fragments/-%23-EventFragment">EventFragment</a></span><div class="anchors"><a class="self" href="#/v5/api/utils/abi/fragments/-%23-EventFragment-from"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/abi/src.ts/fragments.ts#L520">source</a></div></div><div class="body"><p>Tra la la...</p>
|
|
|
|
</div></div><a name="/v5/api/utils/abi/fragments/-%23-EventFragment-isEventFragment"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="path">EventFragment</span><span class="symbol">.</span><span class="method">isEventFragment</span><span class="symbol">(</span> <span class="param">object</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">boolean</span><div class="anchors"><a class="self" href="#/v5/api/utils/abi/fragments/-%23-EventFragment-isEventFragment"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/abi/src.ts/fragments.ts#L572">source</a></div></div><div class="body"><p>Tra lal al</p>
|
|
|
|
</div></div><a name="/v5/api/utils/abi/fragments/-%23-FunctionFragment"></a><a name="/v5/api/utils/abi/fragments/-%23-fragments--FunctionFragment"></a><a name="/v5/api/utils/abi/fragments/"></a><h2 class="show-anchors"><div>FunctionFragment<span class="inherits"> inherits <a href="#/v5/api/utils/abi/fragments/-%23-ConstructorFragment">ConstructorFragment</a></span><div class="anchors"><a class="self" href="#/v5/api/utils/abi/fragments/-%23-FunctionFragment"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/abi/src.ts/fragments.ts#L804">source</a></div></div></h2>
|
|
<a name="/v5/api/utils/abi/fragments/-%23-fragments--FunctionFragment--properties"></a><a name="/v5/api/utils/abi/fragments/"></a><h3 class="show-anchors"><div>Properties<div class="anchors"><a class="self" href="#/v5/api/utils/abi/fragments/-%23-fragments--FunctionFragment--properties"></a></div></div></h3>
|
|
<div class="property show-anchors"><div class="signature"><span class="path">fragment</span><span class="symbol">.</span><span class="method">constant</span> <span class="arrow">⇒</span> <span class="returns">boolean</span><div class="anchors"></div></div><div class="body"><p>This is whether the function is constant (i.e. does not change state). This is true if the state mutability is <code class="inline">pure</code> or <code class="inline">view</code>.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">fragment</span><span class="symbol">.</span><span class="method">stateMutability</span> <span class="arrow">⇒</span> <span class="returns">string</span><div class="anchors"></div></div><div class="body"><p>This is the state mutability of the constructor. It can be any of:</p>
|
|
|
|
<p><ul><li><code class="inline">nonpayable</code> </li><li><code class="inline">payable</code> </li><li><code class="inline">pure</code> </li><li><code class="inline">view</code> </li></ul></p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">fragment</span><span class="symbol">.</span><span class="method">outputs</span> <span class="arrow">⇒</span> <span class="returns">Array< <a href="#/v5/api/utils/abi/fragments/-%23-ParamType">ParamType</a> ></span><div class="anchors"></div></div><div class="body"><p>A list of the Function output parameters.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/abi/fragments/-%23-fragments--FunctionFragment--method"></a><a name="/v5/api/utils/abi/fragments/"></a><h3 class="show-anchors"><div>Method<div class="anchors"><a class="self" href="#/v5/api/utils/abi/fragments/-%23-fragments--FunctionFragment--method"></a></div></div></h3>
|
|
<a name="/v5/api/utils/abi/fragments/-%23-FunctionFragment-from"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="path">FunctionFragment</span><span class="symbol">.</span><span class="method">from</span><span class="symbol">(</span> <span class="param">objectOrString</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/abi/fragments/-%23-FunctionFragment">FunctionFragment</a></span><div class="anchors"><a class="self" href="#/v5/api/utils/abi/fragments/-%23-FunctionFragment-from"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/abi/src.ts/fragments.ts#L746">source</a></div></div><div class="body"><p>Tra la la...</p>
|
|
|
|
</div></div><a name="/v5/api/utils/abi/fragments/-%23-FunctionFragment-isFunctionFragment"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="path">FunctionFragment</span><span class="symbol">.</span><span class="method">isFunctionFragment</span><span class="symbol">(</span> <span class="param">object</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">boolean</span><div class="anchors"><a class="self" href="#/v5/api/utils/abi/fragments/-%23-FunctionFragment-isFunctionFragment"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/abi/src.ts/fragments.ts#L925">source</a></div></div><div class="body"><p>Tra lal al</p>
|
|
|
|
</div></div><a name="/v5/api/utils/abi/fragments/-%23-ParamType"></a><a name="/v5/api/utils/abi/fragments/-%23-fragments--ParamType"></a><a name="/v5/api/utils/abi/fragments/"></a><h2 class="show-anchors"><div>ParamType<div class="anchors"><a class="self" href="#/v5/api/utils/abi/fragments/-%23-ParamType"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/abi/src.ts/fragments.ts#L251">source</a></div></div></h2><p>The following examples will represent the Solidity parameter:</p>
|
|
|
|
<p><code class="inline">string foobar</code></p>
|
|
|
|
<a name="/v5/api/utils/abi/fragments/-%23-fragments--ParamType--properties"></a><a name="/v5/api/utils/abi/fragments/"></a><h3 class="show-anchors"><div>Properties<div class="anchors"><a class="self" href="#/v5/api/utils/abi/fragments/-%23-fragments--ParamType--properties"></a></div></div></h3>
|
|
<a name="/v5/api/utils/abi/fragments/-%23-ParamType-name"></a><div class="property show-anchors"><div class="signature"><span class="path">paramType</span><span class="symbol">.</span><span class="method">name</span> <span class="arrow">⇒</span> <span class="returns">string</span><div class="anchors"><a class="self" href="#/v5/api/utils/abi/fragments/-%23-ParamType-name"></a></div></div><div class="body"><p>The local parameter name. This may be null for unnamed parameters. For example, the parameter definition <code class="inline">string foobar</code> would be <code class="inline">foobar</code>.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/abi/fragments/-%23-ParamType-type"></a><div class="property show-anchors"><div class="signature"><span class="path">paramType</span><span class="symbol">.</span><span class="method">type</span> <span class="arrow">⇒</span> <span class="returns">string</span><div class="anchors"><a class="self" href="#/v5/api/utils/abi/fragments/-%23-ParamType-type"></a></div></div><div class="body"><p>The full type of the parameter, including tuple and array symbols. This may be null for unnamed parameters. For the above example, this would be <code class="inline">foobar</code>.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/abi/fragments/-%23-ParamType-baseType"></a><div class="property show-anchors"><div class="signature"><span class="path">paramType</span><span class="symbol">.</span><span class="method">baseType</span> <span class="arrow">⇒</span> <span class="returns">string</span><div class="anchors"><a class="self" href="#/v5/api/utils/abi/fragments/-%23-ParamType-baseType"></a></div></div><div class="body"><p>The base type of the parameter. For primitive types (e.g. <code class="inline">address</code>, <code class="inline">uint256</code>, etc) this is equal to <a href="#/v5/api/utils/abi/fragments/-%23-ParamType-type">type</a>. For arrays, it will be the string <code class="inline">array</code> and for a tuple, it will be the string <code class="inline">tuple</code>.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/abi/fragments/-%23-ParamType-indexed"></a><div class="property show-anchors"><div class="signature"><span class="path">paramType</span><span class="symbol">.</span><span class="method">indexed</span> <span class="arrow">⇒</span> <span class="returns">boolean</span><div class="anchors"><a class="self" href="#/v5/api/utils/abi/fragments/-%23-ParamType-indexed"></a></div></div><div class="body"><p>Whether the parameter has been marked as indexed. This <b>only</b> applies to parameters which are part of an <a href="#/v5/api/utils/abi/fragments/-%23-EventFragment">EventFragment</a>.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/abi/fragments/-%23-ParamType-arrayChildren"></a><div class="property show-anchors"><div class="signature"><span class="path">paramType</span><span class="symbol">.</span><span class="method">arrayChildren</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/abi/fragments/-%23-ParamType">ParamType</a></span><div class="anchors"><a class="self" href="#/v5/api/utils/abi/fragments/-%23-ParamType-arrayChildren"></a></div></div><div class="body"><p>The type of children of the array. This is null for for any parameter wjhich is not an array.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/abi/fragments/-%23-ParamType-arrayLength"></a><div class="property show-anchors"><div class="signature"><span class="path">paramType</span><span class="symbol">.</span><span class="method">arrayLength</span> <span class="arrow">⇒</span> <span class="returns">number</span><div class="anchors"><a class="self" href="#/v5/api/utils/abi/fragments/-%23-ParamType-arrayLength"></a></div></div><div class="body"><p>The length of the array, or <code class="inline">-1</code> for dynamic-length arrays. This is null for parameters which is not arrays.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/abi/fragments/-%23-ParamType-components"></a><div class="property show-anchors"><div class="signature"><span class="path">paramType</span><span class="symbol">.</span><span class="method">components</span> <span class="arrow">⇒</span> <span class="returns">Array< <a href="#/v5/api/utils/abi/fragments/-%23-ParamType">ParamType</a> ></span><div class="anchors"><a class="self" href="#/v5/api/utils/abi/fragments/-%23-ParamType-components"></a></div></div><div class="body"><p>The components of a tuple. This is null for non-tuple parameters.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/abi/fragments/-%23-fragments--ParamType--methods"></a><a name="/v5/api/utils/abi/fragments/"></a><h3 class="show-anchors"><div>Methods<div class="anchors"><a class="self" href="#/v5/api/utils/abi/fragments/-%23-fragments--ParamType--methods"></a></div></div></h3><p>Tra la la...</p>
|
|
|
|
<div class="property show-anchors"><div class="signature"><span class="path">paramType</span><span class="symbol">.</span><span class="method">format</span><span class="symbol">(</span> <span class="symbol">[</span> <span class="param">outputType</span> = <span class="param">sighash</span> <span class="symbol">]</span> <span class="symbol">)</span><div class="anchors"></div></div><div class="body"><p>Tra la la...</p>
|
|
|
|
</div></div><a name="/v5/api/utils/abi/fragments/-%23-ParamType-from"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="path">ParamType</span><span class="symbol">.</span><span class="method">from</span><span class="symbol">(</span> <span class="param">objectOrString</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/abi/fragments/-%23-ParamType">ParamType</a></span><div class="anchors"><a class="self" href="#/v5/api/utils/abi/fragments/-%23-ParamType-from"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/abi/src.ts/fragments.ts#L357">source</a></div></div><div class="body"><p>Tra la la...</p>
|
|
|
|
</div></div><a name="/v5/api/utils/abi/fragments/-%23-ParamType-isParamType"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="path">ParamType</span><span class="symbol">.</span><span class="method">isParamType</span><span class="symbol">(</span> <span class="param">object</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">boolean</span><div class="anchors"><a class="self" href="#/v5/api/utils/abi/fragments/-%23-ParamType-isParamType"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/abi/src.ts/fragments.ts#L388">source</a></div></div><div class="body"><p>Tra la la...</p>
|
|
|
|
</div></div><div class="page-separator"></div><a name="/v5/api/utils/abi/interface/-%23-Interface"></a><a name="/v5/api/utils/abi/interface/-%23-Interface"></a><a name="/v5/api/utils/abi/interface/"></a><h1 class="show-anchors"><div>Interface<div class="anchors"><a class="self" href="#/v5/api/utils/abi/interface/-%23-Interface"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/abi/src.ts/interface.ts#L65">source</a></div></div></h1><p>The <b>Interface</b> Class abstracts the encoding and decoding required to interact with contracts on the Ethereum network.</p>
|
|
|
|
<p>Many of the standards organically evolved along side the <a href="https://solidity.readthedocs.io/en/v0.6.2/">Solidity</a> language, which other languages have adopted to remain compatibile with existing deployed contracts.</p>
|
|
|
|
<p>The EVM itself does not understand what the ABI is. It is simply an agreed upon set of formats to encode various types of data which each contract can expect so they can interoperate with each other.</p>
|
|
|
|
<a name="/v5/api/utils/abi/interface/-%23-Interface--creating"></a><a name="/v5/api/utils/abi/interface/-%23-Interface--Interface--creating"></a><a name="/v5/api/utils/abi/interface/"></a><h2 class="show-anchors"><div>Creating Instances<div class="anchors"><a class="self" href="#/v5/api/utils/abi/interface/-%23-Interface--creating"></a></div></div></h2>
|
|
<div class="property show-anchors"><div class="signature"><span class="modifier">new </span><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="method">Interface</span><span class="symbol">(</span> <span class="param">abi</span> <span class="symbol">)</span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/abi/src.ts/interface.ts#L79">source</a></div></div><div class="body"><p>Create a new <b>Interface</b> from a JSON string or object representing <i>abi</i>.</p>
|
|
|
|
<p>The <i>abi</i> may be a JSON string or the parsed Object (using JSON.parse) which is emitted by the <a href="https://solidity.readthedocs.io/en/v0.6.0/using-the-compiler.html#output-description">Solidity compiler</a> (or compatible languages).</p>
|
|
|
|
<p>The <i>abi</i> may also be a <a href="https://blog.ricmoo.com/human-readable-contract-abis-in-ethers-js-141902f4d917">Human-Readable Abi</a>, which is a format the Ethers created to simplify manually typing the ABI into the source and so that a Contract ABI can also be referenced easily within the same source file.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/abi/interface/-%23-Interface--properties"></a><a name="/v5/api/utils/abi/interface/-%23-Interface--Interface--properties"></a><a name="/v5/api/utils/abi/interface/"></a><h2 class="show-anchors"><div>Properties<div class="anchors"><a class="self" href="#/v5/api/utils/abi/interface/-%23-Interface--properties"></a></div></div></h2>
|
|
<div class="property show-anchors"><div class="signature"><span class="path">interface</span><span class="symbol">.</span><span class="method">fragments</span> <span class="arrow">⇒</span> <span class="returns">Array< <a href="#/v5/api/utils/abi/fragments/-%23-Fragment">Fragment</a> ></span><div class="anchors"></div></div><div class="body"><p>All the <a href="#/v5/api/utils/abi/fragments/-%23-Fragment">Fragments</a> in the interface.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">interface</span><span class="symbol">.</span><span class="method">events</span> <span class="arrow">⇒</span> <span class="returns">Array< <a href="#/v5/api/utils/abi/fragments/-%23-EventFragment">EventFragment</a> ></span><div class="anchors"></div></div><div class="body"><p>All the <a href="#/v5/api/utils/abi/fragments/-%23-EventFragment">Event Fragments</a> in the interface.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">interface</span><span class="symbol">.</span><span class="method">functions</span> <span class="arrow">⇒</span> <span class="returns">Array< <a href="#/v5/api/utils/abi/fragments/-%23-FunctionFragment">FunctionFragment</a> ></span><div class="anchors"></div></div><div class="body"><p>All the <a href="#/v5/api/utils/abi/fragments/-%23-FunctionFragment">Function Fragments</a> in the interface.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">interface</span><span class="symbol">.</span><span class="method">deploy</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/abi/fragments/-%23-ConstructorFragment">ConstructorFragment</a></span><div class="anchors"></div></div><div class="body"><p>The <a href="#/v5/api/utils/abi/fragments/-%23-ConstructorFragment">Constructor Fragments</a> for the interface.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/abi/interface/-%23-Interface--formatting"></a><a name="/v5/api/utils/abi/interface/-%23-Interface--Interface--formatting"></a><a name="/v5/api/utils/abi/interface/"></a><h2 class="show-anchors"><div>Formatting<div class="anchors"><a class="self" href="#/v5/api/utils/abi/interface/-%23-Interface--formatting"></a></div></div></h2>
|
|
<div class="property show-anchors"><div class="signature"><span class="path">interface</span><span class="symbol">.</span><span class="method">format</span><span class="symbol">(</span> <span class="symbol">[</span> <span class="param">format</span> <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">string | Array< string ></span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/abi/src.ts/interface.ts#L145">source</a></div></div><div class="body"><p>Return the formatted <b>Interface</b>. If the format type is <code class="inline">json</code> a single string is returned, otherwise an Array of the human-readable strings is returned.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/abi/interface/-%23-Interface--fragments"></a><a name="/v5/api/utils/abi/interface/-%23-Interface--Interface--fragments"></a><a name="/v5/api/utils/abi/interface/"></a><h2 class="show-anchors"><div>Fragment Access<div class="anchors"><a class="self" href="#/v5/api/utils/abi/interface/-%23-Interface--fragments"></a></div></div></h2>
|
|
<div class="property show-anchors"><div class="signature"><span class="path">interface</span><span class="symbol">.</span><span class="method">getFunction</span><span class="symbol">(</span> <span class="param">fragment</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/abi/fragments/-%23-FunctionFragment">FunctionFragment</a></span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/abi/src.ts/interface.ts#L179">source</a></div></div><div class="body"><p>Returns the <a href="#/v5/api/utils/abi/fragments/-%23-FunctionFragment">FunctionFragment</a> for <i>fragment</i> (see <a href="#/v5/api/utils/abi/interface/-%23-Interface--specifying-fragments">Specifying Fragments</a>).</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">interface</span><span class="symbol">.</span><span class="method">getEvent</span><span class="symbol">(</span> <span class="param">fragment</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/abi/fragments/-%23-EventFragment">EventFragment</a></span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/abi/src.ts/interface.ts#L211">source</a></div></div><div class="body"><p>Returns the <a href="#/v5/api/utils/abi/fragments/-%23-EventFragment">EventFragment</a> for <i>fragment</i> (see <a href="#/v5/api/utils/abi/interface/-%23-Interface--specifying-fragments">Specifying Fragments</a>).</p>
|
|
|
|
</div></div><a name="/v5/api/utils/abi/interface/-%23-Interface--selectors"></a><a name="/v5/api/utils/abi/interface/-%23-Interface--Interface--selectors"></a><a name="/v5/api/utils/abi/interface/"></a><h2 class="show-anchors"><div>Signature and Topic Hashes<div class="anchors"><a class="self" href="#/v5/api/utils/abi/interface/-%23-Interface--selectors"></a></div></div></h2>
|
|
<div class="property show-anchors"><div class="signature"><span class="path">interface</span><span class="symbol">.</span><span class="method">getSighash</span><span class="symbol">(</span> <span class="param">fragment</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a>< 4 > ></span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/abi/src.ts/interface.ts#L244">source</a></div></div><div class="body"><p>Return the sighash (or Function Selector) for <i>fragment</i> (see <a href="#/v5/api/utils/abi/interface/-%23-Interface--specifying-fragments">Specifying Fragments</a>).</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">interface</span><span class="symbol">.</span><span class="method">getEventTopic</span><span class="symbol">(</span> <span class="param">fragment</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a>< 32 > ></span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/abi/src.ts/interface.ts#L253">source</a></div></div><div class="body"><p>Return the topic hash for <i>fragment</i> (see <a href="#/v5/api/utils/abi/interface/-%23-Interface--specifying-fragments">Specifying Fragments</a>).</p>
|
|
|
|
</div></div><a name="/v5/api/utils/abi/interface/-%23-Interface--encoding"></a><a name="/v5/api/utils/abi/interface/-%23-Interface--Interface--encoding"></a><a name="/v5/api/utils/abi/interface/"></a><h2 class="show-anchors"><div>Encoding Data<div class="anchors"><a class="self" href="#/v5/api/utils/abi/interface/-%23-Interface--encoding"></a></div></div></h2>
|
|
<div class="property show-anchors"><div class="signature"><span class="path">interface</span><span class="symbol">.</span><span class="method">encodeDeploy</span><span class="symbol">(</span> <span class="symbol">[</span> <span class="param">values</span> <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a> ></span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/abi/src.ts/interface.ts#L270">source</a></div></div><div class="body"><p>Return the encoded deployment data, which can be concatenated to the deployment bytecode of a contract to pass <i>values</i> into the contract constructor.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">interface</span><span class="symbol">.</span><span class="method">encodeFilterTopics</span><span class="symbol">(</span> <span class="param">fragment</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">values</span> <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Array< topic | Array< topic > ></span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/abi/src.ts/interface.ts#L344">source</a></div></div><div class="body"><p>Returns the encoded topic filter, which can be passed to getLogs for <i>fragment</i> (see <a href="#/v5/api/utils/abi/interface/-%23-Interface--specifying-fragments">Specifying Fragments</a>) for the given <i>values</i>.</p>
|
|
|
|
<p>Each <i>topic</i> is a 32 byte (64 nibble) <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a>.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">interface</span><span class="symbol">.</span><span class="method">encodeFunctionData</span><span class="symbol">(</span> <span class="param">fragment</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">values</span> <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a> ></span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/abi/src.ts/interface.ts#L290">source</a></div></div><div class="body"><p>Returns the encoded data, which can be used as the data for a transaction for <i>fragment</i> (see <a href="#/v5/api/utils/abi/interface/-%23-Interface--specifying-fragments">Specifying Fragments</a>) for the given <i>values</i>.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">interface</span><span class="symbol">.</span><span class="method">encodeFunctionResult</span><span class="symbol">(</span> <span class="param">fragment</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">values</span> <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a> ></span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/abi/src.ts/interface.ts#L335">source</a></div></div><div class="body"><p>Returns the encoded result, which would normally be the response from a call for <i>fragment</i> (see <a href="#/v5/api/utils/abi/interface/-%23-Interface--specifying-fragments">Specifying Fragments</a>) for the given <i>values</i>.</p>
|
|
|
|
<p>Most developers will not need this method, but may be useful for authors of a mock blockchain.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/abi/interface/-%23-Interface--decoding"></a><a name="/v5/api/utils/abi/interface/-%23-Interface--Interface--decoding"></a><a name="/v5/api/utils/abi/interface/"></a><h2 class="show-anchors"><div>Decoding Data<div class="anchors"><a class="self" href="#/v5/api/utils/abi/interface/-%23-Interface--decoding"></a></div></div></h2>
|
|
<div class="property show-anchors"><div class="signature"><span class="path">interface</span><span class="symbol">.</span><span class="method">decodeEventLog</span><span class="symbol">(</span> <span class="param">fragment</span> <span class="symbol">,</span> <span class="param">data</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">topics</span> <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/abi/interface/-%23-Result">Result</a></span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/abi/src.ts/interface.ts#L445">source</a></div></div><div class="body"><p>Returns the decoded event values from an event log for <i>fragment</i> (see <a href="#/v5/api/utils/abi/interface/-%23-Interface--specifying-fragments">Specifying Fragments</a>) for the given <i>data</i> with the optional <i>topics</i>.</p>
|
|
|
|
<p>If <i>topics</i> is not specified, placeholders will be inserted into the result.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">interface</span><span class="symbol">.</span><span class="method">decodeFunctionData</span><span class="symbol">(</span> <span class="param">fragment</span> <span class="symbol">,</span> <span class="param">data</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/abi/interface/-%23-Result">Result</a></span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/abi/src.ts/interface.ts#L275">source</a></div></div><div class="body"><p>Returns the decoded values from transaction data for <i>fragment</i> (see <a href="#/v5/api/utils/abi/interface/-%23-Interface--specifying-fragments">Specifying Fragments</a>) for the given <i>data</i>.</p>
|
|
|
|
<p>Most developers will not need this method, but may be useful for debugging or inspecting transactions.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">interface</span><span class="symbol">.</span><span class="method">decodeFunctionResult</span><span class="symbol">(</span> <span class="param">fragment</span> <span class="symbol">,</span> <span class="param">data</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/abi/interface/-%23-Result">Result</a></span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/abi/src.ts/interface.ts#L302">source</a></div></div><div class="body"><p>Returns the decoded values from the result of a call for <i>fragment</i> (see <a href="#/v5/api/utils/abi/interface/-%23-Interface--specifying-fragments">Specifying Fragments</a>) for the given <i>data</i>.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/abi/interface/-%23-Interface--parsing"></a><a name="/v5/api/utils/abi/interface/-%23-Interface--Interface--parsing"></a><a name="/v5/api/utils/abi/interface/"></a><h2 class="show-anchors"><div>Parsing<div class="anchors"><a class="self" href="#/v5/api/utils/abi/interface/-%23-Interface--parsing"></a></div></div></h2><p>The functions are generally the most useful for most developers. They will automatically search the ABI for a matching Event or Function and decode the components as a fully specified description.</p>
|
|
|
|
<div class="property show-anchors"><div class="signature"><span class="path">interface</span><span class="symbol">.</span><span class="method">parseLog</span><span class="symbol">(</span> <span class="param">log</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/abi/interface/-%23-LogDescription">LogDescription</a></span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/abi/src.ts/interface.ts#L552">source</a></div></div><div class="body"><p>Search the event that matches the <i>log</i> topic hash and parse the values the log represents.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">interface</span><span class="symbol">.</span><span class="method">parseTransaction</span><span class="symbol">(</span> <span class="param">transaction</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/abi/interface/-%23-TransactionDescription">TransactionDescription</a></span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/abi/src.ts/interface.ts#L535">source</a></div></div><div class="body"><p>Search for the function that matches the <i>transaction</i> data sighash and parse the transaction properties.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/abi/interface/-%23-Interface--types"></a><a name="/v5/api/utils/abi/interface/-%23-Interface--Interface--types"></a><a name="/v5/api/utils/abi/interface/"></a><h2 class="show-anchors"><div>Types<div class="anchors"><a class="self" href="#/v5/api/utils/abi/interface/-%23-Interface--types"></a></div></div></h2>
|
|
<a name="/v5/api/utils/abi/interface/-%23-Result"></a><a name="/v5/api/utils/abi/interface/-%23-Interface--Interface--types--Result"></a><a name="/v5/api/utils/abi/interface/"></a><h3 class="show-anchors"><div>Result<span class="inherits"> inherits Array<any></span><div class="anchors"><a class="self" href="#/v5/api/utils/abi/interface/-%23-Result"></a></div></div></h3><p>A <b>Result</b> is an array, so each value can be accessed as a positional argument.</p>
|
|
|
|
<p>Additionally, if values are named, the identical object as its positional value can be accessed by its name.</p>
|
|
|
|
<p>The name <code class="inline">length</code> is however reserved as it is part of the Array, so any named value for this key is renamed to <code class="inline">_length</code>. If there is a name collision, only the first is available by its key.</p>
|
|
|
|
<a name="/v5/api/utils/abi/interface/-%23-LogDescription"></a><a name="/v5/api/utils/abi/interface/-%23-Interface--Interface--types--LogDescription"></a><a name="/v5/api/utils/abi/interface/"></a><h3 class="show-anchors"><div>LogDescription<div class="anchors"><a class="self" href="#/v5/api/utils/abi/interface/-%23-LogDescription"></a></div></div></h3>
|
|
<div class="property show-anchors"><div class="signature"><span class="path">logDescription</span><span class="symbol">.</span><span class="method">args</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/abi/interface/-%23-Result">Result</a></span><div class="anchors"></div></div><div class="body"><p>The values of the input parameters of the event.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">logDescription</span><span class="symbol">.</span><span class="method">eventFragment</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/abi/fragments/-%23-EventFragment">EventFragment</a></span><div class="anchors"></div></div><div class="body"><p>The <a href="#/v5/api/utils/abi/fragments/-%23-EventFragment">EventFragment</a> which matches the topic in the Log.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">logDescription</span><span class="symbol">.</span><span class="method">name</span> <span class="arrow">⇒</span> <span class="returns">string</span><div class="anchors"></div></div><div class="body"><p>The event name. (e.g. <code class="inline">Transfer</code>)</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">logDescription</span><span class="symbol">.</span><span class="method">signature</span> <span class="arrow">⇒</span> <span class="returns">string</span><div class="anchors"></div></div><div class="body"><p>The event signature. (e.g. <code class="inline">Transfer(address,address,uint256)</code>)</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">logDescription</span><span class="symbol">.</span><span class="method">topic</span> <span class="arrow">⇒</span> <span class="returns">string</span><div class="anchors"></div></div><div class="body"><p>The topic hash.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/abi/interface/-%23-TransactionDescription"></a><a name="/v5/api/utils/abi/interface/-%23-Interface--Interface--types--TransactionDescription"></a><a name="/v5/api/utils/abi/interface/"></a><h3 class="show-anchors"><div>TransactionDescription<div class="anchors"><a class="self" href="#/v5/api/utils/abi/interface/-%23-TransactionDescription"></a></div></div></h3>
|
|
<div class="property show-anchors"><div class="signature"><span class="path">transactionDescription</span><span class="symbol">.</span><span class="method">args</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/abi/interface/-%23-Result">Result</a></span><div class="anchors"></div></div><div class="body"><p>The decoded values from the transaction data which were passed as the input parameters.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">transactionDescription</span><span class="symbol">.</span><span class="method">functionFragment</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/abi/fragments/-%23-FunctionFragment">FunctionFragment</a></span><div class="anchors"></div></div><div class="body"><p>The <a href="#/v5/api/utils/abi/fragments/-%23-FunctionFragment">FunctionFragment</a> which matches the sighash in the transaction data.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">transactionDescription</span><span class="symbol">.</span><span class="method">name</span> <span class="arrow">⇒</span> <span class="returns">string</span><div class="anchors"></div></div><div class="body"><p>The name of the function. (e.g. <code class="inline">transfer</code>)</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">transactionDescription</span><span class="symbol">.</span><span class="method">sighash</span> <span class="arrow">⇒</span> <span class="returns">string</span><div class="anchors"></div></div><div class="body"><p>The sighash (or function selector) that matched the transaction data.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">transactionDescription</span><span class="symbol">.</span><span class="method">signature</span> <span class="arrow">⇒</span> <span class="returns">string</span><div class="anchors"></div></div><div class="body"><p>The signature of the function. (e.g. <code class="inline">transfer(address,uint256)</code>)</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">transactionDescription</span><span class="symbol">.</span><span class="method">value</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/bignumber/">BigNumber</a></span><div class="anchors"></div></div><div class="body"><p>The value from the transaction.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/abi/interface/-%23-Interface--specifying-fragments"></a><a name="/v5/api/utils/abi/interface/-%23-Interface--Interface--specifying-fragments"></a><a name="/v5/api/utils/abi/interface/"></a><h2 class="show-anchors"><div>Specifying Fragments<div class="anchors"><a class="self" href="#/v5/api/utils/abi/interface/-%23-Interface--specifying-fragments"></a></div></div></h2><p>When specifying a fragment to any of the functions in an <b>Interface</b>, any of the following may be used:</p>
|
|
|
|
<p><ul><li>The <b>name</b> of the event or function, if it is unique and non-ambiguous within the ABI (e.g. <code class="inline">transfer</code>) </li><li>The <b>signature</b> of the event or function. The signature is normalized, so, for example, <code class="inline">uint</code> and <code class="inline">uint256</code> are equivalent (e.g. <code class="inline">transfer(address, uint)</code>) </li><li>The <b>sighash</b> or <b>topichash</b> of the function. The sighash is often referred to the function selector in Solidity (e.g. <code class="inline">0xa9059cbb</code>) </li><li>A <a href="#/v5/api/utils/abi/fragments/-%23-Fragment">Fragment</a> </li></ul></p>
|
|
|
|
<div class="page-separator"></div><a name="/v5/api/utils/address/-%23-addresses"></a><a name="/v5/api/utils/address/-%23-addresses"></a><a name="/v5/api/utils/address/"></a><h1 class="show-anchors"><div>Addresses<div class="anchors"><a class="self" href="#/v5/api/utils/address/-%23-addresses"></a></div></div></h1><p>Explain addresses,formats and checksumming here.</p>
|
|
|
|
<p>Also see: <a href="#/v5/api/utils/constants/">constants.AddressZero</a></p>
|
|
|
|
<a name="/v5/api/utils/address/-%23-address-formats"></a><a name="/v5/api/utils/address/-%23-addresses--address-formats"></a><a name="/v5/api/utils/address/"></a><h2 class="show-anchors"><div>Address Formats<div class="anchors"><a class="self" href="#/v5/api/utils/address/-%23-address-formats"></a></div></div></h2>
|
|
<a name="/v5/api/utils/address/-%23-address"></a><a name="/v5/api/utils/address/-%23-addresses--address-formats--address"></a><a name="/v5/api/utils/address/"></a><h3 class="show-anchors"><div>Address<div class="anchors"><a class="self" href="#/v5/api/utils/address/-%23-address"></a></div></div></h3><p>An <b>Address</b> is a <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a> of 20 bytes (40 nibbles), with optional mixed case.</p>
|
|
|
|
<p>If the case is mixed, it is a <b>Checksum Address</b>, which uses a specific pattern of uppercase and lowercase letters within a given address to reduce the risk of errors introduced from typing an address or cut and paste issues.</p>
|
|
|
|
<p>All functions that return an Address will return a Checksum Address.</p>
|
|
|
|
<a name="/v5/api/utils/address/-%23-address-icap"></a><a name="/v5/api/utils/address/-%23-addresses--address-formats--address-icap"></a><a name="/v5/api/utils/address/"></a><h3 class="show-anchors"><div>ICAP Address<div class="anchors"><a class="self" href="#/v5/api/utils/address/-%23-address-icap"></a></div></div></h3><p>The <b>ICAP Address Format</b> was an early attempt to introduce a checksum into Ethereum addresses using the popular banking industry's <a href="https://en.wikipedia.org/wiki/International_Bank_Account_Number">IBAN</a> format with the country code specified as <b>XE</b>.</p>
|
|
|
|
<p>Due to the way IBAN encodes address, only addresses that fit into 30 base-36 characters are actually compatible, so the format was adapted to support 31 base-36 characters which is large enough for a full Ethereum address, however the preferred method was to select a private key whose address has a <code class="inline">0</code> as the first byte, which allows the address to be formatted as a fully compatibly standard IBAN address with 30 base-36 characters.</p>
|
|
|
|
<p>In general this format is no longer widely supported anymore, however any function that accepts an address can receive an ICAP address, and it will be converted internally.</p>
|
|
|
|
<p>To convert an address into the ICAP format, see <a href="#/v5/api/utils/address/-%23-utils-getIcapAddress">getIcapAddress</a>.</p>
|
|
|
|
<a name="/v5/api/utils/address/-%23-utils--address"></a><a name="/v5/api/utils/address/-%23-addresses--utils--address"></a><a name="/v5/api/utils/address/"></a><h2 class="show-anchors"><div>Converting and Verifying<div class="anchors"><a class="self" href="#/v5/api/utils/address/-%23-utils--address"></a></div></div></h2>
|
|
<a name="/v5/api/utils/address/-%23-utils-getAddress"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="method">getAddress</span><span class="symbol">(</span> <span class="param">address</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/address/-%23-address">Address</a> ></span><div class="anchors"><a class="self" href="#/v5/api/utils/address/-%23-utils-getAddress"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/address/src.ts/index.ts#L80">source</a></div></div><div class="body"><p>Returns <i>address</i> as a Checksum Address.</p>
|
|
|
|
<p>If <i>address</i> is an invalid 40-nibble <a href="#/v5/api/utils/bytes/-%23-HexString">HexString</a> or if it contains mixed case and the checksum is invalid, an InvalidArgument Error is thrown.</p>
|
|
|
|
<p>The value of <i>address</i> may be any supported address format.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/address/-%23-utils-getIcapAddress"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="method">getIcapAddress</span><span class="symbol">(</span> <span class="param">address</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/address/-%23-address-icap">IcapAddress</a> ></span><div class="anchors"><a class="self" href="#/v5/api/utils/address/-%23-utils-getIcapAddress"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/address/src.ts/index.ts#L126">source</a></div></div><div class="body"><p>Returns <i>address</i> as an <a href="https://github.com/ethereum/wiki/wiki/Inter-exchange-Client-Address-Protocol-%28ICAP%29">ICAP address</a>. Supports the same restrictions as <a href="#/v5/api/utils/address/-%23-utils-getAddress">utils.getAddress</a>.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/address/-%23-utils-isAddress"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="method">isAddress</span><span class="symbol">(</span> <span class="param">address</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">boolean</span><div class="anchors"><a class="self" href="#/v5/api/utils/address/-%23-utils-isAddress"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/address/src.ts/index.ts#L118">source</a></div></div><div class="body"><p>Returns true if <i>address</i> is valid (in any supported format).</p>
|
|
|
|
</div></div><a name="/v5/api/utils/address/-%23-utils--address-derivation"></a><a name="/v5/api/utils/address/-%23-addresses--utils--address-derivation"></a><a name="/v5/api/utils/address/"></a><h2 class="show-anchors"><div>Derivation<div class="anchors"><a class="self" href="#/v5/api/utils/address/-%23-utils--address-derivation"></a></div></div></h2>
|
|
<a name="/v5/api/utils/address/-%23-utils-computeAddress"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="method">computeAddress</span><span class="symbol">(</span> <span class="param">publicOrPrivateKey</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/address/-%23-address">Address</a> ></span><div class="anchors"><a class="self" href="#/v5/api/utils/address/-%23-utils-computeAddress"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/transactions/src.ts/index.ts#L75">source</a></div></div><div class="body"><p>Returns the address for <i>publicOrPrivateKey</i>. A public key may be compressed or uncompressed, and a private key will be converted automatically to a public key for the derivation.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/address/-%23-utils-recoverAddress"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="method">recoverAddress</span><span class="symbol">(</span> <span class="param">digest</span> <span class="symbol">,</span> <span class="param">signature</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/address/-%23-address">Address</a> ></span><div class="anchors"><a class="self" href="#/v5/api/utils/address/-%23-utils-recoverAddress"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/transactions/src.ts/index.ts#L80">source</a></div></div><div class="body"><p>Use <a href="https://en.wikipedia.org/wiki/Elliptic_Curve_Digital_Signature_Algorithm#Public_key_recovery">ECDSA Public Key Recovery</a> to determine the address that signed <i>digest</i> to which generated <i>signature</i>.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/address/-%23-utils--contract-addresses"></a><a name="/v5/api/utils/address/-%23-addresses--utils--contract-addresses"></a><a name="/v5/api/utils/address/"></a><h2 class="show-anchors"><div>Contracts Addresses<div class="anchors"><a class="self" href="#/v5/api/utils/address/-%23-utils--contract-addresses"></a></div></div></h2>
|
|
<a name="/v5/api/utils/address/-%23-utils-getContractAddress"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="method">getContractAddress</span><span class="symbol">(</span> <span class="param">transaction</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/address/-%23-address">Address</a> ></span><div class="anchors"><a class="self" href="#/v5/api/utils/address/-%23-utils-getContractAddress"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/address/src.ts/index.ts#L133">source</a></div></div><div class="body"><p>Returns the contract address that would result if <i>transaction</i> was used to deploy a contract.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/address/-%23-utils-getCreate2Address"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="method">getCreate2Address</span><span class="symbol">(</span> <span class="param">from</span> <span class="symbol">,</span> <span class="param">salt</span> <span class="symbol">,</span> <span class="param">initCodeHash</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/address/-%23-address">Address</a> ></span><div class="anchors"><a class="self" href="#/v5/api/utils/address/-%23-utils-getCreate2Address"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/address/src.ts/index.ts#L146">source</a></div></div><div class="body"><p>Returns the contract address that would result from the given <a href="https://eips.ethereum.org/EIPS/eip-1014">CREATE2</a> call.</p>
|
|
|
|
</div></div><div class="page-separator"></div><a name="/v5/api/utils/bignumber/-%23-BigNumber"></a><a name="/v5/api/utils/bignumber/-%23-BigNumber"></a><a name="/v5/api/utils/bignumber/"></a><h1 class="show-anchors"><div>BigNumber<div class="anchors"><a class="self" href="#/v5/api/utils/bignumber/-%23-BigNumber"></a></div></div></h1><p>Many operations in Ethereum operation on numbers which are <a href="#/v5/api/utils/bignumber/-%23-BigNumber--notes-safenumbers">outside the range of safe values</a> to use in JavaScript.</p>
|
|
|
|
<p>A <b>BigNumber</b> is an object which safely allows mathematic operations on numbers of any magnitude.</p>
|
|
|
|
<p>Most operations which need to return a value will return a <b>BigNumber</b> and parameters which accept values will generally accept them.</p>
|
|
|
|
<a name="/v5/api/utils/bignumber/-%23-BigNumber--types"></a><a name="/v5/api/utils/bignumber/-%23-BigNumber--BigNumber--types"></a><a name="/v5/api/utils/bignumber/"></a><h2 class="show-anchors"><div>Types<div class="anchors"><a class="self" href="#/v5/api/utils/bignumber/-%23-BigNumber--types"></a></div></div></h2>
|
|
<a name="/v5/api/utils/bignumber/-%23-BigNumberish"></a><a name="/v5/api/utils/bignumber/-%23-BigNumber--BigNumber--types--BigNumberish"></a><a name="/v5/api/utils/bignumber/"></a><h3 class="show-anchors"><div>BigNumberish<div class="anchors"><a class="self" href="#/v5/api/utils/bignumber/-%23-BigNumberish"></a></div></div></h3><p>Many functions and methods in this library take in values which can be non-ambiguously and safely converted to a BigNumber. These values can be sepcified as:</p>
|
|
|
|
<div class="definition"><div class="term"><b><i>string</i></b></div><div class="body"><p>A <a href="#/v5/api/utils/bytes/-%23-HexString">HexString</a> or a decimal string, either of which may be negative.</p>
|
|
|
|
</div></div><div class="definition"><div class="term"><b><i>BytesLike</i></b></div><div class="body"><p>A <a href="#/v5/api/utils/bytes/-%23-BytesLike">BytesLike</a> Object, such as an Array or Uint8Array.</p>
|
|
|
|
</div></div><div class="definition"><div class="term"><b><i>BigNumber</i></b></div><div class="body"><p>An existing <a href="#/v5/api/utils/bignumber/">BigNumber</a> instance.</p>
|
|
|
|
</div></div><div class="definition"><div class="term"><b><i>number</i></b></div><div class="body"><p>A number that is within the <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/MAX_SAFE_INTEGER#Description">safe range</a> for JavaScript numbers.</p>
|
|
|
|
</div></div><div class="definition"><div class="term"><b><i>BigInt</i></b></div><div class="body"><p>A JavaScript <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt">BigInt</a> object, on environments that support BigInt.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/bignumber/-%23-BigNumber--creating"></a><a name="/v5/api/utils/bignumber/-%23-BigNumber--BigNumber--creating"></a><a name="/v5/api/utils/bignumber/"></a><h2 class="show-anchors"><div>Creating Instances<div class="anchors"><a class="self" href="#/v5/api/utils/bignumber/-%23-BigNumber--creating"></a></div></div></h2><p>The constructor of BigNumber cannot be called directly. Instead, Use the static <code class="inline">BigNumber.from</code>.</p>
|
|
|
|
<div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">BigNumber</span><span class="symbol">.</span><span class="method">from</span><span class="symbol">(</span> <span class="param">aBigNumberish</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/bignumber/">BigNumber</a></span><div class="anchors"></div></div><div class="body"><p>Returns an instance of a <b>BigNumber</b> for <i>aBigNumberish</i>.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/bignumber/-%23-BigNumber--BigNumber--creating--examples"></a><a name="/v5/api/utils/bignumber/"></a><h3 class="show-anchors"><div>Examples:<div class="anchors"></div></div></h3>
|
|
<div class="code"><span class="comment">// From a decimal string...
|
|
</span>BigNumber.from("42")
|
|
<span class="result ok">// { BigNumber: "42" }
|
|
</span>
|
|
<span class="comment">// From a HexString...
|
|
</span>BigNumber.from("0x2a")
|
|
<span class="result ok">// { BigNumber: "42" }
|
|
</span>
|
|
<span class="comment">// From a negative HexString...
|
|
</span>BigNumber.from("-0x2a")
|
|
<span class="result ok">// { BigNumber: "-42" }
|
|
</span>
|
|
<span class="comment">// From an Array (or Uint8Array)...
|
|
</span>BigNumber.from([ 42 ])
|
|
<span class="result ok">// { BigNumber: "42" }
|
|
</span>
|
|
<span class="comment">// From an existing BigNumber...
|
|
</span>let one1 = constants.One;
|
|
let one2 = BigNumber.from(one1)
|
|
|
|
one2
|
|
<span class="result ok">// { BigNumber: "1" }
|
|
</span>
|
|
<span class="comment">// ...which returns the same instance
|
|
</span>one1 === one2
|
|
<span class="result ok">// true
|
|
</span>
|
|
<span class="comment">// From a (safe) number...
|
|
</span>BigNumber.from(42)
|
|
<span class="result ok">// { BigNumber: "42" }
|
|
</span>
|
|
<span class="comment">// From a ES2015 BigInt... (only on platforms with BigInt support)
|
|
</span>BigNumber.from(42n)
|
|
<span class="result ok">// { BigNumber: "42" }
|
|
</span>
|
|
<span class="comment">// Numbers outside the safe range fail:
|
|
</span>BigNumber.from(Number.MAX_SAFE_INTEGER);
|
|
<span class="result error">// Error: overflow (fault="overflow", operation="BigNumber.from", value=9007199254740991, code=NUMERIC_FAULT, version=bignumber/5.0.2)
|
|
</span></div><a name="/v5/api/utils/bignumber/-%23-BigNumber--methods"></a><a name="/v5/api/utils/bignumber/-%23-BigNumber--BigNumber--methods"></a><a name="/v5/api/utils/bignumber/"></a><h2 class="show-anchors"><div>Methods<div class="anchors"><a class="self" href="#/v5/api/utils/bignumber/-%23-BigNumber--methods"></a></div></div></h2><p>The BigNumber class is immutable, so no operations can change the value it represents.</p>
|
|
|
|
<a name="/v5/api/utils/bignumber/-%23-BigNumber--BigNumber--methods--math-operations"></a><a name="/v5/api/utils/bignumber/"></a><h3 class="show-anchors"><div>Math Operations<div class="anchors"><a class="self" href="#/v5/api/utils/bignumber/-%23-BigNumber--BigNumber--methods--math-operations"></a></div></div></h3>
|
|
<div class="property show-anchors"><div class="signature"><span class="path">BigNumber</span><span class="symbol">.</span><span class="method">add</span><span class="symbol">(</span> <span class="param">otherValue</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/bignumber/">BigNumber</a></span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/bignumber/src.ts/bignumber.ts#L71">source</a></div></div><div class="body"><p>Returns a BigNumber with the value of <i>BigNumber</i> <b>+</b> <i>otherValue</i>.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">BigNumber</span><span class="symbol">.</span><span class="method">sub</span><span class="symbol">(</span> <span class="param">otherValue</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/bignumber/">BigNumber</a></span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/bignumber/src.ts/bignumber.ts#L75">source</a></div></div><div class="body"><p>Returns a BigNumber with the value of <i>BigNumber</i> <b>-</b> <i>otherValue</i>.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">BigNumber</span><span class="symbol">.</span><span class="method">mul</span><span class="symbol">(</span> <span class="param">otherValue</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/bignumber/">BigNumber</a></span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/bignumber/src.ts/bignumber.ts#L87">source</a></div></div><div class="body"><p>Returns a BigNumber with the value of <i>BigNumber</i> <b>×</b> <i>otherValue</i>.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">BigNumber</span><span class="symbol">.</span><span class="method">div</span><span class="symbol">(</span> <span class="param">divisor</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/bignumber/">BigNumber</a></span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/bignumber/src.ts/bignumber.ts#L79">source</a></div></div><div class="body"><p>Returns a BigNumber with the value of <i>BigNumber</i> <b>÷</b> <i>divisor</i>.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">BigNumber</span><span class="symbol">.</span><span class="method">mod</span><span class="symbol">(</span> <span class="param">divisor</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/bignumber/">BigNumber</a></span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/bignumber/src.ts/bignumber.ts#L91">source</a></div></div><div class="body"><p>Returns a BigNumber with the value of the <b>remainder</b> of <i>BigNumber</i> ÷ <i>divisor</i>.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">BigNumber</span><span class="symbol">.</span><span class="method">pow</span><span class="symbol">(</span> <span class="param">exponent</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/bignumber/">BigNumber</a></span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/bignumber/src.ts/bignumber.ts#L99">source</a></div></div><div class="body"><p>Returns a BigNumber with the value of <i>BigNumber</i> to the power of <i>exponent</i>.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">BigNumber</span><span class="symbol">.</span><span class="method">abs</span><span class="symbol">(</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/bignumber/">BigNumber</a></span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/bignumber/src.ts/bignumber.ts#L64">source</a></div></div><div class="body"><p>Returns a BigNumber with the absolute value of <i>BigNumber</i>.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">BigNumber</span><span class="symbol">.</span><span class="method">mask</span><span class="symbol">(</span> <span class="param">bitcount</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/bignumber/">BigNumber</a></span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/bignumber/src.ts/bignumber.ts#L127">source</a></div></div><div class="body"><p>Returns a BigNumber with the value of <i>BigNumber</i> with bits beyond the <i>bitcount</i> least significant bits set to zero.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/bignumber/-%23-BigNumber--BigNumber--methods--two-s-compliment"></a><a name="/v5/api/utils/bignumber/"></a><h3 class="show-anchors"><div>Two's Compliment<div class="anchors"><a class="self" href="#/v5/api/utils/bignumber/-%23-BigNumber--BigNumber--methods--two-s-compliment"></a></div></div></h3><p><a href="https://en.wikipedia.org/wiki/Two%27s_complement">Two's Complicment</a> is an elegant method used to encode and decode fixed-width signed values while efficiently preserving mathematic operations. Most users will not need to interact with these.</p>
|
|
|
|
<div class="property show-anchors"><div class="signature"><span class="path">BigNumber</span><span class="symbol">.</span><span class="method">fromTwos</span><span class="symbol">(</span> <span class="param">bitwidth</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/bignumber/">BigNumber</a></span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/bignumber/src.ts/bignumber.ts#L56">source</a></div></div><div class="body"><p>Returns a BigNumber with the value of <i>BigNumber</i> converted from twos-compliment with <i>bitwidth</i>.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">BigNumber</span><span class="symbol">.</span><span class="method">toTwos</span><span class="symbol">(</span> <span class="param">bitwidth</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/bignumber/">BigNumber</a></span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/bignumber/src.ts/bignumber.ts#L60">source</a></div></div><div class="body"><p>Returns a BigNumber with the value of <i>BigNumber</i> converted to twos-compliment with <i>bitwidth</i>.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/bignumber/-%23-BigNumber--BigNumber--methods--comparison-and-equivalence"></a><a name="/v5/api/utils/bignumber/"></a><h3 class="show-anchors"><div>Comparison and Equivalence<div class="anchors"><a class="self" href="#/v5/api/utils/bignumber/-%23-BigNumber--BigNumber--methods--comparison-and-equivalence"></a></div></div></h3>
|
|
<div class="property show-anchors"><div class="signature"><span class="path">BigNumber</span><span class="symbol">.</span><span class="method">eq</span><span class="symbol">(</span> <span class="param">otherValue</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">boolean</span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/bignumber/src.ts/bignumber.ts#L148">source</a></div></div><div class="body"><p>Returns true if and only if the value of <i>BigNumber</i> is equal to <i>otherValue</i>.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">BigNumber</span><span class="symbol">.</span><span class="method">lt</span><span class="symbol">(</span> <span class="param">otherValue</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">boolean</span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/bignumber/src.ts/bignumber.ts#L152">source</a></div></div><div class="body"><p>Returns true if and only if the value of <i>BigNumber</i> <b><</b> <i>otherValue</i>.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">BigNumber</span><span class="symbol">.</span><span class="method">lte</span><span class="symbol">(</span> <span class="param">otherValue</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">boolean</span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/bignumber/src.ts/bignumber.ts#L156">source</a></div></div><div class="body"><p>Returns true if and only if the value of <i>BigNumber</i> <b>≤</b> <i>otherValue</i>.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">BigNumber</span><span class="symbol">.</span><span class="method">gt</span><span class="symbol">(</span> <span class="param">otherValue</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">boolean</span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/bignumber/src.ts/bignumber.ts#L160">source</a></div></div><div class="body"><p>Returns true if and only if the value of <i>BigNumber</i> <b>></b> <i>otherValue</i>.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">BigNumber</span><span class="symbol">.</span><span class="method">gte</span><span class="symbol">(</span> <span class="param">otherValue</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">boolean</span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/bignumber/src.ts/bignumber.ts#L164">source</a></div></div><div class="body"><p>Returns true if and only if the value of <i>BigNumber</i> <b>≥</b> <i>otherValue</i>.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">BigNumber</span><span class="symbol">.</span><span class="method">isZero</span><span class="symbol">(</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">boolean</span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/bignumber/src.ts/bignumber.ts#L172">source</a></div></div><div class="body"><p>Returns true if and only if the value of <i>BigNumber</i> is zero.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/bignumber/-%23-BigNumber--BigNumber--methods--conversion"></a><a name="/v5/api/utils/bignumber/"></a><h3 class="show-anchors"><div>Conversion<div class="anchors"><a class="self" href="#/v5/api/utils/bignumber/-%23-BigNumber--BigNumber--methods--conversion"></a></div></div></h3>
|
|
<div class="property show-anchors"><div class="signature"><span class="path">BigNumber</span><span class="symbol">.</span><span class="method">toNumber</span><span class="symbol">(</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">number</span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/bignumber/src.ts/bignumber.ts#L176">source</a></div></div><div class="body"><p>Returns the value of <i>BigNumber</i> as a JavaScript value.</p>
|
|
|
|
<p>This will <b>throw an error</b> if the value is greater than or equal to <i>Number.MAX_SAFE_INTEGER</i> or less than or equal to <i>Number.MIN_SAFE_INTEGER</i>.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">BigNumber</span><span class="symbol">.</span><span class="method">toString</span><span class="symbol">(</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">string</span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/bignumber/src.ts/bignumber.ts#L185">source</a></div></div><div class="body"><p>Returns the value of <i>BigNumber</i> as a base-10 string.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">BigNumber</span><span class="symbol">.</span><span class="method">toHexString</span><span class="symbol">(</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a> ></span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/bignumber/src.ts/bignumber.ts#L193">source</a></div></div><div class="body"><p>Returns the value of <i>BigNumber</i> as a base-16, <code class="inline">0x</code>-prefixed <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a>.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/bignumber/-%23-BigNumber--BigNumber--methods--inspection"></a><a name="/v5/api/utils/bignumber/"></a><h3 class="show-anchors"><div>Inspection<div class="anchors"><a class="self" href="#/v5/api/utils/bignumber/-%23-BigNumber--BigNumber--methods--inspection"></a></div></div></h3>
|
|
<div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">BigNumnber</span><span class="symbol">.</span><span class="method">isBigNumber</span><span class="symbol">(</span> <span class="param">object</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">boolean</span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/bignumber/src.ts/bignumber.ts#L246">source</a></div></div><div class="body"><p>Returns true if and only if the <i>object</i> is a BigNumber object.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/bignumber/-%23-BigNumber--BigNumber--methods--examples"></a><a name="/v5/api/utils/bignumber/"></a><h3 class="show-anchors"><div>Examples<div class="anchors"><a class="self" href="#/v5/api/utils/bignumber/-%23-BigNumber--BigNumber--methods--examples"></a></div></div></h3>
|
|
<div class="code">let a = BigNumber.from(42);
|
|
let b = BigNumber.from("91");
|
|
|
|
a.mul(b);
|
|
<span class="result ok">// { BigNumber: "3822" }
|
|
</span></div><a name="/v5/api/utils/bignumber/-%23-BigNumber--notes"></a><a name="/v5/api/utils/bignumber/-%23-BigNumber--BigNumber--notes"></a><a name="/v5/api/utils/bignumber/"></a><h2 class="show-anchors"><div>Notes<div class="anchors"><a class="self" href="#/v5/api/utils/bignumber/-%23-BigNumber--notes"></a></div></div></h2><p>This section is a for a couple of questions that come up frequently.</p>
|
|
|
|
<a name="/v5/api/utils/bignumber/-%23-BigNumber--notes-safenumbers"></a><a name="/v5/api/utils/bignumber/-%23-BigNumber--BigNumber--notes--BigNumber--notes-safenumbers"></a><a name="/v5/api/utils/bignumber/"></a><h3 class="show-anchors"><div>Why can't I just use numbers?<div class="anchors"><a class="self" href="#/v5/api/utils/bignumber/-%23-BigNumber--notes-safenumbers"></a></div></div></h3><p>The first problem many encounter when dealing with Ethereum is the concept of numbers. Most common currencies are broken down with very little granularity. For example, there are only 100 cents in a single dollar. However, there are 10<sup>18</sup> <b>wei</b> in a single <b>ether</b>.</p>
|
|
|
|
<p>JavaScript uses <a href="https://en.wikipedia.org/wiki/Double-precision_floating-point_format">IEEE 754 double-precision binary floating point</a> numbers to represent numeric values. As a result, there are <i>holes</i> in the integer set after 9,007,199,254,740,991; which is problematic for <i>Ethereum</i> because that is only around 0.009 ether (in wei), which means any value over that will begin to experience rounding errors.</p>
|
|
|
|
<p>To demonstrate how this may be an issue in your code, consider:</p>
|
|
|
|
<div class="code">(Number.MAX_SAFE_INTEGER + 2 - 2) == (Number.MAX_SAFE_INTEGER)
|
|
<span class="result ok">// false
|
|
</span></div><p>To remedy this, all numbers (which can be large) are stored and manipulated as <a href="#/v5/api/utils/bignumber/">Big Numbers</a>.</p>
|
|
|
|
<p>The functions <a href="#/v5/api/utils/display-logic/-%23-utils-parseEther">parseEther( etherString )</a> and <a href="#/v5/api/utils/display-logic/-%23-utils-formatEther">formatEther( wei )</a> can be used to convert between string representations, which are displayed to or entered by the user and Big Number representations which can have mathematical operations handled safely.</p>
|
|
|
|
<a name="/v5/api/utils/bignumber/-%23-BigNumber--BigNumber--notes--why-not-bignumber-js-bn-js-bigdecimal-etc"></a><a name="/v5/api/utils/bignumber/"></a><h3 class="show-anchors"><div>Why not BigNumber.js, BN.js, BigDecimal, etc?<div class="anchors"><a class="self" href="#/v5/api/utils/bignumber/-%23-BigNumber--BigNumber--notes--why-not-bignumber-js-bn-js-bigdecimal-etc"></a></div></div></h3><p>Everyone has their own favourite Big Number library, and once someone has choosen one, it becomes part of their identity, like their editor, vi vs emacs. There are over 100 Big Number libraries on <a href="https://www.npmjs.com/search?q=bignumber">npm</a>.</p>
|
|
|
|
<p>One of the biggest differences between the Ethers <a href="#/v5/api/utils/bignumber/">BigNumber</a> object and other libraries is that it is immutable, which is very important when dealing with the asynchronous nature of the blockchain.</p>
|
|
|
|
<p>Capturing the value is not safe in async functions, so immutability protects us from easy to make mistakes, which is not possible on the low-level library's objects which supports myriad in-place operations.</p>
|
|
|
|
<p>Second, the Ethers <a href="#/v5/api/utils/bignumber/">BigNumber</a> provides all the functionality required internally and should generally be sufficient for most developers while not exposing some of the more advanced and rare functionality. So it will be eaiser to swap out the underlying library without impacting consumers.</p>
|
|
|
|
<p>For example, if <a href="https://www.npmjs.com/package/bn.js">BN.js</a> was exposed, someone may use the greatest-common-denominator functions, which would then be functionality the replacing library should also provide to ensure anyone depending on that functionality is not broken.</p>
|
|
|
|
<a name="/v5/api/utils/bignumber/-%23-BigNumber--BigNumber--notes--why-bn-js"></a><a name="/v5/api/utils/bignumber/"></a><h3 class="show-anchors"><div>Why BN.js??<div class="anchors"><a class="self" href="#/v5/api/utils/bignumber/-%23-BigNumber--BigNumber--notes--why-bn-js"></a></div></div></h3><p>The reason why <a href="https://www.npmjs.com/package/bn.js">BN.js</a> is used internally as the big number is because that is the library used by <a href="https://www.npmjs.com/package/elliptic">elliptic</a>.</p>
|
|
|
|
<p>Therefore it <b>must</b> be included regardless, so we leverage that library rather than adding another Big Number library, which would mean two different libraries offering the same functionality.</p>
|
|
|
|
<p>This has saved about 85kb (80% of this library size) of library size over other libraries which include separate Big Number libraries for various purposes.</p>
|
|
|
|
<a name="/v5/api/utils/bignumber/-%23-BigNumber--BigNumber--notes--allow-us-to-set-a-global-big-number-library"></a><a name="/v5/api/utils/bignumber/"></a><h3 class="show-anchors"><div>Allow us to set a global Big Number library?<div class="anchors"><a class="self" href="#/v5/api/utils/bignumber/-%23-BigNumber--BigNumber--notes--allow-us-to-set-a-global-big-number-library"></a></div></div></h3><p>Another comment that comes up frequently is tha desire to specify a global user-defined Big Number library, which all functions would return.</p>
|
|
|
|
<p>This becomes problematic since your code may live along side other libraries or code that use Ethers. In fact, even Ethers uses a lot of the public functions internally.</p>
|
|
|
|
<p>If you, for example, used a library that used <code class="inline">a.plus(b)</code> instead of <code class="inline">a.add(b)</code>, this would break Ethers when it tries to compute fees internally, and other libraries likely have similar logic.</p>
|
|
|
|
<p>But, the <a href="#/v5/api/utils/bignumber/">BigNumber</a> prototype is exposed, so you can always add a <code class="inline">toMyCustomBigNumber()</code> method to all <a href="#/v5/api/utils/bignumber/">BigNumber</a>'s globally which is safe.</p>
|
|
|
|
<div class="page-separator"></div><a name="/v5/api/utils/bytes/-%23-byte-manipulation"></a><a name="/v5/api/utils/bytes/"></a><h1 class="show-anchors"><div>Byte Manipulation<div class="anchors"><a class="self" href="#/v5/api/utils/bytes/-%23-byte-manipulation"></a></div></div></h1><p>Tra la la...</p>
|
|
|
|
<a name="/v5/api/utils/bytes/-%23-byte-manipulation--types"></a><a name="/v5/api/utils/bytes/"></a><h2 class="show-anchors"><div>Types<div class="anchors"><a class="self" href="#/v5/api/utils/bytes/-%23-byte-manipulation--types"></a></div></div></h2>
|
|
<a name="/v5/api/utils/bytes/-%23-Bytes"></a><a name="/v5/api/utils/bytes/-%23-byte-manipulation--types--Bytes"></a><a name="/v5/api/utils/bytes/"></a><h3 class="show-anchors"><div>Bytes<div class="anchors"><a class="self" href="#/v5/api/utils/bytes/-%23-Bytes"></a></div></div></h3><p>A <b>Bytes</b> is any object which is an <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array">Array</a> or <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray">TypedArray</a> with each value in the valid byte range (i.e. between 0 and 255 inclusive), or is an Object with a <code class="inline">length</code> property where each indexed property is in the valid byte range.</p>
|
|
|
|
<a name="/v5/api/utils/bytes/-%23-BytesLike"></a><a name="/v5/api/utils/bytes/-%23-byte-manipulation--types--BytesLike"></a><a name="/v5/api/utils/bytes/"></a><h3 class="show-anchors"><div>BytesLike<div class="anchors"><a class="self" href="#/v5/api/utils/bytes/-%23-BytesLike"></a></div></div></h3><p>A <b>BytesLike</b> can be either a <a href="#/v5/api/utils/bytes/-%23-Bytes">Bytes</a> or a <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a>.</p>
|
|
|
|
<a name="/v5/api/utils/bytes/-%23-DataHexString"></a><a name="/v5/api/utils/bytes/-%23-byte-manipulation--types--DataHexString"></a><a name="/v5/api/utils/bytes/"></a><h3 class="show-anchors"><div>DataHexString<div class="anchors"><a class="self" href="#/v5/api/utils/bytes/-%23-DataHexString"></a></div></div></h3><p>A <b>DataHexstring</b> is identical to a <a href="#/v5/api/utils/bytes/-%23-HexString">HexString</a> except that it has an even number of nibbles, and therefore is a valid representation of binary data as a string.</p>
|
|
|
|
<a name="/v5/api/utils/bytes/-%23-HexString"></a><a name="/v5/api/utils/bytes/-%23-byte-manipulation--types--HexString"></a><a name="/v5/api/utils/bytes/"></a><h3 class="show-anchors"><div>HexString<div class="anchors"><a class="self" href="#/v5/api/utils/bytes/-%23-HexString"></a></div></div></h3><p>A <b>Hexstring</b> is a string which has a <code class="inline">0x</code> prefix followed by any number of nibbles (i.e. case-insensitive hexidecumal characters, <code class="inline">0-9</code> and <code class="inline">a-f</code>).</p>
|
|
|
|
<a name="/v5/api/utils/bytes/-%23-Signature"></a><a name="/v5/api/utils/bytes/-%23-byte-manipulation--types--Signature"></a><a name="/v5/api/utils/bytes/"></a><h3 class="show-anchors"><div>Signature<div class="anchors"><a class="self" href="#/v5/api/utils/bytes/-%23-Signature"></a></div></div></h3><p><ul><li><b>r</b> and <b>s</b> --- The x co-ordinate of <b>r</b> and the <b>s</b> value of the signature </li><li><b>v</b> --- The parity of the y co-ordinate of <b>r</b> </li><li><b>_vs</b> --- The <a href="https://eips.ethereum.org/EIPS/eip-2098">compact representation</a> of the <b>s</b> and <b>v</b> </li><li><b>recoveryParam</b> --- The normalized (i.e. 0 or 1) value of <b>v</b> </li></ul></p>
|
|
|
|
<a name="/v5/api/utils/bytes/-%23-signature-raw"></a><a name="/v5/api/utils/bytes/-%23-byte-manipulation--types--signature-raw"></a><a name="/v5/api/utils/bytes/"></a><h3 class="show-anchors"><div>Raw Signature<span class="inherits"> inherits string<<a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a><65>></span><div class="anchors"><a class="self" href="#/v5/api/utils/bytes/-%23-signature-raw"></a></div></div></h3><p>A <b>Raw Signature</b> is a common Signature format where the r, s and v are concanenated into a 65 byte (130 nibble) <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a>.</p>
|
|
|
|
<a name="/v5/api/utils/bytes/-%23-SignatureLike"></a><a name="/v5/api/utils/bytes/-%23-byte-manipulation--types--SignatureLike"></a><a name="/v5/api/utils/bytes/"></a><h3 class="show-anchors"><div>SignatureLike<div class="anchors"><a class="self" href="#/v5/api/utils/bytes/-%23-SignatureLike"></a></div></div></h3><p>A <b>SignatureLike</b> is similar to a <a href="#/v5/api/utils/bytes/-%23-Signature">Signature</a>, except redundant properties may be omitted or it may be a <a href="#/v5/api/utils/bytes/-%23-signature-raw">Raw Signature</a>.</p>
|
|
|
|
<p>For example, if <b>_vs</b> is specified, <b>s</b> and <b>v</b> may be omitted. Likewise, if <b>recoveryParam</b> is provided, <b>v</b> may be omitted (as in these cases the missing values can be computed).</p>
|
|
|
|
<a name="/v5/api/utils/bytes/-%23-byte-manipulation--inspection"></a><a name="/v5/api/utils/bytes/"></a><h2 class="show-anchors"><div>Inspection<div class="anchors"><a class="self" href="#/v5/api/utils/bytes/-%23-byte-manipulation--inspection"></a></div></div></h2>
|
|
<a name="/v5/api/utils/bytes/-%23-utils-isBytes"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="method">isBytes</span><span class="symbol">(</span> <span class="param">object</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">boolean</span><div class="anchors"><a class="self" href="#/v5/api/utils/bytes/-%23-utils-isBytes"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/bytes/src.ts/index.ts#L73">source</a></div></div><div class="body"><p>Returns true if and only if <i>object</i> is a valid <a href="#/v5/api/utils/bytes/-%23-Bytes">Bytes</a>.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/bytes/-%23-utils-isBytesLike"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="method">isBytesLike</span><span class="symbol">(</span> <span class="param">object</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">boolean</span><div class="anchors"><a class="self" href="#/v5/api/utils/bytes/-%23-utils-isBytesLike"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/bytes/src.ts/index.ts#L69">source</a></div></div><div class="body"><p>Returns true if and only if <i>object</i> is a <a href="#/v5/api/utils/bytes/-%23-Bytes">Bytes</a> or <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a>.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/bytes/-%23-utils-isHexString"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="method">isHexString</span><span class="symbol">(</span> <span class="param">object</span> <span class="symbol">,</span> <span class="symbol">[</span> <span class="param">length</span> <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">boolean</span><div class="anchors"><a class="self" href="#/v5/api/utils/bytes/-%23-utils-isHexString"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/bytes/src.ts/index.ts#L184">source</a></div></div><div class="body"><p>Returns true if and only if <i>object</i> is a valid hex string. If <i>length</i> is specified and <i>object</i> is not a valid <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a> of <i>length</i> bytes, an InvalidArgument error is thrown.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/bytes/-%23-byte-manipulation--converting-between-arrays-and-hexstrings"></a><a name="/v5/api/utils/bytes/"></a><h2 class="show-anchors"><div>Converting between Arrays and Hexstrings<div class="anchors"><a class="self" href="#/v5/api/utils/bytes/-%23-byte-manipulation--converting-between-arrays-and-hexstrings"></a></div></div></h2>
|
|
<a name="/v5/api/utils/bytes/-%23-utils-arrayify"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="method">arrayify</span><span class="symbol">(</span> <span class="param">DataHexStringOrArrayish</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">options</span> <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Uint8Array</span><div class="anchors"><a class="self" href="#/v5/api/utils/bytes/-%23-utils-arrayify"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/bytes/src.ts/index.ts#L91">source</a></div></div><div class="body"><p>Converts <i>DataHexStringOrArrayish</i> to a Uint8Array.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/bytes/-%23-utils-hexlify"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="method">hexlify</span><span class="symbol">(</span> <span class="param">hexstringOrArrayish</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a> ></span><div class="anchors"><a class="self" href="#/v5/api/utils/bytes/-%23-utils-hexlify"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/bytes/src.ts/index.ts#L194">source</a></div></div><div class="body"><p>Converts <i>hexstringOrArrayish</i> to a <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a>.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/bytes/-%23-utils-hexValue"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="method">hexValue</span><span class="symbol">(</span> <span class="param">aBigNumberish</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/bytes/-%23-HexString">HexString</a> ></span><div class="anchors"><a class="self" href="#/v5/api/utils/bytes/-%23-utils-hexValue"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/bytes/src.ts/index.ts#L287">source</a></div></div><div class="body"><p>Converts <i>aBigNumberish</i> to a <a href="#/v5/api/utils/bytes/-%23-HexString">HexString</a>, with no <u>unnecessary</u> leading zeros.</p>
|
|
|
|
</div></div><div class="code-title"><div>Examples</div></div><div class="code"><span class="comment">// Convert a hexstring to a Uint8Array
|
|
</span>arrayify("0x1234")
|
|
<span class="result ok">// Uint8Array [ 18, 52 ]
|
|
</span>
|
|
<span class="comment">// Convert an Array to a hexstring
|
|
</span>hexlify([1, 2, 3, 4])
|
|
<span class="result ok">// '0x01020304'
|
|
</span>
|
|
<span class="comment">// Convert an Object to a hexstring
|
|
</span>hexlify({ length: 2, "0": 1, "1": 2 })
|
|
<span class="result ok">// '0x0102'
|
|
</span>
|
|
<span class="comment">// Convert an Array to a hexstring
|
|
</span>hexlify([ 1 ])
|
|
<span class="result ok">// '0x01'
|
|
</span>
|
|
<span class="comment">// Convert a number to a stripped hex value
|
|
</span>hexValue(1)
|
|
<span class="result ok">// '0x1'
|
|
</span>
|
|
<span class="comment">// Convert an Array to a stripped hex value
|
|
</span>hexValue([ 1, 2 ])
|
|
<span class="result ok">// '0x102'
|
|
</span></div><a name="/v5/api/utils/bytes/-%23-byte-manipulation--array-manipulation"></a><a name="/v5/api/utils/bytes/"></a><h2 class="show-anchors"><div>Array Manipulation<div class="anchors"><a class="self" href="#/v5/api/utils/bytes/-%23-byte-manipulation--array-manipulation"></a></div></div></h2>
|
|
<a name="/v5/api/utils/bytes/-%23-utils-concat"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="method">concat</span><span class="symbol">(</span> <span class="param">arrayOfBytesLike</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Uint8Array</span><div class="anchors"><a class="self" href="#/v5/api/utils/bytes/-%23-utils-concat"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/bytes/src.ts/index.ts#L140">source</a></div></div><div class="body"><p>Concatenates all the <a href="#/v5/api/utils/bytes/-%23-BytesLike">BytesLike</a> in <i>arrayOfBytesLike</i> into a single Uint8Array.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/bytes/-%23-utils-stripZeros"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="method">stripZeros</span><span class="symbol">(</span> <span class="param">aBytesLike</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Uint8Array</span><div class="anchors"><a class="self" href="#/v5/api/utils/bytes/-%23-utils-stripZeros"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/bytes/src.ts/index.ts#L154">source</a></div></div><div class="body"><p>Returns a Uint8Array with all leading <code class="inline">0</code> bytes of <i>aBtyesLike</i> removed.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/bytes/-%23-utils-zeroPad"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="method">zeroPad</span><span class="symbol">(</span> <span class="param">aBytesLike</span> <span class="symbol">,</span> <span class="param">length</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Uint8Array</span><div class="anchors"><a class="self" href="#/v5/api/utils/bytes/-%23-utils-zeroPad"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/bytes/src.ts/index.ts#L171">source</a></div></div><div class="body"><p>Retutns a Uint8Array of the data in <i>aBytesLike</i> with <code class="inline">0</code> bytes prepended to <i>length</i> bytes long.</p>
|
|
|
|
<p>If <i>aBytesLike</i> is already longer than <i>length</i> bytes long, an InvalidArgument error will be thrown.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/bytes/-%23-byte-manipulation--hexstring-manipulation"></a><a name="/v5/api/utils/bytes/"></a><h2 class="show-anchors"><div>Hexstring Manipulation<div class="anchors"><a class="self" href="#/v5/api/utils/bytes/-%23-byte-manipulation--hexstring-manipulation"></a></div></div></h2>
|
|
<a name="/v5/api/utils/bytes/-%23-utils-hexConcat"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="method">hexConcat</span><span class="symbol">(</span> <span class="param">arrayOfBytesLike</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a> ></span><div class="anchors"><a class="self" href="#/v5/api/utils/bytes/-%23-utils-hexConcat"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/bytes/src.ts/index.ts#L279">source</a></div></div><div class="body"><p>Concatenates all the <a href="#/v5/api/utils/bytes/-%23-BytesLike">BytesLike</a> in <i>arrayOfBytesLike</i> into a single <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a></p>
|
|
|
|
</div></div><a name="/v5/api/utils/bytes/-%23-utils-hexDataLength"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="method">hexDataLength</span><span class="symbol">(</span> <span class="param">aBytesLike</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a> ></span><div class="anchors"><a class="self" href="#/v5/api/utils/bytes/-%23-utils-hexDataLength"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/bytes/src.ts/index.ts#L253">source</a></div></div><div class="body"><p>Returns the length (in bytes) of <i>aBytesLike</i>.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/bytes/-%23-utils-hexDataSlice"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="method">hexDataSlice</span><span class="symbol">(</span> <span class="param">aBytesLike</span> <span class="symbol">,</span> <span class="param">offset</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">endOffset</span> <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a> ></span><div class="anchors"><a class="self" href="#/v5/api/utils/bytes/-%23-utils-hexDataSlice"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/bytes/src.ts/index.ts#L263">source</a></div></div><div class="body"><p>Returns a <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a> representation of a slice of <i>aBytesLike</i>, from <i>offset</i> (in bytes) to <i>endOffset</i> (in bytes). If <i>endOffset</i> is omitted, the length of <i>aBytesLike</i> is used.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/bytes/-%23-utils-hexStripZeros"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="method">hexStripZeros</span><span class="symbol">(</span> <span class="param">aBytesLike</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/bytes/-%23-HexString">HexString</a> ></span><div class="anchors"><a class="self" href="#/v5/api/utils/bytes/-%23-utils-hexStripZeros"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/bytes/src.ts/index.ts#L293">source</a></div></div><div class="body"><p>Returns a <a href="#/v5/api/utils/bytes/-%23-HexString">HexString</a> representation of <i>aBytesLike</i> with all leading zeros removed.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/bytes/-%23-utils-hexZeroPad"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="method">hexZeroPad</span><span class="symbol">(</span> <span class="param">aBytesLike</span> <span class="symbol">,</span> <span class="param">length</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a> ></span><div class="anchors"><a class="self" href="#/v5/api/utils/bytes/-%23-utils-hexZeroPad"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/bytes/src.ts/index.ts#L305">source</a></div></div><div class="body"><p>Returns a <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a> representation of <i>aBytesLike</i> padded to <i>length</i> bytes.</p>
|
|
|
|
<p>If <i>aBytesLike</i> is already longer than <i>length</i> bytes long, an InvalidArgument error will be thrown.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/bytes/-%23-byte-manipulation--signature-conversion"></a><a name="/v5/api/utils/bytes/"></a><h2 class="show-anchors"><div>Signature Conversion<div class="anchors"><a class="self" href="#/v5/api/utils/bytes/-%23-byte-manipulation--signature-conversion"></a></div></div></h2>
|
|
<a name="/v5/api/utils/bytes/-%23-utils-joinSignature"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="method">joinSignature</span><span class="symbol">(</span> <span class="param">aSignatureLike</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/bytes/-%23-signature-raw">RawSignature</a> ></span><div class="anchors"><a class="self" href="#/v5/api/utils/bytes/-%23-utils-joinSignature"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/bytes/src.ts/index.ts#L442">source</a></div></div><div class="body"><p>Return the raw-format of <i>aSignaturelike</i>, which is 65 bytes (130 nibbles) long, concatenating the <b>r</b>, <b>s</b> and (normalized) <b>v</b> of a Signature.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/bytes/-%23-utils-splitSignature"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="method">splitSignature</span><span class="symbol">(</span> <span class="param">aSignatureLikeOrBytesLike</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/bytes/-%23-Signature">Signature</a></span><div class="anchors"><a class="self" href="#/v5/api/utils/bytes/-%23-utils-splitSignature"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/bytes/src.ts/index.ts#L323">source</a></div></div><div class="body"><p>Return the full expanded-format of <i>aSignaturelike</i> or a raw-format <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a>. Any missing properties will be computed.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/bytes/-%23-byte-manipulation--random-bytes"></a><a name="/v5/api/utils/bytes/"></a><h2 class="show-anchors"><div>Random Bytes<div class="anchors"><a class="self" href="#/v5/api/utils/bytes/-%23-byte-manipulation--random-bytes"></a></div></div></h2>
|
|
<a name="/v5/api/utils/bytes/-%23-utils-randomBytes"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="method">randomBytes</span><span class="symbol">(</span> <span class="param">length</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Uint8Array</span><div class="anchors"><a class="self" href="#/v5/api/utils/bytes/-%23-utils-randomBytes"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/random/src.ts/index.ts#L9">source</a></div></div><div class="body"><p>Return a new Uint8Array of <i>length</i> random bytes.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/bytes/-%23-utils-shuffled"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="method">shuffled</span><span class="symbol">(</span> <span class="param">array</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Array< any ></span><div class="anchors"><a class="self" href="#/v5/api/utils/bytes/-%23-utils-shuffled"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/random/src.ts/shuffle.ts#L3">source</a></div></div><div class="body"><p>Return a copy of <i>array</i> shuffled using <a href="https://en.wikipedia.org/wiki/Fisher-Yates_shuffle">Fisher-Yates Shuffle</a>.</p>
|
|
|
|
</div></div><div class="code-title"><div>Examples</div></div><div class="code">utils.randomBytes(8)
|
|
<span class="result ok">// Uint8Array [ 95, 9, 0, 81, 176, 49, 211, 225 ]
|
|
</span>
|
|
const data = [ 1, 2, 3, 4, 5, 6, 7 ];
|
|
|
|
<span class="comment">// Returns a new Array
|
|
</span>utils.shuffled(data);
|
|
<span class="result ok">// [
|
|
</span><span class="result ok">// 6,
|
|
</span><span class="result ok">// 7,
|
|
</span><span class="result ok">// 4,
|
|
</span><span class="result ok">// 3,
|
|
</span><span class="result ok">// 5,
|
|
</span><span class="result ok">// 1,
|
|
</span><span class="result ok">// 2
|
|
</span><span class="result ok">// ]
|
|
</span>
|
|
<span class="comment">// The Original is unscathed...
|
|
</span>data
|
|
<span class="result ok">// [
|
|
</span><span class="result ok">// 1,
|
|
</span><span class="result ok">// 2,
|
|
</span><span class="result ok">// 3,
|
|
</span><span class="result ok">// 4,
|
|
</span><span class="result ok">// 5,
|
|
</span><span class="result ok">// 6,
|
|
</span><span class="result ok">// 7
|
|
</span><span class="result ok">// ]
|
|
</span></div><div class="page-separator"></div><a name="/v5/api/utils/constants/-%23-constants"></a><a name="/v5/api/utils/constants/-%23-constants"></a><a name="/v5/api/utils/constants/"></a><h1 class="show-anchors"><div>Constants<div class="anchors"><a class="self" href="#/v5/api/utils/constants/-%23-constants"></a></div></div></h1><p>The <b>ethers.contants</b> Object contains commonly used values.</p>
|
|
|
|
<a name="/v5/api/utils/constants/-%23-constants--bytes"></a><a name="/v5/api/utils/constants/"></a><h2 class="show-anchors"><div>Bytes<div class="anchors"><a class="self" href="#/v5/api/utils/constants/-%23-constants--bytes"></a></div></div></h2>
|
|
<a name="/v5/api/utils/constants/-%23-constants-AddressZero"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">constants</span><span class="symbol">.</span><span class="method">AddressZero</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/address/-%23-address">Address</a> ></span><div class="anchors"><a class="self" href="#/v5/api/utils/constants/-%23-constants-AddressZero"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/constants/src.ts/index.ts#L5">source</a></div></div><div class="body"><p>The Address Zero, which is 20 bytes (40 nibbles) of zero.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/constants/-%23-constants-HashZero"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">constants</span><span class="symbol">.</span><span class="method">HashZero</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a>< 32 > ></span><div class="anchors"><a class="self" href="#/v5/api/utils/constants/-%23-constants-HashZero"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/constants/src.ts/index.ts#L6">source</a></div></div><div class="body"><p>The Hash Zero, which is 32 bytes (64 nibbles) of zero.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/constants/-%23-constants--strings"></a><a name="/v5/api/utils/constants/"></a><h2 class="show-anchors"><div>Strings<div class="anchors"><a class="self" href="#/v5/api/utils/constants/-%23-constants--strings"></a></div></div></h2>
|
|
<a name="/v5/api/utils/constants/-%23-constants-EtherSymbol"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">constants</span><span class="symbol">.</span><span class="method">EtherSymbol</span> <span class="arrow">⇒</span> <span class="returns">string</span><div class="anchors"><a class="self" href="#/v5/api/utils/constants/-%23-constants-EtherSymbol"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/constants/src.ts/index.ts#L9">source</a></div></div><div class="body"><p>The Ether symbol, <b>Ξ</b>.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/constants/-%23-constants--bignumber"></a><a name="/v5/api/utils/constants/"></a><h2 class="show-anchors"><div>BigNumber<div class="anchors"><a class="self" href="#/v5/api/utils/constants/-%23-constants--bignumber"></a></div></div></h2>
|
|
<a name="/v5/api/utils/constants/-%23-constants-NegativeOne"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">constants</span><span class="symbol">.</span><span class="method">NegativeOne</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/bignumber/">BigNumber</a></span><div class="anchors"><a class="self" href="#/v5/api/utils/constants/-%23-constants-NegativeOne"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/constants/src.ts/index.ts#L11">source</a></div></div><div class="body"><p>The BigNumber value representing <code class="inline">"-1"</code>.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/constants/-%23-constants-Zero"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">constants</span><span class="symbol">.</span><span class="method">Zero</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/bignumber/">BigNumber</a></span><div class="anchors"><a class="self" href="#/v5/api/utils/constants/-%23-constants-Zero"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/constants/src.ts/index.ts#L12">source</a></div></div><div class="body"><p>The BigNumber value representing <code class="inline">"0"</code>.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/constants/-%23-constants-One"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">constants</span><span class="symbol">.</span><span class="method">One</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/bignumber/">BigNumber</a></span><div class="anchors"><a class="self" href="#/v5/api/utils/constants/-%23-constants-One"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/constants/src.ts/index.ts#L13">source</a></div></div><div class="body"><p>The BigNumber value representing <code class="inline">"1"</code>.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/constants/-%23-constants-Two"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">constants</span><span class="symbol">.</span><span class="method">Two</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/bignumber/">BigNumber</a></span><div class="anchors"><a class="self" href="#/v5/api/utils/constants/-%23-constants-Two"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/constants/src.ts/index.ts#L14">source</a></div></div><div class="body"><p>The BigNumber value representing <code class="inline">"2"</code>.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/constants/-%23-constants-WeiPerEther"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">constants</span><span class="symbol">.</span><span class="method">WeiPerEther</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/bignumber/">BigNumber</a></span><div class="anchors"><a class="self" href="#/v5/api/utils/constants/-%23-constants-WeiPerEther"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/constants/src.ts/index.ts#L15">source</a></div></div><div class="body"><p>The BigNumber value representing <code class="inline">"1000000000000000000"</code>, which is the number of Wei per Ether.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/constants/-%23-constants-MaxUint256"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">constants</span><span class="symbol">.</span><span class="method">MaxUint256</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/bignumber/">BigNumber</a></span><div class="anchors"><a class="self" href="#/v5/api/utils/constants/-%23-constants-MaxUint256"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/constants/src.ts/index.ts#L16">source</a></div></div><div class="body"><p>The BigNumber value representing the maximum <code class="inline">uint256</code> value.</p>
|
|
|
|
</div></div><div class="page-separator"></div><a name="/v5/api/utils/display-logic/-%23-display-logic-and-input"></a><a name="/v5/api/utils/display-logic/"></a><h1 class="show-anchors"><div>Display Logic and Input<div class="anchors"><a class="self" href="#/v5/api/utils/display-logic/-%23-display-logic-and-input"></a></div></div></h1><p>When creating an Application, it is useful to convert between user-friendly strings (usually displaying <b>ether</b>) and the machine-readable values that contracts and maths depend on (usually in <b>wei</b>).</p>
|
|
|
|
<p>For example, a Wallet may specify the balance in ether, and gas prices in gwei for the User Interface, but when sending a transaction, both must be specified in wei.</p>
|
|
|
|
<p>The <a href="#/v5/api/utils/display-logic/-%23-unit-conversion">parseUnits</a> will parse a string representing ether, such as <code class="inline">1.1</code> into a <a href="#/v5/api/utils/bignumber/">BigNumber</a> in wei, and is useful when a user types in a value, such as sending 1.1 ether.</p>
|
|
|
|
<p>The <a href="#/v5/api/utils/display-logic/-%23-unit-conversion">formatUnits</a> will format a <a href="#/v5/api/utils/bignumber/-%23-BigNumberish">BigNumberish</a> into a string, which is useful when displaying a balance.</p>
|
|
|
|
<a name="/v5/api/utils/display-logic/-%23-display-logic-and-input--units"></a><a name="/v5/api/utils/display-logic/"></a><h2 class="show-anchors"><div>Units<div class="anchors"><a class="self" href="#/v5/api/utils/display-logic/-%23-display-logic-and-input--units"></a></div></div></h2>
|
|
<a name="/v5/api/utils/display-logic/-%23-display-logic-and-input--units--decimal-count"></a><a name="/v5/api/utils/display-logic/"></a><h3 class="show-anchors"><div>Decimal Count<div class="anchors"><a class="self" href="#/v5/api/utils/display-logic/-%23-display-logic-and-input--units--decimal-count"></a></div></div></h3><p>A <b>Unit</b> can be specified as an number, which indicates the number of decimal places that should be used.</p>
|
|
|
|
<p><b>Examples:</b></p>
|
|
|
|
<p><ul><li>1 ether in wei, has <b>18</b> decimal places (i.e. 1 ether represents 10<sup>18</sup> wei) </li><li>1 bitcoin in Satoshi, has <b>8</b> decimal places (i.e. 1 bitcoin represents 10<sup>8</sup> satoshi) </li></ul></p>
|
|
|
|
<a name="/v5/api/utils/display-logic/-%23-display-logic-and-input--units--named-units"></a><a name="/v5/api/utils/display-logic/"></a><h3 class="show-anchors"><div>Named Units<div class="anchors"><a class="self" href="#/v5/api/utils/display-logic/-%23-display-logic-and-input--units--named-units"></a></div></div></h3><p>There are also several common <b>Named Units</b>, in which case their name (as a string) may be used.</p>
|
|
|
|
<table class="table compact"><tr><td align="center" width="50%"><b>Name</b></td><td align="center" width="50%"><b>Decimals</b></td><td class="fix"> </td></tr><tr><td align="center" width="50%"><i>wei</i></td><td align="center" width="50%">0</td><td class="fix"> </td></tr><tr><td align="center" width="50%"><i>kwei</i></td><td align="center" width="50%">3</td><td class="fix"> </td></tr><tr><td align="center" width="50%"><i>mwei</i></td><td align="center" width="50%">6</td><td class="fix"> </td></tr><tr><td align="center" width="50%"><i>gwei</i></td><td align="center" width="50%">9</td><td class="fix"> </td></tr><tr><td align="center" width="50%"><i>szabo</i></td><td align="center" width="50%">12</td><td class="fix"> </td></tr><tr><td align="center" width="50%"><i>finney</i></td><td align="center" width="50%">15</td><td class="fix"> </td></tr><tr><td align="center" width="50%"><i>ether</i></td><td align="center" width="50%">18</td><td class="fix"> </td></tr></table><a name="/v5/api/utils/display-logic/-%23-display-logic-and-input--functions"></a><a name="/v5/api/utils/display-logic/"></a><h2 class="show-anchors"><div>Functions<div class="anchors"><a class="self" href="#/v5/api/utils/display-logic/-%23-display-logic-and-input--functions"></a></div></div></h2>
|
|
<a name="/v5/api/utils/display-logic/-%23-display-logic-and-input--functions--formatting"></a><a name="/v5/api/utils/display-logic/"></a><h3 class="show-anchors"><div>Formatting<div class="anchors"><a class="self" href="#/v5/api/utils/display-logic/-%23-display-logic-and-input--functions--formatting"></a></div></div></h3>
|
|
<a name="/v5/api/utils/display-logic/-%23-utils-commify"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="method">commify</span><span class="symbol">(</span> <span class="param">value</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">string</span><div class="anchors"><a class="self" href="#/v5/api/utils/display-logic/-%23-utils-commify"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/units/src.ts/index.ts#L23">source</a></div></div><div class="body"><p>Returns a string with value grouped by 3 digits, separated by <code class="inline">,</code>.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/display-logic/-%23-unit-conversion"></a><a name="/v5/api/utils/display-logic/-%23-display-logic-and-input--functions--unit-conversion"></a><a name="/v5/api/utils/display-logic/"></a><h3 class="show-anchors"><div>Conversion<div class="anchors"><a class="self" href="#/v5/api/utils/display-logic/-%23-unit-conversion"></a></div></div></h3>
|
|
<a name="/v5/api/utils/display-logic/-%23-utils-formatUnits"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="method">formatUnits</span><span class="symbol">(</span> <span class="param">value</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">unit</span> = "<span class="param">ether</span>" <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">string</span><div class="anchors"><a class="self" href="#/v5/api/utils/display-logic/-%23-utils-formatUnits"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/units/src.ts/index.ts#L61">source</a></div></div><div class="body"><p>Returns a string representation of <i>value</i> formatted with <i>unit</i> digits (if it is a number) or to the unit specified (if a string).</p>
|
|
|
|
</div></div><a name="/v5/api/utils/display-logic/-%23-utils-formatEther"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="method">formatEther</span><span class="symbol">(</span> <span class="param">value</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">string</span><div class="anchors"><a class="self" href="#/v5/api/utils/display-logic/-%23-utils-formatEther"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/units/src.ts/index.ts#L77">source</a></div></div><div class="body"><p>The equivalent to calling <code class="inline">formatUnits(value, "ether")</code>.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/display-logic/-%23-utils-parseUnits"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="method">parseUnits</span><span class="symbol">(</span> <span class="param">value</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">unit</span> = "<span class="param">ether</span>" <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/bignumber/">BigNumber</a></span><div class="anchors"><a class="self" href="#/v5/api/utils/display-logic/-%23-utils-parseUnits"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/units/src.ts/index.ts#L69">source</a></div></div><div class="body"><p>Returns a <a href="#/v5/api/utils/bignumber/">BigNumber</a> representation of <i>value</i>, parsed with <i>unit</i> digits (if it is a number) or from the unit specified (if a string).</p>
|
|
|
|
</div></div><a name="/v5/api/utils/display-logic/-%23-utils-parseEther"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="method">parseEther</span><span class="symbol">(</span> <span class="param">value</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/bignumber/">BigNumber</a></span><div class="anchors"><a class="self" href="#/v5/api/utils/display-logic/-%23-utils-parseEther"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/units/src.ts/index.ts#L81">source</a></div></div><div class="body"><p>The equivalent to calling <code class="inline">parseUnits(value, "ether")</code>.</p>
|
|
|
|
</div></div><div class="page-separator"></div><a name="/v5/api/utils/encoding/-%23-encoding"></a><a name="/v5/api/utils/encoding/-%23-encoding"></a><a name="/v5/api/utils/encoding/"></a><h1 class="show-anchors"><div>Encoding Utilities<div class="anchors"><a class="self" href="#/v5/api/utils/encoding/-%23-encoding"></a></div></div></h1>
|
|
<a name="/v5/api/utils/encoding/-%23-Bse58"></a><a name="/v5/api/utils/encoding/-%23-encoding--Bse58"></a><a name="/v5/api/utils/encoding/"></a><h2 class="show-anchors"><div>Base58<div class="anchors"><a class="self" href="#/v5/api/utils/encoding/-%23-Bse58"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/basex/src.ts/index.ts#L138">source</a></div></div></h2>
|
|
<div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="path">base58</span><span class="symbol">.</span><span class="method">decode</span><span class="symbol">(</span> <span class="param">textData</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Uin8Array</span><div class="anchors"></div></div><div class="body"><p>Return a typed Uint8Array representation of <i>textData</i> decoded using base-58 encoding.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="path">base58</span><span class="symbol">.</span><span class="method">encode</span><span class="symbol">(</span> <span class="param">aBytesLike</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">string</span><div class="anchors"></div></div><div class="body"><p>Return <i>aBytesLike</i> encoded as a string using the base-58 encoding.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/encoding/-%23-Base64"></a><a name="/v5/api/utils/encoding/-%23-encoding--Base64"></a><a name="/v5/api/utils/encoding/"></a><h2 class="show-anchors"><div>Base64<div class="anchors"><a class="self" href="#/v5/api/utils/encoding/-%23-Base64"></a></div></div></h2>
|
|
<div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="path">base64</span><span class="symbol">.</span><span class="method">decode</span><span class="symbol">(</span> <span class="param">textData</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Uin8Array</span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/base64/src.ts/index.ts#L6">source</a></div></div><div class="body"><p>Return a typed Uint8Array representation of <i>textData</i> decoded using base-64 encoding.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="path">base64</span><span class="symbol">.</span><span class="method">encode</span><span class="symbol">(</span> <span class="param">aBytesLike</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">string</span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/base64/src.ts/index.ts#L10">source</a></div></div><div class="body"><p>Return <i>aBytesLike</i> encoded as a string using the base-64 encoding.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/encoding/-%23-rlp--methods"></a><a name="/v5/api/utils/encoding/-%23-encoding--rlp--methods"></a><a name="/v5/api/utils/encoding/"></a><h2 class="show-anchors"><div>Recursive-Length Prefix<div class="anchors"><a class="self" href="#/v5/api/utils/encoding/-%23-rlp--methods"></a></div></div></h2><p>The <a href="https://github.com/ethereum/wiki/wiki/RLP">Recursive Length Prefix</a> encoding is used throughout Ethereum to serialize nested structures of Arrays and data.</p>
|
|
|
|
<a name="/v5/api/utils/encoding/-%23-utils-rlpEncode"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="path">RLP</span><span class="symbol">.</span><span class="method">encode</span><span class="symbol">(</span> <span class="param">dataObject</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a> ></span><div class="anchors"><a class="self" href="#/v5/api/utils/encoding/-%23-utils-rlpEncode"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/rlp/src.ts/index.ts#L67">source</a></div></div><div class="body"><p>Encode a structured Data Object into its RLP-encoded representation.</p>
|
|
|
|
<p>Each Data component may be an valid <a href="#/v5/api/utils/bytes/-%23-BytesLike">BytesLike</a>.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/encoding/-%23-utils.rlpDecode"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="path">RLP</span><span class="symbol">.</span><span class="method">decode</span><span class="symbol">(</span> <span class="param">aBytesLike</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/encoding/-%23-rlp--dataobject">DataObject</a></span><div class="anchors"><a class="self" href="#/v5/api/utils/encoding/-%23-utils.rlpDecode"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/rlp/src.ts/index.ts#L147">source</a></div></div><div class="body"><p>Decode an RLP-encoded <i>aBytesLike</i> into its structured Data Object.</p>
|
|
|
|
<p>All Data components will be returned as a <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a>.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/encoding/-%23-rlp--dataobject"></a><a name="/v5/api/utils/encoding/-%23-encoding--rlp--methods--rlp--dataobject"></a><a name="/v5/api/utils/encoding/"></a><h3 class="show-anchors"><div>Data Object<div class="anchors"><a class="self" href="#/v5/api/utils/encoding/-%23-rlp--dataobject"></a></div></div></h3><p>A <b>Data Object</b> is a recursive structure which is used to serialize many internal structures in Ethereum. Each <b>Data Object</b> can either be:</p>
|
|
|
|
<p><ul><li>Binary Data </li><li>An Array of <b>Data Objects</b> (i.e. this recursively includes Nesting) </li></ul></p>
|
|
|
|
<div class="definition"><div class="term"><b>Examples</b></div><div class="body"><p><ul><li><code class="inline">"0x1234"</code> </li><li><code class="inline">[ "0x1234", [ "0xdead", "0xbeef" ], [ ] ]</code> </li></ul></p>
|
|
|
|
</div></div><div class="page-separator"></div><a name="/v5/api/utils/fixednumber/-%23-FixedNumber"></a><a name="/v5/api/utils/fixednumber/-%23-FixedNumber"></a><a name="/v5/api/utils/fixednumber/"></a><h1 class="show-anchors"><div>FixedNumber<div class="anchors"><a class="self" href="#/v5/api/utils/fixednumber/-%23-FixedNumber"></a></div></div></h1><p>A <b>FixedNumber</b> is a fixed-width (in bits) number with an internal base-10 divisor, which allows it to represent a decimal fractional component.</p>
|
|
|
|
<a name="/v5/api/utils/fixednumber/-%23-FixedNumber--creating-instances"></a><a name="/v5/api/utils/fixednumber/"></a><h2 class="show-anchors"><div>Creating Instances<div class="anchors"><a class="self" href="#/v5/api/utils/fixednumber/-%23-FixedNumber--creating-instances"></a></div></div></h2><p>The FixedNumber constructor cannot be called directly. There are several static methods for creating a FixedNumber.</p>
|
|
|
|
<div class="property show-anchors"><div class="signature"><span class="path">FixedNumber</span><span class="symbol">.</span><span class="method">from</span><span class="symbol">(</span> <span class="param">value</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">format</span> = "<span class="param">fixed</span>" <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/fixednumber/">FixedNumber</a></span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/bignumber/src.ts/fixednumber.ts#L339">source</a></div></div><div class="body"><p>Returns an instance of a <b>FixedNumber</b> for <i>value</i> as a <i>format</i>.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">FixedNumber</span><span class="symbol">.</span><span class="method">fromBytes</span><span class="symbol">(</span> <span class="param">aBytesLike</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">format</span> = "<span class="param">fixed</span>" <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/fixednumber/">FixedNumber</a></span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/bignumber/src.ts/fixednumber.ts#L321">source</a></div></div><div class="body"><p>Returns an instance of a <b>FixedNumber</b> for <i>value</i> as a <i>format</i>.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">FixedNumber</span><span class="symbol">.</span><span class="method">fromString</span><span class="symbol">(</span> <span class="param">value</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">format</span> = "<span class="param">fixed</span>" <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/fixednumber/">FixedNumber</a></span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/bignumber/src.ts/fixednumber.ts#L297">source</a></div></div><div class="body"><p>Returns an instance of a <b>FixedNumber</b> for <i>value</i> as a <i>format</i>. The <i>value</i> must not contain more decimals than the <i>format</i> permits.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">FixedNumber</span><span class="symbol">.</span><span class="method">fromValue</span><span class="symbol">(</span> <span class="param">value</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">decimals</span> = <span class="param">0</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">format</span> = "<span class="param">fixed</span>" <span class="symbol">]</span> <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/fixednumber/">FixedNumber</a></span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/bignumber/src.ts/fixednumber.ts#L283">source</a></div></div><div class="body"><p>Returns an instance of a <b>FixedNumber</b> for <i>value</i> with <i>decimals</i> as a <i>format</i>.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/fixednumber/-%23-FixedNumber--properties"></a><a name="/v5/api/utils/fixednumber/"></a><h2 class="show-anchors"><div>Properties<div class="anchors"><a class="self" href="#/v5/api/utils/fixednumber/-%23-FixedNumber--properties"></a></div></div></h2>
|
|
<div class="property show-anchors"><div class="signature"><span class="path">fixednumber</span><span class="symbol">.</span><span class="method">format</span><div class="anchors"></div></div><div class="body"><p>The <a href="#/v5/api/utils/fixednumber/-%23-FixedFormat">FixedFormat</a> of <i>fixednumber</i>.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/fixednumber/-%23-FixedNumber--methods"></a><a name="/v5/api/utils/fixednumber/"></a><h2 class="show-anchors"><div>Methods<div class="anchors"><a class="self" href="#/v5/api/utils/fixednumber/-%23-FixedNumber--methods"></a></div></div></h2>
|
|
<a name="/v5/api/utils/fixednumber/-%23-FixedNumber--methods--math-operations"></a><a name="/v5/api/utils/fixednumber/"></a><h3 class="show-anchors"><div>Math Operations<div class="anchors"><a class="self" href="#/v5/api/utils/fixednumber/-%23-FixedNumber--methods--math-operations"></a></div></div></h3>
|
|
<div class="property show-anchors"><div class="signature"><span class="path">fixednumber</span><span class="symbol">.</span><span class="method">addUnsafe</span><span class="symbol">(</span> <span class="param">otherValue</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/fixednumber/">FixedNumber</a></span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/bignumber/src.ts/fixednumber.ts#L215">source</a></div></div><div class="body"><p>Returns a new FixedNumber with the value of <i>fixedvalue</i> <b>+</b> <i>otherValue</i>.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">fixednumber</span><span class="symbol">.</span><span class="method">subUnsafe</span><span class="symbol">(</span> <span class="param">otherValue</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/fixednumber/">FixedNumber</a></span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/bignumber/src.ts/fixednumber.ts#L222">source</a></div></div><div class="body"><p>Returns a new FixedNumber with the value of <i>fixedvalue</i> <b>-</b> <i>otherValue</i>.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">fixednumber</span><span class="symbol">.</span><span class="method">mulUnsafe</span><span class="symbol">(</span> <span class="param">otherValue</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/fixednumber/">FixedNumber</a></span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/bignumber/src.ts/fixednumber.ts#L229">source</a></div></div><div class="body"><p>Returns a new FixedNumber with the value of <i>fixedvalue</i> <b>×</b> <i>otherValue</i>.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">fixednumber</span><span class="symbol">.</span><span class="method">divUnsafe</span><span class="symbol">(</span> <span class="param">otherValue</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/fixednumber/">FixedNumber</a></span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/bignumber/src.ts/fixednumber.ts#L236">source</a></div></div><div class="body"><p>Returns a new FixedNumber with the value of <i>fixedvalue</i> <b>÷</b> <i>otherValue</i>.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">fixednumber</span><span class="symbol">.</span><span class="method">round</span><span class="symbol">(</span> <span class="symbol">[</span> <span class="param">decimals</span> = <span class="param">0</span> <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/fixednumber/">FixedNumber</a></span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/bignumber/src.ts/fixednumber.ts#L244">source</a></div></div><div class="body"><p>Returns a new FixedNumber with the value of <i>fixedvalue</i> rounded to <i>decimals</i>.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/fixednumber/-%23-FixedNumber--methods--comparison-and-equivalence"></a><a name="/v5/api/utils/fixednumber/"></a><h3 class="show-anchors"><div>Comparison and Equivalence<div class="anchors"><a class="self" href="#/v5/api/utils/fixednumber/-%23-FixedNumber--methods--comparison-and-equivalence"></a></div></div></h3>
|
|
<div class="property show-anchors"><div class="signature"><span class="path">FixedNumber</span><span class="symbol">.</span><span class="method">isZero</span><span class="symbol">(</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">boolean</span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/bignumber/src.ts/fixednumber.ts#L262">source</a></div></div><div class="body"><p>Returns true if and only if the value of <i>FixedNumber</i> is zero.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/fixednumber/-%23-FixedNumber--methods--conversion"></a><a name="/v5/api/utils/fixednumber/"></a><h3 class="show-anchors"><div>Conversion<div class="anchors"><a class="self" href="#/v5/api/utils/fixednumber/-%23-FixedNumber--methods--conversion"></a></div></div></h3>
|
|
<div class="property show-anchors"><div class="signature"><span class="path">fixednumber</span><span class="symbol">.</span><span class="method">toFormat</span><span class="symbol">(</span> <span class="param">format</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/fixednumber/">FixedNumber</a></span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/bignumber/src.ts/fixednumber.ts#L278">source</a></div></div><div class="body"><p>Returns a new FixedNumber with the value of <i>fixedvalue</i> with <i>format</i>.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">fixednumber</span><span class="symbol">.</span><span class="method">toHexString</span><span class="symbol">(</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">string</span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/bignumber/src.ts/fixednumber.ts#L269">source</a></div></div><div class="body"><p>Returns a <a href="#/v5/api/utils/bytes/-%23-HexString">HexString</a> representation of <i>fixednumber</i>.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">fixednumber</span><span class="symbol">.</span><span class="method">toString</span><span class="symbol">(</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">string</span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/bignumber/src.ts/fixednumber.ts#L267">source</a></div></div><div class="body"><p>Returns a string representation of <i>fixednumber</i>.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">fixednumber</span><span class="symbol">.</span><span class="method">toUnsafeFloat</span><span class="symbol">(</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">float</span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/bignumber/src.ts/fixednumber.ts#L276">source</a></div></div><div class="body"><p>Returns a floating-point JavaScript number value of <i>fixednumber</i>. Due to rounding in JavaScript numbers, the value is only approximate.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/fixednumber/-%23-FixedNumber--methods--inspection"></a><a name="/v5/api/utils/fixednumber/"></a><h3 class="show-anchors"><div>Inspection<div class="anchors"><a class="self" href="#/v5/api/utils/fixednumber/-%23-FixedNumber--methods--inspection"></a></div></div></h3>
|
|
<div class="property show-anchors"><div class="signature"><span class="path">FixedNumber</span><span class="symbol">.</span><span class="method">isFixedNumber</span><span class="symbol">(</span> <span class="param">value</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">boolean</span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/bignumber/src.ts/fixednumber.ts#L360">source</a></div></div><div class="body"><p>Returns true if and only if <i>value</i> is a <b>FixedNumber</b>.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/fixednumber/-%23-FixedFormat"></a><a name="/v5/api/utils/fixednumber/-%23-FixedNumber--FixedFormat"></a><a name="/v5/api/utils/fixednumber/"></a><h2 class="show-anchors"><div>FixedFormat<div class="anchors"><a class="self" href="#/v5/api/utils/fixednumber/-%23-FixedFormat"></a></div></div></h2><p>A <b>FixedFormat</b> is a simple object which represents a decimal (base-10) Fixed-Point data representation. Usually using this class directly is uneccessary, as passing in a <a href="#/v5/api/utils/fixednumber/-%23-FixedFormat--strings">Format Strings</a> directly into the <a href="#/v5/api/utils/fixednumber/">FixedNumber</a> will automatically create this.</p>
|
|
|
|
<a name="/v5/api/utils/fixednumber/-%23-FixedFormat--strings"></a><a name="/v5/api/utils/fixednumber/-%23-FixedNumber--FixedFormat--FixedFormat--strings"></a><a name="/v5/api/utils/fixednumber/"></a><h3 class="show-anchors"><div>Format Strings<div class="anchors"><a class="self" href="#/v5/api/utils/fixednumber/-%23-FixedFormat--strings"></a></div></div></h3><p>A format string is composed of three components, including signed-ness, bit-width and number of decimals.</p>
|
|
|
|
<p>A signed format string begins with <code class="inline">fixed</code>, which an unsigned format string begins with <code class="inline">ufixed</code>, followed by the width (in bits) and the number of decimals.</p>
|
|
|
|
<p>The width must be conguent to 0 mod 8 (i.e. <code class="inline">(width % 8) == 0</code>) and no larger than 256 bits and the number of decimals must be no larger than 80.</p>
|
|
|
|
<p>For example:</p>
|
|
|
|
<p><ul><li><b>fixed128x18</b> is signed, 128 bits wide and has 18 decimals; this is useful for most purposes </li><li><b>fixed32x0</b> is signed, 32 bits wide and has 0 decimals; this would be the same as a <code class="inline">int32_t</code> in C </li><li><b>ufixed32x0</b> is unsigned, 32 bits wide and has 0 decimals; this would be the same as a <code class="inline">uint32_t</code> in C </li><li><b>fixed</b> is shorthand for <code class="inline">fixed128x18</code> </li><li><b>ufixed</b> is shorthand for <code class="inline">ufixed128x18</code> </li></ul></p>
|
|
|
|
<a name="/v5/api/utils/fixednumber/-%23-FixedNumber--FixedFormat--creating-instances"></a><a name="/v5/api/utils/fixednumber/"></a><h3 class="show-anchors"><div>Creating Instances<div class="anchors"><a class="self" href="#/v5/api/utils/fixednumber/-%23-FixedNumber--FixedFormat--creating-instances"></a></div></div></h3>
|
|
<a name="/v5/api/utils/fixednumber/-%23-FixedNumber-from"></a><div class="property show-anchors"><div class="signature"><span class="path">FixedFormat</span><span class="symbol">.</span><span class="method">from</span><span class="symbol">(</span> <span class="param">value</span> = "<span class="param">fixed128x18</span>" <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/fixednumber/-%23-FixedFormat">FixedFormat</a></span><div class="anchors"><a class="self" href="#/v5/api/utils/fixednumber/-%23-FixedNumber-from"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/bignumber/src.ts/fixednumber.ts#L140">source</a></div></div><div class="body"><p>Returns a new instance of a <b>FixedFormat</b> defined by <i>value</i>. Any valid <a href="#/v5/api/utils/fixednumber/-%23-FixedFormat--strings">Format Strings</a> may be passed in as well as any object which has any of <code class="inline">signed</code>, <code class="inline">width</code> and <code class="inline">decimals</code> defined, including a <a href="#/v5/api/utils/fixednumber/-%23-FixedFormat">FixedFormat</a> object.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/fixednumber/-%23-FixedNumber--FixedFormat--properties"></a><a name="/v5/api/utils/fixednumber/"></a><h3 class="show-anchors"><div>Properties<div class="anchors"><a class="self" href="#/v5/api/utils/fixednumber/-%23-FixedNumber--FixedFormat--properties"></a></div></div></h3>
|
|
<div class="property show-anchors"><div class="signature"><span class="path">fixedFormat</span><span class="symbol">.</span><span class="method">signed</span> <span class="arrow">⇒</span> <span class="returns">boolean</span><div class="anchors"></div></div><div class="body"><p>The signed-ness of <i>fixedFormat</i>, true if negative values are supported.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">fixedFormat</span><span class="symbol">.</span><span class="method">width</span> <span class="arrow">⇒</span> <span class="returns">number</span><div class="anchors"></div></div><div class="body"><p>The width (in bits) of <i>fixedFormat</i>.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">fixedFormat</span><span class="symbol">.</span><span class="method">decimals</span> <span class="arrow">⇒</span> <span class="returns">number</span><div class="anchors"></div></div><div class="body"><p>The number of decimal points of <i>fixedFormat</i>.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">fixedFormat</span><span class="symbol">.</span><span class="method">name</span> <span class="arrow">⇒</span> <span class="returns">string</span><div class="anchors"></div></div><div class="body"><p>The name of the <i>fixedFormat</i>, which can be used to recreate the format and is the string that the Solidity language uses to represent this format.</p>
|
|
|
|
</div></div><div class="definition"><div class="term"><b><i>"fixed"</i></b></div><div class="body"><p>A shorthand for <code class="inline">fixed128x80</code>.</p>
|
|
|
|
</div></div><div class="page-separator"></div><a name="/v5/api/utils/hashing/-%23-hashing-algorithms"></a><a name="/v5/api/utils/hashing/-%23-hashing-algorithms"></a><a name="/v5/api/utils/hashing/"></a><h1 class="show-anchors"><div>Hashing Algorithms<div class="anchors"><a class="self" href="#/v5/api/utils/hashing/-%23-hashing-algorithms"></a></div></div></h1><p>Explain what hash functions are?</p>
|
|
|
|
<a name="/v5/api/utils/hashing/-%23-cryptographic-hash-functions"></a><a name="/v5/api/utils/hashing/-%23-hashing-algorithms--cryptographic-hash-functions"></a><a name="/v5/api/utils/hashing/"></a><h2 class="show-anchors"><div>Cryptographic Hash Functions<div class="anchors"><a class="self" href="#/v5/api/utils/hashing/-%23-cryptographic-hash-functions"></a></div></div></h2><p>The <a href="https://en.wikipedia.org/wiki/Cryptographic_hash_function">Cryptographic Hash Functions</a> are a specific family of hash functions.</p>
|
|
|
|
<a name="/v5/api/utils/hashing/-%23-utils-id"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="method">id</span><span class="symbol">(</span> <span class="param">text</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a>< 32 > ></span><div class="anchors"><a class="self" href="#/v5/api/utils/hashing/-%23-utils-id"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/hash/src.ts/index.ts#L47">source</a></div></div><div class="body"><p>The Ethereum Identity function computs the <a href="https://en.wikipedia.org/wiki/SHA-3">KECCAK256</a> hash of the <i>text</i> bytes.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/hashing/-%23-utils-keccak256"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="method">keccak256</span><span class="symbol">(</span> <span class="param">aBytesLike</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a>< 32 > ></span><div class="anchors"><a class="self" href="#/v5/api/utils/hashing/-%23-utils-keccak256"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/keccak256/src.ts/index.ts#L7">source</a></div></div><div class="body"><p>Returns the <a href="https://en.wikipedia.org/wiki/SHA-3">KECCAK256</a> digest <i>aBytesLike</i>.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/hashing/-%23-utils-ripemd160"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="method">ripemd160</span><span class="symbol">(</span> <span class="param">aBytesLike</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a>< 20 > ></span><div class="anchors"><a class="self" href="#/v5/api/utils/hashing/-%23-utils-ripemd160"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/sha2/src.ts/index.ts#L14">source</a></div></div><div class="body"><p>Returns the <a href="https://en.m.wikipedia.org/wiki/RIPEMD">RIPEMD-160</a> digest of <i>aBytesLike</i>.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/hashing/-%23-utils-sha256"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="method">sha256</span><span class="symbol">(</span> <span class="param">aBytesLike</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a>< 32 > ></span><div class="anchors"><a class="self" href="#/v5/api/utils/hashing/-%23-utils-sha256"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/sha2/src.ts/index.ts#L18">source</a></div></div><div class="body"><p>Returns the <a href="https://en.wikipedia.org/wiki/SHA-2">SHA2-256</a> digest of <i>aBytesLike</i>.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/hashing/-%23-utils-sha512"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="method">sha512</span><span class="symbol">(</span> <span class="param">aBytesLike</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a>< 64 > ></span><div class="anchors"><a class="self" href="#/v5/api/utils/hashing/-%23-utils-sha512"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/sha2/src.ts/index.ts#L22">source</a></div></div><div class="body"><p>Returns the <a href="https://en.wikipedia.org/wiki/SHA-2">SHA2-512</a> digest of <i>aBytesLike</i>.</p>
|
|
|
|
</div></div><div class="code-title"><div>KECCAK256</div></div><div class="code">utils.keccak256([ 0x12, 0x34 ])
|
|
<span class="result ok">// '0x56570de287d73cd1cb6092bb8fdee6173974955fdef345ae579ee9f475ea7432'
|
|
</span>
|
|
utils.keccak256("0x")
|
|
<span class="result ok">// '0xc5d2460186f7233c927e7db2dcc703c0e500b653ca82273b7bfad8045d85a470'
|
|
</span>
|
|
utils.keccak256("0x1234")
|
|
<span class="result ok">// '0x56570de287d73cd1cb6092bb8fdee6173974955fdef345ae579ee9f475ea7432'
|
|
</span>
|
|
<span class="comment">// The value MUST be data, such as:
|
|
</span><span class="comment">// - an Array of numbers
|
|
</span><span class="comment">// - a data hex string (e.g. "0x1234")
|
|
</span><span class="comment">// - a Uint8Array
|
|
</span>
|
|
<span class="comment">// Do NOT use UTF-8 strings that are not a DataHexstring
|
|
</span>utils.keccak256("hello world")
|
|
<span class="result error">// Error: invalid arrayify value (argument="value", value="hello world", code=INVALID_ARGUMENT, version=bytes/5.0.1)
|
|
</span>
|
|
<span class="comment">// If needed, convert strings to bytes first:
|
|
</span>utils.keccak256(utils.toUtf8Bytes("hello world"))
|
|
<span class="result ok">// '0x47173285a8d7341e5e972fc677286384f802f8ef42a5ec5f03bbfa254cb01fad'
|
|
</span>
|
|
<span class="comment">// Or equivalently use the identity function:
|
|
</span>utils.id("hello world")
|
|
<span class="result ok">// '0x47173285a8d7341e5e972fc677286384f802f8ef42a5ec5f03bbfa254cb01fad'
|
|
</span>
|
|
<span class="comment">// Keep in mind that the string "0x1234" represents TWO
|
|
</span><span class="comment">// bytes (i.e. [ 0x12, 0x34 ]. If you wish to compute the
|
|
</span><span class="comment">// hash of the 6 characters "0x1234", convert it to UTF-8
|
|
</span><span class="comment">// bytes first using utils.toUtf8Bytes.
|
|
</span>
|
|
<span class="comment">// Consider the following examples:
|
|
</span>
|
|
<span class="comment">// Hash of TWO (2) bytes:
|
|
</span>utils.keccak256("0x1234")
|
|
<span class="result ok">// '0x56570de287d73cd1cb6092bb8fdee6173974955fdef345ae579ee9f475ea7432'
|
|
</span>
|
|
<span class="comment">// Hash of TWO (2) bytes: (same result)
|
|
</span>utils.keccak256([ 0x12, 0x34 ])
|
|
<span class="result ok">// '0x56570de287d73cd1cb6092bb8fdee6173974955fdef345ae579ee9f475ea7432'
|
|
</span>
|
|
const bytes = utils.toUtf8Bytes("0x1234");
|
|
<span class="result ok">// Uint8Array [ 48, 120, 49, 50, 51, 52 ]
|
|
</span>
|
|
<span class="comment">// Hash of SIX (6) characters (different than above)
|
|
</span>utils.keccak256(bytes)
|
|
<span class="result ok">// '0x1ac7d1b81b7ba1025b36ccb86723da6ee5a87259f1c2fd5abe69d3200b512ec8'
|
|
</span>
|
|
<span class="comment">// Hash of SIX (6) characters (same result)
|
|
</span>utils.id("0x1234")
|
|
<span class="result ok">// '0x1ac7d1b81b7ba1025b36ccb86723da6ee5a87259f1c2fd5abe69d3200b512ec8'
|
|
</span></div><div class="code-title"><div>RIPEMD160</div></div><div class="code">utils.ripemd160("0x")
|
|
<span class="result ok">// '0x9c1185a5c5e9fc54612808977ee8f548b2258d31'
|
|
</span>
|
|
utils.ripemd160("0x1234")
|
|
<span class="result ok">// '0xc39867e393cb061b837240862d9ad318c176a96d'
|
|
</span></div><div class="code-title"><div>SHA-2</div></div><div class="code">utils.sha256("0x")
|
|
<span class="result ok">// '0xe3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855'
|
|
</span>
|
|
utils.sha256("0x1234")
|
|
<span class="result ok">// '0x3a103a4e5729ad68c02a678ae39accfbc0ae208096437401b7ceab63cca0622f'
|
|
</span>
|
|
utils.sha512("0x")
|
|
<span class="result ok">// '0xcf83e1357eefb8bdf1542850d66d8007d620e4050b5715dc83f4a921d36ce9ce47d0d13c5d85f2b0ff8318d2877eec2f63b931bd47417a81a538327af927da3e'
|
|
</span>
|
|
utils.sha512("0x1234")
|
|
<span class="result ok">// '0x4c54886c9821195522d88ff4705c3e0c686b921054421e6ea598739c29c26e1ee75419aaceec94dd2e3c0dbb82ecf895c9f61215f375de6d800d9b99d3d4b816'
|
|
</span></div><a name="/v5/api/utils/hashing/-%23-utils--hmac"></a><a name="/v5/api/utils/hashing/-%23-hashing-algorithms--utils--hmac"></a><a name="/v5/api/utils/hashing/"></a><h2 class="show-anchors"><div>HMAC<div class="anchors"><a class="self" href="#/v5/api/utils/hashing/-%23-utils--hmac"></a></div></div></h2>
|
|
<a name="/v5/api/utils/hashing/-%23-utils-computeHmac"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="method">computeHmac</span><span class="symbol">(</span> <span class="param">algorithm</span> <span class="symbol">,</span> <span class="param">key</span> <span class="symbol">,</span> <span class="param">data</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a> ></span><div class="anchors"><a class="self" href="#/v5/api/utils/hashing/-%23-utils-computeHmac"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/sha2/src.ts/index.ts#L27">source</a></div></div><div class="body"><p>Returns the <a href="https://en.wikipedia.org/wiki/HMAC">HMAC</a> of <i>data</i> with <i>key</i> using the <a href="#/v5/api/utils/hashing/-%23-utils--hmac-supported-algorithm">Algorithm</a> <i>algorithm</i>.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/hashing/-%23-utils--hmac-supported-algorithm"></a><a name="/v5/api/utils/hashing/-%23-hashing-algorithms--utils--hmac--utils--hmac-supported-algorithm"></a><a name="/v5/api/utils/hashing/"></a><h3 class="show-anchors"><div><b>HMAC Supported Algorithms</b><div class="anchors"><a class="self" href="#/v5/api/utils/hashing/-%23-utils--hmac-supported-algorithm"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/sha2/src.ts/index.ts#L11">source</a></div></div></h3>
|
|
<div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="path">SupportedAlgorithm</span><span class="symbol">.</span><span class="method">sha256</span> <span class="arrow">⇒</span> <span class="returns">string</span><div class="anchors"></div></div><div class="body"><p>Use the <a href="https://en.wikipedia.org/wiki/SHA-2">SHA2-256</a> hash algorithm.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="path">SupportedAlgorithm</span><span class="symbol">.</span><span class="method">sha512</span> <span class="arrow">⇒</span> <span class="returns">string</span><div class="anchors"></div></div><div class="body"><p>Use the <a href="https://en.wikipedia.org/wiki/SHA-2">SHA2-512</a> hash algorithm.</p>
|
|
|
|
</div></div><div class="code-title"><div>HMAC</div></div><div class="code">const key = "0x0102";
|
|
const data = "0x1234";
|
|
utils.computeHmac("sha256", key, data)
|
|
<span class="result ok">// '0x7553df81c628815cf569696cad13a37c606c5058df13d9dff4fee2cf5e9b5779'
|
|
</span></div><a name="/v5/api/utils/hashing/-%23-utils--hashing-helpers"></a><a name="/v5/api/utils/hashing/-%23-hashing-algorithms--utils--hashing-helpers"></a><a name="/v5/api/utils/hashing/"></a><h2 class="show-anchors"><div>Hashing Helpers<div class="anchors"><a class="self" href="#/v5/api/utils/hashing/-%23-utils--hashing-helpers"></a></div></div></h2>
|
|
<a name="/v5/api/utils/hashing/-%23-utils-hashMessage"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="method">hashMessage</span><span class="symbol">(</span> <span class="param">message</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a>< 32 > ></span><div class="anchors"><a class="self" href="#/v5/api/utils/hashing/-%23-utils-hashMessage"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/hash/src.ts/index.ts#L53">source</a></div></div><div class="body"><p>Computes the <a href="https://eips.ethereum.org/EIPS/eip-191">EIP-191</a> personal message digest of <i>message</i>. Personal messages are converted to UTF-8 bytes and prefixed with <code class="inline">\x19Ethereum Signed Message:</code> and the length of <i>message</i>.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/hashing/-%23-utils-namehash"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="method">namehash</span><span class="symbol">(</span> <span class="param">name</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a>< 32 > ></span><div class="anchors"><a class="self" href="#/v5/api/utils/hashing/-%23-utils-namehash"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/hash/src.ts/index.ts#L29">source</a></div></div><div class="body"><p>Returns the <a href="https://docs.ens.domains/contract-api-reference/name-processing#hashing-names">ENS Namehash</a> of <i>name</i>.</p>
|
|
|
|
</div></div><div class="code-title"><div>Hashing Messages</div></div><div class="code"><span class="comment">// @TODO: include examples of hashMessage; it can be complex. :)
|
|
</span></div><div class="code-title"><div>Namehash</div></div><div class="code">utils.namehash("")
|
|
<span class="result ok">// '0x0000000000000000000000000000000000000000000000000000000000000000'
|
|
</span>
|
|
utils.namehash("eth")
|
|
<span class="result ok">// '0x93cdeb708b7545dc668eb9280176169d1c33cfd8ed6f04690a0bcc88a93fc4ae'
|
|
</span>
|
|
utils.namehash("ricmoo.firefly.eth")
|
|
<span class="result ok">// '0x0bcad17ecf260d6506c6b97768bdc2acfb6694445d27ffd3f9c1cfbee4a9bd6d'
|
|
</span>
|
|
utils.namehash("ricmoo.xyz")
|
|
<span class="result ok">// '0x7d56aa46358ba2f8b77d8e05bcabdd2358370dcf34e87810f8cea77ecb3fc57d'
|
|
</span></div><a name="/v5/api/utils/hashing/-%23-utils--solidity-hashing"></a><a name="/v5/api/utils/hashing/-%23-hashing-algorithms--utils--solidity-hashing"></a><a name="/v5/api/utils/hashing/"></a><h2 class="show-anchors"><div>Solidity Hashing Algorithms<div class="anchors"><a class="self" href="#/v5/api/utils/hashing/-%23-utils--solidity-hashing"></a></div></div></h2><p>When using the Solidity <code class="inline">abi.packEncoded(...)</code> function, a non-standard <i>tightly packed</i> version of encoding is used. These functions implement the tightly packing algorithm.</p>
|
|
|
|
<a name="/v5/api/utils/hashing/-%23-utils-solidityPack"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="method">solidityPack</span><span class="symbol">(</span> <span class="param">types</span> <span class="symbol">,</span> <span class="param">values</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a> ></span><div class="anchors"><a class="self" href="#/v5/api/utils/hashing/-%23-utils-solidityPack"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/solidity/src.ts/index.ts#L73">source</a></div></div><div class="body"><p>Returns the non-standard encoded <i>values</i> packed according to their respecive type in <i>types</i>.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/hashing/-%23-utils-solidityKeccak256"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="method">solidityKeccak256</span><span class="symbol">(</span> <span class="param">types</span> <span class="symbol">,</span> <span class="param">values</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a>< 32 > ></span><div class="anchors"><a class="self" href="#/v5/api/utils/hashing/-%23-utils-solidityKeccak256"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/solidity/src.ts/index.ts#L82">source</a></div></div><div class="body"><p>Returns the <a href="https://en.wikipedia.org/wiki/SHA-3">KECCAK256</a> of the non-standard encoded <i>values</i> packed according to their respective type in <i>types</i>.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/hashing/-%23-utils-soliditySha256"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="method">soliditySha256</span><span class="symbol">(</span> <span class="param">types</span> <span class="symbol">,</span> <span class="param">values</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a>< 32 > ></span><div class="anchors"><a class="self" href="#/v5/api/utils/hashing/-%23-utils-soliditySha256"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/solidity/src.ts/index.ts#L86">source</a></div></div><div class="body"><p>Returns the <a href="https://en.wikipedia.org/wiki/SHA-2">SHA2-256</a> of the non-standard encoded <i>values</i> packed according to their respective type in <i>types</i>.</p>
|
|
|
|
</div></div><div class="code-title"><div>Solidity Hashing</div></div><div class="code">utils.solidityPack([ "int16", "uint48" ], [ -1, 12 ])
|
|
<span class="result ok">// '0xffff00000000000c'
|
|
</span>
|
|
utils.solidityPack([ "string", "uint8" ], [ "Hello", 3 ])
|
|
<span class="result ok">// '0x48656c6c6f03'
|
|
</span>
|
|
utils.solidityKeccak256([ "int16", "uint48" ], [ -1, 12 ])
|
|
<span class="result ok">// '0x81da7abb5c9c7515f57dab2fc946f01217ab52f3bd8958bc36bd55894451a93c'
|
|
</span>
|
|
utils.soliditySha256([ "int16", "uint48" ], [ -1, 12 ])
|
|
<span class="result ok">// '0xa5580fb602f6e2ba9c588011dc4e6c2335e0f5d970dc45869db8f217efc6911a'
|
|
</span></div><div class="page-separator"></div><a name="/v5/api/utils/hdnode/-%23-hdnodes"></a><a name="/v5/api/utils/hdnode/-%23-hdnodes"></a><a name="/v5/api/utils/hdnode/"></a><h1 class="show-anchors"><div>HD Wallet<div class="anchors"><a class="self" href="#/v5/api/utils/hdnode/-%23-hdnodes"></a></div></div></h1><p>TODO: Explain <a href="https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki">BIP32</a> <a href="https://en.bitcoin.it/wiki/BIP_0039">BIP-39</a> and whatnot here...</p>
|
|
|
|
<a name="/v5/api/utils/hdnode/-%23-hdnodes--types"></a><a name="/v5/api/utils/hdnode/"></a><h2 class="show-anchors"><div>Types<div class="anchors"><a class="self" href="#/v5/api/utils/hdnode/-%23-hdnodes--types"></a></div></div></h2>
|
|
<a name="/v5/api/utils/hdnode/-%23-hdnodes--defaultpath"></a><a name="/v5/api/utils/hdnode/-%23-hdnodes--types--hdnodes--defaultpath"></a><a name="/v5/api/utils/hdnode/"></a><h3 class="show-anchors"><div>Constants<div class="anchors"><a class="self" href="#/v5/api/utils/hdnode/-%23-hdnodes--defaultpath"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/hdnode/src.ts/index.ts#L67">source</a></div></div></h3>
|
|
<div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="method">defaultPath</span> <span class="arrow">⇒</span> <span class="returns">"m/44'/60'/0'/0/0"</span><div class="anchors"></div></div><div class="body"><p>The default path for Ethereum in an HD Wallet</p>
|
|
|
|
</div></div><a name="/v5/api/utils/hdnode/-%23-Mnemonic"></a><a name="/v5/api/utils/hdnode/-%23-hdnodes--types--Mnemonic"></a><a name="/v5/api/utils/hdnode/"></a><h3 class="show-anchors"><div>Mnemonic<div class="anchors"><a class="self" href="#/v5/api/utils/hdnode/-%23-Mnemonic"></a></div></div></h3>
|
|
<div class="property show-anchors"><div class="signature"><span class="path">mnemonic</span><span class="symbol">.</span><span class="method">phrase</span> <span class="arrow">⇒</span> <span class="returns">string</span><div class="anchors"></div></div><div class="body"><p>The mnemonic phrase for this mnemonic. It is 12, 15, 18, 21 or 24 words long and separated by the whitespace specified by the <code class="inline">locale</code>.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">mnemonic</span><span class="symbol">.</span><span class="method">path</span> <span class="arrow">⇒</span> <span class="returns">string</span><div class="anchors"></div></div><div class="body"><p>The HD path for this mnemonic.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">mnemonic</span><span class="symbol">.</span><span class="method">locale</span> <span class="arrow">⇒</span> <span class="returns">string</span><div class="anchors"></div></div><div class="body"><p>The language of the wordlist this mnemonic is using.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/hdnode/-%23-HDNode"></a><a name="/v5/api/utils/hdnode/-%23-hdnodes--HDNode"></a><a name="/v5/api/utils/hdnode/"></a><h2 class="show-anchors"><div>HDNode<div class="anchors"><a class="self" href="#/v5/api/utils/hdnode/-%23-HDNode"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/hdnode/src.ts/index.ts#L75">source</a></div></div></h2>
|
|
<a name="/v5/api/utils/hdnode/-%23-HDNode--creating"></a><a name="/v5/api/utils/hdnode/-%23-hdnodes--HDNode--HDNode--creating"></a><a name="/v5/api/utils/hdnode/"></a><h3 class="show-anchors"><div>Creating Instances<div class="anchors"><a class="self" href="#/v5/api/utils/hdnode/-%23-HDNode--creating"></a></div></div></h3>
|
|
<a name="/v5/api/utils/hdnode/-%23-HDNode-fromMnemonic"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">HDNode</span><span class="symbol">.</span><span class="method">fromMnemonic</span><span class="symbol">(</span> <span class="param">phrase</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">password</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">wordlist</span> <span class="symbol">]</span> <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/hdnode/-%23-HDNode">HDNode</a></span><div class="anchors"><a class="self" href="#/v5/api/utils/hdnode/-%23-HDNode-fromMnemonic"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/hdnode/src.ts/index.ts#L262">source</a></div></div><div class="body"><p>Return the <a href="#/v5/api/utils/hdnode/-%23-HDNode">HDNode</a> for <i>phrase</i> with the optional <i>password</i> and <i>wordlist</i>.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/hdnode/-%23-HDNode-fromSeed"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">HDNode</span><span class="symbol">.</span><span class="method">fromSeed</span><span class="symbol">(</span> <span class="param">aBytesLike</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/hdnode/-%23-HDNode">HDNode</a></span><div class="anchors"><a class="self" href="#/v5/api/utils/hdnode/-%23-HDNode-fromSeed"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/hdnode/src.ts/index.ts#L277">source</a></div></div><div class="body"><p>Return the <a href="#/v5/api/utils/hdnode/-%23-HDNode">HDNode</a> for the seed <i>aBytesLike</i>.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/hdnode/-%23-HDNode-fromExtendedKey"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">HDNode</span><span class="symbol">.</span><span class="method">fromExtendedKey</span><span class="symbol">(</span> <span class="param">extendedKey</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/hdnode/-%23-HDNode">HDNode</a></span><div class="anchors"><a class="self" href="#/v5/api/utils/hdnode/-%23-HDNode-fromExtendedKey"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/hdnode/src.ts/index.ts#L281">source</a></div></div><div class="body"><p>Return the <a href="#/v5/api/utils/hdnode/-%23-HDNode">HDNode</a> for the <i>extendedKey</i>. If <i>extendedKey</i> was neutered, the <b>HDNode</b> will only be able to compute addresses and not private keys.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/hdnode/-%23-HDNode--properties"></a><a name="/v5/api/utils/hdnode/-%23-hdnodes--HDNode--HDNode--properties"></a><a name="/v5/api/utils/hdnode/"></a><h3 class="show-anchors"><div>Properties<div class="anchors"><a class="self" href="#/v5/api/utils/hdnode/-%23-HDNode--properties"></a></div></div></h3>
|
|
<div class="property show-anchors"><div class="signature"><span class="path">hdNode</span><span class="symbol">.</span><span class="method">privateKey</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a>< 32 > ></span><div class="anchors"></div></div><div class="body"><p>The private key for this HDNode.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">hdNode</span><span class="symbol">.</span><span class="method">publicKey</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a>< 33 > ></span><div class="anchors"></div></div><div class="body"><p>The (compresses) public key for this HDNode.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">hdNode</span><span class="symbol">.</span><span class="method">fingerprint</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a>< 4 > ></span><div class="anchors"></div></div><div class="body"><p>The fingerprint is meant as an index to quickly match parent and children nodes together, however collisions may occur and software should verify matching nodes.</p>
|
|
|
|
<p>Most developers will not need to use this.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">hdNode</span><span class="symbol">.</span><span class="method">parentFingerprint</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a>< 4 > ></span><div class="anchors"></div></div><div class="body"><p>The fingerprint of the parent node. See <i>fingerprint</i> for more details.</p>
|
|
|
|
<p>Most developers will not need to use this.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">hdNode</span><span class="symbol">.</span><span class="method">address</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/address/-%23-address">Address</a> ></span><div class="anchors"></div></div><div class="body"><p>The address of this HDNode.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">hdNode</span><span class="symbol">.</span><span class="method">mnemonic</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/hdnode/-%23-Mnemonic">Mnemonic</a></span><div class="anchors"></div></div><div class="body"><p>The mnemonic of this HDNode, if known.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">hdNode</span><span class="symbol">.</span><span class="method">path</span> <span class="arrow">⇒</span> <span class="returns">string</span><div class="anchors"></div></div><div class="body"><p>The path of this HDNode, if known. If the <i>mnemonic</i> is also known, this will match <code class="inline">mnemonic.path</code>.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">hdNode</span><span class="symbol">.</span><span class="method">chainCode</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a>< 32 > ></span><div class="anchors"></div></div><div class="body"><p>The chain code is used as a non-secret private key which is then used with EC-multiply to provide the ability to derive addresses without the private key of child non-hardened nodes.</p>
|
|
|
|
<p>Most developers will not need to use this.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">hdNode</span><span class="symbol">.</span><span class="method">index</span> <span class="arrow">⇒</span> <span class="returns">number</span><div class="anchors"></div></div><div class="body"><p>The index of this HDNode. This will match the last component of the <i>path</i>.</p>
|
|
|
|
<p>Most developers will not need to use this.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">hdNode</span><span class="symbol">.</span><span class="method">depth</span> <span class="arrow">⇒</span> <span class="returns">number</span><div class="anchors"></div></div><div class="body"><p>The depth of this HDNode. This will match the number of components (less one, the <code class="inline">m/</code>) of the <i>path</i>.</p>
|
|
|
|
<p>Most developers will not need to use this.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">hdNode</span><span class="symbol">.</span><span class="method">extendedKey</span> <span class="arrow">⇒</span> <span class="returns">string</span><div class="anchors"></div></div><div class="body"><p>A serialized string representation of this HDNode. Not all properties are included in the serialization, such as the mnemonic and path, so serializing and deserializing (using the <code class="inline">fromExtendedKey</code> class method) will result in reduced information.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/hdnode/-%23-HDNode--methods"></a><a name="/v5/api/utils/hdnode/-%23-hdnodes--HDNode--HDNode--methods"></a><a name="/v5/api/utils/hdnode/"></a><h3 class="show-anchors"><div>Methods<div class="anchors"><a class="self" href="#/v5/api/utils/hdnode/-%23-HDNode--methods"></a></div></div></h3>
|
|
<a name="/v5/api/utils/hdnode/-%23-HDNode-neuter"></a><div class="property show-anchors"><div class="signature"><span class="path">hdNode</span><span class="symbol">.</span><span class="method">neuter</span><span class="symbol">(</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/hdnode/-%23-HDNode">HDNode</a></span><div class="anchors"><a class="self" href="#/v5/api/utils/hdnode/-%23-HDNode-neuter"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/hdnode/src.ts/index.ts#L161">source</a></div></div><div class="body"><p>Return a new instance of <i>hdNode</i> with its private key removed but all otehr properties preserved. This ensures that the key can not leak the private key of itself or any derived children, but may still be used to compute the addresses of itself and any non-hardened children.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/hdnode/-%23-HDNode-derivePath"></a><div class="property show-anchors"><div class="signature"><span class="path">hdNode</span><span class="symbol">.</span><span class="method">derivePath</span><span class="symbol">(</span> <span class="param">path</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/hdnode/-%23-HDNode">HDNode</a></span><div class="anchors"><a class="self" href="#/v5/api/utils/hdnode/-%23-HDNode-derivePath"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/hdnode/src.ts/index.ts#L224">source</a></div></div><div class="body"><p>Return a new <a href="#/v5/api/utils/hdnode/-%23-HDNode">HDNode</a> which is the child of <i>hdNode</i> found by deriving <i>path</i>.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/hdnode/-%23-HDNode--utilities"></a><a name="/v5/api/utils/hdnode/-%23-hdnodes--HDNode--utilities"></a><a name="/v5/api/utils/hdnode/"></a><h2 class="show-anchors"><div>Other Functions<div class="anchors"><a class="self" href="#/v5/api/utils/hdnode/-%23-HDNode--utilities"></a></div></div></h2>
|
|
<a name="/v5/api/utils/hdnode/-%23-utils-mnemonicToSeed"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="method">mnemonicToSeed</span><span class="symbol">(</span> <span class="param">phrase</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">password</span> <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a>< 64 > ></span><div class="anchors"><a class="self" href="#/v5/api/utils/hdnode/-%23-utils-mnemonicToSeed"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/hdnode/src.ts/index.ts#L309">source</a></div></div><div class="body"><p>Convert a mnemonic phrase to a seed, according to <a href="https://en.bitcoin.it/wiki/BIP_0039">BIP-39</a>.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/hdnode/-%23-utils-mnemonicToEntropy"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="method">mnemonicToEntropy</span><span class="symbol">(</span> <span class="param">phrase</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">wordlist</span> <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a> ></span><div class="anchors"><a class="self" href="#/v5/api/utils/hdnode/-%23-utils-mnemonicToEntropy"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/hdnode/src.ts/index.ts#L317">source</a></div></div><div class="body"><p>Convert a mnemonic phrase to its entropy, according to <a href="https://en.bitcoin.it/wiki/BIP_0039">BIP-39</a>.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/hdnode/-%23-utils-isValidMnemonic"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="method">isValidMnemonic</span><span class="symbol">(</span> <span class="param">phrase</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">wordlist</span> <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">boolean</span><div class="anchors"><a class="self" href="#/v5/api/utils/hdnode/-%23-utils-isValidMnemonic"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/hdnode/src.ts/index.ts#L398">source</a></div></div><div class="body"><p>Returns true if <i>phrase</i> is a valid mnemonic phrase, by testing the checksum.</p>
|
|
|
|
</div></div><div class="page-separator"></div><a name="/v5/api/utils/logger/-%23-logging"></a><a name="/v5/api/utils/logger/-%23-logging"></a><a name="/v5/api/utils/logger/"></a><h1 class="show-anchors"><div>Logging<div class="anchors"><a class="self" href="#/v5/api/utils/logger/-%23-logging"></a></div></div></h1><p>These are just a few simple logging utilities provided to simplify and standardize the error facilities across the Ethers library.</p>
|
|
|
|
<p>The <a href="#/v5/api/utils/logger/-%23-Logger">Logger</a> library has zero dependencies and is intentionally very light so it can be easily included in each library.</p>
|
|
|
|
<p>The <a href="#/v5/api/utils/logger/-%23-Logger--censorship">Censorship</a> functionality relies on one instance of the Ethers library being included. In large bundled packages or when <code class="inline">npm link</code> is used, this may not be the case. If you require this functionality, ensure that your bundling is configured properly.</p>
|
|
|
|
<a name="/v5/api/utils/logger/-%23-Logger"></a><a name="/v5/api/utils/logger/-%23-logging--Logger"></a><a name="/v5/api/utils/logger/"></a><h2 class="show-anchors"><div>Logger<div class="anchors"><a class="self" href="#/v5/api/utils/logger/-%23-Logger"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/logger/src.ts/index.ts#L143">source</a></div></div></h2>
|
|
<div class="property show-anchors"><div class="signature"><span class="modifier">new </span><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="method">Logger</span><span class="symbol">(</span> <span class="param">version</span> <span class="symbol">)</span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/logger/src.ts/index.ts#L150">source</a></div></div><div class="body"><p>Create a new logger which will include <i>version</i> in all errors thrown.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">Logger</span><span class="symbol">.</span><span class="method">globalLogger</span><span class="symbol">(</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/logger/-%23-Logger">Logger</a></span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/logger/src.ts/index.ts#L298">source</a></div></div><div class="body"><p>Returns the singleton global logger.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/logger/-%23-logging--Logger--logging-output"></a><a name="/v5/api/utils/logger/"></a><h3 class="show-anchors"><div>Logging Output<div class="anchors"><a class="self" href="#/v5/api/utils/logger/-%23-logging--Logger--logging-output"></a></div></div></h3>
|
|
<div class="property show-anchors"><div class="signature"><span class="path">logger</span><span class="symbol">.</span><span class="method">debug</span><span class="symbol">(</span> ...<span class="param">args</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">void</span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/logger/src.ts/index.ts#L167">source</a></div></div><div class="body"><p>Log debugging information.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">logger</span><span class="symbol">.</span><span class="method">info</span><span class="symbol">(</span> ...<span class="param">args</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">void</span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/logger/src.ts/index.ts#L171">source</a></div></div><div class="body"><p>Log generic information.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">logger</span><span class="symbol">.</span><span class="method">warn</span><span class="symbol">(</span> ...<span class="param">args</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">void</span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/logger/src.ts/index.ts#L175">source</a></div></div><div class="body"><p>Log warnings.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/logger/-%23-logging--Logger--errors"></a><a name="/v5/api/utils/logger/"></a><h3 class="show-anchors"><div>Errors<div class="anchors"><a class="self" href="#/v5/api/utils/logger/-%23-logging--Logger--errors"></a></div></div></h3><p>These functions honor the current <a href="#/v5/api/utils/logger/-%23-Logger--censorship">Censorship</a> and help create a standard error model for detecting and processing errors within Ethers.</p>
|
|
|
|
<div class="property show-anchors"><div class="signature"><span class="path">logger</span><span class="symbol">.</span><span class="method">makeError</span><span class="symbol">(</span> <span class="param">message</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">code</span> = <span class="param">UNKNOWN_ERROR</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">params</span> <span class="symbol">]</span> <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Error</span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/logger/src.ts/index.ts#L179">source</a></div></div><div class="body"><p>Create an Error object with <i>message</i> and an optional <i>code</i> and additional <i>params</i> set. This is useful when an error is needed to be rejected instead of thrown.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">logger</span><span class="symbol">.</span><span class="method">throwError</span><span class="symbol">(</span> <span class="param">message</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">code</span> = <span class="param">UNKNOWN_ERROR</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">params</span> <span class="symbol">]</span> <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">never</span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/logger/src.ts/index.ts#L216">source</a></div></div><div class="body"><p>Throw an Error with <i>message</i> and an optional <i>code</i> and additional <i>params</i> set.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">logger</span><span class="symbol">.</span><span class="method">throwArgumentError</span><span class="symbol">(</span> <span class="param">message</span> <span class="symbol">,</span> <span class="param">name</span> <span class="symbol">,</span> <span class="param">value</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">never</span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/logger/src.ts/index.ts#L220">source</a></div></div><div class="body"><p>Throw an <a href="#/v5/api/utils/logger/-%23-errors-InvalidArgument">INVALID_ARGUMENT</a> Error with <i>name</i> and <i>value</i>.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/logger/-%23-logging--Logger--usage-validation"></a><a name="/v5/api/utils/logger/"></a><h3 class="show-anchors"><div>Usage Validation<div class="anchors"><a class="self" href="#/v5/api/utils/logger/-%23-logging--Logger--usage-validation"></a></div></div></h3><p>There can be used to ensure various properties and actions are safe.</p>
|
|
|
|
<div class="property show-anchors"><div class="signature"><span class="path">logger</span><span class="symbol">.</span><span class="method">checkAbstract</span><span class="symbol">(</span> <span class="param">target</span> <span class="symbol">,</span> <span class="param">kind</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">void</span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/logger/src.ts/index.ts#L286">source</a></div></div><div class="body"><p>Checks that <i>target</i> is not <i>kind</i> and performs the same operatons as <code class="inline">checkNew</code>. This is useful for ensuring abstract classes are not being instantiated.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">logger</span><span class="symbol">.</span><span class="method">checkArgumentCount</span><span class="symbol">(</span> <span class="param">count</span> <span class="symbol">,</span> <span class="param">expectedCound</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">message</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">void</span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/logger/src.ts/index.ts#L258">source</a></div></div><div class="body"><p>If <i>count</i> is not equal to <i>expectedCount</i>, throws a <a href="#/v5/api/utils/logger/-%23-errors-MissingArgument">MISSING_ARGUMENT</a> or <a href="#/v5/api/utils/logger/-%23-errors-UnexpectedArgument">UNEXPECTED_ARGUMENT</a> error.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">logger</span><span class="symbol">.</span><span class="method">checkNew</span><span class="symbol">(</span> <span class="param">target</span> <span class="symbol">,</span> <span class="param">kind</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">void</span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/logger/src.ts/index.ts#L280">source</a></div></div><div class="body"><p>If <i>target</i> is not a valid <code class="inline">this</code> or <code class="inline">target</code> value, throw a <a href="#/v5/api/utils/logger/-%23-errors-MissingNew">MISSING_NEW</a> error. This is useful to ensure callers of a Class are using <code class="inline">new</code>.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">logger</span><span class="symbol">.</span><span class="method">checkNormalize</span><span class="symbol">(</span> <span class="param">message</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">void</span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/logger/src.ts/index.ts#L227">source</a></div></div><div class="body"><p>Check that the environment has a correctly functioning <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/normalize">String.normalize</a>. If not, a <a href="#/v5/api/utils/logger/-%23-errors-UnsupportedOperation">UNSUPPORTED_OPERATION</a> error is thrown.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">logger</span><span class="symbol">.</span><span class="method">checkSafeUint53</span><span class="symbol">(</span> <span class="param">value</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">message</span> <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">void</span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/logger/src.ts/index.ts#L236">source</a></div></div><div class="body"><p>If <i>value</i> is not safe as a <a href="https://en.wikipedia.org/wiki/Double-precision_floating-point_format">JavaScript number</a>, throws a <a href="#/v5/api/utils/logger/-%23-errors-NumericFault">NUMERIC_FAULT</a> error.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/logger/-%23-Logger--censorship"></a><a name="/v5/api/utils/logger/-%23-logging--Logger--Logger--censorship"></a><a name="/v5/api/utils/logger/"></a><h3 class="show-anchors"><div>Censorship<div class="anchors"><a class="self" href="#/v5/api/utils/logger/-%23-Logger--censorship"></a></div></div></h3>
|
|
<div class="property show-anchors"><div class="signature"><span class="path">Logger</span><span class="symbol">.</span><span class="method">setCensorship</span><span class="symbol">(</span> <span class="param">censor</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">permanent</span> = <span class="param">false</span> <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">void</span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/logger/src.ts/index.ts#L303">source</a></div></div><div class="body"><p>Set error censorship, optionally preventing errors from being uncensored.</p>
|
|
|
|
<p>In production applications, this prevents any error from leaking information by masking the message and values of errors.</p>
|
|
|
|
<p>This can impact debugging, making it substantially more difficult.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">Logger</span><span class="symbol">.</span><span class="method">setLogLevel</span><span class="symbol">(</span> <span class="param">logLevel</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">void</span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/logger/src.ts/index.ts#L321">source</a></div></div><div class="body"><p>Set the log level, to suppress logging output below a <a href="#/v5/api/utils/logger/-%23-Logger-levels">particular log level</a>.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/logger/-%23-errors"></a><a name="/v5/api/utils/logger/-%23-logging--errors"></a><a name="/v5/api/utils/logger/"></a><h2 class="show-anchors"><div>Errors<div class="anchors"><a class="self" href="#/v5/api/utils/logger/-%23-errors"></a></div></div></h2><p>Every error in Ethers has a <code class="inline">code</code> value, which is a string that will match one of the following error codes.</p>
|
|
|
|
<a name="/v5/api/utils/logger/-%23-logging--errors--generic-error-codes"></a><a name="/v5/api/utils/logger/"></a><h3 class="show-anchors"><div>Generic Error Codes<div class="anchors"><a class="self" href="#/v5/api/utils/logger/-%23-logging--errors--generic-error-codes"></a></div></div></h3>
|
|
<div class="property show-anchors"><div class="signature"><span class="path">Logger</span><span class="symbol">.</span><span class="path">errors</span><span class="symbol">.</span><span class="method">NOT_IMPLEMENTED</span><div class="anchors"></div></div><div class="body"><p>The operation is not implemented.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">Logger</span><span class="symbol">.</span><span class="path">errors</span><span class="symbol">.</span><span class="method">SERVER_ERROR</span><div class="anchors"></div></div><div class="body"><p>There was an error communicating with a server.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/logger/-%23-errors-Timeout"></a><div class="property show-anchors"><div class="signature"><span class="path">Logger</span><span class="symbol">.</span><span class="path">errors</span><span class="symbol">.</span><span class="method">TIMEOUT</span><div class="anchors"><a class="self" href="#/v5/api/utils/logger/-%23-errors-Timeout"></a></div></div><div class="body"><p>A timeout occurred.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/logger/-%23-errors-UnknownError"></a><div class="property show-anchors"><div class="signature"><span class="path">Logger</span><span class="symbol">.</span><span class="path">errors</span><span class="symbol">.</span><span class="method">UNKNOWN_ERROR</span><div class="anchors"><a class="self" href="#/v5/api/utils/logger/-%23-errors-UnknownError"></a></div></div><div class="body"><p>A generic unknown error.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/logger/-%23-errors-UnsupportedOperation"></a><div class="property show-anchors"><div class="signature"><span class="path">Logger</span><span class="symbol">.</span><span class="path">errors</span><span class="symbol">.</span><span class="method">UNSUPPORTED_OPERATION</span><div class="anchors"><a class="self" href="#/v5/api/utils/logger/-%23-errors-UnsupportedOperation"></a></div></div><div class="body"><p>The operation is not supported.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/logger/-%23-logging--errors--safety-error-codes"></a><a name="/v5/api/utils/logger/"></a><h3 class="show-anchors"><div>Safety Error Codes<div class="anchors"><a class="self" href="#/v5/api/utils/logger/-%23-logging--errors--safety-error-codes"></a></div></div></h3>
|
|
<div class="property show-anchors"><div class="signature"><span class="path">Logger</span><span class="symbol">.</span><span class="path">errors</span><span class="symbol">.</span><span class="method">BUFFER_OVERRUN</span><div class="anchors"></div></div><div class="body"><p>The amount of data needed is more than the amount of data required, which would cause the data buffer to read past its end.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/logger/-%23-errors-NumericFault"></a><div class="property show-anchors"><div class="signature"><span class="path">Logger</span><span class="symbol">.</span><span class="path">errors</span><span class="symbol">.</span><span class="method">NUMERIC_FAULT</span><div class="anchors"><a class="self" href="#/v5/api/utils/logger/-%23-errors-NumericFault"></a></div></div><div class="body"><p>There was an invalid operation done on numeric values.</p>
|
|
|
|
<p>Common cases of this occur when there is <a href="https://en.wikipedia.org/wiki/Integer_overflow">overflow</a>, <a href="https://en.wikipedia.org/wiki/Arithmetic_underflow">arithmetic underflow</a> in fixed numeric types or division by zero.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/logger/-%23-logging--errors--usage-error-codes"></a><a name="/v5/api/utils/logger/"></a><h3 class="show-anchors"><div>Usage Error Codes<div class="anchors"><a class="self" href="#/v5/api/utils/logger/-%23-logging--errors--usage-error-codes"></a></div></div></h3>
|
|
<a name="/v5/api/utils/logger/-%23-errors-InvalidArgument"></a><div class="property show-anchors"><div class="signature"><span class="path">Logger</span><span class="symbol">.</span><span class="path">errors</span><span class="symbol">.</span><span class="method">INVALID_ARGUMENT</span><div class="anchors"><a class="self" href="#/v5/api/utils/logger/-%23-errors-InvalidArgument"></a></div></div><div class="body"><p>The type or value of an argument is invalid. This will generally also include the <code class="inline">name</code> and <code class="inline">value</code> of the argument. Any function which accepts sensitive data (such as a private key) will include the string <code class="inline">[[REDACTED]]</code> instead of the value passed in.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/logger/-%23-errors-MissingArgument"></a><div class="property show-anchors"><div class="signature"><span class="path">Logger</span><span class="symbol">.</span><span class="path">errors</span><span class="symbol">.</span><span class="method">MISSING_ARGUMENT</span><div class="anchors"><a class="self" href="#/v5/api/utils/logger/-%23-errors-MissingArgument"></a></div></div><div class="body"><p>An expected parameter was not specified.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/logger/-%23-errors-MissingNew"></a><div class="property show-anchors"><div class="signature"><span class="path">Logger</span><span class="symbol">.</span><span class="path">errors</span><span class="symbol">.</span><span class="method">MISSING_NEW</span><div class="anchors"><a class="self" href="#/v5/api/utils/logger/-%23-errors-MissingNew"></a></div></div><div class="body"><p>An object is a Class, but is now being called with <code class="inline">new</code>.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/logger/-%23-errors-UnexpectedArgument"></a><div class="property show-anchors"><div class="signature"><span class="path">Logger</span><span class="symbol">.</span><span class="path">errors</span><span class="symbol">.</span><span class="method">UNEXPECTED_ARGUMENT</span><div class="anchors"><a class="self" href="#/v5/api/utils/logger/-%23-errors-UnexpectedArgument"></a></div></div><div class="body"><p>Too many parameters we passed into a function.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/logger/-%23-logging--errors--ethereum-error-codes"></a><a name="/v5/api/utils/logger/"></a><h3 class="show-anchors"><div>Ethereum Error Codes<div class="anchors"><a class="self" href="#/v5/api/utils/logger/-%23-logging--errors--ethereum-error-codes"></a></div></div></h3>
|
|
<div class="property show-anchors"><div class="signature"><span class="path">Logger</span><span class="symbol">.</span><span class="path">errors</span><span class="symbol">.</span><span class="method">CALL_EXCEPTION</span><div class="anchors"></div></div><div class="body"><p>An attempt to call a blockchain contract (getter) resulted in a revert or other error.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">Logger</span><span class="symbol">.</span><span class="path">errors</span><span class="symbol">.</span><span class="method">INSUFFICIENT_FUNDS</span><div class="anchors"></div></div><div class="body"><p>The account is attempting to make a transaction which costs more than is available.</p>
|
|
|
|
<p>A sending account must have enough ether to pay for the value, the gas limit (at the gas price) as well as the intrinsic cost of data. The intrinsic cost of data is 4 gas for each zero byte and 68 gas for each non-zero byte.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">Logger</span><span class="symbol">.</span><span class="path">errors</span><span class="symbol">.</span><span class="method">NETWORK_ERROR</span><div class="anchors"></div></div><div class="body"><p>An Ethereum network validation error, such as an invalid chain ID.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">Logger</span><span class="symbol">.</span><span class="path">errors</span><span class="symbol">.</span><span class="method">NONCE_EXPIRED</span><div class="anchors"></div></div><div class="body"><p>The nonce being specified has already been used in a mined transaction.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">Logger</span><span class="symbol">.</span><span class="path">errors</span><span class="symbol">.</span><span class="method">REPLACEMENT_UNDERPRICED</span><div class="anchors"></div></div><div class="body"><p>When replacing a transaction, by using a nonce which has already been sent to the network, but which has not been mined yet the new transaction must specify a higher gas price.</p>
|
|
|
|
<p>This error occurs when the gas price is insufficient to <i>bribe</i> the transaction pool to prefer the new transaction over the old one. Generally, the new gas price should be about 50% + 1 wei more, so if a gas price of 10 gwei was used, the replacement should be 15.000000001 gwei.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">Logger</span><span class="symbol">.</span><span class="path">errors</span><span class="symbol">.</span><span class="method">UNPREDICTABLE_GAS_LIMIT</span><div class="anchors"></div></div><div class="body"><p>When estimating the required amount of gas for a transaction, a node is queried for its best guess.</p>
|
|
|
|
<p>If a node is unable (or unwilling) to predict the cost, this error occurs.</p>
|
|
|
|
<p>The best remedy for this situation is to specify a gas limit in the transaction manually.</p>
|
|
|
|
<p>This error can also indicate that the transaction is expected to fail regardless, if for example an account with no tokens is attempting to send a token.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/logger/-%23-Logger-levels"></a><a name="/v5/api/utils/logger/-%23-logging--Logger-levels"></a><a name="/v5/api/utils/logger/"></a><h2 class="show-anchors"><div>Log Levels<div class="anchors"><a class="self" href="#/v5/api/utils/logger/-%23-Logger-levels"></a></div></div></h2>
|
|
<div class="property show-anchors"><div class="signature"><span class="path">Logger</span><span class="symbol">.</span><span class="path">levels</span><span class="symbol">.</span><span class="method">DEBUG</span><div class="anchors"></div></div><div class="body"><p>Log all output, including debugging information.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">Logger</span><span class="symbol">.</span><span class="path">levels</span><span class="symbol">.</span><span class="method">INFO</span><div class="anchors"></div></div><div class="body"><p>Only log output for infomational, warnings and errors.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">Logger</span><span class="symbol">.</span><span class="path">levels</span><span class="symbol">.</span><span class="method">WARNING</span><div class="anchors"></div></div><div class="body"><p>Only log output for warnings and errors.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">Logger</span><span class="symbol">.</span><span class="path">levels</span><span class="symbol">.</span><span class="method">ERROR</span><div class="anchors"></div></div><div class="body"><p>Only log output for errors.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">Logger</span><span class="symbol">.</span><span class="path">levels</span><span class="symbol">.</span><span class="method">OFF</span><div class="anchors"></div></div><div class="body"><p>Do not output any logs.</p>
|
|
|
|
</div></div><div class="page-separator"></div><a name="/v5/api/utils/properties/-%23-property-utilities"></a><a name="/v5/api/utils/properties/"></a><h1 class="show-anchors"><div>Property Utilities<div class="anchors"><a class="self" href="#/v5/api/utils/properties/-%23-property-utilities"></a></div></div></h1>
|
|
<div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="method">checkProperties</span><span class="symbol">(</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">void</span><div class="anchors"></div></div><div class="body">
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="method">deepCopy</span><span class="symbol">(</span> <span class="param">anObject</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">any</span><div class="anchors"></div></div><div class="body">
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="method">defineReadOnly</span><span class="symbol">(</span> <span class="param">anObject</span> <span class="symbol">,</span> <span class="param">name</span> <span class="symbol">,</span> <span class="param">value</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">void</span><div class="anchors"></div></div><div class="body">
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="method">getStatic</span><span class="symbol">(</span> <span class="param">aConstructor</span> <span class="symbol">,</span> <span class="param">key</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">any</span><div class="anchors"></div></div><div class="body">
|
|
</div></div><a name="/v5/api/utils/properties/-%23-utils-resolveproperties"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="method">resolveProperties</span><span class="symbol">(</span> <span class="param">anObject</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Promise< any ></span><div class="anchors"><a class="self" href="#/v5/api/utils/properties/-%23-utils-resolveproperties"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/properties/src.ts/index.ts#L32">source</a></div></div><div class="body">
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="method">shallowCopy</span><span class="symbol">(</span> <span class="param">anObject</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">any</span><div class="anchors"></div></div><div class="body">
|
|
</div></div><div class="page-separator"></div><a name="/v5/api/utils/signing-key/-%23-SigningKey"></a><a name="/v5/api/utils/signing-key/-%23-SigningKey"></a><a name="/v5/api/utils/signing-key/"></a><h1 class="show-anchors"><div>Signing Key<div class="anchors"><a class="self" href="#/v5/api/utils/signing-key/-%23-SigningKey"></a></div></div></h1>
|
|
<a name="/v5/api/utils/signing-key/-%23-SigningKey-constructor"></a><div class="property show-anchors"><div class="signature"><span class="modifier">new </span><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="method">SigningKey</span><span class="symbol">(</span> <span class="param">privateKey</span> <span class="symbol">)</span><div class="anchors"><a class="self" href="#/v5/api/utils/signing-key/-%23-SigningKey-constructor"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/signing-key/src.ts/index.ts#L32">source</a></div></div><div class="body"><p>Create a new SigningKey for <i>privateKey</i>.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">signingKey</span><span class="symbol">.</span><span class="method">privateKey</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a>< 32 > ></span><div class="anchors"></div></div><div class="body"><p>The private key for this Signing Key.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">signingKey</span><span class="symbol">.</span><span class="method">publicKey</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a>< 65 > ></span><div class="anchors"></div></div><div class="body"><p>The uncompressed public key for this Signing Key. It will always be 65 bytes (130 nibbles) and begine with <code class="inline">0x04</code>.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">signingKey</span><span class="symbol">.</span><span class="method">compressedPublicKey</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a>< 33 > ></span><div class="anchors"></div></div><div class="body"><p>The compressed public key for this Signing Key. It will always be 33 bytes (66 nibbles) and begine with either <code class="inline">0x02</code> or <code class="inline">0x03</code>.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">signingKey</span><span class="symbol">.</span><span class="method">signDigest</span><span class="symbol">(</span> <span class="param">digest</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/bytes/-%23-Signature">Signature</a></span><div class="anchors"></div></div><div class="body"><p>Sign the <i>digest</i> and return the signature.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">signingKey</span><span class="symbol">.</span><span class="method">computeSharedSecret</span><span class="symbol">(</span> <span class="param">otherKey</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a>< 32 > ></span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/signing-key/src.ts/index.ts#L61">source</a></div></div><div class="body"><p>Compute the ECDH shared secret with <i>otherKey</i>. The <i>otherKey</i> may be either a public key or a private key, but generally will be a public key from another party.</p>
|
|
|
|
<p>It is best practice that each party computes the hash of this before using it as a symmetric key.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">SigningKey</span><span class="symbol">.</span><span class="method">isSigningKey</span><span class="symbol">(</span> <span class="param">anObject</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">boolean</span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/signing-key/src.ts/index.ts#L67">source</a></div></div><div class="body"><p>Returns true if <i>anObject</i> is a SigningKey.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/signing-key/-%23-SigningKey--other-functions"></a><a name="/v5/api/utils/signing-key/"></a><h2 class="show-anchors"><div>Other Functions<div class="anchors"><a class="self" href="#/v5/api/utils/signing-key/-%23-SigningKey--other-functions"></a></div></div></h2>
|
|
<a name="/v5/api/utils/signing-key/-%23-utils-verifyMessage"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="method">verifyMessage</span><span class="symbol">(</span> <span class="param">message</span> <span class="symbol">,</span> <span class="param">signature</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/address/-%23-address">Address</a> ></span><div class="anchors"><a class="self" href="#/v5/api/utils/signing-key/-%23-utils-verifyMessage"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/wallet/src.ts/index.ts#L172">source</a></div></div><div class="body"><p>Returns the address that signed <i>message</i> producing <i>signature</i>. The signature may have a non-canonical v (i.e. does not need to be 27 or 28), in which case it will be normalized to compute the `recoveryParam` which will then be used to compute the address; this allows systems which use the v to encode additional data (such as <a href="https://eips.ethereum.org/EIPS/eip-155">EIP-155</a>) to be used since the v parameter is still completely non-ambiguous.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/signing-key/-%23-utils-recoverPublicKey"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="method">recoverPublicKey</span><span class="symbol">(</span> <span class="param">digest</span> <span class="symbol">,</span> <span class="param">signature</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a>< 65 > ></span><div class="anchors"><a class="self" href="#/v5/api/utils/signing-key/-%23-utils-recoverPublicKey"></a></div></div><div class="body">
|
|
</div></div><a name="/v5/api/utils/signing-key/-%23-utils-computePublicKey"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="method">computePublicKey</span><span class="symbol">(</span> <span class="param">key</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">compressed</span> = <span class="param">false</span> <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a> ></span><div class="anchors"><a class="self" href="#/v5/api/utils/signing-key/-%23-utils-computePublicKey"></a></div></div><div class="body"><p>Computes the public key of <i>key</i>, optionally compressing it. The <i>key</i> can be any form of public key (compressed or uncompressed) or a private key.</p>
|
|
|
|
</div></div><div class="page-separator"></div><a name="/v5/api/utils/strings/-%23-strings"></a><a name="/v5/api/utils/strings/-%23-strings"></a><a name="/v5/api/utils/strings/"></a><h1 class="show-anchors"><div>Strings<div class="anchors"><a class="self" href="#/v5/api/utils/strings/-%23-strings"></a></div></div></h1><p>Tra la la</p>
|
|
|
|
<a name="/v5/api/utils/strings/-%23-Bytes32String"></a><a name="/v5/api/utils/strings/-%23-strings--Bytes32String"></a><a name="/v5/api/utils/strings/"></a><h2 class="show-anchors"><div>Bytes32String<div class="anchors"><a class="self" href="#/v5/api/utils/strings/-%23-Bytes32String"></a></div></div></h2><p>A string in Solidity is length prefixed with its 256-bit (32 byte) length, which means that even short strings require 2 words (64 bytes) of storage.</p>
|
|
|
|
<p>In many cases, we deal with short strings, so instead of prefixing the string with its length, we can null-terminate it and fit it in a single word (32 bytes). Since we need only a single byte for the null termination, we can store strings up to 31 bytes long in a word.</p>
|
|
|
|
<div class="definition container-box note"><div class="term">Note</div><div class="body"><p>Strings that are 31 <u><i>bytes</i></u> long may contain fewer than 31 <u><i>characters</i></u>, since UTF-8 requires multiple bytes to encode international characters.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/strings/-%23-utils-parseBytes32"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="method">parseBytes32String</span><span class="symbol">(</span> <span class="param">aBytesLike</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">string</span><div class="anchors"><a class="self" href="#/v5/api/utils/strings/-%23-utils-parseBytes32"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/strings/src.ts/bytes32.ts#L21">source</a></div></div><div class="body"><p>Returns the decoded string represented by the <code class="inline">Bytes32</code> encoded data.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/strings/-%23-utils-formatBytes32"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="method">formatBytes32String</span><span class="symbol">(</span> <span class="param">text</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a>< 32 > ></span><div class="anchors"><a class="self" href="#/v5/api/utils/strings/-%23-utils-formatBytes32"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/strings/src.ts/bytes32.ts#L9">source</a></div></div><div class="body"><p>Returns a <code class="inline">bytes32</code> string representation of <i>text</i>. If the length of <i>text</i> exceeds 31 bytes, it will throw an error.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/strings/-%23-strings-utf8"></a><a name="/v5/api/utils/strings/-%23-strings--strings-utf8"></a><a name="/v5/api/utils/strings/"></a><h2 class="show-anchors"><div>UTF-8 Strings<div class="anchors"><a class="self" href="#/v5/api/utils/strings/-%23-strings-utf8"></a></div></div></h2>
|
|
<a name="/v5/api/utils/strings/-%23-utils-toUtf8Bytes"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="method">toUtf8Bytes</span><span class="symbol">(</span> <span class="param">text</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">form</span> = <span class="param">current</span> <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Uint8Array</span><div class="anchors"><a class="self" href="#/v5/api/utils/strings/-%23-utils-toUtf8Bytes"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/strings/src.ts/utf8.ts#L202">source</a></div></div><div class="body"><p>Returns the UTF-8 bytes of <i>text</i>, optionally normalizing it using the <a href="#/v5/api/utils/strings/-%23-strings--unicode-normalization-form">UnicodeNormalizationForm</a> <i>form</i>.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/strings/-%23-utils-toUtf8CodePoints"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="method">toUtf8CodePoints</span><span class="symbol">(</span> <span class="param">text</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">form</span> = <span class="param">current</span> <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Array< number ></span><div class="anchors"><a class="self" href="#/v5/api/utils/strings/-%23-utils-toUtf8CodePoints"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/strings/src.ts/utf8.ts#L293">source</a></div></div><div class="body"><p>Returns the Array of codepoints of <i>text</i>, optionally normalized using the <a href="#/v5/api/utils/strings/-%23-strings--unicode-normalization-form">UnicodeNormalizationForm</a> <i>form</i>.</p>
|
|
|
|
</div></div><div class="definition container-box note"><div class="term">Note</div><div class="body"><p>This function correctly splits each <b>user-perceived character</b> into its codepoint, accounting for surrogate pairs. This should not be confused with <code class="inline">string.split("")</code>, which destroys surrogate pairs, spliting between each UTF-16 codeunit instead.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/strings/-%23-utils-toUtf8String"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="method">toUtf8String</span><span class="symbol">(</span> <span class="param">aBytesLike</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">onError</span> = <span class="param">error</span> <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">string</span><div class="anchors"><a class="self" href="#/v5/api/utils/strings/-%23-utils-toUtf8String"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/strings/src.ts/utf8.ts#L289">source</a></div></div><div class="body"><p>Returns the string represented by the UTF-8 bytes of <i>aBytesLike</i>.</p>
|
|
|
|
<p>The <i>onError</i> is a <a href="#/v5/api/utils/strings/-%23-strings--error-handling">Custom UTF-8 Error function</a> and if not specified it defaults to the <a href="#/v5/api/utils/strings/-%23-strings--Utf8Error">error</a> function, which throws an error on <b>any</b> UTF-8 error.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/strings/-%23-strings--unicode-normalization-form"></a><a name="/v5/api/utils/strings/-%23-strings--strings--unicode-normalization-form"></a><a name="/v5/api/utils/strings/"></a><h2 class="show-anchors"><div>UnicodeNormalizationForm<div class="anchors"><a class="self" href="#/v5/api/utils/strings/-%23-strings--unicode-normalization-form"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/strings/src.ts/utf8.ts#L11">source</a></div></div></h2><p>There are several <a href="https://en.wikipedia.org/wiki/Unicode_equivalence">commonly used forms</a> when normalizing UTF-8 data, which allow strings to be compared or hashed in a stable way.</p>
|
|
|
|
<div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="path">UnicodeNormalizationForm</span><span class="symbol">.</span><span class="method">current</span><div class="anchors"></div></div><div class="body"><p>Maintain the current normalization form.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="path">UnicodeNormalizationForm</span><span class="symbol">.</span><span class="method">NFC</span><div class="anchors"></div></div><div class="body"><p>The Composed Normalization Form. This form uses single codepoints which represent the fully composed character.</p>
|
|
|
|
<p>For example, the <b>é</b> is a single codepoint, <code class="inline">0x00e9</code>.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="path">UnicodeNormalizationForm</span><span class="symbol">.</span><span class="method">NFD</span><div class="anchors"></div></div><div class="body"><p>The Decomposed Normalization Form. This form uses multiple codepoints (when necessary) to compose a character.</p>
|
|
|
|
<p>For example, the <b>é</b> is made up of two codepoints, <code class="inline">"0x0065"</code> (which is the letter <code class="inline">"e"</code>) and <code class="inline">"0x0301"</code> which is a special diacritic UTF-8 codepoint which indicates the previous character should have an acute accent.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="path">UnicodeNormalizationForm</span><span class="symbol">.</span><span class="method">NFKC</span><div class="anchors"></div></div><div class="body"><p>The Composed Normalization Form with Canonical Equivalence. The Canonical representation folds characters which have the same syntactic representation but different semantic meaning.</p>
|
|
|
|
<p>For example, the Roman Numeral <b>I</b>, which has a UTF-8 codepoint <code class="inline">"0x2160"</code>, is folded into the capital letter I, <code class="inline">"0x0049"</code>.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="path">UnicodeNormalizationForm</span><span class="symbol">.</span><span class="method">NFKD</span><div class="anchors"></div></div><div class="body"><p>The Decomposed Normalization Form with Canonical Equivalence. See NFKC for more an example.</p>
|
|
|
|
</div></div><div class="definition container-box note"><div class="term">Note</div><div class="body"><p>Only certain specified characters are folded in Canonical Equivalence, and thus it should <b>not</b> be considered a method to acheive <i>any</i> level of security from <a href="https://en.wikipedia.org/wiki/IDN_homograph_attack">homoglyph attacks</a>.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/strings/-%23-strings--error-handling"></a><a name="/v5/api/utils/strings/-%23-strings--strings--error-handling"></a><a name="/v5/api/utils/strings/"></a><h2 class="show-anchors"><div>Custom UTF-8 Error Handling<div class="anchors"><a class="self" href="#/v5/api/utils/strings/-%23-strings--error-handling"></a></div></div></h2><p>When converting a string to its codepoints, there is the possibility of invalid byte sequences. Since certain situations may need specific ways to handle UTF-8 errors, a custom error handling function can be used, which has the signature:</p>
|
|
|
|
<div class="property show-anchors"><div class="signature"><span class="method">errorFunction</span><span class="symbol">(</span> <span class="param">reason</span> <span class="symbol">,</span> <span class="param">offset</span> <span class="symbol">,</span> <span class="param">bytes</span> <span class="symbol">,</span> <span class="param">output</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">badCodepoint</span> <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">number</span><div class="anchors"></div></div><div class="body"><p>The <i>reason</i> is one of the <a href="#/v5/api/utils/strings/-%23-strings--error-reasons">UTF-8 Error Reasons</a>, <i>offset</i> is the index into <i>bytes</i> where the error was first encountered, output is the list of codepoints already processed (and may be modified) and in certain Error Reasons, the <i>badCodepoint</i> indicates the currently computed codepoint, but which would be rejected because its value is invalid.</p>
|
|
|
|
<p>This function should return the number of bytes to skip past keeping in mind the value at <i>offset</i> will already be consumed.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/strings/-%23-strings--error-reasons"></a><a name="/v5/api/utils/strings/-%23-strings--strings--error-handling--strings--error-reasons"></a><a name="/v5/api/utils/strings/"></a><h3 class="show-anchors"><div>UTF-8 Error Reasons<div class="anchors"><a class="self" href="#/v5/api/utils/strings/-%23-strings--error-reasons"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/strings/src.ts/utf8.ts#L19">source</a></div></div></h3>
|
|
<div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="path">Utf8ErrorReason</span><span class="symbol">.</span><span class="method">BAD_PREFIX</span><div class="anchors"></div></div><div class="body"><p>A byte was encountered which is invalid to begin a UTF-8 byte sequence with.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="path">Utf8ErrorReason</span><span class="symbol">.</span><span class="method">MISSING_CONTINUE</span><div class="anchors"></div></div><div class="body"><p>A UTF-8 sequence was begun, but did not have enough continuation bytes for the sequence. For this error the <i>ofset</i> is the index at which a continuation byte was expected.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="path">Utf8ErrorReason</span><span class="symbol">.</span><span class="method">OUT_OF_RANGE</span><div class="anchors"></div></div><div class="body"><p>The computed codepoint is outside the range for valid UTF-8 codepoints (i.e. the codepoint is greater than 0x10ffff). This reason will pass the computed <i>badCountpoint</i> into the custom error function.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="path">Utf8ErrorReason</span><span class="symbol">.</span><span class="method">OVERLONG</span><div class="anchors"></div></div><div class="body"><p>Due to the way UTF-8 allows variable length byte sequences to be used, it is possible to have multiple representations of the same character, which means <a href="https://en.wikipedia.org/wiki/UTF-8#Overlong_encodings">overlong sequences</a> allow for a non-distinguished string to be formed, which can impact security as multiple strings that are otherwise equal can have different hashes.</p>
|
|
|
|
<p>Generally, overlong sequences are an attempt to circumvent some part of security, but in rare cases may be produced by lazy libraries or used to encode the null terminating character in a way that is safe to include in a <code class="inline">char*</code>.</p>
|
|
|
|
<p>This reason will pass the computed <i>badCountpoint</i> into the custom error function, which is actually a valid codepoint, just one that was arrived at through unsafe methods.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="path">Utf8ErrorReason</span><span class="symbol">.</span><span class="method">OVERRUN</span><div class="anchors"></div></div><div class="body"><p>The string does not have enough characters remaining for the length of this sequence.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="path">Utf8ErrorReason</span><span class="symbol">.</span><span class="method">UNEXPECTED_CONTINUE</span><div class="anchors"></div></div><div class="body"><p>This error is similar to BAD_PREFIX, since a continuation byte cannot begin a valid sequence, but many may wish to process this differently. However, most developers would want to trap this and perform the same operation as a BAD_PREFIX.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="path">Utf8ErrorReason</span><span class="symbol">.</span><span class="method">UTF16_SURROGATE</span><div class="anchors"></div></div><div class="body"><p>The computed codepoint represents a value reserved for UTF-16 surrogate pairs. This reason will pass the computed surrogate half <i>badCountpoint</i> into the custom error function.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/strings/-%23-strings--strings--error-handling--provided-utf-8-error-handling-functions"></a><a name="/v5/api/utils/strings/"></a><h3 class="show-anchors"><div>Provided UTF-8 Error Handling Functions<div class="anchors"><a class="self" href="#/v5/api/utils/strings/-%23-strings--strings--error-handling--provided-utf-8-error-handling-functions"></a></div></div></h3><p>There are already several functions available for the most common situations.</p>
|
|
|
|
<a name="/v5/api/utils/strings/-%23-strings--Utf8Error"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="path">Utf8ErrorFuncs</span><span class="symbol">.</span><span class="method">error</span><div class="anchors"><a class="self" href="#/v5/api/utils/strings/-%23-strings--Utf8Error"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/strings/src.ts/utf8.ts#L55">source</a></div></div><div class="body"><p>The will throw an error on <b>any</b> error with a UTF-8 sequence, including invalid prefix bytes, overlong sequences, UTF-16 surrogate pairs.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/strings/-%23-strings--Utf8Ignore"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="path">Utf8ErrorFuncs</span><span class="symbol">.</span><span class="method">ignore</span><div class="anchors"><a class="self" href="#/v5/api/utils/strings/-%23-strings--Utf8Ignore"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/strings/src.ts/utf8.ts#L59">source</a></div></div><div class="body"><p>This will drop all invalid sequences (by consuming invalid prefix bytes and any following continuation bytes) from the final string as well as permit overlong sequences to be converted to their equivalent string.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/strings/-%23-strings--Utf8Replace"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="path">Utf8ErrorFuncs</span><span class="symbol">.</span><span class="method">replace</span><div class="anchors"><a class="self" href="#/v5/api/utils/strings/-%23-strings--Utf8Replace"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/strings/src.ts/utf8.ts#L81">source</a></div></div><div class="body"><p>This will replace all invalid sequences (by consuming invalid prefix bytes and any following continuation bytes) with the <a href="https://en.wikipedia.org/wiki/Specials_%28Unicode_block%29#Replacement_character">UTF-8 Replacement Character</a>, (i.e. U+FFFD).</p>
|
|
|
|
</div></div><div class="page-separator"></div><a name="/v5/api/utils/transactions/-%23-transactions"></a><a name="/v5/api/utils/transactions/-%23-transactions"></a><a name="/v5/api/utils/transactions/"></a><h1 class="show-anchors"><div>Transactions<div class="anchors"><a class="self" href="#/v5/api/utils/transactions/-%23-transactions"></a></div></div></h1>
|
|
<a name="/v5/api/utils/transactions/-%23-transactions--types"></a><a name="/v5/api/utils/transactions/-%23-transactions--transactions--types"></a><a name="/v5/api/utils/transactions/"></a><h2 class="show-anchors"><div>Types<div class="anchors"><a class="self" href="#/v5/api/utils/transactions/-%23-transactions--types"></a></div></div></h2>
|
|
<a name="/v5/api/utils/transactions/-%23-UnsignedTransaction"></a><a name="/v5/api/utils/transactions/-%23-transactions--transactions--types--UnsignedTransaction"></a><a name="/v5/api/utils/transactions/"></a><h3 class="show-anchors"><div>UnsignedTransaction<div class="anchors"><a class="self" href="#/v5/api/utils/transactions/-%23-UnsignedTransaction"></a></div></div></h3><p>An unsigned transaction represents a transaction that has not been signed and its values are flexible as long as they are not ambiguous.</p>
|
|
|
|
<div class="property show-anchors"><div class="signature"><span class="path">unsignedTransaction</span><span class="symbol">.</span><span class="method">to</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/address/-%23-address">Address</a> ></span><div class="anchors"></div></div><div class="body"><p>The addres this transaction is to.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">unsignedTransaction</span><span class="symbol">.</span><span class="method">nonce</span> <span class="arrow">⇒</span> <span class="returns">number</span><div class="anchors"></div></div><div class="body"><p>The nonce of this transaction.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">unsignedTransaction</span><span class="symbol">.</span><span class="method">gasLimit</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/bignumber/-%23-BigNumberish">BigNumberish</a></span><div class="anchors"></div></div><div class="body"><p>The gas limit for this transaction.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">unsignedTransaction</span><span class="symbol">.</span><span class="method">gasPrice</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/bignumber/-%23-BigNumberish">BigNumberish</a></span><div class="anchors"></div></div><div class="body"><p>The gas price for this transaction.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">unsignedTransaction</span><span class="symbol">.</span><span class="method">data</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/bytes/-%23-BytesLike">BytesLike</a></span><div class="anchors"></div></div><div class="body"><p>The data for this transaction.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">unsignedTransaction</span><span class="symbol">.</span><span class="method">value</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/bignumber/-%23-BigNumberish">BigNumberish</a></span><div class="anchors"></div></div><div class="body"><p>The value (in wei) for this transaction.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">unsignedTransaction</span><span class="symbol">.</span><span class="method">chainId</span> <span class="arrow">⇒</span> <span class="returns">number</span><div class="anchors"></div></div><div class="body"><p>The chain ID for this transaction. If the chain ID is 0 or null, then <a href="https://eips.ethereum.org/EIPS/eip-155">EIP-155</a> is disabled and legacy signing is used, unless overridden in a signature.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/transactions/-%23-Transaction"></a><a name="/v5/api/utils/transactions/-%23-transactions--transactions--types--Transaction"></a><a name="/v5/api/utils/transactions/"></a><h3 class="show-anchors"><div>Transaction<div class="anchors"><a class="self" href="#/v5/api/utils/transactions/-%23-Transaction"></a></div></div></h3><p>A generic object to represent a transaction.</p>
|
|
|
|
<div class="property show-anchors"><div class="signature"><span class="path">transaction</span><span class="symbol">.</span><span class="method">hash</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a>< 32 > ></span><div class="anchors"></div></div><div class="body"><p>The transaction hash, which can be used as an identifier for <i>transaction</i>. This is the keccak256 of the serialized RLP encoded representation of <i>transaction</i>.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">unsignedTransaction</span><span class="symbol">.</span><span class="method">to</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/address/-%23-address">Address</a> ></span><div class="anchors"></div></div><div class="body"><p>The address <i>transaction</i> is to.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">transaction</span><span class="symbol">.</span><span class="method">from</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/address/-%23-address">Address</a> ></span><div class="anchors"></div></div><div class="body"><p>The address <i>transaction</i> is from.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">transaction</span><span class="symbol">.</span><span class="method">nonce</span> <span class="arrow">⇒</span> <span class="returns">number</span><div class="anchors"></div></div><div class="body"><p>The nonce for <i>transaction</i>. Each transaction sent to the network from an account includes this, which ensures the order and non-replayability of a transaction. This must be equal to the current number of transactions ever sent to the network by the <b>from</b> address.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">transaction</span><span class="symbol">.</span><span class="method">gasLimit</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/bignumber/">BigNumber</a></span><div class="anchors"></div></div><div class="body"><p>The gas limit for <i>transaction</i>. An account must have enough ether to cover the gas (at the specified <b>gasPrice</b>). Any unused gas is refunded at the end of the transaction, and if there is insufficient gas to complete execution, the effects of the trasaction are reverted, but the gas is <b>fully consumed</b> and an out-of-gas error occurs.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">transaction</span><span class="symbol">.</span><span class="method">gasPrice</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/bignumber/">BigNumber</a></span><div class="anchors"></div></div><div class="body"><p>The price (in wei) per unit of gas for <i>transaction</i>.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">transaction</span><span class="symbol">.</span><span class="method">data</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/bytes/-%23-BytesLike">BytesLike</a></span><div class="anchors"></div></div><div class="body"><p>The data for <i>transaction</i>. In a contract this is the call data.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">transaction</span><span class="symbol">.</span><span class="method">value</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/bignumber/">BigNumber</a></span><div class="anchors"></div></div><div class="body"><p>The value (in wei) for <i>transaction</i>.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">transaction</span><span class="symbol">.</span><span class="method">chainId</span> <span class="arrow">⇒</span> <span class="returns">number</span><div class="anchors"></div></div><div class="body"><p>The chain ID for <i>transaction</i>. This is used as part of <a href="https://eips.ethereum.org/EIPS/eip-155">EIP-155</a> to prevent replay attacks on different networks.</p>
|
|
|
|
<p>For example, if a transaction was made on ropsten with an account also used on homestead, it would be possible for a transaction signed on ropsten to be executed on homestead, which is likely unintended.</p>
|
|
|
|
<p>There are situations where replay may be desired, however these are very rare and it is almost always recommended to specify the chain ID.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">transaction</span><span class="symbol">.</span><span class="method">r</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a>< 32 > ></span><div class="anchors"></div></div><div class="body"><p>The r portion of the elliptic curve signatures for <i>transaction</i>. This is more accurately, the x coordinate of the point r (from which the y can be computed, along with v).</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">transaction</span><span class="symbol">.</span><span class="method">s</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a>< 32 > ></span><div class="anchors"></div></div><div class="body"><p>The s portion of the elliptic curve signatures for <i>transaction</i>.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">transaction</span><span class="symbol">.</span><span class="method">v</span> <span class="arrow">⇒</span> <span class="returns">number</span><div class="anchors"></div></div><div class="body"><p>The v portion of the elliptic curve signatures for <i>transaction</i>. This is used to refine which of the two possible points a given x-coordinate can have, and in <a href="https://eips.ethereum.org/EIPS/eip-155">EIP-155</a> is additionally used to encode the chain ID into the serialized transaction.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/transactions/-%23-transactions--functions"></a><a name="/v5/api/utils/transactions/-%23-transactions--transactions--functions"></a><a name="/v5/api/utils/transactions/"></a><h2 class="show-anchors"><div>Functions<div class="anchors"><a class="self" href="#/v5/api/utils/transactions/-%23-transactions--functions"></a></div></div></h2>
|
|
<a name="/v5/api/utils/transactions/-%23-utils-parseTransaction"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="method">parseTransaction</span><span class="symbol">(</span> <span class="param">aBytesLike</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/transactions/-%23-Transaction">Transaction</a></span><div class="anchors"><a class="self" href="#/v5/api/utils/transactions/-%23-utils-parseTransaction"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/transactions/src.ts/index.ts#L165">source</a></div></div><div class="body"><p>Parses the transaction properties from a serialized transactions.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/transactions/-%23-utils-serializeTransaction"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="method">serializeTransaction</span><span class="symbol">(</span> <span class="param">tx</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">signature</span> <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a> ></span><div class="anchors"><a class="self" href="#/v5/api/utils/transactions/-%23-utils-serializeTransaction"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/transactions/src.ts/index.ts#L85">source</a></div></div><div class="body"><p>Computes the serialized <i>transaction</i>, optionally serialized with the a <i>signature</i>. If <i>signature</i> is not present, the unsigned serialized transaction is returned, which can be used to compute the hash necessary to sign.</p>
|
|
|
|
<p>This function uses <a href="https://eips.ethereum.org/EIPS/eip-155">EIP-155</a> if a chainId is provided, otherwise legacy serialization is used. It is <b>highly</b> recommended to always specify a <i>chainId</i>.</p>
|
|
|
|
<p>If <i>signature</i> includes a chain ID (explicitly or implicitly by using an <a href="https://eips.ethereum.org/EIPS/eip-155">EIP-155</a> <code class="inline">v</code> or <code class="inline">_vs</code>) it will be used to compute the chain ID.</p>
|
|
|
|
<p>If there is a mismatch between the chain ID of <i>transaction</i> and <i>signature</i> an error is thrown.</p>
|
|
|
|
</div></div><div class="page-separator"></div><a name="/v5/api/utils/web/-%23-web"></a><a name="/v5/api/utils/web/-%23-web"></a><a name="/v5/api/utils/web/"></a><h1 class="show-anchors"><div>Web Utilities<div class="anchors"><a class="self" href="#/v5/api/utils/web/-%23-web"></a></div></div></h1>
|
|
<a name="/v5/api/utils/web/-%23-utils-fetchJson"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="method">fetchJson</span><span class="symbol">(</span> <span class="param">urlOrConnectionInfo</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">json</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">processFunc</span> <span class="symbol">]</span> <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Promise< any ></span><div class="anchors"><a class="self" href="#/v5/api/utils/web/-%23-utils-fetchJson"></a></div></div><div class="body"><p>Fetch and parse the JSON content from <i>urlOrConnectionInfo</i>, with the optiona body <i>json</i> and optionally processing the result with <i>processFun</i> before returning it.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/web/-%23-utils-poll"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="method">poll</span><span class="symbol">(</span> <span class="param">pollFunc</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">options</span> <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Promise< any ></span><div class="anchors"><a class="self" href="#/v5/api/utils/web/-%23-utils-poll"></a></div></div><div class="body"><p>Repeatedly call pollFunc using the <a href="#/v5/api/utils/web/-%23-PollOptions">PollOptions</a> until it returns a value other than undefined.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/web/-%23-ConnectionInfo"></a><a name="/v5/api/utils/web/-%23-web--ConnectionInfo"></a><a name="/v5/api/utils/web/"></a><h3 class="show-anchors"><div>ConnectionInfo<div class="anchors"><a class="self" href="#/v5/api/utils/web/-%23-ConnectionInfo"></a></div></div></h3>
|
|
<div class="property show-anchors"><div class="signature"><span class="path">connection</span><span class="symbol">.</span><span class="method">url</span> <span class="arrow">⇒</span> <span class="returns">string</span><div class="anchors"></div></div><div class="body"><p>The URL to connect to.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">connection</span><span class="symbol">.</span><span class="method">user</span> <span class="arrow">⇒</span> <span class="returns">string</span><div class="anchors"></div></div><div class="body"><p>The username to use for <a href="https://en.wikipedia.org/wiki/Basic_access_authentication">Basic Authentication</a>. The default is null (i.e. do not use basic authentication)</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">connection</span><span class="symbol">.</span><span class="method">password</span> <span class="arrow">⇒</span> <span class="returns">string</span><div class="anchors"></div></div><div class="body"><p>The password to use for <a href="https://en.wikipedia.org/wiki/Basic_access_authentication">Basic Authentication</a>. The default is null (i.e. do not use basic authentication)</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">connection</span><span class="symbol">.</span><span class="method">allowInsecureAuthentication</span> <span class="arrow">⇒</span> <span class="returns">boolean</span><div class="anchors"></div></div><div class="body"><p>Allow <a href="https://en.wikipedia.org/wiki/Basic_access_authentication">Basic Authentication</a> over non-secure HTTP. The default is false.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">connection</span><span class="symbol">.</span><span class="method">timeout</span> <span class="arrow">⇒</span> <span class="returns">number</span><div class="anchors"></div></div><div class="body"><p>How long to wait before rejecting with a <i>timeout</i> error.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">connection</span><span class="symbol">.</span><span class="method">headers</span> <span class="arrow">⇒</span> <span class="returns">{[key:string]:string}</span><div class="anchors"></div></div><div class="body"><p>Additional headers to include in the connection.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/web/-%23-PollOptions"></a><a name="/v5/api/utils/web/-%23-web--PollOptions"></a><a name="/v5/api/utils/web/"></a><h3 class="show-anchors"><div>PollOptions<div class="anchors"><a class="self" href="#/v5/api/utils/web/-%23-PollOptions"></a></div></div></h3>
|
|
<div class="property show-anchors"><div class="signature"><span class="path">options</span><span class="symbol">.</span><span class="method">timeout</span> <span class="arrow">⇒</span> <span class="returns">number</span><div class="anchors"></div></div><div class="body"><p>The amount of time allowed to ellapse before triggering a timeout error.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">options</span><span class="symbol">.</span><span class="method">floor</span> <span class="arrow">⇒</span> <span class="returns">number</span><div class="anchors"></div></div><div class="body"><p>The minimum time limit to allow for <a href="https://en.wikipedia.org/wiki/Exponential_backoff">Exponential Backoff</a>.</p>
|
|
|
|
<p>The default is 0s.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">options</span><span class="symbol">.</span><span class="method">ceiling</span> <span class="arrow">⇒</span> <span class="returns">number</span><div class="anchors"></div></div><div class="body"><p>The maximum time limit to allow for <a href="https://en.wikipedia.org/wiki/Exponential_backoff">Exponential Backoff</a>.</p>
|
|
|
|
<p>The default is 10s.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">options</span><span class="symbol">.</span><span class="method">interval</span> <span class="arrow">⇒</span> <span class="returns">number</span><div class="anchors"></div></div><div class="body"><p>The interval used during <a href="https://en.wikipedia.org/wiki/Exponential_backoff">Exponential Backoff</a> calculation.</p>
|
|
|
|
<p>The default is 250ms.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">options</span><span class="symbol">.</span><span class="method">retryLimit</span> <span class="arrow">⇒</span> <span class="returns">number</span><div class="anchors"></div></div><div class="body"><p>The number of times to retry in the event of an error or <i>undefined</i> is returned.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">options</span><span class="symbol">.</span><span class="method">onceBlock</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/providers/provider/">Provider</a></span><div class="anchors"></div></div><div class="body"><p>If this is specified, the polling will wait on new blocks from <i>provider</i> before attempting the <i>pollFunc</i> again.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">options</span><span class="symbol">.</span><span class="method">oncePoll</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/providers/provider/">Provider</a></span><div class="anchors"></div></div><div class="body"><p>If this is specified, the polling will occur on each poll cycle of <i>provider</i> before attempting the <i>pollFunc</i> again.</p>
|
|
|
|
</div></div><div class="page-separator"></div><a name="/v5/api/utils/wordlists/-%23-wordlists"></a><a name="/v5/api/utils/wordlists/-%23-wordlists"></a><a name="/v5/api/utils/wordlists/"></a><h1 class="show-anchors"><div>Wordlists<div class="anchors"><a class="self" href="#/v5/api/utils/wordlists/-%23-wordlists"></a></div></div></h1>
|
|
<a name="/v5/api/utils/wordlists/-%23-Wordlist"></a><a name="/v5/api/utils/wordlists/-%23-wordlists--Wordlist"></a><a name="/v5/api/utils/wordlists/"></a><h2 class="show-anchors"><div>Wordlist<div class="anchors"><a class="self" href="#/v5/api/utils/wordlists/-%23-Wordlist"></a></div></div></h2>
|
|
<div class="property show-anchors"><div class="signature"><span class="path">wordlist</span><span class="symbol">.</span><span class="method">locale</span> <span class="arrow">⇒</span> <span class="returns">string</span><div class="anchors"></div></div><div class="body"><p>The locale for this wordlist.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">wordlist</span><span class="symbol">.</span><span class="method">getWord</span><span class="symbol">(</span> <span class="param">index</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">string</span><div class="anchors"></div></div><div class="body"><p>Returns the word at <i>index</i>.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">wordlist</span><span class="symbol">.</span><span class="method">getWordIndex</span><span class="symbol">(</span> <span class="param">word</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">number</span><div class="anchors"></div></div><div class="body"><p>Returns the index of <i>word</i> within the wordlist.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">wordlist</span><span class="symbol">.</span><span class="method">split</span><span class="symbol">(</span> <span class="param">mnemonic</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Array< string ></span><div class="anchors"></div></div><div class="body"><p>Returns the mnemonic split into each individual word, according to a locale's valid whitespace character set.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">wordlist</span><span class="symbol">.</span><span class="method">join</span><span class="symbol">(</span> <span class="param">words</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">string</span><div class="anchors"></div></div><div class="body"><p>Returns the mnemonic by joining <i>words</i> together using the whitespace that is standard for the locale.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">Wordlist</span><span class="symbol">.</span><span class="method">check</span><span class="symbol">(</span> <span class="param">wordlists</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a>< 32 > ></span><div class="anchors"></div></div><div class="body"><p>Checks that all words map both directions correctly and return the hash of the lists. Sub-classes should use this to validate the wordlist is correct against the official wordlist hash.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">Wordlist</span><span class="symbol">.</span><span class="method">register</span><span class="symbol">(</span> <span class="param">wordlist</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">name</span> <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">void</span><div class="anchors"></div></div><div class="body"><p>Register a wordlist with the list of wordlists, optionally overriding the registered <i>name</i>.</p>
|
|
|
|
</div></div><a name="/v5/api/utils/wordlists/-%23-wordlists--languages"></a><a name="/v5/api/utils/wordlists/-%23-wordlists--wordlists--languages"></a><a name="/v5/api/utils/wordlists/"></a><h2 class="show-anchors"><div>Languages<div class="anchors"><a class="self" href="#/v5/api/utils/wordlists/-%23-wordlists--languages"></a></div></div></h2><p>The <a href="https://github.com/bitcoin/bips/blob/master/bip-0039/bip-0039-wordlists.md">official wordlists</a> availalbe in at `ethers.wordlists`. In the browser, only the english langauge is available by default; to include the others (which increases the size of the library), see the dist files in the `ethers` package.</p>
|
|
|
|
<div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">wordlists</span><span class="symbol">.</span><span class="method">cz</span> <span class="arrow">⇒</span> <span class="returns">Wordlist</span><div class="anchors"></div></div><div class="body"><p>The Czech <a href="#/v5/api/utils/wordlists/-%23-Wordlist">Wordlist</a>.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">wordlists</span><span class="symbol">.</span><span class="method">en</span> <span class="arrow">⇒</span> <span class="returns">Wordlist</span><div class="anchors"></div></div><div class="body"><p>The English <a href="#/v5/api/utils/wordlists/-%23-Wordlist">Wordlist</a>.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">wordlists</span><span class="symbol">.</span><span class="method">es</span> <span class="arrow">⇒</span> <span class="returns">Wordlist</span><div class="anchors"></div></div><div class="body"><p>The Spanish <a href="#/v5/api/utils/wordlists/-%23-Wordlist">Wordlist</a>.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">wordlists</span><span class="symbol">.</span><span class="method">fr</span> <span class="arrow">⇒</span> <span class="returns">Wordlist</span><div class="anchors"></div></div><div class="body"><p>The French <a href="#/v5/api/utils/wordlists/-%23-Wordlist">Wordlist</a>.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">wordlists</span><span class="symbol">.</span><span class="method">it</span> <span class="arrow">⇒</span> <span class="returns">Wordlist</span><div class="anchors"></div></div><div class="body"><p>The Italian <a href="#/v5/api/utils/wordlists/-%23-Wordlist">Wordlist</a>.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">wordlists</span><span class="symbol">.</span><span class="method">ja</span> <span class="arrow">⇒</span> <span class="returns">Wordlist</span><div class="anchors"></div></div><div class="body"><p>The Japanese <a href="#/v5/api/utils/wordlists/-%23-Wordlist">Wordlist</a>.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">wordlists</span><span class="symbol">.</span><span class="method">ko</span> <span class="arrow">⇒</span> <span class="returns">Wordlist</span><div class="anchors"></div></div><div class="body"><p>The Korean <a href="#/v5/api/utils/wordlists/-%23-Wordlist">Wordlist</a>.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">wordlists</span><span class="symbol">.</span><span class="method">zh_cn</span> <span class="arrow">⇒</span> <span class="returns">Wordlist</span><div class="anchors"></div></div><div class="body"><p>The Simplified Chinese <a href="#/v5/api/utils/wordlists/-%23-Wordlist">Wordlist</a>.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">wordlists</span><span class="symbol">.</span><span class="method">zh_tw</span> <span class="arrow">⇒</span> <span class="returns">Wordlist</span><div class="anchors"></div></div><div class="body"><p>The Traditional Chinese <a href="#/v5/api/utils/wordlists/-%23-Wordlist">Wordlist</a>.</p>
|
|
|
|
</div></div><div class="page-separator"></div><a name="/v5/api/other/-%23-other-libraries"></a><a name="/v5/api/other/"></a><h1 class="show-anchors"><div>Other Libraries<div class="anchors"><a class="self" href="#/v5/api/other/-%23-other-libraries"></a></div></div></h1><p>Now that ethers is more modular, it is possible to have additional ancillary packages, which are not part of the core but optionally add functionality only needed in certain situations.</p>
|
|
|
|
<div class="toc"><div style="padding-left: 0px"><span class="bullet">•</span><a href="#/v5/api/other/assembly/">Assembly</a></div><div style="padding-left: 0px"><span class="bullet">•</span><a href="#/v5/api/other/hardware/">Hardware Wallets</a></div></div><div class="page-separator"></div><a name="/v5/api/other/assembly/-%23-assembly"></a><a name="/v5/api/other/assembly/"></a><h1 class="show-anchors"><div>Assembly<div class="anchors"><a class="self" href="#/v5/api/other/assembly/-%23-assembly"></a></div></div></h1><p>This module should still be considered fairly experimental.</p>
|
|
|
|
<div class="toc"><div style="padding-left: 0px"><span class="bullet">•</span><a href="#/v5/api/other/assembly/dialect/">Ethers ASM Dialect</a></div><div style="padding-left: 0px"><span class="bullet">•</span><a href="#/v5/api/other/assembly/api/">Utilities</a></div><div style="padding-left: 0px"><span class="bullet">•</span><a href="#/v5/api/other/assembly/ast/">Abstract Syntax Tree</a></div></div><div class="page-separator"></div><a name="/v5/api/other/assembly/dialect/-%23-asm-dialect"></a><a name="/v5/api/other/assembly/dialect/-%23-asm-dialect"></a><a name="/v5/api/other/assembly/dialect/"></a><h1 class="show-anchors"><div>Ethers ASM Dialect<div class="anchors"><a class="self" href="#/v5/api/other/assembly/dialect/-%23-asm-dialect"></a></div></div></h1><p>This provides a quick, high-level overcview of the <b>Ethers ASM Dialect</b> for EVM, which is defined by the <a href="https://github.com/ethers-io/ethers.js/blob/master/packages/asm/grammar.jison">Ethers ASM Dialect Grammar</a></p>
|
|
|
|
<p>Once a program is compiled by a higher level langauge into ASM (assembly), or hand-coded directly in ASM, it needs to be assembled into bytecode.</p>
|
|
|
|
<p>The assembly process performs a very small set of operations and is intentionally simple and closely related to the underlying EVM bytecode.</p>
|
|
|
|
<p>Operations include embedding programs within programs (for example the deployment bootstrap has the runtime embedded in it) and computing the necessary offsets for jump operations.</p>
|
|
|
|
<p>The <a href="#/v5/cli/asm/">Command-Line Assembler</a> can be used to assemble an <i>Ethers ASM Dialect</i> file or to disassemble bytecode into its human-readable (ish) opcodes and literals.</p>
|
|
|
|
<a name="/v5/api/other/assembly/dialect/-%23-asm-dialect-opcode"></a><a name="/v5/api/other/assembly/dialect/-%23-asm-dialect--asm-dialect-opcode"></a><a name="/v5/api/other/assembly/dialect/"></a><h2 class="show-anchors"><div>Opcodes<div class="anchors"><a class="self" href="#/v5/api/other/assembly/dialect/-%23-asm-dialect-opcode"></a></div></div></h2><p>An <b>Opcode</b> may be provided in either a <i>functional</i> or <i>instructional</i> syntax. For Opcodes that require parameters, the <i>functional</i> syntax is recommended and the <i>instructional</i> syntax will raise a warning.</p>
|
|
|
|
<p>@TODO: Examples</p>
|
|
|
|
<a name="/v5/api/other/assembly/dialect/-%23-asm-dialect-label"></a><a name="/v5/api/other/assembly/dialect/-%23-asm-dialect--asm-dialect-label"></a><a name="/v5/api/other/assembly/dialect/"></a><h2 class="show-anchors"><div>Labels<div class="anchors"><a class="self" href="#/v5/api/other/assembly/dialect/-%23-asm-dialect-label"></a></div></div></h2><p>A <b>Label</b> is a position in the program which can be jumped to. A <code class="inline">JUMPDEST</code> is automatically added to this point in the assembled output.</p>
|
|
|
|
<p>@TODO: Exmaples</p>
|
|
|
|
<a name="/v5/api/other/assembly/dialect/-%23-asm-dialect-literal"></a><a name="/v5/api/other/assembly/dialect/-%23-asm-dialect--asm-dialect-literal"></a><a name="/v5/api/other/assembly/dialect/"></a><h2 class="show-anchors"><div>Literals<div class="anchors"><a class="self" href="#/v5/api/other/assembly/dialect/-%23-asm-dialect-literal"></a></div></div></h2><p>A <b>Literal</b> puts data on the stack when executed using a <code class="inline">PUSH</code> operation.</p>
|
|
|
|
<p>A <b>Literal</b> can be provided using a <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a> or a decimal byte value.</p>
|
|
|
|
<p>@TODO: exmples</p>
|
|
|
|
<a name="/v5/api/other/assembly/dialect/-%23-asm-dialect-comment"></a><a name="/v5/api/other/assembly/dialect/-%23-asm-dialect--asm-dialect-comment"></a><a name="/v5/api/other/assembly/dialect/"></a><h2 class="show-anchors"><div>Comments<div class="anchors"><a class="self" href="#/v5/api/other/assembly/dialect/-%23-asm-dialect-comment"></a></div></div></h2><p>To enter a comment in the <b>Ethers ASM Dialect</b>, any text following a semi-colon (i.e. <code class="inline">;</code>) is ignored by the assembler.</p>
|
|
|
|
<a name="/v5/api/other/assembly/dialect/-%23-asm-dialect-scope"></a><a name="/v5/api/other/assembly/dialect/-%23-asm-dialect--asm-dialect-scope"></a><a name="/v5/api/other/assembly/dialect/"></a><h2 class="show-anchors"><div>Scopes<div class="anchors"><a class="self" href="#/v5/api/other/assembly/dialect/-%23-asm-dialect-scope"></a></div></div></h2><p>A common case in Ethereum is to have one program embedded in another.</p>
|
|
|
|
<p>The most common use of this is embedding a Contract <b>runtime bytecode</b> within a <b>deployment bytecode</b>, which can be used as <b>init code</b>.</p>
|
|
|
|
<p>When deploying a program to Ethereum, an <b>init transaction</b> is used. An <i>init transaction</i> has a null <code class="inline">to</code> address and contains bytecode in the <code class="inline">data</code>. This <code class="inline">data</code> bytecode is a program, that when executed returns some other bytecode as a result, this restul is the bytecode to be installed.</p>
|
|
|
|
<p>Therefore it is important that embedded code uses jumps relative to itself, not the entire program it is embedded in, which also means that a jump can <b>only</b> target its own scope, no parent or child scopes. This is enforced by the assembler.</p>
|
|
|
|
<p>A scope may access the offset of any child <a href="#/v5/api/other/assembly/dialect/-%23-asm-dialect-datasegment">Data Segment</a> or child <a href="#/v5/api/other/assembly/dialect/-%23-asm-dialect-scope">Scopes</a> (with respect to itself) and may access the length of any <a href="#/v5/api/other/assembly/dialect/-%23-asm-dialect-datasegment">Data Segment</a> or <a href="#/v5/api/other/assembly/dialect/-%23-asm-dialect-scope">Scopes</a> anywhere in the program.</p>
|
|
|
|
<p>Every program in the <b>Ethers ASM Dialect</b> has a top-leve scope named <code class="inline">_</code>.</p>
|
|
|
|
<a name="/v5/api/other/assembly/dialect/-%23-asm-dialect-datasegment"></a><a name="/v5/api/other/assembly/dialect/-%23-asm-dialect--asm-dialect-datasegment"></a><a name="/v5/api/other/assembly/dialect/"></a><h2 class="show-anchors"><div>Data Segment<div class="anchors"><a class="self" href="#/v5/api/other/assembly/dialect/-%23-asm-dialect-datasegment"></a></div></div></h2><p>A <b>Data Segment</b> allows arbitrary data to be embedded into a program, which can be useful for lookup tables or deploy-time constants.</p>
|
|
|
|
<p>An emtpty <b>Data Segment</b> can also be used when a labelled location is required, but without the <code class="inline">JUMPDEST</code> which a <a href="#/v5/api/other/assembly/dialect/-%23-asm-dialect-label">Labels</a> adds.</p>
|
|
|
|
<p>@TODO: Example</p>
|
|
|
|
<a name="/v5/api/other/assembly/dialect/-%23-asm-dialect-links"></a><a name="/v5/api/other/assembly/dialect/-%23-asm-dialect--asm-dialect-links"></a><a name="/v5/api/other/assembly/dialect/"></a><h2 class="show-anchors"><div>Links<div class="anchors"><a class="self" href="#/v5/api/other/assembly/dialect/-%23-asm-dialect-links"></a></div></div></h2><p>A <b>Link</b> allows access to a <a href="#/v5/api/other/assembly/dialect/-%23-asm-dialect-scope">Scopes</a>, <a href="#/v5/api/other/assembly/dialect/-%23-asm-dialect-datasegment">Data Segment</a> or <a href="#/v5/api/other/assembly/dialect/-%23-asm-dialect-label">Labels</a>.</p>
|
|
|
|
<p>To access the byte offset of a labelled item, use <code class="inline">$foobar</code>.</p>
|
|
|
|
<p>For a <a href="#/v5/api/other/assembly/dialect/-%23-asm-dialect-label">Labels</a>, the target must be directly reachable within this scope. For a <a href="#/v5/api/other/assembly/dialect/-%23-asm-dialect-datasegment">Data Segment</a> or a <a href="#/v5/api/other/assembly/dialect/-%23-asm-dialect-scope">Scopes</a>, it can be inside the same scope or any child scope.</p>
|
|
|
|
<p>For a <a href="#/v5/api/other/assembly/dialect/-%23-asm-dialect-datasegment">Data Segment</a> or a <a href="#/v5/api/other/assembly/dialect/-%23-asm-dialect-label">Labels</a>, there is an additional type of <b>Link</b>, which provides the length of the data or bytecode respectively. A <b>Length Link</b> is accessed by <code class="inline">#foobar</code> and is pushed on the stack as a literal.</p>
|
|
|
|
<a name="/v5/api/other/assembly/dialect/-%23-asm-dialect-placeholder"></a><a name="/v5/api/other/assembly/dialect/-%23-asm-dialect--asm-dialect-placeholder"></a><a name="/v5/api/other/assembly/dialect/"></a><h2 class="show-anchors"><div>Stack Placeholders<div class="anchors"><a class="self" href="#/v5/api/other/assembly/dialect/-%23-asm-dialect-placeholder"></a></div></div></h2><p>@TODO: exampl</p>
|
|
|
|
<a name="/v5/api/other/assembly/dialect/-%23-asm-dialect-scripting"></a><a name="/v5/api/other/assembly/dialect/-%23-asm-dialect--asm-dialect-scripting"></a><a name="/v5/api/other/assembly/dialect/"></a><h2 class="show-anchors"><div>Evaluation and Excution<div class="anchors"><a class="self" href="#/v5/api/other/assembly/dialect/-%23-asm-dialect-scripting"></a></div></div></h2>
|
|
<div class="page-separator"></div><a name="/v5/api/other/assembly/api/-%23-asm-utilities"></a><a name="/v5/api/other/assembly/api/-%23-asm-utilities"></a><a name="/v5/api/other/assembly/api/"></a><h1 class="show-anchors"><div>Utilities<div class="anchors"><a class="self" href="#/v5/api/other/assembly/api/-%23-asm-utilities"></a></div></div></h1>
|
|
<a name="/v5/api/other/assembly/api/-%23-asm-utilities--assembler"></a><a name="/v5/api/other/assembly/api/"></a><h2 class="show-anchors"><div>Assembler<div class="anchors"><a class="self" href="#/v5/api/other/assembly/api/-%23-asm-utilities--assembler"></a></div></div></h2><p>The assembler utilities allow parsing and assembling an <a href="#/v5/api/other/assembly/dialect/">Ethers ASM Dialect</a> source file.</p>
|
|
|
|
<a name="/v5/api/other/assembly/api/-%23-asm-parse"></a><div class="property show-anchors"><div class="signature"><span class="path">asm</span><span class="symbol">.</span><span class="method">parse</span><span class="symbol">(</span> <span class="param">code</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/other/assembly/ast/-%23-asm-node">Node</a></span><div class="anchors"><a class="self" href="#/v5/api/other/assembly/api/-%23-asm-parse"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/asm/src.ts/assembler.ts#L1245">source</a></div></div><div class="body"><p>Parse an ethers-format assembly file and return the <a href="#/v5/api/other/assembly/ast/">Abstract Syntax Tree</a>.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">asm</span><span class="symbol">.</span><span class="method">assemble</span><span class="symbol">(</span> <span class="param">node</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a> ></span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/asm/src.ts/assembler.ts#L1316">source</a></div></div><div class="body"><p>Performs assembly of the <a href="#/v5/api/other/assembly/ast/">Abstract Syntax Tree</a> <i>node</i> and return the resulting bytecode representation.</p>
|
|
|
|
</div></div><a name="/v5/api/other/assembly/api/-%23-asm-utilities--disassembler"></a><a name="/v5/api/other/assembly/api/"></a><h2 class="show-anchors"><div>Disassembler<div class="anchors"><a class="self" href="#/v5/api/other/assembly/api/-%23-asm-utilities--disassembler"></a></div></div></h2><p>The <b>Disassembler</b> utilities make it easy to convert bytecode into an object which can easily be examined for program structure.</p>
|
|
|
|
<div class="property show-anchors"><div class="signature"><span class="path">asm</span><span class="symbol">.</span><span class="method">disassemble</span><span class="symbol">(</span> <span class="param">bytecode</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/other/assembly/api/-%23-asm-bytecode">Bytecode</a></span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/asm/src.ts/assembler.ts#L601">source</a></div></div><div class="body"><p>Returns an array of Operations given <i>bytecode</i>.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">asm</span><span class="symbol">.</span><span class="method">formatBytecode</span><span class="symbol">(</span> <span class="param">operations</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">string</span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/asm/src.ts/assembler.ts#L645">source</a></div></div><div class="body"><p>Create a formatted output of an array of <a href="#/v5/api/other/assembly/api/-%23-asm-operation">Operation</a>.</p>
|
|
|
|
</div></div><a name="/v5/api/other/assembly/api/-%23-asm-bytecode"></a><a name="/v5/api/other/assembly/api/-%23-asm-utilities--disassembler--asm-bytecode"></a><a name="/v5/api/other/assembly/api/"></a><h3 class="show-anchors"><div>Bytecode<span class="inherits"> inherits Array<<a href="#/v5/api/other/assembly/api/-%23-asm-operation">Operation</a>></span><div class="anchors"><a class="self" href="#/v5/api/other/assembly/api/-%23-asm-bytecode"></a></div></div></h3><p>Each arary index represents an operation, collapsing multi-byte operations (i.e. <code class="inline">PUSH</code>) into a single operation.</p>
|
|
|
|
<div class="property show-anchors"><div class="signature"><span class="path">bytecode</span><span class="symbol">.</span><span class="method">getOperation</span><span class="symbol">(</span> <span class="param">offset</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/other/assembly/api/-%23-asm-operation">Operation</a></span><div class="anchors"></div></div><div class="body"><p>Get the operation at a given <i>offset</i> into the bytecode. This ensures that the byte at <i>offset</i> is an operation and not data contained within a <code class="inline">PUSH</code>, in which case null it returned.</p>
|
|
|
|
</div></div><a name="/v5/api/other/assembly/api/-%23-asm-operation"></a><a name="/v5/api/other/assembly/api/-%23-asm-utilities--disassembler--asm-operation"></a><a name="/v5/api/other/assembly/api/"></a><h3 class="show-anchors"><div>Operation<div class="anchors"><a class="self" href="#/v5/api/other/assembly/api/-%23-asm-operation"></a></div></div></h3><p>An <b>Operation</b> is a single command from a disassembled bytecode stream.</p>
|
|
|
|
<div class="property show-anchors"><div class="signature"><span class="path">operation</span><span class="symbol">.</span><span class="method">opcode</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/other/assembly/api/-%23-asm-opcode">Opcode</a></span><div class="anchors"></div></div><div class="body"><p>The opcode for this Operation.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">operation</span><span class="symbol">.</span><span class="method">offset</span> <span class="arrow">⇒</span> <span class="returns">number</span><div class="anchors"></div></div><div class="body"><p>The offset into the bytecode for this Operation.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">operation</span><span class="symbol">.</span><span class="method">pushValue</span> <span class="arrow">⇒</span> <span class="returns">string< <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a> ></span><div class="anchors"></div></div><div class="body"><p>If the opcode is a <code class="inline">PUSH</code>, this is the value of that push</p>
|
|
|
|
</div></div><a name="/v5/api/other/assembly/api/-%23-asm-opcode"></a><a name="/v5/api/other/assembly/api/-%23-asm-utilities--asm-opcode"></a><a name="/v5/api/other/assembly/api/"></a><h2 class="show-anchors"><div>Opcode<div class="anchors"><a class="self" href="#/v5/api/other/assembly/api/-%23-asm-opcode"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/asm/src.ts/opcodes.ts#L21">source</a></div></div></h2>
|
|
<div class="property show-anchors"><div class="signature"><span class="path">asm</span><span class="symbol">.</span><span class="path">Opcode</span><span class="symbol">.</span><span class="method">from</span><span class="symbol">(</span> <span class="param">valueOrMnemonic</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/other/assembly/api/-%23-asm-opcode">Opcode</a></span><div class="anchors"></div></div><div class="body"><p>Create a new instnace of an Opcode for a given numeric value (e.g. 0x60 is PUSH1) or mnemonic string (e.g. "PUSH1").</p>
|
|
|
|
</div></div><a name="/v5/api/other/assembly/api/-%23-asm-utilities--asm-opcode--properties"></a><a name="/v5/api/other/assembly/api/"></a><h3 class="show-anchors"><div>Properties<div class="anchors"><a class="self" href="#/v5/api/other/assembly/api/-%23-asm-utilities--asm-opcode--properties"></a></div></div></h3>
|
|
<div class="property show-anchors"><div class="signature"><span class="path">opcode</span><span class="symbol">.</span><span class="method">value</span> <span class="arrow">⇒</span> <span class="returns">number</span><div class="anchors"></div></div><div class="body"><p>The value (bytecode as a number) of this opcode.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">opcode</span><span class="symbol">.</span><span class="method">mnemonic</span> <span class="arrow">⇒</span> <span class="returns">string</span><div class="anchors"></div></div><div class="body"><p>The mnemonic string of this opcode.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">opcode</span><span class="symbol">.</span><span class="method">delta</span> <span class="arrow">⇒</span> <span class="returns">number</span><div class="anchors"></div></div><div class="body"><p>The number of items this opcode will consume from the stack.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">opcode</span><span class="symbol">.</span><span class="method">alpha</span> <span class="arrow">⇒</span> <span class="returns">number</span><div class="anchors"></div></div><div class="body"><p>The number of items this opcode will push onto the stack.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">opcode</span><span class="symbol">.</span><span class="method">doc</span> <span class="arrow">⇒</span> <span class="returns">string</span><div class="anchors"></div></div><div class="body"><p>A short description of what this opcode does.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">opcode</span><span class="symbol">.</span><span class="method">isMemory</span><span class="symbol">(</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">"read" | "write" | "full"</span><div class="anchors"></div></div><div class="body"><p>Returns true if the opcode accesses memory.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">opcode</span><span class="symbol">.</span><span class="method">isStatic</span><span class="symbol">(</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">boolean</span><div class="anchors"></div></div><div class="body"><p>Returns true if the opcode cannot change state.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">opcode</span><span class="symbol">.</span><span class="method">isJump</span><span class="symbol">(</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">boolean</span><div class="anchors"></div></div><div class="body"><p>Returns true if the opcode is a jumper operation.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">opcode</span><span class="symbol">.</span><span class="method">isPush</span><span class="symbol">(</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">number</span><div class="anchors"></div></div><div class="body"><p>Returns 0 if the opcode is not a <code class="inline">PUSH*</code>, or the number of bytes this opcode will push if it is.</p>
|
|
|
|
</div></div><div class="page-separator"></div><a name="/v5/api/other/assembly/ast/-%23-asm-ast"></a><a name="/v5/api/other/assembly/ast/-%23-asm-ast"></a><a name="/v5/api/other/assembly/ast/"></a><h1 class="show-anchors"><div>Abstract Syntax Tree<div class="anchors"><a class="self" href="#/v5/api/other/assembly/ast/-%23-asm-ast"></a></div></div></h1><p>Parsing a file using the <a href="#/v5/api/other/assembly/dialect/">Ethers ASM Dialect</a> will generate an Abstract Syntax Tree. The root node will always be a <a href="#/v5/api/other/assembly/ast/-%23-asm-scopenode">ScopeNode</a> whose name is <code class="inline">_</code>.</p>
|
|
|
|
<p>To parse a file into an Abstract Syntax tree, use the <a href="#/v5/api/other/assembly/api/-%23-asm-parse">parse</a> function.</p>
|
|
|
|
<a name="/v5/api/other/assembly/ast/-%23-asm-ast--types"></a><a name="/v5/api/other/assembly/ast/"></a><h2 class="show-anchors"><div>Types<div class="anchors"><a class="self" href="#/v5/api/other/assembly/ast/-%23-asm-ast--types"></a></div></div></h2>
|
|
<a name="/v5/api/other/assembly/ast/-%23-asm-location"></a><a name="/v5/api/other/assembly/ast/-%23-asm-ast--types--asm-location"></a><a name="/v5/api/other/assembly/ast/"></a><h3 class="show-anchors"><div>Location<div class="anchors"><a class="self" href="#/v5/api/other/assembly/ast/-%23-asm-location"></a></div></div></h3>
|
|
<div class="property show-anchors"><div class="signature"><span class="method">offset</span> <span class="arrow">⇒</span> <span class="returns">number</span><div class="anchors"></div></div><div class="body"><p>The offset into the source code to the start of this node.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="method">length</span> <span class="arrow">⇒</span> <span class="returns">number</span><div class="anchors"></div></div><div class="body"><p>The length of characters in the source code to the end of this node.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="method">source</span> <span class="arrow">⇒</span> <span class="returns">string</span><div class="anchors"></div></div><div class="body"><p>The source code of this node.</p>
|
|
|
|
</div></div><a name="/v5/api/other/assembly/ast/-%23-asm-ast--nodes"></a><a name="/v5/api/other/assembly/ast/"></a><h2 class="show-anchors"><div>Nodes<div class="anchors"><a class="self" href="#/v5/api/other/assembly/ast/-%23-asm-ast--nodes"></a></div></div></h2><p>@TODO: Place a diagram here showing the hierarchy</p>
|
|
|
|
<a name="/v5/api/other/assembly/ast/-%23-asm-node"></a><a name="/v5/api/other/assembly/ast/-%23-asm-ast--nodes--asm-node"></a><a name="/v5/api/other/assembly/ast/"></a><h3 class="show-anchors"><div>Node<div class="anchors"><a class="self" href="#/v5/api/other/assembly/ast/-%23-asm-node"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/asm/src.ts/assembler.ts#L156">source</a></div></div></h3>
|
|
<div class="property show-anchors"><div class="signature"><span class="path">node</span><span class="symbol">.</span><span class="method">tag</span> <span class="arrow">⇒</span> <span class="returns">string</span><div class="anchors"></div></div><div class="body"><p>A unique tag for this node for the lifetime of the process.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">node</span><span class="symbol">.</span><span class="method">location</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/other/assembly/ast/-%23-asm-location">Location</a></span><div class="anchors"></div></div><div class="body"><p>The source code and location within the source code that this node represents.</p>
|
|
|
|
</div></div><a name="/v5/api/other/assembly/ast/-%23-asm-valuenode"></a><a name="/v5/api/other/assembly/ast/-%23-asm-ast--nodes--asm-valuenode"></a><a name="/v5/api/other/assembly/ast/"></a><h3 class="show-anchors"><div>ValueNode<span class="inherits"> inherits <a href="#/v5/api/other/assembly/ast/-%23-asm-node">Node</a></span><div class="anchors"><a class="self" href="#/v5/api/other/assembly/ast/-%23-asm-valuenode"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/asm/src.ts/assembler.ts#L213">source</a></div></div></h3><p>A <b>ValueNode</b> is a node which may manipulate the stack.</p>
|
|
|
|
<a name="/v5/api/other/assembly/ast/-%23-asm-literalnode"></a><a name="/v5/api/other/assembly/ast/-%23-asm-ast--nodes--asm-literalnode"></a><a name="/v5/api/other/assembly/ast/"></a><h3 class="show-anchors"><div>LiteralNode<span class="inherits"> inherits <a href="#/v5/api/other/assembly/ast/-%23-asm-valuenode">ValueNode</a></span><div class="anchors"><a class="self" href="#/v5/api/other/assembly/ast/-%23-asm-literalnode"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/asm/src.ts/assembler.ts#L237">source</a></div></div></h3>
|
|
<div class="property show-anchors"><div class="signature"><span class="path">literalNode</span><span class="symbol">.</span><span class="method">value</span> <span class="arrow">⇒</span> <span class="returns">string</span><div class="anchors"></div></div><div class="body"><p>The literal value of this node, which may be a <a href="#/v5/api/utils/bytes/-%23-DataHexString">DataHexString</a> or string of a decimal number.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">literalNode</span><span class="symbol">.</span><span class="method">verbatim</span> <span class="arrow">⇒</span> <span class="returns">boolean</span><div class="anchors"></div></div><div class="body"><p>This is true in a <a href="#/v5/api/other/assembly/ast/-%23-asm-datanode">DataNode</a> context, since in that case the value should be taken verbatim and no <code class="inline">PUSH</code> operation shoud be added, otherwise false.</p>
|
|
|
|
</div></div><a name="/v5/api/other/assembly/ast/-%23-asm-popnode"></a><a name="/v5/api/other/assembly/ast/-%23-asm-ast--nodes--asm-popnode"></a><a name="/v5/api/other/assembly/ast/"></a><h3 class="show-anchors"><div>PopNode<span class="inherits"> inherits <a href="#/v5/api/other/assembly/ast/-%23-asm-valuenode">ValueNode</a></span><div class="anchors"><a class="self" href="#/v5/api/other/assembly/ast/-%23-asm-popnode"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/asm/src.ts/assembler.ts#L265">source</a></div></div></h3><p>A <b>PopNode</b> is used to store a place-holder for an implicit pop from the stack. It represents the code for an implicit place-holder (i.e. <code class="inline">$$</code>) or an explicit place-holder (e.g. <code class="inline">$1</code>), which indicates the expect stack position to consume.</p>
|
|
|
|
<div class="property show-anchors"><div class="signature"><span class="path">literalNode</span><span class="symbol">.</span><span class="method">index</span> <span class="arrow">⇒</span> <span class="returns">number</span><div class="anchors"></div></div><div class="body"><p>The index this <b>PopNode</b> is representing. For an implicit place-holder this is <code class="inline">0</code>.</p>
|
|
|
|
</div></div><a name="/v5/api/other/assembly/ast/-%23-asm-linknode"></a><a name="/v5/api/other/assembly/ast/-%23-asm-ast--nodes--asm-linknode"></a><a name="/v5/api/other/assembly/ast/"></a><h3 class="show-anchors"><div>LinkNode<span class="inherits"> inherits <a href="#/v5/api/other/assembly/ast/-%23-asm-valuenode">ValueNode</a></span><div class="anchors"><a class="self" href="#/v5/api/other/assembly/ast/-%23-asm-linknode"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/asm/src.ts/assembler.ts#L282">source</a></div></div></h3><p>A <b>LinkNode</b> represents a link to another <a href="#/v5/api/other/assembly/ast/-%23-asm-node">Node</a>'s data, for example <code class="inline">$foo</code> or <code class="inline">#bar</code>.</p>
|
|
|
|
<div class="property show-anchors"><div class="signature"><span class="path">linkNode</span><span class="symbol">.</span><span class="method">label</span> <span class="arrow">⇒</span> <span class="returns">string</span><div class="anchors"></div></div><div class="body"><p>Te name of the target node.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">linkNode</span><span class="symbol">.</span><span class="method">type</span> <span class="arrow">⇒</span> <span class="returns">"offset" | "length"</span><div class="anchors"></div></div><div class="body"><p>Whether this node is for an offset or a length value of the target node.</p>
|
|
|
|
</div></div><a name="/v5/api/other/assembly/ast/-%23-asm-opcodenode"></a><a name="/v5/api/other/assembly/ast/-%23-asm-ast--nodes--asm-opcodenode"></a><a name="/v5/api/other/assembly/ast/"></a><h3 class="show-anchors"><div>OpcodeNode<span class="inherits"> inherits <a href="#/v5/api/other/assembly/ast/-%23-asm-valuenode">ValueNode</a></span><div class="anchors"><a class="self" href="#/v5/api/other/assembly/ast/-%23-asm-opcodenode"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/asm/src.ts/assembler.ts#L367">source</a></div></div></h3>
|
|
<div class="property show-anchors"><div class="signature"><span class="path">opcodeNode</span><span class="symbol">.</span><span class="method">opcode</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/other/assembly/api/-%23-asm-opcode">Opcode</a></span><div class="anchors"></div></div><div class="body"><p>The opcode for this Node.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">opcodeNode</span><span class="symbol">.</span><span class="method">operands</span> <span class="arrow">⇒</span> <span class="returns">Array< <a href="#/v5/api/other/assembly/ast/-%23-asm-valuenode">ValueNode</a> ></span><div class="anchors"></div></div><div class="body"><p>A list of all operands passed into this Node.</p>
|
|
|
|
</div></div><a name="/v5/api/other/assembly/ast/-%23-asm-evaluationnode"></a><a name="/v5/api/other/assembly/ast/-%23-asm-ast--nodes--asm-evaluationnode"></a><a name="/v5/api/other/assembly/ast/"></a><h3 class="show-anchors"><div>EvaluationNode<span class="inherits"> inherits <a href="#/v5/api/other/assembly/ast/-%23-asm-valuenode">ValueNode</a></span><div class="anchors"><a class="self" href="#/v5/api/other/assembly/ast/-%23-asm-evaluationnode"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/asm/src.ts/assembler.ts#L517">source</a></div></div></h3><p>An <b>EvaluationNode</b> is used to execute code and insert the results but does not generate any output assembly, using the <code class="inline">{{! code here }}</code> syntax.</p>
|
|
|
|
<div class="property show-anchors"><div class="signature"><span class="path">literalNode</span><span class="symbol">.</span><span class="method">verbatim</span> <span class="arrow">⇒</span> <span class="returns">boolean</span><div class="anchors"></div></div><div class="body"><p>This is true in a <a href="#/v5/api/other/assembly/ast/-%23-asm-datanode">DataNode</a> context, since in that case the value should be taken verbatim and no <code class="inline">PUSH</code> operation shoud be added, otherwise false.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">evaluationNode</span><span class="symbol">.</span><span class="method">script</span> <span class="arrow">⇒</span> <span class="returns">string</span><div class="anchors"></div></div><div class="body"><p>The code to evaluate and produce the result to use as a literal.</p>
|
|
|
|
</div></div><a name="/v5/api/other/assembly/ast/-%23-asm-executionnode"></a><a name="/v5/api/other/assembly/ast/-%23-asm-ast--nodes--asm-executionnode"></a><a name="/v5/api/other/assembly/ast/"></a><h3 class="show-anchors"><div>ExecutionNode<span class="inherits"> inherits <a href="#/v5/api/other/assembly/ast/-%23-asm-node">Node</a></span><div class="anchors"><a class="self" href="#/v5/api/other/assembly/ast/-%23-asm-executionnode"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/asm/src.ts/assembler.ts#L546">source</a></div></div></h3><p>An <b>ExecutionNode</b> is used to execute code but does not generate any output assembly, using the <code class="inline">{{! code here }}</code> syntax.</p>
|
|
|
|
<div class="property show-anchors"><div class="signature"><span class="path">evaluationNode</span><span class="symbol">.</span><span class="method">script</span> <span class="arrow">⇒</span> <span class="returns">string</span><div class="anchors"></div></div><div class="body"><p>The code to execute. Any result is ignored.</p>
|
|
|
|
</div></div><a name="/v5/api/other/assembly/ast/-%23-asm-labellednode"></a><a name="/v5/api/other/assembly/ast/-%23-asm-ast--nodes--asm-labellednode"></a><a name="/v5/api/other/assembly/ast/"></a><h3 class="show-anchors"><div>LabelledNode<span class="inherits"> inherits <a href="#/v5/api/other/assembly/ast/-%23-asm-node">Node</a></span><div class="anchors"><a class="self" href="#/v5/api/other/assembly/ast/-%23-asm-labellednode"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/asm/src.ts/assembler.ts#L418">source</a></div></div></h3><p>A <b>LabelledNode</b> is used for any Node that has a name, and can therefore be targetted by a <a href="#/v5/api/other/assembly/ast/-%23-asm-linknode">LinkNode</a>.</p>
|
|
|
|
<div class="property show-anchors"><div class="signature"><span class="path">labelledNode</span><span class="symbol">.</span><span class="method">name</span> <span class="arrow">⇒</span> <span class="returns">string</span><div class="anchors"></div></div><div class="body"><p>The name of this node.</p>
|
|
|
|
</div></div><a name="/v5/api/other/assembly/ast/-%23-asm-labelnode"></a><a name="/v5/api/other/assembly/ast/-%23-asm-ast--nodes--asm-labelnode"></a><a name="/v5/api/other/assembly/ast/"></a><h3 class="show-anchors"><div>LabelNode<span class="inherits"> inherits <a href="#/v5/api/other/assembly/ast/-%23-asm-labellednode">LabelledNode</a></span><div class="anchors"><a class="self" href="#/v5/api/other/assembly/ast/-%23-asm-labelnode"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/asm/src.ts/assembler.ts#L429">source</a></div></div></h3><p>A <b>LabelNode</b> is used as a place to <code class="inline">JUMP</code> to by referencing it name, using <code class="inline">@myLabel:</code>. A <code class="inline">JUMPDEST</code> is automatically inserted at the bytecode offset.</p>
|
|
|
|
<a name="/v5/api/other/assembly/ast/-%23-asm-datanode"></a><a name="/v5/api/other/assembly/ast/-%23-asm-ast--nodes--asm-datanode"></a><a name="/v5/api/other/assembly/ast/"></a><h3 class="show-anchors"><div>DataNode<span class="inherits"> inherits <a href="#/v5/api/other/assembly/ast/-%23-asm-labellednode">LabelledNode</a></span><div class="anchors"><a class="self" href="#/v5/api/other/assembly/ast/-%23-asm-datanode"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/asm/src.ts/assembler.ts#L465">source</a></div></div></h3><p>A <b>DataNode</b> allows for data to be inserted directly into the output assembly, using <code class="inline">@myData[ ... ]</code>. The data is padded if needed to ensure values that would otherwise be regarded as a <code class="inline">PUSH</code> value does not impact anything past the data.</p>
|
|
|
|
<div class="property show-anchors"><div class="signature"><span class="path">dataNode</span><span class="symbol">.</span><span class="method">data</span> <span class="arrow">⇒</span> <span class="returns">Array< <a href="#/v5/api/other/assembly/ast/-%23-asm-valuenode">ValueNode</a> ></span><div class="anchors"></div></div><div class="body"><p>The child nodes, which each represent a verbatim piece of data in insert.</p>
|
|
|
|
</div></div><a name="/v5/api/other/assembly/ast/-%23-asm-scopenode"></a><a name="/v5/api/other/assembly/ast/-%23-asm-ast--nodes--asm-scopenode"></a><a name="/v5/api/other/assembly/ast/"></a><h3 class="show-anchors"><div>ScopeNode<span class="inherits"> inherits <a href="#/v5/api/other/assembly/ast/-%23-asm-labellednode">LabelledNode</a></span><div class="anchors"><a class="self" href="#/v5/api/other/assembly/ast/-%23-asm-scopenode"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/asm/src.ts/assembler.ts#L565">source</a></div></div></h3><p>A <b>ScopeNode</b> allows a new frame of reference that all <a href="#/v5/api/other/assembly/ast/-%23-asm-linknode">LinkNode</a>'s will use when resolving offset locations, using <code class="inline">@myScope{ ... }</code>.</p>
|
|
|
|
<div class="property show-anchors"><div class="signature"><span class="path">scopeNode</span><span class="symbol">.</span><span class="method">statements</span> <span class="arrow">⇒</span> <span class="returns">Array< <a href="#/v5/api/other/assembly/ast/-%23-asm-node">Node</a> ></span><div class="anchors"></div></div><div class="body"><p>The list of child nodes for this scope.</p>
|
|
|
|
</div></div><div class="page-separator"></div><a name="/v5/api/other/hardware/-%23-hardware-wallets"></a><a name="/v5/api/other/hardware/"></a><h1 class="show-anchors"><div>Hardware Wallets<div class="anchors"><a class="self" href="#/v5/api/other/hardware/-%23-hardware-wallets"></a></div></div></h1>
|
|
<a name="/v5/api/other/hardware/-%23-hw-ledger"></a><a name="/v5/api/other/hardware/-%23-hardware-wallets--hw-ledger"></a><a name="/v5/api/other/hardware/"></a><h2 class="show-anchors"><div>LedgerSigner<span class="inherits"> inherits <a href="#/v5/api/signer/-%23-Signer">Signer</a></span><div class="anchors"><a class="self" href="#/v5/api/other/hardware/-%23-hw-ledger"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/hardware-wallets/src.ts/ledger.ts#L23">source</a></div></div></h2><p>The <a href="https://www.ledger.com">Ledger Hardware Wallets</a> are a fairly popular brand.</p>
|
|
|
|
<div class="code-title"><div>Importing in ES6 or TypeScript</div></div><div class="code">import { LedgerSigner } from "@ethersproject/hardware-wallets";
|
|
</div><a name="/v5/api/other/hardware/-%23-hardware-wallets--hw-ledger--api"></a><a name="/v5/api/other/hardware/"></a><h3 class="show-anchors"><div>API<div class="anchors"><a class="self" href="#/v5/api/other/hardware/-%23-hardware-wallets--hw-ledger--api"></a></div></div></h3>
|
|
<div class="property show-anchors"><div class="signature"><span class="modifier">new </span><span class="method">LedgerSigner</span><span class="symbol">(</span> <span class="symbol">[</span> <span class="param">provider</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">type</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">path</span> <span class="symbol">]</span> <span class="symbol">]</span> <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/other/hardware/-%23-hw-ledger">LedgerSigner</a></span><div class="anchors"></div></div><div class="body"><p>Connects to a Ledger Hardware Wallet. The <i>type</i> if left unspecified is determined by the environment; in node the default is "hid" and in the browser "u2f" is the default. The default Ethereum path is used if <i>path</i> is left unspecified.</p>
|
|
|
|
</div></div><div class="page-separator"></div><a name="/v5/api/experimental/-%23-experimental"></a><a name="/v5/api/experimental/"></a><h1 class="show-anchors"><div>Experimental<div class="anchors"><a class="self" href="#/v5/api/experimental/-%23-experimental"></a></div></div></h1><p>The <b>Experimental</b> package is used for features that are not ready to be included in the base library. The API should not be considered stable and does not follow <a href="https://semver.org">semver</a> versioning, so applications requiring it should specify the <i>exact version</i> needed.</p>
|
|
|
|
<a name="/v5/api/experimental/-%23-experimental-brainwallet"></a><a name="/v5/api/experimental/-%23-experimental--experimental-brainwallet"></a><a name="/v5/api/experimental/"></a><h2 class="show-anchors"><div>BrainWallet<span class="inherits"> inherits <a href="#/v5/api/signer/-%23-Wallet">Wallet</a></span><div class="anchors"><a class="self" href="#/v5/api/experimental/-%23-experimental-brainwallet"></a></div></div></h2><p>Ethers removed support for BrainWallets in v4, since they are unsafe and many can be easily guessed, allowing attackers to steal the funds. This class is offered to ensure older systems which used brain wallets can still recover their funds and assets.</p>
|
|
|
|
<div class="property show-anchors"><div class="signature"><span class="path">BrainWallet</span><span class="symbol">.</span><span class="method">generate</span><span class="symbol">(</span> <span class="param">username</span> <span class="symbol">,</span> <span class="param">password</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">progressCallback</span> <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/experimental/-%23-experimental-brainwallet">BrainWallet</a></span><div class="anchors"></div></div><div class="body"><p>Generates a brain wallet, with a slightly improved experience, in which the generated wallet has a mnemonic.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">BrainWallet</span><span class="symbol">.</span><span class="method">generateLegacy</span><span class="symbol">(</span> <span class="param">username</span> <span class="symbol">,</span> <span class="param">password</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">progressCallback</span> <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/experimental/-%23-experimental-brainwallet">BrainWallet</a></span><div class="anchors"></div></div><div class="body"><p>Generate a brain wallet which is compatibile with the ethers v3 and earlier.</p>
|
|
|
|
</div></div><a name="/v5/api/experimental/-%23-experimental-eip1193bridge"></a><a name="/v5/api/experimental/-%23-experimental--experimental-eip1193bridge"></a><a name="/v5/api/experimental/"></a><h2 class="show-anchors"><div>EIP1193Bridge<span class="inherits"> inherits <a href="https://nodejs.org/dist/latest-v13.x/docs/api/events.html#events_class_eventemitter">EventEmitter</a></span><div class="anchors"><a class="self" href="#/v5/api/experimental/-%23-experimental-eip1193bridge"></a></div></div></h2><p>The <b>EIP1193Bridge</b> allows a normal Ethers <a href="#/v5/api/signer/-%23-Signer">Signer</a> and <a href="#/v5/api/providers/provider/">Provider</a> to be exposed in as a standard <a href="https://eips.ethereum.org/EIPS/eip-1193">EIP-1193 Provider</a>, which may be useful when interacting with other libraries.</p>
|
|
|
|
<a name="/v5/api/experimental/-%23-experimental-noncemanager"></a><a name="/v5/api/experimental/-%23-experimental--experimental-noncemanager"></a><a name="/v5/api/experimental/"></a><h2 class="show-anchors"><div>NonceManager<span class="inherits"> inherits <a href="#/v5/api/signer/-%23-Signer">Signer</a></span><div class="anchors"><a class="self" href="#/v5/api/experimental/-%23-experimental-noncemanager"></a></div></div></h2><p>The <b>NonceManager</b> is designed to manage the nonce for a Signer, automatically increasing it as it sends transactions.</p>
|
|
|
|
<p>Currently the NonceManager does not handle re-broadcast. If you attempt to send a lot of transactions to the network on a node that does not control that account, the transaction pool may drop your transactions.</p>
|
|
|
|
<p>In the future, it'd be nice if the <b>NonceManager</b> remembered transactions and watched for them on the network, rebroadcasting transactions that appear to have been dropped.</p>
|
|
|
|
<p>Another future feature will be some sort of failure mode. For example, often a transaction is dependent on another transaction being mined first.</p>
|
|
|
|
<div class="property show-anchors"><div class="signature"><span class="modifier">new </span><span class="method">NonceManager</span><span class="symbol">(</span> <span class="param">signer</span> <span class="symbol">)</span><div class="anchors"></div></div><div class="body"><p>Create a new NonceManager.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">nonceManager</span><span class="symbol">.</span><span class="method">signer</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/signer/-%23-Signer">Signer</a></span><div class="anchors"></div></div><div class="body"><p>The signer whose nonce is being managed.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">nonceManager</span><span class="symbol">.</span><span class="method">provider</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/providers/provider/">Provider</a></span><div class="anchors"></div></div><div class="body"><p>The provider associated with the signer.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">nonceManager</span><span class="symbol">.</span><span class="method">setTransactionCount</span><span class="symbol">(</span> <span class="param">count</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">void</span><div class="anchors"></div></div><div class="body"><p>Set the current transaction count (nonce) for the signer.</p>
|
|
|
|
<p>This may be useful it interacting with the signer outside of using this class.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">nonceManager</span><span class="symbol">.</span><span class="method">increaseTransactionCount</span><span class="symbol">(</span> <span class="symbol">[</span> <span class="param">count</span> = <span class="param">1</span> <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">void</span><div class="anchors"></div></div><div class="body"><p>Bump the current transaction count (nonce) by <i>count</i>.</p>
|
|
|
|
<p>This may be useful it interacting with the signer outside of using this class.</p>
|
|
|
|
</div></div><div class="page-separator"></div><a name="/v5/cli/-%23-command-line-interfaces"></a><a name="/v5/cli/"></a><h1 class="show-anchors"><div>Command Line Interfaces<div class="anchors"><a class="self" href="#/v5/cli/-%23-command-line-interfaces"></a></div></div></h1>
|
|
<div class="toc"><div style="padding-left: 0px"><span class="bullet">•</span><a href="#/v5/cli/ethers/">Sandbox Utility</a></div><div style="padding-left: 0px"><span class="bullet">•</span><a href="#/v5/cli/asm/">Assembler</a></div><div style="padding-left: 0px"><span class="bullet">•</span><a href="#/v5/cli/ens/">Ethereum Naming Service</a></div><div style="padding-left: 0px"><span class="bullet">•</span><a href="#/v5/cli/typescript/">TypeScript</a></div><div style="padding-left: 0px"><span class="bullet">•</span><a href="#/v5/cli/plugin/">Making Your Own</a></div></div><div class="page-separator"></div><a name="/v5/cli/ethers/-%23-sandbox-utility"></a><a name="/v5/cli/ethers/"></a><h1 class="show-anchors"><div>Sandbox Utility<div class="anchors"><a class="self" href="#/v5/cli/ethers/-%23-sandbox-utility"></a></div></div></h1><p>The sandbox utility provides a simple way to use the most common ethers utilities required during learning, debuging and managing interactions with the Ethereum network.</p>
|
|
|
|
<p>If no command is given, it will enter a REPL interface with many of the ethers utilities already exposed.</p>
|
|
|
|
<a name="/v5/cli/ethers/-%23-sandbox-utility--help"></a><a name="/v5/cli/ethers/"></a><h2 class="show-anchors"><div>Help<div class="anchors"><a class="self" href="#/v5/cli/ethers/-%23-sandbox-utility--help"></a></div></div></h2>
|
|
<div class="code">Usage:
|
|
ethers [ COMMAND ] [ ARGS ] [ OPTIONS ]
|
|
|
|
COMMANDS (default: sandbox)
|
|
sandbox Run a REPL VM environment with ethers
|
|
init FILENAME Create a new JSON wallet
|
|
[ --force ] Overwrite any existing files
|
|
fund TARGET Fund TARGET with testnet ether
|
|
info [ TARGET ... ] Dump info for accounts, addresses and ENS names
|
|
send TARGET ETHER Send ETHER ether to TARGET form accounts[0]
|
|
[ --allow-zero ] Allow sending to the address zero
|
|
[ --data DATA ] Include data in the transaction
|
|
sweep TARGET Send all ether from accounts[0] to TARGET
|
|
sign-message MESSAGE Sign a MESSAGE with accounts[0]
|
|
[ --hex ] The message content is hex encoded
|
|
eval CODE Run CODE in a VM with ethers
|
|
run FILENAME Run FILENAME in a VM with ethers
|
|
wait HASH Wait for a transaction HASH to be mined
|
|
wrap-ether VALUE Deposit VALUE into Wrapped Ether (WETH)
|
|
unwrap-ether VALUE Withdraw VALUE from Wrapped Ether (WETH)
|
|
send-token TOKEN ADDRESS VALUE
|
|
Send VALUE tokens (at TOKEN) to ADDRESS
|
|
compile FILENAME Compiles a Solidity contract
|
|
[ --no-optimize ] Do not optimize the compiled output
|
|
[ --warnings ] Error on any warning
|
|
deploy FILENAME Compile and deploy a Solidity contract
|
|
[ --no-optimize ] Do not optimize the compiled output
|
|
[ --contract NAME ] Specify the contract to deploy
|
|
|
|
ACCOUNT OPTIONS
|
|
--account FILENAME Load from a file (JSON, RAW or mnemonic)
|
|
--account RAW_KEY Use a private key (insecure *)
|
|
--account 'MNEMONIC' Use a mnemonic (insecure *)
|
|
--account - Use secure entry for a raw key or mnemonic
|
|
--account-void ADDRESS Use an address as a void signer
|
|
--account-void ENS_NAME Add the resolved address as a void signer
|
|
--account-rpc ADDRESS Add the address from a JSON-RPC provider
|
|
--account-rpc INDEX Add the index from a JSON-RPC provider
|
|
--mnemonic-password Prompt for a password for mnemonics
|
|
--xxx-mnemonic-password Prompt for a (experimental) hard password
|
|
|
|
PROVIDER OPTIONS (default: all + homestead)
|
|
--alchemy Include Alchemy
|
|
--etherscan Include Etherscan
|
|
--infura Include INFURA
|
|
--nodesmith Include nodesmith
|
|
--rpc URL Include a custom JSON-RPC
|
|
--offline Dump signed transactions (no send)
|
|
--network NETWORK Network to connect to (default: homestead)
|
|
|
|
TRANSACTION OPTIONS (default: query network)
|
|
--gasPrice GWEI Default gas price for transactions(in wei)
|
|
--gasLimit GAS Default gas limit for transactions
|
|
--nonce NONCE Initial nonce for the first transaction
|
|
--yes Always accept Siging and Sending
|
|
|
|
OTHER OPTIONS
|
|
--wait Wait until transactions are mined
|
|
--debug Show stack traces for errors
|
|
--help Show this usage and exit
|
|
--version Show this version and exit
|
|
|
|
(*) By including mnemonics or private keys on the command line they are
|
|
possibly readable by other users on your system and may get stored in
|
|
your bash history file. This is NOT recommended.</div><a name="/v5/cli/ethers/-%23-sandbox-utility--examples"></a><a name="/v5/cli/ethers/"></a><h2 class="show-anchors"><div>Examples<div class="anchors"><a class="self" href="#/v5/cli/ethers/-%23-sandbox-utility--examples"></a></div></div></h2>
|
|
<a name="/v5/cli/ethers/-%23-cliex-init"></a><div class="code-title"><div>Creating New Wallets</div></div><div class="code">/home/ethers> ethers init wallet.json
|
|
Creating a new JSON Wallet - wallet.json
|
|
Keep this password and file SAFE!! If lost or forgotten
|
|
it CANNOT be recovered, by ANYone, EVER.
|
|
Choose a password: ******
|
|
Confirm password: ******
|
|
Encrypting... 100%
|
|
New account address: 0x485bcC23ae2E5038ec7ec9b8DCB2A6A6291cC003
|
|
Saved: wallet.json
|
|
|
|
|
|
# If you are planning to try out the Ropsten testnet...
|
|
/home/ethers> ethers --network ropsten fund 0x485bcC23ae2E5038ec7ec9b8DCB2A6A6291cC003
|
|
Transaction Hash: 0x8dc55b8f8dc8076acded97f9e3ed7d6162460c0221e2769806006b6d7d1156e0</div><a name="/v5/cli/ethers/-%23-cliex-send"></a><div class="code-title"><div>Sending Ether and Tokens</div></div><div class="code"># Sending ether
|
|
/home/ricmoo> ethers --account wallet.json send ricmoo.firefly.eth 0.123
|
|
Password (wallet.json): ******
|
|
Decrypting... 100%
|
|
Transaction:
|
|
To: 0x8ba1f109551bD432803012645Ac136ddd64DBA72
|
|
From: 0xaB7C8803962c0f2F5BBBe3FA8bf41cd82AA1923C
|
|
Value: 0.123 ether
|
|
Nonce: 96
|
|
Data: 0x
|
|
Gas Limit: 21000
|
|
Gas Price: 1.2 gwei
|
|
Chain ID: 1
|
|
Network: homestead
|
|
Send Transaction? (y/N/a) y
|
|
Response:
|
|
Hash: 0xc4adf8b379033d7ab679d199aa35e6ceee9a802ca5ab0656af067e911c4a589a
|
|
|
|
|
|
# Sending a token (SAI)
|
|
# NOTE: the contract address could be used instead but
|
|
# popular token contract addresses are also managed
|
|
# by ethers
|
|
/home/ricmoo> ethers --account wallet.json send-token sai.tokens.ethers.eth ricmoo.firefly.eth 1.0
|
|
Sending Tokens:
|
|
To: 0x8ba1f109551bD432803012645Ac136ddd64DBA72
|
|
Token Contract: 0x89d24A6b4CcB1B6fAA2625fE562bDD9a23260359
|
|
Value: 1.0
|
|
Password (wallet.json): ******
|
|
Decrypting... 100%
|
|
Transaction:
|
|
To: 0x89d24A6b4CcB1B6fAA2625fE562bDD9a23260359
|
|
From: 0xaB7C8803962c0f2F5BBBe3FA8bf41cd82AA1923C
|
|
Value: 0.0 ether
|
|
Nonce: 95
|
|
Data: 0xa9059cbb0000000000000000000000008ba1f109551bd432803012645ac136ddd64dba720000000000000000000000000000000000000000000000000de0b6b3a7640000
|
|
Gas Limit: 37538
|
|
Gas Price: 1.0 gwei
|
|
Chain ID: 1
|
|
Network: homestead
|
|
Send Transaction? (y/N/a) y
|
|
Response:
|
|
Hash: 0xd609ecb7e3b5e8d36fd781dffceede3975ece6774b6322ea56cf1e4d0a17e3a1</div><a name="/v5/cli/ethers/-%23-cliex-signing"></a><div class="code-title"><div>Signing Messages</div></div><div class="code">/home/ethers> ethers --account wallet.json sign-message 'Hello World'
|
|
Password (wallet.json): ******
|
|
Decrypting... 100%
|
|
Message:
|
|
Message: "Hello World"
|
|
Message (hex): 0x48656c6c6f20576f726c64
|
|
Sign Message? (y/N/a) y
|
|
Signature
|
|
Flat: 0xca3f0b32a22a5ab97ca8be7e4a36b1e81d565c6822465d769f4faa4aa24539fb122ee5649c8a37c9f5fc8446593674159e3a7b039997cd6ee697a24b787b1a161b
|
|
r: 0xca3f0b32a22a5ab97ca8be7e4a36b1e81d565c6822465d769f4faa4aa24539fb
|
|
s: 0x122ee5649c8a37c9f5fc8446593674159e3a7b039997cd6ee697a24b787b1a16
|
|
vs: 0x122ee5649c8a37c9f5fc8446593674159e3a7b039997cd6ee697a24b787b1a16
|
|
v: 27
|
|
recid: 0</div><a name="/v5/cli/ethers/-%23-cliex-scripting"></a><a name="/v5/cli/ethers/-%23-sandbox-utility--examples--cliex-scripting"></a><a name="/v5/cli/ethers/"></a><h3 class="show-anchors"><div>Scripting<div class="anchors"><a class="self" href="#/v5/cli/ethers/-%23-cliex-scripting"></a></div></div></h3><p>The <code class="inline">eval</code> command can be used to execute simple one-line scripts from the command line to be passed into other commands or stored in script environment variables.</p>
|
|
|
|
<div class="code-title"><div>Get the formatted balance of an account</div></div><div class="code">/home/ethers> ethers --network ropsten \
|
|
--account wallet.json \
|
|
eval \
|
|
'accounts[0].getBalance().then(b => formatEther(b))'
|
|
3.141592653589793238</div><div class="code-title"><div>Get the current block number</div></div><div class="code">/home/ethers> ethers --network rinkeby \
|
|
eval "provider.getBlockNumber()"
|
|
5761009</div><div class="code-title"><div>Convert a Solidity signature to JSON</div></div><div class="code">/home/ethers> ethers eval 'utils.Fragment.from(
|
|
"function balanceOf(address) view returns (uint)"
|
|
).format("json")' | json_pp
|
|
{
|
|
"inputs" : [
|
|
{
|
|
"type" : "address",
|
|
"name" : "owner"
|
|
}
|
|
],
|
|
"type" : "function",
|
|
"payble" : false,
|
|
"stateMutability" : "view",
|
|
"ouputs" : [
|
|
{
|
|
"type" : "uint256"
|
|
}
|
|
],
|
|
"name" : "balanceOf",
|
|
"constant" : true
|
|
}</div><div class="code-title"><div>Compute a topic hash</div></div><div class="code">/home/ricmoo> ethers eval 'id("Transfer(address,address,uint256")'
|
|
0xd99659a21de82e379975ce8df556f939a4ccb95e92144f38bb0dd35730ffcdd5</div><div class="code-title"><div>Create a random mnemonic</div></div><div class="code">/home/ricmoo> ethers eval 'Wallet.createRandom().mnemonic'
|
|
useful pond inch knock ritual matrix giggle attend dilemma convince coach amazing</div><a name="/v5/cli/ethers/-%23-cliex-mnemonicpassword"></a><a name="/v5/cli/ethers/-%23-sandbox-utility--examples--cliex-mnemonicpassword"></a><a name="/v5/cli/ethers/"></a><h3 class="show-anchors"><div>Using Mnemonics (with a password)<div class="anchors"><a class="self" href="#/v5/cli/ethers/-%23-cliex-mnemonicpassword"></a></div></div></h3><p>All mnemonic phrases have a password, but the default is to use the empty string (i.e. <code class="inline">""</code>) as the password. If you have a password on your mnemonic, the <code class="inline">--mnemonic-password</code> will prompt for the password to use to decrypt the account.</p>
|
|
|
|
<div class="code">/home/ricmoo> ethers --account mnemonic.txt --mnemonic-password
|
|
Password (mnemonic): ******
|
|
network: homestead (chainId: 1)
|
|
homestead> accounts[0].getAddress()
|
|
<Promise id=0 resolved>
|
|
'0x6d3F723EC1B73141AA4aC248c3ab34A5a1DAD776'
|
|
homestead></div><a name="/v5/cli/ethers/-%23-cliex-mnemonicpassword-xxx"></a><a name="/v5/cli/ethers/-%23-sandbox-utility--examples--cliex-mnemonicpassword-xxx"></a><a name="/v5/cli/ethers/"></a><h3 class="show-anchors"><div>Using Mnemonics (with experimental memory-hard passwords)<div class="anchors"><a class="self" href="#/v5/cli/ethers/-%23-cliex-mnemonicpassword-xxx"></a></div></div></h3><p>The <code class="inline">--xxx-mnemonic-password</code> is similar to the <code class="inline">--mnemonic-password</code> options, which uses a password to decrypt the account for a mnemonic, however it passes the password through the <a href="https://en.wikipedia.org/wiki/Scrypt">scrypt</a> <i>password-based key derivation function</i> first, which is intentionally slow and makes a brute-force attack far more difficult.</p>
|
|
|
|
<div class="code">/home/ricmoo> ethers --account mnemonic.txt --xxx-mnemonic-password
|
|
Password (mnemonic; experimental - hard): ******
|
|
Decrypting... 100%
|
|
network: homestead (chainId: 1)
|
|
homestead> accounts[0].getAddress()
|
|
<Promise id=0 resolved>
|
|
'0x56FC8792cC17971C19bEC4Ced978beEA44711EeD'
|
|
homestead></div><div class="definition container-box warning"><div class="term">Note</div><div class="body"><p>This is still an experimental feature (hence the <code class="inline">xxx</code>).</p>
|
|
|
|
</div></div><div class="page-separator"></div><a name="/v5/cli/asm/-%23-cli-asm"></a><a name="/v5/cli/asm/-%23-cli-asm"></a><a name="/v5/cli/asm/"></a><h1 class="show-anchors"><div>Assembler<div class="anchors"><a class="self" href="#/v5/cli/asm/-%23-cli-asm"></a></div></div></h1><p>The assembler Command-Line utility allows you to assemble the <a href="#/v5/api/other/assembly/dialect/">Ethers ASM Dialect</a> into deployable EVM bytecode and disassemle EVM bytecode into human-readable mnemonics.</p>
|
|
|
|
<a name="/v5/cli/asm/-%23-cli-asm--help"></a><a name="/v5/cli/asm/"></a><h2 class="show-anchors"><div>Help<div class="anchors"><a class="self" href="#/v5/cli/asm/-%23-cli-asm--help"></a></div></div></h2>
|
|
<div class="code">Usage:
|
|
ethers-asm [ FILENAME ] [ OPTIONS ]
|
|
|
|
OPTIONS
|
|
--define KEY=VALUE provide assembler defines
|
|
--disassemble Disassemble input bytecode
|
|
--ignore-warnings Ignore warnings
|
|
--pic generate position independent code
|
|
--target LABEL output LABEL bytecode (default: _)
|
|
|
|
OTHER OPTIONS
|
|
--debug Show stack traces for errors
|
|
--help Show this usage and exit
|
|
--version Show this version and exit</div><a name="/v5/cli/asm/-%23-cli-asm--example-input-files"></a><a name="/v5/cli/asm/"></a><h2 class="show-anchors"><div>Example Input Files<div class="anchors"><a class="self" href="#/v5/cli/asm/-%23-cli-asm--example-input-files"></a></div></div></h2>
|
|
<div class="code-title"><div>SimpleStore.asm</div></div><div class="code">; SimpleStore (uint)
|
|
|
|
; Set the inital value of 42
|
|
sstore(0, 42)
|
|
|
|
; Init code to deploy myContract
|
|
codecopy(0, $myContract, #myContract)
|
|
return(0, #myContract)
|
|
|
|
@myContract {
|
|
; Non-payable
|
|
jumpi($error, callvalue)
|
|
|
|
; Get the Sighash
|
|
shr({{= 256 - 32 }}, calldataload(0))
|
|
|
|
; getValue()
|
|
dup1
|
|
{{= sighash("getValue()") }}
|
|
jumpi($getValue, eq)
|
|
|
|
; setValue(uint)
|
|
dup1
|
|
{{= sighash("setValue(uint)") }}
|
|
jumpi($setValue, eq)
|
|
|
|
; No matching signature
|
|
@error:
|
|
revert(0, 0)
|
|
|
|
@getValue:
|
|
mstore(0, sload(0))
|
|
return (0, 32)
|
|
|
|
@setValue:
|
|
; Make sure we have exactly a uint
|
|
jumpi($error, iszero(eq(calldatasize, 36)))
|
|
|
|
; Store the value
|
|
sstore(0, calldataload(4))
|
|
return (0, 0)
|
|
|
|
; There is no *need* for the PUSH32, it just makes
|
|
; decompiled code look nicer
|
|
@checksum[
|
|
{{= (defines.checksum ? concat([
|
|
Opcode.from("PUSH32"),
|
|
id(myContract.source)
|
|
]): "0x")
|
|
}}
|
|
]
|
|
}</div><div class="code-title"><div>SimpleStore.bin</div></div><div class="code">0x602a6000556044601160003960446000f334601e5760003560e01c8063209652
|
|
0x5514602457806355241077146030575b60006000fd5b60005460005260206000
|
|
0xf35b6024361415601e5760043560005560006000f3</div><div class="definition container-box note"><div class="term">Note: Bytecode File Syntax</div><div class="body"><p>A bin file may be made up of multiple blocks of bytecode, each may optionally begin with a <code class="inline">0x</code> prefix, all of which <b>must</b> be of even length (since bytes are required, with 2 nibbles per byte)</p>
|
|
|
|
<p>All whitespace is ignored.</p>
|
|
|
|
</div></div><a name="/v5/cli/asm/-%23-cli-asm--assembler-examples"></a><a name="/v5/cli/asm/"></a><h2 class="show-anchors"><div>Assembler Examples<div class="anchors"><a class="self" href="#/v5/cli/asm/-%23-cli-asm--assembler-examples"></a></div></div></h2><p>The assembler converts an <a href="#/v5/api/other/assembly/dialect/">Ethers ASM Dialect</a> into bytecode by running multiple passes of an assemble stage, each pass more closely approximating the final result.</p>
|
|
|
|
<p>This allows small portions of the bytecode to be massaged and tweaked until the bytecode stablizes. This allows for more compact jump destinations and for code to be include more advanced meta-programming techniques.</p>
|
|
|
|
<div class="code">/home/ethers> ethers-asm SimpleStore.asm
|
|
0x602a6000556044601160003960446000f334601e5760003560e01c80632096525514602457806355241077146030575b60006000fd5b60005460005260206000f35b6024361415601e5760043560005560006000f3
|
|
|
|
# Piping in ASM source code
|
|
/home/ethers> cat SimpleStore.asm | ethers-asm
|
|
# Same as above
|
|
|
|
# Setting a define which the ASM file checks and adds a checksum
|
|
/home/ethers> ethers-asm --define checksum SimpleStore.asm
|
|
0x602a6000556065601160003960656000f334601e5760003560e01c80632096525514602457806355241077146030575b60006000fd5b60005460005260206000f35b6024361415601e5760043560005560006000f37f10358310d664c9aeb4bf4ce7a10a6a03176bd23194c8ccbd3160a6dac90774d6</div><a name="/v5/cli/asm/-%23-cli-asm--assembler-examples--options"></a><a name="/v5/cli/asm/"></a><h3 class="show-anchors"><div>Options<div class="anchors"><a class="self" href="#/v5/cli/asm/-%23-cli-asm--assembler-examples--options"></a></div></div></h3>
|
|
<div class="definition"><div class="term"><b>--define KEY=VALUE</b> <i>or</i> <b>--define FLAG</b></div><div class="body"><p>This allows key/value pairs (where the value is a string) and flags (which the value is <code class="inline">true</code>) to be passed along to the assembler, which can be accessed in <a href="#/v5/api/other/assembly/dialect/-%23-asm-dialect-scripting">Scripting Blocks</a>, such as <code class="inline">{{= defined.someKey }}</code>.</p>
|
|
|
|
</div></div><div class="definition"><div class="term"><b>--ignore-warnings</b></div><div class="body"><p>By default any warning will be treated like an error. This enabled by-passing warnings.</p>
|
|
|
|
</div></div><div class="definition"><div class="term"><b>--pic</b></div><div class="body"><p>When a program is assembled, the labels are usually given as an absolute byte position, which can be jumped to for loops and control flow. This means that a program must be installed at a specific location.</p>
|
|
|
|
<p>Byt specifying the <b>Position Independent Code</b> flag, code will be generated in a way such that all offsets are relative, allowing the program to be moved without any impact to its logic.</p>
|
|
|
|
<p>This does incur an additional gsas cost of 8 gas per offset access though.</p>
|
|
|
|
</div></div><div class="definition"><div class="term"><b>--target LABEL</b></div><div class="body"><p>All programs have a root scope named <code class="inline">_</code> which is by default assembled. This option allows another labelled target (either a <a href="#/v5/api/other/assembly/dialect/-%23-asm-dialect-scope">Scopes</a> or a <a href="#/v5/api/other/assembly/dialect/-%23-asm-dialect-datasegment">Data Segment</a> to be assembled instead. The entire program is still assembled per usual, so this only impacts which part of the program is output.</p>
|
|
|
|
</div></div><a name="/v5/cli/asm/-%23-cli-asm--disassembler-examples"></a><a name="/v5/cli/asm/"></a><h2 class="show-anchors"><div>Disassembler Examples<div class="anchors"><a class="self" href="#/v5/cli/asm/-%23-cli-asm--disassembler-examples"></a></div></div></h2><p>A disassembled program shows offsets and mnemonics for the given bytecode. This format may change in the future to be more human-readable.</p>
|
|
|
|
<div class="code">/home/ethers> ethers-asm --disassemble SimpleStore.bin
|
|
0000 : 0x2a ; #1
|
|
0002 : 0x00 ; #1
|
|
0004 : SSTORE
|
|
0005 : 0x44 ; #1
|
|
0007 : 0x11 ; #1
|
|
0009 : 0x00 ; #1
|
|
000b : CODECOPY
|
|
000c : 0x44 ; #1
|
|
000e : 0x00 ; #1
|
|
0010 : RETURN
|
|
0011 : CALLVALUE
|
|
0012 : 0x1e ; #1
|
|
0014 : JUMPI
|
|
0015 : 0x00 ; #1
|
|
0017 : CALLDATALOAD
|
|
0018 : 0xe0 ; #1
|
|
001a : SHR
|
|
001b : DUP1
|
|
001c : 0x20965255 ; #4
|
|
0021 : EQ
|
|
0022 : 0x24 ; #1
|
|
0024 : JUMPI
|
|
0025 : DUP1
|
|
0026 : 0x55241077 ; #4
|
|
002b : EQ
|
|
002c : 0x30 ; #1
|
|
002e : JUMPI
|
|
002f*: JUMPDEST
|
|
0030 : 0x00 ; #1
|
|
0032 : 0x00 ; #1
|
|
0034 : REVERT
|
|
0035*: JUMPDEST
|
|
0036 : 0x00 ; #1
|
|
0038 : SLOAD
|
|
0039 : 0x00 ; #1
|
|
003b : MSTORE
|
|
003c : 0x20 ; #1
|
|
003e : 0x00 ; #1
|
|
0040 : RETURN
|
|
0041*: JUMPDEST
|
|
0042 : 0x24 ; #1
|
|
0044 : CALLDATASIZE
|
|
0045 : EQ
|
|
0046 : ISZERO
|
|
0047 : 0x1e ; #1
|
|
0049 : JUMPI
|
|
004a : 0x04 ; #1
|
|
004c : CALLDATALOAD
|
|
004d : 0x00 ; #1
|
|
004f : SSTORE
|
|
0050 : 0x00 ; #1
|
|
0052 : 0x00 ; #1
|
|
0054 : RETURN
|
|
|
|
/home/ethers> cat SimpleStore.bin | ethers-asm --disassemble
|
|
# Same as above</div><div class="page-separator"></div><a name="/v5/cli/ens/-%23-ethereum-naming-service"></a><a name="/v5/cli/ens/"></a><h1 class="show-anchors"><div>Ethereum Naming Service<div class="anchors"><a class="self" href="#/v5/cli/ens/-%23-ethereum-naming-service"></a></div></div></h1>
|
|
<a name="/v5/cli/ens/-%23-ethereum-naming-service--help"></a><a name="/v5/cli/ens/"></a><h2 class="show-anchors"><div>Help<div class="anchors"><a class="self" href="#/v5/cli/ens/-%23-ethereum-naming-service--help"></a></div></div></h2>
|
|
<div class="code">Usage:
|
|
ethers-ens COMMAND [ ARGS ] [ OPTIONS ]
|
|
|
|
COMMANDS
|
|
lookup [ NAME | ADDRESS [ ... ] ]
|
|
Lookup a name or address
|
|
commit NAME Submit a pre-commitment
|
|
[ --duration DAYS ] Register duration (default: 365 days)
|
|
[ --salt SALT ] SALT to blind the commit with
|
|
[ --secret SECRET ] Use id(SECRET) as the salt
|
|
[ --owner OWNER ] The target owner (default: current account)
|
|
reveal NAME Reveal a previous pre-commitment
|
|
[ --duration DAYS ] Register duration (default: 365 days)
|
|
[ --salt SALT ] SALT to blind the commit with
|
|
[ --secret SECRET ] Use id(SECRET) as the salt
|
|
[ --owner OWNER ] The target owner (default: current account)
|
|
set-controller NAME Set the controller (default: current account)
|
|
[ --address ADDRESS ] Specify another address
|
|
set-subnode NAME Set a subnode owner (default: current account)
|
|
[ --address ADDRESS ] Specify another address
|
|
set-resolver NAME Set the resolver (default: resolver.eth)
|
|
[ --address ADDRESS ] Specify another address
|
|
set-addr NAME Set the addr record (default: current account)
|
|
[ --address ADDRESS ] Specify another address
|
|
set-text NAME KEY VALUE Set a text record
|
|
set-email NAME EMAIL Set the email text record
|
|
set-website NAME URL Set the website text record
|
|
set-content NAME HASH Set the IPFS Content Hash
|
|
migrate-registrar NAME Migrate from the Legacy to the Permanent Registrar
|
|
transfer NAME NEW_OWNER Transfer registrant ownership
|
|
reclaim NAME Reset the controller by the registrant
|
|
[ --address ADDRESS ] Specify another address
|
|
|
|
ACCOUNT OPTIONS
|
|
--account FILENAME Load from a file (JSON, RAW or mnemonic)
|
|
--account RAW_KEY Use a private key (insecure *)
|
|
--account 'MNEMONIC' Use a mnemonic (insecure *)
|
|
--account - Use secure entry for a raw key or mnemonic
|
|
--account-void ADDRESS Use an address as a void signer
|
|
--account-void ENS_NAME Add the resolved address as a void signer
|
|
--account-rpc ADDRESS Add the address from a JSON-RPC provider
|
|
--account-rpc INDEX Add the index from a JSON-RPC provider
|
|
--mnemonic-password Prompt for a password for mnemonics
|
|
--xxx-mnemonic-password Prompt for a (experimental) hard password
|
|
|
|
PROVIDER OPTIONS (default: all + homestead)
|
|
--alchemy Include Alchemy
|
|
--etherscan Include Etherscan
|
|
--infura Include INFURA
|
|
--nodesmith Include nodesmith
|
|
--rpc URL Include a custom JSON-RPC
|
|
--offline Dump signed transactions (no send)
|
|
--network NETWORK Network to connect to (default: homestead)
|
|
|
|
TRANSACTION OPTIONS (default: query network)
|
|
--gasPrice GWEI Default gas price for transactions(in wei)
|
|
--gasLimit GAS Default gas limit for transactions
|
|
--nonce NONCE Initial nonce for the first transaction
|
|
--yes Always accept Siging and Sending
|
|
|
|
OTHER OPTIONS
|
|
--wait Wait until transactions are mined
|
|
--debug Show stack traces for errors
|
|
--help Show this usage and exit
|
|
--version Show this version and exit
|
|
|
|
(*) By including mnemonics or private keys on the command line they are
|
|
possibly readable by other users on your system and may get stored in
|
|
your bash history file. This is NOT recommended.</div><a name="/v5/cli/ens/-%23-ethereum-naming-service--examples"></a><a name="/v5/cli/ens/"></a><h2 class="show-anchors"><div>Examples<div class="anchors"><a class="self" href="#/v5/cli/ens/-%23-ethereum-naming-service--examples"></a></div></div></h2><p>TODO examples</p>
|
|
|
|
<div class="page-separator"></div><a name="/v5/cli/typescript/-%23-typescript"></a><a name="/v5/cli/typescript/"></a><h1 class="show-anchors"><div>TypeScript<div class="anchors"><a class="self" href="#/v5/cli/typescript/-%23-typescript"></a></div></div></h1>
|
|
<a name="/v5/cli/typescript/-%23-typescript--help"></a><a name="/v5/cli/typescript/"></a><h2 class="show-anchors"><div>Help<div class="anchors"><a class="self" href="#/v5/cli/typescript/-%23-typescript--help"></a></div></div></h2>
|
|
<div class="code">Usage:
|
|
ethers-ts FILENAME [ ... ] [ OPTIONS ]
|
|
|
|
OPTIONS
|
|
--output FILENAME Write the output to FILENAME (default: stdout)
|
|
--force Overwrite files if they already exist
|
|
--no-optimize Do not run the solc optimizer
|
|
--no-bytecode Do not include bytecode and Factory methods
|
|
|
|
OTHER OPTIONS
|
|
--debug Show stack traces for errors
|
|
--help Show this usage and exit
|
|
--version Show this version and exit
|
|
|
|
(*) By including mnemonics or private keys on the command line they are
|
|
possibly readable by other users on your system and may get stored in
|
|
your bash history file. This is NOT recommended.</div><a name="/v5/cli/typescript/-%23-typescript--examples"></a><a name="/v5/cli/typescript/"></a><h2 class="show-anchors"><div>Examples<div class="anchors"><a class="self" href="#/v5/cli/typescript/-%23-typescript--examples"></a></div></div></h2><p>TODO</p>
|
|
|
|
<div class="page-separator"></div><a name="/v5/cli/plugin/-%23-cli-diy"></a><a name="/v5/cli/plugin/-%23-cli-diy"></a><a name="/v5/cli/plugin/"></a><h1 class="show-anchors"><div>Making Your Own<div class="anchors"><a class="self" href="#/v5/cli/plugin/-%23-cli-diy"></a></div></div></h1><p>The <i>cli</i> library is meant to make it easy to create command line utilities of your own.</p>
|
|
|
|
<a name="/v5/cli/plugin/-%23-cli-cli"></a><a name="/v5/cli/plugin/-%23-cli-diy--cli-cli"></a><a name="/v5/cli/plugin/"></a><h2 class="show-anchors"><div>CLI<div class="anchors"><a class="self" href="#/v5/cli/plugin/-%23-cli-cli"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/cli/src.ts/cli.ts#L715">source</a></div></div></h2><p>A <b>CLI</b> handles parsing all the command-line flags, options and arguments and instantiates a <a href="#/v5/cli/plugin/-%23-cli-plugin">Plugin</a> to process the command.</p>
|
|
|
|
<p>A <b>CLI</b> may support multiple <a href="#/v5/cli/plugin/-%23-cli-plugin">Plugin</a>'s in which case the first argument is used to determine which to run (or if no arguments, the default plugin will be selected) or may be designed to be standalone, in which case exactly one <a href="#/v5/cli/plugin/-%23-cli-plugin">Plugin</a> will be used and no command argument is allowed.</p>
|
|
|
|
<a name="/v5/cli/plugin/-%23-cli-addplugin"></a><div class="property show-anchors"><div class="signature"><span class="method">addPlugin</span><span class="symbol">(</span> <span class="param">command</span> <span class="symbol">,</span> <span class="param">pluginClass</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">void</span><div class="anchors"><a class="self" href="#/v5/cli/plugin/-%23-cli-addplugin"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/cli/src.ts/cli.ts#L755">source</a></div></div><div class="body"><p>Add a <i>plugin</i> class for the <i>command</i>. After all options and flags have been consumed, the first argument will be consumed and the associated plugin class will be instantiated and run.</p>
|
|
|
|
</div></div><a name="/v5/cli/plugin/-%23-cli-setplugin"></a><div class="property show-anchors"><div class="signature"><span class="method">setPlugin</span><span class="symbol">(</span> <span class="param">pluginClass</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">void</span><div class="anchors"><a class="self" href="#/v5/cli/plugin/-%23-cli-setplugin"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/cli/src.ts/cli.ts#L769">source</a></div></div><div class="body"><p>Set a dedicated <a href="#/v5/cli/plugin/-%23-cli-plugin">Plugin</a> class which will handle all input. This may not be used in conjuction with addPlugin and will not automatically accept a command from the arguments.</p>
|
|
|
|
</div></div><a name="/v5/cli/plugin/-%23-cli-showusage"></a><div class="property show-anchors"><div class="signature"><span class="method">showUsage</span><span class="symbol">(</span> <span class="symbol">[</span> <span class="param">message</span> = "" <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">status</span> = <span class="param">0</span> <span class="symbol">]</span> <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">never</span><div class="anchors"><a class="self" href="#/v5/cli/plugin/-%23-cli-showusage"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/cli/src.ts/cli.ts#L783">source</a></div></div><div class="body"><p>Shows the usage help screen for the CLI and terminates.</p>
|
|
|
|
</div></div><a name="/v5/cli/plugin/-%23-cli-run"></a><div class="property show-anchors"><div class="signature"><span class="method">run</span><span class="symbol">(</span> <span class="param">args</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Promise< void ></span><div class="anchors"><a class="self" href="#/v5/cli/plugin/-%23-cli-run"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/cli/src.ts/cli.ts#L910">source</a></div></div><div class="body"><p>Usually the value of <i>args</i> passed in will be <code class="inline">process.argv.slice(2)</code>.</p>
|
|
|
|
</div></div><a name="/v5/cli/plugin/-%23-cli-plugin"></a><a name="/v5/cli/plugin/-%23-cli-diy--cli-plugin"></a><a name="/v5/cli/plugin/"></a><h2 class="show-anchors"><div>Plugin<div class="anchors"><a class="self" href="#/v5/cli/plugin/-%23-cli-plugin"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/cli/src.ts/cli.ts#L490">source</a></div></div></h2><p>Each <b>Plugin</b> manages each command of a CLI and is executed in phases.</p>
|
|
|
|
<p>If the usage (i.e. help) of a CLI is requested, the static methods <code class="inline">getHelp</code> and <code class="inline">getOptionHelp</code> are used to geneate the help screen.</p>
|
|
|
|
<p>Otherwise, a plugin is instantiated and the <code class="inline">prepareOptions</code> is called. Each plugin <b>must</b> call <code class="inline">super.prepareOptions</code>, otherwise the basic options are not yet processed. During this time a Plugin should consume all the flags and options it understands, since any left over flags or options will cause the CLI to bail and issue an <i>unknown option</i> error. This should throw if a value for a given option is invalid or some combination of options and flags is not allowed.</p>
|
|
|
|
<p>Once the prepareOptions is complete (the returned promise is resolved), the <code class="inline">prepareArguments</code> is called. This should validate the number of arguments is expected and throw and error if there are too many or too few arguments or if any arguments do not make sense.</p>
|
|
|
|
<p>Once the prepareArguments is complete (the returned promise is resolved), the <code class="inline">run</code> is called.</p>
|
|
|
|
<div class="property show-anchors"><div class="signature"><span class="path">plugin</span><span class="symbol">.</span><span class="method">network</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/providers/types/-%23-providers-Network">Network</a></span><div class="anchors"></div></div><div class="body"><p>The network this plugin is running for.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">plugin</span><span class="symbol">.</span><span class="method">provider</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/providers/provider/">Provider</a></span><div class="anchors"></div></div><div class="body"><p>The provider for this plugin is running for.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">plugin</span><span class="symbol">.</span><span class="method">accounts</span> <span class="arrow">⇒</span> <span class="returns">Array< <a href="#/v5/api/signer/-%23-Signer">Signer</a> ></span><div class="anchors"></div></div><div class="body"><p>The accounts passed into the plugin using <code class="inline">--account</code>, <code class="inline">--account-rpc</code> and <code class="inline">--account-void</code> which this plugin can use.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">plugin</span><span class="symbol">.</span><span class="method">gasLimit</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/bignumber/">BigNumber</a></span><div class="anchors"></div></div><div class="body"><p>The gas limit this plugin should use. This is null if unspecified.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">plugin</span><span class="symbol">.</span><span class="method">gasPrice</span> <span class="arrow">⇒</span> <span class="returns"><a href="#/v5/api/utils/bignumber/">BigNumber</a></span><div class="anchors"></div></div><div class="body"><p>The gas price this plugin should use. This is null if unspecified.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">plugin</span><span class="symbol">.</span><span class="method">nonce</span> <span class="arrow">⇒</span> <span class="returns">number</span><div class="anchors"></div></div><div class="body"><p>The initial nonce for the account this plugin should use.</p>
|
|
|
|
</div></div><a name="/v5/cli/plugin/-%23-cli-diy--cli-plugin--methods"></a><a name="/v5/cli/plugin/"></a><h3 class="show-anchors"><div>Methods<div class="anchors"><a class="self" href="#/v5/cli/plugin/-%23-cli-diy--cli-plugin--methods"></a></div></div></h3>
|
|
<a name="/v5/cli/plugin/-%23-plugin-prepareoptions"></a><div class="property show-anchors"><div class="signature"><span class="path">plugin</span><span class="symbol">.</span><span class="method">prepareOptions</span><span class="symbol">(</span> <span class="param">argParser</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">verifyOnly</span> = <span class="param">false</span> <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Promise< void ></span><div class="anchors"><a class="self" href="#/v5/cli/plugin/-%23-plugin-prepareoptions"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/cli/src.ts/cli.ts#L515">source</a></div></div><div class="body">
|
|
</div></div><a name="/v5/cli/plugin/-%23-plugin-prepareargs"></a><div class="property show-anchors"><div class="signature"><span class="path">plugin</span><span class="symbol">.</span><span class="method">prepareArgs</span><span class="symbol">(</span> <span class="param">args</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Promise< void ></span><div class="anchors"><a class="self" href="#/v5/cli/plugin/-%23-plugin-prepareargs"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/cli/src.ts/cli.ts#L655">source</a></div></div><div class="body">
|
|
</div></div><a name="/v5/cli/plugin/-%23-plugin-run"></a><div class="property show-anchors"><div class="signature"><span class="path">plugin</span><span class="symbol">.</span><span class="method">run</span><span class="symbol">(</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Promise< void ></span><div class="anchors"><a class="self" href="#/v5/cli/plugin/-%23-plugin-run"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/cli/src.ts/cli.ts#L659">source</a></div></div><div class="body">
|
|
</div></div><a name="/v5/cli/plugin/-%23-plugin-getaddress"></a><div class="property show-anchors"><div class="signature"><span class="path">plugin</span><span class="symbol">.</span><span class="method">getAddress</span><span class="symbol">(</span> <span class="param">addressOrName</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">message</span> = "" <span class="symbol">,</span> <span class="symbol">[</span> <span class="param">allowZero</span> = <span class="param">false</span> <span class="symbol">]</span> <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Promise< string ></span><div class="anchors"><a class="self" href="#/v5/cli/plugin/-%23-plugin-getaddress"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/cli/src.ts/cli.ts#L663">source</a></div></div><div class="body"><p>A plugin should use this method to resolve an address. If the resovled address is the zero address and <i>allowZero</i> is not true, an error is raised.</p>
|
|
|
|
</div></div><a name="/v5/cli/plugin/-%23-plugin-dump"></a><div class="property show-anchors"><div class="signature"><span class="path">plugin</span><span class="symbol">.</span><span class="method">dump</span><span class="symbol">(</span> <span class="param">header</span> <span class="symbol">,</span> <span class="param">info</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">void</span><div class="anchors"><a class="self" href="#/v5/cli/plugin/-%23-plugin-dump"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/cli/src.ts/cli.ts#L682">source</a></div></div><div class="body"><p>Dumps the contents of <i>info</i> to the console with a <i>header</i> in a nicely formatted style. In the future, plugins may support a JSON output format which will automatically work with this method.</p>
|
|
|
|
</div></div><a name="/v5/cli/plugin/-%23-plugin-throwusageerror"></a><div class="property show-anchors"><div class="signature"><span class="path">plugin</span><span class="symbol">.</span><span class="method">throwUsageError</span><span class="symbol">(</span> <span class="symbol">[</span> <span class="param">message</span> = "" <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">never</span><div class="anchors"><a class="self" href="#/v5/cli/plugin/-%23-plugin-throwusageerror"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/cli/src.ts/cli.ts#L688">source</a></div></div><div class="body"><p>Stops exectuion of the plugin and shows the help screen of the plugin with the optional <i>message</i>.</p>
|
|
|
|
</div></div><a name="/v5/cli/plugin/-%23-plugin-throwerror"></a><div class="property show-anchors"><div class="signature"><span class="path">plugin</span><span class="symbol">.</span><span class="method">throwError</span><span class="symbol">(</span> <span class="param">message</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">never</span><div class="anchors"><a class="self" href="#/v5/cli/plugin/-%23-plugin-throwerror"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/cli/src.ts/cli.ts#L693">source</a></div></div><div class="body"><p>Stops execution of the plugin and shows <i>message</i>.</p>
|
|
|
|
</div></div><a name="/v5/cli/plugin/-%23-cli-diy--cli-plugin--static-methods"></a><a name="/v5/cli/plugin/"></a><h3 class="show-anchors"><div>Static Methods<div class="anchors"><a class="self" href="#/v5/cli/plugin/-%23-cli-diy--cli-plugin--static-methods"></a></div></div></h3>
|
|
<a name="/v5/cli/plugin/-%23-plugin-gethelp"></a><div class="property show-anchors"><div class="signature"><span class="path">Plugin</span><span class="symbol">.</span><span class="method">getHelp</span> <span class="arrow">⇒</span> <span class="returns">Help</span><div class="anchors"><a class="self" href="#/v5/cli/plugin/-%23-plugin-gethelp"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/cli/src.ts/cli.ts#L507">source</a></div></div><div class="body"><p>Each subclass should implement this static method which is used to generate the help screen.</p>
|
|
|
|
</div></div><a name="/v5/cli/plugin/-%23-plugin-getoptionshelp"></a><div class="property show-anchors"><div class="signature"><span class="path">Plugin</span><span class="symbol">.</span><span class="method">getOptionHelp</span> <span class="arrow">⇒</span> <span class="returns">Array< Help ></span><div class="anchors"><a class="self" href="#/v5/cli/plugin/-%23-plugin-getoptionshelp"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/cli/src.ts/cli.ts#L511">source</a></div></div><div class="body"><p>Each subclass should implement this static method if it supports additional options which is used to generate the help screen.</p>
|
|
|
|
</div></div><a name="/v5/cli/plugin/-%23-cli-argparser"></a><a name="/v5/cli/plugin/-%23-cli-diy--cli-argparser"></a><a name="/v5/cli/plugin/"></a><h2 class="show-anchors"><div>ArgParser<div class="anchors"><a class="self" href="#/v5/cli/plugin/-%23-cli-argparser"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/cli/src.ts/cli.ts#L292">source</a></div></div></h2><p>The <b>ArgParser</b> is used to parse a command line into flags, options and arguments.</p>
|
|
|
|
<div class="code">/home/ethers> ethers --account wallet.json --yes send ricmoo.eth 1.0
|
|
# An Option ----------^ ^ ^
|
|
# - name = "account" | |
|
|
# - value = "wallet.json" | |
|
|
# A Flag -----------------------------------+ |
|
|
# - name = "yes" |
|
|
# - value = true |
|
|
# Arguments ------------------------------------+
|
|
# - count = 3
|
|
# - [ "send", "ricmoo.eth", "1.0" ]</div><p>Flags are simple binary options (such as the <code class="inline">--yes</code>), which are true if present otherwise false.</p>
|
|
|
|
<p>Options require a single parameter follow them on the command line (such as <code class="inline">--account wallet.json</code>, which nhas the name <code class="inline">account</code> and the value <code class="inline">wallet.json</code>)</p>
|
|
|
|
<p>Arguments are all other values on the command line, and are not accessed through the <b>ArgParser</b> directly.</p>
|
|
|
|
<p>When a CLI is run, an <b>ArgParser</b> is used to validate the command line by using prepareOptions, which consumes all flags and options leaving only the arguments behind, which are then passed into prepareArgs.</p>
|
|
|
|
<a name="/v5/cli/plugin/-%23-argparser-consumeflag"></a><div class="property show-anchors"><div class="signature"><span class="path">argParser</span><span class="symbol">.</span><span class="method">consumeFlag</span><span class="symbol">(</span> <span class="param">name</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">boolean</span><div class="anchors"><a class="self" href="#/v5/cli/plugin/-%23-argparser-consumeflag"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/cli/src.ts/cli.ts#L333">source</a></div></div><div class="body"><p>Remove the flag <i>name</i> and return true if it is present.</p>
|
|
|
|
</div></div><a name="/v5/cli/plugin/-%23-argparser-consumemultioptions"></a><div class="property show-anchors"><div class="signature"><span class="path">argParser</span><span class="symbol">.</span><span class="method">consumeMultiOptions</span><span class="symbol">(</span> <span class="param">names</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Array< {name:string,value:string} ></span><div class="anchors"><a class="self" href="#/v5/cli/plugin/-%23-argparser-consumemultioptions"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/cli/src.ts/cli.ts#L351">source</a></div></div><div class="body"><p>Remove all options which match any name in the Array of <i>names</i> with their values returning the list (in order) of values.</p>
|
|
|
|
</div></div><a name="/v5/cli/plugin/-%23-argparser-consumeoption"></a><div class="property show-anchors"><div class="signature"><span class="path">argParser</span><span class="symbol">.</span><span class="method">consumeOption</span><span class="symbol">(</span> <span class="param">name</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">string</span><div class="anchors"><a class="self" href="#/v5/cli/plugin/-%23-argparser-consumeoption"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/cli/src.ts/cli.ts#L380">source</a></div></div><div class="body"><p>Remove the option with its value for <i>name</i> and return the value. This will throw a UsageError if the option is included multiple times.</p>
|
|
|
|
</div></div><a name="/v5/cli/plugin/-%23-argparser-consumeoptions"></a><div class="property show-anchors"><div class="signature"><span class="path">argParser</span><span class="symbol">.</span><span class="method">consumeOptions</span><span class="symbol">(</span> <span class="param">name</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Array< string ></span><div class="anchors"><a class="self" href="#/v5/cli/plugin/-%23-argparser-consumeoptions"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/cli/src.ts/cli.ts#L376">source</a></div></div><div class="body"><p>Remove all options with their values for <i>name</i> and return the list (in order) of values.</p>
|
|
|
|
</div></div><div class="page-separator"></div><a name="/v5/cookbook/-%23-cookbook"></a><a name="/v5/cookbook/"></a><h1 class="show-anchors"><div>Cookbook<div class="anchors"><a class="self" href="#/v5/cookbook/-%23-cookbook"></a></div></div></h1><p>Cooking...</p>
|
|
|
|
<div class="page-separator"></div><a name="/v5/migration/-%23-migration"></a><a name="/v5/migration/-%23-migration"></a><a name="/v5/migration/"></a><h1 class="show-anchors"><div>Migration Guide<div class="anchors"><a class="self" href="#/v5/migration/-%23-migration"></a></div></div></h1><p>Here are some migration guides when upgrading from older versions of Ethers or other libraries.</p>
|
|
|
|
<div class="toc"><div style="padding-left: 0px"><span class="bullet">•</span><a href="#/v5/migration/web3/">Migration: From Web3.js</a></div><div style="padding-left: 0px"><span class="bullet">•</span><a href="#/v5/migration/ethers-v4/">Migration: From Ethers v4</a></div></div><div class="page-separator"></div><a name="/v5/migration/web3/-%23-migration-from-web3-js"></a><a name="/v5/migration/web3/"></a><h1 class="show-anchors"><div>Migration: From Web3.js<div class="anchors"><a class="self" href="#/v5/migration/web3/-%23-migration-from-web3-js"></a></div></div></h1><p>TODO</p>
|
|
|
|
<a name="/v5/migration/web3/-%23-migration-from-web3-js--contracts"></a><a name="/v5/migration/web3/"></a><h2 class="show-anchors"><div>Contracts<div class="anchors"><a class="self" href="#/v5/migration/web3/-%23-migration-from-web3-js--contracts"></a></div></div></h2>
|
|
<a name="/v5/migration/web3/-%23-migration-from-web3-js--providers"></a><a name="/v5/migration/web3/"></a><h2 class="show-anchors"><div>Providers<div class="anchors"><a class="self" href="#/v5/migration/web3/-%23-migration-from-web3-js--providers"></a></div></div></h2>
|
|
<a name="/v5/migration/web3/-%23-migration-from-web3-js--numbers"></a><a name="/v5/migration/web3/"></a><h2 class="show-anchors"><div>Numbers<div class="anchors"><a class="self" href="#/v5/migration/web3/-%23-migration-from-web3-js--numbers"></a></div></div></h2>
|
|
<a name="/v5/migration/web3/-%23-migration-from-web3-js--utilities"></a><a name="/v5/migration/web3/"></a><h2 class="show-anchors"><div>Utilities<div class="anchors"><a class="self" href="#/v5/migration/web3/-%23-migration-from-web3-js--utilities"></a></div></div></h2>
|
|
<div class="page-separator"></div><a name="/v5/migration/ethers-v4/-%23-migration-v4"></a><a name="/v5/migration/ethers-v4/-%23-migration-v4"></a><a name="/v5/migration/ethers-v4/"></a><h1 class="show-anchors"><div>Migration: From Ethers v4<div class="anchors"><a class="self" href="#/v5/migration/ethers-v4/-%23-migration-v4"></a></div></div></h1>
|
|
<a name="/v5/migration/ethers-v4/-%23-migration-v4--bignumber"></a><a name="/v5/migration/ethers-v4/"></a><h2 class="show-anchors"><div>BigNumber<div class="anchors"><a class="self" href="#/v5/migration/ethers-v4/-%23-migration-v4--bignumber"></a></div></div></h2>
|
|
<a name="/v5/migration/ethers-v4/-%23-migration-v4--bignumber--namespace"></a><a name="/v5/migration/ethers-v4/"></a><h3 class="show-anchors"><div>Namespace<div class="anchors"><a class="self" href="#/v5/migration/ethers-v4/-%23-migration-v4--bignumber--namespace"></a></div></div></h3><p>Since <a href="#/v5/api/utils/bignumber/">BigNumber</a> is used quite frequently, it has been moved to the top level of the umbrella package.</p>
|
|
|
|
<div class="code"><span class="comment">// v4
|
|
</span>ethers.utils.BigNumber
|
|
ethers.utils.BigNumberish
|
|
|
|
<span class="comment">// v5
|
|
</span>ethers.BigNumber
|
|
ethers.BigNumberish
|
|
</div><a name="/v5/migration/ethers-v4/-%23-migration-v4--bignumber--creating-instances"></a><a name="/v5/migration/ethers-v4/"></a><h3 class="show-anchors"><div>Creating Instances<div class="anchors"><a class="self" href="#/v5/migration/ethers-v4/-%23-migration-v4--bignumber--creating-instances"></a></div></div></h3><p>The <code class="inline">bigNumberify</code> method was always preferred over the constructor since it could short-circuit an object instantiation for [[BigNumber] objects (since they are immutable). This has been moved to a static <code class="inline">from</code> class method.</p>
|
|
|
|
<div class="code"><span class="comment">// v4
|
|
</span>new ethers.utils.BigNumber(someValue)
|
|
ethers.utils.bigNumberify(someValue);
|
|
|
|
<span class="comment">// v5
|
|
</span><span class="comment">// - Constructor is private
|
|
</span><span class="comment">// - Removed `bigNumberify`
|
|
</span>ethers.BigNumber.from(someValue)
|
|
</div><a name="/v5/migration/ethers-v4/-%23-migration-v4--contracts"></a><a name="/v5/migration/ethers-v4/"></a><h2 class="show-anchors"><div>Contracts<div class="anchors"><a class="self" href="#/v5/migration/ethers-v4/-%23-migration-v4--contracts"></a></div></div></h2>
|
|
<div class="code"><span class="comment">// @TODO
|
|
</span></div><a name="/v5/migration/ethers-v4/-%23-migration-v4--errors"></a><a name="/v5/migration/ethers-v4/"></a><h2 class="show-anchors"><div>Errors<div class="anchors"><a class="self" href="#/v5/migration/ethers-v4/-%23-migration-v4--errors"></a></div></div></h2>
|
|
<a name="/v5/migration/ethers-v4/-%23-migration-v4--errors--namespace"></a><a name="/v5/migration/ethers-v4/"></a><h3 class="show-anchors"><div>Namespace<div class="anchors"><a class="self" href="#/v5/migration/ethers-v4/-%23-migration-v4--errors--namespace"></a></div></div></h3><p>All errors now belong to the <a href="#/v5/api/utils/logger/-%23-Logger">Logger</a> class and the related functions have been moved to <a href="#/v5/api/utils/logger/-%23-Logger">Logger</a> instances, which can include a per-package version string.</p>
|
|
|
|
<p>Global error fucntions have been moved <a href="#/v5/api/utils/logger/-%23-Logger">Logger</a> class methods.</p>
|
|
|
|
<div class="code"><span class="comment">// v4
|
|
</span>ethers.errors.UNKNOWN_ERROR
|
|
ethers.errors.*
|
|
|
|
errors.setCensorship(censorship, permanent)
|
|
errors.setLogLevel(logLevel)
|
|
|
|
errors.checkArgumentCount(count, expectedCount, suffix)
|
|
errors.checkNew(self, kind)
|
|
errors.checkNormalize()
|
|
errors.throwError(message, code, params)
|
|
errors.warn(...)
|
|
errors.info(...)
|
|
|
|
<span class="comment">// v5
|
|
</span>ethers.utils.Logger.errors.UNKNOWN_ERROR
|
|
ethers.utils.Logger.errors.*
|
|
|
|
Logger.setCensorship(censorship, permanent)
|
|
Logger.setLogLevel(logLevel)
|
|
|
|
const logger = new ethers.utils.Logger(version);
|
|
logger.checkArgumentCount(count, expectedCount, suffix)
|
|
logger.checkNew(self, kind)
|
|
logger.checkNormalize()
|
|
logger.throwError(message, code, params)
|
|
logger.warn(...)
|
|
logger.info(...)
|
|
</div><a name="/v5/migration/ethers-v4/-%23-migration-v4--interface"></a><a name="/v5/migration/ethers-v4/"></a><h2 class="show-anchors"><div>Interface<div class="anchors"><a class="self" href="#/v5/migration/ethers-v4/-%23-migration-v4--interface"></a></div></div></h2><p>The <a href="#/v5/api/utils/abi/interface/">Interface</a> object has undergone the most dramatic changes.</p>
|
|
|
|
<p>It is no longer a meta-class and now has methods that simplify handling contract interface operations without the need for object inspection and special edge cases.</p>
|
|
|
|
<a name="/v5/migration/ethers-v4/-%23-migration-v4--interface--functions"></a><a name="/v5/migration/ethers-v4/"></a><h3 class="show-anchors"><div>Functions<div class="anchors"><a class="self" href="#/v5/migration/ethers-v4/-%23-migration-v4--interface--functions"></a></div></div></h3>
|
|
<div class="code"><span class="comment">// v4 (example: "transfer(address to, uint amount)")
|
|
</span>interface.functions.transfer.encode(to, amount)
|
|
interface.functions.transfer.decode(callData)
|
|
|
|
<span class="comment">// v5
|
|
</span>interface.encodeFunctionData("transfer", [ to, amount ])
|
|
interface.decodeFunctionResult("transfer", data)
|
|
|
|
<span class="comment">// Or you can use any compatible signature or Fragment objects.
|
|
</span><span class="comment">// Notice that signature normalization is performed for you,
|
|
</span><span class="comment">// e.g. "uint" and "uint256" will be automatically converted
|
|
</span>interface.encodeFunctionData("transfer(address,uint)", [ to, amount ])
|
|
interface.decodeFunctionResult("transfer(address to, uint256 amount)", data)
|
|
</div><a name="/v5/migration/ethers-v4/-%23-migration-v4--interface--events"></a><a name="/v5/migration/ethers-v4/"></a><h3 class="show-anchors"><div>Events<div class="anchors"><a class="self" href="#/v5/migration/ethers-v4/-%23-migration-v4--interface--events"></a></div></div></h3>
|
|
<div class="code"><span class="comment">// v4 (example: Transfer(address indexed, address indexed, uint256)
|
|
</span>interface.events.Transfer.encodeTopics(values)
|
|
interface.events.Transfer.decode(data, topics)
|
|
|
|
<span class="comment">// v5
|
|
</span>interface.encodeFilterTopics("Transfer", values)
|
|
interface.encodeEventLog("Transfer", data, topics)
|
|
</div><a name="/v5/migration/ethers-v4/-%23-migration-v4--interface--inspection"></a><a name="/v5/migration/ethers-v4/"></a><h3 class="show-anchors"><div>Inspection<div class="anchors"><a class="self" href="#/v5/migration/ethers-v4/-%23-migration-v4--interface--inspection"></a></div></div></h3><p>Interrogating properties about a function or event can now (mostly) be done directly on the <a href="#/v5/api/utils/abi/fragments/-%23-Fragment">Fragment</a> object.</p>
|
|
|
|
<div class="code">// v4
|
|
interface.functions.transfer.name
|
|
interface.functions.transfer.inputs
|
|
interface.functions.transfer.outputs
|
|
interface.functions.transfer.payable
|
|
interface.functions.transfer.gas
|
|
|
|
// v5
|
|
const functionFragment = interface.getFunction("transfer")
|
|
functionFragment.name
|
|
functionFragment.inputs
|
|
functionFragment.outputs
|
|
functionFragment.payable
|
|
functionFragment.gas
|
|
|
|
|
|
// v4; type is "call" or "transaction"
|
|
interface.functions.transfer.type
|
|
|
|
// v5; constant is true (i.e. "call") or false (i.e. "transaction")
|
|
functionFragment.constant
|
|
|
|
|
|
// v4
|
|
interface.events.Transfer.anonymous
|
|
interface.events.Transfer.inputs
|
|
interface.events.Transfer.name
|
|
|
|
// v5
|
|
const eventFragment = interface.getEvent("Transfer");
|
|
eventFragment.anonymous
|
|
eventFragment.inputs
|
|
eventFragment.name
|
|
|
|
|
|
// v4
|
|
const functionSig = interface.functions.transfer.signature
|
|
const sighash = interface.functions.transfer.sighash
|
|
|
|
const eventSig = interface.events.Transfer.signature
|
|
const topic = interface.events.Transfer.topic
|
|
|
|
// v5
|
|
const functionSig = functionFragment.format()
|
|
const sighash = interface.getSighash(functionFragment)
|
|
|
|
const eventSig = eventFragment.format()
|
|
const topic = interface.getTopic(eventFragment)</div><a name="/v5/migration/ethers-v4/-%23-migration-v4--utilities"></a><a name="/v5/migration/ethers-v4/"></a><h2 class="show-anchors"><div>Utilities<div class="anchors"><a class="self" href="#/v5/migration/ethers-v4/-%23-migration-v4--utilities"></a></div></div></h2>
|
|
<a name="/v5/migration/ethers-v4/-%23-migration-v4--utilities--renaming"></a><a name="/v5/migration/ethers-v4/"></a><h3 class="show-anchors"><div>Renaming<div class="anchors"><a class="self" href="#/v5/migration/ethers-v4/-%23-migration-v4--utilities--renaming"></a></div></div></h3>
|
|
<div class="code"><span class="comment">// @TODO
|
|
</span></div><a name="/v5/migration/ethers-v4/-%23-migration-v4--wallet"></a><a name="/v5/migration/ethers-v4/"></a><h2 class="show-anchors"><div>Wallet<div class="anchors"><a class="self" href="#/v5/migration/ethers-v4/-%23-migration-v4--wallet"></a></div></div></h2>
|
|
<a name="/v5/migration/ethers-v4/-%23-migration-v4--wallet--mnemonic-phrases"></a><a name="/v5/migration/ethers-v4/"></a><h3 class="show-anchors"><div>Mnemonic Phrases<div class="anchors"><a class="self" href="#/v5/migration/ethers-v4/-%23-migration-v4--wallet--mnemonic-phrases"></a></div></div></h3><p>The <b>mnemonic</b> phrase and related properties have been merged into a single <code class="inline">mnemonic</code> object, which also now includes the <code class="inline">locale</code>.</p>
|
|
|
|
<div class="code"><span class="comment">// v4
|
|
</span>wallet.mnemonic
|
|
wallet.path
|
|
|
|
<span class="comment">// v5
|
|
</span><span class="comment">// - Mnemonic phrase and path are a Mnemonic object
|
|
</span><span class="comment">// - Note: wallet.mnemonic is null if there is no mnemonic
|
|
</span>wallet.mnemonic.phrase
|
|
wallet.mnemonic.path
|
|
</div><div class="page-separator"></div><a name="/v5/testing/-%23-testing"></a><a name="/v5/testing/"></a><h1 class="show-anchors"><div>Testing<div class="anchors"><a class="self" href="#/v5/testing/-%23-testing"></a></div></div></h1><p>Here goes info about testing</p>
|
|
|
|
<div class="page-separator"></div><a name="/v5/contributing/-%23-contributing"></a><a name="/v5/contributing/-%23-contributing"></a><a name="/v5/contributing/"></a><h1 class="show-anchors"><div>Contributing and Hacking<div class="anchors"><a class="self" href="#/v5/contributing/-%23-contributing"></a></div></div></h1><p>The ethers.js library is something that I've written out of necessity, and has grown somewhat organically over time.</p>
|
|
|
|
<p>Many things are the way they are for good (at the time, at least) reasons, but I always welcome criticism, and am completely willing to have my mind changed on things.</p>
|
|
|
|
<p>So, pull requests are always welcome, but please keep a few points in mind:</p>
|
|
|
|
<p><ul><li>Backwards-compatibility-breaking changes will not be accepted; they may be considered for the next major version </li><li>Security is important; adding dependencies require fairly convincing arguments as to why </li><li>The library aims to be lean, so keep an eye on the dist/ethers.min.js file size before and after your changes </li><li>Add test cases for both expected and unexpected input </li><li>Any new features need to be supported by me (future issues, documentation, testing, migration), so anything that is overly complicated or specific may not be accepted </li></ul></p>
|
|
|
|
<p>In general, <b>please start an issue <i>before</i> beginning a pull request</b>, so we can have a public discussion and figure out the best way to address to problem/feature. <b>:)</b></p>
|
|
|
|
<a name="/v5/contributing/-%23-contributing--building"></a><a name="/v5/contributing/-%23-contributing--contributing--building"></a><a name="/v5/contributing/"></a><h2 class="show-anchors"><div>Building<div class="anchors"><a class="self" href="#/v5/contributing/-%23-contributing--building"></a></div></div></h2><p>If you wish to modify the source code, there are a few steps involved in setting up your environment.</p>
|
|
|
|
<p>Since the library uses a monorepo, you must install an initial required set of libraries, which can then be used to install the remaining libraries used within each package, as well as link all the packages within the repo with each other.</p>
|
|
|
|
<div class="code-title"><div>Preparing for builds</div></div><div class="code"># Clone the repository
|
|
/home/ricmoo> git clone git@github.com:ethers-io/ethers.js.git
|
|
/home/ricmoo> cd ethers.js
|
|
|
|
# Install the base dependencies
|
|
/home/ricmoo/ethers.js> npm install
|
|
|
|
# Install each module's dependencies and link the libraries
|
|
# internally, so they reference each other
|
|
/home/ricmoo/ethers.js> npm run bootstrap</div><a name="/v5/contributing/-%23-contributing--updating"></a><a name="/v5/contributing/-%23-contributing--contributing--updating"></a><a name="/v5/contributing/"></a><h2 class="show-anchors"><div>Making your changes<div class="anchors"><a class="self" href="#/v5/contributing/-%23-contributing--updating"></a></div></div></h2><p>TODO: Add more information here.</p>
|
|
|
|
<div class="code-title"><div>Watching and Building</div></div><div class="code"># Begin watching the files and re-building whenever they change
|
|
/home/ricmoo/ethers.js> npm run auto-build
|
|
|
|
|
|
# Sometimes the issue only affects the ESM modules
|
|
/home/ricmoo/ethers.js> npm run auto-build-esm
|
|
|
|
|
|
# Or if you only need to run a single build
|
|
/home/ricmoo/ethers.js> npm run _build-cjs
|
|
/home/ricmoo/ethers.js> npm run _build-esm</div><div class="code-title"><div>Testing</div></div><div class="code"># Rebuilds all files and bundles testcases up for testing
|
|
/home/ricmoo/ethers.js> npm test
|
|
|
|
# Often you don't need the full CI experience
|
|
/home/ricmoo/ethers.js> npm run _test-node</div><div class="code-title"><div>Preparing the Distribution</div></div><div class="code">/home/ricmoo/ethers.js> npm run update-version</div><a name="/v5/contributing/-%23-contributing--documentation"></a><a name="/v5/contributing/-%23-contributing--contributing--documentation"></a><a name="/v5/contributing/"></a><h2 class="show-anchors"><div>Documentation<div class="anchors"><a class="self" href="#/v5/contributing/-%23-contributing--documentation"></a></div></div></h2><p>The documents are generated using <a href="#/v5/documentation/">Flatworm</a> documentation generation tool, which was written for the purpose of writing the documentation for ethers.</p>
|
|
|
|
<p>Style Guide (this section will have much more coming):</p>
|
|
|
|
<p><ul><li>Try to keep lines no longer than <i>around</i> 80 characters </li><li>Avoid inline links in the source; use the <code class="inline">externalLinks</code> field in the config.js </li><li>Prefix external links with <code class="inline">link-</code> </li><li>Changing an anchor name must be well justified, as it will break all existing links to that section; flatworm will support symblinks in the future </li><li>In general, I aim for xonsistency; look to similar situations throughout the documentation </li></ul></p>
|
|
|
|
<a name="/v5/contributing/-%23-contributing--contributing--documentation--building"></a><a name="/v5/contributing/"></a><h3 class="show-anchors"><div>Building<div class="anchors"><a class="self" href="#/v5/contributing/-%23-contributing--contributing--documentation--building"></a></div></div></h3><p>To build the documentation, you should first follow the <a href="#/v5/contributing/-%23-contributing--building">above steps</a> to build the ethers library.</p>
|
|
|
|
<p>Building the docs will generate several types of output:</p>
|
|
|
|
<p><ul><li>A full set of HTML pages, linking across each other </li><li>A single one-page HTML page with all pages linking to local anchors </li><li>A full set of README.md pages organized to be browsable and linkable in GitHub </li><li>A metadata dump for tool ingestion (still needs more work) </li><li>(@TODO; only half done) The documentation as a LaTeX and generated PDF </li></ul></p>
|
|
|
|
<div class="code-title"><div>Building the Documentations</div></div><div class="code">/home/ricmoo/ethers.js> npm run build-docs</div><a name="/v5/contributing/-%23-contributing--contributing--documentation--evaluation"></a><a name="/v5/contributing/"></a><h3 class="show-anchors"><div>Evaluation<div class="anchors"><a class="self" href="#/v5/contributing/-%23-contributing--contributing--documentation--evaluation"></a></div></div></h3><p>When building the documentation, all code samples are run through a JavaScript VM to ensure there are no typos in the example code, as well the exact output of results are injected into the output, so there is no need to keep the results and code in-sync.</p>
|
|
|
|
<p>However, this can be a bit of a headache when making many small changes, so to build the documentation faster, you can skip the evaluation step, which will inject the code directly.</p>
|
|
|
|
<div class="code-title"><div>Build docs skipping evaluation</div></div><div class="code">/home/ricmoo/ethers.js> npm run build-docs -- --skip-eval</div><a name="/v5/contributing/-%23-contributing--contributing--documentation--previewing-changes"></a><a name="/v5/contributing/"></a><h3 class="show-anchors"><div>Previewing Changes<div class="anchors"><a class="self" href="#/v5/contributing/-%23-contributing--contributing--documentation--previewing-changes"></a></div></div></h3><p>To preview the changes locally, you can use any standard web server and run from the <code class="inline">/docs/</code> folder, or use the built-in web server.</p>
|
|
|
|
<p>The same caveats as normal web development apply, such flushing browser caches after changing (and re-building) the docs.</p>
|
|
|
|
<div class="code-title"><div>Running a webserver</div></div><div class="code">/home/ricmoo/ethers.js> npm run serve-docs</div><div class="page-separator"></div><a name="/v5/documentation/-%23-flatworm"></a><a name="/v5/documentation/-%23-flatworm"></a><a name="/v5/documentation/"></a><h1 class="show-anchors"><div>Flatworm Docs<div class="anchors"><a class="self" href="#/v5/documentation/-%23-flatworm"></a></div></div></h1><p>The <i>Flatworm Docs</i> rendering engine is designed to be <b>very</b> simple, but provide enough formatting necessary for documenting JavaScript libraries.</p>
|
|
|
|
<p>A lot of its inspiration came from <a href="https://github.com/readthedocs/sphinx_rtd_theme">Read the Docs</a> and the <a href="https://www.sphinx-doc.org/">Sphinx</a> project.</p>
|
|
|
|
<a name="/v5/documentation/-%23-flatworm-fragments"></a><a name="/v5/documentation/-%23-flatworm--flatworm-fragments"></a><a name="/v5/documentation/"></a><h2 class="show-anchors"><div>Fragments<div class="anchors"><a class="self" href="#/v5/documentation/-%23-flatworm-fragments"></a></div></div></h2><p>Each page is made up of fragments. A fragment is a <a href="#/v5/documentation/-%23-flatworm-directive">directive</a>, with an value and optional <i>link</i>, <i>extensions</i> and a body.</p>
|
|
|
|
<p>Many directives support <a href="#/v5/documentation/-%23-flatworm-markdown">markdown</a> in their value and body.</p>
|
|
|
|
<p>A fragment's body continues until another fragment is encountered.</p>
|
|
|
|
<a name="/v5/documentation/-%23-flatworm--flatworm-fragments--directive-format"></a><a name="/v5/documentation/"></a><h3 class="show-anchors"><div>Directive Format<div class="anchors"><a class="self" href="#/v5/documentation/-%23-flatworm--flatworm-fragments--directive-format"></a></div></div></h3>
|
|
<div class="code">_DIRECTIVE: VALUE @<LINK> @EXTENSION<PARAMETER>
|
|
BODY
|
|
|
|
MORE BODY
|
|
|
|
DIRECTIVE: The directive name
|
|
VALUE: Optional; the value to pass to the directive
|
|
LINK: Optional; a name for internal linking
|
|
EXTENSION: Optional; extended directive functionality
|
|
PARAMETER: Optional; value to pass to extended directive functions
|
|
BODY: Optional; the directive body (certain directives only)</div><a name="/v5/documentation/-%23-flatworm-directive"></a><a name="/v5/documentation/-%23-flatworm--flatworm-fragments--flatworm-directive"></a><a name="/v5/documentation/"></a><h3 class="show-anchors"><div>Flatworm Directives<div class="anchors"><a class="self" href="#/v5/documentation/-%23-flatworm-directive"></a></div></div></h3>
|
|
<div class="definition"><div class="term"><b>_section:</b> <i>TITLE</i></div><div class="body"><p>A <i>section</i> has its <b>TITLE</b> in an H1 font. Sections are linked to in <i>Table of Contents</i> and have a dividing line drawn above them.</p>
|
|
|
|
<p>The body supports markdown.</p>
|
|
|
|
<p>There should only be one <code class="inline">_section:</code> per page.</p>
|
|
|
|
<p><b>Extensions:</b> <a href="#/v5/documentation/-%23-flatworm--ext-inherit">@inherit</a>, <a href="#/v5/documentation/-%23-flatworm--ext-src">@src</a>, <a href="#/v5/documentation/-%23-flatworm--ext-nav">@nav</a>, <a href="#/v5/documentation/-%23-flatworm--ext-note">@note</a></p>
|
|
|
|
</div></div><div class="definition"><div class="term"><b>_subsection:</b> <i>TITLE</i></div><div class="body"><p>A <i>subsection</i> has its <b>TITLE</b> in an H2 font. Subsections are linked to in <i>Table of Contents</i> and have a dividing line drawn above them.</p>
|
|
|
|
<p>The title and body support markdown.</p>
|
|
|
|
<p><b>Extensions:</b> <a href="#/v5/documentation/-%23-flatworm--ext-inherit">@inherit</a>, <a href="#/v5/documentation/-%23-flatworm--ext-src">@src</a>, <a href="#/v5/documentation/-%23-flatworm--ext-note">@note</a></p>
|
|
|
|
</div></div><div class="definition"><div class="term"><b>_heading:</b> <i>TITLE</i></div><div class="body"><p>A <i>heading</i> has its <b>TITLE</b> in an H3 font.</p>
|
|
|
|
<p>The title and body support markdown.</p>
|
|
|
|
<p><b>Extensions:</b> <a href="#/v5/documentation/-%23-flatworm--ext-inherit">@inherit</a>, <a href="#/v5/documentation/-%23-flatworm--ext-src">@src</a>, <a href="#/v5/documentation/-%23-flatworm--ext-note">@note</a></p>
|
|
|
|
</div></div><div class="definition"><div class="term"><b>_definition:</b> <i>TERM</i></div><div class="body"><p>A <i>definition</i> has its <b>TERM</b> in normal text and the body is indented.</p>
|
|
|
|
<p>The title and body support markdown.</p>
|
|
|
|
</div></div><div class="definition"><div class="term"><b>_property:</b> <i>SIGNATURE</i></div><div class="body"><p>A <i>property</i> has its JavaScript <b>SIGNATURE</b> formatted.</p>
|
|
|
|
<p>The body supports markdown and the return portion of the signature support markdown links.</p>
|
|
|
|
<p><b>Extensions:</b> <a href="#/v5/documentation/-%23-flatworm--ext-src">@src</a></p>
|
|
|
|
</div></div><div class="definition"><div class="term"><b>_note:</b> <i>BANNER</i></div><div class="body"><p>A <i>note</i> is placed in a blue bordered-box to draw attention to it.</p>
|
|
|
|
<p>The body supports markdown.</p>
|
|
|
|
</div></div><div class="definition"><div class="term"><b>_warning:</b> <i>BANNER</i></div><div class="body"><p>A <i>warning</i> is placed in an orange bordered-box to draw attention to it.</p>
|
|
|
|
<p>The body supports markdown.</p>
|
|
|
|
</div></div><div class="definition"><div class="term"><b>_code:</b> <i>CAPTION</i></div><div class="body"><p>Creates a <a href="#/v5/documentation/-%23-flatworm--code">Code</a> block.</p>
|
|
|
|
<p>The body does <b>not</b> support markdown, and will be output exactly as is, with the exception of <a href="#/v5/documentation/-%23-flatworm--code-eval">Code Evaluation</a>.</p>
|
|
|
|
<p>If a line begins with a <code class="inline">"_"</code>, it should be escaped with a <code class="inline">"\"</code>.</p>
|
|
|
|
<p><b>Extensions:</b> <a href="#/v5/documentation/-%23-flatworm--ext-lang">@lang</a></p>
|
|
|
|
</div></div><div class="definition"><div class="term"><b>_table:</b> <i>FOOTER</i></div><div class="body"><p>Creates a <a href="#/v5/documentation/-%23-flatworm--table">Table</a> structured according to the body.</p>
|
|
|
|
<p>Each cell contents supports markdown and variables supports markdown.</p>
|
|
|
|
<p><b>Extensions:</b> <a href="#/v5/documentation/-%23-flatworm--ext-style">@style</a></p>
|
|
|
|
</div></div><div class="definition"><div class="term"><b>_toc:</b></div><div class="body"><p>A <i>toc</i> injects a Table of Contents, loading each line of the body as a filename and recursively loads the <i>toc</i> if present, otherwise all the <i>sections</i> and <i>subsections</i>.</p>
|
|
|
|
<p>The body does <b>not</b> support markdown, as it is interpreted as a list of files and directories to process.</p>
|
|
|
|
</div></div><div class="definition"><div class="term"><b>_null:</b></div><div class="body"><p>A <i>null</i> is used to terminated a directive. For example, after a <i>definition</i>, the bodies are indented, so a <i>null</i> can be used to reset the indentation.</p>
|
|
|
|
<p>The body supports markdown.</p>
|
|
|
|
</div></div><div class="code-title"><div>Example</div></div><div class="code">_section: Hello World @<link-main>
|
|
Body for section...
|
|
|
|
|
|
_subsection: Some Example @<link-secondary>
|
|
Body for subsection...
|
|
|
|
|
|
_heading: Large Bold Text @<link-here>
|
|
Body for heading...
|
|
|
|
|
|
_definition: Flatworm
|
|
A phylum of relatively **simple** bilaterian, unsegmented,
|
|
soft-bodied invertebrates.
|
|
|
|
|
|
_property: String.fromCharCode(code) => string
|
|
Returns a string created from //code//, a sequence of
|
|
UTF-16 code units.
|
|
|
|
|
|
_code: heading
|
|
|
|
// Some code goes here
|
|
while(1);
|
|
|
|
|
|
_table: Table Footer
|
|
|
|
| **Name** | **Color** |
|
|
| Apple | Red |
|
|
| Banana | Yellow |
|
|
| Grape | Purple |
|
|
|
|
|
|
_toc:
|
|
some-file
|
|
some-directory
|
|
|
|
|
|
_note: Title
|
|
This is placed in a blue box.
|
|
|
|
|
|
_warning: Title
|
|
This is placed in an orange box.
|
|
|
|
|
|
_null:
|
|
This breaks out of a directive. For example, to end
|
|
a ``_note:`` or ``_code:``.</div><a name="/v5/documentation/-%23-flatworm-markdown"></a><a name="/v5/documentation/-%23-flatworm--flatworm-markdown"></a><a name="/v5/documentation/"></a><h2 class="show-anchors"><div>Markdown<div class="anchors"><a class="self" href="#/v5/documentation/-%23-flatworm-markdown"></a></div></div></h2><p>The markdown is simple and does not have the flexibility of other dialects, but allows for <b>bold</b>, <i>italic</i>, <u>underlined</u>, <code class="inline">monospaced</code>, super<sup>script</sup> and <strike>strike</strike> text, supporting <a href="#/v5/documentation/-%23-flatworm-markdown">links</a> and lists.</p>
|
|
|
|
<p>Lists are rendered as blocks of a body, so cannot be used within a title or within another list.</p>
|
|
|
|
<div class="code">**bold text**
|
|
|
|
//italic text//
|
|
|
|
__underlined text__
|
|
|
|
``monospace code``
|
|
|
|
^^superscript text^^
|
|
|
|
~~strikeout text~~
|
|
|
|
- This is a list
|
|
- With bullet points
|
|
- With a total of three items
|
|
|
|
This is a [Link to Ethereum](https://ethereum.org) and this
|
|
is an [Internal Link](some-link).
|
|
|
|
This is a self-titled link [[https://ethereumorg]] and this
|
|
[[some-link]] will use the title from its directives value.</div><a name="/v5/documentation/-%23-flatworm--code"></a><a name="/v5/documentation/-%23-flatworm--flatworm--code"></a><a name="/v5/documentation/"></a><h2 class="show-anchors"><div>Code<div class="anchors"><a class="self" href="#/v5/documentation/-%23-flatworm--code"></a></div></div></h2><p>The code directive creates a monospace, contained block useful for displaying code samples.</p>
|
|
|
|
<a name="/v5/documentation/-%23-flatworm--code-eval"></a><a name="/v5/documentation/-%23-flatworm--flatworm--code--flatworm--code-eval"></a><a name="/v5/documentation/"></a><h3 class="show-anchors"><div>JavaScript Evaluation<div class="anchors"><a class="self" href="#/v5/documentation/-%23-flatworm--code-eval"></a></div></div></h3><p>For JavaScript files, the file is executed with some simple substitution.</p>
|
|
|
|
<p>A bare <code class="inline">//!</code> on a line is replaced with the result of the last statement. Building will fail if an error is thrown.</p>
|
|
|
|
<p>A bare <code class="inline">//!error</code> is replaced with the throw error. Building will fail if an error is not thrown.</p>
|
|
|
|
<p>Also any code included between the lines <b><code class="inline">// <hide></code></b> and <b><code class="inline">// </hide></code></b> will be omitted from the output, which can be used to setup variables.</p>
|
|
|
|
<div class="code-title"><div>Code Evaluation Example</div></div><div class="code">_code: Result of Code Example @lang<javascript>
|
|
|
|
// <hide>
|
|
const url = require("url");
|
|
// </hide>
|
|
|
|
url.parse("https://www.ricmoo.com/").protocol
|
|
//!
|
|
|
|
url.parse(45)
|
|
//! error
|
|
|
|
// You want to assign (doesn't emit eval) AND display the value
|
|
const foo = 4 + 5;
|
|
// <hide>
|
|
foo
|
|
// </hide>
|
|
//!</div><div class="code-title"><div>Result of Code Example</div></div><div class="code">url.parse("https://www.ricmoo.com/").protocol
|
|
<span class="result ok">// 'https:'
|
|
</span>
|
|
url.parse(45)
|
|
<span class="result error">// Error: The "url" argument must be of type string. Received type number
|
|
</span>
|
|
<span class="comment">// You want to assign (doesn't emit eval) AND display the value
|
|
</span>const foo = 4 + 5;
|
|
<span class="result ok">// 9
|
|
</span></div><a name="/v5/documentation/-%23-flatworm--flatworm--code--languages"></a><a name="/v5/documentation/"></a><h3 class="show-anchors"><div>Languages<div class="anchors"><a class="self" href="#/v5/documentation/-%23-flatworm--flatworm--code--languages"></a></div></div></h3><p>The language can be specified using the <a href="#/v5/documentation/-%23-flatworm--ext-lang">@lang extension</a>.</p>
|
|
|
|
<table class="table minimal"><tr><td align="center"><b>Language</b></td><td align="center"><b>Notes</b></td><td class="fix"> </td></tr><tr><td align="center">javascript</td><td align="left">Syntax highlights and <a href="#/v5/documentation/-%23-flatworm--code-eval">evaluates</a> the JavaScipt</td><td class="fix"> </td></tr><tr><td align="center">script</td><td align="left">Same as <code class="inline">javascript</code>, but does not evaluate the results</td><td class="fix"> </td></tr><tr><td align="center">shell</td><td align="left">Shell scripts or command-line</td><td class="fix"> </td></tr><tr><td align="center">text</td><td align="left">Plain text with no syntax highlighting</td><td class="fix"> </td></tr></table><a name="/v5/documentation/-%23-flatworm--table"></a><a name="/v5/documentation/-%23-flatworm--flatworm--table"></a><a name="/v5/documentation/"></a><h2 class="show-anchors"><div>Tables<div class="anchors"><a class="self" href="#/v5/documentation/-%23-flatworm--table"></a></div></div></h2><p>The table directive consumes the entire body up until the next directive. To terminate a table early to begin a text block, use a <b>_null:</b> directive.</p>
|
|
|
|
<p>Each line of the body should be <a href="#/v5/documentation/-%23-flatworm--table-row">Row Data</a> or a <a href="#/v5/documentation/-%23-flatworm--table-variable">Variable Declaration</a> (or continuation of a <i>Variable Declaration</i>). Blank lines are ignored.</p>
|
|
|
|
<a name="/v5/documentation/-%23-flatworm--table-row"></a><a name="/v5/documentation/-%23-flatworm--flatworm--table--flatworm--table-row"></a><a name="/v5/documentation/"></a><h3 class="show-anchors"><div>Row Data<div class="anchors"><a class="self" href="#/v5/documentation/-%23-flatworm--table-row"></a></div></div></h3><p>Each <b>Row Data</b> line must begin and end with a <b><code class="inline">"|"</code></b>, with each gap representing the cell data, <a href="#/v5/documentation/-%23-flatworm--table-alignment">alignment</a> with optional <a href="#/v5/documentation/-%23-flatworm--table-spanning">column and row spanning</a>.</p>
|
|
|
|
<a name="/v5/documentation/-%23-flatworm--table-alignment"></a><a name="/v5/documentation/-%23-flatworm--flatworm--table--flatworm--table-alignment"></a><a name="/v5/documentation/"></a><h3 class="show-anchors"><div>Alignment<div class="anchors"><a class="self" href="#/v5/documentation/-%23-flatworm--table-alignment"></a></div></div></h3><p>The alignment for a cell is determined by the whitespace surrounding the cell data.</p>
|
|
|
|
<table class="table minimal"><tr><td align="center"><b>Alignment</b></td><td align="center"><b>Whitespace</b></td><td class="fix"> </td></tr><tr><td align="center"><i>Left</i></td><td align="left">1 or fewer spaces before the content</td><td class="fix"> </td></tr><tr><td align="center"><i>Right</i></td><td align="left">1 or fewer spaces after the content</td><td class="fix"> </td></tr><tr><td align="center"><i>Center</i></td><td align="left">2 or more space <b>both</b> before and after the content</td><td class="fix"> </td></tr><tr><td class="table-title" colspan="2">Alignment Conditions (higher precedence listed first)</td><td class="fix"> </td></tr></table><div class="code-title"><div>Alignment Example</div></div><div class="code">_table: Result of Alignment Example @style<compact>
|
|
|
|
| center |
|
|
|
|
| left |
|
|
|left |
|
|
|
|
| right |
|
|
| right|</div><table class="table compact"><tr><td align="center" width="100%">center</td><td class="fix"> </td></tr><tr><td align="left" width="100%">left</td><td class="fix"> </td></tr><tr><td align="left" width="100%">left</td><td class="fix"> </td></tr><tr><td align="right" width="100%">right</td><td class="fix"> </td></tr><tr><td align="right" width="100%">right</td><td class="fix"> </td></tr><tr><td class="table-title" colspan="1">Result of Alignment Example</td><td class="fix"> </td></tr></table><a name="/v5/documentation/-%23-flatworm--table-spanning"></a><a name="/v5/documentation/-%23-flatworm--flatworm--table--flatworm--table-spanning"></a><a name="/v5/documentation/"></a><h3 class="show-anchors"><div>Row and Column Spanning<div class="anchors"><a class="self" href="#/v5/documentation/-%23-flatworm--table-spanning"></a></div></div></h3><p>A column may end its content with any number of <b><code class="inline">"<"</code></b> which indicates how many <i>additional</i> columns to extend into.</p>
|
|
|
|
<p>If the cell content contains only a <b><code class="inline">"^"</code></b>, then the row above is extended into this cell (into the same number of columns).</p>
|
|
|
|
<div class="code-title"><div>Cell Spanning Example</div></div><div class="code">_table: Result of Cell Spanning Example @style<compact>
|
|
|
|
| (1x1) | (1x2) <| (2x1) |
|
|
| (2x2) <| (2x1) | ^ |
|
|
| ^ | ^ | (1x1) |</div><table class="table compact"><tr><td align="center" width="25%">(1x1)</td><td align="center" colspan="2" width="50%">(1x2)</td><td align="center" rowspan="2" width="25%">(2x1)</td><td class="fix"> </td></tr><tr><td align="center" colspan="2" rowspan="2" width="50%">(2x2)</td><td align="center" rowspan="2" width="25%">(2x1)</td><td class="fix"> </td></tr><tr><td align="center" width="25%">(1x1)</td><td class="fix"> </td></tr><tr><td class="table-title" colspan="4">Result of Cell Spanning Example</td><td class="fix"> </td></tr></table><a name="/v5/documentation/-%23-flatworm--table-style"></a><a name="/v5/documentation/-%23-flatworm--flatworm--table--flatworm--table-style"></a><a name="/v5/documentation/"></a><h3 class="show-anchors"><div>Styles<div class="anchors"><a class="self" href="#/v5/documentation/-%23-flatworm--table-style"></a></div></div></h3><p>The <a href="#/v5/documentation/-%23-flatworm--ext-style">@style extension</a> for a table can be used to control its appearance.</p>
|
|
|
|
<table class="table minimal"><tr><td align="center"><b>Name</b></td><td align="center"><b>Width</b></td><td align="center"><b>Columns</b></td><td class="fix"> </td></tr><tr><td align="center"><i>minimal</i></td><td align="center">minimum size</td><td align="center">best fit</td><td class="fix"> </td></tr><tr><td align="center"><i>compact</i></td><td align="center">40%</td><td align="center">evenly spaced</td><td class="fix"> </td></tr><tr><td align="center"><i>wide</i></td><td align="center">67%</td><td align="center">evenly spaced</td><td class="fix"> </td></tr><tr><td align="center"><i>full</i></td><td align="center">100%</td><td align="center">evenly spaced</td><td class="fix"> </td></tr></table><a name="/v5/documentation/-%23-flatworm--table-variable"></a><a name="/v5/documentation/-%23-flatworm--flatworm--table--flatworm--table-variable"></a><a name="/v5/documentation/"></a><h3 class="show-anchors"><div>Variables<div class="anchors"><a class="self" href="#/v5/documentation/-%23-flatworm--table-variable"></a></div></div></h3><p>Often the layout of a table is easier to express and maintain without uneven or changing content within it. So the content can be defined separately within a table directive using <b>variables</b>. A varaible name must being with a letter and must only contain letters and numbers.</p>
|
|
|
|
<p>Variables are also useful when content is repeated throughout a table.</p>
|
|
|
|
<p>A variable is declared by starting a line with <code class="inline">"$NAME:"</code>, which consumes all lines until the next variable declaration or until the next table row line.</p>
|
|
|
|
<p>A variable name must start with a letter and may consist of letters and numbers. (i.e. <code class="inline">/[a-z][a-z0-9]*/i</code>)</p>
|
|
|
|
<div class="code-title"><div>Variables Example</div></div><div class="code">_table: Result of Variables Example
|
|
|
|
$Yes: This option is supported.
|
|
$No: This option is **not** supported
|
|
$bottom: This just represents an example of
|
|
what is possible. Notice that variable
|
|
content can span multiple lines.
|
|
|
|
| **Feature** | **Supported** |
|
|
| Dancing Monkey | $Yes |
|
|
| Singing Turtle | $No |
|
|
| Newt Hair | $Yes |
|
|
| $bottom <|</div><table class="table minimal"><tr><td align="center"><b>Feature</b></td><td align="center"><b>Supported</b></td><td class="fix"> </td></tr><tr><td align="center">Dancing Monkey</td><td align="center">This option is supported.</td><td class="fix"> </td></tr><tr><td align="center">Singing Turtle</td><td align="center">This option is <b>not</b> supported.</td><td class="fix"> </td></tr><tr><td align="center">Newt Hair</td><td align="center">This option is supported.</td><td class="fix"> </td></tr><tr><td align="center" colspan="2">This just represents an example of what is possible. Notice that variable content can span multiple lines.</td><td class="fix"> </td></tr><tr><td class="table-title" colspan="2">Result of Variables Example</td><td class="fix"> </td></tr></table><a name="/v5/documentation/-%23-flatworm-config"></a><a name="/v5/documentation/-%23-flatworm--flatworm-config"></a><a name="/v5/documentation/"></a><h2 class="show-anchors"><div>Configuration<div class="anchors"><a class="self" href="#/v5/documentation/-%23-flatworm-config"></a></div></div></h2><p>Configuration is optional (but highly recommended) and may be either a simple JSON file (config.json) or a JS file (config.js) placed in the top of the source folder.</p>
|
|
|
|
<p>TODO: example JSON and example JS</p>
|
|
|
|
<a name="/v5/documentation/-%23-flatworm-extensions"></a><a name="/v5/documentation/-%23-flatworm--flatworm-extensions"></a><a name="/v5/documentation/"></a><h2 class="show-anchors"><div>Extensions<div class="anchors"><a class="self" href="#/v5/documentation/-%23-flatworm-extensions"></a></div></div></h2>
|
|
<a name="/v5/documentation/-%23-flatworm--ext-inherit"></a><a name="/v5/documentation/-%23-flatworm--flatworm-extensions--flatworm--ext-inherit"></a><a name="/v5/documentation/"></a><h3 class="show-anchors"><div>@inherit< <i>markdown</i> ><div class="anchors"><a class="self" href="#/v5/documentation/-%23-flatworm--ext-inherit"></a></div></div></h3><p>Adds an inherits description to a directive. The <i>markdown</i> may contain links.</p>
|
|
|
|
<a name="/v5/documentation/-%23-flatworm--ext-lang"></a><a name="/v5/documentation/-%23-flatworm--flatworm-extensions--flatworm--ext-lang"></a><a name="/v5/documentation/"></a><h3 class="show-anchors"><div>@lang< <i>text</i> ><div class="anchors"><a class="self" href="#/v5/documentation/-%23-flatworm--ext-lang"></a></div></div></h3><p>Set the language a <a href="#/v5/documentation/-%23-flatworm--code">code directive</a> should be syntax-highlighted for. If "javascript", the code will be evaluated.</p>
|
|
|
|
<a name="/v5/documentation/-%23-flatworm--ext-nav"></a><a name="/v5/documentation/-%23-flatworm--flatworm-extensions--flatworm--ext-nav"></a><a name="/v5/documentation/"></a><h3 class="show-anchors"><div>@nav< <i>text</i> ><div class="anchors"><a class="self" href="#/v5/documentation/-%23-flatworm--ext-nav"></a></div></div></h3><p>Sets the name in the breadcrumbs when not the current node.</p>
|
|
|
|
<a name="/v5/documentation/-%23-flatworm--ext-note"></a><a name="/v5/documentation/-%23-flatworm--flatworm-extensions--flatworm--ext-note"></a><a name="/v5/documentation/"></a><h3 class="show-anchors"><div>@note<<i> markdown</i> ><div class="anchors"><a class="self" href="#/v5/documentation/-%23-flatworm--ext-note"></a></div></div></h3><p>Adds a note to a directive. The <i>markdown</i> may contain links. If the directive already has an @INHERIT extension, that will be used instead and the @NOTE will be ignored.</p>
|
|
|
|
<a name="/v5/documentation/-%23-flatworm--ext-src"></a><a name="/v5/documentation/-%23-flatworm--flatworm-extensions--flatworm--ext-src"></a><a name="/v5/documentation/"></a><h3 class="show-anchors"><div>@src< <i>key</i> ><div class="anchors"><a class="self" href="#/v5/documentation/-%23-flatworm--ext-src"></a></div></div></h3><p>Calls the configuration <code class="inline">getSourceUrl(key, VALUE)</code> to get a URL which will be linked to by a link next to the <i>directive</i>.</p>
|
|
|
|
<p>This extended directive function requires an advanced <code class="inline">config.js</code> <a href="#/v5/documentation/-%23-flatworm-config">Configuration</a> file since it requires a JavaScript function.</p>
|
|
|
|
<a name="/v5/documentation/-%23-flatworm--ext-style"></a><a name="/v5/documentation/-%23-flatworm--flatworm-extensions--flatworm--ext-style"></a><a name="/v5/documentation/"></a><h3 class="show-anchors"><div>@style< <i>text</i> ><div class="anchors"><a class="self" href="#/v5/documentation/-%23-flatworm--ext-style"></a></div></div></h3><p>The <a href="#/v5/documentation/-%23-flatworm--table-style">Table Style</a> to use for a table directive.</p>
|
|
|
|
<div class="page-separator"></div><a name="/v5/license/-%23-license"></a><a name="/v5/license/-%23-license"></a><a name="/v5/license/"></a><h1 class="show-anchors"><div>License and Copyright<div class="anchors"><a class="self" href="#/v5/license/-%23-license"></a></div></div></h1><p>The ethers library (including all dependencies) are available under the <a href="https://en.m.wikipedia.org/wiki/MIT_License">MIT License</a>, which permits a wide variety of uses.</p>
|
|
|
|
<a name="/v5/license/-%23-license--mit-license"></a><a name="/v5/license/"></a><h3 class="show-anchors"><div>MIT License<div class="anchors"><a class="self" href="#/v5/license/-%23-license--mit-license"></a></div></div></h3><p><i>Copyright © 2019 <a href="mailto:me@ricmoo.com">Richard Moore</a>.</i></p>
|
|
|
|
<p>Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:</p>
|
|
|
|
<p>The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.</p>
|
|
|
|
<p>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</p>
|
|
|
|
|
|
<div class="footer">
|
|
<div class="nav previous"><!--PREV_LINK--></div>
|
|
<div class="nav next"><!--NEXT_LINK--></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 July 3, 2020, 1:44am.</div>
|
|
</div>
|
|
<script src="/v5/static/script.js" type="text/javascript"></script>
|
|
</body>
|
|
</html>
|