Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Pair<P>

Represents a swap pair.

A pair consists of two parts:

  • the underlying pool, and
  • the strategy, which determines how the pool should be traded.

Unlike UniswapV2, there may be multiple pairs for a given set of two tokens. For example: there could exist both a StableSwap and a CP-AMM pair for two tokens. It is up to the trade calculator to determine

Type Parameters

  • P = unknown

Hierarchy

  • Pair

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Readonly pool

pool: P

Readonly strategy

strategy: PoolStrategy<P>

Static fromStableSwap

fromStableSwap: ((pool: StableSwapPool) => Pair<StableSwapPool>) = pairFromStableSwap

Type declaration

Static fromWrappedToken

fromWrappedToken: ((wrapped: WrappedToken) => Pair<WrappedToken>) = pairFromWrappedToken

Type declaration

Accessors

network

  • get network(): Network

token0

  • get token0(): Token

token0Price

  • get token0Price(): Price

token1

  • get token1(): Token

token1Price

  • get token1Price(): Price

Methods

asAction

  • asAction(outputToken: Token): Action

getOutputAmount

hasZeroLiquidity

  • hasZeroLiquidity(): boolean

involvesToken

  • involvesToken(token: Token): boolean

isStableSwapPair

isWrappedPair

priceOf

  • priceOf(token: Token): Price

  • Return the price of the given token in terms of the other token in the pair.

    Parameters

    • token: Token

      token to return price of

    Returns Price

toString

  • toString(): string

Generated using TypeDoc