README.md

🌟 Lunex - A DEX on the Lunes Blockchain 🌟

Welcome to Lunex, the decentralized exchange (DEX) built on the Lunes blockchain! Our mission is to provide a seamless, secure, and cost-effective platform for trading digital assets. With low fees and a focus on liquidity pools, Lunex is your go-to solution for decentralized trading on the Lunes network.

📜 Table of Contents

1. Introduction
2. Description
3. Features
4. Technologies Used
5. Challenges and Future Enhancements
6. Getting Started
7. Installation and Running the Project
8. Usage
9. Liquidity Pools
10. Smart Contracts
11. Low Fees
12. Credits
13. Contributing
14. How to Use - Contracts
15. Status
16. Versions
17. License

📝 Introduction

Lunex is a cutting-edge DEX specifically designed for the Lunes blockchain. By leveraging the power of smart contracts developed with !INK 4.x, Lunex ensures a robust and secure trading environment. Whether you are a seasoned trader or new to the world of decentralized finance (DeFi), Lunex offers a user-friendly platform with the lowest fees in the market.

📝 Description

What the Application Does

Lunex facilitates decentralized trading of digital assets on the Lunes blockchain. Users can trade directly from their wallets, participate in liquidity pools, and benefit from low transaction fees.

Technologies Used

• Blockchain: Lunes
• Smart Contracts: Developed with !INK 4.x
• Frontend: React.js

Challenges and Future Enhancements

Challenges

• Security: Ensuring the security of smart contracts and user funds.
• Scalability: Maintaining performance as the user base grows.
• User Experience: Simplifying the interface for non-technical users.

Future Enhancements

• Integration with more blockchains: Expanding trading options.
• Advanced trading features: Adding limit orders, stop-loss orders, etc.
• Mobile application: Developing a mobile version of Lunex.

🌟 Features

• 🔗 Decentralized Trading: Trade directly from your wallet without the need for intermediaries.
• 💧 Liquidity Pools: Provide liquidity and earn rewards through our innovative liquidity pool system.
• 💰 Low Fees: Enjoy some of the lowest transaction fees in the DeFi space.
• 🔐 Secure Smart Contracts: Built with !INK 4.x, ensuring security and efficiency.
• 🖥️ User-Friendly Interface: Easy-to-navigate platform for all levels of users.

🚀 Getting Started

1. Create a Lunes Wallet: If you don't have one already, create a Lunes wallet to start trading.
2. Connect Your Wallet: Connect your Lunes wallet to the Lunex DEX.
3. Add Liquidity: Deposit your tokens into our liquidity pools to start earning rewards.
4. Start Trading: Begin trading your favorite tokens with low fees and high security.

🛠️ Installation and Running the Project

To run Lunex locally, follow these steps:

1. Clone the repository:

   git clone https://github.com/yourusername/lunex.git
   cd lunex

2. Install dependencies:

   yarn install

3. Build the project:

   yarn build

4. Start the local development server:

   yarn start

Ensure you have all the necessary tools and dependencies, such as Node.js and Yarn, installed on your machine.

🛠 Usage

To use the Lunex DEX:

1. Connect your Lunes wallet: Ensure you have a Lunes wallet and connect it to the Lunex platform.
2. Add Liquidity: Deposit the desired token pairs into the liquidity pools.
3. Trade Tokens: Use the trading interface to buy or sell tokens.
4. Earn Rewards: Monitor and collect rewards from your provided liquidity.

Example Screenshots

If the project requires authentication, include any necessary credentials or instructions here.

💧 Liquidity Pools

Lunex offers a variety of liquidity pools that allow users to provide liquidity and earn rewards. By adding liquidity to a pool, you facilitate smoother trading operations on our DEX and earn a portion of the transaction fees.

How to Add Liquidity

1. Navigate to the Liquidity Pools section on the Lunex platform.
2. Select the pool you want to provide liquidity to.
3. Deposit the required token pair into the pool.
4. Start earning rewards based on the trading activity in that pool.

🔐 Smart Contracts

Our smart contracts are developed using !INK 4.x, a robust and secure framework for blockchain applications. This ensures that all transactions on Lunex are executed efficiently and securely, providing users with peace of mind.

💸 Low Fees

One of Lunex's standout features is our exceptionally low fees. We believe that trading should be accessible to everyone, which is why we've minimized transaction costs without compromising on security or performance.

🙌 Credits

Lunex is a collaborative effort. Thanks to all the contributors who made this project possible.

• Jorge William: GitHub
• Adelson Santos: GitHub

Special thanks to the following resources for guidance and inspiration:

• Resource 1
• Resource 2

🤝 Contributing

We welcome contributions from the community! Whether you are a developer, designer, or simply passionate about DeFi, your input is valuable to us.

How to Contribute

1. Fork the repository.
2. Create a new branch (git checkout -b feature/YourFeature).
3. Commit your changes (git commit -m 'Add some feature').
4. Push to the branch (git push origin feature/YourFeature).
5. Open a pull request.

Please make sure to follow our Code of Conduct and read our Contributing Guide.

🛠️ How to Use - Contracts

💫 Build

Use these instructions to set up your ink!/Rust environment. Run this command in the contract folder:

cargo contract build

💫 Run Unit Test

cargo test

💫 Deploy

First, start your local node. Deploy using polkadot JS. Instructions on Astar docs.

💫 Run Integration Test

First, start your local node. Recommended swanky-node v0.13.0

yarn
yarn compile
yarn test:typechain

✅ Status

• Contracts: Completed
• Integration Tests: In progress
• UI: Expected by July 2024
• Integration with Mainnet: Expected by August 2024
• Audit: Pending

📦 Versions

• ink!: 4.0.0
• openbrush: 3.0.0

📛 Badges

📄 License

Lunex is open-source and available under the Apache 2.0.