ux: include token balance in my portfolio tool

Author: coccoinomane

projects/pendle/README.md

@@ -15,7 +15,10 @@ More information on Pendle Finance can be found on their own academy page: https
     - Show my pools on Pendle
     - Value of my stETH position on Base chain on Pendle
 
-Please note that most portfolio tools return positions across all chains, without the need to specify the chain.
+Please note that:
+
+- portfolio tools return positions across all chains, without the need to specify the chain
+- for each position both the token balance and dollar valuations will be shown
 
 ### Available markets & pools
 

projects/pendle/examples/flattenPositions.ts

@@ -41,7 +41,7 @@ export const MIN_LIQUIDITY_FOR_MARKET = 100000;
 /**
  * Default slippage tolerance
  */
-export const DEFAULT_SLIPPAGE_TOLERANCE = 0.02;
+export const DEFAULT_SLIPPAGE_TOLERANCE = 0.01;
 
 /**
  * The address used by Pendle API to identify the native token

projects/pendle/src/constants.ts

@@ -4,7 +4,8 @@ import { flattenAndSortPositions, formatFlattenedPositions } from '../helpers/po
 import { MAX_POSITIONS_IN_RESULTS } from '../constants';
 import { getChainNameFromChainId } from '../helpers/chains';
 import { fetchTokenInfoFromAddress } from '../helpers/tokens';
-import { toHumanReadableAmount } from '../helpers/format';
+import { to$$$ } from '../helpers/format';
+import { formatUnits } from 'viem';
 
 interface Props {}
 
@@ -26,7 +27,7 @@ export async function getMyPositionsPortfolio(_props: Props, { notify, evm: { ge
 
     // Build and return output string
     const parts = [
-        `Found ${flattenedResult.totalPositions} positions in your portfolio, worth a total of $${flattenedResult.totalValuation.toFixed(2)}`,
+        `Found ${flattenedResult.totalPositions} positions in your portfolio, worth a total of ${to$$$(flattenedResult.totalValuation)}`,
         firstNPositions.length !== flattenedResult.totalPositions ? `Showing the top ${MAX_POSITIONS_IN_RESULTS} positions by value:` : '',
         formattedOutput,
     ];
@@ -42,11 +43,13 @@ export async function getMyPositionsPortfolio(_props: Props, { notify, evm: { ge
                 const chainName = getChainNameFromChainId(chain.chainId);
                 const subparts = [];
                 for (const syPosition of chain.syPositions) {
+                    if (syPosition.balance === '0') {
+                        continue;
+                    }
                     const tokenAddress = syPosition.syId.split('-')[1] as `0x${string}`;
                     const provider = getProvider(chain.chainId);
                     const tokenInfo = await fetchTokenInfoFromAddress(provider, tokenAddress);
-                    const humanReadableBalance = toHumanReadableAmount(BigInt(syPosition.balance), tokenInfo.decimals);
-                    subparts.push(`${humanReadableBalance} ${tokenInfo.symbol}`);
+                    subparts.push(`${formatUnits(BigInt(syPosition.balance), tokenInfo.decimals)} ${tokenInfo.symbol}`);
                 }
                 parts.push(` - ${chainName} chain: ${subparts.join(', ')}`);
             }

projects/pendle/src/functions/getMyPositionsPortfolio.ts

@@ -43,9 +43,9 @@ export function formatMarketData(marketData: GetMarketDataResponse, market: Mark
     parts.push(` - The underlying asset earns an APY of ${(marketData.underlyingApy * 100).toFixed(2)}%`);
     parts.push(` - Providing liquidity earns you from ${(market.details.aggregatedApy * 100).toFixed(2)}% to ${(market.details.maxBoostedApy * 100).toFixed(2)}% APY (max boost)`);
     if (includeTokensAddresses) {
-        parts.push(` - PT address: ${market.pt}`);
-        parts.push(` - YT address: ${market.yt}`);
-        parts.push(` - SY address: ${market.sy}`);
+        parts.push(` - PT address: ${market.pt.split('-')[1]}`);
+        parts.push(` - YT address: ${market.yt.split('-')[1]}`);
+        parts.push(` - SY address: ${market.sy.split('-')[1]}`);
         parts.push(` - LP address: ${market.address}`);
         parts.push(` - Underlying asset address: ${market.underlyingAsset}`);
     }

projects/pendle/src/helpers/markets.ts

@@ -1,5 +1,7 @@
 import { getChainNameFromChainId } from './chains';
-import { MarketCompactData, ChainPositions, PendleClient, MarketPosition } from './client';
+import { MarketCompactData, ChainPositions, PendleClient, MarketPosition, PendleAsset } from './client';
+import { to$$$ } from './format';
+import { formatUnits } from 'viem';
 
 /**
  * Represents a single token position (PT, YT, or LP) with its context
@@ -11,6 +13,8 @@ export type FlattenedTokenPosition = {
     marketId: string;
     /** Token type: PT, YT, or LP */
     tokenType: 'PT' | 'YT' | 'LP';
+    /** Token address */
+    tokenAddress?: `0x${string}`;
     /** Position type: open or closed */
     positionStatus: 'open' | 'closed';
     /** Valuation in USD */
@@ -31,8 +35,10 @@ export type FlattenedTokenPosition = {
     marketLpNonBoostedApy?: number;
     /** Market implied APY, that is, the APY at which the market trades (different from underlying APY) */
     marketImpliedApy?: number;
-    /** Full market details (optional) */
+    /** Full market details */
     market?: MarketCompactData;
+    /** Full asset details */
+    asset?: PendleAsset;
 };
 
 /**
@@ -67,7 +73,7 @@ export async function flattenAndSortPositions(
 
     // Helper function to process a single PT, YT, or
     // LP market position
-    const processMarketPosition = (
+    const processMarketPosition = async (
         market: MarketPosition,
         chain: ChainPositions,
         chainName: string,
@@ -81,31 +87,46 @@ export async function flattenAndSortPositions(
             throw new Error(`Market data not found for market ${marketAddress}`);
         }
 
+        // Get all assets
+        const assets = await pendleClient.getAllAssets(chain.chainId);
+
         // Process each token type (PT, YT, LP)
         const tokenTypes: Array<'pt' | 'yt' | 'lp'> = ['pt', 'yt', 'lp'];
 
         for (const tokenKey of tokenTypes) {
-            const token = market[tokenKey];
-            if (token && (includeZeroPositions || token.balance !== '0')) {
+            const pos = market[tokenKey];
+            if (pos && (includeZeroPositions || pos.balance !== '0')) {
+                // Extract token address of position
+                let tokenAddress: `0x${string}`;
+                if (tokenKey === 'lp') {
+                    tokenAddress = marketData.address;
+                } else {
+                    tokenAddress = marketData[tokenKey].split('-')[1] as `0x${string}`;
+                }
+                // Get asset details
+                const asset = assets.find((a) => a.address === tokenAddress);
+                // Build flattened position row
                 flattenedPositions.push({
                     chainId: chain.chainId,
                     chainName,
                     marketId: market.marketId,
                     tokenType: tokenKey.toUpperCase() as 'PT' | 'YT' | 'LP',
+                    tokenAddress,
                     positionStatus,
-                    valuation: token.valuation || 0,
-                    balance: token.balance,
-                    activeBalance: token.activeBalance,
-                    claimTokenAmounts: token.claimTokenAmounts,
+                    valuation: pos.valuation || 0,
+                    balance: pos.balance,
+                    activeBalance: pos.activeBalance,
+                    claimTokenAmounts: pos.claimTokenAmounts,
                     marketName: marketData.name,
                     marketExpiry: marketData.expiry,
                     marketLpNonBoostedApy: marketData.details.aggregatedApy,
                     marketImpliedApy: marketData.details.impliedApy,
                     market: marketData,
+                    asset,
                 });
 
-                if (token.valuation > 0) {
-                    totalValuation += token.valuation;
+                if (pos.valuation) {
+                    totalValuation += pos.valuation;
                 }
             }
         }
@@ -123,14 +144,14 @@ export async function flattenAndSortPositions(
         // Process open positions
         if (chain.openPositions) {
             for (const market of chain.openPositions) {
-                processMarketPosition(market, chain, chainName, 'open', marketDetailsMap);
+                await processMarketPosition(market, chain, chainName, 'open', marketDetailsMap);
             }
         }
 
         // Process closed positions if requested
         if (includeClosedPositions && chain.closedPositions) {
             for (const market of chain.closedPositions) {
-                processMarketPosition(market, chain, chainName, 'closed', marketDetailsMap);
+                await processMarketPosition(market, chain, chainName, 'closed', marketDetailsMap);
             }
         }
     }
@@ -169,39 +190,52 @@ export function formatFlattenedPositions(flattenedPositions: FlattenedTokenPosit
         switch (position.tokenType) {
             case 'LP':
                 if (position.marketLpNonBoostedApy) {
-                    apyString = `(unboosted APY: ${(100 * position.marketLpNonBoostedApy).toFixed(2)}%)`;
+                    apyString = `unboosted APY: ${(100 * position.marketLpNonBoostedApy).toFixed(2)}%`;
                 }
                 break;
             case 'YT':
                 if (position.marketImpliedApy) {
-                    apyString = `(implied APY: ${(100 * position.marketImpliedApy).toFixed(2)}%)`;
+                    apyString = `implied APY: ${(100 * position.marketImpliedApy).toFixed(2)}%`;
                 }
                 break;
             case 'PT':
                 break;
         }
 
-        let parts: string[] = [
-            `$${position.valuation.toFixed(2)}`,
-            `${position.tokenType}`,
-            `${position.positionStatus === 'closed' ? '(closed)' : ''}`,
-            `position`,
-            `on ${position.marketName} market`,
-            `on ${position.chainName} chain`,
-            `${apyString}`,
-        ].filter(Boolean); // Remove empty strings
-
-        // Add expiry if available
+        let expiryString = '';
         if (position.marketExpiry) {
-            parts.push(`expires ${position.marketExpiry}`);
+            expiryString = `expires on ${position.marketExpiry}`;
         }
 
-        // Add claimable yield indicator
+        let claimableYieldString = '';
         if (position.claimTokenAmounts && position.claimTokenAmounts.length > 0) {
-            parts.push(`(has claimable yield)`);
+            claimableYieldString = `has claimable yield`;
+        }
+
+        let balanceString = '';
+        if (position.asset?.decimals) {
+            balanceString = `${formatUnits(BigInt(position.balance), position.asset.decimals)} ${position.tokenType} tokens`;
+        }
+
+        let parts: string[] = [
+            `${to$$$(position.valuation)}`,
+            `${position.tokenType}`,
+            `${position.positionStatus === 'closed' ? 'closed' : ''}`,
+            `position`,
+            `on ${position.marketName} market`,
+            `on ${position.chainName} chain:`,
+            `${balanceString},`,
+            `${apyString ? `${apyString},` : ''}`,
+            `${expiryString ? `${expiryString},` : ''}`,
+            `${claimableYieldString ? `${claimableYieldString},` : ''}`,
+        ];
+
+        // Remove last comma if it exists
+        if (parts[parts.length - 1] === ',') {
+            parts.pop();
         }
 
-        formattedParts.push(parts.join(' '));
+        formattedParts.push(parts.filter(Boolean).join(' '));
     }
     return formattedParts.join('\n').replace(/^/gm, linePrefix);
 }