zklighter-perps 1.0.25 → 1.0.27

package/models/Order.ts

@@ -24,19 +24,25 @@ export interface Order {
      * @type {number}
      * @memberof Order
      */
-    order_index: number;
+    market_index: number;
     /**
      * 
      * @type {number}
      * @memberof Order
      */
-    market_index: number;
+    owner_account_index: number;
     /**
      * 
      * @type {number}
      * @memberof Order
      */
-    owner_account_index: number;
+    order_index: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof Order
+     */
+    client_order_index: number;
     /**
      * 
      * @type {string}
@@ -85,12 +91,6 @@ export interface Order {
      * @memberof Order
      */
     nonce: number;
-    /**
-     * 
-     * @type {number}
-     * @memberof Order
-     */
-    client_order_index: number;
     /**
      * 
      * @type {boolean}
@@ -98,13 +98,7 @@ export interface Order {
      */
     is_ask: boolean;
     /**
-     * 
-     * @type {number}
-     * @memberof Order
-     */
-    order_expiry: number;
-    /**
-     * 
+     *  TODO: remove this
      * @type {string}
      * @memberof Order
      */
@@ -121,6 +115,12 @@ export interface Order {
      * @memberof Order
      */
     time_in_force: OrderTimeInForceEnum;
+    /**
+     * 
+     * @type {number}
+     * @memberof Order
+     */
+    order_expiry: number;
     /**
      * 
      * @type {string}
@@ -155,9 +155,10 @@ export type OrderTypeEnum = typeof OrderTypeEnum[keyof typeof OrderTypeEnum];
  * @export
  */
 export const OrderTimeInForceEnum = {
-    Gtd: 'gtd',
-    Ioc: 'ioc',
-    Alo: 'alo'
+    GoodTillTime: 'good-till-time',
+    ImmediateOrCancel: 'immediate-or-cancel',
+    PostOnly: 'post-only',
+    Unknown: 'Unknown'
 } as const;
 export type OrderTimeInForceEnum = typeof OrderTimeInForceEnum[keyof typeof OrderTimeInForceEnum];
 
@@ -176,9 +177,10 @@ 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 (!('order_index' in value) || value['order_index'] === undefined) return false;
+    if (!('client_order_index' in value) || value['client_order_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 (!('filled_base_amount' in value) || value['filled_base_amount'] === undefined) return false;
@@ -187,12 +189,11 @@ 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 (!('order_expiry' in value) || value['order_expiry'] === 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;
@@ -209,9 +210,10 @@ 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'],
+        'order_index': json['order_index'],
+        'client_order_index': json['client_order_index'],
         'initial_base_amount': json['initial_base_amount'],
         'remaining_base_amount': json['remaining_base_amount'],
         'filled_base_amount': json['filled_base_amount'],
@@ -220,12 +222,11 @@ 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'],
+        'order_expiry': json['order_expiry'],
         'status': json['status'],
         'block_height': json['block_height'],
         'timestamp': json['timestamp'],
@@ -238,9 +239,10 @@ 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'],
+        'order_index': value['order_index'],
+        'client_order_index': value['client_order_index'],
         'initial_base_amount': value['initial_base_amount'],
         'remaining_base_amount': value['remaining_base_amount'],
         'filled_base_amount': value['filled_base_amount'],
@@ -249,12 +251,11 @@ 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'],
+        'order_expiry': value['order_expiry'],
         'status': value['status'],
         'block_height': value['block_height'],
         'timestamp': value['timestamp'],

package/openapi.json

@@ -4,7 +4,7 @@
     "title": "",
     "version": ""
   },
-  "host": "zk-perps-api.elliot.ai",
+  "host": "testnet.zklighter.elliot.ai",
   "schemes": [
     "https"
   ],
@@ -2839,11 +2839,6 @@
     "Order": {
       "type": "object",
       "properties": {
-        "order_index": {
-          "type": "integer",
-          "format": "int64",
-          "example": "1"
-        },
         "market_index": {
           "type": "integer",
           "format": "uint8",
@@ -2854,6 +2849,16 @@
           "format": "int64",
           "example": "1"
         },
+        "order_index": {
+          "type": "integer",
+          "format": "int64",
+          "example": "1"
+        },
+        "client_order_index": {
+          "type": "integer",
+          "format": "int64",
+          "example": "234"
+        },
         "initial_base_amount": {
           "type": "string",
           "example": "0.1"
@@ -2889,25 +2894,16 @@
           "format": "int64",
           "example": "722"
         },
-        "client_order_index": {
-          "type": "integer",
-          "format": "int64",
-          "example": "234"
-        },
         "is_ask": {
           "type": "boolean",
           "format": "boolean",
           "example": "true"
         },
-        "order_expiry": {
-          "type": "integer",
-          "format": "int64",
-          "example": "1640995200"
-        },
         "side": {
           "type": "string",
           "example": "buy",
-          "default": "buy"
+          "default": "buy",
+          "description": " TODO: remove this"
         },
         "type": {
           "type": "string",
@@ -2920,11 +2916,17 @@
         "time_in_force": {
           "type": "string",
           "enum": [
-            "gtd",
-            "ioc",
-            "alo"
+            "good-till-time",
+            "immediate-or-cancel",
+            "post-only",
+            "Unknown"
           ],
-          "default": "gtd"
+          "default": "good-till-time"
+        },
+        "order_expiry": {
+          "type": "integer",
+          "format": "int64",
+          "example": "1640995200"
         },
         "status": {
           "type": "string",
@@ -2948,9 +2950,10 @@
       },
       "title": "Order",
       "required": [
-        "order_index",
         "market_index",
         "owner_account_index",
+        "order_index",
+        "client_order_index",
         "initial_base_amount",
         "remaining_base_amount",
         "filled_base_amount",
@@ -2959,12 +2962,11 @@
         "base_size",
         "base_price",
         "nonce",
-        "client_order_index",
         "is_ask",
-        "order_expiry",
         "side",
         "type",
         "time_in_force",
+        "order_expiry",
         "status",
         "block_height",
         "timestamp"

package/package.json

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

package/runtime.ts

@@ -13,7 +13,7 @@
  */
 
 
-export const BASE_PATH = "https://zk-perps-api.elliot.ai".replace(/\/+$/, "");
+export const BASE_PATH = "https://testnet.zklighter.elliot.ai".replace(/\/+$/, "");
 
 export interface ConfigurationParameters {
     basePath?: string; // override base path