zklighter-perps 1.0.15 → 1.0.17

package/.openapi-generator/FILES

@@ -2,15 +2,18 @@ apis/AccountApi.ts
 apis/BlockApi.ts
 apis/CandlestickApi.ts
 apis/InfoApi.ts
+apis/LiquidationApi.ts
 apis/OrderApi.ts
 apis/RootApi.ts
 apis/TransactionApi.ts
 apis/index.ts
 index.ts
+models/Account.ts
 models/AccountMarketStats.ts
 models/AccountPnL.ts
 models/AccountPosition.ts
 models/AccountStats.ts
+models/Accounts.ts
 models/Block.ts
 models/Blocks.ts
 models/Candlestick.ts
@@ -27,8 +30,7 @@ models/Fundings.ts
 models/L1ProviderInfo.ts
 models/Layer1BasicInfo.ts
 models/Layer2BasicInfo.ts
-models/MainAccount.ts
-models/MainAccounts.ts
+models/Liquidation.ts
 models/MarketInfo.ts
 models/NextNonce.ts
 models/Order.ts
@@ -68,9 +70,9 @@ models/ReqGetRangeWithIndex.ts
 models/ReqGetRangeWithIndexSortable.ts
 models/ReqGetRecentTrades.ts
 models/ReqGetRollbacks.ts
-models/ReqGetSubAccount.ts
 models/ReqGetTrades.ts
 models/ReqGetTx.ts
+models/ReqMarkNotifRead.ts
 models/ReqSearch.ts
 models/ResultCode.ts
 models/Rollback.ts
@@ -79,7 +81,6 @@ models/Search.ts
 models/SignBody.ts
 models/SimpleOrder.ts
 models/Status.ts
-models/SubAccount.ts
 models/SubAccounts.ts
 models/Trade.ts
 models/Trades.ts

package/apis/AccountApi.ts

@@ -16,8 +16,8 @@
 import * as runtime from '../runtime';
 import type {
   AccountPnL,
+  Accounts,
   DetailedAccounts,
-  MainAccounts,
   Permission,
   ResultCode,
   SubAccounts,
@@ -25,10 +25,10 @@ import type {
 import {
     AccountPnLFromJSON,
     AccountPnLToJSON,
+    AccountsFromJSON,
+    AccountsToJSON,
     DetailedAccountsFromJSON,
     DetailedAccountsToJSON,
-    MainAccountsFromJSON,
-    MainAccountsToJSON,
     PermissionFromJSON,
     PermissionToJSON,
     ResultCodeFromJSON,
@@ -44,7 +44,6 @@ export interface DoFaucetRequest {
 export interface GetAccountRequest {
     by: GetAccountByEnum;
     value: string;
-    sub_account_index: number;
 }
 
 export interface GetAccountPnlRequest {
@@ -117,7 +116,7 @@ export class AccountApi extends runtime.BaseAPI {
     }
 
     /**
-     * Get account by main account\'s l1_address or index and sub account\'s index. Returns detailed account info
+     * Get account by account\'s l1_address or index. Returns detailed account info
      * GetAccount
      */
     async getAccountRaw(requestParameters: GetAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DetailedAccounts>> {
@@ -135,13 +134,6 @@ export class AccountApi extends runtime.BaseAPI {
             );
         }
 
-        if (requestParameters['sub_account_index'] == null) {
-            throw new runtime.RequiredError(
-                'sub_account_index',
-                'Required parameter "sub_account_index" was null or undefined when calling getAccount().'
-            );
-        }
-
         const queryParameters: any = {};
 
         if (requestParameters['by'] != null) {
@@ -152,10 +144,6 @@ export class AccountApi extends runtime.BaseAPI {
             queryParameters['value'] = requestParameters['value'];
         }
 
-        if (requestParameters['sub_account_index'] != null) {
-            queryParameters['sub_account_index'] = requestParameters['sub_account_index'];
-        }
-
         const headerParameters: runtime.HTTPHeaders = {};
 
         const response = await this.request({
@@ -169,7 +157,7 @@ export class AccountApi extends runtime.BaseAPI {
     }
 
     /**
-     * Get account by main account\'s l1_address or index and sub account\'s index. Returns detailed account info
+     * Get account by account\'s l1_address or index. Returns detailed account info
      * GetAccount
      */
     async getAccount(requestParameters: GetAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DetailedAccounts> {
@@ -272,10 +260,10 @@ export class AccountApi extends runtime.BaseAPI {
     }
 
     /**
-     * Get accounts returns main accounts by account index
+     * Get accounts returns accounts by account index
      * GetAccounts
      */
-    async getAccountsRaw(requestParameters: GetAccountsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MainAccounts>> {
+    async getAccountsRaw(requestParameters: GetAccountsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Accounts>> {
         if (requestParameters['limit'] == null) {
             throw new runtime.RequiredError(
                 'limit',
@@ -306,20 +294,20 @@ export class AccountApi extends runtime.BaseAPI {
             query: queryParameters,
         }, initOverrides);
 
-        return new runtime.JSONApiResponse(response, (jsonValue) => MainAccountsFromJSON(jsonValue));
+        return new runtime.JSONApiResponse(response, (jsonValue) => AccountsFromJSON(jsonValue));
     }
 
     /**
-     * Get accounts returns main accounts by account index
+     * Get accounts returns accounts by account index
      * GetAccounts
      */
-    async getAccounts(requestParameters: GetAccountsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MainAccounts> {
+    async getAccounts(requestParameters: GetAccountsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Accounts> {
         const response = await this.getAccountsRaw(requestParameters, initOverrides);
         return await response.value();
     }
 
     /**
-     * Get accounts by l1_address returns main account and its sub accounts
+     * Get accounts by l1_address returns all accounts associated with the given L1 address
      * GetAccountsByL1Address
      */
     async getAccountsByL1AddressRaw(requestParameters: GetAccountsByL1AddressRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SubAccounts>> {
@@ -349,7 +337,7 @@ export class AccountApi extends runtime.BaseAPI {
     }
 
     /**
-     * Get accounts by l1_address returns main account and its sub accounts
+     * Get accounts by l1_address returns all accounts associated with the given L1 address
      * GetAccountsByL1Address
      */
     async getAccountsByL1Address(requestParameters: GetAccountsByL1AddressRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SubAccounts> {

package/apis/LiquidationApi.ts

@@ -0,0 +1,121 @@
+/* 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 * as runtime from '../runtime';
+import type {
+  ResultCode,
+} from '../models/index';
+import {
+    ResultCodeFromJSON,
+    ResultCodeToJSON,
+} from '../models/index';
+
+export interface MarkNotifReadRequest {
+    notif_type: string;
+    account_index: number;
+    api_key_index: number;
+    liquidation_ids: string;
+    signature: string;
+}
+
+/**
+ * 
+ */
+export class LiquidationApi extends runtime.BaseAPI {
+
+    /**
+     * Mark
+     * MarkNotifRead
+     */
+    async markNotifReadRaw(requestParameters: MarkNotifReadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ResultCode>> {
+        if (requestParameters['notif_type'] == null) {
+            throw new runtime.RequiredError(
+                'notif_type',
+                'Required parameter "notif_type" was null or undefined when calling markNotifRead().'
+            );
+        }
+
+        if (requestParameters['account_index'] == null) {
+            throw new runtime.RequiredError(
+                'account_index',
+                'Required parameter "account_index" was null or undefined when calling markNotifRead().'
+            );
+        }
+
+        if (requestParameters['api_key_index'] == null) {
+            throw new runtime.RequiredError(
+                'api_key_index',
+                'Required parameter "api_key_index" was null or undefined when calling markNotifRead().'
+            );
+        }
+
+        if (requestParameters['liquidation_ids'] == null) {
+            throw new runtime.RequiredError(
+                'liquidation_ids',
+                'Required parameter "liquidation_ids" was null or undefined when calling markNotifRead().'
+            );
+        }
+
+        if (requestParameters['signature'] == null) {
+            throw new runtime.RequiredError(
+                'signature',
+                'Required parameter "signature" was null or undefined when calling markNotifRead().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['notif_type'] != null) {
+            queryParameters['notif_type'] = requestParameters['notif_type'];
+        }
+
+        if (requestParameters['account_index'] != null) {
+            queryParameters['account_index'] = requestParameters['account_index'];
+        }
+
+        if (requestParameters['api_key_index'] != null) {
+            queryParameters['api_key_index'] = requestParameters['api_key_index'];
+        }
+
+        if (requestParameters['liquidation_ids'] != null) {
+            queryParameters['liquidation_ids'] = requestParameters['liquidation_ids'];
+        }
+
+        if (requestParameters['signature'] != null) {
+            queryParameters['signature'] = requestParameters['signature'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/api/v1/markNotifRead`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ResultCodeFromJSON(jsonValue));
+    }
+
+    /**
+     * Mark
+     * MarkNotifRead
+     */
+    async markNotifRead(requestParameters: MarkNotifReadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ResultCode> {
+        const response = await this.markNotifReadRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}

package/apis/OrderApi.ts

@@ -42,13 +42,11 @@ import {
 
 export interface GetAccountActiveOrdersRequest {
     account_index: number;
-    sub_account_index: number;
     market_id: number;
 }
 
 export interface GetAccountInactiveOrdersRequest {
     account_index: number;
-    sub_account_index: number;
     filter: GetAccountInactiveOrdersFilterEnum;
     limit: number;
     market_id?: number;
@@ -107,13 +105,6 @@ export class OrderApi extends runtime.BaseAPI {
             );
         }
 
-        if (requestParameters['sub_account_index'] == null) {
-            throw new runtime.RequiredError(
-                'sub_account_index',
-                'Required parameter "sub_account_index" was null or undefined when calling getAccountActiveOrders().'
-            );
-        }
-
         if (requestParameters['market_id'] == null) {
             throw new runtime.RequiredError(
                 'market_id',
@@ -127,10 +118,6 @@ export class OrderApi extends runtime.BaseAPI {
             queryParameters['account_index'] = requestParameters['account_index'];
         }
 
-        if (requestParameters['sub_account_index'] != null) {
-            queryParameters['sub_account_index'] = requestParameters['sub_account_index'];
-        }
-
         if (requestParameters['market_id'] != null) {
             queryParameters['market_id'] = requestParameters['market_id'];
         }
@@ -168,13 +155,6 @@ export class OrderApi extends runtime.BaseAPI {
             );
         }
 
-        if (requestParameters['sub_account_index'] == null) {
-            throw new runtime.RequiredError(
-                'sub_account_index',
-                'Required parameter "sub_account_index" was null or undefined when calling getAccountInactiveOrders().'
-            );
-        }
-
         if (requestParameters['filter'] == null) {
             throw new runtime.RequiredError(
                 'filter',
@@ -195,10 +175,6 @@ export class OrderApi extends runtime.BaseAPI {
             queryParameters['account_index'] = requestParameters['account_index'];
         }
 
-        if (requestParameters['sub_account_index'] != null) {
-            queryParameters['sub_account_index'] = requestParameters['sub_account_index'];
-        }
-
         if (requestParameters['filter'] != null) {
             queryParameters['filter'] = requestParameters['filter'];
         }

package/apis/TransactionApi.ts

@@ -66,7 +66,7 @@ export interface GetL2SignatureBodyRequest {
 
 export interface GetNextNonceRequest {
     account_index: number;
-    sub_account_index: number;
+    api_key_index: number;
 }
 
 export interface GetPendingTxsRequest {
@@ -353,10 +353,10 @@ export class TransactionApi extends runtime.BaseAPI {
             );
         }
 
-        if (requestParameters['sub_account_index'] == null) {
+        if (requestParameters['api_key_index'] == null) {
             throw new runtime.RequiredError(
-                'sub_account_index',
-                'Required parameter "sub_account_index" was null or undefined when calling getNextNonce().'
+                'api_key_index',
+                'Required parameter "api_key_index" was null or undefined when calling getNextNonce().'
             );
         }
 
@@ -366,8 +366,8 @@ export class TransactionApi extends runtime.BaseAPI {
             queryParameters['account_index'] = requestParameters['account_index'];
         }
 
-        if (requestParameters['sub_account_index'] != null) {
-            queryParameters['sub_account_index'] = requestParameters['sub_account_index'];
+        if (requestParameters['api_key_index'] != null) {
+            queryParameters['api_key_index'] = requestParameters['api_key_index'];
         }
 
         const headerParameters: runtime.HTTPHeaders = {};

package/apis/index.ts

@@ -4,6 +4,7 @@ export * from './AccountApi';
 export * from './BlockApi';
 export * from './CandlestickApi';
 export * from './InfoApi';
+export * from './LiquidationApi';
 export * from './OrderApi';
 export * from './RootApi';
 export * from './TransactionApi';

package/models/Account.ts

@@ -0,0 +1,104 @@
+/* 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 Account
+ */
+export interface Account {
+    /**
+     * 
+     * @type {number}
+     * @memberof Account
+     */
+    code?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof Account
+     */
+    message?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof Account
+     */
+    index: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof Account
+     */
+    l1_address: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof Account
+     */
+    status: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof Account
+     */
+    collateral: string;
+}
+
+/**
+ * Check if a given object implements the Account interface.
+ */
+export function instanceOfAccount(value: object): value is Account {
+    if (!('index' in value) || value['index'] === undefined) return false;
+    if (!('l1_address' in value) || value['l1_address'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    if (!('collateral' in value) || value['collateral'] === undefined) return false;
+    return true;
+}
+
+export function AccountFromJSON(json: any): Account {
+    return AccountFromJSONTyped(json, false);
+}
+
+export function AccountFromJSONTyped(json: any, ignoreDiscriminator: boolean): Account {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'code': json['code'] == null ? undefined : json['code'],
+        'message': json['message'] == null ? undefined : json['message'],
+        'index': json['index'],
+        'l1_address': json['l1_address'],
+        'status': json['status'],
+        'collateral': json['collateral'],
+    };
+}
+
+export function AccountToJSON(value?: Account | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'code': value['code'],
+        'message': value['message'],
+        'index': value['index'],
+        'l1_address': value['l1_address'],
+        'status': value['status'],
+        'collateral': value['collateral'],
+    };
+}
+

package/models/Accounts.ts

@@ -0,0 +1,93 @@
+/* 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';
+import type { Account } from './Account';
+import {
+    AccountFromJSON,
+    AccountFromJSONTyped,
+    AccountToJSON,
+} from './Account';
+
+/**
+ * 
+ * @export
+ * @interface Accounts
+ */
+export interface Accounts {
+    /**
+     * 
+     * @type {number}
+     * @memberof Accounts
+     */
+    code?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof Accounts
+     */
+    message?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof Accounts
+     */
+    total: number;
+    /**
+     * 
+     * @type {Array<Account>}
+     * @memberof Accounts
+     */
+    accounts: Array<Account>;
+}
+
+/**
+ * Check if a given object implements the Accounts interface.
+ */
+export function instanceOfAccounts(value: object): value is Accounts {
+    if (!('total' in value) || value['total'] === undefined) return false;
+    if (!('accounts' in value) || value['accounts'] === undefined) return false;
+    return true;
+}
+
+export function AccountsFromJSON(json: any): Accounts {
+    return AccountsFromJSONTyped(json, false);
+}
+
+export function AccountsFromJSONTyped(json: any, ignoreDiscriminator: boolean): Accounts {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'code': json['code'] == null ? undefined : json['code'],
+        'message': json['message'] == null ? undefined : json['message'],
+        'total': json['total'],
+        'accounts': ((json['accounts'] as Array<any>).map(AccountFromJSON)),
+    };
+}
+
+export function AccountsToJSON(value?: Accounts | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'code': value['code'],
+        'message': value['message'],
+        'total': value['total'],
+        'accounts': ((value['accounts'] as Array<any>).map(AccountToJSON)),
+    };
+}
+

package/models/DetailedAccount.ts

@@ -50,30 +50,12 @@ export interface DetailedAccount {
      * @memberof DetailedAccount
      */
     index?: number;
-    /**
-     * 
-     * @type {number}
-     * @memberof DetailedAccount
-     */
-    sub_account_index?: number;
     /**
      * 
      * @type {string}
      * @memberof DetailedAccount
      */
     l1_address?: string;
-    /**
-     * 
-     * @type {string}
-     * @memberof DetailedAccount
-     */
-    pk?: string;
-    /**
-     * 
-     * @type {number}
-     * @memberof DetailedAccount
-     */
-    nonce?: number;
     /**
      * 
      * @type {number}
@@ -86,12 +68,6 @@ export interface DetailedAccount {
      * @memberof DetailedAccount
      */
     collateral?: string;
-    /**
-     * 
-     * @type {number}
-     * @memberof DetailedAccount
-     */
-    collateral_type?: number;
     /**
      * 
      * @type {Array<AccountPosition>}
@@ -135,13 +111,9 @@ export function DetailedAccountFromJSONTyped(json: any, ignoreDiscriminator: boo
         'code': json['code'] == null ? undefined : json['code'],
         'message': json['message'] == null ? undefined : json['message'],
         'index': json['index'] == null ? undefined : json['index'],
-        'sub_account_index': json['sub_account_index'] == null ? undefined : json['sub_account_index'],
         'l1_address': json['l1_address'] == null ? undefined : json['l1_address'],
-        'pk': json['pk'] == null ? undefined : json['pk'],
-        'nonce': json['nonce'] == null ? undefined : json['nonce'],
         'status': json['status'] == null ? undefined : json['status'],
         'collateral': json['collateral'] == null ? undefined : json['collateral'],
-        'collateral_type': json['collateral_type'] == null ? undefined : json['collateral_type'],
         '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)),
@@ -157,13 +129,9 @@ export function DetailedAccountToJSON(value?: DetailedAccount | null): any {
         'code': value['code'],
         'message': value['message'],
         'index': value['index'],
-        'sub_account_index': value['sub_account_index'],
         'l1_address': value['l1_address'],
-        'pk': value['pk'],
-        'nonce': value['nonce'],
         'status': value['status'],
         'collateral': value['collateral'],
-        'collateral_type': value['collateral_type'],
         '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)),