zklighter-perps 1.0.103 → 1.0.105

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.
@@ -3,6 +3,7 @@ apis/AnnouncementApi.ts
3
3
  apis/BlockApi.ts
4
4
  apis/BridgeApi.ts
5
5
  apis/CandlestickApi.ts
6
+ apis/FundingApi.ts
6
7
  apis/InfoApi.ts
7
8
  apis/NotificationApi.ts
8
9
  apis/OrderApi.ts
@@ -44,6 +45,8 @@ models/EnrichedTx.ts
44
45
  models/ExchangeStats.ts
45
46
  models/FeeBucket.ts
46
47
  models/Funding.ts
48
+ models/FundingRate.ts
49
+ models/FundingRates.ts
47
50
  models/Fundings.ts
48
51
  models/IsWhitelisted.ts
49
52
  models/L1ProviderInfo.ts
@@ -0,0 +1,61 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ *
5
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
6
+ *
7
+ * The version of the OpenAPI document:
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+ import * as runtime from '../runtime';
17
+ import type {
18
+ FundingRates,
19
+ ResultCode,
20
+ } from '../models/index';
21
+ import {
22
+ FundingRatesFromJSON,
23
+ FundingRatesToJSON,
24
+ ResultCodeFromJSON,
25
+ ResultCodeToJSON,
26
+ } from '../models/index';
27
+
28
+ /**
29
+ *
30
+ */
31
+ export class FundingApi extends runtime.BaseAPI {
32
+
33
+ /**
34
+ * Get funding rates
35
+ * funding-rates
36
+ */
37
+ async fundingRatesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FundingRates>> {
38
+ const queryParameters: any = {};
39
+
40
+ const headerParameters: runtime.HTTPHeaders = {};
41
+
42
+ const response = await this.request({
43
+ path: `/api/v1/funding-rates`,
44
+ method: 'GET',
45
+ headers: headerParameters,
46
+ query: queryParameters,
47
+ }, initOverrides);
48
+
49
+ return new runtime.JSONApiResponse(response, (jsonValue) => FundingRatesFromJSON(jsonValue));
50
+ }
51
+
52
+ /**
53
+ * Get funding rates
54
+ * funding-rates
55
+ */
56
+ async fundingRates(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FundingRates> {
57
+ const response = await this.fundingRatesRaw(initOverrides);
58
+ return await response.value();
59
+ }
60
+
61
+ }
package/apis/index.ts CHANGED
@@ -5,6 +5,7 @@ export * from './AnnouncementApi';
5
5
  export * from './BlockApi';
6
6
  export * from './BridgeApi';
7
7
  export * from './CandlestickApi';
8
+ export * from './FundingApi';
8
9
  export * from './InfoApi';
9
10
  export * from './NotificationApi';
10
11
  export * from './OrderApi';
@@ -0,0 +1,79 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ *
5
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
6
+ *
7
+ * The version of the OpenAPI document:
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+ import { mapValues } from '../runtime';
16
+ /**
17
+ *
18
+ * @export
19
+ * @interface FundingRate
20
+ */
21
+ export interface FundingRate {
22
+ /**
23
+ *
24
+ * @type {string}
25
+ * @memberof FundingRate
26
+ */
27
+ exchange: string;
28
+ /**
29
+ *
30
+ * @type {string}
31
+ * @memberof FundingRate
32
+ */
33
+ symbol: string;
34
+ /**
35
+ *
36
+ * @type {number}
37
+ * @memberof FundingRate
38
+ */
39
+ rate: number;
40
+ }
41
+
42
+ /**
43
+ * Check if a given object implements the FundingRate interface.
44
+ */
45
+ export function instanceOfFundingRate(value: object): value is FundingRate {
46
+ if (!('exchange' in value) || value['exchange'] === undefined) return false;
47
+ if (!('symbol' in value) || value['symbol'] === undefined) return false;
48
+ if (!('rate' in value) || value['rate'] === undefined) return false;
49
+ return true;
50
+ }
51
+
52
+ export function FundingRateFromJSON(json: any): FundingRate {
53
+ return FundingRateFromJSONTyped(json, false);
54
+ }
55
+
56
+ export function FundingRateFromJSONTyped(json: any, ignoreDiscriminator: boolean): FundingRate {
57
+ if (json == null) {
58
+ return json;
59
+ }
60
+ return {
61
+
62
+ 'exchange': json['exchange'],
63
+ 'symbol': json['symbol'],
64
+ 'rate': json['rate'],
65
+ };
66
+ }
67
+
68
+ export function FundingRateToJSON(value?: FundingRate | null): any {
69
+ if (value == null) {
70
+ return value;
71
+ }
72
+ return {
73
+
74
+ 'exchange': value['exchange'],
75
+ 'symbol': value['symbol'],
76
+ 'rate': value['rate'],
77
+ };
78
+ }
79
+
@@ -0,0 +1,85 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ *
5
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
6
+ *
7
+ * The version of the OpenAPI document:
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+ import { mapValues } from '../runtime';
16
+ import type { FundingRate } from './FundingRate';
17
+ import {
18
+ FundingRateFromJSON,
19
+ FundingRateFromJSONTyped,
20
+ FundingRateToJSON,
21
+ } from './FundingRate';
22
+
23
+ /**
24
+ *
25
+ * @export
26
+ * @interface FundingRates
27
+ */
28
+ export interface FundingRates {
29
+ /**
30
+ *
31
+ * @type {number}
32
+ * @memberof FundingRates
33
+ */
34
+ code: number;
35
+ /**
36
+ *
37
+ * @type {string}
38
+ * @memberof FundingRates
39
+ */
40
+ message?: string;
41
+ /**
42
+ *
43
+ * @type {Array<FundingRate>}
44
+ * @memberof FundingRates
45
+ */
46
+ funding_rates: Array<FundingRate>;
47
+ }
48
+
49
+ /**
50
+ * Check if a given object implements the FundingRates interface.
51
+ */
52
+ export function instanceOfFundingRates(value: object): value is FundingRates {
53
+ if (!('code' in value) || value['code'] === undefined) return false;
54
+ if (!('funding_rates' in value) || value['funding_rates'] === undefined) return false;
55
+ return true;
56
+ }
57
+
58
+ export function FundingRatesFromJSON(json: any): FundingRates {
59
+ return FundingRatesFromJSONTyped(json, false);
60
+ }
61
+
62
+ export function FundingRatesFromJSONTyped(json: any, ignoreDiscriminator: boolean): FundingRates {
63
+ if (json == null) {
64
+ return json;
65
+ }
66
+ return {
67
+
68
+ 'code': json['code'],
69
+ 'message': json['message'] == null ? undefined : json['message'],
70
+ 'funding_rates': ((json['funding_rates'] as Array<any>).map(FundingRateFromJSON)),
71
+ };
72
+ }
73
+
74
+ export function FundingRatesToJSON(value?: FundingRates | null): any {
75
+ if (value == null) {
76
+ return value;
77
+ }
78
+ return {
79
+
80
+ 'code': value['code'],
81
+ 'message': value['message'],
82
+ 'funding_rates': ((value['funding_rates'] as Array<any>).map(FundingRateToJSON)),
83
+ };
84
+ }
85
+
package/models/Order.ts CHANGED
@@ -31,6 +31,18 @@ export interface Order {
31
31
  * @memberof Order
32
32
  */
33
33
  client_order_index: number;
34
+ /**
35
+ *
36
+ * @type {string}
37
+ * @memberof Order
38
+ */
39
+ order_id: string;
40
+ /**
41
+ *
42
+ * @type {string}
43
+ * @memberof Order
44
+ */
45
+ client_order_id: string;
34
46
  /**
35
47
  *
36
48
  * @type {number}
@@ -151,6 +163,12 @@ export interface Order {
151
163
  * @memberof Order
152
164
  */
153
165
  parent_order_index: number;
166
+ /**
167
+ *
168
+ * @type {string}
169
+ * @memberof Order
170
+ */
171
+ parent_order_id: string;
154
172
  /**
155
173
  *
156
174
  * @type {number}
@@ -220,6 +238,8 @@ export type OrderStatusEnum = typeof OrderStatusEnum[keyof typeof OrderStatusEnu
220
238
  export function instanceOfOrder(value: object): value is Order {
221
239
  if (!('order_index' in value) || value['order_index'] === undefined) return false;
222
240
  if (!('client_order_index' in value) || value['client_order_index'] === undefined) return false;
241
+ if (!('order_id' in value) || value['order_id'] === undefined) return false;
242
+ if (!('client_order_id' in value) || value['client_order_id'] === undefined) return false;
223
243
  if (!('market_index' in value) || value['market_index'] === undefined) return false;
224
244
  if (!('owner_account_index' in value) || value['owner_account_index'] === undefined) return false;
225
245
  if (!('initial_base_amount' in value) || value['initial_base_amount'] === undefined) return false;
@@ -240,6 +260,7 @@ export function instanceOfOrder(value: object): value is Order {
240
260
  if (!('status' in value) || value['status'] === undefined) return false;
241
261
  if (!('trigger_time' in value) || value['trigger_time'] === undefined) return false;
242
262
  if (!('parent_order_index' in value) || value['parent_order_index'] === undefined) return false;
263
+ if (!('parent_order_id' in value) || value['parent_order_id'] === undefined) return false;
243
264
  if (!('block_height' in value) || value['block_height'] === undefined) return false;
244
265
  if (!('timestamp' in value) || value['timestamp'] === undefined) return false;
245
266
  return true;
@@ -257,6 +278,8 @@ export function OrderFromJSONTyped(json: any, ignoreDiscriminator: boolean): Ord
257
278
 
258
279
  'order_index': json['order_index'],
259
280
  'client_order_index': json['client_order_index'],
281
+ 'order_id': json['order_id'],
282
+ 'client_order_id': json['client_order_id'],
260
283
  'market_index': json['market_index'],
261
284
  'owner_account_index': json['owner_account_index'],
262
285
  'initial_base_amount': json['initial_base_amount'],
@@ -277,6 +300,7 @@ export function OrderFromJSONTyped(json: any, ignoreDiscriminator: boolean): Ord
277
300
  'status': json['status'],
278
301
  'trigger_time': json['trigger_time'],
279
302
  'parent_order_index': json['parent_order_index'],
303
+ 'parent_order_id': json['parent_order_id'],
280
304
  'block_height': json['block_height'],
281
305
  'timestamp': json['timestamp'],
282
306
  };
@@ -290,6 +314,8 @@ export function OrderToJSON(value?: Order | null): any {
290
314
 
291
315
  'order_index': value['order_index'],
292
316
  'client_order_index': value['client_order_index'],
317
+ 'order_id': value['order_id'],
318
+ 'client_order_id': value['client_order_id'],
293
319
  'market_index': value['market_index'],
294
320
  'owner_account_index': value['owner_account_index'],
295
321
  'initial_base_amount': value['initial_base_amount'],
@@ -310,6 +336,7 @@ export function OrderToJSON(value?: Order | null): any {
310
336
  'status': value['status'],
311
337
  'trigger_time': value['trigger_time'],
312
338
  'parent_order_index': value['parent_order_index'],
339
+ 'parent_order_id': value['parent_order_id'],
313
340
  'block_height': value['block_height'],
314
341
  'timestamp': value['timestamp'],
315
342
  };
@@ -25,6 +25,12 @@ export interface SimpleOrder {
25
25
  * @memberof SimpleOrder
26
26
  */
27
27
  order_index: number;
28
+ /**
29
+ *
30
+ * @type {string}
31
+ * @memberof SimpleOrder
32
+ */
33
+ order_id: string;
28
34
  /**
29
35
  *
30
36
  * @type {number}
@@ -62,6 +68,7 @@ export interface SimpleOrder {
62
68
  */
63
69
  export function instanceOfSimpleOrder(value: object): value is SimpleOrder {
64
70
  if (!('order_index' in value) || value['order_index'] === undefined) return false;
71
+ if (!('order_id' in value) || value['order_id'] === undefined) return false;
65
72
  if (!('owner_account_index' in value) || value['owner_account_index'] === undefined) return false;
66
73
  if (!('initial_base_amount' in value) || value['initial_base_amount'] === undefined) return false;
67
74
  if (!('remaining_base_amount' in value) || value['remaining_base_amount'] === undefined) return false;
@@ -81,6 +88,7 @@ export function SimpleOrderFromJSONTyped(json: any, ignoreDiscriminator: boolean
81
88
  return {
82
89
 
83
90
  'order_index': json['order_index'],
91
+ 'order_id': json['order_id'],
84
92
  'owner_account_index': json['owner_account_index'],
85
93
  'initial_base_amount': json['initial_base_amount'],
86
94
  'remaining_base_amount': json['remaining_base_amount'],
@@ -96,6 +104,7 @@ export function SimpleOrderToJSON(value?: SimpleOrder | null): any {
96
104
  return {
97
105
 
98
106
  'order_index': value['order_index'],
107
+ 'order_id': value['order_id'],
99
108
  'owner_account_index': value['owner_account_index'],
100
109
  'initial_base_amount': value['initial_base_amount'],
101
110
  'remaining_base_amount': value['remaining_base_amount'],
package/models/index.ts CHANGED
@@ -33,6 +33,8 @@ export * from './EnrichedTx';
33
33
  export * from './ExchangeStats';
34
34
  export * from './FeeBucket';
35
35
  export * from './Funding';
36
+ export * from './FundingRate';
37
+ export * from './FundingRates';
36
38
  export * from './Fundings';
37
39
  export * from './IsWhitelisted';
38
40
  export * from './L1ProviderInfo';
package/openapi.json CHANGED
@@ -1161,6 +1161,30 @@
1161
1161
  "description": "Get account fee bucket"
1162
1162
  }
1163
1163
  },
1164
+ "/api/v1/funding-rates": {
1165
+ "get": {
1166
+ "summary": "funding-rates",
1167
+ "operationId": "funding-rates",
1168
+ "responses": {
1169
+ "200": {
1170
+ "description": "A successful response.",
1171
+ "schema": {
1172
+ "$ref": "#/definitions/FundingRates"
1173
+ }
1174
+ },
1175
+ "400": {
1176
+ "description": "Bad request",
1177
+ "schema": {
1178
+ "$ref": "#/definitions/ResultCode"
1179
+ }
1180
+ }
1181
+ },
1182
+ "tags": [
1183
+ "funding"
1184
+ ],
1185
+ "description": "Get funding rates"
1186
+ }
1187
+ },
1164
1188
  "/api/v1/fundings": {
1165
1189
  "get": {
1166
1190
  "summary": "fundings",
@@ -3812,6 +3836,51 @@
3812
3836
  "direction"
3813
3837
  ]
3814
3838
  },
3839
+ "FundingRate": {
3840
+ "type": "object",
3841
+ "properties": {
3842
+ "exchange": {
3843
+ "type": "string"
3844
+ },
3845
+ "symbol": {
3846
+ "type": "string"
3847
+ },
3848
+ "rate": {
3849
+ "type": "number",
3850
+ "format": "double"
3851
+ }
3852
+ },
3853
+ "title": "FundingRate",
3854
+ "required": [
3855
+ "exchange",
3856
+ "symbol",
3857
+ "rate"
3858
+ ]
3859
+ },
3860
+ "FundingRates": {
3861
+ "type": "object",
3862
+ "properties": {
3863
+ "code": {
3864
+ "type": "integer",
3865
+ "format": "int32",
3866
+ "example": "200"
3867
+ },
3868
+ "message": {
3869
+ "type": "string"
3870
+ },
3871
+ "funding_rates": {
3872
+ "type": "array",
3873
+ "items": {
3874
+ "$ref": "#/definitions/FundingRate"
3875
+ }
3876
+ }
3877
+ },
3878
+ "title": "FundingRates",
3879
+ "required": [
3880
+ "code",
3881
+ "funding_rates"
3882
+ ]
3883
+ },
3815
3884
  "Fundings": {
3816
3885
  "type": "object",
3817
3886
  "properties": {
@@ -4156,6 +4225,14 @@
4156
4225
  "format": "int64",
4157
4226
  "example": "234"
4158
4227
  },
4228
+ "order_id": {
4229
+ "type": "string",
4230
+ "example": "1"
4231
+ },
4232
+ "client_order_id": {
4233
+ "type": "string",
4234
+ "example": "234"
4235
+ },
4159
4236
  "market_index": {
4160
4237
  "type": "integer",
4161
4238
  "format": "uint8",
@@ -4280,6 +4357,10 @@
4280
4357
  "format": "int64",
4281
4358
  "example": "1"
4282
4359
  },
4360
+ "parent_order_id": {
4361
+ "type": "string",
4362
+ "example": "1"
4363
+ },
4283
4364
  "block_height": {
4284
4365
  "type": "integer",
4285
4366
  "format": "int64",
@@ -4295,6 +4376,8 @@
4295
4376
  "required": [
4296
4377
  "order_index",
4297
4378
  "client_order_index",
4379
+ "order_id",
4380
+ "client_order_id",
4298
4381
  "market_index",
4299
4382
  "owner_account_index",
4300
4383
  "initial_base_amount",
@@ -4315,6 +4398,7 @@
4315
4398
  "status",
4316
4399
  "trigger_time",
4317
4400
  "parent_order_index",
4401
+ "parent_order_id",
4318
4402
  "block_height",
4319
4403
  "timestamp"
4320
4404
  ]
@@ -6333,6 +6417,10 @@
6333
6417
  "format": "int64",
6334
6418
  "example": "1"
6335
6419
  },
6420
+ "order_id": {
6421
+ "type": "string",
6422
+ "example": "1"
6423
+ },
6336
6424
  "owner_account_index": {
6337
6425
  "type": "integer",
6338
6426
  "format": "int64",
@@ -6359,6 +6447,7 @@
6359
6447
  "title": "SimpleOrder",
6360
6448
  "required": [
6361
6449
  "order_index",
6450
+ "order_id",
6362
6451
  "owner_account_index",
6363
6452
  "initial_base_amount",
6364
6453
  "remaining_base_amount",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "zklighter-perps",
3
- "version": "1.0.103",
3
+ "version": "1.0.105",
4
4
  "description": "zkLighter Perps SDK",
5
5
  "main": "index.ts",
6
6
  "directories": {