zklighter-perps 1.0.349 → 1.0.350

package/.openapi-generator/FILES

@@ -283,6 +283,7 @@ models/ReqTvHistory.ts
 models/ReqTvSymbolInfo.ts
 models/RespAtomicOrder.ts
 models/RespAtomicOrderList.ts
+models/RespBuyVolumeQuota.ts
 models/RespChangeAccountTier.ts
 models/RespConnectX.ts
 models/RespConnectXCallback.ts

package/apis/AccountApi.ts

@@ -30,6 +30,7 @@ import type {
   PartnerStats,
   PnlLeaderboard,
   PositionFundings,
+  RespBuyVolumeQuota,
   RespChangeAccountTier,
   RespConnectX,
   RespConnectXCallback,
@@ -82,6 +83,8 @@ import {
     PnlLeaderboardToJSON,
     PositionFundingsFromJSON,
     PositionFundingsToJSON,
+    RespBuyVolumeQuotaFromJSON,
+    RespBuyVolumeQuotaToJSON,
     RespChangeAccountTierFromJSON,
     RespChangeAccountTierToJSON,
     RespConnectXFromJSON,
@@ -169,6 +172,14 @@ export interface ApikeysRequest {
     api_key_index?: number;
 }
 
+export interface BuyVolumeQuotaRequest {
+    quota: number;
+    authorization?: string;
+    tx_info?: string;
+    tx_hash?: string;
+    destination_l1_address?: string;
+}
+
 export interface ChangeAccountTierRequest {
     account_index: number;
     new_tier: string;
@@ -772,6 +783,76 @@ export class AccountApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Buy volume quota with USDC
+     * buyVolumeQuota
+     */
+    async buyVolumeQuotaRaw(requestParameters: BuyVolumeQuotaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RespBuyVolumeQuota>> {
+        if (requestParameters['quota'] == null) {
+            throw new runtime.RequiredError(
+                'quota',
+                'Required parameter "quota" was null or undefined when calling buyVolumeQuota().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (requestParameters['authorization'] != null) {
+            headerParameters['authorization'] = String(requestParameters['authorization']);
+        }
+
+        const consumes: runtime.Consume[] = [
+            { contentType: 'multipart/form-data' },
+        ];
+        // @ts-ignore: canConsumeForm may be unused
+        const canConsumeForm = runtime.canConsumeForm(consumes);
+
+        let formParams: { append(param: string, value: any): any };
+        let useForm = false;
+        if (useForm) {
+            formParams = new FormData();
+        } else {
+            formParams = new URLSearchParams();
+        }
+
+        if (requestParameters['tx_info'] != null) {
+            formParams.append('tx_info', requestParameters['tx_info'] as any);
+        }
+
+        if (requestParameters['tx_hash'] != null) {
+            formParams.append('tx_hash', requestParameters['tx_hash'] as any);
+        }
+
+        if (requestParameters['quota'] != null) {
+            formParams.append('quota', requestParameters['quota'] as any);
+        }
+
+        if (requestParameters['destination_l1_address'] != null) {
+            formParams.append('destination_l1_address', requestParameters['destination_l1_address'] as any);
+        }
+
+        const response = await this.request({
+            path: `/api/v1/buyVolumeQuota`,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: formParams,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => RespBuyVolumeQuotaFromJSON(jsonValue));
+    }
+
+    /**
+     * Buy volume quota with USDC
+     * buyVolumeQuota
+     */
+    async buyVolumeQuota(requestParameters: BuyVolumeQuotaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RespBuyVolumeQuota> {
+        const response = await this.buyVolumeQuotaRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Change account tier
      * changeAccountTier

package/models/AccountLimits.ts

@@ -103,6 +103,24 @@ export interface AccountLimits {
      * @memberof AccountLimits
      */
     user_tier_last_update?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof AccountLimits
+     */
+    volume_quota_remaining: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof AccountLimits
+     */
+    volume_quota_cap: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof AccountLimits
+     */
+    volume_quota_purchase_cap: string;
 }
 
 /**
@@ -121,6 +139,9 @@ export function instanceOfAccountLimits(value: object): value is AccountLimits {
     if (!('current_taker_fee_tick' in value) || value['current_taker_fee_tick'] === undefined) return false;
     if (!('leased_lit' in value) || value['leased_lit'] === undefined) return false;
     if (!('effective_lit_stakes' in value) || value['effective_lit_stakes'] === undefined) return false;
+    if (!('volume_quota_remaining' in value) || value['volume_quota_remaining'] === undefined) return false;
+    if (!('volume_quota_cap' in value) || value['volume_quota_cap'] === undefined) return false;
+    if (!('volume_quota_purchase_cap' in value) || value['volume_quota_purchase_cap'] === undefined) return false;
     return true;
 }
 
@@ -148,6 +169,9 @@ export function AccountLimitsFromJSONTyped(json: any, ignoreDiscriminator: boole
         'leased_lit': json['leased_lit'],
         'effective_lit_stakes': json['effective_lit_stakes'],
         'user_tier_last_update': json['user_tier_last_update'] == null ? undefined : json['user_tier_last_update'],
+        'volume_quota_remaining': json['volume_quota_remaining'],
+        'volume_quota_cap': json['volume_quota_cap'],
+        'volume_quota_purchase_cap': json['volume_quota_purchase_cap'],
     };
 }
 
@@ -171,6 +195,9 @@ export function AccountLimitsToJSON(value?: AccountLimits | null): any {
         'leased_lit': value['leased_lit'],
         'effective_lit_stakes': value['effective_lit_stakes'],
         'user_tier_last_update': value['user_tier_last_update'],
+        'volume_quota_remaining': value['volume_quota_remaining'],
+        'volume_quota_cap': value['volume_quota_cap'],
+        'volume_quota_purchase_cap': value['volume_quota_purchase_cap'],
     };
 }
 

package/models/RespBuyVolumeQuota.ts

@@ -0,0 +1,125 @@
+/* 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 RespBuyVolumeQuota
+ */
+export interface RespBuyVolumeQuota {
+    /**
+     * 
+     * @type {number}
+     * @memberof RespBuyVolumeQuota
+     */
+    code: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof RespBuyVolumeQuota
+     */
+    message?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof RespBuyVolumeQuota
+     */
+    tx_hash: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof RespBuyVolumeQuota
+     */
+    l1_address: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof RespBuyVolumeQuota
+     */
+    quota: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof RespBuyVolumeQuota
+     */
+    volume_quota_remaining: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof RespBuyVolumeQuota
+     */
+    status: RespBuyVolumeQuotaStatusEnum;
+}
+
+
+/**
+ * @export
+ */
+export const RespBuyVolumeQuotaStatusEnum = {
+    Credited: 'credited',
+    Pending: 'pending'
+} as const;
+export type RespBuyVolumeQuotaStatusEnum = typeof RespBuyVolumeQuotaStatusEnum[keyof typeof RespBuyVolumeQuotaStatusEnum];
+
+
+/**
+ * Check if a given object implements the RespBuyVolumeQuota interface.
+ */
+export function instanceOfRespBuyVolumeQuota(value: object): value is RespBuyVolumeQuota {
+    if (!('code' in value) || value['code'] === undefined) return false;
+    if (!('tx_hash' in value) || value['tx_hash'] === undefined) return false;
+    if (!('l1_address' in value) || value['l1_address'] === undefined) return false;
+    if (!('quota' in value) || value['quota'] === undefined) return false;
+    if (!('volume_quota_remaining' in value) || value['volume_quota_remaining'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    return true;
+}
+
+export function RespBuyVolumeQuotaFromJSON(json: any): RespBuyVolumeQuota {
+    return RespBuyVolumeQuotaFromJSONTyped(json, false);
+}
+
+export function RespBuyVolumeQuotaFromJSONTyped(json: any, ignoreDiscriminator: boolean): RespBuyVolumeQuota {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'code': json['code'],
+        'message': json['message'] == null ? undefined : json['message'],
+        'tx_hash': json['tx_hash'],
+        'l1_address': json['l1_address'],
+        'quota': json['quota'],
+        'volume_quota_remaining': json['volume_quota_remaining'],
+        'status': json['status'],
+    };
+}
+
+export function RespBuyVolumeQuotaToJSON(value?: RespBuyVolumeQuota | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'code': value['code'],
+        'message': value['message'],
+        'tx_hash': value['tx_hash'],
+        'l1_address': value['l1_address'],
+        'quota': value['quota'],
+        'volume_quota_remaining': value['volume_quota_remaining'],
+        'status': value['status'],
+    };
+}
+

package/models/index.ts

@@ -254,6 +254,7 @@ export * from './ReqTvHistory';
 export * from './ReqTvSymbolInfo';
 export * from './RespAtomicOrder';
 export * from './RespAtomicOrderList';
+export * from './RespBuyVolumeQuota';
 export * from './RespChangeAccountTier';
 export * from './RespConnectX';
 export * from './RespConnectXCallback';

package/openapi.json

@@ -1318,6 +1318,49 @@
         "description": "Get if next bridge is fast"
       }
     },
+    "/api/v1/buyVolumeQuota": {
+      "post": {
+        "summary": "buyVolumeQuota",
+        "operationId": "buyVolumeQuota",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/RespBuyVolumeQuota"
+            }
+          },
+          "400": {
+            "description": "Bad request",
+            "schema": {
+              "$ref": "#/definitions/ResultCode"
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "authorization",
+            "in": "header",
+            "required": false,
+            "type": "string"
+          },
+          {
+            "name": "body",
+            "in": "body",
+            "required": true,
+            "schema": {
+              "$ref": "#/definitions/ReqBuyVolumeQuota"
+            }
+          }
+        ],
+        "tags": [
+          "account"
+        ],
+        "consumes": [
+          "multipart/form-data"
+        ],
+        "description": "Buy volume quota with USDC"
+      }
+    },
     "/api/v1/candles": {
       "get": {
         "summary": "candles",
@@ -8602,6 +8645,18 @@
         "user_tier_last_update": {
           "type": "integer",
           "format": "int64"
+        },
+        "volume_quota_remaining": {
+          "type": "string",
+          "example": "1010780"
+        },
+        "volume_quota_cap": {
+          "type": "string",
+          "example": "15000000"
+        },
+        "volume_quota_purchase_cap": {
+          "type": "string",
+          "example": "30000000"
         }
       },
       "title": "AccountLimits",
@@ -8617,7 +8672,10 @@
         "current_maker_fee_tick",
         "current_taker_fee_tick",
         "leased_lit",
-        "effective_lit_stakes"
+        "effective_lit_stakes",
+        "volume_quota_remaining",
+        "volume_quota_cap",
+        "volume_quota_purchase_cap"
       ]
     },
     "AccountMarginStats": {
@@ -16932,6 +16990,28 @@
         "account_index"
       ]
     },
+    "ReqBuyVolumeQuota": {
+      "type": "object",
+      "properties": {
+        "tx_info": {
+          "type": "string"
+        },
+        "tx_hash": {
+          "type": "string"
+        },
+        "quota": {
+          "type": "integer",
+          "format": "int64"
+        },
+        "destination_l1_address": {
+          "type": "string"
+        }
+      },
+      "title": "ReqBuyVolumeQuota",
+      "required": [
+        "quota"
+      ]
+    },
     "ReqChangeAccountTier": {
       "type": "object",
       "properties": {
@@ -20707,6 +20787,54 @@
         "atomic_orders"
       ]
     },
+    "RespBuyVolumeQuota": {
+      "type": "object",
+      "properties": {
+        "code": {
+          "type": "integer",
+          "format": "int32",
+          "example": "200"
+        },
+        "message": {
+          "type": "string"
+        },
+        "tx_hash": {
+          "type": "string",
+          "example": "0x70997970C51812dc3A010C7d01b50e0d17dc79C8"
+        },
+        "l1_address": {
+          "type": "string",
+          "example": "0x70997970C51812dc3A010C7d01b50e0d17dc79C8"
+        },
+        "quota": {
+          "type": "integer",
+          "format": "int64",
+          "example": "1000000"
+        },
+        "volume_quota_remaining": {
+          "type": "integer",
+          "format": "int64",
+          "example": "1010780"
+        },
+        "status": {
+          "type": "string",
+          "example": "credited",
+          "enum": [
+            "credited",
+            "pending"
+          ]
+        }
+      },
+      "title": "RespBuyVolumeQuota",
+      "required": [
+        "code",
+        "tx_hash",
+        "l1_address",
+        "quota",
+        "volume_quota_remaining",
+        "status"
+      ]
+    },
     "RespChangeAccountTier": {
       "type": "object",
       "properties": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zklighter-perps",
-  "version": "1.0.349",
+  "version": "1.0.350",
   "description": "Lighter Perps SDK",
   "main": "index.ts",
   "directories": {