zklighter-perps 1.0.50 → 1.0.51

package/.openapi-generator/FILES

@@ -33,6 +33,8 @@ models/Fundings.ts
 models/L1ProviderInfo.ts
 models/Layer1BasicInfo.ts
 models/Layer2BasicInfo.ts
+models/Leaderboard.ts
+models/LeaderboardEntry.ts
 models/Liquidation.ts
 models/MarketInfo.ts
 models/NextNonce.ts
@@ -69,6 +71,7 @@ models/ReqGetByAccount.ts
 models/ReqGetCandlesticks.ts
 models/ReqGetFundings.ts
 models/ReqGetL1Tx.ts
+models/ReqGetLeaderboard.ts
 models/ReqGetNextNonce.ts
 models/ReqGetOrderBookDetails.ts
 models/ReqGetOrderBookOrders.ts

package/apis/AccountApi.ts

@@ -19,6 +19,7 @@ import type {
   AccountPnL,
   Accounts,
   DetailedAccounts,
+  Leaderboard,
   PublicPools,
   ResultCode,
   SubAccounts,
@@ -32,6 +33,8 @@ import {
     AccountsToJSON,
     DetailedAccountsFromJSON,
     DetailedAccountsToJSON,
+    LeaderboardFromJSON,
+    LeaderboardToJSON,
     PublicPoolsFromJSON,
     PublicPoolsToJSON,
     ResultCodeFromJSON,
@@ -64,6 +67,11 @@ export interface FaucetRequest {
     l1_address: string;
 }
 
+export interface LeaderboardRequest {
+    type: LeaderboardTypeEnum;
+    l1_address?: string;
+}
+
 export interface PnlRequest {
     by: PnlByEnum;
     value: string;
@@ -309,6 +317,49 @@ export class AccountApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Get points leaderboard
+     * leaderboard
+     */
+    async leaderboardRaw(requestParameters: LeaderboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Leaderboard>> {
+        if (requestParameters['type'] == null) {
+            throw new runtime.RequiredError(
+                'type',
+                'Required parameter "type" was null or undefined when calling leaderboard().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['type'] != null) {
+            queryParameters['type'] = requestParameters['type'];
+        }
+
+        if (requestParameters['l1_address'] != null) {
+            queryParameters['l1_address'] = requestParameters['l1_address'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/api/v1/leaderboard`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => LeaderboardFromJSON(jsonValue));
+    }
+
+    /**
+     * Get points leaderboard
+     * leaderboard
+     */
+    async leaderboard(requestParameters: LeaderboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Leaderboard> {
+        const response = await this.leaderboardRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Get account PnL chart
      * pnl
@@ -482,6 +533,14 @@ export const AccountsSortEnum = {
     Desc: 'desc'
 } as const;
 export type AccountsSortEnum = typeof AccountsSortEnum[keyof typeof AccountsSortEnum];
+/**
+ * @export
+ */
+export const LeaderboardTypeEnum = {
+    Weekly: 'weekly',
+    All: 'all'
+} as const;
+export type LeaderboardTypeEnum = typeof LeaderboardTypeEnum[keyof typeof LeaderboardTypeEnum];
 /**
  * @export
  */

package/models/Leaderboard.ts

@@ -0,0 +1,77 @@
+/* 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 { LeaderboardEntry } from './LeaderboardEntry';
+import {
+    LeaderboardEntryFromJSON,
+    LeaderboardEntryFromJSONTyped,
+    LeaderboardEntryToJSON,
+} from './LeaderboardEntry';
+
+/**
+ * 
+ * @export
+ * @interface Leaderboard
+ */
+export interface Leaderboard {
+    /**
+     * 
+     * @type {Array<LeaderboardEntry>}
+     * @memberof Leaderboard
+     */
+    entries: Array<LeaderboardEntry>;
+    /**
+     * 
+     * @type {number}
+     * @memberof Leaderboard
+     */
+    week_start: number;
+}
+
+/**
+ * Check if a given object implements the Leaderboard interface.
+ */
+export function instanceOfLeaderboard(value: object): value is Leaderboard {
+    if (!('entries' in value) || value['entries'] === undefined) return false;
+    if (!('week_start' in value) || value['week_start'] === undefined) return false;
+    return true;
+}
+
+export function LeaderboardFromJSON(json: any): Leaderboard {
+    return LeaderboardFromJSONTyped(json, false);
+}
+
+export function LeaderboardFromJSONTyped(json: any, ignoreDiscriminator: boolean): Leaderboard {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'entries': ((json['entries'] as Array<any>).map(LeaderboardEntryFromJSON)),
+        'week_start': json['week_start'],
+    };
+}
+
+export function LeaderboardToJSON(value?: Leaderboard | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'entries': ((value['entries'] as Array<any>).map(LeaderboardEntryToJSON)),
+        'week_start': value['week_start'],
+    };
+}
+

package/models/LeaderboardEntry.ts

@@ -0,0 +1,79 @@
+/* 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 LeaderboardEntry
+ */
+export interface LeaderboardEntry {
+    /**
+     * 
+     * @type {string}
+     * @memberof LeaderboardEntry
+     */
+    l1_address: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof LeaderboardEntry
+     */
+    points: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof LeaderboardEntry
+     */
+    entry: number;
+}
+
+/**
+ * Check if a given object implements the LeaderboardEntry interface.
+ */
+export function instanceOfLeaderboardEntry(value: object): value is LeaderboardEntry {
+    if (!('l1_address' in value) || value['l1_address'] === undefined) return false;
+    if (!('points' in value) || value['points'] === undefined) return false;
+    if (!('entry' in value) || value['entry'] === undefined) return false;
+    return true;
+}
+
+export function LeaderboardEntryFromJSON(json: any): LeaderboardEntry {
+    return LeaderboardEntryFromJSONTyped(json, false);
+}
+
+export function LeaderboardEntryFromJSONTyped(json: any, ignoreDiscriminator: boolean): LeaderboardEntry {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'l1_address': json['l1_address'],
+        'points': json['points'],
+        'entry': json['entry'],
+    };
+}
+
+export function LeaderboardEntryToJSON(value?: LeaderboardEntry | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'l1_address': value['l1_address'],
+        'points': value['points'],
+        'entry': value['entry'],
+    };
+}
+

package/models/ReqGetLeaderboard.ts

@@ -0,0 +1,80 @@
+/* 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 ReqGetLeaderboard
+ */
+export interface ReqGetLeaderboard {
+    /**
+     * 
+     * @type {string}
+     * @memberof ReqGetLeaderboard
+     */
+    type: ReqGetLeaderboardTypeEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof ReqGetLeaderboard
+     */
+    l1_address?: string;
+}
+
+
+/**
+ * @export
+ */
+export const ReqGetLeaderboardTypeEnum = {
+    Weekly: 'weekly',
+    All: 'all'
+} as const;
+export type ReqGetLeaderboardTypeEnum = typeof ReqGetLeaderboardTypeEnum[keyof typeof ReqGetLeaderboardTypeEnum];
+
+
+/**
+ * Check if a given object implements the ReqGetLeaderboard interface.
+ */
+export function instanceOfReqGetLeaderboard(value: object): value is ReqGetLeaderboard {
+    if (!('type' in value) || value['type'] === undefined) return false;
+    return true;
+}
+
+export function ReqGetLeaderboardFromJSON(json: any): ReqGetLeaderboard {
+    return ReqGetLeaderboardFromJSONTyped(json, false);
+}
+
+export function ReqGetLeaderboardFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReqGetLeaderboard {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'type': json['type'],
+        'l1_address': json['l1_address'] == null ? undefined : json['l1_address'],
+    };
+}
+
+export function ReqGetLeaderboardToJSON(value?: ReqGetLeaderboard | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'type': value['type'],
+        'l1_address': value['l1_address'],
+    };
+}
+

package/models/index.ts

@@ -25,6 +25,8 @@ export * from './Fundings';
 export * from './L1ProviderInfo';
 export * from './Layer1BasicInfo';
 export * from './Layer2BasicInfo';
+export * from './Leaderboard';
+export * from './LeaderboardEntry';
 export * from './Liquidation';
 export * from './MarketInfo';
 export * from './NextNonce';
@@ -61,6 +63,7 @@ export * from './ReqGetByAccount';
 export * from './ReqGetCandlesticks';
 export * from './ReqGetFundings';
 export * from './ReqGetL1Tx';
+export * from './ReqGetLeaderboard';
 export * from './ReqGetNextNonce';
 export * from './ReqGetOrderBookDetails';
 export * from './ReqGetOrderBookOrders';

package/openapi.json

@@ -922,6 +922,51 @@
         "description": "Get zklighter general info, including contract address, and count of transactions and active users"
       }
     },
+    "/api/v1/leaderboard": {
+      "get": {
+        "summary": "leaderboard",
+        "operationId": "leaderboard",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/Leaderboard"
+            }
+          },
+          "400": {
+            "description": "Bad request",
+            "schema": {
+              "$ref": "#/definitions/ResultCode"
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "type",
+            "in": "query",
+            "required": true,
+            "type": "string",
+            "enum": [
+              "weekly",
+              "all"
+            ]
+          },
+          {
+            "name": "l1_address",
+            "in": "query",
+            "required": false,
+            "type": "string"
+          }
+        ],
+        "tags": [
+          "account"
+        ],
+        "consumes": [
+          "multipart/form-data"
+        ],
+        "description": "Get points leaderboard"
+      }
+    },
     "/api/v1/markNotifRead": {
       "get": {
         "summary": "markNotifRead",
@@ -2769,6 +2814,51 @@
         "total_transaction_count"
       ]
     },
+    "Leaderboard": {
+      "type": "object",
+      "properties": {
+        "entries": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/LeaderboardEntry"
+          }
+        },
+        "week_start": {
+          "type": "integer",
+          "format": "int64",
+          "example": "1730073600000"
+        }
+      },
+      "title": "Leaderboard",
+      "required": [
+        "entries",
+        "week_start"
+      ]
+    },
+    "LeaderboardEntry": {
+      "type": "object",
+      "properties": {
+        "l1_address": {
+          "type": "string",
+          "example": "0x70997970C51812dc3A010C7d01b50e0d17dc79C8"
+        },
+        "points": {
+          "type": "integer",
+          "format": "int64",
+          "example": "1000"
+        },
+        "entry": {
+          "type": "integer",
+          "format": "int32"
+        }
+      },
+      "title": "LeaderboardEntry",
+      "required": [
+        "l1_address",
+        "points",
+        "entry"
+      ]
+    },
     "Liquidation": {
       "type": "object",
       "properties": {
@@ -4139,6 +4229,25 @@
         "hash"
       ]
     },
+    "ReqGetLeaderboard": {
+      "type": "object",
+      "properties": {
+        "type": {
+          "type": "string",
+          "enum": [
+            "weekly",
+            "all"
+          ]
+        },
+        "l1_address": {
+          "type": "string"
+        }
+      },
+      "title": "ReqGetLeaderboard",
+      "required": [
+        "type"
+      ]
+    },
     "ReqGetNextNonce": {
       "type": "object",
       "properties": {

package/package.json

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