@gearbox-protocol/sdk 14.12.0-next.67 → 14.12.0-next.69

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

@@ -100,7 +100,7 @@ declare const delayedReceivedAssetSchema: z.ZodObject<{
     assetType: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"Stable">, z.ZodLiteral<"ETH">, z.ZodLiteral<"BTC">]>>;
   }, z.core.$strip>;
   isDelayed: z.ZodLiteral<true>;
-  redeemerAddress: z.ZodOptional<z.ZodPipe<z.ZodString, z.ZodTransform<`0x${string}`, string>>>;
+  redeemer: z.ZodOptional<z.ZodPipe<z.ZodString, z.ZodTransform<`0x${string}`, string>>>;
   claimableAt: z.ZodOptional<z.ZodNumber>;
 }, z.core.$strip>;
 /**
@@ -130,7 +130,7 @@ declare const receivedAssetSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
     assetType: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"Stable">, z.ZodLiteral<"ETH">, z.ZodLiteral<"BTC">]>>;
   }, z.core.$strip>;
   isDelayed: z.ZodLiteral<true>;
-  redeemerAddress: z.ZodOptional<z.ZodPipe<z.ZodString, z.ZodTransform<`0x${string}`, string>>>;
+  redeemer: z.ZodOptional<z.ZodPipe<z.ZodString, z.ZodTransform<`0x${string}`, string>>>;
   claimableAt: z.ZodOptional<z.ZodNumber>;
 }, z.core.$strip>], "isDelayed">;
 /**
@@ -153,6 +153,8 @@ declare const liquidationApprovalSchema: z.ZodObject<{
  * {@link LiquidationPosition}
  **/
 declare const liquidationPositionSchema: z.ZodObject<{
+  kind: z.ZodLiteral<"liquidation">;
+  name: z.ZodString;
   chainId: z.ZodNumber;
   sourceToken: z.ZodObject<{
     chainId: z.ZodNumber;
@@ -260,7 +262,7 @@ declare const liquidationDetailsSchema: z.ZodObject<{
       assetType: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"Stable">, z.ZodLiteral<"ETH">, z.ZodLiteral<"BTC">]>>;
     }, z.core.$strip>;
     isDelayed: z.ZodLiteral<true>;
-    redeemerAddress: z.ZodOptional<z.ZodPipe<z.ZodString, z.ZodTransform<`0x${string}`, string>>>;
+    redeemer: z.ZodOptional<z.ZodPipe<z.ZodString, z.ZodTransform<`0x${string}`, string>>>;
     claimableAt: z.ZodOptional<z.ZodNumber>;
   }, z.core.$strip>], "isDelayed">>;
   isLiquidatorEligible: z.ZodBoolean;

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

@@ -80,12 +80,17 @@ interface ApyBreakdown {
   /**
    * Everything combined, in basis points: the number a UI shows as "APY".
    *
+   * Absent in `onchain` mode: it folds in the incentives of {@link rewards},
+   * which only the backend knows.
+   *
    * @example `842` for 8.42% APY
+   *
+   * @mode offchain
    **/
-  totalApy: Bps;
+  totalApy?: Bps;
   /**
    * The part generated by the underlying protocol alone, without incentives,
-   * in basis points.
+   * in basis points. Always readable from the chain.
    *
    * @example `610` for 6.10% APY
    **/
@@ -93,8 +98,10 @@ interface ApyBreakdown {
   /**
    * Incentives that make up the difference between {@link organicApy} and
    * {@link totalApy}, plus any points programs that carry no APY at all.
+   *
+   * @mode offchain
    **/
-  rewards: Rewards[];
+  rewards?: Rewards[];
 }
 /**
  * Fields both opportunity kinds share.
@@ -109,7 +116,7 @@ interface OpportunityBase {
    *
    * @example `"USDC Pool"`, `"wstETH / WETH"`
    **/
-  title: string;
+  name: string;
   /**
    * Curator of the market this opportunity belongs to.
    **/
@@ -123,32 +130,12 @@ interface OpportunityBase {
    **/
   underlyingToken: Token;
   /**
-   * Size of the opportunity.
-   *
-   * For a pool this is the supply of pool shares; for a strategy it is the
-   * summed total value of the credit accounts holding the target collateral.
-   **/
-  totalSupply: Amount;
-  /**
-   * Debt principal drawn against the opportunity.
+   * Debt principal drawn against the opportunity: everything the pool has lent
+   * out for a {@link PoolOpportunity} (`pool.totalBorrowed()`), only what the
+   * strategy's credit manager has drawn for a {@link StrategyOpportunity}
+   * (`pool.creditManagerBorrowed(creditManager)`).
    **/
   totalBorrow: Amount;
-  /**
-   * How much of the available capital is currently borrowed, in basis points.
-   *
-   * @example `7500` for 75% utilization
-   **/
-  utilization: Bps;
-  /**
-   * Yield earned by supplying. For a strategy it is the net yield at
-   * {@link StrategyOpportunity.maxLeverage}.
-   *
-   * Absent in `onchain` mode: every yield figure that folds in incentives,
-   * points or smoothing is computed by the backend.
-   *
-   * @mode offchain
-   **/
-  supplyApy?: ApyBreakdown;
   /**
    * Tokens accepted as collateral, i.e. the tokens that have both a non-zero
    * liquidation threshold and a non-zero quota limit.
@@ -184,6 +171,27 @@ interface PoolOpportunity extends OpportunityBase {
    * Address of the ERC-4626 pool contract.
    **/
   pool: Address;
+  /**
+   * Size of the pool: the underlying its shares are worth, converted at the
+   * current share rate, i.e. `pool.totalAssets()`. Denominated in the
+   * underlying rather than in shares, so it is comparable with
+   * {@link OpportunityBase.totalBorrow}.
+   **/
+  totalSupply: Amount;
+  /**
+   * How much of the pool's capital is currently borrowed, in basis points.
+   *
+   * @example `7500` for 75% utilization
+   **/
+  utilization: Bps;
+  /**
+   * Yield earned by supplying to the pool.
+   *
+   * Its {@link ApyBreakdown.organicApy} is the pool's own supply rate (
+   * which consists of base interest and quota revenue)
+   * so this group is present in `onchain` mode too, with only that part filled.
+   **/
+  supplyApy: ApyBreakdown;
 }
 /**
  * A leveraged position: one credit manager plus one target collateral token.
@@ -233,11 +241,22 @@ interface StrategyOpportunity extends OpportunityBase {
   expirationDate: Timestamp | null;
   /**
    * Yield the collateral itself earns while it sits in the credit account,
-   * before leverage.
+   * before leverage. Comes from external sources rather than from the chain.
    *
    * @mode offchain
    **/
   collateralApy?: ApyBreakdown;
+  /**
+   * Net yield at {@link maxLeverage}:
+   * `collateralApy * maxLeverage - borrowApy * (maxLeverage - 1)`, applied to
+   * {@link ApyBreakdown.totalApy}, {@link ApyBreakdown.organicApy} and
+   * {@link ApyBreakdown.rewards} alike.
+   *
+   * Absent in `onchain` mode: its {@link collateralApy} term is.
+   *
+   * @mode offchain
+   **/
+  maxLeverageApy?: ApyBreakdown;
   /**
    * Annual cost of the borrowed underlying, in basis points, including the
    * protocol's interest fee.
@@ -253,6 +272,28 @@ interface StrategyOpportunity extends OpportunityBase {
    * @example `90` for +0.9% APY
    **/
   additionalBorrowApy?: Bps;
+  /**
+   * Size of the strategy: the summed total value of the credit accounts
+   * holding {@link targetCollateral}. An account that holds several strategy
+   * collaterals counts in full towards each of them.
+   *
+   * Absent in `onchain` mode.
+   *
+   * @mode offchain
+   **/
+  totalValue?: Amount;
+  /**
+   * Share of {@link totalValue} that is borrowed, in basis points:
+   * `totalBorrow / totalValue`.
+   *
+   * Absent in `onchain` mode, because its denominator is, see
+   * {@link totalValue}.
+   *
+   * @example `7500` for 75% utilization
+   *
+   * @mode offchain
+   **/
+  utilization?: Bps;
   /**
    * Largest debt a single new position can take on right now: the tightest of
    * the credit manager's remaining debt limit, the pool's free liquidity and