zklighter-perps 1.0.207 → 1.0.208

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.
@@ -100,6 +100,7 @@ models/PriceLevel.ts
100
100
  models/PublicPoolInfo.ts
101
101
  models/PublicPoolMetadata.ts
102
102
  models/PublicPoolShare.ts
103
+ models/Referral.ts
103
104
  models/ReferralCode.ts
104
105
  models/ReferralPointEntry.ts
105
106
  models/ReferralPoints.ts
@@ -150,6 +151,7 @@ models/ReqGetTrades.ts
150
151
  models/ReqGetTransferFeeInfo.ts
151
152
  models/ReqGetTransferHistory.ts
152
153
  models/ReqGetTx.ts
154
+ models/ReqGetUserReferrals.ts
153
155
  models/ReqGetWithdrawHistory.ts
154
156
  models/ReqIsWhitelisted.ts
155
157
  models/RespChangeAccountTier.ts
@@ -189,6 +191,7 @@ models/Tx.ts
189
191
  models/TxHash.ts
190
192
  models/TxHashes.ts
191
193
  models/Txs.ts
194
+ models/UserReferrals.ts
192
195
  models/ValidatorInfo.ts
193
196
  models/WithdrawHistory.ts
194
197
  models/WithdrawHistoryItem.ts
package/apis/OrderApi.ts CHANGED
@@ -773,6 +773,8 @@ export type ExportTypeEnum = typeof ExportTypeEnum[keyof typeof ExportTypeEnum];
773
773
  * @export
774
774
  */
775
775
  export const ExchangeMetricsPeriodEnum = {
776
+ H: 'h',
777
+ D: 'd',
776
778
  W: 'w',
777
779
  M: 'm',
778
780
  Q: 'q',
@@ -797,7 +799,8 @@ export const ExchangeMetricsKindEnum = {
797
799
  WithdrawFee: 'withdraw_fee',
798
800
  OpenInterest: 'open_interest',
799
801
  AccountCount: 'account_count',
800
- ActiveAccountCount: 'active_account_count'
802
+ ActiveAccountCount: 'active_account_count',
803
+ Tps: 'tps'
801
804
  } as const;
802
805
  export type ExchangeMetricsKindEnum = typeof ExchangeMetricsKindEnum[keyof typeof ExchangeMetricsKindEnum];
803
806
  /**
@@ -20,6 +20,7 @@ import type {
20
20
  RespUpdateKickback,
21
21
  RespUpdateReferralCode,
22
22
  ResultCode,
23
+ UserReferrals,
23
24
  } from '../models/index';
24
25
  import {
25
26
  ReferralCodeFromJSON,
@@ -32,6 +33,8 @@ import {
32
33
  RespUpdateReferralCodeToJSON,
33
34
  ResultCodeFromJSON,
34
35
  ResultCodeToJSON,
36
+ UserReferralsFromJSON,
37
+ UserReferralsToJSON,
35
38
  } from '../models/index';
36
39
 
37
40
  export interface ReferralCreateRequest {
@@ -77,6 +80,13 @@ export interface ReferralUseRequest {
77
80
  signature?: string;
78
81
  }
79
82
 
83
+ export interface ReferralUserReferralsRequest {
84
+ l1_address: string;
85
+ authorization?: string;
86
+ auth?: string;
87
+ cursor?: string;
88
+ }
89
+
80
90
  /**
81
91
  *
82
92
  */
@@ -480,4 +490,55 @@ export class ReferralApi extends runtime.BaseAPI {
480
490
  return await response.value();
481
491
  }
482
492
 
493
+ /**
494
+ * Get user referrals
495
+ * referral_userReferrals
496
+ */
497
+ async referralUserReferralsRaw(requestParameters: ReferralUserReferralsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserReferrals>> {
498
+ if (requestParameters['l1_address'] == null) {
499
+ throw new runtime.RequiredError(
500
+ 'l1_address',
501
+ 'Required parameter "l1_address" was null or undefined when calling referralUserReferrals().'
502
+ );
503
+ }
504
+
505
+ const queryParameters: any = {};
506
+
507
+ if (requestParameters['auth'] != null) {
508
+ queryParameters['auth'] = requestParameters['auth'];
509
+ }
510
+
511
+ if (requestParameters['l1_address'] != null) {
512
+ queryParameters['l1_address'] = requestParameters['l1_address'];
513
+ }
514
+
515
+ if (requestParameters['cursor'] != null) {
516
+ queryParameters['cursor'] = requestParameters['cursor'];
517
+ }
518
+
519
+ const headerParameters: runtime.HTTPHeaders = {};
520
+
521
+ if (requestParameters['authorization'] != null) {
522
+ headerParameters['authorization'] = String(requestParameters['authorization']);
523
+ }
524
+
525
+ const response = await this.request({
526
+ path: `/api/v1/referral/userReferrals`,
527
+ method: 'GET',
528
+ headers: headerParameters,
529
+ query: queryParameters,
530
+ }, initOverrides);
531
+
532
+ return new runtime.JSONApiResponse(response, (jsonValue) => UserReferralsFromJSON(jsonValue));
533
+ }
534
+
535
+ /**
536
+ * Get user referrals
537
+ * referral_userReferrals
538
+ */
539
+ async referralUserReferrals(requestParameters: ReferralUserReferralsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserReferrals> {
540
+ const response = await this.referralUserReferralsRaw(requestParameters, initOverrides);
541
+ return await response.value();
542
+ }
543
+
483
544
  }
@@ -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 Referral
20
+ */
21
+ export interface Referral {
22
+ /**
23
+ *
24
+ * @type {string}
25
+ * @memberof Referral
26
+ */
27
+ l1_address: string;
28
+ /**
29
+ *
30
+ * @type {string}
31
+ * @memberof Referral
32
+ */
33
+ referral_code: string;
34
+ /**
35
+ *
36
+ * @type {number}
37
+ * @memberof Referral
38
+ */
39
+ used_at: number;
40
+ }
41
+
42
+ /**
43
+ * Check if a given object implements the Referral interface.
44
+ */
45
+ export function instanceOfReferral(value: object): value is Referral {
46
+ if (!('l1_address' in value) || value['l1_address'] === undefined) return false;
47
+ if (!('referral_code' in value) || value['referral_code'] === undefined) return false;
48
+ if (!('used_at' in value) || value['used_at'] === undefined) return false;
49
+ return true;
50
+ }
51
+
52
+ export function ReferralFromJSON(json: any): Referral {
53
+ return ReferralFromJSONTyped(json, false);
54
+ }
55
+
56
+ export function ReferralFromJSONTyped(json: any, ignoreDiscriminator: boolean): Referral {
57
+ if (json == null) {
58
+ return json;
59
+ }
60
+ return {
61
+
62
+ 'l1_address': json['l1_address'],
63
+ 'referral_code': json['referral_code'],
64
+ 'used_at': json['used_at'],
65
+ };
66
+ }
67
+
68
+ export function ReferralToJSON(value?: Referral | null): any {
69
+ if (value == null) {
70
+ return value;
71
+ }
72
+ return {
73
+
74
+ 'l1_address': value['l1_address'],
75
+ 'referral_code': value['referral_code'],
76
+ 'used_at': value['used_at'],
77
+ };
78
+ }
79
+
@@ -50,6 +50,8 @@ export interface ReqGetExchangeMetrics {
50
50
  * @export
51
51
  */
52
52
  export const ReqGetExchangeMetricsPeriodEnum = {
53
+ H: 'h',
54
+ D: 'd',
53
55
  W: 'w',
54
56
  M: 'm',
55
57
  Q: 'q',
@@ -75,7 +77,8 @@ export const ReqGetExchangeMetricsKindEnum = {
75
77
  WithdrawFee: 'withdraw_fee',
76
78
  OpenInterest: 'open_interest',
77
79
  AccountCount: 'account_count',
78
- ActiveAccountCount: 'active_account_count'
80
+ ActiveAccountCount: 'active_account_count',
81
+ Tps: 'tps'
79
82
  } as const;
80
83
  export type ReqGetExchangeMetricsKindEnum = typeof ReqGetExchangeMetricsKindEnum[keyof typeof ReqGetExchangeMetricsKindEnum];
81
84
 
@@ -0,0 +1,77 @@
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 ReqGetUserReferrals
20
+ */
21
+ export interface ReqGetUserReferrals {
22
+ /**
23
+ *
24
+ * @type {string}
25
+ * @memberof ReqGetUserReferrals
26
+ */
27
+ auth?: string;
28
+ /**
29
+ *
30
+ * @type {string}
31
+ * @memberof ReqGetUserReferrals
32
+ */
33
+ l1_address: string;
34
+ /**
35
+ *
36
+ * @type {string}
37
+ * @memberof ReqGetUserReferrals
38
+ */
39
+ cursor?: string;
40
+ }
41
+
42
+ /**
43
+ * Check if a given object implements the ReqGetUserReferrals interface.
44
+ */
45
+ export function instanceOfReqGetUserReferrals(value: object): value is ReqGetUserReferrals {
46
+ if (!('l1_address' in value) || value['l1_address'] === undefined) return false;
47
+ return true;
48
+ }
49
+
50
+ export function ReqGetUserReferralsFromJSON(json: any): ReqGetUserReferrals {
51
+ return ReqGetUserReferralsFromJSONTyped(json, false);
52
+ }
53
+
54
+ export function ReqGetUserReferralsFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReqGetUserReferrals {
55
+ if (json == null) {
56
+ return json;
57
+ }
58
+ return {
59
+
60
+ 'auth': json['auth'] == null ? undefined : json['auth'],
61
+ 'l1_address': json['l1_address'],
62
+ 'cursor': json['cursor'] == null ? undefined : json['cursor'],
63
+ };
64
+ }
65
+
66
+ export function ReqGetUserReferralsToJSON(value?: ReqGetUserReferrals | null): any {
67
+ if (value == null) {
68
+ return value;
69
+ }
70
+ return {
71
+
72
+ 'auth': value['auth'],
73
+ 'l1_address': value['l1_address'],
74
+ 'cursor': value['cursor'],
75
+ };
76
+ }
77
+
@@ -0,0 +1,94 @@
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 { Referral } from './Referral';
17
+ import {
18
+ ReferralFromJSON,
19
+ ReferralFromJSONTyped,
20
+ ReferralToJSON,
21
+ } from './Referral';
22
+
23
+ /**
24
+ *
25
+ * @export
26
+ * @interface UserReferrals
27
+ */
28
+ export interface UserReferrals {
29
+ /**
30
+ *
31
+ * @type {number}
32
+ * @memberof UserReferrals
33
+ */
34
+ code: number;
35
+ /**
36
+ *
37
+ * @type {string}
38
+ * @memberof UserReferrals
39
+ */
40
+ message?: string;
41
+ /**
42
+ *
43
+ * @type {string}
44
+ * @memberof UserReferrals
45
+ */
46
+ cursor: string;
47
+ /**
48
+ *
49
+ * @type {Array<Referral>}
50
+ * @memberof UserReferrals
51
+ */
52
+ referrals: Array<Referral>;
53
+ }
54
+
55
+ /**
56
+ * Check if a given object implements the UserReferrals interface.
57
+ */
58
+ export function instanceOfUserReferrals(value: object): value is UserReferrals {
59
+ if (!('code' in value) || value['code'] === undefined) return false;
60
+ if (!('cursor' in value) || value['cursor'] === undefined) return false;
61
+ if (!('referrals' in value) || value['referrals'] === undefined) return false;
62
+ return true;
63
+ }
64
+
65
+ export function UserReferralsFromJSON(json: any): UserReferrals {
66
+ return UserReferralsFromJSONTyped(json, false);
67
+ }
68
+
69
+ export function UserReferralsFromJSONTyped(json: any, ignoreDiscriminator: boolean): UserReferrals {
70
+ if (json == null) {
71
+ return json;
72
+ }
73
+ return {
74
+
75
+ 'code': json['code'],
76
+ 'message': json['message'] == null ? undefined : json['message'],
77
+ 'cursor': json['cursor'],
78
+ 'referrals': ((json['referrals'] as Array<any>).map(ReferralFromJSON)),
79
+ };
80
+ }
81
+
82
+ export function UserReferralsToJSON(value?: UserReferrals | null): any {
83
+ if (value == null) {
84
+ return value;
85
+ }
86
+ return {
87
+
88
+ 'code': value['code'],
89
+ 'message': value['message'],
90
+ 'cursor': value['cursor'],
91
+ 'referrals': ((value['referrals'] as Array<any>).map(ReferralToJSON)),
92
+ };
93
+ }
94
+
package/models/index.ts CHANGED
@@ -86,6 +86,7 @@ export * from './PriceLevel';
86
86
  export * from './PublicPoolInfo';
87
87
  export * from './PublicPoolMetadata';
88
88
  export * from './PublicPoolShare';
89
+ export * from './Referral';
89
90
  export * from './ReferralCode';
90
91
  export * from './ReferralPointEntry';
91
92
  export * from './ReferralPoints';
@@ -136,6 +137,7 @@ export * from './ReqGetTrades';
136
137
  export * from './ReqGetTransferFeeInfo';
137
138
  export * from './ReqGetTransferHistory';
138
139
  export * from './ReqGetTx';
140
+ export * from './ReqGetUserReferrals';
139
141
  export * from './ReqGetWithdrawHistory';
140
142
  export * from './ReqIsWhitelisted';
141
143
  export * from './RespChangeAccountTier';
@@ -175,6 +177,7 @@ export * from './Tx';
175
177
  export * from './TxHash';
176
178
  export * from './TxHashes';
177
179
  export * from './Txs';
180
+ export * from './UserReferrals';
178
181
  export * from './ValidatorInfo';
179
182
  export * from './WithdrawHistory';
180
183
  export * from './WithdrawHistoryItem';
package/openapi.json CHANGED
@@ -1301,6 +1301,8 @@
1301
1301
  "required": true,
1302
1302
  "type": "string",
1303
1303
  "enum": [
1304
+ "h",
1305
+ "d",
1304
1306
  "w",
1305
1307
  "m",
1306
1308
  "q",
@@ -1327,7 +1329,8 @@
1327
1329
  "withdraw_fee",
1328
1330
  "open_interest",
1329
1331
  "account_count",
1330
- "active_account_count"
1332
+ "active_account_count",
1333
+ "tps"
1331
1334
  ]
1332
1335
  },
1333
1336
  {
@@ -2959,6 +2962,59 @@
2959
2962
  "description": "Use referral code"
2960
2963
  }
2961
2964
  },
2965
+ "/api/v1/referral/userReferrals": {
2966
+ "get": {
2967
+ "summary": "referral_userReferrals",
2968
+ "operationId": "referral_userReferrals",
2969
+ "responses": {
2970
+ "200": {
2971
+ "description": "A successful response.",
2972
+ "schema": {
2973
+ "$ref": "#/definitions/UserReferrals"
2974
+ }
2975
+ },
2976
+ "400": {
2977
+ "description": "Bad request",
2978
+ "schema": {
2979
+ "$ref": "#/definitions/ResultCode"
2980
+ }
2981
+ }
2982
+ },
2983
+ "parameters": [
2984
+ {
2985
+ "name": "authorization",
2986
+ "in": "header",
2987
+ "required": false,
2988
+ "type": "string"
2989
+ },
2990
+ {
2991
+ "name": "auth",
2992
+ "in": "query",
2993
+ "required": false,
2994
+ "type": "string"
2995
+ },
2996
+ {
2997
+ "name": "l1_address",
2998
+ "in": "query",
2999
+ "required": true,
3000
+ "type": "string"
3001
+ },
3002
+ {
3003
+ "name": "cursor",
3004
+ "in": "query",
3005
+ "required": false,
3006
+ "type": "string"
3007
+ }
3008
+ ],
3009
+ "tags": [
3010
+ "referral"
3011
+ ],
3012
+ "consumes": [
3013
+ "multipart/form-data"
3014
+ ],
3015
+ "description": "Get user referrals"
3016
+ }
3017
+ },
2962
3018
  "/api/v1/sendTx": {
2963
3019
  "post": {
2964
3020
  "summary": "sendTx",
@@ -7888,6 +7944,27 @@
7888
7944
  "entry_timestamp"
7889
7945
  ]
7890
7946
  },
7947
+ "Referral": {
7948
+ "type": "object",
7949
+ "properties": {
7950
+ "l1_address": {
7951
+ "type": "string"
7952
+ },
7953
+ "referral_code": {
7954
+ "type": "string"
7955
+ },
7956
+ "used_at": {
7957
+ "type": "integer",
7958
+ "format": "int64"
7959
+ }
7960
+ },
7961
+ "title": "Referral",
7962
+ "required": [
7963
+ "l1_address",
7964
+ "referral_code",
7965
+ "used_at"
7966
+ ]
7967
+ },
7891
7968
  "ReferralCode": {
7892
7969
  "type": "object",
7893
7970
  "properties": {
@@ -8681,6 +8758,8 @@
8681
8758
  "period": {
8682
8759
  "type": "string",
8683
8760
  "enum": [
8761
+ "h",
8762
+ "d",
8684
8763
  "w",
8685
8764
  "m",
8686
8765
  "q",
@@ -8704,7 +8783,8 @@
8704
8783
  "withdraw_fee",
8705
8784
  "open_interest",
8706
8785
  "account_count",
8707
- "active_account_count"
8786
+ "active_account_count",
8787
+ "tps"
8708
8788
  ]
8709
8789
  },
8710
8790
  "filter": {
@@ -9355,6 +9435,24 @@
9355
9435
  "value"
9356
9436
  ]
9357
9437
  },
9438
+ "ReqGetUserReferrals": {
9439
+ "type": "object",
9440
+ "properties": {
9441
+ "auth": {
9442
+ "type": "string"
9443
+ },
9444
+ "l1_address": {
9445
+ "type": "string"
9446
+ },
9447
+ "cursor": {
9448
+ "type": "string"
9449
+ }
9450
+ },
9451
+ "title": "ReqGetUserReferrals",
9452
+ "required": [
9453
+ "l1_address"
9454
+ ]
9455
+ },
9358
9456
  "ReqGetWithdrawHistory": {
9359
9457
  "type": "object",
9360
9458
  "properties": {
@@ -11052,6 +11150,34 @@
11052
11150
  "txs"
11053
11151
  ]
11054
11152
  },
11153
+ "UserReferrals": {
11154
+ "type": "object",
11155
+ "properties": {
11156
+ "code": {
11157
+ "type": "integer",
11158
+ "format": "int32",
11159
+ "example": "200"
11160
+ },
11161
+ "message": {
11162
+ "type": "string"
11163
+ },
11164
+ "cursor": {
11165
+ "type": "string"
11166
+ },
11167
+ "referrals": {
11168
+ "type": "array",
11169
+ "items": {
11170
+ "$ref": "#/definitions/Referral"
11171
+ }
11172
+ }
11173
+ },
11174
+ "title": "UserReferrals",
11175
+ "required": [
11176
+ "code",
11177
+ "cursor",
11178
+ "referrals"
11179
+ ]
11180
+ },
11055
11181
  "ValidatorInfo": {
11056
11182
  "type": "object",
11057
11183
  "properties": {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "zklighter-perps",
3
- "version": "1.0.207",
3
+ "version": "1.0.208",
4
4
  "description": "zkLighter Perps SDK",
5
5
  "main": "index.ts",
6
6
  "directories": {