Feat/add additional analytics to swaps (#2057)

* feat(extension): send total value in ada as success event on swap

* feat(extension): add exact amount check on collateral value

* feat(extension): auto-reclaim collateral if amount too large

* feat(extension): add optional check on inMemoryWallet utxos

* fix(extension): add check if unspendable utxos present in wallet when auto-reclaiming collateral

Author: mchappell

apps/browser-extension-wallet/src/hooks/useCollateral.ts

@@ -51,7 +51,7 @@ export const useCollateral = (): UseCollateralReturn => {
 
   useEffect(() => {
     const isPureUtxoWithEnoughCoins = (utxo: Cardano.Utxo): boolean =>
-      !utxo[1].value?.assets && utxo[1].value.coins >= COLLATERAL_AMOUNT_LOVELACES;
+      !utxo[1].value?.assets && utxo[1].value.coins === COLLATERAL_AMOUNT_LOVELACES;
 
     const checkCollateral = async (): Promise<void> => {
       if (!inMemoryWallet?.utxo?.available$) return;

apps/browser-extension-wallet/src/routes/PopupView.tsx

@@ -18,6 +18,8 @@ import { removePreloaderIfExists } from '@utils/remove-reloader-if-exists';
 import { ENHANCED_ANALYTICS_OPT_IN_STATUS_LS_KEY } from '@providers/AnalyticsProvider/config';
 import { EnhancedAnalyticsOptInStatus } from '@providers/AnalyticsProvider/analyticsTracker';
 import { useAnalyticsContext } from '@providers';
+import { useObservable } from '@lace/common';
+import { autoReclaimLargeCollateralUtxos } from '@src/utils/collateral-utils';
 
 dayjs.extend(duration);
 
@@ -41,6 +43,12 @@ export const PopupView = (): React.ReactElement => {
     initialHdDiscoveryCompleted
   } = useWalletStore();
 
+  const unspendable = useObservable(inMemoryWallet?.balance?.utxo.unspendable$);
+
+  useEffect(() => {
+    autoReclaimLargeCollateralUtxos(inMemoryWallet);
+  }, [unspendable, inMemoryWallet]);
+
   const [{ lastMnemonicVerification, mnemonicVerificationFrequency, chainName }] = useAppSettingsContext();
   const backgroundServices = useBackgroundServiceAPIContext();
 

apps/browser-extension-wallet/src/utils/collateral-utils.ts

@@ -0,0 +1,35 @@
+import { Cardano } from '@cardano-sdk/core';
+import { ObservableWallet } from '@cardano-sdk/wallet';
+import { firstValueFrom, take } from 'rxjs';
+import { COLLATERAL_AMOUNT_LOVELACES } from './constants';
+
+/**
+ * Checks if a UTXO is unspendable (collateral) with too high coin lockup
+ * @param utxo - The UTXO to check
+ * @returns true if the UTXO has no assets and coins exceed the collateral amount threshold
+ */
+const isUnspendableWithTooHighCoinLockup = (utxo: Cardano.Utxo): boolean =>
+  !utxo[1].value?.assets && utxo[1].value.coins > COLLATERAL_AMOUNT_LOVELACES;
+
+/**
+ * Automatically reclaims collateral UTXOs that are too large
+ * If any unspendable UTXOs have a coin value over COLLATERAL_AMOUNT_LOVELACES,
+ * they are automatically removed from the unspendable set to reclaim them
+ * @param inMemoryWallet - The wallet instance
+ */
+export const autoReclaimLargeCollateralUtxos = async (inMemoryWallet: ObservableWallet): Promise<void> => {
+  // Guard: return early if wallet is not available
+  if (!inMemoryWallet?.utxo?.unspendable$) {
+    return;
+  }
+
+  // if we've got utxos OVER COLLATERAL_AMOUNT_LOVELACES automatically reclaim them
+  const collateral = await firstValueFrom(inMemoryWallet.utxo.unspendable$.pipe(take(1)));
+  const matchingUnspendableUtxos = collateral.filter((o) => isUnspendableWithTooHighCoinLockup(o));
+
+  if (matchingUnspendableUtxos.length > 0) {
+    // Remove the matching unspendable UTXOs by setting unspendable to only the UTXOs that don't match
+    const remainingUnspendableUtxos = collateral.filter((o) => !isUnspendableWithTooHighCoinLockup(o));
+    await inMemoryWallet.utxo.setUnspendable(remainingUnspendableUtxos);
+  }
+};

apps/browser-extension-wallet/src/views/browser-view/features/swaps/components/SwapProvider.tsx

@@ -26,6 +26,7 @@ import {
 import { SwapsContainer } from './SwapContainer';
 import { DropdownList } from './drawers';
 import { usePostHogClientContext } from '@providers/PostHogClientProvider';
+import { useBackgroundServiceAPIContext } from '@providers/BackgroundServiceAPI';
 import { useTranslation } from 'react-i18next';
 import { TFunction } from 'i18next';
 import { storage } from 'webextension-polyfill';
@@ -134,6 +135,8 @@ export const SwapsProvider = (): React.ReactElement => {
   const utxos = useObservable(inMemoryWallet.utxo.available$);
   const collateral = useObservable(inMemoryWallet.utxo.unspendable$);
   const addresses = useObservable(inMemoryWallet.addresses$);
+  const { coinPrices } = useBackgroundServiceAPIContext();
+  const tokenPrices = useObservable(coinPrices.tokenPrices$);
 
   // swaps interface
   const [tokenA, setTokenA] = useState<DropdownList>();
@@ -437,13 +440,26 @@ export const SwapsProvider = (): React.ReactElement => {
   );
 
   const sendSuccessPosthogEvent = useCallback(() => {
+    let totalValueTransferInAda = 0;
+
+    // If swapping from ADA, the quantity is already in ADA
+    if (tokenA.id === 'lovelace') {
+      totalValueTransferInAda = Number(quantity);
+    } else {
+      // For other tokens, get the token price in ADA and multiply by quantity
+      const tokenPrice = tokenPrices?.tokens.get(tokenA.id as Wallet.Cardano.AssetId);
+      const priceInAda = tokenPrice?.price?.priceInAda || 0;
+      totalValueTransferInAda = Number(quantity) * priceInAda;
+    }
+
     posthog.sendEvent(PostHogAction.SwapsSignSuccess, {
       tokenIn: tokenB,
       tokenOut: tokenA,
       quantity,
-      targetSlippage: targetSlippage.toString()
+      targetSlippage: targetSlippage.toString(),
+      totalValueTransferInAda: totalValueTransferInAda.toString()
     });
-  }, [tokenA, tokenB, posthog, quantity, targetSlippage]);
+  }, [tokenA, tokenB, posthog, quantity, targetSlippage, tokenPrices]);
 
   const signAndSubmitSwapRequest = useCallback(async () => {
     const unableToSignErrorText = t('swaps.error.unableToSign');

apps/browser-extension-wallet/src/views/browser-view/routes/index.tsx

@@ -40,7 +40,7 @@ import { DAppExplorer } from '@views/browser/features/dapp/explorer/components/D
 import { useFatalError } from '@hooks/useFatalError';
 import { Crash } from '@components/ErrorBoundary';
 import { useIsPosthogClientInitialized } from '@providers/PostHogClientProvider/useIsPosthogClientInitialized';
-import { logger } from '@lace/common';
+import { logger, useObservable } from '@lace/common';
 import { VotingLayout } from '../features/voting-beta';
 import { catchAndBrandExtensionApiError } from '@utils/catch-and-brand-extension-api-error';
 import { removePreloaderIfExists } from '@utils/remove-reloader-if-exists';
@@ -50,6 +50,7 @@ import { useNotificationsCenterConfig } from '@hooks/useNotificationsCenterConfi
 import { NotificationDetailsContainer, NotificationsCenter } from '../features/notifications-center';
 import { SwapsProvider } from '../features/swaps';
 import { WalletType } from '@cardano-sdk/web-extension';
+import { autoReclaimLargeCollateralUtxos } from '@src/utils/collateral-utils';
 
 export const defaultRoutes: RouteMap = [
   {
@@ -150,7 +151,8 @@ export const BrowserViewRoutes = ({ routesMap = defaultRoutes }: { routesMap?: R
     initialHdDiscoveryCompleted,
     isSharedWallet,
     environmentName,
-    isBitcoinWallet
+    isBitcoinWallet,
+    inMemoryWallet
   } = useWalletStore();
   const [{ chainName }] = useAppSettingsContext();
   const [isLoadingWalletInfo, setIsLoadingWalletInfo] = useState(true);
@@ -161,6 +163,12 @@ export const BrowserViewRoutes = ({ routesMap = defaultRoutes }: { routesMap?: R
   const isVotingCenterEnabled = !!GOV_TOOLS_URLS[environmentName];
   const { isNotificationsCenterEnabled } = useNotificationsCenterConfig();
 
+  const unspendable = useObservable(inMemoryWallet?.balance?.utxo.unspendable$);
+
+  useEffect(() => {
+    autoReclaimLargeCollateralUtxos(inMemoryWallet);
+  }, [unspendable, inMemoryWallet]);
+
   const availableRoutes = routesMap.filter((route) => {
     if (route.path === routes.staking && isSharedWallet) return false;
     if (route.path === routes.voting && !isVotingCenterEnabled) return false;