@gearbox-protocol/sdk 14.0.0 → 14.1.0

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
 };

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

@@ -65,8 +65,10 @@ const chains = {
         "0x601067eba24bb5b558a184fc082525637e96a42d": "Gami Labs"
       },
       testMarketConfigurators: {
-        "0x99df7330bf42d596af2e9d9836d4fc2077c574aa": "M11 Credit"
+        "0x99df7330bf42d596af2e9d9836d4fc2077c574aa": "M11 Credit",
+        "0x610627d8d01a413bdd9b0a0b60070da7dd1e54ad": "Securitize"
       },
+      kycFactories: [],
       isPublic: true,
       wellKnownToken: {
         address: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
@@ -84,6 +86,7 @@ const chains = {
       defaultMarketConfigurators: {
         "0x01023850b360b88de0d0f84015bbba1eba57fe7e": "Chaos Labs"
       },
+      kycFactories: [],
       isPublic: true,
       wellKnownToken: {
         address: "0xaf88d065e77c8cC2239327C5EDb3A432268e5831",
@@ -102,6 +105,7 @@ const chains = {
         "0x2a15969CE5320868eb609680751cF8896DD92De5": "Chaos Labs",
         "0x9dddd1b9ce0ac8aa0c80e4ec141600b9bf0101c3": "UltraYield"
       },
+      kycFactories: [],
       isPublic: true,
       wellKnownToken: {
         address: "0x0b2C639c533813f4Aa9D7837CAf62653d097Ff85",
@@ -117,6 +121,7 @@ const chains = {
       ...base,
       network: "Base",
       defaultMarketConfigurators: {},
+      kycFactories: [],
       isPublic: false,
       wellKnownToken: {
         address: "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913",
@@ -133,6 +138,7 @@ const chains = {
       defaultMarketConfigurators: {
         "0x8FFDd1F1433674516f83645a768E8900A2A5D076": "Chaos Labs"
       },
+      kycFactories: [],
       isPublic: true,
       blockExplorers: {
         default: {
@@ -154,6 +160,7 @@ const chains = {
     ...megaeth,
     network: "MegaETH",
     defaultMarketConfigurators: {},
+    kycFactories: [],
     isPublic: false,
     wellKnownToken: {
       address: "0xFAfDdbb3FC7688494971a79cc65DCa3EF82079E7",
@@ -175,6 +182,7 @@ const chains = {
       "0x16956912813ab9a38d95730b52a8cf53e860a7c5": "Tulipa",
       "0x7c6ee1bf9c1eb3ee55bdbdc1e8d0317aab718e0a": "UltraYield"
     },
+    kycFactories: [],
     isPublic: true,
     wellKnownToken: {
       address: "0xe7cd86e13AC4309349F30B3435a9d337750fC82D",
@@ -188,6 +196,7 @@ const chains = {
       ...berachain,
       network: "Berachain",
       defaultMarketConfigurators: {},
+      kycFactories: [],
       isPublic: false,
       blockExplorers: {
         default: {
@@ -209,6 +218,7 @@ const chains = {
       ...avalanche,
       network: "Avalanche",
       defaultMarketConfigurators: {},
+      kycFactories: [],
       isPublic: false,
       wellKnownToken: {
         address: "0xB97EF9Ef8734C71904D8002F8b6Bc66Dd9c48a6E",
@@ -227,6 +237,7 @@ const chains = {
         "0x92dc4ee43e9b207e16fbf3fd1a6933563c0a0d35": "Re7"
       },
       testMarketConfigurators: {},
+      kycFactories: [],
       isPublic: true,
       wellKnownToken: {
         address: "0x8ac76a51cc950d9822d68b83fe1ad97b32cd580d",
@@ -241,6 +252,7 @@ const chains = {
     ...worldchain,
     network: "WorldChain",
     defaultMarketConfigurators: {},
+    kycFactories: [],
     isPublic: false,
     wellKnownToken: {
       address: "0x79a02482a880bce3f13e09da970dc34db4cd24d1",
@@ -255,6 +267,7 @@ const chains = {
     defaultMarketConfigurators: {
       "0x577424f0e6f50db668cc1bc76babb87e36732291": "Re7"
     },
+    kycFactories: [],
     isPublic: true,
     wellKnownToken: {
       address: "0x796Ea11Fa2dD751eD01b53C372fFDB4AAa8f00F9",
@@ -269,6 +282,7 @@ const chains = {
     defaultMarketConfigurators: {
       "0xc9961b8a0c763779690577f2c76962c086af2fe3": "Invariant Group"
     },
+    kycFactories: [],
     isPublic: true,
     wellKnownToken: {
       address: "0xad11a8BEb98bbf61dbb1aa0F6d6F2ECD87b35afA",
@@ -288,6 +302,7 @@ const chains = {
     defaultMarketConfigurators: {
       "0x25778dbf0e56b7feb8358c4aa2f6f9e19a1c145a": "Re7"
     },
+    kycFactories: [],
     isPublic: true,
     wellKnownToken: {
       address: "0xF242275d3a6527d877f2c927a82D9b057609cc71",
@@ -304,6 +319,7 @@ const chains = {
       "0xce1cf71a28837daaa7b92d00ca4ef2fd649c2a67": "Hyperithm",
       "0x9655f82b585b11cee8a05576ed8efcf755cec04b": "TelosC"
     },
+    kycFactories: [],
     isPublic: true,
     wellKnownToken: {
       address: "0x5d72a9d9a9510cd8cbdba12ac62593a58930a948",
@@ -330,6 +346,7 @@ const chains = {
     defaultMarketConfigurators: {
       "0x1ca8b92aa7233a9f8f7ba031ac45c878141adff0": "Invariant Group"
     },
+    kycFactories: [],
     isPublic: true,
     wellKnownToken: {
       address: "0x67B302E35Aef5EEE8c32D934F5856869EF428330",

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

@@ -31,6 +31,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";
 export {
   ADDRESS_PROVIDER_V310,
@@ -51,6 +52,7 @@ export {
   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/esm/sdk/market/MarketRegister.js

@@ -4,12 +4,17 @@ import {
   AP_MARKET_COMPRESSOR,
   VERSION_RANGE_310
 } from "../constants/index.js";
-import { AddressMap } from "../utils/index.js";
-import { simulateWithPriceUpdates } from "../utils/viem/index.js";
+import { AddressMap, AddressSet } from "../utils/index.js";
+import {
+  executeDelegatedMulticalls
+} from "../utils/viem/index.js";
 import { MarketConfiguratorContract } from "./MarketConfiguratorContract.js";
 import { MarketSuite } from "./MarketSuite.js";
 import { ZapperRegister } from "./ZapperRegister.js";
 class MarketRegister extends ZapperRegister {
+  /**
+   * Mapping pool.address -> MarketSuite
+   */
   #markets = new AddressMap(void 0, "markets");
   #marketFilter;
   #marketConfigurators = new AddressMap(
@@ -23,9 +28,7 @@ class MarketRegister extends ZapperRegister {
    **/
   constructor(sdk, ignoreMarkets = []) {
     super(sdk);
-    this.#ignoreMarkets = new Set(
-      ignoreMarkets.map((m) => m.toLowerCase())
-    );
+    this.#ignoreMarkets = new AddressSet(ignoreMarkets);
   }
   /**
    * Restores market state from a previously serialized snapshot,
@@ -33,40 +36,41 @@ class MarketRegister extends 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 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(
+      AP_MARKET_COMPRESSOR,
+      VERSION_RANGE_310
+    );
+    return [
+      {
+        call: {
+          abi: 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,
@@ -75,7 +79,7 @@ class MarketRegister extends ZapperRegister {
     }
     this.#marketFilter = {
       configurators,
-      pools,
+      pools: [],
       underlying: ADDRESS_0X0
     };
   }
@@ -102,106 +106,45 @@ class MarketRegister extends 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(
-      AP_MARKET_COMPRESSOR,
-      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 simulateWithPriceUpdates(this.client, {
-        priceUpdates: txs,
-        contracts: [
-          {
-            abi: 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: 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 MarketSuite(this.sdk, data));
+      return;
     }
-    this.logger?.info(
-      `loaded ${this.#markets.size} markets in block ${this.sdk.currentBlock}`
-    );
+    await 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 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 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([
@@ -322,6 +265,19 @@ class MarketRegister extends 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 MarketSuite(this.sdk, data));
+    }
+  }
 }
 export {
   MarketRegister

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

@@ -44,6 +44,9 @@ class MarketSuite extends 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/esm/sdk/market/index.js

@@ -1,5 +1,6 @@
 export * from "./adapters/index.js";
 export * from "./credit/index.js";
+export * from "./kyc/index.js";
 export * from "./MarketRegister.js";
 export * from "./MarketSuite.js";
 export * from "./oracle/index.js";