zklighter-perps 1.0.0

package/apis/BlockApi.ts

@@ -0,0 +1,178 @@
+/* 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 {
+  Blocks,
+  CurrentHeight,
+} from '../models/index';
+import {
+    BlocksFromJSON,
+    BlocksToJSON,
+    CurrentHeightFromJSON,
+    CurrentHeightToJSON,
+} from '../models/index';
+
+export interface GetBlockRequest {
+    by: GetBlockByEnum;
+    value: string;
+}
+
+export interface GetBlocksRequest {
+    limit: number;
+    index?: number;
+    sort?: GetBlocksSortEnum;
+}
+
+/**
+ * 
+ */
+export class BlockApi extends runtime.BaseAPI {
+
+    /**
+     * Get block by its height or commitment
+     */
+    async getBlockRaw(requestParameters: GetBlockRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blocks>> {
+        if (requestParameters['by'] == null) {
+            throw new runtime.RequiredError(
+                'by',
+                'Required parameter "by" was null or undefined when calling getBlock().'
+            );
+        }
+
+        if (requestParameters['value'] == null) {
+            throw new runtime.RequiredError(
+                'value',
+                'Required parameter "value" was null or undefined when calling getBlock().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['by'] != null) {
+            queryParameters['by'] = requestParameters['by'];
+        }
+
+        if (requestParameters['value'] != null) {
+            queryParameters['value'] = requestParameters['value'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/api/v1/block`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => BlocksFromJSON(jsonValue));
+    }
+
+    /**
+     * Get block by its height or commitment
+     */
+    async getBlock(requestParameters: GetBlockRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blocks> {
+        const response = await this.getBlockRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Get blocks
+     */
+    async getBlocksRaw(requestParameters: GetBlocksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blocks>> {
+        if (requestParameters['limit'] == null) {
+            throw new runtime.RequiredError(
+                'limit',
+                'Required parameter "limit" was null or undefined when calling getBlocks().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['index'] != null) {
+            queryParameters['index'] = requestParameters['index'];
+        }
+
+        if (requestParameters['limit'] != null) {
+            queryParameters['limit'] = requestParameters['limit'];
+        }
+
+        if (requestParameters['sort'] != null) {
+            queryParameters['sort'] = requestParameters['sort'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/api/v1/blocks`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => BlocksFromJSON(jsonValue));
+    }
+
+    /**
+     * Get blocks
+     */
+    async getBlocks(requestParameters: GetBlocksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blocks> {
+        const response = await this.getBlocksRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     */
+    async getCurrentHeightRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CurrentHeight>> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/api/v1/currentHeight`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => CurrentHeightFromJSON(jsonValue));
+    }
+
+    /**
+     */
+    async getCurrentHeight(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CurrentHeight> {
+        const response = await this.getCurrentHeightRaw(initOverrides);
+        return await response.value();
+    }
+
+}
+
+/**
+ * @export
+ */
+export const GetBlockByEnum = {
+    Commitment: 'commitment',
+    Height: 'height'
+} as const;
+export type GetBlockByEnum = typeof GetBlockByEnum[keyof typeof GetBlockByEnum];
+/**
+ * @export
+ */
+export const GetBlocksSortEnum = {
+    Asc: 'asc',
+    Desc: 'desc'
+} as const;
+export type GetBlocksSortEnum = typeof GetBlocksSortEnum[keyof typeof GetBlocksSortEnum];

package/apis/CandlestickApi.ts

@@ -0,0 +1,231 @@
+/* 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 {
+  Candlesticks,
+  Fundings,
+} from '../models/index';
+import {
+    CandlesticksFromJSON,
+    CandlesticksToJSON,
+    FundingsFromJSON,
+    FundingsToJSON,
+} from '../models/index';
+
+export interface GetCandlesticksRequest {
+    marketId: number;
+    resolution: GetCandlesticksResolutionEnum;
+    startTimestamp: number;
+    endTimestamp: number;
+    countBack: number;
+}
+
+export interface GetFundingsRequest {
+    marketId: number;
+    resolution: GetFundingsResolutionEnum;
+    startTimestamp: number;
+    endTimestamp: number;
+    countBack: number;
+}
+
+/**
+ * 
+ */
+export class CandlestickApi extends runtime.BaseAPI {
+
+    /**
+     * Get candlesticks
+     */
+    async getCandlesticksRaw(requestParameters: GetCandlesticksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Candlesticks>> {
+        if (requestParameters['marketId'] == null) {
+            throw new runtime.RequiredError(
+                'marketId',
+                'Required parameter "marketId" was null or undefined when calling getCandlesticks().'
+            );
+        }
+
+        if (requestParameters['resolution'] == null) {
+            throw new runtime.RequiredError(
+                'resolution',
+                'Required parameter "resolution" was null or undefined when calling getCandlesticks().'
+            );
+        }
+
+        if (requestParameters['startTimestamp'] == null) {
+            throw new runtime.RequiredError(
+                'startTimestamp',
+                'Required parameter "startTimestamp" was null or undefined when calling getCandlesticks().'
+            );
+        }
+
+        if (requestParameters['endTimestamp'] == null) {
+            throw new runtime.RequiredError(
+                'endTimestamp',
+                'Required parameter "endTimestamp" was null or undefined when calling getCandlesticks().'
+            );
+        }
+
+        if (requestParameters['countBack'] == null) {
+            throw new runtime.RequiredError(
+                'countBack',
+                'Required parameter "countBack" was null or undefined when calling getCandlesticks().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['marketId'] != null) {
+            queryParameters['market_id'] = requestParameters['marketId'];
+        }
+
+        if (requestParameters['resolution'] != null) {
+            queryParameters['resolution'] = requestParameters['resolution'];
+        }
+
+        if (requestParameters['startTimestamp'] != null) {
+            queryParameters['start_timestamp'] = requestParameters['startTimestamp'];
+        }
+
+        if (requestParameters['endTimestamp'] != null) {
+            queryParameters['end_timestamp'] = requestParameters['endTimestamp'];
+        }
+
+        if (requestParameters['countBack'] != null) {
+            queryParameters['count_back'] = requestParameters['countBack'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/api/v1/candlesticks`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => CandlesticksFromJSON(jsonValue));
+    }
+
+    /**
+     * Get candlesticks
+     */
+    async getCandlesticks(requestParameters: GetCandlesticksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Candlesticks> {
+        const response = await this.getCandlesticksRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Get fundings
+     */
+    async getFundingsRaw(requestParameters: GetFundingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Fundings>> {
+        if (requestParameters['marketId'] == null) {
+            throw new runtime.RequiredError(
+                'marketId',
+                'Required parameter "marketId" was null or undefined when calling getFundings().'
+            );
+        }
+
+        if (requestParameters['resolution'] == null) {
+            throw new runtime.RequiredError(
+                'resolution',
+                'Required parameter "resolution" was null or undefined when calling getFundings().'
+            );
+        }
+
+        if (requestParameters['startTimestamp'] == null) {
+            throw new runtime.RequiredError(
+                'startTimestamp',
+                'Required parameter "startTimestamp" was null or undefined when calling getFundings().'
+            );
+        }
+
+        if (requestParameters['endTimestamp'] == null) {
+            throw new runtime.RequiredError(
+                'endTimestamp',
+                'Required parameter "endTimestamp" was null or undefined when calling getFundings().'
+            );
+        }
+
+        if (requestParameters['countBack'] == null) {
+            throw new runtime.RequiredError(
+                'countBack',
+                'Required parameter "countBack" was null or undefined when calling getFundings().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['marketId'] != null) {
+            queryParameters['market_id'] = requestParameters['marketId'];
+        }
+
+        if (requestParameters['resolution'] != null) {
+            queryParameters['resolution'] = requestParameters['resolution'];
+        }
+
+        if (requestParameters['startTimestamp'] != null) {
+            queryParameters['start_timestamp'] = requestParameters['startTimestamp'];
+        }
+
+        if (requestParameters['endTimestamp'] != null) {
+            queryParameters['end_timestamp'] = requestParameters['endTimestamp'];
+        }
+
+        if (requestParameters['countBack'] != null) {
+            queryParameters['count_back'] = requestParameters['countBack'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/api/v1/fundings`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => FundingsFromJSON(jsonValue));
+    }
+
+    /**
+     * Get fundings
+     */
+    async getFundings(requestParameters: GetFundingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Fundings> {
+        const response = await this.getFundingsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}
+
+/**
+ * @export
+ */
+export const GetCandlesticksResolutionEnum = {
+    _1m: '1m',
+    _5m: '5m',
+    _15m: '15m',
+    _1h: '1h',
+    _4h: '4h',
+    _1d: '1d'
+} as const;
+export type GetCandlesticksResolutionEnum = typeof GetCandlesticksResolutionEnum[keyof typeof GetCandlesticksResolutionEnum];
+/**
+ * @export
+ */
+export const GetFundingsResolutionEnum = {
+    _1h: '1h'
+} as const;
+export type GetFundingsResolutionEnum = typeof GetFundingsResolutionEnum[keyof typeof GetFundingsResolutionEnum];

package/apis/InfoApi.ts

@@ -0,0 +1,197 @@
+/* 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 {
+  Layer1BasicInfo,
+  Layer2BasicInfo,
+  Rollbacks,
+  Search,
+} from '../models/index';
+import {
+    Layer1BasicInfoFromJSON,
+    Layer1BasicInfoToJSON,
+    Layer2BasicInfoFromJSON,
+    Layer2BasicInfoToJSON,
+    RollbacksFromJSON,
+    RollbacksToJSON,
+    SearchFromJSON,
+    SearchToJSON,
+} from '../models/index';
+
+export interface GetRollbacksRequest {
+    fromBlockHeight: number;
+    offset: number;
+    limit: number;
+}
+
+export interface SearchRequest {
+    keyword: string;
+}
+
+/**
+ * 
+ */
+export class InfoApi extends runtime.BaseAPI {
+
+    /**
+     * Get zklighter l1 general info, including contract address and rpc info
+     */
+    async getLayer1BasicInfoRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Layer1BasicInfo>> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/api/v1/layer1BasicInfo`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => Layer1BasicInfoFromJSON(jsonValue));
+    }
+
+    /**
+     * Get zklighter l1 general info, including contract address and rpc info
+     */
+    async getLayer1BasicInfo(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Layer1BasicInfo> {
+        const response = await this.getLayer1BasicInfoRaw(initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Get zklighter general info, including contract address, and count of transactions and active users
+     */
+    async getLayer2BasicInfoRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Layer2BasicInfo>> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/api/v1/layer2BasicInfo`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => Layer2BasicInfoFromJSON(jsonValue));
+    }
+
+    /**
+     * Get zklighter general info, including contract address, and count of transactions and active users
+     */
+    async getLayer2BasicInfo(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Layer2BasicInfo> {
+        const response = await this.getLayer2BasicInfoRaw(initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Get rollbacks
+     */
+    async getRollbacksRaw(requestParameters: GetRollbacksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Rollbacks>> {
+        if (requestParameters['fromBlockHeight'] == null) {
+            throw new runtime.RequiredError(
+                'fromBlockHeight',
+                'Required parameter "fromBlockHeight" was null or undefined when calling getRollbacks().'
+            );
+        }
+
+        if (requestParameters['offset'] == null) {
+            throw new runtime.RequiredError(
+                'offset',
+                'Required parameter "offset" was null or undefined when calling getRollbacks().'
+            );
+        }
+
+        if (requestParameters['limit'] == null) {
+            throw new runtime.RequiredError(
+                'limit',
+                'Required parameter "limit" was null or undefined when calling getRollbacks().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['fromBlockHeight'] != null) {
+            queryParameters['from_block_height'] = requestParameters['fromBlockHeight'];
+        }
+
+        if (requestParameters['offset'] != null) {
+            queryParameters['offset'] = requestParameters['offset'];
+        }
+
+        if (requestParameters['limit'] != null) {
+            queryParameters['limit'] = requestParameters['limit'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/api/v1/rollbacks`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => RollbacksFromJSON(jsonValue));
+    }
+
+    /**
+     * Get rollbacks
+     */
+    async getRollbacks(requestParameters: GetRollbacksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Rollbacks> {
+        const response = await this.getRollbacksRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Search with a specific keyword
+     */
+    async searchRaw(requestParameters: SearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Search>> {
+        if (requestParameters['keyword'] == null) {
+            throw new runtime.RequiredError(
+                'keyword',
+                'Required parameter "keyword" was null or undefined when calling search().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['keyword'] != null) {
+            queryParameters['keyword'] = requestParameters['keyword'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/api/v1/search`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => SearchFromJSON(jsonValue));
+    }
+
+    /**
+     * Search with a specific keyword
+     */
+    async search(requestParameters: SearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Search> {
+        const response = await this.searchRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}