@gearbox-protocol/sdk 13.0.0-next.3 → 13.0.0-next.31

package/dist/esm/sdk/{pools/extraZappers.js → market/ZapperRegister.js}

@@ -1,4 +1,110 @@
-const extraZappers = {
+import { peripheryCompressorAbi } from "../../abi/compressors/peripheryCompressor.js";
+import { SDKConstruct } from "../base/index.js";
+import {
+  AP_PERIPHERY_COMPRESSOR,
+  VERSION_RANGE_310
+} from "../constants/index.js";
+import { AddressMap, hexEq } from "../utils/index.js";
+class ZapperRegister extends 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(
+      AP_PERIPHERY_COMPRESSOR,
+      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: peripheryCompressorAbi,
+          address: pcAddr,
+          functionName: "getZappers",
+          args: [m.configurator.address, m.pool.pool.address]
+        })
+      ),
+      allowFailure: true,
+      batchSize: 0
+    });
+    this.#zappers = new 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) => 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) => hexEq(z.tokenIn.addr, tokenIn) && hexEq(z.tokenOut.addr, tokenOut)
+    );
+    return zappers;
+  }
+}
+const BROKEN_ZAPPERS = new AddressMap(
+  [["0x90D66b03EC4D462e42e3c7741049FB46a4a03B69", true]],
+  "brokenZappers"
+);
+const MIGRATION_ZAPPERS = {
   Mainnet: [
     {
       baseParams: {
@@ -107,6 +213,7 @@ const extraZappers = {
     }
   ]
 };
+const KYC_ZAPPERS = {};
 export {
-  extraZappers
+  ZapperRegister
 };

package/dist/esm/sdk/market/adapters/PlaceholderAdapterContracts.js

@@ -1,9 +1,18 @@
-import { PlaceholderContract } from "../../base/index.js";
+import {
+  MissingSerializedParamsError,
+  PlaceholderContract
+} from "../../base/index.js";
 class PlaceholderAdapterContract extends PlaceholderContract {
-  targetContract;
-  constructor(sdk, args) {
-    super(sdk, args.baseParams);
-    this.targetContract = args.targetContract;
+  #targetContract;
+  constructor(options, args) {
+    super(options, args.baseParams);
+    this.#targetContract = args.targetContract;
+  }
+  get targetContract() {
+    if (!this.#targetContract) {
+      throw new MissingSerializedParamsError("targetContract");
+    }
+    return this.#targetContract;
   }
 }
 export {

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

@@ -1,3 +1,3 @@
-export * from "./factory.js";
+export * from "./createAdapter.js";
 export * from "./PlaceholderAdapterContracts.js";
 export * from "./types.js";

package/dist/esm/sdk/market/credit/CreditFacadeV310BaseContract.js

@@ -0,0 +1,86 @@
+import {
+  iCreditFacadeMulticallV310Abi,
+  iCreditFacadeV310Abi
+} from "../../../abi/310/generated.js";
+import { iPausableAbi } from "../../../abi/iPausable.js";
+import { BaseContract } from "../../base/index.js";
+const abi = [
+  ...iCreditFacadeV310Abi,
+  ...iCreditFacadeMulticallV310Abi,
+  ...iPausableAbi
+];
+class CreditFacadeV310BaseContract extends BaseContract {
+  constructor(options, args) {
+    super(options, { ...args, abi });
+  }
+  parseFunctionParamsV2(params, strict) {
+    switch (params.functionName) {
+      case "openCreditAccount": {
+        const [onBehalfOf, calls, referralCode] = params.args;
+        return {
+          onBehalfOf,
+          calls: this.register.parseMultiCallV2([...calls], strict),
+          referralCode
+        };
+      }
+      case "closeCreditAccount": {
+        const [creditAccount, calls] = params.args;
+        return {
+          creditAccount,
+          calls: this.register.parseMultiCallV2([...calls], strict)
+        };
+      }
+      case "botMulticall":
+      case "multicall": {
+        const [creditAccount, calls] = params.args;
+        return {
+          creditAccount,
+          calls: this.register.parseMultiCallV2([...calls], strict)
+        };
+      }
+      case "liquidateCreditAccount": {
+        const [creditAccount, to, calls] = params.args;
+        return {
+          creditAccount,
+          to,
+          calls: this.register.parseMultiCallV2([...calls], strict)
+        };
+      }
+      default:
+        return super.parseFunctionParamsV2(params, strict);
+    }
+  }
+  stringifyFunctionParams(params) {
+    switch (params.functionName) {
+      case "openCreditAccount": {
+        const [onBehalfOf, calls, referralCode] = params.args;
+        return [
+          this.labelAddress(onBehalfOf),
+          this.register.parseMultiCall([...calls]).join(","),
+          `${referralCode}`
+        ];
+      }
+      case "closeCreditAccount": {
+        const [creditAccount, calls] = params.args;
+        return [
+          this.labelAddress(creditAccount),
+          this.register.parseMultiCall([...calls]).join(",")
+        ];
+      }
+      case "liquidateCreditAccount": {
+        const [creditAccount, to, calls] = params.args;
+        return [
+          this.labelAddress(creditAccount),
+          this.labelAddress(to),
+          this.register.parseMultiCall([...calls]).join(",")
+        ];
+      }
+      default:
+        return super.stringifyFunctionParams(params);
+    }
+  }
+}
+export {
+  CreditFacadeV310BaseContract,
+  abi as creditFacadeV310Abi
+};

package/dist/esm/sdk/market/credit/CreditFacadeV310Contract.js

@@ -1,28 +1,17 @@
-import {
-  iCreditFacadeMulticallV310Abi,
-  iCreditFacadeV310Abi
-} from "../../../abi/310/generated.js";
-import { iPausableAbi } from "../../../abi/iPausable.js";
-import { BaseContract } from "../../base/index.js";
 import { ADDRESS_0X0 } from "../../constants/index.js";
 import {
   fmtBinaryMask,
   formatBNvalue,
   formatTimestamp
 } from "../../utils/index.js";
-const abi = [
-  ...iCreditFacadeV310Abi,
-  ...iCreditFacadeMulticallV310Abi,
-  ...iPausableAbi
-];
-class CreditFacadeV310Contract extends BaseContract {
+import { CreditFacadeV310BaseContract } from "./CreditFacadeV310BaseContract.js";
+class CreditFacadeV310Contract extends CreditFacadeV310BaseContract {
   underlying;
   constructor(options, { creditFacade, creditManager }) {
     const { baseParams, ...rest } = creditFacade;
     super(options, {
       ...baseParams,
-      name: `CreditFacadeV310(${creditManager.name})`,
-      abi
+      name: `CreditFacadeV310(${creditManager.name})`
     });
     Object.assign(this, rest);
     this.underlying = creditManager.underlying;
@@ -89,35 +78,6 @@ class CreditFacadeV310Contract extends BaseContract {
       args: [to, calls, referralCode]
     });
   }
-  stringifyFunctionParams(params) {
-    switch (params.functionName) {
-      case "openCreditAccount": {
-        const [onBehalfOf, calls, referralCode] = params.args;
-        return [
-          this.labelAddress(onBehalfOf),
-          this.register.parseMultiCall([...calls]).join(","),
-          `${referralCode}`
-        ];
-      }
-      case "closeCreditAccount": {
-        const [creditAccount, calls] = params.args;
-        return [
-          this.labelAddress(creditAccount),
-          this.register.parseMultiCall([...calls]).join(",")
-        ];
-      }
-      case "liquidateCreditAccount": {
-        const [creditAccount, to, calls] = params.args;
-        return [
-          this.labelAddress(creditAccount),
-          this.labelAddress(to),
-          this.register.parseMultiCall([...calls]).join(",")
-        ];
-      }
-      default:
-        return super.stringifyFunctionParams(params);
-    }
-  }
 }
 export {
   CreditFacadeV310Contract

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

@@ -1,6 +1,7 @@
 export * from "./CreditConfiguratorV300Contract.js";
 export * from "./CreditConfiguratorV310Contract.js";
 export * from "./CreditFacadeV300Contract.js";
+export * from "./CreditFacadeV310BaseContract.js";
 export * from "./CreditFacadeV310Contract.js";
 export * from "./CreditManagerV300Contract.js";
 export * from "./CreditManagerV310Contract.js";

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

@@ -5,3 +5,4 @@ export * from "./MarketSuite.js";
 export * from "./oracle/index.js";
 export * from "./pool/index.js";
 export * from "./pricefeeds/index.js";
+export * from "./types.js";

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

@@ -55,6 +55,9 @@ 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/PoolV300Contract.js

@@ -28,6 +28,9 @@ class PoolV300Contract extends BaseContract {
       symbol: data.symbol
     });
   }
+  async getKYCFactory() {
+    return void 0;
+  }
   stateHuman(raw = true) {
     return {
       ...super.stateHuman(raw),

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

@@ -7,16 +7,20 @@ import {
   formatBNvalue,
   percentFmt
 } from "../../utils/index.js";
+import { SecuritizeKYCFactory } from "./SecuritizeKYCFactory.js";
 const abi = [...iPoolV310Abi, ...iPausableAbi];
 class PoolV310Contract extends BaseContract {
   creditManagerDebtParams;
-  constructor(options, data) {
+  #sdk;
+  #kycFactory;
+  constructor(sdk, data) {
     const { baseParams, creditManagerDebtParams, ...rest } = data;
-    super(options, {
+    super(sdk, {
       ...data.baseParams,
       name: `PoolV3(${data.name})`,
       abi
     });
+    this.#sdk = sdk;
     Object.assign(this, rest);
     this.creditManagerDebtParams = new AddressMap(
       creditManagerDebtParams.map((p) => [p.creditManager, p])
@@ -28,6 +32,17 @@ 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/SecuritizeKYCFactory.js

@@ -0,0 +1,73 @@
+import { iSecuritizeDegenNFTAbi } from "../../../abi/310/iSecuritizeDegenNFT.js";
+import { iSecuritizeKYCFactoryAbi } from "../../../abi/310/iSecuritizeKYCFactory.js";
+import { BaseContract } from "../../base/index.js";
+import { AddressMap } from "../../index.js";
+const abi = iSecuritizeKYCFactoryAbi;
+class SecuritizeKYCFactory extends BaseContract {
+  investorCache;
+  #degenNFT;
+  constructor(options, address) {
+    super(options, {
+      addr: address,
+      name: "SecuritizeKYCFactory",
+      abi
+    });
+  }
+  async precomputeWalletAddress(creditManager, investor) {
+    return this.contract.read.precomputeWalletAddress([
+      creditManager,
+      investor
+    ]);
+  }
+  async getWallet(creditAccount) {
+    return this.contract.read.getWallet([creditAccount]);
+  }
+  /**
+   * Returns the investor address for a credit account.
+   * @param creditAccount - Credit account address
+   * @param fromCache - If true, use and update an in-memory cache (creditAccount -> investor). On cache miss, loads from contract and stores the result for future calls.
+   */
+  async getInvestor(creditAccount, fromCache) {
+    if (fromCache && this.investorCache?.has(creditAccount)) {
+      return this.investorCache.get(creditAccount);
+    }
+    const investor = await this.contract.read.getInvestor([creditAccount]);
+    if (fromCache) {
+      if (!this.investorCache) {
+        this.investorCache = new AddressMap();
+      }
+      this.investorCache.upsert(creditAccount, investor);
+    }
+    return investor;
+  }
+  async getDSTokens() {
+    const degenNFT = await this.getDegenNFT();
+    const tokens = await this.client.readContract({
+      address: degenNFT,
+      abi: iSecuritizeDegenNFTAbi,
+      functionName: "getDSTokens"
+    });
+    return [...tokens];
+  }
+  multicall(creditAccount, calls, tokensToRegister) {
+    return this.createRawTx({
+      functionName: "multicall",
+      args: [creditAccount, calls, tokensToRegister]
+    });
+  }
+  openCreditAccount(creditManager, calls, tokensToRegister) {
+    return this.createRawTx({
+      functionName: "openCreditAccount",
+      args: [creditManager, calls, tokensToRegister]
+    });
+  }
+  async getDegenNFT() {
+    if (!this.#degenNFT) {
+      this.#degenNFT = await this.contract.read.getDegenNFT();
+    }
+    return this.#degenNFT;
+  }
+}
+export {
+  SecuritizeKYCFactory
+};

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

@@ -3,4 +3,5 @@ export * from "./LinearInterestRateModelContract.js";
 export * from "./PoolQuotaKeeperV300Contract.js";
 export * from "./PoolSuite.js";
 export * from "./PoolV300Contract.js";
+export * from "./SecuritizeKYCFactory.js";
 export * from "./types.js";

package/dist/esm/sdk/market/pricefeeds/PythPriceFeed.js

@@ -1,7 +1,10 @@
-import { decodeAbiParameters } from "viem";
+import { decodeAbiParameters, parseAbi } from "viem";
 import { pythPriceFeedAbi } from "../../abi/oracles.js";
 import { AbstractPriceFeedContract } from "./AbstractPriceFeed.js";
 const abi = pythPriceFeedAbi;
+const iPythAbi = parseAbi([
+  "function getUpdateFee(bytes[] calldata updateData) external view returns (uint256 feeAmount)"
+]);
 class PythPriceFeed extends AbstractPriceFeedContract {
   token;
   priceFeedId;
@@ -48,6 +51,23 @@ class PythPriceFeed extends AbstractPriceFeedContract {
       description: `updating pyth price for ${this.priceFeedId} [${this.labelAddress(this.address)}]`
     });
   }
+  /**
+   * Returns contract function parameters for the getUpdateFee function on original Pyth contract
+   * @param calldata
+   * @returns
+   */
+  getUpdateFeeParams(calldata) {
+    const [, updateData] = decodeAbiParameters(
+      [{ type: "uint256" }, { type: "bytes[]" }],
+      calldata
+    );
+    return {
+      address: this.pyth,
+      abi: iPythAbi,
+      functionName: "getUpdateFee",
+      args: [updateData]
+    };
+  }
 }
 export {
   PythPriceFeed