@scallop-io/sui-scallop-sdk 1.3.5-rc.1 → 1.4.0

package/src/models/scallopQuery.ts

@@ -47,7 +47,6 @@ import {
   getSCoinAmounts,
   getSCoinSwapRate,
   getSCoinTotalSupply,
-  getAllCoinPrices,
 } from '../queries';
 import {
   ScallopQueryParams,
@@ -192,11 +191,11 @@ export class ScallopQuery {
    * @param indexer - Whether to use indexer.
    * @return Market data.
    */
-  public async queryMarket(
-    indexer: boolean = false,
-    args?: { coinPrices: CoinPrices }
-  ) {
-    return await queryMarket(this, indexer, args?.coinPrices);
+  public async queryMarket(args?: {
+    coinPrices?: CoinPrices;
+    indexer?: boolean;
+  }) {
+    return await queryMarket(this, args?.indexer, args?.coinPrices);
   }
 
   /**
@@ -212,12 +211,17 @@ export class ScallopQuery {
    */
   public async getMarketPools(
     poolCoinNames?: SupportPoolCoins[],
-    indexer: boolean = false,
     args?: {
       coinPrices?: CoinPrices;
+      indexer?: boolean;
     }
   ) {
-    return await getMarketPools(this, poolCoinNames, indexer, args?.coinPrices);
+    return await getMarketPools(
+      this,
+      poolCoinNames,
+      args?.indexer,
+      args?.coinPrices
+    );
   }
 
   /**
@@ -229,16 +233,16 @@ export class ScallopQuery {
    */
   public async getMarketPool(
     poolCoinName: SupportPoolCoins,
-    indexer: boolean = false,
     args?: {
       marketObject?: SuiObjectData | null;
       coinPrice?: number;
+      indexer?: boolean;
     }
   ) {
     return await getMarketPool(
       this,
       poolCoinName,
-      indexer,
+      args?.indexer,
       args?.marketObject,
       args?.coinPrice
     );
@@ -257,9 +261,9 @@ export class ScallopQuery {
    */
   public async getMarketCollaterals(
     collateralCoinNames?: SupportCollateralCoins[],
-    indexer: boolean = false
+    args?: { indexer?: boolean }
   ) {
-    return await getMarketCollaterals(this, collateralCoinNames, indexer);
+    return await getMarketCollaterals(this, collateralCoinNames, args?.indexer);
   }
 
   /**
@@ -271,9 +275,9 @@ export class ScallopQuery {
    */
   public async getMarketCollateral(
     collateralCoinName: SupportCollateralCoins,
-    indexer: boolean = false
+    args?: { indexer?: boolean }
   ) {
-    return await getMarketCollateral(this, collateralCoinName, indexer);
+    return await getMarketCollateral(this, collateralCoinName, args?.indexer);
   }
 
   /**
@@ -383,16 +387,16 @@ export class ScallopQuery {
    */
   public async getSpools(
     stakeMarketCoinNames?: SupportStakeMarketCoins[],
-    indexer: boolean = false,
     args?: {
       marketPools?: MarketPools;
       coinPrices?: CoinPrices;
+      indexer?: boolean;
     }
   ) {
     return await getSpools(
       this,
       stakeMarketCoinNames,
-      indexer,
+      args?.indexer,
       args?.marketPools,
       args?.coinPrices
     );
@@ -407,13 +411,16 @@ export class ScallopQuery {
    */
   public async getSpool(
     stakeMarketCoinName: SupportStakeMarketCoins,
-    indexer: boolean = false,
-    args?: { marketPool?: MarketPool; coinPrices?: CoinPrices }
+    args?: {
+      marketPool?: MarketPool;
+      coinPrices?: CoinPrices;
+      indexer?: boolean;
+    }
   ) {
     return await getSpool(
       this,
       stakeMarketCoinName,
-      indexer,
+      args?.indexer,
       args?.marketPool,
       args?.coinPrices
     );
@@ -537,14 +544,12 @@ export class ScallopQuery {
    */
   public async getBorrowIncentivePools(
     coinNames?: SupportBorrowIncentiveCoins[],
-    indexer: boolean = false,
-    args?: { marketPools?: MarketPools; coinPrices?: CoinPrices }
+    args?: { coinPrices: CoinPrices; indexer?: boolean }
   ) {
     return await getBorrowIncentivePools(
       this,
       coinNames,
-      indexer,
-      args?.marketPools,
+      args?.indexer,
       args?.coinPrices
     );
   }
@@ -574,9 +579,9 @@ export class ScallopQuery {
   public async getLendings(
     poolCoinNames?: SupportPoolCoins[],
     ownerAddress: string = this.walletAddress,
-    indexer: boolean = false
+    args?: { indexer?: boolean }
   ) {
-    return await getLendings(this, poolCoinNames, ownerAddress, indexer);
+    return await getLendings(this, poolCoinNames, ownerAddress, args?.indexer);
   }
 
   /**
@@ -590,9 +595,9 @@ export class ScallopQuery {
   public async getLending(
     poolCoinName: SupportPoolCoins,
     ownerAddress: string = this.walletAddress,
-    indexer: boolean = false
+    args?: { indexer?: boolean }
   ) {
-    return await getLending(this, poolCoinName, ownerAddress, indexer);
+    return await getLending(this, poolCoinName, ownerAddress, args?.indexer);
   }
 
   /**
@@ -607,9 +612,9 @@ export class ScallopQuery {
    */
   public async getObligationAccounts(
     ownerAddress: string = this.walletAddress,
-    indexer: boolean = false
+    args?: { indexer: boolean }
   ) {
-    return await getObligationAccounts(this, ownerAddress, indexer);
+    return await getObligationAccounts(this, ownerAddress, args?.indexer);
   }
 
   /**
@@ -626,13 +631,13 @@ export class ScallopQuery {
   public async getObligationAccount(
     obligationId: string,
     ownerAddress: string = this.walletAddress,
-    indexer: boolean = false
+    args?: { indexer?: boolean }
   ) {
     return await getObligationAccount(
       this,
       obligationId,
       ownerAddress,
-      indexer
+      args?.indexer
     );
   }
 
@@ -645,8 +650,8 @@ export class ScallopQuery {
    *
    * @return Total value locked.
    */
-  public async getTvl(indexer: boolean = false) {
-    return await getTotalValueLocked(this, indexer);
+  public async getTvl(args?: { indexer?: boolean }) {
+    return await getTotalValueLocked(this, args?.indexer);
   }
 
   /**
@@ -819,15 +824,4 @@ export class ScallopQuery {
   public async getCoinPriceByIndexer(poolName: SupportPoolCoins) {
     return this.indexer.getCoinPrice(poolName);
   }
-
-  /**
-   * Get all coin prices, including sCoin
-   * @returns prices data
-   */
-  public async getAllCoinPrices(args?: {
-    marketPools?: MarketPools;
-    coinPrices?: CoinPrices;
-  }) {
-    return getAllCoinPrices(this, args?.marketPools, args?.coinPrices);
-  }
 }

package/src/models/scallopUtils.ts

@@ -8,6 +8,7 @@ import {
   SUPPORT_POOLS,
   SUPPORT_COLLATERALS,
   spoolRewardCoins,
+  borrowIncentiveRewardCoins,
   coinDecimals,
   wormholeCoinIds,
   voloCoinIds,
@@ -20,7 +21,6 @@ import {
   COIN_GECKGO_IDS,
   POOL_ADDRESSES,
   sCoinTypeToName,
-  sCoinRawNameToName,
 } from '../constants';
 import { getPythPrices, queryObligation } from '../queries';
 import {
@@ -40,6 +40,7 @@ import type {
   SupportAssetCoins,
   SupportMarketCoins,
   SupportStakeMarketCoins,
+  SupportBorrowIncentiveCoins,
   CoinPrices,
   CoinWrappedType,
   SupportSCoin,
@@ -156,14 +157,7 @@ export class ScallopUtils {
    * @param coinName - Specific support coin name.
    * @return Coin type.
    */
-  public parseCoinType(
-    coinName: SupportCoins,
-    useOldMarketCoin: boolean = false
-  ) {
-    // try parse scoin first
-    if (sCoinIds[coinName as SupportSCoin] && !useOldMarketCoin) {
-      return sCoinIds[coinName as SupportSCoin];
-    }
+  public parseCoinType(coinName: SupportCoins) {
     coinName = isMarketCoin(coinName) ? this.parseCoinName(coinName) : coinName;
     const coinPackageId =
       this.address.get(`core.coins.${coinName}.id`) ||
@@ -231,16 +225,6 @@ export class ScallopUtils {
     }
   }
 
-  /**
-   * Convert sCoin name to coin name.
-   * This function will parse new sCoin name `scallop_...` to its old market coin name which is shorter
-   * e.g: `scallop_sui -> ssui
-   * @return sCoin name
-   */
-  public parseCoinNameFromSCoinName(coinName: string) {
-    return sCoinRawNameToName[coinName];
-  }
-
   /**
    * Convert sCoin name into sCoin type
    * @param sCoinName
@@ -288,7 +272,7 @@ export class ScallopUtils {
   public parseMarketCoinType(coinName: SupportCoins) {
     const protocolObjectId =
       this.address.get('core.object') ?? PROTOCOL_OBJECT_ID;
-    const coinType = this.parseCoinType(coinName, true);
+    const coinType = this.parseCoinType(coinName);
     return `${protocolObjectId}::reserve::MarketCoin<${coinType}>`;
   }
 
@@ -313,13 +297,12 @@ export class ScallopUtils {
   ): T extends SupportCoins ? T : SupportCoins;
   public parseCoinNameFromType(coinType: string) {
     coinType = normalizeStructTag(coinType);
-
     const coinTypeRegex = new RegExp(`((0x[^:]+::[^:]+::[^<>]+))(?![^<>]*<)`);
     const coinTypeMatch = coinType.match(coinTypeRegex);
     const isMarketCoinType = coinType.includes('reserve::MarketCoin');
     coinType = coinTypeMatch?.[1] ?? coinType;
 
-    const wormholeCoinTypeMap: Record<string, SupportAssetCoins> = {
+    const wormHoleCoinTypeMap: Record<string, SupportAssetCoins> = {
       [`${
         this.address.get('core.coins.wusdc.id') ?? wormholeCoinIds.wusdc
       }::coin::COIN`]: 'wusdc',
@@ -356,7 +339,7 @@ export class ScallopUtils {
     );
 
     const assetCoinName =
-      wormholeCoinTypeMap[coinType] ||
+      wormHoleCoinTypeMap[coinType] ||
       voloCoinTypeMap[coinType] ||
       suiBridgeTypeMap[coinType] ||
       (coinType.split('::')[2].toLowerCase() as SupportAssetCoins);
@@ -400,6 +383,18 @@ export class ScallopUtils {
     return spoolRewardCoins[stakeMarketCoinName];
   };
 
+  /**
+   * Get reward type of borrow incentive pool.
+   *
+   * @param borrowIncentiveCoinName - Support borrow incentive coin.
+   * @return Borrow incentive reward coin name.
+   */
+  public getBorrowIncentiveRewardCoinName = (
+    borrowIncentiveCoinName: SupportBorrowIncentiveCoins
+  ) => {
+    return borrowIncentiveRewardCoins[borrowIncentiveCoinName];
+  };
+
   /**
    * Get coin decimal.
    *

package/src/queries/borrowIncentiveQuery.ts

@@ -1,9 +1,5 @@
 import { normalizeStructTag } from '@mysten/sui/utils';
-import {
-  sCoinRawNameToName,
-  SUPPORT_BORROW_INCENTIVE_POOLS,
-  SUPPORT_BORROW_INCENTIVE_REWARDS,
-} from '../constants';
+import { SUPPORT_BORROW_INCENTIVE_POOLS } from '../constants';
 import {
   parseOriginBorrowIncentivePoolData,
   parseOriginBorrowIncentiveAccountData,
@@ -21,7 +17,6 @@ import type {
   OptionalKeys,
   BorrowIncentivePool,
   CoinPrices,
-  MarketPools,
 } from '../types';
 import BigNumber from 'bignumber.js';
 
@@ -60,14 +55,11 @@ export const getBorrowIncentivePools = async (
     ...SUPPORT_BORROW_INCENTIVE_POOLS,
   ],
   indexer: boolean = false,
-  marketPools?: MarketPools,
   coinPrices?: CoinPrices
 ) => {
   const borrowIncentivePools: BorrowIncentivePools = {};
-  marketPools =
-    marketPools ??
-    (await query.getMarketPools(undefined, false, { coinPrices }));
-  coinPrices = coinPrices ?? (await query.getAllCoinPrices({ marketPools }));
+
+  coinPrices = coinPrices ?? (await query.utils.getCoinPrices()) ?? {};
 
   if (indexer) {
     const borrowIncentivePoolsIndexer =
@@ -75,13 +67,7 @@ export const getBorrowIncentivePools = async (
 
     const updateBorrowIncentivePool = (pool: BorrowIncentivePool) => {
       if (!borrowIncentiveCoinNames.includes(pool.coinName)) return;
-      pool.coinPrice = coinPrices[pool.coinName] || pool.coinPrice;
-      for (const sCoinName of SUPPORT_BORROW_INCENTIVE_REWARDS) {
-        if (pool.points[sCoinName]) {
-          pool.points[sCoinName].coinPrice =
-            coinPrices[sCoinName] ?? pool.points[sCoinName].coinPrice;
-        }
-      }
+      pool.coinPrice = coinPrices[pool.coinName] ?? pool.coinPrice;
       borrowIncentivePools[pool.coinName] = pool;
     };
 
@@ -108,6 +94,7 @@ export const getBorrowIncentivePools = async (
       query.utils.parseCoinNameFromType<SupportBorrowIncentiveCoins>(
         poolCoinType
       );
+
     const poolCoinPrice = coinPrices?.[poolCoinName] ?? 0;
     const poolCoinDecimal = query.utils.getCoinDecimal(poolCoinName);
 
@@ -115,21 +102,17 @@ export const getBorrowIncentivePools = async (
     if (!borrowIncentiveCoinNames.includes(poolCoinName)) {
       continue;
     }
-
-    // pool points for borrow incentive reward
+    // pool points for borrow incentive reward ('sui' and 'sca')
     for (const [coinName, poolPoint] of Object.entries(
       parsedBorrowIncentivePoolData.poolPoints
     )) {
-      const rewardCoinType = poolPoint.pointType;
-      let rewardCoinName = query.utils.parseCoinNameFromType(
-        rewardCoinType
-      ) as SupportBorrowIncentiveRewardCoins;
-      // handle for scoin name
-      if (sCoinRawNameToName[rewardCoinName]) {
-        rewardCoinName = sCoinRawNameToName[rewardCoinName];
-      }
-      const rewardCoinDecimal = query.utils.getCoinDecimal(rewardCoinName);
+      const rewardCoinType = normalizeStructTag(poolPoint.pointType);
+      const rewardCoinName =
+        query.utils.parseCoinNameFromType<SupportBorrowIncentiveRewardCoins>(
+          rewardCoinType
+        );
       const rewardCoinPrice = coinPrices?.[rewardCoinName] ?? 0;
+      const rewardCoinDecimal = query.utils.getCoinDecimal(rewardCoinName);
 
       const symbol = query.utils.parseSymbol(rewardCoinName);
       const coinDecimal = query.utils.getCoinDecimal(rewardCoinName);