@gearbox-protocol/sdk 13.5.0-next.1 → 13.5.0-next.2

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

@@ -1,9 +1,6 @@
 import {
-  decodeAbiParameters,
   erc20Abi
 } from "viem";
-import { iSecuritizeDegenNFTAbi } from "../../abi/310/iSecuritizeDegenNFT.js";
-import { iSecuritizeKYCFactoryAbi } from "../../abi/310/iSecuritizeKYCFactory.js";
 import { iStateSerializerAbi } from "../../abi/iStateSerializer.js";
 import { iVersionAbi } from "../../abi/iVersion.js";
 import {
@@ -12,10 +9,6 @@ import {
   bytes32ToString,
   formatBN
 } from "../utils/index.js";
-import {
-  KYC_UNDERLYING_DEFAULT,
-  KYC_UNDERLYING_ON_DEMAND
-} from "./token-types.js";
 class TokensMeta extends AddressMap {
   #client;
   #tokenDataLoaded = new AddressSet();
@@ -72,32 +65,6 @@ 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) {
-    if (!this.#tokenDataLoaded.has(t.addr)) {
-      throw new Error(
-        `extended token data not loaded for ${t.symbol} (${t.addr})`
-      );
-    }
-    return !!t.contractType?.startsWith("KYC_UNDERLYING::");
-  }
-  /**
-   * Returns true if the token is a DSToken, throws if the token data is not loaded
-   * @param t
-   * @returns
-   */
-  isDSToken(t) {
-    if (!this.#tokenDataLoaded.has(t.addr)) {
-      throw new Error(
-        `extended token data not loaded for ${t.symbol} (${t.addr})`
-      );
-    }
-    return !!t.isDSToken;
-  }
   /**
    * Returns a map of all phantom tokens
    * Throws if token data is not loaded
@@ -111,28 +78,6 @@ 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;
-  }
-  get dsTokens() {
-    const result = new AddressMap();
-    for (const [token, meta] of this.entries()) {
-      if (this.isDSToken(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;
@@ -162,7 +107,8 @@ class TokensMeta extends AddressMap {
     return meta;
   }
   /**
-   * Loads token information about phantom tokens, KYC underlying tokens and DSTokens
+   * Loads token information about phantom tokens
+   * Other special tokens may be loaded here in the future
    *
    * @param tokens - tokens to load data for, defaults to all tokens
    */
@@ -191,116 +137,22 @@ class TokensMeta extends AddressMap {
       batchSize: 0
     });
     this.#logger?.debug(`loaded ${resp.length} contract types`);
-    const kycFactories = new AddressSet();
     for (let i = 0; i < tokensToLoad.length; i++) {
-      const meta = this.#overrideTokenMeta(
-        tokensToLoad[i],
-        resp[2 * i],
-        resp[2 * i + 1]
-      );
+      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`);
-    await this.#loadDSTokens(kycFactories);
   }
-  #overrideTokenMeta(token, contractTypeResp, serializeResp) {
+  #overrideTokenMeta(token, contractTypeResp, _serializeResp) {
     const meta = this.mustGet(token);
     if (contractTypeResp.status === "success") {
       const contractType = 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 {
-        this.upsert(token, {
-          ...meta,
-          contractType
-        });
-      }
-      this.#logger?.debug(`token ${meta.symbol} is ${contractType}`);
-    }
-    return this.mustGet(token);
-  }
-  #overrideKYCUnderlying(meta, contractType, serialized) {
-    if (contractType === KYC_UNDERLYING_DEFAULT) {
-      const decoded = 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 === KYC_UNDERLYING_ON_DEMAND) {
-      const decoded = 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]
-      });
-    }
-  }
-  async #loadDSTokens(kycFactories) {
-    const degenNFTs = await this.#client.multicall({
-      contracts: kycFactories.map((address) => {
-        return {
-          address,
-          abi: iSecuritizeKYCFactoryAbi,
-          functionName: "getDegenNFT"
-        };
-      }),
-      allowFailure: false,
-      batchSize: 0
-    });
-    const resp = await this.#client.multicall({
-      contracts: degenNFTs.map((address) => {
-        return {
-          address,
-          abi: iSecuritizeDegenNFTAbi,
-          functionName: "getDSTokens"
-        };
-      }),
-      allowFailure: false,
-      batchSize: 0
-    });
-    const dsToken = new AddressSet(resp.flat());
-    const tokensToLoad = dsToken.difference(new Set(this.keys()));
-    this.#logger?.debug(
-      `found ${dsToken.size} DSTokens in KYC factories, need to load ${tokensToLoad.size} basic metadata`
-    );
-    await this.#loadWithoutCompressor(tokensToLoad);
-    for (const token of dsToken) {
-      const meta = this.mustGet(token);
       this.upsert(token, {
         ...meta,
-        isDSToken: true
+        contractType
       });
-      this.#tokenDataLoaded.add(token);
-      this.#logger?.debug(`token ${meta.symbol} (${token}) is a DSToken`);
+      this.#logger?.debug(`token ${meta.symbol} is ${contractType}`);
     }
+    return this.mustGet(token);
   }
   async #loadWithoutCompressor(tokens_) {
     if (tokens_.size === 0) {

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

@@ -7,10 +7,6 @@ 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";
 export {
-  KYC_UNDERLYING_DEFAULT,
-  KYC_UNDERLYING_ON_DEMAND,
   PHANTOM_TOKEN_CONTRACT_TYPES
 };

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

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

package/dist/esm/sdk/constants/addresses.js

@@ -1,8 +1,10 @@
 const MULTICALL_ADDRESS = "0xcA11bde05977b3631167028862bE2a173976CA11";
 const ADDRESS_0X0 = "0x0000000000000000000000000000000000000000";
 const NOT_DEPLOYED = "0xNOT DEPLOYED";
+const NATIVE_ADDRESS = "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE";
 export {
   ADDRESS_0X0,
   MULTICALL_ADDRESS,
+  NATIVE_ADDRESS,
   NOT_DEPLOYED
 };

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

@@ -10,9 +10,6 @@ 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(

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

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

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

@@ -53,9 +53,6 @@ class ZapperRegister extends SDKConstruct {
         );
       }
     }
-    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" });
     }
@@ -213,7 +210,6 @@ const MIGRATION_ZAPPERS = {
     }
   ]
 };
-const KYC_ZAPPERS = {};
 export {
   ZapperRegister
 };

package/dist/esm/sdk/market/pool/PoolSuite.js

@@ -55,9 +55,6 @@ class PoolSuite extends SDKConstruct {
   get underlying() {
     return this.pool.underlying;
   }
-  async getKYCFactory() {
-    return this.pool.getKYCFactory();
-  }
   get dirty() {
     return this.pool.dirty || this.rateKeeper.dirty || this.pqk.dirty || this.interestRateModel.dirty;
   }

package/dist/esm/sdk/market/pool/PoolV310Contract.js

@@ -7,20 +7,16 @@ import {
   formatBNvalue,
   percentFmt
 } from "../../utils/index.js";
-import { SecuritizeKYCFactory } from "./SecuritizeKYCFactory.js";
 const abi = [...iPoolV310Abi, ...iPausableAbi];
 class PoolV310Contract extends BaseContract {
   creditManagerDebtParams;
-  #sdk;
-  #kycFactory;
-  constructor(sdk, data) {
+  constructor(options, data) {
     const { baseParams, creditManagerDebtParams, ...rest } = data;
-    super(sdk, {
+    super(options, {
       ...data.baseParams,
       name: `PoolV3(${data.name})`,
       abi
     });
-    this.#sdk = sdk;
     Object.assign(this, rest);
     this.creditManagerDebtParams = new AddressMap(
       creditManagerDebtParams.map((p) => [p.creditManager, p])
@@ -32,17 +28,6 @@ class PoolV310Contract extends BaseContract {
       symbol: data.symbol
     });
   }
-  async getKYCFactory() {
-    if (this.#kycFactory) {
-      return this.#kycFactory;
-    }
-    await this.#sdk.tokensMeta.loadTokenData(this.underlying);
-    const u = this.#sdk.tokensMeta.mustGet(this.underlying);
-    if (this.#sdk.tokensMeta.isKYCUnderlying(u)) {
-      this.#kycFactory = new SecuritizeKYCFactory(this.#sdk, u.kycFactory);
-    }
-    return this.#kycFactory;
-  }
   stateHuman(raw = true) {
     return {
       ...super.stateHuman(raw),

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

@@ -1,6 +1,4 @@
 export * from "./GaugeContract.js";
 export * from "./LinearInterestRateModelContract.js";
 export * from "./PoolSuite.js";
-export * from "./PoolV310Contract.js";
-export * from "./SecuritizeKYCFactory.js";
 export * from "./types.js";

package/dist/esm/sdk/pools/PoolService.js

@@ -1,82 +1,35 @@
 import { iPoolV310Abi } from "../../abi/310/generated.js";
-import { ierc20Abi } from "../../abi/iERC20.js";
 import { ierc20ZapperDepositsAbi } from "../../abi/iERC20ZapperDeposits.js";
 import { iethZapperDepositsAbi } from "../../abi/iETHZapperDeposits.js";
 import { iZapperAbi } from "../../abi/iZapper.js";
-import {
-  KYC_UNDERLYING_DEFAULT,
-  KYC_UNDERLYING_ON_DEMAND,
-  SDKConstruct
-} from "../base/index.js";
-import { AddressSet, hexEq } from "../index.js";
-import { AddressMap } from "../utils/index.js";
-const NATIVE_ADDRESS = "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE";
-const POOL_TOKENS_TO_MIGRATE = new AddressMap([
-  // v2 diesels
-  ["0x6CFaF95457d7688022FC53e7AbE052ef8DFBbdBA", "dDAI"],
-  ["0xc411dB5f5Eb3f7d552F9B8454B2D74097ccdE6E3", "dUSDC"],
-  ["0xe753260F1955e8678DCeA8887759e07aa57E8c54", "dWBTC"],
-  ["0xF21fc650C1B34eb0FDE786D52d23dA99Db3D6278", "dWETH"],
-  ["0x2158034dB06f06dcB9A786D2F1F8c38781bA779d", "dwstETH"],
-  ["0x8A1112AFef7F4FC7c066a77AABBc01b3Fff31D47", "dFRAX"]
-]);
+import { SDKConstruct } from "../base/index.js";
+import { NATIVE_ADDRESS } from "../constants/index.js";
+import { AddressSet, hexEq } from "../utils/index.js";
+import { POOL_TOKENS_TO_MIGRATE } from "./constants.js";
 class PoolService extends SDKConstruct {
+  /**
+   * @inheritdoc IPoolsService.getDepositTokensIn
+   */
   getDepositTokensIn(pool) {
-    const underlying = this.#describeUnderlying(pool);
-    if (this.sdk.tokensMeta.isKYCUnderlying(underlying)) {
-      switch (underlying.contractType) {
-        case KYC_UNDERLYING_DEFAULT:
-          return this.#depositTokensIn(pool, false);
-        case KYC_UNDERLYING_ON_DEMAND:
-          return [underlying.asset];
-      }
-    }
     return this.#depositTokensIn(pool, true);
   }
+  /**
+   * @inheritdoc IPoolsService.getDepositTokensOut
+   */
   getDepositTokensOut(pool, tokenIn) {
-    const underlying = this.#describeUnderlying(pool);
-    if (this.sdk.tokensMeta.isKYCUnderlying(underlying)) {
-      switch (underlying.contractType) {
-        case KYC_UNDERLYING_DEFAULT:
-          return this.#depositTokensOut(pool, tokenIn, false);
-        case KYC_UNDERLYING_ON_DEMAND:
-          return [];
-      }
-    }
     return this.#depositTokensOut(pool, tokenIn, true);
   }
+  /**
+   * @inheritdoc IPoolsService.getDepositMetadata
+   */
   getDepositMetadata(pool, tokenIn, tokenOut) {
-    const underlying = this.#describeUnderlying(pool);
-    if (this.sdk.tokensMeta.isKYCUnderlying(underlying)) {
-      switch (underlying.contractType) {
-        case KYC_UNDERLYING_DEFAULT: {
-          return this.#depositMetadata(
-            "kyc-default",
-            pool,
-            tokenIn,
-            tokenOut,
-            false
-          );
-        }
-        case KYC_UNDERLYING_ON_DEMAND:
-          return {
-            zapper: void 0,
-            approveTarget: underlying.liquidityProvider,
-            permissible: false,
-            type: "kyc-on-demand"
-          };
-      }
-    }
     return this.#depositMetadata("classic", pool, tokenIn, tokenOut, true);
   }
+  /**
+   * @inheritdoc IPoolsService.addLiquidity
+   */
   addLiquidity(props) {
     const { collateral, meta, permit, referralCode, pool, wallet } = props;
-    const underlying = this.#describeUnderlying(pool);
-    if (this.sdk.tokensMeta.isKYCUnderlying(underlying)) {
-      if (underlying.contractType === KYC_UNDERLYING_ON_DEMAND) {
-        return void 0;
-      }
-    }
     const { zapper } = meta;
     if (zapper && hexEq(zapper.tokenIn.addr, NATIVE_ADDRESS)) {
       return {
@@ -115,43 +68,23 @@ class PoolService extends SDKConstruct {
       };
     }
   }
+  /**
+   * @inheritdoc IPoolsService.getWithdrawalTokensIn
+   */
   getWithdrawalTokensIn(pool) {
-    const underlying = this.#describeUnderlying(pool);
-    if (this.sdk.tokensMeta.isKYCUnderlying(underlying)) {
-      switch (underlying.contractType) {
-        case KYC_UNDERLYING_DEFAULT:
-          return this.#withdrawalTokensIn(pool, false);
-        case KYC_UNDERLYING_ON_DEMAND:
-          return [];
-      }
-    }
     return this.#withdrawalTokensIn(pool, true);
   }
+  /**
+   * @inheritdoc IPoolsService.getWithdrawalTokensOut
+   */
   getWithdrawalTokensOut(pool, tokenIn) {
-    const underlying = this.#describeUnderlying(pool);
-    if (this.sdk.tokensMeta.isKYCUnderlying(underlying)) {
-      switch (underlying.contractType) {
-        case KYC_UNDERLYING_DEFAULT:
-          return this.#withdrawalTokensOut(pool, tokenIn, false);
-        case KYC_UNDERLYING_ON_DEMAND:
-          return [underlying.asset];
-      }
-    }
     return this.#withdrawalTokensOut(pool, tokenIn, true);
   }
+  /**
+   * @inheritdoc IPoolsService.removeLiquidity
+   */
   removeLiquidity(props) {
     const { pool, amount, meta, wallet, permit } = props;
-    const underlying = this.#describeUnderlying(pool);
-    if (this.sdk.tokensMeta.isKYCUnderlying(underlying)) {
-      if (underlying.contractType === KYC_UNDERLYING_ON_DEMAND) {
-        return {
-          abi: ierc20Abi,
-          functionName: "approve",
-          args: [underlying.liquidityProvider, 0n],
-          target: underlying.asset
-        };
-      }
-    }
     if (meta.zapper) {
       return permit ? {
         target: meta.zapper.baseParams.addr,
@@ -179,31 +112,14 @@ class PoolService extends SDKConstruct {
       args: [amount, wallet, wallet]
     };
   }
+  /**
+   * @inheritdoc IPoolsService.getWithdrawalMetadata
+   */
   getWithdrawalMetadata(pool, tokenIn, tokenOut) {
-    const underlying = this.#describeUnderlying(pool);
-    if (this.sdk.tokensMeta.isKYCUnderlying(underlying)) {
-      switch (underlying.contractType) {
-        case KYC_UNDERLYING_DEFAULT: {
-          return this.#withdrawalMetadata(
-            "kyc-default",
-            pool,
-            tokenIn,
-            tokenOut,
-            false
-          );
-        }
-        case KYC_UNDERLYING_ON_DEMAND:
-          return {
-            zapper: void 0,
-            approveTarget: void 0,
-            permissible: false,
-            type: "kyc-on-demand"
-          };
-      }
-    }
     return this.#withdrawalMetadata("classic", pool, tokenIn, tokenOut, true);
   }
   /**
+   * TODO: do we still need this after v3.0 deprecation?
    * Filter out v2 diesel tokens (can come from migration v2 -> v3 zappers)
    * Also omits "migration" zappers (v3 -> v3.1) since they are treated in a different way
    */
@@ -294,6 +210,7 @@ class PoolService extends SDKConstruct {
     return r;
   }
   /**
+   * TODO: do we still need this after v3.0 deprecation?
    * Filter out v2 diesel tokens (can come from migration v2 -> v3 zappers)
    * Also omits "migration" zappers (v3 -> v3.1) since they are treated in a different way
    */
@@ -331,7 +248,7 @@ class PoolService extends SDKConstruct {
       zapper,
       // zapper or pool itself
       approveTarget: zapper?.baseParams.addr ?? pool.pool.address,
-      // TODO: instead of permissible, return permitType зависимости от tokenIn
+      // TODO: instead of permissible, return permitType depending on tokenIn
       // "none" | "eip2612" | "dai_like";
       permissible: !!zapper && !hexEq(tokenIn, NATIVE_ADDRESS),
       type
@@ -355,7 +272,7 @@ class PoolService extends SDKConstruct {
       zapper,
       // zapper or pool itself
       approveTarget: zapper?.baseParams.addr,
-      // TODO: instead of permissible, return permitType зависимости от tokenIn
+      // TODO: instead of permissible, return permitType depending on tokenIn
       // "none" | "eip2612" | "dai_like";
       permissible: !!zapper,
       type

package/dist/esm/sdk/pools/constants.js

@@ -0,0 +1,13 @@
+import { AddressMap } from "../utils/index.js";
+const POOL_TOKENS_TO_MIGRATE = new AddressMap([
+  // v2 diesels
+  ["0x6CFaF95457d7688022FC53e7AbE052ef8DFBbdBA", "dDAI"],
+  ["0xc411dB5f5Eb3f7d552F9B8454B2D74097ccdE6E3", "dUSDC"],
+  ["0xe753260F1955e8678DCeA8887759e07aa57E8c54", "dWBTC"],
+  ["0xF21fc650C1B34eb0FDE786D52d23dA99Db3D6278", "dWETH"],
+  ["0x2158034dB06f06dcB9A786D2F1F8c38781bA779d", "dwstETH"],
+  ["0x8A1112AFef7F4FC7c066a77AABBc01b3Fff31D47", "dFRAX"]
+]);
+export {
+  POOL_TOKENS_TO_MIGRATE
+};