Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mgnfy-view/thunder-swap

A decentralized exchange and flash swap protocol
https://github.com/mgnfy-view/thunder-swap

airdrop decentralized-exchange defi flash-swap foundry governance-token smart-contracts solidity uniswap utility-token

Last synced: about 1 month ago
JSON representation

A decentralized exchange and flash swap protocol

Host: GitHub
URL: https://github.com/mgnfy-view/thunder-swap
Owner: mgnfy-view
License: mit
Created: 2024-03-13T12:50:04.000Z (9 months ago)
Default Branch: main
Last Pushed: 2024-05-22T08:30:40.000Z (7 months ago)
Last Synced: 2024-05-29T22:11:27.075Z (7 months ago)
Topics: airdrop, decentralized-exchange, defi, flash-swap, foundry, governance-token, smart-contracts, solidity, uniswap, utility-token
Language: Solidity
Homepage:
Size: 141 KB
Stars: 4
Watchers: 1
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE.txt

Awesome Lists containing this project

README

        

[![Contributors][contributors-shield]][contributors-url]

[![Forks][forks-shield]][forks-url]

[![Stargazers][stars-shield]][stars-url]

[![Issues][issues-shield]][issues-url]

[![MIT License][license-shield]][license-url]

[![LinkedIn][linkedin-shield]][linkedin-url]






  

  Thunder Swap


  


    A decentralized exchange and flash swapping protocol

    


    Explore the docs »

    


    Report Bug

    ·

    Request Feature

  



  Table of Contents

  


    

      About The Project

      

        Built With

      

    

    

      Getting Started

      

        Prerequisites

        Installation

      

    

    Roadmap

    Contributing

    License

    Contact

  


## About The Project

Thunder Swap is a decentralized exchange protocol that also supports flash swaps. A flash swap allows you to get a certain amount of a type of token within the pool as loan, and swap it for a certain amount of the other type of token in the pool, plus some minimal fee.

A thunder swap pool factory is deployed on-chain, and users can interact with it to deploy thunder swap pools for supported tokens (set by the deployer). Liquidity providers can supply pools with liquidity and earn a fees of 0.3% on each swap. Each liquidity provider is minted LP (Liquidity Provider) tokens representing the portion of the pool they own. At any time, liquidity providers can exit the protocol by burning these LP tokens, which allows them to withdraw their liquidity along with any accrued fees.

Both normal swaps and flash swaps take place using the `ThunderSwapPool::flashSwapExactInput()` and `ThunderSwapPool::flashSwapExactOutput()` functions. In a normal swap, the `receiver` address is the user's wallet address; however, in a flash swap, a user sets the `receiver` address as the contract's address (which is `IThunderSwapReceiver` interface compliant). The contract that receives the token loan has to ensure that enough tokens are approved to the `ThunderSwapPool` when the control returns to it and the loan is paid back (along with fees). With flash swaps, contracts can also activate hooks before and after a swap to fine tune their swapping strategy.

Thunder Swap is marching towards a community-driven future with the introduction of the $THUD token, which is the key utility and governance token in the Thunder Swap ecosystem. Currently, the only way to obtain $THUD is via an airdrop conducted by the protocol team to reward loyal and regular users of the protocol. $THUD can be used to partake in governance, allowing the community to support more tokens on the exchange.

### Built With

- ![Foundry](https://img.shields.io/badge/-FOUNDRY-%23323330.svg?style=for-the-badge)

- ![Solidity](https://img.shields.io/badge/Solidity-%23363636.svg?style=for-the-badge&logo=solidity&logoColor=white)

- ![NPM](https://img.shields.io/badge/NPM-%23CB3837.svg?style=for-the-badge&logo=npm&logoColor=white)

## Getting Started

To get a local copy up and running follow these simple steps.

### Prerequisites

Ensure that you have the Foundry framework installed on your system. You can get the installation instructions [here](https://book.getfoundry.sh/getting-started/installation).

Also, you'll need pnpm and make installed and configured on your system.

### Installation

Clone the repo

```shell

git clone https://github.com/mgnfy-view/thunder-swap

```

cd into the repo, and install the necessary dependencies

```shell

cd thunder-swap

make install

pnpm intall

```

That's it, you are good to go now!

## Roadmap

- [x] Smart contract development

  - [x] Thunder Swap Core

  - [x] Thunder Swap $THUD token

  - [x] Thunder Swap Governance

  - [x] Thunder Swap Airdrop Manager

- [x] Testing

  - [x] Unit testing

    - [x] Pool deployment tests

    - [x] Liquidity tests

    - [x] Flash swap tests

    - [x] Airdrop tests

    - [x] Governance tests

    - [x] Miscellaneous tests

- [x] Write a deployment script

- [x] Write docs and README.md

See the [open issues](https://github.com/mgnfy-view/thunder-swap/issues) for a full list of proposed features (and known issues).

## Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".

Don't forget to give the project a star! Thanks again!

1. Fork the Project

2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)

3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)

4. Push to the Branch (`git push origin feature/AmazingFeature`)

5. Open a Pull Request

## License

Distributed under the MIT License. See `LICENSE.txt` for more information.

## Reach Out

Here's a gateway to all my socials, don't forget to hit me up!

[![Linktree](https://img.shields.io/badge/linktree-1de9b6?style=for-the-badge&logo=linktree&logoColor=white)][linktree-url]

[contributors-shield]: https://img.shields.io/github/contributors/mgnfy-view/thunder-swap.svg?style=for-the-badge

[contributors-url]: https://github.com/mgnfy-view/thunder-swap/graphs/contributors

[forks-shield]: https://img.shields.io/github/forks/mgnfy-view/thunder-swap.svg?style=for-the-badge

[forks-url]: https://github.com/mgnfy-view/thunder-swap/network/members

[stars-shield]: https://img.shields.io/github/stars/mgnfy-view/thunder-swap.svg?style=for-the-badge

[stars-url]: https://github.com/mgnfy-view/thunder-swap/stargazers

[issues-shield]: https://img.shields.io/github/issues/mgnfy-view/thunder-swap.svg?style=for-the-badge

[issues-url]: https://github.com/mgnfy-view/thunder-swap/issues

[license-shield]: https://img.shields.io/github/license/mgnfy-view/thunder-swap.svg?style=for-the-badge

[license-url]: https://github.com/mgnfy-view/thunder-swap/blob/main/LICENSE.txt

[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555

[linkedin-url]: https://linkedin.com/in/sahil-gujrati-125ab0284

[linktree-url]: https://linktr.ee/mgnfy.view