zklighter-perps 1.0.337 → 1.0.339

package/.github/workflows/pkg-guard.yml

@@ -0,0 +1,6 @@
+# Supply-chain checks (age, malware, known vulnerabilities) over every lockfile on each PR.
+name: pkg-guard
+on: [pull_request]
+jobs:
+  supply-chain-check:
+    uses: elliottech/pkg-guard/.github/workflows/supply-chain-check.yml@main

package/apis/OrderApi.ts

@@ -77,7 +77,7 @@ export interface AccountActiveOrdersRequest {
     authorization?: string;
     auth?: string;
     market_id?: number;
-    market_type?: AccountActiveOrdersMarketTypeEnum;
+    market_type?: Array<AccountActiveOrdersMarketTypeEnum>;
 }
 
 export interface AccountInactiveOrdersRequest {
@@ -86,7 +86,7 @@ export interface AccountInactiveOrdersRequest {
     authorization?: string;
     auth?: string;
     market_id?: number;
-    market_type?: AccountInactiveOrdersMarketTypeEnum;
+    market_type?: Array<AccountInactiveOrdersMarketTypeEnum>;
     ask_filter?: number;
     between_timestamps?: string;
     cursor?: string;
@@ -150,7 +150,7 @@ export interface TradesRequest {
     sort_by: TradesSortByEnum;
     limit: number;
     market_id?: number;
-    market_type?: TradesMarketTypeEnum;
+    market_type?: Array<TradesMarketTypeEnum>;
     account_index?: number;
     integrator_account_index?: number;
     order_index?: number;
@@ -281,7 +281,7 @@ export class OrderApi extends runtime.BaseAPI {
         }
 
         if (requestParameters['market_type'] != null) {
-            queryParameters['market_type'] = requestParameters['market_type'];
+            queryParameters['market_type'] = requestParameters['market_type']!.join(runtime.COLLECTION_FORMATS["csv"]);
         }
 
         const headerParameters: runtime.HTTPHeaders = {};
@@ -343,7 +343,7 @@ export class OrderApi extends runtime.BaseAPI {
         }
 
         if (requestParameters['market_type'] != null) {
-            queryParameters['market_type'] = requestParameters['market_type'];
+            queryParameters['market_type'] = requestParameters['market_type']!.join(runtime.COLLECTION_FORMATS["csv"]);
         }
 
         if (requestParameters['ask_filter'] != null) {
@@ -897,7 +897,7 @@ export class OrderApi extends runtime.BaseAPI {
         }
 
         if (requestParameters['market_type'] != null) {
-            queryParameters['market_type'] = requestParameters['market_type'];
+            queryParameters['market_type'] = requestParameters['market_type']!.join(runtime.COLLECTION_FORMATS["csv"]);
         }
 
         if (requestParameters['account_index'] != null) {

package/models/EventOrderBookEntry.ts

@@ -164,6 +164,18 @@ export interface EventOrderBookEntry {
      * @memberof EventOrderBookEntry
      */
     open_interest: string;
+    /**
+     *  perps only: both sides, in base tokens
+     * @type {string}
+     * @memberof EventOrderBookEntry
+     */
+    open_interest_limit: string;
+    /**
+     *  perps only: both sides, in USDC at the mark price
+     * @type {string}
+     * @memberof EventOrderBookEntry
+     */
+    open_interest_usd: string;
     /**
      * 
      * @type {number}
@@ -302,6 +314,8 @@ export function instanceOfEventOrderBookEntry(value: object): value is EventOrde
     if (!('start_timestamp' in value) || value['start_timestamp'] === undefined) return false;
     if (!('end_timestamp' in value) || value['end_timestamp'] === undefined) return false;
     if (!('open_interest' in value) || value['open_interest'] === undefined) return false;
+    if (!('open_interest_limit' in value) || value['open_interest_limit'] === undefined) return false;
+    if (!('open_interest_usd' in value) || value['open_interest_usd'] === undefined) return false;
     if (!('outcome' in value) || value['outcome'] === undefined) return false;
     if (!('operator_account_index' in value) || value['operator_account_index'] === undefined) return false;
     if (!('settlement_cap' in value) || value['settlement_cap'] === undefined) return false;
@@ -349,6 +363,8 @@ export function EventOrderBookEntryFromJSONTyped(json: any, ignoreDiscriminator:
         'start_timestamp': json['start_timestamp'],
         'end_timestamp': json['end_timestamp'],
         'open_interest': json['open_interest'],
+        'open_interest_limit': json['open_interest_limit'],
+        'open_interest_usd': json['open_interest_usd'],
         'outcome': json['outcome'],
         'operator_account_index': json['operator_account_index'],
         'settlement_cap': json['settlement_cap'],
@@ -392,6 +408,8 @@ export function EventOrderBookEntryToJSON(value?: EventOrderBookEntry | null): a
         'start_timestamp': value['start_timestamp'],
         'end_timestamp': value['end_timestamp'],
         'open_interest': value['open_interest'],
+        'open_interest_limit': value['open_interest_limit'],
+        'open_interest_usd': value['open_interest_usd'],
         'outcome': value['outcome'],
         'operator_account_index': value['operator_account_index'],
         'settlement_cap': value['settlement_cap'],

package/models/OrderBook.ts

@@ -157,6 +157,18 @@ export interface OrderBook {
      * @memberof OrderBook
      */
     open_interest: string;
+    /**
+     *  perps only: both sides, in base tokens
+     * @type {string}
+     * @memberof OrderBook
+     */
+    open_interest_limit: string;
+    /**
+     *  perps only: both sides, in USDC at the mark price
+     * @type {string}
+     * @memberof OrderBook
+     */
+    open_interest_usd: string;
     /**
      * 
      * @type {number}
@@ -277,6 +289,8 @@ export function instanceOfOrderBook(value: object): value is OrderBook {
     if (!('start_timestamp' in value) || value['start_timestamp'] === undefined) return false;
     if (!('end_timestamp' in value) || value['end_timestamp'] === undefined) return false;
     if (!('open_interest' in value) || value['open_interest'] === undefined) return false;
+    if (!('open_interest_limit' in value) || value['open_interest_limit'] === undefined) return false;
+    if (!('open_interest_usd' in value) || value['open_interest_usd'] === undefined) return false;
     if (!('outcome' in value) || value['outcome'] === undefined) return false;
     if (!('operator_account_index' in value) || value['operator_account_index'] === undefined) return false;
     if (!('settlement_cap' in value) || value['settlement_cap'] === undefined) return false;
@@ -321,6 +335,8 @@ export function OrderBookFromJSONTyped(json: any, ignoreDiscriminator: boolean):
         'start_timestamp': json['start_timestamp'],
         'end_timestamp': json['end_timestamp'],
         'open_interest': json['open_interest'],
+        'open_interest_limit': json['open_interest_limit'],
+        'open_interest_usd': json['open_interest_usd'],
         'outcome': json['outcome'],
         'operator_account_index': json['operator_account_index'],
         'settlement_cap': json['settlement_cap'],
@@ -361,6 +377,8 @@ export function OrderBookToJSON(value?: OrderBook | null): any {
         'start_timestamp': value['start_timestamp'],
         'end_timestamp': value['end_timestamp'],
         'open_interest': value['open_interest'],
+        'open_interest_limit': value['open_interest_limit'],
+        'open_interest_usd': value['open_interest_usd'],
         'outcome': value['outcome'],
         'operator_account_index': value['operator_account_index'],
         'settlement_cap': value['settlement_cap'],

package/models/PerpsMarketStats.ts

@@ -73,6 +73,12 @@ export interface PerpsMarketStats {
      * @memberof PerpsMarketStats
      */
     open_interest_limit: string;
+    /**
+     *  both sides, in USDC at the mark price
+     * @type {string}
+     * @memberof PerpsMarketStats
+     */
+    open_interest_usd: string;
     /**
      * 
      * @type {string}
@@ -166,6 +172,7 @@ export function instanceOfPerpsMarketStats(value: object): value is PerpsMarketS
     if (!('best_bid_price' in value) || value['best_bid_price'] === undefined) return false;
     if (!('open_interest' in value) || value['open_interest'] === undefined) return false;
     if (!('open_interest_limit' in value) || value['open_interest_limit'] === undefined) return false;
+    if (!('open_interest_usd' in value) || value['open_interest_usd'] === undefined) return false;
     if (!('funding_clamp_small' in value) || value['funding_clamp_small'] === undefined) return false;
     if (!('funding_clamp_big' in value) || value['funding_clamp_big'] === undefined) return false;
     if (!('last_trade_price' in value) || value['last_trade_price'] === undefined) return false;
@@ -201,6 +208,7 @@ export function PerpsMarketStatsFromJSONTyped(json: any, ignoreDiscriminator: bo
         'best_bid_price': json['best_bid_price'],
         'open_interest': json['open_interest'],
         'open_interest_limit': json['open_interest_limit'],
+        'open_interest_usd': json['open_interest_usd'],
         'funding_clamp_small': json['funding_clamp_small'],
         'funding_clamp_big': json['funding_clamp_big'],
         'last_trade_price': json['last_trade_price'],
@@ -232,6 +240,7 @@ export function PerpsMarketStatsToJSON(value?: PerpsMarketStats | null): any {
         'best_bid_price': value['best_bid_price'],
         'open_interest': value['open_interest'],
         'open_interest_limit': value['open_interest_limit'],
+        'open_interest_usd': value['open_interest_usd'],
         'funding_clamp_small': value['funding_clamp_small'],
         'funding_clamp_big': value['funding_clamp_big'],
         'last_trade_price': value['last_trade_price'],

package/models/PerpsOrderBookDetail.ts

@@ -164,6 +164,18 @@ export interface PerpsOrderBookDetail {
      * @memberof PerpsOrderBookDetail
      */
     open_interest: number;
+    /**
+     *  both sides, in base tokens
+     * @type {string}
+     * @memberof PerpsOrderBookDetail
+     */
+    open_interest_limit: string;
+    /**
+     *  both sides, in USDC at the mark price
+     * @type {string}
+     * @memberof PerpsOrderBookDetail
+     */
+    open_interest_usd: string;
     /**
      * 
      * @type {number}
@@ -428,6 +440,8 @@ export function instanceOfPerpsOrderBookDetail(value: object): value is PerpsOrd
     if (!('start_timestamp' in value) || value['start_timestamp'] === undefined) return false;
     if (!('end_timestamp' in value) || value['end_timestamp'] === undefined) return false;
     if (!('open_interest' in value) || value['open_interest'] === undefined) return false;
+    if (!('open_interest_limit' in value) || value['open_interest_limit'] === undefined) return false;
+    if (!('open_interest_usd' in value) || value['open_interest_usd'] === undefined) return false;
     if (!('outcome' in value) || value['outcome'] === undefined) return false;
     if (!('operator_account_index' in value) || value['operator_account_index'] === undefined) return false;
     if (!('settlement_cap' in value) || value['settlement_cap'] === undefined) return false;
@@ -496,6 +510,8 @@ export function PerpsOrderBookDetailFromJSONTyped(json: any, ignoreDiscriminator
         'start_timestamp': json['start_timestamp'],
         'end_timestamp': json['end_timestamp'],
         'open_interest': json['open_interest'],
+        'open_interest_limit': json['open_interest_limit'],
+        'open_interest_usd': json['open_interest_usd'],
         'outcome': json['outcome'],
         'operator_account_index': json['operator_account_index'],
         'settlement_cap': json['settlement_cap'],
@@ -560,6 +576,8 @@ export function PerpsOrderBookDetailToJSON(value?: PerpsOrderBookDetail | null):
         'start_timestamp': value['start_timestamp'],
         'end_timestamp': value['end_timestamp'],
         'open_interest': value['open_interest'],
+        'open_interest_limit': value['open_interest_limit'],
+        'open_interest_usd': value['open_interest_usd'],
         'outcome': value['outcome'],
         'operator_account_index': value['operator_account_index'],
         'settlement_cap': value['settlement_cap'],

package/models/ReqExportData.ts

@@ -50,7 +50,7 @@ export interface ReqExportData {
      */
     aggregate?: boolean;
     /**
-     * 
+     *  Milliseconds; omit both timestamps to export all available history.
      * @type {number}
      * @memberof ReqExportData
      */

package/models/ReqGetAccountActiveOrders.ts

@@ -39,10 +39,10 @@ export interface ReqGetAccountActiveOrders {
     market_id?: number;
     /**
      * 
-     * @type {string}
+     * @type {Array<string>}
      * @memberof ReqGetAccountActiveOrders
      */
-    market_type?: ReqGetAccountActiveOrdersMarketTypeEnum;
+    market_type?: Array<ReqGetAccountActiveOrdersMarketTypeEnum>;
 }
 
 

package/models/ReqGetAccountInactiveOrders.ts

@@ -39,10 +39,10 @@ export interface ReqGetAccountInactiveOrders {
     market_id?: number;
     /**
      * 
-     * @type {string}
+     * @type {Array<string>}
      * @memberof ReqGetAccountInactiveOrders
      */
-    market_type?: ReqGetAccountInactiveOrdersMarketTypeEnum;
+    market_type?: Array<ReqGetAccountInactiveOrdersMarketTypeEnum>;
     /**
      * 
      * @type {number}

package/models/ReqGetTrades.ts

@@ -27,10 +27,10 @@ export interface ReqGetTrades {
     market_id?: number;
     /**
      * 
-     * @type {string}
+     * @type {Array<string>}
      * @memberof ReqGetTrades
      */
-    market_type?: ReqGetTradesMarketTypeEnum;
+    market_type?: Array<ReqGetTradesMarketTypeEnum>;
     /**
      * 
      * @type {number}

package/models/SpotOrderBookDetail.ts

@@ -157,6 +157,18 @@ export interface SpotOrderBookDetail {
      * @memberof SpotOrderBookDetail
      */
     open_interest: string;
+    /**
+     *  perps only: both sides, in base tokens
+     * @type {string}
+     * @memberof SpotOrderBookDetail
+     */
+    open_interest_limit: string;
+    /**
+     *  perps only: both sides, in USDC at the mark price
+     * @type {string}
+     * @memberof SpotOrderBookDetail
+     */
+    open_interest_usd: string;
     /**
      * 
      * @type {number}
@@ -337,6 +349,8 @@ export function instanceOfSpotOrderBookDetail(value: object): value is SpotOrder
     if (!('start_timestamp' in value) || value['start_timestamp'] === undefined) return false;
     if (!('end_timestamp' in value) || value['end_timestamp'] === undefined) return false;
     if (!('open_interest' in value) || value['open_interest'] === undefined) return false;
+    if (!('open_interest_limit' in value) || value['open_interest_limit'] === undefined) return false;
+    if (!('open_interest_usd' in value) || value['open_interest_usd'] === undefined) return false;
     if (!('outcome' in value) || value['outcome'] === undefined) return false;
     if (!('operator_account_index' in value) || value['operator_account_index'] === undefined) return false;
     if (!('settlement_cap' in value) || value['settlement_cap'] === undefined) return false;
@@ -391,6 +405,8 @@ export function SpotOrderBookDetailFromJSONTyped(json: any, ignoreDiscriminator:
         'start_timestamp': json['start_timestamp'],
         'end_timestamp': json['end_timestamp'],
         'open_interest': json['open_interest'],
+        'open_interest_limit': json['open_interest_limit'],
+        'open_interest_usd': json['open_interest_usd'],
         'outcome': json['outcome'],
         'operator_account_index': json['operator_account_index'],
         'settlement_cap': json['settlement_cap'],
@@ -441,6 +457,8 @@ export function SpotOrderBookDetailToJSON(value?: SpotOrderBookDetail | null): a
         'start_timestamp': value['start_timestamp'],
         'end_timestamp': value['end_timestamp'],
         'open_interest': value['open_interest'],
+        'open_interest_limit': value['open_interest_limit'],
+        'open_interest_usd': value['open_interest_usd'],
         'outcome': value['outcome'],
         'operator_account_index': value['operator_account_index'],
         'settlement_cap': value['settlement_cap'],

package/openapi.json

@@ -150,14 +150,16 @@
             "name": "market_type",
             "in": "query",
             "required": false,
-            "type": "string",
-            "enum": [
-              "all",
-              "spot",
-              "perp",
-              "bo"
-            ],
-            "default": "all"
+            "type": "array",
+            "items": {
+              "type": "string",
+              "enum": [
+                "all",
+                "spot",
+                "perp",
+                "bo"
+              ]
+            }
           }
         ],
         "tags": [
@@ -221,14 +223,16 @@
             "name": "market_type",
             "in": "query",
             "required": false,
-            "type": "string",
-            "enum": [
-              "all",
-              "spot",
-              "perp",
-              "bo"
-            ],
-            "default": "all"
+            "type": "array",
+            "items": {
+              "type": "string",
+              "enum": [
+                "all",
+                "spot",
+                "perp",
+                "bo"
+              ]
+            }
           },
           {
             "name": "ask_filter",
@@ -2020,21 +2024,18 @@
           },
           {
             "name": "start_timestamp",
+            "description": " Milliseconds; omit both timestamps to export all available history.",
             "in": "query",
             "required": false,
             "type": "integer",
-            "format": "int64",
-            "minimum": 1735689600000,
-            "maximum": 1830297600000
+            "format": "int64"
           },
           {
             "name": "end_timestamp",
             "in": "query",
             "required": false,
             "type": "integer",
-            "format": "int64",
-            "minimum": 1735689600000,
-            "maximum": 1830297600000
+            "format": "int64"
           },
           {
             "name": "side",
@@ -7063,14 +7064,16 @@
             "name": "market_type",
             "in": "query",
             "required": false,
-            "type": "string",
-            "enum": [
-              "all",
-              "spot",
-              "perp",
-              "bo"
-            ],
-            "default": "all"
+            "type": "array",
+            "items": {
+              "type": "string",
+              "enum": [
+                "all",
+                "spot",
+                "perp",
+                "bo"
+              ]
+            }
           },
           {
             "name": "account_index",
@@ -11031,6 +11034,16 @@
           "type": "string",
           "example": "93.0"
         },
+        "open_interest_limit": {
+          "type": "string",
+          "example": "250.2500",
+          "description": " perps only: both sides, in base tokens"
+        },
+        "open_interest_usd": {
+          "type": "string",
+          "example": "281293.25",
+          "description": " perps only: both sides, in USDC at the mark price"
+        },
         "outcome": {
           "type": "integer",
           "format": "int32",
@@ -11125,6 +11138,8 @@
         "start_timestamp",
         "end_timestamp",
         "open_interest",
+        "open_interest_limit",
+        "open_interest_usd",
         "outcome",
         "operator_account_index",
         "settlement_cap",
@@ -13683,6 +13698,16 @@
           "type": "string",
           "example": "93.0"
         },
+        "open_interest_limit": {
+          "type": "string",
+          "example": "250.2500",
+          "description": " perps only: both sides, in base tokens"
+        },
+        "open_interest_usd": {
+          "type": "string",
+          "example": "281293.25",
+          "description": " perps only: both sides, in USDC at the mark price"
+        },
         "outcome": {
           "type": "integer",
           "format": "int32",
@@ -13764,6 +13789,8 @@
         "start_timestamp",
         "end_timestamp",
         "open_interest",
+        "open_interest_limit",
+        "open_interest_usd",
         "outcome",
         "operator_account_index",
         "settlement_cap",
@@ -14365,6 +14392,11 @@
           "type": "string",
           "example": "235.25"
         },
+        "open_interest_usd": {
+          "type": "string",
+          "example": "711521.25",
+          "description": " both sides, in USDC at the mark price"
+        },
         "funding_clamp_small": {
           "type": "string",
           "example": "0.005"
@@ -14435,6 +14467,7 @@
         "best_bid_price",
         "open_interest",
         "open_interest_limit",
+        "open_interest_usd",
         "funding_clamp_small",
         "funding_clamp_big",
         "last_trade_price",
@@ -14568,6 +14601,16 @@
           "format": "double",
           "example": "93.0"
         },
+        "open_interest_limit": {
+          "type": "string",
+          "example": "250.2500",
+          "description": " both sides, in base tokens"
+        },
+        "open_interest_usd": {
+          "type": "string",
+          "example": "281293.25",
+          "description": " both sides, in USDC at the mark price"
+        },
         "outcome": {
           "type": "integer",
           "format": "int32",
@@ -14763,6 +14806,8 @@
         "start_timestamp",
         "end_timestamp",
         "open_interest",
+        "open_interest_limit",
+        "open_interest_usd",
         "outcome",
         "operator_account_index",
         "settlement_cap",
@@ -16494,14 +16539,11 @@
         "start_timestamp": {
           "type": "integer",
           "format": "int64",
-          "maximum": 1830297600000,
-          "minimum": 1735689600000
+          "description": " Milliseconds; omit both timestamps to export all available history."
         },
         "end_timestamp": {
           "type": "integer",
-          "format": "int64",
-          "maximum": 1830297600000,
-          "minimum": 1735689600000
+          "format": "int64"
         },
         "side": {
           "type": "string",
@@ -16687,14 +16729,16 @@
           "default": "255"
         },
         "market_type": {
-          "type": "string",
-          "enum": [
-            "all",
-            "spot",
-            "perp",
-            "bo"
-          ],
-          "default": "all"
+          "type": "array",
+          "items": {
+            "type": "string",
+            "enum": [
+              "all",
+              "spot",
+              "perp",
+              "bo"
+            ]
+          }
         }
       },
       "title": "ReqGetAccountActiveOrders",
@@ -16752,14 +16796,16 @@
           "default": "255"
         },
         "market_type": {
-          "type": "string",
-          "enum": [
-            "all",
-            "spot",
-            "perp",
-            "bo"
-          ],
-          "default": "all"
+          "type": "array",
+          "items": {
+            "type": "string",
+            "enum": [
+              "all",
+              "spot",
+              "perp",
+              "bo"
+            ]
+          }
         },
         "ask_filter": {
           "type": "integer",
@@ -18431,14 +18477,16 @@
           "default": "255"
         },
         "market_type": {
-          "type": "string",
-          "enum": [
-            "all",
-            "spot",
-            "perp",
-            "bo"
-          ],
-          "default": "all"
+          "type": "array",
+          "items": {
+            "type": "string",
+            "enum": [
+              "all",
+              "spot",
+              "perp",
+              "bo"
+            ]
+          }
         },
         "account_index": {
           "type": "integer",
@@ -22141,6 +22189,16 @@
           "type": "string",
           "example": "93.0"
         },
+        "open_interest_limit": {
+          "type": "string",
+          "example": "250.2500",
+          "description": " perps only: both sides, in base tokens"
+        },
+        "open_interest_usd": {
+          "type": "string",
+          "example": "281293.25",
+          "description": " perps only: both sides, in USDC at the mark price"
+        },
         "outcome": {
           "type": "integer",
           "format": "int32",
@@ -22275,6 +22333,8 @@
         "start_timestamp",
         "end_timestamp",
         "open_interest",
+        "open_interest_limit",
+        "open_interest_usd",
         "outcome",
         "operator_account_index",
         "settlement_cap",

package/package.json

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

package/pkg-guard.config.json

@@ -0,0 +1,8 @@
+{
+  "pinCheck": {
+    "block": true
+  },
+  "imageScan": {
+    "block": true
+  }
+}