@gearbox-protocol/sdk 16.0.0-next.35 → 16.0.0-next.36

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

@@ -1,7 +1,9 @@
+import { ChainId } from "../../model/primitives.js";
 import { Position, PositionFilter } from "../../model/positions.js";
 import { DataResponse } from "../../model/response.js";
+import { PositionWithdrawals } from "../../model/withdrawals.js";
 import "../../model/index.js";
-import { WithBlock } from "../types/multichain.js";
+import { WithBlock, WithMultichain } from "../types/multichain.js";
 import { Asset, CreditAccountData } from "../base/types.js";
 import "../types/index.js";
 import "../base/index.js";
@@ -33,6 +35,28 @@ interface ListPositionsPropsBase {
  * {@link MultichainPositionsService.list}.
  **/
 type ListPositionsProps<Multichain extends boolean = false> = ListPositionsPropsBase & WithBlock<Multichain>;
+/**
+ * Chain-independent part of {@link GetCurrentWithdrawalsProps}.
+ *
+ * {@link GetCurrentWithdrawalsPropsBase.blockNumber} is kept on the
+ * multichain form because the method already targets a single chain.
+ **/
+interface GetCurrentWithdrawalsPropsBase {
+  /**
+   * Credit account whose delayed withdrawals to read.
+   **/
+  creditAccount: Address;
+  /**
+   * Block to read at. Defaults to the latest block.
+   **/
+  blockNumber?: bigint;
+}
+/**
+ * Props for {@link PositionsService.getCurrentWithdrawals}.
+ **/
+type GetCurrentWithdrawalsProps<Multichain extends boolean = false> = GetCurrentWithdrawalsPropsBase & WithMultichain<Multichain, {
+  chainId: ChainId;
+}>;
 /**
  * Cross-chain reads of the positions namespace: everything a wallet holds.
  **/
@@ -41,6 +65,11 @@ interface IMultichainPositionsService {
    * Positions of a wallet on all queried chains.
    **/
   list(props: ListPositionsProps<true>): Promise<DataResponse<Position[]>>;
+  /**
+   * Delayed withdrawals of one credit account, see
+   * {@link PositionsService.getCurrentWithdrawals}.
+   **/
+  getCurrentWithdrawals(props: GetCurrentWithdrawalsProps<true>): Promise<DataResponse<PositionWithdrawals>>;
 }
 /**
  * Props for {@link PositionsService.listStrategyPositions}.
@@ -96,4 +125,4 @@ interface AccountSnapshot {
  **/
 declare function accountSnapshotFromCreditAccountData(ca: CreditAccountData): AccountSnapshot;
 //#endregion
-export { AccountSnapshot, IMultichainPositionsService, ListPositionsProps, ListPositionsPropsBase, ListStrategyPositionsProps, accountSnapshotFromCreditAccountData };
+export { AccountSnapshot, GetCurrentWithdrawalsProps, GetCurrentWithdrawalsPropsBase, IMultichainPositionsService, ListPositionsProps, ListPositionsPropsBase, ListStrategyPositionsProps, accountSnapshotFromCreditAccountData };

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

@@ -1,14 +1,16 @@
 import { ChartBundle, ChartRange, PoolPositionChartMetric, StrategyPositionChartMetric } from "../../model/charts.js";
 import { PoolPositionRef, Position, PositionFilter, PositionsTotals, StrategyPositionRef } from "../../model/positions.js";
 import { DataResponse } from "../../model/response.js";
+import { PositionWithdrawals } from "../../model/withdrawals.js";
 import "../../model/index.js";
+import { GetCurrentWithdrawalsProps } from "../../onchain/positions/types.js";
 import { MultichainSDK } from "../../onchain/MultichainSDK.js";
 import "../../onchain/index.js";
 import { GearboxAPI } from "../../offchain/GearboxAPI.js";
 import "../../offchain/index.js";
 import { FilterResult } from "../utils/types.js";
 import "../utils/index.js";
-import { IPositionMergers, IPositionsBase, IPositionsOffchainBranch, IPositionsOffchainOnly, IPositionsOnchainBranch } from "./types.js";
+import { IPositionMergers, IPositionsBase, IPositionsOffchainBranch, IPositionsOffchainOnly, IPositionsOnchainBranch, IPositionsOnchainOnly } from "./types.js";
 import { NamespaceOptions } from "../types.js";
 import { AbstractNamespace } from "../AbstractNamespace.js";
 import { Address } from "viem";
@@ -17,7 +19,7 @@ import { Address } from "viem";
  * The `positions` namespace of a {@link GearboxSDK}, see
  * {@link IPositionsByMode} for what each mode offers.
  **/
-declare class PositionsNamespace extends AbstractNamespace<MultichainSDK["positions"], GearboxAPI["positions"]> implements IPositionsBase, IPositionsOffchainOnly, IPositionsOnchainBranch, IPositionsOffchainBranch {
+declare class PositionsNamespace extends AbstractNamespace<MultichainSDK["positions"], GearboxAPI["positions"]> implements IPositionsBase, IPositionsOffchainOnly, IPositionsOnchainOnly, IPositionsOnchainBranch, IPositionsOffchainBranch {
   /**
    * {@inheritDoc IPositionsBase.merge}
    **/
@@ -40,6 +42,10 @@ declare class PositionsNamespace extends AbstractNamespace<MultichainSDK["positi
    **/
   charts<const Metrics extends readonly PoolPositionChartMetric[]>(key: PoolPositionRef, metrics: Metrics, range: ChartRange): Promise<DataResponse<ChartBundle<Metrics>>>;
   charts<const Metrics extends readonly StrategyPositionChartMetric[]>(key: StrategyPositionRef, metrics: Metrics, range: ChartRange): Promise<DataResponse<ChartBundle<Metrics>>>;
+  /**
+   * {@inheritDoc IPositionsOnchainOnly.getCurrentWithdrawals}
+   **/
+  getCurrentWithdrawals(props: GetCurrentWithdrawalsProps<true>): Promise<DataResponse<PositionWithdrawals>>;
 }
 //#endregion
 export { PositionsNamespace };

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

@@ -1,8 +1,9 @@
 import { ChartBundle, ChartRange, PoolPositionChartMetric, StrategyPositionChartMetric } from "../../model/charts.js";
 import { PoolPositionRef, Position, PositionFilter, PositionsTotals, StrategyPositionRef } from "../../model/positions.js";
 import { DataResponse } from "../../model/response.js";
+import { PositionWithdrawals } from "../../model/withdrawals.js";
 import "../../model/index.js";
-import { IMultichainPositionsService } from "../../onchain/positions/types.js";
+import { GetCurrentWithdrawalsProps, IMultichainPositionsService } from "../../onchain/positions/types.js";
 import "../../onchain/index.js";
 import { IOffchainPositions } from "../../offchain/positions/types.js";
 import "../../offchain/index.js";
@@ -58,9 +59,16 @@ interface IPositionsOffchainOnly {
   charts<const Metrics extends readonly StrategyPositionChartMetric[]>(key: StrategyPositionRef, metrics: Metrics, range: ChartRange): Promise<DataResponse<ChartBundle<Metrics>>>;
 }
 /**
- * Reads only the chain can answer. Empty for now.
+ * Reads only the chain can answer.
  **/
-interface IPositionsOnchainOnly {}
+interface IPositionsOnchainOnly {
+  /**
+   * Delayed withdrawals of one credit account: claimable rows carry the
+   * adapter call and recorded intent a claim is built from; pending rows
+   * name when they mature. Absent in `offchain` mode.
+   **/
+  getCurrentWithdrawals(props: GetCurrentWithdrawalsProps<true>): Promise<DataResponse<PositionWithdrawals>>;
+}
 /**
  * The chain on its own, for a consumer that shows each source as it arrives.
  * Absent in `offchain` mode.

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

@@ -2,8 +2,8 @@ import { Bps } from "../../model/primitives.js";
 import { PoolOpportunityKey, StrategyOpportunityKey } from "../../model/opportunities.js";
 import { PositionCollateral, StrategyPosition, StrategyPositionKey } from "../../model/positions.js";
 import { DataResponse } from "../../model/response.js";
+import { PositionClaimableWithdrawal } from "../../model/withdrawals.js";
 import "../../model/index.js";
-import { ClaimableWithdrawal } from "../../onchain/accounts/withdrawal-compressor/types.js";
 import { Asset } from "../../onchain/base/types.js";
 import { MultiCall } from "../../onchain/types/transactions.js";
 import { PoolSimulation } from "../../onchain/pools/types.js";
@@ -326,13 +326,14 @@ interface LpRedeemParams {
 interface FinalizeParams extends PrepareOptions {
   /**
    * The matured withdrawal to claim, from
-   * `sdk.onchain.chain(chainId).withdrawalCompressor.getCurrentWithdrawals()`.
+   * `sdk.positions.getCurrentWithdrawals()`.
    **/
-  claimable: ClaimableWithdrawal;
+  claimable: PositionClaimableWithdrawal;
   /**
    * The operation to resume. Defaults to the one the request recorded in the
-   * withdrawal's `extraData`, which is what {@link ClaimableWithdrawal.intent}
-   * decodes; pass it explicitly when the compressor is too old to report it.
+   * withdrawal's `extraData`, which is what
+   * {@link PositionClaimableWithdrawal.intent} decodes; pass it explicitly
+   * when the compressor is too old to report it.
    **/
   intent?: ResumableIntent;
 }

package/package.json

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