Class TradeProtocol

Hierarchy

TradeProtocol

Implements

ITradeProtocol

Index

Constructors

Properties

Methods

getLiquidityPool getLiquidityPools getLiquidityPoolsOfUnderlyingToken getOpenInterest getPrice getTradePair getTradePairs getTradePrice subscribeToMarketPrice tryGetPrice unsubscribeFromMarketPrice create

Constructors

constructor

new TradeProtocol(liquidityPools): TradeProtocol
Parameters
- liquidityPools: TradeLiquidityPool[]
Returns TradeProtocol
- Defined in src/components/trade/protocol.ts:39

Properties

`Private` `Readonly` liquidityPools

liquidityPools: TradeLiquidityPool[]

Methods

getLiquidityPool

getLiquidityPool(id): TradeLiquidityPool
Parameters
- id: string
Returns TradeLiquidityPool
Implementation of ITradeProtocol.getLiquidityPool
- Defined in src/components/trade/protocol.ts:83

getLiquidityPools

getLiquidityPools(): TradeLiquidityPool[]
Returns TradeLiquidityPool[]
Implementation of ITradeProtocol.getLiquidityPools
- Defined in src/components/trade/protocol.ts:69

getLiquidityPoolsOfUnderlyingToken

getLiquidityPoolsOfUnderlyingToken(tokenAddress): TradeLiquidityPool[]
Parameters
- tokenAddress: string
Returns TradeLiquidityPool[]
- Defined in src/components/trade/protocol.ts:73

getOpenInterest

getOpenInterest(pairId): OpenInterest
Parameters
- pairId: TradePairId
Returns OpenInterest
Implementation of ITradeProtocol.getOpenInterest
- Defined in src/components/trade/protocol.ts:126

getPrice

getPrice(pairId, size?): MarketPrice
Parameters
- pairId: TradePairId
- Optional size: BigNumber
  Optional
Returns MarketPrice
Implementation of ITradeProtocol.getPrice
- Defined in src/components/trade/protocol.ts:110

getTradePair

getTradePair(pairId): TradePair
Parameters
- pairId: TradePairId
Returns TradePair
Implementation of ITradeProtocol.getTradePair
- Defined in src/components/trade/protocol.ts:91

getTradePairs

getTradePairs(): TradePair[]
Returns TradePair[]
Implementation of ITradeProtocol.getTradePairs
- Defined in src/components/trade/protocol.ts:95

getTradePrice

getTradePrice(lpId, args): BigNumber
Parameters
- lpId: string
- args: GetTradePriceArgs
Returns BigNumber
Implementation of ITradeProtocol.getTradePrice
- Defined in src/components/trade/protocol.ts:122

subscribeToMarketPrice

subscribeToMarketPrice(args, lpId): number
Parameters
- args: SubscribeMarketPriceArgs
- lpId: string
Returns number
Implementation of ITradeProtocol.subscribeToMarketPrice
- Defined in src/components/trade/protocol.ts:99

tryGetPrice

tryGetPrice(pairId, size?): undefined | MarketPrice
Parameters
- pairId: TradePairId
- Optional size: BigNumber
  Optional
Returns undefined | MarketPrice
Implementation of ITradeProtocol.tryGetPrice
- Defined in src/components/trade/protocol.ts:114

unsubscribeFromMarketPrice

unsubscribeFromMarketPrice(id, lpId): void
Parameters
- id: number
- lpId: string
Returns void
Implementation of ITradeProtocol.unsubscribeFromMarketPrice
- Defined in src/components/trade/protocol.ts:106

`Static` create

create(reader, adapter, usdToken, priceFeed): Promise<TradeProtocol>
Parameters
- reader: TradeReader
- adapter: TradeAdapter
- usdToken: TokenInfo
- priceFeed: TradeLpPriceFeed
Returns Promise<TradeProtocol>
- Defined in src/components/trade/protocol.ts:43

Generated using TypeDoc