@gearbox-protocol/sdk 3.0.0-vfour.283 → 3.0.0-vfour.284

package/dist/cjs/sdk/router/RouterV310Contract.js

@@ -22,6 +22,7 @@ __export(RouterV310Contract_exports, {
 });
 module.exports = __toCommonJS(RouterV310Contract_exports);
 var import_routerV310 = require("../../abi/routerV310.js");
+var import_AddressMap = require("../utils/AddressMap.js");
 var import_AbstractRouterContract = require("./AbstractRouterContract.js");
 var import_helpers = require("./helpers.js");
 const abi = import_routerV310.iGearboxRouterV310Abi;
@@ -45,14 +46,37 @@ class RouterV310Contract extends import_AbstractRouterContract.AbstractRouterCon
    * @returns
    */
   async findOneTokenPath(props) {
+    const {
+      creditAccount,
+      creditManager,
+      amount,
+      slippage,
+      tokenIn,
+      tokenOut
+    } = props;
+    const numSplits = this.#numSplitsGetter(
+      creditManager,
+      creditAccount.tokens
+    )(tokenIn);
+    this.logger?.debug(
+      {
+        creditAccount: creditAccount.creditAccount,
+        creditManager: this.labelAddress(creditManager.address),
+        tokenIn: this.labelAddress(tokenIn),
+        target: this.labelAddress(tokenOut),
+        amount,
+        slippage,
+        numSplits
+      },
+      "calling routeOneToOne"
+    );
     const { result } = await this.contract.simulate.routeOneToOne([
-      props.creditAccount.creditAccount,
-      props.tokenIn,
-      props.amount,
-      props.tokenOut,
-      BigInt(props.slippage),
-      4n
-      // TODO:? how many 4n or 0n for underlying
+      creditAccount.creditAccount,
+      tokenIn,
+      amount,
+      tokenOut,
+      BigInt(slippage),
+      numSplits
     ]);
     return {
       amount: result.amount,
@@ -83,15 +107,24 @@ class RouterV310Contract extends import_AbstractRouterContract.AbstractRouterCon
       (0, import_helpers.balancesMap)(expectedBalances),
       (0, import_helpers.balancesMap)(leftoverBalances)
     ];
+    const getNumSplits = this.#numSplitsGetter(cm, expectedBalances);
     const tData = cm.collateralTokens.map(
       (token) => ({
         token,
         balance: expectedMap.get(token) ?? 0n,
         leftoverBalance: leftoverMap.get(token) ?? 0n,
-        numSplits: 4n
-        // TODO:? how many 4n or 0n for underlying
+        numSplits: getNumSplits(token)
       })
     );
+    this.logger?.debug(
+      {
+        creditManager: this.labelAddress(cm.address),
+        target: this.labelAddress(target),
+        slippage,
+        tData: this.#debugTokenData(tData)
+      },
+      "calling routeOpenManyToOne"
+    );
     const { result } = await this.contract.simulate.routeOpenManyToOne([
       cm.address,
       target,
@@ -128,16 +161,26 @@ class RouterV310Contract extends import_AbstractRouterContract.AbstractRouterCon
         leftoverBalances: (0, import_helpers.assetsMap)(balances.leftoverBalances)
       } : void 0
     );
+    const getNumSplits = this.#numSplitsGetter(cm, expectedBalances.values());
     const tData = [];
     for (const token of cm.collateralTokens) {
       tData.push({
         token,
         balance: expectedBalances.get(token)?.balance || 0n,
         leftoverBalance: leftoverBalances.get(token)?.balance || 0n,
-        numSplits: 4n
-        // TODO:? how many 4n or 0n for underlying
+        numSplits: getNumSplits(token)
       });
     }
+    this.logger?.debug(
+      {
+        creditAccount: ca.creditAccount,
+        creditManager: this.labelAddress(cm.address),
+        target: this.labelAddress(ca.underlying),
+        slippage,
+        tData: this.#debugTokenData(tData)
+      },
+      "calling routeManyToOne"
+    );
     const { result } = await this.contract.simulate.routeManyToOne([
       cm.address,
       ca.underlying,
@@ -152,6 +195,35 @@ class RouterV310Contract extends import_AbstractRouterContract.AbstractRouterCon
       calls: [...result.calls]
     };
   }
+  #numSplitsGetter(creditManager, assets) {
+    const { priceOracle } = this.sdk.marketRegister.findByCreditManager(
+      creditManager.address
+    );
+    const inUSD = assets.filter(({ token, balance }) => {
+      const decimals = this.sdk.tokensMeta.decimals(token);
+      const minBalance = 10n ** BigInt(Math.max(8, decimals) - 8);
+      return balance >= minBalance;
+    }).map(({ token, balance }) => {
+      return {
+        token,
+        balance: priceOracle.convertToUSD(token, balance)
+      };
+    }).sort((a, b) => {
+      return b.balance > a.balance ? -1 : 1;
+    });
+    const map = new import_AddressMap.AddressMap(
+      inUSD.map(({ token }, i) => [token, i === 0 ? 4n : 1n])
+    );
+    return (token) => map.get(token) ?? 1n;
+  }
+  #debugTokenData(tData) {
+    return tData.map((t) => ({
+      token: this.labelAddress(t.token),
+      balance: this.sdk.tokensMeta.formatBN(t.token, t.balance),
+      leftoverBalance: this.sdk.tokensMeta.formatBN(t.token, t.leftoverBalance),
+      numSplits: t.numSplits
+    }));
+  }
   findAllSwaps(props) {
     throw ERR_NOT_IMPLEMENTED;
   }

package/dist/esm/sdk/router/RouterV310Contract.js

@@ -1,4 +1,5 @@
 import { iGearboxRouterV310Abi } from "../../abi/routerV310.js";
+import { AddressMap } from "../utils/AddressMap.js";
 import { AbstractRouterContract } from "./AbstractRouterContract.js";
 import { assetsMap, balancesMap } from "./helpers.js";
 const abi = iGearboxRouterV310Abi;
@@ -22,14 +23,37 @@ class RouterV310Contract extends AbstractRouterContract {
    * @returns
    */
   async findOneTokenPath(props) {
+    const {
+      creditAccount,
+      creditManager,
+      amount,
+      slippage,
+      tokenIn,
+      tokenOut
+    } = props;
+    const numSplits = this.#numSplitsGetter(
+      creditManager,
+      creditAccount.tokens
+    )(tokenIn);
+    this.logger?.debug(
+      {
+        creditAccount: creditAccount.creditAccount,
+        creditManager: this.labelAddress(creditManager.address),
+        tokenIn: this.labelAddress(tokenIn),
+        target: this.labelAddress(tokenOut),
+        amount,
+        slippage,
+        numSplits
+      },
+      "calling routeOneToOne"
+    );
     const { result } = await this.contract.simulate.routeOneToOne([
-      props.creditAccount.creditAccount,
-      props.tokenIn,
-      props.amount,
-      props.tokenOut,
-      BigInt(props.slippage),
-      4n
-      // TODO:? how many 4n or 0n for underlying
+      creditAccount.creditAccount,
+      tokenIn,
+      amount,
+      tokenOut,
+      BigInt(slippage),
+      numSplits
     ]);
     return {
       amount: result.amount,
@@ -60,15 +84,24 @@ class RouterV310Contract extends AbstractRouterContract {
       balancesMap(expectedBalances),
       balancesMap(leftoverBalances)
     ];
+    const getNumSplits = this.#numSplitsGetter(cm, expectedBalances);
     const tData = cm.collateralTokens.map(
       (token) => ({
         token,
         balance: expectedMap.get(token) ?? 0n,
         leftoverBalance: leftoverMap.get(token) ?? 0n,
-        numSplits: 4n
-        // TODO:? how many 4n or 0n for underlying
+        numSplits: getNumSplits(token)
       })
     );
+    this.logger?.debug(
+      {
+        creditManager: this.labelAddress(cm.address),
+        target: this.labelAddress(target),
+        slippage,
+        tData: this.#debugTokenData(tData)
+      },
+      "calling routeOpenManyToOne"
+    );
     const { result } = await this.contract.simulate.routeOpenManyToOne([
       cm.address,
       target,
@@ -105,16 +138,26 @@ class RouterV310Contract extends AbstractRouterContract {
         leftoverBalances: assetsMap(balances.leftoverBalances)
       } : void 0
     );
+    const getNumSplits = this.#numSplitsGetter(cm, expectedBalances.values());
     const tData = [];
     for (const token of cm.collateralTokens) {
       tData.push({
         token,
         balance: expectedBalances.get(token)?.balance || 0n,
         leftoverBalance: leftoverBalances.get(token)?.balance || 0n,
-        numSplits: 4n
-        // TODO:? how many 4n or 0n for underlying
+        numSplits: getNumSplits(token)
       });
     }
+    this.logger?.debug(
+      {
+        creditAccount: ca.creditAccount,
+        creditManager: this.labelAddress(cm.address),
+        target: this.labelAddress(ca.underlying),
+        slippage,
+        tData: this.#debugTokenData(tData)
+      },
+      "calling routeManyToOne"
+    );
     const { result } = await this.contract.simulate.routeManyToOne([
       cm.address,
       ca.underlying,
@@ -129,6 +172,35 @@ class RouterV310Contract extends AbstractRouterContract {
       calls: [...result.calls]
     };
   }
+  #numSplitsGetter(creditManager, assets) {
+    const { priceOracle } = this.sdk.marketRegister.findByCreditManager(
+      creditManager.address
+    );
+    const inUSD = assets.filter(({ token, balance }) => {
+      const decimals = this.sdk.tokensMeta.decimals(token);
+      const minBalance = 10n ** BigInt(Math.max(8, decimals) - 8);
+      return balance >= minBalance;
+    }).map(({ token, balance }) => {
+      return {
+        token,
+        balance: priceOracle.convertToUSD(token, balance)
+      };
+    }).sort((a, b) => {
+      return b.balance > a.balance ? -1 : 1;
+    });
+    const map = new AddressMap(
+      inUSD.map(({ token }, i) => [token, i === 0 ? 4n : 1n])
+    );
+    return (token) => map.get(token) ?? 1n;
+  }
+  #debugTokenData(tData) {
+    return tData.map((t) => ({
+      token: this.labelAddress(t.token),
+      balance: this.sdk.tokensMeta.formatBN(t.token, t.balance),
+      leftoverBalance: this.sdk.tokensMeta.formatBN(t.token, t.leftoverBalance),
+      numSplits: t.numSplits
+    }));
+  }
   findAllSwaps(props) {
     throw ERR_NOT_IMPLEMENTED;
   }

package/dist/types/sdk/router/RouterV310Contract.d.ts

@@ -350,6 +350,7 @@ declare const abi: readonly [{
 }];
 type abi = typeof abi;
 export declare class RouterV310Contract extends AbstractRouterContract<abi> implements IRouterContract {
+    #private;
     constructor(sdk: GearboxSDK, address: Address);
     /**
      * Finds best path to swap all Normal tokens and tokens "on the way" to target one and vice versa

package/dist/types/sdk/router/types.d.ts

@@ -59,6 +59,9 @@ export interface FindAllSwapsProps {
     tokenOut: Address;
     amount: bigint;
     leftoverAmount: bigint;
+    /**
+     * Slippage in PERCENTAGE_FORMAT (100% = 10_000) per operation
+     */
     slippage: number | bigint;
 }
 export interface FindClosePathInput {
@@ -73,6 +76,9 @@ export interface FindOneTokenPathProps {
     tokenIn: Address;
     tokenOut: Address;
     amount: bigint;
+    /**
+     * Slippage in PERCENTAGE_FORMAT (100% = 10_000) per operation
+     */
     slippage: number | bigint;
 }
 export interface FindOpenStrategyPathProps {
@@ -80,16 +86,30 @@ export interface FindOpenStrategyPathProps {
     expectedBalances: Array<Asset>;
     leftoverBalances: Array<Asset>;
     target: Address;
+    /**
+     * Slippage in PERCENTAGE_FORMAT (100% = 10_000) per operation
+     */
     slippage: number | bigint;
 }
 export interface FindBestClosePathProps {
     creditAccount: RouterCASlice;
     creditManager: RouterCMSlice;
+    /**
+     * Slippage in PERCENTAGE_FORMAT (100% = 10_000) per operation
+     */
     slippage: bigint | number;
     balances?: ClosePathBalances;
 }
 export interface ClosePathBalances {
+    /**
+     * Current balances or expected balances after some actions (add/withdraw collateral, for example),
+     * if these actions are before router calls
+     */
     expectedBalances: Array<Asset>;
+    /**
+     * Balances to keep on account after all actions.
+     * If the final balance is 0, we set 1 for gas optimization, except for forbidden tokens
+     */
     leftoverBalances: Array<Asset>;
 }
 export interface IRouterContract extends IBaseContract {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gearbox-protocol/sdk",
-  "version": "3.0.0-vfour.283",
+  "version": "3.0.0-vfour.284",
   "description": "Gearbox SDK",
   "license": "MIT",
   "main": "./dist/cjs/sdk/index.js",