zklighter-perps 1.0.23 → 1.0.25

package/models/AccountPosition.ts

@@ -31,12 +31,6 @@ export interface AccountPosition {
      * @memberof AccountPosition
      */
     ooc: number;
-    /**
-     * 
-     * @type {string}
-     * @memberof AccountPosition
-     */
-    name: string;
     /**
      * 
      * @type {string}
@@ -87,7 +81,6 @@ export interface AccountPosition {
 export function instanceOfAccountPosition(value: object): value is AccountPosition {
     if (!('market_id' in value) || value['market_id'] === undefined) return false;
     if (!('ooc' in value) || value['ooc'] === undefined) return false;
-    if (!('name' in value) || value['name'] === undefined) return false;
     if (!('symbol' in value) || value['symbol'] === undefined) return false;
     if (!('sign' in value) || value['sign'] === undefined) return false;
     if (!('position' in value) || value['position'] === undefined) return false;
@@ -110,7 +103,6 @@ export function AccountPositionFromJSONTyped(json: any, ignoreDiscriminator: boo
         
         'market_id': json['market_id'],
         'ooc': json['ooc'],
-        'name': json['name'],
         'symbol': json['symbol'],
         'sign': json['sign'],
         'position': json['position'],
@@ -129,7 +121,6 @@ export function AccountPositionToJSON(value?: AccountPosition | null): any {
         
         'market_id': value['market_id'],
         'ooc': value['ooc'],
-        'name': value['name'],
         'symbol': value['symbol'],
         'sign': value['sign'],
         'position': value['position'],

package/models/Order.ts

@@ -19,6 +19,12 @@ import { mapValues } from '../runtime';
  * @interface Order
  */
 export interface Order {
+    /**
+     * 
+     * @type {number}
+     * @memberof Order
+     */
+    order_index: number;
     /**
      * 
      * @type {number}
@@ -79,6 +85,12 @@ export interface Order {
      * @memberof Order
      */
     nonce: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof Order
+     */
+    client_order_index: number;
     /**
      * 
      * @type {boolean}
@@ -103,6 +115,12 @@ export interface Order {
      * @memberof Order
      */
     type: OrderTypeEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof Order
+     */
+    time_in_force: OrderTimeInForceEnum;
     /**
      * 
      * @type {string}
@@ -133,6 +151,16 @@ export const OrderTypeEnum = {
 } as const;
 export type OrderTypeEnum = typeof OrderTypeEnum[keyof typeof OrderTypeEnum];
 
+/**
+ * @export
+ */
+export const OrderTimeInForceEnum = {
+    Gtd: 'gtd',
+    Ioc: 'ioc',
+    Alo: 'alo'
+} as const;
+export type OrderTimeInForceEnum = typeof OrderTimeInForceEnum[keyof typeof OrderTimeInForceEnum];
+
 /**
  * @export
  */
@@ -148,6 +176,7 @@ export type OrderStatusEnum = typeof OrderStatusEnum[keyof typeof OrderStatusEnu
  * Check if a given object implements the Order interface.
  */
 export function instanceOfOrder(value: object): value is Order {
+    if (!('order_index' in value) || value['order_index'] === undefined) return false;
     if (!('market_index' in value) || value['market_index'] === undefined) return false;
     if (!('owner_account_index' in value) || value['owner_account_index'] === undefined) return false;
     if (!('initial_base_amount' in value) || value['initial_base_amount'] === undefined) return false;
@@ -158,10 +187,12 @@ export function instanceOfOrder(value: object): value is Order {
     if (!('base_size' in value) || value['base_size'] === undefined) return false;
     if (!('base_price' in value) || value['base_price'] === undefined) return false;
     if (!('nonce' in value) || value['nonce'] === undefined) return false;
+    if (!('client_order_index' in value) || value['client_order_index'] === undefined) return false;
     if (!('is_ask' in value) || value['is_ask'] === undefined) return false;
     if (!('order_expiry' in value) || value['order_expiry'] === undefined) return false;
     if (!('side' in value) || value['side'] === undefined) return false;
     if (!('type' in value) || value['type'] === undefined) return false;
+    if (!('time_in_force' in value) || value['time_in_force'] === undefined) return false;
     if (!('status' in value) || value['status'] === undefined) return false;
     if (!('block_height' in value) || value['block_height'] === undefined) return false;
     if (!('timestamp' in value) || value['timestamp'] === undefined) return false;
@@ -178,6 +209,7 @@ export function OrderFromJSONTyped(json: any, ignoreDiscriminator: boolean): Ord
     }
     return {
         
+        'order_index': json['order_index'],
         'market_index': json['market_index'],
         'owner_account_index': json['owner_account_index'],
         'initial_base_amount': json['initial_base_amount'],
@@ -188,10 +220,12 @@ export function OrderFromJSONTyped(json: any, ignoreDiscriminator: boolean): Ord
         'base_size': json['base_size'],
         'base_price': json['base_price'],
         'nonce': json['nonce'],
+        'client_order_index': json['client_order_index'],
         'is_ask': json['is_ask'],
         'order_expiry': json['order_expiry'],
         'side': json['side'],
         'type': json['type'],
+        'time_in_force': json['time_in_force'],
         'status': json['status'],
         'block_height': json['block_height'],
         'timestamp': json['timestamp'],
@@ -204,6 +238,7 @@ export function OrderToJSON(value?: Order | null): any {
     }
     return {
         
+        'order_index': value['order_index'],
         'market_index': value['market_index'],
         'owner_account_index': value['owner_account_index'],
         'initial_base_amount': value['initial_base_amount'],
@@ -214,10 +249,12 @@ export function OrderToJSON(value?: Order | null): any {
         'base_size': value['base_size'],
         'base_price': value['base_price'],
         'nonce': value['nonce'],
+        'client_order_index': value['client_order_index'],
         'is_ask': value['is_ask'],
         'order_expiry': value['order_expiry'],
         'side': value['side'],
         'type': value['type'],
+        'time_in_force': value['time_in_force'],
         'status': value['status'],
         'block_height': value['block_height'],
         'timestamp': value['timestamp'],

package/models/OrderBookDetail.ts

@@ -90,13 +90,13 @@ export interface OrderBookDetail {
      * @type {number}
      * @memberof OrderBookDetail
      */
-    decimal: number;
+    size_decimals: number;
     /**
      * 
      * @type {number}
      * @memberof OrderBookDetail
      */
-    price_tick: number;
+    price_decimals: number;
     /**
      * 
      * @type {number}
@@ -108,31 +108,19 @@ export interface OrderBookDetail {
      * @type {number}
      * @memberof OrderBookDetail
      */
-    initial_margin: number;
+    initial_margin_fraction: number;
     /**
      * 
      * @type {number}
      * @memberof OrderBookDetail
      */
-    maintenance_margin: number;
+    maintenance_margin_fraction: number;
     /**
      * 
      * @type {number}
      * @memberof OrderBookDetail
      */
-    closeoute_margin: number;
-    /**
-     * 
-     * @type {number}
-     * @memberof OrderBookDetail
-     */
-    ask_nonce: number;
-    /**
-     * 
-     * @type {number}
-     * @memberof OrderBookDetail
-     */
-    bid_nonce: number;
+    closeout_margin_fraction: number;
     /**
      * 
      * @type {number}
@@ -210,14 +198,12 @@ export type OrderBookDetailStatusEnum = typeof OrderBookDetailStatusEnum[keyof t
  * Check if a given object implements the OrderBookDetail interface.
  */
 export function instanceOfOrderBookDetail(value: object): value is OrderBookDetail {
-    if (!('decimal' in value) || value['decimal'] === undefined) return false;
-    if (!('price_tick' in value) || value['price_tick'] === undefined) return false;
+    if (!('size_decimals' in value) || value['size_decimals'] === undefined) return false;
+    if (!('price_decimals' in value) || value['price_decimals'] === undefined) return false;
     if (!('quote_multiplier' in value) || value['quote_multiplier'] === undefined) return false;
-    if (!('initial_margin' in value) || value['initial_margin'] === undefined) return false;
-    if (!('maintenance_margin' in value) || value['maintenance_margin'] === undefined) return false;
-    if (!('closeoute_margin' in value) || value['closeoute_margin'] === undefined) return false;
-    if (!('ask_nonce' in value) || value['ask_nonce'] === undefined) return false;
-    if (!('bid_nonce' in value) || value['bid_nonce'] === undefined) return false;
+    if (!('initial_margin_fraction' in value) || value['initial_margin_fraction'] === undefined) return false;
+    if (!('maintenance_margin_fraction' in value) || value['maintenance_margin_fraction'] === undefined) return false;
+    if (!('closeout_margin_fraction' in value) || value['closeout_margin_fraction'] === undefined) return false;
     if (!('last_trade_price' in value) || value['last_trade_price'] === undefined) return false;
     if (!('daily_trades_count' in value) || value['daily_trades_count'] === undefined) return false;
     if (!('daily_base_token_volume' in value) || value['daily_base_token_volume'] === undefined) return false;
@@ -252,14 +238,12 @@ export function OrderBookDetailFromJSONTyped(json: any, ignoreDiscriminator: boo
         'supported_size_decimals': json['supported_size_decimals'] == null ? undefined : json['supported_size_decimals'],
         'supported_price_decimals': json['supported_price_decimals'] == null ? undefined : json['supported_price_decimals'],
         'supported_quote_decimals': json['supported_quote_decimals'] == null ? undefined : json['supported_quote_decimals'],
-        'decimal': json['decimal'],
-        'price_tick': json['price_tick'],
+        'size_decimals': json['size_decimals'],
+        'price_decimals': json['price_decimals'],
         'quote_multiplier': json['quote_multiplier'],
-        'initial_margin': json['initial_margin'],
-        'maintenance_margin': json['maintenance_margin'],
-        'closeoute_margin': json['closeoute_margin'],
-        'ask_nonce': json['ask_nonce'],
-        'bid_nonce': json['bid_nonce'],
+        'initial_margin_fraction': json['initial_margin_fraction'],
+        'maintenance_margin_fraction': json['maintenance_margin_fraction'],
+        'closeout_margin_fraction': json['closeout_margin_fraction'],
         'last_trade_price': json['last_trade_price'],
         'daily_trades_count': json['daily_trades_count'],
         'daily_base_token_volume': json['daily_base_token_volume'],
@@ -290,14 +274,12 @@ export function OrderBookDetailToJSON(value?: OrderBookDetail | null): any {
         'supported_size_decimals': value['supported_size_decimals'],
         'supported_price_decimals': value['supported_price_decimals'],
         'supported_quote_decimals': value['supported_quote_decimals'],
-        'decimal': value['decimal'],
-        'price_tick': value['price_tick'],
+        'size_decimals': value['size_decimals'],
+        'price_decimals': value['price_decimals'],
         'quote_multiplier': value['quote_multiplier'],
-        'initial_margin': value['initial_margin'],
-        'maintenance_margin': value['maintenance_margin'],
-        'closeoute_margin': value['closeoute_margin'],
-        'ask_nonce': value['ask_nonce'],
-        'bid_nonce': value['bid_nonce'],
+        'initial_margin_fraction': value['initial_margin_fraction'],
+        'maintenance_margin_fraction': value['maintenance_margin_fraction'],
+        'closeout_margin_fraction': value['closeout_margin_fraction'],
         'last_trade_price': value['last_trade_price'],
         'daily_trades_count': value['daily_trades_count'],
         'daily_base_token_volume': value['daily_base_token_volume'],

package/models/SimpleOrder.ts

@@ -19,6 +19,12 @@ import { mapValues } from '../runtime';
  * @interface SimpleOrder
  */
 export interface SimpleOrder {
+    /**
+     * 
+     * @type {number}
+     * @memberof SimpleOrder
+     */
+    order_index: number;
     /**
      * 
      * @type {number}
@@ -43,12 +49,6 @@ export interface SimpleOrder {
      * @memberof SimpleOrder
      */
     price: string;
-    /**
-     * 
-     * @type {number}
-     * @memberof SimpleOrder
-     */
-    nonce: number;
     /**
      * 
      * @type {number}
@@ -61,11 +61,11 @@ export interface SimpleOrder {
  * Check if a given object implements the SimpleOrder interface.
  */
 export function instanceOfSimpleOrder(value: object): value is SimpleOrder {
+    if (!('order_index' in value) || value['order_index'] === undefined) return false;
     if (!('owner_account_index' in value) || value['owner_account_index'] === undefined) return false;
     if (!('initial_base_amount' in value) || value['initial_base_amount'] === undefined) return false;
     if (!('remaining_base_amount' in value) || value['remaining_base_amount'] === undefined) return false;
     if (!('price' in value) || value['price'] === undefined) return false;
-    if (!('nonce' in value) || value['nonce'] === undefined) return false;
     if (!('order_expiry' in value) || value['order_expiry'] === undefined) return false;
     return true;
 }
@@ -80,11 +80,11 @@ export function SimpleOrderFromJSONTyped(json: any, ignoreDiscriminator: boolean
     }
     return {
         
+        'order_index': json['order_index'],
         'owner_account_index': json['owner_account_index'],
         'initial_base_amount': json['initial_base_amount'],
         'remaining_base_amount': json['remaining_base_amount'],
         'price': json['price'],
-        'nonce': json['nonce'],
         'order_expiry': json['order_expiry'],
     };
 }
@@ -95,11 +95,11 @@ export function SimpleOrderToJSON(value?: SimpleOrder | null): any {
     }
     return {
         
+        'order_index': value['order_index'],
         'owner_account_index': value['owner_account_index'],
         'initial_base_amount': value['initial_base_amount'],
         'remaining_base_amount': value['remaining_base_amount'],
         'price': value['price'],
-        'nonce': value['nonce'],
         'order_expiry': value['order_expiry'],
     };
 }

package/models/Trade.ts

@@ -31,6 +31,12 @@ export interface Trade {
      * @memberof Trade
      */
     tx_hash: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Trade
+     */
+    type: TradeTypeEnum;
     /**
      * 
      * @type {number}
@@ -93,12 +99,25 @@ export interface Trade {
     timestamp: number;
 }
 
+
+/**
+ * @export
+ */
+export const TradeTypeEnum = {
+    Trade: 'trade',
+    Liquidation: 'liquidation',
+    Deleverage: 'deleverage'
+} as const;
+export type TradeTypeEnum = typeof TradeTypeEnum[keyof typeof TradeTypeEnum];
+
+
 /**
  * Check if a given object implements the Trade interface.
  */
 export function instanceOfTrade(value: object): value is Trade {
     if (!('trade_id' in value) || value['trade_id'] === undefined) return false;
     if (!('tx_hash' in value) || value['tx_hash'] === undefined) return false;
+    if (!('type' in value) || value['type'] === undefined) return false;
     if (!('market_id' in value) || value['market_id'] === undefined) return false;
     if (!('size' in value) || value['size'] === undefined) return false;
     if (!('price' in value) || value['price'] === undefined) return false;
@@ -124,6 +143,7 @@ export function TradeFromJSONTyped(json: any, ignoreDiscriminator: boolean): Tra
         
         'trade_id': json['trade_id'],
         'tx_hash': json['tx_hash'],
+        'type': json['type'],
         'market_id': json['market_id'],
         'size': json['size'],
         'price': json['price'],
@@ -145,6 +165,7 @@ export function TradeToJSON(value?: Trade | null): any {
         
         'trade_id': value['trade_id'],
         'tx_hash': value['tx_hash'],
+        'type': value['type'],
         'market_id': value['market_id'],
         'size': value['size'],
         'price': value['price'],

package/openapi.json

@@ -1941,10 +1941,6 @@
           "format": "int64",
           "example": "3"
         },
-        "name": {
-          "type": "string",
-          "example": "Ethereum"
-        },
         "symbol": {
           "type": "string",
           "example": "ETH"
@@ -1979,7 +1975,6 @@
       "required": [
         "market_id",
         "ooc",
-        "name",
         "symbol",
         "sign",
         "position",
@@ -2844,6 +2839,11 @@
     "Order": {
       "type": "object",
       "properties": {
+        "order_index": {
+          "type": "integer",
+          "format": "int64",
+          "example": "1"
+        },
         "market_index": {
           "type": "integer",
           "format": "uint8",
@@ -2885,6 +2885,11 @@
           "example": "3024"
         },
         "nonce": {
+          "type": "integer",
+          "format": "int64",
+          "example": "722"
+        },
+        "client_order_index": {
           "type": "integer",
           "format": "int64",
           "example": "234"
@@ -2912,6 +2917,15 @@
             "market"
           ]
         },
+        "time_in_force": {
+          "type": "string",
+          "enum": [
+            "gtd",
+            "ioc",
+            "alo"
+          ],
+          "default": "gtd"
+        },
         "status": {
           "type": "string",
           "example": "open",
@@ -2934,6 +2948,7 @@
       },
       "title": "Order",
       "required": [
+        "order_index",
         "market_index",
         "owner_account_index",
         "initial_base_amount",
@@ -2944,10 +2959,12 @@
         "base_size",
         "base_price",
         "nonce",
+        "client_order_index",
         "is_ask",
         "order_expiry",
         "side",
         "type",
+        "time_in_force",
         "status",
         "block_height",
         "timestamp"
@@ -3115,46 +3132,36 @@
           "format": "int64",
           "example": "4"
         },
-        "decimal": {
+        "size_decimals": {
           "type": "integer",
           "format": "uint8",
           "example": "4"
         },
-        "price_tick": {
+        "price_decimals": {
           "type": "integer",
-          "format": "int64",
-          "example": "1"
+          "format": "uint8",
+          "example": "4"
         },
         "quote_multiplier": {
           "type": "integer",
           "format": "int64",
           "example": "10000"
         },
-        "initial_margin": {
+        "initial_margin_fraction": {
           "type": "integer",
           "format": "uin16",
           "example": "100"
         },
-        "maintenance_margin": {
+        "maintenance_margin_fraction": {
           "type": "integer",
           "format": "uin16",
           "example": "50"
         },
-        "closeoute_margin": {
+        "closeout_margin_fraction": {
           "type": "integer",
           "format": "uin16",
           "example": "100"
         },
-        "ask_nonce": {
-          "type": "integer",
-          "format": "int64",
-          "example": "234"
-        },
-        "bid_nonce": {
-          "type": "integer",
-          "format": "int64",
-          "example": "274"
-        },
         "last_trade_price": {
           "type": "number",
           "format": "double",
@@ -3211,14 +3218,12 @@
       },
       "title": "OrderBookDetail",
       "required": [
-        "decimal",
-        "price_tick",
+        "size_decimals",
+        "price_decimals",
         "quote_multiplier",
-        "initial_margin",
-        "maintenance_margin",
-        "closeoute_margin",
-        "ask_nonce",
-        "bid_nonce",
+        "initial_margin_fraction",
+        "maintenance_margin_fraction",
+        "closeout_margin_fraction",
         "last_trade_price",
         "daily_trades_count",
         "daily_base_token_volume",
@@ -4307,6 +4312,11 @@
     "SimpleOrder": {
       "type": "object",
       "properties": {
+        "order_index": {
+          "type": "integer",
+          "format": "int64",
+          "example": "1"
+        },
         "owner_account_index": {
           "type": "integer",
           "format": "int64",
@@ -4324,11 +4334,6 @@
           "type": "string",
           "example": "3024.66"
         },
-        "nonce": {
-          "type": "integer",
-          "format": "int64",
-          "example": "234"
-        },
         "order_expiry": {
           "type": "integer",
           "format": "int64",
@@ -4337,11 +4342,11 @@
       },
       "title": "SimpleOrder",
       "required": [
+        "order_index",
         "owner_account_index",
         "initial_base_amount",
         "remaining_base_amount",
         "price",
-        "nonce",
         "order_expiry"
       ]
     },
@@ -4406,6 +4411,15 @@
           "type": "string",
           "example": "0x70997970C51812dc3A010C7d01b50e0d17dc79C8"
         },
+        "type": {
+          "type": "string",
+          "example": "trade",
+          "enum": [
+            "trade",
+            "liquidation",
+            "deleverage"
+          ]
+        },
         "market_id": {
           "type": "integer",
           "format": "uint8",
@@ -4459,6 +4473,7 @@
       "required": [
         "trade_id",
         "tx_hash",
+        "type",
         "market_id",
         "size",
         "price",

package/package.json

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