@gearbox-protocol/sdk 13.1.0 → 13.2.0-next.1

package/dist/esm/sdk/market/pool/SecuritizeKYCFactory.js

@@ -0,0 +1,73 @@
+import { iSecuritizeDegenNFTAbi } from "../../../abi/310/iSecuritizeDegenNFT.js";
+import { iSecuritizeKYCFactoryAbi } from "../../../abi/310/iSecuritizeKYCFactory.js";
+import { BaseContract } from "../../base/index.js";
+import { AddressMap } from "../../index.js";
+const abi = iSecuritizeKYCFactoryAbi;
+class SecuritizeKYCFactory extends BaseContract {
+  investorCache;
+  #degenNFT;
+  constructor(options, address) {
+    super(options, {
+      addr: address,
+      name: "SecuritizeKYCFactory",
+      abi
+    });
+  }
+  async precomputeWalletAddress(creditManager, investor) {
+    return this.contract.read.precomputeWalletAddress([
+      creditManager,
+      investor
+    ]);
+  }
+  async getWallet(creditAccount) {
+    return this.contract.read.getWallet([creditAccount]);
+  }
+  /**
+   * Returns the investor address for a credit account.
+   * @param creditAccount - Credit account address
+   * @param fromCache - If true, use and update an in-memory cache (creditAccount -> investor). On cache miss, loads from contract and stores the result for future calls.
+   */
+  async getInvestor(creditAccount, fromCache) {
+    if (fromCache && this.investorCache?.has(creditAccount)) {
+      return this.investorCache.get(creditAccount);
+    }
+    const investor = await this.contract.read.getInvestor([creditAccount]);
+    if (fromCache) {
+      if (!this.investorCache) {
+        this.investorCache = new AddressMap();
+      }
+      this.investorCache.upsert(creditAccount, investor);
+    }
+    return investor;
+  }
+  async getDSTokens() {
+    const degenNFT = await this.getDegenNFT();
+    const tokens = await this.client.readContract({
+      address: degenNFT,
+      abi: iSecuritizeDegenNFTAbi,
+      functionName: "getDSTokens"
+    });
+    return [...tokens];
+  }
+  multicall(creditAccount, calls, tokensToRegister) {
+    return this.createRawTx({
+      functionName: "multicall",
+      args: [creditAccount, calls, tokensToRegister]
+    });
+  }
+  openCreditAccount(creditManager, calls, tokensToRegister) {
+    return this.createRawTx({
+      functionName: "openCreditAccount",
+      args: [creditManager, calls, tokensToRegister]
+    });
+  }
+  async getDegenNFT() {
+    if (!this.#degenNFT) {
+      this.#degenNFT = await this.contract.read.getDegenNFT();
+    }
+    return this.#degenNFT;
+  }
+}
+export {
+  SecuritizeKYCFactory
+};

package/dist/esm/sdk/market/pool/index.js

@@ -1,4 +1,6 @@
 export * from "./GaugeContract.js";
 export * from "./LinearInterestRateModelContract.js";
 export * from "./PoolSuite.js";
+export * from "./PoolV310Contract.js";
+export * from "./SecuritizeKYCFactory.js";
 export * from "./types.js";

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

@@ -0,0 +1,371 @@
+import { iPoolV310Abi } from "../../abi/310/generated.js";
+import { ierc20Abi } from "../../abi/iERC20.js";
+import { ierc20ZapperDepositsAbi } from "../../abi/iERC20ZapperDeposits.js";
+import { iethZapperDepositsAbi } from "../../abi/iETHZapperDeposits.js";
+import { iZapperAbi } from "../../abi/iZapper.js";
+import {
+  KYC_UNDERLYING_DEFAULT,
+  KYC_UNDERLYING_ON_DEMAND,
+  SDKConstruct
+} from "../base/index.js";
+import { AddressSet, hexEq } from "../index.js";
+import { AddressMap } from "../utils/index.js";
+const NATIVE_ADDRESS = "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE";
+const POOL_TOKENS_TO_MIGRATE = new AddressMap([
+  // v2 diesels
+  ["0x6CFaF95457d7688022FC53e7AbE052ef8DFBbdBA", "dDAI"],
+  ["0xc411dB5f5Eb3f7d552F9B8454B2D74097ccdE6E3", "dUSDC"],
+  ["0xe753260F1955e8678DCeA8887759e07aa57E8c54", "dWBTC"],
+  ["0xF21fc650C1B34eb0FDE786D52d23dA99Db3D6278", "dWETH"],
+  ["0x2158034dB06f06dcB9A786D2F1F8c38781bA779d", "dwstETH"],
+  ["0x8A1112AFef7F4FC7c066a77AABBc01b3Fff31D47", "dFRAX"]
+]);
+class PoolService extends SDKConstruct {
+  getDepositTokensIn(pool) {
+    const underlying = this.#describeUnderlying(pool);
+    if (this.sdk.tokensMeta.isKYCUnderlying(underlying)) {
+      switch (underlying.contractType) {
+        case KYC_UNDERLYING_DEFAULT:
+          return this.#depositTokensIn(pool, false);
+        case KYC_UNDERLYING_ON_DEMAND:
+          return [underlying.asset];
+      }
+    }
+    return this.#depositTokensIn(pool, true);
+  }
+  getDepositTokensOut(pool, tokenIn) {
+    const underlying = this.#describeUnderlying(pool);
+    if (this.sdk.tokensMeta.isKYCUnderlying(underlying)) {
+      switch (underlying.contractType) {
+        case KYC_UNDERLYING_DEFAULT:
+          return this.#depositTokensOut(pool, tokenIn, false);
+        case KYC_UNDERLYING_ON_DEMAND:
+          return [];
+      }
+    }
+    return this.#depositTokensOut(pool, tokenIn, true);
+  }
+  getDepositMetadata(pool, tokenIn, tokenOut) {
+    const underlying = this.#describeUnderlying(pool);
+    if (this.sdk.tokensMeta.isKYCUnderlying(underlying)) {
+      switch (underlying.contractType) {
+        case KYC_UNDERLYING_DEFAULT: {
+          return this.#depositMetadata(
+            "kyc-default",
+            pool,
+            tokenIn,
+            tokenOut,
+            false
+          );
+        }
+        case 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);
+  }
+  addLiquidity(props) {
+    const { collateral, meta, permit, referralCode, pool, wallet } = props;
+    const underlying = this.#describeUnderlying(pool);
+    if (this.sdk.tokensMeta.isKYCUnderlying(underlying)) {
+      if (underlying.contractType === KYC_UNDERLYING_ON_DEMAND) {
+        return void 0;
+      }
+    }
+    const { zapper } = meta;
+    if (zapper && hexEq(zapper.tokenIn.addr, NATIVE_ADDRESS)) {
+      return {
+        target: zapper.baseParams.addr,
+        abi: iethZapperDepositsAbi,
+        functionName: "depositWithReferral",
+        args: [wallet, referralCode],
+        value: collateral.balance
+      };
+    } else if (zapper) {
+      return permit ? {
+        target: zapper.baseParams.addr,
+        abi: ierc20ZapperDepositsAbi,
+        functionName: "depositWithReferralAndPermit",
+        args: [
+          collateral.balance,
+          wallet,
+          referralCode,
+          permit.deadline,
+          permit.v,
+          permit.r,
+          permit.s
+        ]
+      } : {
+        target: zapper.baseParams.addr,
+        abi: ierc20ZapperDepositsAbi,
+        functionName: "depositWithReferral",
+        args: [collateral.balance, wallet, referralCode]
+      };
+    } else {
+      return {
+        target: pool,
+        abi: iPoolV310Abi,
+        functionName: "depositWithReferral",
+        args: [collateral.balance, wallet, referralCode]
+      };
+    }
+  }
+  getWithdrawalTokensIn(pool) {
+    const underlying = this.#describeUnderlying(pool);
+    if (this.sdk.tokensMeta.isKYCUnderlying(underlying)) {
+      switch (underlying.contractType) {
+        case KYC_UNDERLYING_DEFAULT:
+          return this.#withdrawalTokensIn(pool, false);
+        case KYC_UNDERLYING_ON_DEMAND:
+          return [];
+      }
+    }
+    return this.#withdrawalTokensIn(pool, true);
+  }
+  getWithdrawalTokensOut(pool, tokenIn) {
+    const underlying = this.#describeUnderlying(pool);
+    if (this.sdk.tokensMeta.isKYCUnderlying(underlying)) {
+      switch (underlying.contractType) {
+        case KYC_UNDERLYING_DEFAULT:
+          return this.#withdrawalTokensOut(pool, tokenIn, false);
+        case KYC_UNDERLYING_ON_DEMAND:
+          return [underlying.asset];
+      }
+    }
+    return this.#withdrawalTokensOut(pool, tokenIn, true);
+  }
+  removeLiquidity(props) {
+    const { pool, amount, meta, wallet, permit } = props;
+    const underlying = this.#describeUnderlying(pool);
+    if (this.sdk.tokensMeta.isKYCUnderlying(underlying)) {
+      if (underlying.contractType === KYC_UNDERLYING_ON_DEMAND) {
+        return {
+          abi: ierc20Abi,
+          functionName: "approve",
+          args: [underlying.liquidityProvider, 0n],
+          target: underlying.asset
+        };
+      }
+    }
+    if (meta.zapper) {
+      return permit ? {
+        target: meta.zapper.baseParams.addr,
+        abi: iZapperAbi,
+        functionName: "redeemWithPermit",
+        args: [
+          amount,
+          wallet,
+          permit.deadline,
+          permit.v,
+          permit.r,
+          permit.s
+        ]
+      } : {
+        target: meta.zapper.baseParams.addr,
+        abi: iZapperAbi,
+        functionName: "redeem",
+        args: [amount, wallet]
+      };
+    }
+    return {
+      target: pool,
+      abi: iPoolV310Abi,
+      functionName: "redeem",
+      args: [amount, wallet, wallet]
+    };
+  }
+  getWithdrawalMetadata(pool, tokenIn, tokenOut) {
+    const underlying = this.#describeUnderlying(pool);
+    if (this.sdk.tokensMeta.isKYCUnderlying(underlying)) {
+      switch (underlying.contractType) {
+        case KYC_UNDERLYING_DEFAULT: {
+          return this.#withdrawalMetadata(
+            "kyc-default",
+            pool,
+            tokenIn,
+            tokenOut,
+            false
+          );
+        }
+        case 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
+   */
+  #getDepositZappers(poolAddr) {
+    const zappers = this.sdk.marketRegister.poolZappers(poolAddr);
+    return zappers.filter(
+      (z) => z.type !== "migration" && !POOL_TOKENS_TO_MIGRATE.has(z.tokenIn.addr)
+    );
+  }
+  #depositTokensIn(poolAddr, allowDirectDeposit) {
+    const { pool } = this.sdk.marketRegister.findByPool(poolAddr);
+    const result = new AddressSet();
+    if (allowDirectDeposit) {
+      result.add(pool.underlying);
+    }
+    const zappers = this.#getDepositZappers(poolAddr);
+    for (const z of zappers) {
+      if (hexEq(z.tokenOut.addr, poolAddr)) {
+        result.add(z.tokenIn.addr);
+      }
+    }
+    if (result.size === 0) {
+      throw new Error(
+        `No tokensIn found for pool ${this.labelAddress(poolAddr)}`
+      );
+    }
+    return result.asArray();
+  }
+  #withdrawalTokensIn(poolAddr, allowDirectDeposit) {
+    const { pool } = this.sdk.marketRegister.findByPool(poolAddr);
+    const result = new AddressSet();
+    if (allowDirectDeposit && pool) {
+      result.add(poolAddr);
+    }
+    const zappers = this.#getDepositZappers(poolAddr);
+    for (const z of zappers) {
+      result.add(z.tokenOut.addr);
+    }
+    if (result.size === 0) {
+      throw new Error(
+        `No tokensIn found for pool ${this.labelAddress(poolAddr)}`
+      );
+    }
+    return result.asArray();
+  }
+  #depositTokensOut(poolAddr, tokenIn, allowDirectDeposit) {
+    const result = new AddressSet();
+    const { pool } = this.sdk.marketRegister.findByPool(poolAddr);
+    const zappers = this.#getDepositZappers(poolAddr);
+    for (const z of zappers) {
+      if (hexEq(z.tokenIn.addr, tokenIn)) {
+        result.add(z.tokenOut.addr);
+      }
+    }
+    if (allowDirectDeposit && hexEq(tokenIn, pool.underlying)) {
+      result.add(poolAddr);
+    }
+    if (result.size === 0) {
+      throw new Error(
+        `No tokensOut found for tokenIn ${this.labelAddress(
+          tokenIn
+        )} on pool ${this.labelAddress(poolAddr)}`
+      );
+    }
+    const r = result.asArray();
+    return r;
+  }
+  #withdrawalTokensOut(poolAddr, tokenIn, allowDirectDeposit) {
+    const result = new AddressSet();
+    const { pool } = this.sdk.marketRegister.findByPool(poolAddr);
+    const zappers = this.#getDepositZappers(poolAddr);
+    for (const z of zappers) {
+      if (hexEq(z.tokenOut.addr, tokenIn)) {
+        result.add(z.tokenIn.addr);
+      }
+    }
+    if (allowDirectDeposit && hexEq(tokenIn, poolAddr)) {
+      result.add(pool.underlying);
+    }
+    if (result.size === 0) {
+      throw new Error(
+        `No tokensOut found for tokenIn ${this.labelAddress(
+          tokenIn
+        )} on pool ${this.labelAddress(poolAddr)}`
+      );
+    }
+    const r = result.asArray();
+    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
+   */
+  #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)
+    );
+    if (zappers && zappers.length > 1) {
+      throw new Error(
+        `Multiple zappers found for tokenIn ${this.labelAddress(
+          tokenIn
+        )} and tokenOut ${this.labelAddress(
+          tokenOut
+        )} on pool ${this.labelAddress(poolAddr)}`
+      );
+    }
+    return zappers?.[0];
+  }
+  #depositMetadata(type, poolAddr, tokenIn, tokenOut, allowDirectDeposit) {
+    if (!tokenOut) {
+      throw new Error("tokenOut is required for classic pool deposit");
+    }
+    const { pool } = this.sdk.marketRegister.findByPool(poolAddr);
+    const zapper = this.#getDepositZapper(poolAddr, tokenIn, tokenOut);
+    if (!zapper && !allowDirectDeposit) {
+      throw new Error(
+        `No zapper found for tokenIn ${this.labelAddress(
+          tokenIn
+        )} and tokenOut ${this.labelAddress(
+          tokenOut
+        )} on pool ${this.labelAddress(poolAddr)}`
+      );
+    }
+    return {
+      zapper,
+      // zapper or pool itself
+      approveTarget: zapper?.baseParams.addr ?? pool.pool.address,
+      // TODO: instead of permissible, return permitType зависимости от tokenIn
+      // "none" | "eip2612" | "dai_like";
+      permissible: !!zapper && !hexEq(tokenIn, NATIVE_ADDRESS),
+      type
+    };
+  }
+  #withdrawalMetadata(type, poolAddr, tokenIn, tokenOut, allowDirectDeposit) {
+    if (!tokenOut) {
+      throw new Error("tokenOut is required for classic pool deposit");
+    }
+    const zapper = this.#getDepositZapper(poolAddr, tokenOut, tokenIn);
+    if (!zapper && !allowDirectDeposit) {
+      throw new Error(
+        `No zapper found for tokenIn ${this.labelAddress(
+          tokenOut
+        )} and tokenOut ${this.labelAddress(
+          tokenIn
+        )} on pool ${this.labelAddress(poolAddr)}`
+      );
+    }
+    return {
+      zapper,
+      // zapper or pool itself
+      approveTarget: zapper?.baseParams.addr,
+      // TODO: instead of permissible, return permitType зависимости от tokenIn
+      // "none" | "eip2612" | "dai_like";
+      permissible: !!zapper,
+      type
+    };
+  }
+  #describeUnderlying(pool) {
+    const market = this.sdk.marketRegister.findByPool(pool);
+    return this.sdk.tokensMeta.mustGet(market.underlying);
+  }
+}
+export {
+  PoolService
+};

package/dist/esm/sdk/pools/index.js

@@ -1,3 +1,2 @@
-export * from "./AbstractPoolService.js";
-export * from "./createPoolService.js";
+export * from "./PoolService.js";
 export * from "./types.js";

package/dist/esm/sdk/utils/AddressMap.js

@@ -14,7 +14,7 @@ class AddressMap {
     this.#name = name;
   }
   /**
-   * Adds or updates value, undefined removes value
+   * Adds or overwrites value, undefined removes value
    * @param address
    * @param value
    */

package/dist/esm/sdk/utils/viem/sendRawTx.js

@@ -1,4 +1,7 @@
-import { sendTransaction } from "viem/actions";
+import {
+  estimateGas,
+  sendTransaction
+} from "viem/actions";
 import { getAction } from "viem/utils";
 async function sendRawTx(client, params) {
   const { tx, ...rest } = params;
@@ -13,6 +16,21 @@ async function sendRawTx(client, params) {
     value: BigInt(tx.value)
   });
 }
+async function estimateRawTxGas(client, params) {
+  const { tx, ...rest } = params;
+  return getAction(
+    client,
+    estimateGas,
+    "estimateGas"
+  )({
+    ...rest,
+    account: params.account,
+    data: tx.callData,
+    to: tx.to,
+    value: BigInt(tx.value)
+  });
+}
 export {
+  estimateRawTxGas,
   sendRawTx
 };