feat: wip tx lvl fees

Author: mateuszjasiuk

apps/namadillo/package.json

@@ -12,7 +12,7 @@
     "@keplr-wallet/types": "^0.12.136",
     "@namada/chain-registry": "^1.5.2",
     "@namada/indexer-client": "4.0.5",
-    "@namada/sdk-multicore": "0.23.0",
+    "@namada/sdk-multicore": "file:.yalc/@namada/sdk-multicore",
     "@tailwindcss/container-queries": "^0.1.1",
     "@tanstack/query-core": "^5.40.0",
     "@tanstack/react-query": "^5.40.0",

apps/namadillo/public/config.toml

@@ -4,3 +4,12 @@
 #masp_indexer_url = ""
 #localnet_enabled = false
 #fathom_site_id = ""
+
+[server_fee]
+# tnam or znam address
+# target = "znam175uaqlukleyjjyfcccehp2pw3g696a57skewlv0fenldlw702gtjd6qkpjs09zxl6jafsz3e73h"
+target = "tnam1qrku7yxdt6d23nhe826ntukygzkfyczuu5mm0yll"
+# between 0 and 1
+percentage = 0.001
+# raw max value
+max_value = 100

apps/namadillo/src/App/Transfer/TransferModule.tsx

@@ -130,19 +130,19 @@ export const TransferModule = ({
   }, [gasConfig]);
 
   const availableAmountMinusFees = useMemo(() => {
-    if (!availableAmount || !availableAssets) return;
+    if (!availableAmount || !availableAssets || !displayGasFee) return;
+    let amountMinusFees = availableAmount;
 
-    if (
-      !displayGasFee?.totalDisplayAmount ||
-      // Don't subtract if the gas token is different than the selected asset:
-      gasConfig?.gasToken !== selectedAsset?.asset.address
-    ) {
-      return availableAmount;
+    if (gasConfig?.gasToken === selectedAsset?.asset.address) {
+      amountMinusFees = availableAmount
+        .minus(displayGasFee.totalDisplayAmount)
+        .decimalPlaces(6);
+    }
+    if (feeProps?.frontendFeeConfig?.percentage) {
+      amountMinusFees = amountMinusFees
+        .div(feeProps.frontendFeeConfig.percentage.plus(1))
+        .decimalPlaces(6);
     }
-
-    const amountMinusFees = availableAmount
-      .minus(displayGasFee.totalDisplayAmount)
-      .decimalPlaces(6);
 
     return BigNumber.max(amountMinusFees, 0);
   }, [selectedAsset?.asset.address, availableAmount, displayGasFee]);

apps/namadillo/src/atoms/integrations/services.ts

@@ -16,7 +16,7 @@ import {
 } from "@namada/indexer-client";
 import { getIndexerApi } from "atoms/api";
 import { chainParametersAtom } from "atoms/chain";
-import { rpcUrlAtom } from "atoms/settings";
+import { rpcUrlAtom, serverFeeAtom } from "atoms/settings";
 import { queryForAck, queryForIbcTimeout } from "atoms/transactions";
 import BigNumber from "bignumber.js";
 import * as Comlink from "comlink";
@@ -73,6 +73,7 @@ export const getShieldedArgs = async (
   const store = getDefaultStore();
   const rpcUrl = store.get(rpcUrlAtom);
   const chain = store.get(chainParametersAtom);
+  const serverFee = store.get(serverFeeAtom);
 
   if (!chain.isSuccess) throw "Chain not loaded";
 
@@ -91,6 +92,7 @@ export const getShieldedArgs = async (
       amount,
       destinationChannelId,
       chainId: chain.data.chainId,
+      frontendFeeConfig: serverFee,
     },
   };
 

apps/namadillo/src/atoms/settings/atoms.ts

@@ -1,6 +1,7 @@
 import { isUrlValid, sanitizeUrl } from "@namada/utils";
 import { getCustomIndexerApi, indexerApiAtom } from "atoms/api";
 import { chainParametersAtom, indexerRpcUrlAtom } from "atoms/chain";
+import BigNumber from "bignumber.js";
 import { Getter, Setter, atom, getDefaultStore } from "jotai";
 import { atomWithMutation, atomWithQuery } from "jotai-tanstack-query";
 import { atomWithStorage } from "jotai/utils";
@@ -175,6 +176,19 @@ export const maspIndexerUrlAtom = atom((get) => {
   return "";
 });
 
+// TODO: figure out where to have this atom
+export const serverFeeAtom = atom((get) => {
+  const serverFee = get(defaultServerConfigAtom).data?.server_fee;
+  return (
+    serverFee && {
+      target: serverFee.target,
+      percentage: BigNumber(serverFee.percentage),
+      maxValue:
+        serverFee.max_value ? BigNumber(serverFee.max_value) : undefined,
+    }
+  );
+});
+
 export const updateIndexerUrlAtom = atomWithMutation(() => {
   return {
     mutationKey: ["update-indexer-url"],

apps/namadillo/src/atoms/transfer/atoms.ts

@@ -103,14 +103,16 @@ export const createShieldingTransferAtom = atomWithMutation((get) => {
       gasConfig,
       account,
       memo,
+      frontendFeeConfig,
     }: BuildTxAtomParams<ShieldingTransferProps>) =>
       createShieldingTransferTx(
         chain.data!,
         account,
         params,
         gasConfig,
         rpcUrl,
-        memo
+        memo,
+        frontendFeeConfig
       ),
   };
 });

apps/namadillo/src/atoms/transfer/services.ts

@@ -17,7 +17,7 @@ import BigNumber from "bignumber.js";
 import * as Comlink from "comlink";
 import { NamadaKeychain } from "hooks/useNamadaKeychain";
 import { buildTx, EncodedTxData, isPublicKeyRevealed } from "lib/query";
-import { Address, ChainSettings, GasConfig } from "types";
+import { Address, ChainSettings, FrontendFeeConfig, GasConfig } from "types";
 import { getSdkInstance } from "utils/sdk";
 import {
   IbcTransfer,
@@ -168,7 +168,8 @@ export const createShieldingTransferTx = async (
   props: ShieldingTransferProps[],
   gasConfig: GasConfig,
   rpcUrl: string,
-  memo?: string
+  memo?: string,
+  frontendFeeConfig?: FrontendFeeConfig
 ): Promise<EncodedTxData<ShieldingTransferProps> | undefined> => {
   const source = props[0]?.data[0]?.source;
   const destination = props[0]?.target;
@@ -193,6 +194,10 @@ export const createShieldingTransferTx = async (
         target: destination,
         data: [{ source, token, amount }],
         bparams,
+        frontendSusFee: frontendFeeConfig && {
+          address: frontendFeeConfig.target,
+          amount: frontendFeeConfig.percentage.toString(),
+        },
       };
       const msg: Shield = {
         type: "shield",
@@ -220,7 +225,8 @@ export const createUnshieldingTransferTx = async (
   gasConfig: GasConfig,
   rpcUrl: string,
   disposableSigner: GenDisposableSignerResponse,
-  memo?: string
+  memo?: string,
+  frontendFeeConfig?: FrontendFeeConfig
 ): Promise<EncodedTxData<UnshieldingTransferProps> | undefined> => {
   const { publicKey: signerPublicKey } = disposableSigner;
 
@@ -247,6 +253,10 @@ export const createUnshieldingTransferTx = async (
         source,
         data: [{ target: destination, token, amount }],
         bparams,
+        frontendSusFee: frontendFeeConfig && {
+          address: frontendFeeConfig.target,
+          amount: frontendFeeConfig.percentage.toString(),
+        },
       };
 
       const msg: Unshield = {
@@ -274,7 +284,8 @@ export const createIbcTx = async (
   gasConfig: GasConfig,
   rpcUrl: string,
   signerPublicKey: string,
-  memo?: string
+  memo?: string,
+  frontendFeeConfig?: FrontendFeeConfig
 ): Promise<EncodedTxData<IbcTransferProps>> => {
   let bparams: BparamsMsgValue[] | undefined;
   if (account.type === AccountType.Ledger) {
@@ -292,6 +303,10 @@ export const createIbcTx = async (
         ...props[0],
         gasSpendingKey: props[0].gasSpendingKey,
         bparams,
+        frontendSusFee: frontendFeeConfig && {
+          address: frontendFeeConfig.target,
+          amount: frontendFeeConfig.percentage.toString(),
+        },
       };
 
       // We only check if we need to reveal the public key if the gas spending key is not provided
@@ -326,7 +341,8 @@ export const createOsmosisSwapTx = async (
   gasConfig: GasConfig,
   rpcUrl: string,
   disposableSigner: GenDisposableSignerResponse,
-  memo?: string
+  memo?: string,
+  frontendFeeConfig?: FrontendFeeConfig
 ): Promise<EncodedTxData<OsmosisSwapProps>> => {
   const { publicKey: signerPublicKey } = disposableSigner;
 
@@ -349,6 +365,10 @@ export const createOsmosisSwapTx = async (
           ...transfer,
           gasSpendingKey: transfer.gasSpendingKey,
           bparams,
+          frontendSusFee: frontendFeeConfig && {
+            address: frontendFeeConfig.target,
+            amount: frontendFeeConfig.percentage.toString(),
+          },
         },
       };
       const msg: OsmosisSwap = {

apps/namadillo/src/hooks/useTransaction.tsx

@@ -147,6 +147,7 @@ export const useTransaction = <T,>({
           params,
           gasConfig: feeProps.gasConfig,
           account,
+          frontendFeeConfig: feeProps.frontendFeeConfig,
           ...txAdditionalParams,
         };
         const encodedTxData = await performBuildTx(variables);

apps/namadillo/src/hooks/useTransactionFee/useTransactionFee.ts

@@ -9,11 +9,12 @@ import {
   isPublicKeyRevealedAtom,
 } from "atoms/fees";
 import { tokenPricesFamily } from "atoms/prices/atoms";
+import { serverFeeAtom } from "atoms/settings";
 import BigNumber from "bignumber.js";
 import invariant from "invariant";
 import { useAtomValue } from "jotai";
 import { useMemo, useState } from "react";
-import { GasConfig } from "types";
+import { FrontendFeeConfig, GasConfig } from "types";
 import { TxKind } from "types/txKind";
 import { findCheapestToken } from "./internal";
 
@@ -24,6 +25,7 @@ export type TransactionFeeProps = {
   gasPriceTable: GasPriceTable | undefined;
   onChangeGasLimit: (value: BigNumber) => void;
   onChangeGasToken: (value: string) => void;
+  frontendFeeConfig?: FrontendFeeConfig;
 };
 
 export const useTransactionFee = (
@@ -35,6 +37,7 @@ export const useTransactionFee = (
   const userTransparentBalances = useAtomValue(transparentBalanceAtom);
   const userShieldedBalances = useAtomValue(shieldedBalanceAtom);
   const isPublicKeyRevealed = useAtomValue(isPublicKeyRevealedAtom);
+  const serverFee = useAtomValue(serverFeeAtom);
 
   const { data: nativeToken, isLoading: isLoadingNativeToken } = useAtomValue(
     nativeTokenAddressAtom
@@ -137,6 +140,13 @@ export const useTransactionFee = (
     gasToken,
   };
 
+  // TODO: mappings
+  const frontendFeeConfig = serverFee && {
+    target: serverFee.target,
+    percentage: serverFee.percentage,
+    maxFeeInMinDenom: serverFee.maxValue,
+  };
+
   const isLoading =
     userTransparentBalances.isLoading ||
     isLoadingNativeToken ||
@@ -145,6 +155,7 @@ export const useTransactionFee = (
 
   return {
     gasConfig,
+    frontendFeeConfig,
     isLoading,
     gasEstimate,
     gasPriceTable,

apps/namadillo/src/types.ts

@@ -26,6 +26,7 @@ type Unique = {
 export type PublicKey = string;
 
 export type Address = string;
+export type PaymentAddress = string;
 
 export type BaseDenom = string;
 
@@ -46,6 +47,12 @@ export type GasConfig = {
   gasToken: GasToken;
 };
 
+export type FrontendFeeConfig = {
+  target: Address | PaymentAddress;
+  percentage: BigNumber;
+  maxValue?: BigNumber;
+};
+
 export type GasConfigToDisplay = {
   totalDisplayAmount: BigNumber;
   asset: Asset;
@@ -71,6 +78,11 @@ export type SettingsTomlOptions = {
   rpc_url?: string;
   localnet_enabled?: boolean;
   fathom_site_id?: string;
+  server_fee?: {
+    target: string;
+    percentage: number;
+    max_value?: number;
+  };
 };
 
 export type ChainParameters = {
@@ -184,6 +196,7 @@ export type BuildTxAtomParams<T> = {
   gasConfig: GasConfig;
   memo?: string;
   signer?: Signer;
+  frontendFeeConfig?: FrontendFeeConfig;
 };
 
 export type SortOptions = "asc" | "desc" | undefined;