zklighter-perps 1.0.0

package/.circleci/config.yml

@@ -0,0 +1,86 @@
+version: 2.1
+
+jobs:
+  load_openapi:
+    docker:
+      - image: cimg/base:2024.07
+    
+    working_directory: ~/project
+
+    steps:
+      - run:
+          name: Clone Python SDK
+          command: |
+            git clone https://${GITHUB_TOKEN}@github.com/elliottech/zklighter-perps-python.git
+
+      - persist_to_workspace:
+          root: ~/project/zklighter-perps-python
+          paths:
+            - openapi.json
+
+  update_ts_sdk_job:
+    docker:
+      - image: cimg/openjdk:21.0.2
+
+    working_directory: ~/project
+    
+    steps:
+      - checkout
+
+      - attach_workspace:
+          at: /tmp/workspace
+
+      - run:
+          name: Get openapi.json from workspace
+          command: |
+            cp /tmp/workspace/openapi.json .
+
+      - run:
+          name: Download OpenAPI Generator JAR
+          command: |
+            wget https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/7.7.0/openapi-generator-cli-7.7.0.jar -O openapi-generator-cli.jar
+            
+      - run:
+          name: Generate TS client using OpenAPI Generator
+          command: |
+            java -jar openapi-generator-cli.jar generate -i ./openapi.json -g typescript-fetch -o . -c config.yaml
+      - run:
+          name: push to new branch
+          command: |
+            git remote remove origin
+            git remote add origin https://${GITHUB_TOKEN}@github.com/elliottech/zklighter-perps-ts
+
+            git config --global user.email "hasan@circleci.com"
+            git config --global user.name "CircleCI Hasan"
+            export BRANCH_NAME=`date +%s`
+            git checkout -b $BRANCH_NAME
+            git add .
+            git commit -m "Update SDK"
+            git push origin $BRANCH_NAME
+
+            PR_URL=$(curl -X POST -H "Authorization: Bearer ${GITHUB_TOKEN}" -d '{"title": "Update SDK", "head": "'$BRANCH_NAME'", "base": "main"}' https://api.github.com/repos/elliottech/zklighter-perps-ts/pulls | jq -r '.html_url')
+            curl -X POST -H 'Content-type: application/json' --data '{"text":"TypeScript SDK has been updated. Check the PR here: '$PR_URL'", "type": "mrkdwn"}' ${SLACK_URL}
+
+parameters:
+  update_ts_sdk:
+    default: false
+    type: boolean
+
+
+workflows:
+  version: 2
+  update_ts_sdk:
+    when: << pipeline.parameters.update_ts_sdk >>
+    jobs:
+      - load_openapi:
+          filters:
+            branches:
+              only: main
+          
+      - update_ts_sdk_job:
+          requires:
+            - load_openapi
+          filters:
+            branches:
+              only: main
+          

package/.openapi-generator/FILES

@@ -0,0 +1,95 @@
+apis/AccountApi.ts
+apis/BlockApi.ts
+apis/CandlestickApi.ts
+apis/InfoApi.ts
+apis/OrderApi.ts
+apis/RelayerApi.ts
+apis/RootApi.ts
+apis/TransactionApi.ts
+apis/WsApi.ts
+apis/index.ts
+index.ts
+models/AccountMarketStats.ts
+models/AccountPnL.ts
+models/AccountPosition.ts
+models/AccountStats.ts
+models/Block.ts
+models/Blocks.ts
+models/Candlestick.ts
+models/Candlesticks.ts
+models/ContractAddress.ts
+models/CurrentHeight.ts
+models/Cursor.ts
+models/DetailedAccount.ts
+models/DetailedAccounts.ts
+models/EnrichedTx.ts
+models/ExchangeStats.ts
+models/Funding.ts
+models/Fundings.ts
+models/L1ProviderInfo.ts
+models/Layer1BasicInfo.ts
+models/Layer2BasicInfo.ts
+models/MainAccount.ts
+models/MainAccounts.ts
+models/MarketInfo.ts
+models/MarketSig.ts
+models/NextNonce.ts
+models/Order.ts
+models/OrderBook.ts
+models/OrderBookDepth.ts
+models/OrderBookDetail.ts
+models/OrderBookDetails.ts
+models/OrderBookOrders.ts
+models/OrderBookStats.ts
+models/OrderBooks.ts
+models/Orders.ts
+models/Permission.ts
+models/PnLEntry.ts
+models/PriceLevel.ts
+models/ReqDoFaucet.ts
+models/ReqGetAccount.ts
+models/ReqGetAccountActiveOrders.ts
+models/ReqGetAccountByL1Address.ts
+models/ReqGetAccountInactiveOrders.ts
+models/ReqGetAccountOrders.ts
+models/ReqGetAccountPendingTxs.ts
+models/ReqGetAccountPnL.ts
+models/ReqGetAccountTxs.ts
+models/ReqGetBlock.ts
+models/ReqGetBlockTxs.ts
+models/ReqGetByAccount.ts
+models/ReqGetCandlesticks.ts
+models/ReqGetFundings.ts
+models/ReqGetL1Tx.ts
+models/ReqGetMarketSig.ts
+models/ReqGetNextNonce.ts
+models/ReqGetOrderBookDetails.ts
+models/ReqGetOrderBookOrders.ts
+models/ReqGetOrderBooks.ts
+models/ReqGetPermission.ts
+models/ReqGetRangeWithCursor.ts
+models/ReqGetRangeWithIndex.ts
+models/ReqGetRangeWithIndexSortable.ts
+models/ReqGetRecentTrades.ts
+models/ReqGetRollbacks.ts
+models/ReqGetSubAccount.ts
+models/ReqGetTrades.ts
+models/ReqGetTx.ts
+models/ReqSearch.ts
+models/ResultCode.ts
+models/Rollback.ts
+models/Rollbacks.ts
+models/Search.ts
+models/SignBody.ts
+models/SimpleOrder.ts
+models/Status.ts
+models/SubAccount.ts
+models/SubAccounts.ts
+models/Trade.ts
+models/Trades.ts
+models/Tx.ts
+models/TxHash.ts
+models/Txs.ts
+models/ValidatorInfo.ts
+models/index.ts
+runtime.ts

package/.openapi-generator/VERSION

@@ -0,0 +1 @@
+7.7.0

package/.openapi-generator-ignore

@@ -0,0 +1,23 @@
+# OpenAPI Generator Ignore
+# Generated by openapi-generator https://github.com/openapitools/openapi-generator
+
+# Use this file to prevent files from being overwritten by the generator.
+# The patterns follow closely to .gitignore or .dockerignore.
+
+# As an example, the C# client generator defines ApiClient.cs.
+# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
+#ApiClient.cs
+
+# You can match any string of characters against a directory, file or extension with a single asterisk (*):
+#foo/*/qux
+# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
+
+# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
+#foo/**/qux
+# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
+
+# You can also negate patterns with an exclamation (!).
+# For example, you can ignore all files in a docs folder with the file extension .md:
+#docs/*.md
+# Then explicitly reverse the ignore rule for a single file:
+#!docs/README.md

package/apis/AccountApi.ts

@@ -0,0 +1,454 @@
+/* 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 {
+  AccountPnL,
+  DetailedAccounts,
+  MainAccounts,
+  Permission,
+  ResultCode,
+  SubAccounts,
+} from '../models/index';
+import {
+    AccountPnLFromJSON,
+    AccountPnLToJSON,
+    DetailedAccountsFromJSON,
+    DetailedAccountsToJSON,
+    MainAccountsFromJSON,
+    MainAccountsToJSON,
+    PermissionFromJSON,
+    PermissionToJSON,
+    ResultCodeFromJSON,
+    ResultCodeToJSON,
+    SubAccountsFromJSON,
+    SubAccountsToJSON,
+} from '../models/index';
+
+export interface DoFaucetRequest {
+    l1Address: string;
+}
+
+export interface GetAccountRequest {
+    by: GetAccountByEnum;
+    value: string;
+    subAccountIndex: number;
+}
+
+export interface GetAccountPnlRequest {
+    by: GetAccountPnlByEnum;
+    value: string;
+    resolution: GetAccountPnlResolutionEnum;
+    startTimestamp: number;
+    endTimestamp: number;
+    countBack: number;
+}
+
+export interface GetAccountsRequest {
+    limit: number;
+    index?: number;
+    sort?: GetAccountsSortEnum;
+}
+
+export interface GetAccountsByL1AddressRequest {
+    l1Address: string;
+}
+
+export interface GetPermissionRequest {
+    by: GetPermissionByEnum;
+    value: string;
+    txType: number;
+}
+
+/**
+ * 
+ */
+export class AccountApi extends runtime.BaseAPI {
+
+    /**
+     * Request funds from faucet
+     */
+    async doFaucetRaw(requestParameters: DoFaucetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ResultCode>> {
+        if (requestParameters['l1Address'] == null) {
+            throw new runtime.RequiredError(
+                'l1Address',
+                'Required parameter "l1Address" was null or undefined when calling doFaucet().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['l1Address'] != null) {
+            queryParameters['l1_address'] = requestParameters['l1Address'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/api/v1/faucet`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ResultCodeFromJSON(jsonValue));
+    }
+
+    /**
+     * Request funds from faucet
+     */
+    async doFaucet(requestParameters: DoFaucetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ResultCode> {
+        const response = await this.doFaucetRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Get account by main account\'s l1_address or index and sub account\'s index. Returns detailed account info
+     */
+    async getAccountRaw(requestParameters: GetAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DetailedAccounts>> {
+        if (requestParameters['by'] == null) {
+            throw new runtime.RequiredError(
+                'by',
+                'Required parameter "by" was null or undefined when calling getAccount().'
+            );
+        }
+
+        if (requestParameters['value'] == null) {
+            throw new runtime.RequiredError(
+                'value',
+                'Required parameter "value" was null or undefined when calling getAccount().'
+            );
+        }
+
+        if (requestParameters['subAccountIndex'] == null) {
+            throw new runtime.RequiredError(
+                'subAccountIndex',
+                'Required parameter "subAccountIndex" was null or undefined when calling getAccount().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['by'] != null) {
+            queryParameters['by'] = requestParameters['by'];
+        }
+
+        if (requestParameters['value'] != null) {
+            queryParameters['value'] = requestParameters['value'];
+        }
+
+        if (requestParameters['subAccountIndex'] != null) {
+            queryParameters['sub_account_index'] = requestParameters['subAccountIndex'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/api/v1/account`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => DetailedAccountsFromJSON(jsonValue));
+    }
+
+    /**
+     * Get account by main account\'s l1_address or index and sub account\'s index. Returns detailed account info
+     */
+    async getAccount(requestParameters: GetAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DetailedAccounts> {
+        const response = await this.getAccountRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Get account PnL chart
+     */
+    async getAccountPnlRaw(requestParameters: GetAccountPnlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AccountPnL>> {
+        if (requestParameters['by'] == null) {
+            throw new runtime.RequiredError(
+                'by',
+                'Required parameter "by" was null or undefined when calling getAccountPnl().'
+            );
+        }
+
+        if (requestParameters['value'] == null) {
+            throw new runtime.RequiredError(
+                'value',
+                'Required parameter "value" was null or undefined when calling getAccountPnl().'
+            );
+        }
+
+        if (requestParameters['resolution'] == null) {
+            throw new runtime.RequiredError(
+                'resolution',
+                'Required parameter "resolution" was null or undefined when calling getAccountPnl().'
+            );
+        }
+
+        if (requestParameters['startTimestamp'] == null) {
+            throw new runtime.RequiredError(
+                'startTimestamp',
+                'Required parameter "startTimestamp" was null or undefined when calling getAccountPnl().'
+            );
+        }
+
+        if (requestParameters['endTimestamp'] == null) {
+            throw new runtime.RequiredError(
+                'endTimestamp',
+                'Required parameter "endTimestamp" was null or undefined when calling getAccountPnl().'
+            );
+        }
+
+        if (requestParameters['countBack'] == null) {
+            throw new runtime.RequiredError(
+                'countBack',
+                'Required parameter "countBack" was null or undefined when calling getAccountPnl().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['by'] != null) {
+            queryParameters['by'] = requestParameters['by'];
+        }
+
+        if (requestParameters['value'] != null) {
+            queryParameters['value'] = requestParameters['value'];
+        }
+
+        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/pnl`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => AccountPnLFromJSON(jsonValue));
+    }
+
+    /**
+     * Get account PnL chart
+     */
+    async getAccountPnl(requestParameters: GetAccountPnlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AccountPnL> {
+        const response = await this.getAccountPnlRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Get accounts returns main accounts by account index
+     */
+    async getAccountsRaw(requestParameters: GetAccountsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MainAccounts>> {
+        if (requestParameters['limit'] == null) {
+            throw new runtime.RequiredError(
+                'limit',
+                'Required parameter "limit" was null or undefined when calling getAccounts().'
+            );
+        }
+
+        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/accounts`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => MainAccountsFromJSON(jsonValue));
+    }
+
+    /**
+     * Get accounts returns main accounts by account index
+     */
+    async getAccounts(requestParameters: GetAccountsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MainAccounts> {
+        const response = await this.getAccountsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Get accounts by l1_address returns main account and its sub accounts
+     */
+    async getAccountsByL1AddressRaw(requestParameters: GetAccountsByL1AddressRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SubAccounts>> {
+        if (requestParameters['l1Address'] == null) {
+            throw new runtime.RequiredError(
+                'l1Address',
+                'Required parameter "l1Address" was null or undefined when calling getAccountsByL1Address().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['l1Address'] != null) {
+            queryParameters['l1_address'] = requestParameters['l1Address'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/api/v1/accountsByL1Address`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => SubAccountsFromJSON(jsonValue));
+    }
+
+    /**
+     * Get accounts by l1_address returns main account and its sub accounts
+     */
+    async getAccountsByL1Address(requestParameters: GetAccountsByL1AddressRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SubAccounts> {
+        const response = await this.getAccountsByL1AddressRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Get permission by account\'s l1_address, index and tx_type
+     */
+    async getPermissionRaw(requestParameters: GetPermissionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Permission>> {
+        if (requestParameters['by'] == null) {
+            throw new runtime.RequiredError(
+                'by',
+                'Required parameter "by" was null or undefined when calling getPermission().'
+            );
+        }
+
+        if (requestParameters['value'] == null) {
+            throw new runtime.RequiredError(
+                'value',
+                'Required parameter "value" was null or undefined when calling getPermission().'
+            );
+        }
+
+        if (requestParameters['txType'] == null) {
+            throw new runtime.RequiredError(
+                'txType',
+                'Required parameter "txType" was null or undefined when calling getPermission().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['by'] != null) {
+            queryParameters['by'] = requestParameters['by'];
+        }
+
+        if (requestParameters['value'] != null) {
+            queryParameters['value'] = requestParameters['value'];
+        }
+
+        if (requestParameters['txType'] != null) {
+            queryParameters['tx_type'] = requestParameters['txType'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/api/v1/permission`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => PermissionFromJSON(jsonValue));
+    }
+
+    /**
+     * Get permission by account\'s l1_address, index and tx_type
+     */
+    async getPermission(requestParameters: GetPermissionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Permission> {
+        const response = await this.getPermissionRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}
+
+/**
+ * @export
+ */
+export const GetAccountByEnum = {
+    Index: 'index',
+    L1Address: 'l1_address'
+} as const;
+export type GetAccountByEnum = typeof GetAccountByEnum[keyof typeof GetAccountByEnum];
+/**
+ * @export
+ */
+export const GetAccountPnlByEnum = {
+    Index: 'index',
+    L1Address: 'l1_address'
+} as const;
+export type GetAccountPnlByEnum = typeof GetAccountPnlByEnum[keyof typeof GetAccountPnlByEnum];
+/**
+ * @export
+ */
+export const GetAccountPnlResolutionEnum = {
+    _1m: '1m',
+    _5m: '5m',
+    _15m: '15m',
+    _1h: '1h',
+    _4h: '4h',
+    _1d: '1d'
+} as const;
+export type GetAccountPnlResolutionEnum = typeof GetAccountPnlResolutionEnum[keyof typeof GetAccountPnlResolutionEnum];
+/**
+ * @export
+ */
+export const GetAccountsSortEnum = {
+    Asc: 'asc',
+    Desc: 'desc'
+} as const;
+export type GetAccountsSortEnum = typeof GetAccountsSortEnum[keyof typeof GetAccountsSortEnum];
+/**
+ * @export
+ */
+export const GetPermissionByEnum = {
+    Index: 'index',
+    L1Address: 'l1_address'
+} as const;
+export type GetPermissionByEnum = typeof GetPermissionByEnum[keyof typeof GetPermissionByEnum];