@scallop-io/sui-scallop-sdk 0.46.55 → 0.46.56

package/src/queries/coreQuery.ts

@@ -15,7 +15,7 @@ import {
 } from '../utils';
 import type { SuiObjectResponse, SuiObjectData } from '@mysten/sui.js/client';
 import type { SuiAddressArg } from '@scallop-io/sui-kit';
-import type { ScallopQuery } from '../models';
+import type { ScallopAddress, ScallopCache, ScallopQuery } from '../models';
 import {
   Market,
   MarketPools,
@@ -129,6 +129,9 @@ export const queryMarket = async (
       symbol: query.utils.parseSymbol(poolCoinName),
       coinType: coinType,
       marketCoinType: query.utils.parseMarketCoinType(poolCoinName),
+      sCoinType: query.utils.parseSCoinType(
+        query.utils.parseMarketCoinName(poolCoinName)
+      ),
       coinWrappedType: query.utils.getCoinWrappedType(poolCoinName),
       coinDecimal: query.utils.getCoinDecimal(poolCoinName),
       coinPrice: coinPrice,
@@ -453,6 +456,9 @@ export const getMarketPool = async (
       symbol: query.utils.parseSymbol(poolCoinName),
       coinType: query.utils.parseCoinType(poolCoinName),
       marketCoinType: query.utils.parseMarketCoinType(poolCoinName),
+      sCoinType: query.utils.parseSCoinType(
+        query.utils.parseMarketCoinName(poolCoinName)
+      ),
       coinWrappedType: query.utils.getCoinWrappedType(poolCoinName),
       coinDecimal: query.utils.getCoinDecimal(poolCoinName),
       coinPrice: coinPrice ?? 0,
@@ -683,24 +689,29 @@ export const getMarketCollateral = async (
  * @return Owned obligations.
  */
 export const getObligations = async (
-  query: ScallopQuery,
-  ownerAddress?: string
+  {
+    address,
+  }: {
+    address: ScallopAddress;
+  },
+  ownerAddress: string
 ) => {
-  const owner = ownerAddress || query.suiKit.currentAddress();
-  const protocolObjectId =
-    query.address.get('core.object') || PROTOCOL_OBJECT_ID;
+  const owner = ownerAddress;
+  const protocolObjectId = address.get('core.object') || PROTOCOL_OBJECT_ID;
   const keyObjectsResponse: SuiObjectResponse[] = [];
   let hasNextPage = false;
   let nextCursor: string | null | undefined = null;
   do {
-    const paginatedKeyObjectsResponse = await query.cache.queryGetOwnedObjects({
-      owner,
-      filter: {
-        StructType: `${protocolObjectId}::obligation::ObligationKey`,
-      },
-      cursor: nextCursor,
-    });
-    if (!paginatedKeyObjectsResponse) continue;
+    const paginatedKeyObjectsResponse =
+      await address.cache.queryGetOwnedObjects({
+        owner,
+        filter: {
+          StructType: `${protocolObjectId}::obligation::ObligationKey`,
+        },
+        cursor: nextCursor,
+      });
+
+    if (!paginatedKeyObjectsResponse) break;
 
     keyObjectsResponse.push(...paginatedKeyObjectsResponse.data);
     if (
@@ -717,7 +728,7 @@ export const getObligations = async (
   const keyObjectIds: string[] = keyObjectsResponse
     .map((ref: any) => ref?.data?.objectId)
     .filter((id: any) => id !== undefined);
-  const keyObjects = await query.cache.queryGetObjects(keyObjectIds);
+  const keyObjects = await address.cache.queryGetObjects(keyObjectIds);
 
   const obligations: Obligation[] = [];
   await Promise.allSettled(
@@ -726,7 +737,7 @@ export const getObligations = async (
       if (keyObject.content && 'fields' in keyObject.content) {
         const fields = keyObject.content.fields as any;
         const obligationId = String(fields.ownership.fields.of);
-        const locked = await getObligationLocked(query, obligationId);
+        const locked = await getObligationLocked(address.cache, obligationId);
         obligations.push({ id: obligationId, keyId, locked });
       }
     })
@@ -743,13 +754,12 @@ export const getObligations = async (
  * @return Obligation locked status.
  */
 export const getObligationLocked = async (
-  query: ScallopQuery,
+  cache: ScallopCache,
   obligationId: string
 ) => {
-  const obligationObjectResponse = await query.cache.queryGetObject(
-    obligationId,
-    { showContent: true }
-  );
+  const obligationObjectResponse = await cache.queryGetObject(obligationId, {
+    showContent: true,
+  });
   let obligationLocked = false;
   if (
     obligationObjectResponse?.data &&
@@ -775,16 +785,20 @@ export const getObligationLocked = async (
  * @return Obligation data.
  */
 export const queryObligation = async (
-  query: ScallopQuery,
+  {
+    address,
+  }: {
+    address: ScallopAddress;
+  },
   obligationId: SuiAddressArg
 ) => {
-  const packageId = query.address.get('core.packages.query.id');
+  const packageId = address.get('core.packages.query.id');
   const queryTarget = `${packageId}::obligation_query::obligation_data`;
   const args = [obligationId];
 
   // const txBlock = new SuiKitTxBlock();
   // txBlock.moveCall(queryTarget, args);
-  const queryResult = await query.cache.queryInspectTxn(
+  const queryResult = await address.cache.queryInspectTxn(
     { queryTarget, args }
     // txBlock
   );

package/src/queries/portfolioQuery.ts

@@ -38,11 +38,10 @@ import type {
  */
 export const getLendings = async (
   query: ScallopQuery,
-  poolCoinNames?: SupportPoolCoins[],
+  poolCoinNames: SupportPoolCoins[] = [...SUPPORT_POOLS],
   ownerAddress?: string,
   indexer: boolean = false
 ) => {
-  poolCoinNames = poolCoinNames || [...SUPPORT_POOLS];
   const marketCoinNames = poolCoinNames.map((poolCoinName) =>
     query.utils.parseMarketCoinName(poolCoinName)
   );

package/src/queries/priceQuery.ts

@@ -1,5 +1,5 @@
 import { SuiObjectData } from '@mysten/sui.js/client';
-import type { ScallopQuery } from '../models';
+import type { ScallopAddress } from '../models';
 import type { SupportAssetCoins } from '../types';
 
 /**
@@ -10,17 +10,24 @@ import type { SupportAssetCoins } from '../types';
  * @return Asset coin price.
  */
 export const getPythPrice = async (
-  query: ScallopQuery,
+  {
+    address,
+  }: {
+    address: ScallopAddress;
+  },
   assetCoinName: SupportAssetCoins,
   priceFeedObject?: SuiObjectData | null
 ) => {
-  const pythFeedObjectId = query.address.get(
+  const pythFeedObjectId = address.get(
     `core.coins.${assetCoinName}.oracle.pyth.feedObject`
   );
   priceFeedObject =
     priceFeedObject ||
-    (await query.cache.queryGetObject(pythFeedObjectId, { showContent: true }))
-      ?.data;
+    (
+      await address.cache.queryGetObject(pythFeedObjectId, {
+        showContent: true,
+      })
+    )?.data;
 
   if (priceFeedObject) {
     const priceFeedPoolObject = priceFeedObject;
@@ -58,12 +65,16 @@ export const getPythPrice = async (
 };
 
 export const getPythPrices = async (
-  query: ScallopQuery,
+  {
+    address,
+  }: {
+    address: ScallopAddress;
+  },
   assetCoinNames: SupportAssetCoins[]
 ) => {
   const pythPriceFeedIds = assetCoinNames.reduce(
     (prev, assetCoinName) => {
-      const pythPriceFeed = query.address.get(
+      const pythPriceFeed = address.get(
         `core.coins.${assetCoinName}.oracle.pyth.feedObject`
       );
       if (!prev[pythPriceFeed]) {
@@ -77,7 +88,7 @@ export const getPythPrices = async (
   );
 
   // Fetch multiple objects at once to save rpc calls
-  const priceFeedObjects = await query.cache.queryGetObjects(
+  const priceFeedObjects = await address.cache.queryGetObjects(
     Object.keys(pythPriceFeedIds),
     { showContent: true }
   );
@@ -98,7 +109,7 @@ export const getPythPrices = async (
         async ([assetCoinName, priceFeedObject]) => ({
           coinName: assetCoinName,
           price: await getPythPrice(
-            query,
+            { address },
             assetCoinName as SupportAssetCoins,
             priceFeedObject
           ),

package/src/queries/referralQuery.ts

@@ -1,4 +1,4 @@
-import { ScallopQuery } from 'src/models';
+import { ScallopAddress } from 'src/models';
 
 /**
  * Query the veScaKeyId from the referral bindings table using the borrower address
@@ -6,12 +6,12 @@ import { ScallopQuery } from 'src/models';
  * @returns
  */
 export const queryVeScaKeyIdFromReferralBindings = async (
-  query: ScallopQuery,
+  address: ScallopAddress,
   refereeAddress: string
 ): Promise<string | null> => {
-  const referralBindingTableId = query.address.get('referral.bindingTableId');
+  const referralBindingTableId = address.get('referral.bindingTableId');
 
-  const referralBindResponse = await query.cache.queryGetDynamicFieldObject({
+  const referralBindResponse = await address.cache.queryGetDynamicFieldObject({
     parentId: referralBindingTableId,
     name: {
       type: 'address',

package/src/queries/sCoinQuery.ts

@@ -2,7 +2,7 @@ import { bcs } from '@mysten/sui.js/bcs';
 import assert from 'assert';
 import BigNumber from 'bignumber.js';
 import { SUPPORT_SCOIN } from 'src/constants';
-import { ScallopQuery } from 'src/models';
+import { ScallopQuery, ScallopUtils } from 'src/models';
 import { OptionalKeys, SupportSCoin, sCoinBalance } from 'src/types';
 
 /**
@@ -12,18 +12,22 @@ import { OptionalKeys, SupportSCoin, sCoinBalance } from 'src/types';
  * @returns `number`
  */
 export const getSCoinTotalSupply = async (
-  query: ScallopQuery,
+  {
+    utils,
+  }: {
+    utils: ScallopUtils;
+  },
   sCoinName: SupportSCoin
 ): Promise<sCoinBalance> => {
-  const sCoinPkgId = query.address.get('scoin.id');
+  const sCoinPkgId = utils.address.get('scoin.id');
   // get treasury
-  const args = [query.utils.getSCoinTreasury(sCoinName)];
+  const args = [utils.getSCoinTreasury(sCoinName)];
   const typeArgs = [
-    query.utils.parseSCoinType(sCoinName),
-    query.utils.parseUnderlyingSCoinType(sCoinName),
+    utils.parseSCoinType(sCoinName),
+    utils.parseUnderlyingSCoinType(sCoinName),
   ];
   const queryTarget = `${sCoinPkgId}::s_coin_converter::total_supply`;
-  const queryResults = await query.cache.queryInspectTxn({
+  const queryResults = await utils.cache.queryInspectTxn({
     queryTarget,
     args,
     typeArgs,
@@ -35,9 +39,7 @@ export const getSCoinTotalSupply = async (
     assert(type === 'u64', 'Result type is not u64');
 
     return BigNumber(bcs.de(type, value))
-      .shiftedBy(
-        query.utils.getCoinDecimal(query.utils.parseCoinName(sCoinName))
-      )
+      .shiftedBy(utils.getCoinDecimal(utils.parseCoinName(sCoinName)))
       .toNumber();
   }
 
@@ -53,17 +55,21 @@ export const getSCoinTotalSupply = async (
  * @return All owned sCoins amount.
  */
 export const getSCoinAmounts = async (
-  query: ScallopQuery,
+  {
+    utils,
+  }: {
+    utils: ScallopUtils;
+  },
   sCoinNames?: SupportSCoin[],
   ownerAddress?: string
 ) => {
   sCoinNames = sCoinNames || [...SUPPORT_SCOIN];
-  const owner = ownerAddress || query.suiKit.currentAddress();
+  const owner = ownerAddress || utils.suiKit.currentAddress();
   const sCoins = {} as OptionalKeys<Record<SupportSCoin, number>>;
 
   await Promise.allSettled(
     sCoinNames.map(async (sCoinName) => {
-      const sCoin = await getSCoinAmount(query, sCoinName, owner);
+      const sCoin = await getSCoinAmount({ utils }, sCoinName, owner);
       sCoins[sCoinName] = sCoin;
     })
   );
@@ -80,15 +86,87 @@ export const getSCoinAmounts = async (
  * @return Owned sCoin amount.
  */
 export const getSCoinAmount = async (
-  query: ScallopQuery,
+  {
+    utils,
+  }: {
+    utils: ScallopUtils;
+  },
   sCoinName: SupportSCoin,
   ownerAddress?: string
 ) => {
-  const owner = ownerAddress || query.suiKit.currentAddress();
-  const sCoinType = query.utils.parseSCoinType(sCoinName);
-  const amount = await query.cache.queryGetCoinBalance({
+  const owner = ownerAddress || utils.suiKit.currentAddress();
+  const sCoinType = utils.parseSCoinType(sCoinName);
+  const amount = await utils.cache.queryGetCoinBalance({
     owner,
     coinType: sCoinType,
   });
   return BigNumber(amount).toNumber();
 };
+
+const isSupportStakeCoins = (value: string): value is SupportSCoin => {
+  return SUPPORT_SCOIN.includes(value as SupportSCoin);
+};
+
+const checkAssetParams = (fromSCoin: SupportSCoin, toSCoin: SupportSCoin) => {
+  if (fromSCoin === toSCoin)
+    throw new Error('fromAsset and toAsset must be different');
+
+  if (!isSupportStakeCoins(fromSCoin))
+    throw new Error('fromAsset is not supported');
+
+  if (!isSupportStakeCoins(toSCoin)) {
+    throw new Error('toAsset is not supported');
+  }
+};
+
+/* ==================== Get Swap Rate ==================== */
+
+/**
+ * Get swap rate from sCoin A to sCoin B.
+ * @param fromSCoin
+ * @param toSCoin
+ * @param underlyingCoinPrice - The price of the underlying coin. For example, if fromSCoin is sSUI and toSCoin is sUSDC, then underlyingCoinPrice represents the price of 1 SUI in USDC.
+ * @returns number
+ */
+export const getSCoinSwapRate = async (
+  query: ScallopQuery,
+  fromSCoin: SupportSCoin,
+  toSCoin: SupportSCoin,
+  underlyingCoinPrice?: number
+) => {
+  checkAssetParams(fromSCoin, toSCoin);
+  const fromCoinName = query.utils.parseCoinName(fromSCoin);
+  const toCoinName = query.utils.parseCoinName(toSCoin);
+
+  // Get lending data for both sCoin A and sCoin B
+  const marketPools = await Promise.all([
+    query.getMarketPool(fromCoinName, false),
+    query.getMarketPool(toCoinName, false),
+  ]);
+  if (marketPools.some((pool) => !pool))
+    throw new Error('Failed to fetch the lendings data');
+
+  if (marketPools.some((pool) => pool?.conversionRate === 0)) {
+    throw new Error('Conversion rate cannot be zero');
+  }
+
+  const ScoinAToARate = marketPools[0]!.conversionRate;
+  const BtoSCoinBRate = 1 / marketPools[1]!.conversionRate;
+
+  const calcAtoBRate = async () => {
+    const prices = await query.utils.getCoinPrices([fromCoinName, toCoinName]);
+    if (!prices[fromCoinName] || !prices[toCoinName]) {
+      throw new Error('Failed to fetch the coin prices');
+    }
+    if (prices[toCoinName] === 0) {
+      throw new Error('Price of toCoin cannot be zero');
+    }
+    return prices[fromCoinName]! / prices[toCoinName]!;
+  };
+
+  const AtoBRate = underlyingCoinPrice ?? (await calcAtoBRate());
+  return BigNumber(ScoinAToARate)
+    .multipliedBy(AtoBRate)
+    .multipliedBy(BtoSCoinBRate)
+    .toNumber();
+};

package/src/queries/spoolQuery.ts

@@ -8,7 +8,7 @@ import {
   isMarketCoin,
 } from '../utils';
 import type { SuiObjectResponse } from '@mysten/sui.js/client';
-import type { ScallopQuery } from '../models';
+import type { ScallopQuery, ScallopUtils } from '../models';
 import type {
   MarketPool,
   Spools,
@@ -231,18 +231,22 @@ export const getSpool = async (
  * @return Stake accounts.
  */
 export const getStakeAccounts = async (
-  query: ScallopQuery,
+  {
+    utils,
+  }: {
+    utils: ScallopUtils;
+  },
   ownerAddress?: string
 ) => {
-  const owner = ownerAddress || query.suiKit.currentAddress();
-  const spoolObjectId = query.address.get('spool.object');
+  const owner = ownerAddress || utils.suiKit.currentAddress();
+  const spoolObjectId = utils.address.get('spool.object');
   const stakeAccountType = `${spoolObjectId}::spool_account::SpoolAccount`;
   const stakeObjectsResponse: SuiObjectResponse[] = [];
   let hasNextPage = false;
   let nextCursor: string | null | undefined = null;
   do {
     const paginatedStakeObjectsResponse =
-      await query.cache.queryGetOwnedObjects({
+      await utils.cache.queryGetOwnedObjects({
         owner,
         filter: { StructType: stakeAccountType },
         options: {
@@ -281,8 +285,8 @@ export const getStakeAccounts = async (
     Object.keys(stakeAccounts).reduce(
       (types, stakeMarketCoinName) => {
         const stakeCoinName =
-          query.utils.parseCoinName<SupportStakeCoins>(stakeMarketCoinName);
-        const marketCoinType = query.utils.parseMarketCoinType(stakeCoinName);
+          utils.parseCoinName<SupportStakeCoins>(stakeMarketCoinName);
+        const marketCoinType = utils.parseMarketCoinType(stakeCoinName);
 
         types[
           stakeMarketCoinName as SupportStakeMarketCoins
@@ -295,7 +299,7 @@ export const getStakeAccounts = async (
   const stakeObjectIds: string[] = stakeObjectsResponse
     .map((ref: any) => ref?.data?.objectId)
     .filter((id: any) => id !== undefined);
-  const stakeObjects = await query.cache.queryGetObjects(stakeObjectIds);
+  const stakeObjects = await utils.cache.queryGetObjects(stakeObjectIds);
   for (const stakeObject of stakeObjects) {
     const id = stakeObject.objectId;
     const type = stakeObject.type!;
@@ -413,12 +417,16 @@ export const getStakeAccounts = async (
  * @return Stake pool data.
  */
 export const getStakePool = async (
-  query: ScallopQuery,
+  {
+    utils,
+  }: {
+    utils: ScallopUtils;
+  },
   marketCoinName: SupportStakeMarketCoins
 ) => {
-  const poolId = query.address.get(`spool.pools.${marketCoinName}.id`);
+  const poolId = utils.address.get(`spool.pools.${marketCoinName}.id`);
   let stakePool: StakePool | undefined = undefined;
-  const stakePoolObjectResponse = await query.cache.queryGetObject(poolId, {
+  const stakePoolObjectResponse = await utils.cache.queryGetObject(poolId, {
     showContent: true,
     showType: true,
   });
@@ -469,14 +477,18 @@ export const getStakePool = async (
  * @return Stake reward pool.
  */
 export const getStakeRewardPool = async (
-  query: ScallopQuery,
+  {
+    utils,
+  }: {
+    utils: ScallopUtils;
+  },
   marketCoinName: SupportStakeMarketCoins
 ) => {
-  const poolId = query.address.get(
+  const poolId = utils.address.get(
     `spool.pools.${marketCoinName}.rewardPoolId`
   );
   let stakeRewardPool: StakeRewardPool | undefined = undefined;
-  const stakeRewardPoolObjectResponse = await query.cache.queryGetObject(
+  const stakeRewardPoolObjectResponse = await utils.cache.queryGetObject(
     poolId,
     {
       showContent: true,

package/src/queries/vescaQuery.ts

@@ -5,7 +5,7 @@ import {
   type SuiObjectData,
   DevInspectResults,
 } from '@mysten/sui.js/client';
-import type { ScallopQuery } from '../models';
+import type { ScallopUtils } from '../models';
 import { MAX_LOCK_DURATION } from 'src/constants';
 import { SUI_CLOCK_OBJECT_ID, SuiTxBlock } from '@scallop-io/sui-kit';
 import { bcs } from '@mysten/sui.js/bcs';
@@ -18,17 +18,17 @@ import { z as zod } from 'zod';
  * @return Owned veSca key.
  */
 export const getVescaKeys = async (
-  query: ScallopQuery,
+  utils: ScallopUtils,
   ownerAddress?: string
 ) => {
-  const owner = ownerAddress || query.suiKit.currentAddress();
-  const veScaObjId = query.address.get('vesca.object');
+  const owner = ownerAddress || utils.suiKit.currentAddress();
+  const veScaObjId = utils.address.get('vesca.object');
   const veScaKeyType = `${veScaObjId}::ve_sca::VeScaKey`;
   const keyObjectsResponse: SuiObjectResponse[] = [];
   let hasNextPage = false;
   let nextCursor: string | null | undefined = null;
   do {
-    const paginatedKeyObjectsResponse = await query.cache.queryGetOwnedObjects({
+    const paginatedKeyObjectsResponse = await utils.cache.queryGetOwnedObjects({
       owner,
       filter: {
         StructType: veScaKeyType,
@@ -63,12 +63,19 @@ export const getVescaKeys = async (
  * @param ownerAddress - The owner address.
  * @return Owned veScas.
  */
-export const getVeScas = async (query: ScallopQuery, ownerAddress?: string) => {
-  const keyObjectDatas = await getVescaKeys(query, ownerAddress);
+export const getVeScas = async (
+  {
+    utils,
+  }: {
+    utils: ScallopUtils;
+  },
+  ownerAddress?: string
+) => {
+  const keyObjectDatas = await getVescaKeys(utils, ownerAddress);
 
   const veScas: Vesca[] = Array(keyObjectDatas.length).fill(null);
   const tasks = keyObjectDatas.map(async (veScaKey, idx) => {
-    const veSca = await getVeSca(query, veScaKey);
+    const veSca = await getVeSca(utils, veScaKey);
     if (veSca) {
       veScas[idx] = veSca;
     }
@@ -96,12 +103,12 @@ type SuiObjectRefType = zod.infer<typeof SuiObjectRefZod>;
  * @returns Vesca data.
  */
 export const getVeSca = async (
-  query: ScallopQuery,
+  utils: ScallopUtils,
   veScaKey?: string | SuiObjectData,
   ownerAddress?: string
 ) => {
-  const tableId = query.address.get(`vesca.tableId`);
-  veScaKey = veScaKey || (await getVescaKeys(query, ownerAddress))[0];
+  const tableId = utils.address.get(`vesca.tableId`);
+  veScaKey = veScaKey || (await getVescaKeys(utils, ownerAddress))[0];
 
   if (!veScaKey) return undefined;
   if (typeof veScaKey === 'object') {
@@ -111,7 +118,7 @@ export const getVeSca = async (
   let vesca: Vesca | undefined = undefined;
 
   const veScaDynamicFieldObjectResponse =
-    await query.cache.queryGetDynamicFieldObject({
+    await utils.cache.queryGetDynamicFieldObject({
       parentId: tableId,
       name: {
         type: '0x2::object::ID',
@@ -162,12 +169,12 @@ export const getVeSca = async (
  * Get current total veSca treasury amount.
  */
 const getTotalVeScaTreasuryAmount = async (
-  query: ScallopQuery,
+  utils: ScallopUtils,
   veScaTreasury: SuiObjectData
 ): Promise<string> => {
-  const veScaPkgId = query.address.get('vesca.id');
-  const veScaConfig = query.address.get('vesca.config');
-  veScaTreasury = veScaTreasury ?? query.address.get('vesca.treasury');
+  const veScaPkgId = utils.address.get('vesca.id');
+  const veScaConfig = utils.address.get('vesca.config');
+  veScaTreasury = veScaTreasury ?? utils.address.get('vesca.treasury');
 
   // refresh query
   const refreshQueryTarget = `${veScaPkgId}::treasury::refresh`;
@@ -181,7 +188,7 @@ const getTotalVeScaTreasuryAmount = async (
   const resolvedRefreshArgs = await Promise.all(
     refreshArgs.map(async (arg) => {
       if (typeof arg === 'string') {
-        return (await query.cache.queryGetObject(arg, { showContent: true }))
+        return (await utils.cache.queryGetObject(arg, { showContent: true }))
           ?.data;
       }
       return arg;
@@ -191,7 +198,7 @@ const getTotalVeScaTreasuryAmount = async (
   const resolvedVeScaAmountArgs = await Promise.all(
     veScaAmountArgs.map(async (arg) => {
       if (typeof arg === 'string') {
-        return (await query.cache.queryGetObject(arg, { showContent: true }))
+        return (await utils.cache.queryGetObject(arg, { showContent: true }))
           ?.data;
       }
       return arg;
@@ -204,19 +211,18 @@ const getTotalVeScaTreasuryAmount = async (
   txb.moveCall(veScaAmountQueryTarget, resolvedVeScaAmountArgs);
 
   const txBytes = await txb.txBlock.build({
-    client: query.suiKit.client(),
+    client: utils.suiKit.client(),
     onlyTransactionKind: true,
-    protocolConfig: (await query.cache.getProtocolConfig()) ?? undefined,
   });
 
   // return result
-  const res = await query.cache.queryClient.fetchQuery<DevInspectResults>({
+  const res = await utils.cache.queryClient.fetchQuery<DevInspectResults>({
     queryKey: [
       'getTotalVeScaTreasuryAmount',
       JSON.stringify([...refreshArgs, ...veScaAmountArgs]),
     ],
     queryFn: async () => {
-      return await query.suiKit.inspectTxn(txBytes);
+      return await utils.suiKit.inspectTxn(txBytes);
     },
   });
 
@@ -236,10 +242,10 @@ const getTotalVeScaTreasuryAmount = async (
  * @returns VeScaTreasuryInfo
  */
 export const getVeScaTreasuryInfo = async (
-  query: ScallopQuery
+  utils: ScallopUtils
 ): Promise<VeScaTreasuryInfo | null> => {
-  const veScaTreasuryId = query.address.get('vesca.treasury');
-  const veScaTreasury = await query.cache.queryGetObject(veScaTreasuryId, {
+  const veScaTreasuryId = utils.address.get('vesca.treasury');
+  const veScaTreasury = await utils.cache.queryGetObject(veScaTreasuryId, {
     showContent: true,
   });
 
@@ -255,7 +261,7 @@ export const getVeScaTreasuryInfo = async (
     .shiftedBy(-9)
     .toNumber();
   const totalVeSca = BigNumber(
-    (await getTotalVeScaTreasuryAmount(query, veScaTreasury.data)) ?? 0
+    (await getTotalVeScaTreasuryAmount(utils, veScaTreasury.data)) ?? 0
   )
     .shiftedBy(-9)
     .toNumber();

package/src/types/builder/vesca.ts

@@ -32,6 +32,10 @@ export type VeScaNormalMethods = {
   mintEmptyVeSca: () => TransactionResult;
 };
 
+export type RedeemScaQuickReturnType<T extends boolean> = T extends true
+  ? void
+  : TransactionResult | undefined;
+
 export type VeScaQuickMethods = {
   /**
    * Quick methods to automate
@@ -70,7 +74,10 @@ export type VeScaQuickMethods = {
     veScaKey?: SuiObjectArg,
     autoCheck?: boolean
   ) => Promise<void>;
-  redeemScaQuick: (veScaKey?: SuiObjectArg) => Promise<void>;
+  redeemScaQuick: <T extends boolean>(
+    veSCaKey?: SuiObjectArg,
+    transferSca?: T
+  ) => Promise<RedeemScaQuickReturnType<T>>;
 };
 
 export type SuiTxBlockWithVeScaNormalMethods = SuiKitTxBlock &