@scallop-io/sui-scallop-sdk 0.44.28 → 0.46.0

package/src/models/scallopIndexer.ts

@@ -15,7 +15,11 @@ import type {
   SupportStakeMarketCoins,
   SupportBorrowIncentiveCoins,
   TotalValueLocked,
+  ScallopQueryParams,
+  ScallopParams,
+  ScallopInstanceParams,
 } from '../types';
+import { ScallopCache } from './scallopCache';
 
 /**
  * @description
@@ -30,9 +34,13 @@ import type {
  * ```
  */
 export class ScallopIndexer {
-  private _requestClient: AxiosInstance;
+  private readonly _cache: ScallopCache;
+  public readonly params: ScallopQueryParams;
+  private readonly _requestClient: AxiosInstance;
 
-  public constructor() {
+  public constructor(params: ScallopParams, instance?: ScallopInstanceParams) {
+    this.params = params;
+    this._cache = instance?.cache ?? new ScallopCache();
     this._requestClient = axios.create({
       baseURL: SDK_API_BASE_URL,
       headers: {
@@ -49,10 +57,15 @@ export class ScallopIndexer {
    * @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`);
+    const response = await this._cache.queryClient.fetchQuery({
+      queryKey: ['market'],
+      queryFn: async () => {
+        return await this._requestClient.get<{
+          pools: MarketPool[];
+          collaterals: MarketCollateral[];
+        }>(`/api/market`);
+      },
+    });
 
     if (response.status === 200) {
       return {
@@ -79,18 +92,8 @@ export class ScallopIndexer {
    * @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.');
-    }
+    const response = (await this.getMarket()).pools;
+    return response as Required<MarketPools>;
   }
 
   /**
@@ -101,15 +104,7 @@ export class ScallopIndexer {
   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.');
-    }
+    return (await this.getMarketPools())[poolCoinName] as MarketPool;
   }
 
   /**
@@ -118,21 +113,7 @@ export class ScallopIndexer {
    * @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.');
-    }
+    return (await this.getMarket()).collaterals as Required<MarketCollaterals>;
   }
 
   /**
@@ -143,15 +124,9 @@ export class ScallopIndexer {
   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.');
-    }
+    return (await this.getMarketCollaterals())[
+      collateralCoinName
+    ] as MarketCollateral;
   }
 
   /**
@@ -160,9 +135,14 @@ export class ScallopIndexer {
    * @return Spools data.
    */
   public async getSpools(): Promise<Required<Spools>> {
-    const response = await this._requestClient.get<{
-      spools: Spool[];
-    }>(`${SDK_API_BASE_URL}/api/spools`);
+    const response = await this._cache.queryClient.fetchQuery({
+      queryKey: ['spools'],
+      queryFn: async () => {
+        return await this._requestClient.get<{
+          spools: Spool[];
+        }>(`/api/spools`);
+      },
+    });
 
     if (response.status === 200) {
       return response.data.spools.reduce((spools, spool) => {
@@ -182,15 +162,7 @@ export class ScallopIndexer {
   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.');
-    }
+    return (await this.getSpools())[marketCoinName] as Spool;
   }
 
   /**
@@ -201,9 +173,14 @@ export class ScallopIndexer {
   public async getBorrowIncentivePools(): Promise<
     Required<BorrowIncentivePools>
   > {
-    const response = await this._requestClient.get<{
-      borrowIncentivePools: BorrowIncentivePool[];
-    }>(`${SDK_API_BASE_URL}/api/borrowIncentivePools`);
+    const response = await this._cache.queryClient.fetchQuery({
+      queryKey: ['borrowIncentivePools'],
+      queryFn: async () => {
+        return await this._requestClient.get<{
+          borrowIncentivePools: BorrowIncentivePool[];
+        }>(`/api/borrowIncentivePools`);
+      },
+    });
 
     if (response.status === 200) {
       return response.data.borrowIncentivePools.reduce(
@@ -227,17 +204,9 @@ export class ScallopIndexer {
   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.');
-    }
+    return (await this.getBorrowIncentivePools())[
+      borrowIncentiveCoinName
+    ] as BorrowIncentivePool;
   }
 
   /**
@@ -252,13 +221,18 @@ export class ScallopIndexer {
       supplyValueChangeRatio: number;
     }
   > {
-    const response = await this._requestClient.get<
-      TotalValueLocked & {
-        totalValueChangeRatio: number;
-        borrowValueChangeRatio: number;
-        supplyValueChangeRatio: number;
-      }
-    >(`${SDK_API_BASE_URL}/api/market/tvl`);
+    const response = await this._cache.queryClient.fetchQuery({
+      queryKey: ['totalValueLocked'],
+      queryFn: async () => {
+        return await this._requestClient.get<
+          TotalValueLocked & {
+            totalValueChangeRatio: number;
+            borrowValueChangeRatio: number;
+            supplyValueChangeRatio: number;
+          }
+        >(`/api/market/tvl`);
+      },
+    });
 
     if (response.status === 200) {
       return response.data;

package/src/models/scallopQuery.ts

@@ -25,8 +25,12 @@ import {
   getObligationAccounts,
   getObligationAccount,
   getTotalValueLocked,
+  queryVeScaKeyIdFromReferralBindings,
   getBindedObligationId,
   getBindedVeScaKey,
+  getVeScas,
+  getPythPrices,
+  getTotalVeScaTreasuryAmount,
 } from '../queries';
 import {
   ScallopQueryParams,
@@ -43,6 +47,8 @@ import {
 import { ScallopAddress } from './scallopAddress';
 import { ScallopUtils } from './scallopUtils';
 import { ScallopIndexer } from './scallopIndexer';
+import { ScallopCache } from './scallopCache';
+import { DEFAULT_CACHE_OPTIONS } from 'src/constants/cache';
 
 /**
  * @description
@@ -63,6 +69,7 @@ export class ScallopQuery {
   public address: ScallopAddress;
   public utils: ScallopUtils;
   public indexer: ScallopIndexer;
+  public cache: ScallopCache;
 
   public constructor(
     params: ScallopQueryParams,
@@ -70,20 +77,26 @@ export class ScallopQuery {
   ) {
     this.params = params;
     this.suiKit = instance?.suiKit ?? new SuiKit(params);
+    this.cache =
+      instance?.cache ?? new ScallopCache(DEFAULT_CACHE_OPTIONS, this.suiKit);
     this.address =
       instance?.address ??
-      new ScallopAddress({
-        id: params?.addressesId || ADDRESSES_ID,
-        network: params?.networkType,
-      });
+      new ScallopAddress(
+        {
+          id: params?.addressesId || ADDRESSES_ID,
+          network: params?.networkType,
+        },
+        this.cache
+      );
     this.utils =
       instance?.utils ??
       new ScallopUtils(this.params, {
         suiKit: this.suiKit,
         address: this.address,
+        cache: this.cache,
         query: this,
       });
-    this.indexer = new ScallopIndexer();
+    this.indexer = new ScallopIndexer(this.params, { cache: this.cache });
   }
 
   /**
@@ -263,6 +276,16 @@ export class ScallopQuery {
     return await getPythPrice(this, assetCoinName);
   }
 
+  /**
+   * Get prices from pyth fee object.
+   *
+   * @param assetCoinNames - Array of supported asset coin names.
+   * @return Array of asset coin prices.
+   */
+  public async getPricesFromPyth(assetCoinNames: SupportAssetCoins[]) {
+    return await getPythPrices(this, assetCoinNames);
+  }
+
   /* ==================== Spool Query Methods ==================== */
 
   /**
@@ -515,6 +538,32 @@ export class ScallopQuery {
     return await getTotalValueLocked(this, indexer);
   }
 
+  /**
+   * Get all veSca from walletAdddress
+   * @param walletAddress
+   * @returns array of veSca
+   */
+  public async getVeScas(walletAddress: string) {
+    return await getVeScas(this, walletAddress);
+  }
+
+  /**
+   * Get total vesca treasury with movecall
+   * @returns Promise<string | undefined>
+   */
+  public async getTotalVeScaTreasuryAmount() {
+    return await getTotalVeScaTreasuryAmount(this);
+  }
+
+  /**
+   * Return binded veScaKeyId of walletAddress if exist
+   * @param walletAddress
+   * @returns veScaKeyId
+   */
+  public async getVeScaKeyIdFromReferralBindings(walletAddress: string) {
+    return await queryVeScaKeyIdFromReferralBindings(this, walletAddress);
+  }
+
   /**
    * Get binded obligationId from a veScaKey if it exists.
    * @param veScaKey

package/src/models/scallopUtils.ts

@@ -37,6 +37,8 @@ import type {
   CoinWrappedType,
 } from '../types';
 import { PYTH_ENDPOINTS } from 'src/constants/pyth';
+import { ScallopCache } from './scallopCache';
+import { DEFAULT_CACHE_OPTIONS } from 'src/constants/cache';
 
 /**
  * @description
@@ -58,6 +60,7 @@ export class ScallopUtils {
   private _address: ScallopAddress;
   private _query: ScallopQuery;
   private _priceMap: PriceMap = new Map();
+  private _cache: ScallopCache;
 
   public constructor(
     params: ScallopUtilsParams,
@@ -65,17 +68,23 @@ export class ScallopUtils {
   ) {
     this.params = params;
     this._suiKit = instance?.suiKit ?? new SuiKit(params);
+    this._cache =
+      instance?.cache ?? new ScallopCache(DEFAULT_CACHE_OPTIONS, this._suiKit);
     this._address =
       instance?.address ??
-      new ScallopAddress({
-        id: params?.addressesId || ADDRESSES_ID,
-        network: params?.networkType,
-      });
+      new ScallopAddress(
+        {
+          id: params?.addressesId || ADDRESSES_ID,
+          network: params?.networkType,
+        },
+        this._cache
+      );
     this._query =
       instance?.query ??
       new ScallopQuery(params, {
         suiKit: this._suiKit,
         address: this._address,
+        cache: this._cache,
       });
     this.isTestnet = params.networkType
       ? params.networkType === 'testnet'
@@ -404,43 +413,63 @@ export class ScallopUtils {
       const endpoints =
         this.params.pythEndpoints ??
         PYTH_ENDPOINTS[this.isTestnet ? 'testnet' : 'mainnet'];
-      try {
-        for (const endpoint of endpoints) {
-          try {
-            const pythConnection = new SuiPriceServiceConnection(endpoint);
-            const priceIds = lackPricesCoinNames.map((coinName) =>
-              this._address.get(`core.coins.${coinName}.oracle.pyth.feed`)
+
+      const failedRequests: Set<SupportAssetCoins> = new Set(
+        lackPricesCoinNames
+      );
+
+      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`
             );
-            const priceFeeds =
-              (await pythConnection.getLatestPriceFeeds(priceIds)) || [];
-            for (const [index, feed] of priceFeeds.entries()) {
-              const data = parseDataFromPythPriceFeed(feed, this._address);
-              const coinName = lackPricesCoinNames[index];
-              this._priceMap.set(coinName, {
-                price: data.price,
-                publishTime: data.publishTime,
+            acc[coinName] = priceId;
+            return acc;
+          },
+          {} 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: [priceId],
+                queryFn: async () => {
+                  return await pythConnection.getLatestPriceFeeds([priceId]);
+                },
               });
-              coinPrices[coinName] = data.price;
+              if (feed) {
+                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;
+      }
 
-            break;
-          } catch (e) {
-            console.warn(
-              `Failed to update price feeds with endpoint ${endpoint}: ${e}`
-            );
-          }
-
-          throw new Error('Failed to update price feeds with all endpoins');
-        }
-      } catch (_e) {
-        for (const coinName of lackPricesCoinNames) {
-          const price = await this._query.getPriceFromPyth(coinName);
-          this._priceMap.set(coinName, {
-            price: price,
-            publishTime: Date.now(),
-          });
-          coinPrices[coinName] = price;
-        }
+      if (failedRequests.size > 0) {
+        await Promise.allSettled(
+          Array.from(failedRequests.values()).map(async (coinName) => {
+            const price = await this._query.getPriceFromPyth(coinName);
+            this._priceMap.set(coinName, {
+              price: price,
+              publishTime: Date.now(),
+            });
+            coinPrices[coinName] = price;
+          })
+        );
       }
     }
 

package/src/queries/borrowIncentiveQuery.ts

@@ -1,7 +1,5 @@
 import { normalizeStructTag } from '@mysten/sui.js/utils';
-import { SuiTxBlock as SuiKitTxBlock } from '@scallop-io/sui-kit';
 import {
-  IS_VE_SCA_TEST,
   SUPPORT_BORROW_INCENTIVE_POOLS,
   SUPPORT_BORROW_INCENTIVE_REWARDS,
 } from '../constants';
@@ -41,10 +39,9 @@ export const queryBorrowIncentivePools = async (
   const queryPkgId = query.address.get('borrowIncentive.query');
   const incentivePoolsId = query.address.get('borrowIncentive.incentivePools');
 
-  const txBlock = new SuiKitTxBlock();
   const queryTarget = `${queryPkgId}::incentive_pools_query::incentive_pools_data`;
-  txBlock.moveCall(queryTarget, [incentivePoolsId]);
-  const queryResult = await query.suiKit.inspectTxn(txBlock);
+  const args = [incentivePoolsId];
+  const queryResult = await query.cache.queryInspectTxn({ queryTarget, args });
   const borrowIncentivePoolsQueryData = queryResult.events[0]
     .parsedJson as BorrowIncentivePoolsQueryInterface;
 
@@ -170,10 +167,9 @@ export const queryBorrowIncentiveAccounts = async (
     'borrowIncentive.incentiveAccounts'
   );
   const queryTarget = `${queryPkgId}::incentive_account_query::incentive_account_data`;
+  const args = [incentiveAccountsId, obligationId];
 
-  const txBlock = new SuiKitTxBlock();
-  txBlock.moveCall(queryTarget, [incentiveAccountsId, obligationId]);
-  const queryResult = await query.suiKit.inspectTxn(txBlock);
+  const queryResult = await query.cache.queryInspectTxn({ queryTarget, args });
   const borrowIncentiveAccountsQueryData = queryResult.events[0]
     .parsedJson as BorrowIncentiveAccountsQueryInterface;
 
@@ -211,9 +207,7 @@ export const getBindedObligationId = async (
 ): Promise<string | null> => {
   const borrowIncentiveObjectId = query.address.get('borrowIncentive.object');
   const incentivePoolsId = query.address.get('borrowIncentive.incentivePools');
-  const veScaPkgId = IS_VE_SCA_TEST
-    ? '0xb220d034bdf335d77ae5bfbf6daf059c2cc7a1f719b12bfed75d1736fac038c8'
-    : query.address.get('vesca.id');
+  const veScaObjId = query.address.get('vesca.object');
 
   const client = query.suiKit.client();
 
@@ -232,7 +226,7 @@ export const getBindedObligationId = async (
     .id as string;
 
   // check if veSca is inside the bind table
-  const keyType = `${borrowIncentiveObjectId}::typed_id::TypedID<${veScaPkgId}::ve_sca::VeScaKey>`;
+  const keyType = `${borrowIncentiveObjectId}::typed_id::TypedID<${veScaObjId}::ve_sca::VeScaKey>`;
   const veScaBindTableResponse = await client.getDynamicFieldObject({
     parentId: veScaBindTableId,
     name: {