Class: Density
Utility wrapper around raw Density values from Mangrove.
Constructors
constructor
• new Density(rawDensity, outboundDecimals): Density
Construct a wrapper around a raw Density from Mangrove.
Parameters
| Name | Type | Description |
|---|---|---|
rawDensity | BigNumberish | A raw Density from Mangrove |
outboundDecimals | number | number of decimals for the outbound token |
Returns
Defined in
@mangrovedao/mangrove.js/src/util/Density.ts:20
Methods
clone
▸ clone(): Density
Create a copy of this Density object.
Returns
Defined in
@mangrovedao/mangrove.js/src/util/Density.ts:29
from96X32
▸ from96X32(density96X32, outbound_decimals): Density
Factory method for creating a Density object from a 96X32 density.
Parameters
| Name | Type | Description |
|---|---|---|
density96X32 | BigNumberish | density encoded as a 96X32 |
outbound_decimals | number | number of decimals for the outbound token |
Returns
a Density object corresponding to the given density
Defined in
@mangrovedao/mangrove.js/src/util/Density.ts:40
eq
▸ eq(density): boolean
Equality comparison for densities.
Parameters
| Name | Type | Description |
|---|---|---|
density | Density | The density to compare to |
Returns
boolean
true if the given density is equal to this density; false otherwise
Defined in
@mangrovedao/mangrove.js/src/util/Density.ts:56
toString
▸ toString(): string
Format the density formatted as a string.
Returns
string
the density formatted as a 'mantissa * 2^exponent' string
Defined in
@mangrovedao/mangrove.js/src/util/Density.ts:68
toString
▸ toString(rawDensity): string
Format the density formatted as a string.
Parameters
| Name | Type | Description |
|---|---|---|
rawDensity | BigNumberish | the raw density to format |
Returns
string
the density formatted as a 'mantissa * 2^exponent' string
Defined in
@mangrovedao/mangrove.js/src/util/Density.ts:78
isZero
▸ isZero(): boolean
Check whether the density is zero.
Returns
boolean
true if the density is zero; false otherwise
Defined in
@mangrovedao/mangrove.js/src/util/Density.ts:108
getRequiredOutboundForGasreq
▸ getRequiredOutboundForGasreq(gasreq): Big
Get the minimum amount of outbound tokens required for the given amount of gas.
Parameters
| Name | Type | Description |
|---|---|---|
gasreq | BigNumberish | the amount of gas to calculate the required outbound for |
Returns
Big
the minimum amount of outbound tokens required for the given amount of gas
Defined in
@mangrovedao/mangrove.js/src/util/Density.ts:118
getMaximumGasForRawOutbound
▸ getMaximumGasForRawOutbound(rawOutboundAmt): BigNumber
Get the maximum amount of gas an offer may require for the given raw amount of outbound tokens.
Parameters
| Name | Type | Description |
|---|---|---|
rawOutboundAmt | BigNumberish | the raw amount of outbound tokens to calculate the maximum gas for |
Returns
BigNumber
the maximum amount of gas an offer may require for the given raw amount of outbound tokens
Defined in
@mangrovedao/mangrove.js/src/util/Density.ts:133