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

The Yoroi Types package of Yoroi SDK

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

import { AppFrontendFeeTier } from "../api/app";
import { PortfolioTokenInfo } from "../portfolio/info";
import { PortfolioTokenId } from "../portfolio/token";
import { SwapAggregator } from "./aggregator";
import { SwapApi } from "./api";
import { SwapMakeOrderCalculation, SwapOrderCalculation } from "./calculations";
import { SwapOrderType } from "./order";
import { SwapPoolProvider } from "./pool";
import { SwapStorage } from "./storage";
export type SwapManager = $ReadOnly<{
  clearStorage: $PropertyType<SwapStorage, "clear">,
  slippage: $PropertyType<SwapStorage, "slippage">,
  order: {
    cancel: $PropertyType<SwapApi, "cancelOrder">,
    create: $PropertyType<SwapApi, "createOrder">,
    list: {
      byStatusOpen: $PropertyType<SwapApi, "getOpenOrders">,
      byStatusCompleted: $PropertyType<SwapApi, "getCompletedOrders">,
      ...
    },
    ...
  },
  tokens: {
    list: {
      onlyVerified: $PropertyType<SwapApi, "getTokens">,
      byPair: $PropertyType<SwapApi, "getTokenPairs">,
      ...
    },
    ...
  },
  price: {
    byPair: $PropertyType<SwapApi, "getPrice">,
    ...
  },
  pools: {
    list: {
      byPair: $PropertyType<SwapApi, "getPools">,
      ...
    },
    ...
  },
  stakingKey: string,
  primaryTokenInfo: PortfolioTokenInfo,
  supportedProviders: ReadonlyArray<SwapPoolProvider>,
  aggregator: SwapAggregator,
  aggregatorTokenId?: PortfolioTokenId,
  frontendFeeTiers: ReadonlyArray<AppFrontendFeeTier>,
  makeOrderCalculations(
    args: SwapMakeOrderCalculation
  ): Array<SwapOrderCalculation>,
  getBestPoolCalculation(
    calculations: Array<SwapOrderCalculation>
  ): SwapOrderCalculation | void,
  selectedPoolCalculationSelector(args: {
    type: SwapOrderType,
    selectedPoolId?: string,
    calculations: Array<SwapOrderCalculation>,
    bestPoolCalculation?: SwapOrderCalculation,
    ...
  }): SwapOrderCalculation | void,
  ...
}>;