@gearbox-protocol/sdk 13.5.0-next.1 → 13.5.0-next.3

package/dist/cjs/sdk/pools/PoolService.js

@@ -22,82 +22,38 @@ __export(PoolService_exports, {
 });
 module.exports = __toCommonJS(PoolService_exports);
 var import_generated = require("../../abi/310/generated.js");
-var import_iERC20 = require("../../abi/iERC20.js");
 var import_iERC20ZapperDeposits = require("../../abi/iERC20ZapperDeposits.js");
 var import_iETHZapperDeposits = require("../../abi/iETHZapperDeposits.js");
 var import_iZapper = require("../../abi/iZapper.js");
 var import_base = require("../base/index.js");
-var import__ = require("../index.js");
+var import_constants = require("../constants/index.js");
 var import_utils = require("../utils/index.js");
-const NATIVE_ADDRESS = "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE";
-const POOL_TOKENS_TO_MIGRATE = new import_utils.AddressMap([
-  // v2 diesels
-  ["0x6CFaF95457d7688022FC53e7AbE052ef8DFBbdBA", "dDAI"],
-  ["0xc411dB5f5Eb3f7d552F9B8454B2D74097ccdE6E3", "dUSDC"],
-  ["0xe753260F1955e8678DCeA8887759e07aa57E8c54", "dWBTC"],
-  ["0xF21fc650C1B34eb0FDE786D52d23dA99Db3D6278", "dWETH"],
-  ["0x2158034dB06f06dcB9A786D2F1F8c38781bA779d", "dwstETH"],
-  ["0x8A1112AFef7F4FC7c066a77AABBc01b3Fff31D47", "dFRAX"]
-]);
 class PoolService extends import_base.SDKConstruct {
+  /**
+   * @inheritdoc IPoolsService.getDepositTokensIn
+   */
   getDepositTokensIn(pool) {
-    const underlying = this.#describeUnderlying(pool);
-    if (this.sdk.tokensMeta.isKYCUnderlying(underlying)) {
-      switch (underlying.contractType) {
-        case import_base.KYC_UNDERLYING_DEFAULT:
-          return this.#depositTokensIn(pool, false);
-        case import_base.KYC_UNDERLYING_ON_DEMAND:
-          return [underlying.asset];
-      }
-    }
     return this.#depositTokensIn(pool, true);
   }
+  /**
+   * @inheritdoc IPoolsService.getDepositTokensOut
+   */
   getDepositTokensOut(pool, tokenIn) {
-    const underlying = this.#describeUnderlying(pool);
-    if (this.sdk.tokensMeta.isKYCUnderlying(underlying)) {
-      switch (underlying.contractType) {
-        case import_base.KYC_UNDERLYING_DEFAULT:
-          return this.#depositTokensOut(pool, tokenIn, false);
-        case import_base.KYC_UNDERLYING_ON_DEMAND:
-          return [];
-      }
-    }
     return this.#depositTokensOut(pool, tokenIn, true);
   }
+  /**
+   * @inheritdoc IPoolsService.getDepositMetadata
+   */
   getDepositMetadata(pool, tokenIn, tokenOut) {
-    const underlying = this.#describeUnderlying(pool);
-    if (this.sdk.tokensMeta.isKYCUnderlying(underlying)) {
-      switch (underlying.contractType) {
-        case import_base.KYC_UNDERLYING_DEFAULT: {
-          return this.#depositMetadata(
-            "kyc-default",
-            pool,
-            tokenIn,
-            tokenOut,
-            false
-          );
-        }
-        case import_base.KYC_UNDERLYING_ON_DEMAND:
-          return {
-            zapper: void 0,
-            approveTarget: underlying.liquidityProvider,
-            permissible: false,
-            type: "kyc-on-demand"
-          };
-      }
-    }
     return this.#depositMetadata("classic", pool, tokenIn, tokenOut, true);
   }
+  /**
+   * @inheritdoc IPoolsService.addLiquidity
+   */
   addLiquidity(props) {
     const { collateral, meta, permit, referralCode, pool, wallet } = props;
-    const underlying = this.#describeUnderlying(pool);
-    if (this.sdk.tokensMeta.isKYCUnderlying(underlying)) {
-      if (underlying.contractType === import_base.KYC_UNDERLYING_ON_DEMAND) {
-        return void 0;
-      }
-    }
     const { zapper } = meta;
-    if (zapper && (0, import__.hexEq)(zapper.tokenIn.addr, NATIVE_ADDRESS)) {
+    if (zapper && (0, import_utils.hexEq)(zapper.tokenIn.addr, import_constants.NATIVE_ADDRESS)) {
       return {
         target: zapper.baseParams.addr,
         abi: import_iETHZapperDeposits.iethZapperDepositsAbi,
@@ -134,43 +90,23 @@ class PoolService extends import_base.SDKConstruct {
       };
     }
   }
+  /**
+   * @inheritdoc IPoolsService.getWithdrawalTokensIn
+   */
   getWithdrawalTokensIn(pool) {
-    const underlying = this.#describeUnderlying(pool);
-    if (this.sdk.tokensMeta.isKYCUnderlying(underlying)) {
-      switch (underlying.contractType) {
-        case import_base.KYC_UNDERLYING_DEFAULT:
-          return this.#withdrawalTokensIn(pool, false);
-        case import_base.KYC_UNDERLYING_ON_DEMAND:
-          return [];
-      }
-    }
     return this.#withdrawalTokensIn(pool, true);
   }
+  /**
+   * @inheritdoc IPoolsService.getWithdrawalTokensOut
+   */
   getWithdrawalTokensOut(pool, tokenIn) {
-    const underlying = this.#describeUnderlying(pool);
-    if (this.sdk.tokensMeta.isKYCUnderlying(underlying)) {
-      switch (underlying.contractType) {
-        case import_base.KYC_UNDERLYING_DEFAULT:
-          return this.#withdrawalTokensOut(pool, tokenIn, false);
-        case import_base.KYC_UNDERLYING_ON_DEMAND:
-          return [underlying.asset];
-      }
-    }
     return this.#withdrawalTokensOut(pool, tokenIn, true);
   }
+  /**
+   * @inheritdoc IPoolsService.removeLiquidity
+   */
   removeLiquidity(props) {
     const { pool, amount, meta, wallet, permit } = props;
-    const underlying = this.#describeUnderlying(pool);
-    if (this.sdk.tokensMeta.isKYCUnderlying(underlying)) {
-      if (underlying.contractType === import_base.KYC_UNDERLYING_ON_DEMAND) {
-        return {
-          abi: import_iERC20.ierc20Abi,
-          functionName: "approve",
-          args: [underlying.liquidityProvider, 0n],
-          target: underlying.asset
-        };
-      }
-    }
     if (meta.zapper) {
       return permit ? {
         target: meta.zapper.baseParams.addr,
@@ -198,49 +134,35 @@ class PoolService extends import_base.SDKConstruct {
       args: [amount, wallet, wallet]
     };
   }
+  /**
+   * @inheritdoc IPoolsService.getWithdrawalMetadata
+   */
   getWithdrawalMetadata(pool, tokenIn, tokenOut) {
-    const underlying = this.#describeUnderlying(pool);
-    if (this.sdk.tokensMeta.isKYCUnderlying(underlying)) {
-      switch (underlying.contractType) {
-        case import_base.KYC_UNDERLYING_DEFAULT: {
-          return this.#withdrawalMetadata(
-            "kyc-default",
-            pool,
-            tokenIn,
-            tokenOut,
-            false
-          );
-        }
-        case import_base.KYC_UNDERLYING_ON_DEMAND:
-          return {
-            zapper: void 0,
-            approveTarget: void 0,
-            permissible: false,
-            type: "kyc-on-demand"
-          };
-      }
-    }
     return this.#withdrawalMetadata("classic", pool, tokenIn, tokenOut, true);
   }
   /**
-   * Filter out v2 diesel tokens (can come from migration v2 -> v3 zappers)
-   * Also omits "migration" zappers (v3 -> v3.1) since they are treated in a different way
+   * Returns non-migration zappers available for the pool.
    */
   #getDepositZappers(poolAddr) {
     const zappers = this.sdk.marketRegister.poolZappers(poolAddr);
-    return zappers.filter(
-      (z) => z.type !== "migration" && !POOL_TOKENS_TO_MIGRATE.has(z.tokenIn.addr)
-    );
+    return zappers.filter((z) => z.type !== "migration");
   }
+  /**
+   * Returns all supported deposit input tokens for a pool.
+   *
+   * Includes:
+   * - zapper `tokenIn` where zapper output is pool diesel token
+   * - pool underlying token when direct deposit is enabled
+   */
   #depositTokensIn(poolAddr, allowDirectDeposit) {
     const { pool } = this.sdk.marketRegister.findByPool(poolAddr);
-    const result = new import__.AddressSet();
+    const result = new import_utils.AddressSet();
     if (allowDirectDeposit) {
       result.add(pool.underlying);
     }
     const zappers = this.#getDepositZappers(poolAddr);
     for (const z of zappers) {
-      if ((0, import__.hexEq)(z.tokenOut.addr, poolAddr)) {
+      if ((0, import_utils.hexEq)(z.tokenOut.addr, poolAddr)) {
         result.add(z.tokenIn.addr);
       }
     }
@@ -251,9 +173,16 @@ class PoolService extends import_base.SDKConstruct {
     }
     return result.asArray();
   }
+  /**
+   * Returns all supported withdrawal input tokens for a pool.
+   *
+   * Includes:
+   * - pool diesel token when direct withdrawal is enabled
+   * - all zapper that can be redeemed from the pool
+   */
   #withdrawalTokensIn(poolAddr, allowDirectDeposit) {
     const { pool } = this.sdk.marketRegister.findByPool(poolAddr);
-    const result = new import__.AddressSet();
+    const result = new import_utils.AddressSet();
     if (allowDirectDeposit && pool) {
       result.add(poolAddr);
     }
@@ -268,16 +197,23 @@ class PoolService extends import_base.SDKConstruct {
     }
     return result.asArray();
   }
+  /**
+   * Returns possible deposit outputs for a given input token.
+   *
+   * Includes:
+   * - zapper `tokenOut` for `z.tokenIn` matching `tokenIn`
+   * - pool diesel token for direct underlying deposit when enabled
+   */
   #depositTokensOut(poolAddr, tokenIn, allowDirectDeposit) {
-    const result = new import__.AddressSet();
+    const result = new import_utils.AddressSet();
     const { pool } = this.sdk.marketRegister.findByPool(poolAddr);
     const zappers = this.#getDepositZappers(poolAddr);
     for (const z of zappers) {
-      if ((0, import__.hexEq)(z.tokenIn.addr, tokenIn)) {
+      if ((0, import_utils.hexEq)(z.tokenIn.addr, tokenIn)) {
         result.add(z.tokenOut.addr);
       }
     }
-    if (allowDirectDeposit && (0, import__.hexEq)(tokenIn, pool.underlying)) {
+    if (allowDirectDeposit && (0, import_utils.hexEq)(tokenIn, pool.underlying)) {
       result.add(poolAddr);
     }
     if (result.size === 0) {
@@ -290,16 +226,23 @@ class PoolService extends import_base.SDKConstruct {
     const r = result.asArray();
     return r;
   }
+  /**
+   * Returns possible withdrawal outputs for a given input token.
+   *
+   * Includes:
+   * - zapper `tokenIn` where zapper `z.tokenOut` matches requested `tokenIn`
+   * - pool underlying token for direct diesel-token redemption when enabled
+   */
   #withdrawalTokensOut(poolAddr, tokenIn, allowDirectDeposit) {
-    const result = new import__.AddressSet();
+    const result = new import_utils.AddressSet();
     const { pool } = this.sdk.marketRegister.findByPool(poolAddr);
     const zappers = this.#getDepositZappers(poolAddr);
     for (const z of zappers) {
-      if ((0, import__.hexEq)(z.tokenOut.addr, tokenIn)) {
+      if ((0, import_utils.hexEq)(z.tokenOut.addr, tokenIn)) {
         result.add(z.tokenIn.addr);
       }
     }
-    if (allowDirectDeposit && (0, import__.hexEq)(tokenIn, poolAddr)) {
+    if (allowDirectDeposit && (0, import_utils.hexEq)(tokenIn, poolAddr)) {
       result.add(pool.underlying);
     }
     if (result.size === 0) {
@@ -313,13 +256,12 @@ class PoolService extends import_base.SDKConstruct {
     return r;
   }
   /**
-   * Filter out v2 diesel tokens (can come from migration v2 -> v3 zappers)
-   * Also omits "migration" zappers (v3 -> v3.1) since they are treated in a different way
+   * Returns a single non-migration zapper route for the given token pair.
+   *
+   * Throws when multiple matching zappers exist to keep call construction deterministic.
    */
   #getDepositZapper(poolAddr, tokenIn, tokenOut) {
-    const zappers = this.sdk.marketRegister.getZapper(poolAddr, tokenIn, tokenOut)?.filter(
-      (z) => z.type !== "migration" && !POOL_TOKENS_TO_MIGRATE.has(z.tokenIn.addr)
-    );
+    const zappers = this.sdk.marketRegister.getZapper(poolAddr, tokenIn, tokenOut)?.filter((z) => z.type !== "migration");
     if (zappers && zappers.length > 1) {
       throw new Error(
         `Multiple zappers found for tokenIn ${this.labelAddress(
@@ -331,6 +273,11 @@ class PoolService extends import_base.SDKConstruct {
     }
     return zappers?.[0];
   }
+  /**
+   * Builds metadata required to execute a deposit operation.
+   *
+   * Includes selected zapper route (if any), approve target, and permit support flag.
+   */
   #depositMetadata(type, poolAddr, tokenIn, tokenOut, allowDirectDeposit) {
     if (!tokenOut) {
       throw new Error("tokenOut is required for classic pool deposit");
@@ -348,14 +295,19 @@ class PoolService extends import_base.SDKConstruct {
     }
     return {
       zapper,
-      // zapper or pool itself
+      // Approval target is zapper when routed, otherwise the pool contract.
       approveTarget: zapper?.baseParams.addr ?? pool.pool.address,
-      // TODO: instead of permissible, return permitType зависимости от tokenIn
+      // TODO: instead of permissible, return permitType depending on tokenIn
       // "none" | "eip2612" | "dai_like";
-      permissible: !!zapper && !(0, import__.hexEq)(tokenIn, NATIVE_ADDRESS),
+      permissible: !!zapper && !(0, import_utils.hexEq)(tokenIn, import_constants.NATIVE_ADDRESS),
       type
     };
   }
+  /**
+   * Builds metadata required to execute a withdrawal operation.
+   *
+   * Includes selected zapper route (if any), approve target, and permit support flag.
+   */
   #withdrawalMetadata(type, poolAddr, tokenIn, tokenOut, allowDirectDeposit) {
     if (!tokenOut) {
       throw new Error("tokenOut is required for classic pool deposit");
@@ -372,9 +324,9 @@ class PoolService extends import_base.SDKConstruct {
     }
     return {
       zapper,
-      // zapper or pool itself
+      // Approval target exists only for zapper-based withdrawals.
       approveTarget: zapper?.baseParams.addr,
-      // TODO: instead of permissible, return permitType зависимости от tokenIn
+      // TODO: instead of permissible, return permitType depending on tokenIn
       // "none" | "eip2612" | "dai_like";
       permissible: !!zapper,
       type

package/dist/esm/dev/AccountOpener.js

@@ -6,7 +6,7 @@ import {
   parseEventLogs
 } from "viem";
 import { generatePrivateKey, privateKeyToAccount } from "viem/accounts";
-import { iCreditFacadeV310Abi } from "../abi/310/generated.js";
+import { iCreditFacadeV310Abi, iPoolV310Abi } from "../abi/310/generated.js";
 import { ierc20Abi } from "../abi/iERC20.js";
 import {
   ADDRESS_0X0,
@@ -15,7 +15,6 @@ import {
   childLogger,
   MAX_UINT256,
   PERCENTAGE_FACTOR,
-  PoolService,
   SDKConstruct,
   sendRawTx
 } from "../sdk/index.js";
@@ -44,7 +43,6 @@ class AccountOpener extends SDKConstruct {
   #minDebtMultiplier;
   #allowMint;
   #leverageDelta;
-  #poolService;
   constructor(service, options_ = {}) {
     super(service.sdk);
     const {
@@ -70,7 +68,6 @@ class AccountOpener extends SDKConstruct {
     this.#poolDepositMultiplier = BigInt(poolDepositMultiplier);
     this.#minDebtMultiplier = BigInt(minDebtMultiplier);
     this.#leverageDelta = BigInt(leverageDelta);
-    this.#poolService = new PoolService(service.sdk);
     this.#logger?.info(
       {
         borrower: privateKeyToAccount(this.borrowerKey).address,
@@ -108,10 +105,6 @@ class AccountOpener extends SDKConstruct {
       },
       "opening credit accounts"
     );
-    await Promise.all([
-      this.sdk.tokensMeta.loadTokenData(),
-      this.sdk.marketRegister.loadZappers()
-    ]);
     let deposits = [];
     if (depositIntoPools) {
       try {
@@ -463,34 +456,9 @@ class AccountOpener extends SDKConstruct {
       this.#logger?.debug(
         `depositor balance in underlying: ${this.sdk.tokensMeta.formatBN(pool.underlying, allowance, { symbol: true })}`
       );
-      const tokensOut = this.#poolService.getDepositTokensOut(
-        address,
-        underlying
-      );
-      this.#logger?.debug(
-        { tokensOut: tokensOut.map((t) => this.labelAddress(t)) },
-        "deposit tokens out"
-      );
-      if (tokensOut.length === 0) {
-        throw new Error(`no tokens out found for pool ${poolName}`);
-      }
-      const tokenOut = tokensOut[0];
-      const metadata = this.#poolService.getDepositMetadata(
-        address,
-        underlying,
-        tokenOut
-      );
-      this.logger?.debug(
-        {
-          underlying: this.labelAddress(underlying),
-          tokenOut: this.labelAddress(tokenOut),
-          ...metadata
-        },
-        "pool deposit metadata"
-      );
       txHash = await this.#anvil.writeContract({
         account: depositor,
-        address: metadata.approveTarget,
+        address: underlying,
         abi: ierc20Abi,
         functionName: "approve",
         args: [address, allowance],
@@ -507,21 +475,12 @@ class AccountOpener extends SDKConstruct {
       this.#logger?.debug(
         `depositor approved underlying for pool ${poolName}: ${txHash}`
       );
-      const depositCall = this.#poolService.addLiquidity({
-        collateral: { token: underlying, balance: amount },
-        pool: address,
-        wallet: depositor.address,
-        meta: metadata
-      });
-      if (!depositCall) {
-        throw new Error(`no deposit call could be created for ${poolName}`);
-      }
       txHash = await this.#anvil.writeContract({
         account: depositor,
-        address: depositCall.target,
-        abi: depositCall.abi,
-        functionName: depositCall.functionName,
-        args: depositCall.args,
+        address,
+        abi: iPoolV310Abi,
+        functionName: "deposit",
+        args: [amount, depositor.address],
         chain: this.#anvil.chain
       });
       receipt = await this.#anvil.waitForTransactionReceipt({ hash: txHash });