@scallop-io/sui-scallop-sdk 0.44.27 → 0.45.0

package/src/models/scallopUtils.ts

@@ -37,6 +37,8 @@ import type {
   CoinWrappedType,
 } from '../types';
 import { PYTH_ENDPOINTS } from 'src/constants/pyth';
+import { ScallopCache } from './scallopCache';
+import { DEFAULT_CACHE_OPTIONS } from 'src/constants/cache';
 
 /**
  * @description
@@ -58,6 +60,7 @@ export class ScallopUtils {
   private _address: ScallopAddress;
   private _query: ScallopQuery;
   private _priceMap: PriceMap = new Map();
+  private _cache: ScallopCache;
 
   public constructor(
     params: ScallopUtilsParams,
@@ -65,17 +68,23 @@ export class ScallopUtils {
   ) {
     this.params = params;
     this._suiKit = instance?.suiKit ?? new SuiKit(params);
+    this._cache =
+      instance?.cache ?? new ScallopCache(DEFAULT_CACHE_OPTIONS, this._suiKit);
     this._address =
       instance?.address ??
-      new ScallopAddress({
-        id: params?.addressesId || ADDRESSES_ID,
-        network: params?.networkType,
-      });
+      new ScallopAddress(
+        {
+          id: params?.addressesId || ADDRESSES_ID,
+          network: params?.networkType,
+        },
+        this._cache
+      );
     this._query =
       instance?.query ??
       new ScallopQuery(params, {
         suiKit: this._suiKit,
         address: this._address,
+        cache: this._cache,
       });
     this.isTestnet = params.networkType
       ? params.networkType === 'testnet'
@@ -404,36 +413,56 @@ export class ScallopUtils {
       const endpoints =
         this.params.pythEndpoints ??
         PYTH_ENDPOINTS[this.isTestnet ? 'testnet' : 'mainnet'];
-      try {
-        for (const endpoint of endpoints) {
-          try {
-            const pythConnection = new SuiPriceServiceConnection(endpoint);
-            const priceIds = lackPricesCoinNames.map((coinName) =>
-              this._address.get(`core.coins.${coinName}.oracle.pyth.feed`)
+
+      const failedRequests: Set<SupportAssetCoins> = new Set(
+        lackPricesCoinNames
+      );
+
+      for (const endpoint of endpoints) {
+        let hasFailRequest = false;
+        const pythConnection = new SuiPriceServiceConnection(endpoint);
+
+        const priceIds = Array.from(failedRequests.values()).reduce(
+          (acc, coinName) => {
+            const priceId = this._address.get(
+              `core.coins.${coinName}.oracle.pyth.feed`
             );
-            const priceFeeds =
-              (await pythConnection.getLatestPriceFeeds(priceIds)) || [];
-            for (const [index, feed] of priceFeeds.entries()) {
-              const data = parseDataFromPythPriceFeed(feed, this._address);
-              const coinName = lackPricesCoinNames[index];
-              this._priceMap.set(coinName, {
+            acc[coinName] = priceId;
+            return acc;
+          },
+          {} as Record<SupportAssetCoins, string>
+        );
+
+        for (const [coinName, priceId] of Object.entries(priceIds)) {
+          try {
+            const feed = await this._cache.queryClient.fetchQuery({
+              queryKey: [priceId],
+              queryFn: async () => {
+                return await pythConnection.getLatestPriceFeeds([priceId]);
+              },
+              // staleTime: 15000,
+            });
+            if (feed) {
+              const data = parseDataFromPythPriceFeed(feed[0], this._address);
+              this._priceMap.set(coinName as SupportAssetCoins, {
                 price: data.price,
                 publishTime: data.publishTime,
               });
-              coinPrices[coinName] = data.price;
+              coinPrices[coinName as SupportAssetCoins] = data.price;
             }
-
-            break;
+            failedRequests.delete(coinName as SupportAssetCoins); // remove success price feed to prevent duplicate request on the next endpoint
           } catch (e) {
             console.warn(
-              `Failed to update price feeds with endpoint ${endpoint}: ${e}`
+              `Failed to get price ${coinName} feeds with endpoint ${endpoint}: ${e}`
             );
+            hasFailRequest = true;
           }
-
-          throw new Error('Failed to update price feeds with all endpoins');
         }
-      } catch (_e) {
-        for (const coinName of lackPricesCoinNames) {
+        if (!hasFailRequest) break;
+      }
+
+      if (failedRequests.size > 0) {
+        for (const coinName of failedRequests.values()) {
           const price = await this._query.getPriceFromPyth(coinName);
           this._priceMap.set(coinName, {
             price: price,

package/src/queries/borrowIncentiveQuery.ts

@@ -1,6 +1,6 @@
 import { normalizeStructTag } from '@mysten/sui.js/utils';
-import { SuiTxBlock as SuiKitTxBlock } from '@scallop-io/sui-kit';
 import {
+  IS_VE_SCA_TEST,
   SUPPORT_BORROW_INCENTIVE_POOLS,
   SUPPORT_BORROW_INCENTIVE_REWARDS,
 } from '../constants';
@@ -40,10 +40,9 @@ export const queryBorrowIncentivePools = async (
   const queryPkgId = query.address.get('borrowIncentive.query');
   const incentivePoolsId = query.address.get('borrowIncentive.incentivePools');
 
-  const txBlock = new SuiKitTxBlock();
   const queryTarget = `${queryPkgId}::incentive_pools_query::incentive_pools_data`;
-  txBlock.moveCall(queryTarget, [incentivePoolsId]);
-  const queryResult = await query.suiKit.inspectTxn(txBlock);
+  const args = [incentivePoolsId];
+  const queryResult = await query.cache.queryInspectTxn({ queryTarget, args });
   const borrowIncentivePoolsQueryData = queryResult.events[0]
     .parsedJson as BorrowIncentivePoolsQueryInterface;
 
@@ -169,10 +168,9 @@ export const queryBorrowIncentiveAccounts = async (
     'borrowIncentive.incentiveAccounts'
   );
   const queryTarget = `${queryPkgId}::incentive_account_query::incentive_account_data`;
+  const args = [incentiveAccountsId, obligationId];
 
-  const txBlock = new SuiKitTxBlock();
-  txBlock.moveCall(queryTarget, [incentiveAccountsId, obligationId]);
-  const queryResult = await query.suiKit.inspectTxn(txBlock);
+  const queryResult = await query.cache.queryInspectTxn({ queryTarget, args });
   const borrowIncentiveAccountsQueryData = queryResult.events[0]
     .parsedJson as BorrowIncentiveAccountsQueryInterface;
 
@@ -197,3 +195,97 @@ export const queryBorrowIncentiveAccounts = async (
 
   return borrowIncentiveAccounts;
 };
+
+/**
+ * Check veSca bind status
+ * @param query
+ * @param veScaKey
+ * @returns
+ */
+export const getBindedObligationId = async (
+  query: ScallopQuery,
+  veScaKeyId: string
+): Promise<string | null> => {
+  const borrowIncentiveObjectId = query.address.get('borrowIncentive.object');
+  const incentivePoolsId = query.address.get('borrowIncentive.incentivePools');
+  const veScaPkgId = IS_VE_SCA_TEST
+    ? '0xb220d034bdf335d77ae5bfbf6daf059c2cc7a1f719b12bfed75d1736fac038c8'
+    : query.address.get('vesca.id');
+
+  const client = query.suiKit.client();
+
+  // get incentive pools
+  const incentivePoolsResponse = await client.getObject({
+    id: incentivePoolsId,
+    options: {
+      showContent: true,
+    },
+  });
+
+  if (incentivePoolsResponse.data?.content?.dataType !== 'moveObject')
+    return null;
+  const incentivePoolFields = incentivePoolsResponse.data.content.fields as any;
+  const veScaBindTableId = incentivePoolFields.ve_sca_bind.fields.id
+    .id as string;
+
+  // check if veSca is inside the bind table
+  const keyType = `${borrowIncentiveObjectId}::typed_id::TypedID<${veScaPkgId}::ve_sca::VeScaKey>`;
+  const veScaBindTableResponse = await client.getDynamicFieldObject({
+    parentId: veScaBindTableId,
+    name: {
+      type: keyType,
+      value: veScaKeyId,
+    },
+  });
+
+  if (veScaBindTableResponse.data?.content?.dataType !== 'moveObject')
+    return null;
+  const veScaBindTableFields = veScaBindTableResponse.data.content
+    .fields as any;
+  // get obligationId pair
+  const obligationId = veScaBindTableFields.value.fields.id as string;
+
+  return obligationId;
+};
+
+export const getBindedVeScaKey = async (
+  query: ScallopQuery,
+  obliationId: string
+): Promise<string | null> => {
+  const borrowIncentiveObjectId = query.address.get('borrowIncentive.object');
+  const incentiveAccountsId = query.address.get(
+    'borrowIncentive.incentiveAccounts'
+  );
+  const corePkg = query.address.get('core.object');
+  const client = query.suiKit.client();
+
+  // get IncentiveAccounts object
+  const incentiveAccountsObject = await client.getObject({
+    id: incentiveAccountsId,
+    options: {
+      showContent: true,
+    },
+  });
+  if (incentiveAccountsObject.data?.content?.dataType !== 'moveObject')
+    return null;
+  const incentiveAccountsTableId = (
+    incentiveAccountsObject.data.content.fields as any
+  ).accounts.fields.id.id;
+
+  // Search in the table
+  const bindedIncentiveAcc = await client.getDynamicFieldObject({
+    parentId: incentiveAccountsTableId,
+    name: {
+      type: `${borrowIncentiveObjectId}::typed_id::TypedID<${corePkg}::obligation::Obligation>`,
+      value: obliationId,
+    },
+  });
+
+  if (bindedIncentiveAcc.data?.content?.dataType !== 'moveObject') return null;
+  const bindedIncentiveAccFields = bindedIncentiveAcc.data.content
+    .fields as any;
+
+  return (
+    bindedIncentiveAccFields.value.fields.binded_ve_sca_key?.fields.id ?? null
+  );
+};

package/src/queries/coreQuery.ts

@@ -1,5 +1,4 @@
 import { normalizeStructTag } from '@mysten/sui.js/utils';
-import { SuiTxBlock as SuiKitTxBlock } from '@scallop-io/sui-kit';
 import BigNumber from 'bignumber.js';
 import {
   SUPPORT_POOLS,
@@ -54,10 +53,15 @@ export const queryMarket = async (
 ) => {
   const packageId = query.address.get('core.packages.query.id');
   const marketId = query.address.get('core.market');
-  const txBlock = new SuiKitTxBlock();
   const queryTarget = `${packageId}::market_query::market_data`;
-  txBlock.moveCall(queryTarget, [marketId]);
-  const queryResult = await query.suiKit.inspectTxn(txBlock);
+  const args = [marketId];
+
+  // const txBlock = new SuiKitTxBlock();
+  // txBlock.moveCall(queryTarget, args);
+  const queryResult = await query.cache.queryInspectTxn(
+    { queryTarget, args }
+    // txBlock
+  );
   const marketData = queryResult.events[0].parsedJson as MarketQueryInterface;
   const coinPrices = await query.utils.getCoinPrices();
 
@@ -211,11 +215,8 @@ export const getMarketPools = async (
 ) => {
   poolCoinNames = poolCoinNames || [...SUPPORT_POOLS];
   const marketId = query.address.get('core.market');
-  const marketObjectResponse = await query.suiKit.client().getObject({
-    id: marketId,
-    options: {
-      showContent: true,
-    },
+  const marketObjectResponse = await query.cache.queryGetObject(marketId, {
+    showContent: true,
   });
   const coinPrices = await query.utils.getCoinPrices(poolCoinNames ?? []);
 
@@ -274,11 +275,8 @@ export const getMarketPool = async (
   marketObject =
     marketObject ||
     (
-      await query.suiKit.client().getObject({
-        id: marketId,
-        options: {
-          showContent: true,
-        },
+      await query.cache.queryGetObject(marketId, {
+        showContent: true,
       })
     ).data;
 
@@ -310,9 +308,8 @@ export const getMarketPool = async (
       // Get balance sheet.
       const balanceSheetParentId =
         fields.vault.fields.balance_sheets.fields.table.fields.id.id;
-      const balanceSheetDynamicFieldObjectResponse = await query.suiKit
-        .client()
-        .getDynamicFieldObject({
+      const balanceSheetDynamicFieldObjectResponse =
+        await query.cache.queryGetDynamicFieldObject({
           parentId: balanceSheetParentId,
           name: {
             type: '0x1::type_name::TypeName',
@@ -336,9 +333,8 @@ export const getMarketPool = async (
       // Get borrow index.
       const borrowIndexParentId =
         fields.borrow_dynamics.fields.table.fields.id.id;
-      const borrowIndexDynamicFieldObjectResponse = await query.suiKit
-        .client()
-        .getDynamicFieldObject({
+      const borrowIndexDynamicFieldObjectResponse =
+        await query.cache.queryGetDynamicFieldObject({
           parentId: borrowIndexParentId,
           name: {
             type: '0x1::type_name::TypeName',
@@ -362,9 +358,8 @@ export const getMarketPool = async (
       // Get interest models.
       const interestModelParentId =
         fields.interest_models.fields.table.fields.id.id;
-      const interestModelDynamicFieldObjectResponse = await query.suiKit
-        .client()
-        .getDynamicFieldObject({
+      const interestModelDynamicFieldObjectResponse =
+        await query.cache.queryGetDynamicFieldObject({
           parentId: interestModelParentId,
           name: {
             type: '0x1::type_name::TypeName',
@@ -386,9 +381,8 @@ export const getMarketPool = async (
       }
 
       // Get borrow fee.
-      const borrowFeeDynamicFieldObjectResponse = await query.suiKit
-        .client()
-        .getDynamicFieldObject({
+      const borrowFeeDynamicFieldObjectResponse =
+        await query.cache.queryGetDynamicFieldObject({
           parentId: marketId,
           name: {
             type: `${BORROW_FEE_PROTOCOL_ID}::market_dynamic_keys::BorrowFeeKey`,
@@ -482,11 +476,8 @@ export const getMarketCollaterals = async (
 ) => {
   collateralCoinNames = collateralCoinNames || [...SUPPORT_COLLATERALS];
   const marketId = query.address.get('core.market');
-  const marketObjectResponse = await query.suiKit.client().getObject({
-    id: marketId,
-    options: {
-      showContent: true,
-    },
+  const marketObjectResponse = await query.cache.queryGetObject(marketId, {
+    showContent: true,
   });
   const coinPrices = await query.utils.getCoinPrices(collateralCoinNames ?? []);
 
@@ -544,11 +535,8 @@ export const getMarketCollateral = async (
   marketObject =
     marketObject ||
     (
-      await query.suiKit.client().getObject({
-        id: marketId,
-        options: {
-          showContent: true,
-        },
+      await query.cache.queryGetObject(marketId, {
+        showContent: true,
       })
     ).data;
 
@@ -581,9 +569,8 @@ export const getMarketCollateral = async (
 
       // Get risk model.
       const riskModelParentId = fields.risk_models.fields.table.fields.id.id;
-      const riskModelDynamicFieldObjectResponse = await query.suiKit
-        .client()
-        .getDynamicFieldObject({
+      const riskModelDynamicFieldObjectResponse =
+        await query.cache.queryGetDynamicFieldObject({
           parentId: riskModelParentId,
           name: {
             type: '0x1::type_name::TypeName',
@@ -606,9 +593,8 @@ export const getMarketCollateral = async (
       // Get collateral stat.
       const collateralStatParentId =
         fields.collateral_stats.fields.table.fields.id.id;
-      const collateralStatDynamicFieldObjectResponse = await query.suiKit
-        .client()
-        .getDynamicFieldObject({
+      const collateralStatDynamicFieldObjectResponse =
+        await query.cache.queryGetDynamicFieldObject({
           parentId: collateralStatParentId,
           name: {
             type: '0x1::type_name::TypeName',
@@ -687,15 +673,14 @@ export const getObligations = async (
   let hasNextPage = false;
   let nextCursor: string | null | undefined = null;
   do {
-    const paginatedKeyObjectsResponse = await query.suiKit
-      .client()
-      .getOwnedObjects({
-        owner,
-        filter: {
-          StructType: `${protocolObjectId}::obligation::ObligationKey`,
-        },
-        cursor: nextCursor,
-      });
+    const paginatedKeyObjectsResponse = await query.cache.queryGetOwnedObjects({
+      owner,
+      filter: {
+        StructType: `${protocolObjectId}::obligation::ObligationKey`,
+      },
+      cursor: nextCursor,
+    });
+
     keyObjectsResponse.push(...paginatedKeyObjectsResponse.data);
     if (
       paginatedKeyObjectsResponse.hasNextPage &&
@@ -711,7 +696,8 @@ export const getObligations = async (
   const keyObjectIds: string[] = keyObjectsResponse
     .map((ref: any) => ref?.data?.objectId)
     .filter((id: any) => id !== undefined);
-  const keyObjects = await query.suiKit.getObjects(keyObjectIds);
+  const keyObjects = await query.cache.queryGetObjects(keyObjectIds);
+
   const obligations: Obligation[] = [];
   for (const keyObject of keyObjects) {
     const keyId = keyObject.objectId;
@@ -736,12 +722,10 @@ export const getObligationLocked = async (
   query: ScallopQuery,
   obligationId: string
 ) => {
-  const obligationObjectResponse = await query.suiKit.client().getObject({
-    id: obligationId,
-    options: {
-      showContent: true,
-    },
-  });
+  const obligationObjectResponse = await query.cache.queryGetObject(
+    obligationId,
+    { showContent: true }
+  );
   let obligationLocked = false;
   if (
     obligationObjectResponse.data &&
@@ -772,9 +756,14 @@ export const queryObligation = async (
 ) => {
   const packageId = query.address.get('core.packages.query.id');
   const queryTarget = `${packageId}::obligation_query::obligation_data`;
-  const txBlock = new SuiKitTxBlock();
-  txBlock.moveCall(queryTarget, [obligationId]);
-  const queryResult = await query.suiKit.inspectTxn(txBlock);
+  const args = [obligationId];
+
+  // const txBlock = new SuiKitTxBlock();
+  // txBlock.moveCall(queryTarget, args);
+  const queryResult = await query.cache.queryInspectTxn(
+    { queryTarget, args }
+    // txBlock
+  );
   return queryResult.events[0].parsedJson as ObligationQueryInterface;
 };
 
@@ -797,9 +786,8 @@ export const getCoinAmounts = async (
   let hasNextPage = false;
   let nextCursor: string | null | undefined = null;
   do {
-    const paginatedCoinObjectsResponse = await query.suiKit
-      .client()
-      .getOwnedObjects({
+    const paginatedCoinObjectsResponse = await query.cache.queryGetOwnedObjects(
+      {
         owner,
         filter: {
           MatchAny: assetCoinNames.map((assetCoinName) => {
@@ -812,7 +800,8 @@ export const getCoinAmounts = async (
           showContent: true,
         },
         cursor: nextCursor,
-      });
+      }
+    );
 
     coinObjectsResponse.push(...paginatedCoinObjectsResponse.data);
     if (
@@ -869,16 +858,16 @@ export const getCoinAmount = async (
   let hasNextPage = false;
   let nextCursor: string | null | undefined = null;
   do {
-    const paginatedCoinObjectsResponse = await query.suiKit
-      .client()
-      .getOwnedObjects({
+    const paginatedCoinObjectsResponse = await query.cache.queryGetOwnedObjects(
+      {
         owner,
         filter: { StructType: `0x2::coin::Coin<${coinType}>` },
         options: {
           showContent: true,
         },
         cursor: nextCursor,
-      });
+      }
+    );
 
     coinObjectsResponse.push(...paginatedCoinObjectsResponse.data);
     if (
@@ -932,9 +921,8 @@ export const getMarketCoinAmounts = async (
   let hasNextPage = false;
   let nextCursor: string | null | undefined = null;
   do {
-    const paginatedMarketCoinObjectsResponse = await query.suiKit
-      .client()
-      .getOwnedObjects({
+    const paginatedMarketCoinObjectsResponse =
+      await query.cache.queryGetOwnedObjects({
         owner,
         filter: {
           MatchAny: marketCoinNames.map((marketCoinName) => {
@@ -1007,9 +995,8 @@ export const getMarketCoinAmount = async (
   let hasNextPage = false;
   let nextCursor: string | null | undefined = null;
   do {
-    const paginatedMarketCoinObjectsResponse = await query.suiKit
-      .client()
-      .getOwnedObjects({
+    const paginatedMarketCoinObjectsResponse =
+      await query.cache.queryGetOwnedObjects({
         owner,
         filter: { StructType: `0x2::coin::Coin<${marketCoinType}>` },
         options: {

package/src/queries/priceQuery.ts

@@ -15,12 +15,10 @@ export const getPythPrice = async (
   const pythFeedObjectId = query.address.get(
     `core.coins.${assetCoinName}.oracle.pyth.feedObject`
   );
-  const priceFeedObjectResponse = await query.suiKit.client().getObject({
-    id: pythFeedObjectId,
-    options: {
-      showContent: true,
-    },
-  });
+  const priceFeedObjectResponse = await query.cache.queryGetObject(
+    pythFeedObjectId,
+    { showContent: true }
+  );
 
   if (priceFeedObjectResponse.data) {
     const priceFeedPoolObject = priceFeedObjectResponse.data;

package/src/queries/spoolQuery.ts

@@ -245,9 +245,8 @@ export const getStakeAccounts = async (
   let hasNextPage = false;
   let nextCursor: string | null | undefined = null;
   do {
-    const paginatedStakeObjectsResponse = await query.suiKit
-      .client()
-      .getOwnedObjects({
+    const paginatedStakeObjectsResponse =
+      await query.cache.queryGetOwnedObjects({
         owner,
         filter: { StructType: stakeAccountType },
         options: {
@@ -298,7 +297,7 @@ export const getStakeAccounts = async (
   const stakeObjectIds: string[] = stakeObjectsResponse
     .map((ref: any) => ref?.data?.objectId)
     .filter((id: any) => id !== undefined);
-  const stakeObjects = await query.suiKit.getObjects(stakeObjectIds);
+  const stakeObjects = await query.cache.queryGetObjects(stakeObjectIds);
   for (const stakeObject of stakeObjects) {
     const id = stakeObject.objectId;
     const type = stakeObject.type!;
@@ -421,12 +420,9 @@ export const getStakePool = async (
 ) => {
   const poolId = query.address.get(`spool.pools.${marketCoinName}.id`);
   let stakePool: StakePool | undefined = undefined;
-  const stakePoolObjectResponse = await query.suiKit.client().getObject({
-    id: poolId,
-    options: {
-      showContent: true,
-      showType: true,
-    },
+  const stakePoolObjectResponse = await query.cache.queryGetObject(poolId, {
+    showContent: true,
+    showType: true,
   });
   if (stakePoolObjectResponse.data) {
     const stakePoolObject = stakePoolObjectResponse.data;
@@ -482,13 +478,14 @@ export const getStakeRewardPool = async (
     `spool.pools.${marketCoinName}.rewardPoolId`
   );
   let stakeRewardPool: StakeRewardPool | undefined = undefined;
-  const stakeRewardPoolObjectResponse = await query.suiKit.client().getObject({
-    id: poolId,
-    options: {
+  const stakeRewardPoolObjectResponse = await query.cache.queryGetObject(
+    poolId,
+    {
       showContent: true,
       showType: true,
-    },
-  });
+    }
+  );
+
   if (stakeRewardPoolObjectResponse.data) {
     const stakeRewardPoolObject = stakeRewardPoolObjectResponse.data;
     const id = stakeRewardPoolObject.objectId;

package/src/queries/vescaQuery.ts

@@ -2,7 +2,7 @@ import BigNumber from 'bignumber.js';
 import { Vesca } from '../types';
 import type { SuiObjectResponse, SuiObjectData } from '@mysten/sui.js/client';
 import type { ScallopQuery } from '../models';
-import { IS_VE_SCA_TEST } from 'src/constants';
+import { IS_VE_SCA_TEST, MAX_LOCK_DURATION } from 'src/constants';
 /**
  * Query all owned veSca key.
  *
@@ -91,9 +91,8 @@ export const getVeSca = async (
 
   let vesca: Vesca | undefined = undefined;
 
-  const veScaDynamicFieldObjectResponse = await query.suiKit
-    .client()
-    .getDynamicFieldObject({
+  const veScaDynamicFieldObjectResponse =
+    await query.cache.queryGetDynamicFieldObject({
       parentId: tableId,
       name: {
         type: '0x2::object::ID',
@@ -109,13 +108,26 @@ export const getVeSca = async (
   ) {
     const dynamicFields = (veScaDynamicFieldObject.content.fields as any).value
       .fields;
+
+    const remainingLockPeriodInMilliseconds = Math.max(
+      +dynamicFields.unlock_at * 1000 - Date.now(),
+      0
+    );
+    const lockedScaAmount = String(dynamicFields.locked_sca_amount);
+    const lockedScaCoin = BigNumber(dynamicFields.locked_sca_amount)
+      .shiftedBy(-9)
+      .toNumber();
+    const currentVeScaBalance =
+      lockedScaCoin *
+      (Math.floor(remainingLockPeriodInMilliseconds / 1000) /
+        MAX_LOCK_DURATION);
+
     vesca = {
       id: veScaDynamicFieldObject.objectId,
       keyId: veScaKeyId,
-      lockedScaAmount: BigNumber(dynamicFields.locked_sca_amount).toNumber(),
-      lockedScaCoin: BigNumber(dynamicFields.locked_sca_amount)
-        .shiftedBy(-9)
-        .toNumber(),
+      lockedScaAmount,
+      lockedScaCoin,
+      currentVeScaBalance,
       unlockAt: BigNumber(dynamicFields.unlock_at).toNumber(),
     } as Vesca;
   }

package/src/types/model.ts

@@ -7,6 +7,7 @@ import type {
   ScallopUtils,
   ScallopBuilder,
 } from '../models';
+import { ScallopCache } from 'src/models/scallopCache';
 
 export type ScallopClientFnReturnType<T extends boolean> = T extends true
   ? SuiTransactionBlockResponse
@@ -18,6 +19,7 @@ export type ScallopInstanceParams = {
   query?: ScallopQuery;
   utils?: ScallopUtils;
   builder?: ScallopBuilder;
+  cache: ScallopCache;
 };
 
 export type ScallopAddressParams = {