Class ConstantProductCalculator

An implementation of a math behind constant product pools.

Hierarchy

ConstantProductCalculator

Implements

SwapCalculator

Index

Constructors

constructor

Properties

pool

Methods

Constructors

constructor

new ConstantProductCalculator(pool: Pool): ConstantProductCalculator

- Defined in src/constantProductCalculator.ts:54
Parameters
- pool: Pool
Returns ConstantProductCalculator

Properties

pool

pool: Pool

Methods

getMintedLiquidityTokens

getMintedLiquidityTokens(addedLiqA: bigint, addedLiqB: bigint): bigint

Implementation of SwapCalculator.getMintedLiquidityTokens
- Defined in src/constantProductCalculator.ts:87
Returns amount of liquidity tokens that are going to be minted when adding liquidity.

Parameters
- addedLiqA: bigint
- addedLiqB: bigint
Returns bigint

getPrice

getPrice(decimalLiqA: number, decimalLiqB: number): number

Implementation of SwapCalculator.getPrice
- Defined in src/constantProductCalculator.ts:56
Calculates the price of assets. Accepts and returns decimal values.

Parameters
- decimalLiqA: number
- decimalLiqB: number
Returns number

getSwapAmountDeposited

getSwapAmountDeposited(liqA: bigint, liqB: bigint, grossAmountReceived: bigint): bigint

Implementation of SwapCalculator.getSwapAmountDeposited
- Defined in src/constantProductCalculator.ts:75
- Converts amountReceived to amountDeposited. Ignores fee calculations.
Parameters
- liqA: bigint
- liqB: bigint
- grossAmountReceived: bigint
Returns bigint

getSwapGrossAmountReceived

getSwapGrossAmountReceived(liqA: bigint, liqB: bigint, amountDeposited: bigint): bigint

Implementation of SwapCalculator.getSwapGrossAmountReceived
- Defined in src/constantProductCalculator.ts:63
Converts amountDeposited to amountReceived. Ignores fee calculations.

Parameters
- liqA: bigint
- liqB: bigint
- amountDeposited: bigint
Returns bigint

Generated using TypeDoc