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

package/src/queries/spoolQuery.ts

@@ -1,11 +1,9 @@
 import { normalizeStructTag } from '@mysten/sui/utils';
-import { POOL_ADDRESSES, SUPPORT_SPOOLS } from '../constants';
 import {
   parseOriginSpoolData,
   calculateSpoolData,
   parseOriginSpoolRewardPoolData,
   calculateSpoolRewardPoolData,
-  isMarketCoin,
   parseObjectAs,
 } from '../utils';
 import type { SuiObjectData, SuiObjectResponse } from '@mysten/sui/client';
@@ -16,8 +14,6 @@ import type {
   StakePool,
   StakeRewardPool,
   StakeAccounts,
-  SupportStakeMarketCoins,
-  SupportStakeCoins,
   CoinPrices,
   MarketPools,
   OriginSpoolRewardPoolData,
@@ -28,14 +24,14 @@ import { queryMultipleObjects } from './objectsQuery';
 
 const queryRequiredSpoolObjects = async (
   query: ScallopQuery,
-  stakePoolCoinNames: SupportStakeCoins[]
+  stakePoolCoinNames: string[]
 ) => {
   // Prepare all tasks for querying each object type
   const tasks = stakePoolCoinNames.map((t, idx) => ({
     poolCoinName: stakePoolCoinNames[idx],
-    spool: POOL_ADDRESSES[t]?.spool,
-    spoolReward: POOL_ADDRESSES[t]?.spoolReward,
-    sCoinTreasury: POOL_ADDRESSES[t]?.sCoinTreasury,
+    spool: query.constants.poolAddresses[t]?.spool,
+    spoolReward: query.constants.poolAddresses[t]?.spoolReward,
+    sCoinTreasury: query.constants.poolAddresses[t]?.sCoinTreasury,
   }));
 
   // Query all objects for each key in parallel
@@ -97,7 +93,7 @@ const queryRequiredSpoolObjects = async (
       return acc;
     },
     {} as Record<
-      SupportStakeCoins,
+      string,
       {
         spool: SuiObjectData;
         spoolReward: SuiObjectData;
@@ -141,13 +137,13 @@ const parseSpoolObjects = ({
  */
 export const getSpools = async (
   query: ScallopQuery,
-  stakeMarketCoinNames: SupportStakeMarketCoins[] = [...SUPPORT_SPOOLS],
+  stakeMarketCoinNames: string[] = [...query.constants.whitelist.spool],
   indexer: boolean = false,
   marketPools?: MarketPools,
   coinPrices?: CoinPrices
 ) => {
   const stakeCoinNames = stakeMarketCoinNames.map((stakeMarketCoinName) =>
-    query.utils.parseCoinName<SupportStakeCoins>(stakeMarketCoinName)
+    query.utils.parseCoinName(stakeMarketCoinName)
   );
   marketPools =
     marketPools ??
@@ -165,12 +161,8 @@ export const getSpools = async (
     const spoolsIndexer = await query.indexer.getSpools();
     const updateSpools = (spool: Spool) => {
       if (!stakeMarketCoinNames.includes(spool.marketCoinName)) return;
-      const coinName = query.utils.parseCoinName<SupportStakeCoins>(
-        spool.marketCoinName
-      );
-      const rewardCoinName = query.utils.getSpoolRewardCoinName(
-        spool.marketCoinName
-      );
+      const coinName = query.utils.parseCoinName(spool.marketCoinName);
+      const rewardCoinName = query.utils.getSpoolRewardCoinName();
       spool.coinPrice = coinPrices[coinName] ?? spool.coinPrice;
       spool.marketCoinPrice =
         coinPrices[spool.marketCoinName] ?? spool.marketCoinPrice;
@@ -178,7 +170,9 @@ export const getSpools = async (
         coinPrices[rewardCoinName] ?? spool.rewardCoinPrice;
       spools[spool.marketCoinName] = spool;
     };
-    Object.values(spoolsIndexer).forEach(updateSpools);
+    Object.values(spoolsIndexer)
+      .filter((t) => !!t)
+      .forEach(updateSpools);
 
     return spools;
   }
@@ -224,7 +218,7 @@ export const getSpools = async (
  */
 export const getSpool = async (
   query: ScallopQuery,
-  marketCoinName: SupportStakeMarketCoins,
+  marketCoinName: string,
   indexer: boolean = false,
   coinPrices?: CoinPrices,
   requiredObjects?: {
@@ -232,14 +226,13 @@ export const getSpool = async (
     spoolReward: SuiObjectData;
   }
 ) => {
-  const coinName = query.utils.parseCoinName<SupportStakeCoins>(marketCoinName);
+  const coinName = query.utils.parseCoinName<string>(marketCoinName);
   coinPrices = coinPrices || (await query.getAllCoinPrices());
 
   if (indexer) {
     const spoolIndexer = await query.indexer.getSpool(marketCoinName);
-    const coinName =
-      query.utils.parseCoinName<SupportStakeCoins>(marketCoinName);
-    const rewardCoinName = query.utils.getSpoolRewardCoinName(marketCoinName);
+    const coinName = query.utils.parseCoinName<string>(marketCoinName);
+    const rewardCoinName = query.utils.getSpoolRewardCoinName();
     spoolIndexer.coinPrice = coinPrices?.[coinName] ?? spoolIndexer.coinPrice;
     spoolIndexer.marketCoinPrice =
       coinPrices?.[marketCoinName] ?? spoolIndexer.marketCoinPrice;
@@ -253,7 +246,7 @@ export const getSpool = async (
     coinName
   ];
 
-  const rewardCoinName = query.utils.getSpoolRewardCoinName(marketCoinName);
+  const rewardCoinName = query.utils.getSpoolRewardCoinName();
   coinPrices = coinPrices || (await query.utils.getCoinPrices());
 
   const parsedSpoolObjects = parseSpoolObjects(requiredObjects);
@@ -286,10 +279,10 @@ export const getSpool = async (
     symbol: query.utils.parseSymbol(marketCoinName),
     coinType: query.utils.parseCoinType(coinName),
     marketCoinType: query.utils.parseMarketCoinType(coinName),
-    rewardCoinType: isMarketCoin(rewardCoinName)
+    rewardCoinType: query.utils.isMarketCoin(rewardCoinName)
       ? query.utils.parseMarketCoinType(rewardCoinName)
       : query.utils.parseCoinType(rewardCoinName),
-    sCoinType: query.utils.parseSCoinType(marketCoinName),
+    sCoinType: query.utils.parseSCoinType(marketCoinName) ?? '',
     coinDecimal: query.utils.getCoinDecimal(coinName),
     rewardCoinDecimal: query.utils.getCoinDecimal(rewardCoinName),
     coinPrice: coinPrices?.[coinName] ?? 0,
@@ -352,37 +345,37 @@ export const getStakeAccounts = async (
     }
   } while (hasNextPage);
 
-  const stakeAccounts: StakeAccounts = SUPPORT_SPOOLS.reduce(
-    (acc, stakeName) => {
-      acc[stakeName] = [];
-      return acc;
+  const stakeAccounts: StakeAccounts = [
+    ...utils.constants.whitelist.spool,
+  ].reduce((acc, stakeName) => {
+    acc[stakeName] = [];
+    return acc;
+  }, {} as StakeAccounts);
+
+  const stakeMarketCoinTypes: Record<string, string> = Object.keys(
+    stakeAccounts
+  ).reduce(
+    (types, stakeMarketCoinName) => {
+      const stakeCoinName = utils.parseCoinName<string>(stakeMarketCoinName);
+      const marketCoinType = utils.parseMarketCoinType(stakeCoinName);
+
+      types[stakeMarketCoinName as string] =
+        `${spoolObjectId}::spool_account::SpoolAccount<${marketCoinType}>`;
+      return types;
     },
-    {} as StakeAccounts
+    {} as Record<string, string>
   );
 
-  const stakeMarketCoinTypes: Record<SupportStakeMarketCoins, string> =
-    Object.keys(stakeAccounts).reduce(
-      (types, stakeMarketCoinName) => {
-        const stakeCoinName =
-          utils.parseCoinName<SupportStakeCoins>(stakeMarketCoinName);
-        const marketCoinType = utils.parseMarketCoinType(stakeCoinName);
-
-        types[stakeMarketCoinName as SupportStakeMarketCoins] =
-          `${spoolObjectId}::spool_account::SpoolAccount<${marketCoinType}>`;
-        return types;
-      },
-      {} as Record<SupportStakeMarketCoins, string>
-    );
-
   // Reverse the mapping
-  const reversedStakeMarketCoinTypes: Record<string, SupportStakeMarketCoins> =
-    Object.entries(stakeMarketCoinTypes).reduce(
-      (reversedTypes, [key, value]) => {
-        reversedTypes[value] = key as SupportStakeMarketCoins;
-        return reversedTypes;
-      },
-      {} as Record<string, SupportStakeMarketCoins>
-    );
+  const reversedStakeMarketCoinTypes: Record<string, string> = Object.entries(
+    stakeMarketCoinTypes
+  ).reduce(
+    (reversedTypes, [key, value]) => {
+      reversedTypes[value] = key as string;
+      return reversedTypes;
+    },
+    {} as Record<string, string>
+  );
 
   for (const stakeObject of stakeObjectsResponse.map((ref) => ref.data)) {
     const id = stakeObject?.objectId;
@@ -396,10 +389,7 @@ export const getStakeAccounts = async (
       const points = Number(fields.points);
       const totalPoints = Number(fields.total_points);
 
-      const stakeMarketCoinTypeMap: Record<
-        SupportStakeMarketCoins,
-        StakeAccounts[SupportStakeMarketCoins]
-      > = {
+      const stakeMarketCoinTypeMap: Record<string, StakeAccounts[string]> = {
         sweth: stakeAccounts.sweth,
         ssui: stakeAccounts.ssui,
         swusdc: stakeAccounts.swusdc,
@@ -449,7 +439,7 @@ export const getStakePool = async (
   }: {
     utils: ScallopUtils;
   },
-  marketCoinName: SupportStakeMarketCoins
+  marketCoinName: string
 ) => {
   const poolId = utils.address.get(`spool.pools.${marketCoinName}.id`);
   let stakePool: StakePool | undefined = undefined;
@@ -506,7 +496,7 @@ export const getStakeRewardPool = async (
   }: {
     utils: ScallopUtils;
   },
-  marketCoinName: SupportStakeMarketCoins
+  marketCoinName: string
 ) => {
   const poolId = utils.address.get(
     `spool.pools.${marketCoinName}.rewardPoolId`

package/src/queries/supplyLimitQuery.ts

@@ -1,5 +1,4 @@
 import { ScallopUtils } from 'src/models';
-import { SupportPoolCoins } from 'src/types';
 import { z as zod } from 'zod';
 
 const supplyLimitZod = zod.object({
@@ -25,10 +24,7 @@ const supplyLimitKeyType = `0x6e641f0dca8aedab3101d047e96439178f16301bf0b57fe874
  * @param poolName
  * @returns supply limit (decimals included)
  */
-export const getSupplyLimit = async (
-  utils: ScallopUtils,
-  poolName: SupportPoolCoins
-) => {
+export const getSupplyLimit = async (utils: ScallopUtils, poolName: string) => {
   try {
     const poolCoinType = utils.parseCoinType(poolName).slice(2);
     const marketObject = utils.address.get('core.market');
@@ -43,7 +39,7 @@ export const getSupplyLimit = async (
     });
 
     const parsedData = supplyLimitZod.safeParse(object?.data?.content);
-    if (!parsedData.success) return null;
+    if (!parsedData.success) return '0';
     return parsedData.data.fields.value;
   } catch (e: any) {
     console.error(`Error in getSupplyLimit for ${poolName}: ${e.message}`);

package/src/queries/switchboardQuery.ts

@@ -0,0 +1,64 @@
+import { ScallopQuery } from 'src/models';
+
+export const getOnDemandAggObjectIds = async (
+  query: ScallopQuery,
+  coinNames: string[],
+  switchboardRegistryTableId: string = query.address.get(
+    'core.oracles.switchboard.registryTableId'
+  )
+): Promise<string[]> => {
+  const missingAgg: Array<{
+    idx: number;
+    coinName: string;
+  }> = [];
+
+  // Check if Aggregator is already registered in Address API
+  const registeredAggs = coinNames.map((coinName, idx) => {
+    const registeredAgg = query.utils.address.get(
+      `core.coins.${coinName}.oracle.switchboard`
+    );
+    if (registeredAgg) {
+      return registeredAgg;
+    } else {
+      missingAgg.push({
+        idx,
+        coinName,
+      });
+      return null;
+    }
+  });
+
+  if (missingAgg.length === 0) return registeredAggs;
+
+  // If not, query from the registry table
+  const missingCoinNames = missingAgg.map((agg) => agg.coinName);
+  const coinTypes = missingCoinNames.map((coinName) => {
+    const coinType = query.utils.parseCoinType(coinName);
+    if (!coinType) throw new Error(`Invalid coin name: ${coinName}`);
+    return coinType;
+  });
+
+  await Promise.all(
+    coinTypes.map(async (coinType, idx) => {
+      const dfName = {
+        type: '0x1::type_name::TypeName',
+        value: {
+          name: coinType.slice(2),
+        },
+      };
+
+      const resp = await query.cache.queryGetDynamicFieldObject({
+        parentId: switchboardRegistryTableId,
+        name: dfName,
+      });
+
+      if (!resp?.data?.content || resp.data.content.dataType !== 'moveObject')
+        throw new Error(`No on-demand aggregator found for ${coinType}`);
+
+      const content = resp.data.content;
+      registeredAggs[idx] = (content.fields as any).value;
+    })
+  );
+
+  return registeredAggs;
+};

package/src/queries/xOracleQuery.ts

@@ -1,15 +1,11 @@
 import { SuiObjectResponse } from '@mysten/sui/client';
 import { ScallopAddress, ScallopUtils } from 'src/models';
-import {
-  SupportAssetCoins,
-  SupportOracleType,
-  xOracleRuleType,
-} from 'src/types';
+import { SupportOracleType, xOracleRuleType } from 'src/types';
 
-const PRIMARY_PRICE_UPDATE_POLICY =
-  '0x56e48a141f20a3a6a6d3fc43e58b01fc63f756c08224870e7890c80ec9d2afee';
-const SECONDARY_PRICE_UPDDATE_POLICY =
-  '0xef4d9430ae42c1b24199ac55e87ddd7262622447ee3c7de8868efe839b3d8705';
+// const PRIMARY_PRICE_UPDATE_POLICY =
+//   '0x56e48a141f20a3a6a6d3fc43e58b01fc63f756c08224870e7890c80ec9d2afee';
+// const SECONDARY_PRICE_UPDDATE_POLICY =
+//   '0xef4d9430ae42c1b24199ac55e87ddd7262622447ee3c7de8868efe839b3d8705';
 
 /**
  * Query the price update policy table ids. Usually the value for these table will be constant.
@@ -26,14 +22,14 @@ export const getPriceUpdatePolicies = async (
   const [primaryPriceUpdatePolicyTable, secondaryPriceUpdatePolicyTable] =
     await Promise.all([
       address.cache.queryGetDynamicFieldObject({
-        parentId: PRIMARY_PRICE_UPDATE_POLICY,
+        parentId: address.get('core.oracles.primaryPriceUpdatePolicyObject'),
         name: {
           type: priceUpdatePolicyRulesKeyType,
           value: { dummy_field: false },
         },
       }),
       address.cache.queryGetDynamicFieldObject({
-        parentId: SECONDARY_PRICE_UPDDATE_POLICY,
+        parentId: address.get('core.oracles.secondaryPriceUpdatePolicyObject'),
         name: {
           type: priceUpdatePolicyRulesKeyType,
           value: { dummy_field: false },
@@ -47,24 +43,26 @@ export const getPriceUpdatePolicies = async (
   };
 };
 
-// const PRIMARY_PRICE_UPDATE_POLICY_KEY =
-//   '0x856d0930acc36780eda9ea47019c979ca6ad34fd36f158b181eb7350195acc00';
-// const SECONDARY_PRICE_UPDATE_POLICY_KEY =
-//   '0x304d226734fa5e376423c9ff0f1d49aeb1e2572d4b617d31e11e2f69865b73ed';
-const PRIMARY_PRICE_UPDATE_POLICY_VECSET_ID =
-  '0xc22c9d691ee4c780de09db91d8b487d863211ebf08720772144bcf716318826c';
-const SECONDARY_PRICE_UPDATE_POLICY_VECSET_ID =
-  '0x3b184ff859f5de30eeaf186898e5224925be6bb6d2baa74347ef471a8cd1c0d3';
+// const PRIMARY_PRICE_UPDATE_POLICY_VECSET_ID =
+//   '0xc22c9d691ee4c780de09db91d8b487d863211ebf08720772144bcf716318826c';
+// const SECONDARY_PRICE_UPDATE_POLICY_VECSET_ID =
+//   '0x3b184ff859f5de30eeaf186898e5224925be6bb6d2baa74347ef471a8cd1c0d3';
 
 export const getAssetOracles = async (
   utils: ScallopUtils,
   ruleType: xOracleRuleType
-): Promise<Record<SupportAssetCoins, SupportOracleType[]> | null> => {
-  if (ruleType === 'primary' && !PRIMARY_PRICE_UPDATE_POLICY_VECSET_ID) {
+): Promise<Record<string, string[]> | null> => {
+  if (
+    ruleType === 'primary' &&
+    !utils.address.get('core.oracles.primaryPriceUpdatePolicyVecsetId')
+  ) {
     console.error('Primary price update policy vecset id is not set');
     return null;
   }
-  if (ruleType === 'secondary' && !SECONDARY_PRICE_UPDATE_POLICY_VECSET_ID) {
+  if (
+    ruleType === 'secondary' &&
+    !utils.address.get('core.oracles.secondaryPriceUpdatePolicyVecsetId')
+  ) {
     console.error('Secondary price update policy vecset id is not set');
     return null;
   }
@@ -76,17 +74,16 @@ export const getAssetOracles = async (
       'switchboard',
   };
 
-  const assetPrimaryOracles = {} as Record<
-    SupportAssetCoins,
-    SupportOracleType[]
-  >;
+  const assetOracles = {} as Record<string, SupportOracleType[]>;
   let cursor = null;
   do {
     const response = await utils.cache.queryGetDynamicFields({
       parentId:
         ruleType === 'primary'
-          ? PRIMARY_PRICE_UPDATE_POLICY_VECSET_ID
-          : SECONDARY_PRICE_UPDATE_POLICY_VECSET_ID,
+          ? utils.address.get('core.oracles.primaryPriceUpdatePolicyVecsetId')
+          : utils.address.get(
+              'core.oracles.secondaryPriceUpdatePolicyVecsetId'
+            ),
       cursor,
       limit: 10,
     });
@@ -108,8 +105,8 @@ export const getAssetOracles = async (
 
       const assetName = utils.parseCoinNameFromType(`0x${typeName}`);
       if (!assetName) throw new Error(`Invalid asset name: ${assetName}`);
-      if (!assetPrimaryOracles[assetName]) {
-        assetPrimaryOracles[assetName] = [];
+      if (!assetOracles[assetName]) {
+        assetOracles[assetName] = [];
       }
 
       const value = fields.value as {
@@ -120,7 +117,7 @@ export const getAssetOracles = async (
       };
 
       value.fields.contents.forEach((content) => {
-        assetPrimaryOracles[assetName].push(
+        assetOracles[assetName].push(
           ruleTypeNameToOracleType[`0x${content.fields.name}`]
         );
       });
@@ -128,5 +125,5 @@ export const getAssetOracles = async (
     if (!hasNextPage) break;
   } while (cursor);
 
-  return assetPrimaryOracles;
+  return assetOracles;
 };

package/src/types/address.ts

@@ -1,11 +1,4 @@
-import { SUPPORT_ORACLES } from '../constants';
-import type {
-  SupportAssetCoins,
-  SupportOracleType,
-  SupportPackageType,
-  SupportSCoin,
-  SupportStakeMarketCoins,
-} from './constant';
+import { _SUPPORT_ORACLES, SupportOracleType } from './constant/xOracle';
 
 export interface AddressesInterface {
   core: {
@@ -18,7 +11,7 @@ export interface AddressesInterface {
     obligationAccessStore: string;
     coins: Partial<
       Record<
-        SupportAssetCoins,
+        string,
         {
           id: string;
           treasury: string;
@@ -27,11 +20,11 @@ export interface AddressesInterface {
           symbol: string;
           decimals: number;
           oracle: {
-            [K in SupportOracleType]: K extends (typeof SUPPORT_ORACLES)[0]
+            [K in SupportOracleType]: K extends (typeof _SUPPORT_ORACLES)[0]
               ? string
-              : K extends (typeof SUPPORT_ORACLES)[1]
+              : K extends (typeof _SUPPORT_ORACLES)[1]
                 ? string
-                : K extends (typeof SUPPORT_ORACLES)[2]
+                : K extends (typeof _SUPPORT_ORACLES)[2]
                   ? {
                       feed: string;
                       feedObject: string;
@@ -42,18 +35,20 @@ export interface AddressesInterface {
       >
     >;
     oracles: {
-      [K in SupportOracleType]: K extends (typeof SUPPORT_ORACLES)[0]
+      [K in SupportOracleType]: K extends (typeof _SUPPORT_ORACLES)[0]
         ? {
             registry: string;
             registryCap: string;
             holder: string;
           }
-        : K extends (typeof SUPPORT_ORACLES)[1]
+        : K extends (typeof _SUPPORT_ORACLES)[1]
           ? {
               registry: string;
               registryCap: string;
+              registryTableId: string;
+              state: string;
             }
-          : K extends (typeof SUPPORT_ORACLES)[2]
+          : K extends (typeof _SUPPORT_ORACLES)[2]
             ? {
                 registry: string;
                 registryCap: string;
@@ -62,10 +57,17 @@ export interface AddressesInterface {
                 wormholeState: string;
               }
             : never;
-    } & { xOracle: string; xOracleCap: string };
+    } & {
+      xOracle: string;
+      xOracleCap: string;
+      primaryPriceUpdatePolicyObject: string;
+      secondaryPriceUpdatePolicyObject: string;
+      primaryPriceUpdatePolicyVecsetId: string;
+      secondaryPriceUpdatePolicyVecsetId: string;
+    };
     packages: Partial<
       Record<
-        SupportPackageType,
+        string,
         {
           id: string;
           object?: string;
@@ -81,7 +83,7 @@ export interface AddressesInterface {
     config: string;
     pools: Partial<
       Record<
-        SupportStakeMarketCoins,
+        string,
         {
           id: string;
           rewardPoolId: string;
@@ -130,7 +132,7 @@ export interface AddressesInterface {
     id: string;
     coins: Partial<
       Record<
-        SupportSCoin,
+        string,
         {
           coinType: string;
           symbol: string;

package/src/types/builder/borrowIncentive.ts

@@ -4,7 +4,6 @@ import type {
 } from '@scallop-io/sui-kit';
 import type { TransactionResult } from '@mysten/sui/transactions';
 import type { ScallopBuilder } from '../../models';
-import type { SupportBorrowIncentiveRewardCoins } from '../constant';
 
 export type BorrowIncentiveIds = {
   borrowIncentivePkg: string;
@@ -32,7 +31,7 @@ export type BorrowIncentiveNormalMethods = {
   claimBorrowIncentive: (
     obligation: SuiObjectArg,
     obligationKey: SuiObjectArg,
-    rewardType: SupportBorrowIncentiveRewardCoins
+    rewardType: string
   ) => TransactionResult;
   deactivateBoost: (obligation: SuiObjectArg, veScaKey: SuiObjectArg) => void;
 };
@@ -52,7 +51,7 @@ export type BorrowIncentiveQuickMethods = {
     obligationKey?: string
   ): Promise<void>;
   claimBorrowIncentiveQuick(
-    rewardType: SupportBorrowIncentiveRewardCoins,
+    rewardType: string,
     obligation?: string,
     obligationKey?: string
   ): Promise<TransactionResult>;