build: adds correct vault doc links and tooltip (#1275)

notional-finance · Nov 21, 2024 · ab68337 · ab68337
1 parent b553112
commit ab68337
Show file tree

Hide file tree

Showing 5 changed files with 43 additions and 7 deletions.
diff --git a/packages/core-entities/src/config/whitelisted-vaults.ts b/packages/core-entities/src/config/whitelisted-vaults.ts
@@ -221,3 +221,30 @@ export function getVaultType(
     return 'SingleSidedLP_AutoReinvest';
   }
 }
+
+export function getVaultDocsLink(
+  vaultAddress?: string,
+  network?: Network
+): string {
+  if (
+    vaultAddress &&
+    network &&
+    PendlePTVaults[network].includes(vaultAddress.toLowerCase())
+  ) {
+    return 'https://docs.notional.finance/notional-v3/product-guides/leveraged-pendle-pts';
+  } else if (
+    vaultAddress &&
+    network &&
+    SingleSidedLP_DirectClaim[network].includes(vaultAddress.toLowerCase())
+  ) {
+    return 'https://docs.notional.finance/notional-v3/product-guides/leveraged-yield-farming';
+  } else if (
+    vaultAddress &&
+    network &&
+    Object.keys(PointsMultipliers[network]).includes(vaultAddress.toLowerCase())
+  ) {
+    return 'https://docs.notional.finance/notional-v3/product-guides/leveraged-points-farming';
+  } else {
+    return 'https://docs.notional.finance/notional-v3/product-guides/leveraged-yield-farming';
+  }
+}
diff --git a/packages/features/vault/src/hooks/use-vault-faq.tsx b/packages/features/vault/src/hooks/use-vault-faq.tsx
@@ -4,7 +4,7 @@ import { Box } from '@mui/material';
 import { Body } from '@notional-finance/mui';
 import { RiskFaq } from '../components';
 import { HowItWorksFaq, HowItWorksFaqPendle } from '../components';
-import { VaultType } from '@notional-finance/core-entities';
+import { getVaultDocsLink, VaultType } from '@notional-finance/core-entities';
 import {
   getEtherscanAddressLink,
   Network,
@@ -22,11 +22,13 @@ export const useVaultFaq = (
   selectedNetwork: Network | undefined,
   tokenSymbol: string | undefined,
   points: Record<string, number> | undefined,
-  currentVaultType?: VaultType | undefined
+  currentVaultType?: VaultType | undefined,
+  vaultAddress?: string
 ) => {
+  const docsLink = getVaultDocsLink(vaultAddress, selectedNetwork);
   const faqHeaderLinks = [
     {
-      href: 'https://docs.notional.finance/notional-v3/product-guides/leveraged-vaults',
+      href: docsLink,
       text: (
         <FormattedMessage defaultMessage={'Leveraged Vault Documentation'} />
       ),

diff --git a/packages/features/vault/src/hooks/use-vault-strategy-data.tsx b/packages/features/vault/src/hooks/use-vault-strategy-data.tsx
@@ -1,5 +1,6 @@
 import { useContext } from 'react';
 import { VaultActionContext } from '../vault';
+import { getVaultDocsLink } from '@notional-finance/core-entities';
 
 export interface VaultsDataProps {
   vaultName: string;
@@ -12,15 +13,16 @@ export interface VaultsDataProps {
 
 export const useVaultStrategyData = () => {
   const { state } = useContext(VaultActionContext);
-  const { vaultConfig, deposit } = state;
+  const { vaultConfig, deposit, selectedNetwork, vaultAddress } = state;
+  const docsLink = getVaultDocsLink(vaultAddress, selectedNetwork);
+
   if (!vaultConfig) return undefined;
 
   return {
     baseProtocol: vaultConfig.baseProtocol,
     boosterProtocol: vaultConfig.boosterProtocol,
     primaryBorrowCurrency: deposit?.symbol,
     poolName: vaultConfig.poolName,
-    docsLink:
-      'https://docs.notional.finance/notional-v3/product-guides/leveraged-vaults',
+    docsLink,
   };
 };
diff --git a/packages/features/vault/src/vault-view/vault-summary.tsx b/packages/features/vault/src/vault-view/vault-summary.tsx
@@ -36,7 +36,8 @@ export const VaultSummary = () => {
     selectedNetwork,
     deposit?.symbol,
     points,
-    vaultType
+    vaultType,
+    vaultAddress
   );
 
   return (

diff --git a/packages/shared/notionable-hooks/src/summary/use-trade-summary.tsx b/packages/shared/notionable-hooks/src/summary/use-trade-summary.tsx
@@ -979,6 +979,10 @@ export function useTradeSummary(state: VaultTradeState | TradeState) {
           content: defineMessage({
             defaultMessage: 'Difference from Oracle Price',
           }),
+          toolTipContent: defineMessage({
+            defaultMessage:
+              'The difference between the position value at oracle prices vs. traded market prices.',
+          }),
         },
       },
       value: {