60 lines
15 KiB
HTML
60 lines
15 KiB
HTML
<!DOCTYPE html>
|
|
<html class="paged">
|
|
<head>
|
|
<title>Display Logic and Input</title>
|
|
<link rel="stylesheet" type="text/css" href="/v5/static/style.css">
|
|
</head>
|
|
<body>
|
|
<div class="sidebar">
|
|
<div class="header">
|
|
<div class="logo"><a href="/v5/"><div class="image"></div><div class="name">ethers</div><div class="version">v5.0-beta</div></a></div>
|
|
</div>
|
|
<div class="toc"><div>
|
|
<div class="link title"><a href="/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="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/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="show link depth-2"><a href="/v5/api/signer/">Signers</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="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="show link depth-3"><a href="/v5/api/utils/constants/">Constants</a></div><div class="myself ancestor ancestor 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="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/documentation/">Flatworm Docs</a></div><div class="base show link depth-1"><a href="/v5/license/">License and Copyright</a></div>
|
|
</div></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">Display Logic and Input</span></div>
|
|
|
|
<a name="display-logic-and-input"></a><h1 class="show-anchors"><div>Display Logic and Input<div class="anchors"><a class="self" href="/v5/api/utils/display-logic/#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/#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/#unit-conversion">formatUnits</a> will format a <a href="/v5/api/utils/bignumber/#BigNumberish">BigNumberish</a> into a string, which is useful when displaying a balance.</p>
|
|
|
|
<a name="display-logic-and-input--units"></a><h2 class="show-anchors"><div>Units<div class="anchors"><a class="self" href="/v5/api/utils/display-logic/#display-logic-and-input--units"></a></div></div></h2>
|
|
<a name="display-logic-and-input--units--decimal-count"></a><h3 class="show-anchors"><div>Decimal Count<div class="anchors"><a class="self" href="/v5/api/utils/display-logic/#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="display-logic-and-input--units--named-units"></a><h3 class="show-anchors"><div>Named Units<div class="anchors"><a class="self" href="/v5/api/utils/display-logic/#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="display-logic-and-input--functions"></a><h2 class="show-anchors"><div>Functions<div class="anchors"><a class="self" href="/v5/api/utils/display-logic/#display-logic-and-input--functions"></a></div></div></h2>
|
|
<a name="display-logic-and-input--functions--formatting"></a><h3 class="show-anchors"><div>Formatting<div class="anchors"><a class="self" href="/v5/api/utils/display-logic/#display-logic-and-input--functions--formatting"></a></div></div></h3>
|
|
<a name="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/#utils-commify"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/ethers-v5-beta/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="unit-conversion"></a><a name="display-logic-and-input--functions--unit-conversion"></a><h3 class="show-anchors"><div>Conversion<div class="anchors"><a class="self" href="/v5/api/utils/display-logic/#unit-conversion"></a></div></div></h3>
|
|
<a name="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/#utils-formatUnits"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/ethers-v5-beta/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="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/#utils-formatEther"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/ethers-v5-beta/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="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/#utils-parseUnits"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/ethers-v5-beta/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="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/#utils-parseEther"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/ethers-v5-beta/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="footer">
|
|
<div class="nav previous"><a href="/v5/api/utils/constants/"><span class="arrow">←</span>Constants</a></div>
|
|
<div class="nav next"><a href="/v5/api/utils/encoding/">Encoding Utilities<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>. Last modified on June 12, 2020, 7:17pm.</div>
|
|
</div>
|
|
<script src="/v5/static/script.js" type="text/javascript"></script>
|
|
</body>
|
|
</html>
|