@gearbox-protocol/sdk 13.6.0 → 13.7.0-kyc.2

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

@@ -113,19 +113,23 @@ class CreditAccountServiceV310 extends import_AbstractCreditAccountsService.Abst
     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, import_math.MAX_UINT256, to)
@@ -157,10 +161,12 @@ class CreditAccountServiceV310 extends import_AbstractCreditAccountsService.Abst
       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, import_math.MAX_UINT256, to)
       )

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

@@ -21,7 +21,6 @@ __export(TokensMeta_exports, {
   TokensMeta: () => TokensMeta
 });
 module.exports = __toCommonJS(TokensMeta_exports);
-var import_viem = require("viem");
 var import_iStateSerializer = require("../../abi/iStateSerializer.js");
 var import_iVersion = require("../../abi/iVersion.js");
 var import_utils = require("../utils/index.js");
@@ -81,6 +80,14 @@ class TokensMeta extends import_utils.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
@@ -94,6 +101,19 @@ class TokensMeta extends import_utils.AddressMap {
     }
     return result;
   }
+  /**
+   * Returns a map of all KYC underlying tokens
+   * Throws if token data is not loaded
+   */
+  get kycUnderlyings() {
+    const result = new import_utils.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;
@@ -124,7 +144,7 @@ class TokensMeta extends import_utils.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
    */
@@ -153,10 +173,19 @@ class TokensMeta extends import_utils.AddressMap {
       batchSize: 0
     });
     this.#logger?.debug(`loaded ${resp.length} contract types`);
+    const kycFactories = new import_utils.AddressSet();
     for (let i = 0; i < tokensToLoad.length; i++) {
-      this.#overrideTokenMeta(tokensToLoad[i], resp[2 * i], resp[2 * i + 1]);
+      const meta = this.#overrideTokenMeta(
+        tokensToLoad[i],
+        resp[2 * i],
+        resp[2 * i + 1]
+      );
       this.#tokenDataLoaded.add(tokensToLoad[i]);
+      if (this.isKYCUnderlying(meta)) {
+        kycFactories.add(meta.kycFactory);
+      }
     }
+    this.#logger?.debug(`found ${kycFactories.size} KYC factories`);
   }
   #overrideTokenMeta(token, contractTypeResp, _serializeResp) {
     const meta = this.mustGet(token);
@@ -170,46 +199,6 @@ class TokensMeta extends import_utils.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: import_viem.erc20Abi,
-            functionName: "symbol"
-          },
-          {
-            address: t,
-            abi: import_viem.erc20Abi,
-            functionName: "name"
-          },
-          {
-            address: t,
-            abi: import_viem.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]
-      });
-    }
-  }
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {

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

@@ -18,6 +18,9 @@ var __copyProps = (to, from, except, desc) => {
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var token_types_exports = {};
 __export(token_types_exports, {
+  KYC_ON_DEMAND_LP_MONOPOLIZED: () => KYC_ON_DEMAND_LP_MONOPOLIZED,
+  KYC_UNDERLYING_DEFAULT: () => KYC_UNDERLYING_DEFAULT,
+  KYC_UNDERLYING_ON_DEMAND: () => KYC_UNDERLYING_ON_DEMAND,
   PHANTOM_TOKEN_CONTRACT_TYPES: () => PHANTOM_TOKEN_CONTRACT_TYPES
 });
 module.exports = __toCommonJS(token_types_exports);
@@ -30,7 +33,13 @@ 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";
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  KYC_ON_DEMAND_LP_MONOPOLIZED,
+  KYC_UNDERLYING_DEFAULT,
+  KYC_UNDERLYING_ON_DEMAND,
   PHANTOM_TOKEN_CONTRACT_TYPES
 });

package/dist/cjs/sdk/chain/chains.js

@@ -79,7 +79,8 @@ const chains = {
         "0x601067eba24bb5b558a184fc082525637e96a42d": "Gami Labs"
       },
       testMarketConfigurators: {
-        "0x99df7330bf42d596af2e9d9836d4fc2077c574aa": "M11 Credit"
+        "0x99df7330bf42d596af2e9d9836d4fc2077c574aa": "M11 Credit",
+        "0x610627d8d01a413bdd9b0a0b60070da7dd1e54ad": "Securitize"
       },
       isPublic: true,
       wellKnownToken: {

package/dist/cjs/sdk/constants/address-provider.js

@@ -36,6 +36,7 @@ __export(address_provider_exports, {
   AP_GEAR_TOKEN: () => AP_GEAR_TOKEN,
   AP_INFLATION_ATTACK_BLOCKER: () => AP_INFLATION_ATTACK_BLOCKER,
   AP_INSOLVENCY_CHECKER: () => AP_INSOLVENCY_CHECKER,
+  AP_KYC_COMPRESSOR: () => AP_KYC_COMPRESSOR,
   AP_MARKET_COMPRESSOR: () => AP_MARKET_COMPRESSOR,
   AP_MARKET_CONFIGURATOR: () => AP_MARKET_CONFIGURATOR,
   AP_PARTIAL_LIQUIDATION_BOT: () => AP_PARTIAL_LIQUIDATION_BOT,
@@ -87,6 +88,7 @@ const AP_WETH_GATEWAY = "WETH_GATEWAY";
 const AP_WETH_TOKEN = "WETH_TOKEN";
 const AP_ZAPPER_REGISTER = "ZAPPER_REGISTER";
 const AP_ZERO_PRICE_FEED = "ZERO_PRICE_FEED";
+const AP_KYC_COMPRESSOR = "GLOBAL::KYC_COMPRESSOR";
 const ADDRESS_PROVIDER_V310 = "0xF7f0a609BfAb9a0A98786951ef10e5FE26cC1E38";
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
@@ -108,6 +110,7 @@ const ADDRESS_PROVIDER_V310 = "0xF7f0a609BfAb9a0A98786951ef10e5FE26cC1E38";
   AP_GEAR_TOKEN,
   AP_INFLATION_ATTACK_BLOCKER,
   AP_INSOLVENCY_CHECKER,
+  AP_KYC_COMPRESSOR,
   AP_MARKET_COMPRESSOR,
   AP_MARKET_CONFIGURATOR,
   AP_PARTIAL_LIQUIDATION_BOT,

package/dist/cjs/sdk/market/MarketRegister.js

@@ -29,6 +29,9 @@ var import_MarketConfiguratorContract = require("./MarketConfiguratorContract.js
 var import_MarketSuite = require("./MarketSuite.js");
 var import_ZapperRegister = require("./ZapperRegister.js");
 class MarketRegister extends import_ZapperRegister.ZapperRegister {
+  /**
+   * Mapping pool.address -> MarketSuite
+   */
   #markets = new import_utils.AddressMap(void 0, "markets");
   #marketFilter;
   #marketConfigurators = new import_utils.AddressMap(
@@ -42,9 +45,7 @@ class MarketRegister extends import_ZapperRegister.ZapperRegister {
    **/
   constructor(sdk, ignoreMarkets = []) {
     super(sdk);
-    this.#ignoreMarkets = new Set(
-      ignoreMarkets.map((m) => m.toLowerCase())
-    );
+    this.#ignoreMarkets = new import_utils.AddressSet(ignoreMarkets);
   }
   /**
    * Restores market state from a previously serialized snapshot,
@@ -52,40 +53,41 @@ class MarketRegister extends import_ZapperRegister.ZapperRegister {
    * @param state - Array of market data snapshots.
    **/
   hydrate(state) {
-    this.#markets.clear();
     const configurators = new Set(state.map((m) => m.configurator));
     this.#setMarketFilter([...configurators]);
-    for (const data of state) {
-      const pool = data.pool.baseParams.addr;
-      if (this.#ignoreMarkets.has(pool.toLowerCase())) {
-        this.logger?.debug(
-          `ignoring market of pool ${pool} (${data.pool.name})`
-        );
-        continue;
-      }
-      this.#markets.upsert(
-        data.pool.baseParams.addr,
-        new import_MarketSuite.MarketSuite(this.sdk, data)
-      );
-    }
+    this.#setMarkets(state);
   }
   /**
-   * Fetches all markets from the on-chain for the given market configurators.
+   * @internal
+   * Returns delegated multicalls for loading all markets from the on-chain
+   * market compressor. Used by the SDK to compose batched RPC calls.
    *
-   * @param marketConfigurators - Addresses of market configurator contracts to query.
-   * @param ignoreUpdateablePrices - When `true`, skips generating off-chain
-   *   price updates before loading
+   * @param configurators - Addresses of market configurator contracts to query.
    **/
-  async loadMarkets(marketConfigurators, ignoreUpdateablePrices) {
-    if (!marketConfigurators.length) {
-      this.logger?.warn(
-        "no market configurators provided, skipping loadMarkets"
-      );
-      return;
-    }
-    await this.#loadMarkets(marketConfigurators, [], ignoreUpdateablePrices);
+  getLoadMulticalls(configurators) {
+    this.#setMarketFilter(configurators);
+    const [marketCompressorAddress] = this.sdk.addressProvider.mustGetLatest(
+      import_constants.AP_MARKET_COMPRESSOR,
+      import_constants.VERSION_RANGE_310
+    );
+    return [
+      {
+        call: {
+          abi: import_marketCompressor.marketCompressorAbi,
+          address: marketCompressorAddress,
+          functionName: "getMarkets",
+          args: [this.marketFilter]
+        },
+        onResult: (resp) => {
+          this.#setMarkets(resp);
+          this.logger?.info(
+            `loaded ${this.#markets.size} markets in block ${this.sdk.currentBlock}`
+          );
+        }
+      }
+    ];
   }
-  #setMarketFilter(configurators, pools = []) {
+  #setMarketFilter(configurators) {
     for (const c of configurators) {
       this.#marketConfigurators.upsert(
         c,
@@ -94,7 +96,7 @@ class MarketRegister extends import_ZapperRegister.ZapperRegister {
     }
     this.#marketFilter = {
       configurators,
-      pools,
+      pools: [],
       underlying: import_constants.ADDRESS_0X0
     };
   }
@@ -121,106 +123,45 @@ class MarketRegister extends import_ZapperRegister.ZapperRegister {
    **/
   async syncState(ignoreUpdateablePrices) {
     const dirty = this.markets.some((m) => m.dirty) || this.marketConfigurators.some((c) => c.dirty);
+    let multicalls;
+    let txs = [];
     if (dirty) {
       this.logger?.debug(
         "some markets or market configurators are dirty, reloading everything"
       );
-      await this.#loadMarkets(
-        [...this.marketFilter.configurators],
-        [...this.marketFilter.pools],
-        ignoreUpdateablePrices
-      );
+      multicalls = this.getLoadMulticalls([...this.marketFilter.configurators]);
+      if (!ignoreUpdateablePrices) {
+        const updatables = await this.sdk.priceFeeds.getPartialUpdatablePriceFeeds([
+          ...this.marketFilter.configurators
+        ]);
+        const updates = await this.sdk.priceFeeds.generatePriceFeedsUpdateTxs(updatables);
+        txs = updates.txs;
+      }
     } else if (!ignoreUpdateablePrices) {
-      await this.updatePrices();
-    }
-  }
-  async #loadMarkets(configurators, pools, ignoreUpdateablePrices) {
-    this.#setMarketFilter(configurators, pools);
-    const [marketCompressorAddress] = this.sdk.addressProvider.mustGetLatest(
-      import_constants.AP_MARKET_COMPRESSOR,
-      import_constants.VERSION_RANGE_310
-    );
-    let txs = [];
-    if (!ignoreUpdateablePrices) {
-      const updatables = await this.sdk.priceFeeds.getPartialUpdatablePriceFeeds(
-        configurators,
-        pools
-      );
-      const updates = await this.sdk.priceFeeds.generatePriceFeedsUpdateTxs(updatables);
+      multicalls = this.#getOracleSyncMulticalls();
+      if (!multicalls.length) {
+        return;
+      }
+      this.logger?.debug(`syncing prices on ${multicalls.length} oracles`);
+      const updates = await this.sdk.priceFeeds.generatePriceFeedsUpdateTxs();
       txs = updates.txs;
-    }
-    this.logger?.debug(
-      { configurators, pools },
-      `calling getMarkets with ${txs.length} price updates in block ${this.sdk.currentBlock}`
-    );
-    let markets = [];
-    if (txs.length) {
-      const [resp] = await (0, import_viem.simulateWithPriceUpdates)(this.client, {
-        priceUpdates: txs,
-        contracts: [
-          {
-            abi: import_marketCompressor.marketCompressorAbi,
-            address: marketCompressorAddress,
-            functionName: "getMarkets",
-            args: [this.marketFilter]
-          }
-        ],
-        blockNumber: this.sdk.currentBlock,
-        gas: this.sdk.gasLimit
-      });
-      markets = resp;
     } else {
-      markets = await this.client.readContract({
-        abi: import_marketCompressor.marketCompressorAbi,
-        address: marketCompressorAddress,
-        functionName: "getMarkets",
-        args: [this.marketFilter],
-        blockNumber: this.sdk.currentBlock,
-        // @ts-expect-error
-        gas: this.sdk.gasLimit
-      });
-    }
-    for (const data of markets) {
-      const pool = data.pool.baseParams.addr;
-      if (this.#ignoreMarkets.has(pool.toLowerCase())) {
-        this.logger?.debug(
-          `ignoring market of pool ${pool} (${data.pool.name})`
-        );
-        continue;
-      }
-      this.#markets.upsert(pool, new import_MarketSuite.MarketSuite(this.sdk, data));
+      return;
     }
-    this.logger?.info(
-      `loaded ${this.#markets.size} markets in block ${this.sdk.currentBlock}`
-    );
+    await (0, import_viem.executeDelegatedMulticalls)(this.client, multicalls, {
+      priceUpdates: txs,
+      blockNumber: this.sdk.currentBlock,
+      gas: this.sdk.gasLimit
+    });
   }
-  /**
-   * Loads new prices and price feeds for given oracles from PriceFeedCompressor, defaults to all oracles
-   */
-  async updatePrices(oracles) {
+  #getOracleSyncMulticalls(oracles) {
     const uniqOracles = new import_utils.AddressMap();
     for (const m of this.markets) {
       if (!oracles || oracles.includes(m.priceOracle.address)) {
         uniqOracles.upsert(m.priceOracle.address, m.priceOracle);
       }
     }
-    const multicalls = uniqOracles.values().map((o) => o.syncStateMulticall());
-    if (!multicalls.length) {
-      return;
-    }
-    this.logger?.debug(`syncing prices on ${multicalls.length} oracles`);
-    const { txs } = await this.sdk.priceFeeds.generatePriceFeedsUpdateTxs();
-    const oraclesStates = await (0, import_viem.simulateWithPriceUpdates)(this.client, {
-      priceUpdates: txs,
-      contracts: multicalls.map((mc) => mc.call),
-      gas: this.sdk.gasLimit,
-      blockNumber: this.sdk.currentBlock
-    });
-    for (let i = 0; i < multicalls.length; i++) {
-      const handler = multicalls[i].onResult;
-      const result = oraclesStates[i];
-      handler(result);
-    }
+    return uniqOracles.values().map((o) => o.syncStateMulticall());
   }
   get watchAddresses() {
     return /* @__PURE__ */ new Set([
@@ -341,6 +282,19 @@ class MarketRegister extends import_ZapperRegister.ZapperRegister {
   get markets() {
     return this.#markets.values();
   }
+  #setMarkets(markets) {
+    this.#markets.clear();
+    for (const data of markets) {
+      const pool = data.pool.baseParams.addr;
+      if (this.#ignoreMarkets.has(pool)) {
+        this.logger?.debug(
+          `ignoring market of pool ${pool} (${data.pool.name})`
+        );
+        continue;
+      }
+      this.#markets.upsert(pool, new import_MarketSuite.MarketSuite(this.sdk, data));
+    }
+  }
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {

package/dist/cjs/sdk/market/MarketSuite.js

@@ -65,6 +65,9 @@ class MarketSuite extends import_base.SDKConstruct {
   get underlying() {
     return this.pool.underlying;
   }
+  get kycFactory() {
+    return this.pool.kycFactory;
+  }
   get dirty() {
     return this.configurator.dirty || this.pool.dirty || this.priceOracle.dirty || this.creditManagers.some((cm) => cm.dirty);
   }

package/dist/cjs/sdk/market/index.js

@@ -17,6 +17,7 @@ var market_exports = {};
 module.exports = __toCommonJS(market_exports);
 __reExport(market_exports, require("./adapters/index.js"), module.exports);
 __reExport(market_exports, require("./credit/index.js"), module.exports);
+__reExport(market_exports, require("./kyc/index.js"), module.exports);
 __reExport(market_exports, require("./MarketRegister.js"), module.exports);
 __reExport(market_exports, require("./MarketSuite.js"), module.exports);
 __reExport(market_exports, require("./oracle/index.js"), module.exports);
@@ -27,6 +28,7 @@ __reExport(market_exports, require("./types.js"), module.exports);
 0 && (module.exports = {
   ...require("./adapters/index.js"),
   ...require("./credit/index.js"),
+  ...require("./kyc/index.js"),
   ...require("./MarketRegister.js"),
   ...require("./MarketSuite.js"),
   ...require("./oracle/index.js"),