zklighter-perps 1.0.155 → 1.0.156

package/.openapi-generator/FILES

@@ -78,6 +78,7 @@ models/PositionFundings.ts
 models/PriceLevel.ts
 models/PublicPool.ts
 models/PublicPoolInfo.ts
+models/PublicPoolMetadata.ts
 models/PublicPoolShare.ts
 models/PublicPools.ts
 models/ReferralCode.ts
@@ -113,6 +114,7 @@ models/ReqGetOrderBookOrders.ts
 models/ReqGetOrderBooks.ts
 models/ReqGetPositionFunding.ts
 models/ReqGetPublicPools.ts
+models/ReqGetPublicPoolsMetadata.ts
 models/ReqGetRangeWithCursor.ts
 models/ReqGetRangeWithIndex.ts
 models/ReqGetRangeWithIndexSortable.ts
@@ -129,6 +131,7 @@ models/ReqIsWhitelisted.ts
 models/RespChangeAccountTier.ts
 models/RespGetFastBridgeInfo.ts
 models/RespGetFastwithdrawalInfo.ts
+models/RespPublicPoolsMetadata.ts
 models/RespSendTx.ts
 models/RespSendTxBatch.ts
 models/RespWithdrawalDelay.ts

package/apis/AccountApi.ts

@@ -27,6 +27,7 @@ import type {
   PositionFundings,
   PublicPools,
   RespChangeAccountTier,
+  RespPublicPoolsMetadata,
   ResultCode,
   SubAccounts,
 } from '../models/index';
@@ -55,6 +56,8 @@ import {
     PublicPoolsToJSON,
     RespChangeAccountTierFromJSON,
     RespChangeAccountTierToJSON,
+    RespPublicPoolsMetadataFromJSON,
+    RespPublicPoolsMetadataToJSON,
     ResultCodeFromJSON,
     ResultCodeToJSON,
     SubAccountsFromJSON,
@@ -157,6 +160,15 @@ export interface PublicPoolsRequest {
     account_index?: number;
 }
 
+export interface PublicPoolsMetadataRequest {
+    index: number;
+    limit: number;
+    authorization?: string;
+    auth?: string;
+    filter?: PublicPoolsMetadataFilterEnum;
+    account_index?: number;
+}
+
 /**
  * 
  */
@@ -960,6 +972,72 @@ export class AccountApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Get public pools metadata
+     * publicPoolsMetadata
+     */
+    async publicPoolsMetadataRaw(requestParameters: PublicPoolsMetadataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RespPublicPoolsMetadata>> {
+        if (requestParameters['index'] == null) {
+            throw new runtime.RequiredError(
+                'index',
+                'Required parameter "index" was null or undefined when calling publicPoolsMetadata().'
+            );
+        }
+
+        if (requestParameters['limit'] == null) {
+            throw new runtime.RequiredError(
+                'limit',
+                'Required parameter "limit" was null or undefined when calling publicPoolsMetadata().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['auth'] != null) {
+            queryParameters['auth'] = requestParameters['auth'];
+        }
+
+        if (requestParameters['filter'] != null) {
+            queryParameters['filter'] = requestParameters['filter'];
+        }
+
+        if (requestParameters['index'] != null) {
+            queryParameters['index'] = requestParameters['index'];
+        }
+
+        if (requestParameters['limit'] != null) {
+            queryParameters['limit'] = requestParameters['limit'];
+        }
+
+        if (requestParameters['account_index'] != null) {
+            queryParameters['account_index'] = requestParameters['account_index'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (requestParameters['authorization'] != null) {
+            headerParameters['authorization'] = String(requestParameters['authorization']);
+        }
+
+        const response = await this.request({
+            path: `/api/v1/publicPoolsMetadata`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => RespPublicPoolsMetadataFromJSON(jsonValue));
+    }
+
+    /**
+     * Get public pools metadata
+     * publicPoolsMetadata
+     */
+    async publicPoolsMetadata(requestParameters: PublicPoolsMetadataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RespPublicPoolsMetadata> {
+        const response = await this.publicPoolsMetadataRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
 }
 
 /**
@@ -1025,3 +1103,13 @@ export const PublicPoolsFilterEnum = {
     AccountIndex: 'account_index'
 } as const;
 export type PublicPoolsFilterEnum = typeof PublicPoolsFilterEnum[keyof typeof PublicPoolsFilterEnum];
+/**
+ * @export
+ */
+export const PublicPoolsMetadataFilterEnum = {
+    All: 'all',
+    User: 'user',
+    Protocol: 'protocol',
+    AccountIndex: 'account_index'
+} as const;
+export type PublicPoolsMetadataFilterEnum = typeof PublicPoolsMetadataFilterEnum[keyof typeof PublicPoolsMetadataFilterEnum];

package/models/PublicPoolMetadata.ts

@@ -0,0 +1,156 @@
+/* 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 { PublicPoolShare } from './PublicPoolShare';
+import {
+    PublicPoolShareFromJSON,
+    PublicPoolShareFromJSONTyped,
+    PublicPoolShareToJSON,
+} from './PublicPoolShare';
+
+/**
+ * 
+ * @export
+ * @interface PublicPoolMetadata
+ */
+export interface PublicPoolMetadata {
+    /**
+     * 
+     * @type {number}
+     * @memberof PublicPoolMetadata
+     */
+    code: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof PublicPoolMetadata
+     */
+    message?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof PublicPoolMetadata
+     */
+    account_type: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof PublicPoolMetadata
+     */
+    name: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PublicPoolMetadata
+     */
+    l1_address: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof PublicPoolMetadata
+     */
+    annual_percentage_yield: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof PublicPoolMetadata
+     */
+    status: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof PublicPoolMetadata
+     */
+    operator_fee: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PublicPoolMetadata
+     */
+    total_asset_value: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof PublicPoolMetadata
+     */
+    total_shares: number;
+    /**
+     * 
+     * @type {PublicPoolShare}
+     * @memberof PublicPoolMetadata
+     */
+    account_share?: PublicPoolShare;
+}
+
+/**
+ * Check if a given object implements the PublicPoolMetadata interface.
+ */
+export function instanceOfPublicPoolMetadata(value: object): value is PublicPoolMetadata {
+    if (!('code' in value) || value['code'] === undefined) return false;
+    if (!('account_type' in value) || value['account_type'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('l1_address' in value) || value['l1_address'] === undefined) return false;
+    if (!('annual_percentage_yield' in value) || value['annual_percentage_yield'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    if (!('operator_fee' in value) || value['operator_fee'] === undefined) return false;
+    if (!('total_asset_value' in value) || value['total_asset_value'] === undefined) return false;
+    if (!('total_shares' in value) || value['total_shares'] === undefined) return false;
+    return true;
+}
+
+export function PublicPoolMetadataFromJSON(json: any): PublicPoolMetadata {
+    return PublicPoolMetadataFromJSONTyped(json, false);
+}
+
+export function PublicPoolMetadataFromJSONTyped(json: any, ignoreDiscriminator: boolean): PublicPoolMetadata {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'code': json['code'],
+        'message': json['message'] == null ? undefined : json['message'],
+        'account_type': json['account_type'],
+        'name': json['name'],
+        'l1_address': json['l1_address'],
+        'annual_percentage_yield': json['annual_percentage_yield'],
+        'status': json['status'],
+        'operator_fee': json['operator_fee'],
+        'total_asset_value': json['total_asset_value'],
+        'total_shares': json['total_shares'],
+        'account_share': json['account_share'] == null ? undefined : PublicPoolShareFromJSON(json['account_share']),
+    };
+}
+
+export function PublicPoolMetadataToJSON(value?: PublicPoolMetadata | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'code': value['code'],
+        'message': value['message'],
+        'account_type': value['account_type'],
+        'name': value['name'],
+        'l1_address': value['l1_address'],
+        'annual_percentage_yield': value['annual_percentage_yield'],
+        'status': value['status'],
+        'operator_fee': value['operator_fee'],
+        'total_asset_value': value['total_asset_value'],
+        'total_shares': value['total_shares'],
+        'account_share': PublicPoolShareToJSON(value['account_share']),
+    };
+}
+

package/models/ReqGetPublicPoolsMetadata.ts

@@ -0,0 +1,107 @@
+/* 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 ReqGetPublicPoolsMetadata
+ */
+export interface ReqGetPublicPoolsMetadata {
+    /**
+     * 
+     * @type {string}
+     * @memberof ReqGetPublicPoolsMetadata
+     */
+    auth?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ReqGetPublicPoolsMetadata
+     */
+    filter?: ReqGetPublicPoolsMetadataFilterEnum;
+    /**
+     * 
+     * @type {number}
+     * @memberof ReqGetPublicPoolsMetadata
+     */
+    index: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof ReqGetPublicPoolsMetadata
+     */
+    limit: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof ReqGetPublicPoolsMetadata
+     */
+    account_index?: number;
+}
+
+
+/**
+ * @export
+ */
+export const ReqGetPublicPoolsMetadataFilterEnum = {
+    All: 'all',
+    User: 'user',
+    Protocol: 'protocol',
+    AccountIndex: 'account_index'
+} as const;
+export type ReqGetPublicPoolsMetadataFilterEnum = typeof ReqGetPublicPoolsMetadataFilterEnum[keyof typeof ReqGetPublicPoolsMetadataFilterEnum];
+
+
+/**
+ * Check if a given object implements the ReqGetPublicPoolsMetadata interface.
+ */
+export function instanceOfReqGetPublicPoolsMetadata(value: object): value is ReqGetPublicPoolsMetadata {
+    if (!('index' in value) || value['index'] === undefined) return false;
+    if (!('limit' in value) || value['limit'] === undefined) return false;
+    return true;
+}
+
+export function ReqGetPublicPoolsMetadataFromJSON(json: any): ReqGetPublicPoolsMetadata {
+    return ReqGetPublicPoolsMetadataFromJSONTyped(json, false);
+}
+
+export function ReqGetPublicPoolsMetadataFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReqGetPublicPoolsMetadata {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'auth': json['auth'] == null ? undefined : json['auth'],
+        'filter': json['filter'] == null ? undefined : json['filter'],
+        'index': json['index'],
+        'limit': json['limit'],
+        'account_index': json['account_index'] == null ? undefined : json['account_index'],
+    };
+}
+
+export function ReqGetPublicPoolsMetadataToJSON(value?: ReqGetPublicPoolsMetadata | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'auth': value['auth'],
+        'filter': value['filter'],
+        'index': value['index'],
+        'limit': value['limit'],
+        'account_index': value['account_index'],
+    };
+}
+

package/models/RespPublicPoolsMetadata.ts

@@ -0,0 +1,85 @@
+/* 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 { PublicPoolMetadata } from './PublicPoolMetadata';
+import {
+    PublicPoolMetadataFromJSON,
+    PublicPoolMetadataFromJSONTyped,
+    PublicPoolMetadataToJSON,
+} from './PublicPoolMetadata';
+
+/**
+ * 
+ * @export
+ * @interface RespPublicPoolsMetadata
+ */
+export interface RespPublicPoolsMetadata {
+    /**
+     * 
+     * @type {number}
+     * @memberof RespPublicPoolsMetadata
+     */
+    code: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof RespPublicPoolsMetadata
+     */
+    message?: string;
+    /**
+     * 
+     * @type {Array<PublicPoolMetadata>}
+     * @memberof RespPublicPoolsMetadata
+     */
+    public_pools: Array<PublicPoolMetadata>;
+}
+
+/**
+ * Check if a given object implements the RespPublicPoolsMetadata interface.
+ */
+export function instanceOfRespPublicPoolsMetadata(value: object): value is RespPublicPoolsMetadata {
+    if (!('code' in value) || value['code'] === undefined) return false;
+    if (!('public_pools' in value) || value['public_pools'] === undefined) return false;
+    return true;
+}
+
+export function RespPublicPoolsMetadataFromJSON(json: any): RespPublicPoolsMetadata {
+    return RespPublicPoolsMetadataFromJSONTyped(json, false);
+}
+
+export function RespPublicPoolsMetadataFromJSONTyped(json: any, ignoreDiscriminator: boolean): RespPublicPoolsMetadata {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'code': json['code'],
+        'message': json['message'] == null ? undefined : json['message'],
+        'public_pools': ((json['public_pools'] as Array<any>).map(PublicPoolMetadataFromJSON)),
+    };
+}
+
+export function RespPublicPoolsMetadataToJSON(value?: RespPublicPoolsMetadata | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'code': value['code'],
+        'message': value['message'],
+        'public_pools': ((value['public_pools'] as Array<any>).map(PublicPoolMetadataToJSON)),
+    };
+}
+

package/models/index.ts

@@ -66,6 +66,7 @@ export * from './PositionFundings';
 export * from './PriceLevel';
 export * from './PublicPool';
 export * from './PublicPoolInfo';
+export * from './PublicPoolMetadata';
 export * from './PublicPoolShare';
 export * from './PublicPools';
 export * from './ReferralCode';
@@ -101,6 +102,7 @@ export * from './ReqGetOrderBookOrders';
 export * from './ReqGetOrderBooks';
 export * from './ReqGetPositionFunding';
 export * from './ReqGetPublicPools';
+export * from './ReqGetPublicPoolsMetadata';
 export * from './ReqGetRangeWithCursor';
 export * from './ReqGetRangeWithIndex';
 export * from './ReqGetRangeWithIndexSortable';
@@ -117,6 +119,7 @@ export * from './ReqIsWhitelisted';
 export * from './RespChangeAccountTier';
 export * from './RespGetFastBridgeInfo';
 export * from './RespGetFastwithdrawalInfo';
+export * from './RespPublicPoolsMetadata';
 export * from './RespSendTx';
 export * from './RespSendTxBatch';
 export * from './RespWithdrawalDelay';

package/openapi.json

@@ -2174,6 +2174,82 @@
         "description": "Get public pools"
       }
     },
+    "/api/v1/publicPoolsMetadata": {
+      "get": {
+        "summary": "publicPoolsMetadata",
+        "operationId": "publicPoolsMetadata",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/RespPublicPoolsMetadata"
+            }
+          },
+          "400": {
+            "description": "Bad request",
+            "schema": {
+              "$ref": "#/definitions/ResultCode"
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "authorization",
+            "in": "header",
+            "required": false,
+            "type": "string"
+          },
+          {
+            "name": "auth",
+            "in": "query",
+            "required": false,
+            "type": "string"
+          },
+          {
+            "name": "filter",
+            "in": "query",
+            "required": false,
+            "type": "string",
+            "enum": [
+              "all",
+              "user",
+              "protocol",
+              "account_index"
+            ]
+          },
+          {
+            "name": "index",
+            "in": "query",
+            "required": true,
+            "type": "integer",
+            "format": "int64"
+          },
+          {
+            "name": "limit",
+            "in": "query",
+            "required": true,
+            "type": "integer",
+            "format": "int64",
+            "minimum": 1,
+            "maximum": 100
+          },
+          {
+            "name": "account_index",
+            "in": "query",
+            "required": false,
+            "type": "integer",
+            "format": "int64"
+          }
+        ],
+        "tags": [
+          "account"
+        ],
+        "consumes": [
+          "multipart/form-data"
+        ],
+        "description": "Get public pools metadata"
+      }
+    },
     "/api/v1/recentTrades": {
       "get": {
         "summary": "recentTrades",
@@ -6021,6 +6097,69 @@
         "share_prices"
       ]
     },
+    "PublicPoolMetadata": {
+      "type": "object",
+      "properties": {
+        "code": {
+          "type": "integer",
+          "format": "int32",
+          "example": "200"
+        },
+        "message": {
+          "type": "string"
+        },
+        "account_type": {
+          "type": "integer",
+          "format": "uint8",
+          "example": "1"
+        },
+        "name": {
+          "type": "string"
+        },
+        "l1_address": {
+          "type": "string",
+          "example": "0x70997970C51812dc3A010C7d01b50e0d17dc79C8"
+        },
+        "annual_percentage_yield": {
+          "type": "number",
+          "format": "double",
+          "example": "20.5000"
+        },
+        "status": {
+          "type": "integer",
+          "format": "uint8",
+          "example": "0"
+        },
+        "operator_fee": {
+          "type": "string",
+          "example": "100"
+        },
+        "total_asset_value": {
+          "type": "string",
+          "example": "19995"
+        },
+        "total_shares": {
+          "type": "integer",
+          "format": "int64",
+          "example": "100000"
+        },
+        "account_share": {
+          "$ref": "#/definitions/PublicPoolShare"
+        }
+      },
+      "title": "PublicPoolMetadata",
+      "required": [
+        "code",
+        "account_type",
+        "name",
+        "l1_address",
+        "annual_percentage_yield",
+        "status",
+        "operator_fee",
+        "total_asset_value",
+        "total_shares"
+      ]
+    },
     "PublicPoolShare": {
       "type": "object",
       "properties": {
@@ -7045,6 +7184,42 @@
         "limit"
       ]
     },
+    "ReqGetPublicPoolsMetadata": {
+      "type": "object",
+      "properties": {
+        "auth": {
+          "type": "string"
+        },
+        "filter": {
+          "type": "string",
+          "enum": [
+            "all",
+            "user",
+            "protocol",
+            "account_index"
+          ]
+        },
+        "index": {
+          "type": "integer",
+          "format": "int64"
+        },
+        "limit": {
+          "type": "integer",
+          "format": "int64",
+          "maximum": 100,
+          "minimum": 1
+        },
+        "account_index": {
+          "type": "integer",
+          "format": "int64"
+        }
+      },
+      "title": "ReqGetPublicPoolsMetadata",
+      "required": [
+        "index",
+        "limit"
+      ]
+    },
     "ReqGetRangeWithCursor": {
       "type": "object",
       "properties": {
@@ -7499,6 +7674,30 @@
         "max_withdrawal_amount"
       ]
     },
+    "RespPublicPoolsMetadata": {
+      "type": "object",
+      "properties": {
+        "code": {
+          "type": "integer",
+          "format": "int32",
+          "example": "200"
+        },
+        "message": {
+          "type": "string"
+        },
+        "public_pools": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/PublicPoolMetadata"
+          }
+        }
+      },
+      "title": "RespPublicPoolsMetadata",
+      "required": [
+        "code",
+        "public_pools"
+      ]
+    },
     "RespSendTx": {
       "type": "object",
       "properties": {

package/package.json

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