@scallop-io/sui-scallop-sdk 1.5.3 → 2.0.0-alpha.10

package/src/models/scallopQuery.ts

@@ -1,5 +1,4 @@
 import { SuiKit, SuiObjectArg } from '@scallop-io/sui-kit';
-import { ADDRESS_ID, SUPPORT_POOLS, SUPPORT_SPOOLS } from '../constants';
 import {
   queryMarket,
   getObligations,
@@ -33,36 +32,30 @@ import {
   getBorrowIncentivePools,
   getBorrowLimit,
   getIsolatedAssets,
-  // isIsolatedAsset,
   getSupplyLimit,
   getSCoinAmount,
   getSCoinAmounts,
   getSCoinSwapRate,
   getSCoinTotalSupply,
   getAllCoinPrices,
-  getAllAddresses,
+  getPoolAddresses,
   isIsolatedAsset,
   getUserPortfolio,
   getPriceUpdatePolicies,
   getAssetOracles,
+  getOnDemandAggObjectIds,
 } from '../queries';
 import {
   ScallopQueryParams,
-  SupportStakeMarketCoins,
-  SupportAssetCoins,
-  SupportPoolCoins,
-  SupportCollateralCoins,
-  SupportMarketCoins,
   StakePools,
   StakeRewardPools,
-  SupportBorrowIncentiveCoins,
-  SupportSCoin,
   ScallopQueryInstanceParams,
   MarketPool,
   CoinPrices,
   MarketPools,
   MarketCollaterals,
   xOracleRules,
+  SupportOracleType,
 } from '../types';
 import { ScallopAddress } from './scallopAddress';
 import { ScallopUtils } from './scallopUtils';
@@ -73,6 +66,7 @@ import { normalizeSuiAddress } from '@mysten/sui/utils';
 import { withIndexerFallback } from 'src/utils/indexer';
 import { newSuiKit } from './suiKit';
 import { SuiObjectRef } from '@mysten/sui/client';
+import { ScallopConstants } from './scallopConstants';
 /**
  * @description
  * It provides methods for getting on-chain data from the Scallop contract.
@@ -91,12 +85,13 @@ export class ScallopQuery {
   public suiKit: SuiKit;
   public address: ScallopAddress;
   public utils: ScallopUtils;
+  public constants: ScallopConstants;
   public indexer: ScallopIndexer;
   public cache: ScallopCache;
   public walletAddress: string;
 
   public constructor(
-    params: ScallopQueryParams = {},
+    params: ScallopQueryParams,
     instance?: ScallopQueryInstanceParams
   ) {
     this.params = params;
@@ -107,28 +102,30 @@ export class ScallopQuery {
       params.walletAddress ?? this.suiKit.currentAddress()
     );
 
-    if (instance?.utils) {
-      this.utils = instance.utils;
-      this.address = instance.utils.address;
-      this.cache = this.address.cache;
-    } else {
-      this.cache = new ScallopCache(this.params, {
+    this.cache =
+      instance?.utils?.cache ??
+      instance?.cache ??
+      new ScallopCache(this.params, {
         suiKit: this.suiKit,
       });
-      this.address = new ScallopAddress(
-        {
-          id: params?.addressId ?? ADDRESS_ID,
-          network: params?.networkType,
-          forceInterface: params?.forceAddressesInterface,
-        },
-        {
-          cache: this.cache,
-        }
-      );
-      this.utils = new ScallopUtils(this.params, {
+
+    this.address =
+      instance?.utils?.address ??
+      new ScallopAddress(this.params, {
+        cache: this.cache,
+      });
+
+    this.constants =
+      instance?.utils?.constants ??
+      new ScallopConstants(this.params, {
         address: this.address,
       });
-    }
+
+    this.utils =
+      instance?.utils ??
+      new ScallopUtils(this.params, {
+        constants: this.constants,
+      });
     this.indexer =
       instance?.indexer ??
       new ScallopIndexer(this.params, { cache: this.cache });
@@ -172,15 +169,12 @@ export class ScallopQuery {
    * @param force - Whether to force initialization.
    * @param address - ScallopAddress instance.
    */
-  public async init(force: boolean = false, address?: ScallopAddress) {
-    if (address && !this.address) {
-      this.address = address;
-    }
-    if (force || !this.address.getAddresses()) {
-      await this.address.read();
+  public async init(force: boolean = false) {
+    if (force || !this.constants.isInitialized) {
+      await this.constants.init();
     }
 
-    await this.utils.init(force, this.address);
+    await this.utils.init(force);
   }
 
   /* ==================== Core Query Methods ==================== */
@@ -210,7 +204,7 @@ export class ScallopQuery {
    * @return Market pools data.
    */
   public async getMarketPools(
-    poolCoinNames: SupportPoolCoins[] = [...SUPPORT_POOLS],
+    poolCoinNames: string[] = [...this.constants.whitelist.lending],
     args?: {
       coinPrices?: CoinPrices;
       indexer?: boolean;
@@ -232,7 +226,7 @@ export class ScallopQuery {
    * @return Market pool data.
    */
   public async getMarketPool(
-    poolCoinName: SupportPoolCoins,
+    poolCoinName: string,
     args?: {
       coinPrice?: number;
       indexer?: boolean;
@@ -261,7 +255,7 @@ export class ScallopQuery {
    * @return Market collaterals data.
    */
   public async getMarketCollaterals(
-    collateralCoinNames?: SupportCollateralCoins[],
+    collateralCoinNames: string[] = [...this.constants.whitelist.collateral],
     args?: { indexer?: boolean }
   ) {
     return await getMarketCollaterals(this, collateralCoinNames, args?.indexer);
@@ -275,7 +269,7 @@ export class ScallopQuery {
    * @return Market collateral data.
    */
   public async getMarketCollateral(
-    collateralCoinName: SupportCollateralCoins,
+    collateralCoinName: string,
     args?: { indexer?: boolean }
   ) {
     return await getMarketCollateral(this, collateralCoinName, args?.indexer);
@@ -309,7 +303,7 @@ export class ScallopQuery {
    * @return All coin amounts.
    */
   public async getCoinAmounts(
-    assetCoinNames?: SupportAssetCoins[],
+    assetCoinNames?: string[],
     ownerAddress: string = this.walletAddress
   ) {
     return await getCoinAmounts(this, assetCoinNames, ownerAddress);
@@ -323,7 +317,7 @@ export class ScallopQuery {
    * @return Coin amount.
    */
   public async getCoinAmount(
-    assetCoinName: SupportAssetCoins,
+    assetCoinName: string,
     ownerAddress: string = this.walletAddress
   ) {
     return await getCoinAmount(this, assetCoinName, ownerAddress);
@@ -337,7 +331,7 @@ export class ScallopQuery {
    * @return All market market coin amounts.
    */
   public async getMarketCoinAmounts(
-    marketCoinNames?: SupportMarketCoins[],
+    marketCoinNames?: string[],
     ownerAddress: string = this.walletAddress
   ) {
     return await getMarketCoinAmounts(this, marketCoinNames, ownerAddress);
@@ -351,7 +345,7 @@ export class ScallopQuery {
    * @return Market market coin amount.
    */
   public async getMarketCoinAmount(
-    marketCoinName: SupportMarketCoins,
+    marketCoinName: string,
     ownerAddress: string = this.walletAddress
   ) {
     return await getMarketCoinAmount(this, marketCoinName, ownerAddress);
@@ -363,7 +357,7 @@ export class ScallopQuery {
    * @param assetCoinName - Specific support asset coin name.
    * @return Asset coin price.
    */
-  public async getPriceFromPyth(assetCoinName: SupportAssetCoins) {
+  public async getPriceFromPyth(assetCoinName: string) {
     return await getPythPrice(this, assetCoinName);
   }
 
@@ -373,7 +367,7 @@ export class ScallopQuery {
    * @param assetCoinNames - Array of supported asset coin names.
    * @return Array of asset coin prices.
    */
-  public async getPricesFromPyth(assetCoinNames: SupportAssetCoins[]) {
+  public async getPricesFromPyth(assetCoinNames: string[]) {
     return await getPythPrices(this, assetCoinNames);
   }
 
@@ -387,7 +381,7 @@ export class ScallopQuery {
    * @return Spools data.
    */
   public async getSpools(
-    stakeMarketCoinNames?: SupportStakeMarketCoins[],
+    stakeMarketCoinNames?: string[],
     args?: {
       marketPools?: MarketPools;
       coinPrices?: CoinPrices;
@@ -411,7 +405,7 @@ export class ScallopQuery {
    * @return Spool data.
    */
   public async getSpool(
-    stakeMarketCoinName: SupportStakeMarketCoins,
+    stakeMarketCoinName: string,
     args?: {
       marketPool?: MarketPool;
       coinPrices?: CoinPrices;
@@ -440,7 +434,7 @@ export class ScallopQuery {
    * @return Stake accounts data.
    */
   public async getStakeAccounts(
-    stakeMarketCoinName: SupportStakeMarketCoins,
+    stakeMarketCoinName: string,
     ownerAddress: string = this.walletAddress
   ) {
     const allStakeAccount = await this.getAllStakeAccounts(ownerAddress);
@@ -458,7 +452,7 @@ export class ScallopQuery {
    * @return Stake pools data.
    */
   public async getStakePools(
-    stakeMarketCoinNames: SupportStakeMarketCoins[] = [...SUPPORT_SPOOLS]
+    stakeMarketCoinNames: string[] = [...this.constants.whitelist.spool]
   ) {
     const stakePools: StakePools = {};
     for (const stakeMarketCoinName of stakeMarketCoinNames) {
@@ -482,7 +476,7 @@ export class ScallopQuery {
    * @param stakeMarketCoinName - Specific support stake market coin name.
    * @return Stake pool data.
    */
-  public async getStakePool(stakeMarketCoinName: SupportStakeMarketCoins) {
+  public async getStakePool(stakeMarketCoinName: string) {
     return await getStakePool(this, stakeMarketCoinName);
   }
 
@@ -497,7 +491,7 @@ export class ScallopQuery {
    * @return Stake reward pools data.
    */
   public async getStakeRewardPools(
-    stakeMarketCoinNames: SupportStakeMarketCoins[] = [...SUPPORT_SPOOLS]
+    stakeMarketCoinNames: string[] = [...this.constants.whitelist.spool]
   ) {
     const stakeRewardPools: StakeRewardPools = {};
     await Promise.allSettled(
@@ -525,9 +519,7 @@ export class ScallopQuery {
    * @param marketCoinName - Specific support stake market coin name.
    * @return Stake reward pool data.
    */
-  public async getStakeRewardPool(
-    stakeMarketCoinName: SupportStakeMarketCoins
-  ) {
+  public async getStakeRewardPool(stakeMarketCoinName: string) {
     return await getStakeRewardPool(this, stakeMarketCoinName);
   }
 
@@ -539,7 +531,7 @@ export class ScallopQuery {
    * @return Borrow incentive pools data.
    */
   public async getBorrowIncentivePools(
-    coinNames?: SupportBorrowIncentiveCoins[],
+    coinNames: string[] = [...this.constants.whitelist.lending],
     args?: {
       coinPrices?: CoinPrices;
       indexer?: boolean;
@@ -564,7 +556,7 @@ export class ScallopQuery {
    */
   public async getBorrowIncentiveAccounts(
     obligationId: string | SuiObjectRef,
-    coinNames?: SupportBorrowIncentiveCoins[]
+    coinNames?: string[]
   ) {
     return await queryBorrowIncentiveAccounts(this, obligationId, coinNames);
   }
@@ -578,7 +570,7 @@ export class ScallopQuery {
    * @return All lending and spool infomation.
    */
   public async getLendings(
-    poolCoinNames?: SupportPoolCoins[],
+    poolCoinNames?: string[],
     ownerAddress: string = this.walletAddress,
     args?: {
       indexer?: boolean;
@@ -605,7 +597,7 @@ export class ScallopQuery {
    * @return Lending pool data.
    */
   public async getLending(
-    poolCoinName: SupportPoolCoins,
+    poolCoinName: string,
     ownerAddress: string = this.walletAddress,
     args?: { indexer?: boolean }
   ) {
@@ -755,7 +747,7 @@ export class ScallopQuery {
    * @param sCoinName - Supported sCoin name
    * @returns Total Supply
    */
-  public async getSCoinTotalSupply(sCoinName: SupportSCoin) {
+  public async getSCoinTotalSupply(sCoinName: string) {
     return await getSCoinTotalSupply(this, sCoinName);
   }
 
@@ -767,7 +759,7 @@ export class ScallopQuery {
    * @return All market sCoin amounts.
    */
   public async getSCoinAmounts(
-    sCoinNames?: SupportSCoin[],
+    sCoinNames?: string[],
     ownerAddress: string = this.walletAddress
   ) {
     return await getSCoinAmounts(this, sCoinNames, ownerAddress);
@@ -781,7 +773,7 @@ export class ScallopQuery {
    * @return sCoin amount.
    */
   public async getSCoinAmount(
-    sCoinName: SupportSCoin | SupportMarketCoins,
+    sCoinName: string | string,
     ownerAddress: string = this.walletAddress
   ) {
     const parsedSCoinName = this.utils.parseSCoinName(sCoinName);
@@ -795,10 +787,7 @@ export class ScallopQuery {
    * @param assetCoinNames
    * @returns
    */
-  public async getSCoinSwapRate(
-    fromSCoin: SupportSCoin,
-    toSCoin: SupportSCoin
-  ) {
+  public async getSCoinSwapRate(fromSCoin: string, toSCoin: string) {
     return await getSCoinSwapRate(this, fromSCoin, toSCoin);
   }
 
@@ -806,7 +795,7 @@ export class ScallopQuery {
    * Get flashloan fee for specified assets
    */
   public async getFlashLoanFees(
-    assetCoinNames: SupportAssetCoins[] = [...SUPPORT_POOLS]
+    assetCoinNames: string[] = [...this.constants.whitelist.lending]
   ) {
     return await getFlashLoanFees(this, assetCoinNames);
   }
@@ -814,14 +803,14 @@ export class ScallopQuery {
   /**
    * Get supply limit of lending pool
    */
-  public async getPoolSupplyLimit(poolName: SupportPoolCoins) {
+  public async getPoolSupplyLimit(poolName: string) {
     return await getSupplyLimit(this.utils, poolName);
   }
 
   /**
    * Get borrow limit of borrow pool
    */
-  public async getPoolBorrowLimit(poolName: SupportPoolCoins) {
+  public async getPoolBorrowLimit(poolName: string) {
     return await getBorrowLimit(this.utils, poolName);
   }
 
@@ -835,7 +824,7 @@ export class ScallopQuery {
   /**
    * Check if asset is an isolated asset
    */
-  public async isIsolatedAsset(assetCoinName: SupportAssetCoins) {
+  public async isIsolatedAsset(assetCoinName: string) {
     return isIsolatedAsset(this.utils, assetCoinName);
   }
 
@@ -844,7 +833,7 @@ export class ScallopQuery {
    * @param coinName
    * @returns price data
    */
-  public async getCoinPriceByIndexer(poolName: SupportPoolCoins) {
+  public async getCoinPriceByIndexer(poolName: string) {
     return this.indexer.getCoinPrice(poolName);
   }
 
@@ -877,10 +866,9 @@ export class ScallopQuery {
    * Query all address (lending pool, collateral pool, borrow dynamics, interest models, etc.) of all pool
    * @returns
    */
-  public async getPoolAddresses(
-    pools: SupportPoolCoins[] = [...SUPPORT_POOLS]
-  ) {
-    return getAllAddresses(this, pools);
+  public async getPoolAddresses(apiAddressId = this.address.getId()) {
+    if (!apiAddressId) throw new Error('apiAddressId is required');
+    return getPoolAddresses(apiAddressId);
   }
 
   /**
@@ -915,15 +903,24 @@ export class ScallopQuery {
       getAssetOracles(this.utils, 'secondary'),
     ]);
 
-    return SUPPORT_POOLS.reduce(
+    return [...this.constants.whitelist.lending].reduce(
       (acc, pool) => {
         acc[pool] = {
-          primary: primary?.[pool] ?? [],
-          secondary: secondary?.[pool] ?? [],
+          primary: (primary?.[pool] ?? []) as SupportOracleType[],
+          secondary: (secondary?.[pool] ?? []) as SupportOracleType[],
         };
         return acc;
       },
-      {} as Record<SupportAssetCoins, xOracleRules>
+      {} as Record<string, xOracleRules>
     );
   }
+
+  /**
+   * Get switchboard on-demand aggregator object id based on coinType
+   * @param coinType
+   * @returns
+   */
+  public async getSwitchboardOnDemandAggregatorObjectIds(coinName: string[]) {
+    return await getOnDemandAggObjectIds(this, coinName);
+  }
 }