@gearbox-protocol/sdk 16.0.0 → 16.1.1

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

@@ -74,6 +74,23 @@ declare const STRATEGY_POSITION_CHART_METRICS: readonly ["totalValueUnderlying",
  * token or a token argument on the read.
  **/
 type StrategyPositionChartMetric = (typeof STRATEGY_POSITION_CHART_METRICS)[number];
+/**
+ * Every metric the protocol as a whole can chart.
+ *
+ * Protocol-wide rather than per subject: the series describes Gearbox itself
+ * over every chain the read covers, so it has no address to hang off and is
+ * read from the analytics namespace rather than from an opportunity.
+ *
+ * `tvlUsd` is deliberately not spelled `tvl`: that key is already the credit
+ * manager's TVL in whole underlying tokens, and one metric has exactly one
+ * unit in {@link CHART_METRIC_UNITS}.
+ **/
+declare const PROTOCOL_CHART_METRICS: readonly ["tvlUsd"];
+/**
+ * Metric the protocol as a whole can chart, derived from
+ * {@link PROTOCOL_CHART_METRICS}.
+ **/
+type ProtocolChartMetric = (typeof PROTOCOL_CHART_METRICS)[number];
 /**
  * Any metric an opportunity can chart.
  **/
@@ -89,7 +106,7 @@ type PositionChartMetric = PoolPositionChartMetric | StrategyPositionChartMetric
  * the same rate whether an opportunity or a position charts it — so one metric
  * has one unit in {@link CHART_METRIC_UNITS} no matter who asks for it.
  **/
-type ChartMetric = OpportunityChartMetric | PositionChartMetric;
+type ChartMetric = OpportunityChartMetric | PositionChartMetric | ProtocolChartMetric;
 /**
  * What one chart read asks for, beyond the subject its route names.
  *
@@ -181,6 +198,7 @@ declare const CHART_METRIC_UNITS: {
   readonly debt: "token";
   readonly healthFactor: "bps";
   readonly netApy7d: "bps";
+  readonly tvlUsd: "usd";
 };
 /**
  * A unit together with what it is denominated in.
@@ -341,4 +359,4 @@ interface ChartBundle<Metrics extends readonly ChartMetric[]> {
 }
 type ChartSeriesMap<Metrics extends readonly ChartMetric[]> = number extends Metrics["length"] ? Partial<Record<Metrics[number], ChartSeries>> : Record<Metrics[number], ChartSeries>;
 //#endregion
-export { CHART_METRIC_UNITS, CHART_RANGES, CHART_UNAVAILABLE_CODES, ChartBundle, ChartDenomination, ChartMetric, ChartQuery, ChartRange, ChartSeries, ChartSeriesOk, ChartSeriesUnavailable, ChartUnavailableCode, ChartUnit, ChartValue, ChartWindow, GridSampling, OpportunityChartMetric, POOL_OPPORTUNITY_CHART_METRICS, POOL_POSITION_CHART_METRICS, PoolOpportunityChartMetric, PoolPositionChartMetric, PositionChartMetric, STRATEGY_OPPORTUNITY_CHART_METRICS, STRATEGY_POSITION_CHART_METRICS, StrategyOpportunityChartMetric, StrategyPositionChartMetric };
+export { CHART_METRIC_UNITS, CHART_RANGES, CHART_UNAVAILABLE_CODES, ChartBundle, ChartDenomination, ChartMetric, ChartQuery, ChartRange, ChartSeries, ChartSeriesOk, ChartSeriesUnavailable, ChartUnavailableCode, ChartUnit, ChartValue, ChartWindow, GridSampling, OpportunityChartMetric, POOL_OPPORTUNITY_CHART_METRICS, POOL_POSITION_CHART_METRICS, PROTOCOL_CHART_METRICS, PoolOpportunityChartMetric, PoolPositionChartMetric, PositionChartMetric, ProtocolChartMetric, STRATEGY_OPPORTUNITY_CHART_METRICS, STRATEGY_POSITION_CHART_METRICS, StrategyOpportunityChartMetric, StrategyPositionChartMetric };

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

@@ -68,7 +68,13 @@ declare const strategyPositionChartMetricSchema: z.ZodEnum<{
   totalValueUnderlying: "totalValueUnderlying";
 }>;
 /**
- * {@link ChartMetric}, every metric either kind of subject can chart.
+ * {@link ProtocolChartMetric}
+ **/
+declare const protocolChartMetricSchema: z.ZodEnum<{
+  tvlUsd: "tvlUsd";
+}>;
+/**
+ * {@link ChartMetric}, every metric any subject can chart.
  **/
 declare const chartMetricSchema: z.ZodUnion<readonly [z.ZodEnum<{
   borrowed: "borrowed";
@@ -101,6 +107,8 @@ declare const chartMetricSchema: z.ZodUnion<readonly [z.ZodEnum<{
   netApy7d: "netApy7d";
   pnl: "pnl";
   totalValueUnderlying: "totalValueUnderlying";
+}>, z.ZodEnum<{
+  tvlUsd: "tvlUsd";
 }>]>;
 /**
  * {@link ChartQuery}
@@ -137,6 +145,8 @@ declare const chartQuerySchema: z.ZodObject<{
     netApy7d: "netApy7d";
     pnl: "pnl";
     totalValueUnderlying: "totalValueUnderlying";
+  }>, z.ZodEnum<{
+    tvlUsd: "tvlUsd";
   }>]>>>;
   range: z.ZodEnum<{
     "1d": "1d";
@@ -210,6 +220,8 @@ declare const chartQueryCodec: z.ZodCodec<z.ZodObject<{
     netApy7d: "netApy7d";
     pnl: "pnl";
     totalValueUnderlying: "totalValueUnderlying";
+  }>, z.ZodEnum<{
+    tvlUsd: "tvlUsd";
   }>]>>>;
   range: z.ZodEnum<{
     "1d": "1d";
@@ -341,4 +353,4 @@ declare const chartWindowSchema: z.ZodObject<{
  **/
 declare function chartBundleSchemaFor<const Metrics extends readonly ChartMetric[]>(metrics: Metrics, range: ChartRange): z.ZodType<ChartBundle<Metrics>>;
 //#endregion
-export { chartBundleSchemaFor, chartDenominationSchema, chartMetricSchema, chartQueryCodec, chartQueryParamsSchema, chartQuerySchema, chartRangeSchema, chartSeriesSchema, chartValueSchema, chartWindowSchema, poolOpportunityChartMetricSchema, poolPositionChartMetricSchema, strategyOpportunityChartMetricSchema, strategyPositionChartMetricSchema };
+export { chartBundleSchemaFor, chartDenominationSchema, chartMetricSchema, chartQueryCodec, chartQueryParamsSchema, chartQuerySchema, chartRangeSchema, chartSeriesSchema, chartValueSchema, chartWindowSchema, poolOpportunityChartMetricSchema, poolPositionChartMetricSchema, protocolChartMetricSchema, strategyOpportunityChartMetricSchema, strategyPositionChartMetricSchema };

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

@@ -1,4 +1,5 @@
 import { Amount, Asset, AssetType, Bps, ChainId, Leverage, Timestamp, Token, TokenAmount, TxCall, UnderlyingToken } from "./primitives.js";
+import { CHART_METRIC_UNITS, CHART_RANGES, CHART_UNAVAILABLE_CODES, ChartBundle, ChartDenomination, ChartMetric, ChartQuery, ChartRange, ChartSeries, ChartSeriesOk, ChartSeriesUnavailable, ChartUnavailableCode, ChartUnit, ChartValue, ChartWindow, GridSampling, OpportunityChartMetric, POOL_OPPORTUNITY_CHART_METRICS, POOL_POSITION_CHART_METRICS, PROTOCOL_CHART_METRICS, PoolOpportunityChartMetric, PoolPositionChartMetric, PositionChartMetric, ProtocolChartMetric, STRATEGY_OPPORTUNITY_CHART_METRICS, STRATEGY_POSITION_CHART_METRICS, StrategyOpportunityChartMetric, StrategyPositionChartMetric } from "./charts.js";
 import { ChainScopedFilter, FILTER_ALL, FilterAll, Filterable, isFilterSet } from "./filters.js";
 import { IGearboxError } from "./errors.js";
 import { Curator, CuratorName } from "./curators.js";
@@ -7,10 +8,9 @@ import { ApyBreakdown, Opportunity, OpportunityBase, OpportunityDetail, Opportun
 import { BorrowRateBreakdown, PnlBreakdown, PointsProgramPnL, PointsRewardsPnL, PoolPosition, PoolPositionKey, PoolPositionRef, Position, PositionCollateral, PositionFilter, PositionId, PositionKey, PositionKind, PositionTransaction, PositionTransactionKind, PositionsTotals, RewardsPnL, STRATEGY_POSITION_COLLATERAL_ERROR, StrategyPosition, StrategyPositionKey, StrategyPositionRef, TokenQuotaRate, TokenRewardsPnL, liquidationPositionId, matchesPositionFilter, poolPositionId, positionId, strategyPositionId } from "./positions.js";
 import { AccountHoldings, AccountMetrics, AccountProjection, AccountStateChange, AdapterCallOutsideBracketError, AdjustStrategyPositionPreview, CreditOperationMarket, DelayedStrategyPositionOperationPreview, Estimated, EstimatedProjection, ExitStrategyPositionPreview, InstantStrategyPositionOperationPreview, InvalidTransactionValueError, MalformedBracketError, MalformedBracketKind, MalformedPreviewError, NonAdapterCallInBracketError, OpenStrategyPositionPreview, OperationPreview, OperationPreviewError, PoolOperationType, PoolPositionOperationPreview, PreviewOperationInput, PreviewOperationOptions, RepayStrategyPositionPreview, RoutedField, UnpreviewableAdapterCallError, UnsupportedOutOfBracketCallError, asEstimated } from "./previews.js";
 import { DelayedReceivedAsset, InstantReceivedAsset, LiquidatableAccount, LiquidatableAccountFilter, LiquidationApproval, LiquidationDetails, LiquidationPosition, ReceivedAsset, matchesLiquidatableAccountFilter } from "./liquidations.js";
-import { AnalyticsLiquidationPosition, AnalyticsPoolPosition, AnalyticsPosition, AnalyticsPositionListOptions, AnalyticsPositionOwner, AnalyticsPositionPage, AnalyticsPositionSortField, AnalyticsSortDirection, AnalyticsStrategyPosition } from "./analytics.js";
-import { ANALYTICS_POSITIONS_DEFAULT_LIMIT, ANALYTICS_POSITIONS_MAX_LIMIT, analyticsPositionListOptionsSchema, analyticsPositionListQueryParamsSchema, analyticsPositionListQuerySchema, analyticsPositionPageSchema, analyticsPositionSchema, analyticsPositionSortFieldSchema, analyticsSortDirectionSchema } from "./analytics.schema.js";
-import { CHART_METRIC_UNITS, CHART_RANGES, CHART_UNAVAILABLE_CODES, ChartBundle, ChartDenomination, ChartMetric, ChartQuery, ChartRange, ChartSeries, ChartSeriesOk, ChartSeriesUnavailable, ChartUnavailableCode, ChartUnit, ChartValue, ChartWindow, GridSampling, OpportunityChartMetric, POOL_OPPORTUNITY_CHART_METRICS, POOL_POSITION_CHART_METRICS, PoolOpportunityChartMetric, PoolPositionChartMetric, PositionChartMetric, STRATEGY_OPPORTUNITY_CHART_METRICS, STRATEGY_POSITION_CHART_METRICS, StrategyOpportunityChartMetric, StrategyPositionChartMetric } from "./charts.js";
-import { chartBundleSchemaFor, chartDenominationSchema, chartMetricSchema, chartQueryCodec, chartQueryParamsSchema, chartQuerySchema, chartRangeSchema, chartSeriesSchema, chartValueSchema, chartWindowSchema, poolOpportunityChartMetricSchema, poolPositionChartMetricSchema, strategyOpportunityChartMetricSchema, strategyPositionChartMetricSchema } from "./charts.schema.js";
+import { AnalyticsChartQuery, AnalyticsLiquidationPosition, AnalyticsPoolPosition, AnalyticsPosition, AnalyticsPositionListOptions, AnalyticsPositionOwner, AnalyticsPositionPage, AnalyticsPositionSortField, AnalyticsSortDirection, AnalyticsStrategyPosition } from "./analytics.js";
+import { ANALYTICS_POSITIONS_DEFAULT_LIMIT, ANALYTICS_POSITIONS_MAX_LIMIT, analyticsChartQueryOptionsSchema, analyticsChartQueryParamsSchema, analyticsChartQuerySchema, analyticsPositionListOptionsSchema, analyticsPositionListQueryParamsSchema, analyticsPositionListQuerySchema, analyticsPositionPageSchema, analyticsPositionSchema, analyticsPositionSortFieldSchema, analyticsSortDirectionSchema } from "./analytics.schema.js";
+import { chartBundleSchemaFor, chartDenominationSchema, chartMetricSchema, chartQueryCodec, chartQueryParamsSchema, chartQuerySchema, chartRangeSchema, chartSeriesSchema, chartValueSchema, chartWindowSchema, poolOpportunityChartMetricSchema, poolPositionChartMetricSchema, protocolChartMetricSchema, strategyOpportunityChartMetricSchema, strategyPositionChartMetricSchema } from "./charts.schema.js";
 import { CompareTag, CompareTolerance, ToleranceCompareTag, backendPreferred, compareTagOf, offchainOnly, onchainOnly, tolerance } from "./compare.schema.js";
 import { curatorNameSchema, curatorSchema } from "./curators.schema.js";
 import { booleanParamSchema, encodeFlag, filterAllSchema, filterable } from "./filters.schema.js";
@@ -25,4 +25,4 @@ import { chainFailedSchema, chainMetadataSchema, chainSucceededSchema, dataSourc
 import { SDKError, SDKResult, SDKReturn, SafeValue, isSDKError, safeValue, sdkErr, sdkOk } from "./result.js";
 import { PositionClaimableWithdrawal, PositionPendingWithdrawal, PositionWithdrawals, WithdrawalOutputAmount } from "./withdrawals.js";
 import { positionClaimableWithdrawalSchema, positionPendingWithdrawalSchema, positionWithdrawalsSchema, withdrawalOutputAmountSchema } from "./withdrawals.schema.js";
-export { ANALYTICS_POSITIONS_DEFAULT_LIMIT, ANALYTICS_POSITIONS_MAX_LIMIT, AccountHoldings, AccountMetrics, AccountProjection, AccountStateChange, AdapterCallOutsideBracketError, AdjustStrategyPositionPreview, Amount, AnalyticsLiquidationPosition, AnalyticsPoolPosition, AnalyticsPosition, AnalyticsPositionListOptions, AnalyticsPositionOwner, AnalyticsPositionPage, AnalyticsPositionSortField, AnalyticsSortDirection, AnalyticsStrategyPosition, ApyBreakdown, Asset, AssetType, BorrowRateBreakdown, Bps, CHART_METRIC_UNITS, CHART_RANGES, CHART_UNAVAILABLE_CODES, ChainFailed, ChainId, ChainMetadata, ChainScoped, ChainScopedFilter, ChainSucceeded, ChartBundle, ChartDenomination, ChartMetric, ChartQuery, ChartRange, ChartSeries, ChartSeriesOk, ChartSeriesUnavailable, ChartUnavailableCode, ChartUnit, ChartValue, ChartWindow, CompareTag, CompareTolerance, CreditOperationMarket, Curator, CuratorName, DataResponse, DataSource, DelayedAddCollateralIntent, DelayedCloseAccountIntent, DelayedDecreaseLeverageIntent, DelayedDepositAndIncreaseLeverageIntent, DelayedDepositIntent, DelayedIncreaseLeverageIntent, DelayedIntent, DelayedReceivedAsset, DelayedStrategyPositionOperationPreview, DelayedWithdrawCollateralIntent, Estimated, EstimatedProjection, ExitStrategyPositionPreview, FILTER_ALL, FilterAll, Filterable, GridSampling, IGearboxError, InstantReceivedAsset, InstantStrategyPositionOperationPreview, InvalidTransactionValueError, Leverage, LiquidatableAccount, LiquidatableAccountFilter, LiquidationApproval, LiquidationDetails, LiquidationPosition, MalformedBracketError, MalformedBracketKind, MalformedPreviewError, NonAdapterCallInBracketError, Notice, NoticeKind, NoticeSubject, OpenStrategyPositionPreview, OperationPreview, OperationPreviewError, Opportunity, OpportunityBase, OpportunityChartMetric, OpportunityDetail, OpportunityFilter, OpportunityId, OpportunityKey, OpportunityKind, OpportunityTotals, POOL_OPPORTUNITY_CHART_METRICS, POOL_POSITION_CHART_METRICS, PnlBreakdown, PointRewards, PointsProgram, PointsProgramPnL, PointsRewardsPnL, PoolOperationType, PoolOpportunity, PoolOpportunityChartMetric, PoolOpportunityDetail, PoolOpportunityKey, PoolOpportunityRef, PoolPosition, PoolPositionChartMetric, PoolPositionKey, PoolPositionOperationPreview, PoolPositionRef, Position, PositionChartMetric, PositionClaimableWithdrawal, PositionCollateral, PositionFilter, PositionId, PositionKey, PositionKind, PositionPendingWithdrawal, PositionTransaction, PositionTransactionKind, PositionWithdrawals, PositionsTotals, PreviewOperationInput, PreviewOperationOptions, PriceFeedData, PriceFeedSummary, QuotaAsset, RateCurve, RateCurvePoint, ReceivedAsset, RepayStrategyPositionPreview, ResponseMetadata, Rewards, RewardsPnL, RoutedField, SDKError, SDKResult, SDKReturn, STRATEGY_OPPORTUNITY_CHART_METRICS, STRATEGY_POSITION_CHART_METRICS, STRATEGY_POSITION_COLLATERAL_ERROR, SafeValue, StrategyOpportunity, StrategyOpportunityChartMetric, StrategyOpportunityDetail, StrategyOpportunityKey, StrategyOpportunityRef, StrategyPosition, StrategyPositionChartMetric, StrategyPositionKey, StrategyPositionRef, Timestamp, Token, TokenAmount, TokenQuotaRate, TokenRewards, TokenRewardsPnL, ToleranceCompareTag, TxCall, UnderlyingToken, UnpreviewableAdapterCallError, UnsupportedOutOfBracketCallError, WithdrawalOutputAmount, amountSchema, analyticsPositionListOptionsSchema, analyticsPositionListQueryParamsSchema, analyticsPositionListQuerySchema, analyticsPositionPageSchema, analyticsPositionSchema, analyticsPositionSortFieldSchema, analyticsSortDirectionSchema, apyBreakdownSchema, asEstimated, assetTypeSchema, backendPreferred, booleanParamSchema, borrowRateBreakdownSchema, bpsSchema, chainFailedSchema, chainIdSchema, chainMetadataSchema, chainSucceededSchema, chartBundleSchemaFor, chartDenominationSchema, chartMetricSchema, chartQueryCodec, chartQueryParamsSchema, chartQuerySchema, chartRangeSchema, chartSeriesSchema, chartValueSchema, chartWindowSchema, compareTagOf, curatorNameSchema, curatorSchema, dataSourceSchema, delayedReceivedAssetSchema, encodeFlag, filterAllSchema, filterable, instantReceivedAssetSchema, isFilterSet, isSDKError, leverageSchema, liquidatableAccountFilterSchema, liquidatableAccountSchema, liquidationApprovalSchema, liquidationDetailsSchema, liquidationPositionId, liquidationPositionSchema, matchesLiquidatableAccountFilter, matchesOpportunityFilter, matchesPositionFilter, noticeKindSchema, noticeSchema, offchainOnly, onchainOnly, opportunityBaseSchema, opportunityDetailSchema, opportunityFilterQueryParamsSchema, opportunityFilterQuerySchema, opportunityFilterSchema, opportunityId, opportunityKeySchema, opportunityKindSchema, opportunitySchema, opportunityTotalsSchema, pnlBreakdownSchema, pointRewardsSchema, pointsProgramPnLSchema, pointsProgramSchema, pointsRewardsPnLSchema, poolOpportunityChartMetricSchema, poolOpportunityDetailSchema, poolOpportunityId, poolOpportunityKeySchema, poolOpportunitySchema, poolPositionChartMetricSchema, poolPositionId, poolPositionKeySchema, poolPositionSchema, positionClaimableWithdrawalSchema, positionCollateralSchema, positionFilterQueryParamsSchema, positionFilterQuerySchema, positionFilterSchema, positionId, positionKeySchema, positionKindSchema, positionPendingWithdrawalSchema, positionSchema, positionTransactionKindSchema, positionTransactionSchema, positionWithdrawalsSchema, positionsTotalsSchema, priceFeedDataSchema, priceFeedSummarySchema, quotaAssetSchema, rateCurvePointSchema, rateCurveSchema, receivedAssetSchema, responseMetadataSchema, responseSchema, rewardsPnLSchema, rewardsSchema, safeValue, sdkErr, sdkOk, strategyOpportunityChartMetricSchema, strategyOpportunityDetailSchema, strategyOpportunityId, strategyOpportunityKeySchema, strategyOpportunitySchema, strategyPositionChartMetricSchema, strategyPositionId, strategyPositionKeySchema, strategyPositionSchema, timestampSchema, tokenAmountSchema, tokenQuotaRateSchema, tokenRewardsPnLSchema, tokenRewardsSchema, tokenSchema, tolerance, txCallSchema, underlyingTokenSchema, withdrawalOutputAmountSchema };
+export { ANALYTICS_POSITIONS_DEFAULT_LIMIT, ANALYTICS_POSITIONS_MAX_LIMIT, AccountHoldings, AccountMetrics, AccountProjection, AccountStateChange, AdapterCallOutsideBracketError, AdjustStrategyPositionPreview, Amount, AnalyticsChartQuery, AnalyticsLiquidationPosition, AnalyticsPoolPosition, AnalyticsPosition, AnalyticsPositionListOptions, AnalyticsPositionOwner, AnalyticsPositionPage, AnalyticsPositionSortField, AnalyticsSortDirection, AnalyticsStrategyPosition, ApyBreakdown, Asset, AssetType, BorrowRateBreakdown, Bps, CHART_METRIC_UNITS, CHART_RANGES, CHART_UNAVAILABLE_CODES, ChainFailed, ChainId, ChainMetadata, ChainScoped, ChainScopedFilter, ChainSucceeded, ChartBundle, ChartDenomination, ChartMetric, ChartQuery, ChartRange, ChartSeries, ChartSeriesOk, ChartSeriesUnavailable, ChartUnavailableCode, ChartUnit, ChartValue, ChartWindow, CompareTag, CompareTolerance, CreditOperationMarket, Curator, CuratorName, DataResponse, DataSource, DelayedAddCollateralIntent, DelayedCloseAccountIntent, DelayedDecreaseLeverageIntent, DelayedDepositAndIncreaseLeverageIntent, DelayedDepositIntent, DelayedIncreaseLeverageIntent, DelayedIntent, DelayedReceivedAsset, DelayedStrategyPositionOperationPreview, DelayedWithdrawCollateralIntent, Estimated, EstimatedProjection, ExitStrategyPositionPreview, FILTER_ALL, FilterAll, Filterable, GridSampling, IGearboxError, InstantReceivedAsset, InstantStrategyPositionOperationPreview, InvalidTransactionValueError, Leverage, LiquidatableAccount, LiquidatableAccountFilter, LiquidationApproval, LiquidationDetails, LiquidationPosition, MalformedBracketError, MalformedBracketKind, MalformedPreviewError, NonAdapterCallInBracketError, Notice, NoticeKind, NoticeSubject, OpenStrategyPositionPreview, OperationPreview, OperationPreviewError, Opportunity, OpportunityBase, OpportunityChartMetric, OpportunityDetail, OpportunityFilter, OpportunityId, OpportunityKey, OpportunityKind, OpportunityTotals, POOL_OPPORTUNITY_CHART_METRICS, POOL_POSITION_CHART_METRICS, PROTOCOL_CHART_METRICS, PnlBreakdown, PointRewards, PointsProgram, PointsProgramPnL, PointsRewardsPnL, PoolOperationType, PoolOpportunity, PoolOpportunityChartMetric, PoolOpportunityDetail, PoolOpportunityKey, PoolOpportunityRef, PoolPosition, PoolPositionChartMetric, PoolPositionKey, PoolPositionOperationPreview, PoolPositionRef, Position, PositionChartMetric, PositionClaimableWithdrawal, PositionCollateral, PositionFilter, PositionId, PositionKey, PositionKind, PositionPendingWithdrawal, PositionTransaction, PositionTransactionKind, PositionWithdrawals, PositionsTotals, PreviewOperationInput, PreviewOperationOptions, PriceFeedData, PriceFeedSummary, ProtocolChartMetric, QuotaAsset, RateCurve, RateCurvePoint, ReceivedAsset, RepayStrategyPositionPreview, ResponseMetadata, Rewards, RewardsPnL, RoutedField, SDKError, SDKResult, SDKReturn, STRATEGY_OPPORTUNITY_CHART_METRICS, STRATEGY_POSITION_CHART_METRICS, STRATEGY_POSITION_COLLATERAL_ERROR, SafeValue, StrategyOpportunity, StrategyOpportunityChartMetric, StrategyOpportunityDetail, StrategyOpportunityKey, StrategyOpportunityRef, StrategyPosition, StrategyPositionChartMetric, StrategyPositionKey, StrategyPositionRef, Timestamp, Token, TokenAmount, TokenQuotaRate, TokenRewards, TokenRewardsPnL, ToleranceCompareTag, TxCall, UnderlyingToken, UnpreviewableAdapterCallError, UnsupportedOutOfBracketCallError, WithdrawalOutputAmount, amountSchema, analyticsChartQueryOptionsSchema, analyticsChartQueryParamsSchema, analyticsChartQuerySchema, analyticsPositionListOptionsSchema, analyticsPositionListQueryParamsSchema, analyticsPositionListQuerySchema, analyticsPositionPageSchema, analyticsPositionSchema, analyticsPositionSortFieldSchema, analyticsSortDirectionSchema, apyBreakdownSchema, asEstimated, assetTypeSchema, backendPreferred, booleanParamSchema, borrowRateBreakdownSchema, bpsSchema, chainFailedSchema, chainIdSchema, chainMetadataSchema, chainSucceededSchema, chartBundleSchemaFor, chartDenominationSchema, chartMetricSchema, chartQueryCodec, chartQueryParamsSchema, chartQuerySchema, chartRangeSchema, chartSeriesSchema, chartValueSchema, chartWindowSchema, compareTagOf, curatorNameSchema, curatorSchema, dataSourceSchema, delayedReceivedAssetSchema, encodeFlag, filterAllSchema, filterable, instantReceivedAssetSchema, isFilterSet, isSDKError, leverageSchema, liquidatableAccountFilterSchema, liquidatableAccountSchema, liquidationApprovalSchema, liquidationDetailsSchema, liquidationPositionId, liquidationPositionSchema, matchesLiquidatableAccountFilter, matchesOpportunityFilter, matchesPositionFilter, noticeKindSchema, noticeSchema, offchainOnly, onchainOnly, opportunityBaseSchema, opportunityDetailSchema, opportunityFilterQueryParamsSchema, opportunityFilterQuerySchema, opportunityFilterSchema, opportunityId, opportunityKeySchema, opportunityKindSchema, opportunitySchema, opportunityTotalsSchema, pnlBreakdownSchema, pointRewardsSchema, pointsProgramPnLSchema, pointsProgramSchema, pointsRewardsPnLSchema, poolOpportunityChartMetricSchema, poolOpportunityDetailSchema, poolOpportunityId, poolOpportunityKeySchema, poolOpportunitySchema, poolPositionChartMetricSchema, poolPositionId, poolPositionKeySchema, poolPositionSchema, positionClaimableWithdrawalSchema, positionCollateralSchema, positionFilterQueryParamsSchema, positionFilterQuerySchema, positionFilterSchema, positionId, positionKeySchema, positionKindSchema, positionPendingWithdrawalSchema, positionSchema, positionTransactionKindSchema, positionTransactionSchema, positionWithdrawalsSchema, positionsTotalsSchema, priceFeedDataSchema, priceFeedSummarySchema, protocolChartMetricSchema, quotaAssetSchema, rateCurvePointSchema, rateCurveSchema, receivedAssetSchema, responseMetadataSchema, responseSchema, rewardsPnLSchema, rewardsSchema, safeValue, sdkErr, sdkOk, strategyOpportunityChartMetricSchema, strategyOpportunityDetailSchema, strategyOpportunityId, strategyOpportunityKeySchema, strategyOpportunitySchema, strategyPositionChartMetricSchema, strategyPositionId, strategyPositionKeySchema, strategyPositionSchema, timestampSchema, tokenAmountSchema, tokenQuotaRateSchema, tokenRewardsPnLSchema, tokenRewardsSchema, tokenSchema, tolerance, txCallSchema, underlyingTokenSchema, withdrawalOutputAmountSchema };

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

@@ -129,7 +129,7 @@ interface Token {
    * Ticker symbol.
    *
    * Display ticker, not necessarily the on-chain ERC-20 `symbol()`. The SDK
-   * may rewrite it (curated pretty names, `"source -> target"` for redemption
+   * may rewrite it (curated pretty names, `"target redemption from source"` for redemption
    * phantom tokens).
    *
    * @example `"USDC"`

package/dist/types/offchain/AbstractOffchainNamespace.d.ts

@@ -1,7 +1,7 @@
 import { ILogger } from "../onchain/types/logger.js";
 import { ChainId } from "../model/primitives.js";
-import { ChainScopedFilter } from "../model/filters.js";
 import { ChartBundle, ChartMetric, ChartRange } from "../model/charts.js";
+import { ChainScopedFilter } from "../model/filters.js";
 import { DataResponse } from "../model/response.js";
 import { GearboxAPIOptions } from "./types.js";
 import { z } from "zod/v4";

package/dist/types/offchain/analytics/OffchainAnalytics.d.ts

@@ -1,11 +1,23 @@
+import { ChartBundle, ChartRange, ProtocolChartMetric } from "../../model/charts.js";
+import { ChainScopedFilter } from "../../model/filters.js";
+import { DataResponse } from "../../model/response.js";
 import { GearboxAPIOptions } from "../types.js";
+import { AbstractOffchainNamespace } from "../AbstractOffchainNamespace.js";
 import { IOffchainAnalytics } from "./types.js";
 import { OffchainAnalyticsPositions } from "./OffchainAnalyticsPositions.js";
 //#region src/offchain/analytics/OffchainAnalytics.d.ts
-/** Backend-only protocol analytics, grouped by subject. */
-declare class OffchainAnalytics implements IOffchainAnalytics {
+/**
+ * Backend-only protocol analytics, grouped by subject.
+ *
+ * It owns the protocol-wide charts itself rather than through a sub-namespace:
+ * their subject is Gearbox as a whole, so there is nothing narrower for them to
+ * hang off.
+ **/
+declare class OffchainAnalytics extends AbstractOffchainNamespace implements IOffchainAnalytics {
   readonly positions: OffchainAnalyticsPositions;
   constructor(options: GearboxAPIOptions);
+  /** {@inheritDoc IOffchainAnalytics.getCharts} */
+  getCharts<const Metrics extends readonly ProtocolChartMetric[]>(metrics: Metrics, range: ChartRange, filter?: ChainScopedFilter): Promise<DataResponse<ChartBundle<Metrics>>>;
 }
 //#endregion
 export { OffchainAnalytics };

package/dist/types/offchain/analytics/types.d.ts

@@ -1,3 +1,5 @@
+import { ChartBundle, ChartRange, ProtocolChartMetric } from "../../model/charts.js";
+import { ChainScopedFilter } from "../../model/filters.js";
 import { AnalyticsPositionListOptions, AnalyticsPositionPage } from "../../model/analytics.js";
 import { DataResponse } from "../../model/response.js";
 //#region src/offchain/analytics/types.d.ts
@@ -12,6 +14,15 @@ interface IOffchainAnalyticsPositions {
 /** Backend-only protocol analytics, grouped by subject. */
 interface IOffchainAnalytics {
   readonly positions: IOffchainAnalyticsPositions;
+  /**
+   * Charts of the protocol as a whole: one series per metric named, onto the
+   * one grid that lets them be compared at an index.
+   *
+   * The series sums the chains the read covers, which are the client's own
+   * narrowed by `filter` — so a client built for one chain charts that chain,
+   * not the protocol.
+   **/
+  getCharts<const Metrics extends readonly ProtocolChartMetric[]>(metrics: Metrics, range: ChartRange, filter?: ChainScopedFilter): Promise<DataResponse<ChartBundle<Metrics>>>;
 }
 //#endregion
 export { IOffchainAnalytics, IOffchainAnalyticsPositions };

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

@@ -1,5 +1,5 @@
-import { Opportunity, OpportunityFilter, OpportunityKey, OpportunityTotals, PoolOpportunityDetail, PoolOpportunityKey, StrategyOpportunityDetail, StrategyOpportunityKey } from "../../model/opportunities.js";
 import { ChartBundle, ChartRange } from "../../model/charts.js";
+import { Opportunity, OpportunityFilter, OpportunityKey, OpportunityTotals, PoolOpportunityDetail, PoolOpportunityKey, StrategyOpportunityDetail, StrategyOpportunityKey } from "../../model/opportunities.js";
 import { DataResponse } from "../../model/response.js";
 import { GearboxAPIOptions } from "../types.js";
 import { AbstractOffchainNamespace } from "../AbstractOffchainNamespace.js";

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

@@ -1,5 +1,5 @@
-import { Opportunity, OpportunityFilter, OpportunityKey, OpportunityTotals, PoolOpportunityDetail, PoolOpportunityKey, StrategyOpportunityDetail, StrategyOpportunityKey } from "../../model/opportunities.js";
 import { ChartBundle, ChartRange, PoolOpportunityChartMetric, StrategyOpportunityChartMetric } from "../../model/charts.js";
+import { Opportunity, OpportunityFilter, OpportunityKey, OpportunityTotals, PoolOpportunityDetail, PoolOpportunityKey, StrategyOpportunityDetail, StrategyOpportunityKey } from "../../model/opportunities.js";
 import { DataResponse } from "../../model/response.js";
 //#region src/offchain/opportunities/types.d.ts
 type OpportunityChartMetricFor<K extends OpportunityKey> = {

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

@@ -1,5 +1,5 @@
-import { Position, PositionKey, PositionTransaction, PositionsTotals, StrategyPositionKey } from "../../model/positions.js";
 import { ChartBundle, ChartRange } from "../../model/charts.js";
+import { Position, PositionKey, PositionTransaction, PositionsTotals, StrategyPositionKey } from "../../model/positions.js";
 import { DataResponse } from "../../model/response.js";
 import { ListPositionsPropsBase } from "../../onchain/positions/types.js";
 import { GearboxAPIOptions } from "../types.js";

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

@@ -1,5 +1,5 @@
-import { Position, PositionKey, PositionTransaction, PositionsTotals, StrategyPositionKey } from "../../model/positions.js";
 import { ChartBundle, ChartRange, PoolPositionChartMetric, StrategyPositionChartMetric } from "../../model/charts.js";
+import { Position, PositionKey, PositionTransaction, PositionsTotals, StrategyPositionKey } from "../../model/positions.js";
 import { DataResponse } from "../../model/response.js";
 import { ListPositionsPropsBase } from "../../onchain/positions/types.js";
 import { Address } from "viem";

package/dist/types/onchain/base/TokensMeta.d.ts

@@ -22,7 +22,7 @@ interface FormatBNOptions {
 }
 /**
  * Source, target, and phantom token of a delayed redemption, used to rewrite
- * the phantom's display symbol as `"source -> target"`.
+ * the phantom's display symbol as `"target redemption from source"`.
  **/
 interface RedemptionPhantomRename {
   /**
@@ -72,7 +72,7 @@ declare class TokensMeta extends AddressMap<TokenMetaData> {
    * Returns the display symbol for a token.
    *
    * This is not always the on-chain ERC-20 `symbol()`: curated pretty names
-   * and redemption phantom tokens (`"source -> target"`) replace it.
+   * and redemption phantom tokens (`"target redemption from source"`) replace it.
    *
    * @param token - Token address.
    * @throws If the token is not in the registry.
@@ -133,7 +133,7 @@ declare class TokensMeta extends AddressMap<TokenMetaData> {
   unwrapRWA(token: Address): Address;
   /**
    * Rewrites display symbols of redemption phantom tokens to
-   * `"${source} -> ${target}"`.
+   * `"${target} redemption from ${source}"`.
    *
    * @param renames - Phantom / source / target address triples.
    **/

package/dist/types/onchain/base/token-types.d.ts

@@ -19,7 +19,7 @@ declare const NON_STRATEGY_PHANTOM_TOKEN_TYPES: readonly ["PHANTOM_TOKEN::INFINI
  * Token metadata stored in {@link TokensMeta}.
  *
  * `symbol` is a display ticker. The SDK may rewrite it (curated pretty names,
- * `"source -> target"` for redemption phantom tokens) and it is not guaranteed
+ * `"target redemption from source"` for redemption phantom tokens) and it is not guaranteed
  * to match the ERC-20 `symbol()` on chain.
  */
 interface SimpleTokenMeta extends TokenData {

package/dist/types/onchain/market/strategyName.d.ts

@@ -6,7 +6,7 @@ import "../../model/index.js";
  * borrowed underlying, e.g. `"wstETH / WETH"`.
  *
  * Uses each token's display {@link Token.symbol}, which may already be a
- * curated pretty name or a `"source -> target"` redemption rewrite.
+ * curated pretty name or a `"target redemption from source"` redemption rewrite.
  *
  * @param target - Collateral the position is built around.
  * @param underlying - Token the position borrows.

package/dist/types/sdk/analytics/AnalyticsNamespace.d.ts

@@ -1,11 +1,17 @@
+import { ChartBundle, ChartRange, ProtocolChartMetric } from "../../model/charts.js";
+import { ChainScopedFilter } from "../../model/filters.js";
+import { DataResponse } from "../../model/response.js";
 import { GearboxAPI } from "../../offchain/GearboxAPI.js";
 import "../../offchain/index.js";
 import { IAnalytics } from "./types.js";
 //#region src/sdk/analytics/AnalyticsNamespace.d.ts
 /** Backend-only protocol analytics exposed by {@link GearboxSDK}. */
 declare class AnalyticsNamespace implements IAnalytics {
+  #private;
   readonly positions: GearboxAPI["analytics"]["positions"];
   constructor(backend: GearboxAPI);
+  /** {@inheritDoc IAnalytics.charts} */
+  charts<const Metrics extends readonly ProtocolChartMetric[]>(metrics: Metrics, range: ChartRange, filter?: ChainScopedFilter): Promise<DataResponse<ChartBundle<Metrics>>>;
 }
 //#endregion
 export { AnalyticsNamespace };

package/dist/types/sdk/analytics/types.d.ts

@@ -1,9 +1,25 @@
+import { ChartBundle, ChartRange, ProtocolChartMetric } from "../../model/charts.js";
+import { ChainScopedFilter } from "../../model/filters.js";
+import { DataResponse } from "../../model/response.js";
 import { IOffchainAnalyticsPositions } from "../../offchain/analytics/types.js";
 import "../../offchain/index.js";
 //#region src/sdk/analytics/types.d.ts
 /** Backend-only protocol analytics, grouped by subject. */
 interface IAnalytics {
   readonly positions: IOffchainAnalyticsPositions;
+  /**
+   * Charts of the protocol as a whole: one series per metric named, onto the
+   * one grid that lets them be compared at an index.
+   *
+   * ```ts
+   * const { data } = await sdk.analytics.charts(["tvlUsd"], "1m");
+   * ```
+   *
+   * The series sums the chains the read covers, which are this instance's own
+   * narrowed by `filter` — so an SDK built for one chain charts that chain,
+   * not the protocol.
+   **/
+  charts<const Metrics extends readonly ProtocolChartMetric[]>(metrics: Metrics, range: ChartRange, filter?: ChainScopedFilter): Promise<DataResponse<ChartBundle<Metrics>>>;
 }
 /** `sdk.analytics` per mode: absent when the SDK has no backend source. */
 interface IAnalyticsByMode {

package/dist/types/sdk/opportunities/OpportunitiesNamespace.d.ts

@@ -1,5 +1,5 @@
-import { Opportunity, OpportunityFilter, OpportunityTotals, PoolOpportunityDetail, PoolOpportunityKey, PoolOpportunityRef, StrategyOpportunityDetail, StrategyOpportunityKey, StrategyOpportunityRef } from "../../model/opportunities.js";
 import { ChartBundle, ChartRange, PoolOpportunityChartMetric, StrategyOpportunityChartMetric } from "../../model/charts.js";
+import { Opportunity, OpportunityFilter, OpportunityTotals, PoolOpportunityDetail, PoolOpportunityKey, PoolOpportunityRef, StrategyOpportunityDetail, StrategyOpportunityKey, StrategyOpportunityRef } from "../../model/opportunities.js";
 import { DataResponse } from "../../model/response.js";
 import "../../model/index.js";
 import { MultichainSDK } from "../../onchain/MultichainSDK.js";

package/dist/types/sdk/opportunities/types.d.ts

@@ -1,5 +1,5 @@
-import { Opportunity, OpportunityFilter, OpportunityTotals, PoolOpportunityDetail, PoolOpportunityKey, PoolOpportunityRef, StrategyOpportunityDetail, StrategyOpportunityKey, StrategyOpportunityRef } from "../../model/opportunities.js";
 import { ChartBundle, ChartRange, PoolOpportunityChartMetric, StrategyOpportunityChartMetric } from "../../model/charts.js";
+import { Opportunity, OpportunityFilter, OpportunityTotals, PoolOpportunityDetail, PoolOpportunityKey, PoolOpportunityRef, StrategyOpportunityDetail, StrategyOpportunityKey, StrategyOpportunityRef } from "../../model/opportunities.js";
 import { DataResponse } from "../../model/response.js";
 import "../../model/index.js";
 import { IMultichainOpportunitiesService } from "../../onchain/opportunities/types.js";

package/dist/types/sdk/positions/PositionsNamespace.d.ts

@@ -1,5 +1,5 @@
-import { PoolPositionRef, Position, PositionFilter, PositionTransaction, PositionsTotals, StrategyPositionRef } from "../../model/positions.js";
 import { ChartBundle, ChartRange, PoolPositionChartMetric, StrategyPositionChartMetric } from "../../model/charts.js";
+import { PoolPositionRef, Position, PositionFilter, PositionTransaction, PositionsTotals, StrategyPositionRef } from "../../model/positions.js";
 import { DataResponse } from "../../model/response.js";
 import { PositionWithdrawals } from "../../model/withdrawals.js";
 import "../../model/index.js";

package/dist/types/sdk/positions/types.d.ts

@@ -1,5 +1,5 @@
-import { PoolPositionRef, Position, PositionFilter, PositionTransaction, PositionsTotals, StrategyPositionRef } from "../../model/positions.js";
 import { ChartBundle, ChartRange, PoolPositionChartMetric, StrategyPositionChartMetric } from "../../model/charts.js";
+import { PoolPositionRef, Position, PositionFilter, PositionTransaction, PositionsTotals, StrategyPositionRef } from "../../model/positions.js";
 import { DataResponse } from "../../model/response.js";
 import { PositionWithdrawals } from "../../model/withdrawals.js";
 import "../../model/index.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gearbox-protocol/sdk",
-  "version": "16.0.0",
+  "version": "16.1.1",
   "description": "Gearbox SDK",
   "license": "MIT",
   "repository": {