Merge pull request #868 from threshold-network/feat/tbtc-deposit-telemetry-to-backend

feat: add deposit data telemetry to be retained in the backend

Author: evandrosaturnino

src/enums/api.ts

@@ -7,6 +7,7 @@ export enum ApiUrl {
 
 export enum endpointUrl {
   TRM_WALLET_SCREENING = "/trm/screen",
+  TBTC_DEPOSIT_DATA = "/deposit-data",
   CURVE_ETHEREUM_POOL = "/getPools/ethereum/factory",
   COINGECKO_SIMPLE_PRICE = "/simple/price",
   COINGECKO_VS_CURRENCY = "vs_currencies",

src/hooks/tbtc/useDepositTelemetry.ts

@@ -1,8 +1,10 @@
+import axios from "axios"
 import { DepositReceipt } from "@keep-network/tbtc-v2.ts"
 import { useCallback } from "react"
 import { BitcoinNetwork } from "../../threshold-ts/types"
 import { verifyDepositAddress } from "../../utils/verifyDepositAddress"
 import { useCaptureMessage } from "../sentry"
+import { ApiUrl, endpointUrl } from "../../enums"
 
 export const useDepositTelemetry = (network: BitcoinNetwork) => {
   const captureMessage = useCaptureMessage()
@@ -40,6 +42,28 @@ export const useDepositTelemetry = (network: BitcoinNetwork) => {
           "verification.status": status,
         }
       )
+
+      const requestBody = {
+        depositAddress,
+        depositor: depositor.identifierHex,
+        blindingFactor: blindingFactor.toString(),
+        walletPublicKeyHash: walletPublicKeyHash.toString(),
+        refundPublicKeyHash: refundPublicKeyHash.toString(),
+        refundLocktime: refundLocktime.toString(),
+        extraData: extraData?.toString(),
+        verificationStatus: status,
+        verificationResponse: response,
+      }
+
+      try {
+        await axios.post(
+          `${ApiUrl.TBTC_EXPLORER}${endpointUrl.TBTC_DEPOSIT_DATA}`,
+          requestBody,
+          { timeout: 10000 }
+        )
+      } catch (error) {
+        throw new Error("Failed to submit deposit telemetry", { cause: error })
+      }
     },
     [verifyDepositAddress, network, captureMessage]
   )

src/pages/tBTC/Bridge/Minting/ProvideData.tsx

@@ -41,6 +41,7 @@ import TbtcFees from "../components/TbtcFees"
 import { useIsActive } from "../../../../hooks/useIsActive"
 import { PosthogButtonId } from "../../../../types/posthog"
 import SubmitTxButton from "../../../../components/SubmitTxButton"
+import { Toast } from "../../../../components/Toast"
 import { Deposit } from "@keep-network/tbtc-v2.ts"
 import { useModal } from "../../../../hooks/useModal"
 import { ModalType } from "../../../../enums"
@@ -162,16 +163,18 @@ const MintingProcessForm = withFormik<MintingProcessFormProps, FormValues>({
 export const ProvideDataComponent: FC<{
   onPreviousStepClick: (previosuStep: MintingStep) => void
 }> = ({ onPreviousStepClick }) => {
-  const { updateState } = useTbtcState()
+  const { updateState, resetDepositData } = useTbtcState()
   const [isSubmitButtonLoading, setSubmitButtonLoading] = useState(false)
+  const [telemetryFailed, setTelemetryFailed] = useState(false)
   const [stagedDepositValues, setStagedDepositValues] =
     useState<FormValues | null>(null)
   const formRef = useRef<FormikProps<FormValues>>(null)
   const threshold = useThreshold()
   const { account, chainId } = useIsActive()
   const { isNonEVMActive, nonEVMPublicKey, nonEVMChainName } =
     useNonEVMConnection()
-  const { setDepositDataInLocalStorage } = useTBTCDepositDataFromLocalStorage()
+  const { setDepositDataInLocalStorage, removeDepositDataFromLocalStorage } =
+    useTBTCDepositDataFromLocalStorage()
   const depositTelemetry = useDepositTelemetry(threshold.tbtc.bitcoinNetwork)
   const connectedAccount = account || nonEVMPublicKey
   const { openModal, closeModal: closeModalFromHook, modalType } = useModal()
@@ -217,6 +220,7 @@ export const ProvideDataComponent: FC<{
       const chainName =
         nonEVMChainName || getEthereumNetworkNameFromChainId(chainId)
 
+      setTelemetryFailed(false)
       setSubmitButtonLoading(true)
 
       let deposit: Deposit
@@ -263,7 +267,16 @@ export const ProvideDataComponent: FC<{
         networkName
       )
 
-      depositTelemetry(receipt, btcDepositAddress)
+      try {
+        await depositTelemetry(receipt, btcDepositAddress)
+      } catch (error) {
+        threshold.tbtc.removeDepositData()
+        resetDepositData()
+        removeDepositDataFromLocalStorage(networkName)
+        setSubmitButtonLoading(false)
+        setTelemetryFailed(true)
+        return
+      }
 
       // if the user has NOT declined the json file, ask the user if they want to accept the new file
       if (shouldDownloadDepositReceipt) {
@@ -296,6 +309,15 @@ export const ProvideDataComponent: FC<{
 
   return (
     <>
+      {telemetryFailed && (
+        <Toast
+          title="We couldn't submit deposit telemetry. Please try again."
+          status="error"
+          duration={8000}
+          top={3}
+          zIndex={1}
+        />
+      )}
       <BridgeProcessCardTitle onPreviousStepClick={onPreviousStepClick} />
       <BridgeProcessCardSubTitle
         stepText="Step 1"