Skip to content

Commit

Permalink
Addition of flow chart for course of operations
Browse files Browse the repository at this point in the history
  • Loading branch information
gitshreevatsa committed Oct 10, 2024
1 parent 7fe43d7 commit 870f0bf
Show file tree
Hide file tree
Showing 4 changed files with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,12 +36,12 @@ Before working with this repository, ensure that you have properly set up your e

To help you get started quickly, we provide two demo tasks that showcase the full lifecycle from deployment to execution. These tasks cover deploying and initializing all necessary contracts,
as well as performing operations like minting, swapping, and burning
![alt text](/public/image.png)

### Demo Tasks
1. **Using Factory and Pair Contracts Only**
This demo handles deploying the Factory and Pair contracts and executing a complete flow of operations
[View the demo task](https://github.com/NilFoundation/uniswap-v2-nil/blob/main/tasks/core/demo.ts)
![alt text](/public/demo.png)


**Important:**
Expand All @@ -52,6 +52,7 @@ as well as performing operations like minting, swapping, and burning
2. **Using Factory, Pair, and Router Contracts**
This demo includes an additional layer by utilizing the Router contract along with Factory and Pair
[View the demo-router task](https://github.com/NilFoundation/uniswap-v2-nil/blob/main/tasks/core/demo-router.ts)
![alt text](/public/demo-router.png)

**Important:**
- The `UniswapV2Factory` is used for creating new pairs. `UniswapV2Router01` calls already deployed pair contracts.
Expand Down
Binary file added public/demo-router.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/demo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed public/image.png
Binary file not shown.

0 comments on commit 870f0bf

Please sign in to comment.