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

package/src/models/scallopCache.ts

@@ -351,8 +351,8 @@ export class ScallopCache {
       retryDelay: 1000,
       queryKey: queryKeys.rpc.getOwnedObjects(input),
       queryFn: async () => {
-        const results = await this.callWithRateLimit(
-          async () => await this.client.getOwnedObjects(input)
+        const results = await this.callWithRateLimit(() =>
+          this.client.getOwnedObjects(input)
         );
         if (results && results.data.length > 0) {
           results.data

package/src/models/scallopClient.ts

@@ -59,6 +59,7 @@ export class ScallopClient {
 
     this.cache =
       instance?.builder?.cache ??
+      instance?.cache ??
       new ScallopCache(this.params, {
         suiKit: this.suiKit,
       });
@@ -100,13 +101,13 @@ export class ScallopClient {
    * @param force - Whether to force initialization.
    */
   public async init(force: boolean = false) {
-    if (force || !this.address.getAddresses()) {
-      await this.address.read();
+    if (force || !this.constants.isInitialized) {
+      await this.constants.init();
     }
 
-    await this.builder.init(force, this.address);
-    await this.query.init(force, this.address);
-    await this.utils.init(force, this.address);
+    await this.builder.init(force);
+    await this.query.init(force);
+    await this.utils.init(force);
   }
 
   /* ==================== Query Method ==================== */
@@ -492,9 +493,7 @@ export class ScallopClient {
     const sender = walletAddress ?? this.walletAddress;
     txBlock.setSender(sender);
 
-    const availableStake = (
-      [...this.constants.whitelist.lending] as readonly string[]
-    ).includes(poolCoinName);
+    const availableStake = this.constants.whitelist.lending.has(poolCoinName);
     if (sign && availableStake) {
       await txBlock.unstakeObligationQuick(obligationId, obligationKey);
     }
@@ -540,9 +539,7 @@ export class ScallopClient {
     const sender = walletAddress ?? this.walletAddress;
     txBlock.setSender(sender);
 
-    const availableStake = (
-      [...this.constants.whitelist.lending] as readonly string[]
-    ).includes(poolCoinName);
+    const availableStake = this.constants.whitelist.lending.has(poolCoinName);
     if (sign && availableStake) {
       await txBlock.unstakeObligationQuick(obligationId, obligationKey);
     }

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(),
@@ -44,7 +45,6 @@ export class ScallopConstants {
   };
 
   private _coinDecimals: Record<string, number | undefined> = {};
-  private _coinNameToCoinTypeMap: Record<string, string | undefined> = {};
   private _coinNameToOldMarketCoinTypeMap: Record<string, string | undefined> =
     {};
   private _scoinRawNameToSCoinNameMap: Record<string, string | undefined> = {};
@@ -57,6 +57,7 @@ export class ScallopConstants {
   private _coinTypes: Record<string, string | undefined> = {};
   private _sCoinTypes: Record<string, string | undefined> = {};
   private _coinTypeToCoinNameMap: Record<string, string | undefined> = {};
+  private _supportedBorrowIncentiveRewards: Set<string> = new Set();
 
   constructor(
     public readonly params: ScallopConstantsParams,
@@ -73,6 +74,7 @@ export class ScallopConstants {
 
     this.cache =
       instance?.address?.cache ??
+      instance?.cache ??
       new ScallopCache(this.params, {
         suiKit: newSuiKit(this.params),
       });
@@ -98,7 +100,9 @@ export class ScallopConstants {
 
   get isInitialized() {
     return (
-      !!this._poolAddresses && !!this._whitelist && this.isAddressInitialized
+      !this.isEmptyObject(this._poolAddresses) &&
+      Object.values(this._whitelist).every((t) => t.size > 0) &&
+      this.isAddressInitialized
     );
   }
 
@@ -125,6 +129,10 @@ export class ScallopConstants {
     );
   }
 
+  /**
+   * @description
+   * Return maps of coin names to coin decimals.
+   */
   get coinDecimals() {
     if (this.isEmptyObject(this._coinDecimals)) {
       this._coinDecimals = Object.fromEntries([
@@ -139,6 +147,10 @@ export class ScallopConstants {
     return this._coinDecimals;
   }
 
+  /**
+   * @description
+   * Return maps of coin names to coin types.
+   */
   get coinTypes() {
     if (this.isEmptyObject(this._coinTypes))
       this._coinTypes = Object.fromEntries([
@@ -152,6 +164,22 @@ export class ScallopConstants {
     return this._coinTypes;
   }
 
+  /**
+   * @description
+   * Return maps of coin types to its coin name
+   */
+  get coinTypeToCoinNameMap() {
+    if (this.isEmptyObject(this._coinTypeToCoinNameMap))
+      this._coinTypeToCoinNameMap = Object.fromEntries(
+        Object.entries(this.coinTypes).map(([key, val]) => [val, key])
+      );
+    return this._coinTypeToCoinNameMap;
+  }
+
+  /**
+   * @description
+   * Return maps of wormhole coin types to its coin name.
+   */
   get wormholeCoinTypeToCoinName() {
     if (this.isEmptyObject(this._wormholeCoinTypeToCoinNameMap))
       this._wormholeCoinTypeToCoinNameMap = Object.fromEntries(
@@ -162,27 +190,10 @@ export class ScallopConstants {
     return this._wormholeCoinTypeToCoinNameMap;
   }
 
-  get coinNameToCoinTypeMap() {
-    if (this.isEmptyObject(this._coinNameToCoinTypeMap))
-      this._coinNameToCoinTypeMap = Object.fromEntries(
-        Object.entries(this.poolAddresses)
-          .filter(([_, value]) => !!value)
-          .map(([_, value]) => [value!.coinName, value!.coinType])
-      );
-    return this._coinNameToCoinTypeMap;
-  }
-
-  get coinTypeToCoinNameMap() {
-    if (this.isEmptyObject(this._coinTypeToCoinNameMap))
-      this._coinTypeToCoinNameMap = Object.fromEntries(
-        Object.entries(this.coinNameToCoinTypeMap).map(([key, val]) => [
-          val,
-          key,
-        ])
-      );
-    return this._coinTypeToCoinNameMap;
-  }
-
+  /**
+   * @description
+   * Return maps of coin name to its old market coin type (...::reserve::MarketCoin<coinType>)
+   */
   get coinNameToOldMarketCoinTypeMap() {
     if (this.isEmptyObject(this._coinNameToOldMarketCoinTypeMap))
       this._coinNameToOldMarketCoinTypeMap = Object.fromEntries(
@@ -196,6 +207,10 @@ export class ScallopConstants {
     return this._coinNameToOldMarketCoinTypeMap;
   }
 
+  /**
+   * @description
+   * Return maps of sCoin raw name from its type to its sCoin name. (e.g. 'scallop_sui' -> 'ssui')
+   */
   get sCoinRawNameToScoinNameMap() {
     if (this.isEmptyObject(this._scoinRawNameToSCoinNameMap))
       this._scoinRawNameToSCoinNameMap = Object.fromEntries(
@@ -210,6 +225,10 @@ export class ScallopConstants {
     return this._scoinRawNameToSCoinNameMap;
   }
 
+  /**
+   * @description
+   * Return maps of scoin type to its sCoin name
+   */
   get sCoinTypeToSCoinNameMap() {
     if (this.isEmptyObject(this._scoinTypeToSCoinNameMap))
       this._scoinTypeToSCoinNameMap = Object.fromEntries(
@@ -221,6 +240,10 @@ export class ScallopConstants {
     return this._scoinTypeToSCoinNameMap;
   }
 
+  /**
+   * @description
+   * Return maps of volo coin type to its coin name
+   */
   get voloCoinTypeToCoinNameMap() {
     if (this.isEmptyObject(this._voloCoinTypeToCoinNameMap))
       this._voloCoinTypeToCoinNameMap = {
@@ -229,6 +252,10 @@ export class ScallopConstants {
     return this._voloCoinTypeToCoinNameMap;
   }
 
+  /**
+   * @description
+   * Return maps of sui bridge coin type to its coin name
+   */
   get suiBridgeCoinTypeToCoinNameMap() {
     if (this.isEmptyObject(this._suiBridgeCoinTypeToCoinNameMap))
       this._suiBridgeCoinTypeToCoinNameMap = Object.fromEntries(
@@ -242,6 +269,10 @@ export class ScallopConstants {
     return this._suiBridgeCoinTypeToCoinNameMap;
   }
 
+  /**
+   * @description
+   * Return maps of sCoin coin name to its coin type
+   */
   get sCoinTypes() {
     if (this.isEmptyObject(this._sCoinTypes))
       this._sCoinTypes = Object.fromEntries(
@@ -253,12 +284,20 @@ export class ScallopConstants {
     return this._sCoinTypes;
   }
 
+  /**
+   * @description
+   * Return set of supported coin types for borrow incentive rewards
+   * (all supported pools + sCoins + custom coins from `whitelist.borrowIncentiveRewards`)
+   */
   get supportedBorrowIncentiveRewards() {
-    return new Set([
-      ...Object.values(this.poolAddresses)
-        .filter((t) => !!t)
-        .map((t) => t?.coinName),
-    ]);
+    if (!this._supportedBorrowIncentiveRewards.size)
+      this._supportedBorrowIncentiveRewards = new Set([
+        ...Object.values(this.poolAddresses)
+          .filter((t) => !!t)
+          .map((t) => (t.sCoinName ? [t.coinName, t.sCoinName] : [t.coinName]))
+          .flat(),
+      ]);
+    return this._supportedBorrowIncentiveRewards;
   }
 
   private isEmptyObject(obj: Record<string, unknown>) {
@@ -291,12 +330,15 @@ export class ScallopConstants {
   async readWhiteList() {
     const response = await this.readApi<Record<keyof Whitelist, string[]>>({
       url:
-        this.params.whitelistApiUrl ?? 'https://sui.apis.scallop.io/whitelist',
+        this.params.whitelistApiUrl ??
+        `https://sui.apis.scallop.io/pool/whitelist`,
       queryKey: queryKeys.api.getWhiteList(),
     });
 
     return Object.fromEntries(
-      Object.entries(response).map(([key, value]) => [key, new Set(value)])
+      Object.entries(response)
+        .filter(([_, value]) => Array.isArray(value))
+        .map(([key, value]) => [key, new Set(value)])
     ) as Whitelist;
   }
 
@@ -304,7 +346,7 @@ export class ScallopConstants {
     return await this.readApi<Record<string, PoolAddress>>({
       url:
         this.params.poolAddressesApiUrl ??
-        `https://sui.apis.scallop.io/poolAddresses`,
+        `https://sui.apis.scallop.io/pool/addresses`,
       queryKey: queryKeys.api.getPoolAddresses(),
     });
   }
@@ -328,14 +370,30 @@ export class ScallopConstants {
       this.readWhiteList(),
       this.readPoolAddresses(),
     ]);
+
     if (!this.params.forceWhitelistInterface) {
-      this._whitelist = whitelistResponse;
+      this._whitelist = Object.fromEntries(
+        Object.entries(whitelistResponse)
+          .filter(([_, value]) => Array.isArray(value) || value instanceof Set)
+          .map(([key, value]) => [
+            key as keyof Whitelist,
+            value instanceof Set ? value : new Set(value),
+          ])
+      ) as Whitelist;
     }
-    if (!this.params.forcePoolAddressInterface)
+    if (!this.params.forcePoolAddressInterface) {
       this._poolAddresses = Object.fromEntries(
-        Object.entries(poolAddressesResponse).filter(([key]) =>
-          Object.values(this.whitelist).some((set) => set.has(key))
-        )
+        Object.entries(poolAddressesResponse)
+          .filter(([key]) =>
+            Object.values(this.whitelist).some((set) => set.has(key))
+          )
+          .map(([key, value]) => {
+            const parsedValue = Object.fromEntries(
+              Object.entries(value).map(([k, v]) => [k, v || undefined])
+            );
+            return [key, parsedValue as PoolAddress];
+          })
       );
+    }
   }
 }

package/src/models/scallopQuery.ts

@@ -43,15 +43,9 @@ import {
   getUserPortfolio,
   getPriceUpdatePolicies,
   getAssetOracles,
+  getOnDemandAggObjectIds,
 } from '../queries';
 import {
-  // string,
-  // string,
-  // string,
-  // string,
-  // string,
-  // string,
-  // string,
   ScallopQueryParams,
   StakePools,
   StakeRewardPools,
@@ -61,6 +55,7 @@ import {
   MarketPools,
   MarketCollaterals,
   xOracleRules,
+  SupportOracleType,
 } from '../types';
 import { ScallopAddress } from './scallopAddress';
 import { ScallopUtils } from './scallopUtils';
@@ -109,6 +104,7 @@ export class ScallopQuery {
 
     this.cache =
       instance?.utils?.cache ??
+      instance?.cache ??
       new ScallopCache(this.params, {
         suiKit: this.suiKit,
       });
@@ -173,15 +169,12 @@ export class ScallopQuery {
    * @param force - Whether to force initialization.
    * @param address - ScallopAddress instance.
    */
-  public async init(force: boolean = false, address?: ScallopAddress) {
-    if (address && !this.address) {
-      this.address = address;
-    }
-    if (force || !this.address.getAddresses()) {
-      await this.address.read();
+  public async init(force: boolean = false) {
+    if (force || !this.constants.isInitialized) {
+      await this.constants.init();
     }
 
-    await this.utils.init(force, this.address);
+    await this.utils.init(force);
   }
 
   /* ==================== Core Query Methods ==================== */
@@ -913,12 +906,21 @@ export class ScallopQuery {
     return [...this.constants.whitelist.lending].reduce(
       (acc, pool) => {
         acc[pool] = {
-          primary: primary?.[pool] ?? [],
-          secondary: secondary?.[pool] ?? [],
+          primary: (primary?.[pool] ?? []) as SupportOracleType[],
+          secondary: (secondary?.[pool] ?? []) as SupportOracleType[],
         };
         return acc;
       },
       {} as Record<string, xOracleRules>
     );
   }
+
+  /**
+   * Get switchboard on-demand aggregator object id based on coinType
+   * @param coinType
+   * @returns
+   */
+  public async getSwitchboardOnDemandAggregatorObjectIds(coinName: string[]) {
+    return await getOnDemandAggObjectIds(this, coinName);
+  }
 }

package/src/models/scallopUtils.ts

@@ -67,6 +67,7 @@ export class ScallopUtils {
 
     this.cache =
       instance?.constants?.cache ??
+      instance?.cache ??
       new ScallopCache(this.params, {
         suiKit: this.suiKit,
       });
@@ -111,10 +112,9 @@ export class ScallopUtils {
    * @param force - Whether to force initialization.
    * @param address - ScallopAddress instance.
    */
-  public async init(force: boolean = false, address?: ScallopAddress) {
-    if (address && !this.address) this.address = address;
-    if (force || !this.address.getAddresses()) {
-      await this.address.read();
+  public async init(force: boolean = false) {
+    if (force || !this.constants.isInitialized) {
+      await this.constants.init();
     }
   }
 
@@ -125,7 +125,10 @@ export class ScallopUtils {
    * @return Symbol string.
    */
   public parseSymbol(coinName: string) {
-    return this.constants.poolAddresses[coinName]?.symbol ?? '';
+    return this.isMarketCoin(coinName)
+      ? (this.constants.poolAddresses[this.parseCoinName(coinName)]
+          ?.sCoinSymbol ?? '')
+      : (this.constants.poolAddresses[coinName]?.symbol ?? '');
   }
 
   /**
@@ -143,7 +146,7 @@ export class ScallopUtils {
     if (useOldMarketCoin) {
       return this.constants.coinNameToOldMarketCoinTypeMap[coinName] ?? '';
     }
-    return this.constants.coinNameToCoinTypeMap[coinName] ?? '';
+    return this.constants.coinTypes[coinName] ?? '';
   }
 
   /**
@@ -248,7 +251,10 @@ export class ScallopUtils {
 
     if (isMarketCoinType) {
       return this.parseMarketCoinName(
-        parseStructTag(typeParams as any).name.toLowerCase()
+        (typeof typeParams[0] === 'string'
+          ? parseStructTag(typeParams[0])
+          : typeParams[0]
+        ).name.toLowerCase()
       );
     }
     const assetCoinName =
@@ -436,9 +442,9 @@ export class ScallopUtils {
         },
         [] as [string, string][]
       );
+      if (priceIdPairs.length === 0) break;
 
       const priceIds = priceIdPairs.map(([_, priceId]) => priceId);
-
       const pythConnection = new SuiPriceServiceConnection(endpoint, {
         timeout: 4000,
       });

package/src/queries/borrowIncentiveQuery.ts

@@ -174,8 +174,10 @@ export const queryBorrowIncentiveAccounts = async (
   const borrowIncentiveAccounts: BorrowIncentiveAccounts = Object.values(
     borrowIncentiveAccountsQueryData?.pool_records ?? []
   ).reduce((accounts, accountData) => {
-    const parsedBorrowIncentiveAccount =
-      parseOriginBorrowIncentiveAccountData(accountData);
+    const parsedBorrowIncentiveAccount = parseOriginBorrowIncentiveAccountData(
+      utils,
+      accountData
+    );
     const poolType = parsedBorrowIncentiveAccount.poolType;
     const coinName = utils.parseCoinNameFromType(poolType);
 

package/src/queries/coreQuery.ts

@@ -496,7 +496,7 @@ const parseMarketPoolObjects = ({
   collateralStat?: SuiObjectData;
   interestModel: SuiObjectData;
   riskModel?: SuiObjectData;
-  borrowFeeKey: SuiObjectData;
+  borrowFeeKey?: SuiObjectData;
   supplyLimitKey?: SuiObjectData;
   borrowLimitKey?: SuiObjectData;
   isolatedAssetKey: SuiObjectData;
@@ -506,7 +506,9 @@ const parseMarketPoolObjects = ({
   const _balanceSheet = parseObjectAs<BalanceSheet>(balanceSheet);
   const _interestModel = parseObjectAs<InterestModel>(interestModel);
   const _borrowDynamic = parseObjectAs<BorrowDynamic>(borrowDynamic);
-  const _borrowFee = parseObjectAs<BorrowFee>(borrowFeeKey);
+  const _borrowFee = borrowFeeKey
+    ? parseObjectAs<BorrowFee>(borrowFeeKey)
+    : { value: '0' };
   const _supplyLimit = supplyLimitKey
     ? parseObjectAs<string>(supplyLimitKey)
     : '0';

package/src/queries/index.ts

@@ -12,4 +12,5 @@ export * from './vescaQuery';
 export * from './borrowLimitQuery';
 export * from './poolAddressesQuery';
 export * from './objectsQuery';
+export * from './switchboardQuery';
 export * from './xOracleQuery';

package/src/queries/poolAddressesQuery.ts

@@ -188,7 +188,10 @@ export const getPoolAddresses = async (
       const { symbol, metaData: coinMetadataId } =
         addressApiResponse.core.coins[coinName];
 
-      let spoolData = undefined;
+      let spoolData = {
+        spool: '',
+        spoolReward: '',
+      };
       const _spoolData = addressApiResponse.spool.pools[`s${coinName}`];
       // @ts-ignore
       if (_spoolData) {
@@ -197,11 +200,15 @@ export const getPoolAddresses = async (
         spoolData = {
           spool,
           spoolReward,
-          coinMetadataId,
         };
       }
 
-      let sCoinData = undefined;
+      let sCoinData = {
+        sCoinType: '',
+        sCoinTreasury: '',
+        sCoinMetadataId: '',
+        sCoinSymbol: '',
+      };
       const sCoinName = `s${coinName}`;
       const _sCoinData = addressApiResponse.scoin.coins[sCoinName];
       if (_sCoinData) {
@@ -219,7 +226,21 @@ export const getPoolAddresses = async (
         };
       }
 
-      const { feed: pythFeed, feedObject: pythFeedObjectId } =
+      let pythData = {
+        pythFeed: '',
+        pythFeedObjectId: '',
+      };
+
+      if (addressApiResponse.core.coins[coinName]?.oracle.pyth) {
+        const { feed: pythFeed, feedObject: pythFeedObjectId } =
+          //@ts-ignore
+          addressApiResponse.core.coins[coinName].oracle.pyth;
+        pythData = {
+          pythFeed,
+          pythFeedObjectId,
+        };
+      }
+      const { feed: _pythFeed, feedObject: _pythFeedObjectId } =
         //@ts-ignore
         addressApiResponse.core.coins[coinName].oracle.pyth;
 
@@ -233,7 +254,6 @@ export const getPoolAddresses = async (
         )?.decimals ?? 0;
       const spoolName = spoolData ? `s${coinName}` : undefined;
 
-      // @TODO: add query for flashloanFeeObject
       results[coinName] = {
         coinName,
         symbol,
@@ -243,18 +263,17 @@ export const getPoolAddresses = async (
         interestModel: addresses[3] ?? '',
         riskModel: addresses[4],
         borrowFeeKey: addresses[5] ?? '',
-        supplyLimitKey: addresses[6],
-        borrowLimitKey: addresses[7],
-        isolatedAssetKey: addresses[8],
-        ...(spoolData ?? {}),
-        ...(sCoinData ?? {}),
+        supplyLimitKey: addresses[6] ?? '',
+        borrowLimitKey: addresses[7] ?? '',
+        isolatedAssetKey: addresses[8] ?? '',
+        ...spoolData,
+        ...sCoinData,
         sCoinName,
         coinMetadataId,
         coinType,
         spoolName,
         decimals,
-        pythFeed,
-        pythFeedObjectId,
+        ...pythData,
         flashloanFeeObject: flashloanFeeObjectIds[coinType] ?? '',
       };
 

package/src/queries/portfolioQuery.ts

@@ -42,9 +42,7 @@ export const getLendings = async (
     query.utils.parseMarketCoinName(poolCoinName)
   );
   const stakeMarketCoinNames = marketCoinNames.filter((marketCoinName) =>
-    ([...query.constants.whitelist.spool] as readonly string[]).includes(
-      marketCoinName
-    )
+    query.constants.whitelist.spool.has(marketCoinName)
   ) as string[];
 
   coinPrices = coinPrices ?? (await query.utils.getCoinPrices());
@@ -139,10 +137,7 @@ export const getLending = async (
     throw new Error(`Failed to fetch marketPool for ${poolCoinName}`);
 
   spool =
-    (spool ??
-    ([...query.constants.whitelist.spool] as readonly string[]).includes(
-      marketCoinName
-    ))
+    (spool ?? query.constants.whitelist.spool.has(marketCoinName))
       ? await query.getSpool(marketCoinName as string, {
           indexer,
           marketPool,
@@ -155,10 +150,7 @@ export const getLending = async (
   // if (!spool) throw new Error(`Failed to fetch spool for ${poolCoinName}`);
 
   stakeAccounts =
-    stakeAccounts ||
-    ([...query.constants.whitelist.spool] as readonly string[]).includes(
-      marketCoinName
-    )
+    stakeAccounts || query.constants.whitelist.spool.has(marketCoinName)
       ? await query.getStakeAccounts(marketCoinName as string, ownerAddress)
       : [];
   coinAmount =
@@ -549,7 +541,6 @@ export const getObligationAccount = async (
             borrowIncentivePool.points[
               query.utils.parseSCoinTypeNameToMarketCoinName(key)
             ];
-
           if (accountPoint && poolPoint) {
             let availableClaimAmount = BigNumber(0);
             let availableClaimCoin = BigNumber(0);
@@ -599,6 +590,7 @@ export const getObligationAccount = async (
                 symbol: poolPoint.symbol,
                 coinDecimal: poolPoint.coinDecimal,
                 coinPrice: poolPoint.coinPrice,
+                weightedBorrowAmount: accountBorrowedAmount.toNumber(),
                 availableClaimAmount: availableClaimAmount.toNumber(),
                 availableClaimCoin: availableClaimCoin.toNumber(),
                 boostValue,