@scallop-io/sui-scallop-sdk 1.4.7 → 1.4.8

package/dist/models/scallopQuery.d.ts

@@ -353,6 +353,7 @@ export declare class ScallopQuery {
     getLendings(poolCoinNames?: SupportPoolCoins[], ownerAddress?: string, args?: {
         indexer?: boolean;
         marketPools?: MarketPools;
+        coinPrices?: CoinPrices;
     }): Promise<{
         usdc?: import("../types").Lending | undefined;
         sbeth?: import("../types").Lending | undefined;
@@ -399,6 +400,7 @@ export declare class ScallopQuery {
             collaterals: MarketCollaterals;
             pools: MarketPools;
         };
+        coinPrices?: CoinPrices;
     }): Promise<{
         [x: string]: import("../types").ObligationAccount | undefined;
     }>;
@@ -595,54 +597,60 @@ export declare class ScallopQuery {
         walletAddress?: string;
         indexer?: boolean;
     }): Promise<{
+        totalLockedScaValue: number;
         lendings: {
-            totalSupplyValue: number;
-            suppliedPools: {
-                suppliedCoin: number;
-                suppliedValue: number;
-                stakedCoin: number;
+            suppliedCoin: number;
+            suppliedValue: number;
+            stakedCoin: number;
+            coinName: "usdc" | "sbeth" | "weth" | "wbtc" | "wusdc" | "wusdt" | "sui" | "wapt" | "wsol" | "cetus" | "afsui" | "hasui" | "vsui" | "sca" | "fud" | "deep" | "fdusd";
+            symbol: string;
+            coinType: string;
+            coinPrice: number;
+            coinDecimals: number;
+            supplyApr: number;
+            supplyApy: number;
+            incentiveApr: number;
+        }[];
+        borrowings: {
+            obligationId: string;
+            totalDebtsInUsd: number;
+            totalCollateralInUsd: number;
+            riskLevel: number;
+            availableCollateralInUsd: number;
+            totalUnhealthyCollateralInUsd: number;
+            borrowedPools: {
                 coinName: "usdc" | "sbeth" | "weth" | "wbtc" | "wusdc" | "wusdt" | "sui" | "wapt" | "wsol" | "cetus" | "afsui" | "hasui" | "vsui" | "sca" | "fud" | "deep" | "fdusd";
                 symbol: string;
+                coinDecimals: number;
                 coinType: string;
                 coinPrice: number;
-                coinDecimals: number;
-                supplyApr: number;
-                supplyApy: number;
-                incentiveApr: number;
-            }[];
-        };
-        borrowings: {
-            obligations: {
-                obligationId: string;
-                totalDebtsInUsd: number;
-                totalCollateralInUsd: number;
-                riskLevel: number;
-                availableCollateralInUsd: number;
-                totalUnhealthyCollateralInUsd: number;
-                borrowedPools: {
-                    coinName: "usdc" | "sbeth" | "weth" | "wbtc" | "wusdc" | "wusdt" | "sui" | "wapt" | "wsol" | "cetus" | "afsui" | "hasui" | "vsui" | "sca" | "fud" | "deep" | "fdusd";
+                borrowedCoin: number;
+                borrowedValueInUsd: number;
+                borrowApr: number | undefined;
+                borrowApy: number | undefined;
+                incentiveInfos: {
+                    coinName: "usdc" | "sbeth" | "weth" | "wbtc" | "wusdc" | "wusdt" | "sui" | "wapt" | "wsol" | "cetus" | "afsui" | "hasui" | "vsui" | "sca" | "fud" | "deep" | "fdusd" | "susdc" | "ssbeth" | "sweth" | "swbtc" | "swusdc" | "swusdt" | "ssui" | "swsol" | "scetus" | "safsui" | "shasui" | "svsui" | "ssca" | "sfud" | "sdeep" | "sfdusd";
                     symbol: string;
-                    coinDecimals: number;
                     coinType: string;
-                    coinPrice: number;
-                    borrowedCoin: number;
-                    borrowedValueInUsd: number;
-                    borrowApr: number | undefined;
-                    borrowApy: number | undefined;
-                    incentiveInfos: {
-                        coinName: "usdc" | "sbeth" | "weth" | "wbtc" | "wusdc" | "wusdt" | "sui" | "wapt" | "wsol" | "cetus" | "afsui" | "hasui" | "vsui" | "sca" | "fud" | "deep" | "fdusd" | "susdc" | "ssbeth" | "sweth" | "swbtc" | "swusdc" | "swusdt" | "ssui" | "swsol" | "scetus" | "safsui" | "shasui" | "svsui" | "ssca" | "sfud" | "sdeep" | "sfdusd";
-                        symbol: string;
-                        coinType: string;
-                        incentiveApr: number;
-                    }[];
+                    incentiveApr: number;
                 }[];
             }[];
-            totalDebtValue: number;
-            totalCollateralValue: number;
-        };
+        }[];
         pendingRewards: {
             lendings: any;
             borrowIncentives: any;
         };
+        veScas: {
+            veScaKey: string;
+            coinPrice: number;
+            lockedScaInCoin: number;
+            lockedScaInUsd: number;
+            currentVeScaBalance: number;
+            remainingLockPeriodInDays: number;
+            unlockAt: number;
+        }[];
+        totalDebtValue: number;
+        totalCollateralValue: number;
+        totalSupplyValue: number;
     }>;
 }

package/dist/queries/portfolioQuery.d.ts

@@ -10,7 +10,7 @@ import { SuiObjectRef } from '@mysten/sui/client';
  * @param indexer - Whether to use indexer.
  * @return User lending infomation for specific pools.
  */
-export declare const getLendings: (query: ScallopQuery, poolCoinNames?: SupportPoolCoins[], ownerAddress?: string, marketPools?: MarketPools, indexer?: boolean) => Promise<{
+export declare const getLendings: (query: ScallopQuery, poolCoinNames?: SupportPoolCoins[], ownerAddress?: string, marketPools?: MarketPools, coinPrices?: CoinPrices, indexer?: boolean) => Promise<{
     usdc?: Lending | undefined;
     sbeth?: Lending | undefined;
     weth?: Lending | undefined;
@@ -58,7 +58,7 @@ export declare const getLending: (query: ScallopQuery, poolCoinName: SupportPool
 export declare const getObligationAccounts: (query: ScallopQuery, ownerAddress?: string, market?: {
     pools: MarketPools;
     collaterals: MarketCollaterals;
-}, indexer?: boolean) => Promise<{
+}, coinPrices?: CoinPrices, indexer?: boolean) => Promise<{
     [x: string]: ObligationAccount | undefined;
 }>;
 /**
@@ -82,53 +82,59 @@ export declare const getTotalValueLocked: (query: ScallopQuery, indexer?: boolea
  * Get user portfolio by wallet address
  */
 export declare const getUserPortfolio: (query: ScallopQuery, walletAddress: string, indexer?: boolean) => Promise<{
+    totalLockedScaValue: number;
     lendings: {
-        totalSupplyValue: number;
-        suppliedPools: {
-            suppliedCoin: number;
-            suppliedValue: number;
-            stakedCoin: number;
+        suppliedCoin: number;
+        suppliedValue: number;
+        stakedCoin: number;
+        coinName: "usdc" | "sbeth" | "weth" | "wbtc" | "wusdc" | "wusdt" | "sui" | "wapt" | "wsol" | "cetus" | "afsui" | "hasui" | "vsui" | "sca" | "fud" | "deep" | "fdusd";
+        symbol: string;
+        coinType: string;
+        coinPrice: number;
+        coinDecimals: number;
+        supplyApr: number;
+        supplyApy: number;
+        incentiveApr: number;
+    }[];
+    borrowings: {
+        obligationId: string;
+        totalDebtsInUsd: number;
+        totalCollateralInUsd: number;
+        riskLevel: number;
+        availableCollateralInUsd: number;
+        totalUnhealthyCollateralInUsd: number;
+        borrowedPools: {
             coinName: "usdc" | "sbeth" | "weth" | "wbtc" | "wusdc" | "wusdt" | "sui" | "wapt" | "wsol" | "cetus" | "afsui" | "hasui" | "vsui" | "sca" | "fud" | "deep" | "fdusd";
             symbol: string;
+            coinDecimals: number;
             coinType: string;
             coinPrice: number;
-            coinDecimals: number;
-            supplyApr: number;
-            supplyApy: number;
-            incentiveApr: number;
-        }[];
-    };
-    borrowings: {
-        obligations: {
-            obligationId: string;
-            totalDebtsInUsd: number;
-            totalCollateralInUsd: number;
-            riskLevel: number;
-            availableCollateralInUsd: number;
-            totalUnhealthyCollateralInUsd: number;
-            borrowedPools: {
-                coinName: "usdc" | "sbeth" | "weth" | "wbtc" | "wusdc" | "wusdt" | "sui" | "wapt" | "wsol" | "cetus" | "afsui" | "hasui" | "vsui" | "sca" | "fud" | "deep" | "fdusd";
+            borrowedCoin: number;
+            borrowedValueInUsd: number;
+            borrowApr: number | undefined;
+            borrowApy: number | undefined;
+            incentiveInfos: {
+                coinName: "usdc" | "sbeth" | "weth" | "wbtc" | "wusdc" | "wusdt" | "sui" | "wapt" | "wsol" | "cetus" | "afsui" | "hasui" | "vsui" | "sca" | "fud" | "deep" | "fdusd" | "susdc" | "ssbeth" | "sweth" | "swbtc" | "swusdc" | "swusdt" | "ssui" | "swsol" | "scetus" | "safsui" | "shasui" | "svsui" | "ssca" | "sfud" | "sdeep" | "sfdusd";
                 symbol: string;
-                coinDecimals: number;
                 coinType: string;
-                coinPrice: number;
-                borrowedCoin: number;
-                borrowedValueInUsd: number;
-                borrowApr: number | undefined;
-                borrowApy: number | undefined;
-                incentiveInfos: {
-                    coinName: "usdc" | "sbeth" | "weth" | "wbtc" | "wusdc" | "wusdt" | "sui" | "wapt" | "wsol" | "cetus" | "afsui" | "hasui" | "vsui" | "sca" | "fud" | "deep" | "fdusd" | "susdc" | "ssbeth" | "sweth" | "swbtc" | "swusdc" | "swusdt" | "ssui" | "swsol" | "scetus" | "safsui" | "shasui" | "svsui" | "ssca" | "sfud" | "sdeep" | "sfdusd";
-                    symbol: string;
-                    coinType: string;
-                    incentiveApr: number;
-                }[];
+                incentiveApr: number;
             }[];
         }[];
-        totalDebtValue: number;
-        totalCollateralValue: number;
-    };
+    }[];
     pendingRewards: {
         lendings: any;
         borrowIncentives: any;
     };
+    veScas: {
+        veScaKey: string;
+        coinPrice: number;
+        lockedScaInCoin: number;
+        lockedScaInUsd: number;
+        currentVeScaBalance: number;
+        remainingLockPeriodInDays: number;
+        unlockAt: number;
+    }[];
+    totalDebtValue: number;
+    totalCollateralValue: number;
+    totalSupplyValue: number;
 }>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scallop-io/sui-scallop-sdk",
-  "version": "1.4.7",
+  "version": "1.4.8",
   "description": "Typescript sdk for interacting with Scallop contract on SUI",
   "keywords": [
     "sui",

package/src/models/scallopQuery.ts

@@ -577,13 +577,18 @@ export class ScallopQuery {
   public async getLendings(
     poolCoinNames?: SupportPoolCoins[],
     ownerAddress: string = this.walletAddress,
-    args?: { indexer?: boolean; marketPools?: MarketPools }
+    args?: {
+      indexer?: boolean;
+      marketPools?: MarketPools;
+      coinPrices?: CoinPrices;
+    }
   ) {
     return await getLendings(
       this,
       poolCoinNames,
       ownerAddress,
       args?.marketPools,
+      args?.coinPrices,
       args?.indexer
     );
   }
@@ -622,12 +627,14 @@ export class ScallopQuery {
         collaterals: MarketCollaterals;
         pools: MarketPools;
       };
+      coinPrices?: CoinPrices;
     }
   ) {
     return await getObligationAccounts(
       this,
       ownerAddress,
       args?.market,
+      args?.coinPrices,
       args?.indexer
     );
   }

package/src/queries/poolAddressesQuery.ts

@@ -141,7 +141,7 @@ export const getAllAddresses = async (query: ScallopQuery) => {
         sCoinTreasury,
         sCoinType,
         coinDecimalId,
-        coinType,
+        coinType: `0x${coinType}`,
       };
 
       await new Promise((resolve) => setTimeout(resolve, 200));

package/src/queries/portfolioQuery.ts

@@ -47,6 +47,7 @@ export const getLendings = async (
   poolCoinNames: SupportPoolCoins[] = [...SUPPORT_POOLS],
   ownerAddress?: string,
   marketPools?: MarketPools,
+  coinPrices?: CoinPrices,
   indexer: boolean = false
 ) => {
   const marketCoinNames = poolCoinNames.map((poolCoinName) =>
@@ -56,7 +57,7 @@ export const getLendings = async (
     (SUPPORT_SPOOLS as readonly SupportMarketCoins[]).includes(marketCoinName)
   ) as SupportStakeMarketCoins[];
 
-  const coinPrices = await query.utils.getCoinPrices();
+  coinPrices = coinPrices ?? (await query.utils.getCoinPrices());
   marketPools =
     marketPools ??
     (
@@ -321,12 +322,15 @@ export const getObligationAccounts = async (
     pools: MarketPools;
     collaterals: MarketCollaterals;
   },
+  coinPrices?: CoinPrices,
   indexer: boolean = false
 ) => {
   market = market ?? (await query.getMarketPools(undefined, { indexer }));
-  const coinPrices = await query.getAllCoinPrices({
-    marketPools: market.pools,
-  });
+  coinPrices =
+    coinPrices ??
+    (await query.getAllCoinPrices({
+      marketPools: market.pools,
+    }));
   const [coinAmounts, obligations] = await Promise.all([
     query.getCoinAmounts(undefined, ownerAddress),
     query.getObligations(ownerAddress),
@@ -856,20 +860,26 @@ export const getUserPortfolio = async (
   walletAddress: string,
   indexer: boolean = false
 ) => {
-  const market = await query.getMarketPools();
-  const [lendings, obligationAccounts, borrowIncentivePools] =
+  const coinPrices = await query.utils.getCoinPrices();
+  const market = await query.getMarketPools(undefined, { indexer, coinPrices });
+
+  const [lendings, obligationAccounts, borrowIncentivePools, veScas] =
     await Promise.all([
       query.getLendings(undefined, walletAddress, {
         indexer,
         marketPools: market.pools,
+        coinPrices,
       }),
       query.getObligationAccounts(walletAddress, {
         indexer,
         market: market,
+        coinPrices,
       }),
       query.getBorrowIncentivePools(undefined, {
         marketPools: market.pools,
+        coinPrices,
       }),
+      query.getVeScas({ walletAddress, excludeEmpty: true }),
     ]);
 
   // get pending rewards (spool and borrow incentive)
@@ -988,31 +998,45 @@ export const getUserPortfolio = async (
         }
       >
     );
+
+  const parsedVeScas = veScas.map(
+    ({ keyId, lockedScaCoin, currentVeScaBalance, unlockAt }) => ({
+      veScaKey: keyId,
+      coinPrice: coinPrices.sca ?? 0,
+      lockedScaInCoin: lockedScaCoin,
+      lockedScaInUsd: lockedScaCoin * (coinPrices.sca ?? 0),
+      currentVeScaBalance,
+      remainingLockPeriodInDays:
+        unlockAt - Date.now() > 0 ? (unlockAt - Date.now()) / 86400000 : 0,
+      unlockAt,
+    })
+  );
+
   return {
-    lendings: {
-      totalSupplyValue: parsedLendings.reduce((acc, curr) => {
-        acc += curr.suppliedValue;
+    totalSupplyValue: parsedLendings.reduce((acc, curr) => {
+      acc += curr.suppliedValue;
+      return acc;
+    }, 0),
+    ...parsedObligationAccounts.reduce(
+      (acc, curr) => {
+        acc.totalDebtValue += curr.totalDebtsInUsd;
+        acc.totalCollateralValue += curr.totalCollateralInUsd;
         return acc;
-      }, 0),
-      suppliedPools: parsedLendings,
-    },
-    borrowings: {
-      ...parsedObligationAccounts.reduce(
-        (acc, curr) => {
-          acc.totalDebtValue += curr.totalDebtsInUsd;
-          acc.totalCollateralValue += curr.totalCollateralInUsd;
-          return acc;
-        },
-        {
-          totalDebtValue: 0,
-          totalCollateralValue: 0,
-        } as {
-          totalDebtValue: number;
-          totalCollateralValue: number;
-        }
-      ),
-      obligations: parsedObligationAccounts,
-    },
+      },
+      {
+        totalDebtValue: 0,
+        totalCollateralValue: 0,
+      } as {
+        totalDebtValue: number;
+        totalCollateralValue: number;
+      }
+    ),
+    totalLockedScaValue: parsedVeScas.reduce((acc, curr) => {
+      acc += curr.lockedScaInUsd;
+      return acc;
+    }, 0),
+    lendings: parsedLendings,
+    borrowings: parsedObligationAccounts,
     pendingRewards: {
       lendings: Object.entries(pendingLendingRewards).reduce(
         (acc, [key, value]) => {
@@ -1037,5 +1061,6 @@ export const getUserPortfolio = async (
         [] as any
       ),
     },
+    veScas: parsedVeScas,
   };
 };