From 222915fb078f6f350608b7075b319912794a234e Mon Sep 17 00:00:00 2001
From: wjrjerome <wjrjerome@babylonchain.io>
Date: Mon, 12 Aug 2024 16:11:47 +1000
Subject: [PATCH] fix: issue with fee UI infinite react rendering loop

---
 .github/workflows/ci.yml                      |  4 +-
 .github/workflows/publish.yaml                |  8 +--
 .../components/Staking/Form/StakingAmount.tsx | 49 +++++++++----
 .../components/Staking/Form/StakingFee.tsx    | 23 ++++---
 src/app/components/Staking/Staking.tsx        | 69 +++++++++----------
 src/utils/isStakingSignReady.ts               |  6 ++
 tests/utils/isStakingSignReady.test.ts        | 14 +++-
 7 files changed, 105 insertions(+), 68 deletions(-)

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index 7083d434..b3976930 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -3,11 +3,11 @@ name: ci
 on:
   pull_request:
     branches:
-    - '**'
+      - "**"
 
 jobs:
   lint_test:
     uses: babylonlabs-io/.github/.github/workflows/reusable_node_lint_test.yml@v0.3.0
     with:
       run-build: true
-      run-unit-tests: true
\ No newline at end of file
+      run-unit-tests: true
diff --git a/.github/workflows/publish.yaml b/.github/workflows/publish.yaml
index 96ed64c2..2c9f4030 100644
--- a/.github/workflows/publish.yaml
+++ b/.github/workflows/publish.yaml
@@ -3,10 +3,10 @@ name: docker_publish
 on:
   push:
     branches:
-    - 'main'
-    - 'dev'
+      - "main"
+      - "dev"
     tags:
-    - '*'
+      - "*"
 
 jobs:
   lint_test:
@@ -14,7 +14,7 @@ jobs:
     with:
       run-build: true
       run-unit-tests: true
-  
+
   docker_build:
     needs: [lint_test]
     runs-on: ubuntu-22.04
diff --git a/src/app/components/Staking/Form/StakingAmount.tsx b/src/app/components/Staking/Form/StakingAmount.tsx
index a680754b..3f49d514 100644
--- a/src/app/components/Staking/Form/StakingAmount.tsx
+++ b/src/app/components/Staking/Form/StakingAmount.tsx
@@ -12,6 +12,7 @@ interface StakingAmountProps {
   btcWalletBalanceSat?: number;
   onStakingAmountSatChange: (inputAmountSat: number) => void;
   reset: boolean;
+  isSufficientBalance: boolean;
 }
 
 export const StakingAmount: React.FC<StakingAmountProps> = ({
@@ -20,11 +21,13 @@ export const StakingAmount: React.FC<StakingAmountProps> = ({
   btcWalletBalanceSat,
   onStakingAmountSatChange,
   reset,
+  isSufficientBalance,
 }) => {
   const [value, setValue] = useState("");
   const [error, setError] = useState("");
   // Track if the input field has been interacted with
   const [touched, setTouched] = useState(false);
+  const [blurred, setBlurred] = useState(false);
 
   const errorLabel = "Staking amount";
   const generalErrorMessage = "You should input staking amount";
@@ -51,16 +54,8 @@ export const StakingAmount: React.FC<StakingAmountProps> = ({
     }
   };
 
-  const handleBlur = (_e: FocusEvent<HTMLInputElement>) => {
-    if (!btcWalletBalanceSat) return;
-    setTouched(true);
-
-    if (value === "") {
-      onStakingAmountSatChange(0);
-      setError(generalErrorMessage);
-      return;
-    }
-
+  useEffect(() => {
+    if (!btcWalletBalanceSat || value === "") return;
     const numValue = parseFloat(value);
     const satoshis = btcToSatoshi(numValue);
 
@@ -71,7 +66,7 @@ export const StakingAmount: React.FC<StakingAmountProps> = ({
         message: `${errorLabel} must be a valid number.`,
       },
       {
-        valid: numValue !== 0,
+        valid: numValue > 0,
         message: `${errorLabel} must be greater than 0.`,
       },
       {
@@ -91,18 +86,46 @@ export const StakingAmount: React.FC<StakingAmountProps> = ({
         message: `${errorLabel} must have no more than 8 decimal points.`,
       },
     ];
-
     // Find the first failing validation
     const firstInvalid = validations.find((validation) => !validation.valid);
-
     if (firstInvalid) {
       onStakingAmountSatChange(0);
       setError(firstInvalid.message);
+      return;
     } else {
       setError("");
       onStakingAmountSatChange(satoshis);
       setValue(maxDecimals(satoshiToBtc(satoshis), 8).toString());
     }
+    // The fee + amount check can only be placed after onStakingAmountSatChange is called
+    // This is due to isSufficientBalance being dependent on the value of
+    // stakingAmountSat in parent component
+    if (!isSufficientBalance && validateDecimalPoints(value)) {
+      return setError(
+        "Not enough balance to cover the staking value and its fees",
+      );
+    }
+  }, [
+    isSufficientBalance,
+    blurred,
+    value,
+    btcWalletBalanceSat,
+    minStakingAmountSat,
+    maxStakingAmountSat,
+    onStakingAmountSatChange,
+    coinName,
+  ]);
+
+  const handleBlur = (_e: FocusEvent<HTMLInputElement>) => {
+    if (!btcWalletBalanceSat) return;
+    setTouched(true);
+
+    if (value === "") {
+      onStakingAmountSatChange(0);
+      setError(generalErrorMessage);
+      return;
+    }
+    setBlurred(!blurred);
   };
 
   const minStakeAmount = maxDecimals(satoshiToBtc(minStakingAmountSat), 8);
diff --git a/src/app/components/Staking/Form/StakingFee.tsx b/src/app/components/Staking/Form/StakingFee.tsx
index d2da2131..3eed286d 100644
--- a/src/app/components/Staking/Form/StakingFee.tsx
+++ b/src/app/components/Staking/Form/StakingFee.tsx
@@ -10,7 +10,7 @@ import { LoadingSmall } from "../../Loading/Loading";
 interface StakingFeeProps {
   stakingFeeSat: number;
   selectedFeeRate: number;
-  onSelectedFeeRateChange: (fee: number) => void;
+  onSelectedFeeRateChange: (feeRate: number) => void;
   reset: boolean;
   // optional as component shows loading state
   mempoolFeeRates?: Fees;
@@ -46,6 +46,11 @@ export const StakingFee: React.FC<StakingFeeProps> = ({
     }
   };
 
+  // If staking fee has not been calculated, return null
+  if (!stakingFeeSat) {
+    return null;
+  }
+
   const defaultModeRender = () => {
     return (
       <div className="flex flex-col justify-center gap-1 items-center">
@@ -57,16 +62,12 @@ export const StakingFee: React.FC<StakingFeeProps> = ({
           ) : (
             <LoadingSmall text="Loading recommended fee rate..." />
           )}
-          {stakingFeeSat ? (
-            <p>
-              Transaction fee amount:{" "}
-              <strong>
-                {satoshiToBtc(stakingFeeSat)} {coinName}
-              </strong>
-            </p>
-          ) : (
-            <LoadingSmall text="Loading transaction fee amount..." />
-          )}
+          <p>
+            Transaction fee amount:{" "}
+            <strong>
+              {satoshiToBtc(stakingFeeSat)} {coinName}
+            </strong>
+          </p>
         </div>
         <button
           className="btn btn-sm btn-link no-underline"
diff --git a/src/app/components/Staking/Staking.tsx b/src/app/components/Staking/Staking.tsx
index fbab9a12..97a5481b 100644
--- a/src/app/components/Staking/Staking.tsx
+++ b/src/app/components/Staking/Staking.tsx
@@ -112,6 +112,8 @@ export const Staking: React.FC<StakingProps> = ({
     overTheCapRange: false,
     approchingCapRange: false,
   });
+  const [stakingFeeSat, setStakingFeeSat] = useState<number>(0);
+  const [isSufficientBalance, setIsSufficientBalance] = useState(false);
 
   // Mempool fee rates, comes from the network
   // Fetch fee rates, sat/vB
@@ -242,6 +244,10 @@ export const Staking: React.FC<StakingProps> = ({
 
   // Either use the selected fee rate or the fastest fee rate
   const feeRate = selectedFeeRate || defaultFeeRate;
+  // check that selected Fee rate (if present) is bigger than the min fee
+  if (feeRate && feeRate < minFeeRate) {
+    throw new Error("Selected fee rate is lower than the hour fee");
+  }
 
   const queryClient = useQueryClient();
 
@@ -325,8 +331,7 @@ export const Staking: React.FC<StakingProps> = ({
     });
   };
 
-  // Memoize the staking fee calculation
-  const stakingFeeSat = useMemo(() => {
+  useEffect(() => {
     if (
       btcWalletNetwork &&
       address &&
@@ -334,15 +339,10 @@ export const Staking: React.FC<StakingProps> = ({
       stakingAmountSat &&
       finalityProvider &&
       paramWithCtx?.currentVersion &&
-      mempoolFeeRates &&
+      feeRate &&
       availableUTXOs
     ) {
       try {
-        // check that selected Fee rate (if present) is bigger than the min fee
-        if (selectedFeeRate && selectedFeeRate < minFeeRate) {
-          throw new Error("Selected fee rate is lower than the hour fee");
-        }
-        const memoizedFeeRate = selectedFeeRate || defaultFeeRate;
         // Calculate the staking fee
         const { stakingFeeSat } = createStakingTx(
           paramWithCtx.currentVersion,
@@ -352,25 +352,25 @@ export const Staking: React.FC<StakingProps> = ({
           btcWalletNetwork,
           address,
           publicKeyNoCoord,
-          memoizedFeeRate,
+          feeRate,
           availableUTXOs,
         );
-        return stakingFeeSat;
+        setIsSufficientBalance(true);
+        setStakingFeeSat(stakingFeeSat);
       } catch (error: Error | any) {
-        // fees + staking amount can be more than the balance
-        showError({
-          error: {
-            message: error.message,
-            errorState: ErrorState.STAKING,
-            errorTime: new Date(),
-          },
-          retryAction: () => setSelectedFeeRate(0),
-        });
-        setSelectedFeeRate(0);
-        return 0;
+        // This indicates the user has insufficient funds to cover staking amount + fees
+        if (error?.message.includes("Insufficient funds")) {
+          setIsSufficientBalance(false);
+        } else {
+          showError({
+            error: {
+              message: error.message,
+              errorState: ErrorState.STAKING,
+              errorTime: new Date(),
+            },
+          });
+        }
       }
-    } else {
-      return 0;
     }
   }, [
     btcWalletNetwork,
@@ -380,12 +380,9 @@ export const Staking: React.FC<StakingProps> = ({
     stakingTimeBlocks,
     finalityProvider,
     paramWithCtx,
-    mempoolFeeRates,
-    selectedFeeRate,
     availableUTXOs,
     showError,
-    defaultFeeRate,
-    minFeeRate,
+    feeRate,
   ]);
 
   // Select the finality provider from the list
@@ -581,6 +578,7 @@ export const Staking: React.FC<StakingProps> = ({
           stakingAmountSat,
           stakingTimeBlocksWithFixed,
           !!finalityProvider,
+          isSufficientBalance,
         );
 
       const previewReady =
@@ -604,16 +602,15 @@ export const Staking: React.FC<StakingProps> = ({
                 btcWalletBalanceSat={btcWalletBalanceSat}
                 onStakingAmountSatChange={handleStakingAmountSatChange}
                 reset={resetFormInputs}
+                isSufficientBalance={isSufficientBalance}
+              />
+              <StakingFee
+                mempoolFeeRates={mempoolFeeRates}
+                stakingFeeSat={stakingFeeSat}
+                selectedFeeRate={selectedFeeRate}
+                onSelectedFeeRateChange={setSelectedFeeRate}
+                reset={resetFormInputs}
               />
-              {signReady && (
-                <StakingFee
-                  mempoolFeeRates={mempoolFeeRates}
-                  stakingFeeSat={stakingFeeSat}
-                  selectedFeeRate={selectedFeeRate}
-                  onSelectedFeeRateChange={setSelectedFeeRate}
-                  reset={resetFormInputs}
-                />
-              )}
             </div>
             {showApproachingCapWarning()}
             <span
diff --git a/src/utils/isStakingSignReady.ts b/src/utils/isStakingSignReady.ts
index 71846f57..ccaba3fe 100644
--- a/src/utils/isStakingSignReady.ts
+++ b/src/utils/isStakingSignReady.ts
@@ -9,6 +9,7 @@ export const isStakingSignReady = (
   amount: number,
   time: number,
   fpSelected: boolean,
+  sufficientBalance: boolean,
 ): { isReady: boolean; reason: string } => {
   if (!fpSelected)
     return {
@@ -39,6 +40,11 @@ export const isStakingSignReady = (
       isReady: false,
       reason: "Please enter a valid staking period",
     };
+  } else if (!sufficientBalance) {
+    return {
+      isReady: false,
+      reason: "Not enough balance to cover the staking value and its fees",
+    };
   }
   return {
     isReady: true,
diff --git a/tests/utils/isStakingSignReady.test.ts b/tests/utils/isStakingSignReady.test.ts
index 1dc9cc8e..e9305bc3 100644
--- a/tests/utils/isStakingSignReady.test.ts
+++ b/tests/utils/isStakingSignReady.test.ts
@@ -2,7 +2,7 @@ import { isStakingSignReady } from "@/utils/isStakingSignReady";
 
 describe("utils/isStakingSignReady", () => {
   it("should return false with reason if fpSelected is false", () => {
-    const result = isStakingSignReady(1, 2, 3, 4, 5, 6, false);
+    const result = isStakingSignReady(1, 2, 3, 4, 5, 6, false, true);
     expect(result.isReady).toBe(false);
     expect(result.reason).toBe("Please select a finality provider");
   });
@@ -44,6 +44,7 @@ describe("utils/isStakingSignReady", () => {
         input.amount,
         6,
         true,
+        true,
       );
       expect(result.isReady).toBe(false);
       expect(result.reason).toBe("Please enter a valid stake amount");
@@ -87,14 +88,23 @@ describe("utils/isStakingSignReady", () => {
         5,
         input.time,
         true,
+        true,
       );
       expect(result.isReady).toBe(false);
       expect(result.reason).toBe("Please enter a valid staking period");
     });
   });
 
+  it("should return false with reason if sufficientBalance is false", () => {
+    const result = isStakingSignReady(1, 10, 20, 30, 5, 25, true, false);
+    expect(result.isReady).toBe(false);
+    expect(result.reason).toBe(
+      "Not enough balance to cover the staking value and its fees",
+    );
+  });
+
   it("should return true with empty reason if amount and time are ready", () => {
-    const result = isStakingSignReady(1, 10, 20, 30, 5, 25, true);
+    const result = isStakingSignReady(1, 10, 20, 30, 5, 25, true, true);
     expect(result.isReady).toBe(true);
     expect(result.reason).toBe("");
   });