zklighter-perps 1.0.90 → 1.0.91

package/.openapi-generator/FILES

@@ -5,6 +5,7 @@ apis/CandlestickApi.ts
 apis/InfoApi.ts
 apis/LiquidationApi.ts
 apis/OrderApi.ts
+apis/ReferralApi.ts
 apis/RootApi.ts
 apis/TransactionApi.ts
 apis/index.ts
@@ -65,6 +66,7 @@ models/PublicPool.ts
 models/PublicPoolInfo.ts
 models/PublicPoolShare.ts
 models/PublicPools.ts
+models/ReferralCode.ts
 models/ReqDoFaucet.ts
 models/ReqGetAccount.ts
 models/ReqGetAccountActiveOrders.ts
@@ -94,6 +96,7 @@ models/ReqGetRangeWithCursor.ts
 models/ReqGetRangeWithIndex.ts
 models/ReqGetRangeWithIndexSortable.ts
 models/ReqGetRecentTrades.ts
+models/ReqGetReferralCode.ts
 models/ReqGetTrades.ts
 models/ReqGetTx.ts
 models/ReqGetWithdrawHistory.ts

package/apis/AccountApi.ts

@@ -245,7 +245,7 @@ export class AccountApi extends runtime.BaseAPI {
     }
 
     /**
-     * Get account api key
+     * Get account api key. Set `api_key_index` to 255 to retrieve all api keys associated with the account.
      * apikeys
      */
     async apikeysRaw(requestParameters: ApikeysRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AccountApiKeys>> {
@@ -286,7 +286,7 @@ export class AccountApi extends runtime.BaseAPI {
     }
 
     /**
-     * Get account api key
+     * Get account api key. Set `api_key_index` to 255 to retrieve all api keys associated with the account.
      * apikeys
      */
     async apikeys(requestParameters: ApikeysRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AccountApiKeys> {

package/apis/InfoApi.ts

@@ -62,7 +62,7 @@ export class InfoApi extends runtime.BaseAPI {
     }
 
     /**
-     * Get zklighter general info, including contract address, and count of transactions and active users
+     * Get zklighter general info, including transaction and block stats
      * layer2BasicInfo
      */
     async layer2BasicInfoRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Layer2BasicInfo>> {
@@ -81,7 +81,7 @@ export class InfoApi extends runtime.BaseAPI {
     }
 
     /**
-     * Get zklighter general info, including contract address, and count of transactions and active users
+     * Get zklighter general info, including transaction and block stats
      * layer2BasicInfo
      */
     async layer2BasicInfo(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Layer2BasicInfo> {

package/apis/OrderApi.ts

@@ -98,7 +98,7 @@ export interface TradesRequest {
 export class OrderApi extends runtime.BaseAPI {
 
     /**
-     * Get account active orders
+     * Get account active orders. `auth` can be generated using the SDK.
      * accountActiveOrders
      */
     async accountActiveOrdersRaw(requestParameters: AccountActiveOrdersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Orders>> {
@@ -150,7 +150,7 @@ export class OrderApi extends runtime.BaseAPI {
     }
 
     /**
-     * Get account active orders
+     * Get account active orders. `auth` can be generated using the SDK.
      * accountActiveOrders
      */
     async accountActiveOrders(requestParameters: AccountActiveOrdersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Orders> {
@@ -159,7 +159,7 @@ export class OrderApi extends runtime.BaseAPI {
     }
 
     /**
-     * Get account active orders
+     * Get account inactive orders
      * accountInactiveOrders
      */
     async accountInactiveOrdersRaw(requestParameters: AccountInactiveOrdersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Orders>> {
@@ -216,7 +216,7 @@ export class OrderApi extends runtime.BaseAPI {
     }
 
     /**
-     * Get account active orders
+     * Get account inactive orders
      * accountInactiveOrders
      */
     async accountInactiveOrders(requestParameters: AccountInactiveOrdersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Orders> {

package/apis/ReferralApi.ts

@@ -0,0 +1,238 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import * as runtime from '../runtime';
+import type {
+  ReferralCode,
+  ResultCode,
+} from '../models/index';
+import {
+    ReferralCodeFromJSON,
+    ReferralCodeToJSON,
+    ResultCodeFromJSON,
+    ResultCodeToJSON,
+} from '../models/index';
+
+export interface ReferralCreateRequest {
+    auth: string;
+    account_index: number;
+}
+
+export interface ReferralGetRequest {
+    auth: string;
+    account_index: number;
+}
+
+export interface ReferralUseRequest {
+    l1_address: string;
+    referral_code: string;
+    discord?: string;
+    telegram?: string;
+}
+
+/**
+ * 
+ */
+export class ReferralApi extends runtime.BaseAPI {
+
+    /**
+     * Create referral code
+     * referral_create
+     */
+    async referralCreateRaw(requestParameters: ReferralCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReferralCode>> {
+        if (requestParameters['auth'] == null) {
+            throw new runtime.RequiredError(
+                'auth',
+                'Required parameter "auth" was null or undefined when calling referralCreate().'
+            );
+        }
+
+        if (requestParameters['account_index'] == null) {
+            throw new runtime.RequiredError(
+                'account_index',
+                'Required parameter "account_index" was null or undefined when calling referralCreate().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const consumes: runtime.Consume[] = [
+            { contentType: 'multipart/form-data' },
+        ];
+        // @ts-ignore: canConsumeForm may be unused
+        const canConsumeForm = runtime.canConsumeForm(consumes);
+
+        let formParams: { append(param: string, value: any): any };
+        let useForm = false;
+        if (useForm) {
+            formParams = new FormData();
+        } else {
+            formParams = new URLSearchParams();
+        }
+
+        if (requestParameters['auth'] != null) {
+            formParams.append('auth', requestParameters['auth'] as any);
+        }
+
+        if (requestParameters['account_index'] != null) {
+            formParams.append('account_index', requestParameters['account_index'] as any);
+        }
+
+        const response = await this.request({
+            path: `/api/v1/referral/create`,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: formParams,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ReferralCodeFromJSON(jsonValue));
+    }
+
+    /**
+     * Create referral code
+     * referral_create
+     */
+    async referralCreate(requestParameters: ReferralCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReferralCode> {
+        const response = await this.referralCreateRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Get referral code
+     * referral_get
+     */
+    async referralGetRaw(requestParameters: ReferralGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReferralCode>> {
+        if (requestParameters['auth'] == null) {
+            throw new runtime.RequiredError(
+                'auth',
+                'Required parameter "auth" was null or undefined when calling referralGet().'
+            );
+        }
+
+        if (requestParameters['account_index'] == null) {
+            throw new runtime.RequiredError(
+                'account_index',
+                'Required parameter "account_index" was null or undefined when calling referralGet().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['auth'] != null) {
+            queryParameters['auth'] = requestParameters['auth'];
+        }
+
+        if (requestParameters['account_index'] != null) {
+            queryParameters['account_index'] = requestParameters['account_index'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/api/v1/referral/get`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ReferralCodeFromJSON(jsonValue));
+    }
+
+    /**
+     * Get referral code
+     * referral_get
+     */
+    async referralGet(requestParameters: ReferralGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReferralCode> {
+        const response = await this.referralGetRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Use referral code
+     * referral_use
+     */
+    async referralUseRaw(requestParameters: ReferralUseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ResultCode>> {
+        if (requestParameters['l1_address'] == null) {
+            throw new runtime.RequiredError(
+                'l1_address',
+                'Required parameter "l1_address" was null or undefined when calling referralUse().'
+            );
+        }
+
+        if (requestParameters['referral_code'] == null) {
+            throw new runtime.RequiredError(
+                'referral_code',
+                'Required parameter "referral_code" was null or undefined when calling referralUse().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const consumes: runtime.Consume[] = [
+            { contentType: 'multipart/form-data' },
+        ];
+        // @ts-ignore: canConsumeForm may be unused
+        const canConsumeForm = runtime.canConsumeForm(consumes);
+
+        let formParams: { append(param: string, value: any): any };
+        let useForm = false;
+        if (useForm) {
+            formParams = new FormData();
+        } else {
+            formParams = new URLSearchParams();
+        }
+
+        if (requestParameters['l1_address'] != null) {
+            formParams.append('l1_address', requestParameters['l1_address'] as any);
+        }
+
+        if (requestParameters['referral_code'] != null) {
+            formParams.append('referral_code', requestParameters['referral_code'] as any);
+        }
+
+        if (requestParameters['discord'] != null) {
+            formParams.append('discord', requestParameters['discord'] as any);
+        }
+
+        if (requestParameters['telegram'] != null) {
+            formParams.append('telegram', requestParameters['telegram'] as any);
+        }
+
+        const response = await this.request({
+            path: `/api/v1/referral/use`,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: formParams,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ResultCodeFromJSON(jsonValue));
+    }
+
+    /**
+     * Use referral code
+     * referral_use
+     */
+    async referralUse(requestParameters: ReferralUseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ResultCode> {
+        const response = await this.referralUseRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}

package/apis/TransactionApi.ts

@@ -343,7 +343,7 @@ export class TransactionApi extends runtime.BaseAPI {
     }
 
     /**
-     * Get next nonce for a specific account
+     * Get next nonce for a specific account and api key
      * nextNonce
      */
     async nextNonceRaw(requestParameters: NextNonceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<NextNonce>> {
@@ -384,7 +384,7 @@ export class TransactionApi extends runtime.BaseAPI {
     }
 
     /**
-     * Get next nonce for a specific account
+     * Get next nonce for a specific account and api key
      * nextNonce
      */
     async nextNonce(requestParameters: NextNonceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<NextNonce> {

package/apis/index.ts

@@ -7,5 +7,6 @@ export * from './CandlestickApi';
 export * from './InfoApi';
 export * from './LiquidationApi';
 export * from './OrderApi';
+export * from './ReferralApi';
 export * from './RootApi';
 export * from './TransactionApi';

package/models/ReferralCode.ts

@@ -0,0 +1,87 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface ReferralCode
+ */
+export interface ReferralCode {
+    /**
+     * 
+     * @type {number}
+     * @memberof ReferralCode
+     */
+    code: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof ReferralCode
+     */
+    message?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ReferralCode
+     */
+    referral_code: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof ReferralCode
+     */
+    remaining_usage: number;
+}
+
+/**
+ * Check if a given object implements the ReferralCode interface.
+ */
+export function instanceOfReferralCode(value: object): value is ReferralCode {
+    if (!('code' in value) || value['code'] === undefined) return false;
+    if (!('referral_code' in value) || value['referral_code'] === undefined) return false;
+    if (!('remaining_usage' in value) || value['remaining_usage'] === undefined) return false;
+    return true;
+}
+
+export function ReferralCodeFromJSON(json: any): ReferralCode {
+    return ReferralCodeFromJSONTyped(json, false);
+}
+
+export function ReferralCodeFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReferralCode {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'code': json['code'],
+        'message': json['message'] == null ? undefined : json['message'],
+        'referral_code': json['referral_code'],
+        'remaining_usage': json['remaining_usage'],
+    };
+}
+
+export function ReferralCodeToJSON(value?: ReferralCode | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'code': value['code'],
+        'message': value['message'],
+        'referral_code': value['referral_code'],
+        'remaining_usage': value['remaining_usage'],
+    };
+}
+

package/models/ReqGetReferralCode.ts

@@ -0,0 +1,70 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface ReqGetReferralCode
+ */
+export interface ReqGetReferralCode {
+    /**
+     * 
+     * @type {string}
+     * @memberof ReqGetReferralCode
+     */
+    auth: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof ReqGetReferralCode
+     */
+    account_index: number;
+}
+
+/**
+ * Check if a given object implements the ReqGetReferralCode interface.
+ */
+export function instanceOfReqGetReferralCode(value: object): value is ReqGetReferralCode {
+    if (!('auth' in value) || value['auth'] === undefined) return false;
+    if (!('account_index' in value) || value['account_index'] === undefined) return false;
+    return true;
+}
+
+export function ReqGetReferralCodeFromJSON(json: any): ReqGetReferralCode {
+    return ReqGetReferralCodeFromJSONTyped(json, false);
+}
+
+export function ReqGetReferralCodeFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReqGetReferralCode {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'auth': json['auth'],
+        'account_index': json['account_index'],
+    };
+}
+
+export function ReqGetReferralCodeToJSON(value?: ReqGetReferralCode | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'auth': value['auth'],
+        'account_index': value['account_index'],
+    };
+}
+

package/models/index.ts

@@ -56,6 +56,7 @@ export * from './PublicPool';
 export * from './PublicPoolInfo';
 export * from './PublicPoolShare';
 export * from './PublicPools';
+export * from './ReferralCode';
 export * from './ReqDoFaucet';
 export * from './ReqGetAccount';
 export * from './ReqGetAccountActiveOrders';
@@ -85,6 +86,7 @@ export * from './ReqGetRangeWithCursor';
 export * from './ReqGetRangeWithIndex';
 export * from './ReqGetRangeWithIndexSortable';
 export * from './ReqGetRecentTrades';
+export * from './ReqGetReferralCode';
 export * from './ReqGetTrades';
 export * from './ReqGetTx';
 export * from './ReqGetWithdrawHistory';

package/openapi.json

@@ -130,7 +130,7 @@
         "consumes": [
           "multipart/form-data"
         ],
-        "description": "Get account active orders"
+        "description": "Get account active orders. `auth` can be generated using the SDK."
       }
     },
     "/api/v1/accountInactiveOrders": {
@@ -203,7 +203,7 @@
         "consumes": [
           "multipart/form-data"
         ],
-        "description": "Get account active orders"
+        "description": "Get account inactive orders"
       }
     },
     "/api/v1/accountOrders": {
@@ -520,7 +520,7 @@
         "consumes": [
           "multipart/form-data"
         ],
-        "description": "Get account api key"
+        "description": "Get account api key. Set `api_key_index` to 255 to retrieve all api keys associated with the account."
       }
     },
     "/api/v1/block": {
@@ -1259,7 +1259,7 @@
         "tags": [
           "info"
         ],
-        "description": "Get zklighter general info, including contract address, and count of transactions and active users"
+        "description": "Get zklighter general info, including transaction and block stats"
       }
     },
     "/api/v1/leaderboard": {
@@ -1384,7 +1384,7 @@
         "consumes": [
           "multipart/form-data"
         ],
-        "description": "Get next nonce for a specific account"
+        "description": "Get next nonce for a specific account and api key"
       }
     },
     "/api/v1/orderBookDetails": {
@@ -1747,6 +1747,122 @@
         "description": "Get recent trades"
       }
     },
+    "/api/v1/referral/create": {
+      "post": {
+        "summary": "referral_create",
+        "operationId": "referral_create",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/ReferralCode"
+            }
+          },
+          "400": {
+            "description": "Bad request",
+            "schema": {
+              "$ref": "#/definitions/ResultCode"
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "body",
+            "in": "body",
+            "required": true,
+            "schema": {
+              "$ref": "#/definitions/ReqCreateReferralCode"
+            }
+          }
+        ],
+        "tags": [
+          "referral"
+        ],
+        "consumes": [
+          "multipart/form-data"
+        ],
+        "description": "Create referral code"
+      }
+    },
+    "/api/v1/referral/get": {
+      "get": {
+        "summary": "referral_get",
+        "operationId": "referral_get",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/ReferralCode"
+            }
+          },
+          "400": {
+            "description": "Bad request",
+            "schema": {
+              "$ref": "#/definitions/ResultCode"
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "auth",
+            "in": "query",
+            "required": true,
+            "type": "string"
+          },
+          {
+            "name": "account_index",
+            "in": "query",
+            "required": true,
+            "type": "integer",
+            "format": "int64"
+          }
+        ],
+        "tags": [
+          "referral"
+        ],
+        "consumes": [
+          "multipart/form-data"
+        ],
+        "description": "Get referral code"
+      }
+    },
+    "/api/v1/referral/use": {
+      "post": {
+        "summary": "referral_use",
+        "operationId": "referral_use",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/ResultCode"
+            }
+          },
+          "400": {
+            "description": "Bad request",
+            "schema": {
+              "$ref": "#/definitions/ResultCode"
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "body",
+            "in": "body",
+            "required": true,
+            "schema": {
+              "$ref": "#/definitions/ReqUseReferralCode"
+            }
+          }
+        ],
+        "tags": [
+          "referral"
+        ],
+        "consumes": [
+          "multipart/form-data"
+        ],
+        "description": "Use referral code"
+      }
+    },
     "/api/v1/sendTx": {
       "post": {
         "summary": "sendTx",
@@ -4642,6 +4758,34 @@
         "public_pools"
       ]
     },
+    "ReferralCode": {
+      "type": "object",
+      "properties": {
+        "code": {
+          "type": "integer",
+          "format": "int32",
+          "example": "200"
+        },
+        "message": {
+          "type": "string"
+        },
+        "referral_code": {
+          "type": "string",
+          "example": "5V24K3MJ"
+        },
+        "remaining_usage": {
+          "type": "integer",
+          "format": "int32",
+          "example": "3"
+        }
+      },
+      "title": "ReferralCode",
+      "required": [
+        "code",
+        "referral_code",
+        "remaining_usage"
+      ]
+    },
     "ReqCancelDeposit": {
       "type": "object",
       "properties": {
@@ -4682,6 +4826,23 @@
         "amount"
       ]
     },
+    "ReqCreateReferralCode": {
+      "type": "object",
+      "properties": {
+        "auth": {
+          "type": "string"
+        },
+        "account_index": {
+          "type": "integer",
+          "format": "int64"
+        }
+      },
+      "title": "ReqCreateReferralCode",
+      "required": [
+        "auth",
+        "account_index"
+      ]
+    },
     "ReqDoFaucet": {
       "type": "object",
       "properties": {
@@ -5352,6 +5513,23 @@
         "limit"
       ]
     },
+    "ReqGetReferralCode": {
+      "type": "object",
+      "properties": {
+        "auth": {
+          "type": "string"
+        },
+        "account_index": {
+          "type": "integer",
+          "format": "int64"
+        }
+      },
+      "title": "ReqGetReferralCode",
+      "required": [
+        "auth",
+        "account_index"
+      ]
+    },
     "ReqGetTrades": {
       "type": "object",
       "properties": {
@@ -5569,6 +5747,28 @@
         "auth"
       ]
     },
+    "ReqUseReferralCode": {
+      "type": "object",
+      "properties": {
+        "l1_address": {
+          "type": "string"
+        },
+        "referral_code": {
+          "type": "string"
+        },
+        "discord": {
+          "type": "string"
+        },
+        "telegram": {
+          "type": "string"
+        }
+      },
+      "title": "ReqUseReferralCode",
+      "required": [
+        "l1_address",
+        "referral_code"
+      ]
+    },
     "RespGetFastwithdrawalInfo": {
       "type": "object",
       "properties": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zklighter-perps",
-  "version": "1.0.90",
+  "version": "1.0.91",
   "description": "zkLighter Perps SDK",
   "main": "index.ts",
   "directories": {