zklighter-perps 1.0.0

package/apis/OrderApi.ts

@@ -0,0 +1,607 @@
+/* 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 {
+  ExchangeStats,
+  OrderBookDetails,
+  OrderBookOrders,
+  OrderBooks,
+  Orders,
+  Trades,
+} from '../models/index';
+import {
+    ExchangeStatsFromJSON,
+    ExchangeStatsToJSON,
+    OrderBookDetailsFromJSON,
+    OrderBookDetailsToJSON,
+    OrderBookOrdersFromJSON,
+    OrderBookOrdersToJSON,
+    OrderBooksFromJSON,
+    OrderBooksToJSON,
+    OrdersFromJSON,
+    OrdersToJSON,
+    TradesFromJSON,
+    TradesToJSON,
+} from '../models/index';
+
+export interface GetAccountActiveOrdersRequest {
+    accountIndex: number;
+    subAccountIndex: number;
+    marketId: number;
+}
+
+export interface GetAccountInactiveOrdersRequest {
+    accountIndex: number;
+    subAccountIndex: number;
+    filter: GetAccountInactiveOrdersFilterEnum;
+    limit: number;
+    marketId?: number;
+    cursor?: string;
+}
+
+export interface GetAccountOrdersRequest {
+    accountIndex: number;
+    marketId: number;
+    limit: number;
+    cursor?: string;
+}
+
+export interface GetOrderBookDetailsRequest {
+    filter: GetOrderBookDetailsFilterEnum;
+    marketId?: number;
+}
+
+export interface GetOrderBookOrdersRequest {
+    marketId: number;
+    limit: number;
+}
+
+export interface GetOrderBooksRequest {
+    filter: GetOrderBooksFilterEnum;
+    marketId?: number;
+}
+
+export interface GetRecentTradesRequest {
+    marketId: number;
+    limit: number;
+}
+
+export interface GetTradesRequest {
+    marketId: number;
+    by: GetTradesByEnum;
+    from: number;
+    limit: number;
+    orderIndex?: number;
+}
+
+/**
+ * 
+ */
+export class OrderApi extends runtime.BaseAPI {
+
+    /**
+     * Get account active orders
+     */
+    async getAccountActiveOrdersRaw(requestParameters: GetAccountActiveOrdersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Orders>> {
+        if (requestParameters['accountIndex'] == null) {
+            throw new runtime.RequiredError(
+                'accountIndex',
+                'Required parameter "accountIndex" was null or undefined when calling getAccountActiveOrders().'
+            );
+        }
+
+        if (requestParameters['subAccountIndex'] == null) {
+            throw new runtime.RequiredError(
+                'subAccountIndex',
+                'Required parameter "subAccountIndex" was null or undefined when calling getAccountActiveOrders().'
+            );
+        }
+
+        if (requestParameters['marketId'] == null) {
+            throw new runtime.RequiredError(
+                'marketId',
+                'Required parameter "marketId" was null or undefined when calling getAccountActiveOrders().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['accountIndex'] != null) {
+            queryParameters['account_index'] = requestParameters['accountIndex'];
+        }
+
+        if (requestParameters['subAccountIndex'] != null) {
+            queryParameters['sub_account_index'] = requestParameters['subAccountIndex'];
+        }
+
+        if (requestParameters['marketId'] != null) {
+            queryParameters['market_id'] = requestParameters['marketId'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/api/v1/accountActiveOrders`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => OrdersFromJSON(jsonValue));
+    }
+
+    /**
+     * Get account active orders
+     */
+    async getAccountActiveOrders(requestParameters: GetAccountActiveOrdersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Orders> {
+        const response = await this.getAccountActiveOrdersRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Get account active orders
+     */
+    async getAccountInactiveOrdersRaw(requestParameters: GetAccountInactiveOrdersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Orders>> {
+        if (requestParameters['accountIndex'] == null) {
+            throw new runtime.RequiredError(
+                'accountIndex',
+                'Required parameter "accountIndex" was null or undefined when calling getAccountInactiveOrders().'
+            );
+        }
+
+        if (requestParameters['subAccountIndex'] == null) {
+            throw new runtime.RequiredError(
+                'subAccountIndex',
+                'Required parameter "subAccountIndex" was null or undefined when calling getAccountInactiveOrders().'
+            );
+        }
+
+        if (requestParameters['filter'] == null) {
+            throw new runtime.RequiredError(
+                'filter',
+                'Required parameter "filter" was null or undefined when calling getAccountInactiveOrders().'
+            );
+        }
+
+        if (requestParameters['limit'] == null) {
+            throw new runtime.RequiredError(
+                'limit',
+                'Required parameter "limit" was null or undefined when calling getAccountInactiveOrders().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['accountIndex'] != null) {
+            queryParameters['account_index'] = requestParameters['accountIndex'];
+        }
+
+        if (requestParameters['subAccountIndex'] != null) {
+            queryParameters['sub_account_index'] = requestParameters['subAccountIndex'];
+        }
+
+        if (requestParameters['filter'] != null) {
+            queryParameters['filter'] = requestParameters['filter'];
+        }
+
+        if (requestParameters['marketId'] != null) {
+            queryParameters['market_id'] = requestParameters['marketId'];
+        }
+
+        if (requestParameters['cursor'] != null) {
+            queryParameters['cursor'] = requestParameters['cursor'];
+        }
+
+        if (requestParameters['limit'] != null) {
+            queryParameters['limit'] = requestParameters['limit'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/api/v1/accountInactiveOrders`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => OrdersFromJSON(jsonValue));
+    }
+
+    /**
+     * Get account active orders
+     */
+    async getAccountInactiveOrders(requestParameters: GetAccountInactiveOrdersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Orders> {
+        const response = await this.getAccountInactiveOrdersRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Get account orders
+     */
+    async getAccountOrdersRaw(requestParameters: GetAccountOrdersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Orders>> {
+        if (requestParameters['accountIndex'] == null) {
+            throw new runtime.RequiredError(
+                'accountIndex',
+                'Required parameter "accountIndex" was null or undefined when calling getAccountOrders().'
+            );
+        }
+
+        if (requestParameters['marketId'] == null) {
+            throw new runtime.RequiredError(
+                'marketId',
+                'Required parameter "marketId" was null or undefined when calling getAccountOrders().'
+            );
+        }
+
+        if (requestParameters['limit'] == null) {
+            throw new runtime.RequiredError(
+                'limit',
+                'Required parameter "limit" was null or undefined when calling getAccountOrders().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['accountIndex'] != null) {
+            queryParameters['account_index'] = requestParameters['accountIndex'];
+        }
+
+        if (requestParameters['marketId'] != null) {
+            queryParameters['market_id'] = requestParameters['marketId'];
+        }
+
+        if (requestParameters['cursor'] != null) {
+            queryParameters['cursor'] = requestParameters['cursor'];
+        }
+
+        if (requestParameters['limit'] != null) {
+            queryParameters['limit'] = requestParameters['limit'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/api/v1/accountOrders`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => OrdersFromJSON(jsonValue));
+    }
+
+    /**
+     * Get account orders
+     */
+    async getAccountOrders(requestParameters: GetAccountOrdersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Orders> {
+        const response = await this.getAccountOrdersRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Get exchange stats
+     */
+    async getExchangeStatsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ExchangeStats>> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/api/v1/exchangeStats`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ExchangeStatsFromJSON(jsonValue));
+    }
+
+    /**
+     * Get exchange stats
+     */
+    async getExchangeStats(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ExchangeStats> {
+        const response = await this.getExchangeStatsRaw(initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Get order books metadata
+     */
+    async getOrderBookDetailsRaw(requestParameters: GetOrderBookDetailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderBookDetails>> {
+        if (requestParameters['filter'] == null) {
+            throw new runtime.RequiredError(
+                'filter',
+                'Required parameter "filter" was null or undefined when calling getOrderBookDetails().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['filter'] != null) {
+            queryParameters['filter'] = requestParameters['filter'];
+        }
+
+        if (requestParameters['marketId'] != null) {
+            queryParameters['market_id'] = requestParameters['marketId'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/api/v1/orderBookDetails`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => OrderBookDetailsFromJSON(jsonValue));
+    }
+
+    /**
+     * Get order books metadata
+     */
+    async getOrderBookDetails(requestParameters: GetOrderBookDetailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderBookDetails> {
+        const response = await this.getOrderBookDetailsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Get order book orders
+     */
+    async getOrderBookOrdersRaw(requestParameters: GetOrderBookOrdersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderBookOrders>> {
+        if (requestParameters['marketId'] == null) {
+            throw new runtime.RequiredError(
+                'marketId',
+                'Required parameter "marketId" was null or undefined when calling getOrderBookOrders().'
+            );
+        }
+
+        if (requestParameters['limit'] == null) {
+            throw new runtime.RequiredError(
+                'limit',
+                'Required parameter "limit" was null or undefined when calling getOrderBookOrders().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['marketId'] != null) {
+            queryParameters['market_id'] = requestParameters['marketId'];
+        }
+
+        if (requestParameters['limit'] != null) {
+            queryParameters['limit'] = requestParameters['limit'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/api/v1/orderBookOrders`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => OrderBookOrdersFromJSON(jsonValue));
+    }
+
+    /**
+     * Get order book orders
+     */
+    async getOrderBookOrders(requestParameters: GetOrderBookOrdersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderBookOrders> {
+        const response = await this.getOrderBookOrdersRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Get order books metadata
+     */
+    async getOrderBooksRaw(requestParameters: GetOrderBooksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderBooks>> {
+        if (requestParameters['filter'] == null) {
+            throw new runtime.RequiredError(
+                'filter',
+                'Required parameter "filter" was null or undefined when calling getOrderBooks().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['filter'] != null) {
+            queryParameters['filter'] = requestParameters['filter'];
+        }
+
+        if (requestParameters['marketId'] != null) {
+            queryParameters['market_id'] = requestParameters['marketId'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/api/v1/orderBooks`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => OrderBooksFromJSON(jsonValue));
+    }
+
+    /**
+     * Get order books metadata
+     */
+    async getOrderBooks(requestParameters: GetOrderBooksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderBooks> {
+        const response = await this.getOrderBooksRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Get recent trades
+     */
+    async getRecentTradesRaw(requestParameters: GetRecentTradesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Trades>> {
+        if (requestParameters['marketId'] == null) {
+            throw new runtime.RequiredError(
+                'marketId',
+                'Required parameter "marketId" was null or undefined when calling getRecentTrades().'
+            );
+        }
+
+        if (requestParameters['limit'] == null) {
+            throw new runtime.RequiredError(
+                'limit',
+                'Required parameter "limit" was null or undefined when calling getRecentTrades().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['marketId'] != null) {
+            queryParameters['market_id'] = requestParameters['marketId'];
+        }
+
+        if (requestParameters['limit'] != null) {
+            queryParameters['limit'] = requestParameters['limit'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/api/v1/recentTrades`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => TradesFromJSON(jsonValue));
+    }
+
+    /**
+     * Get recent trades
+     */
+    async getRecentTrades(requestParameters: GetRecentTradesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Trades> {
+        const response = await this.getRecentTradesRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Get trades
+     */
+    async getTradesRaw(requestParameters: GetTradesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Trades>> {
+        if (requestParameters['marketId'] == null) {
+            throw new runtime.RequiredError(
+                'marketId',
+                'Required parameter "marketId" was null or undefined when calling getTrades().'
+            );
+        }
+
+        if (requestParameters['by'] == null) {
+            throw new runtime.RequiredError(
+                'by',
+                'Required parameter "by" was null or undefined when calling getTrades().'
+            );
+        }
+
+        if (requestParameters['from'] == null) {
+            throw new runtime.RequiredError(
+                'from',
+                'Required parameter "from" was null or undefined when calling getTrades().'
+            );
+        }
+
+        if (requestParameters['limit'] == null) {
+            throw new runtime.RequiredError(
+                'limit',
+                'Required parameter "limit" was null or undefined when calling getTrades().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['marketId'] != null) {
+            queryParameters['market_id'] = requestParameters['marketId'];
+        }
+
+        if (requestParameters['orderIndex'] != null) {
+            queryParameters['order_index'] = requestParameters['orderIndex'];
+        }
+
+        if (requestParameters['by'] != null) {
+            queryParameters['by'] = requestParameters['by'];
+        }
+
+        if (requestParameters['from'] != null) {
+            queryParameters['from'] = requestParameters['from'];
+        }
+
+        if (requestParameters['limit'] != null) {
+            queryParameters['limit'] = requestParameters['limit'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/api/v1/trades`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => TradesFromJSON(jsonValue));
+    }
+
+    /**
+     * Get trades
+     */
+    async getTrades(requestParameters: GetTradesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Trades> {
+        const response = await this.getTradesRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}
+
+/**
+ * @export
+ */
+export const GetAccountInactiveOrdersFilterEnum = {
+    MarketId: 'market_id',
+    All: 'all'
+} as const;
+export type GetAccountInactiveOrdersFilterEnum = typeof GetAccountInactiveOrdersFilterEnum[keyof typeof GetAccountInactiveOrdersFilterEnum];
+/**
+ * @export
+ */
+export const GetOrderBookDetailsFilterEnum = {
+    MarketId: 'market_id',
+    All: 'all'
+} as const;
+export type GetOrderBookDetailsFilterEnum = typeof GetOrderBookDetailsFilterEnum[keyof typeof GetOrderBookDetailsFilterEnum];
+/**
+ * @export
+ */
+export const GetOrderBooksFilterEnum = {
+    MarketId: 'market_id',
+    All: 'all'
+} as const;
+export type GetOrderBooksFilterEnum = typeof GetOrderBooksFilterEnum[keyof typeof GetOrderBooksFilterEnum];
+/**
+ * @export
+ */
+export const GetTradesByEnum = {
+    BlockHeight: 'block_height',
+    Timestamp: 'timestamp',
+    TradeId: 'trade_id'
+} as const;
+export type GetTradesByEnum = typeof GetTradesByEnum[keyof typeof GetTradesByEnum];

package/apis/RelayerApi.ts

@@ -0,0 +1,95 @@
+/* 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 {
+  MarketSig,
+} from '../models/index';
+import {
+    MarketSigFromJSON,
+    MarketSigToJSON,
+} from '../models/index';
+
+export interface GetMarketSigRequest {
+    marketId: number;
+    isAsk: boolean;
+    baseAmount: number;
+}
+
+/**
+ * 
+ */
+export class RelayerApi extends runtime.BaseAPI {
+
+    /**
+     * Get Market Signature
+     */
+    async getMarketSigRaw(requestParameters: GetMarketSigRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MarketSig>> {
+        if (requestParameters['marketId'] == null) {
+            throw new runtime.RequiredError(
+                'marketId',
+                'Required parameter "marketId" was null or undefined when calling getMarketSig().'
+            );
+        }
+
+        if (requestParameters['isAsk'] == null) {
+            throw new runtime.RequiredError(
+                'isAsk',
+                'Required parameter "isAsk" was null or undefined when calling getMarketSig().'
+            );
+        }
+
+        if (requestParameters['baseAmount'] == null) {
+            throw new runtime.RequiredError(
+                'baseAmount',
+                'Required parameter "baseAmount" was null or undefined when calling getMarketSig().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['marketId'] != null) {
+            queryParameters['market_id'] = requestParameters['marketId'];
+        }
+
+        if (requestParameters['isAsk'] != null) {
+            queryParameters['is_ask'] = requestParameters['isAsk'];
+        }
+
+        if (requestParameters['baseAmount'] != null) {
+            queryParameters['base_amount'] = requestParameters['baseAmount'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/api/v1/quote`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => MarketSigFromJSON(jsonValue));
+    }
+
+    /**
+     * Get Market Signature
+     */
+    async getMarketSig(requestParameters: GetMarketSigRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MarketSig> {
+        const response = await this.getMarketSigRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}