zklighter-perps 1.0.106 → 1.0.108

package/.circleci/openapi_postprocess.py

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

package/models/AccountPosition.ts

@@ -49,6 +49,12 @@ export interface AccountPosition {
      * @memberof AccountPosition
      */
     pending_order_count: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof AccountPosition
+     */
+    position_tied_order_count: number;
     /**
      * 
      * @type {number}
@@ -85,6 +91,12 @@ export interface AccountPosition {
      * @memberof AccountPosition
      */
     realized_pnl: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof AccountPosition
+     */
+    total_funding_paid_out?: string;
 }
 
 /**
@@ -96,6 +108,7 @@ export function instanceOfAccountPosition(value: object): value is AccountPositi
     if (!('initial_margin_fraction' in value) || value['initial_margin_fraction'] === undefined) return false;
     if (!('open_order_count' in value) || value['open_order_count'] === undefined) return false;
     if (!('pending_order_count' in value) || value['pending_order_count'] === undefined) return false;
+    if (!('position_tied_order_count' in value) || value['position_tied_order_count'] === undefined) return false;
     if (!('sign' in value) || value['sign'] === undefined) return false;
     if (!('position' in value) || value['position'] === undefined) return false;
     if (!('avg_entry_price' in value) || value['avg_entry_price'] === undefined) return false;
@@ -120,12 +133,14 @@ export function AccountPositionFromJSONTyped(json: any, ignoreDiscriminator: boo
         'initial_margin_fraction': json['initial_margin_fraction'],
         'open_order_count': json['open_order_count'],
         'pending_order_count': json['pending_order_count'],
+        'position_tied_order_count': json['position_tied_order_count'],
         'sign': json['sign'],
         'position': json['position'],
         'avg_entry_price': json['avg_entry_price'],
         'position_value': json['position_value'],
         'unrealized_pnl': json['unrealized_pnl'],
         'realized_pnl': json['realized_pnl'],
+        'total_funding_paid_out': json['total_funding_paid_out'] == null ? undefined : json['total_funding_paid_out'],
     };
 }
 
@@ -140,12 +155,14 @@ export function AccountPositionToJSON(value?: AccountPosition | null): any {
         'initial_margin_fraction': value['initial_margin_fraction'],
         'open_order_count': value['open_order_count'],
         'pending_order_count': value['pending_order_count'],
+        'position_tied_order_count': value['position_tied_order_count'],
         'sign': value['sign'],
         'position': value['position'],
         'avg_entry_price': value['avg_entry_price'],
         'position_value': value['position_value'],
         'unrealized_pnl': value['unrealized_pnl'],
         'realized_pnl': value['realized_pnl'],
+        'total_funding_paid_out': value['total_funding_paid_out'],
     };
 }
 

package/models/FundingRate.ts

@@ -19,12 +19,18 @@ import { mapValues } from '../runtime';
  * @interface FundingRate
  */
 export interface FundingRate {
+    /**
+     * 
+     * @type {number}
+     * @memberof FundingRate
+     */
+    market_id: number;
     /**
      * 
      * @type {string}
      * @memberof FundingRate
      */
-    exchange: string;
+    exchange: FundingRateExchangeEnum;
     /**
      * 
      * @type {string}
@@ -39,10 +45,24 @@ export interface FundingRate {
     rate: number;
 }
 
+
+/**
+ * @export
+ */
+export const FundingRateExchangeEnum = {
+    Binance: 'binance',
+    Bybit: 'bybit',
+    Hyperliquid: 'hyperliquid',
+    Lighter: 'lighter'
+} as const;
+export type FundingRateExchangeEnum = typeof FundingRateExchangeEnum[keyof typeof FundingRateExchangeEnum];
+
+
 /**
  * Check if a given object implements the FundingRate interface.
  */
 export function instanceOfFundingRate(value: object): value is FundingRate {
+    if (!('market_id' in value) || value['market_id'] === undefined) return false;
     if (!('exchange' in value) || value['exchange'] === undefined) return false;
     if (!('symbol' in value) || value['symbol'] === undefined) return false;
     if (!('rate' in value) || value['rate'] === undefined) return false;
@@ -59,6 +79,7 @@ export function FundingRateFromJSONTyped(json: any, ignoreDiscriminator: boolean
     }
     return {
         
+        'market_id': json['market_id'],
         'exchange': json['exchange'],
         'symbol': json['symbol'],
         'rate': json['rate'],
@@ -71,6 +92,7 @@ export function FundingRateToJSON(value?: FundingRate | null): any {
     }
     return {
         
+        'market_id': value['market_id'],
         'exchange': value['exchange'],
         'symbol': value['symbol'],
         'rate': value['rate'],

package/models/Order.ts

@@ -151,6 +151,12 @@ export interface Order {
      * @memberof Order
      */
     status: OrderStatusEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof Order
+     */
+    trigger_status: OrderTriggerStatusEnum;
     /**
      * 
      * @type {number}
@@ -169,6 +175,24 @@ export interface Order {
      * @memberof Order
      */
     parent_order_id: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Order
+     */
+    to_trigger_order_id_0: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Order
+     */
+    to_trigger_order_id_1: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Order
+     */
+    to_cancel_order_id_0: string;
     /**
      * 
      * @type {number}
@@ -227,10 +251,24 @@ export const OrderStatusEnum = {
     CanceledTooMuchSlippage: 'canceled-too-much-slippage',
     CanceledNotEnoughLiquidity: 'canceled-not-enough-liquidity',
     CanceledSelfTrade: 'canceled-self-trade',
-    CanceledExpired: 'canceled-expired'
+    CanceledExpired: 'canceled-expired',
+    CanceledOco: 'canceled-oco',
+    CanceledChild: 'canceled-child'
 } as const;
 export type OrderStatusEnum = typeof OrderStatusEnum[keyof typeof OrderStatusEnum];
 
+/**
+ * @export
+ */
+export const OrderTriggerStatusEnum = {
+    Na: 'na',
+    Ready: 'ready',
+    MarkPrice: 'mark-price',
+    Twap: 'twap',
+    ParentOrder: 'parent-order'
+} as const;
+export type OrderTriggerStatusEnum = typeof OrderTriggerStatusEnum[keyof typeof OrderTriggerStatusEnum];
+
 
 /**
  * Check if a given object implements the Order interface.
@@ -258,9 +296,13 @@ export function instanceOfOrder(value: object): value is Order {
     if (!('trigger_price' in value) || value['trigger_price'] === undefined) return false;
     if (!('order_expiry' in value) || value['order_expiry'] === undefined) return false;
     if (!('status' in value) || value['status'] === undefined) return false;
+    if (!('trigger_status' in value) || value['trigger_status'] === undefined) return false;
     if (!('trigger_time' in value) || value['trigger_time'] === undefined) return false;
     if (!('parent_order_index' in value) || value['parent_order_index'] === undefined) return false;
     if (!('parent_order_id' in value) || value['parent_order_id'] === undefined) return false;
+    if (!('to_trigger_order_id_0' in value) || value['to_trigger_order_id_0'] === undefined) return false;
+    if (!('to_trigger_order_id_1' in value) || value['to_trigger_order_id_1'] === undefined) return false;
+    if (!('to_cancel_order_id_0' in value) || value['to_cancel_order_id_0'] === undefined) return false;
     if (!('block_height' in value) || value['block_height'] === undefined) return false;
     if (!('timestamp' in value) || value['timestamp'] === undefined) return false;
     return true;
@@ -298,9 +340,13 @@ export function OrderFromJSONTyped(json: any, ignoreDiscriminator: boolean): Ord
         'trigger_price': json['trigger_price'],
         'order_expiry': json['order_expiry'],
         'status': json['status'],
+        'trigger_status': json['trigger_status'],
         'trigger_time': json['trigger_time'],
         'parent_order_index': json['parent_order_index'],
         'parent_order_id': json['parent_order_id'],
+        'to_trigger_order_id_0': json['to_trigger_order_id_0'],
+        'to_trigger_order_id_1': json['to_trigger_order_id_1'],
+        'to_cancel_order_id_0': json['to_cancel_order_id_0'],
         'block_height': json['block_height'],
         'timestamp': json['timestamp'],
     };
@@ -334,9 +380,13 @@ export function OrderToJSON(value?: Order | null): any {
         'trigger_price': value['trigger_price'],
         'order_expiry': value['order_expiry'],
         'status': value['status'],
+        'trigger_status': value['trigger_status'],
         'trigger_time': value['trigger_time'],
         'parent_order_index': value['parent_order_index'],
         'parent_order_id': value['parent_order_id'],
+        'to_trigger_order_id_0': value['to_trigger_order_id_0'],
+        'to_trigger_order_id_1': value['to_trigger_order_id_1'],
+        'to_cancel_order_id_0': value['to_cancel_order_id_0'],
         'block_height': value['block_height'],
         'timestamp': value['timestamp'],
     };

package/models/Status.ts

@@ -31,6 +31,12 @@ export interface Status {
      * @memberof Status
      */
     network_id: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof Status
+     */
+    timestamp: number;
 }
 
 /**
@@ -39,6 +45,7 @@ export interface Status {
 export function instanceOfStatus(value: object): value is Status {
     if (!('status' in value) || value['status'] === undefined) return false;
     if (!('network_id' in value) || value['network_id'] === undefined) return false;
+    if (!('timestamp' in value) || value['timestamp'] === undefined) return false;
     return true;
 }
 
@@ -54,6 +61,7 @@ export function StatusFromJSONTyped(json: any, ignoreDiscriminator: boolean): St
         
         'status': json['status'],
         'network_id': json['network_id'],
+        'timestamp': json['timestamp'],
     };
 }
 
@@ -65,6 +73,7 @@ export function StatusToJSON(value?: Status | null): any {
         
         'status': value['status'],
         'network_id': value['network_id'],
+        'timestamp': value['timestamp'],
     };
 }
 

package/openapi.json

@@ -2726,6 +2726,11 @@
           "format": "int64",
           "example": "3"
         },
+        "position_tied_order_count": {
+          "type": "integer",
+          "format": "int64",
+          "example": "3"
+        },
         "sign": {
           "type": "integer",
           "format": "int32",
@@ -2750,6 +2755,10 @@
         "realized_pnl": {
           "type": "string",
           "example": "2.000000"
+        },
+        "total_funding_paid_out": {
+          "type": "string",
+          "example": "34.2"
         }
       },
       "title": "AccountPosition",
@@ -2759,6 +2768,7 @@
         "initial_margin_fraction",
         "open_order_count",
         "pending_order_count",
+        "position_tied_order_count",
         "sign",
         "position",
         "avg_entry_price",
@@ -3851,8 +3861,18 @@
     "FundingRate": {
       "type": "object",
       "properties": {
+        "market_id": {
+          "type": "integer",
+          "format": "uint8"
+        },
         "exchange": {
-          "type": "string"
+          "type": "string",
+          "enum": [
+            "binance",
+            "bybit",
+            "hyperliquid",
+            "lighter"
+          ]
         },
         "symbol": {
           "type": "string"
@@ -3864,6 +3884,7 @@
       },
       "title": "FundingRate",
       "required": [
+        "market_id",
         "exchange",
         "symbol",
         "rate"
@@ -4356,7 +4377,20 @@
             "canceled-too-much-slippage",
             "canceled-not-enough-liquidity",
             "canceled-self-trade",
-            "canceled-expired"
+            "canceled-expired",
+            "canceled-oco",
+            "canceled-child"
+          ]
+        },
+        "trigger_status": {
+          "type": "string",
+          "example": "twap",
+          "enum": [
+            "na",
+            "ready",
+            "mark-price",
+            "twap",
+            "parent-order"
           ]
         },
         "trigger_time": {
@@ -4373,6 +4407,18 @@
           "type": "string",
           "example": "1"
         },
+        "to_trigger_order_id_0": {
+          "type": "string",
+          "example": "1"
+        },
+        "to_trigger_order_id_1": {
+          "type": "string",
+          "example": "1"
+        },
+        "to_cancel_order_id_0": {
+          "type": "string",
+          "example": "1"
+        },
         "block_height": {
           "type": "integer",
           "format": "int64",
@@ -4408,9 +4454,13 @@
         "trigger_price",
         "order_expiry",
         "status",
+        "trigger_status",
         "trigger_time",
         "parent_order_index",
         "parent_order_id",
+        "to_trigger_order_id_0",
+        "to_trigger_order_id_1",
+        "to_cancel_order_id_0",
         "block_height",
         "timestamp"
       ]
@@ -6488,12 +6538,18 @@
           "type": "integer",
           "format": "int32",
           "example": "1"
+        },
+        "timestamp": {
+          "type": "integer",
+          "format": "int64",
+          "example": "1717777777"
         }
       },
       "title": "Status",
       "required": [
         "status",
-        "network_id"
+        "network_id",
+        "timestamp"
       ]
     },
     "SubAccounts": {

package/package.json

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