Class PriceMath

A collection of utility functions to convert between price, tickIndex and sqrtPrice.

Index

Constructors

Methods

getSlippageBoundForSqrtPrice invertPrice invertSqrtPriceX64 priceToInitializableTickIndex priceToSqrtPriceX64 priceToTickIndex sqrtPriceX64ToPrice sqrtPriceX64ToTickIndex tickIndexToPrice tickIndexToSqrtPriceX64

Constructors

constructor

new PriceMath(): PriceMath
Returns PriceMath

Methods

`Static`getSlippageBoundForSqrtPrice

getSlippageBoundForSqrtPrice(
sqrtPriceX64: BN,
slippage: Percentage,
): { lowerBound: [BN, number]; upperBound: [BN, number] }
Calculate the sqrtPriceX64 & tick index slippage price boundary for a given price and slippage. Note: This function loses precision
Parameters
- sqrtPriceX64: BN
  the sqrtPriceX64 to apply the slippage on
- slippage: Percentage
  the slippage to apply onto the sqrtPriceX64
Returns { lowerBound: [BN, number]; upperBound: [BN, number] }
the sqrtPriceX64 & tick index slippage price boundary
- Defined in utils/public/price-math.ts:194

`Static`invertPrice

invertPrice(price: Decimal, decimalsA: number, decimalsB: number): Decimal
Utility to invert the price Pb/Pa to Pa/Pb NOTE: precision is lost in this conversion
Parameters
- price: Decimal
  Pb / Pa
- decimalsA: number
  Decimals of original token A (i.e. token A in the given Pb / Pa price)
- decimalsB: number
  Decimals of original token B (i.e. token B in the given Pb / Pa price)
Returns Decimal
inverted price, i.e. Pa / Pb
- Defined in utils/public/price-math.ts:163

`Static`invertSqrtPriceX64

invertSqrtPriceX64(sqrtPriceX64: BN): BN
Utility to invert the sqrtPriceX64 from X64 repr. of sqrt(Pb/Pa) to X64 repr. of sqrt(Pa/Pb) NOTE: precision is lost in this conversion
Parameters
- sqrtPriceX64: BN
  X64 representation of sqrt(Pb / Pa)
Returns BN
inverted sqrtPriceX64, i.e. X64 representation of sqrt(Pa / Pb)
- Defined in utils/public/price-math.ts:180

`Static`priceToInitializableTickIndex

priceToInitializableTickIndex(
    price: Decimal,
    decimalsA: number,
    decimalsB: number,
    tickSpacing: number,
): number
Parameters
- price: Decimal
- decimalsA: number
- decimalsB: number
- tickSpacing: number
Returns number
- Defined in utils/public/price-math.ts:142

`Static`priceToSqrtPriceX64

priceToSqrtPriceX64(price: Decimal, decimalsA: number, decimalsB: number): BN
Parameters
- price: Decimal
- decimalsA: number
- decimalsB: number
Returns BN
- Defined in utils/public/price-math.ts:24

`Static`priceToTickIndex

priceToTickIndex(price: Decimal, decimalsA: number, decimalsB: number): number
Parameters
- price: Decimal
- decimalsA: number
- decimalsB: number
Returns number
- Defined in utils/public/price-math.ts:132

`Static`sqrtPriceX64ToPrice

sqrtPriceX64ToPrice(
    sqrtPriceX64: BN,
    decimalsA: number,
    decimalsB: number,
): Decimal
Parameters
- sqrtPriceX64: BN
- decimalsA: number
- decimalsB: number
Returns Decimal
- Defined in utils/public/price-math.ts:34

`Static`sqrtPriceX64ToTickIndex

sqrtPriceX64ToTickIndex(sqrtPriceX64: BN): number
Parameters
- sqrtPriceX64: BN
Returns number
- Defined in utils/public/price-math.ts:61

`Static`tickIndexToPrice

tickIndexToPrice(
    tickIndex: number,
    decimalsA: number,
    decimalsB: number,
): Decimal
Parameters
- tickIndex: number
- decimalsA: number
- decimalsB: number
Returns Decimal
- Defined in utils/public/price-math.ts:120

`Static`tickIndexToSqrtPriceX64

tickIndexToSqrtPriceX64(tickIndex: number): BN
Parameters
- tickIndex: number
Returns BN
- Defined in utils/public/price-math.ts:48