@gearbox-protocol/sdk 16.0.0-next.9 → 16.1.0

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

@@ -1,7 +1,7 @@
 import { AssetType, Bps, ChainId, Leverage, Timestamp, Token, TokenAmount, UnderlyingToken } from "./primitives.js";
 import { ChainScopedFilter, Filterable } from "./filters.js";
-import { DelayedReceivedAsset, LiquidationPosition } from "./liquidations.js";
 import { ApyBreakdown, PointsProgram } from "./opportunities.js";
+import { DelayedReceivedAsset, LiquidationPosition } from "./liquidations.js";
 import { Address, Hex } from "viem";
 //#region src/model/positions.d.ts
 /**
@@ -122,7 +122,10 @@ interface PoolPosition {
   underlyingToken: UnderlyingToken;
   /**
    * Underlying the held shares are worth at the current share rate, i.e.
-   * `pool.convertToAssets(pool.balanceOf(wallet))`.
+   * `pool.sharesToUnderlying(pool.getShareBalance(wallet))`.
+   *
+   * Does not account for withdraw fee: this is what the shares are worth,
+   * not what leaving with them would pay.
    **/
   netValue: TokenAmount;
   /**
@@ -181,6 +184,11 @@ interface BorrowRateBreakdown {
    **/
   quotas: TokenQuotaRate[];
 }
+/**
+ * Set on {@link StrategyPosition.error} when the account could not be fully
+ * valued (e.g. a dead price feed).
+ **/
+declare const STRATEGY_POSITION_COLLATERAL_ERROR = "collateral computation failed";
 /**
  * An open credit account of a wallet.
  **/
@@ -192,6 +200,9 @@ interface StrategyPosition {
   /**
    * Human-readable strategy name, e.g. `"wstETH / WETH"`. Derived from
    * {@link targetCollateral}.
+   *
+   * In both-mode merge the backend value overlays the chain row, so a
+   * source disagreement is expected.
    **/
   name: string;
   /**
@@ -215,6 +226,9 @@ interface StrategyPosition {
   underlyingToken: UnderlyingToken;
   /**
    * Collateral token this position is a strategy in.
+   *
+   * In both-mode merge the backend value overlays the chain row, so a
+   * source disagreement is expected.
    **/
   targetCollateral: Token | null;
   /**
@@ -310,6 +324,13 @@ interface StrategyPosition {
    * withdrawals.
    **/
   collaterals: PositionCollateral[];
+  /**
+   * Present when the account could not be fully valued (e.g. a dead price
+   * feed). Identity, balances, and debt principal are still filled; valued
+   * fields are best-effort. Set by either the chain compressor path or the
+   * backend.
+   **/
+  error?: string;
 }
 /**
  * A row of the positions list: anything a wallet holds in the protocol.
@@ -452,9 +473,9 @@ interface PositionsTotals {
    **/
   currentYield: ApyBreakdown | null;
   /**
-   * Profit and loss over every position, in USD terms of {@link PnlBreakdown}.
+   * Profit and loss over every position in USD.
    **/
-  pnl: PnlBreakdown | null;
+  pnlUsd: number | null;
   /**
    * Net value of every position in US dollars.
    **/
@@ -468,11 +489,27 @@ interface PositionsTotals {
 /**
  * What a transaction did to a position.
  **/
-type PositionTransactionKind = "open" | "deposit" | "withdraw" | "adjustLeverage" | "addCollateral" | "withdrawCollateral" | "liquidation";
+type PositionTransactionKind = "open" | "deposit" | "withdraw" | "adjustLeverage" | "addCollateral" | "withdrawCollateral" | "liquidation" | "repay" |
+/**
+ * The transaction only rearranged what the account already held — a swap, a
+ * claim or a quota change — without moving its net value or its debt.
+ **/
+"rebalance" |
+/**
+ * The residual kind: the transaction is not one of the above. Either the
+ * backend could not attribute the account's state movement completely, or
+ * the movements it did observe contradict each other (value left the
+ * account while debt grew, say), so no single intent describes it. Never a
+ * synonym for "nothing happened", and never a direction to infer from.
+ **/
+"other";
 /**
  * One transaction in a position's history, from the backend's indexer.
  **/
 interface PositionTransaction {
+  /**
+   * Hash of the transaction.
+   **/
   txHash: Hex;
   /**
    * Unix seconds of the block the transaction was mined in.
@@ -480,9 +517,27 @@ interface PositionTransaction {
   timestamp: Timestamp;
   kind: PositionTransactionKind;
   /**
-   * Assets the transaction moved, in the direction the kind implies.
+   * Net magnitudes of the assets the borrower moved. A directional kind
+   * supplies the direction; callers must not infer one for an `other`
+   * transaction.
    **/
   assets: TokenAmount[];
+  /**
+   * Signed change of every credit-account token balance caused by the
+   * transaction. Positive values were added to the account; negative values
+   * left it. Tokens whose balance did not change are omitted.
+   **/
+  balanceChanges: TokenAmount[];
+  /**
+   * Signed change of the position's total debt — principal plus accrued
+   * interest plus accrued fees — denominated in the market underlying. It is
+   * differenced between the backend's consecutive debt observations around
+   * the transaction, so it is what the borrower ends up owing, not the
+   * principal the transaction asked to move: a repayment outrun by accrued
+   * interest is positive, and a transaction that moved no principal at all
+   * can still carry the interest that accrued alongside it.
+   **/
+  debtChange: TokenAmount;
 }
 //#endregion
-export { BorrowRateBreakdown, PnlBreakdown, PointsProgramPnL, PointsRewardsPnL, PoolPosition, PoolPositionKey, PoolPositionRef, Position, PositionCollateral, PositionFilter, PositionId, PositionKey, PositionKind, PositionTransaction, PositionTransactionKind, PositionsTotals, RewardsPnL, StrategyPosition, StrategyPositionKey, StrategyPositionRef, TokenQuotaRate, TokenRewardsPnL, liquidationPositionId, matchesPositionFilter, poolPositionId, positionId, strategyPositionId };
+export { 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 };

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

@@ -545,6 +545,7 @@ declare const strategyPositionSchema: z.ZodObject<{
       claimableAt: z.ZodOptional<z.ZodNumber>;
     }, z.core.$strip>>;
   }, z.core.$strip>>;
+  error: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
 /**
  * {@link Position}
@@ -891,6 +892,7 @@ declare const positionSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
       claimableAt: z.ZodOptional<z.ZodNumber>;
     }, z.core.$strip>>;
   }, z.core.$strip>>;
+  error: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>, z.ZodObject<{
   kind: z.ZodLiteral<"liquidation">;
   name: z.ZodString;
@@ -1018,67 +1020,21 @@ declare const positionsTotalsSchema: z.ZodObject<{
       }, z.core.$strip>>;
     }, z.core.$strip>], "kind">>>;
   }, z.core.$strip>>;
-  pnl: z.ZodNullable<z.ZodObject<{
-    organic: z.ZodObject<{
-      value: z.ZodCodec<z.ZodUnion<[z.ZodString, z.ZodBigInt]>, z.ZodBigInt>;
-      valueUsd: z.ZodNullable<z.ZodNumber>;
-      token: z.ZodObject<{
-        chainId: z.ZodNumber;
-        address: z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>;
-        symbol: z.ZodString;
-        name: z.ZodString;
-        decimals: z.ZodNumber;
-        assetType: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"Stable">, z.ZodLiteral<"ETH">, z.ZodLiteral<"BTC">]>>;
-      }, z.core.$strip>;
-    }, z.core.$strip>;
-    total: z.ZodObject<{
-      value: z.ZodCodec<z.ZodUnion<[z.ZodString, z.ZodBigInt]>, z.ZodBigInt>;
-      valueUsd: z.ZodNullable<z.ZodNumber>;
-      token: z.ZodObject<{
-        chainId: z.ZodNumber;
-        address: z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>;
-        symbol: z.ZodString;
-        name: z.ZodString;
-        decimals: z.ZodNumber;
-        assetType: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"Stable">, z.ZodLiteral<"ETH">, z.ZodLiteral<"BTC">]>>;
-      }, z.core.$strip>;
-    }, z.core.$strip>;
-    rewards: z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
-      value: z.ZodCodec<z.ZodUnion<[z.ZodString, z.ZodBigInt]>, z.ZodBigInt>;
-      valueUsd: z.ZodNullable<z.ZodNumber>;
-      token: z.ZodObject<{
-        chainId: z.ZodNumber;
-        address: z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>;
-        symbol: z.ZodString;
-        name: z.ZodString;
-        decimals: z.ZodNumber;
-        assetType: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"Stable">, z.ZodLiteral<"ETH">, z.ZodLiteral<"BTC">]>>;
-      }, z.core.$strip>;
-      kind: z.ZodLiteral<"token">;
-    }, z.core.$strip>, z.ZodObject<{
-      kind: z.ZodLiteral<"point">;
-      points: z.ZodArray<z.ZodObject<{
-        id: z.ZodString;
-        name: z.ZodString;
-        multiplier: z.ZodNullable<z.ZodNumber>;
-        value: z.ZodNumber;
-      }, z.core.$strip>>;
-    }, z.core.$strip>], "kind">>;
-  }, z.core.$strip>>;
+  pnlUsd: z.ZodNullable<z.ZodNumber>;
   netValueUsd: z.ZodNullable<z.ZodNumber>;
   claimableUsd: z.ZodNullable<z.ZodNumber>;
 }, z.core.$strip>;
 /**
  * {@link PositionTransactionKind}
  **/
-declare const positionTransactionKindSchema: z.ZodUnion<readonly [z.ZodLiteral<"open">, z.ZodLiteral<"deposit">, z.ZodLiteral<"withdraw">, z.ZodLiteral<"adjustLeverage">, z.ZodLiteral<"addCollateral">, z.ZodLiteral<"withdrawCollateral">, z.ZodLiteral<"liquidation">]>;
+declare const positionTransactionKindSchema: z.ZodUnion<readonly [z.ZodLiteral<"open">, z.ZodLiteral<"deposit">, z.ZodLiteral<"withdraw">, z.ZodLiteral<"adjustLeverage">, z.ZodLiteral<"addCollateral">, z.ZodLiteral<"withdrawCollateral">, z.ZodLiteral<"liquidation">, z.ZodLiteral<"repay">, z.ZodLiteral<"rebalance">, z.ZodLiteral<"other">]>;
 /**
  * {@link PositionTransaction}
  **/
 declare const positionTransactionSchema: z.ZodObject<{
   txHash: z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>;
   timestamp: z.ZodNumber;
-  kind: z.ZodUnion<readonly [z.ZodLiteral<"open">, z.ZodLiteral<"deposit">, z.ZodLiteral<"withdraw">, z.ZodLiteral<"adjustLeverage">, z.ZodLiteral<"addCollateral">, z.ZodLiteral<"withdrawCollateral">, z.ZodLiteral<"liquidation">]>;
+  kind: z.ZodUnion<readonly [z.ZodLiteral<"open">, z.ZodLiteral<"deposit">, z.ZodLiteral<"withdraw">, z.ZodLiteral<"adjustLeverage">, z.ZodLiteral<"addCollateral">, z.ZodLiteral<"withdrawCollateral">, z.ZodLiteral<"liquidation">, z.ZodLiteral<"repay">, z.ZodLiteral<"rebalance">, z.ZodLiteral<"other">]>;
   assets: z.ZodArray<z.ZodObject<{
     value: z.ZodCodec<z.ZodUnion<[z.ZodString, z.ZodBigInt]>, z.ZodBigInt>;
     valueUsd: z.ZodNullable<z.ZodNumber>;
@@ -1091,6 +1047,30 @@ declare const positionTransactionSchema: z.ZodObject<{
       assetType: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"Stable">, z.ZodLiteral<"ETH">, z.ZodLiteral<"BTC">]>>;
     }, z.core.$strip>;
   }, z.core.$strip>>;
+  balanceChanges: z.ZodArray<z.ZodObject<{
+    value: z.ZodCodec<z.ZodUnion<[z.ZodString, z.ZodBigInt]>, z.ZodBigInt>;
+    valueUsd: z.ZodNullable<z.ZodNumber>;
+    token: z.ZodObject<{
+      chainId: z.ZodNumber;
+      address: z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>;
+      symbol: z.ZodString;
+      name: z.ZodString;
+      decimals: z.ZodNumber;
+      assetType: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"Stable">, z.ZodLiteral<"ETH">, z.ZodLiteral<"BTC">]>>;
+    }, z.core.$strip>;
+  }, z.core.$strip>>;
+  debtChange: z.ZodObject<{
+    value: z.ZodCodec<z.ZodUnion<[z.ZodString, z.ZodBigInt]>, z.ZodBigInt>;
+    valueUsd: z.ZodNullable<z.ZodNumber>;
+    token: z.ZodObject<{
+      chainId: z.ZodNumber;
+      address: z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>;
+      symbol: z.ZodString;
+      name: z.ZodString;
+      decimals: z.ZodNumber;
+      assetType: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"Stable">, z.ZodLiteral<"ETH">, z.ZodLiteral<"BTC">]>>;
+    }, z.core.$strip>;
+  }, z.core.$strip>;
 }, z.core.$strip>;
 //#endregion
 export { borrowRateBreakdownSchema, pnlBreakdownSchema, pointsProgramPnLSchema, pointsRewardsPnLSchema, poolPositionKeySchema, poolPositionSchema, positionCollateralSchema, positionFilterQueryParamsSchema, positionFilterQuerySchema, positionFilterSchema, positionKeySchema, positionKindSchema, positionSchema, positionTransactionKindSchema, positionTransactionSchema, positionsTotalsSchema, rewardsPnLSchema, strategyPositionKeySchema, strategyPositionSchema, tokenQuotaRateSchema, tokenRewardsPnLSchema };