chore: cleanup todos

Author: mateuszjasiuk

apps/namadillo/src/App/Swap/SwapCalculations.tsx

@@ -24,12 +24,7 @@ import { SwapSource } from "./SwapSource";
 import { useSwapSimulation } from "./hooks/useSwapSimulation";
 import { useSwapValidation } from "./hooks/useSwapValidation";
 import { SwapQuote, SwapState, SwapStatus } from "./state";
-import {
-  setInternalSwapStateAtom,
-  swapQuoteAtom,
-  swapStateAtom,
-  swapStatusAtom,
-} from "./state/atoms";
+import { swapQuoteAtom, swapStateAtom, swapStatusAtom } from "./state/atoms";
 
 const keplr = new KeplrWalletManager();
 
@@ -45,7 +40,6 @@ export const SwapCalculations = (): JSX.Element => {
 
   // Feature state
   const [swapState, setSwapState] = useAtom(swapStateAtom);
-  const setInternalSwapState = useSetAtom(setInternalSwapStateAtom);
   const { data: quote } = useAtomValue(swapQuoteAtom);
   const setStatus = useSetAtom(swapStatusAtom);
 
@@ -60,11 +54,7 @@ export const SwapCalculations = (): JSX.Element => {
     defaultShieldedAccountAtom
   )?.address;
 
-  useSwapSimulation({
-    swapState,
-    setInternalSwapState,
-    quote,
-  });
+  useSwapSimulation();
 
   const { walletAddress, connectToChainId, registry } = useWalletManager(keplr);
 

apps/namadillo/src/App/Swap/hooks/usePerformOsmosisSwapTx.tsx

@@ -3,8 +3,8 @@ import { AccountType } from "@namada/types";
 import { allDefaultAccountsAtom } from "atoms/accounts";
 import { chainAtom } from "atoms/chain";
 import {
-  createNotificationId,
   dispatchToastNotificationAtom,
+  getNotificationId,
 } from "atoms/notifications";
 import { createOsmosisSwapTxAtom } from "atoms/transfer/atoms";
 import {
@@ -20,34 +20,12 @@ import { useAtomValue, useSetAtom } from "jotai";
 import { broadcastTxWithEvents, signTx, TransactionPair } from "lib/query";
 import { useCallback, useState } from "react";
 import { NamadaAsset, OsmosisSwapTransactionData, TransferStep } from "types";
+import { TransactionError } from "types/errors";
 import { toBaseAmount } from "utils";
 import { SwapStatus } from "../state";
 import { swapQuoteAtom, swapStateAtom, swapStatusAtom } from "../state/atoms";
 
-// TODO: reused - unify
-class TransactionError<T> extends Error {
-  public cause: { originalError: unknown; context: TransactionPair<T> };
-  constructor(
-    public message: string,
-    options: {
-      cause: { originalError: unknown; context: TransactionPair<T> };
-    }
-  ) {
-    super(message);
-    this.cause = options.cause;
-  }
-}
-
-// TODO: reused - unify;
-const getNotificationId = <T,>(tx: TransactionPair<T>): string => {
-  const notificationId = createNotificationId(
-    tx.encodedTxData.txs.map((tx) => tx.hash)
-  );
-
-  return notificationId;
-};
-
-// TODO: configurable
+// TODO: Should be a different address for housefire
 const SWAP_CONTRACT_ADDRESS =
   "osmo14q5zmg3fp774kpz2j8c52q7gqjn0dnm3vcj3guqpj4p9xylqpc7s2ezh0h";
 

apps/namadillo/src/App/Swap/hooks/useSwapSimulation.tsx

@@ -1,23 +1,20 @@
 import invariant from "invariant";
-import { useEffect, useRef } from "react";
+import { useAtom, useAtomValue } from "jotai";
+import { useEffect } from "react";
 import { toDisplayAmount } from "utils";
 import { SwapQuote, SwapState } from "../state";
-
-// TODO: no need to pass props, use atoms directly
-export const useSwapSimulation = ({
-  swapState,
-  setInternalSwapState,
-  quote,
-}: {
-  swapState: SwapState;
-  setInternalSwapState: React.Dispatch<React.SetStateAction<SwapState>>;
-  quote?: SwapQuote;
-}): void => {
-  const swapStateRef = useRef(swapState);
-
-  useEffect(() => {
-    swapStateRef.current = swapState;
-  }, [swapState]);
+import {
+  internalSwapStateAtom,
+  swapQuoteAtom,
+  swapStateAtom,
+} from "../state/atoms";
+
+export const useSwapSimulation = (): void => {
+  const { data: quote } = useAtomValue(swapQuoteAtom);
+  const [internalSwapState, setInternalSwapState] = useAtom(
+    internalSwapStateAtom
+  );
+  const swapState = useAtomValue(swapStateAtom);
 
   useEffect(() => {
     const simulate = (quote: SwapQuote, swapState: SwapState): void => {
@@ -39,15 +36,15 @@ export const useSwapSimulation = ({
       const simulateBuy = swapState.mode === "buy";
 
       if (simulateSell && sellAsset) {
-        if (swapState.sellAmount === swapStateRef.current.sellAmount) {
+        if (swapState.sellAmount === internalSwapState.sellAmount) {
           setInternalSwapState((s) => ({
             ...s,
             buyAmount: toDisplayAmount(buyAsset, quote.amountOut),
             sellAmountPerOneBuy,
           }));
         }
       } else if (simulateBuy && buyAsset) {
-        if (swapState.buyAmount === swapStateRef.current.buyAmount) {
+        if (swapState.buyAmount === internalSwapState.buyAmount) {
           setInternalSwapState((s) => ({
             ...s,
             sellAmount: toDisplayAmount(sellAsset, quote.amountIn),

apps/namadillo/src/App/Swap/state/atoms.ts

@@ -125,7 +125,7 @@ export const swapQuoteAtom = atomWithQuery((get) => {
   const swapState = get(debouncedSwapStateAtom);
   const { sellAsset, buyAsset } = swapState;
 
-  // TODO: osmosis-1 should be dynamic
+  // TODO: this should be configurable once we support osmosis testnet
   const osmosisAssets =
     getChainRegistryByChainId("osmosis-1")?.assets.assets || [];
 

apps/namadillo/src/App/Swap/state/types.ts

@@ -66,7 +66,6 @@ export const statusMessages: Record<
   },
 };
 
-// TODO: make this type mroe specific
 export type SwapState = {
   mode: "sell" | "buy" | "none";
   sellAmount?: BigNumber;

apps/namadillo/src/atoms/notifications/functions.ts

@@ -1,8 +1,17 @@
 export const notificationIdSeparator = ";";
 import { TxProps } from "@namada/types";
+import { TransactionPair } from "lib/query";
 
 export const createNotificationId = (data?: TxProps["hash"][]): string => {
   if (!data) return Date.now().toString();
   if (Array.isArray(data)) return data.join(notificationIdSeparator);
   return data;
 };
+
+export const getNotificationId = <T>(tx: TransactionPair<T>): string => {
+  const notificationId = createNotificationId(
+    tx.encodedTxData.txs.map((tx) => tx.hash)
+  );
+
+  return notificationId;
+};

apps/namadillo/src/hooks/useTransaction.tsx

@@ -1,8 +1,8 @@
 import { useMutation, UseMutationResult } from "@tanstack/react-query";
 import { defaultAccountAtom } from "atoms/accounts";
 import {
-  createNotificationId,
   dispatchToastNotificationAtom,
+  getNotificationId,
 } from "atoms/notifications";
 import { getDisposableSigner } from "atoms/transfer/services";
 import invariant from "invariant";
@@ -15,6 +15,7 @@ import {
   TransactionPair,
 } from "lib/query";
 import { BuildTxAtomParams, ToastNotification } from "types";
+import { TransactionError } from "types/errors";
 import { TransactionEventTypes } from "types/events";
 import { TransactionFeeProps, useTransactionFee } from "./useTransactionFee";
 
@@ -61,14 +62,6 @@ export type UseTransactionOutput<T> = {
   unknown
 >;
 
-const getNotificationId = <T,>(tx: TransactionPair<T>): string => {
-  const notificationId = createNotificationId(
-    tx.encodedTxData.txs.map((tx) => tx.hash)
-  );
-
-  return notificationId;
-};
-
 export const useTransaction = <T,>({
   params,
   createTxAtom,
@@ -133,19 +126,6 @@ export const useTransaction = <T,>({
     });
   };
 
-  class TransactionError<T> extends Error {
-    public cause: { originalError: unknown; context: TransactionPair<T> };
-    constructor(
-      public message: string,
-      options: {
-        cause: { originalError: unknown; context: TransactionPair<T> };
-      }
-    ) {
-      super(message);
-      this.cause = options.cause;
-    }
-  }
-
   const transactionQuery = useMutation({
     mutationFn: async (
       additionalParams: Partial<BuildTxAtomParams<T>> = {}

apps/namadillo/src/types/errors.ts

@@ -0,0 +1,14 @@
+import { TransactionPair } from "lib/query";
+
+export class TransactionError<T> extends Error {
+  public cause: { originalError: unknown; context: TransactionPair<T> };
+  constructor(
+    public message: string,
+    options: {
+      cause: { originalError: unknown; context: TransactionPair<T> };
+    }
+  ) {
+    super(message);
+    this.cause = options.cause;
+  }
+}