@scallop-io/sui-scallop-sdk 2.0.13-merge-split-ve-sca-alpha.5 → 2.1.0-alpha.1

package/src/models/scallopIndexer.ts

@@ -1,54 +1,27 @@
-import axios, { AxiosInstance } from 'axios';
-import { SDK_API_BASE_URL } from 'src/constants';
-import type {
+import {
+  BorrowIncentivePool,
+  BorrowIncentivePoolPoints,
+  BorrowIncentivePools,
   Market,
-  MarketPools,
-  MarketPool,
-  MarketCollaterals,
   MarketCollateral,
-  Spools,
+  MarketCollaterals,
+  MarketPool,
+  MarketPools,
   Spool,
-  BorrowIncentivePools,
-  BorrowIncentivePool,
+  Spools,
   TotalValueLocked,
-  BorrowIncentivePoolPoints,
-  ScallopIndexerInstanceParams,
-  ScallopIndexerParams,
-} from '../types';
-import { ScallopCache } from './scallopCache';
-import { queryKeys } from 'src/constants';
-
-/**
- * @description
- * It provides methods to obtain sdk index data from mainnet.
- *
- *
- * @example
- * ```typescript
- * const scallopIndexer = new scallopIndexer(<parameters>);
- * scallopIndexer.<indexer functions>();
- * await scallopIndexer.<indexer async functions>();
- * ```
- */
-export class ScallopIndexer {
-  private readonly cache: ScallopCache;
-  public readonly params: ScallopIndexerParams;
-  private readonly _requestClient: AxiosInstance;
-
-  public constructor(
-    params: ScallopIndexerParams,
-    instance?: ScallopIndexerInstanceParams
-  ) {
-    this.params = params;
-    this.cache = instance?.cache ?? new ScallopCache(this.params);
-    this._requestClient = axios.create({
-      baseURL: params.indexerApiUrl ?? SDK_API_BASE_URL,
-      headers: {
-        'Content-Type': 'application/json',
-        Accept: 'application/json',
-      },
-      timeout: 30000,
-    });
+} from 'src/types';
+import ScallopAxios, { ScallopAxiosParams } from './scallopAxios';
+import { queryKeys, SDK_API_BASE_URL } from 'src/constants';
+
+export type ScallopIndexerParams = {
+  indexerApiUrl?: string;
+} & ScallopAxiosParams;
+
+class ScallopIndexer extends ScallopAxios {
+  constructor(params: ScallopIndexerParams = {}) {
+    params.baseUrl = params.indexerApiUrl ?? SDK_API_BASE_URL;
+    super(params);
   }
 
   /**
@@ -56,16 +29,11 @@ export class ScallopIndexer {
    *
    * @return Market data.
    */
-  public async getMarket(): Promise<Pick<Market, 'pools' | 'collaterals'>> {
-    const response = await this.cache.queryClient.fetchQuery({
-      queryKey: queryKeys.api.getMarket(),
-      queryFn: async () => {
-        return await this._requestClient.get<{
-          pools: MarketPool[];
-          collaterals: MarketCollateral[];
-        }>(`/api/market/migrate`);
-      },
-    });
+  async getMarket(): Promise<Pick<Market, 'pools' | 'collaterals'>> {
+    const response = await this.get<{
+      pools: MarketPool[];
+      collaterals: MarketCollateral[];
+    }>('/api/market/migrate', queryKeys.api.getMarket());
 
     if (response.status === 200) {
       return {
@@ -91,7 +59,7 @@ export class ScallopIndexer {
    *
    * @return Market pools data.
    */
-  public async getMarketPools(): Promise<Required<MarketPools>> {
+  async getMarketPools(): Promise<Required<MarketPools>> {
     const response = (await this.getMarket()).pools;
     return response as Required<MarketPools>;
   }
@@ -101,7 +69,7 @@ export class ScallopIndexer {
    *
    * @return Market pool data.
    */
-  public async getMarketPool(poolCoinName: string): Promise<MarketPool> {
+  async getMarketPool(poolCoinName: string): Promise<MarketPool> {
     return (await this.getMarketPools())[poolCoinName] as MarketPool;
   }
 
@@ -110,7 +78,7 @@ export class ScallopIndexer {
    *
    * @return Market collaterals data.
    */
-  public async getMarketCollaterals(): Promise<Required<MarketCollaterals>> {
+  async getMarketCollaterals(): Promise<Required<MarketCollaterals>> {
     return (await this.getMarket()).collaterals as Required<MarketCollaterals>;
   }
 
@@ -119,7 +87,7 @@ export class ScallopIndexer {
    *
    * @return Market collateral data.
    */
-  public async getMarketCollateral(
+  async getMarketCollateral(
     collateralCoinName: string
   ): Promise<MarketCollateral> {
     return (await this.getMarketCollaterals())[
@@ -132,15 +100,10 @@ export class ScallopIndexer {
    *
    * @return Spools data.
    */
-  public async getSpools(): Promise<Required<Spools>> {
-    const response = await this.cache.queryClient.fetchQuery({
-      queryKey: queryKeys.api.getSpools(),
-      queryFn: async () => {
-        return await this._requestClient.get<{
-          spools: Spool[];
-        }>(`/api/spools/migrate`);
-      },
-    });
+  async getSpools(): Promise<Required<Spools>> {
+    const response = await this.get<{
+      spools: Spool[];
+    }>('/api/spools/migrate', queryKeys.api.getSpools());
 
     if (response.status === 200) {
       return response.data.spools.reduce((spools, spool) => {
@@ -157,7 +120,7 @@ export class ScallopIndexer {
    *
    * @return Spool data.
    */
-  public async getSpool(marketCoinName: string): Promise<Spool> {
+  async getSpool(marketCoinName: string): Promise<Spool> {
     return (await this.getSpools())[marketCoinName] as Spool;
   }
 
@@ -166,17 +129,13 @@ export class ScallopIndexer {
    *
    * @return Borrow incentive pools data.
    */
-  public async getBorrowIncentivePools(): Promise<
-    Required<BorrowIncentivePools>
-  > {
-    const response = await this.cache.queryClient.fetchQuery({
-      queryKey: queryKeys.api.getBorrowIncentivePool(),
-      queryFn: async () => {
-        return await this._requestClient.get<{
-          borrowIncentivePools: BorrowIncentivePool[];
-        }>(`/api/borrowIncentivePools/migrate`);
-      },
-    });
+  async getBorrowIncentivePools(): Promise<Required<BorrowIncentivePools>> {
+    const response = await this.get<{
+      borrowIncentivePools: BorrowIncentivePool[];
+    }>(
+      '/api/borrowIncentivePools/migrate',
+      queryKeys.api.getBorrowIncentivePool()
+    );
 
     if (response.status === 200) {
       return response.data.borrowIncentivePools.reduce(
@@ -208,7 +167,7 @@ export class ScallopIndexer {
    *
    * @return Borrow incentive pool data.
    */
-  public async getBorrowIncentivePool(
+  async getBorrowIncentivePool(
     borrowIncentiveCoinName: string
   ): Promise<BorrowIncentivePool> {
     return (await this.getBorrowIncentivePools())[
@@ -221,25 +180,20 @@ export class ScallopIndexer {
    *
    * @return Total value locked.
    */
-  public async getTotalValueLocked(): Promise<
+  async getTotalValueLocked(): Promise<
     TotalValueLocked & {
       totalValueChangeRatio: number;
       borrowValueChangeRatio: number;
       supplyValueChangeRatio: number;
     }
   > {
-    const response = await this.cache.queryClient.fetchQuery({
-      queryKey: queryKeys.api.getTotalValueLocked(),
-      queryFn: async () => {
-        return await this._requestClient.get<
-          TotalValueLocked & {
-            totalValueChangeRatio: number;
-            borrowValueChangeRatio: number;
-            supplyValueChangeRatio: number;
-          }
-        >(`/api/market/tvl`);
-      },
-    });
+    const response = await this.get<
+      TotalValueLocked & {
+        totalValueChangeRatio: number;
+        borrowValueChangeRatio: number;
+        supplyValueChangeRatio: number;
+      }
+    >(`/api/market/tvl`, queryKeys.api.getTotalValueLocked());
 
     if (response.status === 200) {
       return response.data;
@@ -253,11 +207,11 @@ export class ScallopIndexer {
    *
    * @return price data.
    */
-  public async getCoinPrice(poolCoinName: string): Promise<number> {
+  async getCoinPrice(poolCoinName: string): Promise<number> {
     return (await this.getMarketPool(poolCoinName))?.coinPrice ?? 0;
   }
 
-  public async getCoinPrices(): Promise<Record<string, number>> {
+  async getCoinPrices(): Promise<Record<string, number>> {
     const marketPools = await this.getMarketPools();
     return Object.entries(marketPools).reduce(
       (prev, [coinName, market]) => {
@@ -268,3 +222,5 @@ export class ScallopIndexer {
     );
   }
 }
+
+export default ScallopIndexer;