zklighter-perps 1.0.96 → 1.0.98

package/.circleci/openapi_postprocess.py

@@ -33,6 +33,9 @@ with open(FILE, "r") as f:
             if "next_cursor" in required_fields:
                 required_fields.remove("next_cursor")
 
+            if "account_share" in required_fields:
+                required_fields.remove("account_share")
+
             if len(required_fields) > 0:
                 data["definitions"][path]["required"] = required_fields
             else:

package/.openapi-generator/FILES

@@ -4,7 +4,7 @@ apis/BlockApi.ts
 apis/BridgeApi.ts
 apis/CandlestickApi.ts
 apis/InfoApi.ts
-apis/LiquidationApi.ts
+apis/NotificationApi.ts
 apis/OrderApi.ts
 apis/ReferralApi.ts
 apis/RootApi.ts
@@ -50,7 +50,6 @@ models/Layer1BasicInfo.ts
 models/Layer2BasicInfo.ts
 models/Leaderboard.ts
 models/LeaderboardEntry.ts
-models/Liquidation.ts
 models/MarketInfo.ts
 models/NextNonce.ts
 models/Order.ts

package/apis/AccountApi.ts

@@ -66,7 +66,7 @@ export interface AccountsByL1AddressRequest {
 
 export interface ApikeysRequest {
     account_index: number;
-    api_key_index: number;
+    api_key_index?: number;
 }
 
 export interface FaucetRequest {
@@ -256,13 +256,6 @@ export class AccountApi extends runtime.BaseAPI {
             );
         }
 
-        if (requestParameters['api_key_index'] == null) {
-            throw new runtime.RequiredError(
-                'api_key_index',
-                'Required parameter "api_key_index" was null or undefined when calling apikeys().'
-            );
-        }
-
         const queryParameters: any = {};
 
         if (requestParameters['account_index'] != null) {

package/apis/NotificationApi.ts

@@ -0,0 +1,112 @@
+/* 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 {
+  ResultCode,
+} from '../models/index';
+import {
+    ResultCodeFromJSON,
+    ResultCodeToJSON,
+} from '../models/index';
+
+export interface NotificationAckRequest {
+    notif_id: string;
+    auth: string;
+    account_index: number;
+}
+
+/**
+ * 
+ */
+export class NotificationApi extends runtime.BaseAPI {
+
+    /**
+     * Ack notification
+     * notification_ack
+     */
+    async notificationAckRaw(requestParameters: NotificationAckRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ResultCode>> {
+        if (requestParameters['notif_id'] == null) {
+            throw new runtime.RequiredError(
+                'notif_id',
+                'Required parameter "notif_id" was null or undefined when calling notificationAck().'
+            );
+        }
+
+        if (requestParameters['auth'] == null) {
+            throw new runtime.RequiredError(
+                'auth',
+                'Required parameter "auth" was null or undefined when calling notificationAck().'
+            );
+        }
+
+        if (requestParameters['account_index'] == null) {
+            throw new runtime.RequiredError(
+                'account_index',
+                'Required parameter "account_index" was null or undefined when calling notificationAck().'
+            );
+        }
+
+        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['notif_id'] != null) {
+            formParams.append('notif_id', requestParameters['notif_id'] as any);
+        }
+
+        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/notification/ack`,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: formParams,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ResultCodeFromJSON(jsonValue));
+    }
+
+    /**
+     * Ack notification
+     * notification_ack
+     */
+    async notificationAck(requestParameters: NotificationAckRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ResultCode> {
+        const response = await this.notificationAckRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}

package/apis/index.ts

@@ -6,7 +6,7 @@ export * from './BlockApi';
 export * from './BridgeApi';
 export * from './CandlestickApi';
 export * from './InfoApi';
-export * from './LiquidationApi';
+export * from './NotificationApi';
 export * from './OrderApi';
 export * from './ReferralApi';
 export * from './RootApi';

package/models/PnLEntry.ts

@@ -31,6 +31,18 @@ export interface PnLEntry {
      * @memberof PnLEntry
      */
     value: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof PnLEntry
+     */
+    trade_pnl: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof PnLEntry
+     */
+    pool_pnl: number;
 }
 
 /**
@@ -39,6 +51,8 @@ export interface PnLEntry {
 export function instanceOfPnLEntry(value: object): value is PnLEntry {
     if (!('timestamp' in value) || value['timestamp'] === undefined) return false;
     if (!('value' in value) || value['value'] === undefined) return false;
+    if (!('trade_pnl' in value) || value['trade_pnl'] === undefined) return false;
+    if (!('pool_pnl' in value) || value['pool_pnl'] === undefined) return false;
     return true;
 }
 
@@ -54,6 +68,8 @@ export function PnLEntryFromJSONTyped(json: any, ignoreDiscriminator: boolean):
         
         'timestamp': json['timestamp'],
         'value': json['value'],
+        'trade_pnl': json['trade_pnl'],
+        'pool_pnl': json['pool_pnl'],
     };
 }
 
@@ -65,6 +81,8 @@ export function PnLEntryToJSON(value?: PnLEntry | null): any {
         
         'timestamp': value['timestamp'],
         'value': value['value'],
+        'trade_pnl': value['trade_pnl'],
+        'pool_pnl': value['pool_pnl'],
     };
 }
 

package/models/PublicPool.ts

@@ -139,7 +139,7 @@ export interface PublicPool {
      * @type {PublicPoolShare}
      * @memberof PublicPool
      */
-    account_share: PublicPoolShare;
+    account_share?: PublicPoolShare;
 }
 
 /**
@@ -162,7 +162,6 @@ export function instanceOfPublicPool(value: object): value is PublicPool {
     if (!('max_referral_usage_limit' in value) || value['max_referral_usage_limit'] === undefined) return false;
     if (!('total_asset_value' in value) || value['total_asset_value'] === undefined) return false;
     if (!('pool_info' in value) || value['pool_info'] === undefined) return false;
-    if (!('account_share' in value) || value['account_share'] === undefined) return false;
     return true;
 }
 
@@ -193,7 +192,7 @@ export function PublicPoolFromJSONTyped(json: any, ignoreDiscriminator: boolean)
         'max_referral_usage_limit': json['max_referral_usage_limit'],
         'total_asset_value': json['total_asset_value'],
         'pool_info': PublicPoolInfoFromJSON(json['pool_info']),
-        'account_share': PublicPoolShareFromJSON(json['account_share']),
+        'account_share': json['account_share'] == null ? undefined : PublicPoolShareFromJSON(json['account_share']),
     };
 }
 

package/models/ReqGetAccountApiKeys.ts

@@ -30,7 +30,7 @@ export interface ReqGetAccountApiKeys {
      * @type {number}
      * @memberof ReqGetAccountApiKeys
      */
-    api_key_index: number;
+    api_key_index?: number;
 }
 
 /**
@@ -38,7 +38,6 @@ export interface ReqGetAccountApiKeys {
  */
 export function instanceOfReqGetAccountApiKeys(value: object): value is ReqGetAccountApiKeys {
     if (!('account_index' in value) || value['account_index'] === undefined) return false;
-    if (!('api_key_index' in value) || value['api_key_index'] === undefined) return false;
     return true;
 }
 
@@ -53,7 +52,7 @@ export function ReqGetAccountApiKeysFromJSONTyped(json: any, ignoreDiscriminator
     return {
         
         'account_index': json['account_index'],
-        'api_key_index': json['api_key_index'],
+        'api_key_index': json['api_key_index'] == null ? undefined : json['api_key_index'],
     };
 }
 

package/models/index.ts

@@ -39,7 +39,6 @@ export * from './Layer1BasicInfo';
 export * from './Layer2BasicInfo';
 export * from './Leaderboard';
 export * from './LeaderboardEntry';
-export * from './Liquidation';
 export * from './MarketInfo';
 export * from './NextNonce';
 export * from './Order';

package/openapi.json

@@ -532,7 +532,7 @@
           {
             "name": "api_key_index",
             "in": "query",
-            "required": true,
+            "required": false,
             "type": "integer",
             "format": "uint8",
             "default": "255"
@@ -1355,15 +1355,15 @@
         "description": "Get points leaderboard"
       }
     },
-    "/api/v1/markNotifRead": {
-      "post": {
-        "summary": "markNotifRead",
-        "operationId": "markNotifRead",
+    "/api/v1/nextNonce": {
+      "get": {
+        "summary": "nextNonce",
+        "operationId": "nextNonce",
         "responses": {
           "200": {
             "description": "A successful response.",
             "schema": {
-              "$ref": "#/definitions/ResultCode"
+              "$ref": "#/definitions/NextNonce"
             }
           },
           "400": {
@@ -1375,32 +1375,38 @@
         },
         "parameters": [
           {
-            "name": "body",
-            "in": "body",
+            "name": "account_index",
+            "in": "query",
             "required": true,
-            "schema": {
-              "$ref": "#/definitions/ReqMarkNotifRead"
-            }
+            "type": "integer",
+            "format": "int64"
+          },
+          {
+            "name": "api_key_index",
+            "in": "query",
+            "required": true,
+            "type": "integer",
+            "format": "uint8"
           }
         ],
         "tags": [
-          "liquidation"
+          "transaction"
         ],
         "consumes": [
           "multipart/form-data"
         ],
-        "description": "Mark liquidation notification as read"
+        "description": "Get next nonce for a specific account and api key"
       }
     },
-    "/api/v1/nextNonce": {
-      "get": {
-        "summary": "nextNonce",
-        "operationId": "nextNonce",
+    "/api/v1/notification/ack": {
+      "post": {
+        "summary": "notification_ack",
+        "operationId": "notification_ack",
         "responses": {
           "200": {
             "description": "A successful response.",
             "schema": {
-              "$ref": "#/definitions/NextNonce"
+              "$ref": "#/definitions/ResultCode"
             }
           },
           "400": {
@@ -1412,27 +1418,21 @@
         },
         "parameters": [
           {
-            "name": "account_index",
-            "in": "query",
-            "required": true,
-            "type": "integer",
-            "format": "int64"
-          },
-          {
-            "name": "api_key_index",
-            "in": "query",
+            "name": "body",
+            "in": "body",
             "required": true,
-            "type": "integer",
-            "format": "uint8"
+            "schema": {
+              "$ref": "#/definitions/ReqAckNotif"
+            }
           }
         ],
         "tags": [
-          "transaction"
+          "notification"
         ],
         "consumes": [
           "multipart/form-data"
         ],
-        "description": "Get next nonce for a specific account and api key"
+        "description": "Ack notification"
       }
     },
     "/api/v1/orderBookDetails": {
@@ -3961,42 +3961,6 @@
         "entryId"
       ]
     },
-    "Liquidation": {
-      "type": "object",
-      "properties": {
-        "liquidation_id": {
-          "type": "integer",
-          "format": "int64",
-          "example": "1"
-        },
-        "account_index": {
-          "type": "integer",
-          "format": "int64",
-          "example": "1"
-        },
-        "liquidation_type": {
-          "type": "integer",
-          "format": "uint8",
-          "example": "1"
-        },
-        "portfolio_value": {
-          "type": "string",
-          "example": "1"
-        },
-        "margin_requirement": {
-          "type": "string",
-          "example": "1"
-        }
-      },
-      "title": "Liquidation",
-      "required": [
-        "liquidation_id",
-        "account_index",
-        "liquidation_type",
-        "portfolio_value",
-        "margin_requirement"
-      ]
-    },
     "MarketInfo": {
       "type": "object",
       "properties": {
@@ -4727,12 +4691,24 @@
           "type": "number",
           "format": "double",
           "example": "12.0"
+        },
+        "trade_pnl": {
+          "type": "number",
+          "format": "double",
+          "example": "12.0"
+        },
+        "pool_pnl": {
+          "type": "number",
+          "format": "double",
+          "example": "12.0"
         }
       },
       "title": "PnLEntry",
       "required": [
         "timestamp",
-        "value"
+        "value",
+        "trade_pnl",
+        "pool_pnl"
       ]
     },
     "PositionFunding": {
@@ -4897,8 +4873,7 @@
         "referral_points_percentage",
         "max_referral_usage_limit",
         "total_asset_value",
-        "pool_info",
-        "account_share"
+        "pool_info"
       ]
     },
     "PublicPoolInfo": {
@@ -5135,6 +5110,28 @@
         "reward_point_multiplier"
       ]
     },
+    "ReqAckNotif": {
+      "type": "object",
+      "properties": {
+        "notif_id": {
+          "type": "string",
+          "example": "'liq:17:5898'"
+        },
+        "auth": {
+          "type": "string"
+        },
+        "account_index": {
+          "type": "integer",
+          "format": "int64"
+        }
+      },
+      "title": "ReqAckNotif",
+      "required": [
+        "notif_id",
+        "auth",
+        "account_index"
+      ]
+    },
     "ReqCancelDeposit": {
       "type": "object",
       "properties": {
@@ -5281,8 +5278,7 @@
       },
       "title": "ReqGetAccountApiKeys",
       "required": [
-        "account_index",
-        "api_key_index"
+        "account_index"
       ]
     },
     "ReqGetAccountByL1Address": {
@@ -6011,39 +6007,6 @@
         "l1_address"
       ]
     },
-    "ReqMarkNotifRead": {
-      "type": "object",
-      "properties": {
-        "notif_type": {
-          "type": "string",
-          "enum": [
-            "liquidation"
-          ]
-        },
-        "account_index": {
-          "type": "integer",
-          "format": "int64"
-        },
-        "api_key_index": {
-          "type": "integer",
-          "format": "uint8"
-        },
-        "liquidation_ids": {
-          "type": "string"
-        },
-        "signature": {
-          "type": "string"
-        }
-      },
-      "title": "ReqMarkNotifRead",
-      "required": [
-        "notif_type",
-        "account_index",
-        "api_key_index",
-        "liquidation_ids",
-        "signature"
-      ]
-    },
     "ReqSendTx": {
       "type": "object",
       "properties": {

package/package.json

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