Merge pull request #1197 from liquity/urgent-redemptions

[App] Urgent redemptions

Author: danielattilasimon

contracts/utils/deployment-manifest-to-app-env.ts

@@ -39,6 +39,7 @@ const ZDeploymentManifest = z.object({
   debtInFrontHelper: ZAddress,
   exchangeHelpers: ZAddress,
   exchangeHelpersV2: ZAddress,
+  redemptionHelper: ZAddress,
 
   governance: z.object({
     LUSDToken: ZAddress,
@@ -189,6 +190,8 @@ function contractNameToAppEnvVariable(contractName: string, prefix: string = "")
       return `${prefix}_EXCHANGE_HELPERS`;
     case "exchangeHelpersV2":
       return `${prefix}_EXCHANGE_HELPERS_V2`;
+    case "redemptionHelper":
+      return `${prefix}_REDEMPTION_HELPER`;
 
     // collateral contracts
     case "activePool":

frontend/app/src/app/redeem/shutdown/page.tsx

@@ -0,0 +1,5 @@
+import { UrgentRedeemScreen } from "@/src/screens/UrgentRedeemScreen/UrgentRedeemScreen";
+
+export default function Page() {
+  return <UrgentRedeemScreen />;
+}

frontend/app/src/comps/AppLayout/AppLayout.tsx

@@ -5,6 +5,7 @@ import type { ReactNode } from "react";
 import { Banner } from "@/Banner";
 import { LegacyPositionsBanner } from "@/src/comps/LegacyPositionsBanner/LegacyPositionsBanner";
 import { SafetyModeBanner } from "@/src/comps/SafetyModeBanner/SafetyModeBanner";
+import { ShutdownModeBanner } from "@/src/comps/ShutdownModeBanner/ShutdownModeBanner";
 import { SubgraphDownBanner } from "@/src/comps/SubgraphDownBanner/SubgraphDownBanner";
 import { V1StabilityPoolBanner } from "@/src/comps/V1StabilityPoolBanner/V1StabilityPoolBanner";
 import { V1StakingBanner } from "@/src/comps/V1StakingBanner/V1StakingBanner";
@@ -45,6 +46,7 @@ export function AppLayout({
         {LEGACY_CHECK && <LegacyPositionsBanner />}
         {SUBGRAPH_CHECK && <SubgraphDownBanner />}
         {SAFETY_MODE_CHECK && <SafetyModeBanner />}
+        {SAFETY_MODE_CHECK && <ShutdownModeBanner />}
         <div
           className={css({
             display: "flex",

frontend/app/src/comps/InfoBox/InfoBox.tsx

@@ -0,0 +1,31 @@
+import type { ReactNode } from "react";
+
+import { css } from "@/styled-system/css";
+
+export function InfoBox(props: {
+  title?: ReactNode;
+  children?: ReactNode;
+}) {
+  return (
+    <section
+      className={css({
+        display: "flex",
+        flexDirection: "column",
+        gap: 8,
+        padding: 16,
+        color: "infoSurfaceContent",
+        background: "infoSurface",
+        border: "1px solid token(colors.infoSurfaceBorder)",
+        borderRadius: 8,
+      })}
+    >
+      {props.title && (
+        <header className={css({ display: "flex", flexDirection: "column", fontSize: 16 })}>
+          <h1 className={css({ fontWeight: 600 })}>{props.title}</h1>
+        </header>
+      )}
+
+      {props.children}
+    </section>
+  );
+}

frontend/app/src/comps/SafetyModeBanner/SafetyModeBanner.tsx

@@ -1,19 +1,26 @@
 "use client";
 
 import { InfoBanner } from "@/src/comps/InfoBanner/InfoBanner";
-import { useSafetyMode } from "@/src/liquity-utils";
+import { useSafetyMode, useShutdownStatus } from "@/src/liquity-utils";
 import { token } from "@/styled-system/tokens";
 import { IconWarning } from "@liquity2/uikit";
 
 export function SafetyModeBanner() {
   const safetyMode = useSafetyMode();
+  const shutdownStatus = useShutdownStatus();
+
+  const shutdownBranchIds = new Set(
+    shutdownStatus.data?.filter((b) => b.isShutdown).map((b) => b.branchId) ?? [],
+  );
+
+  const branchesInSafetyMode = (safetyMode.data?.branchesInSafetyMode ?? [])
+    .filter((b) => !shutdownBranchIds.has(b.branchId));
 
-  const branchesInSafetyMode = safetyMode.data?.branchesInSafetyMode ?? [];
   const branchNames = branchesInSafetyMode.map((b) => b.symbol).join(", ");
 
   return (
     <InfoBanner
-      show={Boolean(safetyMode.data?.isAnySafetyMode)}
+      show={branchesInSafetyMode.length > 0}
       icon={<IconWarning size={16} />}
       messageDesktop={
         <>

frontend/app/src/comps/ShutdownModeBanner/ShutdownModeBanner.tsx

@@ -0,0 +1,32 @@
+"use client";
+
+import { InfoBanner } from "@/src/comps/InfoBanner/InfoBanner";
+import { getBranch, useShutdownStatus } from "@/src/liquity-utils";
+import { token } from "@/styled-system/tokens";
+import { IconWarning } from "@liquity2/uikit";
+
+export function ShutdownModeBanner() {
+  const shutdownStatus = useShutdownStatus();
+
+  const branchesInShutdown = shutdownStatus.data?.filter((b) => b.isShutdown) ?? [];
+  const branchNames = branchesInShutdown.map((b) => getBranch(b.branchId).symbol).join(", ");
+
+  return (
+    <InfoBanner
+      show={branchesInShutdown.length > 0}
+      icon={<IconWarning size={16} />}
+      messageDesktop={
+        <>
+          The {branchNames} branch{branchesInShutdown.length > 1 ? "es are" : " is"} in Shutdown Mode.
+          You can only close positions or redeem BOLD.
+        </>
+      }
+      linkLabel="Learn more"
+      linkLabelMobile="Shutdown Mode active"
+      linkHref="https://docs.liquity.org/v2-faq/borrowing-and-liquidations#what-is-shutdown-mode"
+      linkExternal
+      backgroundColor={token("colors.brandGolden")}
+      foregroundColor={token("colors.brandGoldenContent")}
+    />
+  );
+}

frontend/app/src/content.tsx

@@ -600,6 +600,97 @@ export default {
       </>
     ),
   },
+  shutdownWarning: {
+    title: "Branch Shutdown",
+    borrowMessage: (collName: string) => (
+      <>
+        The {collName} branch is in shutdown mode. New loans cannot be opened on this branch.
+      </>
+    ),
+    loanMessage: (collName: string) => (
+      <>
+        The {collName} branch is in shutdown mode. Loan adjustments are not available. You can only close your loan.
+      </>
+    ),
+  },
+  urgentRedeemScreen: {
+    headingTitle: "Shutdown Redemptions",
+    headingTitleActive: "Shutdown Redemption",
+    selectBranchLabel: "Select branch",
+    redeemFieldLabel: "You redeem",
+    insufficientBalance: (balance: string) => `Insufficient BOLD balance. You have ${balance} BOLD.`,
+    amountCapped: (amount: string) => `Capped to ${amount} BOLD (max amount redeemable).`,
+    youReceive: "You receive",
+    bonusLabel: (bonusPct: string) => `Including ${bonusPct} bonus`,
+    bonusTooltip: (bonusPct: string) => `Shutdown redemptions include a ${bonusPct} bonus on the collateral received.`,
+    slippageTolerance: "Slippage tolerance",
+    manualTrovesLabel: "Manually selected troves",
+    autoTrovesLabel: "Auto-selected troves",
+    useAutoSelection: "Use auto-selection",
+    manuallySelectTroves: "Manually select troves",
+    trovesCount: (count: number) => `${count} ${count === 1 ? "trove" : "troves"} will be used for this redemption.`,
+    action: "Redeem",
+    backLink: "Back",
+    successLink: "Go to the Dashboard",
+    successMessage: "The shutdown redemption was successful.",
+    noShutdown: {
+      title: "No Branches in Shutdown Mode",
+      body: (
+        <>
+          Shutdown redemptions are only available when a branch is in shutdown mode. Currently, all branches are
+          operating normally.
+        </>
+      ),
+      link: "Go to standard redemptions",
+    },
+    noTroves: {
+      title: "No Shutdown Redemptions Available",
+      body: "No troves are currently available for shutdown redemption in this branch.",
+    },
+    troveTable: {
+      trovesSelected: (count: number) => `${count} ${count === 1 ? "trove" : "troves"} selected`,
+      totalDebt: "Total debt:",
+      totalDebtUnit: "BOLD",
+      totalColl: "Total coll:",
+      deselectAll: "Clear all",
+      selectAllOnPage: "Select all on page",
+      clearSelection: "Clear selection",
+      columnTroveId: "Trove ID",
+      columnCollateral: "Collateral",
+      columnDebt: "Debt",
+      columnIcr: "ICR",
+      noTrovesAvailable: "No troves available",
+      page: (current: number, total: number) => `Page ${current} of ${total}`,
+      previous: "Previous",
+      next: "Next",
+    },
+    txFlow: {
+      title: "Review & Send Transaction",
+      youRedeemBold: "You redeem BOLD",
+      redeemTooltip: (bonusPct: string) =>
+        `Shutdown redemptions have 0% fee and include a ${bonusPct} collateral bonus.`,
+      youReceiveToken: (tokenName: string) => `You receive ${tokenName}`,
+      receiveTooltip: (tokenName: string, bonusPct: string) =>
+        `This is the estimated amount of ${tokenName} you will receive, including`
+        + ` the ${bonusPct} bonus. The actual amount may vary based on the selected troves.`,
+      trovesLabel: "Troves to redeem from",
+      trovesTooltip: (
+        <>
+          The number of troves that will be used for this redemption. Shutdown redemptions are competitive - other users
+          may redeem from these troves before your transaction confirms.
+        </>
+      ),
+      trovesValue: (count: number) => `${count} ${count === 1 ? "trove" : "troves"}`,
+      slippageTooltip: (threshold: N) => (
+        <>
+          If the actual collateral received is less than {threshold}{" "}
+          of the expected amount, the transaction will revert.
+        </>
+      ),
+      approveStep: "Approve BOLD",
+      redeemStep: "Execute Shutdown Redemption",
+    },
+  },
   dataSources: {
     title: "Data Sources",
     description:

frontend/app/src/graphql/graphql.ts

@@ -23,6 +23,14 @@ export type Scalars = {
   Timestamp: { input: string; output: string; }
 };
 
+/** Indicates whether the current, partially filled bucket should be included in the response. Defaults to `exclude` */
+export enum Aggregation_Current {
+  /** Exclude the current, partially filled bucket from the response */
+  Exclude = 'exclude',
+  /** Include the current, partially filled bucket in the response */
+  Include = 'include'
+}
+
 export enum Aggregation_Interval {
   Day = 'day',
   Hour = 'hour'
@@ -54,10 +62,8 @@ export type BorrowerInfo_Filter = {
   and?: InputMaybe<Array<InputMaybe<BorrowerInfo_Filter>>>;
   collSurplusBalance?: InputMaybe<Array<Scalars['BigInt']['input']>>;
   collSurplusBalance_contains?: InputMaybe<Array<Scalars['BigInt']['input']>>;
-  collSurplusBalance_contains_nocase?: InputMaybe<Array<Scalars['BigInt']['input']>>;
   collSurplusBalance_not?: InputMaybe<Array<Scalars['BigInt']['input']>>;
   collSurplusBalance_not_contains?: InputMaybe<Array<Scalars['BigInt']['input']>>;
-  collSurplusBalance_not_contains_nocase?: InputMaybe<Array<Scalars['BigInt']['input']>>;
   id?: InputMaybe<Scalars['ID']['input']>;
   id_gt?: InputMaybe<Scalars['ID']['input']>;
   id_gte?: InputMaybe<Scalars['ID']['input']>;
@@ -68,24 +74,18 @@ export type BorrowerInfo_Filter = {
   id_not_in?: InputMaybe<Array<Scalars['ID']['input']>>;
   lastCollSurplusClaimAt?: InputMaybe<Array<Scalars['BigInt']['input']>>;
   lastCollSurplusClaimAt_contains?: InputMaybe<Array<Scalars['BigInt']['input']>>;
-  lastCollSurplusClaimAt_contains_nocase?: InputMaybe<Array<Scalars['BigInt']['input']>>;
   lastCollSurplusClaimAt_not?: InputMaybe<Array<Scalars['BigInt']['input']>>;
   lastCollSurplusClaimAt_not_contains?: InputMaybe<Array<Scalars['BigInt']['input']>>;
-  lastCollSurplusClaimAt_not_contains_nocase?: InputMaybe<Array<Scalars['BigInt']['input']>>;
   nextOwnerIndexes?: InputMaybe<Array<Scalars['Int']['input']>>;
   nextOwnerIndexes_contains?: InputMaybe<Array<Scalars['Int']['input']>>;
-  nextOwnerIndexes_contains_nocase?: InputMaybe<Array<Scalars['Int']['input']>>;
   nextOwnerIndexes_not?: InputMaybe<Array<Scalars['Int']['input']>>;
   nextOwnerIndexes_not_contains?: InputMaybe<Array<Scalars['Int']['input']>>;
-  nextOwnerIndexes_not_contains_nocase?: InputMaybe<Array<Scalars['Int']['input']>>;
   or?: InputMaybe<Array<InputMaybe<BorrowerInfo_Filter>>>;
   troves?: InputMaybe<Scalars['Int']['input']>;
   trovesByCollateral?: InputMaybe<Array<Scalars['Int']['input']>>;
   trovesByCollateral_contains?: InputMaybe<Array<Scalars['Int']['input']>>;
-  trovesByCollateral_contains_nocase?: InputMaybe<Array<Scalars['Int']['input']>>;
   trovesByCollateral_not?: InputMaybe<Array<Scalars['Int']['input']>>;
   trovesByCollateral_not_contains?: InputMaybe<Array<Scalars['Int']['input']>>;
-  trovesByCollateral_not_contains_nocase?: InputMaybe<Array<Scalars['Int']['input']>>;
   troves_gt?: InputMaybe<Scalars['Int']['input']>;
   troves_gte?: InputMaybe<Scalars['Int']['input']>;
   troves_in?: InputMaybe<Array<Scalars['Int']['input']>>;

frontend/app/src/liquity-utils.ts

@@ -1920,3 +1920,97 @@ export function useSafetyMode() {
     enabled: Boolean(allRatios.data),
   });
 }
+
+export type ShutdownStatus = {
+  branchId: BranchId;
+  isShutdown: boolean;
+};
+
+export function useShutdownStatus() {
+  const branches = getBranches();
+
+  return useReadContracts({
+    contracts: branches.map((branch) => ({
+      ...branch.contracts.TroveManager,
+      functionName: "shutdownTime" as const,
+    })),
+    allowFailure: false,
+    query: {
+      refetchInterval: 12_000,
+      select: (results): ShutdownStatus[] => {
+        return results.map((shutdownTime, index) => {
+          const branch = branches[index];
+          if (!branch) {
+            throw new Error(`Branch at index ${index} not found`);
+          }
+          return {
+            branchId: branch.branchId,
+            isShutdown: Number(shutdownTime) > 0,
+          };
+        });
+      },
+    },
+  });
+}
+
+export function useIsBranchShutdown(branchId: BranchId) {
+  const shutdownStatus = useShutdownStatus();
+  return {
+    ...shutdownStatus,
+    data: shutdownStatus.data?.find((s) => s.branchId === branchId)?.isShutdown ?? false,
+  };
+}
+
+export type RedeemableTrove = {
+  id: string;
+  troveId: TroveId;
+  debt: Dnum;
+  coll: Dnum;
+  stake: Dnum;
+  interestRate: Dnum;
+};
+
+async function fetchRedeemableTroves(
+  wagmiConfig: WagmiConfig,
+  branchId: BranchId,
+  maxTroves: number,
+): Promise<RedeemableTrove[]> {
+  const MultiTroveGetter = getProtocolContract("MultiTroveGetter");
+
+  const troves = await readContract(wagmiConfig, {
+    ...MultiTroveGetter,
+    functionName: "getMultipleSortedTroves",
+    args: [BigInt(branchId), -1n, BigInt(maxTroves)],
+  });
+
+  return troves
+    .filter((trove) => trove.entireDebt > 0n)
+    .map((trove) => ({
+      id: getPrefixedTroveId(branchId, `0x${trove.id.toString(16)}` as TroveId),
+      troveId: `0x${trove.id.toString(16)}` as TroveId,
+      debt: dnum18(trove.entireDebt),
+      coll: dnum18(trove.entireColl),
+      stake: dnum18(trove.stake),
+      interestRate: dnum18(trove.annualInterestRate),
+    }));
+}
+
+export function useRedeemableTroves(
+  branchId: BranchId | null,
+  options?: { first?: number },
+) {
+  const wagmiConfig = useWagmiConfig();
+  const maxTroves = options?.first ?? 200;
+
+  return useQuery<RedeemableTrove[]>({
+    queryKey: ["redeemableTroves", branchId, maxTroves],
+    queryFn: async () => {
+      if (branchId === null) {
+        return [];
+      }
+      return fetchRedeemableTroves(wagmiConfig, branchId, maxTroves);
+    },
+    enabled: branchId !== null,
+    refetchInterval: 12_000,
+  });
+}