@lifi/perps-sdk 0.0.0-preview-e1b82a0 → 0.0.0-preview-bc9d3c9

package/src/math/position.ts

@@ -10,10 +10,12 @@
 
 import {
   MarginMode,
+  type PerpsMarket,
   type Position,
   PositionMarginAdjustment,
 } from '@lifi/perps-types'
 import { areFinite, DivBig } from '../decimal/big.js'
+import type { LiquidationEstimateParams } from '../types/provider.js'
 
 /**
  * Calculate notional value of a position.
@@ -179,6 +181,29 @@ export function estimateLiquidationPrice(params: {
     .toNumber()
 }
 
+/**
+ * Estimate the liquidation price of a new isolated position from the flat
+ * `market.maintenanceMarginRate`.
+ *
+ * @returns The estimate, or `undefined` when the market carries no
+ *   `maintenanceMarginRate` or `estimateLiquidationPrice` cannot produce one.
+ * @public
+ */
+export function estimateLiquidationPriceAtMarketRate(
+  market: PerpsMarket,
+  params: LiquidationEstimateParams
+): number | undefined {
+  if (market.maintenanceMarginRate === undefined) {
+    return undefined
+  }
+  return estimateLiquidationPrice({
+    entryPrice: params.entryPrice,
+    leverage: params.leverage,
+    isLong: params.isLong,
+    maintenanceMarginRate: market.maintenanceMarginRate,
+  })
+}
+
 /**
  * Whether an isolated position with this liquidation price is already past
  * liquidation at `currentPrice`: a long liquidates when the price falls to its

package/src/types/api.ts

@@ -293,16 +293,6 @@ export interface GetWithdrawableBalancesParams {
   address: Address
 }
 
-/**
- * Parameters for {@link PerpsClient.getWithdrawalTypes}.
- *
- * @public
- */
-export interface GetWithdrawalTypesParams {
-  provider: string
-  address: Address
-}
-
 /**
  * Parameters for {@link PerpsClient.getPortfolioHistory}.
  *

package/src/types/provider.ts

@@ -37,11 +37,7 @@ import type {
   SDKRequestOptions,
 } from './config.js'
 import type { DepositFlow } from './deposit.js'
-import type {
-  ProviderWithdrawableBalance,
-  WithdrawalSourceTypes,
-  WithdrawFlow,
-} from './withdrawal.js'
+import type { ProviderWithdrawableBalance, WithdrawFlow } from './withdrawal.js'
 
 /**
  * Low-level SDK client: resolved config, the optional end-user wallet, and the
@@ -203,15 +199,6 @@ export interface ProviderGetWithdrawableBalancesParams {
   address: Address
 }
 
-/**
- * Read params for {@link PerpsProviderPlugin.getWithdrawalTypes}.
- *
- * @public
- */
-export interface ProviderGetWithdrawalTypesParams {
-  address: Address
-}
-
 /**
  * Read params for {@link PerpsProvider.getPositions}.
  *
@@ -447,33 +434,20 @@ export interface PerpsProviderPlugin {
   ): Promise<WithdrawFlow>
 
   /**
-   * The `(asset, category)` pairs `params.address` currently has something to
+   * The `(asset, route)` pairs `params.address` currently has something to
    * withdraw from, keyed by provider-native asset id. Only the venue knows how
-   * its balance payload splits across categories, so the split is owned here; the
+   * its balance payload splits across routes, so the split is owned here; the
    * per-asset venue minimum is applied by `PerpsClient.getWithdrawableBalances`,
    * which holds the core asset registry.
    *
-   * Optional: a provider whose withdrawals are not a per-category selection
-   * omits it, and `PerpsClient.getWithdrawableBalances` then resolves
-   * `undefined`.
+   * Optional: a provider whose withdrawals are not a per-route selection omits
+   * it, and `PerpsClient.getWithdrawableBalances` then resolves `undefined`.
    */
   getWithdrawableBalances?(
     params: ProviderGetWithdrawableBalancesParams,
     options?: SDKRequestOptions
   ): Promise<ProviderWithdrawableBalance[]>
 
-  /**
-   * The withdrawal types `params.address` can choose per withdrawable holding,
-   * each with its cap and the `withdrawalOptions` to send with it.
-   *
-   * Optional: a provider with one withdrawal type omits it, and
-   * `PerpsClient.getWithdrawalTypes` then resolves `undefined`.
-   */
-  getWithdrawalTypes?(
-    params: ProviderGetWithdrawalTypesParams,
-    options?: SDKRequestOptions
-  ): Promise<WithdrawalSourceTypes[]>
-
   getPositions(
     params: ProviderGetPositionsParams,
     options?: SDKRequestOptions

package/src/types/withdrawal.ts

@@ -2,22 +2,22 @@ import type {
   ActionType,
   Asset,
   DecimalString,
-  WithdrawalAssetRef,
-  WithdrawalType,
+  WithdrawalRoute,
 } from '@lifi/perps-types'
 import type { Address } from 'viem'
 
+export type { WithdrawalRoute }
+
 /**
- * One withdrawable `(asset, category)` selection as the provider reports it,
- * keyed by provider-native asset id and awaiting the core asset-metadata join.
+ * One withdrawable `(asset, route)` selection as the provider reports it, keyed
+ * by provider-native asset id and awaiting the core asset-metadata join.
  *
  * @public
  */
 export interface ProviderWithdrawableBalance {
   /** Provider-native `Asset.id`; never a display symbol. */
   assetId: string
-  /** The provider category the row draws from; the same value as `Balance.categoryId`. */
-  categoryId: string
+  route: WithdrawalRoute
   /** Withdrawable amount in the asset's own units. Always greater than zero. */
   available: DecimalString
   /**
@@ -41,7 +41,7 @@ export interface ProviderWithdrawableBalance {
 }
 
 /**
- * One withdrawable `(asset, category)` selection a caller can act on: the amount
+ * One withdrawable `(asset, route)` selection a caller can act on: the amount
  * clears the asset's venue minimum, and `asset` carries the precision and
  * minimum needed to scale and validate the withdrawal.
  *
@@ -49,8 +49,7 @@ export interface ProviderWithdrawableBalance {
  */
 export interface WithdrawableBalance {
   asset: Asset
-  /** The provider category the row draws from; the same value as `Balance.categoryId`. */
-  categoryId: string
+  route: WithdrawalRoute
   /** Withdrawable amount in the asset's own units. */
   available: DecimalString
   /**
@@ -78,32 +77,6 @@ export interface WithdrawableBalance {
   isFeeDeducted?: boolean
 }
 
-/**
- * One way a venue can settle a withdrawal from a holding.
- *
- * @public
- */
-export interface WithdrawalTypeOption {
-  type: WithdrawalType
-  /** Largest `amount` this type accepts from the holding, in the asset's own units. */
-  max: DecimalString
-  /**
-   * Provider-specific options to pass unchanged as
-   * `WithdrawalParams.withdrawalOptions` when the user picks this type.
-   */
-  withdrawalOptions: Record<string, unknown>
-}
-
-/**
- * The withdrawal types a venue offers for one holding.
- *
- * @public
- */
-export interface WithdrawalSourceTypes {
-  source: WithdrawalAssetRef
-  options: WithdrawalTypeOption[]
-}
-
 /**
  * The venue accepts a withdrawal to `destination` now.
  *

package/src/version.ts

@@ -10,4 +10,4 @@ export const name = '@lifi/perps-sdk'
  *
  * @public
  */
-export const version = '0.0.0-preview-e1b82a0'
+export const version = '0.0.0-preview-bc9d3c9'