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

package/dist/types/sdk/market/oracle/PriceOracleV300Contract.d.ts

@@ -353,7 +353,7 @@ declare const abi: ({
 })[];
 type abi = typeof abi;
 export declare class PriceOracleV300Contract extends PriceOracleBaseContract<abi> {
-    constructor(sdk: GearboxSDK, data: PriceOracleData, underlying: Address);
+    constructor(sdk: GearboxSDK, data: PriceOracleData);
     processLog(log: Log<bigint, number, false, undefined, undefined, abi, ContractEventName<abi>>): void;
     findTokenForPriceFeed(priceFeed: Address): [token: Address | undefined, reserve: boolean];
 }

package/dist/types/sdk/market/oracle/PriceOracleV310Contract.d.ts

@@ -1,4 +1,4 @@
-import type { Address, ContractEventName, Log } from "viem";
+import type { ContractEventName, Log } from "viem";
 import type { PriceOracleData } from "../../base/index.js";
 import type { GearboxSDK } from "../../GearboxSDK.js";
 import { PriceOracleBaseContract } from "./PriceOracleBaseContract.js";
@@ -339,7 +339,7 @@ declare const abi: readonly [{
 }];
 type abi = typeof abi;
 export declare class PriceOracleV310Contract extends PriceOracleBaseContract<abi> {
-    constructor(sdk: GearboxSDK, data: PriceOracleData, underlying: Address);
+    constructor(sdk: GearboxSDK, data: PriceOracleData);
     processLog(log: Log<bigint, number, false, undefined, undefined, abi, ContractEventName<abi>>): void;
 }
 export {};

package/dist/types/sdk/market/oracle/createPriceOracle.d.ts

@@ -1,5 +1,16 @@
-import type { Address } from "abitype";
 import type { PriceOracleData } from "../../base/index.js";
 import type { GearboxSDK } from "../../GearboxSDK.js";
-import type { PriceOracleContract } from "./types.js";
-export declare function createPriceOracle(sdk: GearboxSDK, data: PriceOracleData, underlying: Address): PriceOracleContract;
+import type { IPriceOracleContract } from "./types.js";
+/**
+ * Used get or create oracle contract instances
+ * In 3.0 we can have same oracle for different pools
+ * But also due to how compressor works for v3.0, each maketData.priceOracle data will have different tokens (for the same oracle)
+ *
+ * So this method bridges multiple compressor data pieces and single oracle contract isntance
+ *
+ * @param sdk
+ * @param data
+ * @param underlying
+ * @returns
+ */
+export declare function getOrCreatePriceOracle(sdk: GearboxSDK, data: PriceOracleData): IPriceOracleContract;

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

@@ -1,9 +1,10 @@
-import type { Address, Hex } from "viem";
+import type { Address, ContractFunctionParameters, ContractFunctionReturnType, Hex } from "viem";
+import type { iPriceFeedCompressorAbi } from "../../../abi/compressors.js";
 import type { IBaseContract } from "../../base/index.js";
-import type { PriceOracleV310Contract } from "../index.js";
-import type { IPriceFeedContract, UpdatePriceFeedsResult } from "../pricefeeds/index.js";
-import type { PriceOracleV300Contract } from "./PriceOracleV300Contract.js";
-export type PriceOracleContract = PriceOracleV300Contract | PriceOracleV310Contract;
+import type { PriceOracleStateHuman } from "../../types/index.js";
+import type { AddressMap } from "../../utils/index.js";
+import type { IPriceFeedContract, PriceFeedRef, UpdatePriceFeedsResult } from "../pricefeeds/index.js";
+import type PriceFeedAnswerMap from "./PriceFeedAnswerMap.js";
 export interface PriceFeedsForTokensOptions {
     main?: boolean;
     reserve?: boolean;
@@ -19,11 +20,101 @@ export interface OnDemandPriceUpdate {
     data: Hex;
 }
 export interface IPriceOracleContract extends IBaseContract {
+    mainPriceFeeds: AddressMap<PriceFeedRef>;
+    mainPrices: PriceFeedAnswerMap;
+    /**
+     * Gets main price for given token
+     * Throws if token price feed is not found or answer is not successful
+     * @param token
+     * @returns
+     */
+    mainPrice: (token: Address) => bigint;
+    reservePriceFeeds: AddressMap<PriceFeedRef>;
+    reservePrices: PriceFeedAnswerMap;
+    /**
+     * Gets reserve price for given token
+     * Throws if token price feed is not found or answer is not successful
+     * @param token
+     * @returns
+     */
+    reservePrice: (token: Address) => bigint;
+    /**
+     * Loads new prices for this oracle from PriceFeedCompressor
+     * Will (re)create price feeds if needed
+     */
+    updatePrices: () => Promise<void>;
+    /**
+     * Paired method to updatePrices, helps to update prices on all oracles in one multicall
+     */
+    syncStateMulticall: () => DelegatedOracleMulticall;
+    /**
+     * 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: Address) => boolean;
+    /**
+     * Helper method to find "attachment point" of price feed (makes sense for updatable price feeds only) -
+     * returns token (in v300 can be ticker) and main/reserve flag
+     *
+     * @deprecated Should be gone after v310 migration
+     *
+     * @param priceFeed
+     * @returns
+     */
+    findTokenForPriceFeed: (priceFeed: Address) => [token: Address | undefined, reserve: boolean];
+    /**
+     * Returns main and reserve price feeds for given tokens
+     * @param tokens
+     * @param opts Option to include main/reserve feeds only, defaults to both
+     * @returns
+     */
     priceFeedsForTokens: (tokens: Address[], opts?: PriceFeedsForTokensOptions) => IPriceFeedContract[];
+    /**
+     * Generates updates for all updateable price feeds in this oracle (including dependencies)
+     * @returns
+     */
     updatePriceFeeds: () => Promise<UpdatePriceFeedsResult>;
+    /**
+     * Converts previously obtained price updates into CreditFacade multicall entries
+     * @param creditFacade
+     * @param updates
+     * @returns
+     */
     onDemandPriceUpdates: (updates?: UpdatePriceFeedsResult) => OnDemandPriceUpdate[];
-    convertToUnderlying: (token: Address, amount: bigint, reserve?: boolean) => bigint;
+    /**
+     * Tries to convert amount of from one token to another, using latest known prices
+     * @param from
+     * @param to
+     * @param amount
+     * @param reserve use reserve price feed instead of main
+     */
     convert: (from: Address, to: Address, amount: bigint, reserve?: boolean) => bigint;
+    /**
+     * Tries to convert amount of token to USD, using latest known prices
+     * @param from
+     * @param amount
+     * @param reserve use reserve price feed instead of main
+     */
     convertToUSD: (from: Address, amount: bigint, reserve?: boolean) => bigint;
+    /**
+     * Tries to convert amount of USD to token, using latest known prices
+     * @param to
+     * @param amount
+     * @param reserve use reserve price feed instead of main
+     */
     convertFromUSD: (to: Address, amount: bigint, reserve?: boolean) => bigint;
+    /**
+     * Returns list of addresses that should be watched for events to sync state
+     */
+    watchAddresses: Set<Address>;
+    /**
+     * Returns human readable state of the oracle
+     */
+    stateHuman: (raw?: boolean) => PriceOracleStateHuman;
+}
+export interface DelegatedOracleMulticall {
+    call: ContractFunctionParameters<typeof iPriceFeedCompressorAbi, "view", "getPriceOracleState">;
+    onResult: (resp: ContractFunctionReturnType<typeof iPriceFeedCompressorAbi, "view", "getPriceOracleState">) => void;
 }

package/dist/types/sdk/plugins/V300StalenessPeriodPlugin.d.ts

@@ -13,8 +13,9 @@ export interface V300StalenessPeriodPluginState extends IPluginState {
     events: StalenessEvent[];
 }
 /**
- * PriceFeedCompressor returns 0 as staleness period for reserve price feeds
- * This is because v3.0 oracle contract cannot return staleness period for reserve price feeds
+ * PriceFeedCompressor returns 0 as staleness period for price feeds in v3.0
+ * This is because v3.0 oracle contract cannot return staleness period for reserve price feeds.
+ * But compressor returns 0 both for main and reserve price feeds.
  * This plugin is a workaround to load staleness periods using oracle events
  */
 export declare class V300StalenessPeriodPlugin extends SDKConstruct implements IGearboxSDKPlugin<V300StalenessPeriodPluginState> {

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

@@ -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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gearbox-protocol/sdk",
-  "version": "4.2.0-next.3",
+  "version": "5.0.0-next.2",
   "description": "Gearbox SDK",
   "license": "MIT",
   "main": "./dist/cjs/sdk/index.js",

package/dist/cjs/dev/PriceFeedStore.js

@@ -1,93 +0,0 @@
-"use strict";
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var PriceFeedStore_exports = {};
-__export(PriceFeedStore_exports, {
-  PriceFeedStore: () => PriceFeedStore
-});
-module.exports = __toCommonJS(PriceFeedStore_exports);
-var import_compressors = require("../abi/compressors.js");
-var import_iPriceFeedStore = require("../abi/iPriceFeedStore.js");
-var import_sdk = require("../sdk/index.js");
-class PriceFeedStore extends import_sdk.SDKConstruct {
-  #store;
-  #compressor;
-  #logger;
-  constructor(sdk) {
-    super(sdk);
-    this.#store = this.sdk.addressProvider.getAddress("PRICE_FEED_STORE");
-    [this.#compressor] = this.sdk.addressProvider.getLatestVersion(
-      import_sdk.AP_PRICE_FEED_COMPRESSOR
-    );
-    this.#logger = sdk.logger?.child?.({
-      module: "PriceFeedStore"
-    });
-  }
-  async load(update = true) {
-    const pfMap = await this.provider.publicClient.readContract({
-      address: this.#store,
-      abi: import_iPriceFeedStore.iPriceFeedStoreAbi,
-      functionName: "getTokenPriceFeedsMap"
-    });
-    const addresses = pfMap.flatMap((f) => f.priceFeeds);
-    const nodes = await this.#loadFromCompressor(addresses, update);
-    const result = new import_sdk.AddressMap();
-    for (const { token, priceFeeds } of pfMap) {
-      result.upsert(
-        token,
-        priceFeeds.map((pf) => nodes.find((n) => n.baseParams.addr === pf)).filter(Boolean)
-      );
-    }
-    return result;
-  }
-  async #loadFromCompressor(priceFeeds, update = true) {
-    let result = await this.provider.publicClient.readContract({
-      address: this.#compressor,
-      abi: import_compressors.iPriceFeedCompressorAbi,
-      functionName: "loadPriceFeedTree",
-      args: [priceFeeds]
-    });
-    if (update) {
-      const feeds = result.map((f) => this.sdk.priceFeeds.create(f));
-      const { txs } = await this.sdk.priceFeeds.generatePriceFeedsUpdateTxs(feeds);
-      const [resp] = await (0, import_sdk.simulateWithPriceUpdates)(
-        this.provider.publicClient,
-        {
-          priceUpdates: txs,
-          contracts: [
-            {
-              address: this.#compressor,
-              abi: import_compressors.iPriceFeedCompressorAbi,
-              functionName: "loadPriceFeedTree",
-              args: [priceFeeds]
-            }
-          ]
-        }
-      );
-      return resp;
-    }
-    this.#logger?.debug(
-      `loaded ${result.length} price feed nodes from compressor`
-    );
-    return [...result];
-  }
-}
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  PriceFeedStore
-});

package/dist/esm/dev/PriceFeedStore.js

@@ -1,74 +0,0 @@
-import { iPriceFeedCompressorAbi } from "../abi/compressors.js";
-import { iPriceFeedStoreAbi } from "../abi/iPriceFeedStore.js";
-import {
-  AddressMap,
-  AP_PRICE_FEED_COMPRESSOR,
-  SDKConstruct,
-  simulateWithPriceUpdates
-} from "../sdk/index.js";
-class PriceFeedStore extends SDKConstruct {
-  #store;
-  #compressor;
-  #logger;
-  constructor(sdk) {
-    super(sdk);
-    this.#store = this.sdk.addressProvider.getAddress("PRICE_FEED_STORE");
-    [this.#compressor] = this.sdk.addressProvider.getLatestVersion(
-      AP_PRICE_FEED_COMPRESSOR
-    );
-    this.#logger = sdk.logger?.child?.({
-      module: "PriceFeedStore"
-    });
-  }
-  async load(update = true) {
-    const pfMap = await this.provider.publicClient.readContract({
-      address: this.#store,
-      abi: iPriceFeedStoreAbi,
-      functionName: "getTokenPriceFeedsMap"
-    });
-    const addresses = pfMap.flatMap((f) => f.priceFeeds);
-    const nodes = await this.#loadFromCompressor(addresses, update);
-    const result = new AddressMap();
-    for (const { token, priceFeeds } of pfMap) {
-      result.upsert(
-        token,
-        priceFeeds.map((pf) => nodes.find((n) => n.baseParams.addr === pf)).filter(Boolean)
-      );
-    }
-    return result;
-  }
-  async #loadFromCompressor(priceFeeds, update = true) {
-    let result = await this.provider.publicClient.readContract({
-      address: this.#compressor,
-      abi: iPriceFeedCompressorAbi,
-      functionName: "loadPriceFeedTree",
-      args: [priceFeeds]
-    });
-    if (update) {
-      const feeds = result.map((f) => this.sdk.priceFeeds.create(f));
-      const { txs } = await this.sdk.priceFeeds.generatePriceFeedsUpdateTxs(feeds);
-      const [resp] = await simulateWithPriceUpdates(
-        this.provider.publicClient,
-        {
-          priceUpdates: txs,
-          contracts: [
-            {
-              address: this.#compressor,
-              abi: iPriceFeedCompressorAbi,
-              functionName: "loadPriceFeedTree",
-              args: [priceFeeds]
-            }
-          ]
-        }
-      );
-      return resp;
-    }
-    this.#logger?.debug(
-      `loaded ${result.length} price feed nodes from compressor`
-    );
-    return [...result];
-  }
-}
-export {
-  PriceFeedStore
-};

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

@@ -1,10 +0,0 @@
-function isV300(version) {
-  return version >= 300 && version < 310;
-}
-function isV310(version) {
-  return version >= 310 && version < 320;
-}
-export {
-  isV300,
-  isV310
-};

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

@@ -1,10 +0,0 @@
-import type { AbiParametersToPrimitiveTypes, ExtractAbiFunction } from "abitype";
-import { iPriceFeedStoreAbi } from "../abi/iPriceFeedStore.js";
-import type { GearboxSDK, PriceFeedTreeNode, Unarray } from "../sdk/index.js";
-import { AddressMap, SDKConstruct } from "../sdk/index.js";
-export type ConnectedPriceFeed = Unarray<AbiParametersToPrimitiveTypes<ExtractAbiFunction<typeof iPriceFeedStoreAbi, "getTokenPriceFeedsMap">["outputs"]>[0]>;
-export declare class PriceFeedStore extends SDKConstruct {
-    #private;
-    constructor(sdk: GearboxSDK);
-    load(update?: boolean): Promise<AddressMap<PriceFeedTreeNode[]>>;
-}

package/dist/types/sdk/utils/version.d.ts

@@ -1,2 +0,0 @@
-export declare function isV300(version: number): boolean;
-export declare function isV310(version: number): boolean;