Class ConcentratedLiquidityPool

Represents a liquidity pool that uses concentrated liquidity (e.g. Uniswap V3).

Hierarchy

ConcentratedLiquidityPool

Index

Constructors

constructor

new ConcentratedLiquidityPool(__namedParameters?: {
feeRate?: number;
initialPrice?: number;
}): ConcentratedLiquidityPool
Parameters
- __namedParameters: {
  feeRate?: number;
  initialPrice?: number;
  } = {}
  - Optional feeRate?: number
  - Optional initialPrice?: number
Returns ConcentratedLiquidityPool
- Defined in concentrated-liquidity-pool.ts:24

Properties

`Readonly` feeRate

feeRate: number

The amount of fees taken from each transaction with the pool.

positions

positions: Map<string, ConcentratedLiquidityPosition> = ...

Holds a map of all active positions in the liquidity pool.

`Private` sqrtPrice

sqrtPrice: number

The internal representation of the price. The square root is tracked for easier math.

Accessors

price

get price(): number
Current price of X as expressed in Y (i.e. amount of Y tokens needed to buy 1 token of X).

Returns number
- Defined in concentrated-liquidity-pool.ts:33

Methods

`Private` addFeesToPositions

addFeesToPositions(__namedParameters: {
    direction: Direction;
    feesToSplit: number;
    token: "x" | "y";
    totalLiquidity: number;
}): void
Parameters
- __namedParameters: {
      direction: Direction;
      feesToSplit: number;
      token: "x" | "y";
      totalLiquidity: number;
  }
  - direction: Direction
  - feesToSplit: number
  - token: "x" | "y"
  - totalLiquidity: number
Returns void
- Defined in concentrated-liquidity-pool.ts:291

buyX

buyX(xDesired: number): number
Returns
The amount of Y tokens you need to pay.
Parameters
- xDesired: number
Returns number
- Defined in concentrated-liquidity-pool.ts:215

buyY

buyY(yDesired: number): number
Returns
The amount of X tokens you need to pay.
Parameters
- yDesired: number
Returns number
- Defined in concentrated-liquidity-pool.ts:148

enterPosition

enterPosition(params: {
    balance?: undefined;
    liquidity: number;
    range: Range;
} | {
    balance: Balance;
    liquidity?: undefined;
    range: Range;
}): ConcentratedLiquidityPosition
When you enter a position, you start providing liquidity to the pool. The position will gain rewards when a trade occurs inside the range in which it is active.
Parameters
- params: {
      balance?: undefined;
      liquidity: number;
      range: Range;
  } | {
      balance: Balance;
      liquidity?: undefined;
      range: Range;
  }
Returns ConcentratedLiquidityPosition
- Defined in concentrated-liquidity-pool.ts:38

exitPosition

exitPosition(id: string): {
x: number;
y: number;
}
Exit all tokens of a position and the rewards that were acrued.
Parameters
- id: string
Returns {
x: number;
y: number;
}
- x: number
- y: number
- Defined in concentrated-liquidity-pool.ts:53

getCurrentRange

getCurrentRange(dir?: Direction): Range
Consider all positions whose range includes the current price and find the narrowest range that is contained by all the ranges of the matched positions. Within this range, the liquidity stays constant during price movements.

Returns
The current active range.
Parameters
- dir: Direction = Direction.UP
  
  The direction of price movement to consider. This becomes relevant when you're at a point exactly in between two possible ranges, each of which could have a different virtual liquidity
Returns Range
- Defined in concentrated-liquidity-pool.ts:94

`Private` getDInvSqrtPrice

getDInvSqrtPrice(dSqrtPrice: number): number
Parameters
- dSqrtPrice: number
Returns number
- Defined in concentrated-liquidity-pool.ts:315

`Private` getDSqrtPrice

getDSqrtPrice(dInvSqrtPrice: number): number
Parameters
- dInvSqrtPrice: number
Returns number
- Defined in concentrated-liquidity-pool.ts:321

getLiquidityInCurrentRange

getLiquidityInCurrentRange(dir: Direction): number
Returns
The amount of virtual liquidity that is available in the current active range.
Parameters
- dir: Direction
  
  The direction of price movement to consider. This becomes relevant when you're at a point exactly in between two possible ranges, each of which could have a different virtual liquidity
Returns number
- Defined in concentrated-liquidity-pool.ts:84

getPosition

getPosition(id: string): undefined | ConcentratedLiquidityPosition
Returns the position with the requested id.
Parameters
- id: string
Returns undefined | ConcentratedLiquidityPosition
- Defined in concentrated-liquidity-pool.ts:66

getPositionsInRange

getPositionsInRange(dir: Direction): ConcentratedLiquidityPosition[]
Returns
An array of positions that are currently contributing to the virtual liquidity in the active range.
Parameters
- dir: Direction
  
  The direction of price movement to consider. This becomes relevant when you're at a point exactly in between two possible ranges, each of which could have a different virtual liquidity
Returns ConcentratedLiquidityPosition[]
- Defined in concentrated-liquidity-pool.ts:73

movePrice

movePrice(targetPrice: number): {
delta: Balance;
}
Make a trade that moves the price to the target.

Returns
The balance delta required to make this trade. Negative values are paid to the pool, positive values are received in return.
Parameters
- targetPrice: number
Returns {
delta: Balance;
}
- delta: Balance
- Defined in concentrated-liquidity-pool.ts:250

sellX

sellX(xWithFees: number): number
Returns
The amount of Y tokens you receive.
Parameters
- xWithFees: number
Returns number
- Defined in concentrated-liquidity-pool.ts:181

sellY

sellY(yWithFees: number): number
Returns
The amount of X tokens you receive.
Parameters
- yWithFees: number
Returns number
- Defined in concentrated-liquidity-pool.ts:114

Class ConcentratedLiquidityPool

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

__namedParameters: { feeRate?: number; initialPrice?: number; } = {}

Optional feeRate?: number

Optional initialPrice?: number

Returns ConcentratedLiquidityPool

Properties

Readonly feeRate

positions

Private sqrtPrice

Accessors

price

Returns number

Methods

Private addFeesToPositions

Parameters

__namedParameters: { direction: Direction; feesToSplit: number; token: "x" | "y"; totalLiquidity: number; }

direction: Direction

feesToSplit: number

token: "x" | "y"

totalLiquidity: number

Returns void

buyX

Returns

Parameters

xDesired: number

Returns number

buyY

Returns

Parameters

yDesired: number

Returns number

enterPosition

Parameters

params: { balance?: undefined; liquidity: number; range: Range; } | { balance: Balance; liquidity?: undefined; range: Range; }

Returns ConcentratedLiquidityPosition

exitPosition

Parameters

id: string

Returns { x: number; y: number; }

x: number

y: number

getCurrentRange

Returns

Parameters

dir: Direction = Direction.UP

Returns Range

Private getDInvSqrtPrice

Parameters

dSqrtPrice: number

Returns number

Private getDSqrtPrice

Parameters

dInvSqrtPrice: number

Returns number

getLiquidityInCurrentRange

Returns

Parameters

dir: Direction

Returns number

getPosition

Parameters

id: string

Returns undefined | ConcentratedLiquidityPosition

getPositionsInRange

Returns

Parameters

dir: Direction

Returns ConcentratedLiquidityPosition[]

movePrice

Returns

Parameters

__namedParameters: {
feeRate?: number;
initialPrice?: number;
} = {}

`Optional` feeRate?: number

`Optional` initialPrice?: number

`Readonly` feeRate

`Private` sqrtPrice

`Private` addFeesToPositions

__namedParameters: {
direction: Direction;
feesToSplit: number;
token: "x" | "y";
totalLiquidity: number;
}

params: {
balance?: undefined;
liquidity: number;
range: Range;
} | {
balance: Balance;
liquidity?: undefined;
range: Range;
}

Returns {
x: number;
y: number;
}

`Private` getDInvSqrtPrice

`Private` getDSqrtPrice

Returns {
delta: Balance;
}