zklighter-perps 1.0.4 → 1.0.5

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.
package/apis/BlockApi.ts CHANGED
@@ -17,12 +17,15 @@ import * as runtime from '../runtime';
17
17
  import type {
18
18
  Blocks,
19
19
  CurrentHeight,
20
+ ResultCode,
20
21
  } from '../models/index';
21
22
  import {
22
23
  BlocksFromJSON,
23
24
  BlocksToJSON,
24
25
  CurrentHeightFromJSON,
25
26
  CurrentHeightToJSON,
27
+ ResultCodeFromJSON,
28
+ ResultCodeToJSON,
26
29
  } from '../models/index';
27
30
 
28
31
  export interface GetBlockRequest {
@@ -17,12 +17,15 @@ import * as runtime from '../runtime';
17
17
  import type {
18
18
  Candlesticks,
19
19
  Fundings,
20
+ ResultCode,
20
21
  } from '../models/index';
21
22
  import {
22
23
  CandlesticksFromJSON,
23
24
  CandlesticksToJSON,
24
25
  FundingsFromJSON,
25
26
  FundingsToJSON,
27
+ ResultCodeFromJSON,
28
+ ResultCodeToJSON,
26
29
  } from '../models/index';
27
30
 
28
31
  export interface GetCandlesticksRequest {
package/apis/InfoApi.ts CHANGED
@@ -17,6 +17,7 @@ import * as runtime from '../runtime';
17
17
  import type {
18
18
  Layer1BasicInfo,
19
19
  Layer2BasicInfo,
20
+ ResultCode,
20
21
  Rollbacks,
21
22
  Search,
22
23
  } from '../models/index';
@@ -25,6 +26,8 @@ import {
25
26
  Layer1BasicInfoToJSON,
26
27
  Layer2BasicInfoFromJSON,
27
28
  Layer2BasicInfoToJSON,
29
+ ResultCodeFromJSON,
30
+ ResultCodeToJSON,
28
31
  RollbacksFromJSON,
29
32
  RollbacksToJSON,
30
33
  SearchFromJSON,
package/apis/OrderApi.ts CHANGED
@@ -20,6 +20,7 @@ import type {
20
20
  OrderBookOrders,
21
21
  OrderBooks,
22
22
  Orders,
23
+ ResultCode,
23
24
  Trades,
24
25
  } from '../models/index';
25
26
  import {
@@ -33,6 +34,8 @@ import {
33
34
  OrderBooksToJSON,
34
35
  OrdersFromJSON,
35
36
  OrdersToJSON,
37
+ ResultCodeFromJSON,
38
+ ResultCodeToJSON,
36
39
  TradesFromJSON,
37
40
  TradesToJSON,
38
41
  } from '../models/index';
@@ -16,10 +16,13 @@
16
16
  import * as runtime from '../runtime';
17
17
  import type {
18
18
  MarketSig,
19
+ ResultCode,
19
20
  } from '../models/index';
20
21
  import {
21
22
  MarketSigFromJSON,
22
23
  MarketSigToJSON,
24
+ ResultCodeFromJSON,
25
+ ResultCodeToJSON,
23
26
  } from '../models/index';
24
27
 
25
28
  export interface GetMarketSigRequest {
package/apis/RootApi.ts CHANGED
@@ -15,13 +15,22 @@
15
15
 
16
16
  import * as runtime from '../runtime';
17
17
  import type {
18
+ ResultCode,
18
19
  Status,
19
20
  } from '../models/index';
20
21
  import {
22
+ ResultCodeFromJSON,
23
+ ResultCodeToJSON,
21
24
  StatusFromJSON,
22
25
  StatusToJSON,
23
26
  } from '../models/index';
24
27
 
28
+ export interface SendFeedbackRequest {
29
+ content: string;
30
+ name?: string;
31
+ email?: string;
32
+ }
33
+
25
34
  /**
26
35
  *
27
36
  */
@@ -53,4 +62,64 @@ export class RootApi extends runtime.BaseAPI {
53
62
  return await response.value();
54
63
  }
55
64
 
65
+ /**
66
+ * Send feedback
67
+ */
68
+ async sendFeedbackRaw(requestParameters: SendFeedbackRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ResultCode>> {
69
+ if (requestParameters['content'] == null) {
70
+ throw new runtime.RequiredError(
71
+ 'content',
72
+ 'Required parameter "content" was null or undefined when calling sendFeedback().'
73
+ );
74
+ }
75
+
76
+ const queryParameters: any = {};
77
+
78
+ const headerParameters: runtime.HTTPHeaders = {};
79
+
80
+ const consumes: runtime.Consume[] = [
81
+ { contentType: 'multipart/form-data' },
82
+ ];
83
+ // @ts-ignore: canConsumeForm may be unused
84
+ const canConsumeForm = runtime.canConsumeForm(consumes);
85
+
86
+ let formParams: { append(param: string, value: any): any };
87
+ let useForm = false;
88
+ if (useForm) {
89
+ formParams = new FormData();
90
+ } else {
91
+ formParams = new URLSearchParams();
92
+ }
93
+
94
+ if (requestParameters['name'] != null) {
95
+ formParams.append('name', requestParameters['name'] as any);
96
+ }
97
+
98
+ if (requestParameters['email'] != null) {
99
+ formParams.append('email', requestParameters['email'] as any);
100
+ }
101
+
102
+ if (requestParameters['content'] != null) {
103
+ formParams.append('content', requestParameters['content'] as any);
104
+ }
105
+
106
+ const response = await this.request({
107
+ path: `/api/v1/feedback`,
108
+ method: 'POST',
109
+ headers: headerParameters,
110
+ query: queryParameters,
111
+ body: formParams,
112
+ }, initOverrides);
113
+
114
+ return new runtime.JSONApiResponse(response, (jsonValue) => ResultCodeFromJSON(jsonValue));
115
+ }
116
+
117
+ /**
118
+ * Send feedback
119
+ */
120
+ async sendFeedback(requestParameters: SendFeedbackRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ResultCode> {
121
+ const response = await this.sendFeedbackRaw(requestParameters, initOverrides);
122
+ return await response.value();
123
+ }
124
+
56
125
  }
@@ -17,6 +17,7 @@ import * as runtime from '../runtime';
17
17
  import type {
18
18
  EnrichedTx,
19
19
  NextNonce,
20
+ ResultCode,
20
21
  SignBody,
21
22
  TxHash,
22
23
  Txs,
@@ -26,6 +27,8 @@ import {
26
27
  EnrichedTxToJSON,
27
28
  NextNonceFromJSON,
28
29
  NextNonceToJSON,
30
+ ResultCodeFromJSON,
31
+ ResultCodeToJSON,
29
32
  SignBodyFromJSON,
30
33
  SignBodyToJSON,
31
34
  TxHashFromJSON,
package/openapi.json CHANGED
@@ -25,6 +25,12 @@
25
25
  "schema": {
26
26
  "$ref": "#/definitions/Status"
27
27
  }
28
+ },
29
+ "400": {
30
+ "description": "Bad request",
31
+ "schema": {
32
+ "$ref": "#/definitions/ResultCode"
33
+ }
28
34
  }
29
35
  },
30
36
  "tags": [
@@ -42,6 +48,12 @@
42
48
  "schema": {
43
49
  "$ref": "#/definitions/DetailedAccounts"
44
50
  }
51
+ },
52
+ "400": {
53
+ "description": "Bad request",
54
+ "schema": {
55
+ "$ref": "#/definitions/ResultCode"
56
+ }
45
57
  }
46
58
  },
47
59
  "parameters": [
@@ -89,6 +101,12 @@
89
101
  "schema": {
90
102
  "$ref": "#/definitions/Orders"
91
103
  }
104
+ },
105
+ "400": {
106
+ "description": "Bad request",
107
+ "schema": {
108
+ "$ref": "#/definitions/ResultCode"
109
+ }
92
110
  }
93
111
  },
94
112
  "parameters": [
@@ -134,6 +152,12 @@
134
152
  "schema": {
135
153
  "$ref": "#/definitions/Orders"
136
154
  }
155
+ },
156
+ "400": {
157
+ "description": "Bad request",
158
+ "schema": {
159
+ "$ref": "#/definitions/ResultCode"
160
+ }
137
161
  }
138
162
  },
139
163
  "parameters": [
@@ -204,6 +228,12 @@
204
228
  "schema": {
205
229
  "$ref": "#/definitions/Orders"
206
230
  }
231
+ },
232
+ "400": {
233
+ "description": "Bad request",
234
+ "schema": {
235
+ "$ref": "#/definitions/ResultCode"
236
+ }
207
237
  }
208
238
  },
209
239
  "parameters": [
@@ -255,6 +285,12 @@
255
285
  "schema": {
256
286
  "$ref": "#/definitions/Txs"
257
287
  }
288
+ },
289
+ "400": {
290
+ "description": "Bad request",
291
+ "schema": {
292
+ "$ref": "#/definitions/ResultCode"
293
+ }
258
294
  }
259
295
  },
260
296
  "parameters": [
@@ -300,6 +336,12 @@
300
336
  "schema": {
301
337
  "$ref": "#/definitions/Txs"
302
338
  }
339
+ },
340
+ "400": {
341
+ "description": "Bad request",
342
+ "schema": {
343
+ "$ref": "#/definitions/ResultCode"
344
+ }
303
345
  }
304
346
  },
305
347
  "parameters": [
@@ -361,6 +403,12 @@
361
403
  "schema": {
362
404
  "$ref": "#/definitions/MainAccounts"
363
405
  }
406
+ },
407
+ "400": {
408
+ "description": "Bad request",
409
+ "schema": {
410
+ "$ref": "#/definitions/ResultCode"
411
+ }
364
412
  }
365
413
  },
366
414
  "parameters": [
@@ -410,6 +458,12 @@
410
458
  "schema": {
411
459
  "$ref": "#/definitions/SubAccounts"
412
460
  }
461
+ },
462
+ "400": {
463
+ "description": "Bad request",
464
+ "schema": {
465
+ "$ref": "#/definitions/ResultCode"
466
+ }
413
467
  }
414
468
  },
415
469
  "parameters": [
@@ -438,6 +492,12 @@
438
492
  "schema": {
439
493
  "$ref": "#/definitions/Blocks"
440
494
  }
495
+ },
496
+ "400": {
497
+ "description": "Bad request",
498
+ "schema": {
499
+ "$ref": "#/definitions/ResultCode"
500
+ }
441
501
  }
442
502
  },
443
503
  "parameters": [
@@ -476,6 +536,12 @@
476
536
  "schema": {
477
537
  "$ref": "#/definitions/Txs"
478
538
  }
539
+ },
540
+ "400": {
541
+ "description": "Bad request",
542
+ "schema": {
543
+ "$ref": "#/definitions/ResultCode"
544
+ }
479
545
  }
480
546
  },
481
547
  "parameters": [
@@ -514,6 +580,12 @@
514
580
  "schema": {
515
581
  "$ref": "#/definitions/Blocks"
516
582
  }
583
+ },
584
+ "400": {
585
+ "description": "Bad request",
586
+ "schema": {
587
+ "$ref": "#/definitions/ResultCode"
588
+ }
517
589
  }
518
590
  },
519
591
  "parameters": [
@@ -563,6 +635,12 @@
563
635
  "schema": {
564
636
  "$ref": "#/definitions/Candlesticks"
565
637
  }
638
+ },
639
+ "400": {
640
+ "description": "Bad request",
641
+ "schema": {
642
+ "$ref": "#/definitions/ResultCode"
643
+ }
566
644
  }
567
645
  },
568
646
  "parameters": [
@@ -626,6 +704,12 @@
626
704
  "schema": {
627
705
  "$ref": "#/definitions/CurrentHeight"
628
706
  }
707
+ },
708
+ "400": {
709
+ "description": "Bad request",
710
+ "schema": {
711
+ "$ref": "#/definitions/ResultCode"
712
+ }
629
713
  }
630
714
  },
631
715
  "tags": [
@@ -643,6 +727,12 @@
643
727
  "schema": {
644
728
  "$ref": "#/definitions/ExchangeStats"
645
729
  }
730
+ },
731
+ "400": {
732
+ "description": "Bad request",
733
+ "schema": {
734
+ "$ref": "#/definitions/ResultCode"
735
+ }
646
736
  }
647
737
  },
648
738
  "tags": [
@@ -660,6 +750,12 @@
660
750
  "schema": {
661
751
  "$ref": "#/definitions/ResultCode"
662
752
  }
753
+ },
754
+ "400": {
755
+ "description": "Bad request",
756
+ "schema": {
757
+ "$ref": "#/definitions/ResultCode"
758
+ }
663
759
  }
664
760
  },
665
761
  "parameters": [
@@ -678,6 +774,42 @@
678
774
  ]
679
775
  }
680
776
  },
777
+ "/api/v1/feedback": {
778
+ "post": {
779
+ "summary": "Send feedback",
780
+ "operationId": "SendFeedback",
781
+ "responses": {
782
+ "200": {
783
+ "description": "A successful response.",
784
+ "schema": {
785
+ "$ref": "#/definitions/ResultCode"
786
+ }
787
+ },
788
+ "400": {
789
+ "description": "Bad request",
790
+ "schema": {
791
+ "$ref": "#/definitions/ResultCode"
792
+ }
793
+ }
794
+ },
795
+ "parameters": [
796
+ {
797
+ "name": "body",
798
+ "in": "body",
799
+ "required": true,
800
+ "schema": {
801
+ "$ref": "#/definitions/ReqSendFeedback"
802
+ }
803
+ }
804
+ ],
805
+ "tags": [
806
+ "root"
807
+ ],
808
+ "consumes": [
809
+ "multipart/form-data"
810
+ ]
811
+ }
812
+ },
681
813
  "/api/v1/fundings": {
682
814
  "get": {
683
815
  "summary": "Get fundings",
@@ -688,6 +820,12 @@
688
820
  "schema": {
689
821
  "$ref": "#/definitions/Fundings"
690
822
  }
823
+ },
824
+ "400": {
825
+ "description": "Bad request",
826
+ "schema": {
827
+ "$ref": "#/definitions/ResultCode"
828
+ }
691
829
  }
692
830
  },
693
831
  "parameters": [
@@ -747,6 +885,12 @@
747
885
  "schema": {
748
886
  "$ref": "#/definitions/SignBody"
749
887
  }
888
+ },
889
+ "400": {
890
+ "description": "Bad request",
891
+ "schema": {
892
+ "$ref": "#/definitions/ResultCode"
893
+ }
750
894
  }
751
895
  },
752
896
  "parameters": [
@@ -777,6 +921,12 @@
777
921
  "schema": {
778
922
  "$ref": "#/definitions/Layer1BasicInfo"
779
923
  }
924
+ },
925
+ "400": {
926
+ "description": "Bad request",
927
+ "schema": {
928
+ "$ref": "#/definitions/ResultCode"
929
+ }
780
930
  }
781
931
  },
782
932
  "tags": [
@@ -794,6 +944,12 @@
794
944
  "schema": {
795
945
  "$ref": "#/definitions/Layer2BasicInfo"
796
946
  }
947
+ },
948
+ "400": {
949
+ "description": "Bad request",
950
+ "schema": {
951
+ "$ref": "#/definitions/ResultCode"
952
+ }
797
953
  }
798
954
  },
799
955
  "tags": [
@@ -811,6 +967,12 @@
811
967
  "schema": {
812
968
  "$ref": "#/definitions/NextNonce"
813
969
  }
970
+ },
971
+ "400": {
972
+ "description": "Bad request",
973
+ "schema": {
974
+ "$ref": "#/definitions/ResultCode"
975
+ }
814
976
  }
815
977
  },
816
978
  "parameters": [
@@ -847,6 +1009,12 @@
847
1009
  "schema": {
848
1010
  "$ref": "#/definitions/OrderBookDetails"
849
1011
  }
1012
+ },
1013
+ "400": {
1014
+ "description": "Bad request",
1015
+ "schema": {
1016
+ "$ref": "#/definitions/ResultCode"
1017
+ }
850
1018
  }
851
1019
  },
852
1020
  "parameters": [
@@ -886,6 +1054,12 @@
886
1054
  "schema": {
887
1055
  "$ref": "#/definitions/OrderBookOrders"
888
1056
  }
1057
+ },
1058
+ "400": {
1059
+ "description": "Bad request",
1060
+ "schema": {
1061
+ "$ref": "#/definitions/ResultCode"
1062
+ }
889
1063
  }
890
1064
  },
891
1065
  "parameters": [
@@ -924,6 +1098,12 @@
924
1098
  "schema": {
925
1099
  "$ref": "#/definitions/OrderBooks"
926
1100
  }
1101
+ },
1102
+ "400": {
1103
+ "description": "Bad request",
1104
+ "schema": {
1105
+ "$ref": "#/definitions/ResultCode"
1106
+ }
927
1107
  }
928
1108
  },
929
1109
  "parameters": [
@@ -963,6 +1143,12 @@
963
1143
  "schema": {
964
1144
  "$ref": "#/definitions/Txs"
965
1145
  }
1146
+ },
1147
+ "400": {
1148
+ "description": "Bad request",
1149
+ "schema": {
1150
+ "$ref": "#/definitions/ResultCode"
1151
+ }
966
1152
  }
967
1153
  },
968
1154
  "parameters": [
@@ -1001,6 +1187,12 @@
1001
1187
  "schema": {
1002
1188
  "$ref": "#/definitions/Permission"
1003
1189
  }
1190
+ },
1191
+ "400": {
1192
+ "description": "Bad request",
1193
+ "schema": {
1194
+ "$ref": "#/definitions/ResultCode"
1195
+ }
1004
1196
  }
1005
1197
  },
1006
1198
  "parameters": [
@@ -1046,6 +1238,12 @@
1046
1238
  "schema": {
1047
1239
  "$ref": "#/definitions/AccountPnL"
1048
1240
  }
1241
+ },
1242
+ "400": {
1243
+ "description": "Bad request",
1244
+ "schema": {
1245
+ "$ref": "#/definitions/ResultCode"
1246
+ }
1049
1247
  }
1050
1248
  },
1051
1249
  "parameters": [
@@ -1119,6 +1317,12 @@
1119
1317
  "schema": {
1120
1318
  "$ref": "#/definitions/MarketSig"
1121
1319
  }
1320
+ },
1321
+ "400": {
1322
+ "description": "Bad request",
1323
+ "schema": {
1324
+ "$ref": "#/definitions/ResultCode"
1325
+ }
1122
1326
  }
1123
1327
  },
1124
1328
  "parameters": [
@@ -1162,6 +1366,12 @@
1162
1366
  "schema": {
1163
1367
  "$ref": "#/definitions/Trades"
1164
1368
  }
1369
+ },
1370
+ "400": {
1371
+ "description": "Bad request",
1372
+ "schema": {
1373
+ "$ref": "#/definitions/ResultCode"
1374
+ }
1165
1375
  }
1166
1376
  },
1167
1377
  "parameters": [
@@ -1200,6 +1410,12 @@
1200
1410
  "schema": {
1201
1411
  "$ref": "#/definitions/Rollbacks"
1202
1412
  }
1413
+ },
1414
+ "400": {
1415
+ "description": "Bad request",
1416
+ "schema": {
1417
+ "$ref": "#/definitions/ResultCode"
1418
+ }
1203
1419
  }
1204
1420
  },
1205
1421
  "parameters": [
@@ -1247,6 +1463,12 @@
1247
1463
  "schema": {
1248
1464
  "$ref": "#/definitions/Search"
1249
1465
  }
1466
+ },
1467
+ "400": {
1468
+ "description": "Bad request",
1469
+ "schema": {
1470
+ "$ref": "#/definitions/ResultCode"
1471
+ }
1250
1472
  }
1251
1473
  },
1252
1474
  "parameters": [
@@ -1275,6 +1497,12 @@
1275
1497
  "schema": {
1276
1498
  "$ref": "#/definitions/TxHash"
1277
1499
  }
1500
+ },
1501
+ "400": {
1502
+ "description": "Bad request",
1503
+ "schema": {
1504
+ "$ref": "#/definitions/ResultCode"
1505
+ }
1278
1506
  }
1279
1507
  },
1280
1508
  "parameters": [
@@ -1305,6 +1533,12 @@
1305
1533
  "schema": {
1306
1534
  "$ref": "#/definitions/Trades"
1307
1535
  }
1536
+ },
1537
+ "400": {
1538
+ "description": "Bad request",
1539
+ "schema": {
1540
+ "$ref": "#/definitions/ResultCode"
1541
+ }
1308
1542
  }
1309
1543
  },
1310
1544
  "parameters": [
@@ -1368,6 +1602,12 @@
1368
1602
  "schema": {
1369
1603
  "$ref": "#/definitions/EnrichedTx"
1370
1604
  }
1605
+ },
1606
+ "400": {
1607
+ "description": "Bad request",
1608
+ "schema": {
1609
+ "$ref": "#/definitions/ResultCode"
1610
+ }
1371
1611
  }
1372
1612
  },
1373
1613
  "parameters": [
@@ -1406,6 +1646,12 @@
1406
1646
  "schema": {
1407
1647
  "$ref": "#/definitions/EnrichedTx"
1408
1648
  }
1649
+ },
1650
+ "400": {
1651
+ "description": "Bad request",
1652
+ "schema": {
1653
+ "$ref": "#/definitions/ResultCode"
1654
+ }
1409
1655
  }
1410
1656
  },
1411
1657
  "parameters": [
@@ -1434,6 +1680,12 @@
1434
1680
  "schema": {
1435
1681
  "$ref": "#/definitions/Txs"
1436
1682
  }
1683
+ },
1684
+ "400": {
1685
+ "description": "Bad request",
1686
+ "schema": {
1687
+ "$ref": "#/definitions/ResultCode"
1688
+ }
1437
1689
  }
1438
1690
  },
1439
1691
  "parameters": [
@@ -1472,6 +1724,12 @@
1472
1724
  "schema": {
1473
1725
  "$ref": "#/definitions/ResultCode"
1474
1726
  }
1727
+ },
1728
+ "400": {
1729
+ "description": "Bad request",
1730
+ "schema": {
1731
+ "$ref": "#/definitions/ResultCode"
1732
+ }
1475
1733
  }
1476
1734
  },
1477
1735
  "tags": [
@@ -1489,6 +1747,12 @@
1489
1747
  "schema": {
1490
1748
  "$ref": "#/definitions/ResultCode"
1491
1749
  }
1750
+ },
1751
+ "400": {
1752
+ "description": "Bad request",
1753
+ "schema": {
1754
+ "$ref": "#/definitions/ResultCode"
1755
+ }
1492
1756
  }
1493
1757
  },
1494
1758
  "tags": [
@@ -3833,6 +4097,24 @@
3833
4097
  "keyword"
3834
4098
  ]
3835
4099
  },
4100
+ "ReqSendFeedback": {
4101
+ "type": "object",
4102
+ "properties": {
4103
+ "name": {
4104
+ "type": "string"
4105
+ },
4106
+ "email": {
4107
+ "type": "string"
4108
+ },
4109
+ "content": {
4110
+ "type": "string"
4111
+ }
4112
+ },
4113
+ "title": "ReqSendFeedback",
4114
+ "required": [
4115
+ "content"
4116
+ ]
4117
+ },
3836
4118
  "ReqSendTx": {
3837
4119
  "type": "object",
3838
4120
  "properties": {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "zklighter-perps",
3
- "version": "1.0.4",
3
+ "version": "1.0.5",
4
4
  "description": "zkLighter Perps SDK",
5
5
  "main": "index.ts",
6
6
  "directories": {