@galacticcouncil/sdk 0.0.1-beta.13 → 0.0.1-beta.15

package/dist/types/api/tradeRouter.d.ts

@@ -18,6 +18,13 @@ export declare class TradeRouter extends Router {
      * @returns Spot price for given path
      */
     private getSpotPrice;
+    /**
+     * Check whether trade is direct or not
+     *
+     * @param swaps - Trade route
+     * @returns true if direct trade, otherwise false
+     */
+    private isDirectTrade;
     /**
      * Calculate and return best possible sell trade for assetIn>assetOut
      *
@@ -27,13 +34,22 @@ export declare class TradeRouter extends Router {
      * @returns Best possible sell trade of given token pair
      */
     getBestSell(assetIn: string, assetOut: string, amountIn: BigNumber | string | number): Promise<Trade>;
+    /**
+     * Calculate the amount out for best possible trade if fees are zero
+     *
+     * @param amountIn - Amount of assetIn to sell for assetOut
+     * @param bestRoute - Best possible trade route (sell)
+     * @param poolsMap - Pools map
+     * @returns the amount out for best possible trade if fees are zero
+     */
+    private calculateDelta0Y;
     /**
      * Calculate and return sell swaps for given path
      * - final amount of previous swap is entry to next one
      *
      * @param amountIn - Amount of assetIn to sell for assetOut
-     * @param path - current path
-     * @param poolsMap - pools map
+     * @param path - Current path
+     * @param poolsMap - Pools map
      * @returns Sell swaps for given path with corresponding pool pairs
      */
     private toSellSwaps;
@@ -46,14 +62,23 @@ export declare class TradeRouter extends Router {
      * @returns Best possible buy trade of given token pair
      */
     getBestBuy(assetIn: string, assetOut: string, amountOut: BigNumber | string | number): Promise<Trade>;
+    /**
+     * Calculate the amount in for best possible trade if fees are zero
+     *
+     * @param amountOut - Amount of assetOut to buy for assetIn
+     * @param bestRoute - Best possible trade route (buy)
+     * @param poolsMap - Pools map
+     * @returns the amount in for best possible trade if fees are zero
+     */
+    private calculateDelta0X;
     /**
      * Calculate and return buy swaps for given path
      * - final amount of previous swap is entry to next one
      * - calculation is done backwards (swaps in reversed order)
      *
      * @param amountOut - Amount of assetOut to buy for assetIn
-     * @param path - current path
-     * @param poolsMap - pools map
+     * @param path - Current path
+     * @param poolsMap - Pools map
      * @returns Buy swaps for given path
      */
     private toBuySwaps;

package/dist/types/types.d.ts

@@ -99,6 +99,8 @@ export interface Trade extends Humanizer {
     amountIn: BigNumber;
     amountOut: BigNumber;
     spotPrice: BigNumber;
+    tradeFee: BigNumber;
+    tradeFeePct: number;
     priceImpactPct: number;
     swaps: Swap[];
     toTx(tradeLimit: BigNumber): Transaction;

package/dist/types/utils/math.d.ts

@@ -11,3 +11,23 @@ import { BigNumber } from './bignumber';
  * @returns Price impact percentage
  */
 export declare function calculatePriceImpact(amount: BigNumber, decimals: number, spotPrice: BigNumber, calculatedAmount: BigNumber): BigNumber;
+/**
+ * The total fee paid for a ‘sell’ transaction
+ * Suppose the trader is selling X for Y
+ *
+ * fee = 1 - (deltaY / delta0Y)
+ *
+ * @param delta0Y - the amount out if fees are zero
+ * @param deltaY - the amount out if the existing nonzero fees are included in the calculation
+ */
+export declare function calculateSellFee(delta0Y: BigNumber, deltaY: BigNumber): BigNumber;
+/**
+ * The total fee paid for a buy transaction
+ * Suppose the trader is buying Y using X
+ *
+ * fee = (deltaX / delta0X) - 1
+ *
+ * @param delta0X - the amount in if fees are zero
+ * @param deltaX - the amount in, inclusive of fees
+ */
+export declare function calculateBuyFee(delta0X: BigNumber, deltaX: BigNumber): BigNumber;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@galacticcouncil/sdk",
-  "version": "0.0.1-beta.13",
+  "version": "0.0.1-beta.15",
   "private": false,
   "description": "Galactic SDK",
   "author": "Pavol Noha <palo@hydradx.io>",