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

package/src/constants/common.ts

@@ -4,134 +4,9 @@ export const SDK_API_BASE_URL = 'https://sdk.api.scallop.io' as const;
 export const IS_VE_SCA_TEST: boolean = false;
 export const USE_TEST_ADDRESS: boolean = false;
 
-// export const ADDRESS_ID =
-//   IS_VE_SCA_TEST || USE_TEST_ADDRESS
-//     ? ('65fb07c39c845425d71d7b18' as const)
-//     : ('67c44a103fe1b8c454eb9699' as const);
-// : ('66f8e7ed9bb9e07fdfb86bbb' as const);
-
 export const SCA_COIN_TYPE = IS_VE_SCA_TEST
   ? (`0x6cd813061a3adf3602b76545f076205f0c8e7ec1d3b1eab9a1da7992c18c0524::sca::SCA` as const)
   : ('0x7016aae72cfc67f2fadf55769c0a7dd54291a583b63051a5ed71081cce836ac6::sca::SCA' as const);
 
 export const OLD_BORROW_INCENTIVE_PROTOCOL_ID =
   '0xc63072e7f5f4983a2efaf5bdba1480d5e7d74d57948e1c7cc436f8e22cbeb410' as const;
-
-// export const SUPPORT_POOLS = [
-//   'usdc', // native USDC
-//   'sbeth', // sui bridge ETH
-//   'sbusdt', // sui bridge USDT
-//   'sbwbtc', // sui bridge WBTC
-//   'weth',
-//   'wbtc',
-//   'wusdc',
-//   'wusdt',
-//   'sui',
-//   'wapt',
-//   'wsol',
-//   'cetus',
-//   'afsui',
-//   'hasui',
-//   'vsui',
-//   'sca',
-//   'fud',
-//   'deep',
-//   'fdusd',
-//   'blub',
-//   'musd',
-//   'ns',
-//   'usdy',
-// ] as const;
-
-// export const SUPPORT_COLLATERALS = [
-//   'usdc', // native USDC
-//   'sbeth', // sui bridge ETH
-//   'sbusdt', // sui bridge USDT
-//   'sbwbtc', // sui bridge WBTC
-//   'weth',
-//   'wbtc',
-//   'wusdc',
-//   'wusdt',
-//   'sui',
-//   'wapt',
-//   'wsol',
-//   'cetus',
-//   'afsui',
-//   'hasui',
-//   'vsui',
-//   'sca',
-//   'fdusd',
-//   'usdy',
-// ] as const;
-
-// export const SUPPORT_SPOOLS = [
-//   'susdc',
-//   'sweth',
-//   'ssui',
-//   'swusdc',
-//   'swusdt',
-//   'scetus',
-//   'safsui',
-//   'shasui',
-//   'svsui',
-// ] as const;
-
-// export const SUPPORT_SCOIN = [
-//   'susdc',
-//   'ssbeth',
-//   'ssbusdt',
-//   'ssbwbtc',
-//   'ssui',
-//   'swusdc',
-//   'swusdt',
-//   'safsui',
-//   'shasui',
-//   'svsui',
-//   'sweth',
-//   'ssca',
-//   'scetus',
-//   'swsol',
-//   'swbtc',
-//   'sdeep',
-//   'sfud',
-//   'sfdusd',
-//   'sblub',
-//   'smusd',
-//   'sns',
-//   'susdy',
-// ] as const;
-
-// export const SUPPORT_SUI_BRIDGE = ['sbeth', 'sbusdt', 'sbwbtc'] as const;
-// export const SUPPORT_WORMHOLE = [
-//   'wusdc',
-//   'wusdt',
-//   'weth',
-//   'wbtc',
-//   'wapt',
-//   'wsol',
-// ] as const;
-
-// export const SUPPORT_SPOOLS_REWARDS = ['sui'] as const;
-
-// export const SUPPORT_BORROW_INCENTIVE_POOLS = [...SUPPORT_POOLS] as const;
-
-// export const SUPPORT_BORROW_INCENTIVE_REWARDS = [
-//   ...SUPPORT_POOLS,
-//   ...SUPPORT_SCOIN,
-// ] as const;
-// export const SUPPORT_ORACLES = ['supra', 'switchboard', 'pyth'] as const;
-
-// export const SUPPORT_PACKAGES = [
-//   'coinDecimalsRegistry',
-//   'math',
-//   'whitelist',
-//   'x',
-//   'protocol',
-//   'protocolWhitelist',
-//   'query',
-//   'supra',
-//   'pyth',
-//   'switchboard',
-//   'xOracle',
-//   'testCoin',
-// ] as const;

package/src/models/scallop.ts

@@ -78,12 +78,25 @@ export class Scallop {
    * @param id - The API id of the addresses.
    * @return Scallop Address.
    */
-  public async getScallopAddress(id?: string) {
+  public async getScallopAddress(id: string = this.params.addressId) {
     await this.address.read(id);
 
     return this.address;
   }
 
+  /**
+   * Get a scallop constants instance that already has initial data.
+   * @returns Scallop Constants
+   */
+  public async getScallopConstants(params?: Partial<ScallopConstantsParams>) {
+    await this.initConstants({
+      ...this.params,
+      ...params,
+    });
+
+    return this.constants;
+  }
+
   /**
    * Create a scallop builder instance that already has initial data.
    *

package/src/models/scallopAddress.ts

@@ -443,7 +443,7 @@ export class ScallopAddress {
     instance?: ScallopAddressInstanceParams
   ) {
     const { addressId, auth, network, forceAddressesInterface } = params;
-    this.cache = instance?.cache ?? new ScallopCache({});
+    this.cache = instance?.cache ?? new ScallopCache(params);
 
     this._requestClient = axios.create({
       baseURL: API_BASE_URL,

package/src/models/scallopBuilder.ts

@@ -220,48 +220,6 @@ export class ScallopBuilder {
     args?: (SuiTxArg | SuiVecTxArg | SuiObjectArg | SuiAmountsArg)[],
     typeArgs?: string[]
   ) {
-    // Disable for now
-    // const resolvedQueryTarget =
-    //   await this.cache.queryGetNormalizedMoveFunction(target);
-    // if (!resolvedQueryTarget) throw new Error('Invalid query target');
-
-    // const { parameters } = resolvedQueryTarget;
-    // try {
-    //   // we can try resolve the args first
-    //   const resolvedArgs = await Promise.all(
-    //     (args ?? []).map(async (arg, idx) => {
-    //       if (typeof arg !== 'string') return arg;
-
-    //       const cachedData = (await this.cache.queryGetObject(arg))?.data;
-    //       if (!cachedData) return arg;
-
-    //       const owner = cachedData.owner;
-    //       if (!owner || typeof owner !== 'object' || !('Shared' in owner))
-    //         return {
-    //           objectId: cachedData.objectId,
-    //           version: cachedData.version,
-    //           digest: cachedData.digest,
-    //         };
-
-    //       const parameter = parameters[idx];
-    //       if (
-    //         typeof parameter !== 'object' ||
-    //         !('MutableReference' in parameter || 'Reference' in parameter)
-    //       )
-    //         return arg;
-
-    //       return {
-    //         objectId: cachedData.objectId,
-    //         initialSharedVersion: owner.Shared.initial_shared_version,
-    //         mutable: 'MutableReference' in parameter,
-    //       };
-    //     })
-    //   );
-    //   return txb.moveCall(target, resolvedArgs, typeArgs);
-    // } catch (e: any) {
-    //   console.error(e.message);
-    //   return txb.moveCall(target, args, typeArgs);
-    // }
     return txb.moveCall(target, args, typeArgs);
   }
 }

package/src/models/scallopCache.ts

@@ -246,7 +246,7 @@ export class ScallopCache {
     return query;
   }
 
-  public async queryGetNormalizedMoveFunction(target: string) {
+  private async queryGetNormalizedMoveFunction(target: string) {
     const { address, module, name } = parseStructTag(target);
     return this.queryClient.fetchQuery({
       queryKey: queryKeys.rpc.getNormalizedMoveFunction(target),
@@ -460,11 +460,7 @@ export class ScallopCache {
     input: GetBalanceParams
   ): Promise<CoinBalance | null> {
     if (!input.coinType) return null;
-
-    return (
-      ((await this.queryGetAllCoinBalances(input.owner)) ?? {})[
-        normalizeStructTag(input.coinType)
-      ] ?? '0'
-    );
+    const coinBalances = await this.queryGetAllCoinBalances(input.owner);
+    return coinBalances[normalizeStructTag(input.coinType)] ?? null;
   }
 }

package/src/models/scallopConstants.ts

@@ -112,7 +112,9 @@ export class ScallopConstants {
     return (
       this.isAddressInitialized && // address is initialized
       !this.isEmptyObject(this._poolAddresses) && // poolAddresses is initialized
-      REQUIRED_WHITELIST_KEYS.every((t) => this.whitelist[t].size > 0) // whitelist is initialized
+      REQUIRED_WHITELIST_KEYS.every(
+        (t) => this.whitelist[t] && this.whitelist[t].size > 0
+      ) // whitelist is initialized
     );
   }
 

package/src/models/scallopQuery.ts

@@ -234,13 +234,6 @@ export class ScallopQuery {
   ) {
     const marketPools = await this.getMarketPools(undefined, args);
     return marketPools.pools[poolCoinName];
-    // return await getMarketPool(
-    //   this,
-    //   poolCoinName,
-    //   args?.indexer,
-    //   args?.marketObject,
-    //   args?.coinPrice
-    // );
   }
 
   /**

package/src/models/suiKit.ts

@@ -1,11 +1,26 @@
 import { SuiKit, SuiKitParams } from '@scallop-io/sui-kit';
 import { RPC_PROVIDERS } from 'src/constants/rpc';
 
-export const newSuiKit = (params: SuiKitParams) => {
+export const newSuiKit = (params: Partial<SuiKitParams>) => {
+  let initParams;
+  if (
+    'suiClients' in params &&
+    params.suiClients &&
+    params.suiClients?.length > 0
+  ) {
+    initParams = {
+      suiClients: params.suiClients,
+    };
+  } else {
+    initParams = {
+      fullnodeUrls:
+        'fullnodeUrls' in params
+          ? (params?.fullnodeUrls ?? RPC_PROVIDERS)
+          : RPC_PROVIDERS,
+    };
+  }
   return new SuiKit({
     ...params,
-    fullnodeUrls: Array.from(
-      new Set([...(params.fullnodeUrls ?? []), ...RPC_PROVIDERS])
-    ),
+    ...initParams,
   });
 };

package/src/queries/coreQuery.ts

@@ -405,21 +405,6 @@ export const getMarketPools = async (
   const collaterals: MarketCollaterals = {};
 
   if (indexer) {
-    // const marketPoolsIndexer = await query.indexer.getMarketPools();
-
-    // const updateMarketPool = (marketPool: MarketPool) => {
-    //   if (!poolCoinNames.includes(marketPool.coinName)) return;
-    //   marketPool.coinPrice =
-    //     coinPrices[marketPool.coinName] ?? marketPool.coinPrice;
-    //   marketPool.coinWrappedType = query.utils.getCoinWrappedType(
-    //     marketPool.coinName
-    //   );
-    //   pools[marketPool.coinName] = marketPool;
-    // };
-
-    // Object.values(marketPoolsIndexer).forEach(updateMarketPool);
-
-    // return pools;
     const marketIndexer = await query.indexer.getMarket();
 
     const updatePools = (item: MarketPool) => {

package/src/queries/poolAddressesQuery.ts

@@ -193,9 +193,7 @@ export const getPoolAddresses = async (
         spoolReward: '',
       };
       const _spoolData = addressApiResponse.spool.pools[`s${coinName}`];
-      // @ts-ignore
       if (_spoolData) {
-        // @ts-ignore
         const { id: spool, rewardPoolId: spoolReward } = _spoolData;
         spoolData = {
           spool,

package/src/queries/portfolioQuery.ts

@@ -146,8 +146,6 @@ export const getLending = async (
           },
         })
       : undefined;
-  // some pool does not have spool
-  // if (!spool) throw new Error(`Failed to fetch spool for ${poolCoinName}`);
 
   stakeAccounts =
     stakeAccounts || query.constants.whitelist.spool.has(marketCoinName)

package/src/queries/xOracleQuery.ts

@@ -2,11 +2,6 @@ import { SuiObjectResponse } from '@mysten/sui/client';
 import { ScallopAddress, ScallopUtils } from 'src/models';
 import { SupportOracleType, xOracleRuleType } from 'src/types';
 
-// const PRIMARY_PRICE_UPDATE_POLICY =
-//   '0x56e48a141f20a3a6a6d3fc43e58b01fc63f756c08224870e7890c80ec9d2afee';
-// const SECONDARY_PRICE_UPDDATE_POLICY =
-//   '0xef4d9430ae42c1b24199ac55e87ddd7262622447ee3c7de8868efe839b3d8705';
-
 /**
  * Query the price update policy table ids. Usually the value for these table will be constant.
  * @param query
@@ -43,11 +38,6 @@ export const getPriceUpdatePolicies = async (
   };
 };
 
-// const PRIMARY_PRICE_UPDATE_POLICY_VECSET_ID =
-//   '0xc22c9d691ee4c780de09db91d8b487d863211ebf08720772144bcf716318826c';
-// const SECONDARY_PRICE_UPDATE_POLICY_VECSET_ID =
-//   '0x3b184ff859f5de30eeaf186898e5224925be6bb6d2baa74347ef471a8cd1c0d3';
-
 export const getAssetOracles = async (
   utils: ScallopUtils,
   ruleType: xOracleRuleType

package/src/types/builder/core.ts

@@ -21,54 +21,38 @@ type ObligationKey = NestedResult;
 type ObligationHotPotato = NestedResult;
 
 export type CoreNormalMethods = {
-  // openObligation: () => Promise<
   openObligation: () => [Obligation, ObligationKey, ObligationHotPotato];
   returnObligation: (
     obligation: SuiObjectArg,
     obligationHotPotato: SuiObjectArg
-    // ) => Promise<void>;
   ) => void;
-  // openObligationEntry: () => Promise<void>;
   openObligationEntry: () => void;
   addCollateral: (
     obligation: SuiObjectArg,
     coin: SuiObjectArg,
     collateralCoinName: string
-    // ) => Promise<void>;
   ) => void;
   takeCollateral: (
     obligation: SuiObjectArg,
     obligationKey: SuiObjectArg,
     amount: number,
     collateralCoinName: string
-    // ) => Promise<TransactionResult>;
-  ) => TransactionResult;
-  deposit: (
-    coin: SuiObjectArg,
-    poolCoinName: string
-    // ) => Promise<TransactionResult>;
-  ) => TransactionResult;
-  depositEntry: (
-    coin: SuiObjectArg,
-    poolCoinName: string
-    // ) => Promise<TransactionResult>;
   ) => TransactionResult;
+  deposit: (coin: SuiObjectArg, poolCoinName: string) => TransactionResult;
+  depositEntry: (coin: SuiObjectArg, poolCoinName: string) => TransactionResult;
   withdraw: (
     marketCoin: SuiObjectArg,
     poolCoinName: string
-    // ) => Promise<TransactionResult>;
   ) => TransactionResult;
   withdrawEntry: (
     marketCoin: SuiObjectArg,
     poolCoinName: string
-    // ) => Promise<TransactionResult>;
   ) => TransactionResult;
   borrow: (
     obligation: SuiObjectArg,
     obligationKey: SuiObjectArg,
     amount: number,
     poolCoinName: string
-    // ) => Promise<TransactionResult>;
   ) => TransactionResult;
   borrowWithReferral: (
     obligation: SuiObjectArg,
@@ -76,31 +60,26 @@ export type CoreNormalMethods = {
     borrowReferral: SuiObjectArg,
     amount: number | SuiTxArg,
     poolCoinName: string
-    // ) => Promise<TransactionResult>;
   ) => TransactionResult;
   borrowEntry: (
     obligation: SuiObjectArg,
     obligationKey: SuiObjectArg,
     amount: number,
     poolCoinName: string
-    // ) => Promise<TransactionResult>;
   ) => TransactionResult;
   repay: (
     obligation: SuiObjectArg,
     coin: SuiObjectArg,
     poolCoinName: string
-    // ) => Promise<void>;
   ) => void;
   borrowFlashLoan: (
     amount: number | SuiTxArg,
     poolCoinName: string
-    // ) => Promise<TransactionResult>;
   ) => TransactionResult;
   repayFlashLoan: (
     coin: SuiObjectArg,
     loan: SuiObjectArg,
     poolCoinName: string
-    // ) => Promise<void>;
   ) => void;
 };
 

package/src/types/model.ts

@@ -74,7 +74,7 @@ export type ScallopCacheParams = {
   walletAddress?: string;
   cacheOptions?: QueryClientConfig;
   config?: ScallopCacheConfig;
-} & SuiKitParams;
+} & Partial<SuiKitParams>;
 
 export type ScallopIndexerParams = ScallopCacheParams & {
   indexerApiUrl?: string;
@@ -99,6 +99,7 @@ export type ScallopConstantsParams = ScallopAddressParams & {
 export type ScallopUtilsParams = ScallopAddressParams &
   ScallopConstantsParams & {
     pythEndpoints?: string[];
+    switchboardSolanaRpc?: string;
   };
 
 export type ScallopQueryParams = ScallopUtilsParams & ScallopIndexerParams;
@@ -109,7 +110,7 @@ export type ScallopBuilderParams = ScallopQueryParams & {
 };
 
 export type ScallopClientParams = ScallopBuilderParams;
-export type ScallopParams = SuiKitParams &
+export type ScallopParams = Partial<SuiKitParams> &
   ScallopAddressParams &
   ScallopConstantsParams & {
     walletAddress?: string;

package/src/constants/pyth.ts

@@ -1,25 +0,0 @@
-// export const PYTH_FEED_IDS: Record<string, string> = {
-//   usdc: 'eaa020c61cc479712813461ce153894a96a6c00b21ed0cfc2798d1f9a9e9c94a',
-//   sbeth: 'ff61491a931112ddf1bd8147cd1b641375f79f5825126d665480874634fd0ace',
-//   sbusdt: '2b89b9dc8fdf9f34709a5b106b472f0f39bb6ca9ce04b0fd7f2e971688e2e53b',
-//   sbwbtc: 'e62df6c8b4a85fe1a67db44dc12de5db330f7ac66b72dc658afedf0f4a415b43',
-//   weth: 'ff61491a931112ddf1bd8147cd1b641375f79f5825126d665480874634fd0ace',
-//   wbtc: 'e62df6c8b4a85fe1a67db44dc12de5db330f7ac66b72dc658afedf0f4a415b43',
-//   wusdc: 'eaa020c61cc479712813461ce153894a96a6c00b21ed0cfc2798d1f9a9e9c94a',
-//   wusdt: '2b89b9dc8fdf9f34709a5b106b472f0f39bb6ca9ce04b0fd7f2e971688e2e53b',
-//   sui: '23d7315113f5b1d3ba7a83604c44b94d79f4fd69af77f804fc7f920a6dc65744',
-//   wapt: '03ae4db29ed4ae33d323568895aa00337e658e348b37509f5372ae51f0af00d5',
-//   wsol: 'ef0d8b6fda2ceba41da15d4095d1da392a0d2f8ed0c6c7bc0f4cfac8c280b56d',
-//   cetus: 'e5b274b2611143df055d6e7cd8d93fe1961716bcd4dca1cad87a83bc1e78c1ef',
-//   afsui: '23d7315113f5b1d3ba7a83604c44b94d79f4fd69af77f804fc7f920a6dc65744',
-//   hasui: '23d7315113f5b1d3ba7a83604c44b94d79f4fd69af77f804fc7f920a6dc65744',
-//   vsui: '23d7315113f5b1d3ba7a83604c44b94d79f4fd69af77f804fc7f920a6dc65744',
-//   sca: '7e17f0ac105abe9214deb9944c30264f5986bf292869c6bd8e8da3ccd92d79bc',
-//   fdusd: 'ccdc1a08923e2e4f4b1e6ea89de6acbc5fe1948e9706f5604b8cb50bc1ed3979',
-//   deep: '29bdd5248234e33bd93d3b81100b5fa32eaa5997843847e2c2cb16d7c6d9f7ff',
-//   fud: '6a4090703da959247727f2b490eb21aea95c8684ecfac675f432008830890c75',
-//   blub: '5fc11ffe4975b624be495be038da30e30bee2004d8ae6282b5364577ef4ca92c',
-//   musd: '2ee09cdb656959379b9262f89de5ff3d4dfed0dd34c072b3e22518496a65249c',
-//   ns: 'bb5ff26e47a3a6cc7ec2fce1db996c2a145300edc5acaabe43bf9ff7c5dd5d32',
-//   usdy: 'e3d1723999820435ebab53003a542ff26847720692af92523eea613a9a28d500',
-// };