@gearbox-protocol/sdk 15.1.0-next.6 → 15.1.0-next.8

package/dist/types/model/history.d.ts

@@ -1,153 +0,0 @@
-import { Timestamp } from "./primitives.js";
-import { OpportunityKey } from "./opportunities.js";
-import { PositionKey } from "./positions.js";
-//#region src/model/history.d.ts
-/**
- * Historical time series of an opportunity.
- *
- * History is backend-only by construction: the chain serves the present, and
- * reconstructing a series from it would mean archive-node reads per point.
- **/
-/**
- * Time window a series covers, ending at the present.
- *
- * `"max"` is the full history the backend retains for the opportunity.
- **/
-type HistoryRange = "1d" | "1w" | "1m" | "1y" | "max";
-/**
- * Series available for a pool opportunity.
- **/
-type PoolHistoryMetric = "depositApy" | "borrowApy" | "dieselRate" | "supplied" | "borrowed" | "availableLiquidity";
-/**
- * Every {@link PoolHistoryMetric}, for callers that enumerate them.
- **/
-declare const POOL_HISTORY_METRICS: readonly ["depositApy", "borrowApy", "dieselRate", "supplied", "borrowed", "availableLiquidity"];
-/**
- * Series available for a strategy opportunity.
- *
- * `collateralPrice` is the collateral/underlying series a liquidation-price
- * chart draws; the two USD series are the same prices quoted in dollars.
- **/
-type StrategyHistoryMetric = "netApy" | "borrowApy" | "collateralApy" | "tvl" | "collateralPrice" | "collateralUsdPrice" | "underlyingUsdPrice";
-/**
- * Every {@link StrategyHistoryMetric}, for callers that enumerate them.
- **/
-declare const STRATEGY_HISTORY_METRICS: readonly ["netApy", "borrowApy", "collateralApy", "tvl", "collateralPrice", "collateralUsdPrice", "underlyingUsdPrice"];
-/**
- * Series available for a pool position.
- *
- * Spelled out rather than aliased to {@link PoolHistoryMetric}: an opportunity
- * and a position are separate contracts with the backend, and the position
- * series are expected to grow their own members (PnL above all) without that
- * change reaching the opportunity charts.
- **/
-type PoolPositionHistoryMetric = "depositApy" | "borrowApy" | "dieselRate" | "supplied" | "borrowed" | "availableLiquidity";
-/**
- * Every {@link PoolPositionHistoryMetric}, for callers that enumerate them.
- **/
-declare const POOL_POSITION_HISTORY_METRICS: readonly ["depositApy", "borrowApy", "dieselRate", "supplied", "borrowed", "availableLiquidity"];
-/**
- * Series available for a strategy position, see the note on
- * {@link PoolPositionHistoryMetric} for why these are spelled out separately
- * from {@link StrategyHistoryMetric}.
- **/
-type StrategyPositionHistoryMetric = "netApy" | "borrowApy" | "collateralApy" | "tvl" | "collateralPrice" | "collateralUsdPrice" | "underlyingUsdPrice";
-/**
- * Every {@link StrategyPositionHistoryMetric}, for callers that enumerate them.
- **/
-declare const STRATEGY_POSITION_HISTORY_METRICS: readonly ["netApy", "borrowApy", "collateralApy", "tvl", "collateralPrice", "collateralUsdPrice", "underlyingUsdPrice"];
-/**
- * Any series a position can return.
- **/
-type PositionHistoryMetric = PoolPositionHistoryMetric | StrategyPositionHistoryMetric;
-/**
- * Any series the read model can return.
- **/
-type HistoryMetric = PoolHistoryMetric | StrategyHistoryMetric | PositionHistoryMetric;
-/**
- * One sample of a series.
- **/
-interface HistoryPoint {
-  /**
-   * When the sample was taken.
-   **/
-  timestamp: Timestamp;
-  /**
-   * Sampled value. The unit follows from the metric: APY metrics are in basis
-   * points, amount metrics are in the underlying's base units expressed as a
-   * float, price metrics are plain prices.
-   *
-   * @example `842` for an 8.42% APY sample
-   **/
-  value: number;
-}
-/**
- * Annotations the backend ships alongside a series, e.g. what a chart drawn
- * from it should say beyond the points themselves.
- *
- * TODO: the backend has not specified this payload yet. It stays empty until
- * it does, so that filling it in later is additive rather than a rename.
- **/
-interface HistoryChartMetadata {}
-/**
- * A named series of samples ordered by ascending timestamp.
- *
- * @typeParam M - Metric the series carries.
- **/
-interface HistorySeries<M extends string = HistoryMetric> {
-  /**
-   * Metric the samples belong to; it also defines their unit, so no separate
-   * unit field ships.
-   **/
-  metric: M;
-  /**
-   * Samples, oldest first.
-   **/
-  points: HistoryPoint[];
-  /**
-   * What the backend says about the series, see {@link HistoryChartMetadata}.
-   **/
-  metadata: HistoryChartMetadata;
-}
-/**
- * A request for one series of a single opportunity.
- *
- * @typeParam M - Metric requested.
- **/
-interface OpportunityHistoryQuery<M extends HistoryMetric = HistoryMetric> {
-  /**
-   * Opportunity the series belongs to.
-   **/
-  opportunity: OpportunityKey;
-  /**
-   * Window to cover.
-   **/
-  range: HistoryRange;
-  /**
-   * Metric to return. A metric that does not apply to the opportunity's kind
-   * has no series.
-   **/
-  metric: M;
-}
-/**
- * A request for one series of a single position.
- *
- * @typeParam M - Metric requested.
- **/
-interface PositionHistoryQuery<M extends PositionHistoryMetric = PositionHistoryMetric> {
-  /**
-   * Position the series belongs to.
-   **/
-  position: PositionKey;
-  /**
-   * Window to cover.
-   **/
-  range: HistoryRange;
-  /**
-   * Metric to return. A metric that does not apply to the position's kind has
-   * no series.
-   **/
-  metric: M;
-}
-//#endregion
-export { HistoryChartMetadata, HistoryMetric, HistoryPoint, HistoryRange, HistorySeries, OpportunityHistoryQuery, POOL_HISTORY_METRICS, POOL_POSITION_HISTORY_METRICS, PoolHistoryMetric, PoolPositionHistoryMetric, PositionHistoryMetric, PositionHistoryQuery, STRATEGY_HISTORY_METRICS, STRATEGY_POSITION_HISTORY_METRICS, StrategyHistoryMetric, StrategyPositionHistoryMetric };

package/dist/types/model/history.schema.d.ts

@@ -1,95 +0,0 @@
-import { HistoryChartMetadata } from "./history.js";
-import { z } from "zod/v4";
-//#region src/model/history.schema.d.ts
-/**
- * Runtime schemas for {@link ./history.js}, see the note in
- * `primitives.schema.ts` on why they are written by hand.
- **/
-/**
- * {@link HistoryRange}
- **/
-declare const historyRangeSchema: z.ZodUnion<readonly [z.ZodLiteral<"1d">, z.ZodLiteral<"1w">, z.ZodLiteral<"1m">, z.ZodLiteral<"1y">, z.ZodLiteral<"max">]>;
-/**
- * {@link PoolHistoryMetric}
- **/
-declare const poolHistoryMetricSchema: z.ZodUnion<readonly [z.ZodLiteral<"depositApy">, z.ZodLiteral<"borrowApy">, z.ZodLiteral<"dieselRate">, z.ZodLiteral<"supplied">, z.ZodLiteral<"borrowed">, z.ZodLiteral<"availableLiquidity">]>;
-/**
- * {@link StrategyHistoryMetric}
- **/
-declare const strategyHistoryMetricSchema: z.ZodUnion<readonly [z.ZodLiteral<"netApy">, z.ZodLiteral<"borrowApy">, z.ZodLiteral<"collateralApy">, z.ZodLiteral<"tvl">, z.ZodLiteral<"collateralPrice">, z.ZodLiteral<"collateralUsdPrice">, z.ZodLiteral<"underlyingUsdPrice">]>;
-/**
- * {@link PoolPositionHistoryMetric}
- **/
-declare const poolPositionHistoryMetricSchema: z.ZodUnion<readonly [z.ZodLiteral<"depositApy">, z.ZodLiteral<"borrowApy">, z.ZodLiteral<"dieselRate">, z.ZodLiteral<"supplied">, z.ZodLiteral<"borrowed">, z.ZodLiteral<"availableLiquidity">]>;
-/**
- * {@link StrategyPositionHistoryMetric}
- **/
-declare const strategyPositionHistoryMetricSchema: z.ZodUnion<readonly [z.ZodLiteral<"netApy">, z.ZodLiteral<"borrowApy">, z.ZodLiteral<"collateralApy">, z.ZodLiteral<"tvl">, z.ZodLiteral<"collateralPrice">, z.ZodLiteral<"collateralUsdPrice">, z.ZodLiteral<"underlyingUsdPrice">]>;
-/**
- * {@link PositionHistoryMetric}
- **/
-declare const positionHistoryMetricSchema: z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodLiteral<"depositApy">, z.ZodLiteral<"borrowApy">, z.ZodLiteral<"dieselRate">, z.ZodLiteral<"supplied">, z.ZodLiteral<"borrowed">, z.ZodLiteral<"availableLiquidity">]>, z.ZodUnion<readonly [z.ZodLiteral<"netApy">, z.ZodLiteral<"borrowApy">, z.ZodLiteral<"collateralApy">, z.ZodLiteral<"tvl">, z.ZodLiteral<"collateralPrice">, z.ZodLiteral<"collateralUsdPrice">, z.ZodLiteral<"underlyingUsdPrice">]>]>;
-/**
- * {@link HistoryMetric}
- **/
-declare const historyMetricSchema: z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodLiteral<"depositApy">, z.ZodLiteral<"borrowApy">, z.ZodLiteral<"dieselRate">, z.ZodLiteral<"supplied">, z.ZodLiteral<"borrowed">, z.ZodLiteral<"availableLiquidity">]>, z.ZodUnion<readonly [z.ZodLiteral<"netApy">, z.ZodLiteral<"borrowApy">, z.ZodLiteral<"collateralApy">, z.ZodLiteral<"tvl">, z.ZodLiteral<"collateralPrice">, z.ZodLiteral<"collateralUsdPrice">, z.ZodLiteral<"underlyingUsdPrice">]>, z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodLiteral<"depositApy">, z.ZodLiteral<"borrowApy">, z.ZodLiteral<"dieselRate">, z.ZodLiteral<"supplied">, z.ZodLiteral<"borrowed">, z.ZodLiteral<"availableLiquidity">]>, z.ZodUnion<readonly [z.ZodLiteral<"netApy">, z.ZodLiteral<"borrowApy">, z.ZodLiteral<"collateralApy">, z.ZodLiteral<"tvl">, z.ZodLiteral<"collateralPrice">, z.ZodLiteral<"collateralUsdPrice">, z.ZodLiteral<"underlyingUsdPrice">]>]>]>;
-/**
- * {@link HistoryPoint}
- **/
-declare const historyPointSchema: z.ZodObject<{
-  timestamp: z.ZodNumber;
-  value: z.ZodNumber;
-}, z.core.$strip>;
-/**
- * {@link HistoryChartMetadata}
- *
- * TODO: empty until the backend specifies the payload.
- **/
-declare const historyChartMetadataSchema: z.ZodType<HistoryChartMetadata>;
-/**
- * {@link HistorySeries}
- **/
-declare const historySeriesSchema: z.ZodObject<{
-  metric: z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodLiteral<"depositApy">, z.ZodLiteral<"borrowApy">, z.ZodLiteral<"dieselRate">, z.ZodLiteral<"supplied">, z.ZodLiteral<"borrowed">, z.ZodLiteral<"availableLiquidity">]>, z.ZodUnion<readonly [z.ZodLiteral<"netApy">, z.ZodLiteral<"borrowApy">, z.ZodLiteral<"collateralApy">, z.ZodLiteral<"tvl">, z.ZodLiteral<"collateralPrice">, z.ZodLiteral<"collateralUsdPrice">, z.ZodLiteral<"underlyingUsdPrice">]>, z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodLiteral<"depositApy">, z.ZodLiteral<"borrowApy">, z.ZodLiteral<"dieselRate">, z.ZodLiteral<"supplied">, z.ZodLiteral<"borrowed">, z.ZodLiteral<"availableLiquidity">]>, z.ZodUnion<readonly [z.ZodLiteral<"netApy">, z.ZodLiteral<"borrowApy">, z.ZodLiteral<"collateralApy">, z.ZodLiteral<"tvl">, z.ZodLiteral<"collateralPrice">, z.ZodLiteral<"collateralUsdPrice">, z.ZodLiteral<"underlyingUsdPrice">]>]>]>;
-  points: z.ZodArray<z.ZodObject<{
-    timestamp: z.ZodNumber;
-    value: z.ZodNumber;
-  }, z.core.$strip>>;
-  metadata: z.ZodType<HistoryChartMetadata, unknown, z.core.$ZodTypeInternals<HistoryChartMetadata, unknown>>;
-}, z.core.$strip>;
-/**
- * {@link OpportunityHistoryQuery}
- **/
-declare const opportunityHistoryQuerySchema: z.ZodObject<{
-  opportunity: z.ZodDiscriminatedUnion<[z.ZodObject<{
-    chainId: z.ZodNumber;
-    pool: z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>;
-    kind: z.ZodLiteral<"pool">;
-  }, z.core.$strip>, z.ZodObject<{
-    chainId: z.ZodNumber;
-    creditManager: z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>;
-    targetCollateral: z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>;
-    kind: z.ZodLiteral<"strategy">;
-  }, z.core.$strip>], "kind">;
-  range: z.ZodUnion<readonly [z.ZodLiteral<"1d">, z.ZodLiteral<"1w">, z.ZodLiteral<"1m">, z.ZodLiteral<"1y">, z.ZodLiteral<"max">]>;
-  metric: z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodLiteral<"depositApy">, z.ZodLiteral<"borrowApy">, z.ZodLiteral<"dieselRate">, z.ZodLiteral<"supplied">, z.ZodLiteral<"borrowed">, z.ZodLiteral<"availableLiquidity">]>, z.ZodUnion<readonly [z.ZodLiteral<"netApy">, z.ZodLiteral<"borrowApy">, z.ZodLiteral<"collateralApy">, z.ZodLiteral<"tvl">, z.ZodLiteral<"collateralPrice">, z.ZodLiteral<"collateralUsdPrice">, z.ZodLiteral<"underlyingUsdPrice">]>, z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodLiteral<"depositApy">, z.ZodLiteral<"borrowApy">, z.ZodLiteral<"dieselRate">, z.ZodLiteral<"supplied">, z.ZodLiteral<"borrowed">, z.ZodLiteral<"availableLiquidity">]>, z.ZodUnion<readonly [z.ZodLiteral<"netApy">, z.ZodLiteral<"borrowApy">, z.ZodLiteral<"collateralApy">, z.ZodLiteral<"tvl">, z.ZodLiteral<"collateralPrice">, z.ZodLiteral<"collateralUsdPrice">, z.ZodLiteral<"underlyingUsdPrice">]>]>]>;
-}, z.core.$strip>;
-/**
- * {@link PositionHistoryQuery}
- **/
-declare const positionHistoryQuerySchema: z.ZodObject<{
-  position: z.ZodDiscriminatedUnion<[z.ZodObject<{
-    chainId: z.ZodNumber;
-    pool: z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>;
-    wallet: z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>;
-    kind: z.ZodLiteral<"pool">;
-  }, z.core.$strip>, z.ZodObject<{
-    chainId: z.ZodNumber;
-    creditAccount: z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>;
-    kind: z.ZodLiteral<"strategy">;
-  }, z.core.$strip>], "kind">;
-  range: z.ZodUnion<readonly [z.ZodLiteral<"1d">, z.ZodLiteral<"1w">, z.ZodLiteral<"1m">, z.ZodLiteral<"1y">, z.ZodLiteral<"max">]>;
-  metric: z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodLiteral<"depositApy">, z.ZodLiteral<"borrowApy">, z.ZodLiteral<"dieselRate">, z.ZodLiteral<"supplied">, z.ZodLiteral<"borrowed">, z.ZodLiteral<"availableLiquidity">]>, z.ZodUnion<readonly [z.ZodLiteral<"netApy">, z.ZodLiteral<"borrowApy">, z.ZodLiteral<"collateralApy">, z.ZodLiteral<"tvl">, z.ZodLiteral<"collateralPrice">, z.ZodLiteral<"collateralUsdPrice">, z.ZodLiteral<"underlyingUsdPrice">]>]>;
-}, z.core.$strip>;
-//#endregion
-export { historyChartMetadataSchema, historyMetricSchema, historyPointSchema, historyRangeSchema, historySeriesSchema, opportunityHistoryQuerySchema, poolHistoryMetricSchema, poolPositionHistoryMetricSchema, positionHistoryMetricSchema, positionHistoryQuerySchema, strategyHistoryMetricSchema, strategyPositionHistoryMetricSchema };

package/dist/types/new-sdk/utils/history.d.ts

@@ -1,18 +0,0 @@
-import { HistoryRange, HistorySeries } from "../../model/history.js";
-import { DataResponse } from "../../model/response.js";
-import "../../model/index.js";
-//#region src/new-sdk/utils/history.d.ts
-/**
- * Reads the charts of one subject, one metric and one range at a time.
- *
- * @typeParam Metric - Metrics the subject has.
- **/
-interface HistoryReader<Metric extends string> {
-  /**
-   * Historical chart of one metric over one window. A metric the subject does
-   * not have is a compile error.
-   **/
-  chart(metric: Metric, range: HistoryRange): Promise<DataResponse<HistorySeries<Metric>>>;
-}
-//#endregion
-export { HistoryReader };