@scallop-io/sui-scallop-sdk 1.4.24-alpha.1 → 1.5.0-alpha.1

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]
       );
     },

package/src/builders/vescaBuilder.ts

@@ -87,6 +87,11 @@ const generateNormalVeScaMethod: GenerateVeScaNormalMethod = ({
     treasury: builder.address.get('vesca.treasury'),
     config: builder.address.get('vesca.config'),
   };
+  const clockObjectRef = txBlock.sharedObjectRef({
+    objectId: SUI_CLOCK_OBJECT_ID,
+    mutable: false,
+    initialSharedVersion: '1',
+  });
 
   return {
     lockSca: (scaCoin, unlockAtInSecondTimestamp) => {
@@ -99,11 +104,7 @@ const generateNormalVeScaMethod: GenerateVeScaNormalMethod = ({
           veScaIds.treasury,
           scaCoin,
           unlockAtInSecondTimestamp,
-          txBlock.sharedObjectRef({
-            objectId: SUI_CLOCK_OBJECT_ID,
-            mutable: false,
-            initialSharedVersion: '1',
-          }),
+          clockObjectRef,
         ],
         []
       );
@@ -118,11 +119,7 @@ const generateNormalVeScaMethod: GenerateVeScaNormalMethod = ({
           veScaIds.table,
           veScaIds.treasury,
           newUnlockAtInSecondTimestamp,
-          txBlock.sharedObjectRef({
-            objectId: SUI_CLOCK_OBJECT_ID,
-            mutable: false,
-            initialSharedVersion: '1',
-          }),
+          clockObjectRef,
         ],
         []
       );
@@ -137,11 +134,7 @@ const generateNormalVeScaMethod: GenerateVeScaNormalMethod = ({
           veScaIds.table,
           veScaIds.treasury,
           scaCoin,
-          txBlock.sharedObjectRef({
-            objectId: SUI_CLOCK_OBJECT_ID,
-            mutable: false,
-            initialSharedVersion: '1',
-          }),
+          clockObjectRef,
         ],
         []
       );
@@ -157,11 +150,7 @@ const generateNormalVeScaMethod: GenerateVeScaNormalMethod = ({
           veScaIds.treasury,
           scaCoin,
           newUnlockAtInSecondTimestamp,
-          txBlock.sharedObjectRef({
-            objectId: SUI_CLOCK_OBJECT_ID,
-            mutable: false,
-            initialSharedVersion: '1',
-          }),
+          clockObjectRef,
         ],
         []
       );
@@ -175,11 +164,7 @@ const generateNormalVeScaMethod: GenerateVeScaNormalMethod = ({
           veScaKey,
           veScaIds.table,
           veScaIds.treasury,
-          txBlock.sharedObjectRef({
-            objectId: SUI_CLOCK_OBJECT_ID,
-            mutable: false,
-            initialSharedVersion: '1',
-          }),
+          clockObjectRef,
         ],
         []
       );
@@ -372,7 +357,7 @@ const generateQuickVeScaMethod: GenerateVeScaQuickMethod = ({
       checkVesca(veSca?.unlockAt);
 
       if (veSca) {
-        const sca = await txBlock.redeemSca(veSca.keyId);
+        const sca = txBlock.redeemSca(veSca.keyId);
         if (transferSca) {
           txBlock.transferObjects([sca], sender);
           return;

package/src/constants/coinGecko.ts

@@ -1,32 +1,24 @@
 import { SupportPoolCoins } from 'src/types/constant/common';
 
 export const COIN_GECKGO_IDS: Record<SupportPoolCoins, string> = {
-  // Sui Bridge
+  usdc: 'usdc',
   sbeth: 'ethereum',
   sbusdt: 'tether',
   sbwbtc: 'bitcoin',
-  // Wormhole
   weth: 'ethereum',
   wbtc: 'bitcoin',
   wusdc: 'usdc',
   wusdt: 'tether',
+  sui: 'sui',
   wapt: 'aptos',
   wsol: 'solana',
-  // Sui Native
-  usdc: 'usdc',
-  // Sui LST
-  sui: 'sui',
+  cetus: 'cetus-protocol',
   afsui: 'sui',
   hasui: 'sui',
   vsui: 'sui',
-  // Stable
-  fdusd: 'first-digital-usd',
-  // DeFi
-  cetus: 'cetus-protocol',
   sca: 'scallop-2',
+  fdusd: 'first-digital-usd',
   deep: 'deepbook',
-  // Isolated Asset
   fud: 'fud-the-pug',
   blub: 'blub',
-  musd: '', // @TODO: add coinGecko id
 };

package/src/constants/common.ts

@@ -50,7 +50,6 @@ export const SUPPORT_POOLS = [
   'deep',
   'fdusd',
   'blub',
-  'musd',
 ] as const;
 
 export const SUPPORT_COLLATERALS = [
@@ -105,7 +104,6 @@ export const SUPPORT_SCOIN = [
   'sfud',
   'sfdusd',
   'sblub',
-  'smusd',
 ] as const;
 
 export const SUPPORT_SUI_BRIDGE = ['sbeth', 'sbusdt', 'sbwbtc'] as const;

package/src/constants/enum.ts

@@ -22,7 +22,6 @@ export const coinDecimals: types.SupportCoinDecimals = {
   deep: 6,
   fud: 5,
   blub: 2,
-  musd: 9,
   susdc: 6,
   sweth: 8,
   ssbeth: 8,
@@ -43,7 +42,6 @@ export const coinDecimals: types.SupportCoinDecimals = {
   sdeep: 6,
   sfud: 5,
   sblub: 2,
-  smusd: 9,
 };
 
 export const assetCoins: types.AssetCoins = {
@@ -67,7 +65,6 @@ export const assetCoins: types.AssetCoins = {
   deep: 'deep',
   fud: 'fud',
   blub: 'blub',
-  musd: 'musd',
 };
 
 export const marketCoins: types.MarketCoins = {
@@ -91,7 +88,6 @@ export const marketCoins: types.MarketCoins = {
   sdeep: 'sdeep',
   sfud: 'sfud',
   sblub: 'sblub',
-  smusd: 'smusd',
 };
 
 export const sCoins: types.SCoins = {
@@ -114,7 +110,6 @@ export const sCoins: types.SCoins = {
   sfud: 'sfud',
   sdeep: 'sdeep',
   sblub: 'sblub',
-  smusd: 'smusd',
 };
 
 export const stakeMarketCoins: types.StakeMarketCoins = {
@@ -175,7 +170,6 @@ export const coinIds: types.AssetCoinIds = {
   sbeth: '0xd0e89b2af5e4910726fbcd8b8dd37bb79b29e5f83f7491bca830e94f7f226d29',
   sbusdt: '0x375f70cf2ae4c00bf37117d0c85a2c71545e6ee05c4a5c7d282cd66a4504b068',
   sbwbtc: '0xaafb102dd0902f5055cadecd687fb5b71ca82ef0e0285d90afde828ec58ca96b',
-  musd: '0xe44df51c0b21a27ab915fa1fe2ca610cd3eaa6d9666fe5e62b988bf7f0bd8722',
 };
 
 export const wormholeCoinIds: types.WormholeCoinIds = {
@@ -193,8 +187,10 @@ export const voloCoinIds: types.VoloCoinIds = {
 
 // PROD VERSION
 export const sCoinIds: types.SCoinIds = {
-  ssui: '0xaafc4f740de0dd0dde642a31148fb94517087052f19afb0f7bed1dc41a50c77b::scallop_sui::SCALLOP_SUI',
-  ssca: '0x5ca17430c1d046fae9edeaa8fd76c7b4193a00d764a0ecfa9418d733ad27bc1e::scallop_sca::SCALLOP_SCA',
+  // ssui: '0xaafc4f740de0dd0dde642a31148fb94517087052f19afb0f7bed1dc41a50c77b::scallop_sui::SCALLOP_SUI', // @TODO: restore on prod
+  ssui: '0x88618204de2dfdc2597681a8441ee726b0dc13494c41e319c3264eb7b35fea90::scallop_sui::SCALLOP_SUI',
+  // ssca: '0x5ca17430c1d046fae9edeaa8fd76c7b4193a00d764a0ecfa9418d733ad27bc1e::scallop_sca::SCALLOP_SCA', // @TODO: restore on prod
+  ssca: '0x9f64a180373a6b66595025ae16a4ab701f0af1dd5c7ce1ac91dc112e52c2a3f8::scallop_sca::SCALLOP_SCA',
   scetus:
     '0xea346ce428f91ab007210443efcea5f5cdbbb3aae7e9affc0ca93f9203c31f0c::scallop_cetus::SCALLOP_CETUS',
   // Wormhole assets
@@ -213,7 +209,8 @@ export const sCoinIds: types.SCoinIds = {
     '0xe1a1cc6bcf0001a015eab84bcc6713393ce20535f55b8b6f35c142e057a25fbe::scallop_v_sui::SCALLOP_V_SUI',
   // stable coins
   susdc:
-    '0x854950aa624b1df59fe64e630b2ba7c550642e9342267a33061d59fb31582da5::scallop_usdc::SCALLOP_USDC',
+    // '0x854950aa624b1df59fe64e630b2ba7c550642e9342267a33061d59fb31582da5::scallop_usdc::SCALLOP_USDC', // @TODO: restore on prod
+    '0x55ed015f9f006c0c96ad36ebe3b3570d088e8498f52defea48e5634c110e485c::scallop_usdc::SCALLOP_USDC',
   swusdc:
     '0xad4d71551d31092230db1fd482008ea42867dbf27b286e9c70a79d2a6191d58d::scallop_wormhole_usdc::SCALLOP_WORMHOLE_USDC',
   swusdt:
@@ -222,8 +219,10 @@ export const sCoinIds: types.SCoinIds = {
     '0x6711551c1e7652a270d9fbf0eee25d99594c157cde3cb5fbb49035eb59b1b001::scallop_fdusd::SCALLOP_FDUSD',
   // isolated assets
   sdeep:
-    '0xeb7a05a3224837c5e5503575aed0be73c091d1ce5e43aa3c3e716e0ae614608f::scallop_deep::SCALLOP_DEEP',
-  sfud: '0xe56d5167f427cbe597da9e8150ef5c337839aaf46891d62468dcf80bdd8e10d1::scallop_fud::SCALLOP_FUD',
+    // '0xeb7a05a3224837c5e5503575aed0be73c091d1ce5e43aa3c3e716e0ae614608f::scallop_deep::SCALLOP_DEEP', // @TODO: restore on prod
+    '0x34f0a2e793e1f79ceac72cfe3bb95f65541da449418289ccd12922d16140c882::scallop_deep::SCALLOP_DEEP',
+  // sfud: '0xe56d5167f427cbe597da9e8150ef5c337839aaf46891d62468dcf80bdd8e10d1::scallop_fud::SCALLOP_FUD', // @TODO: restore on prod
+  sfud: '0x3b23c05f917052255a0b16a534dbd4446911aa4a30bd3497cdf5b736551e7ef8::scallop_fud::SCALLOP_FUD',
   sblub:
     '0xe72f65446eabfad2103037af2d49d24599106fb44bf4c046c1e7e9acf6844dd0::scallop_blub::SCALLOP_BLUB',
   // Sui bridge assets
@@ -233,8 +232,6 @@ export const sCoinIds: types.SCoinIds = {
     '0xb1d7df34829d1513b73ba17cb7ad90c88d1e104bb65ab8f62f13e0cc103783d3::scallop_sb_usdt::SCALLOP_SB_USDT',
   ssbwbtc:
     '0x08c0fe357d3a138f4552bee393ce3a28a45bebcca43373d6a90bc44ab76f82e2::scallop_sb_wbtc::SCALLOP_SB_WBTC',
-  smusd:
-    '0x0a228d1c59071eccf3716076a1f71216846ee256d9fb07ea11fb7c1eb56435a5::scallop_musd::SCALLOP_MUSD',
 } as const;
 
 export const sCoinTypeToName = Object.entries(sCoinIds).reduce(

package/src/constants/index.ts

@@ -10,3 +10,4 @@ export * from './rpc';
 export * from './testAddress';
 export * from './vesca';
 export * from './testAddress';
+export * from './xoracle';