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

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

@@ -1,6 +1,16 @@
 import { ilpPriceFeedAbi } from "../../abi/index.js";
 import { BaseContract } from "../../base/index.js";
 import { PriceFeedRef } from "./PriceFeedRef.js";
+class PartialPriceFeedInitError extends Error {
+  priceFeed;
+  constructor(priceFeed) {
+    super(
+      `price feed ${priceFeed.baseParams.addr} has been initialized with BaseParams only`
+    );
+    this.name = "ErrPartialPriceFeed";
+    this.priceFeed = priceFeed;
+  }
+}
 class AbstractPriceFeedContract extends BaseContract {
   /**
    * True if the contract deployed at this address implements IUpdatablePriceFeed interface
@@ -9,6 +19,7 @@ class AbstractPriceFeedContract extends BaseContract {
   #decimals;
   #underlyingPriceFeeds;
   #skipCheck;
+  #args;
   hasLowerBoundCap = false;
   description;
   constructor(sdk, args) {
@@ -19,6 +30,7 @@ class AbstractPriceFeedContract extends BaseContract {
       contractType: args.baseParams.contractType,
       version: args.baseParams.version
     });
+    this.#args = args;
     this.description = args.description;
     this.#decimals = args.decimals;
     this.#updatable = args.updatable;
@@ -38,25 +50,25 @@ class AbstractPriceFeedContract extends BaseContract {
   }
   get decimals() {
     if (this.#decimals === void 0) {
-      throw new Error("price feed has been initialized with BaseParams only");
+      throw new PartialPriceFeedInitError(this);
     }
     return this.#decimals;
   }
   get updatable() {
     if (this.#updatable === void 0) {
-      throw new Error("price feed has been initialized with BaseParams only");
+      throw new PartialPriceFeedInitError(this.#args);
     }
     return this.#updatable;
   }
   get skipCheck() {
     if (this.#skipCheck === void 0) {
-      throw new Error("price feed has been initialized with BaseParams only");
+      throw new PartialPriceFeedInitError(this.#args);
     }
     return this.#skipCheck;
   }
   get underlyingPriceFeeds() {
     if (!this.#underlyingPriceFeeds) {
-      throw new Error("price feed has been initialized with BaseParams only");
+      throw new PartialPriceFeedInitError(this.#args);
     }
     return this.#underlyingPriceFeeds;
   }
@@ -96,5 +108,6 @@ class AbstractPriceFeedContract extends BaseContract {
   }
 }
 export {
-  AbstractPriceFeedContract
+  AbstractPriceFeedContract,
+  PartialPriceFeedInitError
 };

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

@@ -12,6 +12,9 @@ import {
   createRawTx
 } from "../../utils/index.js";
 import { Hooks } from "../../utils/internal/index.js";
+import {
+  PartialPriceFeedInitError
+} from "./AbstractPriceFeed.js";
 import { BalancerStablePriceFeedContract } from "./BalancerStablePriceFeed.js";
 import { BalancerWeightedPriceFeedContract } from "./BalancerWeightedPriceFeed.js";
 import { BoundedPriceFeedContract } from "./BoundedPriceFeed.js";
@@ -24,7 +27,7 @@ import { ExternalPriceFeedContract } from "./ExternalPriceFeed.js";
 import { MellowLRTPriceFeedContract } from "./MellowLRTPriceFeed.js";
 import { PendleTWAPPTPriceFeed } from "./PendleTWAPPTPriceFeed.js";
 import { PythPriceFeed } from "./PythPriceFeed.js";
-import { RedstonePriceFeedContract } from "./RedstonePriceFeed.js";
+import { isRedstone, RedstonePriceFeedContract } from "./RedstonePriceFeed.js";
 import { RedstoneUpdater } from "./RedstoneUpdater.js";
 import { WstETHPriceFeedContract } from "./WstETHPriceFeed.js";
 import { YearnPriceFeedContract } from "./YearnPriceFeed.js";
@@ -63,35 +66,55 @@ class PriceFeedRegister extends SDKConstruct {
       return existing;
     }
     const feed = this.create(data);
+    if (!feed.loaded) {
+      throw new 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(
+      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: iMarketCompressorAbi,
+      functionName: "getUpdatablePriceFeeds",
+      args: [
+        {
+          configurators,
+          pools: pools ?? [],
+          underlying: 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 createRawTx(
       getChainContractAddress({
@@ -115,7 +138,7 @@ class PriceFeedRegister extends SDKConstruct {
     const txs = [];
     const redstonePFs = [];
     for (const pf of updateables) {
-      if (pf instanceof RedstonePriceFeedContract) {
+      if (isRedstone(pf)) {
         redstonePFs.push(pf);
       }
     }
@@ -142,34 +165,6 @@ class PriceFeedRegister extends SDKConstruct {
     }
     return result;
   }
-  async #loadUpdatablePriceFeeds(marketConfigurators, pools) {
-    const marketCompressorAddress = this.sdk.addressProvider.getAddress(
-      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: iMarketCompressorAbi,
-      functionName: "getUpdatablePriceFeeds",
-      args: [
-        {
-          configurators,
-          pools: pools ?? [],
-          underlying: 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 = bytes32ToString(
       data.baseParams.contractType
@@ -219,6 +214,16 @@ class PriceFeedRegister extends SDKConstruct {
       }
     }
   }
+  #createUpdatableProxy(data) {
+    return new Proxy(this.create(data), {
+      get(target, prop) {
+        if (prop === "updatableDependencies") {
+          return () => [];
+        }
+        return target[prop];
+      }
+    });
+  }
 }
 export {
   PriceFeedRegister

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

@@ -76,6 +76,10 @@ class RedstonePriceFeedContract extends AbstractPriceFeedContract {
     };
   }
 }
+function isRedstone(pf) {
+  return pf.contractType === "PRICE_FEED::REDSTONE";
+}
 export {
-  RedstonePriceFeedContract
+  RedstonePriceFeedContract,
+  isRedstone
 };

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

@@ -4,7 +4,7 @@ import {
   SDKConstruct
 } from "../sdk/index.js";
 import { AddressMap } from "../sdk/index.js";
-class GearboxZappersPlugin extends SDKConstruct {
+class ZappersPlugin extends SDKConstruct {
   #zappers;
   async attach() {
     await this.loadZappers();
@@ -69,5 +69,5 @@ class GearboxZappersPlugin extends SDKConstruct {
   }
 }
 export {
-  GearboxZappersPlugin
+  ZappersPlugin
 };

package/dist/esm/zappers/index.js

@@ -1,2 +1,2 @@
-export * from "./GearboxZappersPlugin.js";
 export * from "./types.js";
+export * from "./ZappersPlugin.js";

package/dist/types/adapters/{GearboxAdaptersPlugin.d.ts → AdaptersPlugin.d.ts}

@@ -1,6 +1,6 @@
 import type { BaseState, IBaseContract, IGearboxSDKPlugin } from "../sdk/index.js";
 import { SDKConstruct } from "../sdk/index.js";
-export declare class GearboxAdaptersPlugin extends SDKConstruct implements IGearboxSDKPlugin {
+export declare class AdaptersPlugin extends SDKConstruct implements IGearboxSDKPlugin {
     readonly name = "Adapters";
     createContract(data: BaseState): IBaseContract | undefined;
     stateHuman(raw?: boolean): {};

package/dist/types/adapters/index.d.ts

@@ -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/types/bots/BotsPlugin.d.ts

@@ -0,0 +1,18 @@
+import type { Address } from "viem";
+import type { GearboxSDK, IGearboxSDKPlugin } from "../sdk/index.js";
+import { SDKConstruct } from "../sdk/index.js";
+import { PartialLiquidationBotV300Contract } from "./PartialLiquidationBotV300Contract.js";
+import type { BotsPluginStateHuman, BotState } from "./types.js";
+export declare class UnsupportedBotVersionError extends Error {
+    readonly state: BotState;
+    constructor(state: BotState);
+}
+export declare class BotsPlugin extends SDKConstruct implements IGearboxSDKPlugin {
+    #private;
+    constructor(sdk: GearboxSDK);
+    attach(): Promise<void>;
+    syncState(): Promise<void>;
+    botsByMarketConfigurator(mc: Address): PartialLiquidationBotV300Contract[];
+    get allBots(): PartialLiquidationBotV300Contract[];
+    stateHuman(raw?: boolean): BotsPluginStateHuman;
+}

package/dist/types/bots/PartialLiquidationBotV300Contract.d.ts

@@ -0,0 +1,223 @@
+import type { GearboxSDK } from "../sdk/index.js";
+import { BaseContract } from "../sdk/index.js";
+import type { BotParameters, BotState, BotStateV300Human, BotType } from "./types.js";
+declare const abi: readonly [{
+    readonly type: "function";
+    readonly name: "feeScaleFactor";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint16";
+        readonly internalType: "uint16";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "liquidateExactCollateral";
+    readonly inputs: readonly [{
+        readonly name: "creditAccount";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "token";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "seizedAmount";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }, {
+        readonly name: "maxRepaidAmount";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }, {
+        readonly name: "to";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "priceUpdates";
+        readonly type: "tuple[]";
+        readonly internalType: "struct IPartialLiquidationBotV3.PriceUpdate[]";
+        readonly components: readonly [{
+            readonly name: "token";
+            readonly type: "address";
+            readonly internalType: "address";
+        }, {
+            readonly name: "reserve";
+            readonly type: "bool";
+            readonly internalType: "bool";
+        }, {
+            readonly name: "data";
+            readonly type: "bytes";
+            readonly internalType: "bytes";
+        }];
+    }];
+    readonly outputs: readonly [{
+        readonly name: "repaidAmount";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "liquidateExactDebt";
+    readonly inputs: readonly [{
+        readonly name: "creditAccount";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "token";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "repaidAmount";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }, {
+        readonly name: "minSeizedAmount";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }, {
+        readonly name: "to";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "priceUpdates";
+        readonly type: "tuple[]";
+        readonly internalType: "struct IPartialLiquidationBotV3.PriceUpdate[]";
+        readonly components: readonly [{
+            readonly name: "token";
+            readonly type: "address";
+            readonly internalType: "address";
+        }, {
+            readonly name: "reserve";
+            readonly type: "bool";
+            readonly internalType: "bool";
+        }, {
+            readonly name: "data";
+            readonly type: "bytes";
+            readonly internalType: "bytes";
+        }];
+    }];
+    readonly outputs: readonly [{
+        readonly name: "seizedAmount";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "maxHealthFactor";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint16";
+        readonly internalType: "uint16";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "minHealthFactor";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint16";
+        readonly internalType: "uint16";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "premiumScaleFactor";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint16";
+        readonly internalType: "uint16";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "treasury";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "version";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "event";
+    readonly name: "LiquidatePartial";
+    readonly inputs: readonly [{
+        readonly name: "creditManager";
+        readonly type: "address";
+        readonly indexed: true;
+        readonly internalType: "address";
+    }, {
+        readonly name: "creditAccount";
+        readonly type: "address";
+        readonly indexed: true;
+        readonly internalType: "address";
+    }, {
+        readonly name: "token";
+        readonly type: "address";
+        readonly indexed: true;
+        readonly internalType: "address";
+    }, {
+        readonly name: "repaidDebt";
+        readonly type: "uint256";
+        readonly indexed: false;
+        readonly internalType: "uint256";
+    }, {
+        readonly name: "seizedCollateral";
+        readonly type: "uint256";
+        readonly indexed: false;
+        readonly internalType: "uint256";
+    }, {
+        readonly name: "fee";
+        readonly type: "uint256";
+        readonly indexed: false;
+        readonly internalType: "uint256";
+    }];
+    readonly anonymous: false;
+}, {
+    readonly type: "error";
+    readonly name: "LiquidatedLessThanNeededException";
+    readonly inputs: readonly [];
+}, {
+    readonly type: "error";
+    readonly name: "LiquidatedMoreThanNeededException";
+    readonly inputs: readonly [];
+}, {
+    readonly type: "error";
+    readonly name: "RepaidMoreThanAllowedException";
+    readonly inputs: readonly [];
+}, {
+    readonly type: "error";
+    readonly name: "SeizedLessThanRequiredException";
+    readonly inputs: readonly [];
+}, {
+    readonly type: "error";
+    readonly name: "UnderlyingNotLiquidatableException";
+    readonly inputs: readonly [];
+}];
+type abi = typeof abi;
+export interface PartialLiquidationBotV300Contract extends BotParameters, BaseContract<abi> {
+}
+export declare class PartialLiquidationBotV300Contract extends BaseContract<abi> {
+    readonly requiredPermissions: bigint;
+    readonly botType: BotType;
+    constructor(sdk: GearboxSDK, args: BotState, params: BotParameters, type: BotType);
+    stateHuman(raw?: boolean): BotStateV300Human;
+}
+export {};