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

package/src/queries/borrowIncentiveQuery.ts

@@ -1,5 +1,4 @@
 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,
@@ -41,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;
 
@@ -170,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;
 

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

@@ -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',

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 = {

package/src/types/query/borrowIncentive.ts

@@ -16,24 +16,6 @@ export type BorrowIncentivePools = OptionalKeys<
   Record<SupportBorrowIncentiveCoins, BorrowIncentivePool>
 >;
 
-// export type BorrowIncentivePool = {
-//   coinName: SupportBorrowIncentiveCoins;
-//   symbol: string;
-//   coinType: string;
-//   rewardCoinType: string;
-//   coinDecimal: number;
-//   rewardCoinDecimal: number;
-//   coinPrice: number;
-//   rewardCoinPrice: number;
-// } & Required<
-//   Pick<
-//     ParsedBorrowIncentivePoolData,
-//     'maxPoints' | 'distributedPoint' | 'maxStake'
-//   >
-// > &
-//   CalculatedBorrowIncentivePoolData &
-//   BorrowIncentiveRewardPool;
-
 export type BorrowIncentivePoolPoints = {
   symbol: string;
   coinName: SupportBorrowIncentiveRewardCoins;
@@ -60,21 +42,6 @@ export type BorrowIncentivePool = {
   >;
 };
 
-// export type OriginBorrowIncentivePoolData = {
-//   created_at: string;
-//   distributed_point: string;
-//   distributed_point_per_period: string;
-//   index: string;
-//   last_update: string;
-//   max_distributed_point: string;
-//   max_stakes: string;
-//   point_distribution_time: string;
-//   pool_type: {
-//     name: string;
-//   };
-//   stakes: string;
-// };
-
 export type OriginBorrowIncentivePoolPointData = {
   point_type: {
     name: string;
@@ -112,18 +79,6 @@ export type ParsedBorrowIncentivePoolPointData = {
   lastUpdate: number;
 };
 
-// export type ParsedBorrowIncentivePoolData = {
-//   poolType: string;
-//   maxPoint: number;
-//   distributedPoint: number;
-//   pointPerPeriod: number;
-//   period: number;
-//   maxStake: number;
-//   staked: number;
-//   index: number;
-//   createdAt: number;
-//   lastUpdate: number;
-// };
 export type ParsedBorrowIncentivePoolData = {
   poolType: string;
   poolPoints: OptionalKeys<
@@ -154,54 +109,10 @@ export type CalculatedBorrowIncentivePoolPointData = {
   rewardPerSec: number;
 };
 
-// export type BorrowIncentiveRewardPool = CalculatedBorrowIncentiveRewardPoolData;
-
-// export type OriginBorrowIncentiveRewardPoolData = {
-//   claimed_rewards: string;
-//   exchange_rate_denominator: string;
-//   exchange_rate_numerator: string;
-//   remaining_reward: string;
-//   reward_type: {
-//     name: string;
-//   };
-// };
-
-// export type ParsedBorrowIncentiveRewardPoolData = {
-//   rewardType: string;
-//   claimedRewards: number;
-//   exchangeRateDenominator: number;
-//   exchangeRateNumerator: number;
-//   remainingRewards: number;
-// };
-
-// export type CalculatedBorrowIncentiveRewardPoolData = {
-//   rewardApr: number;
-//   totalRewardAmount: number;
-//   totalRewardCoin: number;
-//   totalRewardValue: number;
-//   // remaindRewardAmount: number;
-//   // remaindRewardCoin: number;
-//   // remaindRewardValue: number;
-//   // claimedRewardAmount: number;
-//   // claimedRewardCoin: number;
-//   // claimedRewardValue: number;
-//   rewardPerSec: number;
-// };
-
 export type BorrowIncentiveAccounts = OptionalKeys<
   Record<SupportBorrowIncentiveCoins, ParsedBorrowIncentiveAccountData>
 >;
 
-// export type OriginBorrowIncentiveAccountData = {
-//   amount: string;
-//   index: string;
-//   points: string;
-//   pool_type: {
-//     name: string;
-//   };
-//   total_points: string;
-// };
-
 export type OriginBorrowIncentiveAccountPoolData = {
   point_type: {
     name: string;
@@ -220,14 +131,6 @@ export type OriginBorrowIncentiveAccountData = {
   debt_amount: string;
 };
 
-// export type ParsedBorrowIncentiveAccountData = {
-//   poolType: string;
-//   amount: number;
-//   index: number;
-//   points: number;
-//   totalPoints: number;
-// };
-
 export type ParsedBorrowIncentiveAccountPoolData = {
   pointType: string;
   weightedAmount: number;
@@ -250,11 +153,6 @@ export type ParsedBorrowIncentiveAccountData = {
 /**
  * The query interface for `incentive_pools_query::incentive_pools_data` inspectTxn.
  */
-// export interface BorrowIncentivePoolsQueryInterface {
-//   incentive_pools: OriginBorrowIncentivePoolData[];
-//   reward_pool: OriginBorrowIncentiveRewardPoolData;
-// }
-
 export interface BorrowIncentivePoolsQueryInterface {
   incentive_pools: OriginBorrowIncentivePoolData[];
 }
@@ -262,11 +160,6 @@ export interface BorrowIncentivePoolsQueryInterface {
 /**
  * The query interface for `incentive_account_query::incentive_account_data` inspectTxn.
  */
-// export interface BorrowIncentiveAccountsQueryInterface {
-//   incentive_states: OriginBorrowIncentiveAccountData[];
-//   total_points: string;
-// }
-
 export interface BorrowIncentiveAccountsQueryInterface {
   pool_records: OriginBorrowIncentiveAccountData[];
 }