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

package/src/types/builder/spool.ts

@@ -5,7 +5,6 @@ import type {
 } from '@scallop-io/sui-kit';
 import type { TransactionResult } from '@mysten/sui/transactions';
 import type { ScallopBuilder } from '../../models';
-import type { SupportStakeMarketCoins } from '../constant';
 import { SuiTxBlockWithSCoin } from '.';
 
 export type SpoolIds = {
@@ -13,39 +12,37 @@ export type SpoolIds = {
 };
 
 export type SpoolNormalMethods = {
-  createStakeAccount: (
-    stakeMarketCoinName: SupportStakeMarketCoins
-  ) => TransactionResult;
+  createStakeAccount: (stakeMarketCoinName: string) => TransactionResult;
   stake: (
     stakeAccount: SuiAddressArg,
     coin: SuiObjectArg,
-    stakeMarketCoinName: SupportStakeMarketCoins
+    stakeMarketCoinName: string
   ) => void;
   unstake: (
     stakeAccount: SuiAddressArg,
     amount: number,
-    stakeMarketCoinName: SupportStakeMarketCoins
+    stakeMarketCoinName: string
   ) => TransactionResult;
   claim: (
     stakeAccount: SuiAddressArg,
-    stakeMarketCoinName: SupportStakeMarketCoins
+    stakeMarketCoinName: string
   ) => TransactionResult;
 };
 
 export type SpoolQuickMethods = {
   stakeQuick(
     amountOrMarketCoin: SuiObjectArg | number,
-    stakeMarketCoinName: SupportStakeMarketCoins,
+    stakeMarketCoinName: string,
     stakeAccountId?: SuiAddressArg
   ): Promise<void>;
   unstakeQuick(
     amount: number,
-    stakeMarketCoinName: SupportStakeMarketCoins,
+    stakeMarketCoinName: string,
     stakeAccountId?: SuiAddressArg,
     returnSCoin?: boolean
   ): Promise<TransactionResult | undefined>;
   claimQuick(
-    stakeMarketCoinName: SupportStakeMarketCoins,
+    stakeMarketCoinName: string,
     stakeAccountId?: SuiAddressArg
   ): Promise<TransactionResult[]>;
 };

package/src/types/constant/common.ts

@@ -1,53 +1,47 @@
-import {
-  SUPPORT_POOLS,
-  SUPPORT_COLLATERALS,
-  SUPPORT_ORACLES,
-  SUPPORT_PACKAGES,
-  SUPPORT_SPOOLS,
-  SUPPORT_SPOOLS_REWARDS,
-  SUPPORT_BORROW_INCENTIVE_POOLS,
-  SUPPORT_BORROW_INCENTIVE_REWARDS,
-  SUPPORT_SCOIN,
-  SUPPORT_SUI_BRIDGE,
-  SUPPORT_WORMHOLE,
-} from '../../constants';
+export type PoolAddress = {
+  coinName: string;
+  symbol: string;
+  coinType: string;
+  coinMetadataId: string;
+  decimals: number;
+  // optional keys
+  pythFeed?: string;
+  pythFeedObjectId?: string;
+  lendingPoolAddress?: string;
+  borrowDynamic?: string;
+  interestModel?: string;
+  borrowFeeKey?: string;
+  flashloanFeeObject?: string;
+  coinGeckoId?: string;
+  collateralPoolAddress?: string; // not all pool has collateral
+  riskModel?: string;
+  supplyLimitKey?: string;
+  borrowLimitKey?: string;
+  sCoinType?: string;
+  sCoinName?: string;
+  sCoinSymbol?: string;
+  sCoinMetadataId?: string;
+  sCoinTreasury?: string;
+  isolatedAssetKey?: string;
+  spool?: string;
+  spoolReward?: string;
+  spoolName?: string;
+};
 
-type ParseMarketCoins<T extends string> = `s${T}`;
-type ParseCoins<T extends string> = T extends `s${infer R}` ? R : never;
-
-export type SupportCoins =
-  | SupportAssetCoins
-  | SupportMarketCoins
-  | SupportStakeMarketCoins
-  | SupportSCoin;
-export type SupportAssetCoins =
-  | SupportPoolCoins
-  | SupportCollateralCoins
-  | SupportStakeRewardCoins;
-export type SupportPoolCoins = (typeof SUPPORT_POOLS)[number];
-export type SupportCollateralCoins = (typeof SUPPORT_COLLATERALS)[number];
-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>
->;
-export type SupportStakeRewardCoins = (typeof SUPPORT_SPOOLS_REWARDS)[number];
-export type SupportBorrowIncentiveCoins =
-  (typeof SUPPORT_BORROW_INCENTIVE_POOLS)[number];
-export type SupportBorrowIncentiveRewardCoins =
-  (typeof SUPPORT_BORROW_INCENTIVE_REWARDS)[number];
-export type SupportSCoin = (typeof SUPPORT_SCOIN)[number];
-
-export type SupportOracleType = (typeof SUPPORT_ORACLES)[number];
-
-export type SupportPackageType = (typeof SUPPORT_PACKAGES)[number];
-
-export type SupportCoinDecimals = Record<SupportCoins, number>;
+export type Whitelist = {
+  lending: Set<string>;
+  borrowing: Set<string>;
+  collateral: Set<string>;
+  packages: Set<string>;
+  spool: Set<string>;
+  scoin: Set<string>;
+  suiBridge: Set<string>;
+  wormhole: Set<string>;
+  oracles: Set<string>;
+  borrowIncentiveRewards: Set<string>;
+  pythEndpoints: Set<string>;
+  deprecated: Set<string>;
+};
 
 export type CoinWrappedType =
   | {

package/src/types/constant/enum.ts

@@ -1,76 +1,64 @@
-import {
-  SupportCoins,
-  SupportAssetCoins,
-  SupportMarketCoins,
-  SupportStakeMarketCoins,
-  SupportStakeRewardCoins,
-  SupportBorrowIncentiveCoins,
-  SupportBorrowIncentiveRewardCoins,
-  SupportSCoin,
-  SupportSuiBridgeCoins,
-} from './common';
-
 export type Coins = {
-  [K in SupportCoins]: K;
+  [K in string]: K;
 };
 
 export type AssetCoins = {
-  [K in SupportAssetCoins]: K;
+  [K in string]: K;
 };
 
 export type MarketCoins = {
-  [K in SupportMarketCoins]: K;
+  [K in string]: K;
 };
 
 export type SCoins = {
-  [K in SupportSCoin]: K;
+  [K in string]: K;
 };
 
 export type StakeMarketCoins = {
-  [K in SupportStakeMarketCoins]: K;
+  [K in string]: K;
 };
 
 export type StakeRewardCoins = {
-  [key in SupportStakeMarketCoins]: SupportStakeRewardCoins;
+  [key in string]: string;
 };
 
 export type SuiBridgeCoins = {
-  [K in SupportSuiBridgeCoins]: K;
+  [K in string]: K;
 };
 
 export type BorrowIncentiveRewardCoins = {
-  [key in SupportBorrowIncentiveCoins]: SupportBorrowIncentiveRewardCoins[];
+  [key in string]: string[];
 };
 
 export type AssetCoinIds = {
-  [key in SupportAssetCoins]: string;
+  [key in string]: string;
 };
 
 export type SCoinIds = {
-  [key in SupportSCoin]: string;
+  [key in string]: string;
 };
 
 export type SCoinTreasuryCaps = {
-  [key in SupportSCoin]: string;
+  [key in string]: string;
 };
 
 export type SCoinConverterTreasury = {
-  [key in SupportSCoin]: string;
+  [key in string]: string;
 };
 
 type PickFromUnion<T, K extends string> = K extends T ? K : never;
 
 export type WormholeCoinIds = {
   [key in PickFromUnion<
-    SupportAssetCoins,
+    string,
     'weth' | 'wbtc' | 'wusdc' | 'wusdt' | 'wapt' | 'wsol'
   >]: string;
 };
 
 export type VoloCoinIds = {
-  [key in PickFromUnion<SupportAssetCoins, 'vsui'>]: string;
+  [key in PickFromUnion<string, 'vsui'>]: string;
 };
 
 export type SuiBridgedCoinPackageIds = {
-  [key in SupportSuiBridgeCoins]: string;
+  [key in string]: string;
 };

package/src/types/constant/xOracle.ts

@@ -1,11 +1,9 @@
-import { SupportAssetCoins, SupportOracleType } from './common';
-
 export type xOracleRules = {
-  primary: SupportOracleType[];
-  secondary: SupportOracleType[];
+  primary: string[];
+  secondary: string[];
 };
 export type xOracleRuleType = keyof xOracleRules;
 
 export type xOracleListType = {
-  [key in SupportAssetCoins]: xOracleRules;
+  [key in string]: xOracleRules;
 };

package/src/types/model.ts

@@ -11,6 +11,9 @@ import type {
 import { ScallopCache } from 'src/models/scallopCache';
 import { AddressesInterface } from './address';
 import { QueryClient, QueryClientConfig } from '@tanstack/query-core';
+import { AxiosInstance } from 'axios';
+import { PoolAddress, Whitelist } from './constant';
+import { ScallopConstants } from 'src/models/scallopConstants';
 
 export type ScallopClientFnReturnType<T extends boolean> = T extends true
   ? SuiTransactionBlockResponse
@@ -25,6 +28,7 @@ export type ScallopClientVeScaReturnType<T extends boolean> = T extends true
 
 export type ScallopBaseInstanceParams = {
   suiKit?: SuiKit;
+  cache?: ScallopCache;
 };
 
 export type ScallopCacheInstanceParams = ScallopBaseInstanceParams & {
@@ -35,12 +39,17 @@ export type ScallopAddressInstanceParams = ScallopBaseInstanceParams & {
   cache?: ScallopCache;
 };
 
+export type ScallopConstantsInstanceParams = {
+  address?: ScallopAddress;
+  cache?: ScallopCache;
+};
+
 export type ScallopIndexerInstanceParams = {
   cache?: ScallopCache;
 };
 
 export type ScallopUtilsInstanceParams = ScallopBaseInstanceParams & {
-  address?: ScallopAddress;
+  constants?: ScallopConstants;
 };
 
 export type ScallopQueryInstanceParams = ScallopBaseInstanceParams & {
@@ -56,40 +65,52 @@ export type ScallopClientInstanceParams = ScallopBaseInstanceParams & {
   builder?: ScallopBuilder;
 };
 
-export type ScallopAddressParams = {
-  id: string;
-  auth?: string;
-  network?: NetworkType;
-  forceInterface?: Partial<Record<NetworkType, AddressesInterface>>;
+export type ScallopCacheConfig = {
+  tokensPerInterval?: number; // How many requests per interval
+  interval?: number; // Interval in milliseconds
 };
 
-export type ScallopParams = {
-  addressId?: string;
-  forceAddressesInterface?: Partial<Record<NetworkType, AddressesInterface>>;
+export type ScallopCacheParams = {
   walletAddress?: string;
+  cacheOptions?: QueryClientConfig;
+  config?: ScallopCacheConfig;
 } & SuiKitParams;
 
-export type ScallopClientParams = ScallopParams &
-  ScallopBuilderParams &
-  ScallopQueryParams &
-  ScallopUtilsParams &
-  ScallopCacheParams;
-
-export type ScallopBuilderParams = ScallopParams & {
-  pythEndpoints?: string[];
-  usePythPullModel?: boolean;
-  useOnChainXOracleList?: boolean;
-} & ScallopQueryParams;
+export type ScallopIndexerParams = ScallopCacheParams & {
+  indexerApiUrl?: string;
+  axios?: AxiosInstance;
+};
 
-export type ScallopQueryParams = ScallopParams & ScallopUtilsParams;
+export type ScallopAddressParams = ScallopCacheParams & {
+  addressApiUrl?: string;
+  addressId: string;
+  auth?: string;
+  network?: NetworkType;
+  forceAddressesInterface?: Partial<Record<NetworkType, AddressesInterface>>;
+};
 
-export type ScallopUtilsParams = ScallopParams & {
-  pythEndpoints?: string[];
+export type ScallopConstantsParams = ScallopAddressParams & {
+  poolAddressesApiUrl?: string;
+  whitelistApiUrl?: string;
+  forcePoolAddressInterface?: Record<string, PoolAddress>;
+  forceWhitelistInterface?: Whitelist;
 };
 
-export type ScallopCacheParams = Omit<
-  ScallopParams,
-  'addressId' | 'forceAddressesInterface'
-> & {
-  cacheOptions?: QueryClientConfig;
+export type ScallopUtilsParams = ScallopAddressParams &
+  ScallopConstantsParams & {
+    pythEndpoints?: string[];
+  };
+
+export type ScallopQueryParams = ScallopUtilsParams & ScallopIndexerParams;
+
+export type ScallopBuilderParams = ScallopQueryParams & {
+  usePythPullModel?: boolean;
+  useOnChainXOracleList?: boolean;
 };
+
+export type ScallopClientParams = ScallopBuilderParams;
+export type ScallopParams = SuiKitParams &
+  ScallopAddressParams &
+  ScallopConstantsParams & {
+    walletAddress?: string;
+  };

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;