63 lines
15 KiB
HTML
63 lines
15 KiB
HTML
<!DOCTYPE html>
|
|
<html class="paged">
|
|
<head>
|
|
<title>Constants</title>
|
|
<link rel="stylesheet" type="text/css" href="/v5/static/style.css">
|
|
<meta property="og:title" content="Constants"/>
|
|
<meta property="og:description" content="Documentation for ethers, a complete, tiny and simple Ethereum library."/>
|
|
|
|
<meta property="og:image" content="/v5/static/social.jpg"/>
|
|
|
|
</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 class="search"><form action="/v5/search/" method="GET"><input name="search" id="search" /></form><span class="search-icon">⚲</span></div>
|
|
</div>
|
|
<div class="toc"><div>
|
|
<div class="link title"><a href="/v5/">Documentation</a></div><div class="base show link depth-1"><a href="/v5/getting-started/">Getting Started</a></div><div class="base show link depth-1"><a href="/v5/concepts/">Ethereum Basics</a></div><div class="hide link depth-2"><a href="/v5/concepts/events/">Events</a></div><div class="hide link depth-2"><a href="/v5/concepts/gas/">Gas</a></div><div class="hide link depth-2"><a href="/v5/concepts/security/">Security</a></div><div class="hide link depth-2"><a href="/v5/concepts/best-practices/">Best Practices</a></div><div class="base show link depth-1"><a href="/v5/api-keys/">Provider API Keys</a></div><div class="base ancestor show link depth-1"><a href="/v5/api/">Application Programming Interface</a></div><div class="show link depth-2"><a href="/v5/api/providers/">Providers</a></div><div class="hide link depth-3"><a href="/v5/api/providers/provider/">Provider</a></div><div class="hide link depth-3"><a href="/v5/api/providers/jsonrpc-provider/">JsonRpcProvider</a></div><div class="hide link depth-3"><a href="/v5/api/providers/api-providers/">API Providers</a></div><div class="hide link depth-3"><a href="/v5/api/providers/other/">Other Providers</a></div><div class="hide link depth-3"><a href="/v5/api/providers/types/">Types</a></div><div class="show link depth-2"><a href="/v5/api/signer/">Signers</a></div><div class="show link depth-2"><a href="/v5/api/contract/">Contract Interaction</a></div><div class="hide link depth-3"><a href="/v5/api/contract/contract/">Contract</a></div><div class="hide link depth-3"><a href="/v5/api/contract/contract-factory/">ContractFactory</a></div><div class="hide link depth-3"><a href="/v5/api/contract/example/">Example: ERC-20 Contract</a></div><div class="ancestor show link depth-2"><a href="/v5/api/utils/">Utilities</a></div><div class="show link depth-3"><a href="/v5/api/utils/abi/">Application Binary Interface</a></div><div class="hide link depth-4"><a href="/v5/api/utils/abi/coder/">AbiCoder</a></div><div class="hide link depth-4"><a href="/v5/api/utils/abi/formats/">ABI Formats</a></div><div class="hide link depth-4"><a href="/v5/api/utils/abi/fragments/">Fragments</a></div><div class="hide link depth-4"><a href="/v5/api/utils/abi/interface/">Interface</a></div><div class="show link depth-3"><a href="/v5/api/utils/address/">Addresses</a></div><div class="show link depth-3"><a href="/v5/api/utils/bignumber/">BigNumber</a></div><div class="show link depth-3"><a href="/v5/api/utils/bytes/">Byte Manipulation</a></div><div class="myself ancestor ancestor show link depth-3"><a href="/v5/api/utils/constants/">Constants</a></div><div class="link show child depth-4"><a href="#constants--bytes">Bytes</a></div><div class="link show child depth-4"><a href="#constants--strings">Strings</a></div><div class="link show child depth-4"><a href="#constants--bignumber">BigNumber</a></div><div class="show link depth-3"><a href="/v5/api/utils/display-logic/">Display Logic and Input</a></div><div class="show link depth-3"><a href="/v5/api/utils/encoding/">Encoding Utilities</a></div><div class="show link depth-3"><a href="/v5/api/utils/fixednumber/">FixedNumber</a></div><div class="show link depth-3"><a href="/v5/api/utils/hashing/">Hashing Algorithms</a></div><div class="show link depth-3"><a href="/v5/api/utils/hdnode/">HD Wallet</a></div><div class="show link depth-3"><a href="/v5/api/utils/logger/">Logging</a></div><div class="show link depth-3"><a href="/v5/api/utils/properties/">Property Utilities</a></div><div class="show link depth-3"><a href="/v5/api/utils/signing-key/">Signing Key</a></div><div class="show link depth-3"><a href="/v5/api/utils/strings/">Strings</a></div><div class="show link depth-3"><a href="/v5/api/utils/transactions/">Transactions</a></div><div class="show link depth-3"><a href="/v5/api/utils/web/">Web Utilities</a></div><div class="show link depth-3"><a href="/v5/api/utils/wordlists/">Wordlists</a></div><div class="show link depth-2"><a href="/v5/api/other/">Other Libraries</a></div><div class="hide link depth-3"><a href="/v5/api/other/assembly/">Assembly</a></div><div class="hide link depth-4"><a href="/v5/api/other/assembly/dialect/">Ethers ASM Dialect</a></div><div class="hide link depth-4"><a href="/v5/api/other/assembly/api/">Utilities</a></div><div class="hide link depth-4"><a href="/v5/api/other/assembly/ast/">Abstract Syntax Tree</a></div><div class="hide link depth-3"><a href="/v5/api/other/hardware/">Hardware Wallets</a></div><div class="show link depth-2"><a href="/v5/api/experimental/">Experimental</a></div><div class="base show link depth-1"><a href="/v5/cli/">Command Line Interfaces</a></div><div class="hide link depth-2"><a href="/v5/cli/ethers/">Sandbox Utility</a></div><div class="hide link depth-2"><a href="/v5/cli/asm/">Assembler</a></div><div class="hide link depth-2"><a href="/v5/cli/ens/">Ethereum Naming Service</a></div><div class="hide link depth-2"><a href="/v5/cli/typescript/">TypeScript</a></div><div class="hide link depth-2"><a href="/v5/cli/plugin/">Making Your Own</a></div><div class="base show link depth-1"><a href="/v5/cookbook/">Cookbook</a></div><div class="hide link depth-2"><a href="/v5/cookbook/react-native/">React Native (and ilk)</a></div><div class="base show link depth-1"><a href="/v5/migration/">Migration Guide</a></div><div class="hide link depth-2"><a href="/v5/migration/web3/">Migration: From Web3.js</a></div><div class="hide link depth-2"><a href="/v5/migration/ethers-v4/">Migration: From Ethers v4</a></div><div class="base show link depth-1"><a href="/v5/testing/">Testing</a></div><div class="base show link depth-1"><a href="/v5/contributing/">Contributing and Hacking</a></div><div class="base show link depth-1"><a href="/v5/other-resources/">Other Resources</a></div><div class="base show link depth-1"><a href="/v5/documentation/">Flatworm Docs</a></div><div class="base show link depth-1"><a href="/v5/license/">License and Copyright</a></div>
|
|
</div></div>
|
|
<div class="footer">
|
|
<a href="/v5/single-page/">Single Page</a>
|
|
</div>
|
|
</div>
|
|
<div class="content">
|
|
<div class="breadcrumbs"><a href="/v5/">Documentation</a> » <a href="/v5/api/">API</a> » <a href="/v5/api/utils/">Utilities</a> » <span class="current">Constants</span></div>
|
|
|
|
<a name="constants"></a><a name="constants"></a><h1 class="show-anchors"><div>Constants<div class="anchors"><a class="self" href="/v5/api/utils/constants/#constants"></a></div></div></h1><p>The <b>ethers.contants</b> Object contains commonly used values.</p>
|
|
|
|
<a name="constants--bytes"></a><h2 class="show-anchors"><div>Bytes<div class="anchors"><a class="self" href="/v5/api/utils/constants/#constants--bytes"></a></div></div></h2>
|
|
<a name="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/#address">Address</a> ></span><div class="anchors"><a class="self" href="/v5/api/utils/constants/#constants-AddressZero"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/constants/src.ts/addresses.ts#L1">source</a></div></div><div class="body"><p>The Address Zero, which is 20 bytes (40 nibbles) of zero.</p>
|
|
|
|
</div></div><a name="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/#DataHexString">DataHexString</a>< 32 > ></span><div class="anchors"><a class="self" href="/v5/api/utils/constants/#constants-HashZero"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/constants/src.ts/hashes.ts#L1">source</a></div></div><div class="body"><p>The Hash Zero, which is 32 bytes (64 nibbles) of zero.</p>
|
|
|
|
</div></div><a name="constants--strings"></a><h2 class="show-anchors"><div>Strings<div class="anchors"><a class="self" href="/v5/api/utils/constants/#constants--strings"></a></div></div></h2>
|
|
<a name="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/#constants-EtherSymbol"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/constants/src.ts/strings.ts#L2">source</a></div></div><div class="body"><p>The Ether symbol, <b>Ξ</b>.</p>
|
|
|
|
</div></div><a name="constants--bignumber"></a><h2 class="show-anchors"><div>BigNumber<div class="anchors"><a class="self" href="/v5/api/utils/constants/#constants--bignumber"></a></div></div></h2>
|
|
<a name="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/#constants-NegativeOne"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/constants/src.ts/bignumbers.ts#L3">source</a></div></div><div class="body"><p>The BigNumber value representing <code class="inline">"-1"</code>.</p>
|
|
|
|
</div></div><a name="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/#constants-Zero"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/constants/src.ts/bignumbers.ts#L4">source</a></div></div><div class="body"><p>The BigNumber value representing <code class="inline">"0"</code>.</p>
|
|
|
|
</div></div><a name="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/#constants-One"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/constants/src.ts/bignumbers.ts#L5">source</a></div></div><div class="body"><p>The BigNumber value representing <code class="inline">"1"</code>.</p>
|
|
|
|
</div></div><a name="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/#constants-Two"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/constants/src.ts/bignumbers.ts#L6">source</a></div></div><div class="body"><p>The BigNumber value representing <code class="inline">"2"</code>.</p>
|
|
|
|
</div></div><a name="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/#constants-WeiPerEther"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/constants/src.ts/bignumbers.ts#L7">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="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/#constants-MaxUint256"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/master/packages/constants/src.ts/bignumbers.ts#L8">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="footer">
|
|
<div class="nav previous"><a href="/v5/api/utils/bytes/"><span class="arrow">←</span>Byte Manipulation</a></div>
|
|
<div class="nav next"><a href="/v5/api/utils/display-logic/">Display Logic and Input<span class="arrow">→</span></a></div>
|
|
</div>
|
|
<div class="copyright">The content of this site is licensed under the <a href="https://choosealicense.com/licenses/cc-by-4.0/">Creative Commons License</a>. Generated on February 8, 2021, 3:25pm.</div>
|
|
</div>
|
|
<script src="/v5/static/script.js" type="text/javascript"></script>
|
|
<!--EXTRASCRIPT-->
|
|
</body>
|
|
</html>
|