Security News
NIST Misses 2024 Deadline to Clear NVD Backlog
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.
@audius/fixed-decimal
Advanced tools
A data structure to represent fixed precision decimals.
FixedDecimal
is a data structure used to represent fixed precision decimals.
It's particularly useful for representing currency, especially cryptocurrency, as the underlying bigint
can handle large amounts and extremely fractional amounts while keeping exact precision, and the configured decimal places count allows the class to conveniently operate on the underlying value and represent it in a user-friendly manner.
Unlike BigDecimal
solutions elsewhere, FixedDecimal
is not intended to be persisted and arithmetically operated on, but rather used ephemerally for normalizing and formatting. Almost all of its methods are chainable to make it convenient to initialize a FixedDecimal
, operate on it, and immediately get back a string or bigint
representation.
In fact, you probably won't need to initialize a FixedDecimal
directly. Instead, use helper currency constructors that will ensure the input will be coerced to the proper number of decimals.
npm install @audius/fixed-decimal
new FixedDecimal('12.345').toString() // '12.345'
new FixedDecimal(12.345).toString() // '12.345'
new FixedDecimal(BigInt(12345), 3).toString() // '12.345'
new FixedDecimal('12.345', 6).toString() // '12.345000'
new FixedDecimal(12.345, 6).toString() // '12.345000'
new FixedDecimal(BigInt(12345), 6).toString() // '0.012345'
new FixedDecimal(12345.6789).toLocaleString('en-US', {
maximumFractionDigits: 2
}) // 12,345.67
new FixedDecimal(12345.6789).toLocaleString('en-US', {
maximumFractionDigits: 2,
roundingMode: 'halfExpand'
}) // 12,345.68
If, for example, you want to use the 18 decimal ETH in your code, you could create a helper like:
const ETH = (value) => new FixedDecimal(value, 18)
// Calling .value will get the wei amount
console.log(ETH('1.42')).value // 1420000000000000000n
// Can also go from wei to UI string
console.log(
ETH(12345678901234567890n).toLocaleString('en-US', {
maximumFractionDigits: 2
})
) // 12.34
More examples and documentation can be found in the JSDoc and in the tests.
FAQs
A data structure to represent fixed precision decimals
The npm package @audius/fixed-decimal receives a total of 132 weekly downloads. As such, @audius/fixed-decimal popularity was classified as not popular.
We found that @audius/fixed-decimal demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.
Security News
Cloudflare has launched a setup wizard allowing users to easily create and manage a security.txt file for vulnerability disclosure on their websites.
Security News
The Socket Research team breaks down a malicious npm package targeting the legitimate DOMPurify library. It uses obfuscated code to hide that it is exfiltrating browser and crypto wallet data.