zklighter-perps 1.0.242 → 1.0.243

package/.openapi-generator/FILES

@@ -37,6 +37,7 @@ models/ApiToken.ts
 models/ApprovedIntegrator.ts
 models/Asset.ts
 models/AssetDetails.ts
+models/AssetStats.ts
 models/Auth.ts
 models/Block.ts
 models/Blocks.ts

package/apis/OrderApi.ts

@@ -144,8 +144,6 @@ export interface TradesRequest {
     role?: TradesRoleEnum;
     type?: TradesTypeEnum;
     aggregate?: boolean;
-    skip_ask_order_id?: string;
-    skip_bid_order_id?: string;
 }
 
 /**
@@ -821,14 +819,6 @@ export class OrderApi extends runtime.BaseAPI {
             queryParameters['aggregate'] = requestParameters['aggregate'];
         }
 
-        if (requestParameters['skip_ask_order_id'] != null) {
-            queryParameters['skip_ask_order_id'] = requestParameters['skip_ask_order_id'];
-        }
-
-        if (requestParameters['skip_bid_order_id'] != null) {
-            queryParameters['skip_bid_order_id'] = requestParameters['skip_bid_order_id'];
-        }
-
         const headerParameters: runtime.HTTPHeaders = {};
 
         const response = await this.request({

package/models/AccountAsset.ts

@@ -43,8 +43,31 @@ export interface AccountAsset {
      * @memberof AccountAsset
      */
     locked_balance: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof AccountAsset
+     */
+    margin_mode: AccountAssetMarginModeEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof AccountAsset
+     */
+    margin_balance: string;
 }
 
+
+/**
+ * @export
+ */
+export const AccountAssetMarginModeEnum = {
+    Enabled: 'enabled',
+    Disabled: 'disabled'
+} as const;
+export type AccountAssetMarginModeEnum = typeof AccountAssetMarginModeEnum[keyof typeof AccountAssetMarginModeEnum];
+
+
 /**
  * Check if a given object implements the AccountAsset interface.
  */
@@ -53,6 +76,8 @@ export function instanceOfAccountAsset(value: object): value is AccountAsset {
     if (!('asset_id' in value) || value['asset_id'] === undefined) return false;
     if (!('balance' in value) || value['balance'] === undefined) return false;
     if (!('locked_balance' in value) || value['locked_balance'] === undefined) return false;
+    if (!('margin_mode' in value) || value['margin_mode'] === undefined) return false;
+    if (!('margin_balance' in value) || value['margin_balance'] === undefined) return false;
     return true;
 }
 
@@ -70,6 +95,8 @@ export function AccountAssetFromJSONTyped(json: any, ignoreDiscriminator: boolea
         'asset_id': json['asset_id'],
         'balance': json['balance'],
         'locked_balance': json['locked_balance'],
+        'margin_mode': json['margin_mode'],
+        'margin_balance': json['margin_balance'],
     };
 }
 
@@ -83,6 +110,8 @@ export function AccountAssetToJSON(value?: AccountAsset | null): any {
         'asset_id': value['asset_id'],
         'balance': value['balance'],
         'locked_balance': value['locked_balance'],
+        'margin_mode': value['margin_mode'],
+        'margin_balance': value['margin_balance'],
     };
 }
 

package/models/Asset.ts

@@ -67,12 +67,60 @@ export interface Asset {
      * @memberof Asset
      */
     index_price: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof Asset
+     */
+    price_decimals: number;
     /**
      * 
      * @type {string}
      * @memberof Asset
      */
     l1_address: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Asset
+     */
+    loan_to_value: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Asset
+     */
+    liquidation_threshold: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Asset
+     */
+    liquidation_factor: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Asset
+     */
+    liquidation_fee: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Asset
+     */
+    global_supply_cap: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Asset
+     */
+    user_supply_cap: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Asset
+     */
+    total_supplied: string;
 }
 
 
@@ -98,7 +146,15 @@ export function instanceOfAsset(value: object): value is Asset {
     if (!('min_withdrawal_amount' in value) || value['min_withdrawal_amount'] === undefined) return false;
     if (!('margin_mode' in value) || value['margin_mode'] === undefined) return false;
     if (!('index_price' in value) || value['index_price'] === undefined) return false;
+    if (!('price_decimals' in value) || value['price_decimals'] === undefined) return false;
     if (!('l1_address' in value) || value['l1_address'] === undefined) return false;
+    if (!('loan_to_value' in value) || value['loan_to_value'] === undefined) return false;
+    if (!('liquidation_threshold' in value) || value['liquidation_threshold'] === undefined) return false;
+    if (!('liquidation_factor' in value) || value['liquidation_factor'] === undefined) return false;
+    if (!('liquidation_fee' in value) || value['liquidation_fee'] === undefined) return false;
+    if (!('global_supply_cap' in value) || value['global_supply_cap'] === undefined) return false;
+    if (!('user_supply_cap' in value) || value['user_supply_cap'] === undefined) return false;
+    if (!('total_supplied' in value) || value['total_supplied'] === undefined) return false;
     return true;
 }
 
@@ -120,7 +176,15 @@ export function AssetFromJSONTyped(json: any, ignoreDiscriminator: boolean): Ass
         'min_withdrawal_amount': json['min_withdrawal_amount'],
         'margin_mode': json['margin_mode'],
         'index_price': json['index_price'],
+        'price_decimals': json['price_decimals'],
         'l1_address': json['l1_address'],
+        'loan_to_value': json['loan_to_value'],
+        'liquidation_threshold': json['liquidation_threshold'],
+        'liquidation_factor': json['liquidation_factor'],
+        'liquidation_fee': json['liquidation_fee'],
+        'global_supply_cap': json['global_supply_cap'],
+        'user_supply_cap': json['user_supply_cap'],
+        'total_supplied': json['total_supplied'],
     };
 }
 
@@ -138,7 +202,15 @@ export function AssetToJSON(value?: Asset | null): any {
         'min_withdrawal_amount': value['min_withdrawal_amount'],
         'margin_mode': value['margin_mode'],
         'index_price': value['index_price'],
+        'price_decimals': value['price_decimals'],
         'l1_address': value['l1_address'],
+        'loan_to_value': value['loan_to_value'],
+        'liquidation_threshold': value['liquidation_threshold'],
+        'liquidation_factor': value['liquidation_factor'],
+        'liquidation_fee': value['liquidation_fee'],
+        'global_supply_cap': value['global_supply_cap'],
+        'user_supply_cap': value['user_supply_cap'],
+        'total_supplied': value['total_supplied'],
     };
 }
 

package/models/LiquidationInfo.ts

@@ -13,12 +13,24 @@
  */
 
 import { mapValues } from '../runtime';
+import type { AccountAsset } from './AccountAsset';
+import {
+    AccountAssetFromJSON,
+    AccountAssetFromJSONTyped,
+    AccountAssetToJSON,
+} from './AccountAsset';
 import type { AccountPosition } from './AccountPosition';
 import {
     AccountPositionFromJSON,
     AccountPositionFromJSONTyped,
     AccountPositionToJSON,
 } from './AccountPosition';
+import type { Mapint16string } from './Mapint16string';
+import {
+    Mapint16stringFromJSON,
+    Mapint16stringFromJSONTyped,
+    Mapint16stringToJSON,
+} from './Mapint16string';
 import type { RiskInfo } from './RiskInfo';
 import {
     RiskInfoFromJSON,
@@ -56,6 +68,18 @@ export interface LiquidationInfo {
      * @memberof LiquidationInfo
      */
     mark_prices: { [key: string]: number; };
+    /**
+     * 
+     * @type {Array<AccountAsset>}
+     * @memberof LiquidationInfo
+     */
+    assets: Array<AccountAsset>;
+    /**
+     * 
+     * @type {Mapint16string}
+     * @memberof LiquidationInfo
+     */
+    asset_index_prices: Mapint16string;
 }
 
 /**
@@ -66,6 +90,8 @@ export function instanceOfLiquidationInfo(value: object): value is LiquidationIn
     if (!('risk_info_before' in value) || value['risk_info_before'] === undefined) return false;
     if (!('risk_info_after' in value) || value['risk_info_after'] === undefined) return false;
     if (!('mark_prices' in value) || value['mark_prices'] === undefined) return false;
+    if (!('assets' in value) || value['assets'] === undefined) return false;
+    if (!('asset_index_prices' in value) || value['asset_index_prices'] === undefined) return false;
     return true;
 }
 
@@ -83,6 +109,8 @@ export function LiquidationInfoFromJSONTyped(json: any, ignoreDiscriminator: boo
         'risk_info_before': RiskInfoFromJSON(json['risk_info_before']),
         'risk_info_after': RiskInfoFromJSON(json['risk_info_after']),
         'mark_prices': json['mark_prices'],
+        'assets': ((json['assets'] as Array<any>).map(AccountAssetFromJSON)),
+        'asset_index_prices': Mapint16stringFromJSON(json['asset_index_prices']),
     };
 }
 
@@ -96,6 +124,8 @@ export function LiquidationInfoToJSON(value?: LiquidationInfo | null): any {
         'risk_info_before': RiskInfoToJSON(value['risk_info_before']),
         'risk_info_after': RiskInfoToJSON(value['risk_info_after']),
         'mark_prices': value['mark_prices'],
+        'assets': ((value['assets'] as Array<any>).map(AccountAssetToJSON)),
+        'asset_index_prices': Mapint16stringToJSON(value['asset_index_prices']),
     };
 }
 

package/models/ReqGetTrades.ts

@@ -103,18 +103,6 @@ export interface ReqGetTrades {
      * @memberof ReqGetTrades
      */
     aggregate?: boolean;
-    /**
-     * 
-     * @type {string}
-     * @memberof ReqGetTrades
-     */
-    skip_ask_order_id?: string;
-    /**
-     * 
-     * @type {string}
-     * @memberof ReqGetTrades
-     */
-    skip_bid_order_id?: string;
 }
 
 
@@ -202,8 +190,6 @@ export function ReqGetTradesFromJSONTyped(json: any, ignoreDiscriminator: boolea
         'type': json['type'] == null ? undefined : json['type'],
         'limit': json['limit'],
         'aggregate': json['aggregate'] == null ? undefined : json['aggregate'],
-        'skip_ask_order_id': json['skip_ask_order_id'] == null ? undefined : json['skip_ask_order_id'],
-        'skip_bid_order_id': json['skip_bid_order_id'] == null ? undefined : json['skip_bid_order_id'],
     };
 }
 
@@ -227,8 +213,6 @@ export function ReqGetTradesToJSON(value?: ReqGetTrades | null): any {
         'type': value['type'],
         'limit': value['limit'],
         'aggregate': value['aggregate'],
-        'skip_ask_order_id': value['skip_ask_order_id'],
-        'skip_bid_order_id': value['skip_bid_order_id'],
     };
 }
 

package/models/RiskParameters.ts

@@ -30,31 +30,49 @@ export interface RiskParameters {
      * @type {string}
      * @memberof RiskParameters
      */
-    collateral: string;
+    total_account_value: string;
     /**
      * 
      * @type {string}
      * @memberof RiskParameters
      */
-    total_account_value: string;
+    initial_margin_req: string;
     /**
      * 
      * @type {string}
      * @memberof RiskParameters
      */
-    initial_margin_req: string;
+    maintenance_margin_req: string;
     /**
      * 
      * @type {string}
      * @memberof RiskParameters
      */
-    maintenance_margin_req: string;
+    close_out_margin_req: string;
     /**
      * 
      * @type {string}
      * @memberof RiskParameters
      */
-    close_out_margin_req: string;
+    total_account_liquidation_threshold: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof RiskParameters
+     */
+    collateral: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof RiskParameters
+     */
+    usdc_collateral_with_funding: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof RiskParameters
+     */
+    usdc_portfolio_value: string;
 }
 
 /**
@@ -62,11 +80,14 @@ export interface RiskParameters {
  */
 export function instanceOfRiskParameters(value: object): value is RiskParameters {
     if (!('market_id' in value) || value['market_id'] === undefined) return false;
-    if (!('collateral' in value) || value['collateral'] === undefined) return false;
     if (!('total_account_value' in value) || value['total_account_value'] === undefined) return false;
     if (!('initial_margin_req' in value) || value['initial_margin_req'] === undefined) return false;
     if (!('maintenance_margin_req' in value) || value['maintenance_margin_req'] === undefined) return false;
     if (!('close_out_margin_req' in value) || value['close_out_margin_req'] === undefined) return false;
+    if (!('total_account_liquidation_threshold' in value) || value['total_account_liquidation_threshold'] === undefined) return false;
+    if (!('collateral' in value) || value['collateral'] === undefined) return false;
+    if (!('usdc_collateral_with_funding' in value) || value['usdc_collateral_with_funding'] === undefined) return false;
+    if (!('usdc_portfolio_value' in value) || value['usdc_portfolio_value'] === undefined) return false;
     return true;
 }
 
@@ -81,11 +102,14 @@ export function RiskParametersFromJSONTyped(json: any, ignoreDiscriminator: bool
     return {
         
         'market_id': json['market_id'],
-        'collateral': json['collateral'],
         'total_account_value': json['total_account_value'],
         'initial_margin_req': json['initial_margin_req'],
         'maintenance_margin_req': json['maintenance_margin_req'],
         'close_out_margin_req': json['close_out_margin_req'],
+        'total_account_liquidation_threshold': json['total_account_liquidation_threshold'],
+        'collateral': json['collateral'],
+        'usdc_collateral_with_funding': json['usdc_collateral_with_funding'],
+        'usdc_portfolio_value': json['usdc_portfolio_value'],
     };
 }
 
@@ -96,11 +120,14 @@ export function RiskParametersToJSON(value?: RiskParameters | null): any {
     return {
         
         'market_id': value['market_id'],
-        'collateral': value['collateral'],
         'total_account_value': value['total_account_value'],
         'initial_margin_req': value['initial_margin_req'],
         'maintenance_margin_req': value['maintenance_margin_req'],
         'close_out_margin_req': value['close_out_margin_req'],
+        'total_account_liquidation_threshold': value['total_account_liquidation_threshold'],
+        'collateral': value['collateral'],
+        'usdc_collateral_with_funding': value['usdc_collateral_with_funding'],
+        'usdc_portfolio_value': value['usdc_portfolio_value'],
     };
 }
 

package/models/index.ts

@@ -21,6 +21,7 @@ export * from './ApiToken';
 export * from './ApprovedIntegrator';
 export * from './Asset';
 export * from './AssetDetails';
+export * from './AssetStats';
 export * from './Auth';
 export * from './Block';
 export * from './Blocks';

package/openapi.json

@@ -689,8 +689,7 @@
             "in": "query",
             "required": false,
             "type": "integer",
-            "format": "int16",
-            "default": "0"
+            "format": "int16"
           }
         ],
         "tags": [
@@ -4300,18 +4299,6 @@
             "type": "boolean",
             "format": "boolean",
             "default": "false"
-          },
-          {
-            "name": "skip_ask_order_id",
-            "in": "query",
-            "required": false,
-            "type": "string"
-          },
-          {
-            "name": "skip_bid_order_id",
-            "in": "query",
-            "required": false,
-            "type": "string"
           }
         ],
         "tags": [
@@ -4824,6 +4811,18 @@
         "locked_balance": {
           "type": "string",
           "example": "1000"
+        },
+        "margin_mode": {
+          "type": "string",
+          "example": "enabled",
+          "enum": [
+            "enabled",
+            "disabled"
+          ]
+        },
+        "margin_balance": {
+          "type": "string",
+          "example": "1000"
         }
       },
       "title": "AccountAsset",
@@ -4831,7 +4830,9 @@
         "symbol",
         "asset_id",
         "balance",
-        "locked_balance"
+        "locked_balance",
+        "margin_mode",
+        "margin_balance"
       ]
     },
     "AccountLimits": {
@@ -5583,9 +5584,42 @@
           "type": "string",
           "example": "3024.66"
         },
+        "price_decimals": {
+          "type": "integer",
+          "format": "uint8",
+          "example": "4"
+        },
         "l1_address": {
           "type": "string",
           "example": "0x0000000000000000000000000000000000000000"
+        },
+        "loan_to_value": {
+          "type": "string",
+          "example": "0.5"
+        },
+        "liquidation_threshold": {
+          "type": "string",
+          "example": "0.8"
+        },
+        "liquidation_factor": {
+          "type": "string",
+          "example": "0.9"
+        },
+        "liquidation_fee": {
+          "type": "string",
+          "example": "0.01"
+        },
+        "global_supply_cap": {
+          "type": "string",
+          "example": "1000000"
+        },
+        "user_supply_cap": {
+          "type": "string",
+          "example": "1000"
+        },
+        "total_supplied": {
+          "type": "string",
+          "example": "100"
         }
       },
       "title": "Asset",
@@ -5598,7 +5632,15 @@
         "min_withdrawal_amount",
         "margin_mode",
         "index_price",
-        "l1_address"
+        "price_decimals",
+        "l1_address",
+        "loan_to_value",
+        "liquidation_threshold",
+        "liquidation_factor",
+        "liquidation_fee",
+        "global_supply_cap",
+        "user_supply_cap",
+        "total_supplied"
       ]
     },
     "AssetDetails": {
@@ -5625,6 +5667,30 @@
         "asset_details"
       ]
     },
+    "AssetStats": {
+      "type": "object",
+      "properties": {
+        "asset_id": {
+          "type": "integer",
+          "format": "int16",
+          "example": "1"
+        },
+        "index_price": {
+          "type": "string",
+          "example": "3024.66"
+        },
+        "total_supplied": {
+          "type": "string",
+          "example": "100"
+        }
+      },
+      "title": "AssetStats",
+      "required": [
+        "asset_id",
+        "index_price",
+        "total_supplied"
+      ]
+    },
     "Auth": {
       "type": "object",
       "properties": {
@@ -7586,6 +7652,15 @@
             "type": "number",
             "format": "double"
           }
+        },
+        "assets": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/AccountAsset"
+          }
+        },
+        "asset_index_prices": {
+          "$ref": "#/definitions/mapint16string"
         }
       },
       "title": "LiquidationInfo",
@@ -7593,7 +7668,9 @@
         "positions",
         "risk_info_before",
         "risk_info_after",
-        "mark_prices"
+        "mark_prices",
+        "assets",
+        "asset_index_prices"
       ]
     },
     "LiquidationInfos": {
@@ -10001,8 +10078,7 @@
       "properties": {
         "asset_id": {
           "type": "integer",
-          "format": "int16",
-          "default": "0"
+          "format": "int16"
         }
       },
       "title": "ReqGetAssetDetails"
@@ -10938,12 +11014,6 @@
           "type": "boolean",
           "format": "boolean",
           "default": "false"
-        },
-        "skip_ask_order_id": {
-          "type": "string"
-        },
-        "skip_bid_order_id": {
-          "type": "string"
         }
       },
       "title": "ReqGetTrades",
@@ -12434,9 +12504,6 @@
           "type": "integer",
           "format": "int16"
         },
-        "collateral": {
-          "type": "string"
-        },
         "total_account_value": {
           "type": "string"
         },
@@ -12448,16 +12515,31 @@
         },
         "close_out_margin_req": {
           "type": "string"
+        },
+        "total_account_liquidation_threshold": {
+          "type": "string"
+        },
+        "collateral": {
+          "type": "string"
+        },
+        "usdc_collateral_with_funding": {
+          "type": "string"
+        },
+        "usdc_portfolio_value": {
+          "type": "string"
         }
       },
       "title": "RiskParameters",
       "required": [
         "market_id",
-        "collateral",
         "total_account_value",
         "initial_margin_req",
         "maintenance_margin_req",
-        "close_out_margin_req"
+        "close_out_margin_req",
+        "total_account_liquidation_threshold",
+        "collateral",
+        "usdc_collateral_with_funding",
+        "usdc_portfolio_value"
       ]
     },
     "SharePrice": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zklighter-perps",
-  "version": "1.0.242",
+  "version": "1.0.243",
   "description": "Lighter Perps SDK",
   "main": "index.ts",
   "directories": {