@lifi/perps-sdk 18.0.0 → 18.1.0

package/src/index.ts

@@ -118,6 +118,7 @@ export type {
   GetPortfolioHistoryParams,
   GetSetupParams,
   GetWithdrawableBalancesParams,
+  GetWithdrawFlowParams,
   ModifyOrdersParams,
   PerpsClientOptions,
   PerpsConfig,
@@ -166,6 +167,7 @@ export type {
   ProviderGetPositionsParams,
   ProviderGetQuoteParams,
   ProviderGetWithdrawableBalancesParams,
+  ProviderGetWithdrawFlowParams,
   QuoteListener,
   SignActionProgress,
   SignActionsContext,
@@ -174,6 +176,9 @@ export type {
   ProviderWithdrawableBalance,
   WithdrawableBalance,
   WithdrawalRoute,
+  WithdrawFlow,
+  WithdrawFlowReady,
+  WithdrawFlowSetupRequired,
 } from './types/withdrawal.js'
 export { paginateActivity } from './utils/activityPaging.js'
 export type { ExpectedPnl } from './utils/calculations.js'

package/src/types/api.ts

@@ -289,6 +289,16 @@ export interface GetDepositFlowParams {
   address: Address
 }
 
+/**
+ * Parameters for {@link PerpsClient.getWithdrawFlow}.
+ *
+ * @public
+ */
+export interface GetWithdrawFlowParams {
+  provider: string
+  address: Address
+}
+
 /**
  * Parameters for {@link PerpsClient.getWithdrawableBalances}.
  *

package/src/types/provider.ts

@@ -36,7 +36,7 @@ import type {
   SDKRequestOptions,
 } from './config.js'
 import type { DepositFlow } from './deposit.js'
-import type { ProviderWithdrawableBalance } from './withdrawal.js'
+import type { ProviderWithdrawableBalance, WithdrawFlow } from './withdrawal.js'
 
 /**
  * Low-level SDK client: resolved config, the optional end-user wallet, and the
@@ -180,6 +180,15 @@ export interface ProviderGetDepositFlowParams {
   address: Address
 }
 
+/**
+ * Read params for {@link PerpsProviderPlugin.getWithdrawFlow}.
+ *
+ * @public
+ */
+export interface ProviderGetWithdrawFlowParams {
+  address: Address
+}
+
 /**
  * Read params for {@link PerpsProviderPlugin.getWithdrawableBalances}.
  *
@@ -421,6 +430,19 @@ export interface PerpsProviderPlugin {
     options?: SDKRequestOptions
   ): Promise<DepositFlow>
 
+  /**
+   * The withdrawal flow this venue offers `params.address`, resolved from the
+   * venue's own account and setup state — the destination a withdrawal goes
+   * to, or the venue setup that must come first.
+   *
+   * Optional: a provider without a gated withdrawal destination omits it, and
+   * `PerpsClient.getWithdrawFlow` then resolves `undefined`.
+   */
+  getWithdrawFlow?(
+    params: ProviderGetWithdrawFlowParams,
+    options?: SDKRequestOptions
+  ): Promise<WithdrawFlow>
+
   /**
    * The `(asset, route)` pairs `params.address` currently has something to
    * withdraw from, keyed by provider-native asset id. Only the venue knows how

package/src/types/withdrawal.ts

@@ -1,4 +1,5 @@
-import type { Asset } from '@lifi/perps-types'
+import type { ActionType, Asset } from '@lifi/perps-types'
+import type { Address } from 'viem'
 
 /**
  * Which of a venue's two balance routes a withdrawal is drawn from. Lighter's
@@ -49,3 +50,34 @@ export interface WithdrawableBalance {
    */
   withdrawalFee?: string
 }
+
+/**
+ * The venue accepts a withdrawal to `destination` now.
+ *
+ * @public
+ */
+export interface WithdrawFlowReady {
+  kind: 'ready'
+  destination: Address
+}
+
+/**
+ * The venue cannot accept a withdrawal until the listed setup actions are
+ * satisfied — Ondo sends funds only to an address in its address book, behind
+ * a signed-in session.
+ *
+ * @public
+ */
+export interface WithdrawFlowSetupRequired {
+  kind: 'setupRequired'
+  /** Setup action types that must be completed, in execution order. */
+  setup: ActionType[]
+}
+
+/**
+ * The single withdrawal flow a venue offers one address, resolved from the
+ * venue's account and setup state.
+ *
+ * @public
+ */
+export type WithdrawFlow = WithdrawFlowReady | WithdrawFlowSetupRequired

package/src/version.ts

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