@yoroi/types/lib/typescript/swap/api.js.flow

The Yoroi Types package of Yoroi SDK

/**
 * Flowtype definitions for api
 * Generated by Flowgen from a Typescript Definition
 * Flowgen v1.21.0
 */

import { PortfolioTokenInfo } from "../portfolio/info";
import { PortfolioTokenId } from "../portfolio/token";
import {
  SwapCancelOrderData,
  SwapCompletedOrder,
  SwapCreateOrderData,
  SwapCreateOrderResponse,
  SwapOpenOrder,
} from "./order";
import { SwapPool, SwapPoolProvider } from "./pool";
export interface SwapApi {
  createOrder(orderData: SwapCreateOrderData): Promise<SwapCreateOrderResponse>;
  cancelOrder(orderData: SwapCancelOrderData): Promise<string>;
  getOpenOrders(): Promise<SwapOpenOrder[]>;
  getCompletedOrders(): Promise<SwapCompletedOrder[]>;
  getPools(args: {
    tokenA: PortfolioTokenId,
    tokenB: PortfolioTokenId,
    providers?: ReadonlyArray<SwapPoolProvider>,
    ...
  }): Promise<SwapPool[]>;
  getTokenPairs(
    tokenIdBase: PortfolioTokenId
  ): Promise<Array<PortfolioTokenInfo>>;
  getTokens(): Promise<Array<PortfolioTokenInfo>>;
  getPrice(args: {
    baseToken: PortfolioTokenId,
    quoteToken: PortfolioTokenId,
    ...
  }): Promise<number>;
  stakingKey: string;
  primaryTokenInfo: $ReadOnly<PortfolioTokenInfo>;
  supportedProviders: ReadonlyArray<SwapPoolProvider>;
}