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

package/dist/types/offchain/opportunities/OffchainOpportunities.d.ts

@@ -1,9 +1,13 @@
-import { Opportunity, OpportunityFilter, PoolOpportunityDetail, PoolOpportunityKey, StrategyOpportunityDetail, StrategyOpportunityKey } from "../../model/opportunities.js";
-import { HistoryMetric, HistorySeries, OpportunityHistoryQuery } from "../../model/history.js";
+import { ChartBundle, ChartRange, PoolOpportunityChartMetric, StrategyOpportunityChartMetric } from "../../model/charts.js";
+import { Opportunity, OpportunityFilter, OpportunityKey, PoolOpportunityDetail, PoolOpportunityKey, StrategyOpportunityDetail, StrategyOpportunityKey } from "../../model/opportunities.js";
 import { DataResponse } from "../../model/response.js";
 import { GearboxAPIOptions } from "../types.js";
 import { AbstractOffchainNamespace } from "../AbstractOffchainNamespace.js";
 //#region src/offchain/opportunities/OffchainOpportunities.d.ts
+type OpportunityChartMetricFor<K extends OpportunityKey> = {
+  pool: PoolOpportunityChartMetric;
+  strategy: StrategyOpportunityChartMetric;
+}[K["kind"]];
 /**
  * Backend counterpart of the `opportunities` namespace.
  **/
@@ -24,9 +28,9 @@ declare class OffchainOpportunities extends AbstractOffchainNamespace {
    **/
   getStrategy(key: StrategyOpportunityKey): Promise<DataResponse<StrategyOpportunityDetail>>;
   /**
-   * One historical series of one opportunity
+   * Charts of one opportunity: one series per metric, on a shared grid.
    **/
-  getHistory<M extends HistoryMetric>(query: OpportunityHistoryQuery<M>): Promise<DataResponse<HistorySeries<M>>>;
+  getCharts<K extends OpportunityKey, const Metrics extends readonly OpportunityChartMetricFor<K>[]>(key: K, metrics: Metrics, range: ChartRange): Promise<DataResponse<ChartBundle<Metrics>>>;
 }
 //#endregion
 export { OffchainOpportunities };

package/dist/types/offchain/positions/OffchainPositions.d.ts

@@ -1,10 +1,14 @@
-import { Position } from "../../model/positions.js";
-import { HistorySeries, PositionHistoryMetric, PositionHistoryQuery } from "../../model/history.js";
+import { ChartBundle, ChartRange, PoolPositionChartMetric, StrategyPositionChartMetric } from "../../model/charts.js";
+import { Position, PositionKey } from "../../model/positions.js";
 import { DataResponse } from "../../model/response.js";
 import { ListPositionsPropsBase } from "../../sdk/positions/types.js";
 import { GearboxAPIOptions } from "../types.js";
 import { AbstractOffchainNamespace } from "../AbstractOffchainNamespace.js";
 //#region src/offchain/positions/OffchainPositions.d.ts
+type PositionChartMetricFor<K extends PositionKey> = {
+  pool: PoolPositionChartMetric;
+  strategy: StrategyPositionChartMetric;
+}[K["kind"]];
 /**
  * Backend counterpart of the `positions` namespace.
  **/
@@ -16,11 +20,13 @@ declare class OffchainPositions extends AbstractOffchainNamespace {
    **/
   list(props: ListPositionsPropsBase): Promise<DataResponse<Position[]>>;
   /**
-   * One historical series of one position.
+   * Charts of one position: one series per metric, on a shared grid.
    *
-   * @returns An empty series until the backend client is implemented.
+   * @throws {OffchainNotImplementedError} Until the backend serves it. An empty
+   * bundle would be the one answer this model exists to rule out: a chart that
+   * could not be read is not a chart with no points.
    **/
-  getHistory<M extends PositionHistoryMetric>(query: PositionHistoryQuery<M>): Promise<DataResponse<HistorySeries<M>>>;
+  getCharts<K extends PositionKey, const Metrics extends readonly PositionChartMetricFor<K>[]>(key: K, _metrics: Metrics, _range: ChartRange): Promise<DataResponse<ChartBundle<Metrics>>>;
 }
 //#endregion
 export { OffchainPositions };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gearbox-protocol/sdk",
-  "version": "15.1.0-next.7",
+  "version": "15.1.0-next.8",
   "description": "Gearbox SDK",
   "license": "MIT",
   "repository": {

package/dist/cjs/model/history.js

@@ -1,53 +0,0 @@
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-//#region src/model/history.ts
-/**
-* Every {@link PoolHistoryMetric}, for callers that enumerate them.
-**/
-const POOL_HISTORY_METRICS = [
-	"depositApy",
-	"borrowApy",
-	"dieselRate",
-	"supplied",
-	"borrowed",
-	"availableLiquidity"
-];
-/**
-* Every {@link StrategyHistoryMetric}, for callers that enumerate them.
-**/
-const STRATEGY_HISTORY_METRICS = [
-	"netApy",
-	"borrowApy",
-	"collateralApy",
-	"tvl",
-	"collateralPrice",
-	"collateralUsdPrice",
-	"underlyingUsdPrice"
-];
-/**
-* Every {@link PoolPositionHistoryMetric}, for callers that enumerate them.
-**/
-const POOL_POSITION_HISTORY_METRICS = [
-	"depositApy",
-	"borrowApy",
-	"dieselRate",
-	"supplied",
-	"borrowed",
-	"availableLiquidity"
-];
-/**
-* Every {@link StrategyPositionHistoryMetric}, for callers that enumerate them.
-**/
-const STRATEGY_POSITION_HISTORY_METRICS = [
-	"netApy",
-	"borrowApy",
-	"collateralApy",
-	"tvl",
-	"collateralPrice",
-	"collateralUsdPrice",
-	"underlyingUsdPrice"
-];
-//#endregion
-exports.POOL_HISTORY_METRICS = POOL_HISTORY_METRICS;
-exports.POOL_POSITION_HISTORY_METRICS = POOL_POSITION_HISTORY_METRICS;
-exports.STRATEGY_HISTORY_METRICS = STRATEGY_HISTORY_METRICS;
-exports.STRATEGY_POSITION_HISTORY_METRICS = STRATEGY_POSITION_HISTORY_METRICS;

package/dist/cjs/model/history.schema.js

@@ -1,128 +0,0 @@
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const require_model_primitives_schema = require("./primitives.schema.js");
-const require_model_opportunities_schema = require("./opportunities.schema.js");
-const require_model_positions_schema = require("./positions.schema.js");
-let zod_v4 = require("zod/v4");
-//#region src/model/history.schema.ts
-/**
-* Runtime schemas for {@link ./history.js}, see the note in
-* `primitives.schema.ts` on why they are written by hand.
-**/
-/**
-* {@link HistoryRange}
-**/
-const historyRangeSchema = zod_v4.z.union([
-	zod_v4.z.literal("1d"),
-	zod_v4.z.literal("1w"),
-	zod_v4.z.literal("1m"),
-	zod_v4.z.literal("1y"),
-	zod_v4.z.literal("max")
-]);
-/**
-* {@link PoolHistoryMetric}
-**/
-const poolHistoryMetricSchema = zod_v4.z.union([
-	zod_v4.z.literal("depositApy"),
-	zod_v4.z.literal("borrowApy"),
-	zod_v4.z.literal("dieselRate"),
-	zod_v4.z.literal("supplied"),
-	zod_v4.z.literal("borrowed"),
-	zod_v4.z.literal("availableLiquidity")
-]);
-/**
-* {@link StrategyHistoryMetric}
-**/
-const strategyHistoryMetricSchema = zod_v4.z.union([
-	zod_v4.z.literal("netApy"),
-	zod_v4.z.literal("borrowApy"),
-	zod_v4.z.literal("collateralApy"),
-	zod_v4.z.literal("tvl"),
-	zod_v4.z.literal("collateralPrice"),
-	zod_v4.z.literal("collateralUsdPrice"),
-	zod_v4.z.literal("underlyingUsdPrice")
-]);
-/**
-* {@link PoolPositionHistoryMetric}
-**/
-const poolPositionHistoryMetricSchema = zod_v4.z.union([
-	zod_v4.z.literal("depositApy"),
-	zod_v4.z.literal("borrowApy"),
-	zod_v4.z.literal("dieselRate"),
-	zod_v4.z.literal("supplied"),
-	zod_v4.z.literal("borrowed"),
-	zod_v4.z.literal("availableLiquidity")
-]);
-/**
-* {@link StrategyPositionHistoryMetric}
-**/
-const strategyPositionHistoryMetricSchema = zod_v4.z.union([
-	zod_v4.z.literal("netApy"),
-	zod_v4.z.literal("borrowApy"),
-	zod_v4.z.literal("collateralApy"),
-	zod_v4.z.literal("tvl"),
-	zod_v4.z.literal("collateralPrice"),
-	zod_v4.z.literal("collateralUsdPrice"),
-	zod_v4.z.literal("underlyingUsdPrice")
-]);
-/**
-* {@link PositionHistoryMetric}
-**/
-const positionHistoryMetricSchema = zod_v4.z.union([poolPositionHistoryMetricSchema, strategyPositionHistoryMetricSchema]);
-/**
-* {@link HistoryMetric}
-**/
-const historyMetricSchema = zod_v4.z.union([
-	poolHistoryMetricSchema,
-	strategyHistoryMetricSchema,
-	positionHistoryMetricSchema
-]);
-/**
-* {@link HistoryPoint}
-**/
-const historyPointSchema = zod_v4.z.object({
-	timestamp: require_model_primitives_schema.timestampSchema,
-	value: zod_v4.z.number()
-});
-/**
-* {@link HistoryChartMetadata}
-*
-* TODO: empty until the backend specifies the payload.
-**/
-const historyChartMetadataSchema = zod_v4.z.object({});
-/**
-* {@link HistorySeries}
-**/
-const historySeriesSchema = zod_v4.z.object({
-	metric: historyMetricSchema,
-	points: zod_v4.z.array(historyPointSchema),
-	metadata: historyChartMetadataSchema
-});
-/**
-* {@link OpportunityHistoryQuery}
-**/
-const opportunityHistoryQuerySchema = zod_v4.z.object({
-	opportunity: require_model_opportunities_schema.opportunityKeySchema,
-	range: historyRangeSchema,
-	metric: historyMetricSchema
-});
-/**
-* {@link PositionHistoryQuery}
-**/
-const positionHistoryQuerySchema = zod_v4.z.object({
-	position: require_model_positions_schema.positionKeySchema,
-	range: historyRangeSchema,
-	metric: positionHistoryMetricSchema
-});
-//#endregion
-exports.historyChartMetadataSchema = historyChartMetadataSchema;
-exports.historyMetricSchema = historyMetricSchema;
-exports.historyPointSchema = historyPointSchema;
-exports.historyRangeSchema = historyRangeSchema;
-exports.historySeriesSchema = historySeriesSchema;
-exports.opportunityHistoryQuerySchema = opportunityHistoryQuerySchema;
-exports.poolHistoryMetricSchema = poolHistoryMetricSchema;
-exports.poolPositionHistoryMetricSchema = poolPositionHistoryMetricSchema;
-exports.positionHistoryMetricSchema = positionHistoryMetricSchema;
-exports.positionHistoryQuerySchema = positionHistoryQuerySchema;
-exports.strategyHistoryMetricSchema = strategyHistoryMetricSchema;
-exports.strategyPositionHistoryMetricSchema = strategyPositionHistoryMetricSchema;

package/dist/cjs/new-sdk/utils/history.js

@@ -1 +0,0 @@
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });

package/dist/esm/model/history.js

@@ -1,49 +0,0 @@
-//#region src/model/history.ts
-/**
-* Every {@link PoolHistoryMetric}, for callers that enumerate them.
-**/
-const POOL_HISTORY_METRICS = [
-	"depositApy",
-	"borrowApy",
-	"dieselRate",
-	"supplied",
-	"borrowed",
-	"availableLiquidity"
-];
-/**
-* Every {@link StrategyHistoryMetric}, for callers that enumerate them.
-**/
-const STRATEGY_HISTORY_METRICS = [
-	"netApy",
-	"borrowApy",
-	"collateralApy",
-	"tvl",
-	"collateralPrice",
-	"collateralUsdPrice",
-	"underlyingUsdPrice"
-];
-/**
-* Every {@link PoolPositionHistoryMetric}, for callers that enumerate them.
-**/
-const POOL_POSITION_HISTORY_METRICS = [
-	"depositApy",
-	"borrowApy",
-	"dieselRate",
-	"supplied",
-	"borrowed",
-	"availableLiquidity"
-];
-/**
-* Every {@link StrategyPositionHistoryMetric}, for callers that enumerate them.
-**/
-const STRATEGY_POSITION_HISTORY_METRICS = [
-	"netApy",
-	"borrowApy",
-	"collateralApy",
-	"tvl",
-	"collateralPrice",
-	"collateralUsdPrice",
-	"underlyingUsdPrice"
-];
-//#endregion
-export { POOL_HISTORY_METRICS, POOL_POSITION_HISTORY_METRICS, STRATEGY_HISTORY_METRICS, STRATEGY_POSITION_HISTORY_METRICS };

package/dist/esm/model/history.schema.js

@@ -1,116 +0,0 @@
-import { timestampSchema } from "./primitives.schema.js";
-import { opportunityKeySchema } from "./opportunities.schema.js";
-import { positionKeySchema } from "./positions.schema.js";
-import { z } from "zod/v4";
-//#region src/model/history.schema.ts
-/**
-* Runtime schemas for {@link ./history.js}, see the note in
-* `primitives.schema.ts` on why they are written by hand.
-**/
-/**
-* {@link HistoryRange}
-**/
-const historyRangeSchema = z.union([
-	z.literal("1d"),
-	z.literal("1w"),
-	z.literal("1m"),
-	z.literal("1y"),
-	z.literal("max")
-]);
-/**
-* {@link PoolHistoryMetric}
-**/
-const poolHistoryMetricSchema = z.union([
-	z.literal("depositApy"),
-	z.literal("borrowApy"),
-	z.literal("dieselRate"),
-	z.literal("supplied"),
-	z.literal("borrowed"),
-	z.literal("availableLiquidity")
-]);
-/**
-* {@link StrategyHistoryMetric}
-**/
-const strategyHistoryMetricSchema = z.union([
-	z.literal("netApy"),
-	z.literal("borrowApy"),
-	z.literal("collateralApy"),
-	z.literal("tvl"),
-	z.literal("collateralPrice"),
-	z.literal("collateralUsdPrice"),
-	z.literal("underlyingUsdPrice")
-]);
-/**
-* {@link PoolPositionHistoryMetric}
-**/
-const poolPositionHistoryMetricSchema = z.union([
-	z.literal("depositApy"),
-	z.literal("borrowApy"),
-	z.literal("dieselRate"),
-	z.literal("supplied"),
-	z.literal("borrowed"),
-	z.literal("availableLiquidity")
-]);
-/**
-* {@link StrategyPositionHistoryMetric}
-**/
-const strategyPositionHistoryMetricSchema = z.union([
-	z.literal("netApy"),
-	z.literal("borrowApy"),
-	z.literal("collateralApy"),
-	z.literal("tvl"),
-	z.literal("collateralPrice"),
-	z.literal("collateralUsdPrice"),
-	z.literal("underlyingUsdPrice")
-]);
-/**
-* {@link PositionHistoryMetric}
-**/
-const positionHistoryMetricSchema = z.union([poolPositionHistoryMetricSchema, strategyPositionHistoryMetricSchema]);
-/**
-* {@link HistoryMetric}
-**/
-const historyMetricSchema = z.union([
-	poolHistoryMetricSchema,
-	strategyHistoryMetricSchema,
-	positionHistoryMetricSchema
-]);
-/**
-* {@link HistoryPoint}
-**/
-const historyPointSchema = z.object({
-	timestamp: timestampSchema,
-	value: z.number()
-});
-/**
-* {@link HistoryChartMetadata}
-*
-* TODO: empty until the backend specifies the payload.
-**/
-const historyChartMetadataSchema = z.object({});
-/**
-* {@link HistorySeries}
-**/
-const historySeriesSchema = z.object({
-	metric: historyMetricSchema,
-	points: z.array(historyPointSchema),
-	metadata: historyChartMetadataSchema
-});
-/**
-* {@link OpportunityHistoryQuery}
-**/
-const opportunityHistoryQuerySchema = z.object({
-	opportunity: opportunityKeySchema,
-	range: historyRangeSchema,
-	metric: historyMetricSchema
-});
-/**
-* {@link PositionHistoryQuery}
-**/
-const positionHistoryQuerySchema = z.object({
-	position: positionKeySchema,
-	range: historyRangeSchema,
-	metric: positionHistoryMetricSchema
-});
-//#endregion
-export { historyChartMetadataSchema, historyMetricSchema, historyPointSchema, historyRangeSchema, historySeriesSchema, opportunityHistoryQuerySchema, poolHistoryMetricSchema, poolPositionHistoryMetricSchema, positionHistoryMetricSchema, positionHistoryQuerySchema, strategyHistoryMetricSchema, strategyPositionHistoryMetricSchema };

package/dist/esm/new-sdk/utils/history.js

@@ -1 +0,0 @@
-export {};

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 };