@galacticcouncil/sdk-next 0.25.0-pr243-ced8794 → 0.25.0-pr243-1cee03e

package/build/types/sor/TradeRouter.d.ts

@@ -39,7 +39,7 @@ export declare class TradeRouter extends Router {
      */
     private getPoolFeeRange;
     /**
-     * Calculate and return best possible sell trade for assetIn>assetOut
+     * Calculate and return best possible sell trade for assetIn > assetOut
      *
      * @param {number} assetIn - assetIn id
      * @param {number} assetOut - assetOut id
@@ -78,16 +78,23 @@ export declare class TradeRouter extends Router {
      *
      * @param poolsMap - pools map
      * @param route - sell route
-     * @returns - sell trade
+     * @returns sell trade
      */
     private buildSell;
     /**
-     * Calculate the amount out for best possible trade if fees are zero
+     * Calculate route spot price
+     *
+     * @param route - trade route
+     * @returns spot price
+     */
+    private calculateSpot;
+    /**
+     * Calculate the output amount of a trade assuming fees are zero
      *
      * @param amountIn - amount of assetIn to sell for assetOut
-     * @param route - best possible trade route (sell)
+     * @param route - trade route
      * @param poolsMap - pools map
-     * @returns the amount out for best possible trade if fees are zero
+     * @returns the amount out if fees are zero
      */
     private calculateDelta0Y;
     /**
@@ -104,13 +111,12 @@ export declare class TradeRouter extends Router {
      */
     private calculateMostLiquidRoute;
     /**
-     * Calculate and return sell swaps for given path
-     * - final amount of previous swap is entry to next one
+     * Calculate and return sell route for given path
      *
      * @param amountIn - amount of assetIn to sell for assetOut
      * @param path - current path
      * @param poolsMap - pools map
-     * @returns sell swaps for given path
+     * @returns sell route for given path with corresponding pool pairs
      */
     private toSellSwaps;
     /**
@@ -130,10 +136,10 @@ export declare class TradeRouter extends Router {
      */
     getSpotPrice(assetIn: number, assetOut: number): Promise<Amount | undefined>;
     /**
-     * Find best buy route
+     * Find best buy route without errors
      *
      * @param swaps - buy routes
-     * @returns the most beneficial route without errors, if exist
+     * @returns best buy route if exist, otherwise first one found
      */
     private findBestBuyRoute;
     /**
@@ -176,27 +182,26 @@ export declare class TradeRouter extends Router {
      *
      * @param poolsMap - pools map
      * @param route - buy route
-     * @returns - buy trade
+     * @returns buy trade
      */
     private buildBuy;
     /**
-     * Calculate the amount in for best possible trade if fees are zero
+     * Calculates the required input amount for a trade to receive a desired output amount,
+     * assuming fees are zero.
      *
      * @param amountOut - amount of assetOut to buy for assetIn
-     * @param bestRoute - best possible trade route (buy)
+     * @param route - trade route
      * @param poolsMap - pools map
-     * @returns the amount in for best possible trade if fees are zero
+     * @returns the required input amount for a 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)
+     * Calculate and return buy route for given path
      *
      * @param amountOut - amount of assetOut to buy for assetIn
      * @param path - current path
      * @param poolsMap - pools map
-     * @returns buy swaps for given path
+     * @returns buy route for given path
      */
     private toBuySwaps;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@galacticcouncil/sdk-next",
-  "version": "0.25.0-pr243-ced8794",
+  "version": "0.25.0-pr243-1cee03e",
   "description": "Galactic next gen sdk (papi)",
   "author": "GalacticCouncil",
   "repository": {