@lifi/perps-sdk 6.4.0 → 6.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (42) hide show
  1. package/README.md +26 -0
  2. package/dist/cjs/client/PerpsClient.d.ts +3 -1
  3. package/dist/cjs/client/PerpsClient.d.ts.map +1 -1
  4. package/dist/cjs/client/PerpsClient.js +16 -2
  5. package/dist/cjs/client/PerpsClient.js.map +1 -1
  6. package/dist/cjs/index.d.ts +2 -2
  7. package/dist/cjs/index.d.ts.map +1 -1
  8. package/dist/cjs/index.js.map +1 -1
  9. package/dist/cjs/types/api.d.ts +9 -1
  10. package/dist/cjs/types/api.d.ts.map +1 -1
  11. package/dist/cjs/types/provider.d.ts +6 -1
  12. package/dist/cjs/types/provider.d.ts.map +1 -1
  13. package/dist/cjs/version.d.ts +1 -1
  14. package/dist/cjs/version.js +1 -1
  15. package/dist/esm/client/PerpsClient.d.ts +18 -5
  16. package/dist/esm/client/PerpsClient.d.ts.map +1 -1
  17. package/dist/esm/client/PerpsClient.js +31 -6
  18. package/dist/esm/client/PerpsClient.js.map +1 -1
  19. package/dist/esm/index.d.ts +2 -2
  20. package/dist/esm/index.d.ts.map +1 -1
  21. package/dist/esm/index.js.map +1 -1
  22. package/dist/esm/types/api.d.ts +19 -1
  23. package/dist/esm/types/api.d.ts.map +1 -1
  24. package/dist/esm/types/provider.d.ts +16 -1
  25. package/dist/esm/types/provider.d.ts.map +1 -1
  26. package/dist/esm/version.d.ts +1 -1
  27. package/dist/esm/version.js +1 -1
  28. package/dist/types/client/PerpsClient.d.ts +18 -5
  29. package/dist/types/client/PerpsClient.d.ts.map +1 -1
  30. package/dist/types/index.d.ts +2 -2
  31. package/dist/types/index.d.ts.map +1 -1
  32. package/dist/types/types/api.d.ts +19 -1
  33. package/dist/types/types/api.d.ts.map +1 -1
  34. package/dist/types/types/provider.d.ts +16 -1
  35. package/dist/types/types/provider.d.ts.map +1 -1
  36. package/dist/types/version.d.ts +1 -1
  37. package/package.json +2 -2
  38. package/src/client/PerpsClient.ts +45 -6
  39. package/src/index.ts +3 -0
  40. package/src/types/api.ts +22 -0
  41. package/src/types/provider.ts +21 -0
  42. package/src/version.ts +1 -1
@@ -25,6 +25,7 @@ import type {
25
25
  SignedActionStep,
26
26
  SigningMethod,
27
27
  TradeType,
28
+ TwapOrder,
28
29
  } from '@lifi/perps-types'
29
30
  import type { Address } from 'viem'
30
31
  import type {
@@ -228,6 +229,17 @@ export interface ProviderGetOrdersParams {
228
229
  cursor?: string
229
230
  }
230
231
 
232
+ /**
233
+ * Read params for {@link PerpsProvider.getRunningTwaps}.
234
+ *
235
+ * @public
236
+ */
237
+ export interface ProviderGetRunningTwapsParams {
238
+ address: Address
239
+ /** Optional opaque `Market.id` filter (not a display symbol). */
240
+ marketId?: string
241
+ }
242
+
231
243
  /**
232
244
  * Read params for {@link PerpsProvider.getOrder}.
233
245
  *
@@ -424,6 +436,15 @@ export interface PerpsProviderPlugin {
424
436
  options?: SDKRequestOptions
425
437
  ): Promise<OrdersResponse>
426
438
 
439
+ /**
440
+ * Fetch the account's currently running TWAP parent orders directly from the
441
+ * venue. Child slice orders are excluded.
442
+ */
443
+ getRunningTwaps?(
444
+ params: ProviderGetRunningTwapsParams,
445
+ options?: SDKRequestOptions
446
+ ): Promise<TwapOrder[]>
447
+
427
448
  getOrder(
428
449
  params: ProviderGetOrderParams,
429
450
  options?: SDKRequestOptions
package/src/version.ts CHANGED
@@ -10,4 +10,4 @@ export const name = '@lifi/perps-sdk'
10
10
  *
11
11
  * @public
12
12
  */
13
- export const version = '6.4.0'
13
+ export const version = '6.5.0'