@gearbox-protocol/sdk 4.2.0-next.3 → 5.0.0-next.2

package/dist/esm/sdk/market/oracle/PriceOracleBaseContract.js

@@ -3,16 +3,16 @@ import { decodeFunctionData, stringToHex } from "viem";
 import { iPriceFeedCompressorAbi } from "../../../abi/compressors.js";
 import { iUpdatablePriceFeedAbi } from "../../../abi/iUpdatablePriceFeed.js";
 import { BaseContract } from "../../base/index.js";
-import { AP_PRICE_FEED_COMPRESSOR } from "../../constants/index.js";
+import {
+  AP_PRICE_FEED_COMPRESSOR,
+  isV300,
+  VERSION_RANGE_310
+} from "../../constants/index.js";
 import { AddressMap, formatBN } from "../../utils/index.js";
 import { PriceFeedRef } from "../pricefeeds/index.js";
 import PriceFeedAnswerMap from "./PriceFeedAnswerMap.js";
 const ZERO_PRICE_FEED = stringToHex("PRICE_FEED::ZERO", { size: 32 });
 class PriceOracleBaseContract extends BaseContract {
-  /**
-   * Underlying token of market to which this price oracle belongs
-   */
-  underlying;
   /**
    * Mapping Token => [PriceFeed Address, stalenessPeriod]
    */
@@ -38,12 +38,14 @@ class PriceOracleBaseContract extends BaseContract {
     void 0,
     "reservePrices"
   );
-  #priceFeedTree = [];
-  constructor(sdk, args, data, underlying) {
+  #priceFeedTree = new AddressMap(
+    void 0,
+    "priceFeedTree"
+  );
+  constructor(sdk, args, data) {
     super(sdk, args);
-    this.underlying = underlying;
     const { priceFeedMap, priceFeedTree } = data;
-    this.#loadState(priceFeedMap, priceFeedTree);
+    this.#loadState(priceFeedMap, priceFeedTree, true);
   }
   /**
    * Returns main and reserve price feeds for given tokens
@@ -65,7 +67,7 @@ class PriceOracleBaseContract extends BaseContract {
    */
   async updatePriceFeeds() {
     const updatables = [];
-    for (const node of this.#priceFeedTree) {
+    for (const node of this.#priceFeedTree.values()) {
       if (node.updatable) {
         updatables.push(this.sdk.priceFeeds.mustGet(node.baseParams.addr));
       }
@@ -131,30 +133,19 @@ class PriceOracleBaseContract extends BaseContract {
   }
   /**
    * Returns true if oracle's price feed tree contains given price feed
+   * This feed is not necessary connected to token, but can be a component of composite feed for some token
    * @param priceFeed
    * @returns
    */
   usesPriceFeed(priceFeed) {
-    return this.#priceFeedTree.some(
-      (node) => node.baseParams.addr.toLowerCase() === priceFeed.toLowerCase()
-    );
-  }
-  /**
-   * Tries to convert amount of token into underlying of current market
-   * @param token
-   * @param amount
-   * @param reserve
-   * @returns
-   */
-  convertToUnderlying(token, amount, reserve = false) {
-    return this.convert(token, this.underlying, amount, reserve);
+    return this.#priceFeedTree.has(priceFeed);
   }
   /**
    * Tries to convert amount of from one token to another, using latest known prices
    * @param from
    * @param to
    * @param amount
-   * @param reserve
+   * @param reserve use reserve price feed instead of main
    */
   convert(from, to, amount, reserve = false) {
     if (from === to) {
@@ -169,9 +160,8 @@ class PriceOracleBaseContract extends BaseContract {
   /**
    * Tries to convert amount of token to USD, using latest known prices
    * @param from
-   * @param to
    * @param amount
-   * @param reserve
+   * @param reserve use reserve price feed instead of main
    */
   convertToUSD(from, amount, reserve = false) {
     const price = reserve ? this.reservePrice(from) : this.mainPrice(from);
@@ -182,7 +172,7 @@ class PriceOracleBaseContract extends BaseContract {
    * Tries to convert amount of USD to token, using latest known prices
    * @param to
    * @param amount
-   * @param reserve
+   * @param reserve use reserve price feed instead of main
    */
   convertFromUSD(to, amount, reserve = false) {
     const price = reserve ? this.reservePrice(to) : this.mainPrice(to);
@@ -191,26 +181,30 @@ class PriceOracleBaseContract extends BaseContract {
   }
   /**
    * Loads new prices for this oracle from PriceFeedCompressor
-   * Does not update price feeds, only updates prices
+   * Will (re)create price feeds if needed
    */
   async updatePrices() {
     await this.sdk.marketRegister.updatePrices([this.address]);
   }
+  /**
+   * Paired method to updatePrices, helps to update prices on all oracles in one multicall
+   */
   syncStateMulticall() {
-    const args = [this.address];
-    if (this.version === 300) {
-      args.push(
+    let args = [this.address];
+    if (isV300(this.version)) {
+      args = [
+        args[0],
         Array.from(
           /* @__PURE__ */ new Set([
-            this.underlying,
             ...this.mainPriceFeeds.keys(),
             ...this.reservePriceFeeds.keys()
           ])
         )
-      );
+      ];
     }
-    const [address] = this.sdk.addressProvider.getLatestVersion(
-      AP_PRICE_FEED_COMPRESSOR
+    const [address] = this.sdk.addressProvider.mustGetLatest(
+      AP_PRICE_FEED_COMPRESSOR,
+      VERSION_RANGE_310
     );
     return {
       call: {
@@ -221,25 +215,39 @@ class PriceOracleBaseContract extends BaseContract {
       },
       onResult: (resp) => {
         const { priceFeedMap, priceFeedTree } = resp;
-        this.#loadState(priceFeedMap, priceFeedTree);
+        this.#loadState(priceFeedMap, priceFeedTree, true);
       }
     };
   }
-  #loadState(entries, tree) {
-    this.#priceFeedTree = tree;
-    this.mainPriceFeeds.clear();
-    this.reservePriceFeeds.clear();
-    this.mainPrices.clear();
-    this.reservePrices.clear();
+  /**
+   * Helper function to handle situation when we have multiple different compressor data entries for same oracle
+   * This happens in v300
+   *
+   * @deprecated should be unnecessary after full v310 migration (oracles will be unique)
+   * @param data
+   * @returns
+   */
+  merge(data) {
+    const { priceFeedMap, priceFeedTree } = data;
+    this.#loadState(priceFeedMap, priceFeedTree, false);
+    return this;
+  }
+  #loadState(entries, tree, reset) {
+    if (reset) {
+      this.#priceFeedTree.clear();
+      this.mainPriceFeeds.clear();
+      this.reservePriceFeeds.clear();
+      this.mainPrices.clear();
+      this.reservePrices.clear();
+    }
     for (const node of tree) {
+      this.#priceFeedTree.upsert(node.baseParams.addr, node);
       this.sdk.priceFeeds.getOrCreate(node);
     }
-    entries.forEach((entry) => {
+    for (const entry of entries) {
       const { token, priceFeed, reserve, stalenessPeriod } = entry;
       const ref = new PriceFeedRef(this.sdk, priceFeed, stalenessPeriod);
-      const node = this.#priceFeedTree.find(
-        (n) => n.baseParams.addr === priceFeed
-      );
+      const node = this.#priceFeedTree.get(priceFeed);
       const price = node?.answer?.price;
       const priceFeedType = node?.baseParams.contractType;
       if (reserve) {
@@ -256,7 +264,7 @@ class PriceOracleBaseContract extends BaseContract {
         }
       }
       this.#labelPriceFeed(priceFeed, reserve ? "Reserve" : "Main", token);
-    });
+    }
     this.logger?.debug(
       `Got ${this.mainPriceFeeds.size} main and ${this.reservePriceFeeds.size} reserve price feeds`
     );
@@ -277,6 +285,8 @@ class PriceOracleBaseContract extends BaseContract {
    * Helper method to find "attachment point" of price feed (makes sense for updatable price feeds only) -
    * returns token (in v3.0 can be ticker) and main/reserve flag
    *
+   * @deprecated Should be gone after v310 migration
+   *
    * @param priceFeed
    * @returns
    */
@@ -293,6 +303,9 @@ class PriceOracleBaseContract extends BaseContract {
     }
     return [void 0, false];
   }
+  /**
+   * Returns list of addresses that should be watched for events to sync state
+   */
   get watchAddresses() {
     return /* @__PURE__ */ new Set([this.address]);
   }
@@ -319,9 +332,6 @@ class PriceOracleBaseContract extends BaseContract {
       )
     };
   }
-  get priceFeedTree() {
-    return this.#priceFeedTree;
-  }
   #noAnswerWarn(priceFeed, node) {
     let label = this.labelAddress(priceFeed);
     if (!node) {

package/dist/esm/sdk/market/oracle/PriceOracleV300Contract.js

@@ -4,7 +4,7 @@ import { tickerInfoTokensByNetwork } from "../../sdk-gov-legacy/index.js";
 import { PriceOracleBaseContract } from "./PriceOracleBaseContract.js";
 const abi = [...iPriceOracleV300Abi, ...iPausableAbi];
 class PriceOracleV300Contract extends PriceOracleBaseContract {
-  constructor(sdk, data, underlying) {
+  constructor(sdk, data) {
     super(
       sdk,
       {
@@ -12,8 +12,7 @@ class PriceOracleV300Contract extends PriceOracleBaseContract {
         name: "PriceOracleV3",
         abi
       },
-      data,
-      underlying
+      data
     );
   }
   processLog(log) {

package/dist/esm/sdk/market/oracle/PriceOracleV310Contract.js

@@ -2,7 +2,7 @@ import { iPriceOracleV310Abi } from "../../../abi/v310.js";
 import { PriceOracleBaseContract } from "./PriceOracleBaseContract.js";
 const abi = iPriceOracleV310Abi;
 class PriceOracleV310Contract extends PriceOracleBaseContract {
-  constructor(sdk, data, underlying) {
+  constructor(sdk, data) {
     super(
       sdk,
       {
@@ -10,8 +10,7 @@ class PriceOracleV310Contract extends PriceOracleBaseContract {
         name: "PriceOracleV3",
         abi
       },
-      data,
-      underlying
+      data
     );
   }
   processLog(log) {

package/dist/esm/sdk/market/oracle/createPriceOracle.js

@@ -1,15 +1,35 @@
+import { isV300, isV310 } from "../../constants/index.js";
+import { PriceOracleBaseContract } from "./PriceOracleBaseContract.js";
 import { PriceOracleV300Contract } from "./PriceOracleV300Contract.js";
 import { PriceOracleV310Contract } from "./PriceOracleV310Contract.js";
-function createPriceOracle(sdk, data, underlying) {
-  const v = data.baseParams.version;
-  if (v >= 300n && v < 310n) {
-    return new PriceOracleV300Contract(sdk, data, underlying);
+function getOrCreatePriceOracle(sdk, data) {
+  const { version, addr } = data.baseParams;
+  const existing = sdk.contracts.get(addr);
+  if (existing) {
+    return tryExtendExistingOracle(existing, data);
   }
-  if (v === 310n) {
-    return new PriceOracleV310Contract(sdk, data, underlying);
+  if (isV300(version)) {
+    return new PriceOracleV300Contract(sdk, data);
   }
-  throw new Error(`Unsupported oracle version ${v}`);
+  if (isV310(version)) {
+    return new PriceOracleV310Contract(sdk, data);
+  }
+  throw new Error(`Unsupported oracle version ${version}`);
+}
+function tryExtendExistingOracle(existing, data) {
+  const { version, addr } = data.baseParams;
+  if (!(existing instanceof PriceOracleBaseContract)) {
+    throw new Error(
+      `expected oracle contract at ${addr}, found existing ${existing.contractType}`
+    );
+  }
+  if (Number(existing.version) !== Number(version)) {
+    throw new Error(
+      `expected oracle contract at ${addr} to have version ${version}, found ${existing.version}`
+    );
+  }
+  return existing.merge(data);
 }
 export {
-  createPriceOracle
+  getOrCreatePriceOracle
 };

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

@@ -1,11 +1,12 @@
+import { isV300, isV310 } from "../../constants/index.js";
 import { PoolV300Contract } from "./PoolV300Contract.js";
 import { PoolV310Contract } from "./PoolV310Contract.js";
 function createPool(sdk, data) {
   const v = data.baseParams.version;
-  if (v >= 300n && v < 310n) {
+  if (isV300(v)) {
     return new PoolV300Contract(sdk, data);
   }
-  if (v === 310n) {
+  if (isV310(v)) {
     return new PoolV310Contract(sdk, data);
   }
   throw new Error(`Unsupported pool version ${v}`);

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

@@ -1,11 +1,12 @@
+import { isV300, isV310 } from "../../constants/index.js";
 import { PoolQuotaKeeperV300Contract } from "./PoolQuotaKeeperV300Contract.js";
 import { PoolQuotaKeeperV310Contract } from "./PoolQuotaKeeperV310Contract.js";
 function createPoolQuotaKeeper(sdk, pool, pqk) {
   const v = pqk.baseParams.version;
-  if (v >= 300n && v < 310n) {
+  if (isV300(v)) {
     return new PoolQuotaKeeperV300Contract(sdk, pool, pqk);
   }
-  if (v === 310n) {
+  if (isV310(v)) {
     return new PoolQuotaKeeperV310Contract(sdk, pool, pqk);
   }
   throw new Error(`Unsupported pool quota keeper version ${v}`);

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

@@ -1,4 +1,5 @@
 import { decodeAbiParameters, hexToBytes } from "viem";
+import { isV310 } from "../../constants/versions.js";
 import {
   AbstractPriceFeedContract
 } from "./AbstractPriceFeed.js";
@@ -15,7 +16,7 @@ class AbstractLPPriceFeedContract extends AbstractPriceFeedContract {
   constructor(sdk, args) {
     super(sdk, { ...args, decimals: 8 });
     this.hasLowerBoundCap = true;
-    if (args.baseParams.version === 310n) {
+    if (isV310(args.baseParams.version)) {
       const decoder = decodeAbiParameters(
         [
           { type: "address", name: "lpToken" },

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

@@ -2,7 +2,8 @@ import { iPriceFeedCompressorAbi } from "../../../abi/compressors.js";
 import { SDKConstruct } from "../../base/index.js";
 import {
   ADDRESS_0X0,
-  AP_PRICE_FEED_COMPRESSOR
+  AP_PRICE_FEED_COMPRESSOR,
+  VERSION_RANGE_310
 } from "../../constants/index.js";
 import { AddressMap, bytes32ToString, childLogger } from "../../utils/index.js";
 import { Hooks } from "../../utils/internal/index.js";
@@ -109,9 +110,9 @@ class PriceFeedRegister extends SDKConstruct {
    * This is not saved anywhere in PriceFeedRegister, and can later be used to load price feed updates
    */
   async getPartialUpdatablePriceFeeds(marketConfigurators, pools) {
-    const priceFeedCompressorAddress = this.sdk.addressProvider.getAddress(
+    const [priceFeedCompressorAddress] = this.sdk.addressProvider.mustGetLatest(
       AP_PRICE_FEED_COMPRESSOR,
-      310
+      VERSION_RANGE_310
     );
     const configurators = marketConfigurators ?? this.sdk.marketRegister.marketConfigurators.map((mc) => mc.address);
     this.logger?.debug(

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

@@ -1,6 +1,6 @@
 import { bytesToString, decodeAbiParameters, toBytes } from "viem";
 import { redstonePriceFeedAbi } from "../../abi/index.js";
-import { ADDRESS_0X0 } from "../../constants/index.js";
+import { ADDRESS_0X0, isV310 } from "../../constants/index.js";
 import { AbstractPriceFeedContract } from "./AbstractPriceFeed.js";
 class RedstonePriceFeedContract extends AbstractPriceFeedContract {
   token;
@@ -16,7 +16,7 @@ class RedstonePriceFeedContract extends AbstractPriceFeedContract {
       name: `RedstonePriceFeed`,
       abi: redstonePriceFeedAbi
     });
-    if (args.baseParams.version === 310n) {
+    if (isV310(args.baseParams.version)) {
       const decoder = decodeAbiParameters(
         [
           { type: "address", name: "token" },

package/dist/esm/sdk/plugins/V300StalenessPeriodPlugin.js

@@ -1,7 +1,7 @@
 import { getAbiItem, getAddress } from "viem";
 import { iPriceOracleV300Abi } from "../../abi/v300.js";
 import { SDKConstruct } from "../base/index.js";
-import { ADDRESS_PROVIDER_BLOCK } from "../constants/index.js";
+import { ADDRESS_PROVIDER_BLOCK, isV300 } from "../constants/index.js";
 import { PriceFeedRef } from "../market/index.js";
 import { AddressMap, formatDuration, hexEq } from "../utils/index.js";
 import { getLogsSafe } from "../utils/viem/index.js";
@@ -16,12 +16,12 @@ class V300StalenessPeriodPlugin extends SDKConstruct {
     this.#logger = sdk.logger?.child?.({ name: "V300StalenessPeriodPlugin" }) ?? sdk.logger;
   }
   async attach() {
-    await this.#syncReservePriceFeeds();
+    await this.#syncPriceFeeds();
   }
   async syncState() {
-    await this.#syncReservePriceFeeds();
+    await this.#syncPriceFeeds();
   }
-  async #syncReservePriceFeeds() {
+  async #syncPriceFeeds() {
     const oracles = this.#getOraclesMap();
     const [fromBlock, toBlock] = [this.#syncedTo + 1n, this.sdk.currentBlock];
     if (oracles.size === 0 || fromBlock > toBlock) {
@@ -44,7 +44,7 @@ class V300StalenessPeriodPlugin extends SDKConstruct {
       strict: true
     });
     this.#logger?.info(
-      `loaded ${events.length} SetReservePriceFeed events in range [${fromBlock}; ${toBlock}]`
+      `loaded ${events.length} price feed events in range [${fromBlock}; ${toBlock}]`
     );
     for (const e of events) {
       const oracle = oracles.mustGet(e.address);
@@ -97,7 +97,7 @@ class V300StalenessPeriodPlugin extends SDKConstruct {
   }
   #getOraclesMap() {
     return new AddressMap(
-      this.sdk.marketRegister.markets.filter((m) => m.priceOracle.version === 300).map((m) => [m.priceOracle.address, m.priceOracle])
+      this.sdk.marketRegister.markets.filter((m) => isV300(m.priceOracle.version)).map((m) => [m.priceOracle.address, m.priceOracle])
     );
   }
 }

package/dist/esm/sdk/router/createRouter.js

@@ -1,10 +1,11 @@
+import { isV300, isV310 } from "../constants/index.js";
 import { RouterV300Contract } from "./RouterV300Contract.js";
 import { RouterV310Contract } from "./RouterV310Contract.js";
 function createRouter(sdk, address, version) {
-  if (version >= 300 && version < 310) {
+  if (isV300(version)) {
     return new RouterV300Contract(sdk, address, version);
   }
-  if (version === 310) {
+  if (isV310(version)) {
     return new RouterV310Contract(sdk, address, version);
   }
   throw new Error(`Unsupported router version ${version}`);

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

@@ -10,4 +10,3 @@ export * from "./json.js";
 export * from "./mappers.js";
 export * from "./retry.js";
 export * from "./toAddress.js";
-export * from "./version.js";

package/dist/esm/zappers/ZappersPlugin.js

@@ -2,7 +2,8 @@ import { iPeripheryCompressorAbi } from "../abi/compressors.js";
 import {
   AddressMap,
   AP_PERIPHERY_COMPRESSOR,
-  SDKConstruct
+  SDKConstruct,
+  VERSION_RANGE_310
 } from "../sdk/index.js";
 class ZappersPlugin extends SDKConstruct {
   #zappers;
@@ -12,9 +13,9 @@ class ZappersPlugin extends SDKConstruct {
   }
   async loadZappers() {
     this.#zappers = new AddressMap(void 0, "zappers");
-    const pcAddr = this.sdk.addressProvider.getAddress(
+    const [pcAddr] = this.sdk.addressProvider.mustGetLatest(
       AP_PERIPHERY_COMPRESSOR,
-      310
+      VERSION_RANGE_310
     );
     this.sdk.logger?.debug(
       `loading zappers with periphery compressor ${pcAddr}`

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

@@ -6,4 +6,3 @@ export * from "./createTransport.js";
 export * from "./detectChain.js";
 export * from "./ltUtils.js";
 export * from "./migrateFaucet.js";
-export * from "./PriceFeedStore.js";

package/dist/types/sdk/constants/index.d.ts

@@ -4,3 +4,4 @@ export * from "./bot-permissions.js";
 export * from "./math.js";
 export * from "./networks.js";
 export * from "./periphery.js";
+export * from "./versions.js";

package/dist/types/sdk/constants/versions.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Version range, inclusive of both ends
+ */
+export type VersionRange = [number, number];
+export declare const VERSION_RANGE_300: VersionRange;
+export declare const VERSION_RANGE_310: VersionRange;
+export declare function isV300(version: number | bigint | string): boolean;
+export declare function isV310(version: number | bigint | string): boolean;
+export declare function isVersionRange(version: number | bigint | string, range: VersionRange): boolean;

package/dist/types/sdk/core/address-provider/AbstractAddressProviderContract.d.ts

@@ -1,6 +1,7 @@
 import { type Abi, type Address } from "viem";
 import type { BaseContractOptions } from "../../base/BaseContract.js";
 import { BaseContract } from "../../base/index.js";
+import type { VersionRange } from "../../constants/index.js";
 import type { GearboxSDK } from "../../GearboxSDK.js";
 import type { AddressProviderV3StateHuman } from "../../types/index.js";
 import type { AddressProviderState } from "./types.js";
@@ -9,8 +10,8 @@ export default abstract class AbstractAddressProviderContract<abi extends Abi |
     constructor(sdk: GearboxSDK, args: BaseContractOptions<abi>, addresses?: Record<string, Record<number, Address>>);
     protected setInternalAddress(key: string, address: Address, version: number): void;
     getAddress(contract: string, version?: number): Address;
-    getLatestVersion(contract: string): [address: Address, version: number];
-    getLatestInRange(contract: string, range: [number, number]): [address: Address, version: number] | undefined;
+    getLatest(contract: string, range: VersionRange): [address: Address, version: number] | undefined;
+    mustGetLatest(contract: string, range: VersionRange): [address: Address, version: number];
     get state(): AddressProviderState;
     stateHuman(raw?: boolean): AddressProviderV3StateHuman;
 }

package/dist/types/sdk/core/address-provider/types.d.ts

@@ -1,5 +1,6 @@
 import type { Address } from "viem";
 import type { BaseParams, IBaseContract } from "../../base/index.js";
+import type { VersionRange } from "../../constants/versions.js";
 import type { AddressProviderV3StateHuman } from "../../types/index.js";
 export interface AddressProviderState {
     baseParams: BaseParams;
@@ -8,8 +9,8 @@ export interface AddressProviderState {
 export interface IAddressProviderContract extends IBaseContract {
     state: AddressProviderState;
     getAddress: (contract: string, version?: number) => Address;
-    getLatestVersion: (contract: string) => [address: Address, version: number];
-    getLatestInRange: (contract: string, range: [number, number]) => [address: Address, version: number] | undefined;
+    getLatest: (contract: string, range: VersionRange) => [address: Address, version: number] | undefined;
+    mustGetLatest: (contract: string, range: VersionRange) => [address: Address, version: number];
     syncState: (blockNumber: bigint) => Promise<void>;
     stateHuman: (raw?: boolean) => AddressProviderV3StateHuman;
 }

package/dist/types/sdk/market/MarketSuite.d.ts

@@ -5,13 +5,13 @@ import type { GearboxSDK } from "../GearboxSDK.js";
 import type { MarketStateHuman } from "../types/index.js";
 import { CreditSuite } from "./credit/index.js";
 import { MarketConfiguratorContract } from "./MarketConfiguratorContract.js";
-import type { PriceOracleContract } from "./oracle/index.js";
+import type { IPriceOracleContract } from "./oracle/index.js";
 import { PoolSuite } from "./pool/index.js";
 export declare class MarketSuite extends SDKConstruct {
     readonly acl: Address;
     readonly configurator: MarketConfiguratorContract;
     readonly pool: PoolSuite;
-    readonly priceOracle: PriceOracleContract;
+    readonly priceOracle: IPriceOracleContract;
     readonly creditManagers: CreditSuite[];
     /**
      * Original data received from compressor