fix: allow failed address checker users to perform unbond

Author: jrwbabylonlab

src/ui/common/context/wallet/BTCWalletProvider.tsx

@@ -35,14 +35,19 @@ import {
   toNetwork,
 } from "@/ui/common/utils/wallet";
 
+import { useAddressScreeningService } from "../../hooks/services/useAddressScreeningService";
+
 const btcConfig = getNetworkConfigBTC();
+const supportedNetworkMessage =
+  "Only Native SegWit and Taproot addresses are supported. Please switch the address type in your wallet and try again.";
 
 interface BTCWalletContextProps {
   loading: boolean;
   network?: networks.Network;
   publicKeyNoCoord: string;
   address: string;
   connected: boolean;
+  failedBtcAddressRiskAssessment: boolean;
   disconnect: () => void;
   open: () => void;
   getAddress: () => Promise<string>;
@@ -70,6 +75,7 @@ const BTCWalletContext = createContext<BTCWalletContextProps>({
   connected: false,
   publicKeyNoCoord: "",
   address: "",
+  failedBtcAddressRiskAssessment: false,
   disconnect: () => {},
   open: () => {},
   getAddress: async () => "",
@@ -87,6 +93,8 @@ const BTCWalletContext = createContext<BTCWalletContextProps>({
 
 export const BTCWalletProvider = ({ children }: PropsWithChildren) => {
   const [loading, setLoading] = useState(true);
+  const [failedBtcAddressRiskAssessment, setFailedBtcAddressRiskAssessment] =
+    useState(false);
   const [btcWalletProvider, setBTCWalletProvider] = useState<IBTCProvider>();
   const [network, setNetwork] = useState<networks.Network>();
   const [publicKeyNoCoord, setPublicKeyNoCoord] = useState("");
@@ -97,24 +105,25 @@ export const BTCWalletProvider = ({ children }: PropsWithChildren) => {
   const { open = () => {}, connected } = useWalletConnect();
   const logger = useLogger();
   const { updateUser } = useSentryUser();
+  const { screenAddress, clearAddressScreeningResult } =
+    useAddressScreeningService();
 
   const btcDisconnect = useCallback(() => {
     setBTCWalletProvider(undefined);
     setNetwork(undefined);
     setPublicKeyNoCoord("");
     setAddress("");
+    setFailedBtcAddressRiskAssessment(false);
 
     updateUser({ btcAddress: null });
-  }, [updateUser]);
+    clearAddressScreeningResult();
+  }, [updateUser, clearAddressScreeningResult]);
 
   const connectBTC = useCallback(
     async (walletProvider: IBTCProvider | null) => {
       if (!walletProvider) return;
       setLoading(true);
 
-      const supportedNetworkMessage =
-        "Only Native SegWit and Taproot addresses are supported. Please switch the address type in your wallet and try again.";
-
       try {
         const network = await walletProvider.getNetwork();
         if (network !== btcConfig.network) {
@@ -164,6 +173,9 @@ export const BTCWalletProvider = ({ children }: PropsWithChildren) => {
           throw emptyProcessedPubKeyError;
         }
 
+        const failedRiskAssessment = await screenAddress(address);
+        setFailedBtcAddressRiskAssessment(failedRiskAssessment);
+
         setBTCWalletProvider(walletProvider);
         setNetwork(toNetwork(network));
         setAddress(address);
@@ -192,7 +204,7 @@ export const BTCWalletProvider = ({ children }: PropsWithChildren) => {
         });
       }
     },
-    [handleError, publicKeyNoCoord, address, logger, updateUser],
+    [handleError, publicKeyNoCoord, address, logger, updateUser, screenAddress],
   );
 
   useEffect(() => {
@@ -288,13 +300,15 @@ export const BTCWalletProvider = ({ children }: PropsWithChildren) => {
       network,
       publicKeyNoCoord,
       address,
+      failedBtcAddressRiskAssessment,
       connected,
       open,
       disconnect: btcDisconnect,
       ...btcWalletMethods,
     }),
     [
       loading,
+      failedBtcAddressRiskAssessment,
       connected,
       network,
       publicKeyNoCoord,

src/ui/common/context/wallet/WalletConnectionProvider.tsx

@@ -7,7 +7,6 @@ import { useTheme } from "next-themes";
 import { useCallback, type PropsWithChildren } from "react";
 
 import { logTermsAcceptance } from "@/ui/common/api/logTermAcceptance";
-import { verifyBTCAddress } from "@/ui/common/api/verifyBTCAddress";
 import { getNetworkConfigBBN } from "@/ui/common/config/network/bbn";
 import { getNetworkConfigBTC } from "@/ui/common/config/network/btc";
 import { ClientError, ERROR_CODES } from "@/ui/common/errors";
@@ -20,7 +19,6 @@ const context = typeof window !== "undefined" ? window : {};
 
 const lifecycleHooks = {
   acceptTermsOfService: logTermsAcceptance,
-  verifyBTCAddress: verifyBTCAddress,
 };
 
 const config: ChainConfigArr = [

src/ui/common/hooks/services/useAddressScreeningService.ts

@@ -0,0 +1,52 @@
+import { useCallback } from "react";
+
+import { verifyBTCAddress } from "../../api/verifyBTCAddress";
+import {
+  clearBtcAddressScreeningResult,
+  getBtcAddressScreeningResult,
+  setBtcAddressScreeningResult,
+} from "../../utils/local_storage/addressScreeningStorage";
+import { useLogger } from "../useLogger";
+
+export function useAddressScreeningService() {
+  const logger = useLogger();
+
+  const screenAddress = useCallback(
+    async (btcAddress: string) => {
+      try {
+        // Check cache first
+        const cachedResult = getBtcAddressScreeningResult();
+        if (cachedResult && cachedResult.btcAddress === btcAddress) {
+          return cachedResult.failedRiskAssessment;
+        }
+
+        // Perform screening
+        const riskAssessment = await verifyBTCAddress(btcAddress);
+        const failedRiskAssessment = !riskAssessment;
+
+        // Cache result
+        setBtcAddressScreeningResult(btcAddress, failedRiskAssessment);
+
+        logger.info("Address screening completed", {
+          btcAddress,
+          failedRiskAssessment,
+        });
+
+        return failedRiskAssessment;
+      } catch (error: any) {
+        logger.error(error, { data: { btcAddress } });
+        return false; // Default to safe
+      }
+    },
+    [logger],
+  );
+
+  const clearAddressScreeningResult = useCallback(() => {
+    clearBtcAddressScreeningResult();
+  }, []);
+
+  return {
+    screenAddress,
+    clearAddressScreeningResult,
+  };
+}

src/ui/common/utils/local_storage/addressScreeningStorage.ts

@@ -0,0 +1,44 @@
+import { network } from "@/ui/common/config/network/bbn";
+
+export const BTC_ADDRESS_SCREENING_KEY = `btc-address-screening-${network}`;
+
+export interface BtcAddressScreening {
+  btcAddress: string;
+  failedRiskAssessment: boolean;
+}
+
+export function getBtcAddressScreeningResult():
+  | BtcAddressScreening
+  | undefined {
+  try {
+    const value = localStorage.getItem(BTC_ADDRESS_SCREENING_KEY);
+    if (!value) return undefined;
+    const parsed = JSON.parse(value);
+    return parsed;
+  } catch {
+    return undefined;
+  }
+}
+
+export function setBtcAddressScreeningResult(
+  address: string,
+  failedRiskAssessment: boolean = false,
+): void {
+  try {
+    if (!address) return;
+    localStorage.setItem(
+      BTC_ADDRESS_SCREENING_KEY,
+      JSON.stringify({ btcAddress: address, failedRiskAssessment }),
+    );
+  } catch {
+    /* noop */
+  }
+}
+
+export function clearBtcAddressScreeningResult(): void {
+  try {
+    localStorage.removeItem(BTC_ADDRESS_SCREENING_KEY);
+  } catch {
+    /* noop */
+  }
+}