@gearbox-protocol/sdk 16.0.0-next.52 → 16.0.0-next.54

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

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

package/dist/types/onchain/market/credit/CreditSuite.d.ts

@@ -213,8 +213,7 @@ declare class CreditSuite extends SDKConstruct {
   accountStrategyName(creditAccount: Address): string;
   /**
    * Describes this suite's leveraged strategy as the shared read model does,
-   * or `undefined` when {@link strategyTargetCollateral} cannot be resolved or
-   * {@link maxBorrowAmount} is at or below {@link MIN_STRATEGY_BORROW_AMOUNT}.
+   * or `undefined` when credit suite does not offer a strategy opportunity.
    */
   strategyOpportunity(): StrategyOpportunity | undefined;
   /**

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

@@ -1,10 +1,12 @@
 import { NetworkType } from "../onchain/chain/chains.js";
 import "../onchain/index.js";
+import { IAnalyticsByMode } from "./analytics/types.js";
 import { ILiquidationsByMode } from "./liquidations/types.js";
 import { IOpportunities } from "./opportunities/types.js";
 import { IPositions } from "./positions/types.js";
 import { IPreviewByMode } from "./preview/types.js";
 import { GearboxSDKOptions, IGearboxSDK, INoticesByMode, Mode, OffchainByMode, OnchainByMode } from "./types.js";
+import "./analytics/index.js";
 import "./liquidations/index.js";
 import "./opportunities/index.js";
 import "./positions/index.js";
@@ -44,6 +46,8 @@ declare class GearboxSDK<const M extends Mode = Mode> implements IGearboxSDK<M>
    * Chains this instance covers, which every read is scoped to.
    **/
   readonly networks: readonly NetworkType[];
+  /** Protocol-wide analytics. Undefined in `onchain` mode. */
+  readonly analytics: IAnalyticsByMode[M];
   /**
    * Namespace for pool and strategy opportunities.
    **/

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

@@ -0,0 +1,11 @@
+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 {
+  readonly positions: GearboxAPI["analytics"]["positions"];
+  constructor(backend: GearboxAPI);
+}
+//#endregion
+export { AnalyticsNamespace };

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

@@ -0,0 +1,3 @@
+import { IAnalytics, IAnalyticsByMode } from "./types.js";
+import { AnalyticsNamespace } from "./AnalyticsNamespace.js";
+export { AnalyticsNamespace, IAnalytics, IAnalyticsByMode };

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

@@ -0,0 +1,15 @@
+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;
+}
+/** `sdk.analytics` per mode: absent when the SDK has no backend source. */
+interface IAnalyticsByMode {
+  onchain: undefined;
+  offchain: IAnalytics;
+  both: IAnalytics;
+}
+//#endregion
+export { IAnalytics, IAnalyticsByMode };

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

@@ -1,6 +1,7 @@
 import { BorrowLimitBinding, IntentPreviewError, PreviewErrorDetails, PreviewErrorReason, PreviewIssue, PreviewRefusal, raise, refuse } from "../onchain/validation/refusal.js";
 import { LeverageBand } from "../onchain/accounts/intents/leverage-band.js";
 import { OperationState, PathLossRate, WithdrawCeilings } from "../onchain/accounts/intents/types.js";
+import { IAnalytics, IAnalyticsByMode } from "./analytics/types.js";
 import { ILiquidations, ILiquidationsByMode } from "./liquidations/types.js";
 import { AccountFlowError, CreditAccountNotFoundError, DebtOutOfRangeError, ForbiddenTokenError, InsufficientCollateralError, InsufficientPoolLiquidityError, InsufficientSourceBalanceError, LeverageOutOfRangeError, MalformedTransactionError, MarketExpiredError, MarketPausedError, MultipleDelayedWithdrawalsError, NoDelayedRouteError, NoRecordedIntentError, NoStrategyTargetCollateralError, OpenFlowError, PoolSunsetError, QuotaCountExceededError, QuotaLimitReachedError, RefusalErrors, UnexpectedFailureError, UnsupportedCollateralTokenError, UnsupportedTokenPairError, WithRouteRefusals, WithdrawalInProgressError, creditAccountNotFound, noStrategyTargetCollateral, toRefusalError, unexpectedFailure } from "./prepare/errors.js";
 import { AddCollateralParams, AdjustLeverageParams, DelayedStrategyResult, DepositStrategyParams, FinalizeParams, FinalizeResult, IOpportunitiesPrepare, LpParams, LpRedeemParams, LpResult, LpState, OpenStrategyParams, OpenStrategyResult, PoolInput, PositionInput, PrepareOptions, RepayStrategyParams, StrategyInput, StrategyResult, StrategyRoutesResult, WithdrawCollateralParams, WithdrawStrategyParams } from "./prepare/types.js";
@@ -18,6 +19,8 @@ import { IPositionMergers, IPositions, IPositionsBase, IPositionsByMode, IPositi
 import { IPreview, IPreviewByMode } from "./preview/types.js";
 import { EnsureFreshChains, GearboxSDKOptions, IGearboxSDK, INotices, INoticesByMode, Mode, NamespaceOptions, OffchainByMode, OffchainSource, OnchainByMode, OnchainSource, PlainMultichainSDKOptions } from "./types.js";
 import { AbstractNamespace, MergedQuery } from "./AbstractNamespace.js";
+import { AnalyticsNamespace } from "./analytics/AnalyticsNamespace.js";
+import "./analytics/index.js";
 import { LiquidationsNamespace } from "./liquidations/LiquidationsNamespace.js";
 import "./liquidations/index.js";
 import { OpportunitiesNamespace } from "./opportunities/OpportunitiesNamespace.js";
@@ -35,4 +38,4 @@ import { SourceUnavailableError } from "./errors/SourceUnavailableError.js";
 import { assertSameChains } from "./errors/assertSameChains.js";
 import { everyChainFailed } from "./errors/everyChainFailed.js";
 import "./errors/index.js";
-export { AbstractNamespace, AccountFlowError, AccountPrepareRequest, AddCollateralParams, AdjustLeverageParams, AllSourcesFailedError, BorrowLimitBinding, ChainOf, ChainRef, CreditAccountNotFoundError, DEFAULT_MAX_OFFCHAIN_LAG, DEFAULT_MAX_STATE_AGE, DebtOutOfRangeError, DelayedStrategyResult, DepositStrategyParams, EnsureFreshChains, type EntityMerger, ExecuteApi, type FilterResult, FinalizeParams, FinalizeResult, ForbiddenTokenError, GearboxSDK, GearboxSDKOptions, IGearboxSDK, ILiquidations, ILiquidationsByMode, INotices, INoticesByMode, IOpportunities, IOpportunitiesBase, IOpportunitiesByMode, IOpportunitiesExecute, IOpportunitiesOffchainBranch, IOpportunitiesOffchainOnly, IOpportunitiesOnchainBranch, IOpportunitiesOnchainOnly, IOpportunitiesPrepare, IOpportunityMergers, IPositionMergers, IPositions, IPositionsBase, IPositionsByMode, IPositionsOffchainBranch, IPositionsOffchainOnly, IPositionsOnchainBranch, IPositionsOnchainOnly, IPreview, IPreviewByMode, InsufficientCollateralError, InsufficientPoolLiquidityError, InsufficientSourceBalanceError, IntentPreviewError, type LeverageBand, LeverageOutOfRangeError, LiquidationsNamespace, type ListMerger, LpParams, LpRedeemParams, LpResult, LpState, MalformedTransactionError, MarketExpiredError, MarketPausedError, type MergeListResult, MergedQuery, MissingSourceError, Mode, MultipleDelayedWithdrawalsError, NamespaceOptions, NoDelayedRouteError, NoRecordedIntentError, NoSourceServedError, NoStrategyTargetCollateralError, OffchainByMode, OffchainSource, OnchainByMode, OnchainSource, OpenFlowError, OpenPrepareRequest, OpenStrategyParams, OpenStrategyResult, type OperationState, OpportunitiesNamespace, type PathLossRate, PlainMultichainSDKOptions, PoolInput, PoolPrepareRequest, PoolSunsetError, PositionInput, PositionsNamespace, PrepareApi, PrepareOptions, PrepareRequest, PreviewErrorDetails, PreviewErrorReason, PreviewIssue, PreviewNamespace, PreviewRefusal, QuotaCountExceededError, QuotaLimitReachedError, RefusalErrors, RepayStrategyParams, SourceChainMismatchError, SourceUnavailableError, StrategyInput, StrategyResult, StrategyRoutesResult, UnexpectedFailureError, UnsupportedCollateralTokenError, UnsupportedTokenPairError, WithRouteRefusals, type WithdrawCeilings, WithdrawCollateralParams, WithdrawStrategyParams, WithdrawalInProgressError, assertSameChains, creditAccountNotFound, everyChainFailed, filterResponse, mergeChainList, mergeChainOne, noStrategyTargetCollateral, raise, refuse, toRefusalError, unexpectedFailure };
+export { AbstractNamespace, AccountFlowError, AccountPrepareRequest, AddCollateralParams, AdjustLeverageParams, AllSourcesFailedError, AnalyticsNamespace, BorrowLimitBinding, ChainOf, ChainRef, CreditAccountNotFoundError, DEFAULT_MAX_OFFCHAIN_LAG, DEFAULT_MAX_STATE_AGE, DebtOutOfRangeError, DelayedStrategyResult, DepositStrategyParams, EnsureFreshChains, type EntityMerger, ExecuteApi, type FilterResult, FinalizeParams, FinalizeResult, ForbiddenTokenError, GearboxSDK, GearboxSDKOptions, IAnalytics, IAnalyticsByMode, IGearboxSDK, ILiquidations, ILiquidationsByMode, INotices, INoticesByMode, IOpportunities, IOpportunitiesBase, IOpportunitiesByMode, IOpportunitiesExecute, IOpportunitiesOffchainBranch, IOpportunitiesOffchainOnly, IOpportunitiesOnchainBranch, IOpportunitiesOnchainOnly, IOpportunitiesPrepare, IOpportunityMergers, IPositionMergers, IPositions, IPositionsBase, IPositionsByMode, IPositionsOffchainBranch, IPositionsOffchainOnly, IPositionsOnchainBranch, IPositionsOnchainOnly, IPreview, IPreviewByMode, InsufficientCollateralError, InsufficientPoolLiquidityError, InsufficientSourceBalanceError, IntentPreviewError, type LeverageBand, LeverageOutOfRangeError, LiquidationsNamespace, type ListMerger, LpParams, LpRedeemParams, LpResult, LpState, MalformedTransactionError, MarketExpiredError, MarketPausedError, type MergeListResult, MergedQuery, MissingSourceError, Mode, MultipleDelayedWithdrawalsError, NamespaceOptions, NoDelayedRouteError, NoRecordedIntentError, NoSourceServedError, NoStrategyTargetCollateralError, OffchainByMode, OffchainSource, OnchainByMode, OnchainSource, OpenFlowError, OpenPrepareRequest, OpenStrategyParams, OpenStrategyResult, type OperationState, OpportunitiesNamespace, type PathLossRate, PlainMultichainSDKOptions, PoolInput, PoolPrepareRequest, PoolSunsetError, PositionInput, PositionsNamespace, PrepareApi, PrepareOptions, PrepareRequest, PreviewErrorDetails, PreviewErrorReason, PreviewIssue, PreviewNamespace, PreviewRefusal, QuotaCountExceededError, QuotaLimitReachedError, RefusalErrors, RepayStrategyParams, SourceChainMismatchError, SourceUnavailableError, StrategyInput, StrategyResult, StrategyRoutesResult, UnexpectedFailureError, UnsupportedCollateralTokenError, UnsupportedTokenPairError, WithRouteRefusals, type WithdrawCeilings, WithdrawCollateralParams, WithdrawStrategyParams, WithdrawalInProgressError, assertSameChains, creditAccountNotFound, everyChainFailed, filterResponse, mergeChainList, mergeChainOne, noStrategyTargetCollateral, raise, refuse, toRefusalError, unexpectedFailure };

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

@@ -1,5 +1,5 @@
-import { ChartBundle, ChartRange, PoolOpportunityChartMetric, StrategyOpportunityChartMetric } from "../../model/charts.js";
 import { Opportunity, OpportunityFilter, OpportunityTotals, PoolOpportunityDetail, PoolOpportunityKey, PoolOpportunityRef, StrategyOpportunityDetail, StrategyOpportunityKey, StrategyOpportunityRef } from "../../model/opportunities.js";
+import { ChartBundle, ChartRange, PoolOpportunityChartMetric, StrategyOpportunityChartMetric } from "../../model/charts.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 { ChartBundle, ChartRange, PoolOpportunityChartMetric, StrategyOpportunityChartMetric } from "../../model/charts.js";
 import { Opportunity, OpportunityFilter, OpportunityTotals, PoolOpportunityDetail, PoolOpportunityKey, PoolOpportunityRef, StrategyOpportunityDetail, StrategyOpportunityKey, StrategyOpportunityRef } from "../../model/opportunities.js";
+import { ChartBundle, ChartRange, PoolOpportunityChartMetric, StrategyOpportunityChartMetric } from "../../model/charts.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 { ChartBundle, ChartRange, PoolPositionChartMetric, StrategyPositionChartMetric } from "../../model/charts.js";
 import { PoolPositionRef, Position, PositionFilter, PositionTransaction, PositionsTotals, StrategyPositionRef } from "../../model/positions.js";
+import { ChartBundle, ChartRange, PoolPositionChartMetric, StrategyPositionChartMetric } from "../../model/charts.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 { ChartBundle, ChartRange, PoolPositionChartMetric, StrategyPositionChartMetric } from "../../model/charts.js";
 import { PoolPositionRef, Position, PositionFilter, PositionTransaction, PositionsTotals, StrategyPositionRef } from "../../model/positions.js";
+import { ChartBundle, ChartRange, PoolPositionChartMetric, StrategyPositionChartMetric } from "../../model/charts.js";
 import { DataResponse } from "../../model/response.js";
 import { PositionWithdrawals } from "../../model/withdrawals.js";
 import "../../model/index.js";

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

@@ -9,6 +9,7 @@ import "../onchain/index.js";
 import { GearboxAPIOptions } from "../offchain/types.js";
 import { GearboxAPI } from "../offchain/GearboxAPI.js";
 import "../offchain/index.js";
+import { IAnalyticsByMode } from "./analytics/types.js";
 import { ILiquidationsByMode } from "./liquidations/types.js";
 import { IOpportunities } from "./opportunities/types.js";
 import { IPositions } from "./positions/types.js";
@@ -149,6 +150,8 @@ interface IGearboxSDK<M extends Mode = Mode> {
    * `offchain` mode and when an already-attached SDK was injected.
    **/
   attach(): Promise<void>;
+  /** Protocol-wide analytics. Absent in `onchain` mode. */
+  readonly analytics: IAnalyticsByMode[M];
   /**
    * Namespace for pool and strategy opportunities.
    **/

package/package.json

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