@lifi/perps-sdk 28.1.0 → 29.1.0

package/src/types/deposit.ts

@@ -37,20 +37,21 @@ export interface DepositFlowLifiSwap {
 }
 
 /**
- * Fund an address that has no venue account yet. Collateral and the native gas
- * to broadcast with are both needed on `chainId`, where the venue's
- * {@link ActionType.DEPOSIT} action stages the on-chain legs that open the
- * account.
+ * Fund an address that has no venue account yet, or an existing account on a
+ * venue whose collateral no LI.FI route credits directly. Collateral and the
+ * native gas to broadcast with are both needed on `chainId`, where the venue's
+ * {@link ActionType.DEPOSIT} action stages the on-chain legs that credit the
+ * account and open it when none exists.
  *
  * @public
  */
-export interface DepositFlowFirstDepositPipeline {
-  kind: 'firstDepositPipeline'
+export interface DepositFlowVenueDepositPipeline {
+  kind: 'venueDepositPipeline'
   /** Chain on which the deposit legs broadcast; the wallet must be switched here. */
   chainId: number
   /** Native gas asset needed to broadcast the deposit legs. */
   gasAsset: DeclaredDepositAsset
-  /** Collateral asset credited by the first deposit. */
+  /** Collateral asset the venue deposit credits. */
   collateral: DeclaredDepositAsset
   /** Action type used to stage the deposit pipeline. */
   bridgeAction: ActionType.DEPOSIT
@@ -77,5 +78,5 @@ export interface DepositFlowSetupRequired {
  */
 export type DepositFlow =
   | DepositFlowLifiSwap
-  | DepositFlowFirstDepositPipeline
+  | DepositFlowVenueDepositPipeline
   | DepositFlowSetupRequired

package/src/types/provider.ts

@@ -11,6 +11,7 @@ import type {
   AvailableToTrade,
   DecimalString,
   FillsResponse,
+  MarginMode,
   Market,
   MarketRef,
   MarketSettings,
@@ -160,7 +161,8 @@ export interface ActionSignerContribution {
 }
 
 /**
- * Inputs for {@link PerpsProviderPlugin.estimateLiquidationPrice}:
+ * Inputs for {@link PerpsProviderPlugin.estimateLiquidationPrice}: the order
+ * and, when the order adds to one, the open position on the market.
  * `leverage` is the user-selected leverage for the new position, `isLong`
  * carries direction.
  *
@@ -172,6 +174,14 @@ export interface LiquidationEstimateParams {
   leverage: string
   /** `true` for long, `false` for short. */
   isLong: boolean
+  marginMode: MarginMode
+  /**
+   * Order size in base-asset units. The estimate reads it only with
+   * `position`, to blend the order into that position.
+   */
+  size?: DecimalString
+  /** Open position on the market that the order joins. */
+  position?: Position
 }
 
 /**
@@ -633,16 +643,20 @@ export interface PerpsProviderPlugin {
   }
 
   /**
-   * Estimate the liquidation price of a new isolated position on `market`
-   * using the venue's margin model. A preview helper — for existing
+   * Estimate the liquidation price of the position that the order leaves on
+   * `market` using the venue's margin model: a new position, or the blend of
+   * the order into `params.position`. A preview helper — for existing
    * positions, prefer `Position.liquidationPrice` from the venue. Pure —
    * does no I/O.
    *
    * @returns The estimated liquidation price, or `undefined` when `market`
-   *   lacks the margin metadata the model needs or `leverage` leaves no
-   *   margin above the maintenance requirement.
+   *   lacks the margin metadata the model needs, `leverage` leaves no
+   *   margin above the maintenance requirement, or the venue model cannot
+   *   give a correct price for the margin mode and position, such as a cross
+   *   position whose liquidation depends on the whole account.
    * @throws {PerpsError} `ValidationError` when an input does not match the
-   *   decimal pattern or is degenerate, such as a zero leverage.
+   *   decimal pattern or is degenerate, such as a zero leverage or a
+   *   `position` without a `size`.
    */
   estimateLiquidationPrice(
     market: PerpsMarket,

package/src/utils/depositAssets.ts

@@ -3,7 +3,7 @@ import { zeroAddress } from 'viem'
 import type { DeclaredDepositAsset } from '../types/deposit.js'
 
 /**
- * USDC on Ethereum mainnet — the collateral leg of Lighter's first-deposit
+ * USDC on Ethereum mainnet — the collateral leg of Lighter's venue-deposit
  * pipeline, and the token Ondo's provisioned deposit address is funded in.
  *
  * @public
@@ -15,7 +15,7 @@ export const ETHEREUM_USDC: DeclaredDepositAsset = {
 }
 
 /**
- * Ether on Ethereum mainnet, to broadcast the first-deposit pipeline's legs
+ * Ether on Ethereum mainnet, to broadcast the venue-deposit pipeline's legs
  * with.
  *
  * @public
@@ -65,7 +65,7 @@ export const ROBINHOOD_USDG: DeclaredDepositAsset = {
 }
 
 /**
- * Ether on Robinhood Chain, to broadcast the Robinhood first-deposit pipeline's
+ * Ether on Robinhood Chain, to broadcast the Robinhood venue-deposit pipeline's
  * legs with.
  *
  * @public

package/src/version.ts

@@ -10,4 +10,4 @@ export const name = '@lifi/perps-sdk'
  *
  * @public
  */
-export const version = '28.1.0'
+export const version = '29.1.0'