Interface PoolStrategy<P>

Strategy of a pool's LP.

Type Parameters

P

Hierarchy

PoolStrategy

Index

Methods

Methods

asAction

asAction(pool: P, outputToken: Token): Action

- Defined in src/router/entities/pair/strategy.ts:58
Converts this pool to an action.

Parameters
- pool: P
- outputToken: Token
Returns Action

getOutputAmount

getOutputAmount(pool: P, inputAmount: TokenAmount): PoolOutputResult<P>

- Defined in src/router/entities/pair/strategy.ts:33
How many tokens will be output for the given input, and the new pair.

Parameters
- pool: P
- inputAmount: TokenAmount
Returns PoolOutputResult<P>

getPriceOfToken1

getPriceOfToken1(pool: P): Price

- Defined in src/router/entities/pair/strategy.ts:48
Price of token 1 relative to token 0.

Parameters
- pool: P
Returns Price

getToken0

getToken0(pool: P): Token

- Defined in src/router/entities/pair/strategy.ts:38
Gets token 0 of a pool. Arbitrary.

Parameters
- pool: P
Returns Token

getToken1

getToken1(pool: P): Token

- Defined in src/router/entities/pair/strategy.ts:43
Gets token 1 of a pool. Arbitrary.

Parameters
- pool: P
Returns Token

hasZeroLiquidity

hasZeroLiquidity(pool: P): boolean

- Defined in src/router/entities/pair/strategy.ts:53
Returns true if the provided pool has zero liquidity and thus cannot trade.

Parameters
- pool: P
Returns boolean

Generated using TypeDoc