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

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

package/dist/esm/sdk/market/kyc/KYCRegistry.js

@@ -0,0 +1,253 @@
+import { decodeAbiParameters } from "viem";
+import { iKYCCompressorAbi } from "../../../abi/kyc/iKYCCompressor.js";
+import {
+  KYC_ON_DEMAND_LP_MONOPOLIZED,
+  KYC_UNDERLYING_DEFAULT,
+  KYC_UNDERLYING_ON_DEMAND,
+  SDKConstruct
+} from "../../base/index.js";
+import { AP_KYC_COMPRESSOR, VERSION_RANGE_310 } from "../../constants/index.js";
+import { AddressMap, bytes32ToString } from "../../utils/index.js";
+import {
+  KYC_FACTORY_SECURITIZE,
+  SecuritizeKYCFactory
+} from "./securitize/index.js";
+class KYCRegistry extends SDKConstruct {
+  #state;
+  #factories = new AddressMap();
+  /**
+   * @internal
+   *
+   * Returns delegated multicalls for loading all KYC underlying tokens from the on-chain KYC compressor.
+   * Used by the SDK to compose batched RPC calls.
+   *
+   * @param configurators - Market configurators to query.
+   * @param kycFactories - KYC factory contracts to query.
+   */
+  getLoadMulticalls(configurators, kycFactories = []) {
+    if (!kycFactories.length) return [];
+    const [kycCompressorAddress] = this.sdk.addressProvider.mustGetLatest(
+      AP_KYC_COMPRESSOR,
+      VERSION_RANGE_310
+    );
+    return [
+      {
+        call: {
+          abi: iKYCCompressorAbi,
+          address: kycCompressorAddress,
+          functionName: "getKYCMarketsData",
+          args: [configurators, kycFactories]
+        },
+        onResult: (resp) => this.setState(resp)
+      }
+    ];
+  }
+  /**
+   * Fetches decoded investor data from the on-chain KYC compressor.
+   *
+   * Each factory produces its own investor data (e.g. registered tokens,
+   * cached signatures, EIP-712 messages to sign).
+   *
+   * @param investor - Investor EOA address.
+   * @param factories_ - Optional subset of factory addresses to query.
+   *   When omitted, all loaded factories are used.
+   */
+  async getInvestorData(investor, factories_) {
+    const [kycCompressorAddress] = this.sdk.addressProvider.mustGetLatest(
+      AP_KYC_COMPRESSOR,
+      VERSION_RANGE_310
+    );
+    let factories = this.#factories.values();
+    if (factories_?.length) {
+      factories = factories_.map((f) => this.#factories.mustGet(f));
+    }
+    const resp = await this.client.readContract({
+      abi: iKYCCompressorAbi,
+      address: kycCompressorAddress,
+      functionName: "getKYCInvestorData",
+      args: [investor, factories.map((f) => f.address)]
+    });
+    const result = [];
+    for (let i = 0; i < factories.length; i++) {
+      const factory = factories[i];
+      const factoryData = resp[i];
+      const investorData = factory.decodeInvestorData(factoryData);
+      result.push(investorData);
+    }
+    return result;
+  }
+  /** All loaded KYC factory instances. */
+  get factories() {
+    return this.#factories.values();
+  }
+  /** Raw KYC compressor response, or `undefined` before attach/hydrate. */
+  get state() {
+    return this.#state;
+  }
+  /**
+   * Returns a human-readable snapshot of the KYC state.
+   */
+  stateHuman(raw) {
+    return {
+      factories: this.factories.map((f) => f.stateHuman(raw))
+    };
+  }
+  /**
+   * @internal
+   *
+   * Replaces the internal state with a new KYC compressor response.
+   * Rebuilds token metadata for KYC underlyings and re-instantiates factory
+   * wrappers.
+   */
+  setState(resp) {
+    this.#state = resp;
+    for (const u of resp?.[0] ?? []) {
+      this.#loadUnderlyingTokenData(u);
+    }
+    this.#factories.clear();
+    for (const f of resp?.[1] ?? []) {
+      this.#loadKYCFactoryData(f);
+    }
+  }
+  #loadUnderlyingTokenData(u) {
+    const contractType = bytes32ToString(u.baseParams.contractType);
+    const meta = this.tokensMeta.get(u.baseParams.addr);
+    if (!meta) {
+      throw new Error(
+        `KYC underlying token ${contractType} (${u.baseParams.addr}) not found in tokensMeta`
+      );
+    }
+    switch (contractType) {
+      case KYC_UNDERLYING_DEFAULT:
+        this.#loadKYCUnderlyingDefault(meta, u);
+        break;
+      case KYC_UNDERLYING_ON_DEMAND:
+        this.#loadKYCUnderlyingOnDemand(meta, u);
+        break;
+      default:
+        if (this.sdk.strictContractTypes) {
+          throw new Error(`Unknown KYC underlying type: ${contractType}`);
+        }
+        this.logger?.warn(`unknown KYC underlying type: ${contractType}`);
+    }
+  }
+  #loadKYCUnderlyingDefault(meta, data) {
+    const decoded = decodeAbiParameters(
+      [
+        { name: "factory", type: "address" },
+        { name: "asset", type: "address" }
+      ],
+      data.baseParams.serializedParams
+    );
+    this.tokensMeta.upsert(data.baseParams.addr, {
+      ...meta,
+      contractType: KYC_UNDERLYING_DEFAULT,
+      kycFactory: decoded[0],
+      asset: decoded[1]
+    });
+  }
+  #loadKYCUnderlyingOnDemand(meta, data) {
+    const decoded = decodeAbiParameters(
+      [
+        { name: "factory", type: "address" },
+        { name: "asset", type: "address" },
+        { name: "pool", type: "address" },
+        { name: "liquidityProvider", type: "address" },
+        { name: "marketConfigurator", type: "address" },
+        { name: "allowedDepositors", type: "address[]" }
+      ],
+      data.baseParams.serializedParams
+    );
+    const lpMeta = this.#getOnDemandLPMeta(data.extraDetails);
+    if (decoded[3] !== lpMeta.addr) {
+      throw new Error(
+        `Liquidity provider mismatch: ${decoded[3]} !== ${lpMeta.addr} for on-demand underlying ${data.baseParams.addr}`
+      );
+    }
+    this.tokensMeta.upsert(data.baseParams.addr, {
+      ...meta,
+      contractType: KYC_UNDERLYING_ON_DEMAND,
+      kycFactory: decoded[0],
+      asset: decoded[1],
+      pool: decoded[2],
+      marketConfigurator: decoded[4],
+      allowedDepositors: decoded[5],
+      // liquidityProvider: decoded[3],
+      liquidityProvider: lpMeta
+    });
+  }
+  #getOnDemandLPMeta(extraDetails) {
+    const [decoded] = decodeAbiParameters(
+      [
+        {
+          name: "baseParams",
+          type: "tuple",
+          components: [
+            { name: "addr", type: "address" },
+            { name: "version", type: "uint256" },
+            { name: "contractType", type: "bytes32" },
+            { name: "serializedParams", type: "bytes" }
+          ]
+        }
+      ],
+      extraDetails
+    );
+    const contractType = bytes32ToString(decoded.contractType);
+    switch (contractType) {
+      case KYC_ON_DEMAND_LP_MONOPOLIZED:
+        return this.#getOnDemandLPMonopolizedMeta(
+          decoded.addr,
+          decoded.version,
+          decoded.serializedParams
+        );
+      default:
+        throw new Error(`Unknown on-demand LP contract type: ${contractType}`);
+    }
+  }
+  #getOnDemandLPMonopolizedMeta(addr, version, serializedParams) {
+    const [marketConfigurator, depositor, pools] = decodeAbiParameters(
+      [
+        { name: "marketConfigurator", type: "address" },
+        { name: "depositor", type: "address" },
+        {
+          name: "pools",
+          type: "tuple[]",
+          components: [
+            { name: "pool", type: "address" },
+            { name: "wrappedUnderlying", type: "address" },
+            { name: "unwrappedUnderlying", type: "address" },
+            { name: "depositAllowance", type: "uint256" },
+            { name: "claimableAmount", type: "uint256" }
+          ]
+        }
+      ],
+      serializedParams
+    );
+    return {
+      addr,
+      version,
+      contractType: KYC_ON_DEMAND_LP_MONOPOLIZED,
+      marketConfigurator,
+      depositor,
+      pools: [...pools]
+    };
+  }
+  #loadKYCFactoryData(data) {
+    const contractType = bytes32ToString(data.baseParams.contractType);
+    switch (contractType) {
+      case KYC_FACTORY_SECURITIZE:
+        this.#factories.upsert(
+          data.baseParams.addr,
+          new SecuritizeKYCFactory(this.sdk, data)
+        );
+        break;
+      default:
+        throw new Error(
+          `Unknown KYC factory type: ${contractType} for ${data.baseParams.addr}`
+        );
+    }
+  }
+}
+export {
+  KYCRegistry
+};

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

@@ -0,0 +1,3 @@
+export * from "./KYCRegistry.js";
+export * from "./securitize/index.js";
+export * from "./types.js";