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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scallop-io/sui-scallop-sdk",
-  "version": "1.4.27",
+  "version": "1.5.0",
   "description": "Typescript sdk for interacting with Scallop contract on SUI",
   "keywords": [
     "sui",

package/src/builders/borrowIncentiveBuilder.ts

@@ -98,6 +98,12 @@ const generateBorrowIncentiveNormalMethod: GenerateBorrowIncentiveNormalMethod =
       config: builder.address.get('vesca.config'),
     };
 
+    const clockObjectRef = txBlock.sharedObjectRef({
+      objectId: SUI_CLOCK_OBJECT_ID,
+      mutable: false,
+      initialSharedVersion: '1',
+    });
+
     return {
       stakeObligation: (obligationId, obligationKey) => {
         builder.moveCall(
@@ -110,11 +116,7 @@ const generateBorrowIncentiveNormalMethod: GenerateBorrowIncentiveNormalMethod =
             obligationKey,
             obligationId,
             borrowIncentiveIds.obligationAccessStore,
-            txBlock.sharedObjectRef({
-              objectId: SUI_CLOCK_OBJECT_ID,
-              mutable: false,
-              initialSharedVersion: '1',
-            }),
+            clockObjectRef,
           ]
         );
       },
@@ -133,11 +135,7 @@ const generateBorrowIncentiveNormalMethod: GenerateBorrowIncentiveNormalMethod =
             veScaIds.treasury,
             veScaIds.table,
             veScaKey,
-            txBlock.sharedObjectRef({
-              objectId: SUI_CLOCK_OBJECT_ID,
-              mutable: false,
-              initialSharedVersion: '1',
-            }),
+            clockObjectRef,
           ],
           []
         );
@@ -152,11 +150,7 @@ const generateBorrowIncentiveNormalMethod: GenerateBorrowIncentiveNormalMethod =
             borrowIncentiveIds.incentiveAccounts,
             obligationKey,
             obligationId,
-            txBlock.sharedObjectRef({
-              objectId: SUI_CLOCK_OBJECT_ID,
-              mutable: false,
-              initialSharedVersion: '1',
-            }),
+            clockObjectRef,
           ]
         );
       },
@@ -171,11 +165,7 @@ const generateBorrowIncentiveNormalMethod: GenerateBorrowIncentiveNormalMethod =
             borrowIncentiveIds.incentiveAccounts,
             obligationKey,
             obligationId,
-            txBlock.sharedObjectRef({
-              objectId: SUI_CLOCK_OBJECT_ID,
-              mutable: false,
-              initialSharedVersion: '1',
-            }),
+            clockObjectRef,
           ],
           [rewardType]
         );
@@ -190,11 +180,7 @@ const generateBorrowIncentiveNormalMethod: GenerateBorrowIncentiveNormalMethod =
             borrowIncentiveIds.incentiveAccounts,
             obligation,
             veScaKey,
-            txBlock.sharedObjectRef({
-              objectId: SUI_CLOCK_OBJECT_ID,
-              mutable: false,
-              initialSharedVersion: '1',
-            }),
+            clockObjectRef,
           ]
         );
       },

package/src/builders/coreBuilder.ts

@@ -75,6 +75,11 @@ const generateCoreNormalMethod: GenerateCoreNormalMethod = ({
 
   const referralPkgId = builder.address.get('referral.id');
   const referralWitnessType = `${referralPkgId}::scallop_referral_program::REFERRAL_WITNESS`;
+  const clockObjectRef = txBlock.sharedObjectRef({
+    objectId: SUI_CLOCK_OBJECT_ID,
+    mutable: false,
+    initialSharedVersion: '1',
+  });
 
   return {
     openObligation: () => {
@@ -126,11 +131,7 @@ const generateCoreNormalMethod: GenerateCoreNormalMethod = ({
           coreIds.coinDecimalsRegistry,
           txBlock.pure.u64(amount),
           coreIds.xOracle,
-          txBlock.sharedObjectRef({
-            objectId: SUI_CLOCK_OBJECT_ID,
-            mutable: false,
-            initialSharedVersion: '1',
-          }),
+          clockObjectRef,
         ],
         [coinType]
       );
@@ -141,16 +142,7 @@ const generateCoreNormalMethod: GenerateCoreNormalMethod = ({
       return builder.moveCall(
         txBlock,
         `${coreIds.protocolPkg}::mint::mint`,
-        [
-          coreIds.version,
-          coreIds.market,
-          coin,
-          txBlock.sharedObjectRef({
-            objectId: SUI_CLOCK_OBJECT_ID,
-            mutable: false,
-            initialSharedVersion: '1',
-          }),
-        ],
+        [coreIds.version, coreIds.market, coin, clockObjectRef],
         [coinType]
       );
     },
@@ -160,16 +152,7 @@ const generateCoreNormalMethod: GenerateCoreNormalMethod = ({
       return builder.moveCall(
         txBlock,
         `${coreIds.protocolPkg}::mint::mint_entry`,
-        [
-          coreIds.version,
-          coreIds.market,
-          coin,
-          txBlock.sharedObjectRef({
-            objectId: SUI_CLOCK_OBJECT_ID,
-            mutable: false,
-            initialSharedVersion: '1',
-          }),
-        ],
+        [coreIds.version, coreIds.market, coin, clockObjectRef],
         [coinType]
       );
     },
@@ -179,16 +162,7 @@ const generateCoreNormalMethod: GenerateCoreNormalMethod = ({
       return builder.moveCall(
         txBlock,
         `${coreIds.protocolPkg}::redeem::redeem`,
-        [
-          coreIds.version,
-          coreIds.market,
-          marketCoin,
-          txBlock.sharedObjectRef({
-            objectId: SUI_CLOCK_OBJECT_ID,
-            mutable: false,
-            initialSharedVersion: '1',
-          }),
-        ],
+        [coreIds.version, coreIds.market, marketCoin, clockObjectRef],
         [coinType]
       );
     },
@@ -198,16 +172,7 @@ const generateCoreNormalMethod: GenerateCoreNormalMethod = ({
       return builder.moveCall(
         txBlock,
         `${coreIds.protocolPkg}::redeem::redeem_entry`,
-        [
-          coreIds.version,
-          coreIds.market,
-          marketCoin,
-          txBlock.sharedObjectRef({
-            objectId: SUI_CLOCK_OBJECT_ID,
-            mutable: false,
-            initialSharedVersion: '1',
-          }),
-        ],
+        [coreIds.version, coreIds.market, marketCoin, clockObjectRef],
         [coinType]
       );
     },
@@ -225,11 +190,7 @@ const generateCoreNormalMethod: GenerateCoreNormalMethod = ({
           coreIds.coinDecimalsRegistry,
           amount,
           coreIds.xOracle,
-          txBlock.sharedObjectRef({
-            objectId: SUI_CLOCK_OBJECT_ID,
-            mutable: false,
-            initialSharedVersion: '1',
-          }),
+          clockObjectRef,
         ],
         [coinType]
       );
@@ -255,11 +216,7 @@ const generateCoreNormalMethod: GenerateCoreNormalMethod = ({
           borrowReferral,
           typeof amount === 'number' ? txBlock.pure.u64(amount) : amount,
           coreIds.xOracle,
-          txBlock.sharedObjectRef({
-            objectId: SUI_CLOCK_OBJECT_ID,
-            mutable: false,
-            initialSharedVersion: '1',
-          }),
+          clockObjectRef,
         ],
         [coinType, referralWitnessType]
       );
@@ -278,11 +235,7 @@ const generateCoreNormalMethod: GenerateCoreNormalMethod = ({
           coreIds.coinDecimalsRegistry,
           txBlock.pure.u64(amount),
           coreIds.xOracle,
-          txBlock.sharedObjectRef({
-            objectId: SUI_CLOCK_OBJECT_ID,
-            mutable: false,
-            initialSharedVersion: '1',
-          }),
+          clockObjectRef,
         ],
         [coinType]
       );
@@ -292,17 +245,7 @@ const generateCoreNormalMethod: GenerateCoreNormalMethod = ({
       builder.moveCall(
         txBlock,
         `${coreIds.protocolPkg}::repay::repay`,
-        [
-          coreIds.version,
-          obligation,
-          coreIds.market,
-          coin,
-          txBlock.sharedObjectRef({
-            objectId: SUI_CLOCK_OBJECT_ID,
-            mutable: false,
-            initialSharedVersion: '1',
-          }),
-        ],
+        [coreIds.version, obligation, coreIds.market, coin, clockObjectRef],
         [coinType]
       );
     },
@@ -479,7 +422,7 @@ const generateCoreQuickMethod: GenerateCoreQuickMethod = ({
         )) ?? [];
       const updateCoinNames = [...obligationCoinNames, poolCoinName];
       await updateOracles(builder, txBlock, updateCoinNames);
-      return await txBlock.borrow(
+      return txBlock.borrow(
         obligationInfo.obligationId,
         obligationInfo.obligationKey as SuiObjectArg,
         amount,

package/src/builders/oracle.ts

@@ -7,8 +7,14 @@ import { SUPPORT_COLLATERALS, SUPPORT_POOLS } from '../constants';
 import type { TransactionArgument } from '@mysten/sui/transactions';
 import type { SuiTxBlock as SuiKitTxBlock } from '@scallop-io/sui-kit';
 import type { ScallopBuilder } from '../models';
-import type { SupportAssetCoins, SupportOracleType } from '../types';
+import type {
+  SupportAssetCoins,
+  SupportOracleType,
+  xOracleRules,
+  xOracleRuleType,
+} from '../types';
 import { PYTH_ENDPOINTS } from 'src/constants/pyth';
+import { xOracleList } from 'src/constants';
 
 /**
  * Update the price of the oracle for multiple coin.
@@ -21,18 +27,26 @@ import { PYTH_ENDPOINTS } from 'src/constants/pyth';
 export const updateOracles = async (
   builder: ScallopBuilder,
   txBlock: SuiKitTxBlock,
-  assetCoinNames?: SupportAssetCoins[],
+  assetCoinNames: SupportAssetCoins[] = [
+    ...new Set([...SUPPORT_POOLS, ...SUPPORT_COLLATERALS]),
+  ],
   options: {
     usePythPullModel: boolean;
   } = { usePythPullModel: true }
 ) => {
   const usePythPullModel =
     builder.params.usePythPullModel ?? options.usePythPullModel;
-  assetCoinNames = assetCoinNames ?? [
-    ...new Set([...SUPPORT_POOLS, ...SUPPORT_COLLATERALS]),
+  // const rules: SupportOracleType[] = builder.isTestnet ? ['pyth'] : ['pyth'];
+  const flattenedRules: SupportOracleType[] = [
+    ...new Set(
+      Object.values(xOracleList).flatMap(({ primary, secondary }) => [
+        ...primary,
+        ...secondary,
+      ])
+    ),
   ];
-  const rules: SupportOracleType[] = builder.isTestnet ? ['pyth'] : ['pyth'];
-  if (usePythPullModel && rules.includes('pyth')) {
+
+  if (flattenedRules.includes('pyth') && usePythPullModel) {
     const pythClient = new SuiPythClient(
       builder.suiKit.client(),
       builder.address.get('core.oracles.pyth.state'),
@@ -69,7 +83,12 @@ export const updateOracles = async (
   // Remove duplicate coin names.
   const updateAssetCoinNames = [...new Set(assetCoinNames)];
   for (const assetCoinName of updateAssetCoinNames) {
-    await updateOracle(builder, txBlock, assetCoinName, rules);
+    await updateOracle(
+      builder,
+      txBlock,
+      assetCoinName,
+      xOracleList[assetCoinName]
+    );
   }
 };
 
@@ -84,7 +103,7 @@ const updateOracle = async (
   builder: ScallopBuilder,
   txBlock: SuiKitTxBlock,
   assetCoinName: SupportAssetCoins,
-  rules: SupportOracleType[]
+  rules: xOracleRules
 ) => {
   const coinType = builder.utils.parseCoinType(assetCoinName);
 
@@ -129,7 +148,7 @@ const updateOracle = async (
  */
 const updatePrice = (
   txBlock: SuiKitTxBlock,
-  rules: SupportOracleType[],
+  rules: xOracleRules,
   xOraclePackageId: string,
   xOracleId: TransactionArgument | string,
   pythPackageId: string,
@@ -150,37 +169,42 @@ const updatePrice = (
     xOracleId,
     coinType
   );
-  if (rules.includes('pyth')) {
-    updatePythPrice(
-      txBlock,
-      pythPackageId,
-      request,
-      pythStateId,
-      pythFeedObjectId,
-      pythRegistryId,
-      coinType
-    );
-  }
-  if (rules.includes('switchboard')) {
-    updateSwitchboardPrice(
-      txBlock,
-      switchboardPackageId,
-      request,
-      switchboardAggregatorId,
-      switchboardRegistryId,
-      coinType
-    );
-  }
-  if (rules.includes('supra')) {
-    updateSupraPrice(
-      txBlock,
-      supraPackageId,
-      request,
-      supraHolderId,
-      supraRegistryId,
-      coinType
-    );
-  }
+  Object.entries(rules).forEach(([type, rule]: [any, SupportOracleType[]]) => {
+    if (rule.includes('pyth')) {
+      updatePythPrice(
+        type,
+        txBlock,
+        pythPackageId,
+        request,
+        pythStateId,
+        pythFeedObjectId,
+        pythRegistryId,
+        coinType
+      );
+    }
+    if (rule.includes('supra')) {
+      updateSupraPrice(
+        type,
+        txBlock,
+        supraPackageId,
+        request,
+        supraHolderId,
+        supraRegistryId,
+        coinType
+      );
+    }
+    if (rule.includes('switchboard')) {
+      updateSwitchboardPrice(
+        type,
+        txBlock,
+        switchboardPackageId,
+        request,
+        switchboardAggregatorId,
+        switchboardRegistryId,
+        coinType
+      );
+    }
+  });
 
   confirmPriceUpdateRequest(
     txBlock,
@@ -260,6 +284,7 @@ const confirmPriceUpdateRequest = (
  * @return TxBlock created by SuiKit.
  */
 const updateSupraPrice = (
+  type: xOracleRuleType,
   txBlock: SuiKitTxBlock,
   packageId: string,
   request: TransactionArgument,
@@ -268,15 +293,15 @@ const updateSupraPrice = (
   coinType: string
 ) => {
   txBlock.moveCall(
-    `${packageId}::rule::set_price`,
+    `${packageId}::rule::set_price_as_${type}`,
     [
       request,
       holderId,
       registryId,
       txBlock.sharedObjectRef({
         objectId: SUI_CLOCK_OBJECT_ID,
-        mutable: false,
         initialSharedVersion: '1',
+        mutable: false,
       }),
     ],
     [coinType]
@@ -296,6 +321,7 @@ const updateSupraPrice = (
  * @return TxBlock created by SuiKit.
  */
 const updateSwitchboardPrice = (
+  type: xOracleRuleType,
   txBlock: SuiKitTxBlock,
   packageId: string,
   request: TransactionArgument,
@@ -304,15 +330,15 @@ const updateSwitchboardPrice = (
   coinType: string
 ) => {
   txBlock.moveCall(
-    `${packageId}::rule::set_price`,
+    `${packageId}::rule::set_price_as_${type}`,
     [
       request,
       aggregatorId,
       registryId,
       txBlock.sharedObjectRef({
         objectId: SUI_CLOCK_OBJECT_ID,
-        mutable: false,
         initialSharedVersion: '1',
+        mutable: false,
       }),
     ],
     [coinType]
@@ -335,6 +361,7 @@ const updateSwitchboardPrice = (
  * @return TxBlock created by SuiKit.
  */
 const updatePythPrice = (
+  type: xOracleRuleType,
   txBlock: SuiKitTxBlock,
   packageId: string,
   request: TransactionArgument,
@@ -344,7 +371,7 @@ const updatePythPrice = (
   coinType: string
 ) => {
   txBlock.moveCall(
-    `${packageId}::rule::set_price`,
+    `${packageId}::rule::set_price_as_${type}`,
     [
       request,
       stateId,
@@ -352,8 +379,8 @@ const updatePythPrice = (
       registryId,
       txBlock.sharedObjectRef({
         objectId: SUI_CLOCK_OBJECT_ID,
-        mutable: false,
         initialSharedVersion: '1',
+        mutable: false,
       }),
     ],
     [coinType]

package/src/builders/referralBuilder.ts

@@ -32,6 +32,11 @@ const generateReferralNormalMethod: GenerateReferralNormalMethod = ({
   };
 
   const veScaTable = builder.address.get('vesca.table');
+  const clockObjectRef = txBlock.sharedObjectRef({
+    objectId: SUI_CLOCK_OBJECT_ID,
+    mutable: false,
+    initialSharedVersion: '1',
+  });
 
   return {
     bindToReferral: (veScaKeyId: string) => {
@@ -42,11 +47,7 @@ const generateReferralNormalMethod: GenerateReferralNormalMethod = ({
           referralIds.referralBindings,
           txBlock.pure.id(veScaKeyId),
           veScaTable,
-          txBlock.sharedObjectRef({
-            objectId: SUI_CLOCK_OBJECT_ID,
-            mutable: false,
-            initialSharedVersion: '1',
-          }),
+          clockObjectRef,
         ],
         []
       );
@@ -62,11 +63,7 @@ const generateReferralNormalMethod: GenerateReferralNormalMethod = ({
           referralIds.referralBindings,
           referralIds.authorizedWitnessList,
           referralIds.referralTiers,
-          txBlock.sharedObjectRef({
-            objectId: SUI_CLOCK_OBJECT_ID,
-            mutable: false,
-            initialSharedVersion: '1',
-          }),
+          clockObjectRef,
         ],
         [coinType]
       );
@@ -80,11 +77,7 @@ const generateReferralNormalMethod: GenerateReferralNormalMethod = ({
           referralIds.version,
           ticket,
           referralIds.referralRevenuePool,
-          txBlock.sharedObjectRef({
-            objectId: SUI_CLOCK_OBJECT_ID,
-            mutable: false,
-            initialSharedVersion: '1',
-          }),
+          clockObjectRef,
         ],
         [coinType]
       );
@@ -101,11 +94,7 @@ const generateReferralNormalMethod: GenerateReferralNormalMethod = ({
           referralIds.version,
           referralIds.referralRevenuePool,
           veScaKey,
-          txBlock.sharedObjectRef({
-            objectId: SUI_CLOCK_OBJECT_ID,
-            mutable: false,
-            initialSharedVersion: '1',
-          }),
+          clockObjectRef,
         ],
         [coinType]
       );

package/src/builders/spoolBuilder.ts

@@ -126,6 +126,12 @@ const generateSpoolNormalMethod: GenerateSpoolNormalMethod = ({
   const spoolIds: SpoolIds = {
     spoolPkg: builder.address.get('spool.id'),
   };
+  const clockObjectRef = txBlock.sharedObjectRef({
+    objectId: SUI_CLOCK_OBJECT_ID,
+    mutable: false,
+    initialSharedVersion: '1',
+  });
+
   return {
     createStakeAccount: (stakeMarketCoinName) => {
       const marketCoinType =
@@ -136,14 +142,7 @@ const generateSpoolNormalMethod: GenerateSpoolNormalMethod = ({
       return builder.moveCall(
         txBlock,
         `${spoolIds.spoolPkg}::user::new_spool_account`,
-        [
-          stakePoolId,
-          txBlock.sharedObjectRef({
-            objectId: SUI_CLOCK_OBJECT_ID,
-            mutable: false,
-            initialSharedVersion: '1',
-          }),
-        ],
+        [stakePoolId, clockObjectRef],
         [marketCoinType]
       );
     },
@@ -156,16 +155,7 @@ const generateSpoolNormalMethod: GenerateSpoolNormalMethod = ({
       builder.moveCall(
         txBlock,
         `${spoolIds.spoolPkg}::user::stake`,
-        [
-          stakePoolId,
-          stakeAccount,
-          coin,
-          txBlock.sharedObjectRef({
-            objectId: SUI_CLOCK_OBJECT_ID,
-            mutable: false,
-            initialSharedVersion: '1',
-          }),
-        ],
+        [stakePoolId, stakeAccount, coin, clockObjectRef],
         [marketCoinType]
       );
     },
@@ -178,16 +168,7 @@ const generateSpoolNormalMethod: GenerateSpoolNormalMethod = ({
       return builder.moveCall(
         txBlock,
         `${spoolIds.spoolPkg}::user::unstake`,
-        [
-          stakePoolId,
-          stakeAccount,
-          amount,
-          txBlock.sharedObjectRef({
-            objectId: SUI_CLOCK_OBJECT_ID,
-            mutable: false,
-            initialSharedVersion: '1',
-          }),
-        ],
+        [stakePoolId, stakeAccount, amount, clockObjectRef],
         [marketCoinType]
       );
     },
@@ -205,16 +186,7 @@ const generateSpoolNormalMethod: GenerateSpoolNormalMethod = ({
       return builder.moveCall(
         txBlock,
         `${spoolIds.spoolPkg}::user::redeem_rewards`,
-        [
-          stakePoolId,
-          rewardPoolId,
-          stakeAccount,
-          txBlock.sharedObjectRef({
-            objectId: SUI_CLOCK_OBJECT_ID,
-            mutable: false,
-            initialSharedVersion: '1',
-          }),
-        ],
+        [stakePoolId, rewardPoolId, stakeAccount, clockObjectRef],
         [marketCoinType, rewardCoinType]
       );
     },