@scallop-io/sui-scallop-sdk 1.4.19 → 1.4.20

package/dist/types/query/portfolio.d.ts

@@ -105,10 +105,14 @@ export type ObligationBorrowIncentive = {
     rewards: ObligationBorrowIcentiveReward[];
 };
 export type TotalValueLocked = {
+    supplyLendingValue: number;
+    supplyCollateralValue: number;
     supplyValue: number;
     borrowValue: number;
     totalValue: number;
     supplyValueChangeRatio?: number;
+    supplyLendingValueChangeRatio?: number;
+    supplyCollateralValueChangeRatio?: number;
     borrowValueChangeRatio?: number;
     totalValueChangeRatio?: number;
 };

package/package.json

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

package/src/builders/borrowIncentiveBuilder.ts

@@ -1,6 +1,8 @@
 import { Transaction } from '@mysten/sui/transactions';
-import { SUI_CLOCK_OBJECT_ID } from '@mysten/sui/utils';
-import { SuiTxBlock as SuiKitTxBlock } from '@scallop-io/sui-kit';
+import {
+  SuiTxBlock as SuiKitTxBlock,
+  SUI_CLOCK_OBJECT_ID,
+} from '@scallop-io/sui-kit';
 import { getObligations, getObligationLocked } from '../queries';
 import { requireSender } from '../utils';
 import type { SuiObjectArg } from '@scallop-io/sui-kit';
@@ -108,7 +110,11 @@ const generateBorrowIncentiveNormalMethod: GenerateBorrowIncentiveNormalMethod =
             obligationKey,
             obligationId,
             borrowIncentiveIds.obligationAccessStore,
-            SUI_CLOCK_OBJECT_ID,
+            txBlock.sharedObjectRef({
+              objectId: SUI_CLOCK_OBJECT_ID,
+              mutable: false,
+              initialSharedVersion: '1',
+            }),
           ]
         );
       },
@@ -127,7 +133,11 @@ const generateBorrowIncentiveNormalMethod: GenerateBorrowIncentiveNormalMethod =
             veScaIds.treasury,
             veScaIds.table,
             veScaKey,
-            SUI_CLOCK_OBJECT_ID,
+            txBlock.sharedObjectRef({
+              objectId: SUI_CLOCK_OBJECT_ID,
+              mutable: false,
+              initialSharedVersion: '1',
+            }),
           ],
           []
         );
@@ -142,7 +152,11 @@ const generateBorrowIncentiveNormalMethod: GenerateBorrowIncentiveNormalMethod =
             borrowIncentiveIds.incentiveAccounts,
             obligationKey,
             obligationId,
-            SUI_CLOCK_OBJECT_ID,
+            txBlock.sharedObjectRef({
+              objectId: SUI_CLOCK_OBJECT_ID,
+              mutable: false,
+              initialSharedVersion: '1',
+            }),
           ]
         );
       },
@@ -157,7 +171,11 @@ const generateBorrowIncentiveNormalMethod: GenerateBorrowIncentiveNormalMethod =
             borrowIncentiveIds.incentiveAccounts,
             obligationKey,
             obligationId,
-            SUI_CLOCK_OBJECT_ID,
+            txBlock.sharedObjectRef({
+              objectId: SUI_CLOCK_OBJECT_ID,
+              mutable: false,
+              initialSharedVersion: '1',
+            }),
           ],
           [rewardType]
         );
@@ -172,7 +190,11 @@ const generateBorrowIncentiveNormalMethod: GenerateBorrowIncentiveNormalMethod =
             borrowIncentiveIds.incentiveAccounts,
             obligation,
             veScaKey,
-            SUI_CLOCK_OBJECT_ID,
+            txBlock.sharedObjectRef({
+              objectId: SUI_CLOCK_OBJECT_ID,
+              mutable: false,
+              initialSharedVersion: '1',
+            }),
           ]
         );
       },

package/src/builders/coreBuilder.ts

@@ -126,7 +126,11 @@ const generateCoreNormalMethod: GenerateCoreNormalMethod = ({
           coreIds.coinDecimalsRegistry,
           txBlock.pure.u64(amount),
           coreIds.xOracle,
-          SUI_CLOCK_OBJECT_ID,
+          txBlock.sharedObjectRef({
+            objectId: SUI_CLOCK_OBJECT_ID,
+            mutable: false,
+            initialSharedVersion: '1',
+          }),
         ],
         [coinType]
       );
@@ -137,7 +141,16 @@ const generateCoreNormalMethod: GenerateCoreNormalMethod = ({
       return builder.moveCall(
         txBlock,
         `${coreIds.protocolPkg}::mint::mint`,
-        [coreIds.version, coreIds.market, coin, SUI_CLOCK_OBJECT_ID],
+        [
+          coreIds.version,
+          coreIds.market,
+          coin,
+          txBlock.sharedObjectRef({
+            objectId: SUI_CLOCK_OBJECT_ID,
+            mutable: false,
+            initialSharedVersion: '1',
+          }),
+        ],
         [coinType]
       );
     },
@@ -147,7 +160,16 @@ const generateCoreNormalMethod: GenerateCoreNormalMethod = ({
       return builder.moveCall(
         txBlock,
         `${coreIds.protocolPkg}::mint::mint_entry`,
-        [coreIds.version, coreIds.market, coin, SUI_CLOCK_OBJECT_ID],
+        [
+          coreIds.version,
+          coreIds.market,
+          coin,
+          txBlock.sharedObjectRef({
+            objectId: SUI_CLOCK_OBJECT_ID,
+            mutable: false,
+            initialSharedVersion: '1',
+          }),
+        ],
         [coinType]
       );
     },
@@ -157,7 +179,16 @@ const generateCoreNormalMethod: GenerateCoreNormalMethod = ({
       return builder.moveCall(
         txBlock,
         `${coreIds.protocolPkg}::redeem::redeem`,
-        [coreIds.version, coreIds.market, marketCoin, SUI_CLOCK_OBJECT_ID],
+        [
+          coreIds.version,
+          coreIds.market,
+          marketCoin,
+          txBlock.sharedObjectRef({
+            objectId: SUI_CLOCK_OBJECT_ID,
+            mutable: false,
+            initialSharedVersion: '1',
+          }),
+        ],
         [coinType]
       );
     },
@@ -167,7 +198,16 @@ const generateCoreNormalMethod: GenerateCoreNormalMethod = ({
       return builder.moveCall(
         txBlock,
         `${coreIds.protocolPkg}::redeem::redeem_entry`,
-        [coreIds.version, coreIds.market, marketCoin, SUI_CLOCK_OBJECT_ID],
+        [
+          coreIds.version,
+          coreIds.market,
+          marketCoin,
+          txBlock.sharedObjectRef({
+            objectId: SUI_CLOCK_OBJECT_ID,
+            mutable: false,
+            initialSharedVersion: '1',
+          }),
+        ],
         [coinType]
       );
     },
@@ -185,7 +225,11 @@ const generateCoreNormalMethod: GenerateCoreNormalMethod = ({
           coreIds.coinDecimalsRegistry,
           amount,
           coreIds.xOracle,
-          SUI_CLOCK_OBJECT_ID,
+          txBlock.sharedObjectRef({
+            objectId: SUI_CLOCK_OBJECT_ID,
+            mutable: false,
+            initialSharedVersion: '1',
+          }),
         ],
         [coinType]
       );
@@ -211,7 +255,11 @@ const generateCoreNormalMethod: GenerateCoreNormalMethod = ({
           borrowReferral,
           typeof amount === 'number' ? txBlock.pure.u64(amount) : amount,
           coreIds.xOracle,
-          SUI_CLOCK_OBJECT_ID,
+          txBlock.sharedObjectRef({
+            objectId: SUI_CLOCK_OBJECT_ID,
+            mutable: false,
+            initialSharedVersion: '1',
+          }),
         ],
         [coinType, referralWitnessType]
       );
@@ -230,7 +278,11 @@ const generateCoreNormalMethod: GenerateCoreNormalMethod = ({
           coreIds.coinDecimalsRegistry,
           txBlock.pure.u64(amount),
           coreIds.xOracle,
-          SUI_CLOCK_OBJECT_ID,
+          txBlock.sharedObjectRef({
+            objectId: SUI_CLOCK_OBJECT_ID,
+            mutable: false,
+            initialSharedVersion: '1',
+          }),
         ],
         [coinType]
       );
@@ -245,7 +297,11 @@ const generateCoreNormalMethod: GenerateCoreNormalMethod = ({
           obligation,
           coreIds.market,
           coin,
-          SUI_CLOCK_OBJECT_ID,
+          txBlock.sharedObjectRef({
+            objectId: SUI_CLOCK_OBJECT_ID,
+            mutable: false,
+            initialSharedVersion: '1',
+          }),
         ],
         [coinType]
       );
@@ -449,7 +505,7 @@ const generateCoreQuickMethod: GenerateCoreQuickMethod = ({
         )) ?? [];
       const updateCoinNames = [...obligationCoinNames, poolCoinName];
       await updateOracles(builder, txBlock, updateCoinNames);
-      return await txBlock.borrowWithReferral(
+      return txBlock.borrowWithReferral(
         obligationInfo.obligationId,
         obligationInfo.obligationKey as SuiObjectArg,
         borrowReferral,

package/src/builders/oracle.ts

@@ -231,7 +231,19 @@ const confirmPriceUpdateRequest = (
 ) => {
   const target = `${packageId}::x_oracle::confirm_price_update_request`;
   const typeArgs = [coinType];
-  txBlock.moveCall(target, [xOracleId, request, SUI_CLOCK_OBJECT_ID], typeArgs);
+  txBlock.moveCall(
+    target,
+    [
+      xOracleId,
+      request,
+      txBlock.sharedObjectRef({
+        objectId: SUI_CLOCK_OBJECT_ID,
+        mutable: false,
+        initialSharedVersion: '1',
+      }),
+    ],
+    typeArgs
+  );
   return txBlock;
 };
 
@@ -257,7 +269,16 @@ const updateSupraPrice = (
 ) => {
   txBlock.moveCall(
     `${packageId}::rule::set_price`,
-    [request, holderId, registryId, SUI_CLOCK_OBJECT_ID],
+    [
+      request,
+      holderId,
+      registryId,
+      txBlock.sharedObjectRef({
+        objectId: SUI_CLOCK_OBJECT_ID,
+        mutable: false,
+        initialSharedVersion: '1',
+      }),
+    ],
     [coinType]
   );
 };
@@ -284,7 +305,16 @@ const updateSwitchboardPrice = (
 ) => {
   txBlock.moveCall(
     `${packageId}::rule::set_price`,
-    [request, aggregatorId, registryId, SUI_CLOCK_OBJECT_ID],
+    [
+      request,
+      aggregatorId,
+      registryId,
+      txBlock.sharedObjectRef({
+        objectId: SUI_CLOCK_OBJECT_ID,
+        mutable: false,
+        initialSharedVersion: '1',
+      }),
+    ],
     [coinType]
   );
 };
@@ -315,7 +345,17 @@ const updatePythPrice = (
 ) => {
   txBlock.moveCall(
     `${packageId}::rule::set_price`,
-    [request, stateId, feedObjectId, registryId, SUI_CLOCK_OBJECT_ID],
+    [
+      request,
+      stateId,
+      feedObjectId,
+      registryId,
+      txBlock.sharedObjectRef({
+        objectId: SUI_CLOCK_OBJECT_ID,
+        mutable: false,
+        initialSharedVersion: '1',
+      }),
+    ],
     [coinType]
   );
 };

package/src/builders/referralBuilder.ts

@@ -42,7 +42,11 @@ const generateReferralNormalMethod: GenerateReferralNormalMethod = ({
           referralIds.referralBindings,
           txBlock.pure.id(veScaKeyId),
           veScaTable,
-          SUI_CLOCK_OBJECT_ID,
+          txBlock.sharedObjectRef({
+            objectId: SUI_CLOCK_OBJECT_ID,
+            mutable: false,
+            initialSharedVersion: '1',
+          }),
         ],
         []
       );
@@ -58,7 +62,11 @@ const generateReferralNormalMethod: GenerateReferralNormalMethod = ({
           referralIds.referralBindings,
           referralIds.authorizedWitnessList,
           referralIds.referralTiers,
-          SUI_CLOCK_OBJECT_ID,
+          txBlock.sharedObjectRef({
+            objectId: SUI_CLOCK_OBJECT_ID,
+            mutable: false,
+            initialSharedVersion: '1',
+          }),
         ],
         [coinType]
       );
@@ -72,7 +80,11 @@ const generateReferralNormalMethod: GenerateReferralNormalMethod = ({
           referralIds.version,
           ticket,
           referralIds.referralRevenuePool,
-          SUI_CLOCK_OBJECT_ID,
+          txBlock.sharedObjectRef({
+            objectId: SUI_CLOCK_OBJECT_ID,
+            mutable: false,
+            initialSharedVersion: '1',
+          }),
         ],
         [coinType]
       );
@@ -89,7 +101,11 @@ const generateReferralNormalMethod: GenerateReferralNormalMethod = ({
           referralIds.version,
           referralIds.referralRevenuePool,
           veScaKey,
-          SUI_CLOCK_OBJECT_ID,
+          txBlock.sharedObjectRef({
+            objectId: SUI_CLOCK_OBJECT_ID,
+            mutable: false,
+            initialSharedVersion: '1',
+          }),
         ],
         [coinType]
       );

package/src/builders/spoolBuilder.ts

@@ -136,7 +136,14 @@ const generateSpoolNormalMethod: GenerateSpoolNormalMethod = ({
       return builder.moveCall(
         txBlock,
         `${spoolIds.spoolPkg}::user::new_spool_account`,
-        [stakePoolId, SUI_CLOCK_OBJECT_ID],
+        [
+          stakePoolId,
+          txBlock.sharedObjectRef({
+            objectId: SUI_CLOCK_OBJECT_ID,
+            mutable: false,
+            initialSharedVersion: '1',
+          }),
+        ],
         [marketCoinType]
       );
     },
@@ -149,7 +156,16 @@ const generateSpoolNormalMethod: GenerateSpoolNormalMethod = ({
       builder.moveCall(
         txBlock,
         `${spoolIds.spoolPkg}::user::stake`,
-        [stakePoolId, stakeAccount, coin, SUI_CLOCK_OBJECT_ID],
+        [
+          stakePoolId,
+          stakeAccount,
+          coin,
+          txBlock.sharedObjectRef({
+            objectId: SUI_CLOCK_OBJECT_ID,
+            mutable: false,
+            initialSharedVersion: '1',
+          }),
+        ],
         [marketCoinType]
       );
     },
@@ -162,7 +178,16 @@ const generateSpoolNormalMethod: GenerateSpoolNormalMethod = ({
       return builder.moveCall(
         txBlock,
         `${spoolIds.spoolPkg}::user::unstake`,
-        [stakePoolId, stakeAccount, amount, SUI_CLOCK_OBJECT_ID],
+        [
+          stakePoolId,
+          stakeAccount,
+          amount,
+          txBlock.sharedObjectRef({
+            objectId: SUI_CLOCK_OBJECT_ID,
+            mutable: false,
+            initialSharedVersion: '1',
+          }),
+        ],
         [marketCoinType]
       );
     },
@@ -180,7 +205,16 @@ const generateSpoolNormalMethod: GenerateSpoolNormalMethod = ({
       return builder.moveCall(
         txBlock,
         `${spoolIds.spoolPkg}::user::redeem_rewards`,
-        [stakePoolId, rewardPoolId, stakeAccount, SUI_CLOCK_OBJECT_ID],
+        [
+          stakePoolId,
+          rewardPoolId,
+          stakeAccount,
+          txBlock.sharedObjectRef({
+            objectId: SUI_CLOCK_OBJECT_ID,
+            mutable: false,
+            initialSharedVersion: '1',
+          }),
+        ],
         [marketCoinType, rewardCoinType]
       );
     },

package/src/builders/vescaBuilder.ts

@@ -99,7 +99,11 @@ const generateNormalVeScaMethod: GenerateVeScaNormalMethod = ({
           veScaIds.treasury,
           scaCoin,
           unlockAtInSecondTimestamp,
-          SUI_CLOCK_OBJECT_ID,
+          txBlock.sharedObjectRef({
+            objectId: SUI_CLOCK_OBJECT_ID,
+            mutable: false,
+            initialSharedVersion: '1',
+          }),
         ],
         []
       );
@@ -114,7 +118,11 @@ const generateNormalVeScaMethod: GenerateVeScaNormalMethod = ({
           veScaIds.table,
           veScaIds.treasury,
           newUnlockAtInSecondTimestamp,
-          SUI_CLOCK_OBJECT_ID,
+          txBlock.sharedObjectRef({
+            objectId: SUI_CLOCK_OBJECT_ID,
+            mutable: false,
+            initialSharedVersion: '1',
+          }),
         ],
         []
       );
@@ -129,7 +137,11 @@ const generateNormalVeScaMethod: GenerateVeScaNormalMethod = ({
           veScaIds.table,
           veScaIds.treasury,
           scaCoin,
-          SUI_CLOCK_OBJECT_ID,
+          txBlock.sharedObjectRef({
+            objectId: SUI_CLOCK_OBJECT_ID,
+            mutable: false,
+            initialSharedVersion: '1',
+          }),
         ],
         []
       );
@@ -145,7 +157,11 @@ const generateNormalVeScaMethod: GenerateVeScaNormalMethod = ({
           veScaIds.treasury,
           scaCoin,
           newUnlockAtInSecondTimestamp,
-          SUI_CLOCK_OBJECT_ID,
+          txBlock.sharedObjectRef({
+            objectId: SUI_CLOCK_OBJECT_ID,
+            mutable: false,
+            initialSharedVersion: '1',
+          }),
         ],
         []
       );
@@ -159,7 +175,11 @@ const generateNormalVeScaMethod: GenerateVeScaNormalMethod = ({
           veScaKey,
           veScaIds.table,
           veScaIds.treasury,
-          SUI_CLOCK_OBJECT_ID,
+          txBlock.sharedObjectRef({
+            objectId: SUI_CLOCK_OBJECT_ID,
+            mutable: false,
+            initialSharedVersion: '1',
+          }),
         ],
         []
       );

package/src/constants/queryKeys.ts

@@ -5,7 +5,7 @@ import type {
   SuiObjectData,
   SuiObjectDataOptions,
 } from '@mysten/sui/client';
-import type { SuiObjectArg } from '@scallop-io/sui-kit';
+import type { SuiObjectArg, SuiTxArg } from '@scallop-io/sui-kit';
 
 export const queryKeys = {
   api: {
@@ -76,7 +76,7 @@ export const queryKeys = {
     ],
     getTotalVeScaTreasuryAmount: (
       refreshArgs?: any[],
-      vescaAmountArgs?: (string | SuiObjectData)[]
+      vescaAmountArgs?: (string | SuiObjectData | SuiTxArg)[]
     ) => [
       'rpc',
       'getTotalVeScaTreasuryAmount',

package/src/queries/portfolioQuery.ts

@@ -814,7 +814,8 @@ export const getTotalValueLocked = async (
 ) => {
   const market = await query.getMarketPools(undefined, { indexer });
 
-  let supplyValue = BigNumber(0);
+  let supplyLendingValue = BigNumber(0);
+  let supplyCollateralValue = BigNumber(0);
   let borrowValue = BigNumber(0);
 
   if (indexer) {
@@ -826,12 +827,17 @@ export const getTotalValueLocked = async (
       borrowValueChangeRatio: tvlIndexer.borrowValueChangeRatio,
       totalValue: tvlIndexer.totalValue,
       totalValueChangeRatio: tvlIndexer.totalValueChangeRatio,
+      supplyLendingValue: tvlIndexer.supplyLendingValue,
+      supplyLendingValueChangeRatio: tvlIndexer.supplyLendingValueChangeRatio,
+      supplyCollateralValue: tvlIndexer.supplyCollateralValue,
+      supplyCollateralValueChangeRatio:
+        tvlIndexer.supplyCollateralValueChangeRatio,
     };
     return tvl;
   }
 
   for (const pool of Object.values(market.pools)) {
-    supplyValue = supplyValue.plus(
+    supplyLendingValue = supplyLendingValue.plus(
       BigNumber(pool.supplyCoin).multipliedBy(pool.coinPrice)
     );
     borrowValue = borrowValue.plus(
@@ -841,15 +847,20 @@ export const getTotalValueLocked = async (
 
   // console.dir(market.collaterals, { depth: null });
   for (const collateral of Object.values(market.collaterals)) {
-    supplyValue = supplyValue.plus(
+    supplyCollateralValue = supplyCollateralValue.plus(
       BigNumber(collateral.depositCoin).multipliedBy(collateral.coinPrice)
     );
   }
 
   const tvl: TotalValueLocked = {
-    supplyValue: supplyValue.toNumber(),
+    supplyValue: supplyLendingValue.plus(supplyCollateralValue).toNumber(),
+    supplyLendingValue: supplyLendingValue.toNumber(),
+    supplyCollateralValue: supplyCollateralValue.toNumber(),
     borrowValue: borrowValue.toNumber(),
-    totalValue: supplyValue.minus(borrowValue).toNumber(),
+    totalValue: supplyLendingValue
+      .plus(supplyCollateralValue)
+      .minus(borrowValue)
+      .toNumber(),
   };
 
   return tvl;

package/src/queries/vescaQuery.ts

@@ -183,13 +183,29 @@ const getTotalVeScaTreasuryAmount = async (
   const veScaConfig = utils.address.get('vesca.config');
   veScaTreasury = veScaTreasury ?? utils.address.get('vesca.treasury');
 
+  const txb = new SuiTxBlock();
   // refresh query
   const refreshQueryTarget = `${veScaPkgId}::treasury::refresh`;
-  const refreshArgs = [veScaConfig, veScaTreasury, SUI_CLOCK_OBJECT_ID];
+  const refreshArgs = [
+    veScaConfig,
+    veScaTreasury,
+    txb.sharedObjectRef({
+      objectId: SUI_CLOCK_OBJECT_ID,
+      mutable: false,
+      initialSharedVersion: '1',
+    }),
+  ];
 
   // query total veSca amount
   const veScaAmountQueryTarget = `${veScaPkgId}::treasury::total_ve_sca_amount`;
-  const veScaAmountArgs = [veScaTreasury, SUI_CLOCK_OBJECT_ID];
+  const veScaAmountArgs = [
+    veScaTreasury,
+    txb.sharedObjectRef({
+      objectId: SUI_CLOCK_OBJECT_ID,
+      mutable: false,
+      initialSharedVersion: '1',
+    }),
+  ];
 
   // resolve each args
   const resolvedRefreshArgs = await Promise.all(
@@ -210,8 +226,6 @@ const getTotalVeScaTreasuryAmount = async (
     })
   );
 
-  const txb = new SuiTxBlock();
-
   // refresh first
   txb.moveCall(refreshQueryTarget, resolvedRefreshArgs);
   txb.moveCall(veScaAmountQueryTarget, resolvedVeScaAmountArgs);

package/src/types/query/portfolio.ts

@@ -138,10 +138,14 @@ export type ObligationBorrowIncentive = {
 };
 
 export type TotalValueLocked = {
+  supplyLendingValue: number;
+  supplyCollateralValue: number;
   supplyValue: number;
   borrowValue: number;
   totalValue: number;
   supplyValueChangeRatio?: number;
+  supplyLendingValueChangeRatio?: number;
+  supplyCollateralValueChangeRatio?: number;
   borrowValueChangeRatio?: number;
   totalValueChangeRatio?: number;
 };

package/dist/test.d.ts

@@ -1 +0,0 @@
-export {};

package/src/test.ts

@@ -1,17 +0,0 @@
-import { ScallopQuery } from './models';
-
-const main = async () => {
-  try {
-    const query = new ScallopQuery({});
-    await query.init();
-
-    const res = await query.getSpool('ssui');
-    console.dir(res, { depth: null });
-  } catch (e) {
-    console.error(e);
-  } finally {
-    process.exit(0);
-  }
-};
-
-main();