@gearbox-protocol/sdk 17.13.0-next.1 → 17.13.0-next.10

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

@@ -7,11 +7,11 @@ import { z } from "zod/v4";
 /**
  * {@link OpportunityKind}
  **/
-declare const opportunityKindSchema: z.ZodUnion<readonly [z.ZodLiteral<"pool">, z.ZodLiteral<"strategy">]>;
+export declare const opportunityKindSchema: z.ZodUnion<readonly [z.ZodLiteral<"pool">, z.ZodLiteral<"strategy">]>;
 /**
  * {@link PointsProgram}
  **/
-declare const pointsProgramSchema: z.ZodObject<{
+export declare const pointsProgramSchema: z.ZodObject<{
   id: z.ZodString;
   name: z.ZodString;
   multiplier: z.ZodNullable<z.ZodNumber>;
@@ -19,7 +19,7 @@ declare const pointsProgramSchema: z.ZodObject<{
 /**
  * {@link TokenRewards}
  **/
-declare const tokenRewardsSchema: z.ZodObject<{
+export declare const tokenRewardsSchema: z.ZodObject<{
   kind: z.ZodLiteral<"token">;
   token: z.ZodObject<{
     chainId: z.ZodNumber;
@@ -36,7 +36,7 @@ declare const tokenRewardsSchema: z.ZodObject<{
 /**
  * {@link PointRewards}
  **/
-declare const pointRewardsSchema: z.ZodObject<{
+export declare const pointRewardsSchema: z.ZodObject<{
   kind: z.ZodLiteral<"point">;
   points: z.ZodArray<z.ZodObject<{
     id: z.ZodString;
@@ -47,7 +47,7 @@ declare const pointRewardsSchema: z.ZodObject<{
 /**
  * {@link Rewards}
  **/
-declare const rewardsSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
+export declare const rewardsSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
   kind: z.ZodLiteral<"token">;
   token: z.ZodObject<{
     chainId: z.ZodNumber;
@@ -71,7 +71,7 @@ declare const rewardsSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
 /**
  * {@link ApyBreakdown}
  **/
-declare const apyBreakdownSchema: z.ZodObject<{
+export declare const apyBreakdownSchema: z.ZodObject<{
   totalApy: z.ZodOptional<z.ZodNumber>;
   organicApy: z.ZodNumber;
   rewards: z.ZodOptional<z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
@@ -99,7 +99,7 @@ declare const apyBreakdownSchema: z.ZodObject<{
 /**
  * {@link OpportunityBase}
  **/
-declare const opportunityBaseSchema: z.ZodObject<{
+export declare const opportunityBaseSchema: z.ZodObject<{
   chainId: z.ZodNumber;
   name: z.ZodString;
   curator: z.ZodObject<{
@@ -146,7 +146,7 @@ declare const opportunityBaseSchema: z.ZodObject<{
 /**
  * {@link QuotaAsset}
  **/
-declare const quotaAssetSchema: z.ZodObject<{
+export declare const quotaAssetSchema: z.ZodObject<{
   token: z.ZodObject<{
     chainId: z.ZodNumber;
     address: z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>;
@@ -173,7 +173,7 @@ declare const quotaAssetSchema: z.ZodObject<{
 /**
  * {@link PoolOpportunity}
  **/
-declare const poolOpportunitySchema: z.ZodObject<{
+export declare const poolOpportunitySchema: z.ZodObject<{
   chainId: z.ZodNumber;
   name: z.ZodString;
   curator: z.ZodObject<{
@@ -308,7 +308,7 @@ declare const poolOpportunitySchema: z.ZodObject<{
 /**
  * {@link StrategyOpportunity}
  **/
-declare const strategyOpportunitySchema: z.ZodObject<{
+export declare const strategyOpportunitySchema: z.ZodObject<{
   chainId: z.ZodNumber;
   name: z.ZodString;
   curator: z.ZodObject<{
@@ -454,7 +454,7 @@ declare const strategyOpportunitySchema: z.ZodObject<{
 /**
  * {@link Opportunity}
  **/
-declare const opportunitySchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
+export declare const opportunitySchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
   chainId: z.ZodNumber;
   name: z.ZodString;
   curator: z.ZodObject<{
@@ -731,7 +731,7 @@ declare const opportunitySchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
 /**
  * {@link OpportunityFilter}
  **/
-declare const opportunityFilterSchema: z.ZodObject<{
+export declare const opportunityFilterSchema: z.ZodObject<{
   kind: z.ZodOptional<z.ZodUnion<[z.ZodUnion<readonly [z.ZodLiteral<"pool">, z.ZodLiteral<"strategy">]>, z.ZodLiteral<"all">]>>;
   chainIds: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
   underlyingType: z.ZodOptional<z.ZodUnion<[z.ZodUnion<readonly [z.ZodLiteral<"Stable">, z.ZodLiteral<"ETH">, z.ZodLiteral<"BTC">]>, z.ZodLiteral<"all">]>>;
@@ -743,7 +743,7 @@ declare const opportunityFilterSchema: z.ZodObject<{
  * {@link OpportunityFilter} as a URL can carry it: every condition is a string,
  * and a condition that does not narrow is absent rather than empty.
  **/
-declare const opportunityFilterQueryParamsSchema: z.ZodObject<{
+export declare const opportunityFilterQueryParamsSchema: z.ZodObject<{
   kind: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"pool">, z.ZodLiteral<"strategy">]>>;
   chainIds: z.ZodOptional<z.ZodString>;
   underlyingType: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"Stable">, z.ZodLiteral<"ETH">, z.ZodLiteral<"BTC">]>>;
@@ -763,7 +763,7 @@ declare const opportunityFilterQueryParamsSchema: z.ZodObject<{
 /**
  * Code for {@link OpportunityFilter} to encode/decode to/from url query parameters.
  **/
-declare const opportunityFilterQuerySchema: z.ZodCodec<z.ZodObject<{
+export declare const opportunityFilterQuerySchema: z.ZodCodec<z.ZodObject<{
   kind: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"pool">, z.ZodLiteral<"strategy">]>>;
   chainIds: z.ZodOptional<z.ZodString>;
   underlyingType: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"Stable">, z.ZodLiteral<"ETH">, z.ZodLiteral<"BTC">]>>;
@@ -790,7 +790,7 @@ declare const opportunityFilterQuerySchema: z.ZodCodec<z.ZodObject<{
 /**
  * {@link RateCurvePoint}
  **/
-declare const rateCurvePointSchema: z.ZodObject<{
+export declare const rateCurvePointSchema: z.ZodObject<{
   utilization: z.ZodNumber;
   supplyApy: z.ZodNumber;
   borrowApy: z.ZodNumber;
@@ -798,7 +798,7 @@ declare const rateCurvePointSchema: z.ZodObject<{
 /**
  * {@link RateCurve}
  **/
-declare const rateCurveSchema: z.ZodObject<{
+export declare const rateCurveSchema: z.ZodObject<{
   points: z.ZodArray<z.ZodObject<{
     utilization: z.ZodNumber;
     supplyApy: z.ZodNumber;
@@ -809,7 +809,7 @@ declare const rateCurveSchema: z.ZodObject<{
 /**
  * {@link PriceFeedData}. Recursive: a composite feed lists the feeds it reads.
  **/
-declare const priceFeedDataSchema: z.ZodObject<{
+export declare const priceFeedDataSchema: z.ZodObject<{
   name: z.ZodString;
   type: z.ZodString;
   feedAddress: z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>;
@@ -818,7 +818,7 @@ declare const priceFeedDataSchema: z.ZodObject<{
 /**
  * {@link PriceFeedSummary}
  **/
-declare const priceFeedSummarySchema: z.ZodObject<{
+export declare const priceFeedSummarySchema: z.ZodObject<{
   underlyingPriceInUsd: z.ZodNumber;
   collateralPriceInUsd: z.ZodNumber;
   collateralPriceInUnderlying: z.ZodNumber;
@@ -838,7 +838,7 @@ declare const priceFeedSummarySchema: z.ZodObject<{
 /**
  * {@link PoolOpportunityDetail}
  **/
-declare const poolOpportunityDetailSchema: z.ZodObject<{
+export declare const poolOpportunityDetailSchema: z.ZodObject<{
   chainId: z.ZodNumber;
   name: z.ZodString;
   curator: z.ZodObject<{
@@ -981,7 +981,7 @@ declare const poolOpportunityDetailSchema: z.ZodObject<{
 /**
  * {@link StrategyOpportunityDetail}
  **/
-declare const strategyOpportunityDetailSchema: z.ZodObject<{
+export declare const strategyOpportunityDetailSchema: z.ZodObject<{
   chainId: z.ZodNumber;
   name: z.ZodString;
   curator: z.ZodObject<{
@@ -1167,7 +1167,7 @@ declare const strategyOpportunityDetailSchema: z.ZodObject<{
 /**
  * {@link OpportunityDetail}
  **/
-declare const opportunityDetailSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
+export declare const opportunityDetailSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
   chainId: z.ZodNumber;
   name: z.ZodString;
   curator: z.ZodObject<{
@@ -1492,21 +1492,21 @@ declare const opportunityDetailSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
 /**
  * {@link PoolOpportunityKey}
  **/
-declare const poolOpportunityKeySchema: z.ZodObject<{
+export declare const poolOpportunityKeySchema: z.ZodObject<{
   chainId: z.ZodNumber;
   pool: z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>;
 }, z.core.$strip>;
 /**
  * {@link StrategyOpportunityKey}
  **/
-declare const strategyOpportunityKeySchema: z.ZodObject<{
+export declare const strategyOpportunityKeySchema: z.ZodObject<{
   chainId: z.ZodNumber;
   creditManager: z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>;
 }, z.core.$strip>;
 /**
  * {@link OpportunityKey}
  **/
-declare const opportunityKeySchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
+export declare const opportunityKeySchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
   chainId: z.ZodNumber;
   pool: z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>;
   kind: z.ZodLiteral<"pool">;
@@ -1518,10 +1518,9 @@ declare const opportunityKeySchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
 /**
  * {@link OpportunityTotals}
  **/
-declare const opportunityTotalsSchema: z.ZodObject<{
+export declare const opportunityTotalsSchema: z.ZodObject<{
   tvl: z.ZodNumber;
   totalBorrowed: z.ZodNumber;
   totalSupply: z.ZodNumber;
 }, z.core.$strip>;
-//#endregion
-export { apyBreakdownSchema, opportunityBaseSchema, opportunityDetailSchema, opportunityFilterQueryParamsSchema, opportunityFilterQuerySchema, opportunityFilterSchema, opportunityKeySchema, opportunityKindSchema, opportunitySchema, opportunityTotalsSchema, pointRewardsSchema, pointsProgramSchema, poolOpportunityDetailSchema, poolOpportunityKeySchema, poolOpportunitySchema, priceFeedDataSchema, priceFeedSummarySchema, quotaAssetSchema, rateCurvePointSchema, rateCurveSchema, rewardsSchema, strategyOpportunityDetailSchema, strategyOpportunityKeySchema, strategyOpportunitySchema, tokenRewardsSchema };
+//#endregion

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

@@ -1,4 +1,5 @@
 import { AssetType, Bps, ChainId, Leverage, Timestamp, Token, TokenAmount, UnderlyingToken } from "./primitives.js";
+import { Curator } from "./curators.js";
 import { ChainScopedFilter, Filterable } from "./filters.js";
 import { ApyBreakdown, PointsProgram } from "./opportunities.js";
 import { DelayedReceivedAsset, LiquidationPosition } from "./liquidations.js";
@@ -12,18 +13,18 @@ import { Address, Hex } from "viem";
  * - `"liquidation"` — a delayed withdrawal a liquidator took ownership of,
  *   see {@link LiquidationPosition}.
  **/
-type PositionKind = "pool" | "strategy" | "liquidation";
+export type PositionKind = "pool" | "strategy" | "liquidation";
 /**
  * Earnings in a token, as an amount rather than a rate.
  **/
-interface TokenRewardsPnL extends TokenAmount {
+export interface TokenRewardsPnL extends TokenAmount {
   kind: "token";
 }
 /**
  * A points program together with how many points the position has accrued in
  * it. The program itself is described by {@link PointsProgram}.
  **/
-interface PointsProgramPnL extends PointsProgram {
+export interface PointsProgramPnL extends PointsProgram {
   /**
    * Points accrued so far. Points have no price, so this is a plain count
    * rather than an {@link Amount}.
@@ -35,7 +36,7 @@ interface PointsProgramPnL extends PointsProgram {
 /**
  * Earnings accrued as points rather than tokens.
  **/
-interface PointsRewardsPnL {
+export interface PointsRewardsPnL {
   kind: "point";
   /**
    * Programs the position has accrued points in.
@@ -45,7 +46,7 @@ interface PointsRewardsPnL {
 /**
  * Any earnings stream of a position, as accrued amounts.
  **/
-type RewardsPnL = TokenRewardsPnL | PointsRewardsPnL;
+export type RewardsPnL = TokenRewardsPnL | PointsRewardsPnL;
 /**
  * What a position has earned since it was opened, split the same way
  * {@link ApyBreakdown} splits the rates that produced it.
@@ -53,7 +54,7 @@ type RewardsPnL = TokenRewardsPnL | PointsRewardsPnL;
  * Every field needs the position's history, so the whole group is off-chain
  * only, see {@link PoolPosition.pnl} and {@link StrategyPosition.pnl}.
  **/
-interface PnlBreakdown {
+export interface PnlBreakdown {
   /**
    * The part the protocol itself generated: organic interest plus price moves,
    * denominated in the underlying.
@@ -74,7 +75,7 @@ interface PnlBreakdown {
  * One collateral token of a credit account: what the account holds of it, what
  * it pays quota on, and what it has on its way out.
  **/
-interface PositionCollateral {
+export interface PositionCollateral {
   /**
    * Amount of the token the account holds. Phantom tokens are reported as-is,
    * i.e. as the phantom token rather than as the asset it redeems into.
@@ -94,7 +95,7 @@ interface PositionCollateral {
 /**
  * Pool shares held by a wallet.
  **/
-interface PoolPosition {
+export interface PoolPosition {
   /**
    * Discriminates this position from the other kinds a wallet can hold.
    **/
@@ -105,6 +106,8 @@ interface PoolPosition {
    * @example `"USDC Pool"`
    **/
   name: string;
+  /** Curator of the market this pool belongs to. */
+  curator: Curator;
   /**
    * Chain the pool lives on.
    **/
@@ -153,7 +156,7 @@ interface PoolPosition {
  * Per-token quota rate contribution of one collateral token, relative to the
  * position's total value.
  **/
-interface TokenQuotaRate {
+export interface TokenQuotaRate {
   token: Token;
   rate: Bps;
 }
@@ -164,7 +167,7 @@ interface TokenQuotaRate {
  * adds its own quota rate on top. Rates are reported in two normalizations:
  * relative to the position's total value and relative to its debt.
  **/
-interface BorrowRateBreakdown {
+export interface BorrowRateBreakdown {
   /**
    * Base rate plus quota rates, relative to the position's total value.
    **/
@@ -188,11 +191,11 @@ interface BorrowRateBreakdown {
  * 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";
+export declare const STRATEGY_POSITION_COLLATERAL_ERROR = "collateral computation failed";
 /**
  * An open credit account of a wallet.
  **/
-interface StrategyPosition {
+export interface StrategyPosition {
   /**
    * Discriminates this position from the other kinds a wallet can hold.
    **/
@@ -205,6 +208,8 @@ interface StrategyPosition {
    * source disagreement is expected.
    **/
   name: string;
+  /** Curator of the market this credit account belongs to. */
+  curator: Curator;
   /**
    * Chain the account lives on.
    **/
@@ -335,7 +340,7 @@ interface StrategyPosition {
 /**
  * A row of the positions list: anything a wallet holds in the protocol.
  **/
-type Position = PoolPosition | StrategyPosition | LiquidationPosition;
+export type Position = PoolPosition | StrategyPosition | LiquidationPosition;
 /**
  * Canonical id of a position: the string used to match a row read from the
  * chain with the same row served by the backend.
@@ -343,7 +348,7 @@ type Position = PoolPosition | StrategyPosition | LiquidationPosition;
  * A position list is always scoped to one wallet, so the wallet is not part of
  * the id.
  **/
-type PositionId = string;
+export type PositionId = string;
 /**
  * Builds the canonical id of a pool position.
  *
@@ -352,7 +357,7 @@ type PositionId = string;
  * poolPositionId(1, "0xda00...") // "1:pool:0xda00..."
  * ```
  **/
-declare function poolPositionId(chainId: ChainId, pool: Address): PositionId;
+export declare function poolPositionId(chainId: ChainId, pool: Address): PositionId;
 /**
  * Builds the canonical id of a strategy position. The credit account address
  * identifies it on its own, the credit manager is not part of the id.
@@ -362,7 +367,7 @@ declare function poolPositionId(chainId: ChainId, pool: Address): PositionId;
  * strategyPositionId(1, "0x9c4c...") // "1:strategy:0x9c4c..."
  * ```
  **/
-declare function strategyPositionId(chainId: ChainId, creditAccount: Address): PositionId;
+export declare function strategyPositionId(chainId: ChainId, creditAccount: Address): PositionId;
 /**
  * Builds the canonical id of a liquidation position.
  *
@@ -371,11 +376,11 @@ declare function strategyPositionId(chainId: ChainId, creditAccount: Address): P
  * source token plus the moment the withdrawal becomes claimable, which is what
  * distinguishes two withdrawals of the same asset.
  **/
-declare function liquidationPositionId(chainId: ChainId, position: Pick<LiquidationPosition, "redeemer" | "sourceToken" | "claimableAt">): PositionId;
+export declare function liquidationPositionId(chainId: ChainId, position: Pick<LiquidationPosition, "redeemer" | "sourceToken" | "claimableAt">): PositionId;
 /**
  * Canonical id of any position, dispatching on {@link Position.kind}.
  **/
-declare function positionId(position: Position): PositionId;
+export declare function positionId(position: Position): PositionId;
 /**
  * Optional narrowing of a positions list.
  *
@@ -384,7 +389,7 @@ declare function positionId(position: Position): PositionId;
  * `"all"` to say the same thing explicitly, which is what a UI whose state has
  * an "any" option holds, see {@link Filterable}. Conditions combine with AND.
  **/
-interface PositionFilter extends ChainScopedFilter {
+export interface PositionFilter extends ChainScopedFilter {
   /**
    * Keep only positions of this kind.
    **/
@@ -418,11 +423,11 @@ interface PositionFilter extends ChainScopedFilter {
  * @param filter - Conditions to test against. An absent filter matches
  * anything.
  **/
-declare function matchesPositionFilter(position: Position, filter?: PositionFilter): boolean;
+export declare function matchesPositionFilter(position: Position, filter?: PositionFilter): boolean;
 /**
  * Identifies a pool position in a detail or history request.
  **/
-interface PoolPositionKey {
+export interface PoolPositionKey {
   chainId: ChainId;
   /**
    * Address of the ERC-4626 pool contract.
@@ -438,7 +443,7 @@ interface PoolPositionKey {
  * Identifies a strategy position in a detail or history request. The credit
  * account address identifies it on its own.
  **/
-interface StrategyPositionKey {
+export interface StrategyPositionKey {
   chainId: ChainId;
   creditAccount: Address;
 }
@@ -446,14 +451,14 @@ interface StrategyPositionKey {
  * {@link PoolPositionKey} tagged with its kind, for requests that accept both
  * kinds.
  **/
-interface PoolPositionRef extends PoolPositionKey {
+export interface PoolPositionRef extends PoolPositionKey {
   kind: "pool";
 }
 /**
  * {@link StrategyPositionKey} tagged with its kind, for requests that accept
  * both kinds.
  **/
-interface StrategyPositionRef extends StrategyPositionKey {
+export interface StrategyPositionRef extends StrategyPositionKey {
   kind: "strategy";
 }
 /**
@@ -461,13 +466,13 @@ interface StrategyPositionRef extends StrategyPositionKey {
  * kinds. Liquidation positions have none: a delayed withdrawal is a single
  * event rather than a series.
  **/
-type PositionKey = PoolPositionRef | StrategyPositionRef;
+export type PositionKey = PoolPositionRef | StrategyPositionRef;
 /**
  * Aggregate over everything a wallet holds, served by the backend rather than
  * summed by a consumer: the list screen's badges. `null` where the wallet
  * holds nothing that contributes.
  **/
-interface PositionsTotals {
+export interface PositionsTotals {
   /**
    * Blended rate the wallet's positions currently earn.
    **/
@@ -489,7 +494,7 @@ interface PositionsTotals {
 /**
  * What a transaction did to a position.
  **/
-type PositionTransactionKind = "open" | "deposit" | "withdraw" | "adjustLeverage" | "addCollateral" | "withdrawCollateral" | "liquidation" | "repay" |
+export 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.
@@ -506,7 +511,7 @@ type PositionTransactionKind = "open" | "deposit" | "withdraw" | "adjustLeverage
 /**
  * One transaction in a position's history, from the backend's indexer.
  **/
-interface PositionTransaction {
+export interface PositionTransaction {
   /**
    * Hash of the transaction.
    **/
@@ -539,5 +544,4 @@ interface PositionTransaction {
    **/
   debtChange: TokenAmount;
 }
-//#endregion
-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 };
+//#endregion