@lifi/perps-sdk 5.0.0 → 6.1.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 (281) hide show
  1. package/dist/cjs/client/PerpsClient.d.ts +7 -1
  2. package/dist/cjs/client/PerpsClient.d.ts.map +1 -1
  3. package/dist/cjs/client/PerpsClient.js +10 -0
  4. package/dist/cjs/client/PerpsClient.js.map +1 -1
  5. package/dist/cjs/errors/PerpsError.d.ts.map +1 -1
  6. package/dist/cjs/errors/PerpsError.js.map +1 -1
  7. package/dist/cjs/index.d.ts +5 -3
  8. package/dist/cjs/index.d.ts.map +1 -1
  9. package/dist/cjs/index.js +6 -4
  10. package/dist/cjs/index.js.map +1 -1
  11. package/dist/cjs/registry/assetRegistry.d.ts.map +1 -1
  12. package/dist/cjs/registry/assetRegistry.js.map +1 -1
  13. package/dist/cjs/registry/marketRegistry.d.ts +2 -1
  14. package/dist/cjs/registry/marketRegistry.d.ts.map +1 -1
  15. package/dist/cjs/registry/marketRegistry.js +24 -1
  16. package/dist/cjs/registry/marketRegistry.js.map +1 -1
  17. package/dist/cjs/services/createAction.d.ts.map +1 -1
  18. package/dist/cjs/services/createAction.js.map +1 -1
  19. package/dist/cjs/services/executeAction.d.ts.map +1 -1
  20. package/dist/cjs/services/executeAction.js.map +1 -1
  21. package/dist/cjs/services/getActivity.d.ts.map +1 -1
  22. package/dist/cjs/services/getActivity.js.map +1 -1
  23. package/dist/cjs/services/getFills.d.ts.map +1 -1
  24. package/dist/cjs/services/getFills.js.map +1 -1
  25. package/dist/cjs/services/getOhlcv.d.ts.map +1 -1
  26. package/dist/cjs/services/getOhlcv.js.map +1 -1
  27. package/dist/cjs/services/getOrder.d.ts.map +1 -1
  28. package/dist/cjs/services/getOrder.js.map +1 -1
  29. package/dist/cjs/services/getOrders.d.ts.map +1 -1
  30. package/dist/cjs/services/getOrders.js.map +1 -1
  31. package/dist/cjs/services/getPositions.d.ts.map +1 -1
  32. package/dist/cjs/services/getPositions.js.map +1 -1
  33. package/dist/cjs/services/getQuote.d.ts.map +1 -1
  34. package/dist/cjs/services/getQuote.js.map +1 -1
  35. package/dist/cjs/storage/parseStoredRecord.d.ts.map +1 -1
  36. package/dist/cjs/storage/parseStoredRecord.js.map +1 -1
  37. package/dist/cjs/storage/types.d.ts.map +1 -1
  38. package/dist/cjs/transport/fetchWithRetry.d.ts.map +1 -1
  39. package/dist/cjs/transport/fetchWithRetry.js.map +1 -1
  40. package/dist/cjs/transport/retryPolicy.d.ts.map +1 -1
  41. package/dist/cjs/transport/retryPolicy.js.map +1 -1
  42. package/dist/cjs/types/api.d.ts +2 -1
  43. package/dist/cjs/types/api.d.ts.map +1 -1
  44. package/dist/cjs/types/config.d.ts.map +1 -1
  45. package/dist/cjs/types/deposit.d.ts.map +1 -1
  46. package/dist/cjs/types/provider.d.ts +7 -1
  47. package/dist/cjs/types/provider.d.ts.map +1 -1
  48. package/dist/cjs/utils/calculations.d.ts +0 -5
  49. package/dist/cjs/utils/calculations.d.ts.map +1 -1
  50. package/dist/cjs/utils/calculations.js +0 -9
  51. package/dist/cjs/utils/calculations.js.map +1 -1
  52. package/dist/cjs/utils/format.d.ts.map +1 -1
  53. package/dist/cjs/utils/format.js.map +1 -1
  54. package/dist/cjs/utils/orderClassification.d.ts.map +1 -1
  55. package/dist/cjs/utils/orderClassification.js.map +1 -1
  56. package/dist/cjs/utils/transferMargin.d.ts +7 -0
  57. package/dist/cjs/utils/transferMargin.d.ts.map +1 -0
  58. package/dist/cjs/utils/transferMargin.js +50 -0
  59. package/dist/cjs/utils/transferMargin.js.map +1 -0
  60. package/dist/cjs/version.d.ts +1 -1
  61. package/dist/cjs/version.js +1 -1
  62. package/dist/cjs/websocket/PerpsWsClient.d.ts.map +1 -1
  63. package/dist/cjs/websocket/PerpsWsClient.js.map +1 -1
  64. package/dist/cjs/websocket/ReconnectingWebSocket.d.ts.map +1 -1
  65. package/dist/cjs/websocket/ReconnectingWebSocket.js.map +1 -1
  66. package/dist/cjs/websocket/WsProviderBase.d.ts.map +1 -1
  67. package/dist/cjs/websocket/WsProviderBase.js.map +1 -1
  68. package/dist/cjs/websocket/cachePromise.d.ts.map +1 -1
  69. package/dist/cjs/websocket/cachePromise.js.map +1 -1
  70. package/dist/cjs/websocket/types.d.ts.map +1 -1
  71. package/dist/esm/client/PerpsClient.d.ts +24 -1
  72. package/dist/esm/client/PerpsClient.d.ts.map +1 -1
  73. package/dist/esm/client/PerpsClient.js +27 -0
  74. package/dist/esm/client/PerpsClient.js.map +1 -1
  75. package/dist/esm/errors/PerpsError.d.ts +7 -0
  76. package/dist/esm/errors/PerpsError.d.ts.map +1 -1
  77. package/dist/esm/errors/PerpsError.js +7 -0
  78. package/dist/esm/errors/PerpsError.js.map +1 -1
  79. package/dist/esm/index.d.ts +5 -3
  80. package/dist/esm/index.d.ts.map +1 -1
  81. package/dist/esm/index.js +3 -2
  82. package/dist/esm/index.js.map +1 -1
  83. package/dist/esm/registry/assetRegistry.d.ts +5 -1
  84. package/dist/esm/registry/assetRegistry.d.ts.map +1 -1
  85. package/dist/esm/registry/assetRegistry.js +5 -1
  86. package/dist/esm/registry/assetRegistry.js.map +1 -1
  87. package/dist/esm/registry/marketRegistry.d.ts +28 -6
  88. package/dist/esm/registry/marketRegistry.d.ts.map +1 -1
  89. package/dist/esm/registry/marketRegistry.js +49 -6
  90. package/dist/esm/registry/marketRegistry.js.map +1 -1
  91. package/dist/esm/services/createAction.d.ts +2 -0
  92. package/dist/esm/services/createAction.d.ts.map +1 -1
  93. package/dist/esm/services/createAction.js.map +1 -1
  94. package/dist/esm/services/executeAction.d.ts +2 -0
  95. package/dist/esm/services/executeAction.d.ts.map +1 -1
  96. package/dist/esm/services/executeAction.js.map +1 -1
  97. package/dist/esm/services/getActivity.d.ts +4 -2
  98. package/dist/esm/services/getActivity.d.ts.map +1 -1
  99. package/dist/esm/services/getActivity.js.map +1 -1
  100. package/dist/esm/services/getFills.d.ts +4 -2
  101. package/dist/esm/services/getFills.d.ts.map +1 -1
  102. package/dist/esm/services/getFills.js.map +1 -1
  103. package/dist/esm/services/getMarkets.d.ts +1 -1
  104. package/dist/esm/services/getMarkets.d.ts.map +1 -1
  105. package/dist/esm/services/getMarketsContext.d.ts +1 -1
  106. package/dist/esm/services/getMarketsContext.d.ts.map +1 -1
  107. package/dist/esm/services/getOhlcv.d.ts +4 -3
  108. package/dist/esm/services/getOhlcv.d.ts.map +1 -1
  109. package/dist/esm/services/getOhlcv.js.map +1 -1
  110. package/dist/esm/services/getOrder.d.ts +1 -0
  111. package/dist/esm/services/getOrder.d.ts.map +1 -1
  112. package/dist/esm/services/getOrder.js.map +1 -1
  113. package/dist/esm/services/getOrderbook.d.ts +2 -2
  114. package/dist/esm/services/getOrderbook.d.ts.map +1 -1
  115. package/dist/esm/services/getOrders.d.ts +3 -1
  116. package/dist/esm/services/getOrders.d.ts.map +1 -1
  117. package/dist/esm/services/getOrders.js.map +1 -1
  118. package/dist/esm/services/getPositions.d.ts +3 -1
  119. package/dist/esm/services/getPositions.d.ts.map +1 -1
  120. package/dist/esm/services/getPositions.js.map +1 -1
  121. package/dist/esm/services/getQuote.d.ts +3 -1
  122. package/dist/esm/services/getQuote.d.ts.map +1 -1
  123. package/dist/esm/services/getQuote.js.map +1 -1
  124. package/dist/esm/storage/parseStoredRecord.d.ts +4 -0
  125. package/dist/esm/storage/parseStoredRecord.d.ts.map +1 -1
  126. package/dist/esm/storage/parseStoredRecord.js +4 -0
  127. package/dist/esm/storage/parseStoredRecord.js.map +1 -1
  128. package/dist/esm/storage/types.d.ts +10 -6
  129. package/dist/esm/storage/types.d.ts.map +1 -1
  130. package/dist/esm/transport/fetchWithRetry.d.ts +3 -0
  131. package/dist/esm/transport/fetchWithRetry.d.ts.map +1 -1
  132. package/dist/esm/transport/fetchWithRetry.js.map +1 -1
  133. package/dist/esm/transport/retryPolicy.d.ts +20 -0
  134. package/dist/esm/transport/retryPolicy.d.ts.map +1 -1
  135. package/dist/esm/transport/retryPolicy.js.map +1 -1
  136. package/dist/esm/types/api.d.ts +31 -10
  137. package/dist/esm/types/api.d.ts.map +1 -1
  138. package/dist/esm/types/config.d.ts +10 -0
  139. package/dist/esm/types/config.d.ts.map +1 -1
  140. package/dist/esm/types/deposit.d.ts +9 -3
  141. package/dist/esm/types/deposit.d.ts.map +1 -1
  142. package/dist/esm/types/provider.d.ts +63 -18
  143. package/dist/esm/types/provider.d.ts.map +1 -1
  144. package/dist/esm/utils/calculations.d.ts +2 -20
  145. package/dist/esm/utils/calculations.d.ts.map +1 -1
  146. package/dist/esm/utils/calculations.js +0 -23
  147. package/dist/esm/utils/calculations.js.map +1 -1
  148. package/dist/esm/utils/format.d.ts +5 -1
  149. package/dist/esm/utils/format.d.ts.map +1 -1
  150. package/dist/esm/utils/format.js.map +1 -1
  151. package/dist/esm/utils/orderClassification.d.ts +5 -0
  152. package/dist/esm/utils/orderClassification.d.ts.map +1 -1
  153. package/dist/esm/utils/orderClassification.js +5 -0
  154. package/dist/esm/utils/orderClassification.js.map +1 -1
  155. package/dist/esm/utils/transferMargin.d.ts +24 -0
  156. package/dist/esm/utils/transferMargin.d.ts.map +1 -0
  157. package/dist/esm/utils/transferMargin.js +56 -0
  158. package/dist/esm/utils/transferMargin.js.map +1 -0
  159. package/dist/esm/version.d.ts +1 -1
  160. package/dist/esm/version.js +1 -1
  161. package/dist/esm/websocket/PerpsWsClient.d.ts +0 -1
  162. package/dist/esm/websocket/PerpsWsClient.d.ts.map +1 -1
  163. package/dist/esm/websocket/PerpsWsClient.js.map +1 -1
  164. package/dist/esm/websocket/ReconnectingWebSocket.d.ts +5 -3
  165. package/dist/esm/websocket/ReconnectingWebSocket.d.ts.map +1 -1
  166. package/dist/esm/websocket/ReconnectingWebSocket.js.map +1 -1
  167. package/dist/esm/websocket/WsProviderBase.d.ts +17 -0
  168. package/dist/esm/websocket/WsProviderBase.d.ts.map +1 -1
  169. package/dist/esm/websocket/WsProviderBase.js +17 -0
  170. package/dist/esm/websocket/WsProviderBase.js.map +1 -1
  171. package/dist/esm/websocket/cachePromise.d.ts +2 -0
  172. package/dist/esm/websocket/cachePromise.d.ts.map +1 -1
  173. package/dist/esm/websocket/cachePromise.js +2 -0
  174. package/dist/esm/websocket/cachePromise.js.map +1 -1
  175. package/dist/esm/websocket/types.d.ts +5 -0
  176. package/dist/esm/websocket/types.d.ts.map +1 -1
  177. package/dist/types/client/PerpsClient.d.ts +24 -1
  178. package/dist/types/client/PerpsClient.d.ts.map +1 -1
  179. package/dist/types/errors/PerpsError.d.ts +7 -0
  180. package/dist/types/errors/PerpsError.d.ts.map +1 -1
  181. package/dist/types/index.d.ts +5 -3
  182. package/dist/types/index.d.ts.map +1 -1
  183. package/dist/types/registry/assetRegistry.d.ts +5 -1
  184. package/dist/types/registry/assetRegistry.d.ts.map +1 -1
  185. package/dist/types/registry/marketRegistry.d.ts +28 -6
  186. package/dist/types/registry/marketRegistry.d.ts.map +1 -1
  187. package/dist/types/services/createAction.d.ts +2 -0
  188. package/dist/types/services/createAction.d.ts.map +1 -1
  189. package/dist/types/services/executeAction.d.ts +2 -0
  190. package/dist/types/services/executeAction.d.ts.map +1 -1
  191. package/dist/types/services/getActivity.d.ts +4 -2
  192. package/dist/types/services/getActivity.d.ts.map +1 -1
  193. package/dist/types/services/getFills.d.ts +4 -2
  194. package/dist/types/services/getFills.d.ts.map +1 -1
  195. package/dist/types/services/getMarkets.d.ts +1 -1
  196. package/dist/types/services/getMarkets.d.ts.map +1 -1
  197. package/dist/types/services/getMarketsContext.d.ts +1 -1
  198. package/dist/types/services/getMarketsContext.d.ts.map +1 -1
  199. package/dist/types/services/getOhlcv.d.ts +4 -3
  200. package/dist/types/services/getOhlcv.d.ts.map +1 -1
  201. package/dist/types/services/getOrder.d.ts +1 -0
  202. package/dist/types/services/getOrder.d.ts.map +1 -1
  203. package/dist/types/services/getOrderbook.d.ts +2 -2
  204. package/dist/types/services/getOrderbook.d.ts.map +1 -1
  205. package/dist/types/services/getOrders.d.ts +3 -1
  206. package/dist/types/services/getOrders.d.ts.map +1 -1
  207. package/dist/types/services/getPositions.d.ts +3 -1
  208. package/dist/types/services/getPositions.d.ts.map +1 -1
  209. package/dist/types/services/getQuote.d.ts +3 -1
  210. package/dist/types/services/getQuote.d.ts.map +1 -1
  211. package/dist/types/storage/parseStoredRecord.d.ts +4 -0
  212. package/dist/types/storage/parseStoredRecord.d.ts.map +1 -1
  213. package/dist/types/storage/types.d.ts +10 -6
  214. package/dist/types/storage/types.d.ts.map +1 -1
  215. package/dist/types/transport/fetchWithRetry.d.ts +3 -0
  216. package/dist/types/transport/fetchWithRetry.d.ts.map +1 -1
  217. package/dist/types/transport/retryPolicy.d.ts +20 -0
  218. package/dist/types/transport/retryPolicy.d.ts.map +1 -1
  219. package/dist/types/types/api.d.ts +31 -10
  220. package/dist/types/types/api.d.ts.map +1 -1
  221. package/dist/types/types/config.d.ts +10 -0
  222. package/dist/types/types/config.d.ts.map +1 -1
  223. package/dist/types/types/deposit.d.ts +9 -3
  224. package/dist/types/types/deposit.d.ts.map +1 -1
  225. package/dist/types/types/provider.d.ts +63 -18
  226. package/dist/types/types/provider.d.ts.map +1 -1
  227. package/dist/types/utils/calculations.d.ts +2 -20
  228. package/dist/types/utils/calculations.d.ts.map +1 -1
  229. package/dist/types/utils/format.d.ts +5 -1
  230. package/dist/types/utils/format.d.ts.map +1 -1
  231. package/dist/types/utils/orderClassification.d.ts +5 -0
  232. package/dist/types/utils/orderClassification.d.ts.map +1 -1
  233. package/dist/types/utils/transferMargin.d.ts +24 -0
  234. package/dist/types/utils/transferMargin.d.ts.map +1 -0
  235. package/dist/types/version.d.ts +1 -1
  236. package/dist/types/websocket/PerpsWsClient.d.ts +0 -1
  237. package/dist/types/websocket/PerpsWsClient.d.ts.map +1 -1
  238. package/dist/types/websocket/ReconnectingWebSocket.d.ts +5 -3
  239. package/dist/types/websocket/ReconnectingWebSocket.d.ts.map +1 -1
  240. package/dist/types/websocket/WsProviderBase.d.ts +17 -0
  241. package/dist/types/websocket/WsProviderBase.d.ts.map +1 -1
  242. package/dist/types/websocket/cachePromise.d.ts +2 -0
  243. package/dist/types/websocket/cachePromise.d.ts.map +1 -1
  244. package/dist/types/websocket/types.d.ts +5 -0
  245. package/dist/types/websocket/types.d.ts.map +1 -1
  246. package/package.json +2 -2
  247. package/src/client/PerpsClient.ts +39 -0
  248. package/src/errors/PerpsError.ts +7 -0
  249. package/src/index.ts +4 -1
  250. package/src/registry/assetRegistry.ts +5 -1
  251. package/src/registry/marketRegistry.ts +64 -7
  252. package/src/services/createAction.ts +2 -0
  253. package/src/services/executeAction.ts +2 -0
  254. package/src/services/getActivity.ts +4 -2
  255. package/src/services/getFills.ts +4 -2
  256. package/src/services/getMarkets.ts +1 -1
  257. package/src/services/getMarketsContext.ts +1 -1
  258. package/src/services/getOhlcv.ts +4 -3
  259. package/src/services/getOrder.ts +1 -0
  260. package/src/services/getOrderbook.ts +2 -2
  261. package/src/services/getOrders.ts +3 -1
  262. package/src/services/getPositions.ts +3 -1
  263. package/src/services/getQuote.ts +3 -1
  264. package/src/storage/parseStoredRecord.ts +4 -0
  265. package/src/storage/types.ts +10 -6
  266. package/src/transport/fetchWithRetry.ts +3 -0
  267. package/src/transport/retryPolicy.ts +20 -0
  268. package/src/types/api.ts +31 -9
  269. package/src/types/config.ts +10 -0
  270. package/src/types/deposit.ts +9 -3
  271. package/src/types/provider.ts +73 -17
  272. package/src/utils/calculations.ts +2 -28
  273. package/src/utils/format.ts +5 -1
  274. package/src/utils/orderClassification.ts +5 -0
  275. package/src/utils/transferMargin.ts +98 -0
  276. package/src/version.ts +1 -1
  277. package/src/websocket/PerpsWsClient.ts +0 -1
  278. package/src/websocket/ReconnectingWebSocket.ts +5 -3
  279. package/src/websocket/WsProviderBase.ts +17 -0
  280. package/src/websocket/cachePromise.ts +2 -0
  281. package/src/websocket/types.ts +5 -0
@@ -1 +1 @@
1
- {"version":3,"file":"getMarketsContext.d.ts","sourceRoot":"","sources":["../../../src/services/getMarketsContext.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAA;AAEvD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAA;AAC3D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAE1D;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACtC,QAAQ,EAAE,MAAM,CAAA;IAChB,mEAAmE;IACnE,SAAS,CAAC,EAAE,MAAM,EAAE,CAAA;CACrB;AAED;;;;;;GAMG;AACH,wBAAsB,iBAAiB,CACrC,MAAM,EAAE,cAAc,EACtB,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,cAAc,CAAC,CAMzB"}
1
+ {"version":3,"file":"getMarketsContext.d.ts","sourceRoot":"","sources":["../../../src/services/getMarketsContext.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAA;AAEvD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAA;AAC3D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAE1D;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACtC,QAAQ,EAAE,MAAM,CAAA;IAChB,oEAAoE;IACpE,SAAS,CAAC,EAAE,MAAM,EAAE,CAAA;CACrB;AAED;;;;;;GAMG;AACH,wBAAsB,iBAAiB,CACrC,MAAM,EAAE,cAAc,EACtB,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,cAAc,CAAC,CAMzB"}
@@ -8,13 +8,14 @@ import type { PerpsSDKClient } from '../types/provider.js';
8
8
  */
9
9
  export interface GetOhlcvParams {
10
10
  provider: string;
11
- /** Opaque provider `Market.id` (not `displaySymbol`). */
11
+ /** Opaque provider `Market.id`, not a display symbol. */
12
12
  marketId: string;
13
13
  interval: OhlcvInterval;
14
- /** Unix timestamp in milliseconds */
14
+ /** Unix timestamp in milliseconds for the start bound. */
15
15
  startTime?: number;
16
- /** Unix timestamp in milliseconds */
16
+ /** Unix timestamp in milliseconds for the end bound. */
17
17
  endTime?: number;
18
+ /** Maximum candles returned; provider defaults and caps apply. */
18
19
  limit?: number;
19
20
  }
20
21
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"getOhlcv.d.ts","sourceRoot":"","sources":["../../../src/services/getOhlcv.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAA;AAErE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAA;AAC3D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAE1D;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B,QAAQ,EAAE,MAAM,CAAA;IAChB,yDAAyD;IACzD,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,aAAa,CAAA;IACvB,qCAAqC;IACrC,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,qCAAqC;IACrC,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,QAAQ,CAC5B,MAAM,EAAE,cAAc,EACtB,MAAM,EAAE,cAAc,EACtB,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,aAAa,CAAC,CAUxB"}
1
+ {"version":3,"file":"getOhlcv.d.ts","sourceRoot":"","sources":["../../../src/services/getOhlcv.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAA;AAErE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAA;AAC3D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAE1D;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B,QAAQ,EAAE,MAAM,CAAA;IAChB,yDAAyD;IACzD,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,aAAa,CAAA;IACvB,0DAA0D;IAC1D,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,wDAAwD;IACxD,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,kEAAkE;IAClE,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,QAAQ,CAC5B,MAAM,EAAE,cAAc,EACtB,MAAM,EAAE,cAAc,EACtB,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,aAAa,CAAC,CAUxB"}
@@ -1 +1 @@
1
- {"version":3,"file":"getOhlcv.js","sourceRoot":"","sources":["../../../src/services/getOhlcv.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,yBAAyB,CAAA;AAqB3D;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,KAAK,UAAU,QAAQ,CAC5B,MAAsB,EACtB,MAAsB,EACtB,OAA2B;IAE3B,MAAM,GAAG,GAAG,QAAQ,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,QAAQ,EAAE;QACpD,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,SAAS,EAAE,MAAM,CAAC,SAAS;QAC3B,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,KAAK,EAAE,MAAM,CAAC,KAAK;KACpB,CAAC,CAAA;IACF,OAAO,OAAO,CAAgB,MAAM,CAAC,MAAM,EAAE,GAAG,EAAE,EAAE,EAAE,OAAO,CAAC,CAAA;AAChE,CAAC"}
1
+ {"version":3,"file":"getOhlcv.js","sourceRoot":"","sources":["../../../src/services/getOhlcv.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,yBAAyB,CAAA;AAsB3D;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,KAAK,UAAU,QAAQ,CAC5B,MAAsB,EACtB,MAAsB,EACtB,OAA2B;IAE3B,MAAM,GAAG,GAAG,QAAQ,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,QAAQ,EAAE;QACpD,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,SAAS,EAAE,MAAM,CAAC,SAAS;QAC3B,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,KAAK,EAAE,MAAM,CAAC,KAAK;KACpB,CAAC,CAAA;IACF,OAAO,OAAO,CAAgB,MAAM,CAAC,MAAM,EAAE,GAAG,EAAE,EAAE,EAAE,OAAO,CAAC,CAAA;AAChE,CAAC"}
@@ -10,6 +10,7 @@ import type { PerpsSDKClient } from '../types/provider.js';
10
10
  export interface GetOrderParams {
11
11
  provider: string;
12
12
  address: Address;
13
+ /** Venue order id, opaque to the SDK. */
13
14
  id: string;
14
15
  }
15
16
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"getOrder.d.ts","sourceRoot":"","sources":["../../../src/services/getOrder.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAA;AAC9C,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,MAAM,CAAA;AAEnC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAA;AAC3D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAE1D;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,OAAO,CAAA;IAChB,EAAE,EAAE,MAAM,CAAA;CACX;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAsB,QAAQ,CAC5B,MAAM,EAAE,cAAc,EACtB,MAAM,EAAE,cAAc,EACtB,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,KAAK,CAAC,CAKhB"}
1
+ {"version":3,"file":"getOrder.d.ts","sourceRoot":"","sources":["../../../src/services/getOrder.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAA;AAC9C,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,MAAM,CAAA;AAEnC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAA;AAC3D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAE1D;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,OAAO,CAAA;IAChB,yCAAyC;IACzC,EAAE,EAAE,MAAM,CAAA;CACX;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAsB,QAAQ,CAC5B,MAAM,EAAE,cAAc,EACtB,MAAM,EAAE,cAAc,EACtB,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,KAAK,CAAC,CAKhB"}
@@ -1 +1 @@
1
- {"version":3,"file":"getOrder.js","sourceRoot":"","sources":["../../../src/services/getOrder.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAA;AAe9D;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,CAAC,KAAK,UAAU,QAAQ,CAC5B,MAAsB,EACtB,MAAsB,EACtB,OAA2B;IAE3B,OAAO,eAAe,CAAC,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC,QAAQ,CACtD,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE,EAAE,EAAE,MAAM,CAAC,EAAE,EAAE,EAC1C,OAAO,CACR,CAAA;AACH,CAAC"}
1
+ {"version":3,"file":"getOrder.js","sourceRoot":"","sources":["../../../src/services/getOrder.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAA;AAgB9D;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,CAAC,KAAK,UAAU,QAAQ,CAC5B,MAAsB,EACtB,MAAsB,EACtB,OAA2B;IAE3B,OAAO,eAAe,CAAC,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC,QAAQ,CACtD,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE,EAAE,EAAE,MAAM,CAAC,EAAE,EAAE,EAC1C,OAAO,CACR,CAAA;AACH,CAAC"}
@@ -8,9 +8,9 @@ import type { PerpsSDKClient } from '../types/provider.js';
8
8
  */
9
9
  export interface GetOrderbookParams {
10
10
  provider: string;
11
- /** Opaque provider `Market.id` (not `displaySymbol`). */
11
+ /** Opaque provider `Market.id`, not a display symbol. */
12
12
  marketId: string;
13
- /** Number of levels to return (default varies by DEX) */
13
+ /** Optional number of price levels; venue defaults apply when omitted. */
14
14
  depth?: number;
15
15
  }
16
16
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"getOrderbook.d.ts","sourceRoot":"","sources":["../../../src/services/getOrderbook.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAA;AAE1D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAA;AAC3D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAE1D;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,QAAQ,EAAE,MAAM,CAAA;IAChB,yDAAyD;IACzD,QAAQ,EAAE,MAAM,CAAA;IAChB,yDAAyD;IACzD,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED;;;;;;GAMG;AACH,wBAAsB,YAAY,CAChC,MAAM,EAAE,cAAc,EACtB,MAAM,EAAE,kBAAkB,EAC1B,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,iBAAiB,CAAC,CAO5B"}
1
+ {"version":3,"file":"getOrderbook.d.ts","sourceRoot":"","sources":["../../../src/services/getOrderbook.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAA;AAE1D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAA;AAC3D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAE1D;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,QAAQ,EAAE,MAAM,CAAA;IAChB,yDAAyD;IACzD,QAAQ,EAAE,MAAM,CAAA;IAChB,0EAA0E;IAC1E,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED;;;;;;GAMG;AACH,wBAAsB,YAAY,CAChC,MAAM,EAAE,cAAc,EACtB,MAAM,EAAE,kBAAkB,EAC1B,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,iBAAiB,CAAC,CAO5B"}
@@ -10,9 +10,11 @@ import type { PerpsSDKClient } from '../types/provider.js';
10
10
  export interface GetOrdersParams {
11
11
  provider: string;
12
12
  address: Address;
13
- /** Optional filter — opaque `Market.id` (not `displaySymbol`) */
13
+ /** Optional opaque `Market.id` filter, not a display symbol. */
14
14
  marketId?: string;
15
+ /** Maximum items returned; provider defaults and caps apply. */
15
16
  limit?: number;
17
+ /** Opaque pagination cursor from the previous response. */
16
18
  cursor?: string;
17
19
  }
18
20
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"getOrders.d.ts","sourceRoot":"","sources":["../../../src/services/getOrders.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAA;AACvD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,MAAM,CAAA;AAEnC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAA;AAC3D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAE1D;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC9B,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,OAAO,CAAA;IAChB,iEAAiE;IACjE,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAsB,SAAS,CAC7B,MAAM,EAAE,cAAc,EACtB,MAAM,EAAE,eAAe,EACvB,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,cAAc,CAAC,CAUzB"}
1
+ {"version":3,"file":"getOrders.d.ts","sourceRoot":"","sources":["../../../src/services/getOrders.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAA;AACvD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,MAAM,CAAA;AAEnC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAA;AAC3D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAE1D;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC9B,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,OAAO,CAAA;IAChB,gEAAgE;IAChE,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,gEAAgE;IAChE,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,2DAA2D;IAC3D,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAsB,SAAS,CAC7B,MAAM,EAAE,cAAc,EACtB,MAAM,EAAE,eAAe,EACvB,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,cAAc,CAAC,CAUzB"}
@@ -1 +1 @@
1
- {"version":3,"file":"getOrders.js","sourceRoot":"","sources":["../../../src/services/getOrders.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAA;AAkB9D;;;;;;;;;;;;;;;GAeG;AACH,MAAM,CAAC,KAAK,UAAU,SAAS,CAC7B,MAAsB,EACtB,MAAuB,EACvB,OAA2B;IAE3B,OAAO,eAAe,CAAC,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC,SAAS,CACvD;QACE,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,KAAK,EAAE,MAAM,CAAC,KAAK;QACnB,MAAM,EAAE,MAAM,CAAC,MAAM;KACtB,EACD,OAAO,CACR,CAAA;AACH,CAAC"}
1
+ {"version":3,"file":"getOrders.js","sourceRoot":"","sources":["../../../src/services/getOrders.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAA;AAoB9D;;;;;;;;;;;;;;;GAeG;AACH,MAAM,CAAC,KAAK,UAAU,SAAS,CAC7B,MAAsB,EACtB,MAAuB,EACvB,OAA2B;IAE3B,OAAO,eAAe,CAAC,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC,SAAS,CACvD;QACE,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,KAAK,EAAE,MAAM,CAAC,KAAK;QACnB,MAAM,EAAE,MAAM,CAAC,MAAM;KACtB,EACD,OAAO,CACR,CAAA;AACH,CAAC"}
@@ -10,9 +10,11 @@ import type { PerpsSDKClient } from '../types/provider.js';
10
10
  export interface GetPositionsParams {
11
11
  provider: string;
12
12
  address: Address;
13
- /** Optional filter — opaque `Market.id` (not `displaySymbol`) */
13
+ /** Optional opaque `Market.id` filter, not a display symbol. */
14
14
  marketId?: string;
15
+ /** Maximum items returned; provider defaults and caps apply. */
15
16
  limit?: number;
17
+ /** Opaque pagination cursor from the previous response. */
16
18
  cursor?: string;
17
19
  }
18
20
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"getPositions.d.ts","sourceRoot":"","sources":["../../../src/services/getPositions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAA;AAC1D,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,MAAM,CAAA;AAEnC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAA;AAC3D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAE1D;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,OAAO,CAAA;IAChB,iEAAiE;IACjE,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAsB,YAAY,CAChC,MAAM,EAAE,cAAc,EACtB,MAAM,EAAE,kBAAkB,EAC1B,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,iBAAiB,CAAC,CAU5B"}
1
+ {"version":3,"file":"getPositions.d.ts","sourceRoot":"","sources":["../../../src/services/getPositions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAA;AAC1D,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,MAAM,CAAA;AAEnC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAA;AAC3D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAE1D;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,OAAO,CAAA;IAChB,gEAAgE;IAChE,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,gEAAgE;IAChE,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,2DAA2D;IAC3D,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAsB,YAAY,CAChC,MAAM,EAAE,cAAc,EACtB,MAAM,EAAE,kBAAkB,EAC1B,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,iBAAiB,CAAC,CAU5B"}
@@ -1 +1 @@
1
- {"version":3,"file":"getPositions.js","sourceRoot":"","sources":["../../../src/services/getPositions.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAA;AAkB9D;;;;;;;;;;;;;;;GAeG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,MAAsB,EACtB,MAA0B,EAC1B,OAA2B;IAE3B,OAAO,eAAe,CAAC,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC,YAAY,CAC1D;QACE,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,KAAK,EAAE,MAAM,CAAC,KAAK;QACnB,MAAM,EAAE,MAAM,CAAC,MAAM;KACtB,EACD,OAAO,CACR,CAAA;AACH,CAAC"}
1
+ {"version":3,"file":"getPositions.js","sourceRoot":"","sources":["../../../src/services/getPositions.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAA;AAoB9D;;;;;;;;;;;;;;;GAeG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,MAAsB,EACtB,MAA0B,EAC1B,OAA2B;IAE3B,OAAO,eAAe,CAAC,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC,YAAY,CAC1D;QACE,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,KAAK,EAAE,MAAM,CAAC,KAAK;QACnB,MAAM,EAAE,MAAM,CAAC,MAAM;KACtB,EACD,OAAO,CACR,CAAA;AACH,CAAC"}
@@ -8,11 +8,13 @@ import type { PerpsSDKClient } from '../types/provider.js';
8
8
  */
9
9
  export interface GetQuoteParams {
10
10
  provider: string;
11
- /** Human `displaySymbol`, e.g. `"BTC"`. */
11
+ /** Human `displaySymbol`, e.g. `"BTC"`, resolved by the provider. */
12
12
  symbol: string;
13
+ /** Buy consumes asks; sell consumes bids. */
13
14
  side: QuoteSide;
14
15
  /** USD notional to fill. */
15
16
  size: number;
17
+ /** Product family used to distinguish spot and perpetual markets. */
16
18
  type: TradeType;
17
19
  }
18
20
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"getQuote.d.ts","sourceRoot":"","sources":["../../../src/services/getQuote.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAA;AAEpE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAA;AAC3D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAE1D;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B,QAAQ,EAAE,MAAM,CAAA;IAChB,2CAA2C;IAC3C,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,SAAS,CAAA;IACf,4BAA4B;IAC5B,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,SAAS,CAAA;CAChB;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAsB,QAAQ,CAC5B,MAAM,EAAE,cAAc,EACtB,MAAM,EAAE,cAAc,EACtB,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,KAAK,CAAC,CAUhB"}
1
+ {"version":3,"file":"getQuote.d.ts","sourceRoot":"","sources":["../../../src/services/getQuote.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAA;AAEpE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAA;AAC3D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAE1D;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B,QAAQ,EAAE,MAAM,CAAA;IAChB,qEAAqE;IACrE,MAAM,EAAE,MAAM,CAAA;IACd,6CAA6C;IAC7C,IAAI,EAAE,SAAS,CAAA;IACf,4BAA4B;IAC5B,IAAI,EAAE,MAAM,CAAA;IACZ,qEAAqE;IACrE,IAAI,EAAE,SAAS,CAAA;CAChB;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAsB,QAAQ,CAC5B,MAAM,EAAE,cAAc,EACtB,MAAM,EAAE,cAAc,EACtB,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,KAAK,CAAC,CAUhB"}
@@ -1 +1 @@
1
- {"version":3,"file":"getQuote.js","sourceRoot":"","sources":["../../../src/services/getQuote.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAA;AAmB9D;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,CAAC,KAAK,UAAU,QAAQ,CAC5B,MAAsB,EACtB,MAAsB,EACtB,OAA2B;IAE3B,OAAO,eAAe,CAAC,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC,QAAQ,CACtD;QACE,MAAM,EAAE,MAAM,CAAC,MAAM;QACrB,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,IAAI,EAAE,MAAM,CAAC,IAAI;KAClB,EACD,OAAO,CACR,CAAA;AACH,CAAC"}
1
+ {"version":3,"file":"getQuote.js","sourceRoot":"","sources":["../../../src/services/getQuote.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAA;AAqB9D;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,CAAC,KAAK,UAAU,QAAQ,CAC5B,MAAsB,EACtB,MAAsB,EACtB,OAA2B;IAE3B,OAAO,eAAe,CAAC,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC,QAAQ,CACtD;QACE,MAAM,EAAE,MAAM,CAAC,MAAM;QACrB,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,IAAI,EAAE,MAAM,CAAC,IAAI;KAClB,EACD,OAAO,CACR,CAAA;AACH,CAAC"}
@@ -14,6 +14,8 @@ import type { StorageAdapter } from './types.js';
14
14
  *
15
15
  * @param raw Stored string, or `null` when the key is absent.
16
16
  * @param isValid Shape guard run against the parsed value.
17
+ *
18
+ * @public
17
19
  */
18
20
  export declare function parseStoredRecord<T>(raw: string | null, isValid: (value: unknown) => value is T): T | null;
19
21
  /**
@@ -24,6 +26,8 @@ export declare function parseStoredRecord<T>(raw: string | null, isValid: (value
24
26
  * Returns `null` for both the genuine-absence and the evicted-poison cases;
25
27
  * callers that must distinguish them should compare against the pre-read
26
28
  * presence of the key themselves.
29
+ *
30
+ * @public
27
31
  */
28
32
  export declare function readValidatedRecord<T>(storage: StorageAdapter, key: string, isValid: (value: unknown) => value is T): Promise<T | null>;
29
33
  //# sourceMappingURL=parseStoredRecord.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"parseStoredRecord.d.ts","sourceRoot":"","sources":["../../../src/storage/parseStoredRecord.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAA;AAEhD;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,EACjC,GAAG,EAAE,MAAM,GAAG,IAAI,EAClB,OAAO,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,CAAC,GACtC,CAAC,GAAG,IAAI,CAWV;AAED;;;;;;;;GAQG;AACH,wBAAsB,mBAAmB,CAAC,CAAC,EACzC,OAAO,EAAE,cAAc,EACvB,GAAG,EAAE,MAAM,EACX,OAAO,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,CAAC,GACtC,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC,CAOnB"}
1
+ {"version":3,"file":"parseStoredRecord.d.ts","sourceRoot":"","sources":["../../../src/storage/parseStoredRecord.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAA;AAEhD;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,EACjC,GAAG,EAAE,MAAM,GAAG,IAAI,EAClB,OAAO,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,CAAC,GACtC,CAAC,GAAG,IAAI,CAWV;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,mBAAmB,CAAC,CAAC,EACzC,OAAO,EAAE,cAAc,EACvB,GAAG,EAAE,MAAM,EACX,OAAO,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,CAAC,GACtC,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC,CAOnB"}
@@ -13,6 +13,8 @@
13
13
  *
14
14
  * @param raw Stored string, or `null` when the key is absent.
15
15
  * @param isValid Shape guard run against the parsed value.
16
+ *
17
+ * @public
16
18
  */
17
19
  export function parseStoredRecord(raw, isValid) {
18
20
  if (raw === null) {
@@ -35,6 +37,8 @@ export function parseStoredRecord(raw, isValid) {
35
37
  * Returns `null` for both the genuine-absence and the evicted-poison cases;
36
38
  * callers that must distinguish them should compare against the pre-read
37
39
  * presence of the key themselves.
40
+ *
41
+ * @public
38
42
  */
39
43
  export async function readValidatedRecord(storage, key, isValid) {
40
44
  const raw = await storage.get(key);
@@ -1 +1 @@
1
- {"version":3,"file":"parseStoredRecord.js","sourceRoot":"","sources":["../../../src/storage/parseStoredRecord.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;GAeG;AACH,MAAM,UAAU,iBAAiB,CAC/B,GAAkB,EAClB,OAAuC;IAEvC,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;QACjB,OAAO,IAAI,CAAA;IACb,CAAC;IACD,IAAI,MAAe,CAAA;IACnB,IAAI,CAAC;QACH,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IAC1B,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAA;IACb,CAAC;IACD,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAA;AACxC,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB,CACvC,OAAuB,EACvB,GAAW,EACX,OAAuC;IAEvC,MAAM,GAAG,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;IAClC,MAAM,MAAM,GAAG,iBAAiB,CAAC,GAAG,EAAE,OAAO,CAAC,CAAA;IAC9C,IAAI,MAAM,KAAK,IAAI,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;QACpC,MAAM,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;IAC3B,CAAC;IACD,OAAO,MAAM,CAAA;AACf,CAAC"}
1
+ {"version":3,"file":"parseStoredRecord.js","sourceRoot":"","sources":["../../../src/storage/parseStoredRecord.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,UAAU,iBAAiB,CAC/B,GAAkB,EAClB,OAAuC;IAEvC,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;QACjB,OAAO,IAAI,CAAA;IACb,CAAC;IACD,IAAI,MAAe,CAAA;IACnB,IAAI,CAAC;QACH,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IAC1B,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAA;IACb,CAAC;IACD,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAA;AACxC,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB,CACvC,OAAuB,EACvB,GAAW,EACX,OAAuC;IAEvC,MAAM,GAAG,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;IAClC,MAAM,MAAM,GAAG,iBAAiB,CAAC,GAAG,EAAE,OAAO,CAAC,CAAA;IAC9C,IAAI,MAAM,KAAK,IAAI,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;QACpC,MAAM,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;IAC3B,CAAC;IACD,OAAO,MAAM,CAAA;AACf,CAAC"}
@@ -1,14 +1,18 @@
1
1
  /**
2
- * Storage adapter interface for persisting SDK session credentials (provider
3
- * agent keypairs, API keys, read-only tokens). Implement this to use custom
4
- * storage (e.g. encrypted storage, a database, async key-value stores).
2
+ * Asynchronous key-value storage for SDK session credentials (provider agent
3
+ * keypairs, API keys, and read-only tokens). Values are opaque strings; an
4
+ * adapter should preserve them exactly and return `null` when a key is absent.
5
+ * Implement this interface for encrypted storage, a database, or another
6
+ * application-owned store.
7
+ *
8
+ * @public
5
9
  */
6
10
  export interface StorageAdapter {
7
- /** Get a value by key. */
11
+ /** Read the value for `key`, or `null` when the key is absent. */
8
12
  get(key: string): Promise<string | null>;
9
- /** Set a value by key. */
13
+ /** Persist `value` under `key`, replacing any existing value. */
10
14
  set(key: string, value: string): Promise<void>;
11
- /** Remove a value by key. */
15
+ /** Remove `key`; resolving successfully when it is already absent. */
12
16
  remove(key: string): Promise<void>;
13
17
  }
14
18
  //# sourceMappingURL=types.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/storage/types.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B,0BAA0B;IAC1B,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAA;IACxC,0BAA0B;IAC1B,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAC9C,6BAA6B;IAC7B,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CACnC"}
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/storage/types.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,MAAM,WAAW,cAAc;IAC7B,kEAAkE;IAClE,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAA;IACxC,iEAAiE;IACjE,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAC9C,sEAAsE;IACtE,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CACnC"}
@@ -5,8 +5,11 @@ import type { ResolvedRetryPolicy } from './retryPolicy.js';
5
5
  * @public
6
6
  */
7
7
  export interface FetchWithRetryOptions {
8
+ /** Fully resolved retry policy controlling attempts, delays, and classification. */
8
9
  policy: ResolvedRetryPolicy;
10
+ /** Optional fetch implementation; defaults to the global `fetch`. */
9
11
  fetchImpl?: typeof fetch;
12
+ /** Abort signal; cancellation is propagated without retrying. */
10
13
  signal?: AbortSignal;
11
14
  }
12
15
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"fetchWithRetry.d.ts","sourceRoot":"","sources":["../../../src/transport/fetchWithRetry.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,mBAAmB,EAAuB,MAAM,kBAAkB,CAAA;AAEhF;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACpC,MAAM,EAAE,mBAAmB,CAAA;IAC3B,SAAS,CAAC,EAAE,OAAO,KAAK,CAAA;IACxB,MAAM,CAAC,EAAE,WAAW,CAAA;CACrB;AAED;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAEpD;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,cAAc,CAClC,KAAK,EAAE,WAAW,GAAG,GAAG,EACxB,IAAI,EAAE,WAAW,GAAG,SAAS,EAC7B,OAAO,EAAE,qBAAqB,GAC7B,OAAO,CAAC,QAAQ,CAAC,CA4DnB"}
1
+ {"version":3,"file":"fetchWithRetry.d.ts","sourceRoot":"","sources":["../../../src/transport/fetchWithRetry.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,mBAAmB,EAAuB,MAAM,kBAAkB,CAAA;AAEhF;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACpC,oFAAoF;IACpF,MAAM,EAAE,mBAAmB,CAAA;IAC3B,qEAAqE;IACrE,SAAS,CAAC,EAAE,OAAO,KAAK,CAAA;IACxB,iEAAiE;IACjE,MAAM,CAAC,EAAE,WAAW,CAAA;CACrB;AAED;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAEpD;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,cAAc,CAClC,KAAK,EAAE,WAAW,GAAG,GAAG,EACxB,IAAI,EAAE,WAAW,GAAG,SAAS,EAC7B,OAAO,EAAE,qBAAqB,GAC7B,OAAO,CAAC,QAAQ,CAAC,CA4DnB"}
@@ -1 +1 @@
1
- {"version":3,"file":"fetchWithRetry.js","sourceRoot":"","sources":["../../../src/transport/fetchWithRetry.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAA;AAczC;;;;;;GAMG;AACH,MAAM,UAAU,YAAY,CAAC,KAAc;IACzC,OAAO,KAAK,YAAY,KAAK,IAAI,KAAK,CAAC,IAAI,KAAK,YAAY,CAAA;AAC9D,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAClC,KAAwB,EACxB,IAA6B,EAC7B,OAA8B;IAE9B,MAAM,EAAE,MAAM,EAAE,SAAS,GAAG,KAAK,EAAE,MAAM,EAAE,GAAG,OAAO,CAAA;IACrD,MAAM,UAAU,GAAgB,MAAM,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC,CAAA;IAE3E,IAAI,OAAO,GAAG,CAAC,CAAA;IACf,OAAO,IAAI,EAAE,CAAC;QACZ,IAAI,MAAM,EAAE,OAAO,EAAE,CAAC;YACpB,MAAM,MAAM,CAAC,MAAM,IAAI,IAAI,YAAY,CAAC,SAAS,EAAE,YAAY,CAAC,CAAA;QAClE,CAAC;QAED,IAAI,QAA8B,CAAA;QAClC,IAAI,YAAqB,CAAA;QACzB,IAAI,CAAC;YACH,QAAQ,GAAG,MAAM,SAAS,CAAC,KAAK,EAAE,UAAU,CAAC,CAAA;QAC/C,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC;gBACxB,MAAM,KAAK,CAAA;YACb,CAAC;YACD,YAAY,GAAG,KAAK,CAAA;QACtB,CAAC;QAED,IAAI,QAAQ,EAAE,EAAE,EAAE,CAAC;YACjB,OAAO,QAAQ,CAAA;QACjB,CAAC;QAED,MAAM,cAAc,GAAwB,QAAQ;YAClD,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,QAAQ,EAAE,CAAC;YAC/B,CAAC,CAAC,eAAe,CAAA;QAEnB,MAAM,iBAAiB,GAAG,MAAM,CAAC,WAAW,GAAG,OAAO,GAAG,CAAC,CAAA;QAC1D,MAAM,WAAW,GAAG,cAAc,KAAK,MAAM,IAAI,iBAAiB,GAAG,CAAC,CAAA;QAEtE,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,IAAI,QAAQ,EAAE,CAAC;gBACb,OAAO,QAAQ,CAAA;YACjB,CAAC;YACD,MAAM,YAAY,CAAA;QACpB,CAAC;QAED,IAAI,MAAM,CAAC,WAAW,EAAE,CAAC;YACvB,MAAM,EAAE,GAAG,MAAM,MAAM,CAAC,WAAW,CAAC;gBAClC,OAAO;gBACP,QAAQ;gBACR,KAAK,EAAE,YAAY;gBACnB,cAAc;aACf,CAAC,CAAA;YACF,IAAI,CAAC,EAAE,EAAE,CAAC;gBACR,IAAI,QAAQ,EAAE,CAAC;oBACb,OAAO,QAAQ,CAAA;gBACjB,CAAC;gBACD,MAAM,YAAY,CAAA;YACpB,CAAC;QACH,CAAC;QAED,MAAM,OAAO,GAAG,YAAY,CAAC,MAAM,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAA;QACvD,IAAI,OAAO,GAAG,CAAC,EAAE,CAAC;YAChB,MAAM,KAAK,CAAC,OAAO,EAAE,MAAM,CAAC,CAAA;QAC9B,CAAC;QACD,OAAO,EAAE,CAAA;IACX,CAAC;AACH,CAAC;AAED,SAAS,YAAY,CACnB,MAA2B,EAC3B,OAAe,EACf,QAA8B;IAE9B,IAAI,MAAM,CAAC,iBAAiB,IAAI,QAAQ,EAAE,CAAC;QACzC,MAAM,MAAM,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,CAAA;QAClD,IAAI,MAAM,EAAE,CAAC;YACX,MAAM,MAAM,GAAG,eAAe,CAAC,MAAM,CAAC,CAAA;YACtC,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;gBACzB,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,UAAU,CAAC,CAAA;YAC5C,CAAC;QACH,CAAC;IACH,CAAC;IACD,MAAM,GAAG,GAAG,MAAM,CAAC,WAAW,GAAG,CAAC,IAAI,OAAO,CAAA;IAC7C,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,UAAU,CAAC,CAAA;IAC/C,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,MAAM,CAAC,CAAA;AAC3C,CAAC;AAED,SAAS,eAAe,CAAC,MAAc;IACrC,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,CAAA;IAC9B,IAAI,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,OAAO,IAAI,CAAC,EAAE,CAAC;QAC7C,OAAO,OAAO,GAAG,IAAI,CAAA;IACvB,CAAC;IACD,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;IACjC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;QAC1B,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC,CAAA;IACzC,CAAC;IACD,OAAO,SAAS,CAAA;AAClB,CAAC"}
1
+ {"version":3,"file":"fetchWithRetry.js","sourceRoot":"","sources":["../../../src/transport/fetchWithRetry.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAA;AAiBzC;;;;;;GAMG;AACH,MAAM,UAAU,YAAY,CAAC,KAAc;IACzC,OAAO,KAAK,YAAY,KAAK,IAAI,KAAK,CAAC,IAAI,KAAK,YAAY,CAAA;AAC9D,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAClC,KAAwB,EACxB,IAA6B,EAC7B,OAA8B;IAE9B,MAAM,EAAE,MAAM,EAAE,SAAS,GAAG,KAAK,EAAE,MAAM,EAAE,GAAG,OAAO,CAAA;IACrD,MAAM,UAAU,GAAgB,MAAM,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC,CAAA;IAE3E,IAAI,OAAO,GAAG,CAAC,CAAA;IACf,OAAO,IAAI,EAAE,CAAC;QACZ,IAAI,MAAM,EAAE,OAAO,EAAE,CAAC;YACpB,MAAM,MAAM,CAAC,MAAM,IAAI,IAAI,YAAY,CAAC,SAAS,EAAE,YAAY,CAAC,CAAA;QAClE,CAAC;QAED,IAAI,QAA8B,CAAA;QAClC,IAAI,YAAqB,CAAA;QACzB,IAAI,CAAC;YACH,QAAQ,GAAG,MAAM,SAAS,CAAC,KAAK,EAAE,UAAU,CAAC,CAAA;QAC/C,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC;gBACxB,MAAM,KAAK,CAAA;YACb,CAAC;YACD,YAAY,GAAG,KAAK,CAAA;QACtB,CAAC;QAED,IAAI,QAAQ,EAAE,EAAE,EAAE,CAAC;YACjB,OAAO,QAAQ,CAAA;QACjB,CAAC;QAED,MAAM,cAAc,GAAwB,QAAQ;YAClD,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,QAAQ,EAAE,CAAC;YAC/B,CAAC,CAAC,eAAe,CAAA;QAEnB,MAAM,iBAAiB,GAAG,MAAM,CAAC,WAAW,GAAG,OAAO,GAAG,CAAC,CAAA;QAC1D,MAAM,WAAW,GAAG,cAAc,KAAK,MAAM,IAAI,iBAAiB,GAAG,CAAC,CAAA;QAEtE,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,IAAI,QAAQ,EAAE,CAAC;gBACb,OAAO,QAAQ,CAAA;YACjB,CAAC;YACD,MAAM,YAAY,CAAA;QACpB,CAAC;QAED,IAAI,MAAM,CAAC,WAAW,EAAE,CAAC;YACvB,MAAM,EAAE,GAAG,MAAM,MAAM,CAAC,WAAW,CAAC;gBAClC,OAAO;gBACP,QAAQ;gBACR,KAAK,EAAE,YAAY;gBACnB,cAAc;aACf,CAAC,CAAA;YACF,IAAI,CAAC,EAAE,EAAE,CAAC;gBACR,IAAI,QAAQ,EAAE,CAAC;oBACb,OAAO,QAAQ,CAAA;gBACjB,CAAC;gBACD,MAAM,YAAY,CAAA;YACpB,CAAC;QACH,CAAC;QAED,MAAM,OAAO,GAAG,YAAY,CAAC,MAAM,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAA;QACvD,IAAI,OAAO,GAAG,CAAC,EAAE,CAAC;YAChB,MAAM,KAAK,CAAC,OAAO,EAAE,MAAM,CAAC,CAAA;QAC9B,CAAC;QACD,OAAO,EAAE,CAAA;IACX,CAAC;AACH,CAAC;AAED,SAAS,YAAY,CACnB,MAA2B,EAC3B,OAAe,EACf,QAA8B;IAE9B,IAAI,MAAM,CAAC,iBAAiB,IAAI,QAAQ,EAAE,CAAC;QACzC,MAAM,MAAM,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,CAAA;QAClD,IAAI,MAAM,EAAE,CAAC;YACX,MAAM,MAAM,GAAG,eAAe,CAAC,MAAM,CAAC,CAAA;YACtC,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;gBACzB,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,UAAU,CAAC,CAAA;YAC5C,CAAC;QACH,CAAC;IACH,CAAC;IACD,MAAM,GAAG,GAAG,MAAM,CAAC,WAAW,GAAG,CAAC,IAAI,OAAO,CAAA;IAC7C,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,UAAU,CAAC,CAAA;IAC/C,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,MAAM,CAAC,CAAA;AAC3C,CAAC;AAED,SAAS,eAAe,CAAC,MAAc;IACrC,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,CAAA;IAC9B,IAAI,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,OAAO,IAAI,CAAC,EAAE,CAAC;QAC7C,OAAO,OAAO,GAAG,IAAI,CAAA;IACvB,CAAC;IACD,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;IACjC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;QAC1B,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC,CAAA;IACzC,CAAC;IACD,OAAO,SAAS,CAAA;AAClB,CAAC"}
@@ -18,6 +18,7 @@ export type RetryClassification = 'retry-rate-limit' | 'retry-server' | 'retry-n
18
18
  * @public
19
19
  */
20
20
  export interface RetryClassifyContext {
21
+ /** Non-2xx response being classified for retry or terminal failure. */
21
22
  response: Response;
22
23
  }
23
24
  /**
@@ -27,9 +28,13 @@ export interface RetryClassifyContext {
27
28
  * @public
28
29
  */
29
30
  export interface RetryAttemptContext {
31
+ /** Zero-based attempt index for the response/error. */
30
32
  attempt: number;
33
+ /** Response received, when the attempt reached the server. */
31
34
  response?: Response;
35
+ /** Network error thrown before a response was received. */
32
36
  error?: unknown;
37
+ /** Classification returned by the policy's classifier. */
33
38
  classification: RetryClassification;
34
39
  }
35
40
  /**
@@ -42,11 +47,17 @@ export interface RetryAttemptContext {
42
47
  * @public
43
48
  */
44
49
  export interface RetryPolicy {
50
+ /** Maximum total attempts, including the initial request. */
45
51
  maxAttempts?: number;
52
+ /** Initial exponential-backoff ceiling in milliseconds. */
46
53
  baseDelayMs?: number;
54
+ /** Maximum backoff delay in milliseconds. */
47
55
  maxDelayMs?: number;
56
+ /** Whether a valid `Retry-After` response header takes precedence. */
48
57
  respectRetryAfter?: boolean;
58
+ /** Classify a response; `undefined` delegates to the base classifier. */
49
59
  classify?: (ctx: RetryClassifyContext) => RetryClassification | undefined;
60
+ /** Final per-attempt veto after classification requests a retry. */
50
61
  shouldRetry?: (ctx: RetryAttemptContext) => boolean | Promise<boolean>;
51
62
  }
52
63
  /**
@@ -56,12 +67,19 @@ export interface RetryPolicy {
56
67
  * @public
57
68
  */
58
69
  export interface ResolvedRetryPolicy {
70
+ /** Whether retries are enabled. */
59
71
  enabled: boolean;
72
+ /** Maximum total attempts, including the initial request. */
60
73
  maxAttempts: number;
74
+ /** Initial exponential-backoff ceiling in milliseconds. */
61
75
  baseDelayMs: number;
76
+ /** Maximum backoff delay in milliseconds. */
62
77
  maxDelayMs: number;
78
+ /** Whether a valid `Retry-After` header is honored. */
63
79
  respectRetryAfter: boolean;
80
+ /** Final response classifier used for each failed attempt. */
64
81
  classify: (ctx: RetryClassifyContext) => RetryClassification;
82
+ /** Optional final veto after classification requests a retry. */
65
83
  shouldRetry?: (ctx: RetryAttemptContext) => boolean | Promise<boolean>;
66
84
  }
67
85
  /**
@@ -72,7 +90,9 @@ export interface ResolvedRetryPolicy {
72
90
  * @public
73
91
  */
74
92
  export interface ProviderRetryConfig {
93
+ /** Fallback policy for providers without an explicit key. */
75
94
  default?: RetryPolicy | false;
95
+ /** Override keyed by provider type, or `lifi` for backend requests. */
76
96
  [providerKey: string]: RetryPolicy | false | undefined;
77
97
  }
78
98
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"retryPolicy.d.ts","sourceRoot":"","sources":["../../../src/transport/retryPolicy.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,EAAG,MAAe,CAAA;AAE/C;;;;;GAKG;AACH,MAAM,MAAM,mBAAmB,GAC3B,kBAAkB,GAClB,cAAc,GACd,eAAe,GACf,MAAM,CAAA;AAEV;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACnC,QAAQ,EAAE,QAAQ,CAAA;CACnB;AAED;;;;;GAKG;AACH,MAAM,WAAW,mBAAmB;IAClC,OAAO,EAAE,MAAM,CAAA;IACf,QAAQ,CAAC,EAAE,QAAQ,CAAA;IACnB,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,cAAc,EAAE,mBAAmB,CAAA;CACpC;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,WAAW;IAC1B,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,iBAAiB,CAAC,EAAE,OAAO,CAAA;IAC3B,QAAQ,CAAC,EAAE,CAAC,GAAG,EAAE,oBAAoB,KAAK,mBAAmB,GAAG,SAAS,CAAA;IACzE,WAAW,CAAC,EAAE,CAAC,GAAG,EAAE,mBAAmB,KAAK,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;CACvE;AAED;;;;;GAKG;AACH,MAAM,WAAW,mBAAmB;IAClC,OAAO,EAAE,OAAO,CAAA;IAChB,WAAW,EAAE,MAAM,CAAA;IACnB,WAAW,EAAE,MAAM,CAAA;IACnB,UAAU,EAAE,MAAM,CAAA;IAClB,iBAAiB,EAAE,OAAO,CAAA;IAC1B,QAAQ,EAAE,CAAC,GAAG,EAAE,oBAAoB,KAAK,mBAAmB,CAAA;IAC5D,WAAW,CAAC,EAAE,CAAC,GAAG,EAAE,mBAAmB,KAAK,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;CACvE;AAED;;;;;;GAMG;AACH,MAAM,WAAW,mBAAmB;IAClC,OAAO,CAAC,EAAE,WAAW,GAAG,KAAK,CAAA;IAC7B,CAAC,WAAW,EAAE,MAAM,GAAG,WAAW,GAAG,KAAK,GAAG,SAAS,CAAA;CACvD;AAED;;;;;GAKG;AACH,MAAM,MAAM,WAAW,GAAG,WAAW,GAAG,KAAK,GAAG,mBAAmB,CAAA;AAEnE;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,EAAE,mBAejC,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,cAAc,EAAE,mBAO5B,CAAA;AAyCD;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAChC,IAAI,EAAE,mBAAmB,EACzB,MAAM,EAAE,WAAW,GAAG,SAAS,EAC/B,WAAW,EAAE,MAAM,GAClB,mBAAmB,CAkBrB"}
1
+ {"version":3,"file":"retryPolicy.d.ts","sourceRoot":"","sources":["../../../src/transport/retryPolicy.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,EAAG,MAAe,CAAA;AAE/C;;;;;GAKG;AACH,MAAM,MAAM,mBAAmB,GAC3B,kBAAkB,GAClB,cAAc,GACd,eAAe,GACf,MAAM,CAAA;AAEV;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACnC,uEAAuE;IACvE,QAAQ,EAAE,QAAQ,CAAA;CACnB;AAED;;;;;GAKG;AACH,MAAM,WAAW,mBAAmB;IAClC,uDAAuD;IACvD,OAAO,EAAE,MAAM,CAAA;IACf,8DAA8D;IAC9D,QAAQ,CAAC,EAAE,QAAQ,CAAA;IACnB,2DAA2D;IAC3D,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,0DAA0D;IAC1D,cAAc,EAAE,mBAAmB,CAAA;CACpC;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,WAAW;IAC1B,6DAA6D;IAC7D,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,2DAA2D;IAC3D,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,6CAA6C;IAC7C,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,sEAAsE;IACtE,iBAAiB,CAAC,EAAE,OAAO,CAAA;IAC3B,yEAAyE;IACzE,QAAQ,CAAC,EAAE,CAAC,GAAG,EAAE,oBAAoB,KAAK,mBAAmB,GAAG,SAAS,CAAA;IACzE,oEAAoE;IACpE,WAAW,CAAC,EAAE,CAAC,GAAG,EAAE,mBAAmB,KAAK,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;CACvE;AAED;;;;;GAKG;AACH,MAAM,WAAW,mBAAmB;IAClC,mCAAmC;IACnC,OAAO,EAAE,OAAO,CAAA;IAChB,6DAA6D;IAC7D,WAAW,EAAE,MAAM,CAAA;IACnB,2DAA2D;IAC3D,WAAW,EAAE,MAAM,CAAA;IACnB,6CAA6C;IAC7C,UAAU,EAAE,MAAM,CAAA;IAClB,uDAAuD;IACvD,iBAAiB,EAAE,OAAO,CAAA;IAC1B,8DAA8D;IAC9D,QAAQ,EAAE,CAAC,GAAG,EAAE,oBAAoB,KAAK,mBAAmB,CAAA;IAC5D,iEAAiE;IACjE,WAAW,CAAC,EAAE,CAAC,GAAG,EAAE,mBAAmB,KAAK,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;CACvE;AAED;;;;;;GAMG;AACH,MAAM,WAAW,mBAAmB;IAClC,6DAA6D;IAC7D,OAAO,CAAC,EAAE,WAAW,GAAG,KAAK,CAAA;IAC7B,uEAAuE;IACvE,CAAC,WAAW,EAAE,MAAM,GAAG,WAAW,GAAG,KAAK,GAAG,SAAS,CAAA;CACvD;AAED;;;;;GAKG;AACH,MAAM,MAAM,WAAW,GAAG,WAAW,GAAG,KAAK,GAAG,mBAAmB,CAAA;AAEnE;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,EAAE,mBAejC,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,cAAc,EAAE,mBAO5B,CAAA;AAyCD;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAChC,IAAI,EAAE,mBAAmB,EACzB,MAAM,EAAE,WAAW,GAAG,SAAS,EAC/B,WAAW,EAAE,MAAM,GAClB,mBAAmB,CAkBrB"}
@@ -1 +1 @@
1
- {"version":3,"file":"retryPolicy.js","sourceRoot":"","sources":["../../../src/transport/retryPolicy.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,MAAe,CAAA;AA0F/C;;;;GAIG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAwB;IACtD,OAAO,EAAE,IAAI;IACb,WAAW,EAAE,CAAC;IACd,WAAW,EAAE,GAAG;IAChB,UAAU,EAAE,KAAK;IACjB,iBAAiB,EAAE,IAAI;IACvB,QAAQ,EAAE,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE;QACzB,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;YAC5B,OAAO,kBAAkB,CAAA;QAC3B,CAAC;QACD,IAAI,QAAQ,CAAC,MAAM,IAAI,GAAG,IAAI,QAAQ,CAAC,MAAM,IAAI,GAAG,EAAE,CAAC;YACrD,OAAO,cAAc,CAAA;QACvB,CAAC;QACD,OAAO,MAAM,CAAA;IACf,CAAC;CACF,CAAA;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,cAAc,GAAwB;IACjD,OAAO,EAAE,KAAK;IACd,WAAW,EAAE,CAAC;IACd,WAAW,EAAE,CAAC;IACd,UAAU,EAAE,CAAC;IACb,iBAAiB,EAAE,KAAK;IACxB,QAAQ,EAAE,GAAG,EAAE,CAAC,MAAM;CACvB,CAAA;AAED,SAAS,qBAAqB,CAC5B,KAAwC;IAExC,IACE,aAAa,IAAI,KAAK;QACtB,aAAa,IAAI,KAAK;QACtB,YAAY,IAAI,KAAK;QACrB,mBAAmB,IAAI,KAAK;QAC5B,UAAU,IAAI,KAAK;QACnB,aAAa,IAAI,KAAK,EACtB,CAAC;QACD,OAAO,KAAK,CAAA;IACd,CAAC;IACD,OAAO,IAAI,CAAA;AACb,CAAC;AAED,SAAS,WAAW,CAClB,IAAyB,EACzB,QAAyC;IAEzC,IAAI,QAAQ,KAAK,KAAK,EAAE,CAAC;QACvB,OAAO,cAAc,CAAA;IACvB,CAAC;IACD,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,OAAO,IAAI,CAAA;IACb,CAAC;IACD,OAAO;QACL,OAAO,EAAE,IAAI;QACb,WAAW,EAAE,QAAQ,CAAC,WAAW,IAAI,IAAI,CAAC,WAAW;QACrD,WAAW,EAAE,QAAQ,CAAC,WAAW,IAAI,IAAI,CAAC,WAAW;QACrD,UAAU,EAAE,QAAQ,CAAC,UAAU,IAAI,IAAI,CAAC,UAAU;QAClD,iBAAiB,EAAE,QAAQ,CAAC,iBAAiB,IAAI,IAAI,CAAC,iBAAiB;QACvE,QAAQ,EAAE,QAAQ,CAAC,QAAQ;YACzB,CAAC,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC;YACzD,CAAC,CAAC,IAAI,CAAC,QAAQ;QACjB,WAAW,EAAE,QAAQ,CAAC,WAAW,IAAI,IAAI,CAAC,WAAW;KACtD,CAAA;AACH,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,kBAAkB,CAChC,IAAyB,EACzB,MAA+B,EAC/B,WAAmB;IAEnB,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACzB,OAAO,IAAI,CAAA;IACb,CAAC;IACD,IAAI,MAAM,KAAK,KAAK,EAAE,CAAC;QACrB,OAAO,cAAc,CAAA;IACvB,CAAC;IACD,IAAI,qBAAqB,CAAC,MAAM,CAAC,EAAE,CAAC;QAClC,MAAM,WAAW,GAAG,MAAM,CAAC,WAAW,CAAC,CAAA;QACvC,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;YAC9B,OAAO,WAAW,CAAC,IAAI,EAAE,WAAW,CAAC,CAAA;QACvC,CAAC;QACD,IAAI,MAAM,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YACjC,OAAO,WAAW,CAAC,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC,CAAA;QAC1C,CAAC;QACD,OAAO,IAAI,CAAA;IACb,CAAC;IACD,OAAO,WAAW,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;AAClC,CAAC"}
1
+ {"version":3,"file":"retryPolicy.js","sourceRoot":"","sources":["../../../src/transport/retryPolicy.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,MAAe,CAAA;AA8G/C;;;;GAIG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAwB;IACtD,OAAO,EAAE,IAAI;IACb,WAAW,EAAE,CAAC;IACd,WAAW,EAAE,GAAG;IAChB,UAAU,EAAE,KAAK;IACjB,iBAAiB,EAAE,IAAI;IACvB,QAAQ,EAAE,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE;QACzB,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;YAC5B,OAAO,kBAAkB,CAAA;QAC3B,CAAC;QACD,IAAI,QAAQ,CAAC,MAAM,IAAI,GAAG,IAAI,QAAQ,CAAC,MAAM,IAAI,GAAG,EAAE,CAAC;YACrD,OAAO,cAAc,CAAA;QACvB,CAAC;QACD,OAAO,MAAM,CAAA;IACf,CAAC;CACF,CAAA;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,cAAc,GAAwB;IACjD,OAAO,EAAE,KAAK;IACd,WAAW,EAAE,CAAC;IACd,WAAW,EAAE,CAAC;IACd,UAAU,EAAE,CAAC;IACb,iBAAiB,EAAE,KAAK;IACxB,QAAQ,EAAE,GAAG,EAAE,CAAC,MAAM;CACvB,CAAA;AAED,SAAS,qBAAqB,CAC5B,KAAwC;IAExC,IACE,aAAa,IAAI,KAAK;QACtB,aAAa,IAAI,KAAK;QACtB,YAAY,IAAI,KAAK;QACrB,mBAAmB,IAAI,KAAK;QAC5B,UAAU,IAAI,KAAK;QACnB,aAAa,IAAI,KAAK,EACtB,CAAC;QACD,OAAO,KAAK,CAAA;IACd,CAAC;IACD,OAAO,IAAI,CAAA;AACb,CAAC;AAED,SAAS,WAAW,CAClB,IAAyB,EACzB,QAAyC;IAEzC,IAAI,QAAQ,KAAK,KAAK,EAAE,CAAC;QACvB,OAAO,cAAc,CAAA;IACvB,CAAC;IACD,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,OAAO,IAAI,CAAA;IACb,CAAC;IACD,OAAO;QACL,OAAO,EAAE,IAAI;QACb,WAAW,EAAE,QAAQ,CAAC,WAAW,IAAI,IAAI,CAAC,WAAW;QACrD,WAAW,EAAE,QAAQ,CAAC,WAAW,IAAI,IAAI,CAAC,WAAW;QACrD,UAAU,EAAE,QAAQ,CAAC,UAAU,IAAI,IAAI,CAAC,UAAU;QAClD,iBAAiB,EAAE,QAAQ,CAAC,iBAAiB,IAAI,IAAI,CAAC,iBAAiB;QACvE,QAAQ,EAAE,QAAQ,CAAC,QAAQ;YACzB,CAAC,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC;YACzD,CAAC,CAAC,IAAI,CAAC,QAAQ;QACjB,WAAW,EAAE,QAAQ,CAAC,WAAW,IAAI,IAAI,CAAC,WAAW;KACtD,CAAA;AACH,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,kBAAkB,CAChC,IAAyB,EACzB,MAA+B,EAC/B,WAAmB;IAEnB,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACzB,OAAO,IAAI,CAAA;IACb,CAAC;IACD,IAAI,MAAM,KAAK,KAAK,EAAE,CAAC;QACrB,OAAO,cAAc,CAAA;IACvB,CAAC;IACD,IAAI,qBAAqB,CAAC,MAAM,CAAC,EAAE,CAAC;QAClC,MAAM,WAAW,GAAG,MAAM,CAAC,WAAW,CAAC,CAAA;QACvC,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;YAC9B,OAAO,WAAW,CAAC,IAAI,EAAE,WAAW,CAAC,CAAA;QACvC,CAAC;QACD,IAAI,MAAM,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YACjC,OAAO,WAAW,CAAC,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC,CAAA;QAC1C,CAAC;QACD,OAAO,IAAI,CAAA;IACb,CAAC;IACD,OAAO,WAAW,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;AAClC,CAAC"}
@@ -1,4 +1,4 @@
1
- import type { AccountConfigSetting, AccountResponse, ActionStep, ExecuteActionResponse, MarketRef, ModifyOrderInput, OrderSide, OrderType, SignedActionStep, TimeInForce, TriggerOrderInput, WithdrawalParams } from '@lifi/perps-types';
1
+ import type { AccountConfigSetting, AccountResponse, ActionStep, ExecuteActionResponse, MarginMode, MarketRef, ModifyOrderInput, OrderSide, OrderType, SignedActionStep, TimeInForce, TriggerOrderInput, WithdrawalParams } from '@lifi/perps-types';
2
2
  import type { Account, Address, WalletClient } from 'viem';
3
3
  import type { RetryConfig } from '../transport/retryPolicy.js';
4
4
  import type { ProviderConfigs, RequestInterceptor, SwitchChainHook } from './config.js';
@@ -9,10 +9,15 @@ import type { PerpsProviderPlugin } from './provider.js';
9
9
  * @public
10
10
  */
11
11
  export interface PerpsConfig {
12
+ /** Integrator identifier sent in the `x-lifi-integrator` request header. */
12
13
  integrator: string;
14
+ /** LI.FI API key used for authenticated backend requests. */
13
15
  apiKey: string;
16
+ /** Perps API base URL; defaults to {@link DEFAULT_API_URL}. */
14
17
  apiUrl?: string;
18
+ /** Skip the SDK-version compatibility check when set. */
15
19
  disableVersionCheck?: boolean;
20
+ /** Hook that can rewrite URL/request options before transport. */
16
21
  requestInterceptor?: RequestInterceptor;
17
22
  /**
18
23
  * Provider plugins or per-provider config. Two shapes are accepted:
@@ -59,10 +64,11 @@ export interface PerpsConfig {
59
64
  * @public
60
65
  */
61
66
  export interface PerpsClientOptions {
67
+ /** Integrator identifier sent in the `x-lifi-integrator` request header. */
62
68
  integrator: string;
63
- /** API key for authenticated requests (get one at https://portal.li.fi/) */
69
+ /** API key for authenticated requests (get one at https://portal.li.fi/). */
64
70
  apiKey: string;
65
- /** Defaults to DEFAULT_API_URL */
71
+ /** Perps API base URL; defaults to {@link DEFAULT_API_URL}. */
66
72
  apiUrl?: string;
67
73
  /**
68
74
  * Provider plugins or per-provider config. Accepts the same two shapes as
@@ -95,14 +101,27 @@ export interface BuildProviderSetupParams {
95
101
  export interface PlaceOrderParams {
96
102
  provider: string;
97
103
  address: Address;
104
+ /** Opaque provider market reference. */
98
105
  market: MarketRef;
99
106
  side: OrderSide;
100
107
  type: OrderType;
108
+ /** Base-asset size as a decimal wire string. */
101
109
  size: string;
110
+ /** Limit price as a decimal wire string; required by limit-style orders. */
102
111
  price: string;
112
+ /** Optional leverage multiplier; provider defaults apply when omitted. */
103
113
  leverage?: number;
114
+ /**
115
+ * Margin mode the order trades under; omitted falls to the venue's cross
116
+ * default. Lighter's order tx carries the mode directly; Hyperliquid
117
+ * applies it via a prepended leverage update (requires `leverage`).
118
+ */
119
+ marginMode?: MarginMode;
120
+ /** Whether the order may only reduce an existing position. */
104
121
  reduceOnly?: boolean;
122
+ /** Time-in-force policy; provider defaults apply when omitted. */
105
123
  timeInForce?: TimeInForce;
124
+ /** Optional Unix timestamp or provider wire expiry string. */
106
125
  expiresAt?: string;
107
126
  takeProfit?: TriggerOrderInput;
108
127
  stopLoss?: TriggerOrderInput;
@@ -116,6 +135,7 @@ export interface PlaceOrderParams {
116
135
  export interface PlaceTriggerOrderParams {
117
136
  provider: string;
118
137
  address: Address;
138
+ /** Opaque provider market reference. */
119
139
  market: MarketRef;
120
140
  side: OrderSide;
121
141
  takeProfit?: TriggerOrderInput;
@@ -129,6 +149,7 @@ export interface PlaceTriggerOrderParams {
129
149
  export interface WithdrawParams {
130
150
  provider: string;
131
151
  address: Address;
152
+ /** Provider-specific withdrawal payload, including amount/destination. */
132
153
  withdrawal: WithdrawalParams;
133
154
  }
134
155
  /**
@@ -141,11 +162,13 @@ export interface WithdrawParams {
141
162
  export interface SendAssetActionParams {
142
163
  provider: string;
143
164
  address: Address;
144
- /** Canonical `Asset.id` of the asset being moved (for Hyperliquid spot
145
- * assets, the token index as a string) — never a display symbol. */
165
+ /** Canonical `Asset.id` (Hyperliquid spot uses the token index as a string); never a display symbol. */
146
166
  collateral: string;
167
+ /** Source DEX/account identifier understood by the provider. */
147
168
  sourceDex: string;
169
+ /** Destination DEX/account identifier understood by the provider. */
148
170
  destinationDex: string;
171
+ /** Transfer amount as a provider-compatible decimal wire string. */
149
172
  amount: string;
150
173
  }
151
174
  /**
@@ -156,10 +179,9 @@ export interface SendAssetActionParams {
156
179
  export interface CancelOrdersParams {
157
180
  provider: string;
158
181
  address: Address;
159
- /** Venue order ids. Venues whose ids are scoped per market (e.g. Lighter's
160
- * `order_index`) also accept the composite `"<market_id>:<order_id>"`. */
182
+ /** Venue order ids. Market-scoped venues such as Lighter also accept `"<market_id>:<order_id>"`. */
161
183
  ids: string[];
162
- /** Market context for per-market order ids; the order's `market.id`. */
184
+ /** Market context for per-market order ids; use the order's opaque `market.id`. */
163
185
  assetId?: string;
164
186
  }
165
187
  /**
@@ -170,6 +192,7 @@ export interface CancelOrdersParams {
170
192
  export interface ModifyOrdersParams {
171
193
  provider: string;
172
194
  address: Address;
195
+ /** Provider-specific order modifications. */
173
196
  modifications: ModifyOrderInput[];
174
197
  }
175
198
  /**
@@ -220,9 +243,7 @@ export interface ProviderSetup {
220
243
  * Parameters for the internal `PerpsClient.executeProviderSetup` batch submit.
221
244
  */
222
245
  export interface ExecuteProviderSetupParams {
223
- /** Provider to satisfy setup for */
224
246
  provider: string;
225
- /** User wallet address */
226
247
  address: Address;
227
248
  /** The unsatisfied setup steps from checkSetup() */
228
249
  setup: ActionStep[];
@@ -1 +1 @@
1
- {"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../../../src/types/api.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,oBAAoB,EACpB,eAAe,EACf,UAAU,EACV,qBAAqB,EACrB,SAAS,EACT,gBAAgB,EAChB,SAAS,EACT,SAAS,EACT,gBAAgB,EAChB,WAAW,EACX,iBAAiB,EACjB,gBAAgB,EACjB,MAAM,mBAAmB,CAAA;AAC1B,OAAO,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,MAAM,CAAA;AAC1D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAA;AAC9D,OAAO,KAAK,EACV,eAAe,EACf,kBAAkB,EAClB,eAAe,EAChB,MAAM,aAAa,CAAA;AACpB,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAA;AAExD;;;;GAIG;AACH,MAAM,WAAW,WAAW;IAC1B,UAAU,EAAE,MAAM,CAAA;IAClB,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,mBAAmB,CAAC,EAAE,OAAO,CAAA;IAC7B,kBAAkB,CAAC,EAAE,kBAAkB,CAAA;IACvC;;;;;;;;;;;;;OAaG;IACH,SAAS,CAAC,EAAE,mBAAmB,EAAE,GAAG,eAAe,CAAA;IACnD;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,YAAY,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,CAAA;IAC5C;;;;;;;OAOG;IACH,KAAK,CAAC,EAAE,WAAW,CAAA;IACnB;;;;OAIG;IACH,KAAK,CAAC,EAAE,OAAO,KAAK,CAAA;CACrB;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,UAAU,EAAE,MAAM,CAAA;IAClB,4EAA4E;IAC5E,MAAM,EAAE,MAAM,CAAA;IACd,kCAAkC;IAClC,MAAM,CAAC,EAAE,MAAM,CAAA;IACf;;;;OAIG;IACH,SAAS,CAAC,EAAE,mBAAmB,EAAE,GAAG,eAAe,CAAA;IACnD;;;;OAIG;IACH,WAAW,CAAC,EAAE,eAAe,CAAA;CAC9B;AAED;;;;;GAKG;AACH,MAAM,WAAW,wBAAwB;IACvC,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,OAAO,CAAA;CACjB;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,OAAO,CAAA;IAChB,MAAM,EAAE,SAAS,CAAA;IACjB,IAAI,EAAE,SAAS,CAAA;IACf,IAAI,EAAE,SAAS,CAAA;IACf,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,WAAW,CAAC,EAAE,WAAW,CAAA;IACzB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,UAAU,CAAC,EAAE,iBAAiB,CAAA;IAC9B,QAAQ,CAAC,EAAE,iBAAiB,CAAA;CAC7B;AAED;;;;;GAKG;AACH,MAAM,WAAW,uBAAuB;IACtC,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,OAAO,CAAA;IAChB,MAAM,EAAE,SAAS,CAAA;IACjB,IAAI,EAAE,SAAS,CAAA;IACf,UAAU,CAAC,EAAE,iBAAiB,CAAA;IAC9B,QAAQ,CAAC,EAAE,iBAAiB,CAAA;CAC7B;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,OAAO,CAAA;IAChB,UAAU,EAAE,gBAAgB,CAAA;CAC7B;AAED;;;;;;GAMG;AACH,MAAM,WAAW,qBAAqB;IACpC,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,OAAO,CAAA;IAChB;wEACoE;IACpE,UAAU,EAAE,MAAM,CAAA;IAClB,SAAS,EAAE,MAAM,CAAA;IACjB,cAAc,EAAE,MAAM,CAAA;IACtB,MAAM,EAAE,MAAM,CAAA;CACf;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,OAAO,CAAA;IAChB;8EAC0E;IAC1E,GAAG,EAAE,MAAM,EAAE,CAAA;IACb,wEAAwE;IACxE,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,OAAO,CAAA;IAChB,aAAa,EAAE,gBAAgB,EAAE,CAAA;CAClC;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,OAAO,CAAA;CACjB;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACnC,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,OAAO,CAAA;CACjB;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,aAAa;IAC5B;;;;;OAKG;IACH,aAAa,EAAE,OAAO,CAAA;IACtB,iEAAiE;IACjE,KAAK,EAAE,UAAU,EAAE,CAAA;IACnB,qEAAqE;IACrE,OAAO,EAAE,OAAO,CAAA;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC,oCAAoC;IACpC,QAAQ,EAAE,MAAM,CAAA;IAChB,0BAA0B;IAC1B,OAAO,EAAE,OAAO,CAAA;IAChB,oDAAoD;IACpD,KAAK,EAAE,UAAU,EAAE,CAAA;IACnB,wDAAwD;IACxD,aAAa,EAAE,gBAAgB,EAAE,CAAA;CAClC;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC,OAAO,EAAE,qBAAqB,CAAA;CAC/B;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,gBAAiB,SAAQ,eAAe;IACvD,uEAAuE;IACvE,QAAQ,EAAE,oBAAoB,EAAE,CAAA;CACjC"}
1
+ {"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../../../src/types/api.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,oBAAoB,EACpB,eAAe,EACf,UAAU,EACV,qBAAqB,EACrB,UAAU,EACV,SAAS,EACT,gBAAgB,EAChB,SAAS,EACT,SAAS,EACT,gBAAgB,EAChB,WAAW,EACX,iBAAiB,EACjB,gBAAgB,EACjB,MAAM,mBAAmB,CAAA;AAC1B,OAAO,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,MAAM,CAAA;AAC1D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAA;AAC9D,OAAO,KAAK,EACV,eAAe,EACf,kBAAkB,EAClB,eAAe,EAChB,MAAM,aAAa,CAAA;AACpB,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAA;AAExD;;;;GAIG;AACH,MAAM,WAAW,WAAW;IAC1B,4EAA4E;IAC5E,UAAU,EAAE,MAAM,CAAA;IAClB,6DAA6D;IAC7D,MAAM,EAAE,MAAM,CAAA;IACd,+DAA+D;IAC/D,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,yDAAyD;IACzD,mBAAmB,CAAC,EAAE,OAAO,CAAA;IAC7B,kEAAkE;IAClE,kBAAkB,CAAC,EAAE,kBAAkB,CAAA;IACvC;;;;;;;;;;;;;OAaG;IACH,SAAS,CAAC,EAAE,mBAAmB,EAAE,GAAG,eAAe,CAAA;IACnD;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,YAAY,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,CAAA;IAC5C;;;;;;;OAOG;IACH,KAAK,CAAC,EAAE,WAAW,CAAA;IACnB;;;;OAIG;IACH,KAAK,CAAC,EAAE,OAAO,KAAK,CAAA;CACrB;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,4EAA4E;IAC5E,UAAU,EAAE,MAAM,CAAA;IAClB,6EAA6E;IAC7E,MAAM,EAAE,MAAM,CAAA;IACd,+DAA+D;IAC/D,MAAM,CAAC,EAAE,MAAM,CAAA;IACf;;;;OAIG;IACH,SAAS,CAAC,EAAE,mBAAmB,EAAE,GAAG,eAAe,CAAA;IACnD;;;;OAIG;IACH,WAAW,CAAC,EAAE,eAAe,CAAA;CAC9B;AAED;;;;;GAKG;AACH,MAAM,WAAW,wBAAwB;IACvC,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,OAAO,CAAA;CACjB;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,OAAO,CAAA;IAChB,wCAAwC;IACxC,MAAM,EAAE,SAAS,CAAA;IACjB,IAAI,EAAE,SAAS,CAAA;IACf,IAAI,EAAE,SAAS,CAAA;IACf,gDAAgD;IAChD,IAAI,EAAE,MAAM,CAAA;IACZ,4EAA4E;IAC5E,KAAK,EAAE,MAAM,CAAA;IACb,0EAA0E;IAC1E,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB;;;;OAIG;IACH,UAAU,CAAC,EAAE,UAAU,CAAA;IACvB,8DAA8D;IAC9D,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,kEAAkE;IAClE,WAAW,CAAC,EAAE,WAAW,CAAA;IACzB,8DAA8D;IAC9D,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,UAAU,CAAC,EAAE,iBAAiB,CAAA;IAC9B,QAAQ,CAAC,EAAE,iBAAiB,CAAA;CAC7B;AAED;;;;;GAKG;AACH,MAAM,WAAW,uBAAuB;IACtC,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,OAAO,CAAA;IAChB,wCAAwC;IACxC,MAAM,EAAE,SAAS,CAAA;IACjB,IAAI,EAAE,SAAS,CAAA;IACf,UAAU,CAAC,EAAE,iBAAiB,CAAA;IAC9B,QAAQ,CAAC,EAAE,iBAAiB,CAAA;CAC7B;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,OAAO,CAAA;IAChB,0EAA0E;IAC1E,UAAU,EAAE,gBAAgB,CAAA;CAC7B;AAED;;;;;;GAMG;AACH,MAAM,WAAW,qBAAqB;IACpC,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,OAAO,CAAA;IAChB,wGAAwG;IACxG,UAAU,EAAE,MAAM,CAAA;IAClB,gEAAgE;IAChE,SAAS,EAAE,MAAM,CAAA;IACjB,qEAAqE;IACrE,cAAc,EAAE,MAAM,CAAA;IACtB,oEAAoE;IACpE,MAAM,EAAE,MAAM,CAAA;CACf;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,OAAO,CAAA;IAChB,oGAAoG;IACpG,GAAG,EAAE,MAAM,EAAE,CAAA;IACb,mFAAmF;IACnF,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,OAAO,CAAA;IAChB,6CAA6C;IAC7C,aAAa,EAAE,gBAAgB,EAAE,CAAA;CAClC;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,OAAO,CAAA;CACjB;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACnC,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,OAAO,CAAA;CACjB;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,aAAa;IAC5B;;;;;OAKG;IACH,aAAa,EAAE,OAAO,CAAA;IACtB,iEAAiE;IACjE,KAAK,EAAE,UAAU,EAAE,CAAA;IACnB,qEAAqE;IACrE,OAAO,EAAE,OAAO,CAAA;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,OAAO,CAAA;IAChB,oDAAoD;IACpD,KAAK,EAAE,UAAU,EAAE,CAAA;IACnB,wDAAwD;IACxD,aAAa,EAAE,gBAAgB,EAAE,CAAA;CAClC;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC,OAAO,EAAE,qBAAqB,CAAA;CAC/B;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,gBAAiB,SAAQ,eAAe;IACvD,uEAAuE;IACvE,QAAQ,EAAE,oBAAoB,EAAE,CAAA;CACjC"}
@@ -25,6 +25,7 @@ export type SwitchChainHook = (chainId: number) => Promise<PerpsClientSigner | u
25
25
  * @public
26
26
  */
27
27
  export interface ProviderConfig {
28
+ /** Optional provider category/market ids used to filter WS subscriptions. */
28
29
  markets?: string[];
29
30
  }
30
31
  /**
@@ -52,6 +53,7 @@ export type RequestInterceptor = (url: string, options: RequestInit) => RequestI
52
53
  * @public
53
54
  */
54
55
  export interface SDKRequestOptions {
56
+ /** Abort the request and any pending backoff delay. */
55
57
  signal?: AbortSignal;
56
58
  /**
57
59
  * Lighter auth token consumed by provider-direct venue reads (getOrders,
@@ -72,13 +74,21 @@ export interface SDKRequestOptions {
72
74
  * @public
73
75
  */
74
76
  export interface PerpsBaseConfig {
77
+ /** Integrator identifier sent in the `x-lifi-integrator` header. */
75
78
  integrator: string;
79
+ /** API key applied to backend requests when non-empty. */
76
80
  apiKey: string;
81
+ /** Resolved perps API base URL. */
77
82
  apiUrl: string;
83
+ /** Whether SDK version compatibility checks are disabled. */
78
84
  disableVersionCheck?: boolean;
85
+ /** Optional outgoing-request URL/options interceptor. */
79
86
  requestInterceptor?: RequestInterceptor;
87
+ /** Optional per-provider WS market filters. */
80
88
  providers?: ProviderConfigs;
89
+ /** Optional global or per-provider retry configuration. */
81
90
  retry?: RetryConfig;
91
+ /** Fetch implementation used by core HTTP transport. */
82
92
  fetch?: typeof fetch;
83
93
  }
84
94
  //# sourceMappingURL=config.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../../src/types/config.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,MAAM,CAAA;AACjD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAA;AAE9D;;;;;GAKG;AACH,MAAM,MAAM,iBAAiB,GAAG,YAAY,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,CAAA;AAE/D;;;;;;;;;GASG;AACH,MAAM,MAAM,eAAe,GAAG,CAC5B,OAAO,EAAE,MAAM,KACZ,OAAO,CAAC,iBAAiB,GAAG,SAAS,CAAC,CAAA;AAE3C;;;;;GAKG;AACH,MAAM,WAAW,cAAc;IAC7B,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;CACnB;AAED;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG,cAAc,CAAA;AAE9C;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC9B,CAAC,QAAQ,EAAE,MAAM,GAAG,cAAc,GAAG,SAAS,CAAA;CAC/C;AAED;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG,CAC/B,GAAG,EAAE,MAAM,EACX,OAAO,EAAE,WAAW,KACjB,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC,CAAA;AAEvC;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC,MAAM,CAAC,EAAE,WAAW,CAAA;IACpB;;;;;;;;;OASG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;CAC1B;AAED;;;;;GAKG;AACH,MAAM,WAAW,eAAe;IAC9B,UAAU,EAAE,MAAM,CAAA;IAClB,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,MAAM,CAAA;IACd,mBAAmB,CAAC,EAAE,OAAO,CAAA;IAC7B,kBAAkB,CAAC,EAAE,kBAAkB,CAAA;IACvC,SAAS,CAAC,EAAE,eAAe,CAAA;IAC3B,KAAK,CAAC,EAAE,WAAW,CAAA;IACnB,KAAK,CAAC,EAAE,OAAO,KAAK,CAAA;CACrB"}
1
+ {"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../../src/types/config.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,MAAM,CAAA;AACjD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAA;AAE9D;;;;;GAKG;AACH,MAAM,MAAM,iBAAiB,GAAG,YAAY,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,CAAA;AAE/D;;;;;;;;;GASG;AACH,MAAM,MAAM,eAAe,GAAG,CAC5B,OAAO,EAAE,MAAM,KACZ,OAAO,CAAC,iBAAiB,GAAG,SAAS,CAAC,CAAA;AAE3C;;;;;GAKG;AACH,MAAM,WAAW,cAAc;IAC7B,6EAA6E;IAC7E,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;CACnB;AAED;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG,cAAc,CAAA;AAE9C;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC9B,CAAC,QAAQ,EAAE,MAAM,GAAG,cAAc,GAAG,SAAS,CAAA;CAC/C;AAED;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG,CAC/B,GAAG,EAAE,MAAM,EACX,OAAO,EAAE,WAAW,KACjB,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC,CAAA;AAEvC;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC,uDAAuD;IACvD,MAAM,CAAC,EAAE,WAAW,CAAA;IACpB;;;;;;;;;OASG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;CAC1B;AAED;;;;;GAKG;AACH,MAAM,WAAW,eAAe;IAC9B,oEAAoE;IACpE,UAAU,EAAE,MAAM,CAAA;IAClB,0DAA0D;IAC1D,MAAM,EAAE,MAAM,CAAA;IACd,mCAAmC;IACnC,MAAM,EAAE,MAAM,CAAA;IACd,6DAA6D;IAC7D,mBAAmB,CAAC,EAAE,OAAO,CAAA;IAC7B,yDAAyD;IACzD,kBAAkB,CAAC,EAAE,kBAAkB,CAAA;IACvC,+CAA+C;IAC/C,SAAS,CAAC,EAAE,eAAe,CAAA;IAC3B,2DAA2D;IAC3D,KAAK,CAAC,EAAE,WAAW,CAAA;IACnB,wDAAwD;IACxD,KAAK,CAAC,EAAE,OAAO,KAAK,CAAA;CACrB"}
@@ -8,9 +8,11 @@ import type { Address } from 'viem';
8
8
  * @public
9
9
  */
10
10
  export interface DeclaredDepositAsset {
11
+ /** EVM chain id on which the asset is held or broadcast. */
11
12
  chainId: number;
12
- /** EIP-55 checksummed address; the zero address denotes the chain's native gas token. */
13
+ /** EIP-55 checksummed address; the zero address denotes native gas. */
13
14
  address: Address;
15
+ /** Decimal places used by the token; native gas assets use 18. */
14
16
  decimals: number;
15
17
  }
16
18
  /**
@@ -23,6 +25,7 @@ export interface DeclaredDepositAsset {
23
25
  */
24
26
  export interface DepositFlowLifiSwap {
25
27
  kind: 'lifiSwap';
28
+ /** Destination collateral token and its full chain identity. */
26
29
  destination: DeclaredDepositAsset;
27
30
  /**
28
31
  * Credited address when it is not the user's own — a venue-provisioned
@@ -40,10 +43,13 @@ export interface DepositFlowLifiSwap {
40
43
  */
41
44
  export interface DepositFlowFirstDepositPipeline {
42
45
  kind: 'firstDepositPipeline';
43
- /** Chain the deposit legs broadcast on; the user's wallet must be switched to it. */
46
+ /** Chain on which the deposit legs broadcast; the wallet must be switched here. */
44
47
  chainId: number;
48
+ /** Native gas asset needed to broadcast the deposit legs. */
45
49
  gasAsset: DeclaredDepositAsset;
50
+ /** Collateral asset credited by the first deposit. */
46
51
  collateral: DeclaredDepositAsset;
52
+ /** Action type used to stage the deposit pipeline. */
47
53
  bridgeAction: ActionType.DEPOSIT;
48
54
  }
49
55
  /**
@@ -55,7 +61,7 @@ export interface DepositFlowFirstDepositPipeline {
55
61
  */
56
62
  export interface DepositFlowSetupRequired {
57
63
  kind: 'setupRequired';
58
- /** Outstanding `Provider.setup` action types, in the order they must be run. */
64
+ /** Setup action types that must be completed, in execution order. */
59
65
  setup: ActionType[];
60
66
  }
61
67
  /**