@scallop-io/sui-scallop-sdk 1.5.2 → 2.0.0-alpha.1

package/src/types/query/borrowIncentive.ts

@@ -1,8 +1,3 @@
-import type {
-  SupportBorrowIncentiveCoins,
-  SupportBorrowIncentiveRewardCoins,
-} from '../constant';
-
 export interface BorrowIncentiveAccountKey {
   id: string;
   onwerId: string;
@@ -13,12 +8,12 @@ type OptionalKeys<T> = {
 };
 
 export type BorrowIncentivePools = OptionalKeys<
-  Record<SupportBorrowIncentiveCoins, BorrowIncentivePool>
+  Record<string, BorrowIncentivePool>
 >;
 
 export type BorrowIncentivePoolPoints = {
   symbol: string;
-  coinName: SupportBorrowIncentiveRewardCoins;
+  coinName: string;
   coinType: string;
   coinDecimal: number;
   coinPrice: number;
@@ -31,7 +26,7 @@ export type BorrowIncentivePoolPoints = {
   CalculatedBorrowIncentivePoolPointData;
 
 export type BorrowIncentivePool = {
-  coinName: SupportBorrowIncentiveCoins;
+  coinName: string;
   symbol: string;
   coinType: string;
   coinDecimal: number;
@@ -39,9 +34,7 @@ export type BorrowIncentivePool = {
   stakedAmount: number;
   stakedCoin: number;
   stakedValue: number;
-  points: OptionalKeys<
-    Record<SupportBorrowIncentiveRewardCoins, BorrowIncentivePoolPoints>
-  >;
+  points: OptionalKeys<Record<string, BorrowIncentivePoolPoints>>;
 };
 
 export type OriginBorrowIncentivePoolPointData = {
@@ -85,12 +78,7 @@ export type ParsedBorrowIncentivePoolPointData = {
 
 export type ParsedBorrowIncentivePoolData = {
   poolType: string;
-  poolPoints: OptionalKeys<
-    Record<
-      SupportBorrowIncentiveRewardCoins,
-      ParsedBorrowIncentivePoolPointData
-    >
-  >;
+  poolPoints: OptionalKeys<Record<string, ParsedBorrowIncentivePoolPointData>>;
   minStakes: number;
   maxStakes: number;
   staked: number;
@@ -110,7 +98,7 @@ export type CalculatedBorrowIncentivePoolPointData = {
 };
 
 export type BorrowIncentiveAccounts = OptionalKeys<
-  Record<SupportBorrowIncentiveCoins, ParsedBorrowIncentiveAccountData>
+  Record<string, ParsedBorrowIncentiveAccountData>
 >;
 
 export type OriginBorrowIncentiveAccountPoolData = {
@@ -140,12 +128,7 @@ export type ParsedBorrowIncentiveAccountPoolData = {
 };
 
 export type ParsedBorrowIncentiveAccountData = {
-  pointList: OptionalKeys<
-    Record<
-      SupportBorrowIncentiveRewardCoins,
-      ParsedBorrowIncentiveAccountPoolData
-    >
-  >;
+  pointList: OptionalKeys<Record<string, ParsedBorrowIncentiveAccountPoolData>>;
   poolType: string;
   debtAmount: number;
 };

package/src/types/query/core.ts

@@ -1,25 +1,15 @@
-import type {
-  SupportPoolCoins,
-  SupportCollateralCoins,
-  SupportMarketCoins,
-  CoinWrappedType,
-  SupportSCoin,
-} from '../constant';
+import type { CoinWrappedType } from '../constant';
 
 type OptionalKeys<T> = {
   [K in keyof T]?: T[K];
 };
 
-export type MarketPools = OptionalKeys<Record<SupportPoolCoins, MarketPool>>;
-export type MarketCollaterals = OptionalKeys<
-  Record<SupportCollateralCoins, MarketCollateral>
->;
-export type CoinAmounts = OptionalKeys<Record<SupportPoolCoins, number>>;
-export type MarketCoinAmounts = OptionalKeys<
-  Record<SupportMarketCoins, number>
->;
+export type MarketPools = OptionalKeys<Record<string, MarketPool>>;
+export type MarketCollaterals = OptionalKeys<Record<string, MarketCollateral>>;
+export type CoinAmounts = OptionalKeys<Record<string, number>>;
+export type MarketCoinAmounts = OptionalKeys<Record<string, number>>;
 
-export type SCoinAmounts = OptionalKeys<Record<SupportSCoin, number>>;
+export type SCoinAmounts = OptionalKeys<Record<string, number>>;
 
 export type BalanceSheet = {
   cash: string;
@@ -123,7 +113,7 @@ export type RiskModel = {
 export type CollateralStat = { amount: string };
 
 export type MarketPool = {
-  coinName: SupportPoolCoins;
+  coinName: string;
   symbol: string;
   coinType: string;
   marketCoinType: string;
@@ -149,7 +139,7 @@ export type MarketPool = {
   CalculatedMarketPoolData;
 
 export type MarketCollateral = {
-  coinName: SupportCollateralCoins;
+  coinName: string;
   symbol: string;
   coinType: string;
   marketCoinType: string;

package/src/types/query/portfolio.ts

@@ -1,16 +1,11 @@
 import type { MarketPool } from './core';
 import type { Spool } from './spool';
-import type {
-  SupportPoolCoins,
-  SupportCollateralCoins,
-  SupportBorrowIncentiveRewardCoins,
-} from '../constant';
 
 type OptionalKeys<T> = {
   [K in keyof T]?: T[K];
 };
 
-export type Lendings = OptionalKeys<Record<SupportPoolCoins, Lending>>;
+export type Lendings = OptionalKeys<Record<string, Lending>>;
 export type ObligationAccounts = OptionalKeys<
   Record<string, ObligationAccount>
 >;
@@ -72,17 +67,13 @@ export type ObligationAccount = {
   totalDepositedPools: number;
   totalBorrowedPools: number;
   totalRewardedPools: number;
-  collaterals: OptionalKeys<
-    Record<SupportCollateralCoins, ObligationCollateral>
-  >;
-  debts: OptionalKeys<Record<SupportPoolCoins, ObligationDebt>>;
-  borrowIncentives: OptionalKeys<
-    Record<SupportPoolCoins, ObligationBorrowIncentive>
-  >;
+  collaterals: OptionalKeys<Record<string, ObligationCollateral>>;
+  debts: OptionalKeys<Record<string, ObligationDebt>>;
+  borrowIncentives: OptionalKeys<Record<string, ObligationBorrowIncentive>>;
 };
 
 export type ObligationCollateral = {
-  coinName: SupportCollateralCoins;
+  coinName: string;
   coinType: string;
   symbol: string;
   coinDecimal: number;
@@ -99,7 +90,7 @@ export type ObligationCollateral = {
 };
 
 export type ObligationDebt = {
-  coinName: SupportPoolCoins;
+  coinName: string;
   coinType: string;
   symbol: string;
   coinDecimal: number;
@@ -118,7 +109,7 @@ export type ObligationDebt = {
 };
 
 export type ObligationBorrowIcentiveReward = {
-  coinName: SupportBorrowIncentiveRewardCoins;
+  coinName: string;
   coinType: string;
   symbol: string;
   coinDecimal: number;
@@ -129,7 +120,7 @@ export type ObligationBorrowIcentiveReward = {
 };
 
 export type ObligationBorrowIncentive = {
-  coinName: SupportPoolCoins;
+  coinName: string;
   coinType: string;
   symbol: string;
   coinDecimal: number;

package/src/types/query/spool.ts

@@ -1,13 +1,11 @@
-import type { SupportStakeMarketCoins } from '../constant';
-
 type OptionalKeys<T> = {
   [K in keyof T]?: T[K];
 };
 
-export type Spools = OptionalKeys<Record<SupportStakeMarketCoins, Spool>>;
+export type Spools = OptionalKeys<Record<string, Spool>>;
 
 export type Spool = {
-  marketCoinName: SupportStakeMarketCoins;
+  marketCoinName: string;
   symbol: string;
   coinType: string;
   marketCoinType: string;
@@ -121,13 +119,9 @@ export type CalculatedSpoolRewardPoolData = {
   rewardPerSec: number;
 };
 
-export type StakePools = OptionalKeys<
-  Record<SupportStakeMarketCoins, StakePool>
->;
-export type StakeRewardPools = OptionalKeys<
-  Record<SupportStakeMarketCoins, StakeRewardPool>
->;
-export type StakeAccounts = Record<SupportStakeMarketCoins, StakeAccount[]>;
+export type StakePools = OptionalKeys<Record<string, StakePool>>;
+export type StakeRewardPools = OptionalKeys<Record<string, StakeRewardPool>>;
+export type StakeAccounts = Record<string, StakeAccount[]>;
 
 export interface StakeAccount {
   id: string;

package/src/types/utils.ts

@@ -1,25 +1,5 @@
-import type { SupportCoins } from './constant';
-
 export type OptionalKeys<T> = {
   [K in keyof T]?: T[K];
 };
 
-export type CoinPrices = OptionalKeys<Record<SupportCoins, number>>;
-
-export type PoolAddressInfo = {
-  name: string;
-  coingeckoId: string;
-  decimal: number;
-  pythFeedId: string;
-  lendingPoolAddress?: string;
-  collateralPoolAddress?: string; // not all pool has collateral
-  borrowDynamic?: string;
-  interestModelId?: string;
-  borrowFeeKey?: string;
-  supplyLimitKey?: string;
-  borrowLimitKey?: string;
-  isolatedAssetKey?: string;
-  sCoinAddress: string | undefined;
-  marketCoinAddress: string;
-  sCoinName: string | undefined;
-};
+export type CoinPrices = OptionalKeys<Record<string, number>>;

package/src/utils/core.ts

@@ -2,7 +2,7 @@ import { SuiObjectData } from '@mysten/sui/client';
 
 export const parseObjectAs = <T>(object: SuiObjectData): T => {
   if (!(object && object.content && 'fields' in object.content))
-    throw new Error(`Failed to parse object`);
+    throw new Error(`Failed to parse object ${object}`);
 
   const fields = object.content.fields as any;
 

package/src/utils/query.ts

@@ -18,14 +18,11 @@ import type {
   ParsedBorrowIncentivePoolData,
   OriginBorrowIncentiveAccountData,
   ParsedBorrowIncentiveAccountData,
-  SupportPoolCoins,
-  SupportCollateralCoins,
   OriginBorrowIncentivePoolPointData,
   ParsedBorrowIncentivePoolPointData,
   CalculatedBorrowIncentivePoolPointData,
   OriginBorrowIncentiveAccountPoolData,
   ParsedBorrowIncentiveAccountPoolData,
-  SupportBorrowIncentiveRewardCoins,
 } from '../types';
 
 /**
@@ -72,10 +69,13 @@ export const calculateMarketPoolData = (
   utils: ScallopUtils,
   parsedMarketPoolData: ParsedMarketPoolData
 ): CalculatedMarketPoolData => {
-  const poolCoinName = utils.parseCoinNameFromType<SupportPoolCoins>(
+  const poolCoinName = utils.parseCoinNameFromType(
     parsedMarketPoolData.coinType
   );
+
   const coinDecimal = utils.getCoinDecimal(poolCoinName);
+  if (coinDecimal === undefined)
+    throw new Error(`Coin decimal not found for ${poolCoinName}`);
 
   const borrowYearFactor = 24 * 365 * 3600;
 
@@ -210,11 +210,12 @@ export const calculateMarketCollateralData = (
   utils: ScallopUtils,
   parsedMarketCollateralData: ParsedMarketCollateralData
 ): CalculatedMarketCollateralData => {
-  const collateralCoinName =
-    utils.parseCoinNameFromType<SupportCollateralCoins>(
-      parsedMarketCollateralData.coinType
-    );
+  const collateralCoinName = utils.parseCoinNameFromType(
+    parsedMarketCollateralData.coinType
+  );
   const coinDecimal = utils.getCoinDecimal(collateralCoinName);
+  if (coinDecimal === undefined)
+    throw new Error(`Coin decimal not found for ${collateralCoinName}`);
 
   const maxCollateralCoin = BigNumber(
     parsedMarketCollateralData.maxCollateralAmount
@@ -448,17 +449,12 @@ export const parseOriginBorrowIncentivePoolData = (
     poolPoints: originBorrowIncentivePoolData.points.reduce(
       (acc, point) => {
         const parsed = parseOriginBorrowIncentivesPoolPointData(point);
-        const name = utils.parseSCoinTypeNameToMarketCoinName(
-          parseStructTag(parsed.pointType).name.toLowerCase()
-        ) as SupportBorrowIncentiveRewardCoins;
+        const name = utils.parseCoinNameFromType(parsed.pointType) as string;
 
         acc[name] = parsed;
         return acc;
       },
-      {} as Record<
-        SupportBorrowIncentiveRewardCoins,
-        ParsedBorrowIncentivePoolPointData
-      >
+      {} as Record<string, ParsedBorrowIncentivePoolPointData>
     ),
   };
 };
@@ -597,14 +593,11 @@ export const parseOriginBorrowIncentiveAccountData = (
         const parsed = parseOriginBorrowIncentiveAccountPoolPointData(point);
         const name = parseStructTag(
           parsed.pointType
-        ).name.toLowerCase() as SupportBorrowIncentiveRewardCoins;
+        ).name.toLowerCase() as string;
         acc[name] = parsed;
         return acc;
       },
-      {} as Record<
-        SupportBorrowIncentiveRewardCoins,
-        ParsedBorrowIncentiveAccountPoolData
-      >
+      {} as Record<string, ParsedBorrowIncentiveAccountPoolData>
     ),
   };
 };

package/src/utils/util.ts

@@ -1,85 +1,6 @@
 import type { PriceFeed } from '@pythnetwork/pyth-sui-js';
-import {
-  SUPPORT_POOLS,
-  SUPPORT_COLLATERALS,
-  SUPPORT_SPOOLS_REWARDS,
-  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,
-  SupportSCoin,
-  SupportSuiBridgeCoins,
-  SupportWormholeCoins,
-} from '../types';
-
-const COIN_SET = Array.from(
-  new Set([
-    ...SUPPORT_POOLS,
-    ...SUPPORT_COLLATERALS,
-    ...SUPPORT_SPOOLS_REWARDS,
-    ...SUPPORT_BORROW_INCENTIVE_REWARDS,
-    ...SUPPORT_SCOIN,
-  ])
-);
-
-export const isMarketCoin = (
-  coinName: SupportCoins
-): coinName is SupportMarketCoins | SupportSCoin => {
-  const assetCoinName = coinName.slice(1).toLowerCase() as SupportAssetCoins;
-  return (
-    coinName.charAt(0).toLowerCase() === 's' && COIN_SET.includes(assetCoinName)
-  );
-};
-
-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)) {
-    switch (coinName) {
-      case 'sbwbtc':
-        return 'sbwBTC';
-      default: {
-        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';
-    case 'hasui':
-      return 'haSUI';
-    case 'vsui':
-      return 'vSUI';
-    case 'musd':
-      return 'mUSD';
-    default:
-      return coinName.toUpperCase();
-  }
-};
+import { MAX_LOCK_DURATION } from 'src/constants';
+import { ScallopConstants } from 'src/models/scallopConstants';
 
 /**
  * Parse price from pyth price feed.
@@ -90,12 +11,13 @@ export const parseAssetSymbol = (coinName: SupportCoins): string => {
  */
 export const parseDataFromPythPriceFeed = (
   feed: PriceFeed,
-  address: ScallopAddress
+  constants: ScallopConstants
 ) => {
-  const assetCoinNames = COIN_SET as SupportAssetCoins[];
+  const assetCoinNames = [...constants.whitelist.lending] as string[];
   const assetCoinName = assetCoinNames.find((assetCoinName) => {
     return (
-      address.get(`core.coins.${assetCoinName}.oracle.pyth.feed`) === feed.id
+      constants.address.get(`core.coins.${assetCoinName}.oracle.pyth.feed`) ===
+      feed.id
     );
   });
   if (assetCoinName) {

package/src/constants/coinGecko.ts

@@ -1,34 +0,0 @@
-import { SupportPoolCoins } from 'src/types/constant/common';
-
-export const COIN_GECKGO_IDS: Record<SupportPoolCoins, string> = {
-  // Sui Bridge
-  sbeth: 'ethereum',
-  sbusdt: 'tether',
-  sbwbtc: 'bitcoin',
-  // Wormhole
-  weth: 'ethereum',
-  wbtc: 'bitcoin',
-  wusdc: 'usdc',
-  wusdt: 'tether',
-  wapt: 'aptos',
-  wsol: 'solana',
-  // Sui Native
-  usdc: 'usdc',
-  // Sui LST
-  sui: 'sui',
-  afsui: 'sui',
-  hasui: 'sui',
-  vsui: 'sui',
-  // Stable
-  fdusd: 'first-digital-usd',
-  // DeFi
-  cetus: 'cetus-protocol',
-  sca: 'scallop-2',
-  deep: 'deepbook',
-  // Isolated Asset
-  fud: 'fud-the-pug',
-  blub: 'blub',
-  musd: 'meta-usd',
-  ns: 'suins-token',
-  usdy: 'ondo-us-dollar-yield',
-};