Create README.md

Kavorix · Aug 5, 2022 · 4af3179 · 4af3179
1 parent 462d24f
commit 4af3179
Showing 1 changed file with 21 additions and 0 deletions.
diff --git a/backend/README.md b/backend/README.md
@@ -0,0 +1,21 @@
+## 3 Contracts -
+
+### Contract 1 (Factory)
+
+- Create Pool
+
+### Contract 2 (Liquidity Token)
+
+### Contract 3 (Pool)
+
+- **Swap**
+
+Calculate amountOut ----------> take token from trader --------> loop path array ---------> Swap token
+
+- **Add Liquidity**
+
+Take tokens from liquidity provider --------> calculate tokens to be minted ---------> mint liquidity tokens
+
+- **Remove liquidity**
+
+Transfer liquidity token from provider -------> Calculate tokens to be burnt ---------> burnt liquidity tokens ------> send back his assests