near-amount-formatter

A utility package for formatting and parsing NEAR Protocol token amounts.

Installation

npm install near-amount-formatter

Usage

Format yoctoNEAR to NEAR

import { formatNearAmount } from 'near-amount-formatter';

const near = formatNearAmount('1000000000000000000000000', 5); // '1.00000'

Parse NEAR to yoctoNEAR

import { parseNearAmount } from 'near-amount-formatter';

const yocto = parseNearAmount('1.5'); // '1500000000000000000000000'

Get formatted account balance

import { getFormattedBalance } from 'near-amount-formatter';

const balance = await getFormattedBalance('alice.near', 5); // { yocto: '...', near: '1.23456' }

Format raw token amount

import { formatTokenAmount } from 'near-amount-formatter';

const amount = formatTokenAmount('1000000', 6, 6); // '1.000000'

Get formatted token balance

import { getFormattedTokenBalance } from 'near-amount-formatter';

const token = await getFormattedTokenBalance( 'token.contract.near', 'alice.near', 18, 6 ); // { raw: '...', formatted: '1.234567' }

API

| Function | Returns | |---|---| | formatNearAmount(yoctoAmount, decimals?) | string | | parseNearAmount(nearAmount) | string | | getFormattedBalance(accountId, decimals?) | Promise<{ yocto, near }> | | formatTokenAmount(rawAmount, tokenDecimals, displayDecimals?) | string | | getFormattedTokenBalance(contractId, accountId, tokenDecimals, displayDecimals?) | Promise<{ raw, formatted }> |

License

MIT