@scallop-io/sui-scallop-sdk 1.5.0 → 1.5.2

package/src/models/scallopAddress.ts

@@ -25,6 +25,9 @@ const EMPTY_ADDRESSES: AddressesInterface = {
         id: '',
         metaData: '',
         treasury: '',
+        symbol: '',
+        coinType: '',
+        decimals: 0,
         oracle: {
           supra: '',
           switchboard: '',
@@ -38,6 +41,9 @@ const EMPTY_ADDRESSES: AddressesInterface = {
         id: '',
         metaData: '',
         treasury: '',
+        symbol: '',
+        coinType: '',
+        decimals: 0,
         oracle: {
           supra: '',
           switchboard: '',
@@ -51,6 +57,9 @@ const EMPTY_ADDRESSES: AddressesInterface = {
         id: '',
         metaData: '',
         treasury: '',
+        symbol: '',
+        coinType: '',
+        decimals: 0,
         oracle: {
           supra: '',
           switchboard: '',
@@ -64,6 +73,9 @@ const EMPTY_ADDRESSES: AddressesInterface = {
         id: '',
         metaData: '',
         treasury: '',
+        symbol: '',
+        coinType: '',
+        decimals: 0,
         oracle: {
           supra: '',
           switchboard: '',
@@ -77,6 +89,9 @@ const EMPTY_ADDRESSES: AddressesInterface = {
         id: '',
         metaData: '',
         treasury: '',
+        symbol: '',
+        coinType: '',
+        decimals: 0,
         oracle: {
           supra: '',
           switchboard: '',
@@ -90,6 +105,9 @@ const EMPTY_ADDRESSES: AddressesInterface = {
         id: '',
         metaData: '',
         treasury: '',
+        symbol: '',
+        coinType: '',
+        decimals: 0,
         oracle: {
           supra: '',
           switchboard: '',
@@ -103,6 +121,9 @@ const EMPTY_ADDRESSES: AddressesInterface = {
         id: '',
         metaData: '',
         treasury: '',
+        symbol: '',
+        coinType: '',
+        decimals: 0,
         oracle: {
           supra: '',
           switchboard: '',
@@ -116,6 +137,9 @@ const EMPTY_ADDRESSES: AddressesInterface = {
         id: '',
         metaData: '',
         treasury: '',
+        symbol: '',
+        coinType: '',
+        decimals: 0,
         oracle: {
           supra: '',
           switchboard: '',
@@ -129,6 +153,9 @@ const EMPTY_ADDRESSES: AddressesInterface = {
         id: '',
         metaData: '',
         treasury: '',
+        symbol: '',
+        coinType: '',
+        decimals: 0,
         oracle: {
           supra: '',
           switchboard: '',
@@ -142,6 +169,9 @@ const EMPTY_ADDRESSES: AddressesInterface = {
         id: '',
         metaData: '',
         treasury: '',
+        symbol: '',
+        coinType: '',
+        decimals: 0,
         oracle: {
           supra: '',
           switchboard: '',
@@ -155,6 +185,9 @@ const EMPTY_ADDRESSES: AddressesInterface = {
         id: '',
         metaData: '',
         treasury: '',
+        symbol: '',
+        coinType: '',
+        decimals: 0,
         oracle: {
           supra: '',
           switchboard: '',
@@ -168,6 +201,9 @@ const EMPTY_ADDRESSES: AddressesInterface = {
         id: '',
         metaData: '',
         treasury: '',
+        symbol: '',
+        coinType: '',
+        decimals: 0,
         oracle: {
           supra: '',
           switchboard: '',
@@ -317,46 +353,55 @@ const EMPTY_ADDRESSES: AddressesInterface = {
         coinType: '',
         treasury: '',
         metaData: '',
+        symbol: '',
       },
       scetus: {
         coinType: '',
         treasury: '',
         metaData: '',
+        symbol: '',
       },
       ssca: {
         coinType: '',
         treasury: '',
         metaData: '',
+        symbol: '',
       },
       swusdc: {
         coinType: '',
         treasury: '',
         metaData: '',
+        symbol: '',
       },
       swusdt: {
         coinType: '',
         treasury: '',
         metaData: '',
+        symbol: '',
       },
       sweth: {
         coinType: '',
         treasury: '',
         metaData: '',
+        symbol: '',
       },
       safsui: {
         coinType: '',
         treasury: '',
         metaData: '',
+        symbol: '',
       },
       shasui: {
         coinType: '',
         treasury: '',
         metaData: '',
+        symbol: '',
       },
       svsui: {
         coinType: '',
         treasury: '',
         metaData: '',
+        symbol: '',
       },
     },
   },

package/src/models/scallopQuery.ts

@@ -297,14 +297,8 @@ export class ScallopQuery {
    * @param obligationId - The obligation id.
    * @return Obligation data.
    */
-  public async queryObligation(
-    obligationId: SuiObjectArg,
-    args?: {
-      version: SuiObjectArg;
-      market: SuiObjectArg;
-    }
-  ) {
-    return queryObligation(this, obligationId, args?.version, args?.market);
+  public async queryObligation(obligationId: SuiObjectArg) {
+    return queryObligation(this, obligationId);
   }
 
   /**
@@ -924,8 +918,8 @@ export class ScallopQuery {
     return SUPPORT_POOLS.reduce(
       (acc, pool) => {
         acc[pool] = {
-          primary: primary[pool] ?? [],
-          secondary: secondary[pool] ?? [],
+          primary: primary?.[pool] ?? [],
+          secondary: secondary?.[pool] ?? [],
         };
         return acc;
       },

package/src/queries/coreQuery.ts

@@ -1007,11 +1007,11 @@ export const queryObligation = async (
   }: {
     address: ScallopAddress;
   },
-  obligationId: SuiObjectArg,
-  version: SuiObjectArg = address.get('core.version'),
-  market: SuiObjectArg = address.get('core.market')
+  obligationId: SuiObjectArg
 ) => {
   const packageId = address.get('core.packages.query.id');
+  const version = address.get('core.version');
+  const market = address.get('core.market');
   const queryTarget = `${packageId}::obligation_query::obligation_data`;
 
   const args = [
@@ -1023,7 +1023,7 @@ export const queryObligation = async (
       mutable: false,
       initialSharedVersion: '1',
     },
-  ]; // @TODO: recheck and confirm on production, need to re-deploy the query package (remind Nathan)
+  ];
 
   const queryResult = await address.cache.queryInspectTxn(
     { queryTarget, args }

package/src/queries/xOracleQuery.ts

@@ -7,14 +7,14 @@ import {
 } from 'src/types';
 
 const PRIMARY_PRICE_UPDATE_POLICY =
-  '0xbcd908d0ee6d63d726e61676f3feeec3d19817f4849bbecf372dd3399f247f6b'; // @TODO: move this constant to api address
+  '0x56e48a141f20a3a6a6d3fc43e58b01fc63f756c08224870e7890c80ec9d2afee';
 const SECONDARY_PRICE_UPDDATE_POLICY =
-  '0x624a6f120777bb30e718b86e836c205ef4229448052377dc3d78272a6662b2c0'; // @TODO: move this constant to api address
+  '0xef4d9430ae42c1b24199ac55e87ddd7262622447ee3c7de8868efe839b3d8705';
 
 /**
  * Query the price update policy table ids. Usually the value for these table will be constant.
  * @param query
- * @returns
+ * @returns Primary and Secondary price update policy table object
  */
 export const getPriceUpdatePolicies = async (
   address: ScallopAddress
@@ -23,7 +23,6 @@ export const getPriceUpdatePolicies = async (
   secondary: SuiObjectResponse | null;
 }> => {
   const priceUpdatePolicyRulesKeyType = `${address.get('core.packages.xOracle.object')}::price_update_policy::PriceUpdatePolicyRulesKey`;
-
   const [primaryPriceUpdatePolicyTable, secondaryPriceUpdatePolicyTable] =
     await Promise.all([
       address.cache.queryGetDynamicFieldObject({
@@ -53,14 +52,23 @@ export const getPriceUpdatePolicies = async (
 // const SECONDARY_PRICE_UPDATE_POLICY_KEY =
 //   '0x304d226734fa5e376423c9ff0f1d49aeb1e2572d4b617d31e11e2f69865b73ed';
 const PRIMARY_PRICE_UPDATE_POLICY_VECSET_ID =
-  '0xfb1330aa028ed6a159b742c71b5a79b3b6824cf71efa40ea82b52486ad209264';
+  '0xc22c9d691ee4c780de09db91d8b487d863211ebf08720772144bcf716318826c';
 const SECONDARY_PRICE_UPDATE_POLICY_VECSET_ID =
-  '0x4b827acc73f3f53f808dd73a7ee0a60ae61e84322176bece72b26467030b467c';
+  '0x3b184ff859f5de30eeaf186898e5224925be6bb6d2baa74347ef471a8cd1c0d3';
 
 export const getAssetOracles = async (
   utils: ScallopUtils,
   ruleType: xOracleRuleType
-): Promise<Record<SupportAssetCoins, SupportOracleType[]>> => {
+): Promise<Record<SupportAssetCoins, SupportOracleType[]> | null> => {
+  if (ruleType === 'primary' && !PRIMARY_PRICE_UPDATE_POLICY_VECSET_ID) {
+    console.error('Primary price update policy vecset id is not set');
+    return null;
+  }
+  if (ruleType === 'secondary' && !SECONDARY_PRICE_UPDATE_POLICY_VECSET_ID) {
+    console.error('Secondary price update policy vecset id is not set');
+    return null;
+  }
+
   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',

package/src/types/address.ts

@@ -23,6 +23,9 @@ export interface AddressesInterface {
           id: string;
           treasury: string;
           metaData: string;
+          coinType: string;
+          symbol: string;
+          decimals: number;
           oracle: {
             [K in SupportOracleType]: K extends (typeof SUPPORT_ORACLES)[0]
               ? string
@@ -130,6 +133,7 @@ export interface AddressesInterface {
         SupportSCoin,
         {
           coinType: string;
+          symbol: string;
           treasury: string;
           metaData: string;
         }

package/src/types/model.ts

@@ -78,6 +78,7 @@ export type ScallopClientParams = ScallopParams &
 export type ScallopBuilderParams = ScallopParams & {
   pythEndpoints?: string[];
   usePythPullModel?: boolean;
+  useOnChainXOracleList?: boolean;
 } & ScallopQueryParams;
 
 export type ScallopQueryParams = ScallopParams & ScallopUtilsParams;