@scallop-io/sui-scallop-sdk 1.3.3 → 1.3.4-alpha.2

package/src/models/scallopQuery.ts

@@ -47,6 +47,9 @@ import {
   SupportBorrowIncentiveCoins,
   SupportSCoin,
   ScallopQueryInstanceParams,
+  MarketPool,
+  CoinPrices,
+  MarketPools,
 } from '../types';
 import { ScallopAddress } from './scallopAddress';
 import { ScallopUtils } from './scallopUtils';
@@ -64,6 +67,7 @@ import { normalizeSuiAddress } from '@mysten/sui/utils';
 import { getSupplyLimit } from 'src/queries/supplyLimit';
 import { withIndexerFallback } from 'src/utils/indexer';
 import { getIsolatedAssets, isIsolatedAsset } from 'src/queries/isolatedAsset';
+import { newSuiKit } from './suiKit';
 
 /**
  * @description
@@ -93,10 +97,10 @@ export class ScallopQuery {
   ) {
     this.params = params;
     this.suiKit =
-      instance?.suiKit ?? instance?.utils?.suiKit ?? new SuiKit(params);
+      instance?.suiKit ?? instance?.utils?.suiKit ?? newSuiKit(params);
 
     this.walletAddress = normalizeSuiAddress(
-      params.walletAddress || this.suiKit.currentAddress()
+      params.walletAddress ?? this.suiKit.currentAddress()
     );
 
     if (instance?.utils) {
@@ -111,7 +115,7 @@ export class ScallopQuery {
       );
       this.address = new ScallopAddress(
         {
-          id: params?.addressesId || ADDRESSES_ID,
+          id: params?.addressesId ?? ADDRESSES_ID,
           network: params?.networkType,
           forceInterface: params?.forceAddressesInterface,
         },
@@ -183,8 +187,11 @@ export class ScallopQuery {
    * @param indexer - Whether to use indexer.
    * @return Market data.
    */
-  public async queryMarket(indexer: boolean = false) {
-    return await queryMarket(this, indexer);
+  public async queryMarket(
+    indexer: boolean = false,
+    args?: { coinPrices: CoinPrices }
+  ) {
+    return await queryMarket(this, indexer, args?.coinPrices);
   }
 
   /**
@@ -200,9 +207,12 @@ export class ScallopQuery {
    */
   public async getMarketPools(
     poolCoinNames?: SupportPoolCoins[],
-    indexer: boolean = false
+    indexer: boolean = false,
+    args?: {
+      coinPrices?: CoinPrices;
+    }
   ) {
-    return await getMarketPools(this, poolCoinNames, indexer);
+    return await getMarketPools(this, poolCoinNames, indexer, args?.coinPrices);
   }
 
   /**
@@ -214,9 +224,19 @@ export class ScallopQuery {
    */
   public async getMarketPool(
     poolCoinName: SupportPoolCoins,
-    indexer: boolean = false
+    indexer: boolean = false,
+    args?: {
+      marketObject?: SuiObjectData | null;
+      coinPrice?: number;
+    }
   ) {
-    return await getMarketPool(this, poolCoinName, indexer);
+    return await getMarketPool(
+      this,
+      poolCoinName,
+      indexer,
+      args?.marketObject,
+      args?.coinPrice
+    );
   }
 
   /**
@@ -358,9 +378,19 @@ export class ScallopQuery {
    */
   public async getSpools(
     stakeMarketCoinNames?: SupportStakeMarketCoins[],
-    indexer: boolean = false
+    indexer: boolean = false,
+    args?: {
+      marketPools?: MarketPools;
+      coinPrices?: CoinPrices;
+    }
   ) {
-    return await getSpools(this, stakeMarketCoinNames, indexer);
+    return await getSpools(
+      this,
+      stakeMarketCoinNames,
+      indexer,
+      args?.marketPools,
+      args?.coinPrices
+    );
   }
 
   /**
@@ -372,9 +402,16 @@ export class ScallopQuery {
    */
   public async getSpool(
     stakeMarketCoinName: SupportStakeMarketCoins,
-    indexer: boolean = false
+    indexer: boolean = false,
+    args?: { marketPool?: MarketPool; coinPrices?: CoinPrices }
   ) {
-    return await getSpool(this, stakeMarketCoinName, indexer);
+    return await getSpool(
+      this,
+      stakeMarketCoinName,
+      indexer,
+      args?.marketPool,
+      args?.coinPrices
+    );
   }
 
   /**
@@ -495,9 +532,15 @@ export class ScallopQuery {
    */
   public async getBorrowIncentivePools(
     coinNames?: SupportBorrowIncentiveCoins[],
-    indexer: boolean = false
+    indexer: boolean = false,
+    args?: { coinPrices: CoinPrices }
   ) {
-    return await getBorrowIncentivePools(this, coinNames, indexer);
+    return await getBorrowIncentivePools(
+      this,
+      coinNames,
+      indexer,
+      args?.coinPrices
+    );
   }
 
   /**

package/src/models/scallopUtils.ts

@@ -18,8 +18,11 @@ import {
   SUPPORT_SCOIN,
   sCoinIds,
   suiBridgeCoins,
+  COIN_GECKGO_IDS,
+  POOL_ADDRESSES,
+  sCoinTypeToName,
 } from '../constants';
-import { getPythPrice, queryObligation } from '../queries';
+import { getPythPrices, queryObligation } from '../queries';
 import {
   parseDataFromPythPriceFeed,
   isMarketCoin,
@@ -28,7 +31,7 @@ import {
   isSuiBridgeAsset,
   isWormholeAsset,
 } from '../utils';
-import { PYTH_ENDPOINTS } from 'src/constants/pyth';
+import { PYTH_ENDPOINTS, PYTH_FEED_IDS } from 'src/constants/pyth';
 import { ScallopCache } from './scallopCache';
 import { DEFAULT_CACHE_OPTIONS } from 'src/constants/cache';
 import type {
@@ -39,15 +42,16 @@ import type {
   SupportStakeMarketCoins,
   SupportBorrowIncentiveCoins,
   CoinPrices,
-  PriceMap,
   CoinWrappedType,
   SupportSCoin,
   ScallopUtilsInstanceParams,
   SupportSuiBridgeCoins,
   SupportWormholeCoins,
+  PoolAddressInfo,
 } from '../types';
 import { queryKeys } from 'src/constants';
 import type { SuiObjectArg, SuiTxArg, SuiTxBlock } from '@scallop-io/sui-kit';
+import { newSuiKit } from './suiKit';
 
 /**
  * @description
@@ -69,7 +73,6 @@ export class ScallopUtils {
   public address: ScallopAddress;
   public cache: ScallopCache;
   public walletAddress: string;
-  private _priceMap: PriceMap = new Map();
 
   public constructor(
     params: ScallopUtilsParams,
@@ -80,9 +83,7 @@ export class ScallopUtils {
       ...params,
     };
     this.suiKit =
-      instance?.suiKit ??
-      instance?.address?.cache._suiKit ??
-      new SuiKit(params);
+      instance?.suiKit ?? instance?.address?.cache._suiKit ?? newSuiKit(params);
 
     this.walletAddress = params.walletAddress ?? this.suiKit.currentAddress();
 
@@ -100,7 +101,7 @@ export class ScallopUtils {
         instance?.address ??
         new ScallopAddress(
           {
-            id: params?.addressesId || ADDRESSES_ID,
+            id: params?.addressesId ?? ADDRESSES_ID,
             network: params?.networkType,
             forceInterface: params?.forceAddressesInterface,
           },
@@ -224,6 +225,7 @@ export class ScallopUtils {
       return undefined;
     }
   }
+
   /**
    * Convert sCoin name into sCoin type
    * @param sCoinName
@@ -233,6 +235,15 @@ export class ScallopUtils {
     return sCoinIds[sCoinName];
   }
 
+  /**
+   * Convert sCoinType into sCoin name
+   * @param sCoinType
+   * @returns sCoin name
+   */
+  public parseSCoinNameFromType(sCoinType: string) {
+    return sCoinTypeToName[sCoinType];
+  }
+
   /**
    * Convert sCoin name into its underlying coin type
    * @param sCoinName
@@ -261,7 +272,7 @@ export class ScallopUtils {
    */
   public parseMarketCoinType(coinName: SupportCoins) {
     const protocolObjectId =
-      this.address.get('core.object') || PROTOCOL_OBJECT_ID;
+      this.address.get('core.object') ?? PROTOCOL_OBJECT_ID;
     const coinType = this.parseCoinType(coinName);
     return `${protocolObjectId}::reserve::MarketCoin<${coinType}>`;
   }
@@ -290,7 +301,7 @@ export class ScallopUtils {
     const coinTypeRegex = new RegExp(`((0x[^:]+::[^:]+::[^<>]+))(?![^<>]*<)`);
     const coinTypeMatch = coinType.match(coinTypeRegex);
     const isMarketCoinType = coinType.includes('reserve::MarketCoin');
-    coinType = coinTypeMatch?.[1] || coinType;
+    coinType = coinTypeMatch?.[1] ?? coinType;
 
     const wormHoleCoinTypeMap: Record<string, SupportAssetCoins> = {
       [`${
@@ -428,7 +439,7 @@ export class ScallopUtils {
     coinType: string = SUI_TYPE_ARG,
     ownerAddress?: string
   ) {
-    ownerAddress = ownerAddress || this.suiKit.currentAddress();
+    ownerAddress = ownerAddress ?? this.suiKit.currentAddress();
     const coins = await this.suiKit.suiInteractor.selectCoins(
       ownerAddress,
       amount,
@@ -508,100 +519,68 @@ export class ScallopUtils {
    * @return  Asset coin price.
    */
   public async getCoinPrices(
-    assetCoinNames: SupportAssetCoins[] = [
+    _: SupportAssetCoins[] = [
       ...new Set([...SUPPORT_POOLS, ...SUPPORT_COLLATERALS]),
     ] as SupportAssetCoins[]
   ) {
-    const coinPrices: CoinPrices = {};
-    const existPricesCoinNames: SupportAssetCoins[] = [];
-    const lackPricesCoinNames: SupportAssetCoins[] = [];
-
-    assetCoinNames.forEach((assetCoinName) => {
-      if (
-        this._priceMap.has(assetCoinName) &&
-        Date.now() - this._priceMap.get(assetCoinName)!.publishTime < 1000 * 60
-      ) {
-        existPricesCoinNames.push(assetCoinName);
-      } else {
-        lackPricesCoinNames.push(assetCoinName);
-        this.cache.queryClient.invalidateQueries({
-          queryKey: queryKeys.oracle.getPythLatestPriceFeed(
-            this.address.get(`core.coins.${assetCoinName}.oracle.pyth.feed`)
-          ),
-        });
-      }
-    });
-
-    if (existPricesCoinNames.length > 0) {
-      for (const coinName of existPricesCoinNames) {
-        coinPrices[coinName] = this._priceMap.get(coinName)!.price;
-      }
-    }
+    let coinPrices: CoinPrices = {};
+
+    const endpoints =
+      this.params.pythEndpoints ??
+      PYTH_ENDPOINTS[this.isTestnet ? 'testnet' : 'mainnet'];
+
+    const failedRequests: Set<SupportAssetCoins> = new Set([
+      ...SUPPORT_POOLS,
+      ...SUPPORT_COLLATERALS,
+    ]);
+
+    for (const endpoint of endpoints) {
+      const priceIdPairs = Array.from(failedRequests.values()).reduce(
+        (acc, coinName) => {
+          const priceId = this.address.get(
+            `core.coins.${coinName}.oracle.pyth.feed`
+          );
+          acc.push([coinName, priceId]);
+          return acc;
+        },
+        [] as [string, string][]
+      );
 
-    if (lackPricesCoinNames.length > 0) {
-      const endpoints =
-        this.params.pythEndpoints ??
-        PYTH_ENDPOINTS[this.isTestnet ? 'testnet' : 'mainnet'];
+      const priceIds = priceIdPairs.map(([_, priceId]) => priceId);
 
-      const failedRequests: Set<SupportAssetCoins> = new Set(
-        lackPricesCoinNames
-      );
+      const pythConnection = new SuiPriceServiceConnection(endpoint, {
+        timeout: 2000,
+      });
 
-      for (const endpoint of endpoints) {
-        const priceIds = Array.from(failedRequests.values()).reduce(
-          (acc, coinName) => {
-            const priceId = this.address.get(
-              `core.coins.${coinName}.oracle.pyth.feed`
-            );
-            acc[coinName] = priceId;
-            return acc;
+      try {
+        const feeds = await this.cache.queryClient.fetchQuery({
+          queryKey: queryKeys.oracle.getPythLatestPriceFeeds(),
+          queryFn: async () => {
+            return await pythConnection.getLatestPriceFeeds(priceIds);
           },
-          {} as Record<SupportAssetCoins, string>
-        );
-
-        await Promise.allSettled(
-          Object.entries(priceIds).map(async ([coinName, priceId]) => {
-            const pythConnection = new SuiPriceServiceConnection(endpoint);
-            try {
-              const feed = await this.cache.queryClient.fetchQuery({
-                queryKey: queryKeys.oracle.getPythLatestPriceFeed(priceId),
-                queryFn: async () => {
-                  return (
-                    (await pythConnection.getLatestPriceFeeds([priceId])) ?? []
-                  );
-                },
-              });
-              if (feed[0]) {
-                const data = parseDataFromPythPriceFeed(feed[0], this.address);
-                this._priceMap.set(coinName as SupportAssetCoins, {
-                  price: data.price,
-                  publishTime: data.publishTime,
-                });
-                coinPrices[coinName as SupportAssetCoins] = data.price;
-              }
-              failedRequests.delete(coinName as SupportAssetCoins); // remove success price feed to prevent duplicate request on the next endpoint
-            } catch (e) {
-              console.warn(
-                `Failed to get price ${coinName} feeds with endpoint ${endpoint}: ${e}`
-              );
-            }
-          })
-        );
-        if (failedRequests.size === 0) break;
+          staleTime: 30000,
+          gcTime: 30000,
+        });
+        if (feeds) {
+          feeds.forEach((feed, idx) => {
+            const coinName = priceIdPairs[idx][0] as SupportAssetCoins;
+            const data = parseDataFromPythPriceFeed(feed, this.address);
+            coinPrices[coinName as SupportAssetCoins] = data.price;
+            failedRequests.delete(coinName as SupportAssetCoins); // remove success price feed to prevent duplicate request on the next endpoint
+          });
+        }
+      } catch (e: any) {
+        console.error(e.message);
       }
+      if (failedRequests.size === 0) break;
+    }
 
-      if (failedRequests.size > 0) {
-        await Promise.allSettled(
-          Array.from(failedRequests.values()).map(async (coinName) => {
-            const price = await getPythPrice(this, coinName);
-            this._priceMap.set(coinName, {
-              price: price,
-              publishTime: Date.now(),
-            });
-            coinPrices[coinName] = price;
-          })
-        );
-      }
+    if (failedRequests.size > 0) {
+      coinPrices = {
+        ...coinPrices,
+        ...(await getPythPrices(this, Array.from(failedRequests.values()))),
+      };
+      failedRequests.clear();
     }
 
     return coinPrices;
@@ -670,4 +649,25 @@ export class ScallopUtils {
     }
     return findClosestUnlockRound(newUnlockAtInSecondTimestamp);
   }
+
+  /**
+   * Get detailed contract address and price id information for supported pool in Scallop
+   * @returns Supported pool informations
+   */
+  public getSupportedPoolAddresses(): PoolAddressInfo[] {
+    return SUPPORT_POOLS.map((poolName) => {
+      const sCoinName = this.parseSCoinName(poolName)!;
+      return {
+        name: this.parseSymbol(poolName),
+        coingeckoId: COIN_GECKGO_IDS[poolName],
+        decimal: coinDecimals[poolName],
+        pythFeedId: PYTH_FEED_IDS[poolName],
+        ...POOL_ADDRESSES[poolName],
+        sCoinAddress: sCoinIds[sCoinName],
+        marketCoinAddress: this.parseMarketCoinType(poolName),
+        coinAddress: this.parseCoinType(poolName),
+        sCoinName: sCoinName ? this.parseSymbol(sCoinName) : undefined,
+      };
+    });
+  }
 }

package/src/models/suiKit.ts

@@ -0,0 +1,11 @@
+import { SuiKit, SuiKitParams } from '@scallop-io/sui-kit';
+import { RPC_PROVIDERS } from 'src/constants/rpc';
+
+export const newSuiKit = (params: SuiKitParams) => {
+  return new SuiKit({
+    ...params,
+    fullnodeUrls: Array.from(
+      new Set([...(params.fullnodeUrls ?? []), ...RPC_PROVIDERS])
+    ),
+  });
+};

package/src/queries/borrowIncentiveQuery.ts

@@ -1,8 +1,5 @@
 import { normalizeStructTag } from '@mysten/sui/utils';
-import {
-  SUPPORT_BORROW_INCENTIVE_POOLS,
-  SUPPORT_BORROW_INCENTIVE_REWARDS,
-} from '../constants';
+import { SUPPORT_BORROW_INCENTIVE_POOLS } from '../constants';
 import {
   parseOriginBorrowIncentivePoolData,
   parseOriginBorrowIncentiveAccountData,
@@ -19,6 +16,7 @@ import type {
   BorrowIncentivePoolPoints,
   OptionalKeys,
   BorrowIncentivePool,
+  CoinPrices,
 } from '../types';
 import BigNumber from 'bignumber.js';
 
@@ -56,17 +54,12 @@ export const getBorrowIncentivePools = async (
   borrowIncentiveCoinNames: SupportBorrowIncentiveCoins[] = [
     ...SUPPORT_BORROW_INCENTIVE_POOLS,
   ],
-  indexer: boolean = false
+  indexer: boolean = false,
+  coinPrices?: CoinPrices
 ) => {
   const borrowIncentivePools: BorrowIncentivePools = {};
 
-  const coinPrices =
-    (await query.utils.getCoinPrices([
-      ...new Set([
-        ...borrowIncentiveCoinNames,
-        ...SUPPORT_BORROW_INCENTIVE_REWARDS,
-      ]),
-    ])) ?? {};
+  coinPrices = coinPrices ?? (await query.utils.getCoinPrices()) ?? {};
 
   if (indexer) {
     const borrowIncentivePoolsIndexer =
@@ -74,7 +67,7 @@ export const getBorrowIncentivePools = async (
 
     const updateBorrowIncentivePool = (pool: BorrowIncentivePool) => {
       if (!borrowIncentiveCoinNames.includes(pool.coinName)) return;
-      pool.coinPrice = coinPrices[pool.coinName] || pool.coinPrice;
+      pool.coinPrice = coinPrices[pool.coinName] ?? pool.coinPrice;
       borrowIncentivePools[pool.coinName] = pool;
     };