Interface TradeLiquidityPool

id

Optional onUpdate

getAvailableLiquidity

• getAvailableLiquidity(args): Promise<AvailableLiquidity>

• Parameters

  • args: GetAvailableLiquidityArgs

  Returns Promise<AvailableLiquidity>

getLpTokenPrice

• getLpTokenPrice(): Promise<BigNumber>

• Returns Promise<BigNumber>

getOpenInterest

• getOpenInterest(args): OpenInterest

• Parameters

  • args: {
        pair: Pair;
    }

    • pair: Pair

  Returns OpenInterest

getPairAvailability

• getPairAvailability(args): Availability

• Parameters

  • args: GetAvailabilityArgs

  Returns Availability

getPairState

• getPairState(pair): PairState

• Parameters

  • pair: Pair

  Returns PairState

getPrice

• getPrice(pair, size?): Readonly<MarketPrice>

• Parameters

  • pair: Pair
  • Optional size: BigNumber

  Returns Readonly<MarketPrice>

getTradePair

• getTradePair(pair): TradePair

• Parameters

  • pair: Pair

  Returns TradePair

getTradePairs

• getTradePairs(): TradePair[]

• Returns TradePair[]

getTradePrice

• getTradePrice(args): BigNumber

• Parameters

  • args: GetTradePriceArgs

  Returns BigNumber

getUnderlyingToken

• getUnderlyingToken(): TokenInfo

• Returns TokenInfo

listenToLpPairTradeability

• listenToLpPairTradeability(listener): void

• Parameters

  • listener: LpPairTradeabilityListener

  Returns void

placeOrder

• placeOrder(args): Promise<{
      accountId: number;
      accountUser: string;
      createdTimestampUnixMillis: number;
      expiryTimestampUnixMillis: number;
      id: string;
      kind: {
          kind: "market";
      } | {
          args: {
              limitPrice: BigNumber;
          };
          kind: "limit";
      } | {
          args: {
              stopLoss?: null | {
                  kind: "position";
              } | {
                  id: string;
                  kind: "order";
              };
              triggerPrice: BigNumber;
          };
          kind: "stopMarket";
      } | {
          args: {
              limitPrice: BigNumber;
              triggerPrice: BigNumber;
          };
          kind: "stopLimit";
      } | {
          args: {
              takeProfit?: null | {
                  kind: "position";
              } | {
                  id: string;
                  kind: "order";
              };
              triggerPrice: BigNumber;
          };
          kind: "limitTrigger";
      } | {
          kind: string;
      };
      lpId: string;
      nonce: string;
      pair: Pair;
      signature: string;
      size: {
          amount: BigNumber;
          unit: "lpc" | "lot";
      };
      status: {
          content: {
              status: "placed";
          } | {
              content: {
                  timestampUnixMillis: number;
                  triggerPrice: BigNumber;
              };
              status: "triggered";
          };
          status: "open";
      } | {
          content: {
              price: BigNumber;
              settlementStatus: {
                  status: "queued";
              } | {
                  status: "beforeTx";
              } | {
                  status: "indexing";
              } | {
                  content: {
                      txHash: string;
                  };
                  status: "settled";
              };
              timestampUnixMillis: number;
          };
          status: "filled";
      } | {
          content: {
              reason: string;
              timestampUnixMillis: number;
              userCancellation?: null | {
                  address: string;
                  nonce: string;
                  signature: {
                      r: string;
                      s: string;
                      v: number;
                  };
              };
          };
          status: "cancelled";
      };
  }>

• Parameters

  • args: LpPlaceOrderArgs

  Returns Promise<{
      accountId: number;
      accountUser: string;
      createdTimestampUnixMillis: number;
      expiryTimestampUnixMillis: number;
      id: string;
      kind: {
          kind: "market";
      } | {
          args: {
              limitPrice: BigNumber;
          };
          kind: "limit";
      } | {
          args: {
              stopLoss?: null | {
                  kind: "position";
              } | {
                  id: string;
                  kind: "order";
              };
              triggerPrice: BigNumber;
          };
          kind: "stopMarket";
      } | {
          args: {
              limitPrice: BigNumber;
              triggerPrice: BigNumber;
          };
          kind: "stopLimit";
      } | {
          args: {
              takeProfit?: null | {
                  kind: "position";
              } | {
                  id: string;
                  kind: "order";
              };
              triggerPrice: BigNumber;
          };
          kind: "limitTrigger";
      } | {
          kind: string;
      };
      lpId: string;
      nonce: string;
      pair: Pair;
      signature: string;
      size: {
          amount: BigNumber;
          unit: "lpc" | "lot";
      };
      status: {
          content: {
              status: "placed";
          } | {
              content: {
                  timestampUnixMillis: number;
                  triggerPrice: BigNumber;
              };
              status: "triggered";
          };
          status: "open";
      } | {
          content: {
              price: BigNumber;
              settlementStatus: {
                  status: "queued";
              } | {
                  status: "beforeTx";
              } | {
                  status: "indexing";
              } | {
                  content: {
                      txHash: string;
                  };
                  status: "settled";
              };
              timestampUnixMillis: number;
          };
          status: "filled";
      } | {
          content: {
              reason: string;
              timestampUnixMillis: number;
              userCancellation?: null | {
                  address: string;
                  nonce: string;
                  signature: {
                      r: string;
                      s: string;
                      v: number;
                  };
              };
          };
          status: "cancelled";
      };
  }>

placeOrders

• placeOrders(args): Promise<{
      accountId: number;
      accountUser: string;
      createdTimestampUnixMillis: number;
      expiryTimestampUnixMillis: number;
      id: string;
      kind: {
          kind: "market";
      } | {
          args: {
              limitPrice: BigNumber;
          };
          kind: "limit";
      } | {
          args: {
              stopLoss?: null | {
                  kind: "position";
              } | {
                  id: string;
                  kind: "order";
              };
              triggerPrice: BigNumber;
          };
          kind: "stopMarket";
      } | {
          args: {
              limitPrice: BigNumber;
              triggerPrice: BigNumber;
          };
          kind: "stopLimit";
      } | {
          args: {
              takeProfit?: null | {
                  kind: "position";
              } | {
                  id: string;
                  kind: "order";
              };
              triggerPrice: BigNumber;
          };
          kind: "limitTrigger";
      } | {
          kind: string;
      };
      lpId: string;
      nonce: string;
      pair: Pair;
      signature: string;
      size: {
          amount: BigNumber;
          unit: "lpc" | "lot";
      };
      status: {
          content: {
              status: "placed";
          } | {
              content: {
                  timestampUnixMillis: number;
                  triggerPrice: BigNumber;
              };
              status: "triggered";
          };
          status: "open";
      } | {
          content: {
              price: BigNumber;
              settlementStatus: {
                  status: "queued";
              } | {
                  status: "beforeTx";
              } | {
                  status: "indexing";
              } | {
                  content: {
                      txHash: string;
                  };
                  status: "settled";
              };
              timestampUnixMillis: number;
          };
          status: "filled";
      } | {
          content: {
              reason: string;
              timestampUnixMillis: number;
              userCancellation?: null | {
                  address: string;
                  nonce: string;
                  signature: {
                      r: string;
                      s: string;
                      v: number;
                  };
              };
          };
          status: "cancelled";
      };
  }[]>

• Parameters

  • args: LpPlaceOrderArgs[]

  Returns Promise<{
      accountId: number;
      accountUser: string;
      createdTimestampUnixMillis: number;
      expiryTimestampUnixMillis: number;
      id: string;
      kind: {
          kind: "market";
      } | {
          args: {
              limitPrice: BigNumber;
          };
          kind: "limit";
      } | {
          args: {
              stopLoss?: null | {
                  kind: "position";
              } | {
                  id: string;
                  kind: "order";
              };
              triggerPrice: BigNumber;
          };
          kind: "stopMarket";
      } | {
          args: {
              limitPrice: BigNumber;
              triggerPrice: BigNumber;
          };
          kind: "stopLimit";
      } | {
          args: {
              takeProfit?: null | {
                  kind: "position";
              } | {
                  id: string;
                  kind: "order";
              };
              triggerPrice: BigNumber;
          };
          kind: "limitTrigger";
      } | {
          kind: string;
      };
      lpId: string;
      nonce: string;
      pair: Pair;
      signature: string;
      size: {
          amount: BigNumber;
          unit: "lpc" | "lot";
      };
      status: {
          content: {
              status: "placed";
          } | {
              content: {
                  timestampUnixMillis: number;
                  triggerPrice: BigNumber;
              };
              status: "triggered";
          };
          status: "open";
      } | {
          content: {
              price: BigNumber;
              settlementStatus: {
                  status: "queued";
              } | {
                  status: "beforeTx";
              } | {
                  status: "indexing";
              } | {
                  content: {
                      txHash: string;
                  };
                  status: "settled";
              };
              timestampUnixMillis: number;
          };
          status: "filled";
      } | {
          content: {
              reason: string;
              timestampUnixMillis: number;
              userCancellation?: null | {
                  address: string;
                  nonce: string;
                  signature: {
                      r: string;
                      s: string;
                      v: number;
                  };
              };
          };
          status: "cancelled";
      };
  }[]>

replaceOrder

• replaceOrder(args): Promise<ReplaceOrderResponse>

• Parameters

  • args: LpReplaceOrderArgs

  Returns Promise<ReplaceOrderResponse>

subscribeToMarketPrice

• subscribeToMarketPrice(args): number

• Parameters

  • args: SubscribeMarketPriceArgs

  Returns number

unsubscribeFromMarketPrice

• unsubscribeFromMarketPrice(id): void

• Parameters

  • id: number

  Returns void