@gearbox-protocol/sdk 12.8.0 → 13.0.0-next.10

package/dist/cjs/{sdk/pools/PoolServiceV310.js → abi/iStateSerializer.js}

@@ -16,15 +16,21 @@ var __copyProps = (to, from, except, desc) => {
   return to;
 };
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var PoolServiceV310_exports = {};
-__export(PoolServiceV310_exports, {
-  PoolServiceV310: () => PoolServiceV310
+var iStateSerializer_exports = {};
+__export(iStateSerializer_exports, {
+  iStateSerializerAbi: () => iStateSerializerAbi
 });
-module.exports = __toCommonJS(PoolServiceV310_exports);
-var import_AbstractPoolService = require("./AbstractPoolService.js");
-class PoolServiceV310 extends import_AbstractPoolService.AbstractPoolService {
-}
+module.exports = __toCommonJS(iStateSerializer_exports);
+const iStateSerializerAbi = [
+  {
+    type: "function",
+    inputs: [],
+    name: "serialize",
+    outputs: [{ name: "serializedData", internalType: "bytes", type: "bytes" }],
+    stateMutability: "view"
+  }
+];
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  PoolServiceV310
+  iStateSerializerAbi
 });

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

@@ -21,19 +21,21 @@ __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__ = require("../index.js");
 var import_utils = require("../utils/index.js");
 class TokensMeta extends import_utils.AddressMap {
   #client;
-  #phantomTokensLoaded;
+  #tokenDataLoaded = new import_utils.AddressSet();
   constructor(client) {
     super(void 0, "tokensMeta");
     this.#client = client;
   }
   reset() {
     this.clear();
-    this.#phantomTokensLoaded = void 0;
+    this.#tokenDataLoaded.clear();
   }
   symbol(token) {
     return this.mustGet(token).symbol;
@@ -41,28 +43,43 @@ class TokensMeta extends import_utils.AddressMap {
   decimals(token) {
     return this.mustGet(token).decimals;
   }
-  /**
-   * Returns the phantom token type for a given token, or undefined for normal tokens
-   * Throws if the phantom token data is not loaded
-   */
-  phantomTokenType(token) {
-    if (!this.#phantomTokensLoaded?.has(token)) {
-      throw new Error("phantom token data not loaded");
+  isPhantomToken(t) {
+    if (!this.#tokenDataLoaded.has(t.addr)) {
+      throw new Error(
+        `extended token data not loaded for ${t.symbol} (${t.addr})`
+      );
     }
-    return this.mustGet(token).phantomTokenType;
+    return "contractType" in t && t.contractType.startsWith("PHANTOM_TOKEN::");
+  }
+  isKYCUnderlying(t) {
+    if (!this.#tokenDataLoaded.has(t.addr)) {
+      throw new Error(
+        `extended token data not loaded for ${t.symbol} (${t.addr})`
+      );
+    }
+    return "contractType" in t && t.contractType.startsWith("KYC_UNDERLYING::");
   }
   /**
    * Returns a map of all phantom tokens
    * Throws if the phantom token data is not loaded
    */
   get phantomTokens() {
-    if (!this.#phantomTokensLoaded) {
-      throw new Error("phantom tokens not loaded");
+    const result = new import_utils.AddressMap();
+    for (const [token, meta] of this.entries()) {
+      if (this.isPhantomToken(meta)) {
+        result.upsert(token, meta);
+      }
+    }
+    return result;
+  }
+  get kycUnderlyings() {
+    const result = new import_utils.AddressMap();
+    for (const [token, meta] of this.entries()) {
+      if (this.isKYCUnderlying(meta)) {
+        result.upsert(token, meta);
+      }
     }
-    return new import_utils.AddressMap(
-      this.entries().filter(([_, v]) => !!v.phantomTokenType),
-      "phantomTokens"
-    );
+    return result;
   }
   formatBN(arg0, arg1, arg2) {
     const token = typeof arg0 === "object" ? arg0.token : arg0;
@@ -83,30 +100,92 @@ class TokensMeta extends import_utils.AddressMap {
     return meta;
   }
   /**
-   * Loads phantom token data for all known tokens from chain
+   * Loads token information about phantom token and KYC underlying tokens
+   *
+   * @param tokens - tokens to load data for, defaults to all tokens
    */
-  async loadPhantomTokens() {
-    this.#phantomTokensLoaded = new import_utils.AddressSet();
-    const tokens = this.keys();
+  async loadTokenData(...tokens) {
+    const tokenz = new import_utils.AddressSet(tokens.length > 0 ? tokens : this.keys());
+    const tokensToLoad = Array.from(tokenz.difference(this.#tokenDataLoaded));
+    if (tokensToLoad.length === 0) {
+      return;
+    }
     const resp = await this.#client.multicall({
-      contracts: tokens.map(
-        (t) => ({
-          address: t,
-          abi: import_iVersion.iVersionAbi,
-          functionName: "contractType"
-        })
+      contracts: tokensToLoad.flatMap(
+        (t) => [
+          {
+            address: t,
+            abi: import_iVersion.iVersionAbi,
+            functionName: "contractType"
+          },
+          {
+            address: t,
+            abi: import_iStateSerializer.iStateSerializerAbi,
+            functionName: "serialize"
+          }
+        ]
       ),
       allowFailure: true,
       batchSize: 0
     });
-    for (let i = 0; i < resp.length; i++) {
-      if (resp[i].status === "success") {
-        const contractType = (0, import__.bytes32ToString)(resp[i].result);
-        if (contractType.startsWith("PHANTOM_TOKEN::")) {
-          this.mustGet(tokens[i]).phantomTokenType = contractType;
+    for (let i = 0; i < tokensToLoad.length; i++) {
+      this.#overrideTokenMeta(tokensToLoad[i], resp[i], resp[i + 1]);
+      this.#tokenDataLoaded.add(tokensToLoad[i]);
+    }
+  }
+  #overrideTokenMeta(token, contractTypeResp, serializeResp) {
+    const meta = this.mustGet(token);
+    if (contractTypeResp.status === "success") {
+      const contractType = (0, import__.bytes32ToString)(contractTypeResp.result);
+      if (contractType.startsWith("KYC_UNDERLYING::")) {
+        if (serializeResp.status === "success") {
+          this.#overrideKYCUnderlying(meta, contractType, serializeResp.result);
+        } else {
+          throw new Error(
+            `token ${meta.symbol} (${token}) is ${contractType} but serialize failed: ${serializeResp.error}`
+          );
         }
+      } else if (contractType.startsWith("PHANTOM_TOKEN::")) {
+        this.upsert(token, {
+          ...meta,
+          contractType
+        });
       }
-      this.#phantomTokensLoaded.add(tokens[i]);
+    }
+  }
+  #overrideKYCUnderlying(meta, contractType, serialized) {
+    if (contractType === import__.KYC_UNDERLYING_DEFAULT) {
+      const decoded = (0, import_viem.decodeAbiParameters)(
+        [
+          { type: "address", name: "kycFactory" },
+          { type: "address", name: "asset" }
+        ],
+        serialized
+      );
+      this.upsert(meta.addr, {
+        ...meta,
+        contractType,
+        kycFactory: decoded[0],
+        asset: decoded[1]
+      });
+    } else if (contractType === import__.KYC_UNDERLYING_ON_DEMAND) {
+      const decoded = (0, import_viem.decodeAbiParameters)(
+        [
+          { type: "address", name: "kycFactory" },
+          { type: "address", name: "asset" },
+          { type: "address", name: "pool" },
+          { type: "address", name: "liquidityProvider" }
+        ],
+        serialized
+      );
+      this.upsert(meta.addr, {
+        ...meta,
+        contractType,
+        kycFactory: decoded[0],
+        asset: decoded[1],
+        pool: decoded[2],
+        liquidityProvider: decoded[3]
+      });
     }
   }
 }

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

@@ -21,6 +21,7 @@ __reExport(base_exports, require("./Construct.js"), module.exports);
 __reExport(base_exports, require("./PlaceholderContract.js"), module.exports);
 __reExport(base_exports, require("./SDKConstruct.js"), module.exports);
 __reExport(base_exports, require("./TokensMeta.js"), module.exports);
+__reExport(base_exports, require("./token-types.js"), module.exports);
 __reExport(base_exports, require("./types.js"), module.exports);
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
@@ -30,5 +31,6 @@ __reExport(base_exports, require("./types.js"), module.exports);
   ...require("./PlaceholderContract.js"),
   ...require("./SDKConstruct.js"),
   ...require("./TokensMeta.js"),
+  ...require("./token-types.js"),
   ...require("./types.js")
 });

package/dist/cjs/sdk/{constants/phantom-tokens.js → base/token-types.js}

@@ -16,11 +16,13 @@ var __copyProps = (to, from, except, desc) => {
   return to;
 };
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var phantom_tokens_exports = {};
-__export(phantom_tokens_exports, {
+var token_types_exports = {};
+__export(token_types_exports, {
+  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(phantom_tokens_exports);
+module.exports = __toCommonJS(token_types_exports);
 const PHANTOM_TOKEN_CONTRACT_TYPES = [
   "PHANTOM_TOKEN::CONVEX",
   "PHANTOM_TOKEN::INFINIFI_UNWIND",
@@ -30,7 +32,11 @@ 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";
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  KYC_UNDERLYING_DEFAULT,
+  KYC_UNDERLYING_ON_DEMAND,
   PHANTOM_TOKEN_CONTRACT_TYPES
 });

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

@@ -21,7 +21,6 @@ __reExport(constants_exports, require("./bot-permissions.js"), module.exports);
 __reExport(constants_exports, require("./math.js"), module.exports);
 __reExport(constants_exports, require("./networks.js"), module.exports);
 __reExport(constants_exports, require("./periphery.js"), module.exports);
-__reExport(constants_exports, require("./phantom-tokens.js"), module.exports);
 __reExport(constants_exports, require("./versions.js"), module.exports);
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
@@ -31,6 +30,5 @@ __reExport(constants_exports, require("./versions.js"), module.exports);
   ...require("./math.js"),
   ...require("./networks.js"),
   ...require("./periphery.js"),
-  ...require("./phantom-tokens.js"),
   ...require("./versions.js")
 });

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

@@ -22,13 +22,13 @@ __export(MarketRegister_exports, {
 });
 module.exports = __toCommonJS(MarketRegister_exports);
 var import_marketCompressor = require("../../abi/compressors/marketCompressor.js");
-var import_base = require("../base/index.js");
 var import_constants = require("../constants/index.js");
 var import_utils = require("../utils/index.js");
 var import_viem = require("../utils/viem/index.js");
 var import_MarketConfiguratorContract = require("./MarketConfiguratorContract.js");
 var import_MarketSuite = require("./MarketSuite.js");
-class MarketRegister extends import_base.SDKConstruct {
+var import_ZapperRegister = require("./ZapperRegister.js");
+class MarketRegister extends import_ZapperRegister.ZapperRegister {
   /**
    * Mapping pool.address -> MarketSuite
    */

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

@@ -62,6 +62,9 @@ class MarketSuite extends import_base.SDKConstruct {
     this.priceOracle = (0, import_oracle.getOrCreatePriceOracle)(sdk, marketData.priceOracle);
     this.lossPolicy = (0, import_loss_policy.createLossPolicy)(sdk, marketData.lossPolicy);
   }
+  get underlying() {
+    return this.pool.underlying;
+  }
   get dirty() {
     return this.configurator.dirty || this.pool.dirty || this.priceOracle.dirty || this.creditManagers.some((cm) => cm.dirty);
   }

package/dist/cjs/{plugins/zappers/extraZappers.js → sdk/market/ZapperRegister.js}

@@ -16,12 +16,115 @@ var __copyProps = (to, from, except, desc) => {
   return to;
 };
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var extraZappers_exports = {};
-__export(extraZappers_exports, {
-  extraZappers: () => extraZappers
+var ZapperRegister_exports = {};
+__export(ZapperRegister_exports, {
+  ZapperRegister: () => ZapperRegister
 });
-module.exports = __toCommonJS(extraZappers_exports);
-const extraZappers = {
+module.exports = __toCommonJS(ZapperRegister_exports);
+var import_peripheryCompressor = require("../../abi/compressors/peripheryCompressor.js");
+var import_base = require("../base/index.js");
+var import_constants = require("../constants/index.js");
+var import_utils = require("../utils/index.js");
+class ZapperRegister extends import_base.SDKConstruct {
+  /**
+   * Mapping pool.address -> ZapperData[]
+   * Needs to be loaded explicitly using loadZappers method
+   */
+  #zappers;
+  /**
+   * Load zappers for all pools using periphery compressor, adds hardcoded zappers
+   */
+  async loadZappers(force) {
+    if (!force && this.#zappers) {
+      return;
+    }
+    const [pcAddr] = this.sdk.addressProvider.mustGetLatest(
+      import_constants.AP_PERIPHERY_COMPRESSOR,
+      import_constants.VERSION_RANGE_310
+    );
+    this.logger?.debug(`loading zappers with periphery compressor ${pcAddr}`);
+    const markets = this.sdk.marketRegister.markets;
+    const resp = await this.client.multicall({
+      contracts: markets.map(
+        (m) => ({
+          abi: import_peripheryCompressor.peripheryCompressorAbi,
+          address: pcAddr,
+          functionName: "getZappers",
+          args: [m.configurator.address, m.pool.pool.address]
+        })
+      ),
+      allowFailure: true,
+      batchSize: 0
+    });
+    this.#zappers = new import_utils.AddressMap(void 0, "zappers");
+    for (let i = 0; i < resp.length; i++) {
+      const { status, result, error } = resp[i];
+      const marketConfigurator = markets[i].configurator.address;
+      const pool = markets[i].pool.pool.address;
+      if (status === "success") {
+        for (const z of result) {
+          this.#addZapper({ ...z, pool, type: "base" });
+        }
+      } else {
+        this.logger?.error(
+          `failed to load zapper for market configurator ${this.labelAddress(
+            marketConfigurator
+          )} and pool ${this.labelAddress(pool)}: ${error}`
+        );
+      }
+    }
+    for (const z of KYC_ZAPPERS[this.networkType] ?? []) {
+      this.#addZapper({ ...z, type: "kyc" });
+    }
+    for (const z of MIGRATION_ZAPPERS[this.networkType] ?? []) {
+      this.#addZapper({ ...z, type: "migration" });
+    }
+  }
+  #addZapper(z) {
+    if (BROKEN_ZAPPERS.has(z.baseParams.addr)) {
+      return;
+    }
+    const existing = this.zappers.get(z.pool);
+    if (existing) {
+      const hasZapper = existing.some(
+        (zz) => (0, import_utils.hexEq)(zz.baseParams.addr, z.baseParams.addr)
+      );
+      if (!hasZapper) {
+        existing.push(z);
+      }
+    } else {
+      this.zappers.upsert(z.pool, [z]);
+    }
+    const zappersTokens = [z.tokenIn, z.tokenOut];
+    for (const t of zappersTokens) {
+      this.sdk.tokensMeta.upsert(t.addr, t);
+      this.sdk.setAddressLabel(t.addr, t.symbol);
+    }
+  }
+  get zappers() {
+    if (!this.#zappers) {
+      throw new Error("zappers not loaded, call loadZappers first");
+    }
+    return this.#zappers;
+  }
+  poolZappers(pool) {
+    return this.zappers.get(pool) ?? [];
+  }
+  /**
+   * Can return multiple zappers if there are multiple zappers for the same tokenIn and tokenOut
+   */
+  getZapper(pool, tokenIn, tokenOut) {
+    const zappers = this.zappers.get(pool)?.filter(
+      (z) => (0, import_utils.hexEq)(z.tokenIn.addr, tokenIn) && (0, import_utils.hexEq)(z.tokenOut.addr, tokenOut)
+    );
+    return zappers;
+  }
+}
+const BROKEN_ZAPPERS = new import_utils.AddressMap(
+  [["0x90D66b03EC4D462e42e3c7741049FB46a4a03B69", true]],
+  "brokenZappers"
+);
+const MIGRATION_ZAPPERS = {
   Mainnet: [
     {
       baseParams: {
@@ -130,7 +233,8 @@ const extraZappers = {
     }
   ]
 };
+const KYC_ZAPPERS = {};
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  extraZappers
+  ZapperRegister
 });

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

@@ -22,6 +22,7 @@ __reExport(market_exports, require("./MarketSuite.js"), module.exports);
 __reExport(market_exports, require("./oracle/index.js"), module.exports);
 __reExport(market_exports, require("./pool/index.js"), module.exports);
 __reExport(market_exports, require("./pricefeeds/index.js"), module.exports);
+__reExport(market_exports, require("./types.js"), module.exports);
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   ...require("./adapters/index.js"),
@@ -30,5 +31,6 @@ __reExport(market_exports, require("./pricefeeds/index.js"), module.exports);
   ...require("./MarketSuite.js"),
   ...require("./oracle/index.js"),
   ...require("./pool/index.js"),
-  ...require("./pricefeeds/index.js")
+  ...require("./pricefeeds/index.js"),
+  ...require("./types.js")
 });