@scallop-io/sui-scallop-sdk 0.46.53 → 0.46.54

package/src/queries/borrowIncentiveQuery.ts

@@ -73,10 +73,11 @@ export const queryBorrowIncentivePools = async (
   const queryTarget = `${queryPkgId}::incentive_pools_query::incentive_pools_data`;
   const args = [incentivePoolsId];
   const queryResult = await query.cache.queryInspectTxn({ queryTarget, args });
-  const borrowIncentivePoolsQueryData = queryResult.events[0]
-    .parsedJson as BorrowIncentivePoolsQueryInterface;
+  const borrowIncentivePoolsQueryData = queryResult?.events[0].parsedJson as
+    | BorrowIncentivePoolsQueryInterface
+    | undefined;
 
-  for (const pool of borrowIncentivePoolsQueryData.incentive_pools) {
+  for (const pool of borrowIncentivePoolsQueryData?.incentive_pools ?? []) {
     const borrowIncentivePoolPoints: OptionalKeys<
       Record<SupportBorrowIncentiveRewardCoins, BorrowIncentivePoolPoints>
     > = {};
@@ -177,11 +178,12 @@ export const queryBorrowIncentiveAccounts = async (
   const args = [incentiveAccountsId, obligationId];
 
   const queryResult = await query.cache.queryInspectTxn({ queryTarget, args });
-  const borrowIncentiveAccountsQueryData = queryResult.events[0]
-    .parsedJson as BorrowIncentiveAccountsQueryInterface;
+  const borrowIncentiveAccountsQueryData = queryResult?.events[0].parsedJson as
+    | BorrowIncentiveAccountsQueryInterface
+    | undefined;
 
   const borrowIncentiveAccounts: BorrowIncentiveAccounts = Object.values(
-    borrowIncentiveAccountsQueryData.pool_records
+    borrowIncentiveAccountsQueryData?.pool_records ?? []
   ).reduce((accounts, accountData) => {
     const parsedBorrowIncentiveAccount =
       parseOriginBorrowIncentiveAccountData(accountData);
@@ -224,7 +226,7 @@ export const getBindedObligationId = async (
     }
   );
 
-  if (incentivePoolsResponse.data?.content?.dataType !== 'moveObject')
+  if (incentivePoolsResponse?.data?.content?.dataType !== 'moveObject')
     return null;
   const incentivePoolFields = incentivePoolsResponse.data.content.fields as any;
   const veScaBindTableId = incentivePoolFields.ve_sca_bind.fields.id
@@ -240,7 +242,7 @@ export const getBindedObligationId = async (
     },
   });
 
-  if (veScaBindTableResponse.data?.content?.dataType !== 'moveObject')
+  if (veScaBindTableResponse?.data?.content?.dataType !== 'moveObject')
     return null;
   const veScaBindTableFields = veScaBindTableResponse.data.content
     .fields as any;
@@ -267,7 +269,7 @@ export const getBindedVeScaKey = async (
       showContent: true,
     }
   );
-  if (incentiveAccountsObject.data?.content?.dataType !== 'moveObject')
+  if (incentiveAccountsObject?.data?.content?.dataType !== 'moveObject')
     return null;
   const incentiveAccountsTableId = (
     incentiveAccountsObject.data.content.fields as any
@@ -282,7 +284,7 @@ export const getBindedVeScaKey = async (
     },
   });
 
-  if (bindedIncentiveAcc.data?.content?.dataType !== 'moveObject') return null;
+  if (bindedIncentiveAcc?.data?.content?.dataType !== 'moveObject') return null;
   const bindedIncentiveAccFields = bindedIncentiveAcc.data.content
     .fields as any;
 

package/src/queries/coreQuery.ts

@@ -82,9 +82,11 @@ export const queryMarket = async (
   const args = [marketId];
 
   const queryResult = await query.cache.queryInspectTxn({ queryTarget, args });
-  const marketData = queryResult.events[0].parsedJson as MarketQueryInterface;
+  const marketData = queryResult?.events[0].parsedJson as
+    | MarketQueryInterface
+    | undefined;
 
-  for (const pool of marketData.pools) {
+  for (const pool of marketData?.pools ?? []) {
     const coinType = normalizeStructTag(pool.type.name);
     const poolCoinName =
       query.utils.parseCoinNameFromType<SupportPoolCoins>(coinType);
@@ -141,7 +143,7 @@ export const queryMarket = async (
     };
   }
 
-  for (const collateral of marketData.collaterals) {
+  for (const collateral of marketData?.collaterals ?? []) {
     const coinType = normalizeStructTag(collateral.type.name);
     const collateralCoinName =
       query.utils.parseCoinNameFromType<SupportCollateralCoins>(coinType);
@@ -240,7 +242,7 @@ export const getMarketPools = async (
         query,
         poolCoinName,
         indexer,
-        marketObjectResponse.data,
+        marketObjectResponse?.data,
         coinPrices?.[poolCoinName]
       );
 
@@ -293,7 +295,7 @@ export const getMarketPool = async (
       await query.cache.queryGetObject(marketId, {
         showContent: true,
       })
-    ).data;
+    )?.data;
 
   coinPrice =
     coinPrice ||
@@ -317,6 +319,8 @@ export const getMarketPool = async (
             },
           },
         });
+      if (!balanceSheetDynamicFieldObjectResponse) return undefined;
+
       const balanceSheetDynamicFieldObject =
         balanceSheetDynamicFieldObjectResponse.data;
       if (
@@ -342,6 +346,8 @@ export const getMarketPool = async (
             },
           },
         });
+      if (!borrowIndexDynamicFieldObjectResponse) return undefined;
+
       const borrowIndexDynamicFieldObject =
         borrowIndexDynamicFieldObjectResponse.data;
       if (
@@ -367,6 +373,8 @@ export const getMarketPool = async (
             },
           },
         });
+
+      if (!interestModelDynamicFieldObjectResponse) return undefined;
       const interestModelDynamicFieldObject =
         interestModelDynamicFieldObjectResponse.data;
       if (
@@ -393,6 +401,7 @@ export const getMarketPool = async (
           },
         });
 
+      if (!borrowFeeDynamicFieldObjectResponse) return undefined;
       const borrowFeeDynamicFieldObject =
         borrowFeeDynamicFieldObjectResponse.data;
       if (
@@ -508,7 +517,7 @@ export const getMarketCollaterals = async (
         query,
         collateralCoinName,
         indexer,
-        marketObjectResponse.data,
+        marketObjectResponse?.data,
         coinPrices?.[collateralCoinName]
       );
 
@@ -561,7 +570,7 @@ export const getMarketCollateral = async (
       await query.cache.queryGetObject(marketId, {
         showContent: true,
       })
-    ).data;
+    )?.data;
 
   coinPrice =
     coinPrice ||
@@ -586,6 +595,8 @@ export const getMarketCollateral = async (
             },
           },
         });
+
+      if (!riskModelDynamicFieldObjectResponse) return undefined;
       const riskModelDynamicFieldObject =
         riskModelDynamicFieldObjectResponse.data;
       if (
@@ -610,6 +621,8 @@ export const getMarketCollateral = async (
             },
           },
         });
+
+      if (!collateralStatDynamicFieldObjectResponse) return undefined;
       const collateralStatDynamicFieldObject =
         collateralStatDynamicFieldObjectResponse.data;
       if (
@@ -687,6 +700,7 @@ export const getObligations = async (
       },
       cursor: nextCursor,
     });
+    if (!paginatedKeyObjectsResponse) continue;
 
     keyObjectsResponse.push(...paginatedKeyObjectsResponse.data);
     if (
@@ -738,7 +752,7 @@ export const getObligationLocked = async (
   );
   let obligationLocked = false;
   if (
-    obligationObjectResponse.data &&
+    obligationObjectResponse?.data &&
     obligationObjectResponse?.data?.content?.dataType === 'moveObject' &&
     'lock_key' in obligationObjectResponse.data.content.fields
   ) {
@@ -774,7 +788,9 @@ export const queryObligation = async (
     { queryTarget, args }
     // txBlock
   );
-  return queryResult.events[0].parsedJson as ObligationQueryInterface;
+  return queryResult?.events[0].parsedJson as
+    | ObligationQueryInterface
+    | undefined;
 };
 
 /**
@@ -929,7 +945,7 @@ export const getFlashLoanFees = async (
     const marketObjectRes = await query.cache.queryGetObject(marketObjectId, {
       showContent: true,
     });
-    if (marketObjectRes.data?.content?.dataType !== 'moveObject')
+    if (marketObjectRes?.data?.content?.dataType !== 'moveObject')
       throw new Error('Failed to get market object');
 
     // get vault
@@ -946,12 +962,13 @@ export const getFlashLoanFees = async (
     });
 
     // get the dynamic object ids
-    const dynamicFieldObjectIds = balanceSheetDynamicFields.data
-      .filter((field) => {
-        const assetType = (field.name.value as any).name as string;
-        return !!assetTypeMap[assetType];
-      })
-      .map((field) => field.objectId);
+    const dynamicFieldObjectIds =
+      balanceSheetDynamicFields?.data
+        .filter((field) => {
+          const assetType = (field.name.value as any).name as string;
+          return !!assetTypeMap[assetType];
+        })
+        .map((field) => field.objectId) ?? [];
 
     flashloanFeeObjects.push(
       ...(await query.cache.queryGetObjects(dynamicFieldObjectIds, {

package/src/queries/loyaltyProgramQuery.ts

@@ -40,7 +40,7 @@ export const getLoyaltyProgramInformations = async (
     showContent: true,
   });
 
-  if (rewardPoolObject.data?.content?.dataType !== 'moveObject') return null;
+  if (rewardPoolObject?.data?.content?.dataType !== 'moveObject') return null;
   const rewardPoolFields = rewardPoolObject.data.content.fields;
   const { isClaimEnabled, totalPoolReward } = rewardPoolFieldsZod.parse(
     rewardPoolFields
@@ -68,7 +68,7 @@ export const getLoyaltyProgramInformations = async (
     },
   });
 
-  if (userRewardObject.data?.content?.dataType !== 'moveObject') return result;
+  if (userRewardObject?.data?.content?.dataType !== 'moveObject') return result;
   const userRewardFields = userRewardObject.data.content.fields;
   result.pendingReward = userRewardFieldsZod.parse(
     userRewardFields

package/src/queries/portfolioQuery.ts

@@ -362,7 +362,7 @@ export const getObligationAccount = async (
   let totalBorrowedValueWithWeight = BigNumber(0);
 
   for (const assetCoinName of collateralAssetCoinNames) {
-    const collateral = obligationQuery.collaterals.find((collateral) => {
+    const collateral = obligationQuery?.collaterals.find((collateral) => {
       const collateralCoinName =
         query.utils.parseCoinNameFromType<SupportCollateralCoins>(
           collateral.type.name
@@ -432,7 +432,7 @@ export const getObligationAccount = async (
   ];
 
   for (const assetCoinName of borrowAssetCoinNames) {
-    const debt = obligationQuery.debts.find((debt) => {
+    const debt = obligationQuery?.debts.find((debt) => {
       const poolCoinName = query.utils.parseCoinNameFromType<SupportPoolCoins>(
         debt.type.name
       );

package/src/queries/priceQuery.ts

@@ -20,7 +20,7 @@ export const getPythPrice = async (
   priceFeedObject =
     priceFeedObject ||
     (await query.cache.queryGetObject(pythFeedObjectId, { showContent: true }))
-      .data;
+      ?.data;
 
   if (priceFeedObject) {
     const priceFeedPoolObject = priceFeedObject;

package/src/queries/referralQuery.ts

@@ -19,7 +19,7 @@ export const queryVeScaKeyIdFromReferralBindings = async (
     },
   });
 
-  if (referralBindResponse.data?.content?.dataType !== 'moveObject')
+  if (referralBindResponse?.data?.content?.dataType !== 'moveObject')
     return null;
 
   const fields = referralBindResponse.data.content.fields as any;

package/src/queries/sCoinQuery.ts

@@ -28,7 +28,7 @@ export const getSCoinTotalSupply = async (
     args,
     typeArgs,
   });
-  const results = queryResults.results;
+  const results = queryResults?.results;
   if (results && results[0].returnValues) {
     const value = Uint8Array.from(results[0].returnValues[0][0]);
     const type = results[0].returnValues[0][1]; // should be u64

package/src/queries/spoolQuery.ts

@@ -251,6 +251,8 @@ export const getStakeAccounts = async (
         },
         cursor: nextCursor,
       });
+    if (!paginatedStakeObjectsResponse) continue;
+
     stakeObjectsResponse.push(...paginatedStakeObjectsResponse.data);
     if (
       paginatedStakeObjectsResponse.hasNextPage &&
@@ -420,7 +422,7 @@ export const getStakePool = async (
     showContent: true,
     showType: true,
   });
-  if (stakePoolObjectResponse.data) {
+  if (stakePoolObjectResponse?.data) {
     const stakePoolObject = stakePoolObjectResponse.data;
     const id = stakePoolObject.objectId;
     const type = stakePoolObject.type!;
@@ -482,7 +484,7 @@ export const getStakeRewardPool = async (
     }
   );
 
-  if (stakeRewardPoolObjectResponse.data) {
+  if (stakeRewardPoolObjectResponse?.data) {
     const stakeRewardPoolObject = stakeRewardPoolObjectResponse.data;
     const id = stakeRewardPoolObject.objectId;
     const type = stakeRewardPoolObject.type!;

package/src/queries/vescaQuery.ts

@@ -35,8 +35,11 @@ export const getVescaKeys = async (
       },
       cursor: nextCursor,
     });
+    if (!paginatedKeyObjectsResponse) continue;
+
     keyObjectsResponse.push(...paginatedKeyObjectsResponse.data);
     if (
+      paginatedKeyObjectsResponse &&
       paginatedKeyObjectsResponse.hasNextPage &&
       paginatedKeyObjectsResponse.nextCursor
     ) {
@@ -115,6 +118,8 @@ export const getVeSca = async (
         value: typeof veScaKey === 'string' ? veScaKey : veScaKey.objectId,
       },
     });
+  if (!veScaDynamicFieldObjectResponse) return undefined;
+
   const veScaDynamicFieldObject = veScaDynamicFieldObjectResponse.data;
   if (
     veScaDynamicFieldObject &&
@@ -177,7 +182,7 @@ const getTotalVeScaTreasuryAmount = async (
     refreshArgs.map(async (arg) => {
       if (typeof arg === 'string') {
         return (await query.cache.queryGetObject(arg, { showContent: true }))
-          .data;
+          ?.data;
       }
       return arg;
     })
@@ -187,7 +192,7 @@ const getTotalVeScaTreasuryAmount = async (
     veScaAmountArgs.map(async (arg) => {
       if (typeof arg === 'string') {
         return (await query.cache.queryGetObject(arg, { showContent: true }))
-          .data;
+          ?.data;
       }
       return arg;
     })
@@ -201,7 +206,7 @@ const getTotalVeScaTreasuryAmount = async (
   const txBytes = await txb.txBlock.build({
     client: query.suiKit.client(),
     onlyTransactionKind: true,
-    protocolConfig: await query.cache.getProtocolConfig(),
+    protocolConfig: (await query.cache.getProtocolConfig()) ?? undefined,
   });
 
   // return result

package/src/utils/index.ts

@@ -1,3 +1,4 @@
 export * from './builder';
 export * from './query';
 export * from './util';
+export * from './tokenBucket';

package/src/utils/tokenBucket.ts

@@ -0,0 +1,63 @@
+import { DEFAULT_INTERVAL_IN_MS } from 'src/constants/tokenBucket';
+
+class TokenBucket {
+  private tokensPerInterval: number;
+  private interval: number;
+  private tokens: number;
+  private lastRefill: number;
+
+  constructor(tokensPerInterval: number, intervalInMs: number) {
+    this.tokensPerInterval = tokensPerInterval;
+    this.interval = intervalInMs;
+    this.tokens = tokensPerInterval;
+    this.lastRefill = Date.now();
+  }
+
+  refill() {
+    const now = Date.now();
+    const elapsed = now - this.lastRefill;
+    if (elapsed > this.interval) {
+      const tokensToAdd =
+        Math.floor(elapsed / this.interval) * this.tokensPerInterval;
+      this.tokens = Math.min(this.tokens + tokensToAdd, this.tokensPerInterval);
+      this.lastRefill = now;
+    }
+  }
+
+  removeTokens(count: number) {
+    this.refill();
+    if (this.tokens >= count) {
+      this.tokens -= count;
+      return true;
+    }
+    return false;
+  }
+}
+
+const callWithRateLimit = async <T>(
+  tokenBucket: TokenBucket,
+  fn: () => Promise<T>,
+  retryDelayInMs = DEFAULT_INTERVAL_IN_MS,
+  maxRetries = 5 // Adding a maximum retries limit,
+): Promise<T | null> => {
+  let retries = 0;
+
+  const tryRequest = async (): Promise<T | null> => {
+    if (tokenBucket.removeTokens(1)) {
+      return await fn();
+    } else if (retries < maxRetries) {
+      retries++;
+      // Use a Promise to correctly handle the async operation with setTimeout
+      await new Promise((resolve) => setTimeout(resolve, retryDelayInMs));
+      return tryRequest();
+    } else {
+      // Optionally, handle the case where the maximum number of retries is reached
+      console.error('Maximum retries reached');
+      return null;
+    }
+  };
+
+  return tryRequest();
+};
+
+export { TokenBucket, callWithRateLimit };