@scallop-io/sui-scallop-sdk 1.4.15-rc.3 → 1.4.16

package/src/models/scallopClient.ts

@@ -1,6 +1,5 @@
 import { normalizeSuiAddress } from '@mysten/sui/utils';
 import { SuiKit } from '@scallop-io/sui-kit';
-import { DEFAULT_CACHE_OPTIONS } from 'src/constants/cache';
 import {
   ADDRESSES_ID,
   SUPPORT_BORROW_INCENTIVE_POOLS,
@@ -75,11 +74,9 @@ export class ScallopClient {
       this.address = this.utils.address;
       this.cache = this.address.cache;
     } else {
-      this.cache = new ScallopCache(
-        this.suiKit,
-        this.walletAddress,
-        DEFAULT_CACHE_OPTIONS
-      );
+      this.cache = new ScallopCache(this.params, {
+        suiKit: this.suiKit,
+      });
       this.address = new ScallopAddress(
         {
           id: params?.addressesId ?? ADDRESSES_ID,

package/src/models/scallopIndexer.ts

@@ -22,8 +22,6 @@ import type {
   ScallopIndexerInstanceParams,
 } from '../types';
 import { ScallopCache } from './scallopCache';
-import { DEFAULT_CACHE_OPTIONS } from 'src/constants/cache';
-import { SuiKit } from '@scallop-io/sui-kit';
 import { queryKeys } from 'src/constants';
 
 /**
@@ -48,9 +46,7 @@ export class ScallopIndexer {
     instance?: ScallopIndexerInstanceParams
   ) {
     this.params = params;
-    this.cache =
-      instance?.cache ??
-      new ScallopCache(new SuiKit({}), undefined, DEFAULT_CACHE_OPTIONS);
+    this.cache = instance?.cache ?? new ScallopCache(this.params);
     this._requestClient = axios.create({
       baseURL: SDK_API_BASE_URL,
       headers: {

package/src/models/scallopQuery.ts

@@ -1,10 +1,5 @@
-import { SuiKit } from '@scallop-io/sui-kit';
-import {
-  ADDRESSES_ID,
-  SUPPORT_POOLS,
-  SUPPORT_SPOOLS,
-  DEFAULT_CACHE_OPTIONS,
-} from '../constants';
+import { SuiKit, SuiObjectArg } from '@scallop-io/sui-kit';
+import { ADDRESSES_ID, SUPPORT_POOLS, SUPPORT_SPOOLS } from '../constants';
 import {
   queryMarket,
   getObligations,
@@ -47,6 +42,7 @@ import {
   getAllCoinPrices,
   getAllAddresses,
   isIsolatedAsset,
+  getUserPortfolio,
 } from '../queries';
 import {
   ScallopQueryParams,
@@ -63,6 +59,7 @@ import {
   MarketPool,
   CoinPrices,
   MarketPools,
+  MarketCollaterals,
 } from '../types';
 import { ScallopAddress } from './scallopAddress';
 import { ScallopUtils } from './scallopUtils';
@@ -72,6 +69,7 @@ import { SuiObjectData } from '@mysten/sui/client';
 import { normalizeSuiAddress } from '@mysten/sui/utils';
 import { withIndexerFallback } from 'src/utils/indexer';
 import { newSuiKit } from './suiKit';
+import { SuiObjectRef } from '@mysten/sui/client';
 /**
  * @description
  * It provides methods for getting on-chain data from the Scallop contract.
@@ -111,11 +109,9 @@ export class ScallopQuery {
       this.address = instance.utils.address;
       this.cache = this.address.cache;
     } else {
-      this.cache = new ScallopCache(
-        this.suiKit,
-        this.walletAddress,
-        DEFAULT_CACHE_OPTIONS
-      );
+      this.cache = new ScallopCache(this.params, {
+        suiKit: this.suiKit,
+      });
       this.address = new ScallopAddress(
         {
           id: params?.addressesId ?? ADDRESSES_ID,
@@ -298,7 +294,7 @@ export class ScallopQuery {
    * @param obligationId - The obligation id.
    * @return Obligation data.
    */
-  public async queryObligation(obligationId: string) {
+  public async queryObligation(obligationId: string | SuiObjectArg) {
     return queryObligation(this, obligationId);
   }
 
@@ -564,7 +560,7 @@ export class ScallopQuery {
    * @return Borrow incentive accounts data.
    */
   public async getBorrowIncentiveAccounts(
-    obligationId: string,
+    obligationId: string | SuiObjectRef,
     coinNames?: SupportBorrowIncentiveCoins[]
   ) {
     return await queryBorrowIncentiveAccounts(this, obligationId, coinNames);
@@ -581,9 +577,20 @@ export class ScallopQuery {
   public async getLendings(
     poolCoinNames?: SupportPoolCoins[],
     ownerAddress: string = this.walletAddress,
-    args?: { indexer?: boolean }
+    args?: {
+      indexer?: boolean;
+      marketPools?: MarketPools;
+      coinPrices?: CoinPrices;
+    }
   ) {
-    return await getLendings(this, poolCoinNames, ownerAddress, args?.indexer);
+    return await getLendings(
+      this,
+      poolCoinNames,
+      ownerAddress,
+      args?.marketPools,
+      args?.coinPrices,
+      args?.indexer
+    );
   }
 
   /**
@@ -614,9 +621,22 @@ export class ScallopQuery {
    */
   public async getObligationAccounts(
     ownerAddress: string = this.walletAddress,
-    args?: { indexer?: boolean }
+    args?: {
+      indexer?: boolean;
+      market?: {
+        collaterals: MarketCollaterals;
+        pools: MarketPools;
+      };
+      coinPrices?: CoinPrices;
+    }
   ) {
-    return await getObligationAccounts(this, ownerAddress, args?.indexer);
+    return await getObligationAccounts(
+      this,
+      ownerAddress,
+      args?.market,
+      args?.coinPrices,
+      args?.indexer
+    );
   }
 
   /**
@@ -843,10 +863,24 @@ export class ScallopQuery {
   }
 
   /**
-   * Query all address (lending pool, collateral pool, borrow dynamics, interest models) of all pool
+   * Query all address (lending pool, collateral pool, borrow dynamics, interest models, etc.) of all pool
    * @returns
    */
   public async getPoolAddresses() {
     return getAllAddresses(this);
   }
+
+  /**
+   * Get user portfolio
+   */
+  public async getUserPortfolio(args?: {
+    walletAddress?: string;
+    indexer?: boolean;
+  }) {
+    return getUserPortfolio(
+      this,
+      args?.walletAddress ?? this.walletAddress,
+      args?.indexer ?? false
+    );
+  }
 }

package/src/models/scallopUtils.ts

@@ -33,7 +33,6 @@ import {
 } from '../utils';
 import { PYTH_ENDPOINTS, PYTH_FEED_IDS } from 'src/constants/pyth';
 import { ScallopCache } from './scallopCache';
-import { DEFAULT_CACHE_OPTIONS } from 'src/constants/cache';
 import type {
   ScallopUtilsParams,
   SupportCoins,
@@ -49,7 +48,7 @@ import type {
   PoolAddressInfo,
 } from '../types';
 import { queryKeys } from 'src/constants';
-import type { SuiObjectArg, SuiTxArg, SuiTxBlock } from '@scallop-io/sui-kit';
+import type { SuiObjectArg, SuiTxBlock } from '@scallop-io/sui-kit';
 import { newSuiKit } from './suiKit';
 
 /**
@@ -81,21 +80,18 @@ export class ScallopUtils {
       pythEndpoints: params.pythEndpoints ?? PYTH_ENDPOINTS['mainnet'],
       ...params,
     };
+    this.walletAddress =
+      params.walletAddress ?? instance?.suiKit?.currentAddress() ?? '';
     this.suiKit =
-      instance?.suiKit ?? instance?.address?.cache._suiKit ?? newSuiKit(params);
-
-    this.walletAddress = params.walletAddress ?? this.suiKit.currentAddress();
+      instance?.suiKit ?? instance?.address?.cache.suiKit ?? newSuiKit(params);
 
     if (instance?.address) {
       this.address = instance.address;
       this.cache = this.address.cache;
-      this.suiKit = this.address.cache._suiKit;
     } else {
-      this.cache = new ScallopCache(
-        this.suiKit,
-        this.walletAddress,
-        DEFAULT_CACHE_OPTIONS
-      );
+      this.cache = new ScallopCache(this.params, {
+        suiKit: this.suiKit,
+      });
       this.address =
         instance?.address ??
         new ScallopAddress(
@@ -450,7 +446,7 @@ export class ScallopUtils {
     coinType: string = SUI_TYPE_ARG,
     ownerAddress?: string
   ) {
-    ownerAddress = ownerAddress ?? this.suiKit.currentAddress();
+    ownerAddress = ownerAddress ?? this.walletAddress;
     const coins = await this.suiKit.suiInteractor.selectCoins(
       ownerAddress,
       amount,
@@ -468,7 +464,7 @@ export class ScallopUtils {
    */
   public async mergeSimilarCoins(
     txBlock: SuiTxBlock,
-    dest: SuiTxArg,
+    dest: SuiObjectArg,
     coinType: string,
     sender: string = this.walletAddress
   ): Promise<void> {

package/src/queries/borrowIncentiveQuery.ts

@@ -23,6 +23,7 @@ import type {
   MarketPools,
 } from '../types';
 import BigNumber from 'bignumber.js';
+import { SuiObjectRef } from '@mysten/sui/client';
 
 /**
  * Query borrow incentive pools data using moveCall
@@ -188,7 +189,7 @@ export const queryBorrowIncentiveAccounts = async (
   }: {
     utils: ScallopUtils;
   },
-  obligationId: string,
+  obligationId: string | SuiObjectRef,
   borrowIncentiveCoinNames: SupportBorrowIncentiveCoins[] = [
     ...SUPPORT_BORROW_INCENTIVE_POOLS,
   ]
@@ -245,12 +246,8 @@ export const getBindedObligationId = async (
   const veScaObjId = address.get('vesca.object');
 
   // get incentive pools
-  const incentivePoolsResponse = await address.cache.queryGetObject(
-    incentivePoolsId,
-    {
-      showContent: true,
-    }
-  );
+  const incentivePoolsResponse =
+    await address.cache.queryGetObject(incentivePoolsId);
 
   if (incentivePoolsResponse?.data?.content?.dataType !== 'moveObject')
     return null;
@@ -293,12 +290,8 @@ export const getBindedVeScaKey = async (
   const corePkg = address.get('core.object');
 
   // get IncentiveAccounts object
-  const incentiveAccountsObject = await address.cache.queryGetObject(
-    incentiveAccountsId,
-    {
-      showContent: true,
-    }
-  );
+  const incentiveAccountsObject =
+    await address.cache.queryGetObject(incentiveAccountsId);
   if (incentiveAccountsObject?.data?.content?.dataType !== 'moveObject')
     return null;
   const incentiveAccountsTableId = (

package/src/queries/coreQuery.ts

@@ -292,33 +292,65 @@ const queryRequiredMarketObjects = async (
   // Map the results back to poolCoinNames
   const mapObjects = (
     tasks: { poolCoinName: string; [key: string]: string | undefined }[],
-    fetchedObjects: SuiObjectData[]
+    fetchedObjects: SuiObjectData[],
+    keyValue: string
   ) => {
     const resultMap: Record<string, SuiObjectData> = {};
-    let fetchedIndex = 0;
+    const fetchedObjectMap = fetchedObjects.reduce(
+      (acc, obj) => {
+        acc[obj.objectId] = obj;
+        return acc;
+      },
+      {} as Record<string, SuiObjectData>
+    );
 
     for (const task of tasks) {
-      const key = task[Object.keys(task)[1]]; // current object key being queried
-      if (key) {
-        resultMap[task.poolCoinName] = fetchedObjects[fetchedIndex];
-        fetchedIndex++;
+      if (task[keyValue]) {
+        resultMap[task.poolCoinName] = fetchedObjectMap[task[keyValue]];
       }
     }
     return resultMap;
   };
 
-  const balanceSheetMap = mapObjects(tasks, balanceSheetObjects);
-  const collateralStatMap = mapObjects(tasks, collateralStatObjects);
-  const borrowDynamicMap = mapObjects(tasks, borrowDynamicObjects);
-  const interestModelMap = mapObjects(tasks, interestModelObjects);
-  const riskModelMap = mapObjects(tasks, riskModelObjects);
-  const borrowFeeMap = mapObjects(tasks, borrowFeeObjects);
-  const supplyLimitMap = mapObjects(tasks, supplyLimitObjects);
-  const borrowLimitMap = mapObjects(tasks, borrowLimitObjects);
-  const isolatedAssetMap = mapObjects(tasks, isolatedAssetObjects);
-
+  const balanceSheetMap = mapObjects(
+    tasks,
+    balanceSheetObjects,
+    'balanceSheet'
+  );
+  const collateralStatMap = mapObjects(
+    tasks,
+    collateralStatObjects,
+    'collateralStat'
+  );
+  const borrowDynamicMap = mapObjects(
+    tasks,
+    borrowDynamicObjects,
+    'borrowDynamic'
+  );
+  const interestModelMap = mapObjects(
+    tasks,
+    interestModelObjects,
+    'interestModel'
+  );
+  const riskModelMap = mapObjects(tasks, riskModelObjects, 'riskModel');
+  const borrowFeeMap = mapObjects(tasks, borrowFeeObjects, 'borrowFeeKey');
+  const supplyLimitMap = mapObjects(
+    tasks,
+    supplyLimitObjects,
+    'supplyLimitKey'
+  );
+  const borrowLimitMap = mapObjects(
+    tasks,
+    borrowLimitObjects,
+    'borrowLimitKey'
+  );
+  const isolatedAssetMap = mapObjects(
+    tasks,
+    isolatedAssetObjects,
+    'isolatedAssetKey'
+  );
   // Construct the final requiredObjects result
-  return poolCoinNames.reduce(
+  const result = poolCoinNames.reduce(
     (acc, name) => {
       acc[name] = {
         balanceSheet: balanceSheetMap[name],
@@ -348,6 +380,8 @@ const queryRequiredMarketObjects = async (
       }
     >
   );
+
+  return result;
 };
 
 /**
@@ -687,9 +721,7 @@ export const getMarketCollaterals = async (
     return marketCollaterals;
   }
 
-  const marketObjectResponse = await query.cache.queryGetObject(marketId, {
-    showContent: true,
-  });
+  const marketObjectResponse = await query.cache.queryGetObject(marketId);
   await Promise.allSettled(
     collateralCoinNames.map(async (collateralCoinName) => {
       const marketCollateral = await getMarketCollateral(
@@ -747,12 +779,7 @@ export const getMarketCollateral = async (
 
   const marketId = query.address.get('core.market');
   marketObject =
-    marketObject ||
-    (
-      await query.cache.queryGetObject(marketId, {
-        showContent: true,
-      })
-    )?.data;
+    marketObject || (await query.cache.queryGetObject(marketId))?.data;
 
   if (!(marketObject && marketObject.content?.dataType === 'moveObject'))
     throw new Error(`Failed to fetch marketObject`);
@@ -915,10 +942,7 @@ export const getObligations = async (
         (content): content is SuiParsedData & { dataType: 'moveObject' } =>
           content?.dataType === 'moveObject'
       )
-      .map((content) => (content.fields as any).ownership.fields.of),
-    {
-      showContent: true,
-    }
+      .map((content) => (content.fields as any).ownership.fields.of)
   );
 
   await Promise.allSettled(
@@ -953,11 +977,7 @@ export const getObligationLocked = async (
 ) => {
   const obligationObjectData =
     typeof obligation === 'string'
-      ? (
-          await cache.queryGetObject(obligation, {
-            showContent: true,
-          })
-        )?.data
+      ? (await cache.queryGetObject(obligation))?.data
       : obligation;
   let obligationLocked = false;
   if (
@@ -1045,11 +1065,11 @@ export const getCoinAmount = async (
 ) => {
   const owner = ownerAddress ?? query.suiKit.currentAddress();
   const coinType = query.utils.parseCoinType(assetCoinName);
-  const amount = await query.cache.queryGetCoinBalance({
+  const coinBalance = await query.cache.queryGetCoinBalance({
     owner,
     coinType: coinType,
   });
-  return BigNumber(amount).toNumber();
+  return BigNumber(coinBalance?.totalBalance ?? '0').toNumber();
 };
 
 /**
@@ -1102,11 +1122,11 @@ export const getMarketCoinAmount = async (
 ) => {
   const owner = ownerAddress ?? query.suiKit.currentAddress();
   const marketCoinType = query.utils.parseMarketCoinType(marketCoinName);
-  const amount = await query.cache.queryGetCoinBalance({
+  const coinBalance = await query.cache.queryGetCoinBalance({
     owner,
     coinType: marketCoinType,
   });
-  return BigNumber(amount).toNumber();
+  return BigNumber(coinBalance?.totalBalance ?? '0').toNumber();
 };
 
 /**
@@ -1145,16 +1165,12 @@ export const getFlashLoanFees = async (
     })
     .filter((t) => !!t) as string[];
 
-  const flashloanFeeObjects = await query.cache.queryGetObjects(objIds, {
-    showContent: true,
-  });
+  const flashloanFeeObjects = await query.cache.queryGetObjects(objIds);
 
   if (missingAssets.length > 0) {
     // get market object
     const marketObjectId = query.address.get('core.market');
-    const marketObjectRes = await query.cache.queryGetObject(marketObjectId, {
-      showContent: true,
-    });
+    const marketObjectRes = await query.cache.queryGetObject(marketObjectId);
     if (marketObjectRes?.data?.content?.dataType !== 'moveObject')
       throw new Error('Failed to get market object');
 
@@ -1181,9 +1197,7 @@ export const getFlashLoanFees = async (
         .map((field) => field.objectId) ?? [];
 
     flashloanFeeObjects.push(
-      ...(await query.cache.queryGetObjects(dynamicFieldObjectIds, {
-        showContent: true,
-      }))
+      ...(await query.cache.queryGetObjects(dynamicFieldObjectIds))
     );
   }
 

package/src/queries/loyaltyProgramQuery.ts

@@ -36,9 +36,7 @@ export const getLoyaltyProgramInformations = async (
   const rewardPool = query.address.get('loyaltyProgram.rewardPool');
 
   // get fields from rewardPool object
-  const rewardPoolObject = await query.cache.queryGetObject(rewardPool, {
-    showContent: true,
-  });
+  const rewardPoolObject = await query.cache.queryGetObject(rewardPool);
 
   if (rewardPoolObject?.data?.content?.dataType !== 'moveObject') return null;
   const rewardPoolFields = rewardPoolObject.data.content.fields;

package/src/queries/objectsQuery.ts

@@ -1,18 +1,16 @@
-import { SuiObjectDataOptions } from '@mysten/sui/dist/cjs/client';
 import { ScallopCache } from 'src/models/scallopCache';
 import { partitionArray } from 'src/utils';
 
 export const queryMultipleObjects = async (
   cache: ScallopCache,
   objectIds: string[],
-  options?: SuiObjectDataOptions,
   partitionSize = 50
 ) => {
   const objectIdsPartition = partitionArray(objectIds, partitionSize);
 
   const objects = [];
   for (const objectIds of objectIdsPartition) {
-    const result = await cache.queryGetObjects(objectIds, options);
+    const result = await cache.queryGetObjects(objectIds);
     objects.push(...result);
   }
 

package/src/queries/poolAddressesQuery.ts

@@ -12,6 +12,7 @@ export const getAllAddresses = async (query: ScallopQuery) => {
         borrowDynamic?: string;
         spoolReward?: string;
         spool?: string;
+        sCoinType?: string;
         sCoinTreasury?: string;
         interestModel?: string;
         riskModel?: string;
@@ -19,18 +20,15 @@ export const getAllAddresses = async (query: ScallopQuery) => {
         supplyLimitKey?: string;
         borrowLimitKey?: string;
         isolatedAssetKey?: string;
-        coinDecimalId?: string;
+        coinMetadataId?: string;
         borrowIncentivePoolId?: string;
+        coinType?: string;
       }
     >
   > = {};
 
   const marketId = query.address.get('core.market');
-  const marketObject = (
-    await query.cache.queryGetObject(marketId, {
-      showContent: true,
-    })
-  )?.data;
+  const marketObject = (await query.cache.queryGetObject(marketId))?.data;
 
   if (!(marketObject && marketObject.content?.dataType === 'moveObject'))
     throw new Error(`Failed to fetch marketObject`);
@@ -78,7 +76,8 @@ export const getAllAddresses = async (query: ScallopQuery) => {
           },
         })
       )?.data?.objectId;
-    } catch (_e) {
+    } catch (e: any) {
+      console.error(e.message);
       return undefined;
     }
   };
@@ -115,11 +114,13 @@ export const getAllAddresses = async (query: ScallopQuery) => {
         // @ts-ignore
         `spool.pools.s${coinName}.rewardPoolId`
       );
+      // @ts-ignore
+      const sCoinType = query.address.get(`scoin.coins.s${coinName}.coinType`);
       const sCoinTreasury = query.address.get(
         // @ts-ignore
         `scoin.coins.s${coinName}.treasury`
       );
-      const coinDecimalId = query.address.get(
+      const coinMetadataId = query.address.get(
         `core.coins.${coinName}.metaData`
       );
       results[coinName as SupportPoolCoins] = {
@@ -135,10 +136,12 @@ export const getAllAddresses = async (query: ScallopQuery) => {
         spool,
         spoolReward: rewardPool,
         sCoinTreasury,
-        coinDecimalId,
+        sCoinType,
+        coinMetadataId,
+        coinType: `0x${coinType}`,
       };
 
-      await new Promise((resolve) => setTimeout(resolve, 200));
+      await new Promise((resolve) => setTimeout(resolve, 500));
     })
   );