@lifi/perps-sdk 6.3.0 → 6.5.0

package/src/types/api.ts

@@ -1,6 +1,8 @@
 import type {
   AccountConfigSetting,
   AccountResponse,
+  CancelTwapOrderParams as ActionCancelTwapOrderParams,
+  PlaceTwapOrderParams as ActionPlaceTwapOrderParams,
   ActionStep,
   ExecuteActionResponse,
   MarginMode,
@@ -126,7 +128,7 @@ export interface PlaceOrderParams {
   /** Opaque provider market reference. */
   market: MarketRef
   side: OrderSide
-  type: OrderType
+  type: Exclude<OrderType, OrderType.TWAP>
   /** Base-asset size as a decimal wire string. */
   size: string
   /** Limit price as a decimal wire string; required by limit-style orders. */
@@ -165,6 +167,26 @@ export interface PlaceTriggerOrderParams {
   stopLoss?: TriggerOrderInput
 }
 
+/**
+ * Client parameters for placing a TWAP order.
+ *
+ * @public
+ */
+export interface PlaceTwapOrderParams extends ActionPlaceTwapOrderParams {
+  provider: string
+  address: Address
+}
+
+/**
+ * Client parameters for cancelling a running TWAP order.
+ *
+ * @public
+ */
+export interface CancelTwapOrderParams extends ActionCancelTwapOrderParams {
+  provider: string
+  address: Address
+}
+
 /**
  * Parameters for withdrawing funds.
  *

package/src/types/provider.ts

@@ -25,6 +25,7 @@ import type {
   SignedActionStep,
   SigningMethod,
   TradeType,
+  TwapOrder,
 } from '@lifi/perps-types'
 import type { Address } from 'viem'
 import type {
@@ -228,6 +229,17 @@ export interface ProviderGetOrdersParams {
   cursor?: string
 }
 
+/**
+ * Read params for {@link PerpsProvider.getRunningTwaps}.
+ *
+ * @public
+ */
+export interface ProviderGetRunningTwapsParams {
+  address: Address
+  /** Optional opaque `Market.id` filter (not a display symbol). */
+  marketId?: string
+}
+
 /**
  * Read params for {@link PerpsProvider.getOrder}.
  *
@@ -424,6 +436,15 @@ export interface PerpsProviderPlugin {
     options?: SDKRequestOptions
   ): Promise<OrdersResponse>
 
+  /**
+   * Fetch the account's currently running TWAP parent orders directly from the
+   * venue. Child slice orders are excluded.
+   */
+  getRunningTwaps?(
+    params: ProviderGetRunningTwapsParams,
+    options?: SDKRequestOptions
+  ): Promise<TwapOrder[]>
+
   getOrder(
     params: ProviderGetOrderParams,
     options?: SDKRequestOptions

package/src/version.ts

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