@gearbox-protocol/sdk 12.9.8 → 12.10.0

package/dist/esm/sdk/market/pricefeeds/updates/PythUpdater.js

@@ -1,158 +0,0 @@
-import { z } from "zod/v4";
-import { SDKConstruct } from "../../../base/index.js";
-import { fetchPythPayloads } from "./fetchPythPayloads.js";
-import { PriceUpdatesCache } from "./PriceUpdatesCache.js";
-import { PriceUpdateTx } from "./PriceUpdateTx.js";
-class PythUpdateTx extends PriceUpdateTx {
-  name = "pyth";
-}
-const PythOptions = z.object({
-  /**
-   * Fixed pyth historic timestamp in seconds
-   * Set to true to enable pyth historical mode using timestamp from attach block
-   */
-  historicTimestamp: z.union([z.number().nonnegative(), z.literal(true)]).optional(),
-  /**
-   * Override Hermes API with this proxy. Can be used to set caching proxies, to avoid rate limiting
-   */
-  apiProxy: z.url().optional(),
-  /**
-   * TTL for pyth cache in milliseconds
-   * If 0, disables caching
-   * If not set, uses some default value
-   * Cache is always enabled in historical mode
-   */
-  cacheTTL: z.number().nonnegative().optional(),
-  /**
-   * When true, no error will be thrown when pyth is unable to fetch data for some feeds
-   */
-  ignoreMissingFeeds: z.boolean().optional()
-});
-class PythUpdater extends SDKConstruct {
-  #cache;
-  #historicalTimestamp;
-  #apiProxy;
-  #ignoreMissingFeeds;
-  constructor(sdk, opts = {}) {
-    super(sdk);
-    const { apiProxy, cacheTTL, ignoreMissingFeeds, historicTimestamp } = opts;
-    this.#ignoreMissingFeeds = ignoreMissingFeeds;
-    this.#apiProxy = apiProxy;
-    if (historicTimestamp) {
-      this.#historicalTimestamp = historicTimestamp === true ? Number(this.sdk.timestamp) : historicTimestamp;
-      this.logger?.debug(
-        `using historical timestamp ${this.#historicalTimestamp}`
-      );
-    }
-    this.#cache = PriceUpdatesCache.get("pyth", {
-      // currently staleness period is 240 seconds on all networks, add some buffer
-      // this period of 4 minutes is selected based on time that is required for user to sign transaction with wallet
-      // so it's unlikely to decrease
-      ttl: cacheTTL ?? 225 * 1e3,
-      historical: !!historicTimestamp
-    });
-  }
-  async getUpdateTxs(feeds) {
-    if (feeds.length === 0) {
-      return [];
-    }
-    this.logger?.debug(
-      `generating update transactions for ${feeds.length} pyth price feeds`
-    );
-    const pythFeeds = new Map(
-      feeds.filter(isPyth).map((f) => [f.priceFeedId, f])
-    );
-    const payloads = await this.#getPayloads(new Set(pythFeeds.keys()));
-    let [minTimestamp, maxTimestamp] = [Number.POSITIVE_INFINITY, 0];
-    const results = [];
-    for (const p of payloads) {
-      const priceFeed = pythFeeds.get(p.dataFeedId);
-      if (!priceFeed) {
-        throw new Error(`cannot find price feed for ${p.dataFeedId}`);
-      }
-      const { dataFeedId, timestamp, cached, data } = p;
-      minTimestamp = Math.min(minTimestamp, timestamp);
-      maxTimestamp = Math.max(maxTimestamp, timestamp);
-      results.push(
-        new PythUpdateTx(priceFeed.createPriceUpdateTx(data), {
-          dataFeedId,
-          priceFeed: priceFeed.address,
-          timestamp,
-          cached
-        })
-      );
-    }
-    let tsRange = "";
-    if (results.length) {
-      const minDelta = BigInt(minTimestamp) - this.sdk.timestamp;
-      tsRange = `, timestamps ${minTimestamp} (${minDelta})`;
-      if (minTimestamp !== maxTimestamp) {
-        const maxDelta = BigInt(maxTimestamp) - this.sdk.timestamp;
-        tsRange = `${tsRange} - ${maxTimestamp} (${maxDelta})`;
-      }
-    }
-    this.logger?.debug(
-      `generated ${results.length} update transactions for pyth price feeds: ${Array.from(pythFeeds.keys()).join(", ")}${tsRange}`
-    );
-    return results;
-  }
-  /**
-   * Gets pyth payloads
-   * @param dataFeedsIds
-   * @returns
-   */
-  async #getPayloads(dataFeedsIds) {
-    this.logger?.debug(
-      `getting pyth payloads for ${dataFeedsIds.size} price feeds: ${Array.from(dataFeedsIds).join(", ")}`
-    );
-    const fromCache = [];
-    const uncached = [];
-    for (const priceFeedsId of dataFeedsIds) {
-      const cached = this.#cache.get(priceFeedsId);
-      if (cached) {
-        fromCache.push({ ...cached, cached: true });
-      } else {
-        uncached.push(priceFeedsId);
-      }
-    }
-    const fromPyth = await this.#fetchPayloads(
-      new Set(uncached)
-    );
-    for (const resp of fromPyth) {
-      this.#cache.set(resp, resp.dataFeedId);
-    }
-    this.logger?.debug(
-      `got ${fromPyth.length} new pyth updates and ${fromCache.length} from cache`
-    );
-    return [...fromCache, ...fromPyth];
-  }
-  /**
-   * Fetches pyth payloads from Hermes API
-   * @param dataFeedsIds
-   * @returns
-   */
-  async #fetchPayloads(dataFeedsIds) {
-    if (dataFeedsIds.size === 0) {
-      return [];
-    }
-    const ids = Array.from(dataFeedsIds);
-    const tsStr = this.#historicalTimestamp ? ` with historical timestamp ${this.#historicalTimestamp}` : "";
-    this.logger?.debug(
-      `fetching pyth payloads for ${dataFeedsIds.size} price feeds: ${ids.join(", ")}${tsStr}`
-    );
-    return fetchPythPayloads({
-      dataFeedsIds,
-      historicalTimestampSeconds: this.#historicalTimestamp,
-      apiProxy: this.#apiProxy,
-      ignoreMissingFeeds: this.#ignoreMissingFeeds,
-      logger: this.logger
-    });
-  }
-}
-function isPyth(pf) {
-  return pf.contractType === "PRICE_FEED::PYTH";
-}
-export {
-  PythOptions,
-  PythUpdater
-};

package/dist/esm/sdk/market/pricefeeds/updates/fetchPythPayloads.js

@@ -1,115 +0,0 @@
-import { Buffer } from "buffer";
-import { encodeAbiParameters, toHex } from "viem";
-import { retry } from "../../../utils/index.js";
-import {
-  parseAccumulatorUpdateData,
-  parsePriceFeedMessage,
-  sliceAccumulatorUpdateData
-} from "./PythAccumulatorUpdateData.js";
-async function fetchPythPayloads(options) {
-  const {
-    dataFeedsIds,
-    ignoreMissingFeeds,
-    historicalTimestampSeconds,
-    logger,
-    apiProxy,
-    customFetch = fetch,
-    returnPrices
-  } = options;
-  const ids = Array.from(new Set(dataFeedsIds));
-  if (ids.length === 0) {
-    return [];
-  }
-  let api = apiProxy ?? "https://hermes.pyth.network/v2/updates/price/";
-  api = api.endsWith("/") ? api : `${api}/`;
-  const url = new URL(api + (historicalTimestampSeconds ?? "latest"));
-  url.searchParams.append("parsed", returnPrices ? "true" : "false");
-  if (ignoreMissingFeeds) {
-    url.searchParams.append("ignore_invalid_price_ids", "true");
-  }
-  for (const id of dataFeedsIds) {
-    url.searchParams.append("ids[]", id);
-  }
-  const resp = await retry(
-    async () => {
-      const resp2 = await customFetch(url.toString());
-      if (!resp2.ok) {
-        const body = await resp2.text();
-        throw new Error(
-          `failed to fetch pyth payloads: ${resp2.statusText}: ${body}`
-        );
-      }
-      const data = await resp2.json();
-      return data;
-    },
-    { attempts: 3, exponent: 2, interval: 200 }
-  );
-  const result = respToCalldata(resp, returnPrices);
-  if (result.length !== ids.length) {
-    if (ignoreMissingFeeds) {
-      logger?.warn(`expected ${ids.length} price feeds, got ${result.length}`);
-    } else {
-      throw new Error(
-        `expected ${ids.length} price feeds, got ${result.length}`
-      );
-    }
-  }
-  return result;
-}
-function respToCalldata(resp, returnPrices) {
-  if (resp.binary.data.length === 0) {
-    return [];
-  }
-  const updates = splitAccumulatorUpdates(resp.binary.data[0]);
-  const priceMap = /* @__PURE__ */ new Map();
-  if (returnPrices && resp.parsed) {
-    for (const feed of resp.parsed) {
-      const feedId = feed.id.startsWith("0x") ? feed.id : `0x${feed.id}`;
-      priceMap.set(feedId.toLowerCase(), {
-        price: BigInt(feed.price.price),
-        decimals: Math.abs(feed.price.expo)
-      });
-    }
-  }
-  return updates.map(({ data, dataFeedId, timestamp }) => {
-    const base = {
-      dataFeedId,
-      data: encodeAbiParameters(
-        [{ type: "uint256" }, { type: "bytes[]" }],
-        [BigInt(timestamp), [data]]
-      ),
-      timestamp,
-      cached: false
-    };
-    if (returnPrices) {
-      const priceInfo = priceMap.get(dataFeedId.toLowerCase());
-      if (!priceInfo) {
-        throw new Error(`Price info not found for feed ${dataFeedId}`);
-      }
-      return {
-        ...base,
-        price: priceInfo.price,
-        decimals: priceInfo.decimals
-      };
-    }
-    return base;
-  });
-}
-function splitAccumulatorUpdates(binary) {
-  const data = Buffer.from(binary, "hex");
-  const parsed = parseAccumulatorUpdateData(data);
-  const results = [];
-  for (let i = 0; i < parsed.updates.length; i++) {
-    const upd = parsed.updates[i].message;
-    const msg = parsePriceFeedMessage(upd);
-    results.push({
-      dataFeedId: toHex(msg.feedId),
-      timestamp: msg.publishTime.toNumber(),
-      data: toHex(sliceAccumulatorUpdateData(data, i, i + 1))
-    });
-  }
-  return results;
-}
-export {
-  fetchPythPayloads
-};

package/dist/types/sdk/market/pricefeeds/updates/PythAccumulatorUpdateData.d.ts

@@ -1,41 +0,0 @@
-/**
- * This is https://github.com/pyth-network/pyth-crosschain/blob/main/price_service/sdk/js/src/AccumulatorUpdateData.ts
- * modified to use buffer from npm package
- */
-import BN from "bn.js";
-import { Buffer } from "buffer";
-export type AccumulatorUpdateData = {
-    vaa: Buffer;
-    updates: {
-        message: Buffer;
-        proof: number[][];
-    }[];
-};
-export type PriceFeedMessage = {
-    feedId: Buffer;
-    price: BN;
-    confidence: BN;
-    exponent: number;
-    publishTime: BN;
-    prevPublishTime: BN;
-    emaPrice: BN;
-    emaConf: BN;
-};
-export type TwapMessage = {
-    feedId: Buffer;
-    cumulativePrice: BN;
-    cumulativeConf: BN;
-    numDownSlots: BN;
-    exponent: number;
-    publishTime: BN;
-    prevPublishTime: BN;
-    publishSlot: BN;
-};
-export declare function isAccumulatorUpdateData(updateBytes: Buffer): boolean;
-export declare function parsePriceFeedMessage(message: Buffer): PriceFeedMessage;
-export declare function parseTwapMessage(message: Buffer): TwapMessage;
-/**
- * An AccumulatorUpdateData contains a VAA and a list of updates. This function returns a new serialized AccumulatorUpdateData with only the updates in the range [start, end).
- */
-export declare function sliceAccumulatorUpdateData(data: Buffer, start?: number, end?: number): Buffer;
-export declare function parseAccumulatorUpdateData(data: Buffer): AccumulatorUpdateData;

package/dist/types/sdk/market/pricefeeds/updates/PythUpdater.d.ts

@@ -1,26 +0,0 @@
-import { z } from "zod/v4";
-import { SDKConstruct } from "../../../base/index.js";
-import type { GearboxSDK } from "../../../GearboxSDK.js";
-import type { IPriceFeedContract } from "../types.js";
-import { PriceUpdateTx } from "./PriceUpdateTx.js";
-import type { IPriceUpdater, IPriceUpdateTask } from "./types.js";
-export type PythUpdateTask = IPriceUpdateTask;
-declare class PythUpdateTx extends PriceUpdateTx<PythUpdateTask> {
-    readonly name = "pyth";
-}
-export declare const PythOptions: z.ZodObject<{
-    historicTimestamp: z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodLiteral<true>]>>;
-    apiProxy: z.ZodOptional<z.ZodURL>;
-    cacheTTL: z.ZodOptional<z.ZodNumber>;
-    ignoreMissingFeeds: z.ZodOptional<z.ZodBoolean>;
-}, z.core.$strip>;
-export type PythOptions = z.infer<typeof PythOptions>;
-/**
- * Class to update multiple pyth price feeds at once
- */
-export declare class PythUpdater extends SDKConstruct implements IPriceUpdater<PythUpdateTask> {
-    #private;
-    constructor(sdk: GearboxSDK, opts?: PythOptions);
-    getUpdateTxs(feeds: IPriceFeedContract[]): Promise<PythUpdateTx[]>;
-}
-export {};

package/dist/types/sdk/market/pricefeeds/updates/fetchPythPayloads.d.ts

@@ -1,45 +0,0 @@
-import type { ILogger } from "../../../types/logger.js";
-import type { TimestampedCalldata, TimestampedCalldataWithPrice } from "./types.js";
-export interface FetchPythPayloadsOptions {
-    /**
-     * Feeds to fetch
-     */
-    dataFeedsIds: Iterable<string>;
-    /**
-     * When true, will not throw an error if pyth is unable to fetch data for some feeds
-     */
-    ignoreMissingFeeds?: boolean;
-    /**
-     * Historical timestamp in seconds
-     */
-    historicalTimestampSeconds?: number;
-    /**
-     * Override Hermes API with this proxy. Can be used to set caching proxies, to avoid rate limiting
-     */
-    apiProxy?: string;
-    /**
-     * Logger to use
-     */
-    logger?: ILogger;
-    /**
-     * Custom fetch function to use instead of global fetch.
-     * Can be used to add custom headers, authentication, or use a different HTTP client.
-     */
-    customFetch?: typeof fetch;
-    /**
-     * When true, returns the price data for each feed.
-     */
-    returnPrices?: boolean;
-}
-/**
- * Fetches pyth payloads from Hermes API with price data
- */
-export declare function fetchPythPayloads(options: FetchPythPayloadsOptions & {
-    returnPrices: true;
-}): Promise<TimestampedCalldataWithPrice[]>;
-/**
- * Fetches pyth payloads from Hermes API
- */
-export declare function fetchPythPayloads(options: FetchPythPayloadsOptions & {
-    returnPrices?: false;
-}): Promise<TimestampedCalldata[]>;