@scallop-io/sui-scallop-sdk 2.0.0-alpha.9 → 2.0.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scallop-io/sui-scallop-sdk",
-  "version": "2.0.0-alpha.9",
+  "version": "2.0.1",
   "description": "Typescript sdk for interacting with Scallop contract on SUI",
   "keywords": [
     "sui",

package/src/builders/oracles/index.ts

@@ -9,7 +9,6 @@ import type {
 } from 'src/types';
 import { xOracleList as X_ORACLE_LIST } from 'src/constants';
 import { updatePythPriceFeeds } from './pyth';
-// import { updateSwitchboardAggregators } from './switchboard';
 
 /**
  * Update the price of the oracle for multiple coin.
@@ -66,20 +65,6 @@ export const updateOracles = async (
       await updatePythPriceFeeds(builder, assetCoinNames, txBlock);
   }
 
-  // Handle Switchboard on-demand aggregator
-  // if (flattenedRules.has('switchboard')) {
-  //   const switchboardAssetCoinNames = assetCoinNames.filter((assetCoinName) =>
-  //     filterAssetCoinNames(assetCoinName, 'switchboard')
-  //   );
-  //   if (switchboardAssetCoinNames.length > 0) {
-  //     await updateSwitchboardAggregators(
-  //       builder,
-  //       switchboardAssetCoinNames,
-  //       txBlock
-  //     );
-  //   }
-  // }
-
   // Remove duplicate coin names.
   const updateAssetCoinNames = [...new Set(assetCoinNames)];
   for (const assetCoinName of updateAssetCoinNames) {

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/constants/testAddress.ts

@@ -122,12 +122,16 @@ export const TEST_ADDRESSES: AddressesInterface = {
         '0x1edeae568fde99e090dbdec4bcdbd33a15f53a1ce1f87aeef1a560dedf4b4a90',
       primaryPriceUpdatePolicyObject:
         '0xbcd908d0ee6d63d726e61676f3feeec3d19817f4849bbecf372dd3399f247f6b',
+      // '0x56e48a141f20a3a6a6d3fc43e58b01fc63f756c08224870e7890c80ec9d2afee' // prod
       secondaryPriceUpdatePolicyObject:
         '0x624a6f120777bb30e718b86e836c205ef4229448052377dc3d78272a6662b2c0',
+      // '0xef4d9430ae42c1b24199ac55e87ddd7262622447ee3c7de8868efe839b3d8705' // prod
       primaryPriceUpdatePolicyVecsetId:
         '0xfb1330aa028ed6a159b742c71b5a79b3b6824cf71efa40ea82b52486ad209264',
+      // '0xc22c9d691ee4c780de09db91d8b487d863211ebf08720772144bcf716318826c', // prod
       secondaryPriceUpdatePolicyVecsetId:
         '0x4b827acc73f3f53f808dd73a7ee0a60ae61e84322176bece72b26467030b467c',
+      // '0x3b184ff859f5de30eeaf186898e5224925be6bb6d2baa74347ef471a8cd1c0d3' // prod
       supra: {
         registry: '',
         registryCap: '',
@@ -304,7 +308,7 @@ export const TEST_ADDRESSES: AddressesInterface = {
         coinType:
           '0x88618204de2dfdc2597681a8441ee726b0dc13494c41e319c3264eb7b35fea90::scallop_sui::SCALLOP_SUI',
         metaData: '',
-        symbol: '',
+        symbol: 'sSUI',
         treasury:
           '0x03f1d94a40bd9f5d556bacb5c5245732b185572f6a29b36ad8b555d9a8a24f09',
       },
@@ -312,7 +316,7 @@ export const TEST_ADDRESSES: AddressesInterface = {
         coinType:
           '0x9f64a180373a6b66595025ae16a4ab701f0af1dd5c7ce1ac91dc112e52c2a3f8::scallop_sca::SCALLOP_SCA',
         metaData: '',
-        symbol: '',
+        symbol: 'sSCA',
         treasury:
           '0x1b05d2cd8b20dba19da073a54195fc52d2f438ea19dea0713bae7a7dab308199',
       },
@@ -321,7 +325,7 @@ export const TEST_ADDRESSES: AddressesInterface = {
           '0x55ed015f9f006c0c96ad36ebe3b3570d088e8498f52defea48e5634c110e485c::scallop_usdc::SCALLOP_USDC',
         treasury:
           '0x6ef82ef94472dcb8c2cdeac8df38874024c08570ca165986ba56d1e38fe0c0a3',
-        symbol: '',
+        symbol: 'sUSDC',
         metaData:
           '0x763a21eba338e00bc684aaad80491c89eea5f247b59c47df45b17610c9ad58f2',
       },
@@ -329,7 +333,7 @@ export const TEST_ADDRESSES: AddressesInterface = {
         coinType:
           '0x34f0a2e793e1f79ceac72cfe3bb95f65541da449418289ccd12922d16140c882::scallop_deep::SCALLOP_DEEP',
         metaData: '',
-        symbol: '',
+        symbol: 'sDEEP',
         treasury:
           '0x71d41465cf2d16fa0206126526bebdf65c8871d1fcfbd0c2237db2306afd67ba',
       },
@@ -337,7 +341,7 @@ export const TEST_ADDRESSES: AddressesInterface = {
         coinType:
           '0x3b23c05f917052255a0b16a534dbd4446911aa4a30bd3497cdf5b736551e7ef8::scallop_fud::SCALLOP_FUD',
         metaData: '',
-        symbol: '',
+        symbol: 'sFUD',
         treasury:
           '0x858c492d51425b922c040c1a389e185b3b00d565e7d72ead1a81dc733104660d',
       },

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/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/scallopConstants.ts

@@ -36,6 +36,7 @@ export class ScallopConstants {
     scoin: new Set(),
     spool: new Set(),
     borrowIncentiveRewards: new Set(),
+    rewardsAsPoint: new Set(),
     suiBridge: new Set(),
     wormhole: new Set(),
     oracles: new Set(),
@@ -98,10 +99,22 @@ export class ScallopConstants {
   }
 
   get isInitialized() {
+    const REQUIRED_WHITELIST_KEYS = [
+      'lending',
+      'collateral',
+      'borrowing',
+      'packages',
+      'scoin',
+      'spool',
+      'oracles',
+      'pythEndpoints',
+    ] as const;
     return (
-      !this.isEmptyObject(this._poolAddresses) &&
-      Object.values(this._whitelist).every((t) => t.size > 0) &&
-      this.isAddressInitialized
+      this.isAddressInitialized && // address is initialized
+      !this.isEmptyObject(this._poolAddresses) && // poolAddresses 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/scallopUtils.ts

@@ -554,7 +554,9 @@ export class ScallopUtils {
   public getSupportedPoolAddresses(): PoolAddress[] {
     return this.constants.poolAddresses
       ? Object.values(this.constants.poolAddresses).filter(
-          (address): address is PoolAddress => address !== undefined
+          (poolAddress): poolAddress is PoolAddress =>
+            poolAddress !== undefined &&
+            this.constants.whitelist.lending.has(poolAddress.coinName)
         )
       : [];
   }

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

@@ -13,7 +13,7 @@ import type {
   CoinAmounts,
   CoinPrices,
   TotalValueLocked,
-  ObligationBorrowIcentiveReward,
+  ObligationBorrowIncentiveReward,
   MarketPools,
   MarketCollaterals,
 } from '../types';
@@ -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)
@@ -534,7 +532,7 @@ export const getObligationAccount = async (
     const coinName = poolCoinName as string;
     const borrowIncentivePool = borrowIncentivePools[coinName];
     if (borrowIncentivePool) {
-      const rewards: ObligationBorrowIcentiveReward[] = [];
+      const rewards: ObligationBorrowIncentiveReward[] = [];
       Object.entries(borrowIncentiveAccount.pointList).forEach(
         ([key, accountPoint]) => {
           const poolPoint =
@@ -590,6 +588,7 @@ export const getObligationAccount = async (
                 symbol: poolPoint.symbol,
                 coinDecimal: poolPoint.coinDecimal,
                 coinPrice: poolPoint.coinPrice,
+                weightedBorrowAmount: accountBorrowedAmount.toNumber(),
                 availableClaimAmount: availableClaimAmount.toNumber(),
                 availableClaimCoin: availableClaimCoin.toNumber(),
                 boostValue,

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/constant/common.ts

@@ -39,6 +39,7 @@ export type Whitelist = {
   wormhole: Set<string>;
   oracles: Set<string>;
   borrowIncentiveRewards: Set<string>;
+  rewardsAsPoint: Set<string>;
   pythEndpoints: Set<string>;
   deprecated: Set<string>;
 };

package/src/types/query/portfolio.ts

@@ -108,12 +108,13 @@ export type ObligationDebt = {
   availableRepayCoin: number;
 };
 
-export type ObligationBorrowIcentiveReward = {
+export type ObligationBorrowIncentiveReward = {
   coinName: string;
   coinType: string;
   symbol: string;
   coinDecimal: number;
   coinPrice: number;
+  weightedBorrowAmount: number;
   availableClaimCoin: number;
   availableClaimAmount: number;
   boostValue: number;
@@ -125,7 +126,7 @@ export type ObligationBorrowIncentive = {
   symbol: string;
   coinDecimal: number;
   coinPrice: number;
-  rewards: ObligationBorrowIcentiveReward[];
+  rewards: ObligationBorrowIncentiveReward[];
 };
 
 export type TotalValueLocked = {