@gearbox-protocol/sdk 14.12.0-next.71 → 14.12.0-next.72

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

@@ -1,3 +1,5 @@
+import { PoolPosition } from "../../model/positions.js";
+import "../../model/index.js";
 import { Asset } from "../base/types.js";
 import { IZapperContract } from "../market/zapper/types.js";
 import "../market/index.js";
@@ -101,10 +103,25 @@ interface WithdrawalMetadata {
    */
   type?: MarketType;
 }
+/**
+ * Props for {@link IPoolsService.listPositions}.
+ **/
+interface ListPoolPositionsProps {
+  /**
+   * Wallet whose pool shares to describe.
+   **/
+  wallet: Address;
+}
 /**
  * Service interface for pool liquidity operations.
  **/
 interface IPoolsService {
+  /**
+   * Lists all pool positions a wallet holds.
+   *
+   * @param props - {@link ListPoolPositionsProps}
+   **/
+  listPositions(props: ListPoolPositionsProps): Promise<PoolPosition[]>;
   /**
    * Returns list of tokens that can be deposited to a pool
    * @param pool
@@ -164,4 +181,4 @@ interface IPoolsService {
   removeLiquidity(props: RemoveLiquidityProps): PoolServiceCallResult;
 }
 //#endregion
-export { AddLiquidityProps, DepositMetadata, IPoolsService, MarketType, PoolServiceCall, PoolServiceCallResult, RemoveLiquidityProps, WithdrawalMetadata };
+export { AddLiquidityProps, DepositMetadata, IPoolsService, ListPoolPositionsProps, MarketType, PoolServiceCall, PoolServiceCallResult, RemoveLiquidityProps, WithdrawalMetadata };

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

@@ -0,0 +1,33 @@
+import { Position } from "../../model/positions.js";
+import "../../model/index.js";
+import { MultichainResult } from "../types/multichain.js";
+import { PluginsMap } from "../plugins/types.js";
+import "../plugins/index.js";
+import { ListPositionsProps } from "./types.js";
+import "../types/index.js";
+import { MultichainConstruct } from "../base/MultichainConstruct.js";
+import "../base/index.js";
+//#region src/sdk/positions/MultichainPositionsService.d.ts
+/**
+ * Cross-chain counterpart of {@link PositionsService}.
+ *
+ * Fans out over every chain configured in {@link MultichainSDK}. A chain that
+ * fails is logged and skipped so one dead RPC does not hide the positions a
+ * wallet holds elsewhere; its failure is reported in
+ * {@link MultichainResult.meta}.
+ *
+ * @typeParam Plugins - Map of attached plugin types.
+ **/
+declare class MultichainPositionsService<const Plugins extends PluginsMap = {}> extends MultichainConstruct<Plugins> {
+  #private;
+  /**
+   * Positions of a wallet on all queried chains, see
+   * {@link PositionsService.list}.
+   *
+   * A filter that names chains narrows the fan-out itself, so chains whose rows
+   * would be discarded are never queried and never appear in the meta.
+   **/
+  list(props: ListPositionsProps): Promise<MultichainResult<Position[]>>;
+}
+//#endregion
+export { MultichainPositionsService };

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

@@ -0,0 +1,22 @@
+import { Position } from "../../model/positions.js";
+import "../../model/index.js";
+import { ListPositionsProps } from "./types.js";
+import { SDKConstruct } from "../base/SDKConstruct.js";
+import "../base/index.js";
+//#region src/sdk/positions/PositionsService.d.ts
+/**
+ * The `positions` read model of one chain: everything a wallet holds in the
+ * protocol — pool shares, open credit accounts, and delayed withdrawals it
+ * took over by liquidating.
+ **/
+declare class PositionsService extends SDKConstruct {
+  /**
+   * Every position of a wallet on this chain, optionally narrowed by
+   * {@link PositionFilter} (see {@link matchesPositionFilter} for what each
+   * criterion selects). Reads live chain state, so rows reflect the moment of
+   * the call rather than the SDK's loaded snapshot.
+   **/
+  list(props: ListPositionsProps): Promise<Position[]>;
+}
+//#endregion
+export { PositionsService };

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

@@ -0,0 +1,4 @@
+import { ListPositionsProps } from "./types.js";
+import { MultichainPositionsService } from "./MultichainPositionsService.js";
+import { PositionsService } from "./PositionsService.js";
+export { ListPositionsProps, MultichainPositionsService, PositionsService };

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

@@ -0,0 +1,25 @@
+import { PositionFilter } from "../../model/positions.js";
+import "../../model/index.js";
+import { Address } from "viem";
+//#region src/sdk/positions/types.d.ts
+/**
+ * Props for {@link PositionsService.list}.
+ *
+ * Chain scoping is expressed by {@link PositionFilter.chainIds} rather than by
+ * the `networks` prop of the other multichain services, so the props are the
+ * same on both, see {@link MultichainPositionsService.list}.
+ **/
+interface ListPositionsProps {
+  /**
+   * Wallet whose positions to list. Every kind of position belongs to a wallet:
+   * pool shares and credit accounts to their holder, delayed withdrawals to the
+   * liquidator that took them over.
+   **/
+  wallet: Address;
+  /**
+   * Optional narrowing, see {@link PositionFilter}.
+   **/
+  filter?: PositionFilter;
+}
+//#endregion
+export { ListPositionsProps };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gearbox-protocol/sdk",
-  "version": "14.12.0-next.71",
+  "version": "14.12.0-next.72",
   "description": "Gearbox SDK",
   "license": "MIT",
   "repository": {