@scallop-io/sui-scallop-sdk 2.3.0-lst-x-oracle-alpha.9 → 2.3.1

package/src/models/scallopQuery.ts

@@ -1,83 +1,68 @@
 import ScallopUtils, { ScallopUtilsParams } from './scallopUtils';
 import ScallopIndexer, { ScallopIndexerParams } from './scallopIndexer';
-import { withIndexerFallback } from './utils';
+import { withIndexerFallback } from 'src/utils';
 import {
+  CoinPrices,
   MarketCollaterals,
   MarketPool,
   MarketPools,
   StakePools,
   StakeRewardPools,
-} from 'src/types/query';
-import { SuiObjectRef, SuiObjectData } from '@mysten/sui/dist/cjs/client';
-import { SuiObjectArg } from '@scallop-io/sui-kit';
-import { ScallopQueryInterface } from './interface';
+  SupportOracleType,
+  xOracleRules,
+} from 'src/types';
 import {
-  getBorrowIncentivePools,
-  queryBorrowIncentiveAccounts,
+  getAllCoinPrices,
+  getAssetOracles,
   getBindedObligationId,
   getBindedVeScaKey,
-} from 'src/queries/borrowIncentiveQuery';
-import { getBorrowLimit } from 'src/queries/borrowLimitQuery';
-import {
-  queryMarket,
-  getMarketPools,
-  getMarketCollaterals,
-  getMarketCollateral,
-  getObligations,
-  queryObligation,
-  getCoinAmounts,
+  getBorrowIncentivePools,
+  getBorrowLimit,
   getCoinAmount,
-  getMarketCoinAmounts,
-  getMarketCoinAmount,
+  getCoinAmounts,
   getFlashLoanFees,
-} from 'src/queries/coreQuery';
-import {
   getIsolatedAssets,
-  isIsolatedAsset,
-} from 'src/queries/isolatedAssetQuery';
-import {
-  getLoyaltyProgramInformations,
-  getVeScaLoyaltyProgramInformations,
-} from 'src/queries/loyaltyProgramQuery';
-import { getPoolAddresses } from 'src/queries/poolAddressesQuery';
-import {
-  getLendings,
   getLending,
+  getLendings,
+  getLoyaltyProgramInformations,
+  getMarketCoinAmount,
+  getMarketCoinAmounts,
+  getMarketCollateral,
+  getMarketCollaterals,
+  getMarketPools,
+  getObligationAccount,
   getObligationAccounts,
-  getTotalValueLocked,
-  getUserPortfolio,
-} from 'src/queries/portfolioQuery';
-import {
+  getObligationAccountsByIds,
+  getObligations,
+  getOnDemandAggObjectIds,
+  getPoolAddresses,
+  getPriceUpdatePolicies,
   getPythPrice,
   getPythPrices,
-  getAllCoinPrices,
-} from 'src/queries/priceQuery';
-import { queryVeScaKeyIdFromReferralBindings } from 'src/queries/referralQuery';
-import {
-  getSCoinTotalSupply,
-  getSCoinAmounts,
   getSCoinAmount,
+  getSCoinAmounts,
   getSCoinSwapRate,
-} from 'src/queries/sCoinQuery';
-import {
+  getSCoinTotalSupply,
   getSpools,
   getStakeAccounts,
   getStakePool,
   getStakeRewardPool,
-} from 'src/queries/spoolQuery';
-import { getSupplyLimit } from 'src/queries/supplyLimitQuery';
-import { getOnDemandAggObjectIds } from 'src/queries/switchboardQuery';
-import {
+  getSupplyLimit,
+  getTotalValueLocked,
+  getUserPortfolio,
   getVeSca,
+  getVeScaLoyaltyProgramInformations,
   getVeScas,
   getVeScaTreasuryInfo,
-} from 'src/queries/vescaQuery';
-import {
-  getPriceUpdatePolicies,
-  getAssetOracles,
-} from 'src/queries/xOracleQuery';
-import { CoinPrices } from 'src/types/util';
-import { SupportOracleType, xOracleRules } from 'src/types/constant';
+  isIsolatedAsset,
+  queryBorrowIncentiveAccounts,
+  queryMarket,
+  queryObligation,
+  queryVeScaKeyIdFromReferralBindings,
+} from 'src/queries';
+import { SuiObjectRef, SuiObjectData } from '@mysten/sui/dist/cjs/client';
+import { SuiObjectArg } from '@scallop-io/sui-kit';
+import { ScallopQueryInterface } from './interface';
 
 export type ScallopQueryParams = {
   indexer?: ScallopIndexer;
@@ -89,7 +74,7 @@ class ScallopQuery implements ScallopQueryInterface {
   public readonly indexer: ScallopIndexer;
   public readonly utils: ScallopUtils;
 
-  constructor(params: ScallopQueryParams) {
+  constructor(params: ScallopQueryParams = {}) {
     this.utils = params.utils ?? new ScallopUtils(params);
     this.indexer =
       params.indexer ??
@@ -125,6 +110,14 @@ class ScallopQuery implements ScallopQueryInterface {
       this,
       this.getObligationAccounts
     );
+    this.getObligationAccountsByIds = withIndexerFallback.call(
+      this,
+      this.getObligationAccountsByIds
+    );
+    this.getObligationAccountById = withIndexerFallback.call(
+      this,
+      this.getObligationAccountById
+    );
     this.getObligationAccount = withIndexerFallback.call(
       this,
       this.getObligationAccount
@@ -575,13 +568,13 @@ class ScallopQuery implements ScallopQueryInterface {
   }
 
   /**
-   * Get user all obligation accounts information.
+   * Get user all obligation accounts information from ownerAddress.
    *
    * @description
    * All collateral and borrowing information in all obligation accounts owned by the user.
    *
    * @param ownerAddress - The owner address.
-   * @param indexer - Whether to use indexer.
+   * @param args - Additional arguments.
    * @return All obligation accounts information.
    */
   async getObligationAccounts(
@@ -604,6 +597,68 @@ class ScallopQuery implements ScallopQueryInterface {
     );
   }
 
+  /**
+   * Get user all obligation accounts information from obligationIds.
+   *
+   * @description
+   * All collateral and borrowing information in all obligation accounts.
+   *
+   * @param obligationIds - Obligation IDs.
+   * @param args - Additional arguments.
+   * @return All obligation accounts information.
+   */
+  async getObligationAccountsByIds(
+    obligationIds: string[],
+    args?: {
+      market?: {
+        collaterals: MarketCollaterals;
+        pools: MarketPools;
+      };
+      coinPrices?: CoinPrices;
+      indexer?: boolean;
+    }
+  ) {
+    return await getObligationAccountsByIds(
+      this,
+      obligationIds,
+      args?.market,
+      args?.coinPrices,
+      args?.indexer
+    );
+  }
+
+  /**
+   * Get obligation account by id
+   *
+   * @description
+   * All collateral and borrowing information in obligation account.
+   *
+   * @param obligationId - Obligation ID.
+   * @param args - Additional arguments.
+   * @return All obligation accounts information.
+   */
+  async getObligationAccountById(
+    obligationId: string,
+    args?: {
+      market?: {
+        collaterals: MarketCollaterals;
+        pools: MarketPools;
+      };
+      coinPrices?: CoinPrices;
+      indexer?: boolean;
+    }
+  ) {
+    return await getObligationAccount(
+      this,
+      obligationId,
+      '',
+      args?.indexer,
+      args?.market,
+      args?.coinPrices,
+      {}
+    );
+  }
+
   /**
    * Get obligation account information for specific id.
    *
@@ -612,7 +667,7 @@ class ScallopQuery implements ScallopQueryInterface {
    *
    * @param obligationId - The obligation id.
    * @param ownerAddress - The owner address.
-   * @param indexer - Whether to use indexer.
+   * @param args - Additional arguments.
    * @return Borrowing and collateral information.
    */
   async getObligationAccount(
@@ -868,6 +923,7 @@ class ScallopQuery implements ScallopQueryInterface {
 
   /**
    * Return the supported primary and secondary oracles for all supported pool assets
+   * @returns
    */
   async getAssetOracles() {
     const [primary, secondary] = await Promise.all([

package/src/models/scallopQueryClient.ts

@@ -1,5 +1,5 @@
 import { QueryClient, QueryClientConfig } from '@tanstack/query-core';
-import { DEFAULT_CACHE_OPTIONS } from 'src/constants/cache';
+import { DEFAULT_CACHE_OPTIONS } from 'src/constants';
 
 export type ScallopQueryClientParams = {
   queryClient?: QueryClient;

package/src/models/scallopSuiKit.ts

@@ -8,7 +8,7 @@ import {
   SuiTxBlock,
   Transaction,
 } from '@scallop-io/sui-kit';
-import { queryKeys } from 'src/constants/queryKeys';
+import { queryKeys } from 'src/constants';
 import {
   CoinBalance,
   DevInspectResults,

package/src/models/scallopUtils.ts

@@ -7,16 +7,18 @@ import {
   Transaction,
 } from '@scallop-io/sui-kit';
 import ScallopConstants, { ScallopConstantsParams } from './scallopConstants';
-import { findClosestUnlockRound } from './utils';
+import { CoinPrices, CoinWrappedType, PoolAddress } from 'src/types';
+import { findClosestUnlockRound } from 'src/utils';
+import {
+  MAX_LOCK_DURATION,
+  queryKeys,
+  UNLOCK_ROUND_DURATION,
+} from 'src/constants';
 import { PriceFeed, SuiPriceServiceConnection } from '@pythnetwork/pyth-sui-js';
 import ScallopSuiKit, { ScallopSuiKitParams } from './scallopSuiKit';
 import { SuiObjectData } from '@mysten/sui/dist/cjs/client';
-import { queryObligation } from 'src/queries/coreQuery';
+import { queryObligation } from 'src/queries';
 import { ScallopUtilsInterface } from './interface';
-import { MAX_LOCK_DURATION, UNLOCK_ROUND_DURATION } from 'src/constants/vesca';
-import { queryKeys } from 'src/constants/queryKeys';
-import { CoinWrappedType, PoolAddress } from 'src/types/constant';
-import { CoinPrices } from 'src/types/util';
 
 export type ScallopUtilsParams = {
   pythEndpoints?: string[];
@@ -29,6 +31,7 @@ class ScallopUtils implements ScallopUtilsInterface {
   public pythEndpoints: string[];
   public readonly scallopSuiKit: ScallopSuiKit;
   public readonly constants: ScallopConstants;
+  public readonly timeout: number;
 
   constructor(params: ScallopUtilsParams = {}) {
     this.constants = params.scallopConstants ?? new ScallopConstants(params);
@@ -42,6 +45,8 @@ class ScallopUtils implements ScallopUtilsInterface {
     this.pythEndpoints = params.pythEndpoints ?? [
       'https://hermes.pyth.network',
     ];
+
+    this.timeout = params.axiosTimeout ?? 4000;
   }
 
   get walletAddress() {
@@ -536,7 +541,7 @@ class ScallopUtils implements ScallopUtilsInterface {
 
       const priceIds = priceIdPairs.map(([_, priceId]) => priceId);
       const pythConnection = new SuiPriceServiceConnection(endpoint, {
-        timeout: 4000,
+        timeout: this.timeout,
       });
 
       try {

package/src/queries/borrowIncentiveQuery.ts

@@ -3,7 +3,7 @@ import {
   parseOriginBorrowIncentivePoolData,
   parseOriginBorrowIncentiveAccountData,
   calculateBorrowIncentivePoolPointData,
-} from './utils';
+} from 'src/utils';
 import type {
   ScallopAddress,
   ScallopQuery,
@@ -16,11 +16,12 @@ import type {
   BorrowIncentiveAccountsQueryInterface,
   BorrowIncentiveAccounts,
   BorrowIncentivePoolPoints,
+  OptionalKeys,
+  CoinPrices,
   MarketPools,
-} from 'src/types/query';
+} from 'src/types';
 import BigNumber from 'bignumber.js';
 import { SuiObjectRef } from '@mysten/sui/client';
-import { CoinPrices, OptionalKeys } from 'src/types/util';
 
 /**
  * Query borrow incentive pools data using moveCall