@gearbox-protocol/sdk 3.0.0-vfour.310 → 3.0.0-vfour.312

package/dist/cjs/sdk/market/pricefeeds/PriceFeedsRegister.js

@@ -27,6 +27,7 @@ var import_base = require("../../base/index.js");
 var import_constants = require("../../constants/index.js");
 var import_utils = require("../../utils/index.js");
 var import_internal = require("../../utils/internal/index.js");
+var import_AbstractPriceFeed = require("./AbstractPriceFeed.js");
 var import_BalancerStablePriceFeed = require("./BalancerStablePriceFeed.js");
 var import_BalancerWeightedPriceFeed = require("./BalancerWeightedPriceFeed.js");
 var import_BoundedPriceFeed = require("./BoundedPriceFeed.js");
@@ -78,35 +79,55 @@ class PriceFeedRegister extends import_base.SDKConstruct {
       return existing;
     }
     const feed = this.create(data);
+    if (!feed.loaded) {
+      throw new import_AbstractPriceFeed.PartialPriceFeedInitError({ ...data, abi: [], name: "" });
+    }
     this.#feeds.upsert(data.baseParams.addr, feed);
     return feed;
   }
   /**
    * Loads PARTIAL information about all updatable price feeds from MarketCompressor
-   * This can later be used to load price feed updates
+   * This is not saved anywhere in PriceFeedRegister, and can later be used to load price feed updates
    */
-  async preloadUpdatablePriceFeeds(marketConfigurators, pools) {
-    const feedsData = await this.#loadUpdatablePriceFeeds(
-      marketConfigurators,
-      pools
+  async getPartialUpdatablePriceFeeds(marketConfigurators, pools) {
+    const marketCompressorAddress = this.sdk.addressProvider.getAddress(
+      import_constants.AP_MARKET_COMPRESSOR,
+      310
     );
-    for (const data of feedsData) {
-      const feed = this.create({ baseParams: data });
-      this.#feeds.upsert(feed.address, feed);
-    }
+    const configurators = marketConfigurators ?? this.sdk.marketRegister.marketConfigurators.map((mc) => mc.address);
+    this.logger?.debug(
+      { configurators, pools },
+      "calling getUpdatablePriceFeeds"
+    );
+    const result = await this.provider.publicClient.readContract({
+      address: marketCompressorAddress,
+      abi: import_compressors.iMarketCompressorAbi,
+      functionName: "getUpdatablePriceFeeds",
+      args: [
+        {
+          configurators,
+          pools: pools ?? [],
+          underlying: import_constants.ADDRESS_0X0
+        }
+      ]
+    });
+    this.logger?.debug(`loaded ${result.length} partial updatable price feeds`);
+    return result.map((baseParams) => this.#createUpdatableProxy({ baseParams }));
   }
   /**
    * Generates price update transaction via multicall3 without any market data knowledge
+   *
+   * @deprecated TODO: seems that it's not used anywhere
+   *
    * @param marketConfigurators
    * @param pools
    * @returns
    */
   async getUpdatePriceFeedsTx(marketConfigurators, pools) {
-    const feedsData = await this.#loadUpdatablePriceFeeds(
+    const feeds = await this.getPartialUpdatablePriceFeeds(
       marketConfigurators,
       pools
     );
-    const feeds = feedsData.map((data) => this.create({ baseParams: data }));
     const updates = await this.#generatePriceFeedsUpdateTxs(feeds);
     return (0, import_utils.createRawTx)(
       (0, import_viem.getChainContractAddress)({
@@ -130,7 +151,7 @@ class PriceFeedRegister extends import_base.SDKConstruct {
     const txs = [];
     const redstonePFs = [];
     for (const pf of updateables) {
-      if (pf instanceof import_RedstonePriceFeed.RedstonePriceFeedContract) {
+      if ((0, import_RedstonePriceFeed.isRedstone)(pf)) {
         redstonePFs.push(pf);
       }
     }
@@ -157,34 +178,6 @@ class PriceFeedRegister extends import_base.SDKConstruct {
     }
     return result;
   }
-  async #loadUpdatablePriceFeeds(marketConfigurators, pools) {
-    const marketCompressorAddress = this.sdk.addressProvider.getAddress(
-      import_constants.AP_MARKET_COMPRESSOR,
-      310
-    );
-    const configurators = marketConfigurators ?? this.sdk.marketRegister.marketConfigurators.map((mc) => mc.address);
-    this.logger?.debug(
-      { configurators, pools },
-      "calling getUpdatablePriceFeeds"
-    );
-    const result = await this.provider.publicClient.readContract({
-      address: marketCompressorAddress,
-      abi: import_compressors.iMarketCompressorAbi,
-      functionName: "getUpdatablePriceFeeds",
-      args: [
-        {
-          configurators,
-          pools: pools ?? [],
-          underlying: import_constants.ADDRESS_0X0
-        }
-      ]
-      // It's passed as ...rest in viem readContract action, but this might change
-      // @ts-ignore
-      // gas: 500_000_000n,
-    });
-    this.logger?.debug(`loaded ${result.length} updatable price feeds`);
-    return result;
-  }
   create(data) {
     const contractType = (0, import_utils.bytes32ToString)(
       data.baseParams.contractType
@@ -234,6 +227,16 @@ class PriceFeedRegister extends import_base.SDKConstruct {
       }
     }
   }
+  #createUpdatableProxy(data) {
+    return new Proxy(this.create(data), {
+      get(target, prop) {
+        if (prop === "updatableDependencies") {
+          return () => [];
+        }
+        return target[prop];
+      }
+    });
+  }
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {

package/dist/cjs/sdk/market/pricefeeds/RedstonePriceFeed.js

@@ -18,7 +18,8 @@ var __copyProps = (to, from, except, desc) => {
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var RedstonePriceFeed_exports = {};
 __export(RedstonePriceFeed_exports, {
-  RedstonePriceFeedContract: () => RedstonePriceFeedContract
+  RedstonePriceFeedContract: () => RedstonePriceFeedContract,
+  isRedstone: () => isRedstone
 });
 module.exports = __toCommonJS(RedstonePriceFeed_exports);
 var import_viem = require("viem");
@@ -99,7 +100,11 @@ class RedstonePriceFeedContract extends import_AbstractPriceFeed.AbstractPriceFe
     };
   }
 }
+function isRedstone(pf) {
+  return pf.contractType === "PRICE_FEED::REDSTONE";
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  RedstonePriceFeedContract
+  RedstonePriceFeedContract,
+  isRedstone
 });

package/dist/cjs/zappers/{GearboxZappersPlugin.js → ZappersPlugin.js}

@@ -16,15 +16,15 @@ var __copyProps = (to, from, except, desc) => {
   return to;
 };
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var GearboxZappersPlugin_exports = {};
-__export(GearboxZappersPlugin_exports, {
-  GearboxZappersPlugin: () => GearboxZappersPlugin
+var ZappersPlugin_exports = {};
+__export(ZappersPlugin_exports, {
+  ZappersPlugin: () => ZappersPlugin
 });
-module.exports = __toCommonJS(GearboxZappersPlugin_exports);
+module.exports = __toCommonJS(ZappersPlugin_exports);
 var import_compressors = require("../abi/compressors.js");
 var import_sdk = require("../sdk/index.js");
 var import_sdk2 = require("../sdk/index.js");
-class GearboxZappersPlugin extends import_sdk.SDKConstruct {
+class ZappersPlugin extends import_sdk.SDKConstruct {
   #zappers;
   async attach() {
     await this.loadZappers();
@@ -90,5 +90,5 @@ class GearboxZappersPlugin extends import_sdk.SDKConstruct {
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  GearboxZappersPlugin
+  ZappersPlugin
 });

package/dist/cjs/zappers/index.js

@@ -15,10 +15,10 @@ var __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "defau
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var zappers_exports = {};
 module.exports = __toCommonJS(zappers_exports);
-__reExport(zappers_exports, require("./GearboxZappersPlugin.js"), module.exports);
 __reExport(zappers_exports, require("./types.js"), module.exports);
+__reExport(zappers_exports, require("./ZappersPlugin.js"), module.exports);
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  ...require("./GearboxZappersPlugin.js"),
-  ...require("./types.js")
+  ...require("./types.js"),
+  ...require("./ZappersPlugin.js")
 });

package/dist/esm/adapters/{GearboxAdaptersPlugin.js → AdaptersPlugin.js}

@@ -22,7 +22,7 @@ import { UniswapV3AdapterContract } from "./UniswapV3AdapterContract.js";
 import { VelodromeV2RouterAdapterContract } from "./VelodromeV2AdapterContract.js";
 import { WstETHV1AdapterContract } from "./WstETHV1AdapterContract.js";
 import { YearnV2RouterAdapterContract } from "./YearnV2AdapterContract.js";
-class GearboxAdaptersPlugin extends SDKConstruct {
+class AdaptersPlugin extends SDKConstruct {
   name = "Adapters";
   createContract(data) {
     const args = data;
@@ -93,5 +93,5 @@ class GearboxAdaptersPlugin extends SDKConstruct {
   }
 }
 export {
-  GearboxAdaptersPlugin
+  AdaptersPlugin
 };

package/dist/esm/adapters/index.js

@@ -1,5 +1,6 @@
 export * from "./abi/index.js";
 export * from "./AbstractAdapter.js";
+export * from "./AdaptersPlugin.js";
 export * from "./BalancerV2VaultAdapterContract.js";
 export * from "./BalancerV3RouterAdapterContract.js";
 export * from "./CamelotV3AdapterContract.js";
@@ -14,7 +15,6 @@ export * from "./CurveV1StableNGAdapterContract.js";
 export * from "./DaiUsdsAdapterContract.js";
 export * from "./EqualizerRouterAdapterContract.js";
 export * from "./ERC4626AdapterContract.js";
-export * from "./GearboxAdaptersPlugin.js";
 export * from "./MellowERC4626VaultAdapterContract.js";
 export * from "./MellowVaultAdapterContract.js";
 export * from "./PendleRouterAdapterContract.js";

package/dist/esm/bots/BotsPlugin.js

@@ -0,0 +1,171 @@
+import { iPeripheryCompressorAbi } from "../abi/compressors.js";
+import {
+  AddressMap,
+  AP_PERIPHERY_COMPRESSOR,
+  SDKConstruct,
+  TypedObjectUtils
+} from "../sdk/index.js";
+import { iPartialLiquidationBotV300Abi } from "./abi/index.js";
+import { PartialLiquidationBotV300Contract } from "./PartialLiquidationBotV300Contract.js";
+import { BOT_TYPES } from "./types.js";
+class UnsupportedBotVersionError extends Error {
+  state;
+  constructor(state) {
+    super(
+      `unsupported bot version ${state.baseParams.version} for bot at ${state.baseParams.addr}`
+    );
+    this.state = state;
+  }
+}
+class BotsPlugin extends SDKConstruct {
+  #logger;
+  #botsByMarket = new AddressMap();
+  constructor(sdk) {
+    super(sdk);
+    this.#logger = sdk.logger?.child?.({ name: "BotsPlugin" }) ?? sdk.logger;
+  }
+  async attach() {
+    await this.#load();
+  }
+  async syncState() {
+    await this.#load();
+  }
+  botsByMarketConfigurator(mc) {
+    return this.#botsByMarket.get(mc) ?? [];
+  }
+  get allBots() {
+    return this.#botsByMarket.values().flat();
+  }
+  async #load() {
+    this.#botsByMarket.clear();
+    const pcAddr = this.sdk.addressProvider.getAddress(
+      AP_PERIPHERY_COMPRESSOR,
+      310
+    );
+    this.#logger?.debug(`loading bots with periphery compressor ${pcAddr}`);
+    const mcs = this.sdk.marketRegister.marketConfigurators.map(
+      (mc) => mc.address
+    );
+    const botsData = await this.client.multicall({
+      contracts: mcs.map(
+        (mc) => ({
+          address: pcAddr,
+          abi: iPeripheryCompressorAbi,
+          functionName: "getBots",
+          args: [mc]
+        })
+      ),
+      allowFailure: false
+    });
+    const botsByMcV300 = {};
+    for (let i = 0; i < mcs.length; i++) {
+      const mc = mcs[i];
+      const marketBotData = botsData[i];
+      const marketBots = [];
+      for (const bot of marketBotData) {
+        if (bot.baseParams.version === 300n) {
+          marketBots.push(bot);
+        } else {
+          this.#logger?.warn(new UnsupportedBotVersionError(bot));
+        }
+      }
+      if (marketBots.length === 4) {
+        botsByMcV300[mc] = marketBots;
+      } else {
+        this.#logger?.warn(
+          `each market configurator should have 4 v300 bots, but ${mc} has ${marketBots.length}`
+        );
+      }
+    }
+    const botAddrsV300 = Object.values(botsByMcV300).flatMap(
+      (b) => b.map((b2) => b2.baseParams.addr)
+    );
+    this.#logger?.debug(`loaded ${botAddrsV300.length} v300 bots`);
+    const params = await this.#getBotsV300Parameters(botAddrsV300);
+    for (const [mc, botStates] of TypedObjectUtils.entries(botsByMcV300)) {
+      this.#botsByMarket.upsert(
+        mc,
+        botStates.map((state, i) => ({
+          state,
+          params: params[state.baseParams.addr],
+          type: BOT_TYPES[i]
+        })).sort((a, b) => a.params.minHealthFactor - b.params.minHealthFactor).map(
+          ({ state, params: params2, type }) => new PartialLiquidationBotV300Contract(
+            this.sdk,
+            state,
+            params2,
+            type
+          )
+        )
+      );
+    }
+  }
+  async #getBotsV300Parameters(addresses) {
+    const BOT_INFO_LENGTH = 4;
+    const resp = await this.provider.publicClient.multicall({
+      allowFailure: false,
+      contracts: addresses.map(
+        (address) => [
+          {
+            address,
+            abi: iPartialLiquidationBotV300Abi,
+            functionName: "minHealthFactor",
+            args: []
+          },
+          {
+            address,
+            abi: iPartialLiquidationBotV300Abi,
+            functionName: "maxHealthFactor",
+            args: []
+          },
+          {
+            address,
+            abi: iPartialLiquidationBotV300Abi,
+            functionName: "premiumScaleFactor",
+            args: []
+          },
+          {
+            address,
+            abi: iPartialLiquidationBotV300Abi,
+            functionName: "feeScaleFactor",
+            args: []
+          }
+        ]
+      ).flat(1)
+    });
+    return addresses.reduce(
+      (acc, address, index) => {
+        const from = index * BOT_INFO_LENGTH;
+        const to = (index + 1) * BOT_INFO_LENGTH;
+        const [
+          minHealthFactor,
+          maxHealthFactor,
+          premiumScaleFactor,
+          feeScaleFactor
+        ] = resp.slice(from, to);
+        acc[address] = {
+          minHealthFactor,
+          maxHealthFactor,
+          premiumScaleFactor,
+          feeScaleFactor
+        };
+        return acc;
+      },
+      {}
+    );
+  }
+  stateHuman(raw) {
+    return {
+      bots: Object.fromEntries(
+        this.#botsByMarket.entries().map(([mc, bots]) => [
+          this.labelAddress(mc),
+          bots.map((b) => b.stateHuman(raw))
+        ])
+      )
+    };
+  }
+}
+export {
+  BotsPlugin,
+  UnsupportedBotVersionError
+};

package/dist/esm/bots/PartialLiquidationBotV300Contract.js

@@ -0,0 +1,31 @@
+import { BaseContract, formatPercentage } from "../sdk/index.js";
+import { iPartialLiquidationBotV300Abi } from "./abi/index.js";
+const abi = iPartialLiquidationBotV300Abi;
+class PartialLiquidationBotV300Contract extends BaseContract {
+  requiredPermissions;
+  botType;
+  constructor(sdk, args, params, type) {
+    super(sdk, {
+      abi,
+      ...args.baseParams,
+      name: `PartialLiquidationBotV300 (${type})`
+    });
+    this.requiredPermissions = args.requiredPermissions;
+    Object.assign(this, params);
+    this.botType = type;
+  }
+  stateHuman(raw) {
+    return {
+      ...super.stateHuman(raw),
+      botType: this.botType,
+      minHealthFactor: formatPercentage(this.minHealthFactor),
+      maxHealthFactor: formatPercentage(this.maxHealthFactor),
+      premiumScaleFactor: formatPercentage(this.premiumScaleFactor),
+      feeScaleFactor: formatPercentage(this.feeScaleFactor),
+      requiredPermissions: this.requiredPermissions.toString(10)
+    };
+  }
+}
+export {
+  PartialLiquidationBotV300Contract
+};

package/dist/esm/bots/abi/iPartialLiquidationBotV300.js

@@ -0,0 +1,140 @@
+const iPartialLiquidationBotV300Abi = [
+  {
+    type: "function",
+    name: "feeScaleFactor",
+    inputs: [],
+    outputs: [{ name: "", type: "uint16", internalType: "uint16" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "liquidateExactCollateral",
+    inputs: [
+      { name: "creditAccount", type: "address", internalType: "address" },
+      { name: "token", type: "address", internalType: "address" },
+      { name: "seizedAmount", type: "uint256", internalType: "uint256" },
+      { name: "maxRepaidAmount", type: "uint256", internalType: "uint256" },
+      { name: "to", type: "address", internalType: "address" },
+      {
+        name: "priceUpdates",
+        type: "tuple[]",
+        internalType: "struct IPartialLiquidationBotV3.PriceUpdate[]",
+        components: [
+          { name: "token", type: "address", internalType: "address" },
+          { name: "reserve", type: "bool", internalType: "bool" },
+          { name: "data", type: "bytes", internalType: "bytes" }
+        ]
+      }
+    ],
+    outputs: [
+      { name: "repaidAmount", type: "uint256", internalType: "uint256" }
+    ],
+    stateMutability: "nonpayable"
+  },
+  {
+    type: "function",
+    name: "liquidateExactDebt",
+    inputs: [
+      { name: "creditAccount", type: "address", internalType: "address" },
+      { name: "token", type: "address", internalType: "address" },
+      { name: "repaidAmount", type: "uint256", internalType: "uint256" },
+      { name: "minSeizedAmount", type: "uint256", internalType: "uint256" },
+      { name: "to", type: "address", internalType: "address" },
+      {
+        name: "priceUpdates",
+        type: "tuple[]",
+        internalType: "struct IPartialLiquidationBotV3.PriceUpdate[]",
+        components: [
+          { name: "token", type: "address", internalType: "address" },
+          { name: "reserve", type: "bool", internalType: "bool" },
+          { name: "data", type: "bytes", internalType: "bytes" }
+        ]
+      }
+    ],
+    outputs: [
+      { name: "seizedAmount", type: "uint256", internalType: "uint256" }
+    ],
+    stateMutability: "nonpayable"
+  },
+  {
+    type: "function",
+    name: "maxHealthFactor",
+    inputs: [],
+    outputs: [{ name: "", type: "uint16", internalType: "uint16" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "minHealthFactor",
+    inputs: [],
+    outputs: [{ name: "", type: "uint16", internalType: "uint16" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "premiumScaleFactor",
+    inputs: [],
+    outputs: [{ name: "", type: "uint16", internalType: "uint16" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "treasury",
+    inputs: [],
+    outputs: [{ name: "", type: "address", internalType: "address" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "version",
+    inputs: [],
+    outputs: [{ name: "", type: "uint256", internalType: "uint256" }],
+    stateMutability: "view"
+  },
+  {
+    type: "event",
+    name: "LiquidatePartial",
+    inputs: [
+      {
+        name: "creditManager",
+        type: "address",
+        indexed: true,
+        internalType: "address"
+      },
+      {
+        name: "creditAccount",
+        type: "address",
+        indexed: true,
+        internalType: "address"
+      },
+      {
+        name: "token",
+        type: "address",
+        indexed: true,
+        internalType: "address"
+      },
+      {
+        name: "repaidDebt",
+        type: "uint256",
+        indexed: false,
+        internalType: "uint256"
+      },
+      {
+        name: "seizedCollateral",
+        type: "uint256",
+        indexed: false,
+        internalType: "uint256"
+      },
+      { name: "fee", type: "uint256", indexed: false, internalType: "uint256" }
+    ],
+    anonymous: false
+  },
+  { type: "error", name: "LiquidatedLessThanNeededException", inputs: [] },
+  { type: "error", name: "LiquidatedMoreThanNeededException", inputs: [] },
+  { type: "error", name: "RepaidMoreThanAllowedException", inputs: [] },
+  { type: "error", name: "SeizedLessThanRequiredException", inputs: [] },
+  { type: "error", name: "UnderlyingNotLiquidatableException", inputs: [] }
+];
+export {
+  iPartialLiquidationBotV300Abi
+};

package/dist/esm/bots/abi/index.js

@@ -0,0 +1 @@
+export * from "./iPartialLiquidationBotV300.js";

package/dist/esm/bots/index.js

@@ -0,0 +1,4 @@
+export * from "./abi/index.js";
+export * from "./BotsPlugin.js";
+export * from "./PartialLiquidationBotV300Contract.js";
+export * from "./types.js";

package/dist/esm/bots/package.json

@@ -0,0 +1 @@
+{"type": "module","sideEffects":false}

package/dist/esm/bots/types.js

@@ -0,0 +1,9 @@
+const BOT_TYPES = [
+  "PARTIAL_LIQUIDATION_BOT",
+  "DELEVERAGE_BOT_PEGGED",
+  "DELEVERAGE_BOT_LV",
+  "DELEVERAGE_BOT_HV"
+];
+export {
+  BOT_TYPES
+};

package/dist/esm/sdk/index.js

@@ -1,6 +1,5 @@
 export * from "./accounts/index.js";
 export * from "./base/index.js";
-export * from "./bots/index.js";
 export * from "./chain/index.js";
 export * from "./constants/index.js";
 export * from "./core/index.js";

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

@@ -53,11 +53,11 @@ class MarketRegister extends SDKConstruct {
     );
     let txs = [];
     if (!ignoreUpdateablePrices) {
-      await this.sdk.priceFeeds.preloadUpdatablePriceFeeds(
+      const updatables = await this.sdk.priceFeeds.getPartialUpdatablePriceFeeds(
         configurators,
         pools
       );
-      const updates = await this.sdk.priceFeeds.generatePriceFeedsUpdateTxs();
+      const updates = await this.sdk.priceFeeds.generatePriceFeedsUpdateTxs(updatables);
       txs = updates.txs;
     }
     this.#logger?.debug(