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

https://github.com/bubble-finance/bubble-v1-protocol

Smart contracts for Bubble v1 protocol ๐Ÿ“œ
https://github.com/bubble-finance/bubble-v1-protocol

dex farms forge foundry launchpad monad openzeppelin raffle smart-contracts solidity solmate tokens web3

Last synced: 4 months ago
JSON representation

Smart contracts for Bubble v1 protocol ๐Ÿ“œ

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]




Bubble V1 Protocol


Bubble is the #1 gamified and ecosystem-focused native DEX built on Monad


Report Bug
ยท
Request Feature


Table of Contents



  1. About The Project



  2. Getting Started


  3. Roadmap

  4. Contributing

  5. License

  6. Contact

## About The Project

![bubblefi](./images/bubblefi.png)

Welcome to Bubble, the #1 gamified and ecosystem-focused native DEX built on Monad. Bubble is the ultimate liquidity hub catering to the interests of both degens and mature traders alike with features such as MEV shield, gas sponsored swaps, raffle, launchpads, farms and more.

This repository houses the core and auxiliary smart contracts for Bubble v1. For those seeking non-technical, in-depth documentation, we have prepared a comprehensive guide available on [GitBook](https://bubblefi.gitbook.io/bubblefi). This resource is tailored to provide a thorough understanding of Bubble, its features, and how to get started, making it an invaluable asset for both newcomers and experienced users alike.

Join us in shaping the future of decentralized finance on Monad by contributing to Bubble. Whether you're a developer looking to build on our platform, a degen trader seeking a new exchange, or simply curious about the project, we welcome you to explore and engage with our community.

### Built With

- Solidity
- Foundry
- Pnpm

## Getting Started

### Prerequisites

Make sure you have git, rust, foundry, node.js, and pnpm installed and configured on your system.

### Installation

Clone the repo,

```shell
git clone https://github.com/Bubble-Finance/bubble-v1-protocol.git
```

cd into the repo, and install the necessary dependencies

```shell
cd bubble-v1-protocol
pnpm i
forge build
```

Run tests by executing

```shell
forge test
```

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

## Roadmap

- [x] Smart contract development
- [x] Unit tests
- [x] Write a good README.md

See the [open issues](https://github.com/Bubble-Finance/bubble-v1-protocol/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

[![Discord](https://img.shields.io/badge/Discord-%235865F2.svg?style=for-the-badge&logo=discord&logoColor=white)][discord-url]
[![X](https://img.shields.io/badge/X-%23000000.svg?style=for-the-badge&logo=X&logoColor=white)][x-url]

[contributors-shield]: https://img.shields.io/github/contributors/Bubble-Finance/bubble-v1-protocol.svg?style=for-the-badge
[contributors-url]: https://github.com/Bubble-Finance/bubble-v1-protocol/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/Bubble-Finance/bubble-v1-protocol.svg?style=for-the-badge
[forks-url]: https://github.com/Bubble-Finance/bubble-v1-protocol/network/members
[stars-shield]: https://img.shields.io/github/stars/Bubble-Finance/bubble-v1-protocol.svg?style=for-the-badge
[stars-url]: https://github.com/Bubble-Finance/bubble-v1-protocol/stargazers
[issues-shield]: https://img.shields.io/github/issues/Bubble-Finance/bubble-v1-protocol.svg?style=for-the-badge
[issues-url]: https://github.com/Bubble-Finance/bubble-v1-protocol/issues
[license-shield]: https://img.shields.io/github/license/Bubble-Finance/bubble-v1-protocol.svg?style=for-the-badge
[license-url]: https://github.com/Bubble-Finance/bubble-v1-protocol/blob/master/LICENSE.txt
[discord-url]: https://discord.gg/gUG5fhF69D
[x-url]: https://x.com/Bubblefi_xyz