@gearbox-protocol/sdk 1.5.11 → 1.5.12

package/lib/pathfinder/pathfinder.d.ts

@@ -1,13 +1,14 @@
 import { Provider } from "@ethersproject/abstract-provider";
-import { BigNumber, BigNumberish, Signer } from "ethers";
+import { BigNumberish, Signer } from "ethers";
 import { NetworkType } from "../core/constants";
 import { CreditAccountData } from "../core/creditAccount";
 import { CreditManagerData } from "../core/creditManager";
 import { SupportedToken } from "../tokens/token";
 import { IPathFinder } from "../types";
-import { PathFinderOpenStrategyResult, PathFinderResult, SwapOperation } from "./core";
+import { MultiCall, PathFinderCloseResult, PathFinderOpenStrategyResult, PathFinderResult, SwapOperation } from "./core";
 export interface CloseResult {
     amount: BigNumberish;
+    calls: Array<MultiCall>;
     gasUsage: BigNumberish;
 }
 export declare class PathFinder {
@@ -18,7 +19,27 @@ export declare class PathFinder {
     constructor(address: string, provider: Signer | Provider, network?: NetworkType, connectors?: Array<SupportedToken>);
     findAllSwaps(creditAccount: CreditAccountData, swapOperation: SwapOperation, tokenIn: SupportedToken | string, tokenOut: SupportedToken | string, amount: BigNumberish, slippage: number): Promise<Array<PathFinderResult>>;
     findOneTokenPath(creditAccount: CreditAccountData, tokenIn: SupportedToken | string, tokenOut: SupportedToken | string, amount: BigNumberish, slippage: number): Promise<PathFinderResult>;
+    /**
+     * @dev Finds the best path for opening credit account and converting all NORMAL tokens and LP token in the way to TARGET
+     * @param cm CreditManagerData which represents credit manager you want to use to open credit account
+     * @param expectedBalances Expected balances which would be on account accounting also debt. For example,
+     *    if you open an USDC credit account, borrow 50_000 USDC and provide 10 WETH and 10_USDC as collateral
+     *    from your own funds, expectedBalances should be: { "USDC": 60_000 * (10**6), "<address of WETH>": WAD.mul(10) }
+     *
+     * @param target Address of symbol of desired token
+     * @param slippage Slippage in PERCENTAGE_FORMAT (100% = 10_000) per operation
+     * @returns PathFinderOpenStrategyResult which
+     */
     findOpenStrategyPath(cm: CreditManagerData, expectedBalances: Record<SupportedToken | string, BigNumberish>, target: SupportedToken | string, slippage: number): Promise<PathFinderOpenStrategyResult>;
-    findBestClosePath(creditAccount: CreditAccountData, slippage: number): Promise<BigNumber>;
+    /**
+     * @dev Finds the path to swap / withdraw all assets from CreditAccount into underlying asset
+     *   Can bu used for closing credit account and for liquidations as well.
+     * @param creditAccount CreditAccountData object used for close path computation
+     * @param slippage Slippage in PERCENTAGE_FORMAT (100% = 10_000) per operation
+     * @return The best option in PathFinderCloseResult format, which
+     *          - underlyingBalance - total balance of underlying token
+     *          - calls - list of calls which should be done to swap & unwrap everything to underlying token
+     */
+    findBestClosePath(creditAccount: CreditAccountData, slippage: number): Promise<PathFinderCloseResult>;
     static compare(r1: CloseResult, r2: CloseResult, gasPriceRAY: BigNumberish): CloseResult;
 }

package/lib/pathfinder/pathfinder.js

@@ -74,7 +74,6 @@ var PathFinder = /** @class */ (function () {
                         results = _a.sent();
                         return [2 /*return*/, results.map(function (r) { return ({
                                 amount: ethers_1.BigNumber.from(r.amount),
-                                gasUsage: r.gasUsage.toNumber(),
                                 calls: r.calls,
                             }); })];
                 }
@@ -102,6 +101,17 @@ var PathFinder = /** @class */ (function () {
             });
         });
     };
+    /**
+     * @dev Finds the best path for opening credit account and converting all NORMAL tokens and LP token in the way to TARGET
+     * @param cm CreditManagerData which represents credit manager you want to use to open credit account
+     * @param expectedBalances Expected balances which would be on account accounting also debt. For example,
+     *    if you open an USDC credit account, borrow 50_000 USDC and provide 10 WETH and 10_USDC as collateral
+     *    from your own funds, expectedBalances should be: { "USDC": 60_000 * (10**6), "<address of WETH>": WAD.mul(10) }
+     *
+     * @param target Address of symbol of desired token
+     * @param slippage Slippage in PERCENTAGE_FORMAT (100% = 10_000) per operation
+     * @returns PathFinderOpenStrategyResult which
+     */
     PathFinder.prototype.findOpenStrategyPath = function (cm, expectedBalances, target, slippage) {
         return __awaiter(this, void 0, void 0, function () {
             var targetAddr, expectedBalancesAddr, balances, result, balancesAfter;
@@ -135,6 +145,15 @@ var PathFinder = /** @class */ (function () {
             });
         });
     };
+    /**
+     * @dev Finds the path to swap / withdraw all assets from CreditAccount into underlying asset
+     *   Can bu used for closing credit account and for liquidations as well.
+     * @param creditAccount CreditAccountData object used for close path computation
+     * @param slippage Slippage in PERCENTAGE_FORMAT (100% = 10_000) per operation
+     * @return The best option in PathFinderCloseResult format, which
+     *          - underlyingBalance - total balance of underlying token
+     *          - calls - list of calls which should be done to swap & unwrap everything to underlying token
+     */
     PathFinder.prototype.findBestClosePath = function (creditAccount, slippage) {
         return __awaiter(this, void 0, void 0, function () {
             var loopsPerTx, pathOptions, requests, results, bestResult;
@@ -156,8 +175,12 @@ var PathFinder = /** @class */ (function () {
                         }, {
                             amount: ethers_1.BigNumber.from(0),
                             gasUsage: 0,
+                            calls: [],
                         });
-                        return [2 /*return*/, ethers_1.BigNumber.from(bestResult.amount)];
+                        return [2 /*return*/, {
+                                underlyingBalance: ethers_1.BigNumber.from(bestResult.amount).add(creditAccount.allBalances[creditAccount.underlyingToken.toLowerCase()]),
+                                calls: bestResult.calls,
+                            }];
                 }
             });
         });

package/lib/pathfinder/pathfinder.spec.js

@@ -8,10 +8,12 @@ describe("PathFinder test", function () {
         var r1 = {
             amount: 2000,
             gasUsage: 1000,
+            calls: [],
         };
         var r2 = {
             amount: 3000,
             gasUsage: 2000,
+            calls: [],
         };
         var result = pathfinder_1.PathFinder.compare(r1, r2, constants_1.RAY);
         (0, chai_1.expect)(result).to.be.eql(r2);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gearbox-protocol/sdk",
-  "version": "1.5.11",
+  "version": "1.5.12",
   "description": "Gearbox SDK",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",