zklighter-perps 1.0.16 → 1.0.17

package/.openapi-generator/FILES

@@ -2,6 +2,7 @@ apis/AccountApi.ts
 apis/BlockApi.ts
 apis/CandlestickApi.ts
 apis/InfoApi.ts
+apis/LiquidationApi.ts
 apis/OrderApi.ts
 apis/RootApi.ts
 apis/TransactionApi.ts
@@ -29,6 +30,7 @@ models/Fundings.ts
 models/L1ProviderInfo.ts
 models/Layer1BasicInfo.ts
 models/Layer2BasicInfo.ts
+models/Liquidation.ts
 models/MarketInfo.ts
 models/NextNonce.ts
 models/Order.ts
@@ -70,6 +72,7 @@ models/ReqGetRecentTrades.ts
 models/ReqGetRollbacks.ts
 models/ReqGetTrades.ts
 models/ReqGetTx.ts
+models/ReqMarkNotifRead.ts
 models/ReqSearch.ts
 models/ResultCode.ts
 models/Rollback.ts

package/apis/LiquidationApi.ts

@@ -0,0 +1,121 @@
+/* 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 MarkNotifReadRequest {
+    notif_type: string;
+    account_index: number;
+    api_key_index: number;
+    liquidation_ids: string;
+    signature: string;
+}
+
+/**
+ * 
+ */
+export class LiquidationApi extends runtime.BaseAPI {
+
+    /**
+     * Mark
+     * MarkNotifRead
+     */
+    async markNotifReadRaw(requestParameters: MarkNotifReadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ResultCode>> {
+        if (requestParameters['notif_type'] == null) {
+            throw new runtime.RequiredError(
+                'notif_type',
+                'Required parameter "notif_type" was null or undefined when calling markNotifRead().'
+            );
+        }
+
+        if (requestParameters['account_index'] == null) {
+            throw new runtime.RequiredError(
+                'account_index',
+                'Required parameter "account_index" was null or undefined when calling markNotifRead().'
+            );
+        }
+
+        if (requestParameters['api_key_index'] == null) {
+            throw new runtime.RequiredError(
+                'api_key_index',
+                'Required parameter "api_key_index" was null or undefined when calling markNotifRead().'
+            );
+        }
+
+        if (requestParameters['liquidation_ids'] == null) {
+            throw new runtime.RequiredError(
+                'liquidation_ids',
+                'Required parameter "liquidation_ids" was null or undefined when calling markNotifRead().'
+            );
+        }
+
+        if (requestParameters['signature'] == null) {
+            throw new runtime.RequiredError(
+                'signature',
+                'Required parameter "signature" was null or undefined when calling markNotifRead().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['notif_type'] != null) {
+            queryParameters['notif_type'] = requestParameters['notif_type'];
+        }
+
+        if (requestParameters['account_index'] != null) {
+            queryParameters['account_index'] = requestParameters['account_index'];
+        }
+
+        if (requestParameters['api_key_index'] != null) {
+            queryParameters['api_key_index'] = requestParameters['api_key_index'];
+        }
+
+        if (requestParameters['liquidation_ids'] != null) {
+            queryParameters['liquidation_ids'] = requestParameters['liquidation_ids'];
+        }
+
+        if (requestParameters['signature'] != null) {
+            queryParameters['signature'] = requestParameters['signature'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/api/v1/markNotifRead`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ResultCodeFromJSON(jsonValue));
+    }
+
+    /**
+     * Mark
+     * MarkNotifRead
+     */
+    async markNotifRead(requestParameters: MarkNotifReadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ResultCode> {
+        const response = await this.markNotifReadRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}

package/apis/index.ts

@@ -4,6 +4,7 @@ export * from './AccountApi';
 export * from './BlockApi';
 export * from './CandlestickApi';
 export * from './InfoApi';
+export * from './LiquidationApi';
 export * from './OrderApi';
 export * from './RootApi';
 export * from './TransactionApi';

package/models/EnrichedTx.ts

@@ -108,7 +108,7 @@ export interface EnrichedTx {
      * @type {number}
      * @memberof EnrichedTx
      */
-    verify_at?: number;
+    executed_at: number;
     /**
      * 
      * @type {number}
@@ -127,21 +127,15 @@ export interface EnrichedTx {
      * @memberof EnrichedTx
      */
     verified_at: number;
-    /**
-     * 
-     * @type {number}
-     * @memberof EnrichedTx
-     */
-    executed_at: number;
 }
 
 /**
  * Check if a given object implements the EnrichedTx interface.
  */
 export function instanceOfEnrichedTx(value: object): value is EnrichedTx {
+    if (!('executed_at' in value) || value['executed_at'] === undefined) return false;
     if (!('committed_at' in value) || value['committed_at'] === undefined) return false;
     if (!('verified_at' in value) || value['verified_at'] === undefined) return false;
-    if (!('executed_at' in value) || value['executed_at'] === undefined) return false;
     return true;
 }
 
@@ -169,11 +163,10 @@ export function EnrichedTxFromJSONTyped(json: any, ignoreDiscriminator: boolean)
         'expire_at': json['expire_at'] == null ? undefined : json['expire_at'],
         'block_height': json['block_height'] == null ? undefined : json['block_height'],
         'created_at': json['created_at'] == null ? undefined : json['created_at'],
-        'verify_at': json['verify_at'] == null ? undefined : json['verify_at'],
+        'executed_at': json['executed_at'],
         'sequence_index': json['sequence_index'] == null ? undefined : json['sequence_index'],
         'committed_at': json['committed_at'],
         'verified_at': json['verified_at'],
-        'executed_at': json['executed_at'],
     };
 }
 
@@ -197,11 +190,10 @@ export function EnrichedTxToJSON(value?: EnrichedTx | null): any {
         'expire_at': value['expire_at'],
         'block_height': value['block_height'],
         'created_at': value['created_at'],
-        'verify_at': value['verify_at'],
+        'executed_at': value['executed_at'],
         'sequence_index': value['sequence_index'],
         'committed_at': value['committed_at'],
         'verified_at': value['verified_at'],
-        'executed_at': value['executed_at'],
     };
 }
 

package/models/Liquidation.ts

@@ -0,0 +1,76 @@
+/* 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 Liquidation
+ */
+export interface Liquidation {
+    /**
+     * 
+     * @type {number}
+     * @memberof Liquidation
+     */
+    LiquidationId?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof Liquidation
+     */
+    AccountIndex?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof Liquidation
+     */
+    LiquidationType?: number;
+}
+
+/**
+ * Check if a given object implements the Liquidation interface.
+ */
+export function instanceOfLiquidation(value: object): value is Liquidation {
+    return true;
+}
+
+export function LiquidationFromJSON(json: any): Liquidation {
+    return LiquidationFromJSONTyped(json, false);
+}
+
+export function LiquidationFromJSONTyped(json: any, ignoreDiscriminator: boolean): Liquidation {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'LiquidationId': json['LiquidationId'] == null ? undefined : json['LiquidationId'],
+        'AccountIndex': json['AccountIndex'] == null ? undefined : json['AccountIndex'],
+        'LiquidationType': json['LiquidationType'] == null ? undefined : json['LiquidationType'],
+    };
+}
+
+export function LiquidationToJSON(value?: Liquidation | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'LiquidationId': value['LiquidationId'],
+        'AccountIndex': value['AccountIndex'],
+        'LiquidationType': value['LiquidationType'],
+    };
+}
+

package/models/ReqMarkNotifRead.ts

@@ -0,0 +1,97 @@
+/* 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 ReqMarkNotifRead
+ */
+export interface ReqMarkNotifRead {
+    /**
+     * 
+     * @type {string}
+     * @memberof ReqMarkNotifRead
+     */
+    notif_type: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof ReqMarkNotifRead
+     */
+    account_index: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof ReqMarkNotifRead
+     */
+    api_key_index: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof ReqMarkNotifRead
+     */
+    liquidation_ids: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ReqMarkNotifRead
+     */
+    signature: string;
+}
+
+/**
+ * Check if a given object implements the ReqMarkNotifRead interface.
+ */
+export function instanceOfReqMarkNotifRead(value: object): value is ReqMarkNotifRead {
+    if (!('notif_type' in value) || value['notif_type'] === undefined) return false;
+    if (!('account_index' in value) || value['account_index'] === undefined) return false;
+    if (!('api_key_index' in value) || value['api_key_index'] === undefined) return false;
+    if (!('liquidation_ids' in value) || value['liquidation_ids'] === undefined) return false;
+    if (!('signature' in value) || value['signature'] === undefined) return false;
+    return true;
+}
+
+export function ReqMarkNotifReadFromJSON(json: any): ReqMarkNotifRead {
+    return ReqMarkNotifReadFromJSONTyped(json, false);
+}
+
+export function ReqMarkNotifReadFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReqMarkNotifRead {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'notif_type': json['notif_type'],
+        'account_index': json['account_index'],
+        'api_key_index': json['api_key_index'],
+        'liquidation_ids': json['liquidation_ids'],
+        'signature': json['signature'],
+    };
+}
+
+export function ReqMarkNotifReadToJSON(value?: ReqMarkNotifRead | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'notif_type': value['notif_type'],
+        'account_index': value['account_index'],
+        'api_key_index': value['api_key_index'],
+        'liquidation_ids': value['liquidation_ids'],
+        'signature': value['signature'],
+    };
+}
+

package/models/Tx.ts

@@ -96,7 +96,7 @@ export interface Tx {
      * @type {number}
      * @memberof Tx
      */
-    verify_at: number;
+    executed_at: number;
     /**
      * 
      * @type {number}
@@ -121,7 +121,7 @@ export function instanceOfTx(value: object): value is Tx {
     if (!('expire_at' in value) || value['expire_at'] === undefined) return false;
     if (!('block_height' in value) || value['block_height'] === undefined) return false;
     if (!('created_at' in value) || value['created_at'] === undefined) return false;
-    if (!('verify_at' in value) || value['verify_at'] === undefined) return false;
+    if (!('executed_at' in value) || value['executed_at'] === undefined) return false;
     if (!('sequence_index' in value) || value['sequence_index'] === undefined) return false;
     return true;
 }
@@ -148,7 +148,7 @@ export function TxFromJSONTyped(json: any, ignoreDiscriminator: boolean): Tx {
         'expire_at': json['expire_at'],
         'block_height': json['block_height'],
         'created_at': json['created_at'],
-        'verify_at': json['verify_at'],
+        'executed_at': json['executed_at'],
         'sequence_index': json['sequence_index'],
     };
 }
@@ -171,7 +171,7 @@ export function TxToJSON(value?: Tx | null): any {
         'expire_at': value['expire_at'],
         'block_height': value['block_height'],
         'created_at': value['created_at'],
-        'verify_at': value['verify_at'],
+        'executed_at': value['executed_at'],
         'sequence_index': value['sequence_index'],
     };
 }

package/models/index.ts

@@ -22,6 +22,7 @@ export * from './Fundings';
 export * from './L1ProviderInfo';
 export * from './Layer1BasicInfo';
 export * from './Layer2BasicInfo';
+export * from './Liquidation';
 export * from './MarketInfo';
 export * from './NextNonce';
 export * from './Order';
@@ -63,6 +64,7 @@ export * from './ReqGetRecentTrades';
 export * from './ReqGetRollbacks';
 export * from './ReqGetTrades';
 export * from './ReqGetTx';
+export * from './ReqMarkNotifRead';
 export * from './ReqSearch';
 export * from './ResultCode';
 export * from './Rollback';

package/openapi.json

@@ -914,6 +914,67 @@
         "description": "Get zklighter general info, including contract address, and count of transactions and active users"
       }
     },
+    "/api/v1/markNotifRead": {
+      "get": {
+        "summary": "MarkNotifRead",
+        "operationId": "MarkNotifRead",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/ResultCode"
+            }
+          },
+          "400": {
+            "description": "Bad request",
+            "schema": {
+              "$ref": "#/definitions/ResultCode"
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "notif_type",
+            "in": "query",
+            "required": true,
+            "type": "string"
+          },
+          {
+            "name": "account_index",
+            "in": "query",
+            "required": true,
+            "type": "integer",
+            "format": "int32"
+          },
+          {
+            "name": "api_key_index",
+            "in": "query",
+            "required": true,
+            "type": "integer",
+            "format": "uint8"
+          },
+          {
+            "name": "liquidation_ids",
+            "in": "query",
+            "required": true,
+            "type": "string"
+          },
+          {
+            "name": "signature",
+            "in": "query",
+            "required": true,
+            "type": "string"
+          }
+        ],
+        "tags": [
+          "liquidation"
+        ],
+        "consumes": [
+          "multipart/form-data"
+        ],
+        "description": "Mark"
+      }
+    },
     "/api/v1/nextNonce": {
       "get": {
         "summary": "GetNextNonce",
@@ -2288,7 +2349,7 @@
           "format": "int64",
           "example": "1640995200"
         },
-        "verify_at": {
+        "executed_at": {
           "type": "integer",
           "format": "int64",
           "example": "1640995200"
@@ -2307,11 +2368,6 @@
           "type": "integer",
           "format": "int64",
           "example": "1640995200"
-        },
-        "executed_at": {
-          "type": "integer",
-          "format": "int64",
-          "example": "1640995200"
         }
       },
       "title": "EnrichedTx",
@@ -2545,6 +2601,24 @@
         "total_transaction_count"
       ]
     },
+    "Liquidation": {
+      "type": "object",
+      "properties": {
+        "LiquidationId": {
+          "type": "integer",
+          "format": "int64"
+        },
+        "AccountIndex": {
+          "type": "integer",
+          "format": "int32"
+        },
+        "LiquidationType": {
+          "type": "integer",
+          "format": "uint8"
+        }
+      },
+      "title": "Liquidation"
+    },
     "MarketInfo": {
       "type": "object",
       "properties": {
@@ -3885,6 +3959,36 @@
         "value"
       ]
     },
+    "ReqMarkNotifRead": {
+      "type": "object",
+      "properties": {
+        "notif_type": {
+          "type": "string"
+        },
+        "account_index": {
+          "type": "integer",
+          "format": "int32"
+        },
+        "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"
+      ]
+    },
     "ReqSearch": {
       "type": "object",
       "properties": {
@@ -4295,7 +4399,7 @@
           "format": "int64",
           "example": "1640995200"
         },
-        "verify_at": {
+        "executed_at": {
           "type": "integer",
           "format": "int64",
           "example": "1640995200"
@@ -4320,7 +4424,7 @@
         "expire_at",
         "block_height",
         "created_at",
-        "verify_at",
+        "executed_at",
         "sequence_index"
       ]
     },

package/package.json

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