feat: add sentio method from leaderboard (#53)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@compolabs/spark-orderbook-ts-sdk",
-  "version": "1.14.2",
+  "version": "1.14.3",
   "type": "module",
   "main": "./dist/index.сjs",
   "module": "./dist/index.js",

src/SparkOrderbook.ts

@@ -20,6 +20,7 @@ import {
   FulfillOrderManyParams,
   FulfillOrderManyWithDepositParams,
   GetActiveOrdersParams,
+  GetLeaderBoardQueryParams,
   GetOrdersParams,
   GetTradeEventQueryParams,
   GetTradeOrderEventsParams,
@@ -358,6 +359,10 @@ export class SparkOrderbook {
     return this.activeSentioApi?.getTradeEvent(params);
   }
 
+  async getLeaderBoard(params: GetLeaderBoardQueryParams) {
+    return this.activeSentioApi?.getLeaderBoard(params);
+  }
+
   /**
    * @experimental
    * Returns the current instance to allow method chaining.

src/interface.ts

@@ -234,6 +234,13 @@ export interface GetTradeEventQueryParams {
   fromTimestamp: number;
 }
 
+export interface GetLeaderBoardQueryParams {
+  page: number;
+  search?: string;
+  currentTimestamp: number;
+  interval: number;
+}
+
 export interface SentioApiParams {
   url: string;
   apiKey: string;
@@ -273,6 +280,14 @@ export interface RowTradeEvent {
   volume: number;
 }
 
+export interface TraderVolumeResponse {
+  walletId: string;
+  traderVolume: number;
+  id: number;
+  totalCount: number;
+  isYour: boolean;
+}
+
 interface ColumnTypes {
   block_date: string;
   total_value_locked_score: string;

src/query/sentioQuery.ts

@@ -1,10 +1,12 @@
 import {
+  GetLeaderBoardQueryParams,
   GetSentioResponse,
   GetTradeEventQueryParams,
   GetUserScoreSnapshotParams,
   RowSnapshot,
   RowTradeEvent,
   SentioApiParams,
+  TraderVolumeResponse,
 } from "src/interface";
 import { Fetch } from "src/utils/Fetch";
 
@@ -16,13 +18,78 @@ interface sqlQueryParams {
 }
 
 export class SentioQuery extends Fetch {
-  private apiKey: string;
+  private readonly apiKey: string;
 
   constructor({ url, apiKey }: SentioApiParams) {
     super(url);
     this.apiKey = apiKey;
   }
 
+  async getLeaderBoardQuery({
+    page,
+    search = "",
+    currentTimestamp,
+    interval,
+  }: GetLeaderBoardQueryParams): Promise<
+    GetSentioResponse<TraderVolumeResponse>
+  > {
+    const limit = 10;
+    const offset = page * limit;
+    const sqlQuery: sqlQueryParams = {
+      sqlQuery: {
+        sql: `WITH Combined AS (
+              SELECT 
+                  seller AS walletId,
+                  volume,
+                  timestamp
+              FROM TradeEvent
+              WHERE timestamp BETWEEN ${currentTimestamp} - ${interval} AND ${currentTimestamp}
+              UNION ALL
+              SELECT 
+                  buyer AS walletId,
+                  volume,
+                  timestamp
+              FROM TradeEvent
+              WHERE timestamp BETWEEN ${currentTimestamp} - ${interval} AND ${currentTimestamp}
+          ),
+          Ranked AS (
+              SELECT 
+                  walletId,
+                  SUM(volume) AS traderVolume,
+                  ROW_NUMBER() OVER (ORDER BY SUM(volume) DESC) AS id
+              FROM Combined
+              GROUP BY walletId
+          ),
+          Filtered AS (
+              SELECT 
+                  id,
+                  walletId,
+                  traderVolume,
+                  COUNT(*) OVER () AS totalCount
+              FROM Ranked
+              WHERE walletId LIKE '%${search}%'
+          )
+          SELECT 
+              id,
+              walletId,
+              traderVolume,
+              totalCount
+          FROM Filtered
+          ORDER BY traderVolume DESC
+          LIMIT ${limit} OFFSET ${offset};`,
+        size: 20,
+      },
+    };
+    const headers: Record<string, string> = {
+      "api-key": this.apiKey,
+    };
+    return await this.post<GetSentioResponse<TraderVolumeResponse>>(
+      sqlQuery,
+      "same-origin",
+      headers,
+    );
+  }
+
   async getUserScoreSnapshotQuery({
     userAddress,
     blockDate,
@@ -102,3 +169,22 @@ export const getTradeEventQuery = async ({
     toTimestamp,
   });
 };
+
+export const getLeaderBoardQuery = async ({
+  page,
+  search,
+  url,
+  apiKey,
+  currentTimestamp,
+  interval,
+}: GetLeaderBoardQueryParams & SentioApiParams): Promise<
+  GetSentioResponse<TraderVolumeResponse>
+> => {
+  const sentioQuery = new SentioQuery({ url, apiKey });
+  return await sentioQuery.getLeaderBoardQuery({
+    page,
+    search,
+    currentTimestamp,
+    interval,
+  });
+};

src/sentioApi.ts

@@ -1,8 +1,10 @@
 import {
+  getLeaderBoardQuery,
   getTradeEventQuery,
   getUserScoreSnapshotQuery,
 } from "./query/sentioQuery";
 import {
+  GetLeaderBoardQueryParams,
   GetTradeEventQueryParams,
   GetUserScoreSnapshotParams,
   SentioApiParams,
@@ -35,4 +37,15 @@ export class SentioApi {
       apiKey: this.apiKey,
     });
   };
+
+  getLeaderBoard = (params: GetLeaderBoardQueryParams) => {
+    return getLeaderBoardQuery({
+      page: params.page,
+      search: params.search,
+      currentTimestamp: params.currentTimestamp,
+      interval: params.interval,
+      url: this.url,
+      apiKey: this.apiKey,
+    });
+  };
 }