43 lines
36 KiB
HTML
43 lines
36 KiB
HTML
<html><head><title>FixedNumber</title><link rel="stylesheet" type="text/css" href="/static/style.css"></head><body><div class="sidebar"><div class="header"><div class="logo"><a href="/"><div class="image"></div><div class="name">ethers</div><div class="version">v5.0-beta</div></a></div></div><div class="toc"><div><div class="link title"><a href="/">Documentation</a></div><div class="base show link depth-1"><a href="/getting-started/">Getting Started</a></div><div class="hide link depth-2"><a href="/getting-started/#getting-started--installing">Installing</a></div><div class="hide link depth-2"><a href="/getting-started/#getting-started--importing">Importing</a></div><div class="base show link depth-1"><a href="/concepts/">Concepts</a></div><div class="hide link depth-2"><a href="/concepts/events/">Events</a></div><div class="hide link depth-3"><a href="/concepts/events/#events--solidity-topics">Solidity Topics</a></div><div class="hide link depth-2"><a href="/concepts/gas/">Gas</a></div><div class="hide link depth-3"><a href="/concepts/gas/#gas-price">Gas Price</a></div><div class="hide link depth-3"><a href="/concepts/gas/#gas-limit">Gas Limit</a></div><div class="base ancestor show link depth-1"><a href="/api/">Application Programming Interface</a></div><div class="show link depth-2"><a href="/api/contract/">Contract Interaction</a></div><div class="hide link depth-3"><a href="/api/contract/contract/">Contract</a></div><div class="hide link depth-4"><a href="/api/contract/contract/#contract--properties">Properties</a></div><div class="hide link depth-4"><a href="/api/contract/contract/#contract--methods">Methods</a></div><div class="hide link depth-4"><a href="/api/contract/contract/#contract--events">Events</a></div><div class="hide link depth-4"><a href="/api/contract/contract/#contract-metaclass">Meta-Class</a></div><div class="hide link depth-3"><a href="/api/contract/example/">Example: ERC-20 Contract</a></div><div class="hide link depth-4"><a href="/api/contract/example/#example-erc-20-contract--connecting-to-a-contract">Connecting to a Contract</a></div><div class="hide link depth-4"><a href="/api/contract/example/#example-erc-20-contract--properties-inheritted-from-contract">Properties ^^//(inheritted from [[contract]])//^^</a></div><div class="hide link depth-4"><a href="/api/contract/example/#example-erc-20-contract--methods-inheritted-from-contract">Methods ^^//(inheritted from [[contract]])//^^</a></div><div class="hide link depth-4"><a href="/api/contract/example/#erc20-events">Events ^^//(inheritted from Contract)//^^</a></div><div class="hide link depth-4"><a href="/api/contract/example/#example-erc-20-contract--meta-class-methods-added-at-runtime">Meta-Class Methods ^^//(added at Runtime)//^^</a></div><div class="hide link depth-4"><a href="/api/contract/example/#example-erc-20-contract--meta-class-filters-added-at-runtime">Meta-Class Filters ^^//(added at Runtime)//^^</a></div><div class="show link depth-2"><a href="/api/signer/">Signers</a></div><div class="hide link depth-3"><a href="/api/signer/#signer">Signer</a></div><div class="hide link depth-3"><a href="/api/signer/#wallet">Wallet</a></div><div class="hide link depth-3"><a href="/api/signer/#void-signer">VoidSigner</a></div><div class="hide link depth-3"><a href="/api/signer/#externally-owned-account">ExternallyOwnedAccount</a></div><div class="show link depth-2"><a href="/api/providers/">Providers</a></div><div class="hide link depth-3"><a href="/api/providers/provider/">Provider</a></div><div class="hide link depth-4"><a href="/api/providers/provider/#provider--accounts-methods">Accounts Methods</a></div><div class="hide link depth-4"><a href="/api/providers/provider/#provider--blocks-methods">Blocks Methods</a></div><div class="hide link depth-4"><a href="/api/providers/provider/#provider--ethereum-naming-service-ens-methods">Ethereum Naming Service (ENS) Methods</a></div><div class="hide link depth-4"><a href="/api/providers/provider/#provider--logs-methods">Logs Methods</a></div><div class="hide link depth-4"><a href="/api/providers/provider/#provider--network-status-methods">Network Status Methods</a></div><div class="hide link depth-4"><a href="/api/providers/provider/#provider--transactions-methods">Transactions Methods</a></div><div class="hide link depth-4"><a href="/api/providers/provider/#provider--event-emitter-methods">Event Emitter Methods</a></div><div class="hide link depth-4"><a href="/api/providers/provider/#provider--inspection-methods">Inspection Methods</a></div><div class="hide link depth-3"><a href="/api/providers/jsonrpc-provider/">JsonRpcProvider</a></div><div class="hide link depth-4"><a href="/api/providers/jsonrpc-provider/#signer-jsonrpc">JsonRpcSigner</a></div><div class="hide link depth-4"><a href="/api/providers/jsonrpc-provider/#provider-jsonrpc-uncheckedsigner">JsonRpcUncheckedSigner</a></div><div class="hide link depth-3"><a href="/api/providers/api-providers/">API Providers</a></div><div class="hide link depth-4"><a href="/api/providers/api-providers/#api-providers--etherscanprovider">EtherscanProvider</a></div><div class="hide link depth-4"><a href="/api/providers/api-providers/#api-providers--infuraprovider">InfuraProvider</a></div><div class="hide link depth-4"><a href="/api/providers/api-providers/#api-providers--alchemyprovider">AlchemyProvider</a></div><div class="hide link depth-4"><a href="/api/providers/api-providers/#api-providers--cloudfrontprovider">CloudfrontProvider</a></div><div class="hide link depth-3"><a href="/api/providers/other/">Other Providers</a></div><div class="hide link depth-4"><a href="/api/providers/other/#provider-fallback">FallbackProvider</a></div><div class="hide link depth-4"><a href="/api/providers/other/#provider-ipc">IpcProvider</a></div><div class="hide link depth-4"><a href="/api/providers/other/#provider-urljsonrpc">UrlJsonRpcProvider</a></div><div class="hide link depth-4"><a href="/api/providers/other/#provider-web3">Web3Provider</a></div><div class="hide link depth-3"><a href="/api/providers/types/">Types</a></div><div class="hide link depth-4"><a href="/api/providers/types/#provider-blocktag">BlockTag</a></div><div class="hide link depth-4"><a href="/api/providers/types/#provider-network">Network</a></div><div class="hide link depth-4"><a href="/api/providers/types/#provider-block">Block</a></div><div class="hide link depth-4"><a href="/api/providers/types/#types--events-and-logs">Events and Logs</a></div><div class="hide link depth-4"><a href="/api/providers/types/#types--transactions">Transactions</a></div><div class="ancestor show link depth-2"><a href="/api/utils/">Utilities</a></div><div class="show link depth-3"><a href="/api/utils/abi/">Application Binary Interface</a></div><div class="hide link depth-4"><a href="/api/utils/abi/interface/">Interface</a></div><div class="hide link depth-5"><a href="/api/utils/abi/interface/#abi-interface--creating-instances">Creating Instances</a></div><div class="hide link depth-5"><a href="/api/utils/abi/interface/#abi-interface--properties">Properties</a></div><div class="hide link depth-5"><a href="/api/utils/abi/interface/#abi-interface--formatting">Formatting</a></div><div class="hide link depth-5"><a href="/api/utils/abi/interface/#abi-interface--fragment-access">Fragment Access</a></div><div class="hide link depth-5"><a href="/api/utils/abi/interface/#abi-interface--signature-and-topic-hashes">Signature and Topic Hashes</a></div><div class="hide link depth-5"><a href="/api/utils/abi/interface/#abi-interface--encoding-data">Encoding Data</a></div><div class="hide link depth-5"><a href="/api/utils/abi/interface/#abi-interface--decoding-data">Decoding Data</a></div><div class="hide link depth-5"><a href="/api/utils/abi/interface/#abi-interface--parsing">Parsing</a></div><div class="hide link depth-5"><a href="/api/utils/abi/interface/#abi-interface--types">Types</a></div><div class="hide link depth-5"><a href="/api/utils/abi/interface/#abi-fragmentid">Specifying Fragments</a></div><div class="hide link depth-4"><a href="/api/utils/abi/fragments/">Fragments</a></div><div class="hide link depth-5"><a href="/api/utils/abi/fragments/#fragments--formats">Formats</a></div><div class="hide link depth-5"><a href="/api/utils/abi/fragments/#abi-fragment">Fragment</a></div><div class="hide link depth-5"><a href="/api/utils/abi/fragments/#abi-constructorfragment">ConstructorFragment</a></div><div class="hide link depth-5"><a href="/api/utils/abi/fragments/#abi-eventfragment">EventFragment</a></div><div class="hide link depth-5"><a href="/api/utils/abi/fragments/#abi-functionfragment">FunctionFragment</a></div><div class="hide link depth-5"><a href="/api/utils/abi/fragments/#abi-paramtype">ParamType</a></div><div class="show link depth-3"><a href="/api/utils/address/">Addresses</a></div><div class="hide link depth-4"><a href="/api/utils/address/#address-formats">Address Formats</a></div><div class="hide link depth-4"><a href="/api/utils/address/#addresses--functions">Functions</a></div><div class="show link depth-3"><a href="/api/utils/bignumber/">BigNumber</a></div><div class="hide link depth-4"><a href="/api/utils/bignumber/#bignumber--types">Types</a></div><div class="hide link depth-4"><a href="/api/utils/bignumber/#bignumber--creating-instances">Creating Instances</a></div><div class="hide link depth-4"><a href="/api/utils/bignumber/#bignumber--methods">Methods</a></div><div class="hide link depth-4"><a href="/api/utils/bignumber/#bignumber--notes">Notes</a></div><div class="show link depth-3"><a href="/api/utils/bytes/">Byte Manipulation</a></div><div class="hide link depth-4"><a href="/api/utils/bytes/#byte-manipulation--types">Types</a></div><div class="hide link depth-4"><a href="/api/utils/bytes/#byte-manipulation--inspection">Inspection</a></div><div class="hide link depth-4"><a href="/api/utils/bytes/#byte-manipulation--converting-between-arrays-and-hexstrings">Converting between Arrays and Hexstrings</a></div><div class="hide link depth-4"><a href="/api/utils/bytes/#byte-manipulation--array-manipulation">Array Manipulation</a></div><div class="hide link depth-4"><a href="/api/utils/bytes/#byte-manipulation--hexstring-manipulation">Hexstring Manipulation</a></div><div class="hide link depth-4"><a href="/api/utils/bytes/#byte-manipulation--signature-conversion">Signature Conversion</a></div><div class="hide link depth-4"><a href="/api/utils/bytes/#byte-manipulation--random-bytes">Random Bytes</a></div><div class="show link depth-3"><a href="/api/utils/constants/">Constants</a></div><div class="hide link depth-4"><a href="/api/utils/constants/#constants--bytes">Bytes</a></div><div class="hide link depth-4"><a href="/api/utils/constants/#constants--strings">Strings</a></div><div class="hide link depth-4"><a href="/api/utils/constants/#constants--bignumber">BigNumber</a></div><div class="show link depth-3"><a href="/api/utils/display-logic/">Display Logic and Input</a></div><div class="hide link depth-4"><a href="/api/utils/display-logic/#display-logic-and-input--units">Units</a></div><div class="hide link depth-4"><a href="/api/utils/display-logic/#display-logic-and-input--functions">Functions</a></div><div class="show link depth-3"><a href="/api/utils/encoding/">Encoding Utilities</a></div><div class="hide link depth-4"><a href="/api/utils/encoding/#bse58">Base58</a></div><div class="hide link depth-4"><a href="/api/utils/encoding/#base64">Base64</a></div><div class="hide link depth-4"><a href="/api/utils/encoding/#rlp">Recursive-Length Prefix</a></div><div class="myself ancestor ancestor show link depth-3"><a href="/api/utils/fixednumber/">FixedNumber</a></div><div class="child link depth-4"><a href="/api/utils/fixednumber/#fixednumber--creating-instances">Creating Instances</a></div><div class="child link depth-4"><a href="/api/utils/fixednumber/#fixednumber--properties">Properties</a></div><div class="child link depth-4"><a href="/api/utils/fixednumber/#fixednumber--methods">Methods</a></div><div class="child link depth-4"><a href="/api/utils/fixednumber/#fixedformat">FixedFormat</a></div><div class="show link depth-3"><a href="/api/utils/hashing/">Hashing Algorithms</a></div><div class="hide link depth-4"><a href="/api/utils/hashing/#hashing-algorithms--cryptographic-hashing">Cryptographic Hashing</a></div><div class="hide link depth-4"><a href="/api/utils/hashing/#hashing-algorithms--common-hashing-helpers">Common Hashing Helpers</a></div><div class="hide link depth-4"><a href="/api/utils/hashing/#hashing-algorithms--solidity-hashing-algorithms">Solidity Hashing Algorithms</a></div><div class="show link depth-3"><a href="/api/utils/hdnode/">HD Wallet</a></div><div class="hide link depth-4"><a href="/api/utils/hdnode/#hd-wallet--types">Types</a></div><div class="hide link depth-4"><a href="/api/utils/hdnode/#hdnode">HDNode</a></div><div class="hide link depth-4"><a href="/api/utils/hdnode/#hd-wallet--other-functions">Other Functions</a></div><div class="show link depth-3"><a href="/api/utils/logger/">Logging</a></div><div class="hide link depth-4"><a href="/api/utils/logger/#logger">Logger</a></div><div class="hide link depth-4"><a href="/api/utils/logger/#errors">Errors</a></div><div class="hide link depth-4"><a href="/api/utils/logger/#logger-levels">Log Levels</a></div><div class="show link depth-3"><a href="/api/utils/properties/">Property Utilities</a></div><div class="show link depth-3"><a href="/api/utils/signing-key/">Signing Key</a></div><div class="hide link depth-4"><a href="/api/utils/signing-key/#utils-signingkey--other-functions">Other Functions</a></div><div class="show link depth-3"><a href="/api/utils/strings/">Strings</a></div><div class="hide link depth-4"><a href="/api/utils/strings/#bytes32-string">Bytes32String</a></div><div class="hide link depth-4"><a href="/api/utils/strings/#utf8-string">UTF-8 Strings</a></div><div class="hide link depth-4"><a href="/api/utils/strings/#unicode-normalization-form">UnicodeNormalizationForm</a></div><div class="hide link depth-4"><a href="/api/utils/strings/#utf8error">Custom UTF-8 Error Handling</a></div><div class="show link depth-3"><a href="/api/utils/transactions/">Transactions</a></div><div class="hide link depth-4"><a href="/api/utils/transactions/#utils-transactions--types">Types</a></div><div class="hide link depth-4"><a href="/api/utils/transactions/#utils-transactions--functions">Functions</a></div><div class="show link depth-3"><a href="/api/utils/web/">Web Utilities</a></div><div class="show link depth-3"><a href="/api/utils/wordlists/">Wordlists</a></div><div class="hide link depth-4"><a href="/api/utils/wordlists/#wordlist">Wordlist</a></div><div class="hide link depth-4"><a href="/api/utils/wordlists/#wordlist-languages">Languages</a></div><div class="show link depth-2"><a href="/api/other/">Other Libraries</a></div><div class="hide link depth-3"><a href="/api/other/assembly/">Assembly</a></div><div class="hide link depth-4"><a href="/api/other/assembly/dialect/">Ethers ASM Dialect</a></div><div class="hide link depth-5"><a href="/api/other/assembly/dialect/#asm-dialect-opcode">Opcodes</a></div><div class="hide link depth-5"><a href="/api/other/assembly/dialect/#asm-dialect-label">Labels</a></div><div class="hide link depth-5"><a href="/api/other/assembly/dialect/#asm-dialect-literal">Literals</a></div><div class="hide link depth-5"><a href="/api/other/assembly/dialect/#asm-dialect-comment">Comments</a></div><div class="hide link depth-5"><a href="/api/other/assembly/dialect/#asm-dialect-scope">Scopes</a></div><div class="hide link depth-5"><a href="/api/other/assembly/dialect/#asm-dialect-datasegment">Data Segment</a></div><div class="hide link depth-5"><a href="/api/other/assembly/dialect/#asm-dialect-links">Links</a></div><div class="hide link depth-5"><a href="/api/other/assembly/dialect/#asm-dialect-placeholder">Stack Placeholders</a></div><div class="hide link depth-5"><a href="/api/other/assembly/dialect/#asm-dialect-scripting">Evaluation and Excution</a></div><div class="hide link depth-4"><a href="/api/other/assembly/api/">Utilities</a></div><div class="hide link depth-5"><a href="/api/other/assembly/api/#asm-utilities--assembler">Assembler</a></div><div class="hide link depth-5"><a href="/api/other/assembly/api/#asm-utilities--disassembler">Disassembler</a></div><div class="hide link depth-5"><a href="/api/other/assembly/api/#asm-opcode">Opcode</a></div><div class="hide link depth-4"><a href="/api/other/assembly/ast/">Abstract Syntax Tree</a></div><div class="hide link depth-5"><a href="/api/other/assembly/ast/#asm-ast--types">Types</a></div><div class="hide link depth-5"><a href="/api/other/assembly/ast/#asm-ast--nodes">Nodes</a></div><div class="hide link depth-3"><a href="/api/other/hardware/">Hardware Wallets</a></div><div class="hide link depth-4"><a href="/api/other/hardware/#hw-ledger">LedgerSigner</a></div><div class="base show link depth-1"><a href="/cli/">Command Line Interfaces</a></div><div class="hide link depth-2"><a href="/cli/ethers/">Sandbox Utility</a></div><div class="hide link depth-3"><a href="/cli/ethers/#sandbox-utility--help">Help</a></div><div class="hide link depth-3"><a href="/cli/ethers/#sandbox-utility--examples">Examples</a></div><div class="hide link depth-2"><a href="/cli/asm/">Assembler</a></div><div class="hide link depth-3"><a href="/cli/asm/#cli-asm--help">Help</a></div><div class="hide link depth-3"><a href="/cli/asm/#cli-asm--example-input-files">Example Input Files</a></div><div class="hide link depth-3"><a href="/cli/asm/#cli-asm--assembler-examples">Assembler Examples</a></div><div class="hide link depth-3"><a href="/cli/asm/#cli-asm--disassembler-examples">Disassembler Examples</a></div><div class="hide link depth-2"><a href="/cli/ens/">Ethereum Naming Service</a></div><div class="hide link depth-3"><a href="/cli/ens/#ethereum-naming-service--help">Help</a></div><div class="hide link depth-3"><a href="/cli/ens/#ethereum-naming-service--examples">Examples</a></div><div class="hide link depth-2"><a href="/cli/typescript/">TypeScript</a></div><div class="hide link depth-3"><a href="/cli/typescript/#typescript--help">Help</a></div><div class="hide link depth-3"><a href="/cli/typescript/#typescript--examples">Examples</a></div><div class="hide link depth-2"><a href="/cli/plugin/">Making Your Own</a></div><div class="hide link depth-3"><a href="/cli/plugin/#cli-cli">CLI</a></div><div class="hide link depth-3"><a href="/cli/plugin/#cli-plugin">Plugin</a></div><div class="hide link depth-3"><a href="/cli/plugin/#cli-argparser">ArgParser</a></div><div class="base show link depth-1"><a href="/cookbook/">Cookbook</a></div><div class="base show link depth-1"><a href="/migration/">Migration Guide</a></div><div class="hide link depth-2"><a href="/migration/web3/">Migration: From Web3.js</a></div><div class="hide link depth-3"><a href="/migration/web3/#migration-from-web3-js--contracts">Contracts</a></div><div class="hide link depth-3"><a href="/migration/web3/#migration-from-web3-js--providers">Providers</a></div><div class="hide link depth-3"><a href="/migration/web3/#migration-from-web3-js--numbers">Numbers</a></div><div class="hide link depth-3"><a href="/migration/web3/#migration-from-web3-js--utilities">Utilities</a></div><div class="hide link depth-2"><a href="/migration/ethers-v4/">Migration: From Ethers v4</a></div><div class="hide link depth-3"><a href="/migration/ethers-v4/#migration-v4--bignumber">BigNumber</a></div><div class="hide link depth-3"><a href="/migration/ethers-v4/#migration-v4--contracts">Contracts</a></div><div class="hide link depth-3"><a href="/migration/ethers-v4/#migration-v4--errors">Errors</a></div><div class="hide link depth-3"><a href="/migration/ethers-v4/#migration-v4--interface">Interface</a></div><div class="hide link depth-3"><a href="/migration/ethers-v4/#migration-v4--utilities">Utilities</a></div><div class="hide link depth-3"><a href="/migration/ethers-v4/#migration-v4--wallet">Wallet</a></div><div class="base show link depth-1"><a href="/testing/">Testing</a></div><div class="base show link depth-1"><a href="/contributing/">Contributing and Hacking</a></div><div class="hide link depth-2"><a href="/contributing/#contributing-and-hacking--building">Building</a></div><div class="base show link depth-1"><a href="/documentation/">Flatworm Docs</a></div><div class="hide link depth-2"><a href="/documentation/#flatworm-fragments">Fragments</a></div><div class="hide link depth-2"><a href="/documentation/#flatworm-markdown">Markdown</a></div><div class="hide link depth-2"><a href="/documentation/#flatworm-config">Configuration</a></div><div class="hide link depth-2"><a href="/documentation/#flatworm-extended-directive-functions">Extended Directive Functions</a></div><div class="base show link depth-1"><a href="/license/">License and Copyright</a></div></div></div></div><div class="content"><div class="breadcrumbs"><a href="/">Documentation</a> » <a href="/api/">API</a> » <a href="/api/utils/">Utilities</a> » <span class="current">FixedNumber</span></div><a name="fixednumber"></a><a name="fixednumber"></a><a name="fixednumber"></a><h1 class="show-anchors"><div>FixedNumber<div class="anchors"><a class="self" href="#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="fixednumber--creating-instances"></a><h2 class="show-anchors"><div>Creating Instances<div class="anchors"><a class="self" href="#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="method">from</span> ( <span class="param">value</span> [ , <span class="param">format</span> = <span class="default-value">"</span><span class="param">fixed</span>" ] ) <span class="arrow">⇒</span> <span class="returns"><a href="/api/utils/fixednumber/">FixedNumber</a></span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/ethers-v5-beta/packages/bignumber/src.ts/fixednumber.ts#L323">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="method">fromBytes</span> ( <span class="param">aBytesLike</span> [ , <span class="param">format</span> = <span class="default-value">"</span><span class="param">fixed</span>" ] ) <span class="arrow">⇒</span> <span class="returns"><a href="/api/utils/fixednumber/">FixedNumber</a></span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/ethers-v5-beta/packages/bignumber/src.ts/fixednumber.ts#L305">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="method">fromString</span> ( <span class="param">value</span> [ , <span class="param">format</span> = <span class="default-value">"</span><span class="param">fixed</span>" ] ) <span class="arrow">⇒</span> <span class="returns"><a href="/api/utils/fixednumber/">FixedNumber</a></span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/ethers-v5-beta/packages/bignumber/src.ts/fixednumber.ts#L281">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="method">fromValue</span> ( <span class="param">value</span> [ , <span class="param">decimals</span> = <span class="default-value">0</span> [ , <span class="param">format</span> = <span class="default-value">"</span><span class="param">fixed</span>" ] ] ) <span class="arrow">⇒</span> <span class="returns"><a href="/api/utils/fixednumber/">FixedNumber</a></span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/ethers-v5-beta/packages/bignumber/src.ts/fixednumber.ts#L267">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="fixednumber--properties"></a><h2 class="show-anchors"><div>Properties<div class="anchors"><a class="self" href="#fixednumber--properties"></a></div></div></h2>
|
|
|
|
<div class="property show-anchors"><div class="signature"><span class="path">fixednumber</span> . <span class="method">format</span><div class="anchors"></div></div><div class="body"><p>The <a href="/api/utils/fixednumber/#fixedformat">FixedFormat</a> of <i>fixednumber</i>.</p></div></div>
|
|
<a name="fixednumber--methods"></a><h2 class="show-anchors"><div>Methods<div class="anchors"><a class="self" href="#fixednumber--methods"></a></div></div></h2>
|
|
|
|
<a name="fixednumber--methods--math-operations"></a><h3 class="show-anchors"><div>Math Operations<div class="anchors"><a class="self" href="#fixednumber--methods--math-operations"></a></div></div></h3>
|
|
|
|
<div class="property show-anchors"><div class="signature"><span class="path">fixednumber</span> . <span class="method">addUnsafe</span> ( <span class="param">otherValue</span> ) <span class="arrow">⇒</span> <span class="returns"><a href="/api/utils/fixednumber/">FixedNumber</a></span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/ethers-v5-beta/packages/bignumber/src.ts/fixednumber.ts#L203">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="method">subUnsafe</span> ( <span class="param">otherValue</span> ) <span class="arrow">⇒</span> <span class="returns"><a href="/api/utils/fixednumber/">FixedNumber</a></span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/ethers-v5-beta/packages/bignumber/src.ts/fixednumber.ts#L210">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="method">mulUnsafe</span> ( <span class="param">otherValue</span> ) <span class="arrow">⇒</span> <span class="returns"><a href="/api/utils/fixednumber/">FixedNumber</a></span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/ethers-v5-beta/packages/bignumber/src.ts/fixednumber.ts#L217">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="method">divUnsafe</span> ( <span class="param">otherValue</span> ) <span class="arrow">⇒</span> <span class="returns"><a href="/api/utils/fixednumber/">FixedNumber</a></span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/ethers-v5-beta/packages/bignumber/src.ts/fixednumber.ts#L224">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="method">round</span> ( [ <span class="param">decimals</span> = <span class="default-value">0</span> ] ) <span class="arrow">⇒</span> <span class="returns"><a href="/api/utils/fixednumber/">FixedNumber</a></span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/ethers-v5-beta/packages/bignumber/src.ts/fixednumber.ts#L232">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="fixednumber--methods--conversion"></a><h3 class="show-anchors"><div>Conversion<div class="anchors"><a class="self" href="#fixednumber--methods--conversion"></a></div></div></h3>
|
|
|
|
<div class="property show-anchors"><div class="signature"><span class="path">fixednumber</span> . <span class="method">toFormat</span> ( <span class="param">format</span> ) <span class="arrow">⇒</span> <span class="returns"><a href="/api/utils/fixednumber/">FixedNumber</a></span><div class="anchors"><a class="source" href="https://github.com/ethers-io/ethers.js/blob/ethers-v5-beta/packages/bignumber/src.ts/fixednumber.ts#L262">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="method">toHexString</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/ethers-v5-beta/packages/bignumber/src.ts/fixednumber.ts#L253">source</a></div></div><div class="body"><p>Returns a <a href="/api/utils/bytes/#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="method">toString</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/ethers-v5-beta/packages/bignumber/src.ts/fixednumber.ts#L251">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="method">toUnsafeFloat</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/ethers-v5-beta/packages/bignumber/src.ts/fixednumber.ts#L260">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="fixednumber--methods--inspection"></a><h3 class="show-anchors"><div>Inspection<div class="anchors"><a class="self" href="#fixednumber--methods--inspection"></a></div></div></h3>
|
|
|
|
<div class="property show-anchors"><div class="signature"><span class="path">FixedNumber</span> . <span class="method">isFixedNumber</span> ( <span class="param">value</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/ethers-v5-beta/packages/bignumber/src.ts/fixednumber.ts#L344">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="fixedformat"></a><a name="fixednumber--fixedformat"></a><a name="fixedformat"></a><h2 class="show-anchors"><div>FixedFormat<div class="anchors"><a class="self" href="#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="/api/utils/fixednumber/#fixedformatstring">Format Strings</a> directly into the <a href="/api/utils/fixednumber/">FixedNumber</a> will automatically create this.</p>
|
|
<a name="fixedformatstring"></a><a name="fixednumber--fixedformat--fixedformatstring"></a><a name="fixedformatstring"></a><h3 class="show-anchors"><div>Format Strings<div class="anchors"><a class="self" href="#fixedformatstring"></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><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 ``int32_t` in C</li><li><b>ufixed32x0</b> is unsigned, 32 bits wide and has 0 decimals; this would be the same as a ``uint32_t` in C</li><li><b>fixed</b> is shorthand for ``fixed128x18`</li><li><b>ufixed</b> is shorthand for ``ufixed128x18`</li></ul>
|
|
<a name="fixednumber--fixedformat--creating-instances"></a><h3 class="show-anchors"><div>Creating Instances<div class="anchors"><a class="self" href="#fixednumber--fixedformat--creating-instances"></a></div></div></h3>
|
|
|
|
<a name="fixednumber-from"></a><div class="property show-anchors"><div class="signature"><span class="path">FixedFormat</span> . <span class="method">from</span> ( <span class="param">value</span> = <span class="default-value">"</span><span class="param">fixed128x18</span>" ) <span class="arrow">⇒</span> <span class="returns"><a href="/api/utils/fixednumber/#fixedformat">FixedFormat</a></span><div class="anchors"><a class="self" href="#fixednumber-from"></a><a class="source" href="https://github.com/ethers-io/ethers.js/blob/ethers-v5-beta/packages/bignumber/src.ts/fixednumber.ts#L134">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="/api/utils/fixednumber/#fixedformatstring">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="/api/utils/fixednumber/#fixedformat">FixedFormat</a> object.</p></div></div>
|
|
<a name="fixednumber--fixedformat--properties"></a><h3 class="show-anchors"><div>Properties<div class="anchors"><a class="self" href="#fixednumber--fixedformat--properties"></a></div></div></h3>
|
|
|
|
<div class="property show-anchors"><div class="signature"><span class="path">fixedFormat</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="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="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="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 show-anchors"><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="footer"><div class="nav previous"><a href="/api/utils/encoding/"><span class="arrow">←</span>Encoding Utilities</a></div> <div class="nav next"><a href="/api/utils/hashing/">Hashing Algorithms<span class="arrow">→</span></a></div></div><div class="copyright">The content of this site is licensed under the <a href="https://choosealicense.com/licenses/cc-by-4.0/">Creative Commons Attribution 4.0 International License</a>.</div></div><script src="/script.js" type="text/javascript"></script></body></html><!-- ContentHash:336a7055d8c9c3b8b03c227a15f0a9ac02667010f5e4a76ca3663dfca8fcc126 --> |