Improve folder structure and name (#29)

* rename model folder to contracts

* move models into entities

* - rename PositionModel to Position
- rename MarketModel to Market

* - move contracts into hooks, since they hooks to connects with contracts
- move tradeTypeMathOperation into trade file since it's not a hook, rename it to tradeValue

README.md

@@ -1,4 +1,5 @@
 # Next dapp starter kit
+
 This is a template meant to kickstart dapps.
 
 ![Next dapp starter kit](/public/next-dapp-starter-kit.png)
@@ -25,3 +26,17 @@ Run the development server:
 ```bash
 bun dev
 ```
+
+## Folder structure
+
+### Entities
+
+Entities is where business logic lives. Instead of having that spread out on components we create classes with logic.
+
+**Markets**
+
+Logic associated with Omen markets like Outcome, Position and Market.
+
+**Tokens**
+
+Logic related to blockchain tokens like Token, Currency, NativeCurrency

app/components/CardBet.tsx

@@ -12,10 +12,9 @@ import { Card } from "@/app/components/ui";
 import { UserPosition } from "@/queries/conditional-tokens/types";
 import { getConditionMarket, getMarketUserTrades } from "@/queries/omen";
 import { remainingTime } from "@/utils/dates";
-import { MarketModel, PositionModel } from "@/models";
-import { tradeTypeMathOperation } from "@/model/market";
+import { Market, Position, valueByTrade } from "@/entities";
+import { redeemPositions } from "@/hooks/contracts";
 import { WXDAI } from "@/constants";
-import { redeemPositions } from "@/model/conditionalTokens";
 import { waitForTransactionReceipt } from "wagmi/actions";
 import { useState } from "react";
 import { ModalId, useModalContext } from "@/context/ModalContext";
@@ -26,7 +25,7 @@ interface BetProps {
 }
 
 export const CardBet = ({ userPosition }: BetProps) => {
-  const position = new PositionModel(userPosition.position);
+  const position = new Position(userPosition.position);
 
   const config = useConfig();
   const { address } = useAccount();
@@ -45,7 +44,7 @@ export const CardBet = ({ userPosition }: BetProps) => {
 
   const market =
     data?.conditions[0] &&
-    new MarketModel(data?.conditions[0]?.fixedProductMarketMakers[0]);
+    new Market(data?.conditions[0]?.fixedProductMarketMakers[0]);
 
   const outcomeIndex = position.outcomeIndex - 1;
 
@@ -66,7 +65,7 @@ export const CardBet = ({ userPosition }: BetProps) => {
     userTrades?.fpmmTrades.reduce((acc, trade) => {
       const type = trade.type;
       const collateralAmountUSD = parseFloat(trade.collateralAmountUSD);
-      return tradeTypeMathOperation[type](acc, collateralAmountUSD);
+      return valueByTrade[type](acc, collateralAmountUSD);
     }, 0) ?? 0;
 
   const outcomeBalance =
@@ -75,7 +74,7 @@ export const CardBet = ({ userPosition }: BetProps) => {
       const collateralAmountUSD = parseFloat(
         formatEther(trade.outcomeTokensTraded as bigint)
       );
-      return tradeTypeMathOperation[type](acc, collateralAmountUSD);
+      return valueByTrade[type](acc, collateralAmountUSD);
     }, 0) ?? 0;
 
   const balance = outcomeBalance ? outcomeBalance.toFixed(2) : "-";

app/components/ConfirmTrade.tsx

@@ -13,12 +13,14 @@ import { SLIPPAGE, SwapDirection, SwapState } from ".";
 import { useState } from "react";
 import { waitForTransactionReceipt, writeContract } from "wagmi/actions";
 import MarketABI from "@/abi/market.json";
-import { CONDITIONAL_TOKEN_CONTRACT_ADDRESS } from "@/model/conditionalTokens";
+import {
+  CONDITIONAL_TOKEN_CONTRACT_ADDRESS,
+  useReadCalcSellAmount,
+} from "@/hooks/contracts";
 import ConditionalTokensABI from "@/abi/conditionalTokens.json";
 import { addFraction, removeFraction } from "@/utils/price";
 import { useConfig } from "wagmi";
 import { Address, erc20Abi, formatEther, parseEther } from "viem";
-import { useReadCalcSellAmount } from "@/model/market";
 import { WXDAI } from "@/constants";
 import { TransactionModal } from "./TransactionModal";
 

app/components/Swapbox.tsx

@@ -6,13 +6,13 @@ import { useEffect, useState } from "react";
 import { erc20Abi, formatEther, parseEther, Address } from "viem";
 import { useAccount, useReadContract } from "wagmi";
 import { ConnectButton } from ".";
-import { useReadCalcBuyAmount } from "@/model/market";
 import { Outcome, Token } from "@/entities";
 import { FixedProductMarketMaker } from "@/queries/omen";
 import {
   CONDITIONAL_TOKEN_CONTRACT_ADDRESS,
   useReadBalance,
-} from "@/model/conditionalTokens";
+  useReadCalcBuyAmount,
+} from "@/hooks/contracts";
 import ConditionalTokensABI from "@/abi/conditionalTokens.json";
 import {
   calcSellAmountInCollateral,
@@ -22,7 +22,6 @@ import {
 import { ConfirmTrade } from "./ConfirmTrade";
 import { ModalId, useModalContext } from "@/context/ModalContext";
 import { WXDAI } from "@/constants";
-import { MarketModel } from "../../models";
 
 export const SLIPPAGE = 0.01;
 const ONE_UNIT = "1";
@@ -201,7 +200,7 @@ export const Swapbox = ({ market }: { market: FixedProductMarketMaker }) => {
         <SwapInput
           title="You Swap"
           value={tokenAmountIn}
-          onChange={(event) => {
+          onChange={event => {
             setTokenAmountIn(event.target.value);
           }}
           onClick={currentState.changeInToken}

app/components/UserBets.tsx

@@ -3,15 +3,14 @@ import { useAccount } from "wagmi";
 import { formatEther } from "viem";
 import { cx } from "class-variance-authority";
 import { waitForTransactionReceipt } from "wagmi/actions";
-import { MarketModel } from "@/models";
+import { Market, valueByTrade } from "@/entities";
 import { useState } from "react";
 import { Button, Icon, Logo, Tag } from "swapr-ui";
 import { WXDAI } from "@/constants";
 import { TransactionModal } from ".";
 import { ModalId, useModalContext } from "@/context/ModalContext";
 import { config } from "@/providers/config";
-import { redeemPositions, useReadBalance } from "@/model/conditionalTokens";
-import { tradeTypeMathOperation } from "@/model/market";
+import { redeemPositions, useReadBalance } from "@/hooks/contracts";
 import { getCondition } from "@/queries/conditional-tokens";
 import { FixedProductMarketMaker, getMarketUserTrades } from "@/queries/omen";
 
@@ -53,15 +52,15 @@ export const UserBets = ({ market }: UserBets) => {
   });
 
   const [outcome0UserTrades, outcome1UserTrades] = [
-    userTrades?.fpmmTrades.filter((trade) => trade.outcomeIndex === "0") || [],
-    userTrades?.fpmmTrades.filter((trade) => trade.outcomeIndex === "1") || [],
+    userTrades?.fpmmTrades.filter(trade => trade.outcomeIndex === "0") || [],
+    userTrades?.fpmmTrades.filter(trade => trade.outcomeIndex === "1") || [],
   ];
 
   const outcome0CollateralAmountUSDSpent = outcome0UserTrades.reduce(
     (acc, trade) => {
       const type = trade.type;
       const collateralAmountUSD = parseFloat(trade.collateralAmountUSD);
-      return tradeTypeMathOperation[type](acc, collateralAmountUSD);
+      return valueByTrade[type](acc, collateralAmountUSD);
     },
     0
   );
@@ -70,7 +69,7 @@ export const UserBets = ({ market }: UserBets) => {
     (acc, trade) => {
       const type = trade.type;
       const collateralAmountUSD = parseFloat(trade.collateralAmountUSD);
-      return tradeTypeMathOperation[type](acc, collateralAmountUSD);
+      return valueByTrade[type](acc, collateralAmountUSD);
     },
     0
   );
@@ -85,15 +84,15 @@ export const UserBets = ({ market }: UserBets) => {
     const collateralAmountUSD = parseFloat(
       formatEther(trade.outcomeTokensTraded as bigint)
     );
-    return tradeTypeMathOperation[type](acc, collateralAmountUSD);
+    return valueByTrade[type](acc, collateralAmountUSD);
   }, 0);
 
   const outcome1TradedBalance = outcome1UserTrades.reduce((acc, trade) => {
     const type = trade.type;
     const collateralAmountUSD = parseFloat(
       formatEther(trade.outcomeTokensTraded as bigint)
     );
-    return tradeTypeMathOperation[type](acc, collateralAmountUSD);
+    return valueByTrade[type](acc, collateralAmountUSD);
   }, 0);
 
   const outcomesTradedBalance = [outcome0TradedBalance, outcome1TradedBalance];
@@ -119,7 +118,7 @@ export const UserBets = ({ market }: UserBets) => {
   )
     return null;
 
-  const marketModel = new MarketModel(market);
+  const marketModel = new Market(market);
 
   const { condition } = conditionData;
   const isResolved = condition.resolved;

app/markets/MarketDetails.tsx

@@ -7,7 +7,7 @@ import { Button, IconButton, Tag } from "swapr-ui";
 import { remainingTime } from "@/utils/dates";
 import Link from "next/link";
 import { Address } from "viem";
-import { MarketModel } from "@/models";
+import { Market } from "@/entities";
 import { UserBets } from "../components/UserBets";
 
 interface MarketDetailsProps {
@@ -25,7 +25,7 @@ export const MarketDetails = ({ id }: MarketDetailsProps) => {
     return <LoadingMarketDetails />;
 
   const market = data.fixedProductMarketMaker;
-  const marketModel = new MarketModel(market);
+  const marketModel = new Market(market);
 
   const closingDate = new Date(+market.openingTimestamp * 1000);
 

entities/index.ts

@@ -1,3 +1,2 @@
-export * from "./token";
-export * from "./outcome";
-export * from "./nativeCurrency";
+export * from "./tokens";
+export * from "./markets";

entities/markets/index.ts

@@ -0,0 +1,4 @@
+export * from "./market";
+export * from "./position";
+export * from "./outcome";
+export * from "./trade";

models/Market.ts → entities/markets/market.ts

@@ -2,7 +2,7 @@ import { FixedProductMarketMaker } from "@/queries/omen";
 import { fromHex } from "viem";
 import { Outcome } from "@/entities";
 
-export class MarketModel {
+export class Market {
   data: FixedProductMarketMaker;
   closingDate: Date;
   answer: number | null;

models/Position.ts → entities/markets/position.ts

@@ -1,11 +1,11 @@
-import { Position } from "@/queries/conditional-tokens/types";
+import { Position as ConditionalTokenPosition } from "@/queries/conditional-tokens/types";
 
-export class PositionModel {
+export class Position {
   conditionId: string;
   outcomeIndex: number;
   outcomes?: string[] | null;
 
-  constructor(position: Position) {
+  constructor(position: ConditionalTokenPosition) {
     this.conditionId = position.conditionIdsStr;
     this.outcomeIndex = position.indexSets[0];
     this.outcomes = position.conditions?.[0]?.outcomes;

entities/markets/trade.ts

@@ -0,0 +1,8 @@
+import { TradeType } from "@/queries/omen/types";
+
+export const valueByTrade = {
+  [TradeType.Buy]: (previousValue: number, newValue: number) =>
+    previousValue + newValue,
+  [TradeType.Sell]: (previousValue: number, newValue: number) =>
+    previousValue - newValue,
+};

entities/tokens/index.ts

@@ -0,0 +1,2 @@
+export * from "./token";
+export * from "./nativeCurrency";

hooks/contracts/index.ts

@@ -0,0 +1,2 @@
+export * from "./conditionalTokens";
+export * from "./market";

model/market.ts → hooks/contracts/market.ts

@@ -1,7 +1,6 @@
 import MarketABI from "@/abi/market.json";
 import { Abi, Address, parseEther } from "viem";
 import { UseReadContractParameters, useReadContract } from "wagmi";
-import { TradeType } from "@/queries/omen";
 
 export const useReadMarketContract = ({
   address,
@@ -45,10 +44,3 @@ export const useReadCalcSellAmount = (
     query: { enabled: !!tokenOutAmount },
   });
 };
-
-export const tradeTypeMathOperation = {
-  [TradeType.Buy]: (previousValue: number, newValue: number) =>
-    previousValue + newValue,
-  [TradeType.Sell]: (previousValue: number, newValue: number) =>
-    previousValue - newValue,
-};