gateio-api 0.0.1 → 1.0.2

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 (320) hide show
  1. package/README.md +251 -106
  2. package/dist/cjs/RestClient.d.ts +2534 -0
  3. package/dist/cjs/RestClient.js +2700 -0
  4. package/dist/cjs/RestClient.js.map +1 -0
  5. package/dist/cjs/WebsocketClient.d.ts +107 -0
  6. package/dist/cjs/WebsocketClient.js +504 -0
  7. package/dist/cjs/WebsocketClient.js.map +1 -0
  8. package/dist/cjs/index.d.ts +43 -0
  9. package/dist/cjs/index.js +64 -0
  10. package/dist/cjs/index.js.map +1 -0
  11. package/dist/cjs/lib/BaseRestClient.d.ts +63 -0
  12. package/dist/cjs/lib/BaseRestClient.js +324 -0
  13. package/dist/cjs/lib/BaseRestClient.js.map +1 -0
  14. package/dist/cjs/lib/BaseWSClient.d.ts +172 -0
  15. package/dist/cjs/lib/BaseWSClient.js +619 -0
  16. package/dist/cjs/lib/BaseWSClient.js.map +1 -0
  17. package/dist/cjs/lib/logger.d.ts +6 -0
  18. package/dist/cjs/lib/logger.js +16 -0
  19. package/dist/cjs/lib/logger.js.map +1 -0
  20. package/dist/cjs/lib/misc-util.d.ts +1 -0
  21. package/dist/cjs/lib/misc-util.js +8 -0
  22. package/dist/cjs/lib/misc-util.js.map +1 -0
  23. package/dist/cjs/lib/requestUtils.d.ts +38 -0
  24. package/dist/cjs/lib/requestUtils.js +47 -0
  25. package/dist/cjs/lib/requestUtils.js.map +1 -0
  26. package/dist/cjs/lib/webCryptoAPI.d.ts +10 -0
  27. package/dist/cjs/lib/webCryptoAPI.js +57 -0
  28. package/dist/cjs/lib/webCryptoAPI.js.map +1 -0
  29. package/dist/cjs/lib/websocket/WsStore.d.ts +57 -0
  30. package/dist/cjs/lib/websocket/WsStore.js +249 -0
  31. package/dist/cjs/lib/websocket/WsStore.js.map +1 -0
  32. package/dist/cjs/lib/websocket/WsStore.types.d.ts +44 -0
  33. package/dist/cjs/lib/websocket/WsStore.types.js +13 -0
  34. package/dist/cjs/lib/websocket/WsStore.types.js.map +1 -0
  35. package/dist/cjs/lib/websocket/websocket-util.d.ts +78 -0
  36. package/dist/cjs/lib/websocket/websocket-util.js +153 -0
  37. package/dist/cjs/lib/websocket/websocket-util.js.map +1 -0
  38. package/dist/cjs/package.json +3 -0
  39. package/dist/cjs/types/request/account.d.ts +10 -0
  40. package/dist/cjs/types/request/account.js +7 -0
  41. package/dist/cjs/types/request/account.js.map +1 -0
  42. package/dist/cjs/types/request/collateralLoan.d.ts +39 -0
  43. package/dist/cjs/types/request/collateralLoan.js +7 -0
  44. package/dist/cjs/types/request/collateralLoan.js.map +1 -0
  45. package/dist/cjs/types/request/delivery.d.ts +89 -0
  46. package/dist/cjs/types/request/delivery.js +7 -0
  47. package/dist/cjs/types/request/delivery.js.map +1 -0
  48. package/dist/cjs/types/request/earn.d.ts +16 -0
  49. package/dist/cjs/types/request/earn.js +7 -0
  50. package/dist/cjs/types/request/earn.js.map +1 -0
  51. package/dist/cjs/types/request/earnuni.d.ts +30 -0
  52. package/dist/cjs/types/request/earnuni.js +7 -0
  53. package/dist/cjs/types/request/earnuni.js.map +1 -0
  54. package/dist/cjs/types/request/flashswap.d.ts +28 -0
  55. package/dist/cjs/types/request/flashswap.js +7 -0
  56. package/dist/cjs/types/request/flashswap.js.map +1 -0
  57. package/dist/cjs/types/request/futures.d.ts +168 -0
  58. package/dist/cjs/types/request/futures.js +7 -0
  59. package/dist/cjs/types/request/futures.js.map +1 -0
  60. package/dist/cjs/types/request/margin.d.ts +47 -0
  61. package/dist/cjs/types/request/margin.js +7 -0
  62. package/dist/cjs/types/request/margin.js.map +1 -0
  63. package/dist/cjs/types/request/marginuni.d.ts +29 -0
  64. package/dist/cjs/types/request/marginuni.js +7 -0
  65. package/dist/cjs/types/request/marginuni.js.map +1 -0
  66. package/dist/cjs/types/request/multicollateralLoan.d.ts +55 -0
  67. package/dist/cjs/types/request/multicollateralLoan.js +7 -0
  68. package/dist/cjs/types/request/multicollateralLoan.js.map +1 -0
  69. package/dist/cjs/types/request/options.d.ts +81 -0
  70. package/dist/cjs/types/request/options.js +3 -0
  71. package/dist/cjs/types/request/options.js.map +1 -0
  72. package/dist/cjs/types/request/rebate.d.ts +26 -0
  73. package/dist/cjs/types/request/rebate.js +3 -0
  74. package/dist/cjs/types/request/rebate.js.map +1 -0
  75. package/dist/cjs/types/request/spot.d.ts +115 -0
  76. package/dist/cjs/types/request/spot.js +7 -0
  77. package/dist/cjs/types/request/spot.js.map +1 -0
  78. package/dist/cjs/types/request/subaccount.d.ts +19 -0
  79. package/dist/cjs/types/request/subaccount.js +3 -0
  80. package/dist/cjs/types/request/subaccount.js.map +1 -0
  81. package/dist/cjs/types/request/unified.d.ts +64 -0
  82. package/dist/cjs/types/request/unified.js +3 -0
  83. package/dist/cjs/types/request/unified.js.map +1 -0
  84. package/dist/cjs/types/request/wallet.d.ts +50 -0
  85. package/dist/cjs/types/request/wallet.js +3 -0
  86. package/dist/cjs/types/request/wallet.js.map +1 -0
  87. package/dist/cjs/types/request/withdrawal.d.ts +12 -0
  88. package/dist/cjs/types/request/withdrawal.js +7 -0
  89. package/dist/cjs/types/request/withdrawal.js.map +1 -0
  90. package/dist/cjs/types/response/account.d.ts +24 -0
  91. package/dist/cjs/types/response/account.js +7 -0
  92. package/dist/cjs/types/response/account.js.map +1 -0
  93. package/dist/cjs/types/response/collateralloan.d.ts +58 -0
  94. package/dist/cjs/types/response/collateralloan.js +7 -0
  95. package/dist/cjs/types/response/collateralloan.js.map +1 -0
  96. package/dist/cjs/types/response/delivery.d.ts +144 -0
  97. package/dist/cjs/types/response/delivery.js +7 -0
  98. package/dist/cjs/types/response/delivery.js.map +1 -0
  99. package/dist/cjs/types/response/earn.d.ts +60 -0
  100. package/dist/cjs/types/response/earn.js +7 -0
  101. package/dist/cjs/types/response/earn.js.map +1 -0
  102. package/dist/cjs/types/response/earnuni.d.ts +40 -0
  103. package/dist/cjs/types/response/earnuni.js +7 -0
  104. package/dist/cjs/types/response/earnuni.js.map +1 -0
  105. package/dist/cjs/types/response/flashswap.d.ts +32 -0
  106. package/dist/cjs/types/response/flashswap.js +7 -0
  107. package/dist/cjs/types/response/flashswap.js.map +1 -0
  108. package/dist/cjs/types/response/futures.d.ts +398 -0
  109. package/dist/cjs/types/response/futures.js +7 -0
  110. package/dist/cjs/types/response/futures.js.map +1 -0
  111. package/dist/cjs/types/response/margin.d.ts +96 -0
  112. package/dist/cjs/types/response/margin.js +7 -0
  113. package/dist/cjs/types/response/margin.js.map +1 -0
  114. package/dist/cjs/types/response/marginuni.d.ts +39 -0
  115. package/dist/cjs/types/response/marginuni.js +7 -0
  116. package/dist/cjs/types/response/marginuni.js.map +1 -0
  117. package/dist/cjs/types/response/multicollateralLoan.d.ts +151 -0
  118. package/dist/cjs/types/response/multicollateralLoan.js +7 -0
  119. package/dist/cjs/types/response/multicollateralLoan.js.map +1 -0
  120. package/dist/cjs/types/response/options.d.ts +192 -0
  121. package/dist/cjs/types/response/options.js +7 -0
  122. package/dist/cjs/types/response/options.js.map +1 -0
  123. package/dist/cjs/types/response/rebate.d.ts +40 -0
  124. package/dist/cjs/types/response/rebate.js +3 -0
  125. package/dist/cjs/types/response/rebate.js.map +1 -0
  126. package/dist/cjs/types/response/shared.d.ts +5 -0
  127. package/dist/cjs/types/response/shared.js +3 -0
  128. package/dist/cjs/types/response/shared.js.map +1 -0
  129. package/dist/cjs/types/response/spot.d.ts +224 -0
  130. package/dist/cjs/types/response/spot.js +7 -0
  131. package/dist/cjs/types/response/spot.js.map +1 -0
  132. package/dist/cjs/types/response/subaccount.d.ts +40 -0
  133. package/dist/cjs/types/response/subaccount.js +3 -0
  134. package/dist/cjs/types/response/subaccount.js.map +1 -0
  135. package/dist/cjs/types/response/unified.d.ts +113 -0
  136. package/dist/cjs/types/response/unified.js +3 -0
  137. package/dist/cjs/types/response/unified.js.map +1 -0
  138. package/dist/cjs/types/response/wallet.d.ts +181 -0
  139. package/dist/cjs/types/response/wallet.js +3 -0
  140. package/dist/cjs/types/response/wallet.js.map +1 -0
  141. package/dist/cjs/types/response/withdrawal.d.ts +12 -0
  142. package/dist/cjs/types/response/withdrawal.js +3 -0
  143. package/dist/cjs/types/response/withdrawal.js.map +1 -0
  144. package/dist/cjs/types/shared.d.ts +16 -0
  145. package/dist/cjs/types/shared.js +3 -0
  146. package/dist/cjs/types/shared.js.map +1 -0
  147. package/dist/cjs/types/websockets/client.d.ts +44 -0
  148. package/dist/cjs/types/websockets/client.js +6 -0
  149. package/dist/cjs/types/websockets/client.js.map +1 -0
  150. package/dist/cjs/types/websockets/events.d.ts +5 -0
  151. package/dist/cjs/types/websockets/events.js +3 -0
  152. package/dist/cjs/types/websockets/events.js.map +1 -0
  153. package/dist/cjs/types/websockets/requests.d.ts +36 -0
  154. package/dist/cjs/types/websockets/requests.js +3 -0
  155. package/dist/cjs/types/websockets/requests.js.map +1 -0
  156. package/dist/cjs/types/websockets/wsAPI.d.ts +101 -0
  157. package/dist/cjs/types/websockets/wsAPI.js +8 -0
  158. package/dist/cjs/types/websockets/wsAPI.js.map +1 -0
  159. package/dist/mjs/RestClient.d.ts +2534 -0
  160. package/dist/mjs/RestClient.js +2696 -0
  161. package/dist/mjs/RestClient.js.map +1 -0
  162. package/dist/mjs/WebsocketClient.d.ts +107 -0
  163. package/dist/mjs/WebsocketClient.js +500 -0
  164. package/dist/mjs/WebsocketClient.js.map +1 -0
  165. package/dist/mjs/index.d.ts +43 -0
  166. package/dist/mjs/index.js +48 -0
  167. package/dist/mjs/index.js.map +1 -0
  168. package/dist/mjs/lib/BaseRestClient.d.ts +63 -0
  169. package/dist/mjs/lib/BaseRestClient.js +317 -0
  170. package/dist/mjs/lib/BaseRestClient.js.map +1 -0
  171. package/dist/mjs/lib/BaseWSClient.d.ts +172 -0
  172. package/dist/mjs/lib/BaseWSClient.js +612 -0
  173. package/dist/mjs/lib/BaseWSClient.js.map +1 -0
  174. package/dist/mjs/lib/logger.d.ts +6 -0
  175. package/dist/mjs/lib/logger.js +13 -0
  176. package/dist/mjs/lib/logger.js.map +1 -0
  177. package/dist/mjs/lib/misc-util.d.ts +1 -0
  178. package/dist/mjs/lib/misc-util.js +4 -0
  179. package/dist/mjs/lib/misc-util.js.map +1 -0
  180. package/dist/mjs/lib/requestUtils.d.ts +38 -0
  181. package/dist/mjs/lib/requestUtils.js +41 -0
  182. package/dist/mjs/lib/requestUtils.js.map +1 -0
  183. package/dist/mjs/lib/webCryptoAPI.d.ts +10 -0
  184. package/dist/mjs/lib/webCryptoAPI.js +52 -0
  185. package/dist/mjs/lib/webCryptoAPI.js.map +1 -0
  186. package/dist/mjs/lib/websocket/WsStore.d.ts +57 -0
  187. package/dist/mjs/lib/websocket/WsStore.js +244 -0
  188. package/dist/mjs/lib/websocket/WsStore.js.map +1 -0
  189. package/dist/mjs/lib/websocket/WsStore.types.d.ts +44 -0
  190. package/dist/mjs/lib/websocket/WsStore.types.js +10 -0
  191. package/dist/mjs/lib/websocket/WsStore.types.js.map +1 -0
  192. package/dist/mjs/lib/websocket/websocket-util.d.ts +78 -0
  193. package/dist/mjs/lib/websocket/websocket-util.js +145 -0
  194. package/dist/mjs/lib/websocket/websocket-util.js.map +1 -0
  195. package/dist/mjs/package.json +3 -0
  196. package/dist/mjs/types/request/account.d.ts +10 -0
  197. package/dist/mjs/types/request/account.js +6 -0
  198. package/dist/mjs/types/request/account.js.map +1 -0
  199. package/dist/mjs/types/request/collateralLoan.d.ts +39 -0
  200. package/dist/mjs/types/request/collateralLoan.js +6 -0
  201. package/dist/mjs/types/request/collateralLoan.js.map +1 -0
  202. package/dist/mjs/types/request/delivery.d.ts +89 -0
  203. package/dist/mjs/types/request/delivery.js +6 -0
  204. package/dist/mjs/types/request/delivery.js.map +1 -0
  205. package/dist/mjs/types/request/earn.d.ts +16 -0
  206. package/dist/mjs/types/request/earn.js +6 -0
  207. package/dist/mjs/types/request/earn.js.map +1 -0
  208. package/dist/mjs/types/request/earnuni.d.ts +30 -0
  209. package/dist/mjs/types/request/earnuni.js +6 -0
  210. package/dist/mjs/types/request/earnuni.js.map +1 -0
  211. package/dist/mjs/types/request/flashswap.d.ts +28 -0
  212. package/dist/mjs/types/request/flashswap.js +6 -0
  213. package/dist/mjs/types/request/flashswap.js.map +1 -0
  214. package/dist/mjs/types/request/futures.d.ts +168 -0
  215. package/dist/mjs/types/request/futures.js +6 -0
  216. package/dist/mjs/types/request/futures.js.map +1 -0
  217. package/dist/mjs/types/request/margin.d.ts +47 -0
  218. package/dist/mjs/types/request/margin.js +6 -0
  219. package/dist/mjs/types/request/margin.js.map +1 -0
  220. package/dist/mjs/types/request/marginuni.d.ts +29 -0
  221. package/dist/mjs/types/request/marginuni.js +6 -0
  222. package/dist/mjs/types/request/marginuni.js.map +1 -0
  223. package/dist/mjs/types/request/multicollateralLoan.d.ts +55 -0
  224. package/dist/mjs/types/request/multicollateralLoan.js +6 -0
  225. package/dist/mjs/types/request/multicollateralLoan.js.map +1 -0
  226. package/dist/mjs/types/request/options.d.ts +81 -0
  227. package/dist/mjs/types/request/options.js +2 -0
  228. package/dist/mjs/types/request/options.js.map +1 -0
  229. package/dist/mjs/types/request/rebate.d.ts +26 -0
  230. package/dist/mjs/types/request/rebate.js +2 -0
  231. package/dist/mjs/types/request/rebate.js.map +1 -0
  232. package/dist/mjs/types/request/spot.d.ts +115 -0
  233. package/dist/mjs/types/request/spot.js +6 -0
  234. package/dist/mjs/types/request/spot.js.map +1 -0
  235. package/dist/mjs/types/request/subaccount.d.ts +19 -0
  236. package/dist/mjs/types/request/subaccount.js +2 -0
  237. package/dist/mjs/types/request/subaccount.js.map +1 -0
  238. package/dist/mjs/types/request/unified.d.ts +64 -0
  239. package/dist/mjs/types/request/unified.js +2 -0
  240. package/dist/mjs/types/request/unified.js.map +1 -0
  241. package/dist/mjs/types/request/wallet.d.ts +50 -0
  242. package/dist/mjs/types/request/wallet.js +2 -0
  243. package/dist/mjs/types/request/wallet.js.map +1 -0
  244. package/dist/mjs/types/request/withdrawal.d.ts +12 -0
  245. package/dist/mjs/types/request/withdrawal.js +6 -0
  246. package/dist/mjs/types/request/withdrawal.js.map +1 -0
  247. package/dist/mjs/types/response/account.d.ts +24 -0
  248. package/dist/mjs/types/response/account.js +6 -0
  249. package/dist/mjs/types/response/account.js.map +1 -0
  250. package/dist/mjs/types/response/collateralloan.d.ts +58 -0
  251. package/dist/mjs/types/response/collateralloan.js +6 -0
  252. package/dist/mjs/types/response/collateralloan.js.map +1 -0
  253. package/dist/mjs/types/response/delivery.d.ts +144 -0
  254. package/dist/mjs/types/response/delivery.js +6 -0
  255. package/dist/mjs/types/response/delivery.js.map +1 -0
  256. package/dist/mjs/types/response/earn.d.ts +60 -0
  257. package/dist/mjs/types/response/earn.js +6 -0
  258. package/dist/mjs/types/response/earn.js.map +1 -0
  259. package/dist/mjs/types/response/earnuni.d.ts +40 -0
  260. package/dist/mjs/types/response/earnuni.js +6 -0
  261. package/dist/mjs/types/response/earnuni.js.map +1 -0
  262. package/dist/mjs/types/response/flashswap.d.ts +32 -0
  263. package/dist/mjs/types/response/flashswap.js +6 -0
  264. package/dist/mjs/types/response/flashswap.js.map +1 -0
  265. package/dist/mjs/types/response/futures.d.ts +398 -0
  266. package/dist/mjs/types/response/futures.js +6 -0
  267. package/dist/mjs/types/response/futures.js.map +1 -0
  268. package/dist/mjs/types/response/margin.d.ts +96 -0
  269. package/dist/mjs/types/response/margin.js +6 -0
  270. package/dist/mjs/types/response/margin.js.map +1 -0
  271. package/dist/mjs/types/response/marginuni.d.ts +39 -0
  272. package/dist/mjs/types/response/marginuni.js +6 -0
  273. package/dist/mjs/types/response/marginuni.js.map +1 -0
  274. package/dist/mjs/types/response/multicollateralLoan.d.ts +151 -0
  275. package/dist/mjs/types/response/multicollateralLoan.js +6 -0
  276. package/dist/mjs/types/response/multicollateralLoan.js.map +1 -0
  277. package/dist/mjs/types/response/options.d.ts +192 -0
  278. package/dist/mjs/types/response/options.js +6 -0
  279. package/dist/mjs/types/response/options.js.map +1 -0
  280. package/dist/mjs/types/response/rebate.d.ts +40 -0
  281. package/dist/mjs/types/response/rebate.js +2 -0
  282. package/dist/mjs/types/response/rebate.js.map +1 -0
  283. package/dist/mjs/types/response/shared.d.ts +5 -0
  284. package/dist/mjs/types/response/shared.js +2 -0
  285. package/dist/mjs/types/response/shared.js.map +1 -0
  286. package/dist/mjs/types/response/spot.d.ts +224 -0
  287. package/dist/mjs/types/response/spot.js +6 -0
  288. package/dist/mjs/types/response/spot.js.map +1 -0
  289. package/dist/mjs/types/response/subaccount.d.ts +40 -0
  290. package/dist/mjs/types/response/subaccount.js +2 -0
  291. package/dist/mjs/types/response/subaccount.js.map +1 -0
  292. package/dist/mjs/types/response/unified.d.ts +113 -0
  293. package/dist/mjs/types/response/unified.js +2 -0
  294. package/dist/mjs/types/response/unified.js.map +1 -0
  295. package/dist/mjs/types/response/wallet.d.ts +181 -0
  296. package/dist/mjs/types/response/wallet.js +2 -0
  297. package/dist/mjs/types/response/wallet.js.map +1 -0
  298. package/dist/mjs/types/response/withdrawal.d.ts +12 -0
  299. package/dist/mjs/types/response/withdrawal.js +2 -0
  300. package/dist/mjs/types/response/withdrawal.js.map +1 -0
  301. package/dist/mjs/types/shared.d.ts +16 -0
  302. package/dist/mjs/types/shared.js +2 -0
  303. package/dist/mjs/types/shared.js.map +1 -0
  304. package/dist/mjs/types/websockets/client.d.ts +44 -0
  305. package/dist/mjs/types/websockets/client.js +5 -0
  306. package/dist/mjs/types/websockets/client.js.map +1 -0
  307. package/dist/mjs/types/websockets/events.d.ts +5 -0
  308. package/dist/mjs/types/websockets/events.js +2 -0
  309. package/dist/mjs/types/websockets/events.js.map +1 -0
  310. package/dist/mjs/types/websockets/requests.d.ts +36 -0
  311. package/dist/mjs/types/websockets/requests.js +2 -0
  312. package/dist/mjs/types/websockets/requests.js.map +1 -0
  313. package/dist/mjs/types/websockets/wsAPI.d.ts +101 -0
  314. package/dist/mjs/types/websockets/wsAPI.js +7 -0
  315. package/dist/mjs/types/websockets/wsAPI.js.map +1 -0
  316. package/package.json +49 -38
  317. package/index.js +0 -1
  318. package/lib/index.d.ts +0 -1
  319. package/lib/index.js +0 -16
  320. package/lib/index.js.map +0 -1
@@ -0,0 +1,78 @@
1
+ import { WSAPIRequest } from '../../types/websockets/requests';
2
+ /**
3
+ * Should be one WS key per unique URL. Some URLs may need a suffix.
4
+ */
5
+ export declare const WS_KEY_MAP: {
6
+ /**
7
+ * Spot & Margin
8
+ * https://www.gate.io/docs/developers/apiv4/ws/en/
9
+ */
10
+ readonly spotV4: "spotV4";
11
+ /**
12
+ * Perpetual futures (USDT)
13
+ * https://www.gate.io/docs/developers/futures/ws/en/#gate-io-futures-websocket-v4
14
+ */
15
+ readonly perpFuturesUSDTV4: "perpFuturesUSDTV4";
16
+ /**
17
+ * Perpetual futures (BTC)
18
+ * https://www.gate.io/docs/developers/futures/ws/en/#gate-io-futures-websocket-v4
19
+ */
20
+ readonly perpFuturesBTCV4: "perpFuturesBTCV4";
21
+ /**
22
+ * Delivery Futures (USDT)
23
+ * https://www.gate.io/docs/developers/delivery/ws/en/
24
+ */
25
+ readonly deliveryFuturesUSDTV4: "deliveryFuturesUSDTV4";
26
+ /**
27
+ * Delivery Futures (BTC)
28
+ * https://www.gate.io/docs/developers/delivery/ws/en/
29
+ */
30
+ readonly deliveryFuturesBTCV4: "deliveryFuturesBTCV4";
31
+ /**
32
+ * Options
33
+ * https://www.gate.io/docs/developers/options/ws/en/
34
+ */
35
+ readonly optionsV4: "optionsV4";
36
+ /**
37
+ * Announcements V4
38
+ * https://www.gate.io/docs/developers/options/ws/en/
39
+ */
40
+ readonly announcementsV4: "announcementsV4";
41
+ };
42
+ /** This is used to differentiate between each of the available websocket streams */
43
+ export type WsKey = (typeof WS_KEY_MAP)[keyof typeof WS_KEY_MAP];
44
+ export type FuturesWsKey = typeof WS_KEY_MAP.perpFuturesUSDTV4 | typeof WS_KEY_MAP.perpFuturesBTCV4 | typeof WS_KEY_MAP.deliveryFuturesUSDTV4 | typeof WS_KEY_MAP.deliveryFuturesBTCV4;
45
+ export type WsMarket = 'all';
46
+ /**
47
+ * Normalised internal format for a request (subscribe/unsubscribe/etc) on a topic, with optional parameters.
48
+ *
49
+ * - Topic: the topic this event is for
50
+ * - Payload: the parameters to include, optional. E.g. auth requires key + sign. Some topics allow configurable parameters.
51
+ */
52
+ export interface WsTopicRequest<TWSTopic extends string = string, TWSPayload = any> {
53
+ topic: TWSTopic;
54
+ payload?: TWSPayload;
55
+ }
56
+ /**
57
+ * Conveniently allow users to request a topic either as string topics or objects (containing string topic + params)
58
+ */
59
+ export type WsTopicRequestOrStringTopic<TWSTopic extends string, TWSPayload = any> = WsTopicRequest<TWSTopic, TWSPayload> | string;
60
+ /**
61
+ * Some exchanges have two livenet environments, some have test environments, some dont. This allows easy flexibility for different exchanges.
62
+ * Examples:
63
+ * - One livenet and one testnet: NetworkMap<'livenet' | 'testnet'>
64
+ * - One livenet, sometimes two, one testnet: NetworkMap<'livenet' | 'testnet', 'livenet2'>
65
+ * - Only one livenet, no other networks: NetworkMap<'livenet'>
66
+ */
67
+ type NetworkMap<TRequiredKeys extends string, TOptionalKeys extends string | undefined = undefined> = Record<TRequiredKeys, string> & (TOptionalKeys extends string ? Record<TOptionalKeys, string | undefined> : Record<TRequiredKeys, string>);
68
+ export declare const WS_BASE_URL_MAP: Record<WsKey, NetworkMap<'livenet' | 'testnet'>>;
69
+ export declare function neverGuard(x: never, msg: string): Error;
70
+ /**
71
+ * WS API promises are stored using a primary key. This key is constructed using
72
+ * properties found in every request & reply.
73
+ */
74
+ export declare function getPromiseRefForWSAPIRequest(requestEvent: WSAPIRequest): string;
75
+ export declare function getPrivateSpotTopics(): string[];
76
+ export declare function getPrivateFuturesTopics(): string[];
77
+ export declare function getPrivateOptionsTopics(): string[];
78
+ export {};
@@ -0,0 +1,153 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.getPrivateOptionsTopics = exports.getPrivateFuturesTopics = exports.getPrivateSpotTopics = exports.getPromiseRefForWSAPIRequest = exports.neverGuard = exports.WS_BASE_URL_MAP = exports.WS_KEY_MAP = void 0;
4
+ /**
5
+ * Should be one WS key per unique URL. Some URLs may need a suffix.
6
+ */
7
+ exports.WS_KEY_MAP = {
8
+ /**
9
+ * Spot & Margin
10
+ * https://www.gate.io/docs/developers/apiv4/ws/en/
11
+ */
12
+ spotV4: 'spotV4',
13
+ /**
14
+ * Perpetual futures (USDT)
15
+ * https://www.gate.io/docs/developers/futures/ws/en/#gate-io-futures-websocket-v4
16
+ */
17
+ perpFuturesUSDTV4: 'perpFuturesUSDTV4',
18
+ /**
19
+ * Perpetual futures (BTC)
20
+ * https://www.gate.io/docs/developers/futures/ws/en/#gate-io-futures-websocket-v4
21
+ */
22
+ perpFuturesBTCV4: 'perpFuturesBTCV4',
23
+ /**
24
+ * Delivery Futures (USDT)
25
+ * https://www.gate.io/docs/developers/delivery/ws/en/
26
+ */
27
+ deliveryFuturesUSDTV4: 'deliveryFuturesUSDTV4',
28
+ /**
29
+ * Delivery Futures (BTC)
30
+ * https://www.gate.io/docs/developers/delivery/ws/en/
31
+ */
32
+ deliveryFuturesBTCV4: 'deliveryFuturesBTCV4',
33
+ /**
34
+ * Options
35
+ * https://www.gate.io/docs/developers/options/ws/en/
36
+ */
37
+ optionsV4: 'optionsV4',
38
+ /**
39
+ * Announcements V4
40
+ * https://www.gate.io/docs/developers/options/ws/en/
41
+ */
42
+ announcementsV4: 'announcementsV4',
43
+ };
44
+ exports.WS_BASE_URL_MAP = {
45
+ spotV4: {
46
+ livenet: 'wss://api.gateio.ws/ws/v4/',
47
+ testnet: 'NoTestnetForSpotWebsockets!',
48
+ },
49
+ perpFuturesUSDTV4: {
50
+ livenet: 'wss://fx-ws.gateio.ws/v4/ws/usdt',
51
+ testnet: 'wss://fx-ws-testnet.gateio.ws/v4/ws/usdt',
52
+ },
53
+ perpFuturesBTCV4: {
54
+ livenet: 'wss://fx-ws.gateio.ws/v4/ws/btc',
55
+ testnet: 'wss://fx-ws-testnet.gateio.ws/v4/ws/btc',
56
+ },
57
+ deliveryFuturesUSDTV4: {
58
+ livenet: 'wss://fx-ws.gateio.ws/v4/ws/delivery/usdt',
59
+ testnet: 'wss://fx-ws-testnet.gateio.ws/v4/ws/delivery/usdt',
60
+ },
61
+ deliveryFuturesBTCV4: {
62
+ livenet: 'wss://fx-ws.gateio.ws/v4/ws/delivery/btc',
63
+ testnet: 'wss://fx-ws-testnet.gateio.ws/v4/ws/delivery/btc',
64
+ },
65
+ optionsV4: {
66
+ livenet: 'wss://op-ws.gateio.live/v4/ws',
67
+ testnet: 'wss://op-ws-testnet.gateio.live/v4/ws',
68
+ },
69
+ announcementsV4: {
70
+ livenet: 'wss://api.gateio.ws/ws/v4/ann',
71
+ testnet: 'NoTestnetForAnnouncementsWebSockets!',
72
+ },
73
+ };
74
+ function neverGuard(x, msg) {
75
+ return new Error(`Unhandled value exception "${x}", ${msg}`);
76
+ }
77
+ exports.neverGuard = neverGuard;
78
+ /**
79
+ * WS API promises are stored using a primary key. This key is constructed using
80
+ * properties found in every request & reply.
81
+ */
82
+ function getPromiseRefForWSAPIRequest(requestEvent) {
83
+ const promiseRef = [requestEvent.channel, requestEvent.payload?.req_id].join('_');
84
+ return promiseRef;
85
+ }
86
+ exports.getPromiseRefForWSAPIRequest = getPromiseRefForWSAPIRequest;
87
+ function getPrivateSpotTopics() {
88
+ // Consumeable channels for spot
89
+ const privateSpotTopics = [
90
+ 'spot.orders',
91
+ 'spot.usertrades',
92
+ 'spot.balances',
93
+ 'spot.margin_balances',
94
+ 'spot.funding_balances',
95
+ 'spot.cross_balances',
96
+ 'spot.priceorders',
97
+ ];
98
+ // WebSocket API for spot
99
+ const privateSpotWSAPITopics = [
100
+ 'spot.login',
101
+ 'spot.order_place',
102
+ 'spot.order_cancel',
103
+ 'spot.order_cancel_ids',
104
+ 'spot.order_cancel_cp',
105
+ 'spot.order_amend',
106
+ 'spot.order_status',
107
+ ];
108
+ return [...privateSpotTopics, ...privateSpotWSAPITopics];
109
+ }
110
+ exports.getPrivateSpotTopics = getPrivateSpotTopics;
111
+ function getPrivateFuturesTopics() {
112
+ // These are the same for perps vs delivery futures
113
+ const privatePerpetualFuturesTopics = [
114
+ 'futures.orders',
115
+ 'futures.usertrades',
116
+ 'futures.liquidates',
117
+ 'futures.auto_deleverages',
118
+ 'futures.position_closes',
119
+ 'futures.balances',
120
+ 'futures.reduce_risk_limits',
121
+ 'futures.positions',
122
+ 'futures.autoorders',
123
+ ];
124
+ const privatePerpetualFuturesWSAPITopics = [
125
+ 'futures.login',
126
+ 'futures.order_place',
127
+ 'futures.order_batch_place',
128
+ 'futures.order_cancel',
129
+ 'futures.order_cancel_cp',
130
+ 'futures.order_amend',
131
+ 'futures.order_list',
132
+ 'futures.order_status',
133
+ ];
134
+ return [
135
+ ...privatePerpetualFuturesTopics,
136
+ ...privatePerpetualFuturesWSAPITopics,
137
+ ];
138
+ }
139
+ exports.getPrivateFuturesTopics = getPrivateFuturesTopics;
140
+ function getPrivateOptionsTopics() {
141
+ const privateOptionsTopics = [
142
+ 'options.orders',
143
+ 'options.usertrades',
144
+ 'options.liquidates',
145
+ 'options.user_settlements',
146
+ 'options.position_closes',
147
+ 'options.balances',
148
+ 'options.positions',
149
+ ];
150
+ return [...privateOptionsTopics];
151
+ }
152
+ exports.getPrivateOptionsTopics = getPrivateOptionsTopics;
153
+ //# sourceMappingURL=websocket-util.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"websocket-util.js","sourceRoot":"","sources":["../../../../src/lib/websocket/websocket-util.ts"],"names":[],"mappings":";;;AAMA;;GAEG;AACU,QAAA,UAAU,GAAG;IACxB;;;OAGG;IACH,MAAM,EAAE,QAAQ;IAChB;;;OAGG;IACH,iBAAiB,EAAE,mBAAmB;IACtC;;;OAGG;IACH,gBAAgB,EAAE,kBAAkB;IACpC;;;OAGG;IACH,qBAAqB,EAAE,uBAAuB;IAC9C;;;OAGG;IACH,oBAAoB,EAAE,sBAAsB;IAC5C;;;OAGG;IACH,SAAS,EAAE,WAAW;IACtB;;;OAGG;IACH,eAAe,EAAE,iBAAiB;CAC1B,CAAC;AAkDE,QAAA,eAAe,GAGxB;IACF,MAAM,EAAE;QACN,OAAO,EAAE,4BAA4B;QACrC,OAAO,EAAE,6BAA6B;KACvC;IACD,iBAAiB,EAAE;QACjB,OAAO,EAAE,kCAAkC;QAC3C,OAAO,EAAE,0CAA0C;KACpD;IACD,gBAAgB,EAAE;QAChB,OAAO,EAAE,iCAAiC;QAC1C,OAAO,EAAE,yCAAyC;KACnD;IACD,qBAAqB,EAAE;QACrB,OAAO,EAAE,2CAA2C;QACpD,OAAO,EAAE,mDAAmD;KAC7D;IACD,oBAAoB,EAAE;QACpB,OAAO,EAAE,0CAA0C;QACnD,OAAO,EAAE,kDAAkD;KAC5D;IACD,SAAS,EAAE;QACT,OAAO,EAAE,+BAA+B;QACxC,OAAO,EAAE,uCAAuC;KACjD;IACD,eAAe,EAAE;QACf,OAAO,EAAE,+BAA+B;QACxC,OAAO,EAAE,sCAAsC;KAChD;CACF,CAAC;AAEF,SAAgB,UAAU,CAAC,CAAQ,EAAE,GAAW;IAC9C,OAAO,IAAI,KAAK,CAAC,8BAA8B,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC;AAC/D,CAAC;AAFD,gCAEC;AAED;;;GAGG;AACH,SAAgB,4BAA4B,CAC1C,YAA0B;IAE1B,MAAM,UAAU,GAAG,CAAC,YAAY,CAAC,OAAO,EAAE,YAAY,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,IAAI,CAC1E,GAAG,CACJ,CAAC;IACF,OAAO,UAAU,CAAC;AACpB,CAAC;AAPD,oEAOC;AAED,SAAgB,oBAAoB;IAClC,gCAAgC;IAChC,MAAM,iBAAiB,GAAG;QACxB,aAAa;QACb,iBAAiB;QACjB,eAAe;QACf,sBAAsB;QACtB,uBAAuB;QACvB,qBAAqB;QACrB,kBAAkB;KACnB,CAAC;IAEF,yBAAyB;IACzB,MAAM,sBAAsB,GAAqB;QAC/C,YAAY;QACZ,kBAAkB;QAClB,mBAAmB;QACnB,uBAAuB;QACvB,sBAAsB;QACtB,kBAAkB;QAClB,mBAAmB;KACpB,CAAC;IAEF,OAAO,CAAC,GAAG,iBAAiB,EAAE,GAAG,sBAAsB,CAAC,CAAC;AAC3D,CAAC;AAxBD,oDAwBC;AAED,SAAgB,uBAAuB;IACrC,mDAAmD;IACnD,MAAM,6BAA6B,GAAG;QACpC,gBAAgB;QAChB,oBAAoB;QACpB,oBAAoB;QACpB,0BAA0B;QAC1B,yBAAyB;QACzB,kBAAkB;QAClB,4BAA4B;QAC5B,mBAAmB;QACnB,oBAAoB;KACrB,CAAC;IAEF,MAAM,kCAAkC,GAAwB;QAC9D,eAAe;QACf,qBAAqB;QACrB,2BAA2B;QAC3B,sBAAsB;QACtB,yBAAyB;QACzB,qBAAqB;QACrB,oBAAoB;QACpB,sBAAsB;KACvB,CAAC;IAEF,OAAO;QACL,GAAG,6BAA6B;QAChC,GAAG,kCAAkC;KACtC,CAAC;AACJ,CAAC;AA7BD,0DA6BC;AAED,SAAgB,uBAAuB;IACrC,MAAM,oBAAoB,GAAG;QAC3B,gBAAgB;QAChB,oBAAoB;QACpB,oBAAoB;QACpB,0BAA0B;QAC1B,yBAAyB;QACzB,kBAAkB;QAClB,mBAAmB;KACpB,CAAC;IAEF,OAAO,CAAC,GAAG,oBAAoB,CAAC,CAAC;AACnC,CAAC;AAZD,0DAYC"}
@@ -0,0 +1,3 @@
1
+ {
2
+ "type": "commonjs"
3
+ }
@@ -0,0 +1,10 @@
1
+ /**==========================================================================================================================
2
+ * ACCOUNT
3
+ * ==========================================================================================================================
4
+ */
5
+ export interface CreateStpGroupReq {
6
+ name: string;
7
+ id?: number;
8
+ creator_id?: number;
9
+ create_time?: number;
10
+ }
@@ -0,0 +1,7 @@
1
+ "use strict";
2
+ /**==========================================================================================================================
3
+ * ACCOUNT
4
+ * ==========================================================================================================================
5
+ */
6
+ Object.defineProperty(exports, "__esModule", { value: true });
7
+ //# sourceMappingURL=account.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"account.js","sourceRoot":"","sources":["../../../../src/types/request/account.ts"],"names":[],"mappings":";AAAA;;;GAGG"}
@@ -0,0 +1,39 @@
1
+ /**==========================================================================================================================
2
+ * COLLATERAL LOAN
3
+ * ==========================================================================================================================
4
+ */
5
+ export interface SubmitLoanOrderReq {
6
+ collateral_amount: string;
7
+ collateral_currency: string;
8
+ borrow_amount: string;
9
+ borrow_currency: string;
10
+ }
11
+ export interface GetLoanOrdersReq {
12
+ page?: number;
13
+ limit?: number;
14
+ collateral_currency?: string;
15
+ borrow_currency?: string;
16
+ }
17
+ export interface GetLoanRepaymentHistoryReq {
18
+ source: 'repay' | 'liquidate';
19
+ borrow_currency?: string;
20
+ collateral_currency?: string;
21
+ page?: number;
22
+ limit?: number;
23
+ from?: number;
24
+ to?: number;
25
+ }
26
+ export interface UpdateLoanCollateralReq {
27
+ order_id: number;
28
+ collateral_currency: string;
29
+ collateral_amount: string;
30
+ type: 'append' | 'redeem';
31
+ }
32
+ export interface GetLoanCollateralRecordsReq {
33
+ page?: number;
34
+ limit?: number;
35
+ from?: number;
36
+ to?: number;
37
+ borrow_currency?: string;
38
+ collateral_currency?: string;
39
+ }
@@ -0,0 +1,7 @@
1
+ "use strict";
2
+ /**==========================================================================================================================
3
+ * COLLATERAL LOAN
4
+ * ==========================================================================================================================
5
+ */
6
+ Object.defineProperty(exports, "__esModule", { value: true });
7
+ //# sourceMappingURL=collateralLoan.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"collateralLoan.js","sourceRoot":"","sources":["../../../../src/types/request/collateralLoan.ts"],"names":[],"mappings":";AAAA;;;GAGG"}
@@ -0,0 +1,89 @@
1
+ /**==========================================================================================================================
2
+ * DELIVERY
3
+ * ==========================================================================================================================
4
+ */
5
+ export interface GetDeliveryOrderBookReq {
6
+ settle: 'usdt';
7
+ contract: string;
8
+ interval?: '0' | '0.1' | '0.01';
9
+ limit?: number;
10
+ with_id?: boolean;
11
+ }
12
+ export interface GetDeliveryTradesReq {
13
+ settle: 'usdt';
14
+ contract: string;
15
+ limit?: number;
16
+ last_id?: string;
17
+ from?: number;
18
+ to?: number;
19
+ }
20
+ export interface GetDeliveryCandlesReq {
21
+ settle: 'usdt';
22
+ contract: string;
23
+ from?: number;
24
+ to?: number;
25
+ limit?: number;
26
+ interval?: '10s' | '30s' | '1m' | '5m' | '15m' | '30m' | '1h' | '2h' | '4h' | '6h' | '8h' | '12h' | '1d' | '7d' | '1w' | '30d';
27
+ }
28
+ export interface GetDeliveryBookReq {
29
+ settle: 'usdt';
30
+ limit?: number;
31
+ from?: number;
32
+ to?: number;
33
+ type?: 'dnw' | 'pnl' | 'fee' | 'refr' | 'fund' | 'point_dnw' | 'point_fee' | 'point_refr' | 'bonus_offset';
34
+ }
35
+ export interface SubmitDeliveryFuturesOrderReq {
36
+ settle: 'usdt';
37
+ contract: string;
38
+ size: number;
39
+ iceberg?: number;
40
+ price?: string;
41
+ close?: boolean;
42
+ reduce_only?: boolean;
43
+ tif?: string;
44
+ text?: string;
45
+ auto_size?: string;
46
+ stp_act?: string;
47
+ }
48
+ export interface GetDeliveryOrdersReq {
49
+ settle: 'usdt';
50
+ contract?: string;
51
+ status: 'open' | 'finished';
52
+ limit?: number;
53
+ offset?: number;
54
+ last_id?: string;
55
+ count_total?: 0 | 1;
56
+ }
57
+ export interface GetDeliveryTradingHistoryReq {
58
+ settle: 'usdt';
59
+ contract?: string;
60
+ order?: number;
61
+ limit?: number;
62
+ offset?: number;
63
+ last_id?: string;
64
+ count_total?: 0 | 1;
65
+ }
66
+ export interface GetDeliveryClosedPositionsReq {
67
+ settle: 'usdt';
68
+ contract?: string;
69
+ limit?: number;
70
+ }
71
+ export interface GetDeliveryLiquidationHistoryReq {
72
+ settle: 'usdt';
73
+ contract?: string;
74
+ limit?: number;
75
+ at?: number;
76
+ }
77
+ export interface GetDeliverySettlementHistoryReq {
78
+ settle: 'usdt';
79
+ contract?: string;
80
+ limit?: number;
81
+ at?: number;
82
+ }
83
+ export interface GetDeliveryAutoOrdersReq {
84
+ settle: 'usdt';
85
+ status: 'open' | 'finished';
86
+ contract?: string;
87
+ limit?: number;
88
+ offset?: number;
89
+ }
@@ -0,0 +1,7 @@
1
+ "use strict";
2
+ /**==========================================================================================================================
3
+ * DELIVERY
4
+ * ==========================================================================================================================
5
+ */
6
+ Object.defineProperty(exports, "__esModule", { value: true });
7
+ //# sourceMappingURL=delivery.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"delivery.js","sourceRoot":"","sources":["../../../../src/types/request/delivery.ts"],"names":[],"mappings":";AAAA;;;GAGG"}
@@ -0,0 +1,16 @@
1
+ /**==========================================================================================================================
2
+ * EARN
3
+ * ==========================================================================================================================
4
+ */
5
+ export interface GetStructuredProductListReq {
6
+ status: string;
7
+ type?: string;
8
+ page?: number;
9
+ limit?: number;
10
+ }
11
+ export interface GetStructuredProductOrdersReq {
12
+ from?: number;
13
+ to?: number;
14
+ page?: number;
15
+ limit?: number;
16
+ }
@@ -0,0 +1,7 @@
1
+ "use strict";
2
+ /**==========================================================================================================================
3
+ * EARN
4
+ * ==========================================================================================================================
5
+ */
6
+ Object.defineProperty(exports, "__esModule", { value: true });
7
+ //# sourceMappingURL=earn.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"earn.js","sourceRoot":"","sources":["../../../../src/types/request/earn.ts"],"names":[],"mappings":";AAAA;;;GAGG"}
@@ -0,0 +1,30 @@
1
+ /**==========================================================================================================================
2
+ * EARN UNI
3
+ * ==========================================================================================================================
4
+ */
5
+ export interface SubmitLendOrRedeemReq {
6
+ currency: string;
7
+ amount: string;
8
+ type: 'lend' | 'redeem';
9
+ min_rate?: string;
10
+ }
11
+ export interface GetLendingOrdersReq {
12
+ currency?: string;
13
+ page?: number;
14
+ limit?: number;
15
+ }
16
+ export interface GetLendingRecordsReq {
17
+ currency?: string;
18
+ page?: number;
19
+ limit?: number;
20
+ from?: number;
21
+ to?: number;
22
+ type?: 'lend' | 'redeem';
23
+ }
24
+ export interface GetLendingInterestRecordsReq {
25
+ currency?: string;
26
+ page?: number;
27
+ limit?: number;
28
+ from?: number;
29
+ to?: number;
30
+ }
@@ -0,0 +1,7 @@
1
+ "use strict";
2
+ /**==========================================================================================================================
3
+ * EARN UNI
4
+ * ==========================================================================================================================
5
+ */
6
+ Object.defineProperty(exports, "__esModule", { value: true });
7
+ //# sourceMappingURL=earnuni.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"earnuni.js","sourceRoot":"","sources":["../../../../src/types/request/earnuni.ts"],"names":[],"mappings":";AAAA;;;GAGG"}
@@ -0,0 +1,28 @@
1
+ /**==========================================================================================================================
2
+ * FLASH SWAP
3
+ * ==========================================================================================================================
4
+ */
5
+ export interface SubmitFlashSwapOrderReq {
6
+ preview_id: string;
7
+ sell_currency: string;
8
+ sell_amount: string;
9
+ buy_currency: string;
10
+ buy_amount: string;
11
+ }
12
+ export interface GetFlashSwapOrdersReq {
13
+ status?: number;
14
+ sell_currency?: string;
15
+ buy_currency?: string;
16
+ reverse?: boolean;
17
+ limit?: number;
18
+ page?: number;
19
+ }
20
+ export interface GetFlashSwapOrderReq {
21
+ order_id: number;
22
+ }
23
+ export interface SubmitFlashSwapOrderPreviewReq {
24
+ sell_currency: string;
25
+ sell_amount?: string;
26
+ buy_currency: string;
27
+ buy_amount?: string;
28
+ }
@@ -0,0 +1,7 @@
1
+ "use strict";
2
+ /**==========================================================================================================================
3
+ * FLASH SWAP
4
+ * ==========================================================================================================================
5
+ */
6
+ Object.defineProperty(exports, "__esModule", { value: true });
7
+ //# sourceMappingURL=flashswap.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"flashswap.js","sourceRoot":"","sources":["../../../../src/types/request/flashswap.ts"],"names":[],"mappings":";AAAA;;;GAGG"}