@scallop-io/sui-scallop-sdk 1.4.13 → 1.4.14-alpha.1

package/dist/models/scallopCache.d.ts

@@ -38,6 +38,7 @@ export declare class ScallopCache {
      * - `none`: No queries will be refetched. Queries that match the refetch predicate will only be marked as invalid.
      */
     invalidateAllCache(): Promise<Promise<void>[]>;
+    private retryFn;
     /**
      * @description Provides cache for inspectTxn of the SuiKit.
      * @param QueryInspectTxnParams

package/dist/models/scallopUtils.d.ts

@@ -59,12 +59,13 @@ export declare class ScallopUtils {
      */
     parseSCoinName<T extends SupportSCoin>(coinName: SupportCoins | SupportMarketCoins): T | undefined;
     /**
-     * Convert sCoin name to coin name.
+     * Convert sCoin name to market coin name.
      * This function will parse new sCoin name `scallop_...` to its old market coin name which is shorter
      * e.g: `scallop_sui -> ssui
+     * if no `scallop_...` is encountered, return coinName
      * @return sCoin name
      */
-    parseCoinNameFromSCoinName(coinName: string): "susdc" | "ssbeth" | "sweth" | "swbtc" | "swusdc" | "swusdt" | "ssui" | "swsol" | "scetus" | "safsui" | "shasui" | "svsui" | "ssca" | "sfud" | "sdeep";
+    parseSCoinTypeNameToMarketCoinName(coinName: string): "susdc" | "ssbeth" | "sweth" | "swbtc" | "swusdc" | "swusdt" | "ssui" | "swsol" | "scetus" | "safsui" | "shasui" | "svsui" | "ssca" | "sfud" | "sdeep";
     /**
      * Convert sCoin name into sCoin type
      * @param sCoinName
@@ -110,6 +111,7 @@ export declare class ScallopUtils {
     parseCoinNameFromType<T extends SupportAssetCoins>(coinType: string): T extends SupportAssetCoins ? T : SupportAssetCoins;
     parseCoinNameFromType<T extends SupportMarketCoins>(coinType: string): T extends SupportMarketCoins ? T : SupportMarketCoins;
     parseCoinNameFromType<T extends SupportCoins>(coinType: string): T extends SupportCoins ? T : SupportCoins;
+    parseCoinNameFromType<T extends SupportSCoin>(coinType: string): T extends SupportSCoin ? T : SupportSCoin;
     /**
      * Convert market coin name to coin name.
      *

package/dist/utils/query.d.ts

@@ -40,7 +40,7 @@ export declare const parseOriginBorrowIncentivesPoolPointData: (originBorrowInce
  * @param originBorrowIncentivePoolData - Origin borrow incentive pool data
  * @return Parsed borrow incentive pool data
  */
-export declare const parseOriginBorrowIncentivePoolData: (originBorrowIncentivePoolData: OriginBorrowIncentivePoolData) => ParsedBorrowIncentivePoolData;
+export declare const parseOriginBorrowIncentivePoolData: (utils: ScallopUtils, originBorrowIncentivePoolData: OriginBorrowIncentivePoolData) => ParsedBorrowIncentivePoolData;
 export declare const calculateBorrowIncentivePoolPointData: (parsedBorrowIncentivePoolPointData: ParsedBorrowIncentivePoolPointData, rewardCoinPrice: number, rewardCoinDecimal: number, poolCoinPrice: number, poolCoinDecimal: number) => CalculatedBorrowIncentivePoolPointData;
 export declare const parseOriginBorrowIncentiveAccountPoolPointData: (originBorrowIncentiveAccountPoolPointData: OriginBorrowIncentiveAccountPoolData) => ParsedBorrowIncentiveAccountPoolData;
 /**

package/package.json

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

package/src/constants/enum.ts

@@ -157,16 +157,24 @@ export const voloCoinIds: types.VoloCoinIds = {
 
 // PROD VERSION
 export const sCoinIds: types.SCoinIds = {
+  // prod values
+  // ssui: '0xaafc4f740de0dd0dde642a31148fb94517087052f19afb0f7bed1dc41a50c77b::scallop_sui::SCALLOP_SUI',
+  // swusdc:
+  //   '0xad4d71551d31092230db1fd482008ea42867dbf27b286e9c70a79d2a6191d58d::scallop_wormhole_usdc::SCALLOP_WORMHOLE_USDC',
+  // swusdt:
+  //   '0xe6e5a012ec20a49a3d1d57bd2b67140b96cd4d3400b9d79e541f7bdbab661f95::scallop_wormhole_usdt::SCALLOP_WORMHOLE_USDT',
+  // ssca: '0x5ca17430c1d046fae9edeaa8fd76c7b4193a00d764a0ecfa9418d733ad27bc1e::scallop_sca::SCALLOP_SCA',
+
+  ssui: '0xf569919046f19a0c40b519ecfbb6ca0319698cd5908716c29b62ef56541f298b::scallop_sui::SCALLOP_SUI',
+  swusdt:
+    '0xac781d9f73058ff5e69f9bf8dde32f2e8c71c66d7fe8497fc83b2d9182254b22::scallop_wormhole_usdt::SCALLOP_WORMHOLE_USDT',
+  swusdc:
+    '0xf5447c4305a486d8c8557559887c2c39449ddb5e748f15d33946d02a1663c158::scallop_wormhole_usdc::SCALLOP_WORMHOLE_USDC',
+  ssca: '0x958428555e778e55918a59eb1c92c77f32b5c554fa3a5e56cd0815086b5072e7::scallop_sca::SCALLOP_SCA',
   susdc:
     '0x854950aa624b1df59fe64e630b2ba7c550642e9342267a33061d59fb31582da5::scallop_usdc::SCALLOP_USDC',
   ssbeth:
     '0xb14f82d8506d139eacef109688d1b71e7236bcce9b2c0ad526abcd6aa5be7de0::scallop_sb_eth::SCALLOP_SB_ETH',
-  ssui: '0xaafc4f740de0dd0dde642a31148fb94517087052f19afb0f7bed1dc41a50c77b::scallop_sui::SCALLOP_SUI',
-  swusdc:
-    '0xad4d71551d31092230db1fd482008ea42867dbf27b286e9c70a79d2a6191d58d::scallop_wormhole_usdc::SCALLOP_WORMHOLE_USDC',
-  swusdt:
-    '0xe6e5a012ec20a49a3d1d57bd2b67140b96cd4d3400b9d79e541f7bdbab661f95::scallop_wormhole_usdt::SCALLOP_WORMHOLE_USDT',
-  ssca: '0x5ca17430c1d046fae9edeaa8fd76c7b4193a00d764a0ecfa9418d733ad27bc1e::scallop_sca::SCALLOP_SCA',
   scetus:
     '0xea346ce428f91ab007210443efcea5f5cdbbb3aae7e9affc0ca93f9203c31f0c::scallop_cetus::SCALLOP_CETUS',
   sweth:

package/src/constants/tokenBucket.ts

@@ -1,2 +1,2 @@
 export const DEFAULT_TOKENS_PER_INTERVAL = 10;
-export const DEFAULT_INTERVAL_IN_MS = 50;
+export const DEFAULT_INTERVAL_IN_MS = 250;

package/src/models/scallopCache.ts

@@ -106,6 +106,11 @@ export class ScallopCache {
     );
   }
 
+  private retryFn(errCount: number, err: any) {
+    if (err.status === 429) return true;
+    if (errCount >= 5) return false;
+    return false;
+  }
   /**
    * @description Provides cache for inspectTxn of the SuiKit.
    * @param QueryInspectTxnParams
@@ -122,7 +127,7 @@ export class ScallopCache {
     txBlock.moveCall(queryTarget, args, typeArgs);
 
     const query = await this.queryClient.fetchQuery({
-      retry: 5,
+      retry: this.retryFn,
       retryDelay: 1000,
       queryKey: queryKeys.rpc.getInspectTxn(queryTarget, args, typeArgs),
       queryFn: async () => {
@@ -146,7 +151,7 @@ export class ScallopCache {
     options?: SuiObjectDataOptions
   ): Promise<SuiObjectResponse | null> {
     return this.queryClient.fetchQuery({
-      retry: 5,
+      retry: this.retryFn,
       retryDelay: 1000,
       queryKey: queryKeys.rpc.getObject(objectId, this.walletAddress, options),
       queryFn: async () => {
@@ -177,7 +182,7 @@ export class ScallopCache {
     // objectIds.sort();
 
     return this.queryClient.fetchQuery({
-      retry: 5,
+      retry: this.retryFn,
       retryDelay: 1000,
       queryKey: queryKeys.rpc.getObjects(
         objectIds,
@@ -200,7 +205,7 @@ export class ScallopCache {
    */
   public async queryGetOwnedObjects(input: GetOwnedObjectsParams) {
     return this.queryClient.fetchQuery({
-      retry: 5,
+      retry: this.retryFn,
       retryDelay: 1000,
       queryKey: queryKeys.rpc.getOwnedObjects(input),
       queryFn: async () => {
@@ -216,7 +221,7 @@ export class ScallopCache {
     input: GetDynamicFieldsParams
   ): Promise<DynamicFieldPage | null> {
     return this.queryClient.fetchQuery({
-      retry: 5,
+      retry: this.retryFn,
       retryDelay: 1000,
       queryKey: queryKeys.rpc.getDynamicFields(input),
       queryFn: async () => {
@@ -232,7 +237,7 @@ export class ScallopCache {
     input: GetDynamicFieldObjectParams
   ): Promise<SuiObjectResponse | null> {
     return this.queryClient.fetchQuery({
-      retry: 5,
+      retry: this.retryFn,
       retryDelay: (attemptIndex) => Math.min(1000 * attemptIndex, 8000),
       queryKey: queryKeys.rpc.getDynamicFieldObject(input),
       queryFn: async () => {
@@ -247,7 +252,7 @@ export class ScallopCache {
     owner: string
   ): Promise<{ [k: string]: string }> {
     return this.queryClient.fetchQuery({
-      retry: 5,
+      retry: this.retryFn,
       retryDelay: 1000,
       queryKey: queryKeys.rpc.getAllCoinBalances(owner),
       queryFn: async () => {

package/src/models/scallopUtils.ts

@@ -232,13 +232,14 @@ export class ScallopUtils {
   }
 
   /**
-   * Convert sCoin name to coin name.
+   * Convert sCoin name to market coin name.
    * This function will parse new sCoin name `scallop_...` to its old market coin name which is shorter
    * e.g: `scallop_sui -> ssui
+   * if no `scallop_...` is encountered, return coinName
    * @return sCoin name
    */
-  public parseCoinNameFromSCoinName(coinName: string) {
-    return sCoinRawNameToName[coinName];
+  public parseSCoinTypeNameToMarketCoinName(coinName: string) {
+    return sCoinRawNameToName[coinName] ?? coinName;
   }
 
   /**
@@ -311,8 +312,14 @@ export class ScallopUtils {
   public parseCoinNameFromType<T extends SupportCoins>(
     coinType: string
   ): T extends SupportCoins ? T : SupportCoins;
+  public parseCoinNameFromType<T extends SupportSCoin>(
+    coinType: string
+  ): T extends SupportSCoin ? T : SupportSCoin;
   public parseCoinNameFromType(coinType: string) {
     coinType = normalizeStructTag(coinType);
+    if (sCoinTypeToName[coinType]) {
+      return sCoinTypeToName[coinType] as SupportSCoin;
+    }
 
     const coinTypeRegex = new RegExp(`((0x[^:]+::[^:]+::[^<>]+))(?![^<>]*<)`);
     const coinTypeMatch = coinType.match(coinTypeRegex);

package/src/queries/borrowIncentiveQuery.ts

@@ -1,6 +1,5 @@
 import { normalizeStructTag } from '@mysten/sui/utils';
 import {
-  sCoinRawNameToName,
   SUPPORT_BORROW_INCENTIVE_POOLS,
   SUPPORT_BORROW_INCENTIVE_REWARDS,
 } from '../constants';
@@ -100,8 +99,10 @@ export const getBorrowIncentivePools = async (
     const borrowIncentivePoolPoints: OptionalKeys<
       Record<SupportBorrowIncentiveRewardCoins, BorrowIncentivePoolPoints>
     > = {};
-    const parsedBorrowIncentivePoolData =
-      parseOriginBorrowIncentivePoolData(pool);
+    const parsedBorrowIncentivePoolData = parseOriginBorrowIncentivePoolData(
+      query.utils,
+      pool
+    );
 
     const poolCoinType = normalizeStructTag(pool.pool_type.name);
     const poolCoinName =
@@ -121,13 +122,10 @@ export const getBorrowIncentivePools = async (
       parsedBorrowIncentivePoolData.poolPoints
     )) {
       const rewardCoinType = poolPoint.pointType;
-      let rewardCoinName = query.utils.parseCoinNameFromType(
+      const rewardCoinName = query.utils.parseCoinNameFromType(
         rewardCoinType
       ) as SupportBorrowIncentiveRewardCoins;
       // handle for scoin name
-      if (sCoinRawNameToName[rewardCoinName]) {
-        rewardCoinName = sCoinRawNameToName[rewardCoinName];
-      }
       const rewardCoinDecimal = query.utils.getCoinDecimal(rewardCoinName);
       const rewardCoinPrice = coinPrices?.[rewardCoinName] ?? 0;
 

package/src/queries/borrowLimitQuery.ts

@@ -17,8 +17,8 @@ const borrowLimitZod = zod.object({
   }),
 });
 
-const borrowLimitKeyType = `0xe7dbb371a9595631f7964b7ece42255ad0e738cc85fe6da26c7221b220f01af6::market_dynamic_keys::BorrowLimitKey`; // prod
-// const borrowLimitKeyType = `0xb784ea287d944e478a3ceaa071f8885072cce6b7224cf245914dc2f9963f460e::market_dynamic_keys::BorrowLimitKey`;
+// const borrowLimitKeyType = `0xe7dbb371a9595631f7964b7ece42255ad0e738cc85fe6da26c7221b220f01af6::market_dynamic_keys::BorrowLimitKey`; // prod
+const borrowLimitKeyType = `0xb784ea287d944e478a3ceaa071f8885072cce6b7224cf245914dc2f9963f460e::market_dynamic_keys::BorrowLimitKey`;
 
 /**
  * Return supply limit of a pool (including the decimals)

package/src/queries/isolatedAssetQuery.ts

@@ -18,8 +18,8 @@ const isolatedAssetZod = zod.object({
   }),
 });
 
-const isolatedAssetKeyType = `0xe7dbb371a9595631f7964b7ece42255ad0e738cc85fe6da26c7221b220f01af6::market_dynamic_keys::IsolatedAssetKey`; // prod
-// const isolatedAssetKeyType = `0x6c23585e940a989588432509107e98bae06dbca4e333f26d0635d401b3c7c76d::market_dynamic_keys::IsolatedAssetKey`;
+// const isolatedAssetKeyType = `0xe7dbb371a9595631f7964b7ece42255ad0e738cc85fe6da26c7221b220f01af6::market_dynamic_keys::IsolatedAssetKey`; // prod
+const isolatedAssetKeyType = `0x6c23585e940a989588432509107e98bae06dbca4e333f26d0635d401b3c7c76d::market_dynamic_keys::IsolatedAssetKey`;
 
 /**
  * Return list of isolated assets coin types

package/src/queries/portfolioQuery.ts

@@ -532,7 +532,7 @@ export const getObligationAccount = async (
         ([key, accountPoint]) => {
           const poolPoint =
             borrowIncentivePool.points[
-              key as SupportBorrowIncentiveRewardCoins
+              query.utils.parseSCoinTypeNameToMarketCoinName(key)
             ];
 
           if (accountPoint && poolPoint) {
@@ -577,6 +577,11 @@ export const getObligationAccount = async (
                   .toNumber()
               : 1;
 
+            // console.log({
+            //   availableClaimAmount: availableClaimAmount.toString(),
+            //   coinName: poolPoint.coinName,
+            //   coinType: poolPoint.coinType,
+            // });
             if (availableClaimAmount.isGreaterThanOrEqualTo(0)) {
               rewards.push({
                 coinName: poolPoint.coinName,

package/src/queries/supplyLimitQuery.ts

@@ -17,8 +17,8 @@ const supplyLimitZod = zod.object({
   }),
 });
 
-const supplyLimitKeyType = `0x6e641f0dca8aedab3101d047e96439178f16301bf0b57fe8745086ff1195eb3e::market_dynamic_keys::SupplyLimitKey`; // prod
-// const supplyLimitKeyType = `0x6c23585e940a989588432509107e98bae06dbca4e333f26d0635d401b3c7c76d::market_dynamic_keys::SupplyLimitKey`;
+// const supplyLimitKeyType = `0x6e641f0dca8aedab3101d047e96439178f16301bf0b57fe8745086ff1195eb3e::market_dynamic_keys::SupplyLimitKey`; // prod
+const supplyLimitKeyType = `0x6c23585e940a989588432509107e98bae06dbca4e333f26d0635d401b3c7c76d::market_dynamic_keys::SupplyLimitKey`;
 /**
  * Return supply limit of a pool (including the decimals)
  * @param utils

package/src/utils/query.ts

@@ -27,7 +27,6 @@ import type {
   ParsedBorrowIncentiveAccountPoolData,
   SupportBorrowIncentiveRewardCoins,
 } from '../types';
-import { sCoinRawNameToName } from 'src/constants';
 
 /**
  *  Parse origin market pool data to a more readable format.
@@ -424,6 +423,7 @@ export const parseOriginBorrowIncentivesPoolPointData = (
  * @return Parsed borrow incentive pool data
  */
 export const parseOriginBorrowIncentivePoolData = (
+  utils: ScallopUtils,
   originBorrowIncentivePoolData: OriginBorrowIncentivePoolData
 ): ParsedBorrowIncentivePoolData => {
   return {
@@ -434,12 +434,10 @@ export const parseOriginBorrowIncentivePoolData = (
     poolPoints: originBorrowIncentivePoolData.points.reduce(
       (acc, point) => {
         const parsed = parseOriginBorrowIncentivesPoolPointData(point);
-        let name = parseStructTag(
-          parsed.pointType
-        ).name.toLowerCase() as SupportBorrowIncentiveRewardCoins;
-        if (sCoinRawNameToName[name]) {
-          name = sCoinRawNameToName[name];
-        }
+        const name = utils.parseSCoinTypeNameToMarketCoinName(
+          parseStructTag(parsed.pointType).name.toLowerCase()
+        ) as SupportBorrowIncentiveRewardCoins;
+
         acc[name] = parsed;
         return acc;
       },

package/src/utils/tokenBucket.ts

@@ -42,7 +42,7 @@ const callWithRateLimit = async <T>(
   fn: () => Promise<T>,
   retryDelayInMs = DEFAULT_INTERVAL_IN_MS,
   maxRetries = 15,
-  backoffFactor = 2 // The factor by which to increase the delay
+  backoffFactor = 1.25 // The factor by which to increase the delay
 ): Promise<T | null> => {
   let retries = 0;