Class Pair

Hierarchy

Pair

Constructors

constructor

new Pair(address: string, first: Currency, second: Currency, state: PairState): Pair

- Defined in model/Pair.ts:20
Parameters
- address: string
- first: Currency
- second: Currency
- state: PairState
Returns Pair

Properties

Readonly address

address: string

Private inverted

inverted: boolean

Private oracle

oracle: Oracle

Methods

getBurnFee

getBurnFee(): BigNumber

- Defined in model/Pair.ts:215
Returns BigNumber

getBurnOutput

getBurnOutput(liquidity: BigNumber): { first: CurrencyValue; second: CurrencyValue }

- Defined in model/Pair.ts:182
Parameters
- liquidity: BigNumber
Returns { first: CurrencyValue; second: CurrencyValue }
- first: CurrencyValue
- second: CurrencyValue

getChainId

getChainId(): undefined | ChainId

- Defined in model/Pair.ts:135
Returns undefined | ChainId

Private getDepositAmount0In

getDepositAmount0In(amount0: BigNumber, updatedReserve0: BigNumber, updatedReserve1: BigNumber): BigNumber

- Defined in model/Pair.ts:370
Parameters
- amount0: BigNumber
- updatedReserve0: BigNumber
- updatedReserve1: BigNumber
Returns BigNumber

Private getDepositAmount1In

getDepositAmount1In(amount1: BigNumber, updatedReserve0: BigNumber, updatedReserve1: BigNumber): BigNumber

- Defined in model/Pair.ts:374
Parameters
- amount1: BigNumber
- updatedReserve0: BigNumber
- updatedReserve1: BigNumber
Returns BigNumber

getDepositReservesFraction

getDepositReservesFraction(firstTokenPrice?: TokenPrice, secondTokenPrice?: TokenPrice): undefined | BigNumber

- Defined in model/Pair.ts:90
Parameters
- Optional firstTokenPrice: TokenPrice
- Optional secondTokenPrice: TokenPrice
Returns undefined | BigNumber

getEstimatedSwapFee

getEstimatedSwapFee(input: BigNumber): BigNumber

- Defined in model/Pair.ts:74
Parameters
- input: BigNumber
Returns BigNumber

Private getExtraLiquidity

getExtraLiquidity(amount0: BigNumber, amount1: BigNumber, reserve0: BigNumber, reserve1: BigNumber, liquidity: BigNumber): { extraLiquidity: BigNumber; swapDeposit0Amount: BigNumber; swapDeposit1Amount: BigNumber }

- Defined in model/Pair.ts:316
Parameters
- amount0: BigNumber
- amount1: BigNumber
- reserve0: BigNumber
- reserve1: BigNumber
- liquidity: BigNumber
Returns { extraLiquidity: BigNumber; swapDeposit0Amount: BigNumber; swapDeposit1Amount: BigNumber }
- extraLiquidity: BigNumber
- swapDeposit0Amount: BigNumber
- swapDeposit1Amount: BigNumber

getFirstLiquidityIn

getFirstLiquidityIn(secondLiquidityIn: CurrencyValue): undefined | CurrencyValue

- Defined in model/Pair.ts:141
Parameters
- secondLiquidityIn: CurrencyValue
Returns undefined | CurrencyValue

getFirstReserve

getFirstReserve(): CurrencyValue

- Defined in model/Pair.ts:82
Returns CurrencyValue

getInitialRatio

getInitialRatio(): BigNumber

- Defined in model/Pair.ts:196
Returns BigNumber

getLiquidity

getLiquidity(firstValue: CurrencyValue, secondValue: CurrencyValue, proportional: boolean): { liquidity: BigNumber; swapDepositFirstAmount: CurrencyValue; swapDepositSecondAmount: CurrencyValue }

- Defined in model/Pair.ts:165
Parameters
- firstValue: CurrencyValue
- secondValue: CurrencyValue
- proportional: boolean
Returns { liquidity: BigNumber; swapDepositFirstAmount: CurrencyValue; swapDepositSecondAmount: CurrencyValue }
- liquidity: BigNumber
- swapDepositFirstAmount: CurrencyValue
- swapDepositSecondAmount: CurrencyValue

getMintFee

getMintFee(): BigNumber

- Defined in model/Pair.ts:219
Returns BigNumber

getPrice

getPrice(): BigNumber

- Defined in model/Pair.ts:207
Returns BigNumber

Private getRatio

getRatio(amount0: BigNumber, amount1: BigNumber, reserve0: BigNumber, reserve1: BigNumber): { ratio: BigNumber; ratio0: BigNumber; ratio1: BigNumber }

- Defined in model/Pair.ts:340
Parameters
- amount0: BigNumber
- amount1: BigNumber
- reserve0: BigNumber
- reserve1: BigNumber
Returns { ratio: BigNumber; ratio0: BigNumber; ratio1: BigNumber }
- ratio: BigNumber
- ratio0: BigNumber
- ratio1: BigNumber

Private getRawLiquidity

getRawLiquidity(currency0: CurrencyValue, currency1: CurrencyValue, proportional: boolean): { liquidity: BigNumber; swapDeposit0Amount: CurrencyValue; swapDeposit1Amount: CurrencyValue }

- Defined in model/Pair.ts:261
Parameters
- currency0: CurrencyValue
- currency1: CurrencyValue
- proportional: boolean
Returns { liquidity: BigNumber; swapDeposit0Amount: CurrencyValue; swapDeposit1Amount: CurrencyValue }
- liquidity: BigNumber
- swapDeposit0Amount: CurrencyValue
- swapDeposit1Amount: CurrencyValue

getSecondLiquidityIn

getSecondLiquidityIn(firstLiquidityIn: CurrencyValue): undefined | CurrencyValue

- Defined in model/Pair.ts:153
Parameters
- firstLiquidityIn: CurrencyValue
Returns undefined | CurrencyValue

getSecondReserve

getSecondReserve(): CurrencyValue

- Defined in model/Pair.ts:86
Returns CurrencyValue

Private getSwapAmount0In

getSwapAmount0In(amount1Out: BigNumber): BigNumber

- Defined in model/Pair.ts:223
Parameters
- amount1Out: BigNumber
Returns BigNumber

Private getSwapAmount0Out

getSwapAmount0Out(amount1In: BigNumber, updatedReserves?: [BigNumber, BigNumber]): BigNumber

- Defined in model/Pair.ts:237
Parameters
- amount1In: BigNumber
- Optional updatedReserves: [BigNumber, BigNumber]
Returns BigNumber

Private getSwapAmount1In

getSwapAmount1In(amount0Out: BigNumber): BigNumber

- Defined in model/Pair.ts:230
Parameters
- amount0Out: BigNumber
Returns BigNumber

Private getSwapAmount1Out

getSwapAmount1Out(amount0In: BigNumber, updatedReserves?: [BigNumber, BigNumber]): BigNumber

- Defined in model/Pair.ts:249
Parameters
- amount0In: BigNumber
- Optional updatedReserves: [BigNumber, BigNumber]
Returns BigNumber

getSwapFee

getSwapFee(): BigNumber

- Defined in model/Pair.ts:211
Returns BigNumber

getSwapInput

getSwapInput(output: CurrencyValue): undefined | CurrencyValue

- Defined in model/Pair.ts:32
Parameters
- output: CurrencyValue
Returns undefined | CurrencyValue

getSwapOutput

getSwapOutput(input: CurrencyValue): undefined | CurrencyValue

- Defined in model/Pair.ts:53
Parameters
- input: CurrencyValue
Returns undefined | CurrencyValue

getToken0Address

getToken0Address(): string

- Defined in model/Pair.ts:123
Returns string

getToken0Symbol

getToken0Symbol(): string

- Defined in model/Pair.ts:115
Returns string

getToken1Address

getToken1Address(): string

- Defined in model/Pair.ts:127
Returns string

getToken1Symbol

getToken1Symbol(): string

- Defined in model/Pair.ts:119
Returns string

getTotalSupply

getTotalSupply(): BigNumber

- Defined in model/Pair.ts:131
Returns BigNumber

Private initialDeposit

initialDeposit(ratio: BigNumber): BigNumber[]

- Defined in model/Pair.ts:347
Parameters
- ratio: BigNumber
Returns BigNumber[]

isEmpty

isEmpty(): boolean

- Defined in model/Pair.ts:78
Returns boolean

Private swapDeposit0

swapDeposit0(amount0: BigNumber, updatedReserve0: BigNumber, updatedReserve1: BigNumber): BigNumber[]

- Defined in model/Pair.ts:352
Parameters
- amount0: BigNumber
- updatedReserve0: BigNumber
- updatedReserve1: BigNumber
Returns BigNumber[]

Private swapDeposit1

swapDeposit1(amount1: BigNumber, updatedReserve0: BigNumber, updatedReserve1: BigNumber): BigNumber[]

- Defined in model/Pair.ts:361
Parameters
- amount1: BigNumber
- updatedReserve0: BigNumber
- updatedReserve1: BigNumber
Returns BigNumber[]