@scallop-io/sui-scallop-sdk 0.44.7 → 0.44.9

package/src/models/scallopIndexer.ts

@@ -0,0 +1,269 @@
+import axios, { AxiosInstance } from 'axios';
+import { SDK_API_BASE_URL } from '../constants';
+import type {
+  Market,
+  MarketPools,
+  MarketPool,
+  MarketCollaterals,
+  MarketCollateral,
+  Spools,
+  Spool,
+  BorrowIncentivePools,
+  BorrowIncentivePool,
+  SupportPoolCoins,
+  SupportCollateralCoins,
+  SupportStakeMarketCoins,
+  SupportBorrowIncentiveCoins,
+  TotalValueLocked,
+} from '../types';
+
+/**
+ * @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 _requestClient: AxiosInstance;
+
+  public constructor() {
+    this._requestClient = axios.create({
+      baseURL: SDK_API_BASE_URL,
+      headers: {
+        'Content-Type': 'application/json',
+        Accept: 'application/json',
+      },
+      timeout: 30000,
+    });
+  }
+
+  /**
+   * Get market index data.
+   *
+   * @return Market data.
+   */
+  public async getMarket(): Promise<Pick<Market, 'pools' | 'collaterals'>> {
+    const response = await this._requestClient.get<{
+      pools: MarketPool[];
+      collaterals: MarketCollateral[];
+    }>(`${SDK_API_BASE_URL}/api/market`);
+
+    if (response.status === 200) {
+      return {
+        pools: response.data.pools.reduce((marketPools, marketPool) => {
+          marketPools[marketPool.coinName] = marketPool;
+          return marketPools;
+        }, {} as MarketPools),
+        collaterals: response.data.collaterals.reduce(
+          (marketCollaterals, marketCollateral) => {
+            marketCollaterals[marketCollateral.coinName] = marketCollateral;
+            return marketCollaterals;
+          },
+          {} as MarketCollaterals
+        ),
+      };
+    } else {
+      throw Error('Failed to getMarket.');
+    }
+  }
+
+  /**
+   * Get market pools index data.
+   *
+   * @return Market pools data.
+   */
+  public async getMarketPools(): Promise<Required<MarketPools>> {
+    const response = await this._requestClient.get<{
+      pools: MarketPool[];
+    }>(`${SDK_API_BASE_URL}/api/market/pools`);
+
+    if (response.status === 200) {
+      return response.data.pools.reduce((marketPools, marketPool) => {
+        marketPools[marketPool.coinName] = marketPool;
+        return marketPools;
+      }, {} as MarketPools) as Required<MarketPools>;
+    } else {
+      throw Error('Failed to getMarketPools.');
+    }
+  }
+
+  /**
+   * Get market pool index data.
+   *
+   * @return Market pool data.
+   */
+  public async getMarketPool(
+    poolCoinName: SupportPoolCoins
+  ): Promise<MarketPool> {
+    const response = await this._requestClient.get<{
+      pool: MarketPool;
+    }>(`${SDK_API_BASE_URL}/api/market/pool/${poolCoinName}`);
+
+    if (response.status === 200) {
+      return response.data.pool;
+    } else {
+      throw Error('Failed to getMarketPool.');
+    }
+  }
+
+  /**
+   * Get market collaterals index data.
+   *
+   * @return Market collaterals data.
+   */
+  public async getMarketCollaterals(): Promise<Required<MarketCollaterals>> {
+    const response = await this._requestClient.get<{
+      collaterals: MarketCollateral[];
+    }>(`${SDK_API_BASE_URL}/api/market/collaterals`);
+
+    if (response.status === 200) {
+      return response.data.collaterals.reduce(
+        (marketCollaterals, marketCollateral) => {
+          marketCollaterals[marketCollateral.coinName] = marketCollateral;
+          return marketCollaterals;
+        },
+        {} as MarketCollaterals
+      ) as Required<MarketCollaterals>;
+    } else {
+      throw Error('Failed to getMarketCollaterals.');
+    }
+  }
+
+  /**
+   * Get market collateral index data.
+   *
+   * @return Market collateral data.
+   */
+  public async getMarketCollateral(
+    collateralCoinName: SupportCollateralCoins
+  ): Promise<MarketCollateral> {
+    const response = await this._requestClient.get<{
+      collateral: MarketCollateral;
+    }>(`${SDK_API_BASE_URL}/api/market/collateral/${collateralCoinName}`);
+
+    if (response.status === 200) {
+      return response.data.collateral;
+    } else {
+      throw Error('Failed to getMarketCollateral.');
+    }
+  }
+
+  /**
+   * Get spools index data.
+   *
+   * @return Spools data.
+   */
+  public async getSpools(): Promise<Required<Spools>> {
+    const response = await this._requestClient.get<{
+      spools: Spool[];
+    }>(`${SDK_API_BASE_URL}/api/spools`);
+
+    if (response.status === 200) {
+      return response.data.spools.reduce((spools, spool) => {
+        spools[spool.marketCoinName] = spool;
+        return spools;
+      }, {} as Spools) as Required<Spools>;
+    } else {
+      throw Error('Failed to getSpools.');
+    }
+  }
+
+  /**
+   * Get spool index data.
+   *
+   * @return Spool data.
+   */
+  public async getSpool(
+    marketCoinName: SupportStakeMarketCoins
+  ): Promise<Spool> {
+    const response = await this._requestClient.get<{
+      spool: Spool;
+    }>(`${SDK_API_BASE_URL}/api/spool/${marketCoinName}`);
+
+    if (response.status === 200) {
+      return response.data.spool;
+    } else {
+      throw Error('Failed to getSpool.');
+    }
+  }
+
+  /**
+   * Get borrow incentive pools index data.
+   *
+   * @return Borrow incentive pools data.
+   */
+  public async getBorrowIncentivePools(): Promise<
+    Required<BorrowIncentivePools>
+  > {
+    const response = await this._requestClient.get<{
+      borrowIncentivePools: BorrowIncentivePool[];
+    }>(`${SDK_API_BASE_URL}/api/borrowIncentivePools`);
+
+    if (response.status === 200) {
+      return response.data.borrowIncentivePools.reduce(
+        (borrowIncentivePools, borrowIncentivePool) => {
+          borrowIncentivePools[borrowIncentivePool.coinName] =
+            borrowIncentivePool;
+          return borrowIncentivePools;
+        },
+        {} as BorrowIncentivePools
+      ) as Required<BorrowIncentivePools>;
+    } else {
+      throw Error('Failed to getBorrowIncentivePools.');
+    }
+  }
+
+  /**
+   * Get borrow incentive pool index data.
+   *
+   * @return Borrow incentive pool data.
+   */
+  public async getBorrowIncentivePool(
+    borrowIncentiveCoinName: SupportBorrowIncentiveCoins
+  ): Promise<BorrowIncentivePool> {
+    const response = await this._requestClient.get<{
+      borrowIncentivePool: BorrowIncentivePool;
+    }>(
+      `${SDK_API_BASE_URL}/api/borrowIncentivePool/${borrowIncentiveCoinName}`
+    );
+
+    if (response.status === 200) {
+      return response.data.borrowIncentivePool;
+    } else {
+      throw Error('Failed to getSpool.');
+    }
+  }
+
+  /**
+   * Get total value locked index data.
+   *
+   * @return Total value locked.
+   */
+  public async getTotalValueLocked(): Promise<
+    TotalValueLocked & {
+      totalValueChangeRatio: number;
+      borrowValueChangeRatio: number;
+      supplyValueChangeRatio: number;
+    }
+  > {
+    const response = await this._requestClient.get<
+      TotalValueLocked & {
+        totalValueChangeRatio: number;
+        borrowValueChangeRatio: number;
+        supplyValueChangeRatio: number;
+      }
+    >(`${SDK_API_BASE_URL}/api/market/tvl`);
+
+    if (response.status === 200) {
+      return response.data;
+    } else {
+      throw Error('Failed to getTotalValueLocked.');
+    }
+  }
+}

package/src/models/scallopQuery.ts

@@ -40,10 +40,11 @@ import {
 } from '../types';
 import { ScallopAddress } from './scallopAddress';
 import { ScallopUtils } from './scallopUtils';
+import { ScallopIndexer } from './scallopIndexer';
 
 /**
  * @description
- * it provides methods for getting on-chain data from the Scallop contract.
+ * It provides methods for getting on-chain data from the Scallop contract.
  *
  * @example
  * ```typescript
@@ -59,6 +60,7 @@ export class ScallopQuery {
   public suiKit: SuiKit;
   public address: ScallopAddress;
   public utils: ScallopUtils;
+  public indexer: ScallopIndexer;
 
   public constructor(
     params: ScallopQueryParams,
@@ -79,6 +81,7 @@ export class ScallopQuery {
         address: this.address,
         query: this,
       });
+    this.indexer = new ScallopIndexer();
   }
 
   /**
@@ -97,11 +100,11 @@ export class ScallopQuery {
 
   /**
    * Query market data.
-   *
+   * @param indexer - Whether to use indexer.
    * @return Market data.
    */
-  public async queryMarket() {
-    return await queryMarket(this);
+  public async queryMarket(indexer: boolean = false) {
+    return await queryMarket(this, indexer);
   }
 
   /**
@@ -112,20 +115,28 @@ export class ScallopQuery {
    * the `queryMarket` method to reduce time consumption.
    *
    * @param poolCoinNames - Specific an array of support pool coin name.
+   * @param indexer - Whether to use indexer.
    * @return Market pools data.
    */
-  public async getMarketPools(poolCoinNames?: SupportPoolCoins[]) {
-    return await getMarketPools(this, poolCoinNames);
+  public async getMarketPools(
+    poolCoinNames?: SupportPoolCoins[],
+    indexer: boolean = false
+  ) {
+    return await getMarketPools(this, poolCoinNames, indexer);
   }
 
   /**
    * Get  market pool
    *
    * @param poolCoinName - Specific support pool coin name.
+   * @param indexer - Whether to use indexer.
    * @return Market pool data.
    */
-  public async getMarketPool(poolCoinName: SupportPoolCoins) {
-    return await getMarketPool(this, poolCoinName);
+  public async getMarketPool(
+    poolCoinName: SupportPoolCoins,
+    indexer: boolean = false
+  ) {
+    return await getMarketPool(this, poolCoinName, indexer);
   }
 
   /**
@@ -136,22 +147,28 @@ export class ScallopQuery {
    * the `queryMarket` method to reduce time consumption.
    *
    * @param collateralCoinNames - Specific an array of support collateral coin name.
+   * @param indexer - Whether to use indexer.
    * @return Market collaterals data.
    */
   public async getMarketCollaterals(
-    collateralCoinNames?: SupportCollateralCoins[]
+    collateralCoinNames?: SupportCollateralCoins[],
+    indexer: boolean = false
   ) {
-    return await getMarketCollaterals(this, collateralCoinNames);
+    return await getMarketCollaterals(this, collateralCoinNames, indexer);
   }
 
   /**
    * Get market collateral
    *
    * @param collateralCoinName - Specific support collateral coin name.
+   * @param indexer - Whether to use indexer.
    * @return Market collateral data.
    */
-  public async getMarketCollateral(collateralCoinName: SupportCollateralCoins) {
-    return await getMarketCollateral(this, collateralCoinName);
+  public async getMarketCollateral(
+    collateralCoinName: SupportCollateralCoins,
+    indexer: boolean = false
+  ) {
+    return await getMarketCollateral(this, collateralCoinName, indexer);
   }
 
   /**
@@ -246,20 +263,28 @@ export class ScallopQuery {
    * Get spools data.
    *
    * @param stakeMarketCoinNames - Specific an array of support stake market coin name.
+   * @param indexer - Whether to use indexer.
    * @return Spools data.
    */
-  public async getSpools(stakeMarketCoinNames?: SupportStakeMarketCoins[]) {
-    return await getSpools(this, stakeMarketCoinNames);
+  public async getSpools(
+    stakeMarketCoinNames?: SupportStakeMarketCoins[],
+    indexer: boolean = false
+  ) {
+    return await getSpools(this, stakeMarketCoinNames, indexer);
   }
 
   /**
    * Get spool data.
    *
    * @param stakeMarketCoinName - Specific support stake market coin name.
+   * @param indexer - Whether to use indexer.
    * @return Spool data.
    */
-  public async getSpool(stakeMarketCoinName: SupportStakeMarketCoins) {
-    return await getSpool(this, stakeMarketCoinName);
+  public async getSpool(
+    stakeMarketCoinName: SupportStakeMarketCoins,
+    indexer: boolean = false
+  ) {
+    return await getSpool(this, stakeMarketCoinName, indexer);
   }
 
   /**
@@ -374,12 +399,14 @@ export class ScallopQuery {
    * Get borrow incentive pools data.
    *
    * @param coinNames - Specific an array of support borrow incentive coin name.
+   * @param indexer - Whether to use indexer.
    * @return Borrow incentive pools data.
    */
   public async getBorrowIncentivePools(
-    coinNames?: SupportBorrowIncentiveCoins[]
+    coinNames?: SupportBorrowIncentiveCoins[],
+    indexer: boolean = false
   ) {
-    return await queryBorrowIncentivePools(this, coinNames);
+    return await queryBorrowIncentivePools(this, coinNames, indexer);
   }
 
   /**
@@ -401,13 +428,15 @@ export class ScallopQuery {
    *
    * @param poolCoinNames - Specific an array of support pool coin name.
    * @param ownerAddress - The owner address.
+   * @param indexer - Whether to use indexer.
    * @return All lending and spool infomation.
    */
   public async getLendings(
     poolCoinNames?: SupportPoolCoins[],
-    ownerAddress?: string
+    ownerAddress?: string,
+    indexer: boolean = false
   ) {
-    return await getLendings(this, poolCoinNames, ownerAddress);
+    return await getLendings(this, poolCoinNames, ownerAddress, indexer);
   }
 
   /**
@@ -415,13 +444,15 @@ export class ScallopQuery {
    *
    * @param poolCoinName - Specific support pool coin name.
    * @param ownerAddress - The owner address.
+   * @param indexer - Whether to use indexer.
    * @return Lending pool data.
    */
   public async getLending(
     poolCoinName: SupportPoolCoins,
-    ownerAddress?: string
+    ownerAddress?: string,
+    indexer: boolean = false
   ) {
-    return await getLending(this, poolCoinName, ownerAddress);
+    return await getLending(this, poolCoinName, ownerAddress, indexer);
   }
 
   /**
@@ -431,10 +462,14 @@ export class ScallopQuery {
    * All collateral and borrowing information in all obligation accounts owned by the user.
    *
    * @param ownerAddress - The owner address.
+   * @param indexer - Whether to use indexer.
    * @return All obligation accounts information.
    */
-  public async getObligationAccounts(ownerAddress?: string) {
-    return await getObligationAccounts(this, ownerAddress);
+  public async getObligationAccounts(
+    ownerAddress?: string,
+    indexer: boolean = false
+  ) {
+    return await getObligationAccounts(this, ownerAddress, indexer);
   }
 
   /**
@@ -445,24 +480,32 @@ export class ScallopQuery {
    *
    * @param obligationId - The obligation id.
    * @param ownerAddress - The owner address.
+   * @param indexer - Whether to use indexer.
    * @return Borrowing and collateral information.
    */
   public async getObligationAccount(
     obligationId: string,
-    ownerAddress?: string
+    ownerAddress?: string,
+    indexer: boolean = false
   ) {
-    return await getObligationAccount(this, obligationId, ownerAddress);
+    return await getObligationAccount(
+      this,
+      obligationId,
+      ownerAddress,
+      indexer
+    );
   }
 
   /**
    * Get total value locked.
    *
+   * @param indexer - Whether to use indexer.
    * @description
    * Include total supplied value and total borrowed value.
    *
    * @return Total value locked.
    */
-  public async getTvl() {
-    return await getTotalValueLocked(this);
+  public async getTvl(indexer: boolean = false) {
+    return await getTotalValueLocked(this, indexer);
   }
 }

package/src/queries/borrowIncentiveQuery.ts

@@ -23,11 +23,13 @@ import type {
  *
  * @param query - The Scallop query instance.
  * @param borrowIncentiveCoinNames - Specific an array of support borrow incentive coin name.
+ * @param indexer - Whether to use indexer.
  * @return Borrow incentive pools data.
  */
 export const queryBorrowIncentivePools = async (
   query: ScallopQuery,
-  borrowIncentiveCoinNames?: SupportBorrowIncentiveCoins[]
+  borrowIncentiveCoinNames?: SupportBorrowIncentiveCoins[],
+  indexer: boolean = false
 ) => {
   borrowIncentiveCoinNames = borrowIncentiveCoinNames || [
     ...SUPPORT_BORROW_INCENTIVE_POOLS,
@@ -47,8 +49,32 @@ export const queryBorrowIncentivePools = async (
       borrowIncentivePoolsQueryData.reward_pool
     );
   const rewardCoinType = parsedBorrowIncentiveRewardPoolData.rewardType;
+  const rewardCoinName =
+    query.utils.parseCoinNameFromType<SupportAssetCoins>(rewardCoinType);
+  const coinPrices = await query.utils.getCoinPrices(
+    [...new Set([...borrowIncentiveCoinNames, rewardCoinName])] ?? []
+  );
 
   const borrowIncentivePools: BorrowIncentivePools = {};
+
+  if (indexer) {
+    const borrowIncentivePoolsIndexer =
+      await query.indexer.getBorrowIncentivePools();
+    for (const borrowIncentivePool of Object.values(
+      borrowIncentivePoolsIndexer
+    )) {
+      if (!borrowIncentiveCoinNames.includes(borrowIncentivePool.coinName))
+        continue;
+      borrowIncentivePool.coinPrice =
+        coinPrices[borrowIncentivePool.coinName] ||
+        borrowIncentivePool.coinPrice;
+      borrowIncentivePool.rewardCoinPrice =
+        coinPrices[rewardCoinName] || borrowIncentivePool.rewardCoinPrice;
+      borrowIncentivePools[borrowIncentivePool.coinName] = borrowIncentivePool;
+    }
+    return borrowIncentivePools;
+  }
+
   for (const pool of borrowIncentivePoolsQueryData.incentive_pools) {
     const coinType = normalizeStructTag(pool.pool_type.name);
     const coinName =
@@ -61,11 +87,6 @@ export const queryBorrowIncentivePools = async (
       continue;
     }
 
-    const coinPrices = await query.utils.getCoinPrices([
-      coinName,
-      rewardCoinName,
-    ]);
-
     const parsedBorrowIncentivePoolData =
       parseOriginBorrowIncentivePoolData(pool);