@scallop-io/sui-scallop-sdk 1.5.3 → 2.0.0-alpha.2

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',
-};

package/src/constants/enum.ts

@@ -1,268 +0,0 @@
-import type * as types from '../types';
-import { IS_VE_SCA_TEST } from './common';
-
-export const coinDecimals: types.SupportCoinDecimals = {
-  usdc: 6,
-  sbeth: 8,
-  sbusdt: 6,
-  sbwbtc: 8,
-  weth: 8,
-  wbtc: 8,
-  wusdc: 6,
-  wusdt: 6,
-  sui: 9,
-  wapt: 8,
-  wsol: 8,
-  cetus: 9,
-  afsui: 9,
-  hasui: 9,
-  vsui: 9,
-  sca: 9,
-  fdusd: 6,
-  deep: 6,
-  fud: 5,
-  blub: 2,
-  musd: 9,
-  ns: 6,
-  usdy: 6,
-  susdc: 6,
-  sweth: 8,
-  ssbeth: 8,
-  ssbusdt: 6,
-  ssbwbtc: 8,
-  swbtc: 8,
-  swusdc: 6,
-  swusdt: 6,
-  ssui: 9,
-  swapt: 8,
-  swsol: 8,
-  scetus: 9,
-  safsui: 9,
-  shasui: 9,
-  svsui: 9,
-  ssca: 9,
-  sfdusd: 6,
-  sdeep: 6,
-  sfud: 5,
-  sblub: 2,
-  smusd: 9,
-  sns: 6,
-  susdy: 6,
-};
-
-export const assetCoins: types.AssetCoins = {
-  usdc: 'usdc',
-  sbeth: 'sbeth',
-  sbusdt: 'sbusdt',
-  sbwbtc: 'sbwbtc',
-  weth: 'weth',
-  wbtc: 'wbtc',
-  wusdc: 'wusdc',
-  wusdt: 'wusdt',
-  sui: 'sui',
-  wapt: 'wapt',
-  wsol: 'wsol',
-  cetus: 'cetus',
-  afsui: 'afsui',
-  hasui: 'hasui',
-  vsui: 'vsui',
-  sca: 'sca',
-  fdusd: 'fdusd',
-  deep: 'deep',
-  fud: 'fud',
-  blub: 'blub',
-  musd: 'musd',
-  ns: 'ns',
-  usdy: 'usdy',
-};
-
-export const marketCoins: types.MarketCoins = {
-  susdc: 'susdc',
-  ssbeth: 'ssbeth',
-  ssbusdt: 'ssbusdt',
-  ssbwbtc: 'ssbwbtc',
-  sweth: 'sweth',
-  swbtc: 'swbtc',
-  swusdc: 'swusdc',
-  swusdt: 'swusdt',
-  ssui: 'ssui',
-  swapt: 'swapt',
-  swsol: 'swsol',
-  scetus: 'scetus',
-  safsui: 'safsui',
-  shasui: 'shasui',
-  svsui: 'svsui',
-  ssca: 'ssca',
-  sfdusd: 'sfdusd',
-  sdeep: 'sdeep',
-  sfud: 'sfud',
-  sblub: 'sblub',
-  smusd: 'smusd',
-  sns: 'sns',
-  susdy: 'susdy',
-};
-
-export const sCoins: types.SCoins = {
-  susdc: 'susdc',
-  ssbeth: 'ssbeth',
-  ssbusdt: 'ssbusdt',
-  sweth: 'sweth',
-  swusdc: 'swusdc',
-  swusdt: 'swusdt',
-  ssbwbtc: 'ssbwbtc',
-  ssui: 'ssui',
-  scetus: 'scetus',
-  safsui: 'safsui',
-  shasui: 'shasui',
-  svsui: 'svsui',
-  ssca: 'ssca',
-  swsol: 'swsol',
-  swbtc: 'swbtc',
-  sfdusd: 'sfdusd',
-  sfud: 'sfud',
-  sdeep: 'sdeep',
-  sblub: 'sblub',
-  smusd: 'smusd',
-  sns: 'sns',
-  susdy: 'susdy',
-};
-
-export const stakeMarketCoins: types.StakeMarketCoins = {
-  susdc: 'susdc',
-  sweth: 'sweth',
-  ssui: 'ssui',
-  swusdc: 'swusdc',
-  swusdt: 'swusdt',
-  scetus: 'scetus',
-  safsui: 'safsui',
-  shasui: 'shasui',
-  svsui: 'svsui',
-};
-
-export const spoolRewardCoins: types.StakeRewardCoins = {
-  sweth: 'sui',
-  ssui: 'sui',
-  swusdc: 'sui',
-  swusdt: 'sui',
-  scetus: 'sui',
-  safsui: 'sui',
-  shasui: 'sui',
-  svsui: 'sui',
-  susdc: 'sui',
-};
-
-export const suiBridgeCoins: types.SuiBridgeCoins = {
-  sbeth: 'sbeth',
-  sbusdt: 'sbusdt',
-  sbwbtc: 'sbwbtc',
-};
-
-export const coinIds: types.AssetCoinIds = {
-  sui: '0x0000000000000000000000000000000000000000000000000000000000000002',
-  cetus: '0x06864a6f921804860930db6ddbe2e16acdf8504495ea7481637a1c8b9a8fe54b',
-  sca: IS_VE_SCA_TEST
-    ? '0x6cd813061a3adf3602b76545f076205f0c8e7ec1d3b1eab9a1da7992c18c0524'
-    : '0x7016aae72cfc67f2fadf55769c0a7dd54291a583b63051a5ed71081cce836ac6',
-  musd: '0xe44df51c0b21a27ab915fa1fe2ca610cd3eaa6d9666fe5e62b988bf7f0bd8722',
-  ns: '0x5145494a5f5100e645e4b0aa950fa6b68f614e8c59e17bc5ded3495123a79178',
-  // Wormhole assets
-  weth: '0xaf8cd5edc19c4512f4259f0bee101a40d41ebed738ade5874359610ef8eeced5',
-  wbtc: '0x027792d9fed7f9844eb4839566001bb6f6cb4804f66aa2da6fe1ee242d896881',
-  wapt: '0x3a5143bb1196e3bcdfab6203d1683ae29edd26294fc8bfeafe4aaa9d2704df37',
-  wsol: '0xb7844e289a8410e50fb3ca48d69eb9cf29e27d223ef90353fe1bd8e27ff8f3f8',
-  // Sui LST
-  afsui: '0xf325ce1300e8dac124071d3152c5c5ee6174914f8bc2161e88329cf579246efc',
-  hasui: '0xbde4ba4c2e274a60ce15c1cfff9e5c42e41654ac8b6d906a57efa4bd3c29f47d',
-  vsui: '0x549e8b69270defbfafd4f94e17ec44cdbdd99820b33bda2278dea3b9a32d3f55',
-  // stable coins
-  usdc: '0xdba34672e30cb065b1f93e3ab55318768fd6fef66c15942c9f7cb846e2f900e7',
-  wusdc: '0x5d4b302506645c37ff133b98c4b50a5ae14841659738d6d733d59d0d217a93bf',
-  wusdt: '0xc060006111016b8a020ad5b33834984a437aaa7d3c74c18e09a95d48aceab08c',
-  fdusd: '0xf16e6b723f242ec745dfd7634ad072c42d5c1d9ac9d62a39c381303eaa57693a',
-  usdy: '0x960b531667636f39e85867775f52f6b1f220a058c4de786905bdf761e06a56bb',
-  // isolated assets
-  deep: '0xdeeb7a4662eec9f2f3def03fb937a663dddaa2e215b8078a284d026b7946c270',
-  fud: '0x76cb819b01abed502bee8a702b4c2d547532c12f25001c9dea795a5e631c26f1',
-  blub: '0xfa7ac3951fdca92c5200d468d31a365eb03b2be9936fde615e69f0c1274ad3a0',
-  // Sui bridge assets
-  sbeth: '0xd0e89b2af5e4910726fbcd8b8dd37bb79b29e5f83f7491bca830e94f7f226d29',
-  sbusdt: '0x375f70cf2ae4c00bf37117d0c85a2c71545e6ee05c4a5c7d282cd66a4504b068',
-  sbwbtc: '0xaafb102dd0902f5055cadecd687fb5b71ca82ef0e0285d90afde828ec58ca96b',
-};
-
-export const wormholeCoinIds: types.WormholeCoinIds = {
-  weth: '0xaf8cd5edc19c4512f4259f0bee101a40d41ebed738ade5874359610ef8eeced5',
-  wbtc: '0x027792d9fed7f9844eb4839566001bb6f6cb4804f66aa2da6fe1ee242d896881',
-  wusdc: '0x5d4b302506645c37ff133b98c4b50a5ae14841659738d6d733d59d0d217a93bf',
-  wusdt: '0xc060006111016b8a020ad5b33834984a437aaa7d3c74c18e09a95d48aceab08c',
-  wapt: '0x3a5143bb1196e3bcdfab6203d1683ae29edd26294fc8bfeafe4aaa9d2704df37',
-  wsol: '0xb7844e289a8410e50fb3ca48d69eb9cf29e27d223ef90353fe1bd8e27ff8f3f8',
-};
-
-export const voloCoinIds: types.VoloCoinIds = {
-  vsui: '0x549e8b69270defbfafd4f94e17ec44cdbdd99820b33bda2278dea3b9a32d3f55',
-};
-
-export const sCoinIds: types.SCoinIds = {
-  ssui: '0xaafc4f740de0dd0dde642a31148fb94517087052f19afb0f7bed1dc41a50c77b::scallop_sui::SCALLOP_SUI',
-  ssca: '0x5ca17430c1d046fae9edeaa8fd76c7b4193a00d764a0ecfa9418d733ad27bc1e::scallop_sca::SCALLOP_SCA',
-  scetus:
-    '0xea346ce428f91ab007210443efcea5f5cdbbb3aae7e9affc0ca93f9203c31f0c::scallop_cetus::SCALLOP_CETUS',
-  smusd:
-    '0x0a228d1c59071eccf3716076a1f71216846ee256d9fb07ea11fb7c1eb56435a5::scallop_musd::SCALLOP_MUSD',
-  sns: '0x6511052d2f1404934e0d877709949bcda7c1d451d1218a4b2643ca2f3fa93991::scallop_ns::SCALLOP_NS',
-  // Wormhole assets
-  sweth:
-    '0x67540ceb850d418679e69f1fb6b2093d6df78a2a699ffc733f7646096d552e9b::scallop_wormhole_eth::SCALLOP_WORMHOLE_ETH',
-  swsol:
-    '0x1392650f2eca9e3f6ffae3ff89e42a3590d7102b80e2b430f674730bc30d3259::scallop_wormhole_sol::SCALLOP_WORMHOLE_SOL',
-  swbtc:
-    '0x2cf76a9cf5d3337961d1154283234f94da2dcff18544dfe5cbdef65f319591b5::scallop_wormhole_btc::SCALLOP_WORMHOLE_BTC',
-  // Sui LST
-  safsui:
-    '0x00671b1fa2a124f5be8bdae8b91ee711462c5d9e31bda232e70fd9607b523c88::scallop_af_sui::SCALLOP_AF_SUI',
-  shasui:
-    '0x9a2376943f7d22f88087c259c5889925f332ca4347e669dc37d54c2bf651af3c::scallop_ha_sui::SCALLOP_HA_SUI',
-  svsui:
-    '0xe1a1cc6bcf0001a015eab84bcc6713393ce20535f55b8b6f35c142e057a25fbe::scallop_v_sui::SCALLOP_V_SUI',
-  // stable coins
-  susdc:
-    '0x854950aa624b1df59fe64e630b2ba7c550642e9342267a33061d59fb31582da5::scallop_usdc::SCALLOP_USDC',
-  swusdc:
-    '0xad4d71551d31092230db1fd482008ea42867dbf27b286e9c70a79d2a6191d58d::scallop_wormhole_usdc::SCALLOP_WORMHOLE_USDC',
-  swusdt:
-    '0xe6e5a012ec20a49a3d1d57bd2b67140b96cd4d3400b9d79e541f7bdbab661f95::scallop_wormhole_usdt::SCALLOP_WORMHOLE_USDT',
-  sfdusd:
-    '0x6711551c1e7652a270d9fbf0eee25d99594c157cde3cb5fbb49035eb59b1b001::scallop_fdusd::SCALLOP_FDUSD',
-  susdy:
-    '0xd285cbbf54c87fd93cd15227547467bb3e405da8bbf2ab99f83f323f88ac9a65::scallop_usdy::SCALLOP_USDY',
-  // isolated assets
-  sdeep:
-    '0xeb7a05a3224837c5e5503575aed0be73c091d1ce5e43aa3c3e716e0ae614608f::scallop_deep::SCALLOP_DEEP',
-  sfud: '0xe56d5167f427cbe597da9e8150ef5c337839aaf46891d62468dcf80bdd8e10d1::scallop_fud::SCALLOP_FUD',
-  sblub:
-    '0xe72f65446eabfad2103037af2d49d24599106fb44bf4c046c1e7e9acf6844dd0::scallop_blub::SCALLOP_BLUB',
-  // Sui bridge assets
-  ssbeth:
-    '0xb14f82d8506d139eacef109688d1b71e7236bcce9b2c0ad526abcd6aa5be7de0::scallop_sb_eth::SCALLOP_SB_ETH',
-  ssbusdt:
-    '0xb1d7df34829d1513b73ba17cb7ad90c88d1e104bb65ab8f62f13e0cc103783d3::scallop_sb_usdt::SCALLOP_SB_USDT',
-  ssbwbtc:
-    '0x08c0fe357d3a138f4552bee393ce3a28a45bebcca43373d6a90bc44ab76f82e2::scallop_sb_wbtc::SCALLOP_SB_WBTC',
-} as const;
-
-export const sCoinTypeToName = Object.entries(sCoinIds).reduce(
-  (acc, [coinName, coinType]) => {
-    acc[coinType] = coinName as types.SupportSCoin;
-    return acc;
-  },
-  {} as Record<string, types.SupportSCoin>
-);
-
-export const sCoinRawNameToName = Object.entries(sCoinIds).reduce(
-  (acc, [coinName, coinType]) => {
-    acc[coinType.split('::')[2].toLowerCase()] = coinName as types.SupportSCoin;
-    return acc;
-  },
-  {} as Record<string, types.SupportSCoin>
-);

package/src/constants/flashloan.ts

@@ -1,18 +0,0 @@
-import { OptionalKeys, SupportPoolCoins } from 'src/types';
-
-export const FlashLoanFeeObjectMap: OptionalKeys<
-  Record<SupportPoolCoins, string>
-> = {
-  vsui: '0x0069cddee7a5c0b1d34beb5ef0620f978096525f1830b055f38b110f40d73fbb',
-  wbtc: '0x2078490aa37d8fb42b511e5c95e217cb957d141267e16980bc802d76b42719f7',
-  sui: '0x27614284a8f0a699ffd35aae8f2572c937ec76771cb21b0d7930ec4491a76ed4',
-  wusdt: '0x5b61983a19b5159ca348d291e4b595f42db70ccda32852a2ed85528aa65171e4',
-  wapt: '0x9d5898edcd1e4abcb044273242293a9d036f6a977bf3fe57ab71f5a87c505ee6',
-  afsui: '0xac87fde83d434554ec300c1334c9a622aa5b59e82a04334dc99e1cc1f75d4eae',
-  hasui: '0xb9f505d532de1d6c9f3a8522a2d16f2958b75c0ed939d4f80b96f584a2a8ed5e',
-  wusdc: '0xd241d6a7e44ac11a6689370ed9a98eec389b98b8a6695c61fddede9fa7567b90',
-  weth: '0xd252acb058e77877810c1290564e290a8f9fcab5bc9aca2884ede8a38810cf34',
-  sca: '0xe04e46471754b6f48d81c549ecfec09de02733715a63bec02364c6ac7c4dd2dc',
-  cetus: '0xe65a73d11c31b2d323ad2b9f6b4bb0a3c0df9c1b212eef66c854941186a5ddc7',
-  wsol: '0xe84bdb35b790fc7bdd1645122ac6ac0fc904531d6772c9e25904fece322c5f34',
-};