zklighter-perps 1.0.102 → 1.0.103

package/.circleci/config.yml

@@ -13,8 +13,7 @@ jobs:
       - run:
           name: Clone zklighter-perps repository
           command: |
-            git clone https://${GITHUB_TOKEN}@github.com/elliottech/zklighter-perps.git
-            git checkout << pipeline.parameters.BE_BRANCH >>
+            git clone -b << pipeline.parameters.BE_BRANCH >> --depth 1 https://${GITHUB_TOKEN}@github.com/elliottech/zklighter-perps.git
 
       - run:
           name: Download goctl-swagger binary
@@ -129,7 +128,9 @@ jobs:
             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')
+            BE_BRANCH=<< pipeline.parameters.BE_BRANCH >>
+
+            PR_URL=$(curl -X POST -H "Authorization: Bearer ${GITHUB_TOKEN}" -d '{"title": "'$BE_BRANCH'", "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}
 
   update_npm_package:

package/.openapi-generator/FILES

@@ -33,6 +33,7 @@ models/ContractAddress.ts
 models/CreateIntentAddressResp.ts
 models/CurrentHeight.ts
 models/Cursor.ts
+models/DailyReturn.ts
 models/Deposit.ts
 models/DepositHistory.ts
 models/DepositHistoryItem.ts
@@ -63,6 +64,7 @@ models/OrderBooks.ts
 models/Orders.ts
 models/PnLEntry.ts
 models/PositionFunding.ts
+models/PositionFundings.ts
 models/PriceLevel.ts
 models/PublicPool.ts
 models/PublicPoolInfo.ts
@@ -95,6 +97,7 @@ models/ReqGetNextNonce.ts
 models/ReqGetOrderBookDetails.ts
 models/ReqGetOrderBookOrders.ts
 models/ReqGetOrderBooks.ts
+models/ReqGetPositionFunding.ts
 models/ReqGetPublicPools.ts
 models/ReqGetRangeWithCursor.ts
 models/ReqGetRangeWithIndex.ts
@@ -109,7 +112,6 @@ models/ReqIsWhitelisted.ts
 models/RespGetFastBridgeInfo.ts
 models/RespGetFastwithdrawalInfo.ts
 models/ResultCode.ts
-models/Return.ts
 models/SimpleOrder.ts
 models/Status.ts
 models/SubAccounts.ts

package/apis/AccountApi.ts

@@ -22,6 +22,7 @@ import type {
   FeeBucket,
   IsWhitelisted,
   Leaderboard,
+  PositionFundings,
   PublicPools,
   ResultCode,
   SubAccounts,
@@ -41,6 +42,8 @@ import {
     IsWhitelistedToJSON,
     LeaderboardFromJSON,
     LeaderboardToJSON,
+    PositionFundingsFromJSON,
+    PositionFundingsToJSON,
     PublicPoolsFromJSON,
     PublicPoolsToJSON,
     ResultCodeFromJSON,
@@ -96,6 +99,13 @@ export interface PnlRequest {
     ignore_transfers?: boolean;
 }
 
+export interface PositionFundingRequest {
+    account_index: number;
+    limit: number;
+    market_id?: number;
+    cursor?: string;
+}
+
 export interface PublicPoolsRequest {
     index: number;
     limit: number;
@@ -545,6 +555,64 @@ export class AccountApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Get accounts position fundings
+     * positionFunding
+     */
+    async positionFundingRaw(requestParameters: PositionFundingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PositionFundings>> {
+        if (requestParameters['account_index'] == null) {
+            throw new runtime.RequiredError(
+                'account_index',
+                'Required parameter "account_index" was null or undefined when calling positionFunding().'
+            );
+        }
+
+        if (requestParameters['limit'] == null) {
+            throw new runtime.RequiredError(
+                'limit',
+                'Required parameter "limit" was null or undefined when calling positionFunding().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['account_index'] != null) {
+            queryParameters['account_index'] = requestParameters['account_index'];
+        }
+
+        if (requestParameters['market_id'] != null) {
+            queryParameters['market_id'] = requestParameters['market_id'];
+        }
+
+        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/positionFunding`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => PositionFundingsFromJSON(jsonValue));
+    }
+
+    /**
+     * Get accounts position fundings
+     * positionFunding
+     */
+    async positionFunding(requestParameters: PositionFundingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PositionFundings> {
+        const response = await this.positionFundingRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Get public pools
      * publicPools

package/models/DailyReturn.ts

@@ -0,0 +1,70 @@
+/* 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 DailyReturn
+ */
+export interface DailyReturn {
+    /**
+     * 
+     * @type {number}
+     * @memberof DailyReturn
+     */
+    timestamp: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof DailyReturn
+     */
+    daily_return: number;
+}
+
+/**
+ * Check if a given object implements the DailyReturn interface.
+ */
+export function instanceOfDailyReturn(value: object): value is DailyReturn {
+    if (!('timestamp' in value) || value['timestamp'] === undefined) return false;
+    if (!('daily_return' in value) || value['daily_return'] === undefined) return false;
+    return true;
+}
+
+export function DailyReturnFromJSON(json: any): DailyReturn {
+    return DailyReturnFromJSONTyped(json, false);
+}
+
+export function DailyReturnFromJSONTyped(json: any, ignoreDiscriminator: boolean): DailyReturn {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'timestamp': json['timestamp'],
+        'daily_return': json['daily_return'],
+    };
+}
+
+export function DailyReturnToJSON(value?: DailyReturn | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'timestamp': value['timestamp'],
+        'daily_return': value['daily_return'],
+    };
+}
+

package/models/PositionFundings.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 { PositionFunding } from './PositionFunding';
+import {
+    PositionFundingFromJSON,
+    PositionFundingFromJSONTyped,
+    PositionFundingToJSON,
+} from './PositionFunding';
+
+/**
+ * 
+ * @export
+ * @interface PositionFundings
+ */
+export interface PositionFundings {
+    /**
+     * 
+     * @type {number}
+     * @memberof PositionFundings
+     */
+    code: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof PositionFundings
+     */
+    message?: string;
+    /**
+     * 
+     * @type {Array<PositionFunding>}
+     * @memberof PositionFundings
+     */
+    position_fundings: Array<PositionFunding>;
+    /**
+     * 
+     * @type {string}
+     * @memberof PositionFundings
+     */
+    next_cursor?: string;
+}
+
+/**
+ * Check if a given object implements the PositionFundings interface.
+ */
+export function instanceOfPositionFundings(value: object): value is PositionFundings {
+    if (!('code' in value) || value['code'] === undefined) return false;
+    if (!('position_fundings' in value) || value['position_fundings'] === undefined) return false;
+    return true;
+}
+
+export function PositionFundingsFromJSON(json: any): PositionFundings {
+    return PositionFundingsFromJSONTyped(json, false);
+}
+
+export function PositionFundingsFromJSONTyped(json: any, ignoreDiscriminator: boolean): PositionFundings {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'code': json['code'],
+        'message': json['message'] == null ? undefined : json['message'],
+        'position_fundings': ((json['position_fundings'] as Array<any>).map(PositionFundingFromJSON)),
+        'next_cursor': json['next_cursor'] == null ? undefined : json['next_cursor'],
+    };
+}
+
+export function PositionFundingsToJSON(value?: PositionFundings | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'code': value['code'],
+        'message': value['message'],
+        'position_fundings': ((value['position_fundings'] as Array<any>).map(PositionFundingToJSON)),
+        'next_cursor': value['next_cursor'],
+    };
+}
+

package/models/PublicPoolInfo.ts

@@ -13,12 +13,12 @@
  */
 
 import { mapValues } from '../runtime';
-import type { Return } from './Return';
+import type { DailyReturn } from './DailyReturn';
 import {
-    ReturnFromJSON,
-    ReturnFromJSONTyped,
-    ReturnToJSON,
-} from './Return';
+    DailyReturnFromJSON,
+    DailyReturnFromJSONTyped,
+    DailyReturnToJSON,
+} from './DailyReturn';
 
 /**
  * 
@@ -82,10 +82,10 @@ export interface PublicPoolInfo {
     annual_percentage_yield: number;
     /**
      * 
-     * @type {Array<Return>}
+     * @type {Array<DailyReturn>}
      * @memberof PublicPoolInfo
      */
-    returns: Array<Return>;
+    daily_returns: Array<DailyReturn>;
 }
 
 /**
@@ -101,7 +101,7 @@ export function instanceOfPublicPoolInfo(value: object): value is PublicPoolInfo
     if (!('share_price_7d' in value) || value['share_price_7d'] === undefined) return false;
     if (!('share_price_30d' in value) || value['share_price_30d'] === undefined) return false;
     if (!('annual_percentage_yield' in value) || value['annual_percentage_yield'] === undefined) return false;
-    if (!('returns' in value) || value['returns'] === undefined) return false;
+    if (!('daily_returns' in value) || value['daily_returns'] === undefined) return false;
     return true;
 }
 
@@ -124,7 +124,7 @@ export function PublicPoolInfoFromJSONTyped(json: any, ignoreDiscriminator: bool
         'share_price_7d': json['share_price_7d'],
         'share_price_30d': json['share_price_30d'],
         'annual_percentage_yield': json['annual_percentage_yield'],
-        'returns': ((json['returns'] as Array<any>).map(ReturnFromJSON)),
+        'daily_returns': ((json['daily_returns'] as Array<any>).map(DailyReturnFromJSON)),
     };
 }
 
@@ -143,7 +143,7 @@ export function PublicPoolInfoToJSON(value?: PublicPoolInfo | null): any {
         'share_price_7d': value['share_price_7d'],
         'share_price_30d': value['share_price_30d'],
         'annual_percentage_yield': value['annual_percentage_yield'],
-        'returns': ((value['returns'] as Array<any>).map(ReturnToJSON)),
+        'daily_returns': ((value['daily_returns'] as Array<any>).map(DailyReturnToJSON)),
     };
 }
 

package/models/ReqGetPositionFunding.ts

@@ -0,0 +1,86 @@
+/* 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 ReqGetPositionFunding
+ */
+export interface ReqGetPositionFunding {
+    /**
+     * 
+     * @type {number}
+     * @memberof ReqGetPositionFunding
+     */
+    account_index: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof ReqGetPositionFunding
+     */
+    market_id?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof ReqGetPositionFunding
+     */
+    cursor?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof ReqGetPositionFunding
+     */
+    limit: number;
+}
+
+/**
+ * Check if a given object implements the ReqGetPositionFunding interface.
+ */
+export function instanceOfReqGetPositionFunding(value: object): value is ReqGetPositionFunding {
+    if (!('account_index' in value) || value['account_index'] === undefined) return false;
+    if (!('limit' in value) || value['limit'] === undefined) return false;
+    return true;
+}
+
+export function ReqGetPositionFundingFromJSON(json: any): ReqGetPositionFunding {
+    return ReqGetPositionFundingFromJSONTyped(json, false);
+}
+
+export function ReqGetPositionFundingFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReqGetPositionFunding {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'account_index': json['account_index'],
+        'market_id': json['market_id'] == null ? undefined : json['market_id'],
+        'cursor': json['cursor'] == null ? undefined : json['cursor'],
+        'limit': json['limit'],
+    };
+}
+
+export function ReqGetPositionFundingToJSON(value?: ReqGetPositionFunding | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'account_index': value['account_index'],
+        'market_id': value['market_id'],
+        'cursor': value['cursor'],
+        'limit': value['limit'],
+    };
+}
+

package/models/index.ts

@@ -22,6 +22,7 @@ export * from './ContractAddress';
 export * from './CreateIntentAddressResp';
 export * from './CurrentHeight';
 export * from './Cursor';
+export * from './DailyReturn';
 export * from './Deposit';
 export * from './DepositHistory';
 export * from './DepositHistoryItem';
@@ -52,6 +53,7 @@ export * from './OrderBooks';
 export * from './Orders';
 export * from './PnLEntry';
 export * from './PositionFunding';
+export * from './PositionFundings';
 export * from './PriceLevel';
 export * from './PublicPool';
 export * from './PublicPoolInfo';
@@ -84,6 +86,7 @@ export * from './ReqGetNextNonce';
 export * from './ReqGetOrderBookDetails';
 export * from './ReqGetOrderBookOrders';
 export * from './ReqGetOrderBooks';
+export * from './ReqGetPositionFunding';
 export * from './ReqGetPublicPools';
 export * from './ReqGetRangeWithCursor';
 export * from './ReqGetRangeWithIndex';
@@ -98,7 +101,6 @@ export * from './ReqIsWhitelisted';
 export * from './RespGetFastBridgeInfo';
 export * from './RespGetFastwithdrawalInfo';
 export * from './ResultCode';
-export * from './Return';
 export * from './SimpleOrder';
 export * from './Status';
 export * from './SubAccounts';

package/openapi.json

@@ -1686,6 +1686,65 @@
         "description": "Get account PnL chart"
       }
     },
+    "/api/v1/positionFunding": {
+      "get": {
+        "summary": "positionFunding",
+        "operationId": "positionFunding",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/PositionFundings"
+            }
+          },
+          "400": {
+            "description": "Bad request",
+            "schema": {
+              "$ref": "#/definitions/ResultCode"
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "account_index",
+            "in": "query",
+            "required": true,
+            "type": "integer",
+            "format": "int64"
+          },
+          {
+            "name": "market_id",
+            "in": "query",
+            "required": false,
+            "type": "integer",
+            "format": "uint8",
+            "default": "255"
+          },
+          {
+            "name": "cursor",
+            "in": "query",
+            "required": false,
+            "type": "string"
+          },
+          {
+            "name": "limit",
+            "in": "query",
+            "required": true,
+            "type": "integer",
+            "format": "int64",
+            "minimum": 1,
+            "maximum": 100
+          }
+        ],
+        "tags": [
+          "account"
+        ],
+        "consumes": [
+          "multipart/form-data"
+        ],
+        "description": "Get accounts position fundings"
+      }
+    },
     "/api/v1/publicPools": {
       "get": {
         "summary": "publicPools",
@@ -3172,6 +3231,26 @@
       },
       "title": "Cursor"
     },
+    "DailyReturn": {
+      "type": "object",
+      "properties": {
+        "timestamp": {
+          "type": "integer",
+          "format": "int64",
+          "example": "1640995200"
+        },
+        "daily_return": {
+          "type": "number",
+          "format": "double",
+          "example": "0.0001"
+        }
+      },
+      "title": "DailyReturn",
+      "required": [
+        "timestamp",
+        "daily_return"
+      ]
+    },
     "Deposit": {
       "type": "object",
       "properties": {
@@ -4773,6 +4852,33 @@
         "position_side"
       ]
     },
+    "PositionFundings": {
+      "type": "object",
+      "properties": {
+        "code": {
+          "type": "integer",
+          "format": "int32",
+          "example": "200"
+        },
+        "message": {
+          "type": "string"
+        },
+        "position_fundings": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/PositionFunding"
+          }
+        },
+        "next_cursor": {
+          "type": "string"
+        }
+      },
+      "title": "PositionFundings",
+      "required": [
+        "code",
+        "position_fundings"
+      ]
+    },
     "PriceLevel": {
       "type": "object",
       "properties": {
@@ -4934,10 +5040,10 @@
           "format": "double",
           "example": "20.5000"
         },
-        "returns": {
+        "daily_returns": {
           "type": "array",
           "items": {
-            "$ref": "#/definitions/Return"
+            "$ref": "#/definitions/DailyReturn"
           }
         }
       },
@@ -4952,7 +5058,7 @@
         "share_price_7d",
         "share_price_30d",
         "annual_percentage_yield",
-        "returns"
+        "daily_returns"
       ]
     },
     "PublicPoolShare": {
@@ -5769,6 +5875,34 @@
       },
       "title": "ReqGetOrderBooks"
     },
+    "ReqGetPositionFunding": {
+      "type": "object",
+      "properties": {
+        "account_index": {
+          "type": "integer",
+          "format": "int64"
+        },
+        "market_id": {
+          "type": "integer",
+          "format": "uint8",
+          "default": "255"
+        },
+        "cursor": {
+          "type": "string"
+        },
+        "limit": {
+          "type": "integer",
+          "format": "int64",
+          "maximum": 100,
+          "minimum": 1
+        }
+      },
+      "title": "ReqGetPositionFunding",
+      "required": [
+        "account_index",
+        "limit"
+      ]
+    },
     "ReqGetPublicPools": {
       "type": "object",
       "properties": {
@@ -6191,26 +6325,6 @@
         "code"
       ]
     },
-    "Return": {
-      "type": "object",
-      "properties": {
-        "timestamp": {
-          "type": "integer",
-          "format": "int64",
-          "example": "1640995200"
-        },
-        "return": {
-          "type": "number",
-          "format": "double",
-          "example": "0.0001"
-        }
-      },
-      "title": "Return",
-      "required": [
-        "timestamp",
-        "return"
-      ]
-    },
     "SimpleOrder": {
       "type": "object",
       "properties": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zklighter-perps",
-  "version": "1.0.102",
+  "version": "1.0.103",
   "description": "zkLighter Perps SDK",
   "main": "index.ts",
   "directories": {