feat: update lens and filtering logic to check for inflation protection (#110)

haydenshively · web-flow · commit 34b4e69d5419 · 2025-11-04T16:46:33.000-05:00
diff --git a/apps/lite/src/app/dashboard/borrow-subpage.tsx b/apps/lite/src/app/dashboard/borrow-subpage.tsx
@@ -3,7 +3,11 @@ import { restructure } from "@morpho-org/blue-sdk-viem";
 import { metaMorphoFactoryAbi } from "@morpho-org/uikit/assets/abis/meta-morpho-factory";
 import { morphoAbi } from "@morpho-org/uikit/assets/abis/morpho";
 import useContractEvents from "@morpho-org/uikit/hooks/use-contract-events/use-contract-events";
-import { readAccrualVaults, readAccrualVaultsStateOverride } from "@morpho-org/uikit/lens/read-vaults";
+import {
+  marketHasDeadDeposit,
+  readAccrualVaults,
+  readAccrualVaultsStateOverride,
+} from "@morpho-org/uikit/lens/read-vaults";
 import { CORE_DEPLOYMENTS, getContractDeploymentInfo } from "@morpho-org/uikit/lib/deployments";
 import { Token } from "@morpho-org/uikit/lib/utils";
 import { useMemo } from "react";
@@ -18,7 +22,7 @@ import * as Merkl from "@/hooks/use-merkl-campaigns";
 import { useMerklOpportunities } from "@/hooks/use-merkl-opportunities";
 import { useTopNCurators } from "@/hooks/use-top-n-curators";
 import { type DisplayableCurators, getDisplayableCurators } from "@/lib/curators";
-import { CREATE_METAMORPHO_EVENT_OVERRIDES, getDeploylessMode } from "@/lib/overrides";
+import { CREATE_METAMORPHO_EVENT_OVERRIDES, getDeploylessMode, getShouldEnforceDeadDeposit } from "@/lib/overrides";
 import { getTokenURI } from "@/lib/tokens";
 
 const STALE_TIME = 5 * 60 * 1000;
@@ -35,6 +39,7 @@ export function BorrowSubPage() {
 
   const shouldOverrideCreateMetaMorphoEvents = chainId !== undefined && chainId in CREATE_METAMORPHO_EVENT_OVERRIDES;
   const shouldUseDeploylessReads = getDeploylessMode(chainId) === "deployless";
+  const shouldEnforceDeadDeposit = getShouldEnforceDeadDeposit(chainId);
 
   const [morpho, factory, factoryV1_1] = useMemo(
     () => [
@@ -96,15 +101,22 @@ export function BorrowSubPage() {
     },
   });
 
-  const marketIds = useMemo(
-    () => [
-      ...new Set(
-        vaultsData?.flatMap((d) => d.allocations.filter((alloc) => alloc.config.enabled).map((alloc) => alloc.id)) ??
-          [],
-      ),
-    ],
-    [vaultsData],
-  );
+  const marketIds = useMemo(() => {
+    // Get a flat map of allocations[i].id across all vaults for allocations that meet certain criteria:
+    // - they are actually enabled as a potential liquidity sink
+    // - they have a dead deposit (or dead deposit enforcement is disabled)
+    const filteredAllocationMarketIds = (vaultsData ?? []).flatMap((vd) =>
+      vd.allocations
+        .filter((alloc) => {
+          const isEnabled = alloc.config.enabled;
+          const isDeadDepositStateValid = !shouldEnforceDeadDeposit || marketHasDeadDeposit(vd, alloc.id);
+
+          return isEnabled && isDeadDepositStateValid;
+        })
+        .map((alloc) => alloc.id),
+    );
+    return [...new Set(filteredAllocationMarketIds)];
+  }, [shouldEnforceDeadDeposit, vaultsData]);
   const markets = useMarkets({ chainId, marketIds, staleTime: STALE_TIME, fetchPrices: true });
   const marketsArr = useMemo(() => {
     const marketsArr = Object.values(markets).filter(
diff --git a/apps/lite/src/app/dashboard/earn-subpage.tsx b/apps/lite/src/app/dashboard/earn-subpage.tsx
@@ -10,7 +10,12 @@ import {
 import { metaMorphoAbi } from "@morpho-org/uikit/assets/abis/meta-morpho";
 import { metaMorphoFactoryAbi } from "@morpho-org/uikit/assets/abis/meta-morpho-factory";
 import useContractEvents from "@morpho-org/uikit/hooks/use-contract-events/use-contract-events";
-import { readAccrualVaults, readAccrualVaultsStateOverride } from "@morpho-org/uikit/lens/read-vaults";
+import {
+  getDeadDepositsBitmap,
+  readAccrualVaults,
+  readAccrualVaultsStateOverride,
+  vaultHasDeadDeposits,
+} from "@morpho-org/uikit/lens/read-vaults";
 import { CORE_DEPLOYMENTS, getContractDeploymentInfo } from "@morpho-org/uikit/lib/deployments";
 import { Token } from "@morpho-org/uikit/lib/utils";
 import { useEffect, useMemo } from "react";
@@ -25,7 +30,7 @@ import * as Merkl from "@/hooks/use-merkl-campaigns";
 import { useMerklOpportunities } from "@/hooks/use-merkl-opportunities";
 import { useTopNCurators } from "@/hooks/use-top-n-curators";
 import { getDisplayableCurators } from "@/lib/curators";
-import { CREATE_METAMORPHO_EVENT_OVERRIDES, getDeploylessMode } from "@/lib/overrides";
+import { CREATE_METAMORPHO_EVENT_OVERRIDES, getDeploylessMode, getShouldEnforceDeadDeposit } from "@/lib/overrides";
 import { getTokenURI } from "@/lib/tokens";
 
 const STALE_TIME = 5 * 60 * 1000;
@@ -37,6 +42,7 @@ export function EarnSubPage() {
 
   const shouldOverrideCreateMetaMorphoEvents = chainId !== undefined && chainId in CREATE_METAMORPHO_EVENT_OVERRIDES;
   const shouldUseDeploylessReads = getDeploylessMode(chainId) === "deployless";
+  const shouldEnforceDeadDeposit = getShouldEnforceDeadDeposit(chainId);
 
   const [morpho, factory, factoryV1_1] = useMemo(
     () => [
@@ -116,8 +122,9 @@ export function EarnSubPage() {
 
   const marketIds = useMemo(() => [...new Set(vaultsData?.flatMap((d) => d.vault.withdrawQueue) ?? [])], [vaultsData]);
   const markets = useMarkets({ chainId, marketIds, staleTime: STALE_TIME });
-  const vaults = useMemo(() => {
+  const { vaults, hasDeadDeposits } = useMemo(() => {
     const vaults: AccrualVault[] = [];
+    const hasDeadDeposits = new Map<Address, boolean>();
     vaultsData?.forEach((vaultData) => {
       const { vault: address, supplyQueue, withdrawQueue, ...iVault } = vaultData.vault;
       // NOTE: pending values are placeholders
@@ -131,13 +138,17 @@ export function EarnSubPage() {
         pendingTimelock: { value: 0n, validAt: 0n },
       });
 
-      if (vault.name === "" || vaultData.allocations.some((allocation) => markets[allocation.id] === undefined)) {
+      const shouldSkipVault =
+        vault.name === "" || vaultData.allocations.some((allocation) => markets[allocation.id] === undefined);
+
+      if (shouldSkipVault) {
         const urlSearchParams = new URLSearchParams(window.location.search);
         if (urlSearchParams.has("dev")) {
           // Detailed logging of filtering reason to help curators diagnose their situation.
           console.log(`Skipping vault '${vault.name}':
 - ${vault.name === "" ? "❌" : "✅"} name is defined
 - ${vaultData.allocations.some((allocation) => markets[allocation.id] === undefined) ? "❌" : "✅"} fetched constituent markets
+- ${shouldEnforceDeadDeposit && !hasDeadDeposits ? "❌" : "✅"} has dead deposits (${getDeadDepositsBitmap(vaultData)})
 `);
         }
         return;
@@ -167,10 +178,11 @@ export function EarnSubPage() {
       });
 
       vaults.push(new AccrualVault(vault, allocations));
+      hasDeadDeposits.set(vault.address, vaultHasDeadDeposits(vaultData));
     });
     vaults.sort((a, b) => (a.netApy > b.netApy ? -1 : 1));
-    return vaults;
-  }, [vaultsData, markets]);
+    return { vaults, hasDeadDeposits };
+  }, [shouldEnforceDeadDeposit, vaultsData, markets]);
 
   // MARK: Fetch metadata for every ERC20 asset
   const tokenAddresses = useMemo(() => {
@@ -230,23 +242,27 @@ export function EarnSubPage() {
   ) as { [vault: Address]: bigint | undefined };
 
   const rows = useMemo(() => {
-    return vaults.map((vault) => {
-      const { decimals, symbol } = tokens.get(vault.asset) ?? { decimals: undefined, symbol: undefined };
+    return vaults
+      .map((vault) => {
+        const { decimals, symbol } = tokens.get(vault.asset) ?? { decimals: undefined, symbol: undefined };
+        const isDeadDepositStateValid = !shouldEnforceDeadDeposit || (hasDeadDeposits.get(vault.address) ?? false);
 
-      return {
-        vault,
-        asset: {
-          address: vault.asset,
+        return {
+          vault,
+          isDeadDepositStateValid,
+          asset: {
+            address: vault.asset,
+            imageSrc: getTokenURI({ symbol, address: vault.asset, chainId }),
+            symbol,
+            decimals,
+          } as Token,
+          curators: getDisplayableCurators(vault, curators, chainId),
+          userShares: userShares[vault.address],
           imageSrc: getTokenURI({ symbol, address: vault.asset, chainId }),
-          symbol,
-          decimals,
-        } as Token,
-        curators: getDisplayableCurators(vault, curators, chainId),
-        userShares: userShares[vault.address],
-        imageSrc: getTokenURI({ symbol, address: vault.asset, chainId }),
-      };
-    });
-  }, [vaults, tokens, userShares, curators, chainId]);
+        };
+      })
+      .filter((vault) => vault.isDeadDepositStateValid || (vault.userShares ?? 0n) > 0n);
+  }, [vaults, hasDeadDeposits, shouldEnforceDeadDeposit, tokens, userShares, curators, chainId]);
 
   const userRows = rows.filter((row) => (row.userShares ?? 0n) > 0n);
 
diff --git a/apps/lite/src/components/earn-sheet-content.tsx b/apps/lite/src/components/earn-sheet-content.tsx
@@ -30,7 +30,15 @@ const STYLE_INPUT_WRAPPER =
   "bg-primary hover:bg-secondary flex flex-col gap-4 rounded-2xl p-4 transition-colors duration-200 ease-in-out";
 const STYLE_INPUT_HEADER = "text-secondary-foreground flex items-center justify-between text-xs font-light";
 
-export function EarnSheetContent({ vaultAddress, asset }: { vaultAddress: Address; asset: Token }) {
+export function EarnSheetContent({
+  vaultAddress,
+  isDeadDepositStateValid,
+  asset,
+}: {
+  vaultAddress: Address;
+  isDeadDepositStateValid: boolean;
+  asset: Token;
+}) {
   const { address: userAddress } = useAccount();
 
   const [selectedTab, setSelectedTab] = useState(Actions.Deposit);
@@ -41,7 +49,7 @@ export function EarnSheetContent({ vaultAddress, asset }: { vaultAddress: Addres
     address: userAddress,
     query: { enabled: !!userAddress },
   });
-  const canInteract = userBytecode !== undefined && userBytecode === null;
+  const isProtectedFromInflation = isDeadDepositStateValid || (userBytecode !== undefined && userBytecode === null);
 
   const { data: allowance, refetch: refetchAllowance } = useReadContract({
     address: asset.address,
@@ -157,15 +165,15 @@ export function EarnSheetContent({ vaultAddress, asset }: { vaultAddress: Addres
           {approvalTxnConfig ? (
             <TransactionButton
               variables={approvalTxnConfig}
-              disabled={inputValue === 0n || !canInteract}
+              disabled={inputValue === 0n || !isProtectedFromInflation}
               onTxnReceipt={() => refetchAllowance()}
             >
               Approve
             </TransactionButton>
           ) : (
             <TransactionButton
               variables={depositTxnConfig}
-              disabled={!inputValue || !canInteract}
+              disabled={!inputValue || !isProtectedFromInflation}
               onTxnReceipt={() => {
                 setTextInputValue("");
                 void refetchMaxes();
diff --git a/apps/lite/src/components/earn-table.tsx b/apps/lite/src/components/earn-table.tsx
@@ -29,6 +29,7 @@ import { getTokenURI } from "@/lib/tokens";
 
 export type Row = {
   vault: AccrualVault;
+  isDeadDepositStateValid: boolean;
   asset: Token;
   curators: DisplayableCurators;
   userShares: bigint | undefined;
@@ -326,7 +327,11 @@ export function EarnTable({
                     </TableCell>
                   </TableRow>
                 </SheetTrigger>
-                <EarnSheetContent vaultAddress={row.vault.address} asset={row.asset} />
+                <EarnSheetContent
+                  vaultAddress={row.vault.address}
+                  isDeadDepositStateValid={row.isDeadDepositStateValid}
+                  asset={row.asset}
+                />
               </Sheet>
             );
           })}
diff --git a/apps/lite/src/lib/overrides.tsx b/apps/lite/src/lib/overrides.tsx
@@ -1,6 +1,7 @@
 import { tac } from "@morpho-org/uikit/lib/chains/tac";
+import { CORE_DEPLOYMENTS } from "@morpho-org/uikit/lib/deployments";
 import { type Address } from "viem";
-import { sei } from "viem/chains";
+import { celo, sei } from "viem/chains";
 
 export const CREATE_METAMORPHO_EVENT_OVERRIDES: Record<number, Address[]> = {
   [sei.id]: ["0x015F10a56e97e02437D294815D8e079e1903E41C", "0x948FcC6b7f68f4830Cd69dB1481a9e1A142A4923"],
@@ -17,3 +18,12 @@ export function getDeploylessMode(chainId: number | undefined): "deployless" | "
   if (chainId === undefined) return "stateOverride";
   return DEPLOYLESS_MODE_OVERRIDES[chainId] ?? "stateOverride";
 }
+
+// On these chains, vaults/markets must have >= 1e9 shares owned by the 0xDEAD address in order
+// to show up, and contract accounts are allowed to deposit. On all other chains, the 0xDEAD
+// requirement is unenforced, and contract accounts are blocked from depositing.
+const ENFORCE_DEAD_DEPOSIT_CHAINS = [...CORE_DEPLOYMENTS, celo.id];
+
+export function getShouldEnforceDeadDeposit(chainId: number | undefined) {
+  return chainId !== undefined && ENFORCE_DEAD_DEPOSIT_CHAINS.includes(chainId);
+}
diff --git a/apps/lite/test/components/earn-sheet-content.test.tsx b/apps/lite/test/components/earn-sheet-content.test.tsx
@@ -72,7 +72,9 @@ describe("deposit flow", () => {
       await client.deal({ account, amount: parseEther(amount), erc20: asset.address }); // for deposit
       await client.impersonateAccount({ address: account });
 
-      render(<TestableEarnSheetContent vaultAddress={vaultAddress} asset={asset} />, { wagmiConfig });
+      render(<TestableEarnSheetContent vaultAddress={vaultAddress} asset={asset} isDeadDepositStateValid={true} />, {
+        wagmiConfig,
+      });
 
       // Wait for tabs -- this implies the `Testable` wrapper has connected the mock account
       await waitFor(() => screen.findAllByRole("tab"));
@@ -176,7 +178,9 @@ describe("withdraw flow", () => {
       ]);
       const maxText = formatUnits(maxWithdraw, asset.decimals!);
 
-      render(<TestableEarnSheetContent vaultAddress={vaultAddress} asset={asset} />, { wagmiConfig });
+      render(<TestableEarnSheetContent vaultAddress={vaultAddress} asset={asset} isDeadDepositStateValid={true} />, {
+        wagmiConfig,
+      });
 
       // Wait for tabs -- this implies the `Testable` wrapper has connected the mock account
       await waitFor(() => screen.findAllByRole("tab"));
@@ -247,7 +251,9 @@ describe("withdraw flow", () => {
       await client.deal({ account, amount: parseEther(shares), erc20: vaultAddress }); // for withdraw
       await client.impersonateAccount({ address: account });
 
-      render(<TestableEarnSheetContent vaultAddress={vaultAddress} asset={asset} />, { wagmiConfig });
+      render(<TestableEarnSheetContent vaultAddress={vaultAddress} asset={asset} isDeadDepositStateValid={true} />, {
+        wagmiConfig,
+      });
 
       // Wait for tabs -- this implies the `Testable` wrapper has connected the mock account
       await waitFor(() => screen.findAllByRole("tab"));
diff --git a/packages/uikit/src/lens/read-vaults.s.sol b/packages/uikit/src/lens/read-vaults.s.sol
diff --git a/packages/uikit/src/lens/read-vaults.ts b/packages/uikit/src/lens/read-vaults.ts
