@scallop-io/sui-scallop-sdk 1.3.0-alpha.1 → 1.3.0-alpha.3

package/src/models/scallopUtils.ts

@@ -17,6 +17,7 @@ import {
   MAX_LOCK_DURATION,
   SUPPORT_SCOIN,
   sCoinIds,
+  suiBridgeCoins,
 } from '../constants';
 import { getPythPrice, queryObligation } from '../queries';
 import {
@@ -24,6 +25,8 @@ import {
   isMarketCoin,
   parseAssetSymbol,
   findClosestUnlockRound,
+  isSuiBridgeAsset,
+  isWormholeAsset,
 } from '../utils';
 import { PYTH_ENDPOINTS } from 'src/constants/pyth';
 import { ScallopCache } from './scallopCache';
@@ -40,6 +43,8 @@ import type {
   CoinWrappedType,
   SupportSCoin,
   ScallopUtilsInstanceParams,
+  SupportSuiBridgeCoins,
+  SupportWormholeCoins,
 } from '../types';
 import type { SuiObjectArg, SuiTxArg, SuiTxBlock } from '@scallop-io/sui-kit';
 
@@ -96,6 +101,7 @@ export class ScallopUtils {
           {
             id: params?.addressesId || ADDRESSES_ID,
             network: params?.networkType,
+            forceInterface: params?.forceAddressesInterface,
           },
           {
             cache: this.cache,
@@ -106,6 +112,14 @@ export class ScallopUtils {
       ? params.networkType === 'testnet'
       : false;
   }
+  // -------------- TYPE GUARDS --------------
+  public isSuiBridgeAsset(coinName: any): coinName is SupportSuiBridgeCoins {
+    return isSuiBridgeAsset(coinName);
+  }
+
+  public isWormholeAsset(coinName: any): coinName is SupportWormholeCoins {
+    return isWormholeAsset(coinName);
+  }
 
   /**
    * Request the scallop API to initialize data.
@@ -128,16 +142,7 @@ export class ScallopUtils {
    * @return Symbol string.
    */
   public parseSymbol(coinName: SupportCoins) {
-    if (isMarketCoin(coinName)) {
-      const assetCoinName = coinName
-        .slice(1)
-        .toLowerCase() as SupportAssetCoins;
-      return (
-        coinName.slice(0, 1).toLowerCase() + parseAssetSymbol(assetCoinName)
-      );
-    } else {
-      return parseAssetSymbol(coinName);
-    }
+    return parseAssetSymbol(coinName);
   }
 
   /**
@@ -173,10 +178,23 @@ export class ScallopUtils {
     const voloPackageIds = [
       this.address.get('core.coins.vsui.id') ?? voloCoinIds.vsui,
     ];
+
+    const suiBridgePackageIds = Object.values<SupportSuiBridgeCoins>(
+      suiBridgeCoins
+    ).reduce((curr, coinName) => {
+      curr.push(
+        this.address.get(`core.coins.${coinName}.id`) ?? coinIds[coinName]
+      );
+      return curr;
+    }, [] as string[]);
     if (wormHolePackageIds.includes(coinPackageId)) {
       return `${coinPackageId}::coin::COIN`;
     } else if (voloPackageIds.includes(coinPackageId)) {
       return `${coinPackageId}::cert::CERT`;
+    } else if (suiBridgePackageIds.includes(coinPackageId)) {
+      // handle sui bridge assets
+      const typeCoinName = coinName.slice(2);
+      return `${coinPackageId}::${typeCoinName}::${typeCoinName.toUpperCase()}`;
     } else {
       return `${coinPackageId}::${coinName}::${coinName.toUpperCase()}`;
     }
@@ -299,9 +317,20 @@ export class ScallopUtils {
       }::cert::CERT`]: 'vsui',
     };
 
+    const suiBridgeTypeMap = Object.values<SupportSuiBridgeCoins>(
+      suiBridgeCoins
+    ).reduce(
+      (curr, coinName) => {
+        curr[this.parseCoinType(coinName)] = coinName;
+        return curr;
+      },
+      {} as Record<string, SupportSuiBridgeCoins>
+    );
+
     const assetCoinName =
       wormHoleCoinTypeMap[coinType] ||
       voloCoinTypeMap[coinType] ||
+      suiBridgeTypeMap[coinType] ||
       (coinType.split('::')[2].toLowerCase() as SupportAssetCoins);
 
     return isMarketCoinType
@@ -310,7 +339,7 @@ export class ScallopUtils {
   }
 
   /**
-   * Convert marke coin name to coin name.
+   * Convert market coin name to coin name.
    *
    * @param marketCoinName - Specific support market coin name.
    * @return Coin Name.
@@ -370,17 +399,19 @@ export class ScallopUtils {
    * return Coin wrapped type.
    */
   public getCoinWrappedType(assetCoinName: SupportAssetCoins): CoinWrappedType {
-    return assetCoinName === 'wusdc' ||
-      assetCoinName === 'wusdt' ||
-      assetCoinName === 'weth' ||
-      assetCoinName === 'wbtc' ||
-      assetCoinName === 'wapt' ||
-      assetCoinName === 'wsol'
-      ? {
-          from: 'Wormhole',
-          type: 'Portal from Ethereum',
-        }
-      : undefined;
+    if (this.isSuiBridgeAsset(assetCoinName)) {
+      return {
+        from: 'Sui Bridge',
+        type: 'Asset from Sui Bridge',
+      };
+    } else if (this.isWormholeAsset(assetCoinName)) {
+      return {
+        from: 'Wormhole',
+        type: 'Portal from Ethereum',
+      };
+    }
+
+    return undefined;
   }
 
   /**
@@ -429,7 +460,7 @@ export class ScallopUtils {
       if (existingCoins.length > 0) {
         txBlock.mergeCoins(dest, existingCoins.slice(0, 500));
       }
-    } catch (e) {
+    } catch (_e) {
       // ignore
     }
   }

package/src/queries/coreQuery.ts

@@ -324,7 +324,6 @@ export const getMarketPool = async (
     if (marketObject.content && 'fields' in marketObject.content) {
       const fields = marketObject.content.fields as any;
       const coinType = query.utils.parseCoinType(poolCoinName);
-
       // Get balance sheet.
       const balanceSheetParentId =
         fields.vault.fields.balance_sheets.fields.table.fields.id.id;

package/src/queries/spoolQuery.ts

@@ -272,18 +272,13 @@ export const getStakeAccounts = async (
     }
   } while (hasNextPage);
 
-  const stakeAccounts: StakeAccounts = {
-    susdc: [],
-    sweth: [],
-    ssui: [],
-    swusdc: [],
-    swusdt: [],
-    scetus: [],
-    safsui: [],
-    shasui: [],
-    svsui: [],
-    // ssca: [],
-  };
+  const stakeAccounts: StakeAccounts = SUPPORT_SPOOLS.reduce(
+    (acc, stakeName) => {
+      acc[stakeName] = [];
+      return acc;
+    },
+    {} as StakeAccounts
+  );
 
   const stakeMarketCoinTypes: Record<SupportStakeMarketCoins, string> =
     Object.keys(stakeAccounts).reduce(
@@ -299,6 +294,16 @@ export const getStakeAccounts = async (
       {} as Record<SupportStakeMarketCoins, string>
     );
 
+  // Reverse the mapping
+  const reversedStakeMarketCoinTypes: Record<string, SupportStakeMarketCoins> =
+    Object.entries(stakeMarketCoinTypes).reduce(
+      (reversedTypes, [key, value]) => {
+        reversedTypes[value] = key as SupportStakeMarketCoins;
+        return reversedTypes;
+      },
+      {} as Record<string, SupportStakeMarketCoins>
+    );
+
   const stakeObjectIds: string[] = stakeObjectsResponse
     .map((ref: any) => ref?.data?.objectId)
     .filter((id: any) => id !== undefined);
@@ -317,98 +322,30 @@ export const getStakeAccounts = async (
       const index = Number(fields.index);
       const points = Number(fields.points);
       const totalPoints = Number(fields.total_points);
-      if (normalizeStructTag(type) === stakeMarketCoinTypes.sweth) {
-        stakeAccounts.sweth.push({
-          id,
-          type: normalizeStructTag(type),
-          stakePoolId,
-          stakeType: normalizeStructTag(stakeType),
-          staked,
-          index,
-          points,
-          totalPoints,
-        });
-      } else if (normalizeStructTag(type) === stakeMarketCoinTypes.ssui) {
-        stakeAccounts.ssui.push({
-          id,
-          type: normalizeStructTag(type),
-          stakePoolId,
-          stakeType: normalizeStructTag(stakeType),
-          staked,
-          index,
-          points,
-          totalPoints,
-        });
-      } else if (normalizeStructTag(type) === stakeMarketCoinTypes.swusdc) {
-        stakeAccounts.swusdc.push({
-          id,
-          type: normalizeStructTag(type),
-          stakePoolId,
-          stakeType: normalizeStructTag(stakeType),
-          staked,
-          index,
-          points,
-          totalPoints,
-        });
-      } else if (normalizeStructTag(type) === stakeMarketCoinTypes.swusdt) {
-        stakeAccounts.swusdt.push({
-          id,
-          type: normalizeStructTag(type),
-          stakePoolId,
-          stakeType: normalizeStructTag(stakeType),
-          staked,
-          index,
-          points,
-          totalPoints,
-        });
-      } else if (normalizeStructTag(type) === stakeMarketCoinTypes.scetus) {
-        stakeAccounts.scetus.push({
-          id,
-          type: normalizeStructTag(type),
-          stakePoolId,
-          stakeType: normalizeStructTag(stakeType),
-          staked,
-          index,
-          points,
-          totalPoints,
-        });
-      } else if (normalizeStructTag(type) === stakeMarketCoinTypes.safsui) {
-        stakeAccounts.safsui.push({
-          id,
-          type: normalizeStructTag(type),
-          stakePoolId,
-          stakeType: normalizeStructTag(stakeType),
-          staked,
-          index,
-          points,
-          totalPoints,
-        });
-      } else if (normalizeStructTag(type) === stakeMarketCoinTypes.shasui) {
-        stakeAccounts.shasui.push({
-          id,
-          type: normalizeStructTag(type),
-          stakePoolId,
-          stakeType: normalizeStructTag(stakeType),
-          staked,
-          index,
-          points,
-          totalPoints,
-        });
-      } else if (normalizeStructTag(type) === stakeMarketCoinTypes.svsui) {
-        stakeAccounts.svsui.push({
-          id,
-          type: normalizeStructTag(type),
-          stakePoolId,
-          stakeType: normalizeStructTag(stakeType),
-          staked,
-          index,
-          points,
-          totalPoints,
-        });
-      } else if (normalizeStructTag(type) === stakeMarketCoinTypes.susdc) {
-        stakeAccounts.susdc.push({
+
+      const stakeMarketCoinTypeMap: Record<
+        SupportStakeMarketCoins,
+        StakeAccounts[SupportStakeMarketCoins]
+      > = {
+        sweth: stakeAccounts.sweth,
+        ssui: stakeAccounts.ssui,
+        swusdc: stakeAccounts.swusdc,
+        swusdt: stakeAccounts.swusdt,
+        scetus: stakeAccounts.scetus,
+        safsui: stakeAccounts.safsui,
+        shasui: stakeAccounts.shasui,
+        svsui: stakeAccounts.svsui,
+        susdc: stakeAccounts.susdc,
+      };
+
+      const normalizedType = normalizeStructTag(type);
+      const stakeAccountArray =
+        stakeMarketCoinTypeMap[reversedStakeMarketCoinTypes[normalizedType]];
+
+      if (stakeAccountArray) {
+        stakeAccountArray.push({
           id,
-          type: normalizeStructTag(type),
+          type: normalizedType,
           stakePoolId,
           stakeType: normalizeStructTag(stakeType),
           staked,

package/src/queries/vescaQuery.ts

@@ -71,7 +71,8 @@ export const getVeScas = async (
   }: {
     utils: ScallopUtils;
   },
-  ownerAddress?: string
+  ownerAddress?: string,
+  excludeEmpty?: boolean
 ) => {
   const keyObjectDatas = await getVescaKeys(utils, ownerAddress);
 
@@ -84,9 +85,14 @@ export const getVeScas = async (
   });
   await Promise.allSettled(tasks);
 
-  return veScas
+  const result = veScas
     .filter(Boolean)
     .sort((a, b) => b!.currentVeScaBalance - a!.currentVeScaBalance);
+
+  if (excludeEmpty) {
+    return result.filter((v) => v.lockedScaAmount !== '0');
+  }
+  return result;
 };
 
 const SuiObjectRefZod = zod.object({

package/src/types/constant/common.ts

@@ -8,6 +8,8 @@ import {
   SUPPORT_BORROW_INCENTIVE_POOLS,
   SUPPORT_BORROW_INCENTIVE_REWARDS,
   SUPPORT_SCOIN,
+  SUPPORT_SUI_BRIDGE,
+  SUPPORT_WORMHOLE,
 } from '../../constants';
 
 type ParseMarketCoins<T extends string> = `s${T}`;
@@ -29,6 +31,8 @@ export type SupportMarketCoins =
   | ParseMarketCoins<SupportPoolCoins>
   | SupportStakeMarketCoins;
 export type SupportStakeMarketCoins = (typeof SUPPORT_SPOOLS)[number];
+export type SupportSuiBridgeCoins = (typeof SUPPORT_SUI_BRIDGE)[number];
+export type SupportWormholeCoins = (typeof SUPPORT_WORMHOLE)[number];
 export type SupportStakeCoins = Extract<
   SupportPoolCoins,
   ParseCoins<SupportStakeMarketCoins>

package/src/types/constant/enum.ts

@@ -7,6 +7,7 @@ import {
   SupportBorrowIncentiveCoins,
   SupportBorrowIncentiveRewardCoins,
   SupportSCoin,
+  SupportSuiBridgeCoins,
 } from './common';
 
 export type Coins = {
@@ -33,6 +34,10 @@ export type StakeRewardCoins = {
   [key in SupportStakeMarketCoins]: SupportStakeRewardCoins;
 };
 
+export type SuiBridgeCoins = {
+  [K in SupportSuiBridgeCoins]: K;
+};
+
 export type BorrowIncentiveRewardCoins = {
   [key in SupportBorrowIncentiveCoins]: SupportBorrowIncentiveRewardCoins[];
 };
@@ -65,3 +70,7 @@ export type WormholeCoinIds = {
 export type VoloCoinIds = {
   [key in PickFromUnion<SupportAssetCoins, 'vsui'>]: string;
 };
+
+export type SuiBridgedCoinPackageIds = {
+  [key in SupportSuiBridgeCoins]: string;
+};

package/src/types/model.ts

@@ -9,6 +9,7 @@ import type {
   ScallopIndexer,
 } from '../models';
 import { ScallopCache } from 'src/models/scallopCache';
+import { AddressesInterface } from './address';
 
 export type ScallopClientFnReturnType<T extends boolean> = T extends true
   ? SuiTransactionBlockResponse
@@ -56,10 +57,12 @@ export type ScallopAddressParams = {
   id: string;
   auth?: string;
   network?: NetworkType;
+  forceInterface?: Partial<Record<NetworkType, AddressesInterface>>;
 };
 
 export type ScallopParams = {
   addressesId?: string;
+  forceAddressesInterface?: Partial<Record<NetworkType, AddressesInterface>>;
   walletAddress?: string;
 } & SuiKitParams;
 

package/src/utils/index.ts

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

package/src/utils/indexer.ts

@@ -0,0 +1,39 @@
+/**
+ * Generic wrapper for methods with indexer fallback.
+ *
+ * @param method - The method to call with fallback behavior.
+ * @param context - The context (`this`) of the class instance.
+ * @param args - The arguments to pass to the method.
+ * @returns The result of the method call.
+ */
+export async function callMethodWithIndexerFallback(
+  method: Function,
+  context: any,
+  ...args: any[]
+) {
+  const indexer = args[args.length - 1]; // Assume last argument is always `indexer`
+
+  if (indexer) {
+    try {
+      return await method.apply(context, args);
+    } catch (_e) {
+      console.warn('Indexer requests failed. Retrying without indexer..');
+      return await method.apply(context, [...args.slice(0, -1), false]);
+    }
+  }
+  return await method.apply(context, args);
+}
+
+/**
+ * This function creates a wrapper for methods that have an indexer parameter.
+ * It ensures fallback behavior if indexer fails.
+ *
+ * @param method - The method to wrap.
+ * @returns A function that applies indexer fallback.
+ */
+export function withIndexerFallback(method: Function) {
+  return (...args: any[]) => {
+    // @ts-ignore
+    return callMethodWithIndexerFallback(method, this, ...args); // Preserve `this` with arrow function
+  };
+}

package/src/utils/util.ts

@@ -6,12 +6,16 @@ import {
   MAX_LOCK_DURATION,
   SUPPORT_BORROW_INCENTIVE_REWARDS,
   SUPPORT_SCOIN,
+  SUPPORT_SUI_BRIDGE,
+  SUPPORT_WORMHOLE,
 } from '../constants';
 import type { ScallopAddress } from '../models';
 import type {
   SupportAssetCoins,
   SupportCoins,
   SupportMarketCoins,
+  SupportSuiBridgeCoins,
+  SupportWormholeCoins,
 } from '../types';
 
 const COIN_SET = Array.from(
@@ -33,11 +37,29 @@ export const isMarketCoin = (
   );
 };
 
-export const parseAssetSymbol = (coinName: SupportAssetCoins): string => {
-  const isWormhole = coinName.charAt(0) === 'w';
-  if (isWormhole) {
+export const isSuiBridgeAsset = (
+  coinName: any
+): coinName is SupportSuiBridgeCoins => {
+  return SUPPORT_SUI_BRIDGE.includes(coinName);
+};
+
+export const isWormholeAsset = (
+  coinName: any
+): coinName is SupportWormholeCoins => {
+  return SUPPORT_WORMHOLE.includes(coinName);
+};
+
+export const parseAssetSymbol = (coinName: SupportCoins): string => {
+  if (isWormholeAsset(coinName)) {
     return `w${coinName.slice(1).toUpperCase()}`;
   }
+  if (isSuiBridgeAsset(coinName)) {
+    return `sb${coinName.slice(2).toUpperCase()}`;
+  }
+  if (isMarketCoin(coinName)) {
+    const assetCoinName = coinName.slice(1).toLowerCase() as SupportAssetCoins;
+    return coinName.slice(0, 1).toLowerCase() + parseAssetSymbol(assetCoinName);
+  }
   switch (coinName) {
     case 'afsui':
       return 'afSUI';