Class: TokenCalculations
Calculates to and from units for a token based on decimals
Hierarchy
TokenCalculations↳
Token
Constructors
constructor
• new TokenCalculations(decimals, displayedDecimals): TokenCalculations
Parameters
| Name | Type | Description |
|---|---|---|
decimals | number | Number of decimals used by the token. |
displayedDecimals | number | - |
Returns
Defined in
@mangrovedao/mangrove.js/src/token.ts:64
Properties
decimals
• decimals: number
Number of decimals used by the token.
Defined in
@mangrovedao/mangrove.js/src/token.ts:65
displayedDecimals
• displayedDecimals: number
Defined in
@mangrovedao/mangrove.js/src/token.ts:66
Methods
fromUnits
▸ fromUnits(amount): Big
Convert base/quote from internal amount to public amount.
Uses each token's decimals parameter.
Parameters
| Name | Type |
|---|---|
amount | string | number | BigNumber |
Returns
Big
Example
const usdc = await mgv.token("USDC");
token.fromUnits("1e7") // 10
const dai = await mgv.token("DAI")
market.fromUnits("1e18") // 1
Defined in
@mangrovedao/mangrove.js/src/token.ts:81
toUnits
▸ toUnits(amount): BigNumber
Convert base/quote from public amount to internal contract amount.
Uses each token's decimals parameter.
If bq is "base", will convert the base, the quote otherwise.
Parameters
| Name | Type |
|---|---|
amount | BigSource |
Returns
BigNumber
Example
const usdc = await mgv.token("USDC");
token.toUnits(10) // 10e7 as ethers.BigNumber
const dai = await mgv.token("DAI")
market.toUnits(1) // 1e18 as ethers.BigNumber
Defined in
@mangrovedao/mangrove.js/src/token.ts:98
toFixed
▸ toFixed(amount, decimals?): string
Convert human-readable amounts to a string with the given number of decimal places. Defaults to the token's decimals places.
Parameters
| Name | Type |
|---|---|
amount | BigSource |
decimals? | number |
Returns
string
Example
token.toFixed("10.123"); // "10.12"
token.toFixed(token.fromUnits("1e7"));
Defined in
@mangrovedao/mangrove.js/src/token.ts:112
round
▸ round(amount): Big
Rounds an amount according to the token's decimals.
Parameters
| Name | Type | Description |
|---|---|---|
amount | Big | The amount to round. |
Returns
Big
The rounded amount.
Defined in
@mangrovedao/mangrove.js/src/token.ts:123