zklighter-perps 1.0.24 → 1.0.26

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 (6) hide show
  1. package/models/Order.ts +45 -8
  2. package/models/OrderBookDetail.ts +0 -18
  3. package/models/SimpleOrder.ts +9 -9
  4. package/models/Trade.ts +21 -0
  5. package/openapi.json +47 -26
  6. package/package.json +1 -1
package/models/Order.ts CHANGED
@@ -31,6 +31,18 @@ export interface Order {
31
31
  * @memberof Order
32
32
  */
33
33
  owner_account_index: number;
34
+ /**
35
+ *
36
+ * @type {number}
37
+ * @memberof Order
38
+ */
39
+ order_index: number;
40
+ /**
41
+ *
42
+ * @type {number}
43
+ * @memberof Order
44
+ */
45
+ client_order_index: number;
34
46
  /**
35
47
  *
36
48
  * @type {string}
@@ -86,23 +98,29 @@ export interface Order {
86
98
  */
87
99
  is_ask: boolean;
88
100
  /**
89
- *
90
- * @type {number}
101
+ * TODO: remove this
102
+ * @type {string}
91
103
  * @memberof Order
92
104
  */
93
- order_expiry: number;
105
+ side: string;
94
106
  /**
95
107
  *
96
108
  * @type {string}
97
109
  * @memberof Order
98
110
  */
99
- side: string;
111
+ type: OrderTypeEnum;
100
112
  /**
101
113
  *
102
114
  * @type {string}
103
115
  * @memberof Order
104
116
  */
105
- type: OrderTypeEnum;
117
+ time_in_force: OrderTimeInForceEnum;
118
+ /**
119
+ *
120
+ * @type {number}
121
+ * @memberof Order
122
+ */
123
+ order_expiry: number;
106
124
  /**
107
125
  *
108
126
  * @type {string}
@@ -133,6 +151,16 @@ export const OrderTypeEnum = {
133
151
  } as const;
134
152
  export type OrderTypeEnum = typeof OrderTypeEnum[keyof typeof OrderTypeEnum];
135
153
 
154
+ /**
155
+ * @export
156
+ */
157
+ export const OrderTimeInForceEnum = {
158
+ Gtd: 'gtd',
159
+ Ioc: 'ioc',
160
+ Alo: 'alo'
161
+ } as const;
162
+ export type OrderTimeInForceEnum = typeof OrderTimeInForceEnum[keyof typeof OrderTimeInForceEnum];
163
+
136
164
  /**
137
165
  * @export
138
166
  */
@@ -150,6 +178,8 @@ export type OrderStatusEnum = typeof OrderStatusEnum[keyof typeof OrderStatusEnu
150
178
  export function instanceOfOrder(value: object): value is Order {
151
179
  if (!('market_index' in value) || value['market_index'] === undefined) return false;
152
180
  if (!('owner_account_index' in value) || value['owner_account_index'] === undefined) return false;
181
+ if (!('order_index' in value) || value['order_index'] === undefined) return false;
182
+ if (!('client_order_index' in value) || value['client_order_index'] === undefined) return false;
153
183
  if (!('initial_base_amount' in value) || value['initial_base_amount'] === undefined) return false;
154
184
  if (!('remaining_base_amount' in value) || value['remaining_base_amount'] === undefined) return false;
155
185
  if (!('filled_base_amount' in value) || value['filled_base_amount'] === undefined) return false;
@@ -159,9 +189,10 @@ export function instanceOfOrder(value: object): value is Order {
159
189
  if (!('base_price' in value) || value['base_price'] === undefined) return false;
160
190
  if (!('nonce' in value) || value['nonce'] === undefined) return false;
161
191
  if (!('is_ask' in value) || value['is_ask'] === undefined) return false;
162
- if (!('order_expiry' in value) || value['order_expiry'] === undefined) return false;
163
192
  if (!('side' in value) || value['side'] === undefined) return false;
164
193
  if (!('type' in value) || value['type'] === undefined) return false;
194
+ if (!('time_in_force' in value) || value['time_in_force'] === undefined) return false;
195
+ if (!('order_expiry' in value) || value['order_expiry'] === undefined) return false;
165
196
  if (!('status' in value) || value['status'] === undefined) return false;
166
197
  if (!('block_height' in value) || value['block_height'] === undefined) return false;
167
198
  if (!('timestamp' in value) || value['timestamp'] === undefined) return false;
@@ -180,6 +211,8 @@ export function OrderFromJSONTyped(json: any, ignoreDiscriminator: boolean): Ord
180
211
 
181
212
  'market_index': json['market_index'],
182
213
  'owner_account_index': json['owner_account_index'],
214
+ 'order_index': json['order_index'],
215
+ 'client_order_index': json['client_order_index'],
183
216
  'initial_base_amount': json['initial_base_amount'],
184
217
  'remaining_base_amount': json['remaining_base_amount'],
185
218
  'filled_base_amount': json['filled_base_amount'],
@@ -189,9 +222,10 @@ export function OrderFromJSONTyped(json: any, ignoreDiscriminator: boolean): Ord
189
222
  'base_price': json['base_price'],
190
223
  'nonce': json['nonce'],
191
224
  'is_ask': json['is_ask'],
192
- 'order_expiry': json['order_expiry'],
193
225
  'side': json['side'],
194
226
  'type': json['type'],
227
+ 'time_in_force': json['time_in_force'],
228
+ 'order_expiry': json['order_expiry'],
195
229
  'status': json['status'],
196
230
  'block_height': json['block_height'],
197
231
  'timestamp': json['timestamp'],
@@ -206,6 +240,8 @@ export function OrderToJSON(value?: Order | null): any {
206
240
 
207
241
  'market_index': value['market_index'],
208
242
  'owner_account_index': value['owner_account_index'],
243
+ 'order_index': value['order_index'],
244
+ 'client_order_index': value['client_order_index'],
209
245
  'initial_base_amount': value['initial_base_amount'],
210
246
  'remaining_base_amount': value['remaining_base_amount'],
211
247
  'filled_base_amount': value['filled_base_amount'],
@@ -215,9 +251,10 @@ export function OrderToJSON(value?: Order | null): any {
215
251
  'base_price': value['base_price'],
216
252
  'nonce': value['nonce'],
217
253
  'is_ask': value['is_ask'],
218
- 'order_expiry': value['order_expiry'],
219
254
  'side': value['side'],
220
255
  'type': value['type'],
256
+ 'time_in_force': value['time_in_force'],
257
+ 'order_expiry': value['order_expiry'],
221
258
  'status': value['status'],
222
259
  'block_height': value['block_height'],
223
260
  'timestamp': value['timestamp'],
package/models/OrderBookDetail.ts CHANGED
@@ -121,18 +121,6 @@ export interface OrderBookDetail {
121
121
  * @memberof OrderBookDetail
122
122
  */
123
123
  closeout_margin_fraction: number;
124
- /**
125
- *
126
- * @type {number}
127
- * @memberof OrderBookDetail
128
- */
129
- ask_nonce: number;
130
- /**
131
- *
132
- * @type {number}
133
- * @memberof OrderBookDetail
134
- */
135
- bid_nonce: number;
136
124
  /**
137
125
  *
138
126
  * @type {number}
@@ -216,8 +204,6 @@ export function instanceOfOrderBookDetail(value: object): value is OrderBookDeta
216
204
  if (!('initial_margin_fraction' in value) || value['initial_margin_fraction'] === undefined) return false;
217
205
  if (!('maintenance_margin_fraction' in value) || value['maintenance_margin_fraction'] === undefined) return false;
218
206
  if (!('closeout_margin_fraction' in value) || value['closeout_margin_fraction'] === undefined) return false;
219
- if (!('ask_nonce' in value) || value['ask_nonce'] === undefined) return false;
220
- if (!('bid_nonce' in value) || value['bid_nonce'] === undefined) return false;
221
207
  if (!('last_trade_price' in value) || value['last_trade_price'] === undefined) return false;
222
208
  if (!('daily_trades_count' in value) || value['daily_trades_count'] === undefined) return false;
223
209
  if (!('daily_base_token_volume' in value) || value['daily_base_token_volume'] === undefined) return false;
@@ -258,8 +244,6 @@ export function OrderBookDetailFromJSONTyped(json: any, ignoreDiscriminator: boo
258
244
  'initial_margin_fraction': json['initial_margin_fraction'],
259
245
  'maintenance_margin_fraction': json['maintenance_margin_fraction'],
260
246
  'closeout_margin_fraction': json['closeout_margin_fraction'],
261
- 'ask_nonce': json['ask_nonce'],
262
- 'bid_nonce': json['bid_nonce'],
263
247
  'last_trade_price': json['last_trade_price'],
264
248
  'daily_trades_count': json['daily_trades_count'],
265
249
  'daily_base_token_volume': json['daily_base_token_volume'],
@@ -296,8 +280,6 @@ export function OrderBookDetailToJSON(value?: OrderBookDetail | null): any {
296
280
  'initial_margin_fraction': value['initial_margin_fraction'],
297
281
  'maintenance_margin_fraction': value['maintenance_margin_fraction'],
298
282
  'closeout_margin_fraction': value['closeout_margin_fraction'],
299
- 'ask_nonce': value['ask_nonce'],
300
- 'bid_nonce': value['bid_nonce'],
301
283
  'last_trade_price': value['last_trade_price'],
302
284
  'daily_trades_count': value['daily_trades_count'],
303
285
  'daily_base_token_volume': value['daily_base_token_volume'],
package/models/SimpleOrder.ts CHANGED
@@ -19,6 +19,12 @@ import { mapValues } from '../runtime';
19
19
  * @interface SimpleOrder
20
20
  */
21
21
  export interface SimpleOrder {
22
+ /**
23
+ *
24
+ * @type {number}
25
+ * @memberof SimpleOrder
26
+ */
27
+ order_index: number;
22
28
  /**
23
29
  *
24
30
  * @type {number}
@@ -43,12 +49,6 @@ export interface SimpleOrder {
43
49
  * @memberof SimpleOrder
44
50
  */
45
51
  price: string;
46
- /**
47
- *
48
- * @type {number}
49
- * @memberof SimpleOrder
50
- */
51
- nonce: number;
52
52
  /**
53
53
  *
54
54
  * @type {number}
@@ -61,11 +61,11 @@ export interface SimpleOrder {
61
61
  * Check if a given object implements the SimpleOrder interface.
62
62
  */
63
63
  export function instanceOfSimpleOrder(value: object): value is SimpleOrder {
64
+ if (!('order_index' in value) || value['order_index'] === undefined) return false;
64
65
  if (!('owner_account_index' in value) || value['owner_account_index'] === undefined) return false;
65
66
  if (!('initial_base_amount' in value) || value['initial_base_amount'] === undefined) return false;
66
67
  if (!('remaining_base_amount' in value) || value['remaining_base_amount'] === undefined) return false;
67
68
  if (!('price' in value) || value['price'] === undefined) return false;
68
- if (!('nonce' in value) || value['nonce'] === undefined) return false;
69
69
  if (!('order_expiry' in value) || value['order_expiry'] === undefined) return false;
70
70
  return true;
71
71
  }
@@ -80,11 +80,11 @@ export function SimpleOrderFromJSONTyped(json: any, ignoreDiscriminator: boolean
80
80
  }
81
81
  return {
82
82
 
83
+ 'order_index': json['order_index'],
83
84
  'owner_account_index': json['owner_account_index'],
84
85
  'initial_base_amount': json['initial_base_amount'],
85
86
  'remaining_base_amount': json['remaining_base_amount'],
86
87
  'price': json['price'],
87
- 'nonce': json['nonce'],
88
88
  'order_expiry': json['order_expiry'],
89
89
  };
90
90
  }
@@ -95,11 +95,11 @@ export function SimpleOrderToJSON(value?: SimpleOrder | null): any {
95
95
  }
96
96
  return {
97
97
 
98
+ 'order_index': value['order_index'],
98
99
  'owner_account_index': value['owner_account_index'],
99
100
  'initial_base_amount': value['initial_base_amount'],
100
101
  'remaining_base_amount': value['remaining_base_amount'],
101
102
  'price': value['price'],
102
- 'nonce': value['nonce'],
103
103
  'order_expiry': value['order_expiry'],
104
104
  };
105
105
  }
package/models/Trade.ts CHANGED
@@ -31,6 +31,12 @@ export interface Trade {
31
31
  * @memberof Trade
32
32
  */
33
33
  tx_hash: string;
34
+ /**
35
+ *
36
+ * @type {string}
37
+ * @memberof Trade
38
+ */
39
+ type: TradeTypeEnum;
34
40
  /**
35
41
  *
36
42
  * @type {number}
@@ -93,12 +99,25 @@ export interface Trade {
93
99
  timestamp: number;
94
100
  }
95
101
 
102
+
103
+ /**
104
+ * @export
105
+ */
106
+ export const TradeTypeEnum = {
107
+ Trade: 'trade',
108
+ Liquidation: 'liquidation',
109
+ Deleverage: 'deleverage'
110
+ } as const;
111
+ export type TradeTypeEnum = typeof TradeTypeEnum[keyof typeof TradeTypeEnum];
112
+
113
+
96
114
  /**
97
115
  * Check if a given object implements the Trade interface.
98
116
  */
99
117
  export function instanceOfTrade(value: object): value is Trade {
100
118
  if (!('trade_id' in value) || value['trade_id'] === undefined) return false;
101
119
  if (!('tx_hash' in value) || value['tx_hash'] === undefined) return false;
120
+ if (!('type' in value) || value['type'] === undefined) return false;
102
121
  if (!('market_id' in value) || value['market_id'] === undefined) return false;
103
122
  if (!('size' in value) || value['size'] === undefined) return false;
104
123
  if (!('price' in value) || value['price'] === undefined) return false;
@@ -124,6 +143,7 @@ export function TradeFromJSONTyped(json: any, ignoreDiscriminator: boolean): Tra
124
143
 
125
144
  'trade_id': json['trade_id'],
126
145
  'tx_hash': json['tx_hash'],
146
+ 'type': json['type'],
127
147
  'market_id': json['market_id'],
128
148
  'size': json['size'],
129
149
  'price': json['price'],
@@ -145,6 +165,7 @@ export function TradeToJSON(value?: Trade | null): any {
145
165
 
146
166
  'trade_id': value['trade_id'],
147
167
  'tx_hash': value['tx_hash'],
168
+ 'type': value['type'],
148
169
  'market_id': value['market_id'],
149
170
  'size': value['size'],
150
171
  'price': value['price'],
package/openapi.json CHANGED
@@ -2849,6 +2849,16 @@
2849
2849
  "format": "int64",
2850
2850
  "example": "1"
2851
2851
  },
2852
+ "order_index": {
2853
+ "type": "integer",
2854
+ "format": "int64",
2855
+ "example": "1"
2856
+ },
2857
+ "client_order_index": {
2858
+ "type": "integer",
2859
+ "format": "int64",
2860
+ "example": "234"
2861
+ },
2852
2862
  "initial_base_amount": {
2853
2863
  "type": "string",
2854
2864
  "example": "0.1"
@@ -2882,22 +2892,18 @@
2882
2892
  "nonce": {
2883
2893
  "type": "integer",
2884
2894
  "format": "int64",
2885
- "example": "234"
2895
+ "example": "722"
2886
2896
  },
2887
2897
  "is_ask": {
2888
2898
  "type": "boolean",
2889
2899
  "format": "boolean",
2890
2900
  "example": "true"
2891
2901
  },
2892
- "order_expiry": {
2893
- "type": "integer",
2894
- "format": "int64",
2895
- "example": "1640995200"
2896
- },
2897
2902
  "side": {
2898
2903
  "type": "string",
2899
2904
  "example": "buy",
2900
- "default": "buy"
2905
+ "default": "buy",
2906
+ "description": " TODO: remove this"
2901
2907
  },
2902
2908
  "type": {
2903
2909
  "type": "string",
@@ -2907,6 +2913,20 @@
2907
2913
  "market"
2908
2914
  ]
2909
2915
  },
2916
+ "time_in_force": {
2917
+ "type": "string",
2918
+ "enum": [
2919
+ "gtd",
2920
+ "ioc",
2921
+ "alo"
2922
+ ],
2923
+ "default": "gtd"
2924
+ },
2925
+ "order_expiry": {
2926
+ "type": "integer",
2927
+ "format": "int64",
2928
+ "example": "1640995200"
2929
+ },
2910
2930
  "status": {
2911
2931
  "type": "string",
2912
2932
  "example": "open",
@@ -2931,6 +2951,8 @@
2931
2951
  "required": [
2932
2952
  "market_index",
2933
2953
  "owner_account_index",
2954
+ "order_index",
2955
+ "client_order_index",
2934
2956
  "initial_base_amount",
2935
2957
  "remaining_base_amount",
2936
2958
  "filled_base_amount",
@@ -2940,9 +2962,10 @@
2940
2962
  "base_price",
2941
2963
  "nonce",
2942
2964
  "is_ask",
2943
- "order_expiry",
2944
2965
  "side",
2945
2966
  "type",
2967
+ "time_in_force",
2968
+ "order_expiry",
2946
2969
  "status",
2947
2970
  "block_height",
2948
2971
  "timestamp"
@@ -3140,16 +3163,6 @@
3140
3163
  "format": "uin16",
3141
3164
  "example": "100"
3142
3165
  },
3143
- "ask_nonce": {
3144
- "type": "integer",
3145
- "format": "int64",
3146
- "example": "234"
3147
- },
3148
- "bid_nonce": {
3149
- "type": "integer",
3150
- "format": "int64",
3151
- "example": "274"
3152
- },
3153
3166
  "last_trade_price": {
3154
3167
  "type": "number",
3155
3168
  "format": "double",
@@ -3212,8 +3225,6 @@
3212
3225
  "initial_margin_fraction",
3213
3226
  "maintenance_margin_fraction",
3214
3227
  "closeout_margin_fraction",
3215
- "ask_nonce",
3216
- "bid_nonce",
3217
3228
  "last_trade_price",
3218
3229
  "daily_trades_count",
3219
3230
  "daily_base_token_volume",
@@ -4302,6 +4313,11 @@
4302
4313
  "SimpleOrder": {
4303
4314
  "type": "object",
4304
4315
  "properties": {
4316
+ "order_index": {
4317
+ "type": "integer",
4318
+ "format": "int64",
4319
+ "example": "1"
4320
+ },
4305
4321
  "owner_account_index": {
4306
4322
  "type": "integer",
4307
4323
  "format": "int64",
@@ -4319,11 +4335,6 @@
4319
4335
  "type": "string",
4320
4336
  "example": "3024.66"
4321
4337
  },
4322
- "nonce": {
4323
- "type": "integer",
4324
- "format": "int64",
4325
- "example": "234"
4326
- },
4327
4338
  "order_expiry": {
4328
4339
  "type": "integer",
4329
4340
  "format": "int64",
@@ -4332,11 +4343,11 @@
4332
4343
  },
4333
4344
  "title": "SimpleOrder",
4334
4345
  "required": [
4346
+ "order_index",
4335
4347
  "owner_account_index",
4336
4348
  "initial_base_amount",
4337
4349
  "remaining_base_amount",
4338
4350
  "price",
4339
- "nonce",
4340
4351
  "order_expiry"
4341
4352
  ]
4342
4353
  },
@@ -4401,6 +4412,15 @@
4401
4412
  "type": "string",
4402
4413
  "example": "0x70997970C51812dc3A010C7d01b50e0d17dc79C8"
4403
4414
  },
4415
+ "type": {
4416
+ "type": "string",
4417
+ "example": "trade",
4418
+ "enum": [
4419
+ "trade",
4420
+ "liquidation",
4421
+ "deleverage"
4422
+ ]
4423
+ },
4404
4424
  "market_id": {
4405
4425
  "type": "integer",
4406
4426
  "format": "uint8",
@@ -4454,6 +4474,7 @@
4454
4474
  "required": [
4455
4475
  "trade_id",
4456
4476
  "tx_hash",
4477
+ "type",
4457
4478
  "market_id",
4458
4479
  "size",
4459
4480
  "price",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "zklighter-perps",
3
- "version": "1.0.24",
3
+ "version": "1.0.26",
4
4
  "description": "zkLighter Perps SDK",
5
5
  "main": "index.ts",
6
6
  "directories": {