@gearbox-protocol/sdk 14.0.0-next.9 → 14.1.0-next.1

package/dist/esm/sdk/accounts/AbstractCreditAccountsService.js

@@ -1,3 +1,4 @@
+import { ierc4626AdapterAbi } from "@gearbox-protocol/integrations-v3";
 import { encodeFunctionData, getContract } from "viem";
 import {
   iBotListV310Abi,
@@ -8,6 +9,7 @@ import { peripheryCompressorAbi } from "../../abi/compressors/peripheryCompresso
 import { rewardsCompressorAbi } from "../../abi/compressors/rewardsCompressor.js";
 import { iWithdrawalCompressorV310Abi } from "../../abi/IWithdrawalCompressorV310.js";
 import { iBaseRewardPoolAbi } from "../../abi/iBaseRewardPool.js";
+import { iKYCFactoryAbi } from "../../abi/kyc/iKYCFactory.js";
 import { SDKConstruct } from "../base/index.js";
 import { chains } from "../chain/chains.js";
 import {
@@ -25,7 +27,7 @@ import {
   getRawPriceUpdates
 } from "../market/index.js";
 import { assetsMap } from "../router/index.js";
-import { AddressMap, AddressSet } from "../utils/index.js";
+import { AddressMap, AddressSet, hexEq } from "../utils/index.js";
 import { simulateWithPriceUpdates } from "../utils/viem/index.js";
 import {
   extractPriceUpdates,
@@ -71,24 +73,40 @@ class AbstractCreditAccountService extends SDKConstruct {
     } catch (_e) {
       return void 0;
     }
+    const marketSuite = this.sdk.marketRegister.findByCreditManager(
+      raw.creditManager
+    );
+    const factory = marketSuite.kycFactory;
+    let ca;
+    let investor;
     if (raw.success) {
-      return raw;
+      ca = raw;
+      investor = await factory?.getInvestor(raw.creditAccount, false);
+    } else {
+      const { txs: priceUpdateTxs } = await this.getUpdateForAccount(raw);
+      [ca, investor] = await simulateWithPriceUpdates(this.client, {
+        priceUpdates: priceUpdateTxs,
+        contracts: [
+          {
+            abi: creditAccountCompressorAbi,
+            address: this.#compressor,
+            functionName: "getCreditAccountData",
+            args: [account]
+          },
+          ...factory ? [
+            {
+              abi: iKYCFactoryAbi,
+              address: factory.address,
+              functionName: "getInvestor",
+              args: [raw.creditAccount]
+            }
+          ] : []
+        ],
+        blockNumber,
+        gas: this.sdk.gasLimit
+      });
     }
-    const { txs: priceUpdateTxs } = await this.getUpdateForAccount(raw);
-    const [cad] = await simulateWithPriceUpdates(this.client, {
-      priceUpdates: priceUpdateTxs,
-      contracts: [
-        {
-          abi: creditAccountCompressorAbi,
-          address: this.#compressor,
-          functionName: "getCreditAccountData",
-          args: [account]
-        }
-      ],
-      blockNumber,
-      gas: this.sdk.gasLimit
-    });
-    return cad;
+    return { ...ca, investor };
   }
   /**
    * {@inheritDoc ICreditAccountsService.getCreditAccounts}
@@ -144,6 +162,99 @@ class AbstractCreditAccountService extends SDKConstruct {
     );
     return allCAs.sort((a, b) => Number(a.healthFactor - b.healthFactor));
   }
+  /**
+   * {@inheritDoc ICreditAccountsService.getBorrowerCreditAccounts}
+   **/
+  async getBorrowerCreditAccounts(borrower, options, blockNumber) {
+    const {
+      creditManager,
+      includeZeroDebt = false,
+      maxHealthFactor = MAX_UINT256,
+      minHealthFactor = 0n,
+      ignoreReservePrices = false
+    } = options ?? {};
+    const { txs: priceUpdateTxs } = await this.sdk.priceFeeds.generatePriceFeedsUpdateTxs(
+      ignoreReservePrices ? { main: true } : void 0
+    );
+    const investorDataList = await this.sdk.kyc.getInvestorData(borrower);
+    const kycAccountAddresses = investorDataList.flatMap(
+      (d) => d.creditAccounts.map((ca) => ca.creditAccount)
+    );
+    const cmFilter = creditManager ? {
+      configurators: [],
+      creditManagers: [creditManager],
+      pools: [],
+      underlying: ADDRESS_0X0
+    } : {
+      configurators: this.marketConfigurators,
+      creditManagers: [],
+      pools: [],
+      underlying: ADDRESS_0X0
+    };
+    const permissiveFilter = {
+      owner: borrower,
+      includeZeroDebt: true,
+      minHealthFactor: 0n,
+      maxHealthFactor: MAX_UINT256,
+      reverting: false
+    };
+    const kycContracts = kycAccountAddresses.map(
+      (account) => ({
+        abi: creditAccountCompressorAbi,
+        address: this.#compressor,
+        functionName: "getCreditAccountData",
+        args: [account]
+      })
+    );
+    const getCreditAccountsContracts = [false, true].map(
+      (reverting) => ({
+        abi: creditAccountCompressorAbi,
+        address: this.#compressor,
+        functionName: "getCreditAccounts",
+        args: [cmFilter, { ...permissiveFilter, reverting }, 0n]
+      })
+    );
+    const allContracts = [...kycContracts, ...getCreditAccountsContracts];
+    const results = await simulateWithPriceUpdates(this.client, {
+      priceUpdates: priceUpdateTxs,
+      contracts: allContracts,
+      blockNumber,
+      gas: this.sdk.gasLimit
+    });
+    const kycResults = results.slice(
+      0,
+      kycAccountAddresses.length
+    );
+    const normalResults = results.slice(kycAccountAddresses.length);
+    const seen = new AddressSet();
+    const allCAs = [];
+    for (const ca of kycResults) {
+      if (!seen.has(ca.creditAccount)) {
+        seen.add(ca.creditAccount);
+        allCAs.push({ ...ca, investor: borrower });
+      }
+    }
+    for (const [accounts] of normalResults) {
+      for (const ca of accounts) {
+        if (!seen.has(ca.creditAccount)) {
+          seen.add(ca.creditAccount);
+          allCAs.push({ ...ca, investor: void 0 });
+        }
+      }
+    }
+    const filtered = allCAs.filter((ca) => {
+      if (!includeZeroDebt && ca.debt === 0n) return false;
+      if (ca.healthFactor < minHealthFactor) return false;
+      if (ca.healthFactor > maxHealthFactor) return false;
+      if (creditManager && !hexEq(ca.creditManager, creditManager))
+        return false;
+      return true;
+    });
+    this.logger?.debug(
+      `loaded ${allCAs.length} borrower credit accounts (${kycResults.length} KYC, ${filtered.length} after filter)`
+    );
+    return filtered.sort((a, b) => Number(a.healthFactor - b.healthFactor));
+  }
   /**
    * {@inheritDoc ICreditAccountsService.getRewards}
    **/
@@ -353,6 +464,13 @@ class AbstractCreditAccountService extends SDKConstruct {
     closePath
   }) {
     const cm = this.sdk.marketRegister.findCreditManager(ca.creditManager);
+    await this.sdk.tokensMeta.loadTokenData(cm.underlying);
+    const underlying = this.sdk.tokensMeta.mustGet(cm.underlying);
+    if (this.sdk.tokensMeta.isKYCUnderlying(underlying)) {
+      throw new Error(
+        "closeCreditAccount is not supported for KYC underlying credit accounts"
+      );
+    }
     const routerCloseResult = closePath || await this.sdk.routerFor(ca).findBestClosePath({
       creditAccount: ca,
       creditManager: cm.creditManager,
@@ -458,8 +576,18 @@ class AbstractCreditAccountService extends SDKConstruct {
       ],
       {}
     ) : [];
+    const unwrapCalls = collateral && isDecrease ? await this.getKYCUnwrapCalls(
+      collateral[0].balance,
+      creditAccount.creditManager
+    ) || [] : [];
+    if (addCollateralCalls.length > 0 && unwrapCalls.length === 0 && collateral && collateral?.[0].token !== creditAccount.underlying) {
+      throw new Error(
+        "Can't use collateral other than underlying for non KYC market"
+      );
+    }
     const operationCalls = [
       ...addCollateralCalls,
+      ...unwrapCalls,
       this.#prepareChangeDebt(creditAccount.creditFacade, change, isDecrease)
     ];
     const calls = await this.prependPriceUpdates(
@@ -667,6 +795,29 @@ class AbstractCreditAccountService extends SDKConstruct {
     const tx = await this.multicallTx(cm, creditAccount.creditAccount, calls);
     return { tx, calls, creditFacade: cm.creditFacade };
   }
+  /**
+   * {@inheritDoc ICreditAccountsService.getApprovalAddress}
+   **/
+  async getApprovalAddress(options) {
+    const { creditManager } = options;
+    const suite = this.sdk.marketRegister.findCreditManager(creditManager);
+    const marketSuite = this.sdk.marketRegister.findByPool(suite.pool);
+    const factory = marketSuite.kycFactory;
+    if (factory) {
+      return factory.getApprovalAddress(options);
+    }
+    return suite.creditManager.address;
+  }
+  /**
+   * {@inheritDoc ICreditAccountsService.getOpenAccountRequirements}
+   */
+  async getOpenAccountRequirements(borrower, creditManager, props) {
+    const { kycFactory } = this.sdk.marketRegister.findByCreditManager(creditManager);
+    if (!kycFactory) {
+      return void 0;
+    }
+    return kycFactory.getOpenAccountRequirements(borrower, props);
+  }
   /**
    * {@inheritDoc ICreditAccountsService.openCA}
    **/
@@ -684,7 +835,8 @@ class AbstractCreditAccountService extends SDKConstruct {
       calls: openPathCalls,
       callsAfter,
       minQuota,
-      averageQuota
+      averageQuota,
+      kycOptions
     } = props;
     const cmSuite = this.sdk.marketRegister.findCreditManager(creditManager);
     const cm = cmSuite.creditManager;
@@ -718,7 +870,13 @@ class AbstractCreditAccountService extends SDKConstruct {
     if (reopenCreditAccount) {
       tx = await this.multicallTx(cmSuite, reopenCreditAccount, calls);
     } else {
-      tx = await this.openCreditAccountTx(cmSuite, to, calls, referralCode);
+      tx = await this.openCreditAccountTx(
+        cmSuite,
+        to,
+        calls,
+        referralCode,
+        kycOptions
+      );
     }
     tx.value = ethAmount.toString(10);
     return { calls, tx, creditFacade: cmSuite.creditFacade };
@@ -801,6 +959,131 @@ class AbstractCreditAccountService extends SDKConstruct {
     return resp;
   }
   /**
+   * Returns multicall entries to redeem (unwrap) KYC ERC-4626 vault shares into underlying for the given credit manager.
+   * Used when withdrawing debt from a KYC market: redeems adapter vault shares so the underlying can be withdrawn.
+   * Only applies when the credit manager's underlying is KYC-gated and has an ERC-4626 adapter configured.
+   * @param amount - Number of vault shares (adapter tokens) to redeem
+   * @param creditManager - Credit manager address
+   * @returns Array of MultiCall to pass to credit facade multicall, or undefined if underlying is not KYC or no adapter is configured
+   */
+  async getKYCUnwrapCalls(amount, creditManager) {
+    const suite = this.sdk.marketRegister.findCreditManager(creditManager);
+    const meta = this.sdk.tokensMeta.mustGet(suite.underlying);
+    if (!this.sdk.tokensMeta.isKYCUnderlying(meta)) {
+      return void 0;
+    }
+    const adapter = suite.creditManager.adapters.get(meta.addr);
+    const adapterAddress = adapter?.address;
+    if (!adapterAddress) {
+      return void 0;
+    }
+    const mc = [
+      {
+        target: adapterAddress,
+        callData: encodeFunctionData({
+          abi: ierc4626AdapterAbi,
+          functionName: "redeem",
+          args: [amount, ADDRESS_0X0, ADDRESS_0X0]
+        })
+      }
+    ];
+    return mc;
+  }
+  /**
+   * Returns multicall entries to deposit (wrap) underlying into KYC ERC-4626 vault shares for the given credit manager.
+   * Used when adding debt on a KYC market: deposits underlying into the adapter vault so shares are minted on the account.
+   * Only applies when the credit manager's underlying is KYC-gated and has an ERC-4626 adapter configured.
+   * @param amount - Amount of underlying assets to deposit into the vault (in underlying decimals)
+   * @param creditManager - Credit manager address
+   * @returns Array of MultiCall to pass to credit facade multicall, or undefined if underlying is not KYC or no adapter is configured
+   */
+  async getKYCWrapCalls(amount, creditManager) {
+    const suite = this.sdk.marketRegister.findCreditManager(creditManager);
+    const meta = this.sdk.tokensMeta.mustGet(suite.underlying);
+    if (!this.sdk.tokensMeta.isKYCUnderlying(meta)) {
+      return void 0;
+    }
+    const adapter = suite.creditManager.adapters.get(meta.addr);
+    const adapterAddress = adapter?.address;
+    if (!adapterAddress) {
+      return void 0;
+    }
+    const mc = [
+      {
+        target: adapterAddress,
+        callData: encodeFunctionData({
+          abi: ierc4626AdapterAbi,
+          functionName: "deposit",
+          args: [amount, ADDRESS_0X0]
+        })
+      }
+    ];
+    return mc;
+  }
+  /**
+   * Returns multicall entries to call redeemDiff on the KYC ERC-4626 adapter for the given credit manager.
+   * Redeems the leftover vault shares (e.g. after repaying debt) so the account does not hold excess KYC vault tokens.
+   * Only applies when the credit manager's underlying is KYC-gated and has an ERC-4626 adapter configured.
+   * @param amount - Leftover vault share amount to redeem (in adapter/vault decimals)
+   * @param creditManager - Credit manager address
+   * @returns Array of MultiCall to pass to credit facade multicall, or undefined if underlying is not KYC or no adapter is configured
+   */
+  async getRedeemDiffCalls(amount, creditManager) {
+    const suite = this.sdk.marketRegister.findCreditManager(creditManager);
+    const meta = this.sdk.tokensMeta.mustGet(suite.underlying);
+    if (!this.sdk.tokensMeta.isKYCUnderlying(meta)) {
+      return void 0;
+    }
+    const adapter = suite.creditManager.adapters.get(meta.addr);
+    const adapterAddress = adapter?.address;
+    if (!adapterAddress) {
+      return void 0;
+    }
+    const mc = [
+      {
+        target: adapterAddress,
+        callData: encodeFunctionData({
+          abi: ierc4626AdapterAbi,
+          functionName: "redeemDiff",
+          args: [amount]
+        })
+      }
+    ];
+    return mc;
+  }
+  /**
+   * Returns multicall entries to call depositDiff on the KYC ERC-4626 adapter for the given credit manager.
+   * Deposits the leftover underlying (e.g. after decreasing debt) into the vault so the account does not hold excess underlying.
+   * Only applies when the credit manager's underlying is KYC-gated and has an ERC-4626 adapter configured.
+   * @param amount - Leftover underlying amount to deposit into the vault (in underlying decimals)
+   * @param creditManager - Credit manager address
+   * @returns Array of MultiCall to pass to credit facade multicall, or undefined if underlying is not KYC or no adapter is configured
+   */
+  async getDepositDiffCalls(amount, creditManager) {
+    const suite = this.sdk.marketRegister.findCreditManager(creditManager);
+    const meta = this.sdk.tokensMeta.mustGet(suite.underlying);
+    if (!this.sdk.tokensMeta.isKYCUnderlying(meta)) {
+      return void 0;
+    }
+    const adapter = suite.creditManager.adapters.get(meta.addr);
+    const adapterAddress = adapter?.address;
+    if (!adapterAddress) {
+      return void 0;
+    }
+    const mc = [
+      {
+        target: adapterAddress,
+        callData: encodeFunctionData({
+          abi: ierc4626AdapterAbi,
+          functionName: "depositDiff",
+          args: [amount]
+        })
+      }
+    ];
+    return mc;
+  }
+  /**
+   * Returns raw txs that are needed to update all price feeds so that all credit accounts (possibly from different markets) compute
    * {@inheritDoc ICreditAccountsService.getOnDemandPriceUpdates}
    **/
   async getOnDemandPriceUpdates(account, ignoreReservePrices) {
@@ -1055,9 +1338,19 @@ class AbstractCreditAccountService extends SDKConstruct {
    * @param to
    * @param calls
    * @param referralCode
+   * @param kycOptions
    * @returns
    */
-  async openCreditAccountTx(suite, to, calls, referralCode) {
+  async openCreditAccountTx(suite, to, calls, referralCode, kycOptions) {
+    const marketSuite = this.sdk.marketRegister.findByPool(suite.pool);
+    const factory = marketSuite.kycFactory;
+    if (factory) {
+      return factory.openCreditAccount(
+        suite.creditManager.address,
+        calls,
+        kycOptions
+      );
+    }
     return suite.creditFacade.openCreditAccount(to, calls, referralCode ?? 0n);
   }
   /**
@@ -1065,9 +1358,17 @@ class AbstractCreditAccountService extends SDKConstruct {
    * @param suite
    * @param creditAccount
    * @param calls
+   * @param kycOptions
    * @returns
    */
-  async multicallTx(suite, creditAccount, calls) {
+  async multicallTx(suite, creditAccount, calls, kycOptions) {
+    const marketSuite = this.sdk.marketRegister.findByCreditManager(
+      suite.creditManager.address
+    );
+    const factory = marketSuite.kycFactory;
+    if (factory) {
+      return factory.multicall(creditAccount, calls, kycOptions);
+    }
     return suite.creditFacade.multicall(creditAccount, calls);
   }
   /**
@@ -1076,12 +1377,25 @@ class AbstractCreditAccountService extends SDKConstruct {
    * @param creditAccount
    * @param calls
    * @param operation
+   * @param kycOptions
    * @returns
    */
-  async closeCreditAccountTx(suite, creditAccount, calls, operation) {
+  async closeCreditAccountTx(suite, creditAccount, calls, operation, kycOptions) {
+    const marketSuite = this.sdk.marketRegister.findByCreditManager(
+      suite.creditManager.address
+    );
+    const factory = marketSuite.kycFactory;
     if (operation === "close") {
+      if (factory) {
+        throw new Error(
+          "CloseOptions=close is not supported for KYC underlying credit accounts"
+        );
+      }
       return suite.creditFacade.closeCreditAccount(creditAccount, calls);
     }
+    if (factory) {
+      return factory.multicall(creditAccount, calls, kycOptions);
+    }
     return suite.creditFacade.multicall(creditAccount, calls);
   }
 }

package/dist/esm/sdk/accounts/CreditAccountsServiceV310.js

@@ -90,19 +90,23 @@ class CreditAccountServiceV310 extends AbstractCreditAccountService {
     creditAccount: ca,
     permits,
     to,
-    tokensToClaim
+    tokensToClaim,
+    calls: wrapCalls = []
   }) {
     const cm = this.sdk.marketRegister.findCreditManager(ca.creditManager);
     const addCollateral = collateralAssets.filter((a) => a.balance > 0);
     const router = this.sdk.routerFor(ca);
+    const unwrapCalls = await this.getRedeemDiffCalls(1n, ca.creditManager) ?? [];
     const claimPath = await router.findClaimAllRewards({
       tokensToClaim,
       creditAccount: ca
     });
     const operationCalls = [
       ...this.prepareAddCollateral(ca.creditFacade, addCollateral, permits),
+      ...wrapCalls,
       ...this.prepareDisableQuotas(ca),
       ...this.prepareDecreaseDebt(ca),
+      ...unwrapCalls,
       ...claimPath.calls,
       ...assetsToWithdraw.map(
         (t) => this.prepareWithdrawToken(ca.creditFacade, t.token, MAX_UINT256, to)
@@ -134,10 +138,12 @@ class CreditAccountServiceV310 extends AbstractCreditAccountService {
       tokensToClaim,
       creditAccount: ca
     });
+    const wrapCalls = await this.getDepositDiffCalls(1n, ca.creditManager) ?? [];
     const addCollateral = collateralAssets.filter((a) => a.balance > 0);
     const operationCalls = [
       ...this.prepareAddCollateral(ca.creditFacade, addCollateral, permits),
       ...claimPath.calls,
+      ...wrapCalls,
       ...assetsToWithdraw.map(
         (t) => this.prepareWithdrawToken(ca.creditFacade, t.token, MAX_UINT256, to)
       )

package/dist/esm/sdk/base/TokensMeta.js

@@ -1,6 +1,3 @@
-import {
-  erc20Abi
-} from "viem";
 import { iStateSerializerAbi } from "../../abi/iStateSerializer.js";
 import { iVersionAbi } from "../../abi/iVersion.js";
 import {
@@ -65,6 +62,14 @@ class TokensMeta extends AddressMap {
     }
     return !!t.contractType?.startsWith("PHANTOM_TOKEN::");
   }
+  /**
+   * Returns true if the token is a KYC underlying token, throws if the token data is not loaded
+   * @param t
+   * @returns
+   */
+  isKYCUnderlying(t) {
+    return !!t.contractType?.startsWith("KYC_UNDERLYING::");
+  }
   /**
    * Returns a map of all phantom tokens
    * Throws if token data is not loaded
@@ -78,6 +83,19 @@ class TokensMeta extends AddressMap {
     }
     return result;
   }
+  /**
+   * Returns a map of all KYC underlying tokens
+   * Throws if token data is not loaded
+   */
+  get kycUnderlyings() {
+    const result = new AddressMap();
+    for (const [token, meta] of this.entries()) {
+      if (this.isKYCUnderlying(meta)) {
+        result.upsert(token, meta);
+      }
+    }
+    return result;
+  }
   formatBN(arg0, arg1, arg2) {
     const token = typeof arg0 === "object" ? arg0.token : arg0;
     const amount = typeof arg0 === "object" ? arg0.balance : arg1;
@@ -108,7 +126,7 @@ class TokensMeta extends AddressMap {
   }
   /**
    * Loads token information about phantom tokens
-   * Other special tokens may be loaded here in the future
+   * In future other custom tokens types that do not have compressors might be handled here
    *
    * @param tokens - tokens to load data for, defaults to all tokens
    */
@@ -154,46 +172,6 @@ class TokensMeta extends AddressMap {
     }
     return this.mustGet(token);
   }
-  async #loadWithoutCompressor(tokens_) {
-    if (tokens_.size === 0) {
-      return;
-    }
-    const tokens = Array.from(tokens_);
-    const resp = await this.#client.multicall({
-      contracts: tokens.flatMap(
-        (t) => [
-          {
-            address: t,
-            abi: erc20Abi,
-            functionName: "symbol"
-          },
-          {
-            address: t,
-            abi: erc20Abi,
-            functionName: "name"
-          },
-          {
-            address: t,
-            abi: erc20Abi,
-            functionName: "decimals"
-          }
-        ]
-      ),
-      allowFailure: false,
-      batchSize: 0
-    });
-    this.#logger?.debug(
-      `loaded ${resp.length} basic metadata without compressor`
-    );
-    for (let i = 0; i < tokens.length; i++) {
-      this.upsert(tokens[i], {
-        addr: tokens[i],
-        symbol: resp[3 * i],
-        name: resp[3 * i + 1],
-        decimals: resp[3 * i + 2]
-      });
-    }
-  }
 }
 export {
   TokensMeta

package/dist/esm/sdk/base/token-types.js

@@ -7,6 +7,12 @@ const PHANTOM_TOKEN_CONTRACT_TYPES = [
   "PHANTOM_TOKEN::STAKING_REWARDS",
   "PHANTOM_TOKEN::UPSHIFT_WITHDRAW"
 ];
+const KYC_UNDERLYING_DEFAULT = "KYC_UNDERLYING::DEFAULT";
+const KYC_UNDERLYING_ON_DEMAND = "KYC_UNDERLYING::ON_DEMAND";
+const KYC_ON_DEMAND_LP_MONOPOLIZED = "ON_DEMAND_LP::MONOPOLIZED";
 export {
+  KYC_ON_DEMAND_LP_MONOPOLIZED,
+  KYC_UNDERLYING_DEFAULT,
+  KYC_UNDERLYING_ON_DEMAND,
   PHANTOM_TOKEN_CONTRACT_TYPES
 };