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

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,11 +1,11 @@
 import { SuiObjectResponse } from '@mysten/sui/client';
 import { ScallopAddress, ScallopUtils } from 'src/models';
-import { 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.
@@ -22,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 },
@@ -43,39 +43,47 @@ export const getPriceUpdatePolicies = async (
   };
 };
 
-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<string, string[]> | null> => {
-  if (ruleType === 'primary' && !PRIMARY_PRICE_UPDATE_POLICY_VECSET_ID) {
+  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;
   }
 
-  const ruleTypeNameToOracleType: Record<string, string> = {
+  const ruleTypeNameToOracleType: Record<string, SupportOracleType> = {
     [`${utils.address.get('core.packages.pyth.object')}::rule::Rule`]: 'pyth',
     [`${utils.address.get('core.packages.supra.object')}::rule::Rule`]: 'supra',
     [`${utils.address.get('core.packages.switchboard.object')}::rule::Rule`]:
       'switchboard',
   };
 
-  const assetPrimaryOracles = {} as Record<string, string[]>;
+  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,
     });
@@ -97,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 {
@@ -109,7 +117,7 @@ export const getAssetOracles = async (
       };
 
       value.fields.contents.forEach((content) => {
-        assetPrimaryOracles[assetName].push(
+        assetOracles[assetName].push(
           ruleTypeNameToOracleType[`0x${content.fields.name}`]
         );
       });
@@ -117,5 +125,5 @@ export const getAssetOracles = async (
     if (!hasNextPage) break;
   } while (cursor);
 
-  return assetPrimaryOracles;
+  return assetOracles;
 };

package/src/types/address.ts

@@ -1,5 +1,4 @@
-const _SUPPORT_ORACLES = ['supra', 'switchboard', 'pyth'] as const;
-type SupportOracleType = (typeof _SUPPORT_ORACLES)[number];
+import { _SUPPORT_ORACLES, SupportOracleType } from './constant/xOracle';
 
 export interface AddressesInterface {
   core: {
@@ -46,6 +45,8 @@ export interface AddressesInterface {
           ? {
               registry: string;
               registryCap: string;
+              registryTableId: string;
+              state: string;
             }
           : K extends (typeof _SUPPORT_ORACLES)[2]
             ? {
@@ -56,7 +57,14 @@ 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<
         string,

package/src/types/constant/common.ts

@@ -39,6 +39,7 @@ export type Whitelist = {
   wormhole: Set<string>;
   oracles: Set<string>;
   borrowIncentiveRewards: Set<string>;
+  rewardsAsPoint: Set<string>;
   pythEndpoints: Set<string>;
   deprecated: Set<string>;
 };

package/src/types/constant/xOracle.ts

@@ -1,6 +1,9 @@
+export const _SUPPORT_ORACLES = ['supra', 'switchboard', 'pyth'] as const;
+export type SupportOracleType = (typeof _SUPPORT_ORACLES)[number];
+
 export type xOracleRules = {
-  primary: string[];
-  secondary: string[];
+  primary: SupportOracleType[];
+  secondary: SupportOracleType[];
 };
 export type xOracleRuleType = keyof xOracleRules;
 

package/src/types/model.ts

@@ -28,6 +28,7 @@ export type ScallopClientVeScaReturnType<T extends boolean> = T extends true
 
 export type ScallopBaseInstanceParams = {
   suiKit?: SuiKit;
+  cache?: ScallopCache;
 };
 
 export type ScallopCacheInstanceParams = ScallopBaseInstanceParams & {
@@ -40,6 +41,7 @@ export type ScallopAddressInstanceParams = ScallopBaseInstanceParams & {
 
 export type ScallopConstantsInstanceParams = {
   address?: ScallopAddress;
+  cache?: ScallopCache;
 };
 
 export type ScallopIndexerInstanceParams = {

package/src/types/query/portfolio.ts

@@ -114,6 +114,7 @@ export type ObligationBorrowIcentiveReward = {
   symbol: string;
   coinDecimal: number;
   coinPrice: number;
+  weightedBorrowAmount: number;
   availableClaimCoin: number;
   availableClaimAmount: number;
   boostValue: number;

package/src/utils/query.ts

@@ -1,5 +1,5 @@
 import BigNumber from 'bignumber.js';
-import { normalizeStructTag, parseStructTag } from '@mysten/sui/utils';
+import { normalizeStructTag } from '@mysten/sui/utils';
 import type { ScallopUtils } from '../models';
 import type {
   OriginMarketPoolData,
@@ -581,6 +581,7 @@ export const parseOriginBorrowIncentiveAccountPoolPointData = (
  * @return Parsed borrow incentive account data
  */
 export const parseOriginBorrowIncentiveAccountData = (
+  utils: ScallopUtils,
   originBorrowIncentiveAccountData: OriginBorrowIncentiveAccountData
 ): ParsedBorrowIncentiveAccountData => {
   return {
@@ -591,9 +592,7 @@ export const parseOriginBorrowIncentiveAccountData = (
     pointList: originBorrowIncentiveAccountData.points_list.reduce(
       (acc, point) => {
         const parsed = parseOriginBorrowIncentiveAccountPoolPointData(point);
-        const name = parseStructTag(
-          parsed.pointType
-        ).name.toLowerCase() as string;
+        const name = utils.parseCoinNameFromType(parsed.pointType);
         acc[name] = parsed;
         return acc;
       },