fix: ibc shieled deposits with frontend fees

mateuszjasiuk · mateuszjasiuk · commit 4f31a3355946 · 2025-12-12T12:03:55.000+01:00
diff --git a/apps/namadillo/public/config.toml b/apps/namadillo/public/config.toml
@@ -8,9 +8,9 @@
 [frontend_fee."*"]
 transparent_target = "tnam1qrxsru5rdu4he400xny6p779fcw7xuftsgjnmzup"
 shielded_target = "znam1494fmm9qd4frr7jrydnxlcyt57nhngzutxnzgh6y70mkvh23d9z0jk2aasxh4p8dn2kczlgpans"
-percentage = 0.1
+percentage = 0.01
 
-[frontend_fee.tnam1p54697ljxkw3ptffwy8xjhua9uwjc7kk9cc6fxnw]
-transparent_target = "tnam1qrku7yxdt6d23nhe826ntukygzkfyczuu5mm0yll"
-shielded_target = "znam175uaqlukleyjjyfcccehp2pw3g696a57skewlv0fenldlw702gtjd6qkpjs09zxl6jafsz3e73h"
-percentage = 0.5
+# [frontend_fee.tnam1p54697ljxkw3ptffwy8xjhua9uwjc7kk9cc6fxnw]
+# transparent_target = "tnam1qrku7yxdt6d23nhe826ntukygzkfyczuu5mm0yll"
+# shielded_target = "znam175uaqlukleyjjyfcccehp2pw3g696a57skewlv0fenldlw702gtjd6qkpjs09zxl6jafsz3e73h"
+# percentage = 0.5
diff --git a/apps/namadillo/src/App/Ibc/IbcTransfer.tsx b/apps/namadillo/src/App/Ibc/IbcTransfer.tsx
@@ -68,18 +68,18 @@ export const IbcTransfer = ({
   );
   const { trackEvent } = useFathomTracker();
   const { storeTransaction } = useTransactionActions();
+  const shielded = isShieldedAddress(destinationAddress ?? "");
 
   const { transferToNamada, gasConfig, frontendFee } = useIbcTransaction({
     registry,
     sourceAddress,
     sourceChannel,
     destinationChannel,
-    shielded: isShieldedAddress(destinationAddress ?? ""),
+    shielded,
     selectedAsset: selectedAssetWithAmount?.asset,
   });
 
   // DERIVED VALUES
-  const shielded = isShieldedAddress(destinationAddress ?? "");
   const availableDisplayAmount = mapUndefined((baseDenom) => {
     return userAssets ? userAssets[baseDenom]?.amount : undefined;
   }, selectedAssetWithAmount?.asset?.address);
@@ -124,11 +124,16 @@ export const IbcTransfer = ({
   }: OnSubmitTransferParams): Promise<void> => {
     try {
       invariant(registry?.chain, "Error: Chain not selected");
+      invariant(selectedAssetWithAmount?.asset, "Error: Asset not selected");
+      invariant(displayAmount, "Error: Amount not specified");
+      invariant(destinationAddress, "Error: Destination address not specified");
+
       setGeneralErrorMessage("");
       setCurrentStatus("Submitting...");
+
       const result = await transferToNamada.mutateAsync({
-        destinationAddress: destinationAddress ?? "",
-        displayAmount: new BigNumber(displayAmount ?? "0"),
+        destinationAddress,
+        displayAmount: BigNumber(displayAmount),
         memo,
         onUpdateStatus: setCurrentStatus,
       });
diff --git a/apps/namadillo/src/App/Transfer/TransferModule.tsx b/apps/namadillo/src/App/Transfer/TransferModule.tsx
@@ -11,6 +11,7 @@ import {
   namadaShieldedAssetsAtom,
   namadaTransparentAssetsAtom,
 } from "atoms/balance";
+import { getFrontendFeeEntry } from "atoms/fees";
 import { namadaRegistryChainAssetsMapAtom } from "atoms/integrations";
 import BigNumber from "bignumber.js";
 import clsx from "clsx";
@@ -25,7 +26,7 @@ import {
   useNavigate,
   useSearchParams,
 } from "react-router-dom";
-import { AssetWithAmountAndChain } from "types";
+import { AssetWithAmountAndChain, NamadaAsset } from "types";
 import { filterAvailableAssetsWithBalance } from "utils/assets";
 import { getDisplayGasFee } from "utils/gas";
 import { isIbcAddress, isShieldedAddress } from "./common";
@@ -133,7 +134,14 @@ export const TransferModule = ({
   }, [gasConfig]);
 
   const availableAmountMinusFees = useMemo(() => {
-    if (!availableAmount || !availableAssets || !displayGasFee) return;
+    if (
+      !availableAmount ||
+      !availableAssets ||
+      !displayGasFee ||
+      !gasConfig ||
+      !frontendFee
+    )
+      return;
     let amountMinusFees = availableAmount;
 
     if (gasConfig?.gasToken === selectedAsset?.asset.address) {
@@ -142,9 +150,10 @@ export const TransferModule = ({
         .decimalPlaces(6);
     }
 
-    // TODO: move this code
-    const frontendSusFee =
-      frontendFee?.[selectedAsset.asset.address || "default"];
+    const frontendSusFee = getFrontendFeeEntry(
+      frontendFee,
+      (selectedAsset.asset as NamadaAsset).address
+    );
 
     if (frontendSusFee && (isShielding || isUnshielding)) {
       amountMinusFees = amountMinusFees
diff --git a/apps/namadillo/src/atoms/fees/services.ts b/apps/namadillo/src/atoms/fees/services.ts
@@ -5,7 +5,8 @@ import {
 } from "@namada/indexer-client";
 import { FrontendSusFeeProps } from "@namada/sdk-multicore";
 import { assertNever } from "@namada/utils";
-import { FrontendFee } from "types";
+import BigNumber from "bignumber.js";
+import { FrontendFee, FrontendFeeEntry } from "types";
 import { TxKind } from "types/txKind";
 
 export const fetchGasEstimate = async (
@@ -52,13 +53,23 @@ export const fetchTokensGasPrice = async (
   return (await api.apiV1GasPriceGet()).data;
 };
 
+// TODO: movet o utils
+export const getFrontendFeeEntry = (
+  frontendFee: FrontendFee,
+  address: string
+): FrontendFeeEntry | undefined => {
+  return frontendFee[address] || frontendFee["*"];
+};
+
 export const frontendSusMsgFromConfig = (
   frontendFee: FrontendFee,
   token: string,
   whichTarget: "shielded" | "transparent"
-): FrontendSusFeeProps => {
-  const { percentage, shieldedTarget, transparentTarget } =
-    frontendFee[token] || frontendFee["*"];
+): FrontendSusFeeProps | undefined => {
+  const entry = getFrontendFeeEntry(frontendFee, token);
+  if (!entry) return;
+
+  const { percentage, shieldedTarget, transparentTarget } = entry;
 
   const target =
     whichTarget === "shielded" ? shieldedTarget
@@ -72,3 +83,25 @@ export const frontendSusMsgFromConfig = (
 
   return frontendSusFee;
 };
+
+export const calculateAmountWithoutFrontendFee = (
+  displayAmount: BigNumber,
+  frontendFee: FrontendFeeEntry
+): BigNumber => {
+  return (
+    displayAmount
+      .div(frontendFee.percentage.plus(1))
+      // We have to round UP here as sdk discards the remainder when calculating the fee,
+      // basically rounding down. Otherwise we might end up with remaining dust.
+      .decimalPlaces(6, BigNumber.ROUND_UP)
+  );
+};
+
+export const calculateAmountWithFrontendFee = (
+  displayAmount: BigNumber,
+  frontendFee: FrontendFeeEntry
+): BigNumber => {
+  return displayAmount
+    .multipliedBy(frontendFee.percentage.plus(1))
+    .decimalPlaces(6, BigNumber.ROUND_DOWN);
+};
diff --git a/apps/namadillo/src/hooks/useIbcTransaction.tsx b/apps/namadillo/src/hooks/useIbcTransaction.tsx
@@ -7,6 +7,10 @@ import {
 } from "@tanstack/react-query";
 import { TokenCurrency } from "App/Common/TokenCurrency";
 import { chainParametersAtom } from "atoms/chain";
+import {
+  calculateAmountWithFrontendFee,
+  getFrontendFeeEntry,
+} from "atoms/fees";
 import {
   broadcastIbcTransactionAtom,
   createStargateClient,
@@ -21,6 +25,8 @@ import {
 } from "atoms/notifications";
 import { frontendFeeAtom } from "atoms/settings";
 import BigNumber from "bignumber.js";
+import { pipe } from "fp-ts/lib/function";
+import * as O from "fp-ts/Option";
 import invariant from "invariant";
 import { useAtomValue, useSetAtom } from "jotai";
 import {
@@ -35,6 +41,7 @@ import {
   FrontendFee,
   GasConfig,
   IbcTransferStage,
+  NamadaAsset,
   TransferStep,
   TransferTransactionData,
 } from "types";
@@ -193,6 +200,11 @@ export const useIbcTransaction = ({
           gasConfigQuery.error?.message
       );
 
+      const frontendFeeEntry = getFrontendFeeEntry(
+        frontendFee,
+        (selectedAsset as NamadaAsset).address
+      );
+
       const baseAmount = toBaseAmount(selectedAsset, displayAmount);
 
       const sourceChainAssets =
@@ -227,11 +239,25 @@ export const useIbcTransaction = ({
       const chainId = registry.chain.chain_id;
       const denomination = asset.base;
 
+      const amount = pipe(
+        frontendFeeEntry,
+        O.fromNullable,
+        O.filter(() => !!shielded),
+        O.fold(
+          () => baseAmount,
+          (fee) =>
+            toBaseAmount(
+              selectedAsset,
+              calculateAmountWithFrontendFee(BigNumber(displayAmount), fee)
+            )
+        )
+      );
+
       const transferMsg = createIbcTransferMessage(
         sanitizeChannel(sourceChannel!),
         sanitizeAddress(sourceAddress),
         sanitizeAddress(maspCompatibleReceiver),
-        baseAmount,
+        amount,
         denomination,
         maspCompatibleMemo
       );
@@ -256,7 +282,8 @@ export const useIbcTransaction = ({
         chainId,
         destinationChainId || "",
         getIbcTransferStage(!!shielded),
-        !!shielded
+        !!shielded,
+        baseAmount
       );
       dispatchPendingTxNotification(tx);
       setTxHash(tx.hash);
diff --git a/apps/namadillo/src/lib/transactions.ts b/apps/namadillo/src/lib/transactions.ts
@@ -139,18 +139,24 @@ export const createTransferDataFromIbc = (
   sourceChainId: string,
   destinationChainId: string,
   details: IbcTransferStage,
-  isShieldedTx: boolean
+  isShieldedTx: boolean,
+  // It's needed to calculate real amount if frontend fee is used
+  declaratedBaseAmount: BigNumber
 ): TransferTransactionData => {
   const transferAttributes = getIbcTransferAttributes(tx);
   const packetAttributes = getEventAttribute(tx, "send_packet");
   const feeAttributes = getEventAttribute(tx, "fee_pay");
   const tipAttributes = getEventAttribute(tx, "tip_pay");
   const baseDenom = asset.base;
-
-  const transferAmount = toDisplayAmount(
-    asset,
-    getAmountAttributeValue(transferAttributes, "amount", baseDenom)
+  const attrAmount = getAmountAttributeValue(
+    transferAttributes,
+    "amount",
+    baseDenom
   );
+  const baseAmount =
+    attrAmount.eq(declaratedBaseAmount) ? attrAmount : declaratedBaseAmount;
+
+  const transferAmount = toDisplayAmount(asset, baseAmount);
 
   const tipPaid = toDisplayAmount(
     asset,
diff --git a/apps/namadillo/src/types.ts b/apps/namadillo/src/types.ts
@@ -56,6 +56,11 @@ export type FrontendFee = Record<
     percentage: BigNumber;
   }
 >;
+export type FrontendFeeEntry = {
+  transparentTarget: Address;
+  shieldedTarget: PaymentAddress;
+  percentage: BigNumber;
+};
 
 export type GasConfigToDisplay = {
   totalDisplayAmount: BigNumber;
diff --git a/apps/namadillo/src/workers/MaspTxMessages.ts b/apps/namadillo/src/workers/MaspTxMessages.ts
@@ -94,7 +94,7 @@ type GenerateIbcShieldingMemoPayload = {
   amount: BigNumber;
   destinationChannelId: string;
   chainId: string;
-  frontendSusFee: FrontendSusFeeProps;
+  frontendSusFee?: FrontendSusFeeProps;
 };
 export type GenerateIbcShieldingMemo = WebWorkerMessage<
   "generate-ibc-shielding-memo",
