@katanaperps/katana-perps-sdk 0.0.0-placeholder

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 (428) hide show
  1. package/.nvmrc +1 -0
  2. package/LICENSE +21 -0
  3. package/README.md +90 -0
  4. package/dist/abis/ERC20.json +288 -0
  5. package/dist/abis/EarningsEscrow.json +468 -0
  6. package/dist/abis/Exchange_v1.json +3644 -0
  7. package/dist/abis/IOFT.json +447 -0
  8. package/dist/bridge/config.d.ts +262 -0
  9. package/dist/bridge/config.d.ts.map +1 -0
  10. package/dist/bridge/config.js +221 -0
  11. package/dist/bridge/deposit.d.ts +107 -0
  12. package/dist/bridge/deposit.d.ts.map +1 -0
  13. package/dist/bridge/deposit.js +284 -0
  14. package/dist/bridge/index.d.ts +5 -0
  15. package/dist/bridge/index.d.ts.map +1 -0
  16. package/dist/bridge/index.js +7 -0
  17. package/dist/bridge/utils.d.ts +140 -0
  18. package/dist/bridge/utils.d.ts.map +1 -0
  19. package/dist/bridge/utils.js +66 -0
  20. package/dist/bridge/withdraw.d.ts +42 -0
  21. package/dist/bridge/withdraw.d.ts.map +1 -0
  22. package/dist/bridge/withdraw.js +86 -0
  23. package/dist/client/index.d.ts +4 -0
  24. package/dist/client/index.d.ts.map +1 -0
  25. package/dist/client/index.js +6 -0
  26. package/dist/client/orderBook/index.d.ts +2 -0
  27. package/dist/client/orderBook/index.d.ts.map +1 -0
  28. package/dist/client/orderBook/index.js +4 -0
  29. package/dist/client/orderBook/realTime.d.ts +180 -0
  30. package/dist/client/orderBook/realTime.d.ts.map +1 -0
  31. package/dist/client/orderBook/realTime.js +344 -0
  32. package/dist/client/orderBook/utils.d.ts +15 -0
  33. package/dist/client/orderBook/utils.d.ts.map +1 -0
  34. package/dist/client/orderBook/utils.js +77 -0
  35. package/dist/client/rest/authenticated.d.ts +1199 -0
  36. package/dist/client/rest/authenticated.d.ts.map +1 -0
  37. package/dist/client/rest/authenticated.js +1311 -0
  38. package/dist/client/rest/index.d.ts +3 -0
  39. package/dist/client/rest/index.d.ts.map +1 -0
  40. package/dist/client/rest/index.js +5 -0
  41. package/dist/client/rest/public.d.ts +436 -0
  42. package/dist/client/rest/public.d.ts.map +1 -0
  43. package/dist/client/rest/public.js +502 -0
  44. package/dist/client/webSocket/guards.d.ts +15 -0
  45. package/dist/client/webSocket/guards.d.ts.map +1 -0
  46. package/dist/client/webSocket/guards.js +37 -0
  47. package/dist/client/webSocket/index.d.ts +632 -0
  48. package/dist/client/webSocket/index.d.ts.map +1 -0
  49. package/dist/client/webSocket/index.js +1048 -0
  50. package/dist/client/webSocket/transform.d.ts +3 -0
  51. package/dist/client/webSocket/transform.d.ts.map +1 -0
  52. package/dist/client/webSocket/transform.js +244 -0
  53. package/dist/constants.d.ts +34 -0
  54. package/dist/constants.d.ts.map +1 -0
  55. package/dist/constants.js +38 -0
  56. package/dist/index.d.ts +9 -0
  57. package/dist/index.d.ts.map +1 -0
  58. package/dist/index.js +14 -0
  59. package/dist/orderbook/apiConversions.d.ts +8 -0
  60. package/dist/orderbook/apiConversions.d.ts.map +1 -0
  61. package/dist/orderbook/apiConversions.js +100 -0
  62. package/dist/orderbook/demo.d.ts +2 -0
  63. package/dist/orderbook/demo.d.ts.map +1 -0
  64. package/dist/orderbook/demo.js +68 -0
  65. package/dist/orderbook/index.d.ts +3 -0
  66. package/dist/orderbook/index.d.ts.map +1 -0
  67. package/dist/orderbook/index.js +5 -0
  68. package/dist/orderbook/quantities.d.ts +112 -0
  69. package/dist/orderbook/quantities.d.ts.map +1 -0
  70. package/dist/orderbook/quantities.js +257 -0
  71. package/dist/orderbook/utils.d.ts +8 -0
  72. package/dist/orderbook/utils.d.ts.map +1 -0
  73. package/dist/orderbook/utils.js +28 -0
  74. package/dist/pipmath.d.ts +21 -0
  75. package/dist/pipmath.d.ts.map +1 -0
  76. package/dist/pipmath.js +110 -0
  77. package/dist/signatures.d.ts +37 -0
  78. package/dist/signatures.d.ts.map +1 -0
  79. package/dist/signatures.js +450 -0
  80. package/dist/tests/orderbook/quantities/calculateInitialMarginFractionWithOverride.test.d.ts +2 -0
  81. package/dist/tests/orderbook/quantities/calculateInitialMarginFractionWithOverride.test.d.ts.map +1 -0
  82. package/dist/tests/orderbook/quantities/calculateInitialMarginFractionWithOverride.test.js +49 -0
  83. package/dist/tests/orderbook/quantities/calculateMaximumInitialMarginFractionOverride.test.d.ts +2 -0
  84. package/dist/tests/orderbook/quantities/calculateMaximumInitialMarginFractionOverride.test.d.ts.map +1 -0
  85. package/dist/tests/orderbook/quantities/calculateMaximumInitialMarginFractionOverride.test.js +122 -0
  86. package/dist/tests/orderbook/quantities/determineMaximumReduceOnlyQuantityAvailableAtPriceLevel.test.d.ts +2 -0
  87. package/dist/tests/orderbook/quantities/determineMaximumReduceOnlyQuantityAvailableAtPriceLevel.test.d.ts.map +1 -0
  88. package/dist/tests/orderbook/quantities/determineMaximumReduceOnlyQuantityAvailableAtPriceLevel.test.js +138 -0
  89. package/dist/tests/orderbook/quantities.test.d.ts +2 -0
  90. package/dist/tests/orderbook/quantities.test.d.ts.map +1 -0
  91. package/dist/tests/orderbook/quantities.test.js +310 -0
  92. package/dist/tests/testHelpers.d.ts +2 -0
  93. package/dist/tests/testHelpers.d.ts.map +1 -0
  94. package/dist/tests/testHelpers.js +16 -0
  95. package/dist/tests/utils/deriveBaseURL.test.d.ts +2 -0
  96. package/dist/tests/utils/deriveBaseURL.test.d.ts.map +1 -0
  97. package/dist/tests/utils/deriveBaseURL.test.js +46 -0
  98. package/dist/typechain-types/ERC20.d.ts +170 -0
  99. package/dist/typechain-types/ERC20.d.ts.map +1 -0
  100. package/dist/typechain-types/ERC20.js +2 -0
  101. package/dist/typechain-types/EarningsEscrow.d.ts +210 -0
  102. package/dist/typechain-types/EarningsEscrow.d.ts.map +1 -0
  103. package/dist/typechain-types/EarningsEscrow.js +2 -0
  104. package/dist/typechain-types/ExchangeLayerZeroAdapter.d.ts +253 -0
  105. package/dist/typechain-types/ExchangeLayerZeroAdapter.d.ts.map +1 -0
  106. package/dist/typechain-types/ExchangeLayerZeroAdapter.js +2 -0
  107. package/dist/typechain-types/ExchangeLayerZeroAdapter_v2.d.ts +338 -0
  108. package/dist/typechain-types/ExchangeLayerZeroAdapter_v2.d.ts.map +1 -0
  109. package/dist/typechain-types/ExchangeLayerZeroAdapter_v2.js +2 -0
  110. package/dist/typechain-types/ExchangeLayerZeroAdapter_v3.d.ts +413 -0
  111. package/dist/typechain-types/ExchangeLayerZeroAdapter_v3.d.ts.map +1 -0
  112. package/dist/typechain-types/ExchangeLayerZeroAdapter_v3.js +2 -0
  113. package/dist/typechain-types/Exchange_v1.d.ts +2172 -0
  114. package/dist/typechain-types/Exchange_v1.d.ts.map +1 -0
  115. package/dist/typechain-types/Exchange_v1.js +2 -0
  116. package/dist/typechain-types/Exchange_v2.d.ts +2148 -0
  117. package/dist/typechain-types/Exchange_v2.d.ts.map +1 -0
  118. package/dist/typechain-types/Exchange_v2.js +2 -0
  119. package/dist/typechain-types/FixedIncomeVaultProviderStateAggregator_v1.d.ts +148 -0
  120. package/dist/typechain-types/FixedIncomeVaultProviderStateAggregator_v1.d.ts.map +1 -0
  121. package/dist/typechain-types/FixedIncomeVaultProviderStateAggregator_v1.js +2 -0
  122. package/dist/typechain-types/FixedIncomeVaultProvider_v1.d.ts +1204 -0
  123. package/dist/typechain-types/FixedIncomeVaultProvider_v1.d.ts.map +1 -0
  124. package/dist/typechain-types/FixedIncomeVaultProvider_v1.js +2 -0
  125. package/dist/typechain-types/IOFT.d.ts +247 -0
  126. package/dist/typechain-types/IOFT.d.ts.map +1 -0
  127. package/dist/typechain-types/IOFT.js +2 -0
  128. package/dist/typechain-types/IRewardVault.d.ts +649 -0
  129. package/dist/typechain-types/IRewardVault.d.ts.map +1 -0
  130. package/dist/typechain-types/IRewardVault.js +2 -0
  131. package/dist/typechain-types/KumaOFTAdapterUSDC.d.ts +638 -0
  132. package/dist/typechain-types/KumaOFTAdapterUSDC.d.ts.map +1 -0
  133. package/dist/typechain-types/KumaOFTAdapterUSDC.js +2 -0
  134. package/dist/typechain-types/KumaOFTUSDC.d.ts +756 -0
  135. package/dist/typechain-types/KumaOFTUSDC.d.ts.map +1 -0
  136. package/dist/typechain-types/KumaOFTUSDC.js +2 -0
  137. package/dist/typechain-types/KumaStargateForwarder_v1.d.ts +252 -0
  138. package/dist/typechain-types/KumaStargateForwarder_v1.d.ts.map +1 -0
  139. package/dist/typechain-types/KumaStargateForwarder_v1.js +2 -0
  140. package/dist/typechain-types/KumaStargateForwarder_v2.d.ts +252 -0
  141. package/dist/typechain-types/KumaStargateForwarder_v2.d.ts.map +1 -0
  142. package/dist/typechain-types/KumaStargateForwarder_v2.js +2 -0
  143. package/dist/typechain-types/ProfitShareVaultProvider_v1.d.ts +1095 -0
  144. package/dist/typechain-types/ProfitShareVaultProvider_v1.d.ts.map +1 -0
  145. package/dist/typechain-types/ProfitShareVaultProvider_v1.js +2 -0
  146. package/dist/typechain-types/StargatePoolUSDC.d.ts +956 -0
  147. package/dist/typechain-types/StargatePoolUSDC.d.ts.map +1 -0
  148. package/dist/typechain-types/StargatePoolUSDC.js +2 -0
  149. package/dist/typechain-types/common.d.ts +51 -0
  150. package/dist/typechain-types/common.d.ts.map +1 -0
  151. package/dist/typechain-types/common.js +2 -0
  152. package/dist/typechain-types/factories/ERC20__factory.d.ts +226 -0
  153. package/dist/typechain-types/factories/ERC20__factory.d.ts.map +1 -0
  154. package/dist/typechain-types/factories/ERC20__factory.js +305 -0
  155. package/dist/typechain-types/factories/EarningsEscrow__factory.d.ts +370 -0
  156. package/dist/typechain-types/factories/EarningsEscrow__factory.d.ts.map +1 -0
  157. package/dist/typechain-types/factories/EarningsEscrow__factory.js +485 -0
  158. package/dist/typechain-types/factories/ExchangeLayerZeroAdapter__factory.d.ts +359 -0
  159. package/dist/typechain-types/factories/ExchangeLayerZeroAdapter__factory.d.ts.map +1 -0
  160. package/dist/typechain-types/factories/ExchangeLayerZeroAdapter__factory.js +471 -0
  161. package/dist/typechain-types/factories/ExchangeLayerZeroAdapter_v2__factory.d.ts +419 -0
  162. package/dist/typechain-types/factories/ExchangeLayerZeroAdapter_v2__factory.d.ts.map +1 -0
  163. package/dist/typechain-types/factories/ExchangeLayerZeroAdapter_v2__factory.js +545 -0
  164. package/dist/typechain-types/factories/ExchangeLayerZeroAdapter_v3__factory.d.ts +546 -0
  165. package/dist/typechain-types/factories/ExchangeLayerZeroAdapter_v3__factory.d.ts.map +1 -0
  166. package/dist/typechain-types/factories/ExchangeLayerZeroAdapter_v3__factory.js +710 -0
  167. package/dist/typechain-types/factories/Exchange_v1__factory.d.ts +2852 -0
  168. package/dist/typechain-types/factories/Exchange_v1__factory.d.ts.map +1 -0
  169. package/dist/typechain-types/factories/Exchange_v1__factory.js +3661 -0
  170. package/dist/typechain-types/factories/Exchange_v2__factory.d.ts +2832 -0
  171. package/dist/typechain-types/factories/Exchange_v2__factory.d.ts.map +1 -0
  172. package/dist/typechain-types/factories/Exchange_v2__factory.js +3636 -0
  173. package/dist/typechain-types/factories/FixedIncomeVaultProviderStateAggregator_v1__factory.d.ts +180 -0
  174. package/dist/typechain-types/factories/FixedIncomeVaultProviderStateAggregator_v1__factory.d.ts.map +1 -0
  175. package/dist/typechain-types/factories/FixedIncomeVaultProviderStateAggregator_v1__factory.js +246 -0
  176. package/dist/typechain-types/factories/FixedIncomeVaultProvider_v1__factory.d.ts +2092 -0
  177. package/dist/typechain-types/factories/FixedIncomeVaultProvider_v1__factory.d.ts.map +1 -0
  178. package/dist/typechain-types/factories/FixedIncomeVaultProvider_v1__factory.js +2702 -0
  179. package/dist/typechain-types/factories/IOFT__factory.d.ts +352 -0
  180. package/dist/typechain-types/factories/IOFT__factory.d.ts.map +1 -0
  181. package/dist/typechain-types/factories/IOFT__factory.js +464 -0
  182. package/dist/typechain-types/factories/IRewardVault__factory.d.ts +1019 -0
  183. package/dist/typechain-types/factories/IRewardVault__factory.d.ts.map +1 -0
  184. package/dist/typechain-types/factories/IRewardVault__factory.js +1311 -0
  185. package/dist/typechain-types/factories/KumaOFTAdapterUSDC__factory.d.ts +996 -0
  186. package/dist/typechain-types/factories/KumaOFTAdapterUSDC__factory.d.ts.map +1 -0
  187. package/dist/typechain-types/factories/KumaOFTAdapterUSDC__factory.js +1306 -0
  188. package/dist/typechain-types/factories/KumaOFTUSDC__factory.d.ts +1234 -0
  189. package/dist/typechain-types/factories/KumaOFTUSDC__factory.d.ts.map +1 -0
  190. package/dist/typechain-types/factories/KumaOFTUSDC__factory.js +1619 -0
  191. package/dist/typechain-types/factories/KumaStargateForwarder_v1__factory.d.ts +354 -0
  192. package/dist/typechain-types/factories/KumaStargateForwarder_v1__factory.d.ts.map +1 -0
  193. package/dist/typechain-types/factories/KumaStargateForwarder_v1__factory.js +464 -0
  194. package/dist/typechain-types/factories/KumaStargateForwarder_v2__factory.d.ts +370 -0
  195. package/dist/typechain-types/factories/KumaStargateForwarder_v2__factory.d.ts.map +1 -0
  196. package/dist/typechain-types/factories/KumaStargateForwarder_v2__factory.js +486 -0
  197. package/dist/typechain-types/factories/ProfitShareVaultProvider_v1__factory.d.ts +1914 -0
  198. package/dist/typechain-types/factories/ProfitShareVaultProvider_v1__factory.d.ts.map +1 -0
  199. package/dist/typechain-types/factories/ProfitShareVaultProvider_v1__factory.js +2475 -0
  200. package/dist/typechain-types/factories/StargatePoolUSDC__factory.d.ts +1557 -0
  201. package/dist/typechain-types/factories/StargatePoolUSDC__factory.d.ts.map +1 -0
  202. package/dist/typechain-types/factories/StargatePoolUSDC__factory.js +2019 -0
  203. package/dist/typechain-types/factories/index.d.ts +5 -0
  204. package/dist/typechain-types/factories/index.d.ts.map +1 -0
  205. package/dist/typechain-types/factories/index.js +13 -0
  206. package/dist/typechain-types/index.d.ts +10 -0
  207. package/dist/typechain-types/index.d.ts.map +1 -0
  208. package/dist/typechain-types/index.js +15 -0
  209. package/dist/types/delegatedKeys.d.ts +44 -0
  210. package/dist/types/delegatedKeys.d.ts.map +1 -0
  211. package/dist/types/delegatedKeys.js +2 -0
  212. package/dist/types/enums/index.d.ts +4 -0
  213. package/dist/types/enums/index.d.ts.map +1 -0
  214. package/dist/types/enums/index.js +6 -0
  215. package/dist/types/enums/request.d.ts +980 -0
  216. package/dist/types/enums/request.d.ts.map +1 -0
  217. package/dist/types/enums/request.js +906 -0
  218. package/dist/types/enums/response.d.ts +329 -0
  219. package/dist/types/enums/response.d.ts.map +1 -0
  220. package/dist/types/enums/response.js +296 -0
  221. package/dist/types/enums/signature.d.ts +118 -0
  222. package/dist/types/enums/signature.d.ts.map +1 -0
  223. package/dist/types/enums/signature.js +131 -0
  224. package/dist/types/errors.d.ts +5 -0
  225. package/dist/types/errors.d.ts.map +1 -0
  226. package/dist/types/errors.js +2 -0
  227. package/dist/types/index.d.ts +9 -0
  228. package/dist/types/index.d.ts.map +1 -0
  229. package/dist/types/index.js +10 -0
  230. package/dist/types/orderBook.d.ts +72 -0
  231. package/dist/types/orderBook.d.ts.map +1 -0
  232. package/dist/types/orderBook.js +2 -0
  233. package/dist/types/rest/common/common.d.ts +118 -0
  234. package/dist/types/rest/common/common.d.ts.map +1 -0
  235. package/dist/types/rest/common/common.js +2 -0
  236. package/dist/types/rest/common/guards.d.ts +8 -0
  237. package/dist/types/rest/common/guards.d.ts.map +1 -0
  238. package/dist/types/rest/common/guards.js +14 -0
  239. package/dist/types/rest/endpoints/AssociateWallet.d.ts +40 -0
  240. package/dist/types/rest/endpoints/AssociateWallet.d.ts.map +1 -0
  241. package/dist/types/rest/endpoints/AssociateWallet.js +2 -0
  242. package/dist/types/rest/endpoints/CancelOrders.d.ts +134 -0
  243. package/dist/types/rest/endpoints/CancelOrders.d.ts.map +1 -0
  244. package/dist/types/rest/endpoints/CancelOrders.js +2 -0
  245. package/dist/types/rest/endpoints/CreateOrder.d.ts +401 -0
  246. package/dist/types/rest/endpoints/CreateOrder.d.ts.map +1 -0
  247. package/dist/types/rest/endpoints/CreateOrder.js +2 -0
  248. package/dist/types/rest/endpoints/GetAuthenticationToken.d.ts +39 -0
  249. package/dist/types/rest/endpoints/GetAuthenticationToken.d.ts.map +1 -0
  250. package/dist/types/rest/endpoints/GetAuthenticationToken.js +2 -0
  251. package/dist/types/rest/endpoints/GetCandles.d.ts +115 -0
  252. package/dist/types/rest/endpoints/GetCandles.d.ts.map +1 -0
  253. package/dist/types/rest/endpoints/GetCandles.js +2 -0
  254. package/dist/types/rest/endpoints/GetDeposits.d.ts +109 -0
  255. package/dist/types/rest/endpoints/GetDeposits.d.ts.map +1 -0
  256. package/dist/types/rest/endpoints/GetDeposits.js +2 -0
  257. package/dist/types/rest/endpoints/GetExchange.d.ts +78 -0
  258. package/dist/types/rest/endpoints/GetExchange.d.ts.map +1 -0
  259. package/dist/types/rest/endpoints/GetExchange.js +9 -0
  260. package/dist/types/rest/endpoints/GetFills.d.ts +178 -0
  261. package/dist/types/rest/endpoints/GetFills.d.ts.map +1 -0
  262. package/dist/types/rest/endpoints/GetFills.js +2 -0
  263. package/dist/types/rest/endpoints/GetFundingPayments.d.ts +52 -0
  264. package/dist/types/rest/endpoints/GetFundingPayments.d.ts.map +1 -0
  265. package/dist/types/rest/endpoints/GetFundingPayments.js +2 -0
  266. package/dist/types/rest/endpoints/GetFundingRates.d.ts +34 -0
  267. package/dist/types/rest/endpoints/GetFundingRates.d.ts.map +1 -0
  268. package/dist/types/rest/endpoints/GetFundingRates.js +2 -0
  269. package/dist/types/rest/endpoints/GetGasFees.d.ts +23 -0
  270. package/dist/types/rest/endpoints/GetGasFees.d.ts.map +1 -0
  271. package/dist/types/rest/endpoints/GetGasFees.js +2 -0
  272. package/dist/types/rest/endpoints/GetHistoricalPnL.d.ts +39 -0
  273. package/dist/types/rest/endpoints/GetHistoricalPnL.d.ts.map +1 -0
  274. package/dist/types/rest/endpoints/GetHistoricalPnL.js +2 -0
  275. package/dist/types/rest/endpoints/GetInitialMarginFractionOverride.d.ts +31 -0
  276. package/dist/types/rest/endpoints/GetInitialMarginFractionOverride.d.ts.map +1 -0
  277. package/dist/types/rest/endpoints/GetInitialMarginFractionOverride.js +2 -0
  278. package/dist/types/rest/endpoints/GetLiquidations.d.ts +52 -0
  279. package/dist/types/rest/endpoints/GetLiquidations.d.ts.map +1 -0
  280. package/dist/types/rest/endpoints/GetLiquidations.js +2 -0
  281. package/dist/types/rest/endpoints/GetMarketMakerRewardsEpochs.d.ts +534 -0
  282. package/dist/types/rest/endpoints/GetMarketMakerRewardsEpochs.d.ts.map +1 -0
  283. package/dist/types/rest/endpoints/GetMarketMakerRewardsEpochs.js +2 -0
  284. package/dist/types/rest/endpoints/GetMarkets.d.ts +161 -0
  285. package/dist/types/rest/endpoints/GetMarkets.d.ts.map +1 -0
  286. package/dist/types/rest/endpoints/GetMarkets.js +2 -0
  287. package/dist/types/rest/endpoints/GetOrderBook.d.ts +176 -0
  288. package/dist/types/rest/endpoints/GetOrderBook.d.ts.map +1 -0
  289. package/dist/types/rest/endpoints/GetOrderBook.js +2 -0
  290. package/dist/types/rest/endpoints/GetOrders.d.ts +188 -0
  291. package/dist/types/rest/endpoints/GetOrders.d.ts.map +1 -0
  292. package/dist/types/rest/endpoints/GetOrders.js +2 -0
  293. package/dist/types/rest/endpoints/GetPing.d.ts +8 -0
  294. package/dist/types/rest/endpoints/GetPing.d.ts.map +1 -0
  295. package/dist/types/rest/endpoints/GetPing.js +2 -0
  296. package/dist/types/rest/endpoints/GetPositions.d.ts +104 -0
  297. package/dist/types/rest/endpoints/GetPositions.d.ts.map +1 -0
  298. package/dist/types/rest/endpoints/GetPositions.js +2 -0
  299. package/dist/types/rest/endpoints/GetTickers.d.ts +129 -0
  300. package/dist/types/rest/endpoints/GetTickers.d.ts.map +1 -0
  301. package/dist/types/rest/endpoints/GetTickers.js +2 -0
  302. package/dist/types/rest/endpoints/GetTime.d.ts +14 -0
  303. package/dist/types/rest/endpoints/GetTime.d.ts.map +1 -0
  304. package/dist/types/rest/endpoints/GetTime.js +2 -0
  305. package/dist/types/rest/endpoints/GetTrades.d.ts +62 -0
  306. package/dist/types/rest/endpoints/GetTrades.d.ts.map +1 -0
  307. package/dist/types/rest/endpoints/GetTrades.js +2 -0
  308. package/dist/types/rest/endpoints/GetWallets.d.ts +121 -0
  309. package/dist/types/rest/endpoints/GetWallets.d.ts.map +1 -0
  310. package/dist/types/rest/endpoints/GetWallets.js +2 -0
  311. package/dist/types/rest/endpoints/GetWithdrawals.d.ts +98 -0
  312. package/dist/types/rest/endpoints/GetWithdrawals.d.ts.map +1 -0
  313. package/dist/types/rest/endpoints/GetWithdrawals.js +2 -0
  314. package/dist/types/rest/endpoints/GetWithdrawalsFromManagedAccount.d.ts +98 -0
  315. package/dist/types/rest/endpoints/GetWithdrawalsFromManagedAccount.d.ts.map +1 -0
  316. package/dist/types/rest/endpoints/GetWithdrawalsFromManagedAccount.js +2 -0
  317. package/dist/types/rest/endpoints/Payouts.d.ts +199 -0
  318. package/dist/types/rest/endpoints/Payouts.d.ts.map +1 -0
  319. package/dist/types/rest/endpoints/Payouts.js +2 -0
  320. package/dist/types/rest/endpoints/SetInitialMarginFractionOverride.d.ts +83 -0
  321. package/dist/types/rest/endpoints/SetInitialMarginFractionOverride.d.ts.map +1 -0
  322. package/dist/types/rest/endpoints/SetInitialMarginFractionOverride.js +2 -0
  323. package/dist/types/rest/endpoints/WithdrawFunds.d.ts +144 -0
  324. package/dist/types/rest/endpoints/WithdrawFunds.d.ts.map +1 -0
  325. package/dist/types/rest/endpoints/WithdrawFunds.js +2 -0
  326. package/dist/types/rest/endpoints/WithdrawFundsFromManagedAccountByQuantity.d.ts +161 -0
  327. package/dist/types/rest/endpoints/WithdrawFundsFromManagedAccountByQuantity.d.ts.map +1 -0
  328. package/dist/types/rest/endpoints/WithdrawFundsFromManagedAccountByQuantity.js +2 -0
  329. package/dist/types/rest/endpoints/WithdrawFundsFromManagedAccountByShares.d.ts +160 -0
  330. package/dist/types/rest/endpoints/WithdrawFundsFromManagedAccountByShares.d.ts.map +1 -0
  331. package/dist/types/rest/endpoints/WithdrawFundsFromManagedAccountByShares.js +2 -0
  332. package/dist/types/rest/endpoints/index.d.ts +33 -0
  333. package/dist/types/rest/endpoints/index.d.ts.map +1 -0
  334. package/dist/types/rest/endpoints/index.js +35 -0
  335. package/dist/types/rest/endpoints/internal.d.ts +329 -0
  336. package/dist/types/rest/endpoints/internal.d.ts.map +1 -0
  337. package/dist/types/rest/endpoints/internal.js +14 -0
  338. package/dist/types/rest/index.d.ts +4 -0
  339. package/dist/types/rest/index.d.ts.map +1 -0
  340. package/dist/types/rest/index.js +6 -0
  341. package/dist/types/swaps.d.ts +11 -0
  342. package/dist/types/swaps.d.ts.map +1 -0
  343. package/dist/types/swaps.js +2 -0
  344. package/dist/types/utils.d.ts +67 -0
  345. package/dist/types/utils.d.ts.map +1 -0
  346. package/dist/types/utils.js +3 -0
  347. package/dist/types/webSocket/base.d.ts +83 -0
  348. package/dist/types/webSocket/base.d.ts.map +1 -0
  349. package/dist/types/webSocket/base.js +2 -0
  350. package/dist/types/webSocket/constants.d.ts +41 -0
  351. package/dist/types/webSocket/constants.d.ts.map +1 -0
  352. package/dist/types/webSocket/constants.js +54 -0
  353. package/dist/types/webSocket/index.d.ts +6 -0
  354. package/dist/types/webSocket/index.d.ts.map +1 -0
  355. package/dist/types/webSocket/index.js +8 -0
  356. package/dist/types/webSocket/options.d.ts +276 -0
  357. package/dist/types/webSocket/options.d.ts.map +1 -0
  358. package/dist/types/webSocket/options.js +2 -0
  359. package/dist/types/webSocket/request/index.d.ts +3 -0
  360. package/dist/types/webSocket/request/index.d.ts.map +1 -0
  361. package/dist/types/webSocket/request/index.js +5 -0
  362. package/dist/types/webSocket/request/request.d.ts +137 -0
  363. package/dist/types/webSocket/request/request.d.ts.map +1 -0
  364. package/dist/types/webSocket/request/request.js +2 -0
  365. package/dist/types/webSocket/request/subscriptions.d.ts +498 -0
  366. package/dist/types/webSocket/request/subscriptions.d.ts.map +1 -0
  367. package/dist/types/webSocket/request/subscriptions.js +2 -0
  368. package/dist/types/webSocket/response/candles.d.ts +138 -0
  369. package/dist/types/webSocket/response/candles.d.ts.map +1 -0
  370. package/dist/types/webSocket/response/candles.js +2 -0
  371. package/dist/types/webSocket/response/deposits.d.ts +80 -0
  372. package/dist/types/webSocket/response/deposits.d.ts.map +1 -0
  373. package/dist/types/webSocket/response/deposits.js +2 -0
  374. package/dist/types/webSocket/response/fundingPayments.d.ts +78 -0
  375. package/dist/types/webSocket/response/fundingPayments.d.ts.map +1 -0
  376. package/dist/types/webSocket/response/fundingPayments.js +2 -0
  377. package/dist/types/webSocket/response/index.d.ts +13 -0
  378. package/dist/types/webSocket/response/index.d.ts.map +1 -0
  379. package/dist/types/webSocket/response/index.js +15 -0
  380. package/dist/types/webSocket/response/liquidations.d.ts +78 -0
  381. package/dist/types/webSocket/response/liquidations.d.ts.map +1 -0
  382. package/dist/types/webSocket/response/liquidations.js +2 -0
  383. package/dist/types/webSocket/response/orderbook.d.ts +214 -0
  384. package/dist/types/webSocket/response/orderbook.d.ts.map +1 -0
  385. package/dist/types/webSocket/response/orderbook.js +2 -0
  386. package/dist/types/webSocket/response/orders.d.ts +355 -0
  387. package/dist/types/webSocket/response/orders.d.ts.map +1 -0
  388. package/dist/types/webSocket/response/orders.js +2 -0
  389. package/dist/types/webSocket/response/ordersFill.d.ts +138 -0
  390. package/dist/types/webSocket/response/ordersFill.d.ts.map +1 -0
  391. package/dist/types/webSocket/response/ordersFill.js +2 -0
  392. package/dist/types/webSocket/response/positions.d.ts +120 -0
  393. package/dist/types/webSocket/response/positions.d.ts.map +1 -0
  394. package/dist/types/webSocket/response/positions.js +2 -0
  395. package/dist/types/webSocket/response/tickers.d.ts +131 -0
  396. package/dist/types/webSocket/response/tickers.d.ts.map +1 -0
  397. package/dist/types/webSocket/response/tickers.js +2 -0
  398. package/dist/types/webSocket/response/trades.d.ts +90 -0
  399. package/dist/types/webSocket/response/trades.d.ts.map +1 -0
  400. package/dist/types/webSocket/response/trades.js +2 -0
  401. package/dist/types/webSocket/response/webclient/base.d.ts +24 -0
  402. package/dist/types/webSocket/response/webclient/base.d.ts.map +1 -0
  403. package/dist/types/webSocket/response/webclient/base.js +2 -0
  404. package/dist/types/webSocket/response/webclient/events/exchangeStatus.d.ts +31 -0
  405. package/dist/types/webSocket/response/webclient/events/exchangeStatus.d.ts.map +1 -0
  406. package/dist/types/webSocket/response/webclient/events/exchangeStatus.js +2 -0
  407. package/dist/types/webSocket/response/webclient/events/index.d.ts +4 -0
  408. package/dist/types/webSocket/response/webclient/events/index.d.ts.map +1 -0
  409. package/dist/types/webSocket/response/webclient/events/index.js +6 -0
  410. package/dist/types/webSocket/response/webclient/events/reloadBanners.d.ts +17 -0
  411. package/dist/types/webSocket/response/webclient/events/reloadBanners.d.ts.map +1 -0
  412. package/dist/types/webSocket/response/webclient/events/reloadBanners.js +2 -0
  413. package/dist/types/webSocket/response/webclient/events/transactionSettled.d.ts +76 -0
  414. package/dist/types/webSocket/response/webclient/events/transactionSettled.d.ts.map +1 -0
  415. package/dist/types/webSocket/response/webclient/events/transactionSettled.js +2 -0
  416. package/dist/types/webSocket/response/webclient/index.d.ts +3 -0
  417. package/dist/types/webSocket/response/webclient/index.d.ts.map +1 -0
  418. package/dist/types/webSocket/response/webclient/index.js +5 -0
  419. package/dist/types/webSocket/response/webclient/webclient.d.ts +13 -0
  420. package/dist/types/webSocket/response/webclient/webclient.d.ts.map +1 -0
  421. package/dist/types/webSocket/response/webclient/webclient.js +2 -0
  422. package/dist/types/webSocket/response/withdrawals.d.ts +83 -0
  423. package/dist/types/webSocket/response/withdrawals.d.ts.map +1 -0
  424. package/dist/types/webSocket/response/withdrawals.js +2 -0
  425. package/dist/utils.d.ts +63 -0
  426. package/dist/utils.d.ts.map +1 -0
  427. package/dist/utils.js +136 -0
  428. package/package.json +200 -0
@@ -0,0 +1,115 @@
1
+ import type * as katanaPerps from '@katanaperps/katana-perps-sdk/types';
2
+ /**
3
+ * - Rest Request: `GET /candles`
4
+ *
5
+ * @packageDocumentation
6
+ */
7
+ /**
8
+ * GET candles request interface
9
+ *
10
+ * @see response {@link RestResponseGetCandles}
11
+ * @see type {@link KatanaPerpsCandle}
12
+ *
13
+ * @category KatanaPerps - Get Candles
14
+ */
15
+ export interface RestRequestGetCandles extends katanaPerps.RestRequestPagination, katanaPerps.RestRequestByMarket {
16
+ /**
17
+ * Time interval for data
18
+ *
19
+ * - Use the {@link katanaperps.CandleInterval CandleInterval} enum to get auto completion
20
+ * and inline documentation on the enumerations.
21
+ *
22
+ * @example
23
+ * ```typescript
24
+ * import { RestPublicClient, CandleInterval } from '@katanaperps/katana-perps-sdk';
25
+ *
26
+ * const client = new RestPublicClient();
27
+ *
28
+ * const candles = await client.getCandles({
29
+ * market: 'ETH-USD',
30
+ * interval: CandleInterval.ONE_HOUR
31
+ * })
32
+ * ```
33
+ *
34
+ * <br />
35
+ *
36
+ * ---
37
+ *
38
+ * @see enum {@link katanaperps.CandleInterval CandleInterval}
39
+ */
40
+ interval: katanaPerps.CandleInterval;
41
+ /**
42
+ * - Max results to return from 1-1000.
43
+ *
44
+ * @inheritDoc
45
+ * @defaultValue 50
46
+ */
47
+ limit?: number;
48
+ /**
49
+ * Only allowed in strict cases and for internal use only.
50
+ *
51
+ * @internal
52
+ */
53
+ countBack?: number;
54
+ }
55
+ /**
56
+ * Candle (OHLCV) data points aggregated by time interval
57
+ *
58
+ * - Candles only include values from `fills`, not `liquidations` or `ADLs`.
59
+ *
60
+ * @see request {@link RestRequestGetCandles}
61
+ * @see response {@link RestResponseGetCandles}
62
+ *
63
+ * @category KatanaPerps - Get Candles
64
+ * @category KatanaPerps Interfaces
65
+ */
66
+ export interface KatanaPerpsCandle {
67
+ /**
68
+ * Time of the start of the interval
69
+ */
70
+ start: number;
71
+ /**
72
+ * Price of the first trade in the interval in quote terms
73
+ */
74
+ open: string;
75
+ /**
76
+ * Price of the traded price in the interval in quote terms
77
+ */
78
+ high: string;
79
+ /**
80
+ * Price of the traded price in the interval in quote terms
81
+ */
82
+ low: string;
83
+ /**
84
+ * Price of the last trade in the interval in quote terms
85
+ */
86
+ close: string;
87
+ /**
88
+ * Trading volume in the interval in base terms, `null` for some historical chart data
89
+ */
90
+ baseVolume: string | null;
91
+ /**
92
+ * Trading volume in the interval in quote terms, `null` for some historical chart data
93
+ */
94
+ quoteVolume: string | null;
95
+ /**
96
+ * Number of trades in the interval, `null` for some historical chart data
97
+ */
98
+ trades: number | null;
99
+ /**
100
+ * Fill sequence number of the last trade in the interval, `null` for some historical chart data
101
+ */
102
+ sequence: number | null;
103
+ }
104
+ /**
105
+ * Candle (OHLCV) data points aggregated by time interval
106
+ *
107
+ * - Candles only include values from `fills`: not `liquidations` or `ADLs`.
108
+ *
109
+ * @see type {@link KatanaPerpsCandle}
110
+ * @see request {@link RestRequestGetCandles}
111
+ *
112
+ * @category KatanaPerps - Get Candles
113
+ */
114
+ export type RestResponseGetCandles = KatanaPerpsCandle[];
115
+ //# sourceMappingURL=GetCandles.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"GetCandles.d.ts","sourceRoot":"","sources":["../../../../src/types/rest/endpoints/GetCandles.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,WAAW,MAAM,qCAAqC,CAAC;AAExE;;;;GAIG;AAEH;;;;;;;GAOG;AACH,MAAM,WAAW,qBACf,SAAQ,WAAW,CAAC,qBAAqB,EACvC,WAAW,CAAC,mBAAmB;IACjC;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,QAAQ,EAAE,WAAW,CAAC,cAAc,CAAC;IACrC;;;;;OAKG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B;;OAEG;IACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED;;;;;;;;;GASG;AACH,MAAM,MAAM,sBAAsB,GAAG,iBAAiB,EAAE,CAAC"}
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,109 @@
1
+ import type * as katanaPerps from '#index';
2
+ /**
3
+ * Get Deposit Request
4
+ *
5
+ * @see request {@link katanaPerps.RestAuthenticatedClient.getDeposit RestAuthenticatedClient.getDeposit}
6
+ * @see related {@link RestRequestGetDeposits}
7
+ *
8
+ * @category KatanaPerps - Get Deposits
9
+ */
10
+ export interface RestRequestGetDeposit extends katanaPerps.RestRequestByWallet {
11
+ /**
12
+ * Single `depositId` to return
13
+ */
14
+ depositId: string;
15
+ }
16
+ /**
17
+ * Get {@link KatanaPerpsDeposit Deposits}
18
+ *
19
+ * @see typedoc [Reference Documentation](https://sdk-js-docs-v1-perps.katana.network/interfaces/RestRequestGetDeposits.html)
20
+ * @see request {@link katanaPerps.RestAuthenticatedClient.getDeposits RestAuthenticatedClient.getDeposits}
21
+ * @see related {@link RestRequestGetDeposit}
22
+ *
23
+ * @category KatanaPerps - Get Deposits
24
+ */
25
+ export interface RestRequestGetDeposits extends katanaPerps.RestRequestByWallet, katanaPerps.RestRequestPaginationWithFromId {
26
+ depositId?: undefined;
27
+ }
28
+ /**
29
+ * An object which represents a single deposit on the exchange.
30
+ *
31
+ * @see request {@link katanaPerps.RestAuthenticatedClient.getDeposit RestAuthenticatedClient.getDeposit}
32
+ * @see request {@link katanaPerps.RestAuthenticatedClient.getDeposits RestAuthenticatedClient.getDeposits}
33
+ *
34
+ * @category KatanaPerps - Get Deposits
35
+ * @category KatanaPerps Interfaces
36
+ */
37
+ export interface KatanaPerpsDeposit {
38
+ /**
39
+ * Katana Perps-issued deposit identifier
40
+ */
41
+ depositId: string;
42
+ /**
43
+ * Asset symbol for collateral token
44
+ */
45
+ asset: string;
46
+ /**
47
+ * Deposit amount in asset terms
48
+ */
49
+ quantity: string;
50
+ /**
51
+ * Bridge and source chain of the deposit
52
+ *
53
+ * - Use the {@link katanaPerps.BridgeTarget BridgeTarget} enum to narrow
54
+ * all possible values when needed.
55
+ *
56
+ * @see enum {@link katanaPerps.BridgeTarget BridgeTarget}
57
+ */
58
+ bridgeSource: katanaPerps.DepositSource;
59
+ /**
60
+ * Timestamp of crediting the deposited funds on the exchange
61
+ */
62
+ time: number;
63
+ /**
64
+ * Transaction id of the bridge transaction initiated by the user; also
65
+ * queryable for bridge details on https://layerzeroscan.com/
66
+ */
67
+ bridgeTxId?: string;
68
+ /**
69
+ * Transaction id of the bridge transaction delivering funds to Katana; also
70
+ * queryable for bridge details on https://layerzeroscan.com/
71
+ */
72
+ forwarderTxId?: string;
73
+ /**
74
+ * Transaction id of the deposit transaction on Katana
75
+ */
76
+ katanaTxId: string;
77
+ /**
78
+ * For deposits to vaults, contains details about the vault.
79
+ */
80
+ vault?: {
81
+ /** Manager-specified name */
82
+ name?: string;
83
+ /** Manager wallet address */
84
+ manager: string;
85
+ };
86
+ }
87
+ /**
88
+ * Returns of a single deposit by the `depositId` provided.
89
+ *
90
+ * @see type {@link KatanaPerpsDeposit}
91
+ * @see request {@link RestRequestGetDeposit}
92
+ * @see related {@link RestResponseGetDeposits}
93
+ * @see related {@link RestRequestGetDeposits}
94
+ *
95
+ * @category KatanaPerps - Get Deposits
96
+ */
97
+ export type RestResponseGetDeposit = KatanaPerpsDeposit;
98
+ /**
99
+ * Returns deposits according to the request parameters.
100
+ *
101
+ * @see type {@link KatanaPerpsDeposit}
102
+ * @see request {@link RestRequestGetDeposits}
103
+ * @see related {@link RestResponseGetDeposit}
104
+ * @see related {@link RestRequestGetDeposit}
105
+ *
106
+ * @category KatanaPerps - Get Deposits
107
+ */
108
+ export type RestResponseGetDeposits = KatanaPerpsDeposit[];
109
+ //# sourceMappingURL=GetDeposits.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"GetDeposits.d.ts","sourceRoot":"","sources":["../../../../src/types/rest/endpoints/GetDeposits.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,WAAW,MAAM,QAAQ,CAAC;AAE3C;;;;;;;GAOG;AACH,MAAM,WAAW,qBAAsB,SAAQ,WAAW,CAAC,mBAAmB;IAC5E;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,sBACf,SAAQ,WAAW,CAAC,mBAAmB,EACrC,WAAW,CAAC,+BAA+B;IAC7C,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;;;;;;OAOG;IACH,YAAY,EAAE,WAAW,CAAC,aAAa,CAAC;IACxC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,KAAK,CAAC,EAAE;QACN,6BAA6B;QAC7B,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,8BAA8B;QAC9B,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC;CACH;AAED;;;;;;;;;GASG;AACH,MAAM,MAAM,sBAAsB,GAAG,kBAAkB,CAAC;AAExD;;;;;;;;;GASG;AACH,MAAM,MAAM,uBAAuB,GAAG,kBAAkB,EAAE,CAAC"}
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,78 @@
1
+ /**
2
+ * **Endpoint Parameters**
3
+ *
4
+ * > - **HTTP Request**: `GET /v1/exchange`
5
+ * > - **Endpoint Security:** [Public](https://api-docs-v1-perps.katana.network/#endpointSecurityPublic)
6
+ * > - **API Key Scope:** [None](https://api-docs-v1-perps.katana.network/#api-keys)
7
+ */
8
+ export interface RestRequestGetExchange {
9
+ }
10
+ /**
11
+ * Basic exchange info
12
+ *
13
+ * @category KatanaPerps - Get Exchange
14
+ * @category KatanaPerps Interfaces
15
+ *
16
+ * @see docs [API Documentation](https://api-docs-v1-perps.katana.network/#get-exchange)
17
+ * @see response {@link RestResponseGetExchange}
18
+ */
19
+ export interface KatanaPerpsExchange {
20
+ /** Server time zone, always UTC */
21
+ timeZone: 'UTC';
22
+ /**
23
+ * Current server time
24
+ */
25
+ serverTime: number;
26
+ /**
27
+ * [Katana](https://katana.network/) address of the exchange smart contract for deposits
28
+ */
29
+ exchangeContractAddress: string;
30
+ /**
31
+ * [Katana](https://katana.network/) chain identifier
32
+ */
33
+ chainId: number;
34
+ /**
35
+ * Address of the quote asset (USDC) on [Katana](https://katana.network/)
36
+ */
37
+ quoteTokenAddress: string;
38
+ /** Total open interest across all markets in USD */
39
+ totalOpenInterest: string;
40
+ /** Total exchange trading volume for the trailing 24 hours in USD */
41
+ volume24h: string;
42
+ /** Total exchange trading volume for Katana Perps in USD */
43
+ totalVolume: string;
44
+ /** Total number of trade executions for Katana Perps */
45
+ totalTrades: number;
46
+ /** Balance of the insurance fund in USD */
47
+ insuranceFundBalance?: string;
48
+ /** Default exchange-wide maker trade fee rate */
49
+ defaultMakerFeeRate: string;
50
+ /** Default exchange-wide taker trade fee rate */
51
+ defaultTakerFeeRate: string;
52
+ /** Minimum withdrawal amount in USD */
53
+ withdrawalMinimum: string;
54
+ /**
55
+ * Whether deposits are enabled
56
+ *
57
+ * - Internal use only, not returned in all circumstances
58
+ *
59
+ * @internal
60
+ */
61
+ depositEnabled?: boolean;
62
+ /**
63
+ * Whether deposits are enabled
64
+ *
65
+ * - Internal use only, not returned in all circumstances
66
+ *
67
+ * @internal
68
+ */
69
+ withdrawEnabled?: boolean;
70
+ }
71
+ /**
72
+ * @see docs [API Documentation](https://api-docs-v1-perps.katana.network/#get-exchange)
73
+ * @see type {@link KatanaPerpsExchange}
74
+ *
75
+ * @category KatanaPerps - Get Exchange
76
+ */
77
+ export type RestResponseGetExchange = KatanaPerpsExchange;
78
+ //# sourceMappingURL=GetExchange.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"GetExchange.d.ts","sourceRoot":"","sources":["../../../../src/types/rest/endpoints/GetExchange.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,MAAM,WAAW,sBAAsB;CAAG;AAE1C;;;;;;;;GAQG;AACH,MAAM,WAAW,mBAAmB;IAClC,mCAAmC;IACnC,QAAQ,EAAE,KAAK,CAAC;IAChB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,uBAAuB,EAAE,MAAM,CAAC;IAChC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAC1B,oDAAoD;IACpD,iBAAiB,EAAE,MAAM,CAAC;IAC1B,qEAAqE;IACrE,SAAS,EAAE,MAAM,CAAC;IAClB,4DAA4D;IAC5D,WAAW,EAAE,MAAM,CAAC;IACpB,wDAAwD;IACxD,WAAW,EAAE,MAAM,CAAC;IACpB,2CAA2C;IAC3C,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,iDAAiD;IACjD,mBAAmB,EAAE,MAAM,CAAC;IAC5B,iDAAiD;IACjD,mBAAmB,EAAE,MAAM,CAAC;IAC5B,uCAAuC;IACvC,iBAAiB,EAAE,MAAM,CAAC;IAC1B;;;;;;OAMG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB;;;;;;OAMG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED;;;;;GAKG;AACH,MAAM,MAAM,uBAAuB,GAAG,mBAAmB,CAAC"}
@@ -0,0 +1,9 @@
1
+ "use strict";
2
+ /**
3
+ * **Endpoint Parameters**
4
+ *
5
+ * > - **HTTP Request**: `GET /v1/exchange`
6
+ * > - **Endpoint Security:** [Public](https://api-docs-v1-perps.katana.network/#endpointSecurityPublic)
7
+ * > - **API Key Scope:** [None](https://api-docs-v1-perps.katana.network/#api-keys)
8
+ */
9
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,178 @@
1
+ import type * as katanaPerps from '#index';
2
+ /**
3
+ * Request parameters required to retrieve a single {@link KatanaPerpsFill}.
4
+ *
5
+ * @see related {@link RestRequestGetFills}
6
+ * @see type {@link KatanaPerpsFill}
7
+ *
8
+ * @category KatanaPerps - Get Fills
9
+ */
10
+ export interface RestRequestGetFill extends katanaPerps.RestRequestByWallet {
11
+ /**
12
+ * The `fillId` of the fill to retrieve.
13
+ *
14
+ * - This property being **included** will cause the api to return a single {@link KatanaPerpsFill}
15
+ */
16
+ readonly fillId: string;
17
+ }
18
+ /**
19
+ * Request parameters required to get a list of matching {@link KatanaPerpsFill} items.
20
+ *
21
+ * @see related {@link RestRequestGetFill}
22
+ * @see type {@link KatanaPerpsFill}
23
+ *
24
+ * @category KatanaPerps - Get Fills
25
+ */
26
+ export interface RestRequestGetFills extends katanaPerps.RestRequestByWallet, katanaPerps.RestRequestByMarketOptional, katanaPerps.RestRequestPaginationWithFromId {
27
+ }
28
+ /**
29
+ * @category KatanaPerps - Get Fills
30
+ * @category KatanaPerps Interfaces
31
+ *
32
+ * @see request {@link RestRequestGetFill}
33
+ * @see request {@link RestRequestGetFills}
34
+ * @see related {@link KatanaPerpsOrderFill}
35
+ */
36
+ export interface KatanaPerpsFill {
37
+ /**
38
+ * Exchange-assigned order identifier, omitted for liquidations
39
+ */
40
+ orderId?: string;
41
+ /**
42
+ * Client-provided ID of order, if present
43
+ */
44
+ clientOrderId?: string;
45
+ /**
46
+ * Base-quote pair e.g. 'ETH-USD'
47
+ */
48
+ market: string;
49
+ /**
50
+ * Orders side, `buy` or `sell`
51
+ *
52
+ * @see enum {@link katanaPerps.OrderSide OrderSide}
53
+ */
54
+ side: katanaPerps.OrderSide;
55
+ /**
56
+ * Internal ID of fill
57
+ */
58
+ fillId: string;
59
+ /**
60
+ * Executed price of fill in quote terms
61
+ */
62
+ price: string;
63
+ /**
64
+ * Executed quantity of fill in base terms
65
+ */
66
+ quantity: string;
67
+ /**
68
+ * Executed quantity of trade in quote terms
69
+ */
70
+ quoteQuantity: string;
71
+ /**
72
+ * Realized PnL
73
+ * - PnL only from the fill’s closure, not for the position overall
74
+ * - Does not include fees.
75
+ */
76
+ realizedPnL: string;
77
+ /**
78
+ * Fill timestamp
79
+ */
80
+ time: number;
81
+ /**
82
+ * Maker side of the fill, `buy` or `sell`
83
+ *
84
+ * - omitted for `liquidation` actions
85
+ *
86
+ * @see enum {@link katanaPerps.OrderSide OrderSide}
87
+ */
88
+ makerSide?: katanaPerps.OrderSide;
89
+ /**
90
+ * Fill sequence number
91
+ *
92
+ * - omitted for liquidation actions
93
+ */
94
+ sequence?: number;
95
+ /**
96
+ * Fee amount collected on the fill in quote terms
97
+ *
98
+ * - may be negative due to promotions
99
+ * - omitted for some liquidation actions
100
+ */
101
+ fee?: string;
102
+ /**
103
+ * Whether the fill increases or decreases the notional value of the position, open or close
104
+ *
105
+ * @see enum {@link katanaPerps.FillAction FillAction}
106
+ */
107
+ action: katanaPerps.FillAction;
108
+ /**
109
+ * Resulting position side
110
+ *
111
+ * @see enum {@link katanaPerps.PositionSide PositionSide}
112
+ */
113
+ position: katanaPerps.PositionSide;
114
+ /**
115
+ * Index price of the market at transaction time, for internal use
116
+ */
117
+ indexPrice?: string;
118
+ /**
119
+ * Whether the fill is the maker or taker in the trade from the perspective of the requesting API account,
120
+ * `maker` or `taker`
121
+ *
122
+ * - omitted for liquidation actions
123
+ *
124
+ * @see enum {@link katanaPerps.LiquidityProvider LiquidityProvider}
125
+ */
126
+ liquidity?: katanaPerps.LiquidityProvider;
127
+ /**
128
+ * Fill `type`
129
+ *
130
+ * @see enum {@link katanaPerps.FillType FillType}
131
+ */
132
+ type: katanaPerps.FillType;
133
+ /**
134
+ * Transaction id of the trade settlement transaction or `null` if not yet assigned
135
+ */
136
+ txId: string | null;
137
+ /**
138
+ * Status of the trade settlement transaction
139
+ *
140
+ * @see enum {@link katanaPerps.ChainTransactionStatus ChainTransactionStatus}
141
+ */
142
+ txStatus: katanaPerps.ChainTransactionStatus;
143
+ /**
144
+ * When `true`, the order is a liquidation acquisition only fill.
145
+ */
146
+ isLiquidationAcquisition?: true | undefined;
147
+ }
148
+ /**
149
+ * - Same as {@link KatanaPerpsFill} but without the following properties:
150
+ * - {@link KatanaPerpsFill.market market}
151
+ * - {@link KatanaPerpsFill.orderId orderId}
152
+ * - {@link KatanaPerpsFill.clientOrderId clientOrderId}
153
+ * - {@link KatanaPerpsFill.side side}
154
+ * - {@link KatanaPerpsFill.isLiquidationAcquisition isLiquidationAcquisition}
155
+ * - The omitted properties can instead be found on the order object itself.
156
+ *
157
+ * @category KatanaPerps - Get Orders
158
+ * @category KatanaPerps Interfaces
159
+ *
160
+ * @see related {@link KatanaPerpsFill}
161
+ */
162
+ export interface KatanaPerpsOrderFill extends Omit<KatanaPerpsFill, 'market' | 'orderId' | 'clientOrderId' | 'side' | 'isLiquidationAcquisition'> {
163
+ }
164
+ /**
165
+ * @category KatanaPerps - Get Fills
166
+ *
167
+ * @see request {@link RestRequestGetFill}
168
+ * @see type {@link KatanaPerpsFill}
169
+ */
170
+ export type RestResponseGetFill = KatanaPerpsFill;
171
+ /**
172
+ * @category KatanaPerps - Get Fills
173
+ *
174
+ * @see request {@link RestRequestGetFills}
175
+ * @see type {@link KatanaPerpsFill}
176
+ */
177
+ export type RestResponseGetFills = KatanaPerpsFill[];
178
+ //# sourceMappingURL=GetFills.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"GetFills.d.ts","sourceRoot":"","sources":["../../../../src/types/rest/endpoints/GetFills.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,WAAW,MAAM,QAAQ,CAAC;AAE3C;;;;;;;GAOG;AACH,MAAM,WAAW,kBAAmB,SAAQ,WAAW,CAAC,mBAAmB;IACzE;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;CACzB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,mBACf,SAAQ,WAAW,CAAC,mBAAmB,EACrC,WAAW,CAAC,2BAA2B,EACvC,WAAW,CAAC,+BAA+B;CAAG;AAElD;;;;;;;GAOG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,IAAI,EAAE,WAAW,CAAC,SAAS,CAAC;IAE5B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;;;OAIG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,WAAW,CAAC,SAAS,CAAC;IAClC;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;;OAKG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;;;OAIG;IACH,MAAM,EAAE,WAAW,CAAC,UAAU,CAAC;IAC/B;;;;OAIG;IACH,QAAQ,EAAE,WAAW,CAAC,YAAY,CAAC;IACnC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;;;;OAOG;IACH,SAAS,CAAC,EAAE,WAAW,CAAC,iBAAiB,CAAC;IAC1C;;;;OAIG;IACH,IAAI,EAAE,WAAW,CAAC,QAAQ,CAAC;IAC3B;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB;;;;OAIG;IACH,QAAQ,EAAE,WAAW,CAAC,sBAAsB,CAAC;IAE7C;;OAEG;IACH,wBAAwB,CAAC,EAAE,IAAI,GAAG,SAAS,CAAC;CAC7C;AAED;;;;;;;;;;;;;GAaG;AAEH,MAAM,WAAW,oBACf,SAAQ,IAAI,CACV,eAAe,EACf,QAAQ,GAAG,SAAS,GAAG,eAAe,GAAG,MAAM,GAAG,0BAA0B,CAC7E;CAAG;AAEN;;;;;GAKG;AACH,MAAM,MAAM,mBAAmB,GAAG,eAAe,CAAC;AAElD;;;;;GAKG;AACH,MAAM,MAAM,oBAAoB,GAAG,eAAe,EAAE,CAAC"}
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,52 @@
1
+ import type { RestRequestPagination, RestRequestByWallet, RestRequestByMarketOptional } from '#index';
2
+ /**
3
+ * Get Funding Payments
4
+ *
5
+ * @see response {@link RestResponseGetFundingPayments}
6
+ * @see type {@link KatanaPerpsFundingPayment}
7
+ *
8
+ * @category KatanaPerps - Get Funding Payments
9
+ */
10
+ export interface RestRequestGetFundingPayments extends RestRequestByWallet, RestRequestPagination, RestRequestByMarketOptional {
11
+ }
12
+ /**
13
+ * @see request {@link RestRequestGetFundingPayments}
14
+ * @see response {@link RestResponseGetFundingPayments}
15
+ *
16
+ * @category KatanaPerps - Get Funding Payments
17
+ * @category KatanaPerps Interfaces
18
+ */
19
+ export interface KatanaPerpsFundingPayment {
20
+ /**
21
+ * The timestamp indicating when the item was created.
22
+ */
23
+ time: number;
24
+ /**
25
+ * Market symbol for the item
26
+ */
27
+ market: string;
28
+ /**
29
+ * Quantity of the funding payment in quote terms
30
+ */
31
+ paymentQuantity: string;
32
+ /**
33
+ * Quantity of the open position at payment time in base terms
34
+ */
35
+ positionQuantity: string;
36
+ /**
37
+ * Funding rate for the period
38
+ */
39
+ fundingRate: string;
40
+ /**
41
+ * Index price of the market at payment time
42
+ */
43
+ indexPrice: string;
44
+ }
45
+ /**
46
+ * @see type {@link KatanaPerpsFundingPayment}
47
+ * @see request {@link RestRequestGetFundingPayments}
48
+ *
49
+ * @category KatanaPerps - Get Funding Payments
50
+ */
51
+ export type RestResponseGetFundingPayments = KatanaPerpsFundingPayment[];
52
+ //# sourceMappingURL=GetFundingPayments.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"GetFundingPayments.d.ts","sourceRoot":"","sources":["../../../../src/types/rest/endpoints/GetFundingPayments.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,qBAAqB,EACrB,mBAAmB,EACnB,2BAA2B,EAC5B,MAAM,QAAQ,CAAC;AAEhB;;;;;;;GAOG;AACH,MAAM,WAAW,6BACf,SAAQ,mBAAmB,EACzB,qBAAqB,EACrB,2BAA2B;CAAG;AAElC;;;;;;GAMG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;;;GAKG;AACH,MAAM,MAAM,8BAA8B,GAAG,yBAAyB,EAAE,CAAC"}
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,34 @@
1
+ import type { RestRequestByMarket, RestRequestPagination } from '#index';
2
+ /**
3
+ * Get Funding Rates
4
+ *
5
+ * @see response {@link RestResponseGetFundingRates}
6
+ * @see type {@link KatanaPerpsFundingRate}
7
+ *
8
+ * @category KatanaPerps - Get Funding Rates
9
+ */
10
+ export interface RestRequestGetFundingRates extends RestRequestPagination, RestRequestByMarket {
11
+ }
12
+ /**
13
+ * @see request {@link RestRequestGetFundingRates}
14
+ * @see response {@link RestResponseGetFundingRates}
15
+ *
16
+ * @category KatanaPerps - Get Funding Rates
17
+ * @category KatanaPerps Interfaces
18
+ */
19
+ export interface KatanaPerpsFundingRate {
20
+ /** Funding rate for the period */
21
+ fundingRate: string;
22
+ /** Index price of the market at payment time */
23
+ indexPrice: string;
24
+ /** Timestamp of the payment */
25
+ time: number;
26
+ }
27
+ /**
28
+ * @see type {@link KatanaPerpsFundingRate}
29
+ * @see request {@link RestRequestGetFundingRates}
30
+ *
31
+ * @category KatanaPerps - Get Funding Rates
32
+ */
33
+ export type RestResponseGetFundingRates = KatanaPerpsFundingRate[];
34
+ //# sourceMappingURL=GetFundingRates.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"GetFundingRates.d.ts","sourceRoot":"","sources":["../../../../src/types/rest/endpoints/GetFundingRates.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,qBAAqB,EAAE,MAAM,QAAQ,CAAC;AAEzE;;;;;;;GAOG;AACH,MAAM,WAAW,0BACf,SAAQ,qBAAqB,EAC3B,mBAAmB;CAAG;AAE1B;;;;;;GAMG;AACH,MAAM,WAAW,sBAAsB;IACrC,kCAAkC;IAClC,WAAW,EAAE,MAAM,CAAC;IACpB,gDAAgD;IAChD,UAAU,EAAE,MAAM,CAAC;IACnB,+BAA+B;IAC/B,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;;;GAKG;AACH,MAAM,MAAM,2BAA2B,GAAG,sBAAsB,EAAE,CAAC"}
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,23 @@
1
+ import type { BridgeTarget } from '@katanaperps/katana-perps-sdk/types';
2
+ /**
3
+ * Estimated gas fees by bridge and target chain
4
+ *
5
+ * @see docs [API Documentation](https://api-docs-v1-perps.katana.network/#get-gas-fees)
6
+ * @see response {@link RestResponseGetGasFees}
7
+ *
8
+ * @category KatanaPerps - Get Gas Fees
9
+ * @category KatanaPerps Interfaces
10
+ */
11
+ export interface KatanaPerpsGasFees {
12
+ withdrawal: {
13
+ [K in BridgeTarget]?: string;
14
+ };
15
+ }
16
+ /**
17
+ * @see docs [API Documentation](https://api-docs-v1-perps.katana.network/#get-gas-fees)
18
+ * @see type {@link KatanaPerpsGasFees}
19
+ *
20
+ * @category KatanaPerps - Get Gas Fees
21
+ */
22
+ export type RestResponseGetGasFees = KatanaPerpsGasFees;
23
+ //# sourceMappingURL=GetGasFees.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"GetGasFees.d.ts","sourceRoot":"","sources":["../../../../src/types/rest/endpoints/GetGasFees.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,qCAAqC,CAAC;AAExE;;;;;;;;GAQG;AACH,MAAM,WAAW,kBAAkB;IACjC,UAAU,EAAE;SACT,CAAC,IAAI,YAAY,CAAC,CAAC,EAAE,MAAM;KAC7B,CAAC;CACH;AAED;;;;;GAKG;AACH,MAAM,MAAM,sBAAsB,GAAG,kBAAkB,CAAC"}
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });