zklighter-perps 1.0.26 → 1.0.28

package/.openapi-generator/FILES

@@ -47,6 +47,7 @@ models/Orders.ts
 models/Permission.ts
 models/PnLEntry.ts
 models/PriceLevel.ts
+models/PublicPoolShare.ts
 models/ReqDoFaucet.ts
 models/ReqGetAccount.ts
 models/ReqGetAccountActiveOrders.ts

package/models/Account.ts

@@ -31,6 +31,12 @@ export interface Account {
      * @memberof Account
      */
     message?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof Account
+     */
+    account_type: number;
     /**
      * 
      * @type {number}
@@ -67,25 +73,19 @@ export interface Account {
      * @memberof Account
      */
     collateral: string;
-    /**
-     * 
-     * @type {boolean}
-     * @memberof Account
-     */
-    is_sub_account: boolean;
 }
 
 /**
  * Check if a given object implements the Account interface.
  */
 export function instanceOfAccount(value: object): value is Account {
+    if (!('account_type' in value) || value['account_type'] === undefined) return false;
     if (!('index' in value) || value['index'] === undefined) return false;
     if (!('l1_address' in value) || value['l1_address'] === undefined) return false;
     if (!('cancel_all_time' in value) || value['cancel_all_time'] === undefined) return false;
     if (!('open_order_count' in value) || value['open_order_count'] === undefined) return false;
     if (!('status' in value) || value['status'] === undefined) return false;
     if (!('collateral' in value) || value['collateral'] === undefined) return false;
-    if (!('is_sub_account' in value) || value['is_sub_account'] === undefined) return false;
     return true;
 }
 
@@ -101,13 +101,13 @@ export function AccountFromJSONTyped(json: any, ignoreDiscriminator: boolean): A
         
         'code': json['code'] == null ? undefined : json['code'],
         'message': json['message'] == null ? undefined : json['message'],
+        'account_type': json['account_type'],
         'index': json['index'],
         'l1_address': json['l1_address'],
         'cancel_all_time': json['cancel_all_time'],
         'open_order_count': json['open_order_count'],
         'status': json['status'],
         'collateral': json['collateral'],
-        'is_sub_account': json['is_sub_account'],
     };
 }
 
@@ -119,13 +119,13 @@ export function AccountToJSON(value?: Account | null): any {
         
         'code': value['code'],
         'message': value['message'],
+        'account_type': value['account_type'],
         'index': value['index'],
         'l1_address': value['l1_address'],
         'cancel_all_time': value['cancel_all_time'],
         'open_order_count': value['open_order_count'],
         'status': value['status'],
         'collateral': value['collateral'],
-        'is_sub_account': value['is_sub_account'],
     };
 }
 

package/models/DetailedAccount.ts

@@ -25,6 +25,12 @@ import {
     AccountPositionFromJSONTyped,
     AccountPositionToJSON,
 } from './AccountPosition';
+import type { PublicPoolShare } from './PublicPoolShare';
+import {
+    PublicPoolShareFromJSON,
+    PublicPoolShareFromJSONTyped,
+    PublicPoolShareToJSON,
+} from './PublicPoolShare';
 
 /**
  * 
@@ -44,6 +50,12 @@ export interface DetailedAccount {
      * @memberof DetailedAccount
      */
     message?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof DetailedAccount
+     */
+    account_type?: number;
     /**
      * 
      * @type {number}
@@ -80,12 +92,6 @@ export interface DetailedAccount {
      * @memberof DetailedAccount
      */
     collateral?: string;
-    /**
-     * 
-     * @type {boolean}
-     * @memberof DetailedAccount
-     */
-    is_sub_account?: boolean;
     /**
      * 
      * @type {Array<AccountPosition>}
@@ -104,6 +110,12 @@ export interface DetailedAccount {
      * @memberof DetailedAccount
      */
     market_stats: Array<AccountMarketStats>;
+    /**
+     * 
+     * @type {Array<PublicPoolShare>}
+     * @memberof DetailedAccount
+     */
+    shares: Array<PublicPoolShare>;
 }
 
 /**
@@ -113,6 +125,7 @@ export function instanceOfDetailedAccount(value: object): value is DetailedAccou
     if (!('positions' in value) || value['positions'] === undefined) return false;
     if (!('total_asset_value' in value) || value['total_asset_value'] === undefined) return false;
     if (!('market_stats' in value) || value['market_stats'] === undefined) return false;
+    if (!('shares' in value) || value['shares'] === undefined) return false;
     return true;
 }
 
@@ -128,16 +141,17 @@ export function DetailedAccountFromJSONTyped(json: any, ignoreDiscriminator: boo
         
         'code': json['code'] == null ? undefined : json['code'],
         'message': json['message'] == null ? undefined : json['message'],
+        'account_type': json['account_type'] == null ? undefined : json['account_type'],
         'index': json['index'] == null ? undefined : json['index'],
         'l1_address': json['l1_address'] == null ? undefined : json['l1_address'],
         'cancel_all_time': json['cancel_all_time'] == null ? undefined : json['cancel_all_time'],
         'open_order_count': json['open_order_count'] == null ? undefined : json['open_order_count'],
         'status': json['status'] == null ? undefined : json['status'],
         'collateral': json['collateral'] == null ? undefined : json['collateral'],
-        'is_sub_account': json['is_sub_account'] == null ? undefined : json['is_sub_account'],
         'positions': ((json['positions'] as Array<any>).map(AccountPositionFromJSON)),
         'total_asset_value': json['total_asset_value'],
         'market_stats': ((json['market_stats'] as Array<any>).map(AccountMarketStatsFromJSON)),
+        'shares': ((json['shares'] as Array<any>).map(PublicPoolShareFromJSON)),
     };
 }
 
@@ -149,16 +163,17 @@ export function DetailedAccountToJSON(value?: DetailedAccount | null): any {
         
         'code': value['code'],
         'message': value['message'],
+        'account_type': value['account_type'],
         'index': value['index'],
         'l1_address': value['l1_address'],
         'cancel_all_time': value['cancel_all_time'],
         'open_order_count': value['open_order_count'],
         'status': value['status'],
         'collateral': value['collateral'],
-        'is_sub_account': value['is_sub_account'],
         'positions': ((value['positions'] as Array<any>).map(AccountPositionToJSON)),
         'total_asset_value': value['total_asset_value'],
         'market_stats': ((value['market_stats'] as Array<any>).map(AccountMarketStatsToJSON)),
+        'shares': ((value['shares'] as Array<any>).map(PublicPoolShareToJSON)),
     };
 }
 

package/models/MarketInfo.ts

@@ -37,6 +37,12 @@ export interface MarketInfo {
      * @memberof MarketInfo
      */
     mark_price: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof MarketInfo
+     */
+    open_interest: string;
     /**
      * 
      * @type {string}
@@ -94,6 +100,7 @@ export function instanceOfMarketInfo(value: object): value is MarketInfo {
     if (!('market_id' in value) || value['market_id'] === undefined) return false;
     if (!('index_price' in value) || value['index_price'] === undefined) return false;
     if (!('mark_price' in value) || value['mark_price'] === undefined) return false;
+    if (!('open_interest' in value) || value['open_interest'] === undefined) return false;
     if (!('last_trade_price' in value) || value['last_trade_price'] === undefined) return false;
     if (!('funding_rate' in value) || value['funding_rate'] === undefined) return false;
     if (!('funding_timestamp' in value) || value['funding_timestamp'] === undefined) return false;
@@ -118,6 +125,7 @@ export function MarketInfoFromJSONTyped(json: any, ignoreDiscriminator: boolean)
         'market_id': json['market_id'],
         'index_price': json['index_price'],
         'mark_price': json['mark_price'],
+        'open_interest': json['open_interest'],
         'last_trade_price': json['last_trade_price'],
         'funding_rate': json['funding_rate'],
         'funding_timestamp': json['funding_timestamp'],
@@ -138,6 +146,7 @@ export function MarketInfoToJSON(value?: MarketInfo | null): any {
         'market_id': value['market_id'],
         'index_price': value['index_price'],
         'mark_price': value['mark_price'],
+        'open_interest': value['open_interest'],
         'last_trade_price': value['last_trade_price'],
         'funding_rate': value['funding_rate'],
         'funding_timestamp': value['funding_timestamp'],

package/models/Order.ts

@@ -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];
 

package/models/PublicPoolShare.ts

@@ -0,0 +1,79 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface PublicPoolShare
+ */
+export interface PublicPoolShare {
+    /**
+     * 
+     * @type {number}
+     * @memberof PublicPoolShare
+     */
+    public_pool_id: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof PublicPoolShare
+     */
+    shares_amount: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof PublicPoolShare
+     */
+    entry_usdc: string;
+}
+
+/**
+ * Check if a given object implements the PublicPoolShare interface.
+ */
+export function instanceOfPublicPoolShare(value: object): value is PublicPoolShare {
+    if (!('public_pool_id' in value) || value['public_pool_id'] === undefined) return false;
+    if (!('shares_amount' in value) || value['shares_amount'] === undefined) return false;
+    if (!('entry_usdc' in value) || value['entry_usdc'] === undefined) return false;
+    return true;
+}
+
+export function PublicPoolShareFromJSON(json: any): PublicPoolShare {
+    return PublicPoolShareFromJSONTyped(json, false);
+}
+
+export function PublicPoolShareFromJSONTyped(json: any, ignoreDiscriminator: boolean): PublicPoolShare {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'public_pool_id': json['public_pool_id'],
+        'shares_amount': json['shares_amount'],
+        'entry_usdc': json['entry_usdc'],
+    };
+}
+
+export function PublicPoolShareToJSON(value?: PublicPoolShare | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'public_pool_id': value['public_pool_id'],
+        'shares_amount': value['shares_amount'],
+        'entry_usdc': value['entry_usdc'],
+    };
+}
+

package/models/Rollback.ts

@@ -27,10 +27,10 @@ export interface Rollback {
     from_block_height: number;
     /**
      * 
-     * @type {string}
+     * @type {number}
      * @memberof Rollback
      */
-    from_tx_hash: string;
+    from_tx_sequence_index: number;
     /**
      * 
      * @type {number}
@@ -50,7 +50,7 @@ export interface Rollback {
  */
 export function instanceOfRollback(value: object): value is Rollback {
     if (!('from_block_height' in value) || value['from_block_height'] === undefined) return false;
-    if (!('from_tx_hash' in value) || value['from_tx_hash'] === undefined) return false;
+    if (!('from_tx_sequence_index' in value) || value['from_tx_sequence_index'] === undefined) return false;
     if (!('id' in value) || value['id'] === undefined) return false;
     if (!('created_at' in value) || value['created_at'] === undefined) return false;
     return true;
@@ -67,7 +67,7 @@ export function RollbackFromJSONTyped(json: any, ignoreDiscriminator: boolean):
     return {
         
         'from_block_height': json['from_block_height'],
-        'from_tx_hash': json['from_tx_hash'],
+        'from_tx_sequence_index': json['from_tx_sequence_index'],
         'id': json['id'],
         'created_at': json['created_at'],
     };
@@ -80,7 +80,7 @@ export function RollbackToJSON(value?: Rollback | null): any {
     return {
         
         'from_block_height': value['from_block_height'],
-        'from_tx_hash': value['from_tx_hash'],
+        'from_tx_sequence_index': value['from_tx_sequence_index'],
         'id': value['id'],
         'created_at': value['created_at'],
     };

package/models/index.ts

@@ -39,6 +39,7 @@ export * from './Orders';
 export * from './Permission';
 export * from './PnLEntry';
 export * from './PriceLevel';
+export * from './PublicPoolShare';
 export * from './ReqDoFaucet';
 export * from './ReqGetAccount';
 export * from './ReqGetAccountActiveOrders';

package/openapi.json

@@ -4,7 +4,7 @@
     "title": "",
     "version": ""
   },
-  "host": "zk-perps-api.elliot.ai",
+  "host": "testnet.zklighter.elliot.ai",
   "schemes": [
     "https"
   ],
@@ -1788,6 +1788,11 @@
         "message": {
           "type": "string"
         },
+        "account_type": {
+          "type": "integer",
+          "format": "uint8",
+          "example": "1"
+        },
         "index": {
           "type": "integer",
           "format": "int64",
@@ -1815,22 +1820,17 @@
         "collateral": {
           "type": "string",
           "example": "46342"
-        },
-        "is_sub_account": {
-          "type": "boolean",
-          "format": "boolean",
-          "example": "false"
         }
       },
       "title": "Account",
       "required": [
+        "account_type",
         "index",
         "l1_address",
         "cancel_all_time",
         "open_order_count",
         "status",
-        "collateral",
-        "is_sub_account"
+        "collateral"
       ]
     },
     "AccountApiKeys": {
@@ -2311,6 +2311,11 @@
         "message": {
           "type": "string"
         },
+        "account_type": {
+          "type": "integer",
+          "format": "uint8",
+          "example": "1"
+        },
         "index": {
           "type": "integer",
           "format": "int64",
@@ -2339,11 +2344,6 @@
           "type": "string",
           "example": "46342"
         },
-        "is_sub_account": {
-          "type": "boolean",
-          "format": "boolean",
-          "example": "false"
-        },
         "positions": {
           "type": "array",
           "items": {
@@ -2359,13 +2359,20 @@
           "items": {
             "$ref": "#/definitions/AccountMarketStats"
           }
+        },
+        "shares": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/PublicPoolShare"
+          }
         }
       },
       "title": "DetailedAccount",
       "required": [
         "positions",
         "total_asset_value",
-        "market_stats"
+        "market_stats",
+        "shares"
       ]
     },
     "DetailedAccounts": {
@@ -2760,6 +2767,10 @@
           "type": "string",
           "example": "3024.66"
         },
+        "open_interest": {
+          "type": "string",
+          "example": "235.25"
+        },
         "last_trade_price": {
           "type": "string",
           "example": "3024.66"
@@ -2804,6 +2815,7 @@
         "market_id",
         "index_price",
         "mark_price",
+        "open_interest",
         "last_trade_price",
         "funding_rate",
         "funding_timestamp",
@@ -2916,11 +2928,12 @@
         "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",
@@ -3454,6 +3467,31 @@
         "size"
       ]
     },
+    "PublicPoolShare": {
+      "type": "object",
+      "properties": {
+        "public_pool_id": {
+          "type": "integer",
+          "format": "int64",
+          "example": "1"
+        },
+        "shares_amount": {
+          "type": "integer",
+          "format": "int64",
+          "example": "3000"
+        },
+        "entry_usdc": {
+          "type": "string",
+          "example": "3000"
+        }
+      },
+      "title": "PublicPoolShare",
+      "required": [
+        "public_pool_id",
+        "shares_amount",
+        "entry_usdc"
+      ]
+    },
     "ReqDoFaucet": {
       "type": "object",
       "properties": {
@@ -4215,9 +4253,10 @@
           "format": "int64",
           "example": "45434"
         },
-        "from_tx_hash": {
-          "type": "string",
-          "example": "0x70997970C51812dc3A010C7d01b50e0d17dc79C8"
+        "from_tx_sequence_index": {
+          "type": "integer",
+          "format": "int64",
+          "example": "8761"
         },
         "id": {
           "type": "integer",
@@ -4233,7 +4272,7 @@
       "title": "Rollback",
       "required": [
         "from_block_height",
-        "from_tx_hash",
+        "from_tx_sequence_index",
         "id",
         "created_at"
       ]

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zklighter-perps",
-  "version": "1.0.26",
+  "version": "1.0.28",
   "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